feat: local db (#97)

* feat: local db init v2 Signed-off-by: Innei <i@innei.in> * feat: hydrate Signed-off-by: Innei <i@innei.in> * feat: setting Signed-off-by: Innei <i@innei.in> * fix: read color in dark mode Signed-off-by: Innei <i@innei.in> * chore: cleanup Signed-off-by: Innei <i@innei.in> * update Signed-off-by: Innei <i@innei.in> * update Signed-off-by: Innei <i@innei.in> * update Signed-off-by: Innei <i@innei.in> * feat: persist star data Signed-off-by: Innei <i@innei.in> * Update src/renderer/src/store/entry/hooks.ts --------- Signed-off-by: Innei <i@innei.in>
RSSNext · Jun 28, 2024 · be6968c · be6968c
1 parent e1ae88f
commit be6968c
Show file tree

Hide file tree

Showing 52 changed files with 800 additions and 176 deletions.
diff --git a/package.json b/package.json
@@ -60,6 +60,7 @@
     "clsx": "2.1.1",
     "cmdk": "1.0.0",
     "dayjs": "1.11.11",
+    "dexie": "4.0.7",
     "dnum": "^2.13.1",
     "dotenv": "16.4.5",
     "electron-updater": "^6.2.1",
@@ -96,7 +97,6 @@
     "rehype-stringify": "10.0.0",
     "shiki": "1.9.1",
     "sonner": "^1.5.0",
-    "superjson": "2.2.1",
     "swiper": "11.1.4",
     "tailwind-merge": "2.3.0",
     "tailwindcss-animate": "1.0.7",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/renderer/src/components/feed-icon.tsx b/src/renderer/src/components/feed-icon.tsx
@@ -1,7 +1,7 @@
 import { SiteIcon } from "@renderer/components/site-icon"
 import { Image } from "@renderer/components/ui/image"
 import { cn } from "@renderer/lib/utils"
-import type { EntryModel, FeedModel } from "@renderer/models"
+import type { CombinedEntryModel, FeedModel } from "@renderer/models"
 
 export function FeedIcon({
   feed,
@@ -11,7 +11,7 @@ export function FeedIcon({
   size = 20,
 }: {
   feed: FeedModel
-  entry?: EntryModel["entries"]
+  entry?: CombinedEntryModel["entries"]
   fallbackUrl?: string
   className?: string
   size?: number

diff --git a/src/renderer/src/database/constants.ts b/src/renderer/src/database/constants.ts
@@ -0,0 +1 @@
+export const LOCAL_DB_NAME = "FOLLOW_DB"
diff --git a/src/renderer/src/database/db.ts b/src/renderer/src/database/db.ts
@@ -0,0 +1,55 @@
+import Dexie from "dexie"
+
+import { LOCAL_DB_NAME } from "./constants"
+import {
+  dbSchemaV1,
+} from "./db_schema"
+import type { DB_Entry } from "./schemas/entry"
+import type { DBModel } from "./types"
+
+export interface LobeDBSchemaMap {
+
+  entries: DB_Entry
+  // TODO - Add more schemas here
+  feeds: DB_Entry
+  subscriptions: DB_Entry
+  entryRelated: DB_Entry
+  feedEntries: DB_Entry
+}
+
+// Define a local DB
+export class BrowserDB extends Dexie {
+  public entries: BrowserDBTable<"entries">
+  public feeds: BrowserDBTable<"feeds">
+  public subscriptions: BrowserDBTable<"subscriptions">
+  public entryRelated: BrowserDBTable<"entryRelated">
+  public feedEntries: BrowserDBTable<"feedEntries">
+
+  constructor() {
+    super(LOCAL_DB_NAME)
+    this.version(1).stores(dbSchemaV1)
+
+    this.entries = this.table("entries")
+    this.feeds = this.table("feeds")
+    this.subscriptions = this.table("subscriptions")
+    this.entryRelated = this.table("entryRelated")
+    this.feedEntries = this.table("feedEntries")
+  }
+}
+
+export const browserDB = new BrowserDB()
+
+// ================================================ //
+// ================================================ //
+// ================================================ //
+// ================================================ //
+// ================================================ //
+
+// types helper
+export type BrowserDBSchema = {
+  [t in keyof LobeDBSchemaMap]: {
+    model: LobeDBSchemaMap[t]
+    table: Dexie.Table<DBModel<LobeDBSchemaMap[t]>, string>
+  };
+}
+type BrowserDBTable<T extends keyof LobeDBSchemaMap> = BrowserDBSchema[T]["table"]
diff --git a/src/renderer/src/database/db_schema.ts b/src/renderer/src/database/db_schema.ts
@@ -0,0 +1,7 @@
+export const dbSchemaV1 = {
+  entries: "&id",
+  feeds: "&id",
+  subscriptions: "&id",
+  entryRelated: "&id",
+  feedEntries: "&feedId",
+}
diff --git a/src/renderer/src/database/hooks.ts b/src/renderer/src/database/hooks.ts
@@ -0,0 +1,16 @@
+import { createAtomHooks, jotaiStore } from "@renderer/lib/jotai"
+import { buildStorageNS } from "@renderer/lib/ns"
+import { atomWithStorage } from "jotai/utils"
+
+const SHOULD_USE_INDEXED_DB_KEY = buildStorageNS("shouldUseIndexedDB")
+
+export const [
+  __shouldUseIndexedDBAtom,
+  useShouldUseIndexedDB,
+  useShouldUseIndexedDBValue,
+  useSetShouldUseIndexedDB,
+  getShouldUseIndexedDB,
+  setShouldUseIndexedDB,
+] = createAtomHooks(atomWithStorage(SHOULD_USE_INDEXED_DB_KEY, false))
+
+export const subscribeShouldUseIndexedDB = (callback: (value: boolean) => void) => jotaiStore.sub(__shouldUseIndexedDBAtom, () => callback(getShouldUseIndexedDB()))
diff --git a/src/renderer/src/database/index.ts b/src/renderer/src/database/index.ts
@@ -0,0 +1,4 @@
+export * from "./db"
+export * from "./hooks"
+export * from "./models"
+export * from "./schemas"
diff --git a/src/renderer/src/database/model.ts b/src/renderer/src/database/model.ts
@@ -0,0 +1,31 @@
+/**
+ * @see https://github.com/lobehub/lobe-chat/blob/adebf0a92167faad48581b0b0780cf8faeba362f/src/database/client/core/model.ts
+ */
+
+import type Dexie from "dexie"
+import type { ZodObject } from "zod"
+
+import type { BrowserDB, BrowserDBSchema } from "./db"
+import { browserDB } from "./db"
+
+export class BaseModel<
+  N extends keyof BrowserDBSchema = any,
+  // T extends { id: string } = any,
+  // T = BrowserDBSchema[N]["table"],
+> {
+  protected readonly db: BrowserDB
+  // used to data validation, but use now
+
+  private readonly schema: ZodObject<any>
+  private readonly _tableName: keyof BrowserDBSchema
+
+  constructor(table: N, schema: ZodObject<any>, db = browserDB) {
+    this.db = db
+    this.schema = schema
+    this._tableName = table
+  }
+
+  get table() {
+    return this.db[this._tableName] as Dexie.Table
+  }
+}
diff --git a/src/renderer/src/database/models/entry-related.ts b/src/renderer/src/database/models/entry-related.ts
@@ -0,0 +1,10 @@
+import { BaseModel } from "../model"
+import { DB_EntrySchema } from "../schemas"
+
+class ModelStatic extends BaseModel<"entryRelated"> {
+  constructor() {
+    super("entryRelated", DB_EntrySchema)
+  }
+}
+
+export const entryRelatedModel = new ModelStatic()
diff --git a/src/renderer/src/database/models/entry.ts b/src/renderer/src/database/models/entry.ts
@@ -0,0 +1,10 @@
+import { BaseModel } from "../model"
+import { DB_EntrySchema } from "../schemas"
+
+class EntryModelStatic extends BaseModel<"entries"> {
+  constructor() {
+    super("entries", DB_EntrySchema)
+  }
+}
+
+export const entryModel = new EntryModelStatic()
diff --git a/src/renderer/src/database/models/feed-entry.ts b/src/renderer/src/database/models/feed-entry.ts
@@ -0,0 +1,10 @@
+import { BaseModel } from "../model"
+import { DB_EntrySchema } from "../schemas"
+
+class ModelStatic extends BaseModel<"feedEntries"> {
+  constructor() {
+    super("feedEntries", DB_EntrySchema)
+  }
+}
+
+export const feedEntriesModel = new ModelStatic()
diff --git a/src/renderer/src/database/models/feed.ts b/src/renderer/src/database/models/feed.ts
@@ -0,0 +1,10 @@
+import { BaseModel } from "../model"
+import { DB_EntrySchema } from "../schemas"
+
+class ModelStatic extends BaseModel<"feeds"> {
+  constructor() {
+    super("feeds", DB_EntrySchema)
+  }
+}
+
+export const feedModel = new ModelStatic()
diff --git a/src/renderer/src/database/models/index.ts b/src/renderer/src/database/models/index.ts
@@ -0,0 +1,5 @@
+export * from "./entry"
+export * from "./entry-related"
+export * from "./feed"
+export * from "./feed-entry"
+export * from "./subscription"
diff --git a/src/renderer/src/database/models/subscription.ts b/src/renderer/src/database/models/subscription.ts
@@ -0,0 +1,10 @@
+import { BaseModel } from "../model"
+import { DB_EntrySchema } from "../schemas"
+
+class ModelStatic extends BaseModel<"subscriptions"> {
+  constructor() {
+    super("subscriptions", DB_EntrySchema)
+  }
+}
+
+export const subscriptionModel = new ModelStatic()
diff --git a/src/renderer/src/database/schemas/entry.ts b/src/renderer/src/database/schemas/entry.ts
@@ -0,0 +1,7 @@
+import { z } from "zod"
+
+export const DB_EntrySchema = z.object({
+  id: z.string(),
+})
+
+export type DB_Entry = z.infer<typeof DB_EntrySchema>
diff --git a/src/renderer/src/database/schemas/index.ts b/src/renderer/src/database/schemas/index.ts
@@ -0,0 +1 @@
+export * from "./entry"
diff --git a/src/renderer/src/database/types.ts b/src/renderer/src/database/types.ts
@@ -0,0 +1,5 @@
+export type DBModel<T> = T & {
+  createdAt: number
+  id: string
+  updatedAt: number
+}
diff --git a/src/renderer/src/hooks/biz/useAsRead.ts b/src/renderer/src/hooks/biz/useAsRead.ts
@@ -1,11 +1,10 @@
-import { FEED_COLLECTION_LIST, levels } from "@renderer/lib/constants"
-import type { EntryModel } from "@renderer/models"
+import type { CombinedEntryModel } from "@renderer/models"
 
 import { useRouteParamsSelector } from "./useRouteParams"
 
-export function useAsRead(entry?: EntryModel) {
-  return useRouteParamsSelector(({ feedId, level }) => {
+export function useAsRead(entry?: CombinedEntryModel) {
+  return useRouteParamsSelector(() => {
     if (!entry) return false
-    return entry.read && !(level === levels.folder && feedId === FEED_COLLECTION_LIST)
+    return entry.read
   }, [entry?.read])
 }
diff --git a/src/renderer/src/hooks/biz/useAuth.ts b/src/renderer/src/hooks/biz/useAuth.ts
@@ -1,6 +1,6 @@
 import { signOut } from "@hono/auth-js/react"
 import { QUERY_PERSIST_KEY } from "@renderer/lib/constants"
-import { clearLocalPersistStoreData } from "@renderer/store/utils/local"
+import { clearLocalPersistStoreData } from "@renderer/store/utils/clear"
 import { useCallback } from "react"
 
 export const useSignOut = () =>