feat(desktop): export sqlite database

Author: hyoban

apps/desktop/layer/renderer/package.json

@@ -15,6 +15,7 @@
     "@dnd-kit/core": "6.3.1",
     "@dnd-kit/sortable": "10.0.0",
     "@electron-toolkit/preload": "3.0.2",
+    "@follow/database": "workspace:*",
     "@follow/electron-main": "workspace:*",
     "@follow/shared": "workspace:*",
     "@follow/store": "workspace:*",
@@ -48,7 +49,6 @@
     "cmdk": "1.1.1",
     "dayjs": "1.11.13",
     "dexie": "4.0.11",
-    "dexie-export-import": "4.1.4",
     "dnum": "2.15.0",
     "embla-carousel-react": "8.6.0",
     "embla-carousel-wheel-gestures": "8.0.2",

apps/desktop/layer/renderer/src/database/db.ts

@@ -79,16 +79,6 @@ class BrowserDB extends Dexie {
 
 export const browserDB = new BrowserDB()
 
-export const exportDB = async () => {
-  await import("dexie-export-import")
-  const blob = await browserDB.export({ prettyJson: true })
-  const url = URL.createObjectURL(blob)
-  const a = document.createElement("a")
-  a.href = url
-  a.download = `${LOCAL_DB_NAME}.json`
-  a.click()
-}
-
 // ================================================ //
 // ================================================ //
 // ================================================ //

apps/desktop/layer/renderer/src/modules/settings/tabs/data-control.tsx

@@ -13,6 +13,7 @@ import { Input } from "@follow/components/ui/input/Input.js"
 import { Label } from "@follow/components/ui/label/index.jsx"
 import { RadioGroup, RadioGroupItem } from "@follow/components/ui/radio-group/motion.js"
 import { Slider } from "@follow/components/ui/slider/index.js"
+import { exportDB } from "@follow/database/db"
 import { ELECTRON_BUILD } from "@follow/shared/constants"
 import { env } from "@follow/shared/env.desktop"
 import { zodResolver } from "@hookform/resolvers/zod"
@@ -24,7 +25,6 @@ import { z } from "zod"
 
 import { setGeneralSetting, useGeneralSettingValue } from "~/atoms/settings/general"
 import { useDialog, useModalStack } from "~/components/ui/modal/stacked/hooks"
-import { exportDB } from "~/database"
 import { ipcServices } from "~/lib/client"
 import { queryClient } from "~/lib/query-client"
 import { clearLocalPersistStoreData } from "~/store/utils/clear"

apps/mobile/src/initialize/index.ts

@@ -1,4 +1,4 @@
-import { initializeDb } from "@follow/database/db"
+import { initializeDB } from "@follow/database/db"
 import { hydrateDatabaseToStore } from "@follow/store/hydrate"
 import { tracker } from "@follow/tracker"
 import { nativeApplicationVersion } from "expo-application"
@@ -21,7 +21,7 @@ export const initializeApp = async () => {
   const now = Date.now()
 
   await initDeviceType()
-  initializeDb()
+  initializeDB()
 
   await apm("migrateDatabase", migrateDatabase)
   initializeDayjs()

apps/mobile/src/initialize/migration.ts

@@ -1,4 +1,4 @@
-import { migrateDb } from "@follow/database/db"
+import { migrateDB } from "@follow/database/db"
 import { useSyncExternalStore } from "react"
 
 let storeChangeFn: () => void
@@ -16,7 +16,7 @@ const migrateStore = {
 
 export const migrateDatabase = async () => {
   try {
-    await migrateDb()
+    await migrateDB()
     migrateStore.success = true
     storeChangeFn?.()
   } catch (error) {

locales/settings/en.json

@@ -214,7 +214,7 @@
   "general.export_data.title": "Export Data",
   "general.export_database.button": "Export",
   "general.export_database.description": "Export all your data, including articles (Full Backup).",
-  "general.export_database.label": "Export Database (JSON)",
+  "general.export_database.label": "Export Database",
   "general.group_by_date.description": "Group entries by date.",
   "general.group_by_date.label": "Group by date",
   "general.hide_all_read_subscriptions.description": "Hide subscriptions without unread entries in the subscription list.",

locales/settings/zh-CN.json

@@ -206,7 +206,7 @@
   "general.export_data.title": "导出数据",
   "general.export_database.button": "导出",
   "general.export_database.description": "导出你的所有数据，包括文章（完整备份）。",
-  "general.export_database.label": "导出数据库 (JSON)",
+  "general.export_database.label": "导出数据库",
   "general.group_by_date.description": "按日期对条目进行分组。",
   "general.group_by_date.label": "按日期分组",
   "general.hide_all_read_subscriptions.description": "在订阅列表中隐藏没有未读条目的订阅。",

packages/internal/database/src/db.desktop.ts

@@ -21,15 +21,15 @@ export const sqlite = new SQLocalDrizzle(dbName)
 
 let db: SqliteRemoteDatabase<typeof schema>
 
-export function initializeDb() {
+export function initializeDB() {
   db = drizzle(sqlite.driver, sqlite.batchDriver, {
     schema,
     logger: false,
   })
 }
 export { db }
 
-export async function migrateDb() {
+export async function migrateDB() {
   try {
     await migrate(db, migrations)
   } catch (error) {
@@ -39,3 +39,16 @@ export async function migrateDb() {
     await migrate(db, migrations)
   }
 }
+
+export async function exportDB() {
+  const databaseFile = await sqlite.getDatabaseFile()
+  const fileUrl = URL.createObjectURL(databaseFile)
+
+  const a = document.createElement("a")
+  a.href = fileUrl
+  a.download = "database.sqlite3"
+  a.click()
+  a.remove()
+
+  URL.revokeObjectURL(fileUrl)
+}

packages/internal/database/src/db.rn.ts

@@ -13,15 +13,15 @@ let db: ExpoSQLiteDatabase<typeof schema> & {
   $client: SQLite.SQLiteDatabase
 }
 
-export function initializeDb() {
+export function initializeDB() {
   db = drizzle(sqlite, {
     schema,
     logger: false,
   })
 }
 export { db }
 
-export async function migrateDb(): Promise<void> {
+export async function migrateDB(): Promise<void> {
   try {
     await migrate(db, migrations)
   } catch (error) {
@@ -33,7 +33,9 @@ export async function migrateDb(): Promise<void> {
     }
     await SQLite.deleteDatabaseAsync(SQLITE_DB_NAME)
     sqlite = SQLite.openDatabaseSync(SQLITE_DB_NAME)
-    initializeDb()
+    initializeDB()
     await migrate(db, migrations)
   }
 }
+
+export async function exportDB() {}

packages/internal/database/src/db.ts

@@ -2,5 +2,6 @@ import type { DB } from "./types"
 
 export declare const sqlite: unknown
 export declare const db: DB
-export declare function initializeDb(): void
-export declare function migrateDb(): Promise<void>
+export declare function initializeDB(): void
+export declare function migrateDB(): Promise<void>
+export declare function exportDB(): Promise<Blob>