fix(electron): export and import (#9767)

packages/frontend/apps/electron/test/db/ensure-db.spec.ts

@@ -1,105 +0,0 @@
-import path from 'node:path';
-import { setTimeout } from 'node:timers/promises';
-
-import fs from 'fs-extra';
-import { v4 } from 'uuid';
-import { afterAll, afterEach, beforeEach, expect, test, vi } from 'vitest';
-
-const tmpDir = path.join(__dirname, 'tmp');
-const appDataPath = path.join(tmpDir, 'app-data');
-
-vi.doMock('@affine/electron/helper/main-rpc', () => ({
-  mainRPC: {
-    getPath: async () => appDataPath,
-  },
-}));
-
-const constructorStub = vi.fn();
-const destroyStub = vi.fn();
-destroyStub.mockReturnValue(Promise.resolve());
-
-function existProcess() {
-  process.emit('beforeExit', 0);
-}
-
-vi.doMock('@affine/electron/helper/db/secondary-db', () => {
-  return {
-    SecondaryWorkspaceSQLiteDB: class {
-      constructor(...args: any[]) {
-        constructorStub(...args);
-      }
-
-      connectIfNeeded = () => Promise.resolve();
-
-      pull = () => Promise.resolve();
-
-      destroy = destroyStub;
-    },
-  };
-});
-
-beforeEach(() => {
-  vi.useFakeTimers({ shouldAdvanceTime: true });
-});
-
-afterEach(async () => {
-  existProcess();
-  try {
-    await fs.remove(tmpDir);
-  } catch (e) {
-    console.error(e);
-  }
-  vi.useRealTimers();
-});
-
-afterAll(() => {
-  vi.doUnmock('@affine/electron/helper/main-rpc');
-});
-
-test('can get a valid WorkspaceSQLiteDB', async () => {
-  const { ensureSQLiteDB } = await import(
-    '@affine/electron/helper/nbstore/v1/ensure-db'
-  );
-  const workspaceId = v4();
-  const db0 = await ensureSQLiteDB('workspace', workspaceId);
-  expect(db0).toBeDefined();
-  expect(db0.workspaceId).toBe(workspaceId);
-
-  const db1 = await ensureSQLiteDB('workspace', v4());
-  expect(db1).not.toBe(db0);
-  expect(db1.workspaceId).not.toBe(db0.workspaceId);
-
-  // ensure that the db is cached
-  expect(await ensureSQLiteDB('workspace', workspaceId)).toBe(db0);
-});
-
-test('db should be destroyed when app quits', async () => {
-  const { ensureSQLiteDB } = await import(
-    '@affine/electron/helper/nbstore/v1/ensure-db'
-  );
-  const workspaceId = v4();
-  const db0 = await ensureSQLiteDB('workspace', workspaceId);
-  const db1 = await ensureSQLiteDB('workspace', v4());
-
-  expect(db0.adapter).not.toBeNull();
-  expect(db1.adapter).not.toBeNull();
-
-  existProcess();
-
-  // wait the async `db.destroy()` to be called
-  await setTimeout(100);
-
-  expect(db0.adapter.db).toBeNull();
-  expect(db1.adapter.db).toBeNull();
-});
-
-test('db should be removed in db$Map after destroyed', async () => {
-  const { ensureSQLiteDB, db$Map } = await import(
-    '@affine/electron/helper/nbstore/v1/ensure-db'
-  );
-  const workspaceId = v4();
-  const db = await ensureSQLiteDB('workspace', workspaceId);
-  await db.destroy();
-  await setTimeout(100);
-  expect(db$Map.has(`workspace:${workspaceId}`)).toBe(false);
-});

packages/frontend/apps/electron/test/db/workspace-db-adapter.spec.ts

@@ -1,59 +0,0 @@
-import path from 'node:path';
-
-import fs from 'fs-extra';
-import { v4 } from 'uuid';
-import { afterAll, afterEach, beforeAll, expect, test, vi } from 'vitest';
-
-const tmpDir = path.join(__dirname, 'tmp');
-const appDataPath = path.join(tmpDir, 'app-data');
-
-beforeAll(() => {
-  vi.doMock('@affine/electron/helper/main-rpc', () => ({
-    mainRPC: {
-      getPath: async () => appDataPath,
-    },
-  }));
-});
-
-afterEach(async () => {
-  try {
-    await fs.remove(tmpDir);
-  } catch (e) {
-    console.error(e);
-  }
-});
-
-afterAll(() => {
-  vi.doUnmock('@affine/electron/helper/main-rpc');
-});
-
-test('can create new db file if not exists', async () => {
-  const { openWorkspaceDatabase } = await import(
-    '@affine/electron/helper/nbstore/v1/workspace-db-adapter'
-  );
-  const workspaceId = v4();
-  const db = await openWorkspaceDatabase('workspace', workspaceId);
-  const dbPath = path.join(
-    appDataPath,
-    `workspaces/${workspaceId}`,
-    `storage.db`
-  );
-  expect(await fs.exists(dbPath)).toBe(true);
-  await db.destroy();
-});
-
-test('on destroy, check if resources have been released', async () => {
-  const { openWorkspaceDatabase } = await import(
-    '@affine/electron/helper/nbstore/v1/workspace-db-adapter'
-  );
-  const workspaceId = v4();
-  const db = await openWorkspaceDatabase('workspace', workspaceId);
-  const updateSub = {
-    complete: vi.fn(),
-    next: vi.fn(),
-  };
-  db.update$ = updateSub as any;
-  await db.destroy();
-  expect(db.adapter.db).toBe(null);
-  expect(updateSub.complete).toHaveBeenCalled();
-});

packages/frontend/apps/electron/test/workspace/handlers.spec.ts

@@ -1,5 +1,6 @@
 import path from 'node:path';
 
+import { universalId } from '@affine/nbstore';
 import fs from 'fs-extra';
 import { v4 } from 'uuid';
 import { afterAll, afterEach, describe, expect, test, vi } from 'vitest';
@@ -31,15 +32,22 @@ afterAll(() => {
   vi.doUnmock('@affine/electron/helper/main-rpc');
 });
 
-describe('delete workspace', () => {
-  test('deleteWorkspace', async () => {
-    const { deleteWorkspace } = await import(
+describe('workspace db management', () => {
+  test('trash workspace', async () => {
+    const { trashWorkspace } = await import(
       '@affine/electron/helper/workspace/handlers'
     );
     const workspaceId = v4();
-    const workspacePath = path.join(appDataPath, 'workspaces', workspaceId);
+    const workspacePath = path.join(
+      appDataPath,
+      'workspaces',
+      'local',
+      workspaceId
+    );
     await fs.ensureDir(workspacePath);
-    await deleteWorkspace(workspaceId);
+    await trashWorkspace(
+      universalId({ peer: 'local', type: 'workspace', id: workspaceId })
+    );
     expect(await fs.pathExists(workspacePath)).toBe(false);
     // removed workspace will be moved to deleted-workspaces
     expect(
@@ -48,78 +56,28 @@ describe('delete workspace', () => {
       )
     ).toBe(true);
   });
-});
 
-describe('getWorkspaceMeta', () => {
-  test('can get meta', async () => {
-    const { getWorkspaceMeta } = await import(
-      '@affine/electron/helper/workspace/meta'
+  test('delete workspace', async () => {
+    const { deleteWorkspace } = await import(
+      '@affine/electron/helper/workspace/handlers'
     );
     const workspaceId = v4();
-    const workspacePath = path.join(appDataPath, 'workspaces', workspaceId);
-    const meta = {
-      id: workspaceId,
-    };
-    await fs.ensureDir(workspacePath);
-    await fs.writeJSON(path.join(workspacePath, 'meta.json'), meta);
-    expect(await getWorkspaceMeta('workspace', workspaceId)).toEqual(meta);
-  });
-
-  test('can create meta if not exists', async () => {
-    const { getWorkspaceMeta } = await import(
-      '@affine/electron/helper/workspace/meta'
+    const workspacePath = path.join(
+      appDataPath,
+      'workspaces',
+      'local',
+      workspaceId
     );
-    const workspaceId = v4();
-    const workspacePath = path.join(appDataPath, 'workspaces', workspaceId);
     await fs.ensureDir(workspacePath);
-    expect(await getWorkspaceMeta('workspace', workspaceId)).toEqual({
-      id: workspaceId,
-      mainDBPath: path.join(workspacePath, 'storage.db'),
-      type: 'workspace',
-    });
+    await deleteWorkspace(
+      universalId({ peer: 'local', type: 'workspace', id: workspaceId })
+    );
+    expect(await fs.pathExists(workspacePath)).toBe(false);
+    // deleted workspace will remove it permanently
     expect(
-      await fs.pathExists(path.join(workspacePath, 'meta.json'))
-    ).toBeTruthy();
-  });
-
-  test('can migrate meta if db file is a link', async () => {
-    const { getWorkspaceMeta } = await import(
-      '@affine/electron/helper/workspace/meta'
-    );
-    const workspaceId = v4();
-    const workspacePath = path.join(appDataPath, 'workspaces', workspaceId);
-    await fs.ensureDir(workspacePath);
-    const sourcePath = path.join(tmpDir, 'source.db');
-    await fs.writeFile(sourcePath, 'test');
-
-    await fs.ensureSymlink(sourcePath, path.join(workspacePath, 'storage.db'));
-
-    expect(await getWorkspaceMeta('workspace', workspaceId)).toEqual({
-      id: workspaceId,
-      mainDBPath: path.join(workspacePath, 'storage.db'),
-      type: 'workspace',
-    });
-
-    expect(
-      await fs.pathExists(path.join(workspacePath, 'meta.json'))
-    ).toBeTruthy();
+      await fs.pathExists(
+        path.join(appDataPath, 'deleted-workspaces', workspaceId)
+      )
+    ).toBe(false);
   });
 });
-
-test('storeWorkspaceMeta', async () => {
-  const { storeWorkspaceMeta } = await import(
-    '@affine/electron/helper/workspace/handlers'
-  );
-  const workspaceId = v4();
-  const workspacePath = path.join(appDataPath, 'workspaces', workspaceId);
-  await fs.ensureDir(workspacePath);
-  const meta = {
-    id: workspaceId,
-    mainDBPath: path.join(workspacePath, 'storage.db'),
-    type: 'workspace',
-  };
-  await storeWorkspaceMeta(workspaceId, meta);
-  expect(await fs.readJSON(path.join(workspacePath, 'meta.json'))).toEqual(
-    meta
-  );
-});