v0.6.0-canary.8

Co-authored-by: Himself65 <himself65@outlook.com>

.commitlintrc.json

@@ -17,7 +17,7 @@
         "hooks",
         "i18n",
         "jotai",
-        "octobase-node",
+        "native",
         "templates",
         "y-indexeddb",
         "debug",

.eslintrc.js

@@ -34,6 +34,7 @@ const config = {
     'simple-import-sort',
     'import',
     'unused-imports',
+    'unicorn',
   ],
   rules: {
     'no-undef': 'off',
@@ -74,6 +75,13 @@ const config = {
         ],
       },
     ],
+    'unicorn/filename-case': [
+      'error',
+      {
+        case: 'kebabCase',
+        ignore: ['^\\[[a-zA-Z0-9-_]+\\]\\.tsx$'],
+      },
+    ],
   },
   overrides: [
     {

.github/CLA.md

@@ -58,3 +58,4 @@ Example:
 - Howard Do, @howarddo2208, 2023/04/20
 - 三咲智子 Kevin Deng, @sxzz, 2023/04/21
 - Moeyua, @moeyua, 2023/04/22
+- Shishu, @shishudesu, 2023/05/19

.github/actions/build-rust/action.yml

@@ -0,0 +1,49 @@
+name: 'AFFiNE Rust build'
+description: 'Rust build setup, including cache configuration'
+inputs:
+  target:
+    description: 'Cargo target'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Rust
+      uses: dtolnay/rust-toolchain@stable
+      with:
+        toolchain: stable
+        targets: ${{ inputs.target }}
+
+    - name: Cache cargo
+      uses: actions/cache@v3
+      with:
+        path: |
+          ~/.cargo/registry/index/
+          ~/.cargo/registry/cache/
+          ~/.cargo/git/db/
+          .cargo-cache
+          target/${{ inputs.target }}
+        key: stable-${{ inputs.target }}-cargo-cache
+
+    - name: Build
+      if: ${{ inputs.target != 'x86_64-unknown-linux-gnu' && inputs.target != 'aarch64-unknown-linux-gnu' }}
+      shell: bash
+      run: yarn workspace @affine/native build --target ${{ inputs.target }}
+      env:
+        CARGO_BUILD_INCREMENTAL: 'false'
+
+    - name: Build
+      if: ${{ inputs.target == 'x86_64-unknown-linux-gnu' }}
+      uses: addnab/docker-run-action@v3
+      with:
+        image: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
+        options: --user 0:0 -e CARGO_BUILD_INCREMENTAL=false -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v ${{ github.workspace }}:/build -w /build
+        run: yarn workspace @affine/native build --target ${{ inputs.target }}
+
+    - name: Build
+      if: ${{ inputs.target == 'aarch64-unknown-linux-gnu' }}
+      uses: addnab/docker-run-action@v3
+      with:
+        image: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian-aarch64
+        options: --user 0:0 -e CARGO_BUILD_INCREMENTAL=false -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v ${{ github.workspace }}:/build -w /build
+        run: yarn workspace @affine/native build --target ${{ inputs.target }}

.github/labeler.yml

@@ -15,8 +15,6 @@ mod:dev:
 
 mod:workspace: 'packages/workspace/**/*'
 
-mod:theme: 'packages/theme/**/*'
-
 mod:i18n: 'packages/i18n/**/*'
 
 mod:env: 'packages/env/**/*'

.github/workflows/add-to-project.yml

@@ -1,24 +0,0 @@
-name: Add to GitHub projects
-
-on:
-  issues:
-    types:
-      - opened
-  pull_request_target:
-    types:
-      - opened
-      - reopened
-
-jobs:
-  add-to-project:
-    name: Add issues and pull requests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.4.0
-        with:
-          # You can target a repository in a different organization
-          # to the issue
-          project-url: https://github.com/orgs/toeverything/projects/10
-          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
-          # labeled: bug, needs-triage
-          # label-operator: OR

.github/workflows/build.yml

@@ -4,9 +4,26 @@ on:
   push:
     branches:
       - master
+      - v[0-9]+.[0-9]+.x-staging
+      - v[0-9]+.[0-9]+.x
+    paths-ignore:
+      - README.md
+      - .github/**
+      - '!.github/workflows/build.yml'
   pull_request:
     branches:
       - master
+      - v[0-9]+.[0-9]+.x-staging
+      - v[0-9]+.[0-9]+.x
+    paths-ignore:
+      - README.md
+      - .github/**
+      - '!.github/workflows/build.yml'
+
+env:
+  DEBUG: napi:*
+  APP_NAME: affine
+  MACOSX_DEPLOYMENT_TARGET: '10.13'
 
 jobs:
   lint:
@@ -18,7 +35,9 @@ jobs:
       - uses: actions/checkout@v3
       - name: Setup Node.js
         uses: ./.github/actions/setup-node
-      - run: yarn lint --max-warnings=0
+      - run: |
+          yarn lint --max-warnings=0
+          yarn circular
 
   build-storybook:
     name: Build Storybook
@@ -37,23 +56,6 @@ jobs:
           path: ./packages/component/storybook-static
           if-no-files-found: error
 
-  build-electron:
-    name: Build @affine/electron
-    runs-on: ubuntu-latest
-    environment: development
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: ./.github/actions/setup-node
-      - name: Build Electron
-        working-directory: apps/electron
-        run: yarn exec ts-node-esm ./scripts/build-ci.mts
-      - name: Upload Ubuntu desktop artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: affine-ubuntu
-          path: ./apps/electron/dist
-
   build:
     name: Build @affine/web
     runs-on: ubuntu-latest
@@ -261,7 +263,7 @@ jobs:
 
       - name: Upload test results
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: test-results-e2e-${{ matrix.shard }}
           path: ./test-results
@@ -269,20 +271,63 @@ jobs:
 
   dekstop-test:
     name: Desktop Test
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.spec.os }}
     environment: development
-    needs: [build, build-electron]
+    strategy:
+      fail-fast: false
+      # all combinations: macos-latest x64, macos-latest arm64, windows-latest x64, ubuntu-latest x64
+      matrix:
+        spec:
+          - {
+              os: macos-latest,
+              platform: macos,
+              arch: x64,
+              target: x86_64-apple-darwin,
+              test: true,
+            }
+          - {
+              os: macos-latest,
+              platform: macos,
+              arch: arm64,
+              target: aarch64-apple-darwin,
+              test: false,
+            }
+          - {
+              os: ubuntu-latest,
+              platform: linux,
+              arch: x64,
+              target: x86_64-unknown-linux-gnu,
+              test: true,
+            }
+          - {
+              os: windows-latest,
+              platform: windows,
+              arch: x64,
+              target: x86_64-pc-windows-msvc,
+              test: true,
+            }
+    needs: [build]
     steps:
       - uses: actions/checkout@v3
       - name: Setup Node.js
         uses: ./.github/actions/setup-node
         with:
           playwright-install: true
-      - name: Download Ubuntu desktop artifact
-        uses: actions/download-artifact@v3
+      - name: Build AFFiNE native
+        uses: ./.github/actions/build-rust
         with:
-          name: affine-ubuntu
-          path: ./apps/electron/dist
+          target: ${{ matrix.spec.target }}
+      - name: Run unit tests
+        if: ${{ matrix.spec.test }}
+        shell: bash
+        run: |
+          rm -rf apps/electron/node_modules/better-sqlite3/build
+          yarn --cwd apps/electron/node_modules/better-sqlite3 run install
+          yarn test:unit
+        env:
+          NATIVE_TEST: 'true'
+      - name: Build layers
+        run: yarn workspace @affine/electron build-layers
 
       - name: Download static resource artifact
         uses: actions/download-artifact@v3
@@ -290,15 +335,43 @@ jobs:
           name: next-js-static
           path: ./apps/electron/resources/web-static
 
+      - name: Rebuild Electron dependences
+        shell: bash
+        run: |
+          rm -rf apps/electron/node_modules/better-sqlite3/build
+          yarn workspace @affine/electron rebuild:for-electron --arch=${{ matrix.spec.arch }}
+
       - name: Run desktop tests
-        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test
-        working-directory: apps/electron
+        if: ${{ matrix.spec.test && matrix.spec.os == 'ubuntu-latest' }}
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn workspace @affine/electron test
+        env:
+          COVERAGE: true
+
+      - name: Run desktop tests
+        if: ${{ matrix.spec.test && matrix.spec.os != 'ubuntu-latest' }}
+        run: yarn workspace @affine/electron test
+        env:
+          COVERAGE: true
+
+      - name: Collect code coverage report
+        if: ${{ matrix.spec.test }}
+        run: yarn exec nyc report -t .nyc_output --report-dir .coverage --reporter=lcov
+
+      - name: Upload e2e test coverage results
+        if: ${{ matrix.spec.test }}
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./.coverage/lcov.info
+          flags: e2etest-${{ matrix.spec.os }}-${{ matrix.spec.arch }}
+          name: affine
+          fail_ci_if_error: true
 
       - name: Upload test results
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
-          name: test-results-e2e-${{ matrix.shard }}
+          name: test-results-e2e-${{ matrix.spec.os }}-${{ matrix.spec.arch }}
           path: ./test-results
           if-no-files-found: ignore
 

.github/workflows/nightly-build.yml

@@ -0,0 +1,232 @@
+name: Build Canary Desktop App on Staging Branch
+
+on:
+  push:
+    branches:
+      - v[0-9]+.[0-9]+.x-staging
+    paths-ignore:
+      - README.md
+      - .github/**
+      - '!.github/workflows/nightly-build.yml'
+
+permissions:
+  actions: write
+  contents: write
+  security-events: write
+
+concurrency:
+  # The concurrency group contains the workflow name and the branch name for
+  # pull requests or the commit hash for any other events.
+  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
+  cancel-in-progress: true
+
+env:
+  BUILD_TYPE: internal
+
+jobs:
+  set-build-version:
+    runs-on: ubuntu-latest
+    environment: production
+    outputs:
+      version: 0.0.0-${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: toeverything/set-build-version@latest
+      - id: version
+        run: echo ::set-output name=version::${{ env.BUILD_VERSION }}
+
+  before-make:
+    runs-on: ubuntu-latest
+    environment: production
+    needs:
+      - set-build-version
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+      - name: Replace Version
+        run: ./scripts/set-version.sh ${{ needs.set-build-version.outputs.version }}
+      - name: generate-assets
+        working-directory: apps/electron
+        run: yarn generate-assets
+        env:
+          NEXT_PUBLIC_FIREBASE_API_KEY: ${{ secrets.NEXT_PUBLIC_FIREBASE_API_KEY }}
+          NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN: ${{ secrets.NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN }}
+          NEXT_PUBLIC_FIREBASE_PROJECT_ID: ${{ secrets.NEXT_PUBLIC_FIREBASE_PROJECT_ID }}
+          NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET: ${{ secrets.NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET }}
+          NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID: ${{ secrets.NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID }}
+          NEXT_PUBLIC_FIREBASE_APP_ID: ${{ secrets.NEXT_PUBLIC_FIREBASE_APP_ID }}
+          NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID: ${{ secrets.NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID }}
+          AFFINE_GOOGLE_CLIENT_ID: ${{ secrets.AFFINE_GOOGLE_CLIENT_ID }}
+          AFFINE_GOOGLE_CLIENT_SECRET: ${{ secrets.AFFINE_GOOGLE_CLIENT_SECRET }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
+          NEXT_PUBLIC_SENTRY_DSN: ${{ secrets.NEXT_PUBLIC_SENTRY_DSN }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          API_SERVER_PROFILE: prod
+          ENABLE_TEST_PROPERTIES: false
+          ENABLE_IMAGE_PREVIEW_MODAL: false
+          RELEASE_VERSION: ${{ needs.set-build-version.outputs.version }}
+
+      - name: Upload Artifact (web-static)
+        uses: actions/upload-artifact@v3
+        with:
+          name: before-make-web-static
+          path: apps/electron/resources/web-static
+
+  make-distribution:
+    environment: production
+    strategy:
+      # all combinations: macos-latest x64, macos-latest arm64, windows-latest x64, ubuntu-latest x64
+      matrix:
+        spec:
+          - {
+              os: macos-latest,
+              platform: darwin,
+              arch: x64,
+              target: x86_64-apple-darwin,
+            }
+          - {
+              os: macos-latest,
+              platform: darwin,
+              arch: arm64,
+              target: aarch64-apple-darwin,
+            }
+          - {
+              os: ubuntu-latest,
+              platform: linux,
+              arch: x64,
+              target: x86_64-unknown-linux-gnu,
+            }
+          - {
+              os: windows-latest,
+              platform: win32,
+              arch: x64,
+              target: x86_64-pc-windows-msvc,
+            }
+    runs-on: ${{ matrix.spec.os }}
+    needs:
+      - before-make
+      - set-build-version
+    env:
+      APPLE_ID: ${{ secrets.APPLE_ID }}
+      APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
+      APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
+      SKIP_GENERATE_ASSETS: 1
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+      - name: Build AFFiNE native
+        uses: ./.github/actions/build-rust
+        with:
+          target: ${{ matrix.spec.target }}
+      - name: Replace Version
+        run: ./scripts/set-version.sh ${{ needs.set-build-version.outputs.version }}
+      - uses: actions/download-artifact@v3
+        with:
+          name: before-make-web-static
+          path: apps/electron/resources/web-static
+      - name: Rebuild Electron dependences
+        shell: bash
+        run: |
+          rm -rf apps/electron/node_modules/better-sqlite3/build
+          yarn workspace @affine/electron rebuild:for-electron --arch=${{ matrix.spec.arch }}
+
+      - name: Build layers
+        run: yarn workspace @affine/electron build-layers
+
+      - name: Signing By Apple Developer ID
+        if: ${{ matrix.spec.platform == 'darwin' }}
+        uses: apple-actions/import-codesign-certs@v2
+        with:
+          p12-file-base64: ${{ secrets.CERTIFICATES_P12 }}
+          p12-password: ${{ secrets.CERTIFICATES_P12_PASSWORD }}
+
+      - name: make
+        run: yarn workspace @affine/electron make --platform=${{ matrix.spec.platform }} --arch=${{ matrix.spec.arch }}
+
+      - name: Save artifacts (mac)
+        if: ${{ matrix.spec.platform == 'darwin' }}
+        run: |
+          mkdir -p builds
+          mv apps/electron/out/*/make/*.dmg ./builds/affine-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.dmg
+          mv apps/electron/out/*/make/zip/darwin/${{ matrix.spec.arch }}/*.zip ./builds/affine-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.zip
+      - name: Save artifacts (windows)
+        if: ${{ matrix.spec.platform == 'win32' }}
+        run: |
+          mkdir -p builds
+          mv apps/electron/out/*/make/zip/win32/x64/AFFiNE*-win32-x64-*.zip ./builds/affine-${{ env.BUILD_TYPE }}-windows-x64.zip
+          mv apps/electron/out/*/make/squirrel.windows/x64/*.exe ./builds/affine-${{ env.BUILD_TYPE }}-windows-x64.exe
+          mv apps/electron/out/*/make/squirrel.windows/x64/*.msi ./builds/affine-${{ env.BUILD_TYPE }}-windows-x64.msi
+          mv apps/electron/out/*/make/squirrel.windows/x64/*.nupkg ./builds/affine-${{ env.BUILD_TYPE }}-windows-x64.nupkg
+
+      - name: Save artifacts (linux)
+        if: ${{ matrix.spec.platform == 'linux' }}
+        run: |
+          mkdir -p builds
+          mv apps/electron/out/*/make/zip/linux/x64/*.zip ./builds/affine-${{ env.BUILD_TYPE }}-linux-x64.zip
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: affine-${{ matrix.spec.platform }}-${{ matrix.spec.arch }}-builds
+          path: builds
+
+  release:
+    needs:
+      - make-distribution
+      - set-build-version
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download Artifacts (macos-x64)
+        uses: actions/download-artifact@v3
+        with:
+          name: affine-darwin-x64-builds
+          path: ./
+      - name: Download Artifacts (macos-arm64)
+        uses: actions/download-artifact@v3
+        with:
+          name: affine-darwin-arm64-builds
+          path: ./
+      - name: Download Artifacts (windows-x64)
+        uses: actions/download-artifact@v3
+        with:
+          name: affine-win32-x64-builds
+          path: ./
+      - name: Download Artifacts (linux-x64)
+        uses: actions/download-artifact@v3
+        with:
+          name: affine-linux-x64-builds
+          path: ./
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Generate Release yml
+        run: |
+          cp ./apps/electron/scripts/generate-yml.js .
+          node generate-yml.js
+        env:
+          RELEASE_VERSION: ${{ needs.set-build-version.outputs.version }}
+      - name: Create Release Draft
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+        with:
+          repository: 'toeverything/AFFiNE-Releases'
+          name: ${{ needs.set-build-version.outputs.version }}
+          tag_name: ${{ needs.set-build-version.outputs.version }}
+          prerelease: true
+          files: |
+            ./VERSION
+            ./*.zip
+            ./*.dmg
+            ./*.exe
+            ./*.nupkg
+            ./RELEASES
+            ./*.AppImage
+            ./*.apk
+            ./*.yml

.github/workflows/release-desktop-app.yml

@@ -36,6 +36,9 @@ concurrency:
 
 env:
   BUILD_TYPE: ${{ github.event.inputs.build-type }}
+  DEBUG: napi:*
+  APP_NAME: affine
+  MACOSX_DEPLOYMENT_TARGET: '10.13'
 
 jobs:
   before-make:
@@ -46,8 +49,7 @@ jobs:
       - name: Setup Node.js
         uses: ./.github/actions/setup-node
       - name: generate-assets
-        working-directory: apps/electron
-        run: yarn generate-assets
+        run: yarn workspace @affine/electron generate-assets
         env:
           NEXT_PUBLIC_FIREBASE_API_KEY: ${{ secrets.NEXT_PUBLIC_FIREBASE_API_KEY }}
           NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN: ${{ secrets.NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN }}
@@ -64,6 +66,8 @@ jobs:
           SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
           API_SERVER_PROFILE: prod
           ENABLE_TEST_PROPERTIES: false
+          ENABLE_IMAGE_PREVIEW_MODAL: false
+          RELEASE_VERSION: ${{ github.event.inputs.version }}
 
       - name: Upload Artifact (web-static)
         uses: actions/upload-artifact@v3
@@ -71,28 +75,36 @@ jobs:
           name: before-make-web-static
           path: apps/electron/resources/web-static
 
-      - name: Upload Artifact (electron dist)
-        uses: actions/upload-artifact@v3
-        with:
-          name: before-make-electron-dist
-          path: apps/electron/dist
-
-      - name: Upload YML Build Script
-        uses: actions/upload-artifact@v3
-        with:
-          name: release-yml-build-script
-          path: apps/electron/scripts/generate-yml.js
-
   make-distribution:
     environment: ${{ github.ref_name == 'master' && 'production' || 'development' }}
     strategy:
       # all combinations: macos-latest x64, macos-latest arm64, windows-latest x64, ubuntu-latest x64
       matrix:
         spec:
-          - { os: macos-latest, platform: macos, arch: x64 }
-          - { os: macos-latest, platform: macos, arch: arm64 }
-          - { os: ubuntu-latest, platform: linux, arch: x64 }
-          - { os: windows-latest, platform: windows, arch: x64 }
+          - {
+              os: macos-latest,
+              platform: darwin,
+              arch: x64,
+              target: x86_64-apple-darwin,
+            }
+          - {
+              os: macos-latest,
+              platform: darwin,
+              arch: arm64,
+              target: aarch64-apple-darwin,
+            }
+          - {
+              os: ubuntu-latest,
+              platform: linux,
+              arch: x64,
+              target: x86_64-unknown-linux-gnu,
+            }
+          - {
+              os: windows-latest,
+              platform: win32,
+              arch: x64,
+              target: x86_64-pc-windows-msvc,
+            }
     runs-on: ${{ matrix.spec.os }}
     needs: before-make
     env:
@@ -104,34 +116,42 @@ jobs:
       - uses: actions/checkout@v3
       - name: Setup Node.js
         uses: ./.github/actions/setup-node
+      - name: Build AFFiNE native
+        uses: ./.github/actions/build-rust
+        with:
+          target: ${{ matrix.spec.target }}
       - uses: actions/download-artifact@v3
         with:
           name: before-make-web-static
           path: apps/electron/resources/web-static
-      - uses: actions/download-artifact@v3
-        with:
-          name: before-make-electron-dist
-          path: apps/electron/dist
+
+      - name: Rebuild Electron dependences
+        shell: bash
+        run: |
+          rm -rf apps/electron/node_modules/better-sqlite3/build
+          yarn workspace @affine/electron rebuild:for-electron --arch=${{ matrix.spec.arch }}
+
+      - name: Build layers
+        run: yarn workspace @affine/electron build-layers
 
       - name: Signing By Apple Developer ID
-        if: ${{ matrix.spec.platform == 'macos' }}
+        if: ${{ matrix.spec.platform == 'darwin' }}
         uses: apple-actions/import-codesign-certs@v2
         with:
           p12-file-base64: ${{ secrets.CERTIFICATES_P12 }}
           p12-password: ${{ secrets.CERTIFICATES_P12_PASSWORD }}
 
       - name: make
-        run: yarn make-${{ matrix.spec.platform }}-${{ matrix.spec.arch }}
-        working-directory: apps/electron
+        run: yarn workspace @affine/electron make --platform=${{ matrix.spec.platform }} --arch=${{ matrix.spec.arch }}
 
       - name: Save artifacts (mac)
-        if: ${{ matrix.spec.platform == 'macos' }}
+        if: ${{ matrix.spec.platform == 'darwin' }}
         run: |
           mkdir -p builds
           mv apps/electron/out/*/make/*.dmg ./builds/affine-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.dmg
           mv apps/electron/out/*/make/zip/darwin/${{ matrix.spec.arch }}/*.zip ./builds/affine-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.zip
       - name: Save artifacts (windows)
-        if: ${{ matrix.spec.platform == 'windows' }}
+        if: ${{ matrix.spec.platform == 'win32' }}
         run: |
           mkdir -p builds
           mv apps/electron/out/*/make/zip/win32/x64/AFFiNE*-win32-x64-*.zip ./builds/affine-${{ env.BUILD_TYPE }}-windows-x64.zip
@@ -156,37 +176,36 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - uses: actions/checkout@v3
       - name: Download Artifacts (macos-x64)
         uses: actions/download-artifact@v3
         with:
-          name: affine-macos-x64-builds
+          name: affine-darwin-x64-builds
           path: ./
       - name: Download Artifacts (macos-arm64)
         uses: actions/download-artifact@v3
         with:
-          name: affine-macos-arm64-builds
+          name: affine-darwin-arm64-builds
           path: ./
       - name: Download Artifacts (windows-x64)
         uses: actions/download-artifact@v3
         with:
-          name: affine-windows-x64-builds
+          name: affine-win32-x64-builds
           path: ./
       - name: Download Artifacts (linux-x64)
         uses: actions/download-artifact@v3
         with:
           name: affine-linux-x64-builds
           path: ./
-      - name: Download Artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: release-yml-build-script
-          path: ./
       - uses: actions/setup-node@v3
         with:
           node-version: 18
       - name: Generate Release yml
         run: |
-          RELEASE_VERSION=${{ github.event.inputs.version }} node generate-yml.js
+          cp ./apps/electron/scripts/generate-yml.js .
+          node generate-yml.js
+        env:
+          RELEASE_VERSION: ${{ github.event.inputs.version }}
       - name: Create Release Draft
         uses: softprops/action-gh-release@v1
         env:

.gitignore

@@ -28,9 +28,9 @@ node_modules
 
 # IDE - VSCode
 .vscode/*
-!.vscode/settings.json
 !.vscode/tasks.json
-!.vscode/launch.json
+!.vscode/settings.template.json
+!.vscode/launch.template.json
 !.vscode/extensions.json
 
 # misc
@@ -57,7 +57,7 @@ Thumbs.db
 .next
 out/
 storybook-static
-i18n_generated.ts
+i18n-generated.ts
 
 /test-results/
 /playwright-report/
@@ -66,3 +66,7 @@ i18n_generated.ts
 # Cache
 .eslintcache
 next-env.d.ts
+
+# Rust
+target
+*.node

.i18n-codegen.json

@@ -4,7 +4,7 @@
   "list": [
     {
       "input": "./packages/i18n/src/resources/en.json",
-      "output": "./packages/i18n/src/i18n_generated",
+      "output": "./packages/i18n/src/i18n-generated",
       "parser": {
         "type": "i18next",
         "contextSeparator": "$",

.taplo.toml

@@ -0,0 +1,9 @@
+exclude = ["node_modules/**/*.toml"]
+
+[[rule]]
+keys = ["dependencies", "*-dependencies"]
+
+[rule.formatting]
+align_entries = true
+indent_tables = true
+reorder_keys = true

.vscode/launch.template.json

@@ -6,6 +6,12 @@
       "name": "Run Dev",
       "request": "launch",
       "type": "node-terminal"
+    },
+    {
+      "command": "yarn run dev:local",
+      "name": "Run Dev Locally",
+      "request": "launch",
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.template.json

@@ -26,8 +26,17 @@
   "[toml]": {
     "editor.defaultFormatter": "tamasfe.even-better-toml"
   },
-  "rust-analyzer.linkedProjects": ["packages/octobase-node/Cargo.toml"],
   "[typescriptreact]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
+  },
+  "vitest.include": [
+    "packages/**/*.spec.ts",
+    "packages/**/*.spec.tsx",
+    "apps/web/**/*.spec.ts",
+    "apps/web/**/*.spec.tsx",
+    "apps/electron/layers/**/*.spec.ts",
+    "tests/unit/**/*.spec.ts",
+    "tests/unit/**/*.spec.tsx"
+  ],
+  "deepscan.enable": true
 }

Cargo.lock

@@ -0,0 +1,785 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "affine_native"
+version = "0.0.0"
+dependencies = [
+ "anyhow",
+ "napi",
+ "napi-build",
+ "napi-derive",
+ "notify",
+ "once_cell",
+ "parking_lot",
+ "serde",
+ "serde_json",
+ "tokio",
+ "uuid",
+]
+
+[[package]]
+name = "aho-corasick"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67fc08ce920c31afb70f013dcce1bfc3a3195de6a228474e45e1f145b36f8d04"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "anyhow"
+version = "1.0.71"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c7d0618f0e0b7e8ff11427422b64564d5fb0be1940354bfe2e0529b18a9d9b8"
+
+[[package]]
+name = "autocfg"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+
+[[package]]
+name = "bitflags"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bitflags"
+version = "2.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24a6904aef64d73cf10ab17ebace7befb918b82164785cb89907993be7f83813"
+
+[[package]]
+name = "bytes"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "89b2fd2a0dcf38d7971e2194b6b6eebab45ae01067456a7fd93d5547a61b70be"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "convert_case"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec182b0ca2f35d8fc196cf3404988fd8b8c739a4d270ff118a398feb0cbec1ca"
+dependencies = [
+ "unicode-segmentation",
+]
+
+[[package]]
+name = "crossbeam-channel"
+version = "0.5.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a33c2bf77f2df06183c3aa30d1e96c0695a313d4f9c453cc3762a6db39f99200"
+dependencies = [
+ "cfg-if",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3c063cd8cc95f5c377ed0d4b49a4b21f632396ff690e8470c29b3359b346984b"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "ctor"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dd4056f63fce3b82d852c3da92b08ea59959890813a7f4ce9c0ff85b10cf301b"
+dependencies = [
+ "quote",
+ "syn 2.0.15",
+]
+
+[[package]]
+name = "filetime"
+version = "0.2.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5cbc844cecaee9d4443931972e1289c8ff485cb4cc2767cb03ca139ed6885153"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "redox_syscall",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "fsevent-sys"
+version = "4.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "76ee7a02da4d231650c7cea31349b889be2f45ddb3ef3032d2ec8185f6313fd2"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c85e1d9ab2eadba7e5040d4e09cbd6d072b76a557ad64e797c2cb9d4da21d7e4"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee512640fe35acbfb4bb779db6f0d80704c2cacfa2e39b601ef3e3f47d1ae4c7"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "inotify"
+version = "0.9.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8069d3ec154eb856955c1c0fbffefbf5f3c40a104ec912d4797314c1801abff"
+dependencies = [
+ "bitflags 1.3.2",
+ "inotify-sys",
+ "libc",
+]
+
+[[package]]
+name = "inotify-sys"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e05c02b5e89bff3b946cedeca278abc628fe811e604f027c45a8aa3cf793d0eb"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "453ad9f582a441959e5f0d088b02ce04cfe8d51a8eaf077f12ac6d3e94164ca6"
+
+[[package]]
+name = "kqueue"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2c8fc60ba15bf51257aa9807a48a61013db043fcf3a78cb0d916e8e396dcad98"
+dependencies = [
+ "kqueue-sys",
+ "libc",
+]
+
+[[package]]
+name = "kqueue-sys"
+version = "1.0.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8367585489f01bc55dd27404dcf56b95e6da061a256a666ab23be9ba96a2e587"
+dependencies = [
+ "bitflags 1.3.2",
+ "libc",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.144"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b00cc1c228a6782d0f076e7b232802e0c5689d41bb5df366f2a6b6621cfdfe1"
+
+[[package]]
+name = "libloading"
+version = "0.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b67380fd3b2fbe7527a606e18729d21c6f3951633d0500574c4dc22d2d638b9f"
+dependencies = [
+ "cfg-if",
+ "winapi",
+]
+
+[[package]]
+name = "lock_api"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "435011366fe56583b16cf956f9df0095b405b82d76425bc8981c0e22e60ec4df"
+dependencies = [
+ "autocfg",
+ "scopeguard",
+]
+
+[[package]]
+name = "log"
+version = "0.4.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "memchr"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d"
+
+[[package]]
+name = "mio"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b9d9a46eff5b4ff64b45a9e316a6d1e0bc719ef429cbec4dc630684212bfdf9"
+dependencies = [
+ "libc",
+ "log",
+ "wasi",
+ "windows-sys 0.45.0",
+]
+
+[[package]]
+name = "napi"
+version = "2.12.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49ac8112fe5998579b22e29903c7b277fc7f91c7860c0236f35792caf8156e18"
+dependencies = [
+ "anyhow",
+ "bitflags 2.2.1",
+ "ctor",
+ "napi-derive",
+ "napi-sys",
+ "once_cell",
+ "serde",
+ "serde_json",
+ "tokio",
+]
+
+[[package]]
+name = "napi-build"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "882a73d9ef23e8dc2ebbffb6a6ae2ef467c0f18ac10711e4cc59c5485d41df0e"
+
+[[package]]
+name = "napi-derive"
+version = "2.12.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c47e0f395207c062e680a158f0624ec456c1dfb3c96a8cb888e0401506d50ae9"
+dependencies = [
+ "cfg-if",
+ "convert_case",
+ "napi-derive-backend",
+ "proc-macro2",
+ "quote",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "napi-derive-backend"
+version = "1.0.51"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0a83afae5b4ba6f98ed6e33a52da343fdeb66474f1162a38cde5a3d46eb054e7"
+dependencies = [
+ "convert_case",
+ "once_cell",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "semver",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "napi-sys"
+version = "2.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "166b5ef52a3ab5575047a9fe8d4a030cdd0f63c96f071cd6907674453b07bae3"
+dependencies = [
+ "libloading",
+]
+
+[[package]]
+name = "notify"
+version = "6.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4d9ba6c734de18ca27c8cef5cd7058aa4ac9f63596131e4c7e41e579319032a2"
+dependencies = [
+ "bitflags 1.3.2",
+ "crossbeam-channel",
+ "filetime",
+ "fsevent-sys",
+ "inotify",
+ "kqueue",
+ "libc",
+ "mio",
+ "serde",
+ "walkdir",
+ "windows-sys 0.45.0",
+]
+
+[[package]]
+name = "num_cpus"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fac9e2da13b5eb447a6ce3d392f23a29d8694bff781bf03a16cd9ac8697593b"
+dependencies = [
+ "hermit-abi",
+ "libc",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.17.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b7e5500299e16ebb147ae15a00a942af264cf3688f47923b8fc2cd5858f23ad3"
+
+[[package]]
+name = "parking_lot"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3742b2c103b9f06bc9fff0a37ff4912935851bee6d36f3c02bcc755bcfec228f"
+dependencies = [
+ "lock_api",
+ "parking_lot_core",
+]
+
+[[package]]
+name = "parking_lot_core"
+version = "0.9.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9069cbb9f99e3a5083476ccb29ceb1de18b9118cafa53e90c9551235de2b9521"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "redox_syscall",
+ "smallvec",
+ "windows-sys 0.45.0",
+]
+
+[[package]]
+name = "pin-project-lite"
+version = "0.2.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e0a7ae3ac2f1173085d398531c705756c94a4c56843785df85a60c1a0afac116"
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.56"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b63bdb0cd06f1f4dedf69b254734f9b45af66e4a031e42a7480257d9898b435"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f4f29d145265ec1c483c7c654450edde0bfe043d3938d6972630663356d9500"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "redox_syscall"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fb5a58c1855b4b6819d59012155603f0b22ad30cad752600aadfcb695265519a"
+dependencies = [
+ "bitflags 1.3.2",
+]
+
+[[package]]
+name = "regex"
+version = "1.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af83e617f331cc6ae2da5443c602dfa5af81e517212d9d611a5b3ba1777b5370"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.7.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a5996294f19bd3aae0453a862ad728f60e6600695733dd5df01da90c54363a3c"
+
+[[package]]
+name = "ryu"
+version = "1.0.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f91339c0467de62360649f8d3e185ca8de4224ff281f66000de5eb2a77a79041"
+
+[[package]]
+name = "same-file"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502"
+dependencies = [
+ "winapi-util",
+]
+
+[[package]]
+name = "scopeguard"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
+
+[[package]]
+name = "semver"
+version = "1.0.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bebd363326d05ec3e2f532ab7660680f3b02130d780c299bca73469d521bc0ed"
+
+[[package]]
+name = "serde"
+version = "1.0.162"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "71b2f6e1ab5c2b98c05f0f35b236b22e8df7ead6ffbf51d7808da7f8817e7ab6"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.162"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2a0814352fd64b58489904a44ea8d90cb1a91dcb6b4f5ebabc32c8318e93cb6"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.15",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.96"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "057d394a50403bcac12672b2b18fb387ab6d289d957dab67dd201875391e52f1"
+dependencies = [
+ "itoa",
+ "ryu",
+ "serde",
+]
+
+[[package]]
+name = "signal-hook-registry"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d8229b473baa5980ac72ef434c4415e70c4b5e71b423043adb4ba059f89c99a1"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "smallvec"
+version = "1.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a507befe795404456341dfab10cef66ead4c041f62b8b11bbb92bffe5d0953e0"
+
+[[package]]
+name = "socket2"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "64a4a911eed85daf18834cfaa86a79b7d266ff93ff5ba14005426219480ed662"
+dependencies = [
+ "libc",
+ "winapi",
+]
+
+[[package]]
+name = "syn"
+version = "1.0.109"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a34fcf3e8b60f57e6a14301a2e916d323af98b0ea63c599441eec8558660c822"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "tokio"
+version = "1.28.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c3c786bf8134e5a3a166db9b29ab8f48134739014a3eca7bc6bfa95d673b136f"
+dependencies = [
+ "autocfg",
+ "bytes",
+ "libc",
+ "mio",
+ "num_cpus",
+ "parking_lot",
+ "pin-project-lite",
+ "signal-hook-registry",
+ "socket2",
+ "tokio-macros",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "tokio-macros"
+version = "2.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "630bdcf245f78637c13ec01ffae6187cca34625e8c63150d424b59e55af2675e"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.15",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4"
+
+[[package]]
+name = "unicode-segmentation"
+version = "1.10.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36"
+
+[[package]]
+name = "uuid"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4dad5567ad0cf5b760e5665964bec1b47dfd077ba8a2544b513f3556d3d239a2"
+dependencies = [
+ "getrandom",
+ "rand",
+ "serde",
+]
+
+[[package]]
+name = "walkdir"
+version = "2.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36df944cda56c7d8d8b7496af378e6b16de9284591917d307c9b4d313c44e698"
+dependencies = [
+ "same-file",
+ "winapi-util",
+]
+
+[[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-util"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "windows-sys"
+version = "0.45.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0"
+dependencies = [
+ "windows-targets 0.42.2",
+]
+
+[[package]]
+name = "windows-sys"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
+dependencies = [
+ "windows-targets 0.48.0",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071"
+dependencies = [
+ "windows_aarch64_gnullvm 0.42.2",
+ "windows_aarch64_msvc 0.42.2",
+ "windows_i686_gnu 0.42.2",
+ "windows_i686_msvc 0.42.2",
+ "windows_x86_64_gnu 0.42.2",
+ "windows_x86_64_gnullvm 0.42.2",
+ "windows_x86_64_msvc 0.42.2",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b1eb6f0cd7c80c79759c929114ef071b87354ce476d9d94271031c0497adfd5"
+dependencies = [
+ "windows_aarch64_gnullvm 0.48.0",
+ "windows_aarch64_msvc 0.48.0",
+ "windows_i686_gnu 0.48.0",
+ "windows_i686_msvc 0.48.0",
+ "windows_x86_64_gnu 0.48.0",
+ "windows_x86_64_gnullvm 0.48.0",
+ "windows_x86_64_msvc 0.48.0",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8"
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91ae572e1b79dba883e0d315474df7305d12f569b400fcf90581b06062f7e1bc"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b2ef27e0d7bdfcfc7b868b317c1d32c641a6fe4629c171b8928c7b08d98d7cf3"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "622a1962a7db830d6fd0a69683c80a18fda201879f0f447f065a3b7467daa241"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4542c6e364ce21bf45d69fdd2a8e455fa38d316158cfd43b3ac1c5b1b19f8e00"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca2b8a661f7628cbd23440e50b05d705db3686f894fc9580820623656af974b1"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7896dbc1f41e08872e9d5e8f8baa8fdd2677f29468c4e156210174edc7f7b953"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a"

Cargo.toml

@@ -0,0 +1,8 @@
+[workspace]
+members = ["./packages/native"]
+
+[profile.release]
+lto = true
+codegen-units = 1
+opt-level = 3
+strip = "symbols"

README.md

@@ -30,6 +30,7 @@ See https://github.com/all-?/all-contributors/issues/361#issuecomment-637166066
 [![AFFiNE Window x64](https://img.shields.io/badge/-Windows%20%E2%86%92-blue?style=flat-square&logo=windows&logoColor=white)](https://affine.pro/download)
 [![AFFiNE Linux](https://img.shields.io/badge/-Linux%20%E2%86%92-yellow?style=flat-square&logo=linux&logoColor=white)](https://affine.pro/download)
 
+[![Releases](https://img.shields.io/github/downloads/toeverything/AFFiNE/total)](https://github.com/toeverything/AFFiNE/releases/latest)
 [![stars-icon]](https://github.com/toeverything/AFFiNE)
 [![All Contributors][all-contributors-badge]](#contributors)
 [![codecov]](https://codecov.io/gh/toeverything/AFFiNE)
@@ -69,7 +70,7 @@ See https://github.com/all-?/all-contributors/issues/361#issuecomment-637166066
 
 Before we tell you how to get started with AFFiNE, we'd like to shamelessly plug our awesome user and developer communities across [official social platforms](https://community.affine.pro/c/start-here/)! Once you’re familiar with using the software, maybe you will share your wisdom with others and even consider joining the [AFFiNE Ambassador program](https://community.affine.pro/c/start-here/affine-ambassador) to help spread AFFiNE to the world.
 
-## Getting started & Stay tunned with us.
+## Getting started & staying tuned with us.
 
 ⚠️ Please note that AFFiNE is still under active development and is not yet ready for production use. ⚠️
 
@@ -140,7 +141,7 @@ Thanks a lot to the community for providing such powerful and simple libraries,
 We would like to express our gratitude to all the individuals who have already contributed to AFFiNE! If you have any AFFiNE-related project, documentation, tool or template, please feel free to contribute it by submitting a pull request to our curated list on GitHub: [awesome-affine](https://github.com/toeverything/awesome-affine).
 
 <a href="https://github.com/toeverything/affine/graphs/contributors">
-  <img src="https://user-images.githubusercontent.com/5910926/233382206-312428ca-094a-4579-ae06-213961ed7eab.svg" />
+  <img src="https://user-images.githubusercontent.com/5910926/240508358-93eddded-48a0-40cd-85e4-a1d172dbe1d9.svg" />
 </a>
 
 ## Self-Host

apps/electron/dev-app-update.yml

@@ -0,0 +1,4 @@
+owner: toeverything
+repo: AFFiNE
+provider: github
+private: false

apps/electron/forge.config.js

@@ -1,11 +1,16 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
+const { z } = require('zod');
+
 const {
   utils: { fromBuildIdentifier },
 } = require('@electron-forge/core');
 
 const path = require('node:path');
 
-const buildType = (process.env.BUILD_TYPE || 'stable').trim().toLowerCase();
+const ReleaseTypeSchema = z.enum(['stable', 'beta', 'canary', 'internal']);
+
+const envBuildType = (process.env.BUILD_TYPE || 'canary').trim().toLowerCase();
+const buildType = ReleaseTypeSchema.parse(envBuildType);
 const stableBuild = buildType === 'stable';
 const productName = !stableBuild ? `AFFiNE-${buildType}` : 'AFFiNE';
 const icoPath = !stableBuild
@@ -28,6 +33,7 @@ module.exports = {
   packagerConfig: {
     name: productName,
     appBundleId: fromBuildIdentifier({
+      internal: 'pro.affine.internal',
       canary: 'pro.affine.canary',
       beta: 'pro.affine.beta',
       stable: 'pro.affine.app',
@@ -45,6 +51,8 @@ module.exports = {
           teamId: process.env.APPLE_TEAM_ID,
         }
       : undefined,
+    // do we need the following line?
+    extraResource: ['./resources/app-update.yml'],
   },
   makers: [
     {
@@ -86,7 +94,7 @@ module.exports = {
       config: {
         name: 'AFFiNE',
         setupIcon: icoPath,
-        // loadingGif: './resources/icons/loading.gif',
+        loadingGif: './resources/icons/affine_installing.gif',
       },
     },
   ],

apps/electron/layers/constraints.ts

@@ -0,0 +1,7 @@
+/* eslint-disable @typescript-eslint/consistent-type-imports */
+// This file contains the main process events
+// It will guide preload and main process on the correct event types and payloads
+
+export type MainIPCHandlerMap = typeof import('./main/src/exposed').handlers;
+
+export type MainIPCEventMap = typeof import('./main/src/exposed').events;

apps/electron/layers/logger.ts

@@ -1,3 +0,0 @@
-import log from 'electron-log';
-
-export const logger = log;

apps/electron/layers/main-events.ts

@@ -1,5 +0,0 @@
-// This file contains the main process events
-// It will guide preload and main process on the correct event types and payloads
-export interface MainEventMap {
-  'main:on-db-update': (workspaceId: string) => void;
-}

apps/electron/layers/main/src/__tests__/handlers.spec.ts

@@ -1,226 +0,0 @@
-import assert from 'node:assert';
-import path from 'node:path';
-
-import fs from 'fs-extra';
-import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
-import * as Y from 'yjs';
-
-const registeredHandlers = new Map<string, (...args: any[]) => any>();
-
-// common mock dispatcher for ipcMain.handle and app.on
-async function dispatch(key: string, ...args: any[]) {
-  const handler = registeredHandlers.get(key);
-  assert(handler);
-  return await handler(null, ...args);
-}
-
-const APP_PATH = path.join(__dirname, './tmp');
-
-const browserWindow = {
-  isDestroyed: () => {
-    return false;
-  },
-  setWindowButtonVisibility: (_v: boolean) => {
-    // will be stubbed later
-  },
-  webContents: {
-    send: (_type: string, ..._args: any[]) => {
-      // ...
-    },
-  },
-};
-
-const ipcMain = {
-  handle: (key: string, callback: (...args: any[]) => any) => {
-    registeredHandlers.set(key, callback);
-  },
-};
-
-const nativeTheme = {
-  themeSource: 'light',
-};
-
-function compareBuffer(a: Uint8Array, b: Uint8Array) {
-  if (a.length !== b.length) {
-    return false;
-  }
-  for (let i = 0; i < a.length; i++) {
-    if (a[i] !== b[i]) {
-      return false;
-    }
-  }
-  return true;
-}
-
-// dynamically import handlers so that we can inject local variables to mocks
-vi.doMock('electron', () => {
-  return {
-    app: {
-      getPath: (name: string) => {
-        assert(name === 'appData');
-        return APP_PATH;
-      },
-      name: 'affine-test',
-      on: (name: string, callback: (...args: any[]) => any) => {
-        registeredHandlers.set(name, callback);
-      },
-    },
-    BrowserWindow: {
-      getAllWindows: () => {
-        return [browserWindow];
-      },
-    },
-    nativeTheme: nativeTheme,
-    ipcMain,
-  };
-});
-
-beforeEach(async () => {
-  // clean up tmp folder
-  const { registerHandlers } = await import('../handlers');
-  registerHandlers();
-});
-
-afterEach(async () => {
-  const { cleanupWorkspaceDBs } = await import('../handlers');
-  cleanupWorkspaceDBs();
-  await fs.remove(APP_PATH);
-});
-
-describe('ensureWorkspaceDB', () => {
-  test('should create db file on connection if it does not exist', async () => {
-    const id = 'test-workspace-id';
-    const { ensureWorkspaceDB } = await import('../handlers');
-    const workspaceDB = await ensureWorkspaceDB(id);
-    const file = workspaceDB.path;
-    const fileExists = await fs.pathExists(file);
-    expect(fileExists).toBe(true);
-  });
-});
-
-describe('workspace handlers', () => {
-  test('list all workspace ids', async () => {
-    const ids = ['test-workspace-id', 'test-workspace-id-2'];
-    const { ensureWorkspaceDB } = await import('../handlers');
-    await Promise.all(ids.map(id => ensureWorkspaceDB(id)));
-    const list = await dispatch('workspace:list');
-    expect(list).toEqual(ids);
-  });
-
-  test('delete workspace', async () => {
-    const ids = ['test-workspace-id', 'test-workspace-id-2'];
-    const { ensureWorkspaceDB } = await import('../handlers');
-    await Promise.all(ids.map(id => ensureWorkspaceDB(id)));
-    await dispatch('workspace:delete', 'test-workspace-id-2');
-    const list = await dispatch('workspace:list');
-    expect(list).toEqual(['test-workspace-id']);
-  });
-});
-
-describe('UI handlers', () => {
-  test('theme-change', async () => {
-    await dispatch('ui:theme-change', 'dark');
-    expect(nativeTheme.themeSource).toBe('dark');
-    await dispatch('ui:theme-change', 'light');
-    expect(nativeTheme.themeSource).toBe('light');
-  });
-
-  test('sidebar-visibility-change (macOS)', async () => {
-    vi.stubGlobal('process', { platform: 'darwin' });
-    const setWindowButtonVisibility = vi.fn();
-    browserWindow.setWindowButtonVisibility = setWindowButtonVisibility;
-    await dispatch('ui:sidebar-visibility-change', true);
-    expect(setWindowButtonVisibility).toBeCalledWith(true);
-    await dispatch('ui:sidebar-visibility-change', false);
-    expect(setWindowButtonVisibility).toBeCalledWith(false);
-    vi.unstubAllGlobals();
-  });
-
-  test('sidebar-visibility-change (non-macOS)', async () => {
-    vi.stubGlobal('process', { platform: 'linux' });
-    const setWindowButtonVisibility = vi.fn();
-    browserWindow.setWindowButtonVisibility = setWindowButtonVisibility;
-    await dispatch('ui:sidebar-visibility-change', true);
-    expect(setWindowButtonVisibility).not.toBeCalled();
-    vi.unstubAllGlobals();
-  });
-});
-
-describe('db handlers', () => {
-  test('will reconnect on activate', async () => {
-    const { ensureWorkspaceDB } = await import('../handlers');
-    const workspaceDB = await ensureWorkspaceDB('test-workspace-id');
-    const instance = vi.spyOn(workspaceDB, 'reconnectDB');
-    await dispatch('activate');
-    expect(instance).toBeCalled();
-  });
-
-  test('apply doc and get doc updates', async () => {
-    const workspaceId = 'test-workspace-id';
-    const bin = await dispatch('db:get-doc', workspaceId);
-    // ? is this a good test?
-    expect(bin.every((byte: number) => byte === 0)).toBe(true);
-
-    const ydoc = new Y.Doc();
-    const ytext = ydoc.getText('test');
-    ytext.insert(0, 'hello world');
-    const bin2 = Y.encodeStateAsUpdate(ydoc);
-
-    await dispatch('db:apply-doc-update', workspaceId, bin2);
-
-    const bin3 = await dispatch('db:get-doc', workspaceId);
-    const ydoc2 = new Y.Doc();
-    Y.applyUpdate(ydoc2, bin3);
-    const ytext2 = ydoc2.getText('test');
-    expect(ytext2.toString()).toBe('hello world');
-  });
-
-  test('get non existent doc', async () => {
-    const workspaceId = 'test-workspace-id';
-    const bin = await dispatch('db:get-blob', workspaceId, 'non-existent-id');
-    expect(bin).toBeNull();
-  });
-
-  test('list blobs (empty)', async () => {
-    const workspaceId = 'test-workspace-id';
-    const list = await dispatch('db:get-persisted-blobs', workspaceId);
-    expect(list).toEqual([]);
-  });
-
-  test('CRUD blobs', async () => {
-    const testBin = new Uint8Array([1, 2, 3, 4, 5]);
-    const testBin2 = new Uint8Array([6, 7, 8, 9, 10]);
-    const workspaceId = 'test-workspace-id';
-
-    // add blob
-    await dispatch('db:add-blob', workspaceId, 'testBin', testBin);
-
-    // get blob
-    expect(
-      compareBuffer(
-        await dispatch('db:get-blob', workspaceId, 'testBin'),
-        testBin
-      )
-    ).toBe(true);
-
-    // add another blob
-    await dispatch('db:add-blob', workspaceId, 'testBin2', testBin2);
-    expect(
-      compareBuffer(
-        await dispatch('db:get-blob', workspaceId, 'testBin2'),
-        testBin2
-      )
-    ).toBe(true);
-
-    // list blobs
-    let lists = await dispatch('db:get-persisted-blobs', workspaceId);
-    expect(lists).toHaveLength(2);
-    expect(lists).toContain('testBin');
-    expect(lists).toContain('testBin2');
-
-    // delete blob
-    await dispatch('db:delete-blob', workspaceId, 'testBin');
-    lists = await dispatch('db:get-persisted-blobs', workspaceId);
-    expect(lists).toEqual(['testBin2']);
-  });
-});

apps/electron/layers/main/src/application-menu.ts

@@ -0,0 +1,142 @@
+import { app, Menu } from 'electron';
+
+import { isMacOS } from '../../utils';
+import { subjects } from './events';
+import { checkForUpdatesAndNotify } from './handlers/updater';
+import { revealLogFile } from './logger';
+
+// Unique id for menuitems
+const MENUITEM_NEW_PAGE = 'affine:new-page';
+
+export function createApplicationMenu() {
+  const isMac = isMacOS();
+
+  // Electron menu cannot be modified
+  // You have to copy the complete default menu template event if you want to add a single custom item
+  // See https://www.electronjs.org/docs/latest/api/menu#examples
+  const template = [
+    // { role: 'appMenu' }
+    ...(isMac
+      ? [
+          {
+            label: app.name,
+            submenu: [
+              { role: 'about' },
+              { type: 'separator' },
+              { role: 'services' },
+              { type: 'separator' },
+              { role: 'hide' },
+              { role: 'hideOthers' },
+              { role: 'unhide' },
+              { type: 'separator' },
+              { role: 'quit' },
+            ],
+          },
+        ]
+      : []),
+    // { role: 'fileMenu' }
+    {
+      label: 'File',
+      submenu: [
+        {
+          id: MENUITEM_NEW_PAGE,
+          label: 'New Page',
+          accelerator: isMac ? 'Cmd+N' : 'Ctrl+N',
+          click: () => {
+            subjects.applicationMenu.newPageAction.next();
+          },
+        },
+        { type: 'separator' },
+        isMac ? { role: 'close' } : { role: 'quit' },
+      ],
+    },
+    // { role: 'editMenu' }
+    {
+      label: 'Edit',
+      submenu: [
+        { role: 'undo' },
+        { role: 'redo' },
+        { type: 'separator' },
+        { role: 'cut' },
+        { role: 'copy' },
+        { role: 'paste' },
+        ...(isMac
+          ? [
+              { role: 'pasteAndMatchStyle' },
+              { role: 'delete' },
+              { role: 'selectAll' },
+              { type: 'separator' },
+              {
+                label: 'Speech',
+                submenu: [{ role: 'startSpeaking' }, { role: 'stopSpeaking' }],
+              },
+            ]
+          : [{ role: 'delete' }, { type: 'separator' }, { role: 'selectAll' }]),
+      ],
+    },
+    // { role: 'viewMenu' }
+    {
+      label: 'View',
+      submenu: [
+        { role: 'reload' },
+        { role: 'forceReload' },
+        { role: 'toggleDevTools' },
+        { type: 'separator' },
+        { role: 'resetZoom' },
+        { role: 'zoomIn' },
+        { role: 'zoomOut' },
+        { type: 'separator' },
+        { role: 'togglefullscreen' },
+      ],
+    },
+    // { role: 'windowMenu' }
+    {
+      label: 'Window',
+      submenu: [
+        { role: 'minimize' },
+        { role: 'zoom' },
+        ...(isMac
+          ? [
+              { type: 'separator' },
+              { role: 'front' },
+              { type: 'separator' },
+              { role: 'window' },
+            ]
+          : [{ role: 'close' }]),
+      ],
+    },
+    {
+      role: 'help',
+      submenu: [
+        {
+          label: 'Learn More',
+          click: async () => {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const { shell } = require('electron');
+            await shell.openExternal('https://affine.pro/');
+          },
+        },
+        {
+          label: 'Open logs folder',
+          click: async () => {
+            revealLogFile();
+          },
+        },
+        {
+          label: 'Check for Updates',
+          click: async () => {
+            await checkForUpdatesAndNotify(true);
+          },
+        },
+      ],
+    },
+  ];
+
+  // @ts-ignore The snippet is copied from Electron official docs.
+  //            It's working as expected. No idea why it contains type errors.
+  //            Just ignore for now.
+  const menu = Menu.buildFromTemplate(template);
+  Menu.setApplicationMenu(menu);
+
+  return menu;
+}

apps/electron/layers/main/src/context.ts

@@ -1,9 +1,12 @@
 import { app } from 'electron';
-import path from 'path';
 
 export const appContext = {
-  appName: app.name,
-  appDataPath: path.join(app.getPath('appData'), app.name),
+  get appName() {
+    return app.name;
+  },
+  get appDataPath() {
+    return app.getPath('sessionData');
+  },
 };
 
 export type AppContext = typeof appContext;

apps/electron/layers/main/src/data/export.ts

@@ -1,34 +0,0 @@
-import fs from 'fs-extra';
-
-import { logger } from '../../../logger';
-import type { WorkspaceDatabase } from './sqlite';
-
-/**
- * Start a backup of the database to the given destination.
- */
-export async function exportDatabase(db: WorkspaceDatabase, dest: string) {
-  await fs.copyFile(db.path, dest);
-  logger.log('export: ', dest);
-}
-
-// export async function startBackup(db: WorkspaceDatabase, dest: string) {
-//   let timeout: NodeJS.Timeout | null;
-//   async function backup() {
-//     await fs.copyFile(db.path, dest);
-//     logger.log('backup: ', dest);
-//   }
-
-//   backup();
-
-//   const _db = await db.sqliteDB$;
-
-//   _db.on('change', () => {
-//     if (timeout) {
-//       clearTimeout(timeout);
-//     }
-//     timeout = setTimeout(async () => {
-//       await backup();
-//       timeout = null;
-//     }, 1000);
-//   });
-// }

apps/electron/layers/main/src/data/fs-watch.ts

@@ -1,7 +0,0 @@
-import type { WatchListener } from 'fs-extra';
-import fs from 'fs-extra';
-
-export function watchFile(path: string, callback: WatchListener<string>) {
-  const watcher = fs.watch(path, callback);
-  return () => watcher.close();
-}

apps/electron/layers/main/src/data/sqlite.ts

@@ -1,174 +0,0 @@
-import path from 'node:path';
-
-import type { Database } from 'better-sqlite3';
-import sqlite from 'better-sqlite3';
-import fs from 'fs-extra';
-import * as Y from 'yjs';
-
-import { logger } from '../../../logger';
-import type { AppContext } from '../context';
-
-const schemas = [
-  `CREATE TABLE IF NOT EXISTS "updates" (
-  id INTEGER PRIMARY KEY AUTOINCREMENT,
-  data BLOB NOT NULL,
-  timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
-)`,
-  `CREATE TABLE IF NOT EXISTS "blobs" (
-  key TEXT PRIMARY KEY NOT NULL,
-  data BLOB NOT NULL,
-  timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
-)`,
-];
-
-interface UpdateRow {
-  id: number;
-  data: Buffer;
-  timestamp: string;
-}
-
-interface BlobRow {
-  key: string;
-  data: Buffer;
-  timestamp: string;
-}
-
-export class WorkspaceDatabase {
-  sqliteDB: Database;
-  ydoc = new Y.Doc();
-  firstConnect = false;
-
-  constructor(public path: string) {
-    this.sqliteDB = this.reconnectDB();
-  }
-
-  // release resources
-  destroy = () => {
-    this.sqliteDB?.close();
-    this.ydoc.destroy();
-  };
-
-  reconnectDB = () => {
-    logger.log('open db', this.path);
-    if (this.sqliteDB) {
-      this.sqliteDB.close();
-    }
-
-    // use cached version?
-    const db = (this.sqliteDB = sqlite(this.path));
-    db.exec(schemas.join(';'));
-
-    if (!this.firstConnect) {
-      this.ydoc.on('update', this.addUpdateToSQLite);
-    }
-
-    const updates = this.getUpdates();
-    updates.forEach(update => {
-      Y.applyUpdate(this.ydoc, update.data);
-    });
-
-    this.firstConnect = true;
-
-    return db;
-  };
-
-  getEncodedDocUpdates = () => {
-    return Y.encodeStateAsUpdate(this.ydoc);
-  };
-
-  // non-blocking and use yDoc to validate the update
-  // after that, the update is added to the db
-  applyUpdate = (data: Uint8Array) => {
-    Y.applyUpdate(this.ydoc, data);
-    // todo: trim the updates when the number of records is too large
-    // 1. store the current ydoc state in the db
-    // 2. then delete the old updates
-    // yjs-idb will always trim the db for the first time after DB is loaded
-  };
-
-  addBlob = (key: string, data: Uint8Array) => {
-    try {
-      const statement = this.sqliteDB.prepare(
-        'INSERT INTO blobs (key, data) VALUES (?, ?) ON CONFLICT(key) DO UPDATE SET data = ?'
-      );
-      statement.run(key, data, data);
-    } catch (error) {
-      logger.error('addBlob', error);
-    }
-  };
-
-  getBlob = (key: string) => {
-    try {
-      const statement = this.sqliteDB.prepare(
-        'SELECT data FROM blobs WHERE key = ?'
-      );
-      const row = statement.get(key) as BlobRow;
-      if (!row) {
-        return null;
-      }
-      return row.data;
-    } catch (error) {
-      logger.error('getBlob', error);
-      return null;
-    }
-  };
-
-  deleteBlob = (key: string) => {
-    try {
-      const statement = this.sqliteDB.prepare(
-        'DELETE FROM blobs WHERE key = ?'
-      );
-      statement.run(key);
-    } catch (error) {
-      logger.error('deleteBlob', error);
-    }
-  };
-
-  getPersistentBlobKeys = () => {
-    try {
-      const statement = this.sqliteDB.prepare('SELECT key FROM blobs');
-      const rows = statement.all() as BlobRow[];
-      return rows.map(row => row.key);
-    } catch (error) {
-      logger.error('getPersistentBlobKeys', error);
-      return [];
-    }
-  };
-
-  private getUpdates = () => {
-    try {
-      const statement = this.sqliteDB.prepare('SELECT * FROM updates');
-      const rows = statement.all() as UpdateRow[];
-      return rows;
-    } catch (error) {
-      logger.error('getUpdates', error);
-      return [];
-    }
-  };
-
-  // batch write instead write per key stroke?
-  private addUpdateToSQLite = (data: Uint8Array) => {
-    try {
-      const start = performance.now();
-      const statement = this.sqliteDB.prepare(
-        'INSERT INTO updates (data) VALUES (?)'
-      );
-      statement.run(data);
-      logger.debug('addUpdateToSQLite', performance.now() - start, 'ms');
-    } catch (error) {
-      logger.error('addUpdateToSQLite', error);
-    }
-  };
-}
-
-export async function openWorkspaceDatabase(
-  context: AppContext,
-  workspaceId: string
-) {
-  const basePath = path.join(context.appDataPath, 'workspaces', workspaceId);
-  // hmmm.... blocking api but it should be fine, right?
-  await fs.ensureDir(basePath);
-  const dbPath = path.join(basePath, 'storage.db');
-
-  return new WorkspaceDatabase(dbPath);
-}

apps/electron/layers/main/src/data/workspace.ts

@@ -1,34 +0,0 @@
-import path from 'node:path';
-
-import fs from 'fs-extra';
-
-import { logger } from '../../../logger';
-import type { AppContext } from '../context';
-
-export async function listWorkspaces(context: AppContext) {
-  const basePath = path.join(context.appDataPath, 'workspaces');
-  try {
-    return fs
-      .readdir(basePath, {
-        withFileTypes: true,
-      })
-      .then(dirs => dirs.filter(dir => dir.isDirectory()).map(dir => dir.name));
-  } catch (error) {
-    logger.error('listWorkspaces', error);
-    return [];
-  }
-}
-
-export async function deleteWorkspace(context: AppContext, id: string) {
-  const basePath = path.join(context.appDataPath, 'workspaces', id);
-  const movedPath = path.join(
-    context.appDataPath,
-    'delete-workspaces',
-    `${id}`
-  );
-  try {
-    return fs.move(basePath, movedPath);
-  } catch (error) {
-    logger.error('deleteWorkspace', error);
-  }
-}

apps/electron/layers/main/src/events/application-menu.ts

@@ -0,0 +1,22 @@
+import { Subject } from 'rxjs';
+
+import type { MainEventListener } from './type';
+
+export const applicationMenuSubjects = {
+  newPageAction: new Subject<void>(),
+};
+
+/**
+ * Events triggered by application menu
+ */
+export const applicationMenuEvents = {
+  /**
+   * File -> New Page
+   */
+  onNewPageAction: (fn: () => void) => {
+    const sub = applicationMenuSubjects.newPageAction.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+} satisfies Record<string, MainEventListener>;

apps/electron/layers/main/src/events/db.ts

@@ -0,0 +1,38 @@
+import { Subject } from 'rxjs';
+
+import type { MainEventListener } from './type';
+
+interface DBFilePathMeta {
+  workspaceId: string;
+  path: string;
+  realPath: string;
+}
+
+export const dbSubjects = {
+  // emit workspace ids
+  dbFileMissing: new Subject<string>(),
+  // emit workspace ids
+  dbFileUpdate: new Subject<string>(),
+  dbFilePathChange: new Subject<DBFilePathMeta>(),
+};
+
+export const dbEvents = {
+  onDBFileMissing: (fn: (workspaceId: string) => void) => {
+    const sub = dbSubjects.dbFileMissing.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onDBFileUpdate: (fn: (workspaceId: string) => void) => {
+    const sub = dbSubjects.dbFileUpdate.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onDBFilePathChange: (fn: (meta: DBFilePathMeta) => void) => {
+    const sub = dbSubjects.dbFilePathChange.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+} satisfies Record<string, MainEventListener>;

apps/electron/layers/main/src/events/index.ts

@@ -0,0 +1,9 @@
+export * from './register';
+
+import { applicationMenuSubjects } from './application-menu';
+import { dbSubjects } from './db';
+
+export const subjects = {
+  db: dbSubjects,
+  applicationMenu: applicationMenuSubjects,
+};

apps/electron/layers/main/src/events/register.ts

@@ -0,0 +1,32 @@
+import { app, BrowserWindow } from 'electron';
+
+import { logger } from '../logger';
+import { applicationMenuEvents } from './application-menu';
+import { dbEvents } from './db';
+import { updaterEvents } from './updater';
+
+export const allEvents = {
+  db: dbEvents,
+  updater: updaterEvents,
+  applicationMenu: applicationMenuEvents,
+};
+
+function getActiveWindows() {
+  return BrowserWindow.getAllWindows().filter(win => !win.isDestroyed());
+}
+
+export function registerEvents() {
+  // register events
+  for (const [namespace, namespaceEvents] of Object.entries(allEvents)) {
+    for (const [key, eventRegister] of Object.entries(namespaceEvents)) {
+      const subscription = eventRegister((...args: any) => {
+        const chan = `${namespace}:${key}`;
+        logger.info('[ipc-event]', chan, args);
+        getActiveWindows().forEach(win => win.webContents.send(chan, ...args));
+      });
+      app.on('before-quit', () => {
+        subscription();
+      });
+    }
+  }
+}

apps/electron/layers/main/src/events/type.ts

@@ -0,0 +1 @@
+export type MainEventListener = (...args: any[]) => () => void;

apps/electron/layers/main/src/events/updater.ts

@@ -0,0 +1,36 @@
+import { BehaviorSubject, Subject } from 'rxjs';
+
+import type { MainEventListener } from './type';
+
+interface UpdateMeta {
+  version: string;
+  allowAutoUpdate: boolean;
+}
+
+export const updaterSubjects = {
+  // means it is ready for restart and install the new version
+  updateAvailable: new Subject<UpdateMeta>(),
+  updateReady: new Subject<UpdateMeta>(),
+  downloadProgress: new BehaviorSubject<number>(0),
+};
+
+export const updaterEvents = {
+  onUpdateAvailable: (fn: (versionMeta: UpdateMeta) => void) => {
+    const sub = updaterSubjects.updateAvailable.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onUpdateReady: (fn: (versionMeta: UpdateMeta) => void) => {
+    const sub = updaterSubjects.updateReady.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onDownloadProgress: (fn: (progress: number) => void) => {
+    const sub = updaterSubjects.downloadProgress.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+} satisfies Record<string, MainEventListener>;

apps/electron/layers/main/src/exposed.ts

@@ -0,0 +1,5 @@
+import { allEvents as events } from './events';
+import { allHandlers as handlers } from './handlers';
+
+// this will be used by preload script to expose all handlers and events to the renderer process
+export { events, handlers };

apps/electron/layers/main/src/google-auth.ts

@@ -1,23 +0,0 @@
-const redirectUri = 'https://affine.pro/client/auth-callback';
-
-export const oauthEndpoint = `https://accounts.google.com/o/oauth2/v2/auth?client_id=${process.env.AFFINE_GOOGLE_CLIENT_ID}&redirect_uri=${redirectUri}&response_type=code&scope=openid https://www.googleapis.com/auth/userinfo.email profile&access_type=offline&customParameters={"prompt":"select_account"}`;
-
-const tokenEndpoint = 'https://oauth2.googleapis.com/token';
-
-export const getExchangeTokenParams = (code: string) => {
-  const postData = {
-    code,
-    client_id: process.env.AFFINE_GOOGLE_CLIENT_ID || '',
-    client_secret: process.env.AFFINE_GOOGLE_CLIENT_SECRET || '',
-    redirect_uri: redirectUri,
-    grant_type: 'authorization_code',
-  };
-  const requestInit: RequestInit = {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/x-www-form-urlencoded',
-    },
-    body: new URLSearchParams(postData).toString(),
-  };
-  return { requestInit, url: tokenEndpoint };
-};

apps/electron/layers/main/src/handlers.ts

@@ -1,227 +0,0 @@
-import {
-  app,
-  BrowserWindow,
-  dialog,
-  ipcMain,
-  nativeTheme,
-  shell,
-} from 'electron';
-import { parse } from 'url';
-
-import { logger } from '../../logger';
-import { isMacOS } from '../../utils';
-import { appContext } from './context';
-import { exportDatabase } from './data/export';
-import { watchFile } from './data/fs-watch';
-import type { WorkspaceDatabase } from './data/sqlite';
-import { openWorkspaceDatabase } from './data/sqlite';
-import { deleteWorkspace, listWorkspaces } from './data/workspace';
-import { getExchangeTokenParams, oauthEndpoint } from './google-auth';
-import { sendMainEvent } from './send-main-event';
-
-let currentWorkspaceId = '';
-
-const dbMapping = new Map<string, WorkspaceDatabase>();
-const dbWatchers = new Map<string, () => void>();
-const dBLastUse = new Map<string, number>();
-
-export async function ensureWorkspaceDB(id: string) {
-  let workspaceDB = dbMapping.get(id);
-  if (!workspaceDB) {
-    // hmm... potential race condition?
-    workspaceDB = await openWorkspaceDatabase(appContext, id);
-    dbMapping.set(id, workspaceDB);
-
-    logger.info('watch db file', workspaceDB.path);
-
-    dbWatchers.set(
-      id,
-      watchFile(workspaceDB.path, (event, filename) => {
-        const minTime = 1000;
-        logger.debug(
-          'db file changed',
-          event,
-          filename,
-          Date.now() - dBLastUse.get(id)!
-        );
-
-        if (Date.now() - dBLastUse.get(id)! < minTime || !filename) {
-          logger.debug('skip db update');
-          return;
-        }
-
-        sendMainEvent('main:on-db-update', id);
-
-        // handle DB file update by other process
-        dbWatchers.get(id)?.();
-        dbMapping.delete(id);
-        dbWatchers.delete(id);
-        ensureWorkspaceDB(id);
-      })
-    );
-  }
-  dBLastUse.set(id, Date.now());
-  return workspaceDB;
-}
-
-export async function cleanupWorkspaceDBs() {
-  for (const [id, db] of dbMapping) {
-    logger.info('close db connection', id);
-    db.destroy();
-    dbWatchers.get(id)?.();
-  }
-  dbMapping.clear();
-  dbWatchers.clear();
-  dBLastUse.clear();
-}
-
-function registerWorkspaceHandlers() {
-  ipcMain.handle('workspace:list', async _ => {
-    logger.info('list workspaces');
-    return listWorkspaces(appContext);
-  });
-
-  ipcMain.handle('workspace:delete', async (_, id) => {
-    logger.info('delete workspace', id);
-    return deleteWorkspace(appContext, id);
-  });
-}
-
-function registerUIHandlers() {
-  ipcMain.handle('ui:theme-change', async (_, theme) => {
-    nativeTheme.themeSource = theme;
-    logger.info('theme change', theme);
-  });
-
-  ipcMain.handle('ui:sidebar-visibility-change', async (_, visible) => {
-    // todo
-    // detect if os is macos
-    if (isMacOS()) {
-      const windows = BrowserWindow.getAllWindows();
-      windows.forEach(w => {
-        // hide window buttons when sidebar is not visible
-        w.setWindowButtonVisibility(visible);
-      });
-      logger.info('sidebar visibility change', visible);
-    }
-  });
-
-  ipcMain.handle('ui:workspace-change', async (_, workspaceId) => {
-    logger.info('workspace change', workspaceId);
-    currentWorkspaceId = workspaceId;
-  });
-
-  // @deprecated
-  ipcMain.handle('ui:get-google-oauth-code', async () => {
-    logger.info('starting google sign in ...');
-    shell.openExternal(oauthEndpoint);
-
-    return new Promise((resolve, reject) => {
-      const handleOpenUrl = async (_: any, url: string) => {
-        const mainWindow = BrowserWindow.getAllWindows().find(
-          w => !w.isDestroyed()
-        );
-        const urlObj = parse(url.replace('??', '?'), true);
-        if (!mainWindow || !url.startsWith('affine://auth-callback')) return;
-        const code = urlObj.query['code'] as string;
-        if (!code) return;
-
-        logger.info('google sign in code received from callback', code);
-
-        app.removeListener('open-url', handleOpenUrl);
-        resolve(getExchangeTokenParams(code));
-      };
-
-      app.on('open-url', handleOpenUrl);
-
-      setTimeout(() => {
-        reject(new Error('Timed out'));
-        app.removeListener('open-url', handleOpenUrl);
-      }, 30000);
-    });
-  });
-
-  ipcMain.handle('main:env-update', async (_, env, value) => {
-    process.env[env] = value;
-  });
-}
-
-function registerDBHandlers() {
-  app.on('activate', () => {
-    for (const [_, workspaceDB] of dbMapping) {
-      workspaceDB.reconnectDB();
-    }
-  });
-
-  ipcMain.handle('db:get-doc', async (_, id) => {
-    logger.log('main: get doc', id);
-    const workspaceDB = await ensureWorkspaceDB(id);
-    return workspaceDB.getEncodedDocUpdates();
-  });
-
-  ipcMain.handle('db:apply-doc-update', async (_, id, update) => {
-    logger.log('main: apply doc update', id);
-    const workspaceDB = await ensureWorkspaceDB(id);
-    return workspaceDB.applyUpdate(update);
-  });
-
-  ipcMain.handle('db:add-blob', async (_, workspaceId, key, data) => {
-    logger.log('main: add blob', workspaceId, key);
-    const workspaceDB = await ensureWorkspaceDB(workspaceId);
-    return workspaceDB.addBlob(key, data);
-  });
-
-  ipcMain.handle('db:get-blob', async (_, workspaceId, key) => {
-    logger.log('main: get blob', workspaceId, key);
-    const workspaceDB = await ensureWorkspaceDB(workspaceId);
-    return workspaceDB.getBlob(key);
-  });
-
-  ipcMain.handle('db:get-persisted-blobs', async (_, workspaceId) => {
-    logger.log('main: get persisted blob keys', workspaceId);
-    const workspaceDB = await ensureWorkspaceDB(workspaceId);
-    return workspaceDB.getPersistentBlobKeys();
-  });
-
-  ipcMain.handle('db:delete-blob', async (_, workspaceId, key) => {
-    logger.log('main: delete blob', workspaceId, key);
-    const workspaceDB = await ensureWorkspaceDB(workspaceId);
-    return workspaceDB.deleteBlob(key);
-  });
-
-  ipcMain.handle('ui:open-db-folder', async _ => {
-    const workspaceDB = await ensureWorkspaceDB(currentWorkspaceId);
-    logger.log('main: open db folder', workspaceDB.path);
-    shell.showItemInFolder(workspaceDB.path);
-  });
-
-  ipcMain.handle('ui:open-load-db-file-dialog', async () => {
-    // todo
-  });
-
-  ipcMain.handle('ui:open-save-db-file-dialog', async () => {
-    logger.log('main: open save db file dialog', currentWorkspaceId);
-    const workspaceDB = await ensureWorkspaceDB(currentWorkspaceId);
-    const ret = await dialog.showSaveDialog({
-      properties: ['showOverwriteConfirmation'],
-      title: 'Save Workspace',
-      buttonLabel: 'Save',
-      defaultPath: currentWorkspaceId + '.db',
-      message: 'Save Workspace as SQLite Database',
-    });
-    const filePath = ret.filePath;
-    if (ret.canceled || !filePath) {
-      return null;
-    }
-
-    await exportDatabase(workspaceDB, filePath);
-    shell.showItemInFolder(filePath);
-    return filePath;
-  });
-}
-
-export const registerHandlers = () => {
-  registerWorkspaceHandlers();
-  registerUIHandlers();
-  registerDBHandlers();
-};

apps/electron/layers/main/src/handlers/__tests__/handlers.spec.ts

@@ -0,0 +1,501 @@
+import assert from 'node:assert';
+import path from 'node:path';
+
+import fs from 'fs-extra';
+import type { Subscription } from 'rxjs';
+import { v4 } from 'uuid';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import * as Y from 'yjs';
+
+import type { MainIPCHandlerMap } from '../../../../constraints';
+
+const registeredHandlers = new Map<
+  string,
+  ((...args: any[]) => Promise<any>)[]
+>();
+
+const delay = (ms: number) => new Promise(r => setTimeout(r, ms));
+
+type WithoutFirstParameter<T> = T extends (_: any, ...args: infer P) => infer R
+  ? (...args: P) => R
+  : T;
+
+// common mock dispatcher for ipcMain.handle AND app.on
+// alternatively, we can use single parameter for T & F, eg, dispatch('workspace:list'),
+// however this is too hard to be typed correctly
+async function dispatch<
+  T extends keyof MainIPCHandlerMap,
+  F extends keyof MainIPCHandlerMap[T]
+>(
+  namespace: T,
+  functionName: F,
+  // @ts-ignore
+  ...args: Parameters<WithoutFirstParameter<MainIPCHandlerMap[T][F]>>
+): // @ts-ignore
+ReturnType<MainIPCHandlerMap[T][F]> {
+  // @ts-ignore
+  const handlers = registeredHandlers.get(namespace + ':' + functionName);
+  assert(handlers);
+
+  // we only care about the first handler here
+  return await handlers[0](null, ...args);
+}
+
+const SESSION_DATA_PATH = path.join(__dirname, './tmp', 'affine-test');
+
+const browserWindow = {
+  isDestroyed: () => {
+    return false;
+  },
+  setWindowButtonVisibility: (_v: boolean) => {
+    // will be stubbed later
+  },
+  webContents: {
+    send: (_type: string, ..._args: any[]) => {
+      // will be stubbed later
+    },
+  },
+};
+
+const ipcMain = {
+  handle: (key: string, callback: (...args: any[]) => Promise<any>) => {
+    const handlers = registeredHandlers.get(key) || [];
+    handlers.push(callback);
+    registeredHandlers.set(key, handlers);
+  },
+  setMaxListeners: (_n: number) => {
+    // noop
+  },
+};
+
+const nativeTheme = {
+  themeSource: 'light',
+};
+
+function compareBuffer(a: Uint8Array | null, b: Uint8Array | null) {
+  if (
+    (a === null && b === null) ||
+    a === null ||
+    b === null ||
+    a.length !== b.length
+  ) {
+    return false;
+  }
+  for (let i = 0; i < a.length; i++) {
+    if (a[i] !== b[i]) {
+      return false;
+    }
+  }
+  return true;
+}
+
+const electronModule = {
+  app: {
+    getPath: (name: string) => {
+      assert(name === 'sessionData');
+      return SESSION_DATA_PATH;
+    },
+    name: 'affine-test',
+    on: (name: string, callback: (...args: any[]) => any) => {
+      const handlers = registeredHandlers.get(name) || [];
+      handlers.push(callback);
+      registeredHandlers.set(name, handlers);
+    },
+    addEventListener: (...args: any[]) => {
+      // @ts-ignore
+      electronModule.app.on(...args);
+    },
+    removeEventListener: () => {},
+  },
+  BrowserWindow: {
+    getAllWindows: () => {
+      return [browserWindow];
+    },
+  },
+  nativeTheme: nativeTheme,
+  ipcMain,
+  shell: {} as Partial<Electron.Shell>,
+  dialog: {} as Partial<Electron.Dialog>,
+};
+
+// dynamically import handlers so that we can inject local variables to mocks
+vi.doMock('electron', () => {
+  return electronModule;
+});
+
+let connectableSubscription: Subscription;
+
+beforeEach(async () => {
+  const { registerHandlers } = await import('../register');
+  registerHandlers();
+
+  // should also register events
+  const { registerEvents } = await import('../../events');
+  registerEvents();
+  await fs.mkdirp(SESSION_DATA_PATH);
+  const { database$ } = await import('../db/ensure-db');
+
+  connectableSubscription = database$.connect();
+});
+
+afterEach(async () => {
+  // reset registered handlers
+  registeredHandlers.get('before-quit')?.forEach(fn => fn());
+
+  connectableSubscription.unsubscribe();
+
+  await fs.remove(SESSION_DATA_PATH);
+});
+
+describe('ensureSQLiteDB', () => {
+  test('should create db file on connection if it does not exist', async () => {
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    const workspaceDB = await ensureSQLiteDB(id);
+    const file = workspaceDB.path;
+    const fileExists = await fs.pathExists(file);
+    expect(fileExists).toBe(true);
+  });
+
+  test('when db file is removed', async () => {
+    // stub webContents.send
+    const sendSpy = vi.spyOn(browserWindow.webContents, 'send');
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    let workspaceDB = await ensureSQLiteDB(id);
+    const file = workspaceDB.path;
+    const fileExists = await fs.pathExists(file);
+    expect(fileExists).toBe(true);
+
+    // Can't remove file on Windows, because the sqlite is still holding the file handle
+    if (process.platform === 'win32') {
+      return;
+    }
+
+    await fs.remove(file);
+
+    // wait for 2000ms for file watcher to detect file removal
+    await delay(2000);
+
+    expect(sendSpy).toBeCalledWith('db:onDBFileMissing', id);
+
+    // ensureSQLiteDB should recreate the db file
+    workspaceDB = await ensureSQLiteDB(id);
+    const fileExists2 = await fs.pathExists(file);
+    expect(fileExists2).toBe(true);
+    sendSpy.mockRestore();
+  });
+
+  test('when db file is updated', async () => {
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    const { dbSubjects } = await import('../../events/db');
+    const workspaceDB = await ensureSQLiteDB(id);
+    const file = workspaceDB.path;
+    const fileExists = await fs.pathExists(file);
+    expect(fileExists).toBe(true);
+    const dbUpdateSpy = vi.spyOn(dbSubjects.dbFileUpdate, 'next');
+    await delay(100);
+    // writes some data to the db file
+    await fs.appendFile(file, 'random-data', { encoding: 'binary' });
+    // write again
+    await fs.appendFile(file, 'random-data', { encoding: 'binary' });
+
+    // wait for 2000ms for file watcher to detect file change
+    await delay(2000);
+
+    expect(dbUpdateSpy).toBeCalledWith(id);
+    dbUpdateSpy.mockRestore();
+  });
+});
+
+describe('workspace handlers', () => {
+  test('list all workspace ids', async () => {
+    const ids = [v4(), v4()];
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await Promise.all(ids.map(id => ensureSQLiteDB(id)));
+    const list = await dispatch('workspace', 'list');
+    expect(list.map(([id]) => id).sort()).toEqual(ids.sort());
+  });
+
+  test('delete workspace', async () => {
+    // @TODO dispatch is hanging on Windows
+    if (process.platform === 'win32') {
+      return;
+    }
+    const ids = [v4(), v4()];
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await Promise.all(ids.map(id => ensureSQLiteDB(id)));
+    await dispatch('workspace', 'delete', ids[1]);
+    const list = await dispatch('workspace', 'list');
+    expect(list.map(([id]) => id)).toEqual([ids[0]]);
+  });
+});
+
+describe('UI handlers', () => {
+  test('theme-change', async () => {
+    await dispatch('ui', 'handleThemeChange', 'dark');
+    expect(nativeTheme.themeSource).toBe('dark');
+    await dispatch('ui', 'handleThemeChange', 'light');
+    expect(nativeTheme.themeSource).toBe('light');
+  });
+
+  test('sidebar-visibility-change (macOS)', async () => {
+    vi.stubGlobal('process', { platform: 'darwin' });
+    const setWindowButtonVisibility = vi.fn();
+    browserWindow.setWindowButtonVisibility = setWindowButtonVisibility;
+    await dispatch('ui', 'handleSidebarVisibilityChange', true);
+    expect(setWindowButtonVisibility).toBeCalledWith(true);
+    await dispatch('ui', 'handleSidebarVisibilityChange', false);
+    expect(setWindowButtonVisibility).toBeCalledWith(false);
+    vi.unstubAllGlobals();
+  });
+
+  test('sidebar-visibility-change (non-macOS)', async () => {
+    vi.stubGlobal('process', { platform: 'linux' });
+    const setWindowButtonVisibility = vi.fn();
+    browserWindow.setWindowButtonVisibility = setWindowButtonVisibility;
+    await dispatch('ui', 'handleSidebarVisibilityChange', true);
+    expect(setWindowButtonVisibility).not.toBeCalled();
+    vi.unstubAllGlobals();
+  });
+});
+
+describe('db handlers', () => {
+  test('apply doc and get doc updates', async () => {
+    const workspaceId = v4();
+    const bin = await dispatch('db', 'getDocAsUpdates', workspaceId);
+    // ? is this a good test?
+    expect(bin.every((byte: number) => byte === 0)).toBe(true);
+
+    const ydoc = new Y.Doc();
+    const ytext = ydoc.getText('test');
+    ytext.insert(0, 'hello world');
+    const bin2 = Y.encodeStateAsUpdate(ydoc);
+
+    await dispatch('db', 'applyDocUpdate', workspaceId, bin2);
+
+    const bin3 = await dispatch('db', 'getDocAsUpdates', workspaceId);
+    const ydoc2 = new Y.Doc();
+    Y.applyUpdate(ydoc2, bin3);
+    const ytext2 = ydoc2.getText('test');
+    expect(ytext2.toString()).toBe('hello world');
+  });
+
+  test('get non existent blob', async () => {
+    const workspaceId = v4();
+    const bin = await dispatch('db', 'getBlob', workspaceId, 'non-existent-id');
+    expect(bin).toBeNull();
+  });
+
+  test('list blobs (empty)', async () => {
+    const workspaceId = v4();
+    const list = await dispatch('db', 'getPersistedBlobs', workspaceId);
+    expect(list).toEqual([]);
+  });
+
+  test('CRUD blobs', async () => {
+    const testBin = new Uint8Array([1, 2, 3, 4, 5]);
+    const testBin2 = new Uint8Array([6, 7, 8, 9, 10]);
+    const workspaceId = 'test-workspace-id';
+
+    // add blob
+    await dispatch('db', 'addBlob', workspaceId, 'testBin', testBin);
+
+    // get blob
+    expect(
+      compareBuffer(
+        await dispatch('db', 'getBlob', workspaceId, 'testBin'),
+        testBin
+      )
+    ).toBe(true);
+
+    // add another blob
+    await dispatch('db', 'addBlob', workspaceId, 'testBin2', testBin2);
+    expect(
+      compareBuffer(
+        await dispatch('db', 'getBlob', workspaceId, 'testBin2'),
+        testBin2
+      )
+    ).toBe(true);
+
+    // list blobs
+    let lists = await dispatch('db', 'getPersistedBlobs', workspaceId);
+    expect(lists).toHaveLength(2);
+    expect(lists).toContain('testBin');
+    expect(lists).toContain('testBin2');
+
+    // delete blob
+    await dispatch('db', 'deleteBlob', workspaceId, 'testBin');
+    lists = await dispatch('db', 'getPersistedBlobs', workspaceId);
+    expect(lists).toEqual(['testBin2']);
+  });
+});
+
+describe('dialog handlers', () => {
+  test('revealDBFile', async () => {
+    const mockShowItemInFolder = vi.fn();
+    electronModule.shell.showItemInFolder = mockShowItemInFolder;
+
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    const db = await ensureSQLiteDB(id);
+
+    await dispatch('dialog', 'revealDBFile', id);
+    expect(mockShowItemInFolder).toBeCalledWith(db.path);
+  });
+
+  test('saveDBFileAs (skipped)', async () => {
+    const mockShowSaveDialog = vi.fn(() => {
+      return { filePath: undefined };
+    }) as any;
+    const mockShowItemInFolder = vi.fn();
+    electronModule.dialog.showSaveDialog = mockShowSaveDialog;
+    electronModule.shell.showItemInFolder = mockShowItemInFolder;
+
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await ensureSQLiteDB(id);
+
+    await dispatch('dialog', 'saveDBFileAs', id);
+    expect(mockShowSaveDialog).toBeCalled();
+    expect(mockShowItemInFolder).not.toBeCalled();
+    electronModule.dialog = {};
+    electronModule.shell = {};
+  });
+
+  test('saveDBFileAs', async () => {
+    const newSavedPath = path.join(SESSION_DATA_PATH, 'saved-to');
+    const mockShowSaveDialog = vi.fn(() => {
+      return { filePath: newSavedPath };
+    }) as any;
+    const mockShowItemInFolder = vi.fn();
+    electronModule.dialog.showSaveDialog = mockShowSaveDialog;
+    electronModule.shell.showItemInFolder = mockShowItemInFolder;
+
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await ensureSQLiteDB(id);
+
+    await dispatch('dialog', 'saveDBFileAs', id);
+    expect(mockShowSaveDialog).toBeCalled();
+    expect(mockShowItemInFolder).toBeCalledWith(newSavedPath);
+
+    // check if file is saved to new path
+    expect(await fs.exists(newSavedPath)).toBe(true);
+  });
+
+  test('loadDBFile (skipped)', async () => {
+    const mockShowOpenDialog = vi.fn(() => {
+      return { filePaths: undefined };
+    }) as any;
+    electronModule.dialog.showOpenDialog = mockShowOpenDialog;
+
+    const res = await dispatch('dialog', 'loadDBFile');
+    expect(mockShowOpenDialog).toBeCalled();
+    expect(res.canceled).toBe(true);
+  });
+
+  test('loadDBFile (error, in app-data)', async () => {
+    const mockShowOpenDialog = vi.fn(() => {
+      return {
+        filePaths: [path.join(SESSION_DATA_PATH, 'workspaces')],
+      };
+    }) as any;
+    electronModule.dialog.showOpenDialog = mockShowOpenDialog;
+
+    const res = await dispatch('dialog', 'loadDBFile');
+    expect(mockShowOpenDialog).toBeCalled();
+    expect(res.error).toBe('DB_FILE_PATH_INVALID');
+  });
+
+  test('loadDBFile (error, not a valid db file)', async () => {
+    // create a random db file
+    const basePath = path.join(SESSION_DATA_PATH, 'random-path');
+    const dbPath = path.join(basePath, 'xxx.db');
+    await fs.ensureDir(basePath);
+    await fs.writeFile(dbPath, 'hello world');
+
+    const mockShowOpenDialog = vi.fn(() => {
+      return { filePaths: [dbPath] };
+    }) as any;
+    electronModule.dialog.showOpenDialog = mockShowOpenDialog;
+
+    const res = await dispatch('dialog', 'loadDBFile');
+    expect(mockShowOpenDialog).toBeCalled();
+    expect(res.error).toBe('DB_FILE_INVALID');
+
+    electronModule.dialog = {};
+  });
+
+  test('loadDBFile', async () => {
+    // we use ensureSQLiteDB to create a valid db file
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    const db = await ensureSQLiteDB(id);
+
+    // copy db file to dbPath
+    const basePath = path.join(SESSION_DATA_PATH, 'random-path');
+    const originDBFilePath = path.join(basePath, 'xxx.db');
+    await fs.ensureDir(basePath);
+    await fs.copyFile(db.path, originDBFilePath);
+
+    // on Windows, we skip this test because we can't delete the db file
+    if (process.platform === 'win32') {
+      return;
+    }
+
+    // remove db
+    await fs.remove(db.path);
+
+    // try load originDBFilePath
+    const mockShowOpenDialog = vi.fn(() => {
+      return { filePaths: [originDBFilePath] };
+    }) as any;
+    electronModule.dialog.showOpenDialog = mockShowOpenDialog;
+
+    const res = await dispatch('dialog', 'loadDBFile');
+    expect(mockShowOpenDialog).toBeCalled();
+    expect(res.workspaceId).not.toBeUndefined();
+
+    const importedDb = await ensureSQLiteDB(res.workspaceId!);
+    expect(await fs.realpath(importedDb.path)).toBe(originDBFilePath);
+    expect(importedDb.path).not.toBe(originDBFilePath);
+
+    // try load it again, will trigger error (db file already loaded)
+    const res2 = await dispatch('dialog', 'loadDBFile');
+    expect(res2.error).toBe('DB_FILE_ALREADY_LOADED');
+  });
+
+  test('moveDBFile', async () => {
+    const newPath = path.join(SESSION_DATA_PATH, 'xxx');
+    const mockShowSaveDialog = vi.fn(() => {
+      return { filePath: newPath };
+    }) as any;
+    electronModule.dialog.showSaveDialog = mockShowSaveDialog;
+
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await ensureSQLiteDB(id);
+    const res = await dispatch('dialog', 'moveDBFile', id);
+    expect(mockShowSaveDialog).toBeCalled();
+    expect(res.filePath).toBe(newPath);
+    electronModule.dialog = {};
+  });
+
+  test('moveDBFile (skipped)', async () => {
+    const mockShowSaveDialog = vi.fn(() => {
+      return { filePath: null };
+    }) as any;
+    electronModule.dialog.showSaveDialog = mockShowSaveDialog;
+
+    const id = v4();
+    const { ensureSQLiteDB } = await import('../db/ensure-db');
+    await ensureSQLiteDB(id);
+
+    const res = await dispatch('dialog', 'moveDBFile', id);
+    expect(mockShowSaveDialog).toBeCalled();
+    expect(res.filePath).toBe(undefined);
+    electronModule.dialog = {};
+  });
+});

apps/electron/layers/main/src/handlers/db/ensure-db.ts

@@ -0,0 +1,160 @@
+import type { NotifyEvent } from '@affine/native/event';
+import { createFSWatcher } from '@affine/native/fs-watcher';
+import { app } from 'electron';
+import {
+  connectable,
+  defer,
+  from,
+  fromEvent,
+  identity,
+  lastValueFrom,
+  Observable,
+  ReplaySubject,
+  Subject,
+} from 'rxjs';
+import {
+  debounceTime,
+  exhaustMap,
+  filter,
+  groupBy,
+  ignoreElements,
+  mergeMap,
+  shareReplay,
+  startWith,
+  switchMap,
+  take,
+  takeUntil,
+  tap,
+} from 'rxjs/operators';
+
+import { appContext } from '../../context';
+import { subjects } from '../../events';
+import { logger } from '../../logger';
+import { ts } from '../../utils';
+import type { WorkspaceSQLiteDB } from './sqlite';
+import { openWorkspaceDatabase } from './sqlite';
+
+const databaseInput$ = new Subject<string>();
+export const databaseConnector$ = new ReplaySubject<WorkspaceSQLiteDB>();
+
+const groupedDatabaseInput$ = databaseInput$.pipe(groupBy(identity));
+
+export const database$ = connectable(
+  groupedDatabaseInput$.pipe(
+    mergeMap(workspaceDatabase$ =>
+      workspaceDatabase$.pipe(
+        // only open the first db with the same workspaceId, and emit it to the downstream
+        exhaustMap(workspaceId => {
+          logger.info('[ensureSQLiteDB] open db connection', workspaceId);
+          return from(openWorkspaceDatabase(appContext, workspaceId)).pipe(
+            switchMap(db => {
+              return startWatchingDBFile(db).pipe(
+                // ignore all events and only emit the db to the downstream
+                ignoreElements(),
+                startWith(db)
+              );
+            })
+          );
+        }),
+        shareReplay(1)
+      )
+    ),
+    tap({
+      complete: () => {
+        logger.info('[FSWatcher] close all watchers');
+        createFSWatcher().close();
+      },
+    })
+  ),
+  {
+    connector: () => databaseConnector$,
+    resetOnDisconnect: true,
+  }
+);
+
+export const databaseConnectableSubscription = database$.connect();
+
+// 1. File delete
+// 2. File move
+//   - on Linux, it's `type: { modify: { kind: 'rename', mode: 'from' } }`
+//   - on Windows, it's `type: { remove: { kind: 'any' } }`
+//   - on macOS, it's `type: { modify: { kind: 'rename', mode: 'any' } }`
+export function isRemoveOrMoveEvent(event: NotifyEvent) {
+  return (
+    typeof event.type === 'object' &&
+    ('remove' in event.type ||
+      ('modify' in event.type &&
+        event.type.modify.kind === 'rename' &&
+        (event.type.modify.mode === 'from' ||
+          event.type.modify.mode === 'any')))
+  );
+}
+
+// if we removed the file, we will stop watching it
+function startWatchingDBFile(db: WorkspaceSQLiteDB) {
+  const FSWatcher = createFSWatcher();
+  return new Observable<NotifyEvent>(subscriber => {
+    logger.info('[FSWatcher] start watching db file', db.workspaceId);
+    const subscription = FSWatcher.watch(db.path, {
+      recursive: false,
+    }).subscribe(
+      event => {
+        logger.info('[FSWatcher]', event);
+        subscriber.next(event);
+        // remove file or move file, complete the observable and close db
+        if (isRemoveOrMoveEvent(event)) {
+          subscriber.complete();
+        }
+      },
+      err => {
+        subscriber.error(err);
+      }
+    );
+    return () => {
+      // destroy on unsubscribe
+      logger.info('[FSWatcher] cleanup db file watcher', db.workspaceId);
+      db.destroy();
+      subscription.unsubscribe();
+    };
+  }).pipe(
+    debounceTime(1000),
+    filter(event => !isRemoveOrMoveEvent(event)),
+    tap({
+      next: () => {
+        logger.info(
+          '[FSWatcher] db file changed on disk',
+          db.workspaceId,
+          ts() - db.lastUpdateTime,
+          'ms'
+        );
+        db.reconnectDB();
+        subjects.db.dbFileUpdate.next(db.workspaceId);
+      },
+      complete: () => {
+        // todo: there is still a possibility that the file is deleted
+        // but we didn't get the event soon enough and another event tries to
+        // access the db
+        logger.info('[FSWatcher] db file missing', db.workspaceId);
+        subjects.db.dbFileMissing.next(db.workspaceId);
+        db.destroy();
+      },
+    }),
+    takeUntil(defer(() => fromEvent(app, 'before-quit')))
+  );
+}
+
+export function ensureSQLiteDB(id: string) {
+  const deferValue = lastValueFrom(
+    database$.pipe(
+      filter(db => db.workspaceId === id && db.db.open),
+      take(1),
+      tap({
+        error: err => {
+          logger.error('[ensureSQLiteDB] error', err);
+        },
+      })
+    )
+  );
+  databaseInput$.next(id);
+  return deferValue;
+}

apps/electron/layers/main/src/handlers/db/index.ts

@@ -0,0 +1,42 @@
+import fs from 'fs-extra';
+
+import { appContext } from '../../context';
+import type { NamespaceHandlers } from '../type';
+import { ensureSQLiteDB } from './ensure-db';
+
+export const dbHandlers = {
+  getDocAsUpdates: async (_, id: string) => {
+    const workspaceDB = await ensureSQLiteDB(id);
+    return workspaceDB.getDocAsUpdates();
+  },
+  applyDocUpdate: async (_, id: string, update: Uint8Array) => {
+    const workspaceDB = await ensureSQLiteDB(id);
+    return workspaceDB.applyUpdate(update);
+  },
+  addBlob: async (_, workspaceId: string, key: string, data: Uint8Array) => {
+    const workspaceDB = await ensureSQLiteDB(workspaceId);
+    return workspaceDB.addBlob(key, data);
+  },
+  getBlob: async (_, workspaceId: string, key: string) => {
+    const workspaceDB = await ensureSQLiteDB(workspaceId);
+    return workspaceDB.getBlob(key);
+  },
+  deleteBlob: async (_, workspaceId: string, key: string) => {
+    const workspaceDB = await ensureSQLiteDB(workspaceId);
+    return workspaceDB.deleteBlob(key);
+  },
+  getPersistedBlobs: async (_, workspaceId: string) => {
+    const workspaceDB = await ensureSQLiteDB(workspaceId);
+    return workspaceDB.getPersistentBlobKeys();
+  },
+  getDefaultStorageLocation: async () => {
+    return appContext.appDataPath;
+  },
+  getDBFilePath: async (_, workspaceId: string) => {
+    const workspaceDB = await ensureSQLiteDB(workspaceId);
+    return {
+      path: workspaceDB.path,
+      realPath: await fs.realpath(workspaceDB.path),
+    };
+  },
+} satisfies NamespaceHandlers;

apps/electron/layers/main/src/handlers/db/sqlite.ts

@@ -0,0 +1,247 @@
+import path from 'node:path';
+
+import type { Database } from 'better-sqlite3';
+import sqlite from 'better-sqlite3';
+import fs from 'fs-extra';
+import * as Y from 'yjs';
+
+import type { AppContext } from '../../context';
+import { dbSubjects } from '../../events/db';
+import { logger } from '../../logger';
+import { ts } from '../../utils';
+
+const schemas = [
+  `CREATE TABLE IF NOT EXISTS "updates" (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  data BLOB NOT NULL,
+  timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
+)`,
+  `CREATE TABLE IF NOT EXISTS "blobs" (
+  key TEXT PRIMARY KEY NOT NULL,
+  data BLOB NOT NULL,
+  timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
+)`,
+];
+
+interface UpdateRow {
+  id: number;
+  data: Buffer;
+  timestamp: string;
+}
+
+interface BlobRow {
+  key: string;
+  data: Buffer;
+  timestamp: string;
+}
+
+const SQLITE_ORIGIN = Symbol('sqlite-origin');
+
+export class WorkspaceSQLiteDB {
+  db: Database;
+  ydoc = new Y.Doc();
+  firstConnect = false;
+  lastUpdateTime = ts();
+  destroyed = false;
+
+  constructor(public path: string, public workspaceId: string) {
+    this.db = this.reconnectDB();
+  }
+
+  // release resources
+  destroy = () => {
+    this.db?.close();
+    this.ydoc.destroy();
+  };
+
+  getWorkspaceName = () => {
+    return this.ydoc.getMap('space:meta').get('name') as string;
+  };
+
+  reconnectDB = () => {
+    logger.log('[WorkspaceSQLiteDB] open db', this.workspaceId);
+    if (this.db) {
+      this.db.close();
+    }
+
+    fs.realpath(this.path)
+      .then(realPath => {
+        dbSubjects.dbFilePathChange.next({
+          workspaceId: this.workspaceId,
+          path: this.path,
+          realPath,
+        });
+      })
+      .catch(() => {
+        // skip error
+      });
+
+    // use cached version?
+    const db = (this.db = sqlite(this.path));
+    db.exec(schemas.join(';'));
+
+    if (!this.firstConnect) {
+      this.ydoc.on('update', (update: Uint8Array, origin) => {
+        if (origin !== SQLITE_ORIGIN) {
+          this.addUpdateToSQLite(update);
+        }
+      });
+    }
+
+    Y.transact(this.ydoc, () => {
+      const updates = this.getUpdates();
+      updates.forEach(update => {
+        // give SQLITE_ORIGIN to skip self update
+        Y.applyUpdate(this.ydoc, update.data, SQLITE_ORIGIN);
+      });
+    });
+
+    this.lastUpdateTime = ts();
+
+    if (this.firstConnect) {
+      logger.info('db reconnected', this.workspaceId);
+    } else {
+      logger.info('db connected', this.workspaceId);
+    }
+
+    this.firstConnect = true;
+
+    return db;
+  };
+
+  getDocAsUpdates = () => {
+    return Y.encodeStateAsUpdate(this.ydoc);
+  };
+
+  // non-blocking and use yDoc to validate the update
+  // after that, the update is added to the db
+  applyUpdate = (data: Uint8Array) => {
+    Y.applyUpdate(this.ydoc, data);
+
+    // todo: trim the updates when the number of records is too large
+    // 1. store the current ydoc state in the db
+    // 2. then delete the old updates
+    // yjs-idb will always trim the db for the first time after DB is loaded
+    this.lastUpdateTime = ts();
+    logger.debug('applyUpdate', this.workspaceId, this.lastUpdateTime);
+  };
+
+  addBlob = (key: string, data: Uint8Array) => {
+    this.lastUpdateTime = ts();
+    try {
+      const statement = this.db.prepare(
+        'INSERT INTO blobs (key, data) VALUES (?, ?) ON CONFLICT(key) DO UPDATE SET data = ?'
+      );
+      statement.run(key, data, data);
+      return key;
+    } catch (error) {
+      logger.error('addBlob', error);
+    }
+  };
+
+  getBlob = (key: string) => {
+    try {
+      const statement = this.db.prepare('SELECT data FROM blobs WHERE key = ?');
+      const row = statement.get(key) as BlobRow;
+      if (!row) {
+        return null;
+      }
+      return row.data;
+    } catch (error) {
+      logger.error('getBlob', error);
+      return null;
+    }
+  };
+
+  deleteBlob = (key: string) => {
+    this.lastUpdateTime = ts();
+    try {
+      const statement = this.db.prepare('DELETE FROM blobs WHERE key = ?');
+      statement.run(key);
+    } catch (error) {
+      logger.error('deleteBlob', error);
+    }
+  };
+
+  getPersistentBlobKeys = () => {
+    try {
+      const statement = this.db.prepare('SELECT key FROM blobs');
+      const rows = statement.all() as BlobRow[];
+      return rows.map(row => row.key);
+    } catch (error) {
+      logger.error('getPersistentBlobKeys', error);
+      return [];
+    }
+  };
+
+  private getUpdates = () => {
+    try {
+      const statement = this.db.prepare('SELECT * FROM updates');
+      const rows = statement.all() as UpdateRow[];
+      return rows;
+    } catch (error) {
+      logger.error('getUpdates', error);
+      return [];
+    }
+  };
+
+  // batch write instead write per key stroke?
+  private addUpdateToSQLite = (data: Uint8Array) => {
+    try {
+      const start = performance.now();
+      const statement = this.db.prepare(
+        'INSERT INTO updates (data) VALUES (?)'
+      );
+      statement.run(data);
+      logger.debug(
+        'addUpdateToSQLite',
+        this.workspaceId,
+        'length:',
+        data.length,
+        performance.now() - start,
+        'ms'
+      );
+    } catch (error) {
+      logger.error('addUpdateToSQLite', error);
+    }
+  };
+}
+
+export async function getWorkspaceDBPath(
+  context: AppContext,
+  workspaceId: string
+) {
+  const basePath = path.join(context.appDataPath, 'workspaces', workspaceId);
+  await fs.ensureDir(basePath);
+  return path.join(basePath, 'storage.db');
+}
+
+export async function openWorkspaceDatabase(
+  context: AppContext,
+  workspaceId: string
+) {
+  const dbPath = await getWorkspaceDBPath(context, workspaceId);
+  return new WorkspaceSQLiteDB(dbPath, workspaceId);
+}
+
+export function isValidDBFile(path: string) {
+  let db: Database | null = null;
+  try {
+    db = sqlite(path);
+    // check if db has two tables, one for updates and onefor blobs
+    const statement = db.prepare(
+      `SELECT name FROM sqlite_schema WHERE type='table'`
+    );
+    const rows = statement.all() as { name: string }[];
+    const tableNames = rows.map(row => row.name);
+    if (!tableNames.includes('updates') || !tableNames.includes('blobs')) {
+      return false;
+    }
+    db.close();
+    return true;
+  } catch (error) {
+    logger.error('isValidDBFile', error);
+    db?.close();
+    return false;
+  }
+}

apps/electron/layers/main/src/handlers/dialog/dialog.ts

@@ -0,0 +1,323 @@
+import path from 'node:path';
+
+import { dialog, shell } from 'electron';
+import fs from 'fs-extra';
+import { nanoid } from 'nanoid';
+
+import { appContext } from '../../context';
+import { logger } from '../../logger';
+import { ensureSQLiteDB, isRemoveOrMoveEvent } from '../db/ensure-db';
+import type { WorkspaceSQLiteDB } from '../db/sqlite';
+import { getWorkspaceDBPath, isValidDBFile } from '../db/sqlite';
+import { listWorkspaces } from '../workspace/workspace';
+
+// NOTE:
+// we are using native dialogs because HTML dialogs do not give full file paths
+
+export async function revealDBFile(workspaceId: string) {
+  const workspaceDB = await ensureSQLiteDB(workspaceId);
+  shell.showItemInFolder(await fs.realpath(workspaceDB.path));
+}
+
+// provide a backdoor to set dialog path for testing in playwright
+interface FakeDialogResult {
+  canceled?: boolean;
+  filePath?: string;
+  filePaths?: string[];
+}
+
+// result will be used in the next call to showOpenDialog
+// if it is being read once, it will be reset to undefined
+let fakeDialogResult: FakeDialogResult | undefined = undefined;
+
+function getFakedResult() {
+  const result = fakeDialogResult;
+  fakeDialogResult = undefined;
+  return result;
+}
+
+export function setFakeDialogResult(result: FakeDialogResult | undefined) {
+  fakeDialogResult = result;
+  // for convenience, we will fill filePaths with filePath if it is not set
+  if (result?.filePaths === undefined && result?.filePath !== undefined) {
+    result.filePaths = [result.filePath];
+  }
+}
+
+const ErrorMessages = [
+  'DB_FILE_ALREADY_LOADED',
+  'DB_FILE_PATH_INVALID',
+  'DB_FILE_INVALID',
+  'FILE_ALREADY_EXISTS',
+  'UNKNOWN_ERROR',
+] as const;
+
+type ErrorMessage = (typeof ErrorMessages)[number];
+
+interface SaveDBFileResult {
+  filePath?: string;
+  canceled?: boolean;
+  error?: ErrorMessage;
+}
+
+/**
+ * This function is called when the user clicks the "Save" button in the "Save Workspace" dialog.
+ *
+ * It will just copy the file to the given path
+ */
+export async function saveDBFileAs(
+  workspaceId: string
+): Promise<SaveDBFileResult> {
+  try {
+    const db = await ensureSQLiteDB(workspaceId);
+    const ret =
+      getFakedResult() ??
+      (await dialog.showSaveDialog({
+        properties: ['showOverwriteConfirmation'],
+        title: 'Save Workspace',
+        showsTagField: false,
+        buttonLabel: 'Save',
+        defaultPath: `${db.getWorkspaceName()}_${workspaceId}.db`,
+        message: 'Save Workspace as a SQLite Database file',
+      }));
+    const filePath = ret.filePath;
+    if (ret.canceled || !filePath) {
+      return {
+        canceled: true,
+      };
+    }
+
+    await fs.copyFile(db.path, filePath);
+    logger.log('saved', filePath);
+    shell.showItemInFolder(filePath);
+    return { filePath };
+  } catch (err) {
+    logger.error('saveDBFileAs', err);
+    return {
+      error: 'UNKNOWN_ERROR',
+    };
+  }
+}
+
+interface SelectDBFileLocationResult {
+  filePath?: string;
+  error?: ErrorMessage;
+  canceled?: boolean;
+}
+
+export async function selectDBFileLocation(): Promise<SelectDBFileLocationResult> {
+  try {
+    const ret =
+      getFakedResult() ??
+      (await dialog.showSaveDialog({
+        properties: ['showOverwriteConfirmation'],
+        title: 'Set database location',
+        showsTagField: false,
+        buttonLabel: 'Select',
+        defaultPath: `workspace-storage.db`,
+        message: "Select a location to store the workspace's database file",
+      }));
+    const filePath = ret.filePath;
+    if (ret.canceled || !filePath) {
+      return {
+        canceled: true,
+      };
+    }
+    // the same db file cannot be loaded twice
+    if (await dbFileAlreadyLoaded(filePath)) {
+      return {
+        error: 'DB_FILE_ALREADY_LOADED',
+      };
+    }
+    return { filePath };
+  } catch (err) {
+    logger.error('selectDBFileLocation', err);
+    return {
+      error: (err as any).message,
+    };
+  }
+}
+
+interface LoadDBFileResult {
+  workspaceId?: string;
+  error?: ErrorMessage;
+  canceled?: boolean;
+}
+
+/**
+ * This function is called when the user clicks the "Load" button in the "Load Workspace" dialog.
+ *
+ * It will
+ * - symlink the source db file to a new workspace id to app-data
+ * - return the new workspace id
+ *
+ * eg, it will create a new folder in app-data:
+ * <app-data>/<app-name>/workspaces/<workspace-id>/storage.db
+ *
+ * On the renderer side, after the UI got a new workspace id, it will
+ * update the local workspace id list and then connect to it.
+ *
+ */
+export async function loadDBFile(): Promise<LoadDBFileResult> {
+  try {
+    const ret =
+      getFakedResult() ??
+      (await dialog.showOpenDialog({
+        properties: ['openFile'],
+        title: 'Load Workspace',
+        buttonLabel: 'Load',
+        filters: [
+          {
+            name: 'SQLite Database',
+            // do we want to support other file format?
+            extensions: ['db'],
+          },
+        ],
+        message: 'Load Workspace from a SQLite Database file',
+      }));
+    const filePath = ret.filePaths?.[0];
+    if (ret.canceled || !filePath) {
+      logger.info('loadDBFile canceled');
+      return { canceled: true };
+    }
+
+    // the imported file should not be in app data dir
+    if (filePath.startsWith(path.join(appContext.appDataPath, 'workspaces'))) {
+      logger.warn('loadDBFile: db file in app data dir');
+      return { error: 'DB_FILE_PATH_INVALID' };
+    }
+
+    if (await dbFileAlreadyLoaded(filePath)) {
+      logger.warn('loadDBFile: db file already loaded');
+      return { error: 'DB_FILE_ALREADY_LOADED' };
+    }
+
+    if (!isValidDBFile(filePath)) {
+      // TODO: report invalid db file error?
+      return { error: 'DB_FILE_INVALID' }; // invalid db file
+    }
+
+    // symlink the db file to a new workspace id
+    const workspaceId = nanoid(10);
+    const linkedFilePath = await getWorkspaceDBPath(appContext, workspaceId);
+
+    await fs.ensureDir(path.join(appContext.appDataPath, 'workspaces'));
+
+    await fs.symlink(filePath, linkedFilePath, 'file');
+    logger.info(`loadDBFile, symlink: ${filePath} -> ${linkedFilePath}`);
+
+    return { workspaceId };
+  } catch (err) {
+    logger.error('loadDBFile', err);
+    return {
+      error: 'UNKNOWN_ERROR',
+    };
+  }
+}
+
+interface MoveDBFileResult {
+  filePath?: string;
+  error?: ErrorMessage;
+  canceled?: boolean;
+}
+
+/**
+ * This function is called when the user clicks the "Move" button in the "Move Workspace Storage" setting.
+ *
+ * It will
+ * - move the source db file to a new location
+ * - symlink the new location to the old db file
+ * - return the new file path
+ */
+export async function moveDBFile(
+  workspaceId: string,
+  dbFileLocation?: string
+): Promise<MoveDBFileResult> {
+  let db: WorkspaceSQLiteDB | null = null;
+  try {
+    const { moveFile, FsWatcher } = await import('@affine/native');
+    db = await ensureSQLiteDB(workspaceId);
+    // get the real file path of db
+    const realpath = await fs.realpath(db.path);
+    const isLink = realpath !== db.path;
+    const watcher = FsWatcher.watch(realpath, { recursive: false });
+    const waitForRemove = new Promise<void>(resolve => {
+      const subscription = watcher.subscribe(event => {
+        if (isRemoveOrMoveEvent(event)) {
+          subscription.unsubscribe();
+          // resolve after FSWatcher in `database$` is fired
+          setImmediate(() => {
+            resolve();
+          });
+        }
+      });
+    });
+    const newFilePath =
+      dbFileLocation ??
+      (
+        getFakedResult() ??
+        (await dialog.showSaveDialog({
+          properties: ['showOverwriteConfirmation'],
+          title: 'Move Workspace Storage',
+          showsTagField: false,
+          buttonLabel: 'Save',
+          defaultPath: realpath,
+          message: 'Move Workspace storage file',
+        }))
+      ).filePath;
+
+    // skips if
+    // - user canceled the dialog
+    // - user selected the same file
+    // - user selected the same file in the link file in app data dir
+    if (!newFilePath || newFilePath === realpath || db.path === newFilePath) {
+      return {
+        canceled: true,
+      };
+    }
+
+    db.db.close();
+
+    if (await fs.pathExists(newFilePath)) {
+      return {
+        error: 'FILE_ALREADY_EXISTS',
+      };
+    }
+
+    if (isLink) {
+      // remove the old link to unblock new link
+      await fs.unlink(db.path);
+    }
+
+    logger.info(`[moveDBFile] move ${realpath} -> ${newFilePath}`);
+
+    await moveFile(realpath, newFilePath);
+
+    await fs.ensureSymlink(newFilePath, db.path, 'file');
+    logger.info(`[moveDBFile] symlink: ${realpath} -> ${newFilePath}`);
+    // wait for the file move event emits to the FileWatcher in database$ in ensure-db.ts
+    // so that the db will be destroyed and we can call the `ensureSQLiteDB` in the next step
+    // or the FileWatcher will continue listen on the `realpath` and emit file change events
+    // then the database will reload while receiving these events; and the moved database file will be recreated while reloading database
+    await waitForRemove;
+    logger.info(`removed`);
+    await ensureSQLiteDB(workspaceId);
+
+    return {
+      filePath: newFilePath,
+    };
+  } catch (err) {
+    db?.destroy();
+    logger.error('[moveDBFile]', err);
+    return {
+      error: 'UNKNOWN_ERROR',
+    };
+  }
+}
+
+async function dbFileAlreadyLoaded(path: string) {
+  const meta = await listWorkspaces(appContext);
+  const realpath = await fs.realpath(path);
+  const paths = meta.map(m => m[1].realpath);
+  return paths.includes(realpath);
+}

apps/electron/layers/main/src/handlers/dialog/index.ts

@@ -0,0 +1,33 @@
+import type { NamespaceHandlers } from '../type';
+import {
+  loadDBFile,
+  moveDBFile,
+  revealDBFile,
+  saveDBFileAs,
+  selectDBFileLocation,
+  setFakeDialogResult,
+} from './dialog';
+
+export const dialogHandlers = {
+  revealDBFile: async (_, workspaceId: string) => {
+    return revealDBFile(workspaceId);
+  },
+  loadDBFile: async () => {
+    return loadDBFile();
+  },
+  saveDBFileAs: async (_, workspaceId: string) => {
+    return saveDBFileAs(workspaceId);
+  },
+  moveDBFile: (_, workspaceId: string, dbFileLocation?: string) => {
+    return moveDBFile(workspaceId, dbFileLocation);
+  },
+  selectDBFileLocation: async () => {
+    return selectDBFileLocation();
+  },
+  setFakeDialogResult: async (
+    _,
+    result: Parameters<typeof setFakeDialogResult>[0]
+  ) => {
+    return setFakeDialogResult(result);
+  },
+} satisfies NamespaceHandlers;

apps/electron/layers/main/src/handlers/index.ts

@@ -0,0 +1 @@
+export * from './register';

apps/electron/layers/main/src/handlers/register.ts

@@ -0,0 +1,65 @@
+import { ipcMain } from 'electron';
+
+import { getLogFilePath, logger, revealLogFile } from '../logger';
+import { dbHandlers } from './db';
+import { dialogHandlers } from './dialog';
+import { uiHandlers } from './ui';
+import { updaterHandlers } from './updater';
+import { workspaceHandlers } from './workspace';
+
+type IsomorphicHandler = (
+  e: Electron.IpcMainInvokeEvent,
+  ...args: any[]
+) => Promise<any>;
+
+type NamespaceHandlers = {
+  [key: string]: IsomorphicHandler;
+};
+
+export const debugHandlers = {
+  revealLogFile: async () => {
+    return revealLogFile();
+  },
+  logFilePath: async () => {
+    return getLogFilePath();
+  },
+};
+
+// Note: all of these handlers will be the single-source-of-truth for the apis exposed to the renderer process
+export const allHandlers = {
+  workspace: workspaceHandlers,
+  ui: uiHandlers,
+  db: dbHandlers,
+  dialog: dialogHandlers,
+  debug: debugHandlers,
+  updater: updaterHandlers,
+} satisfies Record<string, NamespaceHandlers>;
+
+export const registerHandlers = () => {
+  // TODO: listen to namespace instead of individual event types
+  ipcMain.setMaxListeners(100);
+  for (const [namespace, namespaceHandlers] of Object.entries(allHandlers)) {
+    for (const [key, handler] of Object.entries(namespaceHandlers)) {
+      const chan = `${namespace}:${key}`;
+      ipcMain.handle(chan, async (e, ...args) => {
+        const start = performance.now();
+        try {
+          const result = await handler(e, ...args);
+          logger.info(
+            '[ipc-api]',
+            chan,
+            args.filter(
+              arg => typeof arg !== 'function' && typeof arg !== 'object'
+            ),
+            '-',
+            (performance.now() - start).toFixed(2),
+            'ms'
+          );
+          return result;
+        } catch (error) {
+          logger.error('[ipc]', chan, error);
+        }
+      });
+    }
+  }
+};

apps/electron/layers/main/src/handlers/type.ts

@@ -0,0 +1,8 @@
+export type IsomorphicHandler = (
+  e: Electron.IpcMainInvokeEvent,
+  ...args: any[]
+) => Promise<any>;
+
+export type NamespaceHandlers = {
+  [key: string]: IsomorphicHandler;
+};

apps/electron/layers/main/src/handlers/ui/google-auth.ts

@@ -0,0 +1,58 @@
+import { app, BrowserWindow, shell } from 'electron';
+import { parse } from 'url';
+
+import { logger } from '../../logger';
+
+const redirectUri = 'https://affine.pro/client/auth-callback';
+
+export const oauthEndpoint = `https://accounts.google.com/o/oauth2/v2/auth?client_id=${process.env.AFFINE_GOOGLE_CLIENT_ID}&redirect_uri=${redirectUri}&response_type=code&scope=openid https://www.googleapis.com/auth/userinfo.email profile&access_type=offline&customParameters={"prompt":"select_account"}`;
+
+const tokenEndpoint = 'https://oauth2.googleapis.com/token';
+
+export const getExchangeTokenParams = (code: string) => {
+  const postData = {
+    code,
+    client_id: process.env.AFFINE_GOOGLE_CLIENT_ID || '',
+    client_secret: process.env.AFFINE_GOOGLE_CLIENT_SECRET || '',
+    redirect_uri: redirectUri,
+    grant_type: 'authorization_code',
+  };
+  const requestInit: RequestInit = {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+    body: new URLSearchParams(postData).toString(),
+  };
+  return { requestInit, url: tokenEndpoint };
+};
+
+export function getGoogleOauthCode() {
+  shell.openExternal(oauthEndpoint);
+
+  return new Promise<ReturnType<typeof getExchangeTokenParams>>(
+    (resolve, reject) => {
+      const handleOpenUrl = async (_: any, url: string) => {
+        const mainWindow = BrowserWindow.getAllWindows().find(
+          w => !w.isDestroyed()
+        );
+        const urlObj = parse(url.replace('??', '?'), true);
+        if (!mainWindow || !url.startsWith('affine://auth-callback')) return;
+        const code = urlObj.query['code'] as string;
+        if (!code) return;
+
+        logger.info('google sign in code received from callback', code);
+
+        app.removeListener('open-url', handleOpenUrl);
+        resolve(getExchangeTokenParams(code));
+      };
+
+      app.on('open-url', handleOpenUrl);
+
+      setTimeout(() => {
+        reject(new Error('Timed out'));
+        app.removeListener('open-url', handleOpenUrl);
+      }, 30000);
+    }
+  );
+}

apps/electron/layers/main/src/handlers/ui/index.ts

@@ -0,0 +1,42 @@
+import { app, BrowserWindow, nativeTheme } from 'electron';
+
+import { isMacOS } from '../../../../utils';
+import type { NamespaceHandlers } from '../type';
+import { getGoogleOauthCode } from './google-auth';
+
+export const uiHandlers = {
+  handleThemeChange: async (_, theme: (typeof nativeTheme)['themeSource']) => {
+    nativeTheme.themeSource = theme;
+  },
+  handleSidebarVisibilityChange: async (_, visible: boolean) => {
+    if (isMacOS()) {
+      const windows = BrowserWindow.getAllWindows();
+      windows.forEach(w => {
+        // hide window buttons when sidebar is not visible
+        w.setWindowButtonVisibility(visible);
+      });
+    }
+  },
+  handleMinimizeApp: async () => {
+    const windows = BrowserWindow.getAllWindows();
+    windows.forEach(w => {
+      w.minimize();
+    });
+  },
+  handleMaximizeApp: async () => {
+    const windows = BrowserWindow.getAllWindows();
+    windows.forEach(w => {
+      if (w.isMaximized()) {
+        w.unmaximize();
+      } else {
+        w.maximize();
+      }
+    });
+  },
+  handleCloseApp: async () => {
+    app.quit();
+  },
+  getGoogleOauthCode: async () => {
+    return getGoogleOauthCode();
+  },
+} satisfies NamespaceHandlers;

apps/electron/layers/main/src/handlers/updater/index.ts

@@ -0,0 +1,18 @@
+import { app } from 'electron';
+
+import type { NamespaceHandlers } from '../type';
+import { checkForUpdatesAndNotify, quitAndInstall } from './updater';
+
+export const updaterHandlers = {
+  currentVersion: async () => {
+    return app.getVersion();
+  },
+  quitAndInstall: async () => {
+    return quitAndInstall();
+  },
+  checkForUpdatesAndNotify: async () => {
+    return checkForUpdatesAndNotify(true);
+  },
+} satisfies NamespaceHandlers;
+
+export * from './updater';

apps/electron/layers/main/src/handlers/updater/updater.ts

@@ -0,0 +1,100 @@
+import { app } from 'electron';
+import type { AppUpdater } from 'electron-updater';
+import { z } from 'zod';
+
+import { isMacOS } from '../../../../utils';
+import { updaterSubjects } from '../../events/updater';
+import { logger } from '../../logger';
+
+export const ReleaseTypeSchema = z.enum([
+  'stable',
+  'beta',
+  'canary',
+  'internal',
+]);
+
+export const envBuildType = (process.env.BUILD_TYPE || 'canary')
+  .trim()
+  .toLowerCase();
+export const buildType = ReleaseTypeSchema.parse(envBuildType);
+const mode = process.env.NODE_ENV;
+const isDev = mode === 'development';
+
+let _autoUpdater: AppUpdater | null = null;
+
+export const quitAndInstall = async () => {
+  _autoUpdater?.quitAndInstall();
+};
+
+let lastCheckTime = 0;
+export const checkForUpdatesAndNotify = async (force = true) => {
+  if (!_autoUpdater) {
+    return; // ?
+  }
+  // check every 30 minutes (1800 seconds) at most
+  if (force || lastCheckTime + 1000 * 1800 < Date.now()) {
+    lastCheckTime = Date.now();
+    return _autoUpdater.checkForUpdatesAndNotify();
+  }
+};
+
+export const registerUpdater = async () => {
+  // require it will cause some side effects and will break generate-main-exposed-meta,
+  // so we wrap it in a function
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const { autoUpdater } = require('electron-updater');
+
+  _autoUpdater = autoUpdater;
+
+  if (!_autoUpdater) {
+    return;
+  }
+
+  // TODO: support auto update on windows and linux
+  const allowAutoUpdate = isMacOS();
+
+  _autoUpdater.autoDownload = false;
+  _autoUpdater.allowPrerelease = buildType !== 'stable';
+  _autoUpdater.autoInstallOnAppQuit = false;
+  _autoUpdater.autoRunAppAfterInstall = true;
+  _autoUpdater.setFeedURL({
+    channel: buildType,
+    provider: 'github',
+    repo: buildType !== 'internal' ? 'AFFiNE' : 'AFFiNE-Releases',
+    owner: 'toeverything',
+    releaseType: buildType === 'stable' ? 'release' : 'prerelease',
+  });
+
+  // register events for checkForUpdatesAndNotify
+  _autoUpdater.on('update-available', info => {
+    if (allowAutoUpdate) {
+      _autoUpdater!.downloadUpdate();
+      logger.info('Update available, downloading...', info);
+    }
+    updaterSubjects.updateAvailable.next({
+      version: info.version,
+      allowAutoUpdate,
+    });
+  });
+  _autoUpdater.on('download-progress', e => {
+    logger.info(`Download progress: ${e.percent}`);
+    updaterSubjects.downloadProgress.next(e.percent);
+  });
+  _autoUpdater.on('update-downloaded', e => {
+    updaterSubjects.updateReady.next({
+      version: e.version,
+      allowAutoUpdate,
+    });
+    // I guess we can skip it?
+    // updaterSubjects.clientDownloadProgress.next(100);
+    logger.info('Update downloaded, ready to install');
+  });
+  _autoUpdater.on('error', e => {
+    logger.error('Error while updating client', e);
+  });
+  _autoUpdater.forceDevUpdateConfig = isDev;
+
+  app.on('activate', async () => {
+    await checkForUpdatesAndNotify(false);
+  });
+};

apps/electron/layers/main/src/handlers/workspace/index.ts

@@ -0,0 +1,8 @@
+import { appContext } from '../../context';
+import type { NamespaceHandlers } from '../type';
+import { deleteWorkspace, listWorkspaces } from './workspace';
+
+export const workspaceHandlers = {
+  list: async () => listWorkspaces(appContext),
+  delete: async (_, id: string) => deleteWorkspace(appContext, id),
+} satisfies NamespaceHandlers;

apps/electron/layers/main/src/handlers/workspace/workspace.ts

@@ -0,0 +1,60 @@
+import path from 'node:path';
+
+import fs from 'fs-extra';
+
+import type { AppContext } from '../../context';
+import { logger } from '../../logger';
+
+interface WorkspaceMeta {
+  path: string;
+  realpath: string;
+}
+
+export async function listWorkspaces(
+  context: AppContext
+): Promise<[workspaceId: string, meta: WorkspaceMeta][]> {
+  const basePath = path.join(context.appDataPath, 'workspaces');
+  try {
+    await fs.ensureDir(basePath);
+    const dirs = await fs.readdir(basePath, {
+      withFileTypes: true,
+    });
+
+    const meta = await Promise.all(
+      dirs.map(async dir => {
+        const dbFilePath = path.join(basePath, dir.name, 'storage.db');
+        if (dir.isDirectory() && (await fs.exists(dbFilePath))) {
+          // try read storage.db under it
+          const realpath = await fs.realpath(dbFilePath);
+          return [dir.name, { path: dbFilePath, realpath }] as [
+            string,
+            WorkspaceMeta
+          ];
+        } else {
+          return null;
+        }
+      })
+    );
+
+    return meta.filter((w): w is [string, WorkspaceMeta] => !!w);
+  } catch (error) {
+    logger.error('listWorkspaces', error);
+    return [];
+  }
+}
+
+export async function deleteWorkspace(context: AppContext, id: string) {
+  const basePath = path.join(context.appDataPath, 'workspaces', id);
+  const movedPath = path.join(
+    context.appDataPath,
+    'delete-workspaces',
+    `${id}`
+  );
+  try {
+    return await fs.move(basePath, movedPath, {
+      overwrite: true,
+    });
+  } catch (error) {
+    logger.error('deleteWorkspace', error);
+  }
+}

apps/electron/layers/main/src/index.ts

@@ -1,23 +1,23 @@
 import './security-restrictions';
 
 import { app } from 'electron';
-import path from 'path';
 
-import { logger } from '../../logger';
+import { createApplicationMenu } from './application-menu';
+import { registerEvents } from './events';
 import { registerHandlers } from './handlers';
+import { registerUpdater } from './handlers/updater';
+import { logger } from './logger';
 import { restoreOrCreateWindow } from './main-window';
 import { registerProtocol } from './protocol';
 
-if (require('electron-squirrel-startup')) app.exit();
-if (process.defaultApp) {
-  if (process.argv.length >= 2) {
-    app.setAsDefaultProtocolClient('affine', process.execPath, [
-      path.resolve(process.argv[1]),
-    ]);
-  }
-} else {
-  app.setAsDefaultProtocolClient('affine');
+if (require('electron-squirrel-startup')) app.quit();
+// allow tests to overwrite app name through passing args
+if (process.argv.includes('--app-name')) {
+  const appNameIndex = process.argv.indexOf('--app-name');
+  const appName = process.argv[appNameIndex + 1];
+  app.setName(appName);
 }
+
 /**
  * Prevent multiple instances
  */
@@ -57,7 +57,10 @@ app
   .whenReady()
   .then(registerProtocol)
   .then(registerHandlers)
+  .then(registerEvents)
   .then(restoreOrCreateWindow)
+  .then(createApplicationMenu)
+  .then(registerUpdater)
   .catch(e => console.error('Failed create window:', e));
 /**
  * Check new app version in production mode only

apps/electron/layers/main/src/logger.ts

@@ -0,0 +1,13 @@
+import { shell } from 'electron';
+import log from 'electron-log';
+
+export const logger = log;
+
+export function getLogFilePath() {
+  return log.transports.file.getFile().path;
+}
+
+export function revealLogFile() {
+  const filePath = getLogFilePath();
+  shell.showItemInFolder(filePath);
+}

apps/electron/layers/main/src/main-window.ts

@@ -2,8 +2,8 @@ import { BrowserWindow, nativeTheme } from 'electron';
 import electronWindowState from 'electron-window-state';
 import { join } from 'path';
 
-import { logger } from '../../logger';
-import { isMacOS } from '../../utils';
+import { isMacOS, isWindows } from '../../utils';
+import { logger } from './logger';
 
 const IS_DEV: boolean =
   process.env.NODE_ENV === 'development' && !process.env.CI;
@@ -18,13 +18,17 @@ async function createWindow() {
   });
 
   const browserWindow = new BrowserWindow({
-    titleBarStyle: isMacOS() ? 'hiddenInset' : 'default',
+    titleBarStyle: isMacOS()
+      ? 'hiddenInset'
+      : isWindows()
+      ? 'hidden'
+      : 'default',
     trafficLightPosition: { x: 24, y: 18 },
     x: mainWindowState.x,
     y: mainWindowState.y,
     width: mainWindowState.width,
     minWidth: 640,
-    transparent: isMacOS(),
+    minHeight: 480,
     visualEffectState: 'active',
     vibrancy: 'under-window',
     height: mainWindowState.height,
@@ -60,7 +64,9 @@ async function createWindow() {
     logger.info('main window is ready to show');
 
     if (DEV_TOOL) {
-      browserWindow.webContents.openDevTools();
+      browserWindow.webContents.openDevTools({
+        mode: 'detach',
+      });
     }
   });
 
@@ -75,9 +81,11 @@ async function createWindow() {
    */
   const pageUrl = process.env.DEV_SERVER_URL || 'file://./index.html'; // see protocol.ts
 
+  logger.info('loading page at', pageUrl);
+
   await browserWindow.loadURL(pageUrl);
 
-  logger.info('main window is loaded at' + pageUrl);
+  logger.info('main window is loaded at', pageUrl);
 
   return browserWindow;
 }

apps/electron/layers/main/src/protocol.ts

@@ -33,7 +33,6 @@ export function registerProtocol() {
   protocol.interceptFileProtocol('file', (request, callback) => {
     const url = request.url.replace(/^file:\/\//, '');
     const realpath = toAbsolutePath(url);
-    // console.log('realpath', realpath, 'for', url);
     callback(realpath);
     return true;
   });
@@ -41,7 +40,6 @@ export function registerProtocol() {
   protocol.registerFileProtocol('assets', (request, callback) => {
     const url = request.url.replace(/^assets:\/\//, '');
     const realpath = toAbsolutePath(url);
-    // console.log('realpath', realpath, 'for', url);
     callback(realpath);
     return true;
   });

apps/electron/layers/main/src/send-main-event.ts

@@ -1,14 +0,0 @@
-import { BrowserWindow } from 'electron';
-
-import type { MainEventMap } from '../../main-events';
-
-function getActiveWindows() {
-  return BrowserWindow.getAllWindows().filter(win => !win.isDestroyed());
-}
-
-export function sendMainEvent<T extends keyof MainEventMap>(
-  type: T,
-  ...args: Parameters<MainEventMap[T]>
-) {
-  getActiveWindows().forEach(win => win.webContents.send(type, ...args));
-}

apps/electron/layers/main/src/utils.ts

@@ -0,0 +1,19 @@
+export function debounce<T extends (...args: any[]) => void>(
+  fn: T,
+  delay: number
+) {
+  let timeoutId: NodeJS.Timer | undefined;
+  return (...args: Parameters<T>) => {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    timeoutId = setTimeout(() => {
+      fn(...args);
+      timeoutId = undefined;
+    }, delay);
+  };
+}
+
+export function ts() {
+  return new Date().getTime();
+}

apps/electron/layers/main/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext",
-    "sourceMap": false,
-    "moduleResolution": "Node",
-    "skipLibCheck": true,
-    "strict": true,
-    "isolatedModules": true,
-    "allowSyntheticDefaultImports": true,
-
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts", "../../types/**/*.d.ts", "index.ts", "../utils.ts"]
-}

apps/electron/layers/preload/preload.d.ts

@@ -2,5 +2,6 @@
 
 interface Window {
   apis: typeof import('./src/affine-apis').apis;
+  events: typeof import('./src/affine-apis').events;
   appInfo: typeof import('./src/affine-apis').appInfo;
 }

apps/electron/layers/preload/src/affine-apis.ts

@@ -1,81 +1,92 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 // NOTE: we will generate preload types from this file
 
 import { ipcRenderer } from 'electron';
 
-import type { MainEventMap } from '../../main-events';
+import type { MainIPCEventMap, MainIPCHandlerMap } from '../../constraints';
 
-// main -> renderer
-function onMainEvent<T extends keyof MainEventMap>(
-  eventName: T,
-  callback: MainEventMap[T]
-): () => void {
-  // @ts-expect-error fix me later
-  const fn = (_, ...args) => callback(...args);
-  ipcRenderer.on(eventName, fn);
-  return () => ipcRenderer.off(eventName, fn);
-}
+type WithoutFirstParameter<T> = T extends (_: any, ...args: infer P) => infer R
+  ? (...args: P) => R
+  : T;
 
-const apis = {
-  db: {
-    // workspace providers
-    getDoc: (id: string): Promise<Uint8Array | null> =>
-      ipcRenderer.invoke('db:get-doc', id),
-    applyDocUpdate: (id: string, update: Uint8Array) =>
-      ipcRenderer.invoke('db:apply-doc-update', id, update),
-    addBlob: (workspaceId: string, key: string, data: Uint8Array) =>
-      ipcRenderer.invoke('db:add-blob', workspaceId, key, data),
-    getBlob: (workspaceId: string, key: string): Promise<Uint8Array | null> =>
-      ipcRenderer.invoke('db:get-blob', workspaceId, key),
-    deleteBlob: (workspaceId: string, key: string) =>
-      ipcRenderer.invoke('db:delete-blob', workspaceId, key),
-    getPersistedBlobs: (workspaceId: string): Promise<string[]> =>
-      ipcRenderer.invoke('db:get-persisted-blobs', workspaceId),
-
-    // listeners
-    onDBUpdate: (callback: (workspaceId: string) => void) => {
-      return onMainEvent('main:on-db-update', callback);
-    },
-  },
-
-  workspace: {
-    list: (): Promise<string[]> => ipcRenderer.invoke('workspace:list'),
-    delete: (id: string): Promise<void> =>
-      ipcRenderer.invoke('workspace:delete', id),
-    // create will be implicitly called by db functions
-  },
-
-  openLoadDBFileDialog: () => ipcRenderer.invoke('ui:open-load-db-file-dialog'),
-  openSaveDBFileDialog: () => ipcRenderer.invoke('ui:open-save-db-file-dialog'),
-
-  // ui
-  onThemeChange: (theme: string) =>
-    ipcRenderer.invoke('ui:theme-change', theme),
-
-  onSidebarVisibilityChange: (visible: boolean) =>
-    ipcRenderer.invoke('ui:sidebar-visibility-change', visible),
-
-  onWorkspaceChange: (workspaceId: string) =>
-    ipcRenderer.invoke('ui:workspace-change', workspaceId),
-
-  openDBFolder: () => ipcRenderer.invoke('ui:open-db-folder'),
-
-  /**
-   * Try sign in using Google and return a request object to exchange the code for a token
-   * Not exchange in Node side because it is easier to do it in the renderer with VPN
-   */
-  getGoogleOauthCode: (): Promise<{ requestInit: RequestInit; url: string }> =>
-    ipcRenderer.invoke('ui:get-google-oauth-code'),
-
-  /**
-   * Secret backdoor to update environment variables in main process
-   */
-  updateEnv: (env: string, value: string) => {
-    ipcRenderer.invoke('main:env-update', env, value);
-  },
+type HandlersMap<N extends keyof MainIPCHandlerMap> = {
+  [K in keyof MainIPCHandlerMap[N]]: WithoutFirstParameter<
+    MainIPCHandlerMap[N][K]
+  >;
 };
 
+type PreloadHandlers = {
+  [N in keyof MainIPCHandlerMap]: HandlersMap<N>;
+};
+
+type MainExposedMeta = {
+  handlers: [namespace: string, handlerNames: string[]][];
+  events: [namespace: string, eventNames: string[]][];
+};
+
+// main handlers that can be invoked from the renderer process
+const apis: PreloadHandlers = (() => {
+  // the following were generated by the build script
+  // 1. bundle extra main/src/expose.ts entry
+  // 2. use generate-main-exposed-meta.mjs to generate exposed-meta.js in dist
+  //
+  // we cannot directly import main/src/handlers.ts because it will be bundled into the preload bundle
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const {
+    handlers: handlersMeta,
+  }: MainExposedMeta = require('../main/exposed-meta');
+
+  const all = handlersMeta.map(([namespace, functionNames]) => {
+    const namespaceApis = functionNames.map(name => {
+      const channel = `${namespace}:${name}`;
+      return [
+        name,
+        (...args: any[]) => {
+          return ipcRenderer.invoke(channel, ...args);
+        },
+      ];
+    });
+    return [namespace, Object.fromEntries(namespaceApis)];
+  });
+
+  return Object.fromEntries(all);
+})();
+
+// main events that can be listened to from the renderer process
+const events: MainIPCEventMap = (() => {
+  const {
+    events: eventsMeta,
+  }: MainExposedMeta = require('../main/exposed-meta');
+
+  // NOTE: ui may try to listen to a lot of the same events, so we increase the limit...
+  ipcRenderer.setMaxListeners(100);
+
+  const all = eventsMeta.map(([namespace, eventNames]) => {
+    const namespaceEvents = eventNames.map(name => {
+      const channel = `${namespace}:${name}`;
+      return [
+        name,
+        (callback: (...args: any[]) => void) => {
+          const fn: (
+            event: Electron.IpcRendererEvent,
+            ...args: any[]
+          ) => void = (_, ...args) => {
+            callback(...args);
+          };
+          ipcRenderer.on(channel, fn);
+          return () => {
+            ipcRenderer.off(channel, fn);
+          };
+        },
+      ];
+    });
+    return [namespace, Object.fromEntries(namespaceEvents)];
+  });
+  return Object.fromEntries(all);
+})();
+
 const appInfo = {
   electron: true,
 };
 
-export { apis, appInfo };
+export { apis, appInfo, events };

apps/electron/layers/preload/src/index.ts

@@ -14,4 +14,5 @@ import * as affineApis from './affine-apis';
  */
 
 contextBridge.exposeInMainWorld('apis', affineApis.apis);
+contextBridge.exposeInMainWorld('events', affineApis.events);
 contextBridge.exposeInMainWorld('appInfo', affineApis.appInfo);

apps/electron/layers/preload/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext",
-    "sourceMap": false,
-    "moduleResolution": "Node",
-    "skipLibCheck": true,
-    "strict": true,
-    "isolatedModules": true,
-
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts", "../../types/**/*.d.ts"]
-}

apps/electron/layers/utils.ts

@@ -1,3 +1,7 @@
 export const isMacOS = () => {
   return process.platform === 'darwin';
 };
+
+export const isWindows = () => {
+  return process.platform === 'win32';
+};

apps/electron/package.json

@@ -1,21 +1,24 @@
 {
   "name": "@affine/electron",
   "private": true,
-  "version": "0.5.4-canary.25",
+  "version": "0.6.0-canary.8",
   "author": "affine",
+  "repository": {
+    "url": "https://github.com/toeverything/AFFiNE",
+    "type": "git"
+  },
   "description": "AFFiNE App",
   "homepage": "https://github.com/toeverything/AFFiNE",
   "scripts": {
     "dev": "yarn electron-rebuild && yarn cross-env DEV_SERVER_URL=http://localhost:8080 node scripts/dev.mjs",
+    "watch": "yarn electron-rebuild && yarn cross-env DEV_SERVER_URL=http://localhost:8080 node scripts/dev.mjs --watch",
     "prod": "yarn electron-rebuild && yarn node scripts/dev.mjs",
+    "build-layers": "zx scripts/build-layers.mjs",
     "generate-assets": "zx scripts/generate-assets.mjs",
+    "generate-main-exposed-meta": "zx scripts/generate-main-exposed-meta.mjs",
     "package": "electron-forge package",
     "make": "electron-forge make",
-    "make-macos-arm64": "electron-forge make --platform=darwin --arch=arm64",
-    "make-macos-x64": "electron-forge make --platform=darwin --arch=x64",
-    "make-windows-x64": "electron-forge make --platform=win32 --arch=x64",
-    "make-linux-x64": "electron-forge make --platform=linux --arch=x64",
-    "rebuild:for-test": "yarn rebuild better-sqlite3",
+    "rebuild:for-unit-test": "yarn rebuild better-sqlite3",
     "rebuild:for-electron": "yarn electron-rebuild",
     "test": "playwright test"
   },
@@ -25,6 +28,7 @@
   "main": "./dist/layers/main/index.js",
   "devDependencies": {
     "@affine-test/kit": "workspace:*",
+    "@affine/native": "workspace:*",
     "@electron-forge/cli": "^6.1.1",
     "@electron-forge/core": "^6.1.1",
     "@electron-forge/core-utils": "^6.1.1",
@@ -37,20 +41,26 @@
     "@electron/remote": "2.0.9",
     "@types/better-sqlite3": "^7.6.4",
     "@types/fs-extra": "^11.0.1",
+    "@types/uuid": "^9.0.1",
     "cross-env": "7.0.3",
-    "electron": "24.2.0",
-    "electron-log": "^5.0.0-beta.23",
+    "electron": "24.4.0",
+    "electron-log": "^5.0.0-beta.24",
     "electron-squirrel-startup": "1.0.0",
     "electron-window-state": "^5.0.3",
-    "esbuild": "^0.17.18",
+    "esbuild": "^0.17.19",
     "fs-extra": "^11.1.1",
     "playwright": "^1.33.0",
     "ts-node": "^10.9.1",
-    "undici": "^5.22.0",
+    "undici": "^5.22.1",
+    "uuid": "^9.0.0",
     "zx": "^7.2.2"
   },
   "dependencies": {
     "better-sqlite3": "^8.3.0",
+    "chokidar": "^3.5.3",
+    "electron-updater": "^5.3.0",
+    "nanoid": "^4.0.2",
+    "rxjs": "^7.8.1",
     "yjs": "^13.6.1"
   },
   "build": {

apps/electron/resources/app-update.yml

@@ -0,0 +1,4 @@
+owner: toeverything
+repo: AFFiNE
+provider: github
+private: false

apps/electron/scripts/build-ci.mts

@@ -1,17 +0,0 @@
-#!/usr/bin/env ts-node-esm
-import * as esbuild from 'esbuild';
-
-import { config } from './common.mjs';
-
-const common = config();
-await esbuild.build(common.preload);
-
-await esbuild.build({
-  ...common.main,
-  define: {
-    ...common.main.define,
-    'process.env.NODE_ENV': `"production"`,
-  },
-});
-
-console.log('Compiled successfully.');

apps/electron/scripts/build-layers.mjs

@@ -0,0 +1,33 @@
+#!/usr/bin/env zx
+import 'zx/globals';
+
+import * as esbuild from 'esbuild';
+
+import { config } from './common.mjs';
+
+const NODE_ENV =
+  process.env.NODE_ENV === 'development' ? 'development' : 'production';
+
+if (process.platform === 'win32') {
+  $.shell = true;
+  $.prefix = '';
+}
+
+async function buildLayers() {
+  const common = config();
+  await esbuild.build(common.preload);
+
+  await esbuild.build({
+    ...common.main,
+    define: {
+      ...common.main.define,
+      'process.env.NODE_ENV': `"${NODE_ENV}"`,
+      'process.env.BUILD_TYPE': `"${process.env.BUILD_TYPE || 'stable'}"`,
+    },
+  });
+
+  await $`yarn workspace @affine/electron generate-main-exposed-meta`;
+}
+
+await buildLayers();
+echo('Build layers done');

apps/electron/scripts/common.mjs

@@ -5,37 +5,48 @@ import { fileURLToPath } from 'url';
 export const root = fileURLToPath(new URL('..', import.meta.url));
 export const NODE_MAJOR_VERSION = 18;
 
-const nativeNodeModulesPlugin = {
-  name: 'native-node-modules',
-  setup(build) {
-    // Mark native Node.js modules as external
-    build.onResolve({ filter: /\.node$/, namespace: 'file' }, args => {
-      return { path: args.path, external: true };
-    });
-  },
-};
+// hard-coded for now:
+// fixme(xp): report error if app is not running on DEV_SERVER_URL
+const DEV_SERVER_URL = process.env.DEV_SERVER_URL;
+
+/** @type 'production' | 'development'' */
+const mode = (process.env.NODE_ENV = process.env.NODE_ENV || 'development');
 
 // List of env that will be replaced by esbuild
 const ENV_MACROS = ['AFFINE_GOOGLE_CLIENT_ID', 'AFFINE_GOOGLE_CLIENT_SECRET'];
 
 /** @return {{main: import('esbuild').BuildOptions, preload: import('esbuild').BuildOptions}} */
 export const config = () => {
-  const define = Object.fromEntries(
-    ENV_MACROS.map(key => [
+  const define = Object.fromEntries([
+    ...ENV_MACROS.map(key => [
       'process.env.' + key,
       JSON.stringify(process.env[key] ?? ''),
-    ])
-  );
+    ]),
+    ['process.env.NODE_ENV', `"${mode}"`],
+  ]);
+
+  if (DEV_SERVER_URL) {
+    define['process.env.DEV_SERVER_URL'] = `"${DEV_SERVER_URL}"`;
+  }
+
   return {
     main: {
-      entryPoints: [resolve(root, './layers/main/src/index.ts')],
+      entryPoints: [
+        resolve(root, './layers/main/src/index.ts'),
+        resolve(root, './layers/main/src/exposed.ts'),
+      ],
       outdir: resolve(root, './dist/layers/main'),
       bundle: true,
       target: `node${NODE_MAJOR_VERSION}`,
       platform: 'node',
-      external: ['electron', 'yjs', 'better-sqlite3'],
-      plugins: [nativeNodeModulesPlugin],
+      external: ['electron', 'yjs', 'better-sqlite3', 'electron-updater'],
       define: define,
+      format: 'cjs',
+      loader: {
+        '.node': 'copy',
+      },
+      assetNames: '[name]',
+      treeShaking: true,
     },
     preload: {
       entryPoints: [resolve(root, './layers/preload/src/index.ts')],
@@ -43,7 +54,7 @@ export const config = () => {
       bundle: true,
       target: `node${NODE_MAJOR_VERSION}`,
       platform: 'node',
-      external: ['electron'],
+      external: ['electron', '../main/exposed-meta'],
       define: define,
     },
   };

apps/electron/scripts/dev.mjs

@@ -1,4 +1,5 @@
-import { spawn } from 'node:child_process';
+/* eslint-disable no-async-promise-executor */
+import { execSync, spawn } from 'node:child_process';
 import { readFileSync } from 'node:fs';
 import path from 'node:path';
 
@@ -7,8 +8,8 @@ import * as esbuild from 'esbuild';
 
 import { config, root } from './common.mjs';
 
-/** @type 'production' | 'development'' */
-const mode = (process.env.NODE_ENV = process.env.NODE_ENV || 'development');
+// this means we don't spawn electron windows, mainly for testing
+const watchMode = process.argv.includes('--watch');
 
 /** Messages on stderr that match any of the contained patterns will be stripped from output */
 const stderrFilterPatterns = [
@@ -29,14 +30,13 @@ try {
   );
 }
 
-// hard-coded for now:
-// fixme(xp): report error if app is not running on DEV_SERVER_URL
-const DEV_SERVER_URL = process.env.DEV_SERVER_URL;
-
 /** @type {ChildProcessWithoutNullStreams | null} */
 let spawnProcess = null;
 
 function spawnOrReloadElectron() {
+  if (watchMode) {
+    return;
+  }
   if (spawnProcess !== null) {
     spawnProcess.off('exit', process.exit);
     spawnProcess.kill('SIGINT');
@@ -59,77 +59,80 @@ function spawnOrReloadElectron() {
     console.error(data);
   });
 
-  // Stops the watch script when the application has been quit
+  // Stops the watch script when the application has quit
   spawnProcess.on('exit', process.exit);
 }
 
 const common = config();
 
-async function main() {
-  async function watchPreload(onInitialBuild) {
+function watchPreload() {
+  return new Promise(async resolve => {
+    let initialBuild = false;
     const preloadBuild = await esbuild.context({
       ...common.preload,
       plugins: [
         ...(common.preload.plugins ?? []),
         {
-          name: 'affine-dev:reload-app-on-preload-change',
+          name: 'electron-dev:reload-app-on-preload-change',
           setup(build) {
-            let initialBuild = false;
             build.onEnd(() => {
               if (initialBuild) {
-                console.log(`[preload] has changed`);
+                console.log(`[preload] has changed, [re]launching electron...`);
                 spawnOrReloadElectron();
               } else {
+                resolve();
                 initialBuild = true;
-                onInitialBuild();
               }
             });
           },
         },
       ],
     });
+    // watch will trigger build.onEnd() on first run & on subsequent changes
     await preloadBuild.watch();
-  }
+  });
+}
 
-  async function watchMain() {
-    const define = {
-      ...common.main.define,
-      'process.env.NODE_ENV': `"${mode}"`,
-    };
-
-    if (DEV_SERVER_URL) {
-      define['process.env.DEV_SERVER_URL'] = `"${DEV_SERVER_URL}"`;
-    }
+async function watchMain() {
+  return new Promise(async resolve => {
+    let initialBuild = false;
 
     const mainBuild = await esbuild.context({
       ...common.main,
-      define: define,
       plugins: [
         ...(common.main.plugins ?? []),
         {
-          name: 'affine-dev:reload-app-on-main-change',
+          name: 'electron-dev:reload-app-on-main-change',
           setup(build) {
-            let initialBuild = false;
             build.onEnd(() => {
+              execSync('yarn generate-main-exposed-meta');
+
               if (initialBuild) {
                 console.log(`[main] has changed, [re]launching electron...`);
+                spawnOrReloadElectron();
               } else {
+                resolve();
                 initialBuild = true;
               }
-              spawnOrReloadElectron();
             });
           },
         },
       ],
     });
     await mainBuild.watch();
-  }
-
-  await watchPreload(async () => {
-    await watchMain();
-    spawnOrReloadElectron();
-    console.log(`Electron is started, watching for changes...`);
   });
 }
 
+async function main() {
+  await watchMain();
+  await watchPreload();
+
+  if (watchMode) {
+    console.log(`Watching for changes...`);
+  } else {
+    spawnOrReloadElectron();
+    console.log(`Electron is started, watching for changes...`);
+  }
+}
+
 main();

apps/electron/scripts/generate-assets.mjs

@@ -1,11 +1,10 @@
 #!/usr/bin/env zx
 import 'zx/globals';
 
+import { createRequire } from 'node:module';
 import path from 'node:path';
 
-import * as esbuild from 'esbuild';
-
-import { config } from './common.mjs';
+const require = createRequire(import.meta.url);
 
 const repoRootDir = path.join(__dirname, '..', '..', '..');
 const electronRootDir = path.join(__dirname, '..');
@@ -13,6 +12,7 @@ const publicDistDir = path.join(electronRootDir, 'resources');
 const affineWebDir = path.join(repoRootDir, 'apps', 'web');
 const affineWebOutDir = path.join(affineWebDir, 'out');
 const publicAffineOutDir = path.join(publicDistDir, `web-static`);
+const releaseVersionEnv = process.env.RELEASE_VERSION || '';
 
 console.log('build with following dir', {
   repoRootDir,
@@ -23,9 +23,16 @@ console.log('build with following dir', {
   publicAffineOutDir,
 });
 
+// step 0: check version match
+const electronPackageJson = require(`${electronRootDir}/package.json`);
+if (releaseVersionEnv && electronPackageJson.version !== releaseVersionEnv) {
+  throw new Error(
+    `Version mismatch, expected ${releaseVersionEnv} but got ${electronPackageJson.version}`
+  );
+}
 // copy web dist files to electron dist
 
-// step 0: clean up
+// step 1: clean up
 await cleanup();
 echo('Clean up done');
 
@@ -36,10 +43,6 @@ if (process.platform === 'win32') {
 
 cd(repoRootDir);
 
-// step 1: build electron resources
-await buildLayers();
-echo('Build layers done');
-
 // step 2: build web (nextjs) dist
 if (!process.env.SKIP_WEB_BUILD) {
   process.env.ENABLE_LEGACY_PROVIDER = 'false';
@@ -64,6 +67,17 @@ if (!process.env.SKIP_WEB_BUILD) {
   await fs.move(affineWebOutDir, publicAffineOutDir, { overwrite: true });
 }
 
+// step 3: update app-updater.yml content with build type in resources folder
+if (process.env.BUILD_TYPE === 'internal') {
+  const appUpdaterYml = path.join(publicDistDir, 'app-update.yml');
+  const appUpdaterYmlContent = await fs.readFile(appUpdaterYml, 'utf-8');
+  const newAppUpdaterYmlContent = appUpdaterYmlContent.replace(
+    'AFFiNE',
+    'AFFiNE-Releases'
+  );
+  await fs.writeFile(appUpdaterYml, newAppUpdaterYmlContent);
+}
+
 /// --------
 /// --------
 /// --------
@@ -75,16 +89,3 @@ async function cleanup() {
   await fs.emptyDir(path.join(electronRootDir, 'layers', 'preload', 'dist'));
   await fs.remove(path.join(electronRootDir, 'out'));
 }
-
-async function buildLayers() {
-  const common = config();
-  await esbuild.build(common.preload);
-
-  await esbuild.build({
-    ...common.main,
-    define: {
-      ...common.main.define,
-      'process.env.NODE_ENV': `"production"`,
-    },
-  });
-}

apps/electron/scripts/generate-main-exposed-meta.mjs

@@ -0,0 +1,36 @@
+const mainDistDir = path.resolve(__dirname, '../dist/layers/main');
+
+// be careful and avoid any side effects in
+const { handlers, events } = await import(
+  'file://' + path.resolve(mainDistDir, 'exposed.js')
+);
+
+const handlersMeta = Object.entries(handlers).map(
+  ([namespace, namespaceHandlers]) => {
+    return [
+      namespace,
+      Object.keys(namespaceHandlers).map(handlerName => handlerName),
+    ];
+  }
+);
+
+const eventsMeta = Object.entries(events).map(
+  ([namespace, namespaceHandlers]) => {
+    return [
+      namespace,
+      Object.keys(namespaceHandlers).map(handlerName => handlerName),
+    ];
+  }
+);
+
+const meta = {
+  handlers: handlersMeta,
+  events: eventsMeta,
+};
+
+await fs.writeFile(
+  path.resolve(mainDistDir, 'exposed-meta.js'),
+  `module.exports = ${JSON.stringify(meta)};`
+);
+
+console.log('generate main exposed-meta.js done');

apps/electron/tests/basic.spec.ts

@@ -1,74 +1,116 @@
-import { resolve } from 'node:path';
+import { platform } from 'node:os';
 
-import { test, testResultDir } from '@affine-test/kit/playwright';
-import type { Page } from '@playwright/test';
 import { expect } from '@playwright/test';
-import type { ElectronApplication } from 'playwright';
-import { _electron as electron } from 'playwright';
 
-let electronApp: ElectronApplication;
-let page: Page;
+import { test } from './fixture';
 
-test.beforeEach(async () => {
-  electronApp = await electron.launch({
-    args: [resolve(__dirname, '..')],
-    executablePath: resolve(__dirname, '../node_modules/.bin/electron'),
-    colorScheme: 'light',
-  });
-  page = await electronApp.firstWindow();
-  await page.getByTestId('onboarding-modal-close-button').click({
-    delay: 100,
-  });
-  // cleanup page data
-  await page.evaluate(() => localStorage.clear());
-});
-
-test.afterEach(async () => {
-  // cleanup page data
-  await page.evaluate(() => localStorage.clear());
-  await page.close();
-  await electronApp.close();
-});
-
-test('new page', async () => {
+test('new page', async ({ page, workspace }) => {
   await page.getByTestId('new-page-button').click({
     delay: 100,
   });
   await page.waitForSelector('v-line');
-  const flavour = await page.evaluate(
-    // @ts-expect-error
-    () => globalThis.currentWorkspace.flavour
-  );
+  const flavour = (await workspace.current()).flavour;
   expect(flavour).toBe('local');
 });
 
-test('app theme', async () => {
-  await page.waitForSelector('v-line');
+// macOS only
+if (platform() === 'darwin') {
+  test('app sidebar router forward/back', async ({ page }) => {
+    await page.getByTestId('help-island').click();
+    await page.getByTestId('easy-guide').click();
+    await page.getByTestId('onboarding-modal-next-button').click();
+    await page.getByTestId('onboarding-modal-close-button').click();
+    {
+      // create pages
+      await page.waitForTimeout(500);
+      await page.getByTestId('new-page-button').click({
+        delay: 100,
+      });
+      await page.waitForSelector('v-line');
+      await page.focus('.affine-default-page-block-title');
+      await page.type('.affine-default-page-block-title', 'test1', {
+        delay: 100,
+      });
+      await page.waitForTimeout(500);
+      await page.getByTestId('new-page-button').click({
+        delay: 100,
+      });
+      await page.waitForSelector('v-line');
+      await page.focus('.affine-default-page-block-title');
+      await page.type('.affine-default-page-block-title', 'test2', {
+        delay: 100,
+      });
+      await page.waitForTimeout(500);
+      await page.getByTestId('new-page-button').click({
+        delay: 100,
+      });
+      await page.waitForSelector('v-line');
+      await page.focus('.affine-default-page-block-title');
+      await page.type('.affine-default-page-block-title', 'test3', {
+        delay: 100,
+      });
+    }
+    {
+      const title = (await page
+        .locator('.affine-default-page-block-title')
+        .textContent()) as string;
+      expect(title.trim()).toBe('test3');
+    }
+
+    await page.click('[data-testid="app-sidebar-arrow-button-back"]');
+    await page.waitForTimeout(1000);
+    await page.click('[data-testid="app-sidebar-arrow-button-back"]');
+    await page.waitForTimeout(1000);
+    {
+      const title = (await page
+        .locator('.affine-default-page-block-title')
+        .textContent()) as string;
+      expect(title.trim()).toBe('test1');
+    }
+    await page.click('[data-testid="app-sidebar-arrow-button-forward"]');
+    await page.waitForTimeout(1000);
+    await page.click('[data-testid="app-sidebar-arrow-button-forward"]');
+    await page.waitForTimeout(1000);
+    {
+      const title = (await page
+        .locator('.affine-default-page-block-title')
+        .textContent()) as string;
+      expect(title.trim()).toBe('test3');
+    }
+  });
+}
+
+test('app theme', async ({ page, electronApp }) => {
   const root = page.locator('html');
   {
     const themeMode = await root.evaluate(element =>
       element.getAttribute('data-theme')
     );
     expect(themeMode).toBe('light');
+
+    const theme = await electronApp.evaluate(({ nativeTheme }) => {
+      return nativeTheme.shouldUseDarkColors ? 'dark' : 'light';
+    });
+
+    expect(theme).toBe('light');
   }
-  await page.screenshot({
-    path: resolve(testResultDir, 'affine-light-theme-electron.png'),
-  });
-  await page.getByTestId('editor-option-menu').click();
-  await page.getByTestId('change-theme-dark').click();
-  await page.waitForTimeout(50);
+
   {
+    await page.getByTestId('editor-option-menu').click();
+    await page.getByTestId('change-theme-dark').click();
+    await page.waitForTimeout(50);
     const themeMode = await root.evaluate(element =>
       element.getAttribute('data-theme')
     );
     expect(themeMode).toBe('dark');
+    const theme = await electronApp.evaluate(({ nativeTheme }) => {
+      return nativeTheme.shouldUseDarkColors ? 'dark' : 'light';
+    });
+    expect(theme).toBe('dark');
   }
-  await page.screenshot({
-    path: resolve(testResultDir, 'affine-dark-theme-electron.png'),
-  });
 });
 
-test('affine cloud disabled', async () => {
+test('affine cloud disabled', async ({ page }) => {
   await page.getByTestId('new-page-button').click({
     delay: 100,
   });
@@ -79,7 +121,8 @@ test('affine cloud disabled', async () => {
     state: 'visible',
   });
 });
-test('affine onboarding button', async () => {
+
+test('affine onboarding button', async ({ page }) => {
   await page.getByTestId('help-island').click();
   await page.getByTestId('easy-guide').click();
   const onboardingModal = page.locator('[data-testid=onboarding-modal]');
@@ -93,7 +136,7 @@ test('affine onboarding button', async () => {
     '[data-testid=onboarding-modal-editing-video]'
   );
   expect(await editingVideo.isVisible()).toEqual(true);
-  await page.getByTestId('onboarding-modal-ok-button').click();
+  await page.getByTestId('onboarding-modal-close-button').click();
 
   expect(await onboardingModal.isVisible()).toEqual(false);
 });

apps/electron/tests/fixture.ts

@@ -0,0 +1,126 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../layers/preload/preload.d.ts" />
+
+/* eslint-disable no-empty-pattern */
+import crypto from 'node:crypto';
+import { join, resolve } from 'node:path';
+
+import {
+  enableCoverage,
+  istanbulTempDir,
+  test as base,
+  testResultDir,
+} from '@affine-test/kit/playwright';
+import fs from 'fs-extra';
+import type { ElectronApplication, Page } from 'playwright';
+import { _electron as electron } from 'playwright';
+
+function generateUUID() {
+  return crypto.randomUUID();
+}
+
+export const test = base.extend<{
+  page: Page;
+  electronApp: ElectronApplication;
+  appInfo: {
+    appPath: string;
+    appData: string;
+    sessionData: string;
+  };
+  workspace: {
+    // get current workspace
+    current: () => Promise<any>; // todo: type
+  };
+}>({
+  page: async ({ electronApp }, use) => {
+    const page = await electronApp.firstWindow();
+    await page.getByTestId('onboarding-modal-close-button').click({
+      delay: 100,
+    });
+    if (!process.env.CI) {
+      await electronApp.evaluate(({ BrowserWindow }) => {
+        BrowserWindow.getAllWindows()[0].webContents.openDevTools({
+          mode: 'detach',
+        });
+      });
+    }
+    const logFilePath = await page.evaluate(async () => {
+      return window.apis?.debug.logFilePath();
+    });
+    // wat for blocksuite to be loaded
+    await page.waitForSelector('v-line');
+    if (enableCoverage) {
+      await fs.promises.mkdir(istanbulTempDir, { recursive: true });
+      await page.exposeFunction(
+        'collectIstanbulCoverage',
+        (coverageJSON?: string) => {
+          if (coverageJSON)
+            fs.writeFileSync(
+              join(
+                istanbulTempDir,
+                `playwright_coverage_${generateUUID()}.json`
+              ),
+              coverageJSON
+            );
+        }
+      );
+    }
+    await use(page);
+    if (enableCoverage) {
+      await page.evaluate(() =>
+        // @ts-expect-error
+        window.collectIstanbulCoverage(JSON.stringify(window.__coverage__))
+      );
+    }
+    await page.close();
+    if (logFilePath) {
+      const logs = await fs.readFile(logFilePath, 'utf-8');
+      console.log(logs);
+    }
+  },
+  electronApp: async ({}, use) => {
+    // a random id to avoid conflicts between tests
+    const id = generateUUID();
+    const ext = process.platform === 'win32' ? '.cmd' : '';
+    const electronApp = await electron.launch({
+      args: [resolve(__dirname, '..'), '--app-name', 'affine-test-' + id],
+      executablePath: resolve(
+        __dirname,
+        '..',
+        'node_modules',
+        '.bin',
+        `electron${ext}`
+      ),
+      recordVideo: {
+        dir: testResultDir,
+      },
+      colorScheme: 'light',
+    });
+    await use(electronApp);
+    // FIXME: the following does not work well on CI
+    // const sessionDataPath = await electronApp.evaluate(async ({ app }) => {
+    //   return app.getPath('sessionData');
+    // });
+    // await fs.rm(sessionDataPath, { recursive: true, force: true });
+  },
+  appInfo: async ({ electronApp }, use) => {
+    const appInfo = await electronApp.evaluate(async ({ app }) => {
+      return {
+        appPath: app.getAppPath(),
+        appData: app.getPath('appData'),
+        sessionData: app.getPath('sessionData'),
+      };
+    });
+    await use(appInfo);
+  },
+  workspace: async ({ page }, use) => {
+    await use({
+      current: async () => {
+        return await page.evaluate(async () => {
+          // @ts-expect-error
+          return globalThis.currentWorkspace;
+        });
+      },
+    });
+  },
+});

apps/electron/tests/setup.ts

@@ -0,0 +1,8 @@
+import { execSync } from 'node:child_process';
+import { join } from 'node:path';
+
+export default async function () {
+  execSync('yarn ts-node-esm scripts/', {
+    cwd: join(__dirname, '..'),
+  });
+}

apps/electron/tests/workspace.spec.ts

@@ -0,0 +1,97 @@
+import path from 'node:path';
+
+import { expect } from '@playwright/test';
+import fs from 'fs-extra';
+
+import { test } from './fixture';
+
+test('check workspace has a DB file', async ({ appInfo, workspace }) => {
+  const w = await workspace.current();
+  const dbPath = path.join(
+    appInfo.sessionData,
+    'workspaces',
+    w.id,
+    'storage.db'
+  );
+  // check if db file exists
+  expect(await fs.exists(dbPath)).toBe(true);
+});
+
+test('move workspace db file', async ({ page, appInfo, workspace }) => {
+  const w = await workspace.current();
+  const settingButton = page.getByTestId('slider-bar-workspace-setting-button');
+  // goto settings
+  await settingButton.click();
+
+  const tmpPath = path.join(appInfo.sessionData, w.id + '-tmp.db');
+
+  // move db file to tmp folder
+  await page.evaluate(tmpPath => {
+    window.apis?.dialog.setFakeDialogResult({
+      filePath: tmpPath,
+    });
+  }, tmpPath);
+
+  await page.getByTestId('move-folder').click();
+  // check if db file exists
+  await page.waitForSelector('text="Move folder success"');
+  expect(await fs.exists(tmpPath)).toBe(true);
+});
+
+test('export then add', async ({ page, appInfo, workspace }) => {
+  const w = await workspace.current();
+  const settingButton = page.getByTestId('slider-bar-workspace-setting-button');
+  // goto settings
+  await settingButton.click();
+
+  const originalId = w.id;
+
+  const newWorkspaceName = 'new-test-name';
+
+  // change workspace name
+  await page.getByTestId('workspace-name-input').fill(newWorkspaceName);
+  await page.getByTestId('save-workspace-name').click();
+  await page.waitForSelector('text="Update workspace name success"');
+  await page.click('[data-tab-key="export"]');
+
+  const tmpPath = path.join(appInfo.sessionData, w.id + '-tmp.db');
+
+  // move db file to tmp folder
+  await page.evaluate(tmpPath => {
+    window.apis?.dialog.setFakeDialogResult({
+      filePath: tmpPath,
+    });
+  }, tmpPath);
+
+  await page.getByTestId('export-affine-backup').click();
+  await page.waitForSelector('text="Export success"');
+
+  expect(await fs.exists(tmpPath)).toBe(true);
+
+  // add workspace
+  // we are reusing the same db file so that we don't need to maintain one
+  // in the codebase
+
+  await page.getByTestId('current-workspace').click();
+  await page.getByTestId('add-or-new-workspace').click();
+
+  await page.evaluate(tmpPath => {
+    window.apis?.dialog.setFakeDialogResult({
+      filePath: tmpPath,
+    });
+  }, tmpPath);
+
+  // load the db file
+  await page.getByTestId('add-workspace').click();
+
+  // should show "Added Successfully" dialog
+  await page.waitForSelector('text="Added Successfully"');
+  await page.getByTestId('create-workspace-continue-button').click();
+
+  // sleep for a while to wait for the workspace to be added :D
+  await page.waitForTimeout(2000);
+  const newWorkspace = await workspace.current();
+  expect(newWorkspace.id).not.toBe(originalId);
+  // check its name is correct
+  await expect(page.getByTestId('workspace-name')).toHaveText(newWorkspaceName);
+});

apps/electron/tsconfig.json

@@ -1,23 +1,24 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "composite": true,
+    "skipLibCheck": true,
     "target": "ESNext",
     "module": "ESNext",
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
-    "moduleResolution": "bundler",
-    "isolatedModules": false,
-    "resolveJsonModule": true,
     "types": ["node"],
     "outDir": "dist",
-    "noEmit": false
+    "moduleResolution": "node",
+    "resolveJsonModule": true
   },
-  "include": ["layers", "types", "package.json"],
+  "include": ["**/*.ts", "**/*.tsx", "package.json"],
   "exclude": ["out", "dist", "node_modules"],
   "references": [
     {
       "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "../../packages/native"
     }
   ],
   "ts-node": {

apps/server/migrations/migration_lock.toml

@@ -1,3 +1,3 @@
 # Please do not edit this file manually
 # It should be added in your version-control system (i.e. Git)
-provider = "postgresql"
+provider = "postgresql"

apps/server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@affine/server",
   "private": true,
-  "version": "0.5.4-canary.25",
+  "version": "0.6.0-canary.8",
   "description": "Affine Node.js server",
   "type": "module",
   "bin": {
@@ -16,36 +16,35 @@
   "dependencies": {
     "@apollo/server": "^4.7.1",
     "@nestjs/apollo": "^11.0.5",
-    "@nestjs/common": "^9.4.0",
-    "@nestjs/core": "^9.4.0",
+    "@nestjs/common": "^9.4.1",
+    "@nestjs/core": "^9.4.1",
     "@nestjs/graphql": "^11.0.5",
-    "@nestjs/platform-express": "^9.4.0",
-    "@prisma/client": "^4.13.0",
-    "bcrypt": "^5.1.0",
+    "@nestjs/platform-express": "^9.4.1",
+    "@node-rs/bcrypt": "^1.7.1",
+    "@prisma/client": "^4.14.1",
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
     "graphql": "^16.6.0",
     "graphql-type-json": "^0.3.2",
     "jsonwebtoken": "^9.0.0",
     "lodash-es": "^4.17.21",
-    "prisma": "^4.13.0",
+    "prisma": "^4.14.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@nestjs/testing": "^9.4.0",
-    "@types/bcrypt": "^5.0.0",
+    "@nestjs/testing": "^9.4.1",
     "@types/express": "^4.17.17",
     "@types/jsonwebtoken": "^9.0.2",
     "@types/lodash-es": "^4.17.7",
-    "@types/node": "^18.16.5",
+    "@types/node": "^18.16.13",
     "@types/supertest": "^2.0.12",
     "c8": "^7.13.0",
     "nodemon": "^2.0.22",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4",
-    "vitest": "^0.31.0"
+    "vitest": "^0.31.1"
   },
   "nodemonConfig": {
     "exec": "node",

apps/server/scripts/gen-auth-key.ts

@@ -1,6 +1,6 @@
 import crypto from 'node:crypto';
 
-import { genSalt } from 'bcrypt';
+import { genSalt } from '@node-rs/bcrypt';
 
 const { privateKey, publicKey } = crypto.generateKeyPairSync('ec', {
   namedCurve: 'prime256v1',

apps/server/src/config/def.ts

@@ -169,10 +169,6 @@ export interface AFFiNEConfig {
    * authentication config
    */
   auth: {
-    /**
-     * Application sign key secret
-     */
-    readonly salt: string;
     /**
      * Application access token expiration time
      */

apps/server/src/config/default.ts

@@ -56,7 +56,6 @@ export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => ({
     debug: true,
   },
   auth: {
-    salt: '$2b$10$x4VDo2nmlo74yB5jflNhlu',
     accessTokenExpiresIn: '1h',
     refreshTokenExpiresIn: '7d',
     publicKey: examplePublicKey,

apps/server/src/modules/auth/service.ts

@@ -3,8 +3,8 @@ import {
   Injectable,
   UnauthorizedException,
 } from '@nestjs/common';
+import { compare, hash } from '@node-rs/bcrypt';
 import { User } from '@prisma/client';
-import { compare, hash } from 'bcrypt';
 import jwt from 'jsonwebtoken';
 
 import { Config } from '../../config';
@@ -69,7 +69,7 @@ export class AuthService {
   }
 
   async register(name: string, email: string, password: string): Promise<User> {
-    const hashedPassword = await hash(password, this.config.auth.salt);
+    const hashedPassword = await hash(password);
 
     const user = await this.prisma.user.findFirst({
       where: {

apps/server/src/tests/app.e2e.ts

@@ -3,8 +3,8 @@ import { afterEach, beforeEach, describe, test } from 'node:test';
 
 import { INestApplication } from '@nestjs/common';
 import { Test } from '@nestjs/testing';
+import { hash } from '@node-rs/bcrypt';
 import { PrismaClient } from '@prisma/client';
-import { hash } from 'bcrypt';
 import request from 'supertest';
 
 import { AppModule } from '../app';
@@ -27,7 +27,7 @@ describe('AppModule', () => {
         id: '1',
         name: 'Alex Yang',
         email: 'alex.yang@example.org',
-        password: await hash('123456', globalThis.AFFiNE.auth.salt),
+        password: await hash('123456'),
       },
     });
   });

apps/web/README.md

@@ -10,7 +10,7 @@ First, run the development server:
 pnpm run dev
 ```
 
-Open [http://localhost:8080](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:8080](http://localhost:8080) with your browser to see the result.
 
 You can start editing the page by modifying `src/pages/workspace/[workspaceId]/all.tsx`. The page auto-updates as you edit the file.
 

apps/web/next.config.mjs

@@ -10,7 +10,7 @@ import debugLocal from 'next-debug-local';
 import { fileURLToPath } from 'url';
 
 import { blockSuiteFeatureFlags, buildFlags } from './preset.config.mjs';
-import { getCommitHash, getGitVersion } from './scripts/gitInfo.mjs';
+import { getCommitHash, getGitVersion } from './scripts/git-info.mjs';
 
 const require = createRequire(import.meta.url);
 const { createVanillaExtractPlugin } = require('@vanilla-extract/next-plugin');
@@ -111,7 +111,6 @@ const nextConfig = {
     '@affine/jotai',
     '@toeverything/hooks',
     '@toeverything/y-indexeddb',
-    '@toeverything/theme',
   ],
   publicRuntimeConfig: {
     PROJECT_NAME: process.env.npm_package_name ?? 'AFFiNE',

apps/web/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@affine/web",
   "private": true,
-  "version": "0.5.4-canary.25",
+  "version": "0.6.0-canary.8",
   "scripts": {
     "dev": "next dev",
     "build": "next build",
     "export": "next export",
-    "start": "next start",
-    "lint": "next lint"
+    "start": "next start"
   },
   "dependencies": {
     "@affine-test/fixtures": "workspace:*",
@@ -19,33 +18,35 @@
     "@affine/jotai": "workspace:*",
     "@affine/templates": "workspace:*",
     "@affine/workspace": "workspace:*",
-    "@blocksuite/blocks": "0.0.0-20230505225643-03f75e5e-nightly",
-    "@blocksuite/editor": "0.0.0-20230505225643-03f75e5e-nightly",
-    "@blocksuite/global": "0.0.0-20230505225643-03f75e5e-nightly",
-    "@blocksuite/icons": "^2.1.15",
-    "@blocksuite/store": "0.0.0-20230505225643-03f75e5e-nightly",
+    "@blocksuite/blocks": "0.0.0-20230525011821-20259c76-nightly",
+    "@blocksuite/editor": "0.0.0-20230525011821-20259c76-nightly",
+    "@blocksuite/global": "0.0.0-20230525011821-20259c76-nightly",
+    "@blocksuite/icons": "^2.1.19",
+    "@blocksuite/lit": "0.0.0-20230525011821-20259c76-nightly",
+    "@blocksuite/store": "0.0.0-20230525011821-20259c76-nightly",
     "@dnd-kit/core": "^6.0.8",
     "@dnd-kit/sortable": "^7.0.2",
-    "@emotion/cache": "^11.10.8",
-    "@emotion/react": "^11.10.8",
-    "@emotion/server": "^11.10.0",
-    "@emotion/styled": "^11.10.8",
-    "@mui/material": "^5.12.3",
+    "@emotion/cache": "^11.11.0",
+    "@emotion/react": "^11.11.0",
+    "@emotion/server": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
+    "@mui/material": "^5.13.1",
     "@react-hookz/web": "^23.0.0",
-    "@sentry/nextjs": "^7.51.0",
+    "@sentry/nextjs": "^7.52.1",
     "@toeverything/hooks": "workspace:*",
     "cmdk": "^0.2.0",
     "css-spring": "^4.1.0",
     "dayjs": "^1.11.7",
     "graphql": "^16.6.0",
     "jotai": "^2.1.0",
-    "jotai-devtools": "^0.5.2",
+    "jotai-devtools": "^0.5.3",
     "lit": "^2.7.4",
     "lottie-web": "^5.11.0",
     "next-themes": "^0.2.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "react": "18.3.0-canary-16d053d59-20230506",
+    "react-dom": "18.3.0-canary-16d053d59-20230506",
     "react-is": "^18.2.0",
+    "rxjs": "^7.8.1",
     "swr": "^2.1.5",
     "y-protocols": "^1.0.5",
     "yjs": "^13.6.1",
@@ -58,22 +59,23 @@
     "@sentry/webpack-plugin": "^1.20.1",
     "@swc-jotai/debug-label": "^0.0.10",
     "@swc-jotai/react-refresh": "^0.0.8",
-    "@types/react": "^18.2.5",
+    "@types/react": "^18.2.6",
     "@types/react-dom": "^18.2.4",
     "@types/webpack-env": "^1.18.0",
     "@vanilla-extract/css": "^1.11.0",
     "@vanilla-extract/next-plugin": "^2.1.2",
     "dotenv": "^16.0.3",
     "eslint": "^8.40.0",
-    "eslint-config-next": "^13.4.1",
-    "next": "^13.4.1",
+    "eslint-config-next": "^13.4.2",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "next": "^13.4.2",
     "next-debug-local": "^0.1.5",
     "next-router-mock": "^0.9.3",
     "raw-loader": "^4.0.2",
     "redux": "^4.2.1",
     "swc-plugin-coverage-instrument": "^0.0.18",
     "typescript": "^5.0.4",
-    "webpack": "^5.82.0"
+    "webpack": "^5.83.1"
   },
   "stableVersion": "0.0.0"
 }

apps/web/preset.config.mjs

@@ -18,6 +18,9 @@ export const blockSuiteFeatureFlags = {
  * @type {import('@affine/env').BuildFlags}
  */
 export const buildFlags = {
+  enableImagePreviewModal: process.env.ENABLE_IMAGE_PREVIEW_MODAL
+    ? process.env.ENABLE_IMAGE_PREVIEW_MODAL === 'true'
+    : true,
   enableTestProperties: process.env.ENABLE_TEST_PROPERTIES
     ? process.env.ENABLE_TEST_PROPERTIES === 'true'
     : true,
@@ -30,4 +33,7 @@ export const buildFlags = {
   enableDebugPage: Boolean(
     process.env.ENABLE_DEBUG_PAGE ?? process.env.NODE_ENV === 'development'
   ),
+  changelogUrl:
+    process.env.CHANGELOG_URL ??
+    'https://affine.pro/blog/whats-new-affine-0518',
 };

apps/web/src/adapters/affine/fetcher.ts

@@ -1,12 +1,12 @@
+import { Unreachable } from '@affine/env/constant';
 import { rootStore } from '@affine/workspace/atom';
-import type { AffineWorkspace } from '@affine/workspace/type';
+import type { AffineLegacyCloudWorkspace } from '@affine/workspace/type';
 import { WorkspaceFlavour } from '@affine/workspace/type';
 import { createEmptyBlockSuiteWorkspace } from '@affine/workspace/utils';
 import { assertExists } from '@blocksuite/store';
 
 import { workspacesAtom } from '../../atoms';
 import { createAffineProviders } from '../../blocksuite';
-import { Unreachable } from '../../components/affine/affine-error-eoundary';
 import { affineApis } from '../../shared/apis';
 
 type Query = (typeof QueryKey)[keyof typeof QueryKey];
@@ -70,7 +70,7 @@ export const fetcher = async (
               workspaceApis: affineApis,
             }
           );
-          const remWorkspace: AffineWorkspace = {
+          const remWorkspace: AffineLegacyCloudWorkspace = {
             ...workspace,
             flavour: WorkspaceFlavour.AFFINE,
             blockSuiteWorkspace,

apps/web/src/adapters/affine/index.tsx

@@ -1,9 +1,13 @@
-import { AFFINE_STORAGE_KEY, config, prefixUrl } from '@affine/env';
+/**
+ * This file has deprecated because we do not maintain legacy affine cloud,
+ *  please use new affine cloud instead.
+ */
+import { AFFINE_STORAGE_KEY, config } from '@affine/env';
 import { initPage } from '@affine/env/blocksuite';
+import { PageNotFoundError } from '@affine/env/constant';
 import { currentAffineUserAtom } from '@affine/workspace/affine/atom';
 import {
   clearLoginStorage,
-  createAffineAuth,
   getLoginStorage,
   isExpired,
   parseIdToken,
@@ -11,8 +15,13 @@ import {
   SignMethod,
 } from '@affine/workspace/affine/login';
 import { rootStore, rootWorkspacesMetadataAtom } from '@affine/workspace/atom';
-import type { AffineWorkspace } from '@affine/workspace/type';
-import { LoadPriority, WorkspaceFlavour } from '@affine/workspace/type';
+import { createIndexedDBBackgroundProvider } from '@affine/workspace/providers';
+import type { AffineLegacyCloudWorkspace } from '@affine/workspace/type';
+import {
+  LoadPriority,
+  ReleaseType,
+  WorkspaceFlavour,
+} from '@affine/workspace/type';
 import {
   cleanupWorkspace,
   createEmptyBlockSuiteWorkspace,
@@ -24,16 +33,16 @@ import { mutate } from 'swr';
 import { z } from 'zod';
 
 import { createAffineProviders } from '../../blocksuite';
-import { PageNotFoundError } from '../../components/affine/affine-error-eoundary';
+import { createAffineDownloadProvider } from '../../blocksuite/providers/affine';
 import { WorkspaceSettingDetail } from '../../components/affine/workspace-setting-detail';
 import { BlockSuitePageList } from '../../components/blocksuite/block-suite-page-list';
 import { PageDetailEditor } from '../../components/page-detail-editor';
 import { PageLoading } from '../../components/pure/loading';
 import { useAffineRefreshAuthToken } from '../../hooks/affine/use-affine-refresh-auth-token';
 import { BlockSuiteWorkspace } from '../../shared';
-import { affineApis } from '../../shared/apis';
+import { affineApis, affineAuth } from '../../shared/apis';
 import { toast } from '../../utils';
-import type { WorkspacePlugin } from '..';
+import type { WorkspaceAdapter } from '../type';
 import { QueryKey } from './fetcher';
 
 const storage = createJSONStorage(() => localStorage);
@@ -46,7 +55,7 @@ const schema = z.object({
 
 const getPersistenceAllWorkspace = () => {
   const items = storage.getItem(AFFINE_STORAGE_KEY, []);
-  const allWorkspaces: AffineWorkspace[] = [];
+  const allWorkspaces: AffineLegacyCloudWorkspace[] = [];
   if (
     Array.isArray(items) &&
     items.every(item => schema.safeParse(item).success)
@@ -60,7 +69,7 @@ const getPersistenceAllWorkspace = () => {
             workspaceApis: affineApis,
           }
         );
-        const affineWorkspace: AffineWorkspace = {
+        const affineWorkspace: AffineLegacyCloudWorkspace = {
           ...item,
           flavour: WorkspaceFlavour.AFFINE,
           blockSuiteWorkspace,
@@ -73,8 +82,6 @@ const getPersistenceAllWorkspace = () => {
   return allWorkspaces;
 };
 
-export const affineAuth = createAffineAuth(prefixUrl);
-
 function AuthContext({ children }: PropsWithChildren): ReactElement {
   const login = useAffineRefreshAuthToken();
 
@@ -84,14 +91,13 @@ function AuthContext({ children }: PropsWithChildren): ReactElement {
     }
   }, [login]);
   if (!login) {
-    return (
-      <PageLoading text="No login, redirecting to local workspace page..." />
-    );
+    return <PageLoading />;
   }
   return <>{children}</>;
 }
 
-export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
+export const AffinePlugin: WorkspaceAdapter<WorkspaceFlavour.AFFINE> = {
+  releaseType: ReleaseType.STABLE,
   flavour: WorkspaceFlavour.AFFINE,
   loadPriority: LoadPriority.HIGH,
   Events: {
@@ -145,6 +151,27 @@ export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
           );
         }
       }
+      {
+        const bs = createEmptyBlockSuiteWorkspace(id, WorkspaceFlavour.AFFINE, {
+          workspaceApis: affineApis,
+        });
+        // fixme:
+        //  force to download workspace binary
+        //  to make sure the workspace is synced
+        const provider = createAffineDownloadProvider(bs);
+        const indexedDBProvider = createIndexedDBBackgroundProvider(bs);
+        await new Promise<void>(resolve => {
+          indexedDBProvider.callbacks.add(() => {
+            resolve();
+          });
+          provider.callbacks.add(() => {
+            indexedDBProvider.connect();
+          });
+          provider.connect();
+        });
+        provider.disconnect();
+        indexedDBProvider.disconnect();
+      }
 
       await mutate(matcher => matcher === QueryKey.getWorkspaces);
       // refresh the local storage
@@ -180,7 +207,8 @@ export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
           cleanupWorkspace(WorkspaceFlavour.AFFINE);
           return null;
         }
-        const workspaces: AffineWorkspace[] = await AffinePlugin.CRUD.list();
+        const workspaces: AffineLegacyCloudWorkspace[] =
+          await AffinePlugin.CRUD.list();
         return (
           workspaces.find(workspace => workspace.id === workspaceId) ?? null
         );
@@ -241,7 +269,7 @@ export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
               storage.setItem(AFFINE_STORAGE_KEY, [...data]);
             }
 
-            const affineWorkspace: AffineWorkspace = {
+            const affineWorkspace: AffineLegacyCloudWorkspace = {
               ...workspace,
               flavour: WorkspaceFlavour.AFFINE,
               blockSuiteWorkspace,
@@ -278,12 +306,12 @@ export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
   UI: {
     Provider: ({ children }) => {
       return (
-        <Suspense fallback={<PageLoading text="Checking login status..." />}>
+        <Suspense fallback={<PageLoading />}>
           <AuthContext>{children}</AuthContext>
         </Suspense>
       );
     },
-    PageDetail: ({ currentWorkspace, currentPageId }) => {
+    PageDetail: ({ currentWorkspace, currentPageId, onLoadEditor }) => {
       const page = currentWorkspace.blockSuiteWorkspace.getPage(currentPageId);
       if (!page) {
         throw new PageNotFoundError(
@@ -297,6 +325,7 @@ export const AffinePlugin: WorkspacePlugin<WorkspaceFlavour.AFFINE> = {
             pageId={currentPageId}
             workspace={currentWorkspace}
             onInit={initPage}
+            onLoad={onLoadEditor}
           />
         </>
       );

apps/web/src/adapters/local/index.tsx

@@ -4,25 +4,49 @@ import {
   DEFAULT_WORKSPACE_NAME,
 } from '@affine/env';
 import { initPage } from '@affine/env/blocksuite';
+import { PageNotFoundError } from '@affine/env/constant';
 import {
   CRUD,
   saveWorkspaceToLocalStorage,
 } from '@affine/workspace/local/crud';
 import { createIndexedDBBackgroundProvider } from '@affine/workspace/providers';
-import { LoadPriority, WorkspaceFlavour } from '@affine/workspace/type';
+import {
+  LoadPriority,
+  ReleaseType,
+  WorkspaceFlavour,
+} from '@affine/workspace/type';
 import { createEmptyBlockSuiteWorkspace } from '@affine/workspace/utils';
 import { nanoid } from '@blocksuite/store';
-import React from 'react';
+import { lazy } from 'react';
 
-import { PageNotFoundError } from '../../components/affine/affine-error-eoundary';
-import { WorkspaceSettingDetail } from '../../components/affine/workspace-setting-detail';
-import { BlockSuitePageList } from '../../components/blocksuite/block-suite-page-list';
-import { PageDetailEditor } from '../../components/page-detail-editor';
-import type { WorkspacePlugin } from '..';
+import type { WorkspaceAdapter } from '../type';
+
+const WorkspaceSettingDetail = lazy(() =>
+  import('../../components/affine/workspace-setting-detail').then(
+    ({ WorkspaceSettingDetail }) => ({
+      default: WorkspaceSettingDetail,
+    })
+  )
+);
+const BlockSuitePageList = lazy(() =>
+  import('../../components/blocksuite/block-suite-page-list').then(
+    ({ BlockSuitePageList }) => ({
+      default: BlockSuitePageList,
+    })
+  )
+);
+const PageDetailEditor = lazy(() =>
+  import('../../components/page-detail-editor').then(
+    ({ PageDetailEditor }) => ({
+      default: PageDetailEditor,
+    })
+  )
+);
 
 const logger = new DebugLogger('use-create-first-workspace');
 
-export const LocalPlugin: WorkspacePlugin<WorkspaceFlavour.LOCAL> = {
+export const LocalPlugin: WorkspaceAdapter<WorkspaceFlavour.LOCAL> = {
+  releaseType: ReleaseType.STABLE,
   flavour: WorkspaceFlavour.LOCAL,
   loadPriority: LoadPriority.LOW,
   Events: {
@@ -57,7 +81,7 @@ export const LocalPlugin: WorkspacePlugin<WorkspaceFlavour.LOCAL> = {
     Provider: ({ children }) => {
       return <>{children}</>;
     },
-    PageDetail: ({ currentWorkspace, currentPageId }) => {
+    PageDetail: ({ currentWorkspace, currentPageId, onLoadEditor }) => {
       const page = currentWorkspace.blockSuiteWorkspace.getPage(currentPageId);
       if (!page) {
         throw new PageNotFoundError(
@@ -70,6 +94,7 @@ export const LocalPlugin: WorkspacePlugin<WorkspaceFlavour.LOCAL> = {
           <PageDetailEditor
             pageId={currentPageId}
             onInit={initPage}
+            onLoad={onLoadEditor}
             workspace={currentWorkspace}
           />
         </>

apps/web/src/adapters/type.tsx

@@ -0,0 +1,21 @@
+import type {
+  AppEvents,
+  WorkspaceCRUD,
+  WorkspaceUISchema,
+} from '@affine/workspace/type';
+import type {
+  LoadPriority,
+  ReleaseType,
+  WorkspaceFlavour,
+} from '@affine/workspace/type';
+
+export interface WorkspaceAdapter<Flavour extends WorkspaceFlavour> {
+  releaseType: ReleaseType;
+  flavour: Flavour;
+  // Plugin will be loaded according to the priority
+  loadPriority: LoadPriority;
+  Events: Partial<AppEvents>;
+  // Fetch necessary data for the first render
+  CRUD: WorkspaceCRUD<Flavour>;
+  UI: WorkspaceUISchema<Flavour>;
+}

apps/web/src/adapters/workspace.ts

@@ -0,0 +1,61 @@
+import type { AppEvents } from '@affine/workspace/type';
+import {
+  LoadPriority,
+  ReleaseType,
+  WorkspaceFlavour,
+} from '@affine/workspace/type';
+
+import { AffinePlugin } from './affine';
+import { LocalPlugin } from './local';
+import type { WorkspaceAdapter } from './type';
+
+const unimplemented = () => {
+  throw new Error('Not implemented');
+};
+
+export const WorkspaceAdapters = {
+  [WorkspaceFlavour.AFFINE]: AffinePlugin,
+  [WorkspaceFlavour.LOCAL]: LocalPlugin,
+  [WorkspaceFlavour.AFFINE_CLOUD]: {
+    releaseType: ReleaseType.UNRELEASED,
+    flavour: WorkspaceFlavour.AFFINE_CLOUD,
+    loadPriority: LoadPriority.HIGH,
+    Events: {} as Partial<AppEvents>,
+    // todo: implement this
+    CRUD: {
+      get: unimplemented,
+      list: unimplemented,
+      delete: unimplemented,
+      create: unimplemented,
+    },
+    // todo: implement this
+    UI: {
+      Provider: unimplemented,
+      PageDetail: unimplemented,
+      PageList: unimplemented,
+      SettingsDetail: unimplemented,
+    },
+  },
+  [WorkspaceFlavour.PUBLIC]: {
+    releaseType: ReleaseType.UNRELEASED,
+    flavour: WorkspaceFlavour.PUBLIC,
+    loadPriority: LoadPriority.LOW,
+    Events: {} as Partial<AppEvents>,
+    // todo: implement this
+    CRUD: {
+      get: unimplemented,
+      list: unimplemented,
+      delete: unimplemented,
+      create: unimplemented,
+    },
+    // todo: implement this
+    UI: {
+      Provider: unimplemented,
+      PageDetail: unimplemented,
+      PageList: unimplemented,
+      SettingsDetail: unimplemented,
+    },
+  },
+} satisfies {
+  [Key in WorkspaceFlavour]: WorkspaceAdapter<Key>;
+};