fix(core): nav item line-height with Emoji (#8148)

close AF-1206

.env.template

@@ -1,14 +1,8 @@
-ENABLE_PLUGIN=
-ENABLE_TEST_PROPERTIES=
-ENABLE_BC_PROVIDER=
 CHANGELOG_URL=
 ENABLE_PRELOADING=
-ENABLE_NEW_SETTING_MODAL=
-ENABLE_SQLITE_PROVIDER=
 ENABLE_NEW_SETTING_UNSTABLE_API=
-ENABLE_NOTIFICATION_CENTER=
-ENABLE_CLOUD=
-ENABLE_MOVE_DATABASE=
-SHOULD_REPORT_TRACE=
-TRACE_REPORT_ENDPOINT=
-CAPTCHA_SITE_KEY=
+ENABLE_CAPTCHA=
+CAPTCHA_SITE_KEY=
+ENABLE_ENHANCE_SHARE_MODE=
+ALLOW_LOCAL_WORKSPACE=
+DEBUG_JOTAI=

.eslintrc.js

@@ -34,8 +34,8 @@ const createPattern = packageName => [
   {
     group: ['@affine/env/constant'],
     message:
-      'Do not import from @affine/env/constant. Use `environment.isDesktop` instead',
-    importNames: ['isDesktop'],
+      'Do not import from @affine/env/constant. Use `environment.isElectron` instead',
+    importNames: ['isElectron'],
   },
 ];
 
@@ -157,11 +157,6 @@ const config = {
             message: "Import from '@blocksuite/global/utils'",
             importNames: ['assertExists', 'assertEquals'],
           },
-          {
-            group: ['react-router-dom'],
-            message: 'Use `useNavigateHelper` instead',
-            importNames: ['useNavigate'],
-          },
         ],
       },
     ],
@@ -252,7 +247,8 @@ const config = {
         'react-hooks/exhaustive-deps': [
           'warn',
           {
-            additionalHooks: 'useAsyncCallback',
+            additionalHooks:
+              '(useAsyncCallback|useCatchEventCallback|useDraggable|useDropTarget|useRefEffect)',
           },
         ],
       },

.github/actions/cluster-auth/action.yml

@@ -0,0 +1,36 @@
+name: 'Auth to Cluster'
+description: 'Auth to the GCP Cluster'
+inputs:
+  gcp-project-number:
+    description: 'GCP project number'
+    required: true
+  gcp-project-id:
+    description: 'GCP project id'
+    required: true
+  service-account:
+    description: 'Service account'
+  cluster-name:
+    description: 'Cluster name'
+  cluster-location:
+    description: 'Cluster location'
+
+runs:
+  using: 'composite'
+  steps:
+    - id: auth
+      uses: google-github-actions/auth@v2
+      with:
+        workload_identity_provider: 'projects/${{ inputs.gcp-project-number }}/locations/global/workloadIdentityPools/github-actions/providers/github-actions-helm-deploy'
+        service_account: '${{ inputs.service-account }}'
+        token_format: 'access_token'
+        project_id: '${{ inputs.gcp-project-id }}'
+
+    - name: 'Setup gcloud cli'
+      uses: 'google-github-actions/setup-gcloud@v2'
+      with:
+        install_components: 'gke-gcloud-auth-plugin'
+
+    - id: get-gke-credentials
+      shell: bash
+      run: |
+        gcloud container clusters get-credentials ${{ inputs.cluster-name }} --region ${{ inputs.cluster-location }} --project ${{ inputs.gcp-project-id }}

.github/actions/deploy/action.yml

@@ -24,24 +24,14 @@ runs:
       shell: bash
       run: |
         echo "GIT_SHORT_HASH=$(git rev-parse --short HEAD)" >> "$GITHUB_ENV"
-    - uses: azure/setup-helm@v4
-    - id: auth
-      uses: google-github-actions/auth@v2
+    - name: 'Auth to cluster'
+      uses: './.github/actions/cluster-auth'
       with:
-        workload_identity_provider: 'projects/${{ inputs.gcp-project-number }}/locations/global/workloadIdentityPools/github-actions/providers/github-actions-helm-deploy'
-        service_account: '${{ inputs.service-account }}'
-        token_format: 'access_token'
-        project_id: '${{ inputs.gcp-project-id }}'
-
-    - name: 'Setup gcloud cli'
-      uses: 'google-github-actions/setup-gcloud@v2'
-      with:
-        install_components: 'gke-gcloud-auth-plugin'
-
-    - id: get-gke-credentials
-      shell: bash
-      run: |
-        gcloud container clusters get-credentials ${{ inputs.cluster-name }} --region ${{ inputs.cluster-location }} --project ${{ inputs.gcp-project-id }}
+        gcp-project-number: '${{ inputs.gcp-project-number }}'
+        gcp-project-id: '${{ inputs.gcp-project-id }}'
+        service-account: '${{ inputs.service-account }}'
+        cluster-name: '${{ inputs.cluster-name }}'
+        cluster-location: '${{ inputs.cluster-location }}'
 
     - name: Deploy
       shell: bash

.github/actions/deploy/deploy.mjs

@@ -14,6 +14,7 @@ const {
   R2_ACCESS_KEY_ID,
   R2_SECRET_ACCESS_KEY,
   CAPTCHA_TURNSTILE_SECRET,
+  METRICS_CUSTOMER_IO_TOKEN,
   COPILOT_OPENAI_API_KEY,
   COPILOT_FAL_API_KEY,
   COPILOT_UNSPLASH_API_KEY,
@@ -117,6 +118,8 @@ const createHelmCommand = ({ isDryRun }) => {
     `--set-string graphql.app.oauth.google.clientSecret="${AFFINE_GOOGLE_CLIENT_SECRET}"`,
     `--set-string graphql.app.payment.stripe.apiKey="${STRIPE_API_KEY}"`,
     `--set-string graphql.app.payment.stripe.webhookKey="${STRIPE_WEBHOOK_KEY}"`,
+    `--set        graphql.app.metrics.enabled=true`,
+    `--set-string graphql.app.metrics.customerIo.token="${METRICS_CUSTOMER_IO_TOKEN}"`,
     `--set        graphql.app.experimental.enableJwstCodec=${namespace === 'dev'}`,
     `--set        graphql.app.features.earlyAccessPreview=false`,
     `--set        graphql.app.features.syncClientVersionCheck=true`,

.github/actions/setup-node/action.yml

@@ -156,7 +156,7 @@ runs:
     - name: Install Playwright's dependencies
       shell: bash
       if: inputs.playwright-install == 'true'
-      run: yarn playwright install --with-deps chromium
+      run: yarn playwright install --with-deps chromium webkit
       env:
         PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/node_modules/.cache/ms-playwright
 

.github/actions/setup-version/action.yml

@@ -17,7 +17,7 @@ runs:
           PACKAGE_VERSION=$(node -p "require('./package.json').version")
           TIME_VERSION=$(date +%Y%m%d%H%M)
           GIT_SHORT_HASH=$(git rev-parse --short HEAD)
-          APP_VERSION=$PACKAGE_VERSION-nightly-$TIME_VERSION-$GIT_SHORT_HASH
+          APP_VERSION=$PACKAGE_VERSION-nightly-$GIT_SHORT_HASH
         fi
         echo $APP_VERSION
         echo "APP_VERSION=$APP_VERSION" >> "$GITHUB_OUTPUT"

.github/deployment/front/Dockerfile

@@ -1,6 +1,8 @@
-FROM openresty/openresty:1.25.3.1-0-buster
+FROM openresty/openresty:1.25.3.2-0-buster
 WORKDIR /app
 COPY ./packages/frontend/web/dist ./dist
+COPY ./packages/frontend/admin/dist ./admin
+COPY ./packages/frontend/mobile/dist ./mobile
 COPY ./.github/deployment/front/nginx.conf /usr/local/openresty/nginx/conf/nginx.conf
 COPY ./.github/deployment/front/affine.nginx.conf /etc/nginx/conf.d/affine.nginx.conf
 

.github/deployment/front/affine.nginx.conf

@@ -1,13 +1,42 @@
 server {
-    listen 8080;
-    root /app/dist;
+  listen 8080;
+  location /admin {
+    root /app/;
+    index index.html;
+    try_files $uri/index.html $uri/ $uri /admin/index.html;
+  }
 
-    location / {
-        try_files $uri $uri/ /index.html;
-    }
+  location ~ ^/(_plugin|assets|imgs|js|plugins|static)/ {
+    root /app/dist/;
+    try_files $uri $uri/ =404;
+  }
 
-    error_page 404 /404.html;
-    location = /404.html {
-        internal;
-    }
+  set $app_root_path /app/dist/;
+  set $mobile_root /app/dist/;
+  set_by_lua $affine_env 'return os.getenv("AFFINE_ENV")';
+
+  if ($affine_env = "dev") {
+    set $mobile_root /app/mobile/;
+  }
+
+  # https://gist.github.com/mariusom/6683dc52b1cad1a1f372e908bdb209d0
+  if ($http_user_agent ~* "(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino") {
+    set $app_root_path $mobile_root;
+  }
+
+  if ($http_user_agent ~* "^(1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-)") {
+    set $app_root_path $mobile_root;
+  }
+
+  location / {
+    root $app_root_path;
+    index index.html;
+    try_files $uri $uri/ /index.html;
+    add_header Cache-Control "private, no-cache, no-store, max-age=0, must-revalidate";
+  }
+
+  error_page 404 /404.html;
+  location = /404.html {
+    internal;
+  }
 }

.github/deployment/front/nginx.conf

@@ -1,14 +1,15 @@
-worker_processes  4;
+worker_processes 4;
 error_log /var/log/nginx/error.log warn;
 pcre_jit on;
+env AFFINE_ENV;
 events {
-    worker_connections 1024;
+  worker_connections 1024;
 }
 http {
-    include       mime.types;
-    log_format    main  '$remote_addr [$time_local] "$request" '
-                        '$status $body_bytes_sent "$http_referer" '
-                        '"$http_user_agent" "$http_x_forwarded_for"';
-    access_log    /var/log/nginx/access.log  main;
-    include /etc/nginx/conf.d/*.conf;
+  include mime.types;
+  log_format main '$remote_addr [$time_local] "$request" '
+  '$status $body_bytes_sent "$http_referer" '
+  '"$http_user_agent" "$http_x_forwarded_for"';
+  access_log /var/log/nginx/access.log main;
+  include /etc/nginx/conf.d/*.conf;
 }

.github/deployment/node/Dockerfile

@@ -2,6 +2,7 @@ FROM node:20-bookworm-slim
 
 COPY ./packages/backend/server /app
 COPY ./packages/frontend/web/dist /app/static
+COPY ./packages/frontend/admin/dist /app/static/admin
 WORKDIR /app
 
 RUN apt-get update && \

.github/helm/affine/Chart.yaml

@@ -3,4 +3,4 @@ name: affine
 description: AFFiNE cloud chart
 type: application
 version: 0.0.0
-appVersion: "0.14.0"
+appVersion: "0.16.0"

.github/helm/affine/charts/graphql/Chart.yaml

@@ -3,7 +3,7 @@ name: graphql
 description: AFFiNE GraphQL server
 type: application
 version: 0.0.0
-appVersion: "0.14.0"
+appVersion: "0.16.0"
 dependencies:
   - name: gcloud-sql-proxy
     version: 0.0.0

.github/helm/affine/charts/graphql/templates/deployment.yaml

@@ -77,8 +77,6 @@ spec:
             value: "{{ .Values.app.https }}"
           - name: ENABLE_R2_OBJECT_STORAGE
             value: "{{ .Values.app.objectStorage.r2.enabled }}"
-          - name: ENABLE_CAPTCHA
-            value: "{{ .Values.app.captcha.enabled }}"
           - name: FEATURES_EARLY_ACCESS_PREVIEW
             value: "{{ .Values.app.features.earlyAccessPreview }}"
           - name: FEATURES_SYNC_CLIENT_VERSION_CHECK
@@ -191,18 +189,25 @@ spec:
                 name: "{{ .Values.app.oauth.github.secretName }}"
                 key: clientSecret
           {{ end }}
+          {{ if .Values.app.metrics.enabled }}
+          - name: METRICS_CUSTOMER_IO_TOKEN
+            valueFrom:
+              secretKeyRef:
+                name: "{{ .Values.app.metrics.secretName }}"
+                key: customerIoSecret
+          {{ end }}
           ports:
             - name: http
               containerPort: {{ .Values.service.port }}
               protocol: TCP
           livenessProbe:
             httpGet:
-              path: /
+              path: /info
               port: http
             initialDelaySeconds: {{ .Values.probe.initialDelaySeconds }}
           readinessProbe:
             httpGet:
-              path: /
+              path: /info
               port: http
             initialDelaySeconds: {{ .Values.probe.initialDelaySeconds }}
           resources:

.github/helm/affine/charts/graphql/templates/metrics-secret.yaml

@@ -0,0 +1,9 @@
+{{- if .Values.app.metrics.enabled -}}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: "{{ .Values.app.metrics.secretName }}"
+type: Opaque
+data:
+  customerIoSecret: {{ .Values.app.metrics.customerIo.token | b64enc }}
+{{- end }}

.github/helm/affine/charts/graphql/templates/migration.yaml

@@ -22,6 +22,8 @@ spec:
             value: "{{ .Values.env }}"
           - name: AFFINE_ENV
             value: "{{ .Release.Namespace }}"
+          - name: DEPLOYMENT_TYPE
+            value: "affine"
           - name: DATABASE_PASSWORD
             valueFrom:
               secretKeyRef:

.github/helm/affine/charts/graphql/templates/service.yaml

@@ -4,6 +4,10 @@ metadata:
   name: {{ include "graphql.fullname" . }}
   labels:
     {{- include "graphql.labels" . | nindent 4 }}
+  {{- with .Values.service.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   type: {{ .Values.service.type }}
   ports:

.github/helm/affine/charts/graphql/values.yaml

@@ -20,12 +20,12 @@ app:
   doc:
     mergeInterval: "3000"
   captcha:
-    enable: false
+    enabled: false
     secretName: captcha
     turnstile:
       secret: ''
   copilot:
-    enable: false
+    enabled: false
     secretName: copilot
     openai:
       key: ''
@@ -54,6 +54,11 @@ app:
     user: ''
     password: ''
     sender: 'noreply@toeverything.info'
+  metrics:
+    enabled: false
+    secretName: 'metrics'
+    customerIo:
+      token: ''
   payment:
     stripe:
       secretName: 'stripe'

.github/helm/affine/charts/sync/Chart.yaml

@@ -3,7 +3,7 @@ name: sync
 description: AFFiNE Sync Server
 type: application
 version: 0.0.0
-appVersion: "0.14.0"
+appVersion: "0.16.0"
 dependencies:
   - name: gcloud-sql-proxy
     version: 0.0.0

.github/helm/affine/charts/web/templates/deployment.yaml

@@ -27,6 +27,9 @@ spec:
         - name: {{ .Chart.Name }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          env:
+          - name: AFFINE_ENV
+            value: "{{ .Release.Namespace }}"
           ports:
             - name: http
               containerPort: {{ .Values.service.port }}

.github/helm/affine/templates/ingress.yaml

@@ -60,13 +60,6 @@ spec:
                 name: affine-graphql
                 port:
                   number: {{ .Values.graphql.service.port }}
-          - path: /oauth
-            pathType: Prefix
-            backend:
-              service:
-                name: affine-graphql
-                port:
-                  number: {{ .Values.graphql.service.port }}
           - path: /
             pathType: Prefix
             backend:
@@ -74,4 +67,11 @@ spec:
                 name: affine-web
                 port:
                   number: {{ .Values.web.service.port }}
+          - path: /js/worker.(.+).js
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: affine-web
+                port:
+                  number: {{ .Values.web.service.port }}
 {{- end }}

.github/helm/affine/values.yaml

@@ -36,14 +36,14 @@ graphql:
     type: ClusterIP
     port: 3000
     annotations:
-      cloud.google.com/backend-config: '{"default": "affine-backendconfig"}'
+      cloud.google.com/backend-config: '{"default": "affine-api-backendconfig"}'
 
 sync:
   service:
     type: ClusterIP
     port: 3010
     annotations:
-      cloud.google.com/backend-config: '{"default": "affine-backendconfig"}'
+      cloud.google.com/backend-config: '{"default": "affine-api-backendconfig"}'
 
 web:
   service:

.github/helm/separate-config/backend-config.yaml

@@ -0,0 +1,10 @@
+apiVersion: cloud.google.com/v1
+kind: BackendConfig
+metadata:
+  name: "affine-api-backendconfig"
+spec:
+  healthCheck:
+    timeoutSec: 1
+    type: HTTP
+    requestPath: /info
+

.github/renovate.json

@@ -27,7 +27,8 @@
       "matchPackagePatterns": ["^@blocksuite"],
       "excludePackageNames": ["@blocksuite/icons"],
       "rangeStrategy": "replace",
-      "followTag": "canary"
+      "followTag": "canary",
+      "enabled": false
     },
     {
       "groupName": "all non-major dependencies",

.github/workflows/build-server-image.yml

@@ -6,6 +6,11 @@ on:
       flavor:
         type: string
         required: true
+  workflow_dispatch:
+    inputs:
+      flavor:
+        type: string
+        required: false
 
 env:
   NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
@@ -53,7 +58,6 @@ jobs:
         run: yarn nx build @affine/web --skip-nx-cache
         env:
           BUILD_TYPE: ${{ github.event.inputs.flavor }}
-          SHOULD_REPORT_TRACE: false
           PUBLIC_PATH: '/'
           SELF_HOSTED: true
           MIXPANEL_TOKEN: ${{ secrets.MIXPANEL_TOKEN }}
@@ -66,6 +70,31 @@ jobs:
           path: ./packages/frontend/web/dist
           if-no-files-found: error
 
+  build-admin-selfhost:
+    name: Build @affine/admin selfhost
+    runs-on: ubuntu-latest
+    environment: ${{ github.event.inputs.flavor }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Version
+        id: version
+        uses: ./.github/actions/setup-version
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+      - name: Build Core
+        run: yarn nx build @affine/admin --skip-nx-cache
+        env:
+          BUILD_TYPE: ${{ github.event.inputs.flavor }}
+          PUBLIC_PATH: '/admin/'
+          SELF_HOSTED: true
+          MIXPANEL_TOKEN: ${{ secrets.MIXPANEL_TOKEN }}
+      - name: Upload admin artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: selfhost-admin
+          path: ./packages/frontend/admin/dist
+          if-no-files-found: error
+
   build-server-native:
     name: Build Server native - ${{ matrix.targets.name }}
     runs-on: ubuntu-latest
@@ -108,6 +137,7 @@ jobs:
     needs:
       - build-server
       - build-web-selfhost
+      - build-admin-selfhost
       - build-server-native
     steps:
       - uses: actions/checkout@v4
@@ -171,6 +201,12 @@ jobs:
           name: selfhost-web
           path: ./packages/frontend/web/dist
 
+      - name: Download selfhost admin artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: selfhost-admin
+          path: ./packages/frontend/admin/dist
+
       - name: Install Node.js dependencies
         run: |
           yarn config set --json supportedArchitectures.cpu '["x64", "arm64", "arm"]'
@@ -185,7 +221,7 @@ jobs:
         uses: ./.github/actions/setup-version
 
       - name: Build graphql Dockerfile
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: true

.github/workflows/build-test.yml

@@ -143,6 +143,36 @@ jobs:
           path: ./test-results
           if-no-files-found: ignore
 
+  e2e-mobile-test:
+    name: E2E Mobile Test
+    runs-on: ubuntu-latest
+    env:
+      DISTRIBUTION: mobile
+      IN_CI_TEST: true
+    strategy:
+      fail-fast: false
+      matrix:
+        shard: [1, 2, 3, 4, 5]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+        with:
+          playwright-install: true
+          electron-install: false
+          full-cache: true
+
+      - name: Run playwright tests
+        run: yarn workspace @affine-test/affine-mobile e2e --forbid-only --shard=${{ matrix.shard }}/${{ strategy.job-total }}
+
+      - name: Upload test results
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-e2e-mobile-${{ matrix.shard }}
+          path: ./test-results
+          if-no-files-found: ignore
+
   e2e-migration-test:
     name: E2E Migration Test
     runs-on: ubuntu-latest
@@ -165,7 +195,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: test-results-e2e-migration
-          path: ./tests/affine-migration/test-results
+          path: ./test-results
           if-no-files-found: ignore
 
   unit-test:
@@ -180,7 +210,7 @@ jobs:
       - name: Setup Node.js
         uses: ./.github/actions/setup-node
         with:
-          electron-install: false
+          electron-install: true
           full-cache: true
 
       - name: Download affine.linux-x64-gnu.node
@@ -351,7 +381,7 @@ jobs:
         env:
           CARGO_TARGET_DIR: '${{ github.workspace }}/target'
           DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
-          COPILOT_OPENAI_API_KEY: ${{ secrets.COPILOT_OPENAI_API_KEY }}
+          COPILOT_OPENAI_API_KEY: 'use_fake_openai_api_key'
 
       - name: Upload server test coverage results
         uses: codecov/codecov-action@v4
@@ -443,13 +473,15 @@ jobs:
           ${{ matrix.tests.script }}
         env:
           DEV_SERVER_URL: http://localhost:8080
+          COPILOT_OPENAI_API_KEY: 1
+          COPILOT_FAL_API_KEY: 1
 
       - name: Upload test results
         if: ${{ failure() }}
         uses: actions/upload-artifact@v4
         with:
           name: test-results-e2e-server
-          path: ./tests/affine-cloud/test-results
+          path: ./test-results
           if-no-files-found: ignore
 
   desktop-test:
@@ -569,6 +601,7 @@ jobs:
       - lint
       - check-yarn-binary
       - e2e-test
+      - e2e-mobile-test
       - e2e-migration-test
       - unit-test
       - server-test

.github/workflows/deploy.yml

@@ -21,6 +21,47 @@ permissions:
   packages: 'write'
 
 jobs:
+  output-prev-version:
+    name: Output previous version
+    runs-on: ubuntu-latest
+    environment: ${{ github.event.inputs.flavor }}
+    outputs:
+      prev: ${{ steps.print.outputs.version }}
+      namespace: ${{ steps.print.outputs.namespace }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Auth to Cluster
+        uses: './.github/actions/cluster-auth'
+        with:
+          gcp-project-number: ${{ secrets.GCP_PROJECT_NUMBER }}
+          gcp-project-id: ${{ secrets.GCP_PROJECT_ID }}
+          service-account: ${{ secrets.GCP_HELM_DEPLOY_SERVICE_ACCOUNT }}
+          cluster-name: ${{ secrets.GCP_CLUSTER_NAME }}
+          cluster-location: ${{ secrets.GCP_CLUSTER_LOCATION }}
+      - name: Output previous version
+        id: print
+        run: |
+          namespace=""
+          if [ "${{ github.event.inputs.flavor }}" = "canary" ]; then
+            namespace="dev"
+          elif [ "${{ github.event.inputs.flavor }}" = "beta" ]; then
+            namespace="beta"
+          elif [ "${{ github.event.inputs.flavor }}" = "stable" ]; then
+            namespace="production"
+          else
+            echo "Invalid flavor: ${{ github.event.inputs.flavor }}"
+            exit 1
+          fi
+
+          echo "Namespace set to: $namespace"
+
+          # Get the previous version from the deployment
+          prev_version=$(kubectl get deployment -n $namespace affine-graphql -o=jsonpath='{.spec.template.spec.containers[0].image}' | awk -F '-' '{print $3}')
+
+          echo "Previous version: $prev_version"
+          echo "version=$prev_version" >> $GITHUB_OUTPUT
+          echo "namesapce=$namespace" >> $GITHUB_OUTPUT
+
   build-server-image:
     name: Build Server Image
     uses: ./.github/workflows/build-server-image.yml
@@ -45,11 +86,10 @@ jobs:
           R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
           R2_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
           BUILD_TYPE: ${{ github.event.inputs.flavor }}
-          SHOULD_REPORT_TRACE: true
-          TRACE_REPORT_ENDPOINT: ${{ secrets.TRACE_REPORT_ENDPOINT }}
           CAPTCHA_SITE_KEY: ${{ secrets.CAPTCHA_SITE_KEY }}
           SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
           SENTRY_PROJECT: 'affine-web'
+          SENTRY_RELEASE: ${{ steps.version.outputs.APP_VERSION }}
           SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
           SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
           PERFSEE_TOKEN: ${{ secrets.PERFSEE_TOKEN }}
@@ -61,11 +101,77 @@ jobs:
           path: ./packages/frontend/web/dist
           if-no-files-found: error
 
+  build-admin:
+    name: Build @affine/admin
+    runs-on: ubuntu-latest
+    environment: ${{ github.event.inputs.flavor }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Version
+        id: version
+        uses: ./.github/actions/setup-version
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+      - name: Build Admin
+        run: yarn nx build @affine/admin --skip-nx-cache
+        env:
+          R2_ACCOUNT_ID: ${{ secrets.R2_ACCOUNT_ID }}
+          R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
+          R2_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
+          BUILD_TYPE: ${{ github.event.inputs.flavor }}
+          CAPTCHA_SITE_KEY: ${{ secrets.CAPTCHA_SITE_KEY }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: 'affine-admin'
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          PERFSEE_TOKEN: ${{ secrets.PERFSEE_TOKEN }}
+          MIXPANEL_TOKEN: ${{ secrets.MIXPANEL_TOKEN }}
+      - name: Upload admin artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: admin
+          path: ./packages/frontend/admin/dist
+          if-no-files-found: error
+
+  build-mobile:
+    name: Build @affine/mobile
+    runs-on: ubuntu-latest
+    environment: ${{ github.event.inputs.flavor }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Version
+        id: version
+        uses: ./.github/actions/setup-version
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+      - name: Build Mobile
+        run: yarn nx build @affine/mobile --skip-nx-cache
+        env:
+          R2_ACCOUNT_ID: ${{ secrets.R2_ACCOUNT_ID }}
+          R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
+          R2_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
+          BUILD_TYPE: ${{ github.event.inputs.flavor }}
+          CAPTCHA_SITE_KEY: ${{ secrets.CAPTCHA_SITE_KEY }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: 'affine-mobile'
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          PERFSEE_TOKEN: ${{ secrets.PERFSEE_TOKEN }}
+          MIXPANEL_TOKEN: ${{ secrets.MIXPANEL_TOKEN }}
+      - name: Upload mobile artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: mobile
+          path: ./packages/frontend/mobile/dist
+          if-no-files-found: error
+
   build-frontend-image:
     name: Build Frontend Image
     runs-on: ubuntu-latest
     needs:
       - build-web
+      - build-admin
+      - build-mobile
     steps:
       - uses: actions/checkout@v4
       - name: Download web artifact
@@ -73,6 +179,16 @@ jobs:
         with:
           name: web
           path: ./packages/frontend/web/dist
+      - name: Download admin artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: admin
+          path: ./packages/frontend/admin/dist
+      - name: Download mobile artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: mobile
+          path: ./packages/frontend/mobile/dist
       - name: Setup env
         run: |
           echo "GIT_SHORT_HASH=$(git rev-parse --short HEAD)" >> "$GITHUB_ENV"
@@ -94,7 +210,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Build front Dockerfile
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: true
@@ -137,6 +253,7 @@ jobs:
           COPILOT_OPENAI_API_KEY: ${{ secrets.COPILOT_OPENAI_API_KEY }}
           COPILOT_FAL_API_KEY: ${{ secrets.COPILOT_FAL_API_KEY }}
           COPILOT_UNSPLASH_API_KEY: ${{ secrets.COPILOT_UNSPLASH_API_KEY }}
+          METRICS_CUSTOMER_IO_TOKEN: ${{ secrets.METRICS_CUSTOMER_IO_TOKEN }}
           MAILER_SENDER: ${{ secrets.OAUTH_EMAIL_SENDER }}
           MAILER_USER: ${{ secrets.OAUTH_EMAIL_LOGIN }}
           MAILER_PASSWORD: ${{ secrets.OAUTH_EMAIL_PASSWORD }}
@@ -155,3 +272,98 @@ jobs:
           STRIPE_API_KEY: ${{ secrets.STRIPE_API_KEY }}
           STRIPE_WEBHOOK_KEY: ${{ secrets.STRIPE_WEBHOOK_KEY }}
           STATIC_IP_NAME: ${{ secrets.STATIC_IP_NAME }}
+
+  deploy-done:
+    needs:
+      - output-prev-version
+      - build-web
+      - build-admin
+      - build-mobile
+      - build-frontend-image
+      - build-server-image
+      - deploy
+    if: always()
+    runs-on: ubuntu-latest
+    name: Post deploy message
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/checkout@v4
+        with:
+          repository: toeverything/blocksuite
+          path: blocksuite
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+        with:
+          extra-flags: 'workspaces focus @affine/changelog'
+          electron-install: false
+      - name: Output deployed info
+        if: ${{ always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
+        id: set_info
+        run: |
+          if [ "${{ github.event.inputs.flavor }}" = "canary" ]; then
+            echo "deployed_url=https://affine.fail" >> $GITHUB_OUTPUT
+          elif [ "${{ github.event.inputs.flavor }}" = "beta" ]; then
+            echo "deployed_url=https://insider.affine.pro" >> $GITHUB_OUTPUT
+          elif [ "${{ github.event.inputs.flavor }}" = "stable" ]; then
+            echo "deployed_url=https://app.affine.pro" >> $GITHUB_OUTPUT
+          else
+            exit 1
+          fi
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Post Success event to a Slack channel
+        if: ${{ always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
+        run: node ./tools/changelog/index.js
+        env:
+          CHANNEL_ID: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+          DEPLOYED_URL: ${{ steps.set_info.outputs.deployed_url }}
+          PREV_VERSION: ${{ needs.output-prev-version.outputs.prev }}
+          NAMESPACE: ${{ needs.output-prev-version.outputs.namespace }}
+          DEPLOYMENT: 'SERVER'
+          FLAVOR: ${{ github.event.inputs.flavor }}
+          BLOCKSUITE_REPO_PATH: ${{ github.workspace }}/blocksuite
+      - name: Post Failed event to a Slack channel
+        id: failed-slack
+        uses: slackapi/slack-github-action@v1.27.0
+        if: ${{ always() && contains(needs.*.result, 'failure') }}
+        with:
+          channel-id: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
+          payload: |
+            {
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Backend deploy failed `${{ github.event.inputs.flavor }}`>",
+                    "type": "mrkdwn"
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+      - name: Post Cancel event to a Slack channel
+        id: cancel-slack
+        uses: slackapi/slack-github-action@v1.27.0
+        if: ${{ always() && contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
+        with:
+          channel-id: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
+          payload: |
+            {
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Backend deploy cancelled `${{ github.event.inputs.flavor }}`>",
+                    "type": "mrkdwn"
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}

.github/workflows/release-desktop.yml

@@ -27,6 +27,8 @@ permissions:
   actions: write
   contents: write
   security-events: write
+  id-token: write
+  attestations: write
 
 env:
   BUILD_TYPE: ${{ github.event.inputs.build-type }}
@@ -56,6 +58,7 @@ jobs:
           SENTRY_PROJECT: 'affine'
           SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
           SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          SENTRY_RELEASE: ${{ steps.version.outputs.APP_VERSION }}
           RELEASE_VERSION: ${{ steps.version.outputs.APP_VERSION }}
           SKIP_NX_CACHE: 'true'
           MIXPANEL_TOKEN: ${{ secrets.MIXPANEL_TOKEN }}
@@ -158,6 +161,20 @@ jobs:
           mv packages/frontend/electron/out/*/make/zip/linux/x64/*.zip ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-linux-x64.zip
           mv packages/frontend/electron/out/*/make/*.AppImage ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-linux-x64.appimage
 
+      - uses: actions/attest-build-provenance@v1
+        if: ${{ matrix.spec.platform == 'darwin' }}
+        with:
+          subject-path: |
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.zip
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-macos-${{ matrix.spec.arch }}.dmg
+
+      - uses: actions/attest-build-provenance@v1
+        if: ${{ matrix.spec.platform == 'linux' }}
+        with:
+          subject-path: |
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-linux-x64.zip
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-linux-x64.appimage
+
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:
@@ -254,6 +271,9 @@ jobs:
       FILES_TO_BE_SIGNED: ${{ steps.get_files_to_be_signed.outputs.FILES_TO_BE_SIGNED }}
     steps:
       - uses: actions/checkout@v4
+      - name: Setup Version
+        id: version
+        uses: ./.github/actions/setup-version
       - name: Setup Node.js
         timeout-minutes: 10
         uses: ./.github/actions/setup-node
@@ -324,6 +344,13 @@ jobs:
           mv packages/frontend/electron/out/*/make/squirrel.windows/x64/*.exe ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-windows-x64.exe
           mv packages/frontend/electron/out/*/make/nsis.windows/x64/*.exe ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-windows-x64.nsis.exe
 
+      - uses: actions/attest-build-provenance@v1
+        with:
+          subject-path: |
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-windows-x64.zip
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-windows-x64.exe
+            ./builds/affine-${{ needs.before-make.outputs.RELEASE_VERSION }}-${{ env.BUILD_TYPE }}-windows-x64.nsis.exe
+
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:
@@ -364,7 +391,7 @@ jobs:
           path: ./
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Generate Release yml
         run: |
           node ./packages/frontend/electron/scripts/generate-yml.js

.github/workflows/workers.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Publish
-        uses: cloudflare/wrangler-action@v3.5.0
+        uses: cloudflare/wrangler-action@v3.7.0
         with:
           apiToken: ${{ secrets.CF_API_TOKEN }}
           accountId: ${{ secrets.CF_ACCOUNT_ID }}

.nvmrc

@@ -1 +1 @@
-20.13.1
+20.17.0

.prettierignore

@@ -12,6 +12,7 @@ storybook-static
 web-static
 public
 packages/backend/server/src/schema.gql
+packages/backend/server/src/fundamentals/error/errors.gen.ts
 packages/frontend/i18n/src/i18n-generated.ts
 packages/frontend/graphql/src/graphql/index.ts
 tests/affine-legacy/**/static

.yarn/patches/yjs-npm-13.6.18-ad0d5f7c43.patch

@@ -0,0 +1,39 @@
+diff --git a/dist/yjs.cjs b/dist/yjs.cjs
+index d2dc06ae11a6eb44f8c8445d4298c0e89c3e4da2..a30ab04fa9f3b77666939caa88335c68c40f194c 100644
+--- a/dist/yjs.cjs
++++ b/dist/yjs.cjs
+@@ -414,7 +414,7 @@ const equalDeleteSets = (ds1, ds2) => {
+  */
+ 
+ 
+-const generateNewClientId = random__namespace.uint32;
++const generateNewClientId = random__namespace.uint53;
+ 
+ /**
+  * @typedef {Object} DocOpts
+diff --git a/dist/yjs.mjs b/dist/yjs.mjs
+index 20c9e58c32bcb6bc714200a2561fd1f542c49523..14267e5e36d9781ca3810d5b70ff8c051dac779e 100644
+--- a/dist/yjs.mjs
++++ b/dist/yjs.mjs
+@@ -378,7 +378,7 @@ const equalDeleteSets = (ds1, ds2) => {
+  */
+ 
+ 
+-const generateNewClientId = random.uint32;
++const generateNewClientId = random.uint53;
+ 
+ /**
+  * @typedef {Object} DocOpts
+diff --git a/src/utils/Doc.js b/src/utils/Doc.js
+index 62643617c86e57c64dd9babdb792fa8888357ec0..4df5048ab12af1ae0f1154da67f06dce1fda7b49 100644
+--- a/src/utils/Doc.js
++++ b/src/utils/Doc.js
+@@ -20,7 +20,7 @@ import * as map from 'lib0/map'
+ import * as array from 'lib0/array'
+ import * as promise from 'lib0/promise'
+ 
+-export const generateNewClientId = random.uint32
++export const generateNewClientId = random.uint53
+ 
+ /**
+  * @typedef {Object} DocOpts

.yarnrc.yml

@@ -12,4 +12,4 @@ npmPublishAccess: public
 
 npmPublishRegistry: "https://registry.npmjs.org"
 
-yarnPath: .yarn/releases/yarn-4.2.2.cjs
+yarnPath: .yarn/releases/yarn-4.4.1.cjs

Cargo.toml

@@ -18,7 +18,7 @@ rand        = "0.8"
 serde       = "1"
 serde_json  = "1"
 sha3        = "0.10"
-sqlx        = { version = "0.7", default-features = false, features = ["chrono", "macros", "migrate", "runtime-tokio", "sqlite", "tls-rustls"] }
+sqlx        = { version = "0.8", default-features = false, features = ["chrono", "macros", "migrate", "runtime-tokio", "sqlite", "tls-rustls"] }
 tiktoken-rs = "0.5"
 tokio       = "1.37"
 uuid        = "1.8"

README.md

@@ -23,7 +23,7 @@
 
 <div align="center">
     <a href="https://affine.pro">Home Page</a> |
-    <a href="https://discord.com/invite/yz6tGVsf5p">Discord</a> |
+    <a href="https://discord.gg/whd5mjYqVw">Discord</a> |
     <a href="https://app.affine.pro">Live Demo</a> |
     <a href="https://affine.pro/blog/">Blog</a> |
     <a href="https://docs.affine.pro/docs/">Documentation</a>
@@ -176,6 +176,12 @@ Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testi
 
 ## License
 
+### Editions
+
+- AFFiNE Community Edition (CE) is the current available version, it's free for self-host under the MIT license.
+
+- AFFiNE Enterprise Edition (EE) is yet to be published, it will have more advanced features and enterprise-oriented offerings, including but not exclusive to rebranding and SSO, advanced admin and audit, etc., you may refer to https://affine.pro/pricing for more information
+
 See [LICENSE] for details.
 
 [all-contributors-badge]: https://img.shields.io/github/contributors/toeverything/AFFiNE
@@ -185,7 +191,7 @@ See [LICENSE] for details.
 [jobs available]: ./docs/jobs.md
 [latest packages]: https://github.com/toeverything/AFFiNE/pkgs/container/affine-self-hosted
 [contributor license agreement]: https://github.com/toeverything/affine/edit/canary/.github/CLA.md
-[rust-version-icon]: https://img.shields.io/badge/Rust-1.77.2-dea584
+[rust-version-icon]: https://img.shields.io/badge/Rust-1.79.0-dea584
 [stars-icon]: https://img.shields.io/github/stars/toeverything/AFFiNE.svg?style=flat&logo=github&colorB=red&label=stars
 [codecov]: https://codecov.io/gh/toeverything/affine/branch/canary/graphs/badge.svg?branch=canary
 [node-version-icon]: https://img.shields.io/badge/node-%3E=18.16.1-success

SECURITY.md

@@ -6,8 +6,8 @@ We recommend users to always use the latest major version. Security updates will
 
 | Version         | Supported          |
 | --------------- | ------------------ |
-| 0.13.x (stable) | :white_check_mark: |
-| < 0.13.x        | :x:                |
+| 0.15.x (stable) | :white_check_mark: |
+| < 0.15.x        | :x:                |
 
 ## Reporting a Vulnerability
 

docs/reference/package.json

@@ -9,7 +9,7 @@
   "devDependencies": {
     "nodemon": "^3.1.0",
     "serve": "^14.2.1",
-    "typedoc": "^0.25.13"
+    "typedoc": "^0.26.0"
   },
   "nodemonConfig": {
     "watch": [
@@ -19,5 +19,5 @@
     ],
     "ext": "ts,md,json"
   },
-  "version": "0.14.0"
+  "version": "0.16.0"
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affine/monorepo",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "private": true,
   "author": "toeverything",
   "license": "MIT",
@@ -56,26 +56,26 @@
     "@affine/cli": "workspace:*",
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.1.0",
-    "@faker-js/faker": "^8.4.1",
+    "@faker-js/faker": "^9.0.0",
     "@istanbuljs/schema": "^0.1.3",
     "@magic-works/i18n-codegen": "^0.6.0",
-    "@nx/vite": "19.0.4",
-    "@playwright/test": "^1.44.0",
+    "@nx/vite": "^19.5.3",
+    "@playwright/test": "=1.46.1",
     "@taplo/cli": "^0.7.0",
-    "@testing-library/react": "^15.0.0",
+    "@testing-library/react": "^16.0.0",
     "@toeverything/infra": "workspace:*",
     "@types/affine__env": "workspace:*",
-    "@types/eslint": "^8.56.7",
+    "@types/eslint": "^9.0.0",
     "@types/node": "^20.12.7",
     "@typescript-eslint/eslint-plugin": "^7.6.0",
     "@typescript-eslint/parser": "^7.6.0",
     "@vanilla-extract/vite-plugin": "^4.0.7",
     "@vanilla-extract/webpack-plugin": "^2.3.7",
     "@vitejs/plugin-react-swc": "^3.6.0",
-    "@vitest/coverage-istanbul": "1.6.0",
-    "@vitest/ui": "1.6.0",
+    "@vitest/coverage-istanbul": "2.0.5",
+    "@vitest/ui": "2.0.5",
     "cross-env": "^7.0.3",
-    "electron": "^30.0.0",
+    "electron": "^31.0.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import-x": "^0.5.0",
@@ -87,29 +87,30 @@
     "eslint-plugin-unicorn": "^52.0.0",
     "eslint-plugin-unused-imports": "^3.1.0",
     "eslint-plugin-vue": "^9.24.1",
-    "fake-indexeddb": "5.0.2",
-    "happy-dom": "^14.7.1",
+    "fake-indexeddb": "6.0.0",
+    "happy-dom": "^15.0.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
     "msw": "^2.3.0",
     "nanoid": "^5.0.7",
     "nx": "^19.0.0",
-    "nyc": "^15.1.0",
-    "oxlint": "0.3.5",
-    "prettier": "^3.2.5",
+    "nyc": "^17.0.0",
+    "oxlint": "0.9.2",
+    "prettier": "^3.3.3",
     "semver": "^7.6.0",
     "serve": "^14.2.1",
     "string-width": "^7.1.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
+    "unplugin-swc": "^1.4.5",
     "vite": "^5.2.8",
     "vite-plugin-istanbul": "^6.0.0",
     "vite-plugin-static-copy": "^1.0.2",
-    "vitest": "1.6.0",
-    "vitest-fetch-mock": "^0.2.2",
-    "vitest-mock-extended": "^1.3.1"
+    "vitest": "2.0.5",
+    "vitest-fetch-mock": "^0.3.0",
+    "vitest-mock-extended": "^2.0.0"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.4.1",
   "resolutions": {
     "array-buffer-byte-length": "npm:@nolyfill/array-buffer-byte-length@latest",
     "array-includes": "npm:@nolyfill/array-includes@latest",
@@ -168,7 +169,6 @@
     "which-typed-array": "npm:@nolyfill/which-typed-array@latest",
     "@reforged/maker-appimage/@electron-forge/maker-base": "7.4.0",
     "macos-alias": "npm:@napi-rs/macos-alias@0.0.4",
-    "fs-xattr": "npm:@napi-rs/xattr@latest",
-    "@radix-ui/react-dialog": "npm:@radix-ui/react-dialog@latest"
+    "fs-xattr": "npm:@napi-rs/xattr@latest"
   }
 }

packages/backend/native/index.d.ts

@@ -1,20 +1,20 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export class Tokenizer {
+export declare class Tokenizer {
   count(content: string, allowedSpecial?: Array<string> | undefined | null): number
 }
 
-export function fromModelName(modelName: string): Tokenizer | null
+export declare function fromModelName(modelName: string): Tokenizer | null
 
-export function getMime(input: Uint8Array): string
+export declare function getMime(input: Uint8Array): string
 
 /**
  * Merge updates in form like `Y.applyUpdate(doc, update)` way and return the
  * result binary.
  */
-export function mergeUpdatesInApplyWay(updates: Array<Buffer>): Buffer
+export declare function mergeUpdatesInApplyWay(updates: Array<Buffer>): Buffer
 
-export function mintChallengeResponse(resource: string, bits?: number | undefined | null): Promise<string>
+export declare function mintChallengeResponse(resource: string, bits?: number | undefined | null): Promise<string>
 
-export function verifyChallengeResponse(response: string, bits: number, resource: string): Promise<boolean>
+export declare function verifyChallengeResponse(response: string, bits: number, resource: string): Promise<boolean>
 

packages/backend/native/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affine/server-native",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "engines": {
     "node": ">= 10.16.0 < 11 || >= 11.8.0"
   },
@@ -33,12 +33,12 @@
     "build:debug": "napi build"
   },
   "devDependencies": {
-    "@napi-rs/cli": "3.0.0-alpha.55",
+    "@napi-rs/cli": "3.0.0-alpha.62",
     "lib0": "^0.2.93",
     "nx": "^19.0.0",
     "nx-cloud": "^19.0.0",
     "tiktoken": "^1.0.15",
     "tinybench": "^2.8.0",
-    "yjs": "^13.6.14"
+    "yjs": "patch:yjs@npm%3A13.6.18#~/.yarn/patches/yjs-npm-13.6.18-ad0d5f7c43.patch"
   }
 }

packages/backend/server/.gitignore

@@ -1 +1,2 @@
 .env
+static/

packages/backend/server/migrations/20240416042935_lifetime_subscription/migration.sql

@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "user_subscriptions" ALTER COLUMN "stripe_subscription_id" DROP NOT NULL,
+ALTER COLUMN "end" DROP NOT NULL;

packages/backend/server/migrations/20240520055805_runtime_setting/migration.sql

@@ -0,0 +1,23 @@
+-- CreateEnum
+CREATE TYPE "RuntimeConfigType" AS ENUM ('String', 'Number', 'Boolean', 'Object', 'Array');
+
+-- CreateTable
+CREATE TABLE "app_runtime_settings" (
+    "id" VARCHAR NOT NULL,
+    "type" "RuntimeConfigType" NOT NULL,
+    "module" VARCHAR NOT NULL,
+    "key" VARCHAR NOT NULL,
+    "value" JSON NOT NULL,
+    "description" TEXT NOT NULL,
+    "updated_at" TIMESTAMPTZ(6) NOT NULL,
+    "deleted_at" TIMESTAMPTZ(6),
+    "last_updated_by" VARCHAR(36),
+
+    CONSTRAINT "app_runtime_settings_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "app_runtime_settings_module_key_key" ON "app_runtime_settings"("module", "key");
+
+-- AddForeignKey
+ALTER TABLE "app_runtime_settings" ADD CONSTRAINT "app_runtime_settings_last_updated_by_fkey" FOREIGN KEY ("last_updated_by") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;

packages/backend/server/migrations/20240521100307_add_copilot_cost/migration.sql

@@ -0,0 +1,4 @@
+-- AlterTable
+ALTER TABLE "ai_sessions_metadata" ADD COLUMN     "deleted_at" TIMESTAMPTZ(6),
+ADD COLUMN     "messageCost" INTEGER NOT NULL DEFAULT 0,
+ADD COLUMN     "tokenCost" INTEGER NOT NULL DEFAULT 0;

packages/backend/server/migrations/20240527095524_fix_prompt_schema/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - Made the column `model` on table `ai_prompts_metadata` required. This step will fail if there are existing NULL values in that column.
+
+*/
+-- AlterTable
+ALTER TABLE "ai_prompts_metadata" ALTER COLUMN "model" SET NOT NULL;

packages/backend/server/migrations/20240625052649_add_fork_session/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "ai_sessions_metadata" ADD COLUMN     "parent_session_id" VARCHAR(36);

packages/backend/server/migrations/20240708034904_prompt_level_config/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "ai_prompts_metadata" ADD COLUMN     "config" JSON;

packages/backend/server/migrations/20240731043837_standardize_table_columns/migration.sql

@@ -0,0 +1,146 @@
+-- AlterTable
+ALTER TABLE "_data_migrations" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "started_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "finished_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "ai_prompts_messages" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "ai_prompts_metadata" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "ai_sessions_messages" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "session_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "ai_sessions_metadata" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "doc_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "deleted_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "parent_session_id" SET DATA TYPE VARCHAR;
+
+-- AlterTable
+ALTER TABLE "app_runtime_settings" ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "deleted_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "last_updated_by" SET DATA TYPE VARCHAR;
+
+-- AlterTable
+ALTER TABLE "features" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "multiple_users_sessions" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "snapshot_histories"
+ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "guid" SET DATA TYPE VARCHAR,
+ALTER COLUMN "timestamp" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "snapshots" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "updates" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_connected_accounts" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_features" ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_invoices" ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_sessions" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "session_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_stripe_customers" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "user_subscriptions" ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "start" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "end" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "next_bill_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "canceled_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "trial_start" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "trial_end" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "users" ALTER COLUMN "name" SET DATA TYPE VARCHAR,
+ALTER COLUMN "email" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "verification_tokens" ALTER COLUMN "token" SET DATA TYPE VARCHAR,
+ALTER COLUMN "expiresAt" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "workspace_features" ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "workspace_page_user_permissions"
+ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "page_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "workspace_pages" ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "page_id" SET DATA TYPE VARCHAR;
+
+-- AlterTable
+ALTER TABLE "workspace_user_permissions" ALTER COLUMN "id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "workspace_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "user_id" SET DATA TYPE VARCHAR,
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- AlterTable
+ALTER TABLE "workspaces" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMP(3);
+
+-- DropTable
+DROP TABLE "accounts";
+
+-- DropTable
+DROP TABLE "blobs";
+
+-- DropTable
+DROP TABLE "new_features_waiting_list";
+
+-- DropTable
+DROP TABLE "optimized_blobs";
+
+-- DropTable
+DROP TABLE "sessions";
+
+-- DropTable
+DROP TABLE "user_workspace_permissions";
+
+-- DropTable
+DROP TABLE "verificationtokens";

packages/backend/server/migrations/20240813053919_use_timestamp_with_timezone/migration.sql

@@ -0,0 +1,95 @@
+/*
+  Warnings:
+
+  - The primary key for the `snapshot_histories` table will be changed. If it partially fails, the table could be left without primary key constraint.
+
+*/
+-- AlterTable
+ALTER TABLE "_data_migrations" ALTER COLUMN "started_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "finished_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "ai_prompts_messages" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "ai_prompts_metadata" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "ai_sessions_messages" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "ai_sessions_metadata" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "deleted_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "app_runtime_settings" ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "deleted_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "features" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "multiple_users_sessions" ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "snapshot_histories" ALTER COLUMN "timestamp" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "snapshots" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "updates" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_connected_accounts" ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_features" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_invoices" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_sessions" ALTER COLUMN "expires_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_stripe_customers" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "user_subscriptions" ALTER COLUMN "start" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "end" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "next_bill_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "canceled_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "trial_start" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "trial_end" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "updated_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "users" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "email_verified" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "verification_tokens" ALTER COLUMN "expiresAt" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "workspace_features" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3),
+ALTER COLUMN "expired_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "workspace_page_user_permissions" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "workspace_user_permissions" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);
+
+-- AlterTable
+ALTER TABLE "workspaces" ALTER COLUMN "created_at" SET DATA TYPE TIMESTAMPTZ(3);

packages/backend/server/migrations/20240813095727_prompt_updated_field/migration.sql

@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "ai_prompts_metadata" ADD COLUMN     "modified" BOOLEAN NOT NULL DEFAULT false,
+ADD COLUMN     "updated_at" TIMESTAMPTZ(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;

packages/backend/server/migrations/20240815064332_userspace/migration.sql

@@ -0,0 +1,13 @@
+-- CreateTable
+CREATE TABLE "user_snapshots" (
+    "user_id" VARCHAR NOT NULL,
+    "id" VARCHAR NOT NULL,
+    "blob" BYTEA NOT NULL,
+    "created_at" TIMESTAMPTZ(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMPTZ(3) NOT NULL,
+
+    CONSTRAINT "user_snapshots_pkey" PRIMARY KEY ("user_id","id")
+);
+
+-- AddForeignKey
+ALTER TABLE "user_snapshots" ADD CONSTRAINT "user_snapshots_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE CASCADE ON UPDATE CASCADE;

packages/backend/server/migrations/20240815084618_update_doc_tables/migration.sql

@@ -0,0 +1,14 @@
+/*
+  Warnings:
+
+  - The primary key for the `updates` table will be changed. If it partially fails, the table could be left without primary key constraint.
+
+*/
+-- AlterTable
+ALTER TABLE "snapshots" ALTER COLUMN "seq" DROP NOT NULL;
+
+-- AlterTable
+ALTER TABLE "updates" DROP CONSTRAINT "updates_pkey",
+ALTER COLUMN "created_at" DROP DEFAULT,
+ALTER COLUMN "seq" DROP NOT NULL,
+ADD CONSTRAINT "updates_pkey" PRIMARY KEY ("workspace_id", "guid", "created_at");

packages/backend/server/migrations/20240826033024_editor_record/migration.sql

@@ -0,0 +1,21 @@
+-- AlterTable
+ALTER TABLE "snapshot_histories" ADD COLUMN     "created_by" VARCHAR;
+
+-- AlterTable
+ALTER TABLE "snapshots" ADD COLUMN     "created_by" VARCHAR,
+ADD COLUMN     "updated_by" VARCHAR;
+
+-- AlterTable
+ALTER TABLE "updates" ADD COLUMN     "created_by" VARCHAR;
+
+-- AddForeignKey
+ALTER TABLE "snapshots" ADD CONSTRAINT "snapshots_created_by_fkey" FOREIGN KEY ("created_by") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "snapshots" ADD CONSTRAINT "snapshots_updated_by_fkey" FOREIGN KEY ("updated_by") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "updates" ADD CONSTRAINT "updates_created_by_fkey" FOREIGN KEY ("created_by") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "snapshot_histories" ADD CONSTRAINT "snapshot_histories_created_by_fkey" FOREIGN KEY ("created_by") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;

packages/backend/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"

packages/backend/server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@affine/server",
   "private": true,
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Affine Node.js server",
   "type": "module",
   "bin": {
@@ -15,15 +15,17 @@
     "test:coverage": "c8 ava --concurrency 1 --serial",
     "postinstall": "prisma generate",
     "data-migration": "node --loader ts-node/esm/transpile-only.mjs ./src/data/index.ts",
-    "predeploy": "yarn prisma migrate deploy && node --import ./scripts/register.js ./dist/data/index.js run"
+    "predeploy": "yarn prisma migrate deploy && node --import ./scripts/register.js ./dist/data/index.js run",
+    "predeploy:ts": "yarn prisma migrate deploy && node --loader ts-node/esm/transpile-only.mjs ./src/data/index.ts run"
   },
   "dependencies": {
     "@apollo/server": "^4.10.2",
-    "@aws-sdk/client-s3": "^3.552.0",
-    "@google-cloud/opentelemetry-cloud-monitoring-exporter": "^0.18.0",
+    "@aws-sdk/client-s3": "^3.620.0",
+    "@fal-ai/serverless-client": "^0.14.0",
+    "@google-cloud/opentelemetry-cloud-monitoring-exporter": "^0.19.0",
     "@google-cloud/opentelemetry-cloud-trace-exporter": "^2.2.0",
     "@google-cloud/opentelemetry-resource-util": "^2.2.0",
-    "@keyv/redis": "^2.8.4",
+    "@keyv/redis": "^3.0.0",
     "@nestjs/apollo": "^12.1.0",
     "@nestjs/common": "^10.3.7",
     "@nestjs/core": "^10.3.7",
@@ -32,64 +34,67 @@
     "@nestjs/platform-express": "^10.3.7",
     "@nestjs/platform-socket.io": "^10.3.7",
     "@nestjs/schedule": "^4.0.1",
-    "@nestjs/serve-static": "^4.0.2",
-    "@nestjs/throttler": "5.1.2",
+    "@nestjs/throttler": "6.2.1",
     "@nestjs/websockets": "^10.3.7",
     "@node-rs/argon2": "^1.8.0",
     "@node-rs/crc32": "^1.10.0",
     "@node-rs/jsonwebtoken": "^0.5.2",
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/core": "^1.24.1",
-    "@opentelemetry/exporter-prometheus": "^0.51.1",
-    "@opentelemetry/exporter-zipkin": "^1.24.1",
-    "@opentelemetry/host-metrics": "^0.35.1",
-    "@opentelemetry/instrumentation": "^0.51.1",
-    "@opentelemetry/instrumentation-graphql": "^0.40.0",
-    "@opentelemetry/instrumentation-http": "^0.51.1",
-    "@opentelemetry/instrumentation-ioredis": "^0.40.0",
-    "@opentelemetry/instrumentation-nestjs-core": "^0.37.1",
-    "@opentelemetry/instrumentation-socket.io": "^0.39.0",
-    "@opentelemetry/resources": "^1.24.1",
-    "@opentelemetry/sdk-metrics": "^1.24.1",
-    "@opentelemetry/sdk-node": "^0.51.1",
-    "@opentelemetry/sdk-trace-node": "^1.24.1",
-    "@opentelemetry/semantic-conventions": "^1.24.1",
-    "@prisma/client": "^5.12.1",
-    "@prisma/instrumentation": "^5.12.1",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^1.25.0",
+    "@opentelemetry/exporter-prometheus": "^0.53.0",
+    "@opentelemetry/exporter-zipkin": "^1.25.0",
+    "@opentelemetry/host-metrics": "^0.35.2",
+    "@opentelemetry/instrumentation": "^0.53.0",
+    "@opentelemetry/instrumentation-graphql": "^0.43.0",
+    "@opentelemetry/instrumentation-http": "^0.53.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.43.0",
+    "@opentelemetry/instrumentation-nestjs-core": "^0.40.0",
+    "@opentelemetry/instrumentation-socket.io": "^0.42.0",
+    "@opentelemetry/resources": "^1.25.0",
+    "@opentelemetry/sdk-metrics": "^1.25.0",
+    "@opentelemetry/sdk-node": "^0.53.0",
+    "@opentelemetry/sdk-trace-node": "^1.25.0",
+    "@opentelemetry/semantic-conventions": "^1.25.0",
+    "@prisma/client": "^5.15.0",
+    "@prisma/instrumentation": "^5.15.0",
     "@socket.io/redis-adapter": "^8.3.0",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.4.5",
     "dotenv-cli": "^7.4.1",
     "express": "^4.19.2",
+    "fast-xml-parser": "^4.4.0",
     "get-stream": "^9.0.1",
     "graphql": "^16.8.1",
     "graphql-scalars": "^1.23.0",
     "graphql-type-json": "^0.3.2",
     "graphql-upload": "^16.0.2",
+    "html-validate": "^8.20.1",
     "ioredis": "^5.3.2",
-    "keyv": "^4.5.4",
+    "keyv": "^5.0.0",
     "lodash-es": "^4.17.21",
     "mixpanel": "^0.18.0",
     "mustache": "^4.2.0",
     "nanoid": "^5.0.7",
     "nest-commander": "^3.12.5",
-    "nestjs-throttler-storage-redis": "^0.4.1",
+    "nestjs-throttler-storage-redis": "^0.5.0",
     "nodemailer": "^6.9.13",
     "on-headers": "^1.0.2",
     "openai": "^4.33.0",
     "parse-duration": "^1.1.0",
+    "piscina": "^4.5.1",
     "pretty-time": "^1.1.0",
     "prisma": "^5.12.1",
     "prom-client": "^15.1.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "semver": "^7.6.0",
+    "ses": "^1.4.1",
     "socket.io": "^4.7.5",
-    "stripe": "^15.0.0",
+    "stripe": "^16.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "ws": "^8.16.0",
-    "yjs": "^13.6.14",
+    "yjs": "patch:yjs@npm%3A13.6.18#~/.yarn/patches/yjs-npm-13.6.18-ad0d5f7c43.patch",
     "zod": "^3.22.4"
   },
   "devDependencies": {
@@ -113,7 +118,7 @@
     "@types/supertest": "^6.0.2",
     "@types/ws": "^8.5.10",
     "ava": "^6.1.2",
-    "c8": "^9.1.0",
+    "c8": "^10.0.0",
     "nodemon": "^3.1.0",
     "sinon": "^18.0.0",
     "supertest": "^7.0.0"
@@ -130,7 +135,14 @@
       "ts-node/esm/transpile-only.mjs",
       "--es-module-specifier-resolution=node"
     ],
+    "watchMode": {
+      "ignoreChanges": [
+        "static/**",
+        "**/*.gen.*"
+      ]
+    },
     "files": [
+      "**/__tests__/**/*.spec.ts",
       "tests/**/*.spec.ts",
       "tests/**/*.e2e.ts"
     ],
@@ -159,9 +171,11 @@
     ],
     "ignore": [
       "**/__tests__/**",
-      "**/dist/**"
+      "**/dist/**",
+      "*.gen.*"
     ],
     "env": {
+      "AFFINE_SERVER_EXTERNAL_URL": "http://localhost:8080",
       "TS_NODE_TRANSPILE_ONLY": true,
       "TS_NODE_PROJECT": "./tsconfig.json",
       "DEBUG": "affine:*",
@@ -179,7 +193,8 @@
     "exclude": [
       "scripts",
       "node_modules",
-      "**/*.spec.ts"
+      "**/*.spec.ts",
+      "**/*.e2e.ts"
     ]
   },
   "stableVersion": "0.5.3",

packages/backend/server/schema.prisma

@@ -11,42 +11,48 @@ datasource db {
 
 model User {
   id              String    @id @default(uuid()) @db.VarChar
-  name            String
-  email           String    @unique
-  emailVerifiedAt DateTime? @map("email_verified")
+  name            String    @db.VarChar
+  email           String    @unique @db.VarChar
+  emailVerifiedAt DateTime? @map("email_verified") @db.Timestamptz(3)
   avatarUrl       String?   @map("avatar_url") @db.VarChar
-  createdAt       DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt       DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
   /// Not available if user signed up through OAuth providers
   password        String?   @db.VarChar
   /// Indicate whether the user finished the signup progress.
   /// for example, the value will be false if user never registered and invited into a workspace by others.
   registered      Boolean   @default(true)
 
-  features             UserFeatures[]
-  customer             UserStripeCustomer?
-  subscriptions        UserSubscription[]
-  invoices             UserInvoice[]
-  workspacePermissions WorkspaceUserPermission[]
-  pagePermissions      WorkspacePageUserPermission[]
-  connectedAccounts    ConnectedAccount[]
-  sessions             UserSession[]
-  aiSessions           AiSession[]
+  features              UserFeature[]
+  customer              UserStripeCustomer?
+  subscriptions         UserSubscription[]
+  invoices              UserInvoice[]
+  workspacePermissions  WorkspaceUserPermission[]
+  pagePermissions       WorkspacePageUserPermission[]
+  connectedAccounts     ConnectedAccount[]
+  sessions              UserSession[]
+  aiSessions            AiSession[]
+  updatedRuntimeConfigs RuntimeConfig[]
+  userSnapshots         UserSnapshot[]
+  createdSnapshot       Snapshot[]                    @relation("createdSnapshot")
+  updatedSnapshot       Snapshot[]                    @relation("updatedSnapshot")
+  createdUpdate         Update[]                      @relation("createdUpdate")
+  createdHistory        SnapshotHistory[]             @relation("createdHistory")
 
   @@index([email])
   @@map("users")
 }
 
 model ConnectedAccount {
-  id                String    @id @default(uuid()) @db.VarChar(36)
-  userId            String    @map("user_id") @db.VarChar(36)
+  id                String    @id @default(uuid()) @db.VarChar
+  userId            String    @map("user_id") @db.VarChar
   provider          String    @db.VarChar
   providerAccountId String    @map("provider_account_id") @db.VarChar
   scope             String?   @db.Text
   accessToken       String?   @map("access_token") @db.Text
   refreshToken      String?   @map("refresh_token") @db.Text
-  expiresAt         DateTime? @map("expires_at") @db.Timestamptz(6)
-  createdAt         DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
-  updatedAt         DateTime  @updatedAt @map("updated_at") @db.Timestamptz(6)
+  expiresAt         DateTime? @map("expires_at") @db.Timestamptz(3)
+  createdAt         DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt         DateTime  @updatedAt @map("updated_at") @db.Timestamptz(3)
 
   user User @relation(fields: [userId], references: [id], onDelete: Cascade)
 
@@ -56,21 +62,22 @@ model ConnectedAccount {
 }
 
 model Session {
-  id        String    @id @default(uuid()) @db.VarChar(36)
-  expiresAt DateTime? @map("expires_at") @db.Timestamptz(6)
-  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
-
+  id           String        @id @default(uuid()) @db.VarChar
+  createdAt    DateTime      @default(now()) @map("created_at") @db.Timestamptz(3)
   userSessions UserSession[]
 
+  // @deprecated use [UserSession.expiresAt]
+  deprecated_expiresAt DateTime? @map("expires_at") @db.Timestamptz(3)
+
   @@map("multiple_users_sessions")
 }
 
 model UserSession {
-  id        String    @id @default(uuid()) @db.VarChar(36)
-  sessionId String    @map("session_id") @db.VarChar(36)
-  userId    String    @map("user_id") @db.VarChar(36)
-  expiresAt DateTime? @map("expires_at") @db.Timestamptz(6)
-  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
+  id        String    @id @default(uuid()) @db.VarChar
+  sessionId String    @map("session_id") @db.VarChar
+  userId    String    @map("user_id") @db.VarChar
+  expiresAt DateTime? @map("expires_at") @db.Timestamptz(3)
+  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
 
   session Session @relation(fields: [sessionId], references: [id], onDelete: Cascade)
   user    User    @relation(fields: [userId], references: [id], onDelete: Cascade)
@@ -80,10 +87,10 @@ model UserSession {
 }
 
 model VerificationToken {
-  token      String   @db.VarChar(36)
+  token      String   @db.VarChar
   type       Int      @db.SmallInt
   credential String?  @db.Text
-  expiresAt  DateTime @db.Timestamptz(6)
+  expiresAt  DateTime @db.Timestamptz(3)
 
   @@unique([type, token])
   @@map("verification_tokens")
@@ -92,12 +99,12 @@ model VerificationToken {
 model Workspace {
   id        String   @id @default(uuid()) @db.VarChar
   public    Boolean
-  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 
   pages           WorkspacePage[]
   permissions     WorkspaceUserPermission[]
   pagePermissions WorkspacePageUserPermission[]
-  features        WorkspaceFeatures[]
+  features        WorkspaceFeature[]
 
   @@map("workspaces")
 }
@@ -108,8 +115,8 @@ model Workspace {
 //   Only the ones that have ever changed will have records here,
 //   and for others we will make sure it's has a default value return in our bussiness logic.
 model WorkspacePage {
-  workspaceId String  @map("workspace_id") @db.VarChar(36)
-  pageId      String  @map("page_id") @db.VarChar(36)
+  workspaceId String  @map("workspace_id") @db.VarChar
+  pageId      String  @map("page_id") @db.VarChar
   public      Boolean @default(false)
   // Page/Edgeless
   mode        Int     @default(0) @db.SmallInt
@@ -120,31 +127,15 @@ model WorkspacePage {
   @@map("workspace_pages")
 }
 
-// @deprecated, use WorkspaceUserPermission
-model DeprecatedUserWorkspacePermission {
+model WorkspaceUserPermission {
   id          String   @id @default(uuid()) @db.VarChar
   workspaceId String   @map("workspace_id") @db.VarChar
-  subPageId   String?  @map("sub_page_id") @db.VarChar
-  userId      String?  @map("entity_id") @db.VarChar
-  /// Read/Write/Admin/Owner
-  type        Int      @db.SmallInt
-  /// Whether the permission invitation is accepted by the user
-  accepted    Boolean  @default(false)
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
-
-  @@unique([workspaceId, subPageId, userId])
-  @@map("user_workspace_permissions")
-}
-
-model WorkspaceUserPermission {
-  id          String   @id @default(uuid()) @db.VarChar(36)
-  workspaceId String   @map("workspace_id") @db.VarChar(36)
-  userId      String   @map("user_id") @db.VarChar(36)
+  userId      String   @map("user_id") @db.VarChar
   // Read/Write
   type        Int      @db.SmallInt
   /// Whether the permission invitation is accepted by the user
   accepted    Boolean  @default(false)
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 
   user      User      @relation(fields: [userId], references: [id], onDelete: Cascade)
   workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
@@ -154,15 +145,15 @@ model WorkspaceUserPermission {
 }
 
 model WorkspacePageUserPermission {
-  id          String   @id @default(uuid()) @db.VarChar(36)
-  workspaceId String   @map("workspace_id") @db.VarChar(36)
-  pageId      String   @map("page_id") @db.VarChar(36)
-  userId      String   @map("user_id") @db.VarChar(36)
+  id          String   @id @default(uuid()) @db.VarChar
+  workspaceId String   @map("workspace_id") @db.VarChar
+  pageId      String   @map("page_id") @db.VarChar
+  userId      String   @map("user_id") @db.VarChar
   // Read/Write
   type        Int      @db.SmallInt
   /// Whether the permission invitation is accepted by the user
   accepted    Boolean  @default(false)
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 
   user      User      @relation(fields: [userId], references: [id], onDelete: Cascade)
   workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
@@ -175,9 +166,9 @@ model WorkspacePageUserPermission {
 // for example:
 // - early access is a feature that allow some users to access the insider version
 // - pro plan is a quota that allow some users access to more resources after they pay
-model UserFeatures {
+model UserFeature {
   id        Int    @id @default(autoincrement())
-  userId    String @map("user_id") @db.VarChar(36)
+  userId    String @map("user_id") @db.VarChar
   featureId Int    @map("feature_id") @db.Integer
 
   // we will record the reason why the feature is enabled/disabled
@@ -185,16 +176,16 @@ model UserFeatures {
   // - pro_plan_v1: "user buy the pro plan"
   reason    String    @db.VarChar
   // record the quota enabled time
-  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
   // record the quota expired time, pay plan is a subscription, so it will expired
-  expiredAt DateTime? @map("expired_at") @db.Timestamptz(6)
+  expiredAt DateTime? @map("expired_at") @db.Timestamptz(3)
   // whether the feature is activated
   // for example:
   // - if we switch the user to another plan, we will set the old plan to deactivated, but dont delete it
   activated Boolean   @default(false)
 
-  feature Features @relation(fields: [featureId], references: [id], onDelete: Cascade)
-  user    User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+  feature Feature @relation(fields: [featureId], references: [id], onDelete: Cascade)
+  user    User    @relation(fields: [userId], references: [id], onDelete: Cascade)
 
   @@index([userId])
   @@map("user_features")
@@ -203,9 +194,9 @@ model UserFeatures {
 // feature gates is a way to enable/disable features for a workspace
 // for example:
 // - copilet is a feature that allow some users in a workspace to access the copilet feature
-model WorkspaceFeatures {
+model WorkspaceFeature {
   id          Int    @id @default(autoincrement())
-  workspaceId String @map("workspace_id") @db.VarChar(36)
+  workspaceId String @map("workspace_id") @db.VarChar
   featureId   Int    @map("feature_id") @db.Integer
 
   // we will record the reason why the feature is enabled/disabled
@@ -213,21 +204,21 @@ model WorkspaceFeatures {
   // - copilet_v1: "owner buy the copilet feature package"
   reason    String    @db.VarChar
   // record the feature enabled time
-  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
   // record the quota expired time, pay plan is a subscription, so it will expired
-  expiredAt DateTime? @map("expired_at") @db.Timestamptz(6)
+  expiredAt DateTime? @map("expired_at") @db.Timestamptz(3)
   // whether the feature is activated
   // for example:
   // - if owner unsubscribe a feature package, we will set the feature to deactivated, but dont delete it
   activated Boolean   @default(false)
 
-  feature   Features  @relation(fields: [featureId], references: [id], onDelete: Cascade)
+  feature   Feature   @relation(fields: [featureId], references: [id], onDelete: Cascade)
   workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
 
   @@map("workspace_features")
 }
 
-model Features {
+model Feature {
   id        Int      @id @default(autoincrement())
   feature   String   @db.VarChar
   version   Int      @default(0) @db.Integer
@@ -235,135 +226,98 @@ model Features {
   type      Int      @db.Integer
   // configs, define by feature conntroller
   configs   Json     @db.Json
-  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 
-  UserFeatureGates  UserFeatures[]
-  WorkspaceFeatures WorkspaceFeatures[]
+  UserFeatureGates  UserFeature[]
+  WorkspaceFeatures WorkspaceFeature[]
 
   @@unique([feature, version])
   @@map("features")
 }
 
-model DeprecatedNextAuthAccount {
-  id                String  @id @default(cuid())
-  userId            String  @map("user_id")
-  type              String
-  provider          String
-  providerAccountId String  @map("provider_account_id")
-  refresh_token     String? @db.Text
-  access_token      String? @db.Text
-  expires_at        Int?
-  token_type        String?
-  scope             String?
-  id_token          String? @db.Text
-  session_state     String?
-
-  @@unique([provider, providerAccountId])
-  @@map("accounts")
-}
-
-model DeprecatedNextAuthSession {
-  id           String   @id @default(cuid())
-  sessionToken String   @unique @map("session_token")
-  userId       String   @map("user_id")
-  expires      DateTime
-
-  @@map("sessions")
-}
-
-model DeprecatedNextAuthVerificationToken {
-  identifier String
-  token      String   @unique
-  expires    DateTime
-
-  @@unique([identifier, token])
-  @@map("verificationtokens")
-}
-
-// deprecated, use [ObjectStorage]
-model Blob {
-  id          Int       @id @default(autoincrement()) @db.Integer
-  hash        String    @db.VarChar
-  workspaceId String    @map("workspace_id") @db.VarChar
-  blob        Bytes     @db.ByteA
-  length      BigInt
-  createdAt   DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
-  // not for keeping, but for snapshot history
-  deletedAt   DateTime? @map("deleted_at") @db.Timestamptz(6)
-
-  @@unique([workspaceId, hash])
-  @@map("blobs")
-}
-
-// deprecated, use [ObjectStorage]
-model OptimizedBlob {
-  id          Int       @id @default(autoincrement()) @db.Integer
-  hash        String    @db.VarChar
-  workspaceId String    @map("workspace_id") @db.VarChar
-  params      String    @db.VarChar
-  blob        Bytes     @db.ByteA
-  length      BigInt
-  createdAt   DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
-  // not for keeping, but for snapshot history
-  deletedAt   DateTime? @map("deleted_at") @db.Timestamptz(6)
-
-  @@unique([workspaceId, hash, params])
-  @@map("optimized_blobs")
-}
-
 // the latest snapshot of each doc that we've seen
 // Snapshot + Updates are the latest state of the doc
 model Snapshot {
   workspaceId String   @map("workspace_id") @db.VarChar
   id          String   @default(uuid()) @map("guid") @db.VarChar
   blob        Bytes    @db.ByteA
-  seq         Int      @default(0) @db.Integer
   state       Bytes?   @db.ByteA
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
   // the `updated_at` field will not record the time of record changed,
   // but the created time of last seen update that has been merged into snapshot.
-  updatedAt   DateTime @map("updated_at") @db.Timestamptz(6)
+  updatedAt   DateTime @map("updated_at") @db.Timestamptz(3)
+  createdBy   String?  @map("created_by") @db.VarChar
+  updatedBy   String?  @map("updated_by") @db.VarChar
+
+  // should not delete origin snapshot even if user is deleted
+  // we only delete the snapshot if the workspace is deleted
+  createdByUser User? @relation(name: "createdSnapshot", fields: [createdBy], references: [id], onDelete: SetNull)
+  updatedByUser User? @relation(name: "updatedSnapshot", fields: [updatedBy], references: [id], onDelete: SetNull)
+
+  // @deprecated use updatedAt only
+  seq Int? @default(0) @db.Integer
+
+  // we need to clear all hanging updates and snapshots before enable the foreign key on workspaceId
+  // workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
 
   @@id([id, workspaceId])
   @@map("snapshots")
 }
 
+// user snapshots are special snapshots for user storage like personal app settings, distinguished from workspace snapshots
+// basically they share the same structure with workspace snapshots
+// but for convenience, we don't fork the updates queue and hisotry for user snapshots, until we have to
+// which means all operation on user snapshot will happen in-pace
+model UserSnapshot {
+  userId    String   @map("user_id") @db.VarChar
+  id        String   @map("id") @db.VarChar
+  blob      Bytes    @db.ByteA
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt DateTime @updatedAt @map("updated_at") @db.Timestamptz(3)
+
+  user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+  @@id([userId, id])
+  @@map("user_snapshots")
+}
+
 model Update {
   workspaceId String   @map("workspace_id") @db.VarChar
   id          String   @map("guid") @db.VarChar
-  seq         Int      @db.Integer
   blob        Bytes    @db.ByteA
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt   DateTime @map("created_at") @db.Timestamptz(3)
+  createdBy   String?  @map("created_by") @db.VarChar
 
-  @@id([workspaceId, id, seq])
+  // will delete createor record if createor's account is deleted
+  createdByUser User? @relation(name: "createdUpdate", fields: [createdBy], references: [id], onDelete: SetNull)
+
+  // @deprecated use createdAt only
+  seq Int? @db.Integer
+
+  @@id([workspaceId, id, createdAt])
   @@map("updates")
 }
 
 model SnapshotHistory {
-  workspaceId String   @map("workspace_id") @db.VarChar(36)
-  id          String   @map("guid") @db.VarChar(36)
-  timestamp   DateTime @db.Timestamptz(6)
+  workspaceId String   @map("workspace_id") @db.VarChar
+  id          String   @map("guid") @db.VarChar
+  timestamp   DateTime @db.Timestamptz(3)
   blob        Bytes    @db.ByteA
   state       Bytes?   @db.ByteA
-  expiredAt   DateTime @map("expired_at") @db.Timestamptz(6)
+  expiredAt   DateTime @map("expired_at") @db.Timestamptz(3)
+  createdBy   String?  @map("created_by") @db.VarChar
+
+  // will delete createor record if creator's account is deleted
+  createdByUser User? @relation(name: "createdHistory", fields: [createdBy], references: [id], onDelete: SetNull)
 
   @@id([workspaceId, id, timestamp])
   @@map("snapshot_histories")
 }
 
-model NewFeaturesWaitingList {
-  id        String   @id @default(uuid()) @db.VarChar
-  email     String   @unique
-  type      Int      @db.SmallInt
-  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
-
-  @@map("new_features_waiting_list")
-}
-
 model UserStripeCustomer {
   userId           String   @id @map("user_id") @db.VarChar
   stripeCustomerId String   @unique @map("stripe_customer_id") @db.VarChar
-  createdAt        DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt        DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 
   user User @relation(fields: [userId], references: [id], onDelete: Cascade)
 
@@ -372,30 +326,30 @@ model UserStripeCustomer {
 
 model UserSubscription {
   id                   Int       @id @default(autoincrement()) @db.Integer
-  userId               String    @map("user_id") @db.VarChar(36)
+  userId               String    @map("user_id") @db.VarChar
   plan                 String    @db.VarChar(20)
   // yearly/monthly
   recurring            String    @db.VarChar(20)
-  // subscription.id
-  stripeSubscriptionId String    @unique @map("stripe_subscription_id")
+  // subscription.id, null for linefetime payment
+  stripeSubscriptionId String?   @unique @map("stripe_subscription_id")
   // subscription.status, active/past_due/canceled/unpaid...
   status               String    @db.VarChar(20)
   // subscription.current_period_start
-  start                DateTime  @map("start") @db.Timestamptz(6)
-  // subscription.current_period_end
-  end                  DateTime  @map("end") @db.Timestamptz(6)
+  start                DateTime  @map("start") @db.Timestamptz(3)
+  // subscription.current_period_end, null for lifetime payment
+  end                  DateTime? @map("end") @db.Timestamptz(3)
   // subscription.billing_cycle_anchor
-  nextBillAt           DateTime? @map("next_bill_at") @db.Timestamptz(6)
+  nextBillAt           DateTime? @map("next_bill_at") @db.Timestamptz(3)
   // subscription.canceled_at
-  canceledAt           DateTime? @map("canceled_at") @db.Timestamptz(6)
+  canceledAt           DateTime? @map("canceled_at") @db.Timestamptz(3)
   // subscription.trial_start
-  trialStart           DateTime? @map("trial_start") @db.Timestamptz(6)
+  trialStart           DateTime? @map("trial_start") @db.Timestamptz(3)
   // subscription.trial_end
-  trialEnd             DateTime? @map("trial_end") @db.Timestamptz(6)
+  trialEnd             DateTime? @map("trial_end") @db.Timestamptz(3)
   stripeScheduleId     String?   @map("stripe_schedule_id") @db.VarChar
 
-  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
-  updatedAt DateTime @updatedAt @map("updated_at") @db.Timestamptz(6)
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt DateTime @updatedAt @map("updated_at") @db.Timestamptz(3)
   user      User     @relation(fields: [userId], references: [id], onDelete: Cascade)
 
   @@unique([userId, plan])
@@ -404,7 +358,7 @@ model UserSubscription {
 
 model UserInvoice {
   id               Int      @id @default(autoincrement()) @db.Integer
-  userId           String   @map("user_id") @db.VarChar(36)
+  userId           String   @map("user_id") @db.VarChar
   stripeInvoiceId  String   @unique @map("stripe_invoice_id")
   currency         String   @db.VarChar(3)
   // CNY 12.50 stored as 1250
@@ -412,8 +366,8 @@ model UserInvoice {
   status           String   @db.VarChar(20)
   plan             String   @db.VarChar(20)
   recurring        String   @db.VarChar(20)
-  createdAt        DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
-  updatedAt        DateTime @updatedAt @map("updated_at") @db.Timestamptz(6)
+  createdAt        DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt        DateTime @updatedAt @map("updated_at") @db.Timestamptz(3)
   // billing reason
   reason           String   @db.VarChar
   lastPaymentError String?  @map("last_payment_error") @db.Text
@@ -441,7 +395,7 @@ model AiPromptMessage {
   content     String       @db.Text
   attachments Json?        @db.Json
   params      Json?        @db.Json
-  createdAt   DateTime     @default(now()) @map("created_at") @db.Timestamptz(6)
+  createdAt   DateTime     @default(now()) @map("created_at") @db.Timestamptz(3)
 
   prompt AiPrompt @relation(fields: [promptId], references: [id], onDelete: Cascade)
 
@@ -455,8 +409,12 @@ model AiPrompt {
   // an mark identifying which view to use to display the session
   // it is only used in the frontend and does not affect the backend
   action    String?  @db.VarChar
-  model     String?  @db.VarChar
-  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  model     String   @db.VarChar
+  config    Json?    @db.Json
+  createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt DateTime @default(now()) @map("updated_at") @db.Timestamptz(3)
+  // whether the prompt is modified by the admin panel
+  modified  Boolean  @default(false)
 
   messages AiPromptMessage[]
   sessions AiSession[]
@@ -465,14 +423,14 @@ model AiPrompt {
 }
 
 model AiSessionMessage {
-  id          String       @id @default(uuid()) @db.VarChar(36)
-  sessionId   String       @map("session_id") @db.VarChar(36)
+  id          String       @id @default(uuid()) @db.VarChar
+  sessionId   String       @map("session_id") @db.VarChar
   role        AiPromptRole
   content     String       @db.Text
   attachments Json?        @db.Json
   params      Json?        @db.Json
-  createdAt   DateTime     @default(now()) @map("created_at") @db.Timestamptz(6)
-  updatedAt   DateTime     @updatedAt @map("updated_at") @db.Timestamptz(6)
+  createdAt   DateTime     @default(now()) @map("created_at") @db.Timestamptz(3)
+  updatedAt   DateTime     @updatedAt @map("updated_at") @db.Timestamptz(3)
 
   session AiSession @relation(fields: [sessionId], references: [id], onDelete: Cascade)
 
@@ -480,12 +438,17 @@ model AiSessionMessage {
 }
 
 model AiSession {
-  id          String   @id @default(uuid()) @db.VarChar(36)
-  userId      String   @map("user_id") @db.VarChar(36)
-  workspaceId String   @map("workspace_id") @db.VarChar(36)
-  docId       String   @map("doc_id") @db.VarChar(36)
-  promptName  String   @map("prompt_name") @db.VarChar(32)
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+  id              String    @id @default(uuid()) @db.VarChar
+  userId          String    @map("user_id") @db.VarChar
+  workspaceId     String    @map("workspace_id") @db.VarChar
+  docId           String    @map("doc_id") @db.VarChar
+  promptName      String    @map("prompt_name") @db.VarChar(32)
+  // the session id of the parent session if this session is a forked session
+  parentSessionId String?   @map("parent_session_id") @db.VarChar
+  messageCost     Int       @default(0)
+  tokenCost       Int       @default(0)
+  createdAt       DateTime  @default(now()) @map("created_at") @db.Timestamptz(3)
+  deletedAt       DateTime? @map("deleted_at") @db.Timestamptz(3)
 
   user     User               @relation(fields: [userId], references: [id], onDelete: Cascade)
   prompt   AiPrompt           @relation(fields: [promptName], references: [name], onDelete: Cascade)
@@ -495,10 +458,35 @@ model AiSession {
 }
 
 model DataMigration {
-  id         String    @id @default(uuid()) @db.VarChar(36)
+  id         String    @id @default(uuid()) @db.VarChar
   name       String    @db.VarChar
-  startedAt  DateTime  @default(now()) @map("started_at") @db.Timestamptz(6)
-  finishedAt DateTime? @map("finished_at") @db.Timestamptz(6)
+  startedAt  DateTime  @default(now()) @map("started_at") @db.Timestamptz(3)
+  finishedAt DateTime? @map("finished_at") @db.Timestamptz(3)
 
   @@map("_data_migrations")
 }
+
+enum RuntimeConfigType {
+  String
+  Number
+  Boolean
+  Object
+  Array
+}
+
+model RuntimeConfig {
+  id            String            @id @db.VarChar
+  type          RuntimeConfigType
+  module        String            @db.VarChar
+  key           String            @db.VarChar
+  value         Json              @db.Json
+  description   String            @db.Text
+  updatedAt     DateTime          @updatedAt @map("updated_at") @db.Timestamptz(3)
+  deletedAt     DateTime?         @map("deleted_at") @db.Timestamptz(3)
+  lastUpdatedBy String?           @map("last_updated_by") @db.VarChar
+
+  lastUpdatedByUser User? @relation(fields: [lastUpdatedBy], references: [id])
+
+  @@unique([module, key])
+  @@map("app_runtime_settings")
+}

packages/backend/server/src/app.controller.ts

@@ -3,7 +3,7 @@ import { Controller, Get } from '@nestjs/common';
 import { Public } from './core/auth';
 import { Config, SkipThrottle } from './fundamentals';
 
-@Controller('/')
+@Controller('/info')
 export class AppController {
   constructor(private readonly config: Config) {}
 
@@ -15,7 +15,7 @@ export class AppController {
       compatibility: this.config.version,
       message: `AFFiNE ${this.config.version} Server`,
       type: this.config.type,
-      flavor: this.config.flavor,
+      flavor: this.config.flavor.type,
     };
   }
 }

packages/backend/server/src/app.module.ts

@@ -1,24 +1,32 @@
-import { join } from 'node:path';
-
-import { Logger, Module } from '@nestjs/common';
+import {
+  DynamicModule,
+  ForwardReference,
+  Logger,
+  Module,
+} from '@nestjs/common';
 import { ScheduleModule } from '@nestjs/schedule';
-import { ServeStaticModule } from '@nestjs/serve-static';
 import { get } from 'lodash-es';
 
 import { AppController } from './app.controller';
 import { AuthModule } from './core/auth';
 import { ADD_ENABLED_FEATURES, ServerConfigModule } from './core/config';
-import { DocModule } from './core/doc';
+import { DocStorageModule } from './core/doc';
 import { FeatureModule } from './core/features';
+import { PermissionModule } from './core/permission';
 import { QuotaModule } from './core/quota';
+import { SelfhostModule } from './core/selfhost';
 import { StorageModule } from './core/storage';
 import { SyncModule } from './core/sync';
 import { UserModule } from './core/user';
 import { WorkspaceModule } from './core/workspaces';
 import { getOptionalModuleMetadata } from './fundamentals';
 import { CacheModule } from './fundamentals/cache';
-import type { AvailablePlugins } from './fundamentals/config';
-import { Config, ConfigModule } from './fundamentals/config';
+import {
+  AFFiNEConfig,
+  ConfigModule,
+  mergeConfigOverride,
+} from './fundamentals/config';
+import { ErrorModule } from './fundamentals/error';
 import { EventModule } from './fundamentals/event';
 import { GqlModule } from './fundamentals/graphql';
 import { HelpersModule } from './fundamentals/helpers';
@@ -30,6 +38,7 @@ import { StorageProviderModule } from './fundamentals/storage';
 import { RateLimiterModule } from './fundamentals/throttler';
 import { WebSocketModule } from './fundamentals/websocket';
 import { REGISTERED_PLUGINS } from './plugins';
+import { ENABLED_PLUGINS } from './plugins/registry';
 
 export const FunctionalityModules = [
   ConfigModule.forRoot(),
@@ -43,54 +52,77 @@ export const FunctionalityModules = [
   MailModule,
   StorageProviderModule,
   HelpersModule,
+  ErrorModule,
 ];
 
+function filterOptionalModule(
+  config: AFFiNEConfig,
+  module: AFFiNEModule | Promise<DynamicModule> | ForwardReference<any>
+) {
+  // can't deal with promise or forward reference
+  if (module instanceof Promise || 'forwardRef' in module) {
+    return module;
+  }
+
+  const requirements = getOptionalModuleMetadata(module, 'requires');
+  // if condition not set or condition met, include the module
+  if (requirements?.length) {
+    const nonMetRequirements = requirements.filter(c => {
+      const value = get(config, c);
+      return (
+        value === undefined ||
+        value === null ||
+        (typeof value === 'string' && value.trim().length === 0)
+      );
+    });
+
+    if (nonMetRequirements.length) {
+      const name = 'module' in module ? module.module.name : module.name;
+      new Logger(name).warn(
+        `${name} is not enabled because of the required configuration is not satisfied.`,
+        'Unsatisfied configuration:',
+        ...nonMetRequirements.map(config => `  AFFiNE.${config}`)
+      );
+      return null;
+    }
+  }
+
+  const predicator = getOptionalModuleMetadata(module, 'if');
+  if (predicator && !predicator(config)) {
+    return null;
+  }
+
+  const contribution = getOptionalModuleMetadata(module, 'contributesTo');
+  if (contribution) {
+    ADD_ENABLED_FEATURES(contribution);
+  }
+
+  const subModules = getOptionalModuleMetadata(module, 'imports');
+  const filteredSubModules = subModules
+    ?.map(subModule => filterOptionalModule(config, subModule))
+    .filter(Boolean);
+  Reflect.defineMetadata('imports', filteredSubModules, module);
+
+  return module;
+}
+
 export class AppModuleBuilder {
   private readonly modules: AFFiNEModule[] = [];
-  constructor(private readonly config: Config) {}
+  constructor(private readonly config: AFFiNEConfig) {}
 
   use(...modules: AFFiNEModule[]): this {
     modules.forEach(m => {
-      const requirements = getOptionalModuleMetadata(m, 'requires');
-      // if condition not set or condition met, include the module
-      if (requirements?.length) {
-        const nonMetRequirements = requirements.filter(c => {
-          const value = get(this.config, c);
-          return (
-            value === undefined ||
-            value === null ||
-            (typeof value === 'string' && value.trim().length === 0)
-          );
-        });
-
-        if (nonMetRequirements.length) {
-          const name = 'module' in m ? m.module.name : m.name;
-          new Logger(name).warn(
-            `${name} is not enabled because of the required configuration is not satisfied.`,
-            'Unsatisfied configuration:',
-            ...nonMetRequirements.map(config => `  AFFiNE.${config}`)
-          );
-          return;
-        }
+      const result = filterOptionalModule(this.config, m);
+      if (result) {
+        this.modules.push(m);
       }
-
-      const predicator = getOptionalModuleMetadata(m, 'if');
-      if (predicator && !predicator(this.config)) {
-        return;
-      }
-
-      const contribution = getOptionalModuleMetadata(m, 'contributesTo');
-      if (contribution) {
-        ADD_ENABLED_FEATURES(contribution);
-      }
-      this.modules.push(m);
     });
 
     return this;
   }
 
   useIf(
-    predicator: (config: Config) => boolean,
+    predicator: (config: AFFiNEConfig) => boolean,
     ...modules: AFFiNEModule[]
   ): this {
     if (predicator(this.config)) {
@@ -103,7 +135,7 @@ export class AppModuleBuilder {
   compile() {
     @Module({
       imports: this.modules,
-      controllers: this.config.isSelfhosted ? [] : [AppController],
+      controllers: [AppController],
     })
     class AppModule {}
 
@@ -111,44 +143,41 @@ export class AppModuleBuilder {
   }
 }
 
-function buildAppModule() {
+export function buildAppModule() {
+  AFFiNE = mergeConfigOverride(AFFiNE);
   const factor = new AppModuleBuilder(AFFiNE);
 
   factor
-    // common fundamental modules
+    // basic
     .use(...FunctionalityModules)
+    .useIf(config => config.flavor.sync, WebSocketModule)
+
     // auth
-    .use(AuthModule)
+    .use(UserModule, AuthModule, PermissionModule)
 
     // business modules
-    .use(DocModule)
+    .use(DocStorageModule)
 
     // sync server only
-    .useIf(config => config.flavor.sync, WebSocketModule, SyncModule)
+    .useIf(config => config.flavor.sync, SyncModule)
 
     // graphql server only
     .useIf(
       config => config.flavor.graphql,
-      ServerConfigModule,
       GqlModule,
       StorageModule,
-      UserModule,
+      ServerConfigModule,
       WorkspaceModule,
       FeatureModule,
       QuotaModule
     )
 
     // self hosted server only
-    .useIf(
-      config => config.isSelfhosted,
-      ServeStaticModule.forRoot({
-        rootPath: join('/app', 'static'),
-      })
-    );
+    .useIf(config => config.isSelfhosted, SelfhostModule);
 
   // plugin modules
-  AFFiNE.plugins.enabled.forEach(name => {
-    const plugin = REGISTERED_PLUGINS.get(name as AvailablePlugins);
+  ENABLED_PLUGINS.forEach(name => {
+    const plugin = REGISTERED_PLUGINS.get(name);
     if (!plugin) {
       throw new Error(`Unknown plugin ${name}`);
     }

packages/backend/server/src/app.ts

@@ -27,9 +27,9 @@ export async function createApp() {
 
   app.use(
     graphqlUploadExpress({
-      // TODO: dynamic limit by quota
+      // TODO(@darkskygit): dynamic limit by quota maybe?
       maxFileSize: 100 * 1024 * 1024,
-      maxFiles: 5,
+      maxFiles: 32,
     })
   );
 
@@ -50,11 +50,13 @@ export async function createApp() {
     app.useWebSocketAdapter(adapter);
   }
 
-  if (AFFiNE.isSelfhosted && AFFiNE.telemetry.enabled) {
+  if (AFFiNE.isSelfhosted && AFFiNE.metrics.telemetry.enabled) {
     const mixpanel = await import('mixpanel');
-    mixpanel.init(AFFiNE.telemetry.token).track('selfhost-server-started', {
-      version: AFFiNE.version,
-    });
+    mixpanel
+      .init(AFFiNE.metrics.telemetry.token)
+      .track('selfhost-server-started', {
+        version: AFFiNE.version,
+      });
   }
 
   return app;

packages/backend/server/src/config/affine.env.ts

@@ -1,24 +1,31 @@
 // Convenient way to map environment variables to config values.
 AFFiNE.ENV_MAP = {
-  AFFINE_SERVER_PORT: ['port', 'int'],
-  AFFINE_SERVER_HOST: 'host',
-  AFFINE_SERVER_SUB_PATH: 'path',
-  AFFINE_SERVER_HTTPS: ['https', 'boolean'],
-  DATABASE_URL: 'db.url',
-  ENABLE_CAPTCHA: ['auth.captcha.enable', 'boolean'],
-  CAPTCHA_TURNSTILE_SECRET: ['auth.captcha.turnstile.secret', 'string'],
-  OAUTH_GOOGLE_CLIENT_ID: 'plugins.oauth.providers.google.clientId',
-  OAUTH_GOOGLE_CLIENT_SECRET: 'plugins.oauth.providers.google.clientSecret',
-  OAUTH_GITHUB_CLIENT_ID: 'plugins.oauth.providers.github.clientId',
-  OAUTH_GITHUB_CLIENT_SECRET: 'plugins.oauth.providers.github.clientSecret',
+  AFFINE_SERVER_EXTERNAL_URL: ['server.externalUrl'],
+  AFFINE_SERVER_PORT: ['server.port', 'int'],
+  AFFINE_SERVER_HOST: 'server.host',
+  AFFINE_SERVER_SUB_PATH: 'server.path',
+  AFFINE_SERVER_HTTPS: ['server.https', 'boolean'],
+  ENABLE_TELEMETRY: ['metrics.telemetry.enabled', 'boolean'],
   MAILER_HOST: 'mailer.host',
   MAILER_PORT: ['mailer.port', 'int'],
   MAILER_USER: 'mailer.auth.user',
   MAILER_PASSWORD: 'mailer.auth.pass',
   MAILER_SENDER: 'mailer.from.address',
   MAILER_SECURE: ['mailer.secure', 'boolean'],
-  THROTTLE_TTL: ['rateLimiter.ttl', 'int'],
-  THROTTLE_LIMIT: ['rateLimiter.limit', 'int'],
+  DATABASE_URL: 'database.datasourceUrl',
+  OAUTH_GOOGLE_CLIENT_ID: 'plugins.oauth.providers.google.clientId',
+  OAUTH_GOOGLE_CLIENT_SECRET: 'plugins.oauth.providers.google.clientSecret',
+  OAUTH_GITHUB_CLIENT_ID: 'plugins.oauth.providers.github.clientId',
+  OAUTH_GITHUB_CLIENT_SECRET: 'plugins.oauth.providers.github.clientSecret',
+  OAUTH_OIDC_ISSUER: 'plugins.oauth.providers.oidc.issuer',
+  OAUTH_OIDC_CLIENT_ID: 'plugins.oauth.providers.oidc.clientId',
+  OAUTH_OIDC_CLIENT_SECRET: 'plugins.oauth.providers.oidc.clientSecret',
+  OAUTH_OIDC_SCOPE: 'plugins.oauth.providers.oidc.args.scope',
+  OAUTH_OIDC_CLAIM_MAP_USERNAME: 'plugins.oauth.providers.oidc.args.claim_id',
+  OAUTH_OIDC_CLAIM_MAP_EMAIL: 'plugins.oauth.providers.oidc.args.claim_email',
+  OAUTH_OIDC_CLAIM_MAP_NAME: 'plugins.oauth.providers.oidc.args.claim_name',
+  METRICS_CUSTOMER_IO_TOKEN: ['metrics.customerIo.token', 'string'],
+  CAPTCHA_TURNSTILE_SECRET: ['plugins.captcha.turnstile.secret', 'string'],
   COPILOT_OPENAI_API_KEY: 'plugins.copilot.openai.apiKey',
   COPILOT_FAL_API_KEY: 'plugins.copilot.fal.apiKey',
   COPILOT_UNSPLASH_API_KEY: 'plugins.copilot.unsplashKey',
@@ -28,16 +35,6 @@ AFFiNE.ENV_MAP = {
   REDIS_SERVER_PASSWORD: 'plugins.redis.password',
   REDIS_SERVER_DATABASE: ['plugins.redis.db', 'int'],
   DOC_MERGE_INTERVAL: ['doc.manager.updatePollInterval', 'int'],
-  DOC_MERGE_USE_JWST_CODEC: [
-    'doc.manager.experimentalMergeWithYOcto',
-    'boolean',
-  ],
   STRIPE_API_KEY: 'plugins.payment.stripe.keys.APIKey',
   STRIPE_WEBHOOK_KEY: 'plugins.payment.stripe.keys.webhookKey',
-  FEATURES_EARLY_ACCESS_PREVIEW: ['featureFlags.earlyAccessPreview', 'boolean'],
-  FEATURES_SYNC_CLIENT_VERSION_CHECK: [
-    'featureFlags.syncClientVersionCheck',
-    'boolean',
-  ],
-  TELEMETRY_ENABLE: ['telemetry.enabled', 'boolean'],
 };

packages/backend/server/src/config/affine.self.ts

@@ -20,35 +20,47 @@ const env = process.env;
 AFFiNE.metrics.enabled = !AFFiNE.node.test;
 
 if (env.R2_OBJECT_STORAGE_ACCOUNT_ID) {
-  AFFiNE.plugins.use('cloudflare-r2', {
+  AFFiNE.use('cloudflare-r2', {
     accountId: env.R2_OBJECT_STORAGE_ACCOUNT_ID,
     credentials: {
       accessKeyId: env.R2_OBJECT_STORAGE_ACCESS_KEY_ID!,
       secretAccessKey: env.R2_OBJECT_STORAGE_SECRET_ACCESS_KEY!,
     },
   });
-  AFFiNE.storage.storages.avatar.provider = 'cloudflare-r2';
-  AFFiNE.storage.storages.avatar.bucket = 'account-avatar';
-  AFFiNE.storage.storages.avatar.publicLinkFactory = key =>
+  AFFiNE.storages.avatar.provider = 'cloudflare-r2';
+  AFFiNE.storages.avatar.bucket = 'account-avatar';
+  AFFiNE.storages.avatar.publicLinkFactory = key =>
     `https://avatar.affineassets.com/${key}`;
 
-  AFFiNE.storage.storages.blob.provider = 'cloudflare-r2';
-  AFFiNE.storage.storages.blob.bucket = `workspace-blobs-${
+  AFFiNE.storages.blob.provider = 'cloudflare-r2';
+  AFFiNE.storages.blob.bucket = `workspace-blobs-${
     AFFiNE.affine.canary ? 'canary' : 'prod'
   }`;
 
-  AFFiNE.storage.storages.copilot.provider = 'cloudflare-r2';
-  AFFiNE.storage.storages.copilot.bucket = `workspace-copilot-${
-    AFFiNE.affine.canary ? 'canary' : 'prod'
-  }`;
+  AFFiNE.use('copilot', {
+    storage: {
+      provider: 'cloudflare-r2',
+      bucket: `workspace-copilot-${AFFiNE.affine.canary ? 'canary' : 'prod'}`,
+    },
+  });
 }
 
-AFFiNE.plugins.use('copilot', {
-  openai: {},
-  fal: {},
+AFFiNE.use('copilot', {
+  openai: {
+    apiKey: '',
+  },
+  fal: {
+    apiKey: '',
+  },
 });
-AFFiNE.plugins.use('redis');
-AFFiNE.plugins.use('payment', {
+AFFiNE.use('redis', {
+  host: env.REDIS_SERVER_HOST,
+  db: 0,
+  port: 6379,
+  username: env.REDIS_SERVER_USER,
+  password: env.REDIS_SERVER_PASSWORD,
+});
+AFFiNE.use('payment', {
   stripe: {
     keys: {
       // fake the key to ensure the server generate full GraphQL Schema even env vars are not set
@@ -57,7 +69,15 @@ AFFiNE.plugins.use('payment', {
     },
   },
 });
-AFFiNE.plugins.use('oauth');
+AFFiNE.use('oauth');
+
+/* Captcha Plugin Default Config */
+AFFiNE.use('captcha', {
+  turnstile: {},
+  challenge: {
+    bits: 20,
+  },
+});
 
 if (AFFiNE.deploy) {
   AFFiNE.mailer = {
@@ -68,5 +88,5 @@ if (AFFiNE.deploy) {
     },
   };
 
-  AFFiNE.plugins.use('gcloud');
+  AFFiNE.use('gcloud');
 }

packages/backend/server/src/config/affine.ts

@@ -26,22 +26,17 @@
 // AFFiNE.serverName = 'Your Cool AFFiNE Selfhosted Cloud';
 //
 // /* Whether the server is deployed behind a HTTPS proxied environment */
-AFFiNE.https = false;
+AFFiNE.server.https = false;
 // /* Domain of your server that your server will be available at */
-AFFiNE.host = 'localhost';
+AFFiNE.server.host = 'localhost';
 // /* The local port of your server that will listen on */
-AFFiNE.port = 3010;
+AFFiNE.server.port = 3010;
 // /* The sub path of your server */
-// /* For example, if you set `AFFiNE.path = '/affine'`, then the server will be available at `${domain}/affine` */
-// AFFiNE.path = '/affine';
-//
-//
-// ###############################################################
-// ##                       Database settings                   ##
-// ###############################################################
-//
-// /* The URL of the database where most of AFFiNE server data will be stored in */
-// AFFiNE.db.url = 'postgres://user:passsword@localhost:5432/affine';
+// /* For example, if you set `AFFiNE.server.path = '/affine'`, then the server will be available at `${domain}/affine` */
+// AFFiNE.server.path = '/affine';
+// /* The external URL of your server, will be consist of protocol + host + port by default */
+// /* Useful when you want to customize the link to server resources for example the doc share link or email link */
+// AFFiNE.server.externalUrl = 'http://affine.local:8080'
 //
 //
 // ###############################################################
@@ -52,19 +47,12 @@ AFFiNE.port = 3010;
 // /* The metrics will be available at `http://localhost:9464/metrics` with [Prometheus] format exported */
 // AFFiNE.metrics.enabled = true;
 //
-// /* Authentication Settings */
-// /* Whether allow anyone signup */
-// AFFiNE.auth.allowSignup = true;
 //
-// /* User Signup password limitation */
-// AFFiNE.auth.password = {
-//   minLength: 8,
-//   maxLength: 32,
-// };
-//
-// /* How long the login session would last by default */
 // AFFiNE.auth.session = {
+//   /* How long the login session would last by default */
 //   ttl: 15 * 24 * 60 * 60, // 15 days
+//   /* How long we should refresh the token before it getting expired */
+//   ttr: 7 * 24 * 60 * 60, // 7 days
 // };
 //
 // /* GraphQL configurations that control the behavior of the Apollo Server behind */
@@ -85,9 +73,6 @@ AFFiNE.port = 3010;
 // /* How long the buffer time of creating a new history snapshot when doc get updated */
 // AFFiNE.doc.history.interval = 1000 * 60 * 10; // 10 minutes
 //
-// /* Use `y-octo` to merge updates at the same time when merging using Yjs */
-// AFFiNE.doc.manager.experimentalMergeWithYOcto = true;
-//
 // /* How often the manager will start a new turn of merging pending updates into doc snapshot */
 // AFFiNE.doc.manager.updatePollInterval = 1000 * 3;
 //
@@ -99,20 +84,29 @@ AFFiNE.port = 3010;
 // /* Redis Plugin */
 // /* Provide caching and session storing backed by Redis. */
 // /* Useful when you deploy AFFiNE server in a cluster. */
-// AFFiNE.plugins.use('redis', {
+// AFFiNE.use('redis', {
 //   /* override options */
 // });
 //
 //
 // /* Payment Plugin */
-// AFFiNE.plugins.use('payment', {
+// AFFiNE.use('payment', {
 //   stripe: { keys: {}, apiVersion: '2023-10-16' },
 // });
 //
 //
+// /* Captcha Plugin Default Config */
+// AFFiNE.plugins.use('captcha', {
+//   turnstile: {},
+//   challenge: {
+//     bits: 20,
+//   },
+// });
+//
+//
 // /* Cloudflare R2 Plugin */
 // /* Enable if you choose to store workspace blobs or user avatars in Cloudflare R2 Storage Service */
-// AFFiNE.plugins.use('cloudflare-r2', {
+// AFFiNE.use('cloudflare-r2', {
 //   accountId: '',
 //   credentials: {
 //     accessKeyId: '',
@@ -122,17 +116,17 @@ AFFiNE.port = 3010;
 //
 // /* AWS S3 Plugin */
 // /* Enable if you choose to store workspace blobs or user avatars in AWS S3 Storage Service */
-// AFFiNE.plugins.use('aws-s3', {
+// AFFiNE.use('aws-s3', {
 //  credentials: {
 //    accessKeyId: '',
 //    secretAccessKey: '',
 // })
 // /* Update the provider of storages */
-// AFFiNE.storage.storages.blob.provider = 'r2';
-// AFFiNE.storage.storages.avatar.provider = 'r2';
+// AFFiNE.storages.blob.provider = 'cloudflare-r2';
+// AFFiNE.storages.avatar.provider = 'cloudflare-r2';
 //
 // /* OAuth Plugin */
-// AFFiNE.plugins.use('oauth', {
+// AFFiNE.use('oauth', {
 //   providers: {
 //     github: {
 //       clientId: '',
@@ -152,5 +146,32 @@ AFFiNE.port = 3010;
 //         access_type: 'offline',
 //       },
 //     },
+//     oidc: {
+//       // OpenID Connect
+//       issuer: '',
+//       clientId: '',
+//       clientSecret: '',
+//       args: {
+//         scope: 'openid email profile',
+//         claim_id: 'preferred_username',
+//         claim_email: 'email',
+//         claim_name: 'name',
+//       },
+//     },
 //   },
 // });
+//
+// /* Copilot Plugin */
+// AFFiNE.use('copilot', {
+//   openai: {
+//     apiKey: 'your-key',
+//   },
+//   fal: {
+//     apiKey: 'your-key',
+//   },
+//   unsplashKey: 'your-key',
+//   storage: {
+//     provider: 'cloudflare-r2',
+//     bucket: 'copilot',
+//   }
+// })

packages/backend/server/src/core/auth/config.ts

@@ -0,0 +1,91 @@
+import {
+  defineRuntimeConfig,
+  defineStartupConfig,
+  ModuleConfig,
+} from '../../fundamentals/config';
+
+export interface AuthStartupConfigurations {
+  /**
+   * auth session config
+   */
+  session: {
+    /**
+     * Application auth expiration time in seconds
+     */
+    ttl: number;
+    /**
+     * Application auth time to refresh in seconds
+     */
+    ttr: number;
+  };
+
+  /**
+   * Application access token config
+   */
+  accessToken: {
+    /**
+     * Application access token expiration time in seconds
+     */
+    ttl: number;
+    /**
+     * Application refresh token expiration time in seconds
+     */
+    refreshTokenTtl: number;
+  };
+}
+
+export interface AuthRuntimeConfigurations {
+  /**
+   * Whether allow anonymous users to sign up
+   */
+  allowSignup: boolean;
+
+  /**
+   * Whether require email verification before access restricted resources
+   */
+  requireEmailVerification: boolean;
+
+  /**
+   * The minimum and maximum length of the password when registering new users
+   */
+  password: {
+    min: number;
+    max: number;
+  };
+}
+
+declare module '../../fundamentals/config' {
+  interface AppConfig {
+    auth: ModuleConfig<AuthStartupConfigurations, AuthRuntimeConfigurations>;
+  }
+}
+
+defineStartupConfig('auth', {
+  session: {
+    ttl: 60 * 60 * 24 * 15, // 15 days
+    ttr: 60 * 60 * 24 * 7, // 7 days
+  },
+  accessToken: {
+    ttl: 60 * 60 * 24 * 7, // 7 days
+    refreshTokenTtl: 60 * 60 * 24 * 30, // 30 days
+  },
+});
+
+defineRuntimeConfig('auth', {
+  allowSignup: {
+    desc: 'Whether allow new registrations',
+    default: true,
+  },
+  requireEmailVerification: {
+    desc: 'Whether require email verification before accessing restricted resources',
+    default: true,
+  },
+  'password.min': {
+    desc: 'The minimum length of user password',
+    default: 8,
+  },
+  'password.max': {
+    desc: 'The maximum length of user password',
+    default: 32,
+  },
+});

packages/backend/server/src/core/auth/controller.ts

@@ -1,7 +1,4 @@
-import { randomUUID } from 'node:crypto';
-
 import {
-  BadRequestException,
   Body,
   Controller,
   Get,
@@ -16,25 +13,37 @@ import type { Request, Response } from 'express';
 
 import {
   Config,
-  PaymentRequiredException,
+  EarlyAccessRequired,
+  EmailTokenNotFound,
+  InternalServerError,
+  InvalidEmail,
+  InvalidEmailToken,
+  SignUpForbidden,
   Throttle,
   URLHelper,
+  UseNamedGuard,
 } from '../../fundamentals';
 import { UserService } from '../user';
 import { validators } from '../utils/validators';
-import { CurrentUser } from './current-user';
 import { Public } from './guard';
-import { AuthService, parseAuthUserSeqNum } from './service';
+import { AuthService } from './service';
+import { CurrentUser, Session } from './session';
 import { TokenService, TokenType } from './token';
 
-class SignInCredential {
-  email!: string;
-  password?: string;
+interface PreflightResponse {
+  registered: boolean;
+  hasPassword: boolean;
 }
 
-class MagicLinkCredential {
-  email!: string;
-  token!: string;
+interface SignInCredential {
+  email: string;
+  password?: string;
+  callbackUrl?: string;
+}
+
+interface MagicLinkCredential {
+  email: string;
+  token: string;
 }
 
 @Throttle('strict')
@@ -49,94 +58,132 @@ export class AuthController {
   ) {}
 
   @Public()
+  @Post('/preflight')
+  async preflight(
+    @Body() params?: { email: string }
+  ): Promise<PreflightResponse> {
+    if (!params?.email) {
+      throw new InvalidEmail();
+    }
+    validators.assertValidEmail(params.email);
+
+    const user = await this.user.findUserWithHashedPasswordByEmail(
+      params.email
+    );
+
+    if (!user) {
+      return {
+        registered: false,
+        hasPassword: false,
+      };
+    }
+
+    return {
+      registered: user.registered,
+      hasPassword: !!user.password,
+    };
+  }
+
+  @Public()
+  @UseNamedGuard('captcha')
   @Post('/sign-in')
   @Header('content-type', 'application/json')
   async signIn(
     @Req() req: Request,
     @Res() res: Response,
     @Body() credential: SignInCredential,
-    @Query('redirect_uri') redirectUri = this.url.home
+    /**
+     * @deprecated
+     */
+    @Query('redirect_uri') redirectUri?: string
   ) {
     validators.assertValidEmail(credential.email);
     const canSignIn = await this.auth.canSignIn(credential.email);
     if (!canSignIn) {
-      throw new PaymentRequiredException(
-        `You don't have early access permission\nVisit https://community.affine.pro/c/insider-general/ for more information`
-      );
+      throw new EarlyAccessRequired();
     }
 
     if (credential.password) {
-      const user = await this.auth.signIn(
+      await this.passwordSignIn(
+        req,
+        res,
         credential.email,
         credential.password
       );
-
-      await this.auth.setCookie(req, res, user);
-      res.status(HttpStatus.OK).send(user);
     } else {
-      // send email magic link
-      const user = await this.user.findUserByEmail(credential.email);
-      if (!user && !this.config.auth.allowSignup) {
-        throw new BadRequestException('You are not allows to sign up.');
-      }
-
-      const result = await this.sendSignInEmail(
-        { email: credential.email, signUp: !user },
+      await this.sendMagicLink(
+        req,
+        res,
+        credential.email,
+        credential.callbackUrl,
         redirectUri
       );
-
-      if (result.rejected.length) {
-        throw new Error('Failed to send sign-in email.');
-      }
-
-      res.status(HttpStatus.OK).send({
-        email: credential.email,
-      });
     }
   }
 
-  async sendSignInEmail(
-    { email, signUp }: { email: string; signUp: boolean },
-    redirectUri: string
+  async passwordSignIn(
+    req: Request,
+    res: Response,
+    email: string,
+    password: string
   ) {
+    const user = await this.auth.signIn(email, password);
+
+    await this.auth.setCookies(req, res, user.id);
+    res.status(HttpStatus.OK).send(user);
+  }
+
+  async sendMagicLink(
+    _req: Request,
+    res: Response,
+    email: string,
+    callbackUrl = '/magic-link',
+    redirectUrl?: string
+  ) {
+    // send email magic link
+    const user = await this.user.findUserByEmail(email);
+    if (!user) {
+      const allowSignup = await this.config.runtime.fetch('auth/allowSignup');
+      if (!allowSignup) {
+        throw new SignUpForbidden();
+      }
+    }
+
     const token = await this.token.createToken(TokenType.SignIn, email);
 
-    const magicLink = this.url.link('/magic-link', {
+    const magicLink = this.url.link(callbackUrl, {
       token,
       email,
-      redirect_uri: redirectUri,
+      ...(redirectUrl
+        ? {
+            redirect_uri: redirectUrl,
+          }
+        : {}),
     });
 
-    const result = await this.auth.sendSignInEmail(email, magicLink, signUp);
+    const result = await this.auth.sendSignInEmail(email, magicLink, !user);
 
-    return result;
+    if (result.rejected.length) {
+      throw new InternalServerError('Failed to send sign-in email.');
+    }
+
+    res.status(HttpStatus.OK).send({
+      email: email,
+    });
   }
 
   @Get('/sign-out')
   async signOut(
-    @Req() req: Request,
     @Res() res: Response,
-    @Query('redirect_uri') redirectUri?: string
+    @Session() session: Session,
+    @Body() { all }: { all: boolean }
   ) {
-    const session = await this.auth.signOut(
-      req.cookies[AuthService.sessionCookieName],
-      parseAuthUserSeqNum(req.headers[AuthService.authUserSeqHeaderName])
+    await this.auth.signOut(
+      session.sessionId,
+      all ? undefined : session.userId
     );
 
-    if (session) {
-      res.cookie(AuthService.sessionCookieName, session.id, {
-        expires: session.expiresAt ?? void 0, // expiredAt is `string | null`
-        ...this.auth.cookieOptions,
-      });
-    } else {
-      res.clearCookie(AuthService.sessionCookieName);
-    }
-
-    if (redirectUri) {
-      return this.url.safeRedirect(res, redirectUri);
-    } else {
-      return res.send(null);
-    }
+    res.status(HttpStatus.OK).send({});
   }
 
   @Public()
@@ -147,17 +194,17 @@ export class AuthController {
     @Body() { email, token }: MagicLinkCredential
   ) {
     if (!token || !email) {
-      throw new BadRequestException('Missing sign-in mail token');
+      throw new EmailTokenNotFound();
     }
 
     validators.assertValidEmail(email);
 
-    const valid = await this.token.verifyToken(TokenType.SignIn, token, {
+    const tokenRecord = await this.token.verifyToken(TokenType.SignIn, token, {
       credential: email,
     });
 
-    if (!valid) {
-      throw new BadRequestException('Invalid sign-in mail token');
+    if (!tokenRecord) {
+      throw new InvalidEmailToken();
     }
 
     const user = await this.user.fulfillUser(email, {
@@ -165,9 +212,8 @@ export class AuthController {
       registered: true,
     });
 
-    await this.auth.setCookie(req, res, user);
-
-    res.send({ id: user.id, email: user.email, name: user.name });
+    await this.auth.setCookies(req, res, user.id);
+    res.send({ id: user.id });
   }
 
   @Throttle('default', { limit: 1200 })
@@ -194,14 +240,4 @@ export class AuthController {
       users: await this.auth.getUserList(token),
     };
   }
-
-  @Public()
-  @Get('/challenge')
-  async challenge() {
-    // TODO: impl in following PR
-    return {
-      challenge: randomUUID(),
-      resource: randomUUID(),
-    };
-  }
 }

packages/backend/server/src/core/auth/guard.ts

@@ -1,26 +1,25 @@
 import type {
   CanActivate,
   ExecutionContext,
+  FactoryProvider,
   OnModuleInit,
 } from '@nestjs/common';
-import {
-  Injectable,
-  SetMetadata,
-  UnauthorizedException,
-  UseGuards,
-} from '@nestjs/common';
+import { Injectable, SetMetadata } from '@nestjs/common';
 import { ModuleRef, Reflector } from '@nestjs/core';
+import type { Request } from 'express';
 
-import { getRequestResponseFromContext } from '../../fundamentals';
-import { AuthService, parseAuthUserSeqNum } from './service';
+import {
+  AuthenticationRequired,
+  Config,
+  getRequestResponseFromContext,
+  mapAnyError,
+  parseCookies,
+} from '../../fundamentals';
+import { WEBSOCKET_OPTIONS } from '../../fundamentals/websocket';
+import { AuthService } from './service';
+import { Session } from './session';
 
-function extractTokenFromHeader(authorization: string) {
-  if (!/^Bearer\s/i.test(authorization)) {
-    return;
-  }
-
-  return authorization.substring(7);
-}
+const PUBLIC_ENTRYPOINT_SYMBOL = Symbol('public');
 
 @Injectable()
 export class AuthGuard implements CanActivate, OnModuleInit {
@@ -38,76 +37,85 @@ export class AuthGuard implements CanActivate, OnModuleInit {
   async canActivate(context: ExecutionContext) {
     const { req, res } = getRequestResponseFromContext(context);
 
-    // check cookie
-    let sessionToken: string | undefined =
-      req.cookies[AuthService.sessionCookieName];
-
-    if (!sessionToken && req.headers.authorization) {
-      sessionToken = extractTokenFromHeader(req.headers.authorization);
-    }
-
-    if (sessionToken) {
-      const userSeq = parseAuthUserSeqNum(
-        req.headers[AuthService.authUserSeqHeaderName]
-      );
-
-      const { user, expiresAt } = await this.auth.getUser(
-        sessionToken,
-        userSeq
-      );
-      if (res && user && expiresAt) {
-        await this.auth.refreshUserSessionIfNeeded(
-          req,
-          res,
-          sessionToken,
-          user.id,
-          expiresAt
-        );
-      }
-
-      if (user) {
-        req.sid = sessionToken;
-        req.user = user;
-      }
+    const userSession = await this.signIn(req);
+    if (res && userSession && userSession.expiresAt) {
+      await this.auth.refreshUserSessionIfNeeded(res, userSession);
     }
 
     // api is public
-    const isPublic = this.reflector.get<boolean>(
-      'isPublic',
-      context.getHandler()
+    const isPublic = this.reflector.getAllAndOverride<boolean>(
+      PUBLIC_ENTRYPOINT_SYMBOL,
+      [context.getClass(), context.getHandler()]
     );
 
     if (isPublic) {
       return true;
     }
 
-    if (!req.user) {
-      throw new UnauthorizedException('You are not signed in.');
+    if (!userSession) {
+      throw new AuthenticationRequired();
     }
 
     return true;
   }
+
+  async signIn(req: Request): Promise<Session | null> {
+    if (req.session) {
+      return req.session;
+    }
+
+    // compatibility with websocket request
+    parseCookies(req);
+
+    // TODO(@forehalo): a cache for user session
+    const userSession = await this.auth.getUserSessionFromRequest(req);
+
+    if (userSession) {
+      req.session = {
+        ...userSession.session,
+        user: userSession.user,
+      };
+
+      return req.session;
+    }
+
+    return null;
+  }
 }
 
 /**
- * This guard is used to protect routes/queries/mutations that require a user to be logged in.
- *
- * The `@CurrentUser()` parameter decorator used in a `Auth` guarded queries would always give us the user because the `Auth` guard will
- * fast throw if user is not logged in.
- *
- * @example
- *
- * ```typescript
- * \@Auth()
- * \@Query(() => UserType)
- * user(@CurrentUser() user: CurrentUser) {
- *   return user;
- * }
- * ```
+ * Mark api to be public accessible
  */
-export const Auth = () => {
-  return UseGuards(AuthGuard);
-};
+export const Public = () => SetMetadata(PUBLIC_ENTRYPOINT_SYMBOL, true);
 
-// api is public accessible
-export const Public = () => SetMetadata('isPublic', true);
+export const AuthWebsocketOptionsProvider: FactoryProvider = {
+  provide: WEBSOCKET_OPTIONS,
+  useFactory: (config: Config, guard: AuthGuard) => {
+    return {
+      ...config.websocket,
+      allowRequest: async (
+        req: any,
+        pass: (err: string | null | undefined, success: boolean) => void
+      ) => {
+        if (!config.websocket.requireAuthentication) {
+          return pass(null, true);
+        }
+
+        try {
+          const authentication = await guard.signIn(req);
+
+          if (authentication) {
+            return pass(null, true);
+          } else {
+            return pass('unauthenticated', false);
+          }
+        } catch (e) {
+          const error = mapAnyError(e);
+          error.log('Websocket');
+          return pass('unauthenticated', false);
+        }
+      },
+    };
+  },
+  inject: [Config, AuthGuard],
+};

packages/backend/server/src/core/auth/index.ts

@@ -1,18 +1,26 @@
+import './config';
+
 import { Module } from '@nestjs/common';
 
 import { FeatureModule } from '../features';
 import { QuotaModule } from '../quota';
 import { UserModule } from '../user';
 import { AuthController } from './controller';
-import { AuthGuard } from './guard';
+import { AuthGuard, AuthWebsocketOptionsProvider } from './guard';
 import { AuthResolver } from './resolver';
 import { AuthService } from './service';
 import { TokenService, TokenType } from './token';
 
 @Module({
   imports: [FeatureModule, UserModule, QuotaModule],
-  providers: [AuthService, AuthResolver, TokenService, AuthGuard],
-  exports: [AuthService, AuthGuard],
+  providers: [
+    AuthService,
+    AuthResolver,
+    TokenService,
+    AuthGuard,
+    AuthWebsocketOptionsProvider,
+  ],
+  exports: [AuthService, AuthGuard, AuthWebsocketOptionsProvider, TokenService],
   controllers: [AuthController],
 })
 export class AuthModule {}
@@ -20,4 +28,4 @@ export class AuthModule {}
 export * from './guard';
 export { ClientTokenType } from './resolver';
 export { AuthService, TokenService, TokenType };
-export * from './current-user';
+export * from './session';

packages/backend/server/src/core/auth/resolver.ts

@@ -1,4 +1,3 @@
-import { BadRequestException, ForbiddenException } from '@nestjs/common';
 import {
   Args,
   Field,
@@ -10,13 +9,25 @@ import {
   Resolver,
 } from '@nestjs/graphql';
 
-import { Config, SkipThrottle, Throttle } from '../../fundamentals';
+import {
+  ActionForbidden,
+  EmailAlreadyUsed,
+  EmailTokenNotFound,
+  EmailVerificationRequired,
+  InvalidEmailToken,
+  LinkExpired,
+  SameEmailProvided,
+  SkipThrottle,
+  Throttle,
+  URLHelper,
+} from '../../fundamentals';
+import { Admin } from '../common';
 import { UserService } from '../user';
 import { UserType } from '../user/types';
 import { validators } from '../utils/validators';
-import { CurrentUser } from './current-user';
 import { Public } from './guard';
 import { AuthService } from './service';
+import { CurrentUser } from './session';
 import { TokenService, TokenType } from './token';
 
 @ObjectType('tokenType')
@@ -35,7 +46,7 @@ export class ClientTokenType {
 @Resolver(() => UserType)
 export class AuthResolver {
   constructor(
-    private readonly config: Config,
+    private readonly url: URLHelper,
     private readonly auth: AuthService,
     private readonly user: UserService,
     private readonly token: TokenService
@@ -54,53 +65,53 @@ export class AuthResolver {
 
   @ResolveField(() => ClientTokenType, {
     name: 'token',
-    deprecationReason: 'use [/api/auth/authorize]',
+    deprecationReason: 'use [/api/auth/sign-in?native=true] instead',
   })
   async clientToken(
     @CurrentUser() currentUser: CurrentUser,
     @Parent() user: UserType
   ): Promise<ClientTokenType> {
     if (user.id !== currentUser.id) {
-      throw new ForbiddenException('Invalid user');
+      throw new ActionForbidden();
     }
 
-    const session = await this.auth.createUserSession(
-      user,
-      undefined,
-      this.config.auth.accessToken.ttl
-    );
+    const userSession = await this.auth.createUserSession(user.id);
 
     return {
-      sessionToken: session.sessionId,
-      token: session.sessionId,
+      sessionToken: userSession.sessionId,
+      token: userSession.sessionId,
       refresh: '',
     };
   }
 
-  @Mutation(() => UserType)
+  @Public()
+  @Mutation(() => Boolean)
   async changePassword(
-    @CurrentUser() user: CurrentUser,
     @Args('token') token: string,
-    @Args('newPassword') newPassword: string
+    @Args('newPassword') newPassword: string,
+    @Args('userId', { type: () => String, nullable: true }) userId?: string
   ) {
-    validators.assertValidPassword(newPassword);
+    if (!userId) {
+      throw new LinkExpired();
+    }
+
     // NOTE: Set & Change password are using the same token type.
     const valid = await this.token.verifyToken(
       TokenType.ChangePassword,
       token,
       {
-        credential: user.id,
+        credential: userId,
       }
     );
 
     if (!valid) {
-      throw new ForbiddenException('Invalid token');
+      throw new InvalidEmailToken();
     }
 
-    await this.auth.changePassword(user.id, newPassword);
-    await this.auth.revokeUserSessions(user.id);
+    await this.auth.changePassword(userId, newPassword);
+    await this.auth.revokeUserSessions(userId);
 
-    return user;
+    return true;
   }
 
   @Mutation(() => UserType)
@@ -109,14 +120,13 @@ export class AuthResolver {
     @Args('token') token: string,
     @Args('email') email: string
   ) {
-    validators.assertValidEmail(email);
     // @see [sendChangeEmail]
     const valid = await this.token.verifyToken(TokenType.VerifyEmail, token, {
       credential: user.id,
     });
 
     if (!valid) {
-      throw new ForbiddenException('Invalid token');
+      throw new InvalidEmailToken();
     }
 
     email = decodeURIComponent(email);
@@ -132,11 +142,14 @@ export class AuthResolver {
   async sendChangePasswordEmail(
     @CurrentUser() user: CurrentUser,
     @Args('callbackUrl') callbackUrl: string,
-    // @deprecated
-    @Args('email', { nullable: true }) _email?: string
+    @Args('email', {
+      nullable: true,
+      deprecationReason: 'fetched from signed in user',
+    })
+    _email?: string
   ) {
     if (!user.emailVerified) {
-      throw new ForbiddenException('Please verify your email first.');
+      throw new EmailVerificationRequired();
     }
 
     const token = await this.token.createToken(
@@ -144,13 +157,9 @@ export class AuthResolver {
       user.id
     );
 
-    const url = new URL(callbackUrl, this.config.baseUrl);
-    url.searchParams.set('token', token);
+    const url = this.url.link(callbackUrl, { userId: user.id, token });
 
-    const res = await this.auth.sendChangePasswordEmail(
-      user.email,
-      url.toString()
-    );
+    const res = await this.auth.sendChangePasswordEmail(user.email, url);
 
     return !res.rejected.length;
   }
@@ -159,25 +168,13 @@ export class AuthResolver {
   async sendSetPasswordEmail(
     @CurrentUser() user: CurrentUser,
     @Args('callbackUrl') callbackUrl: string,
-    @Args('email', { nullable: true }) _email?: string
+    @Args('email', {
+      nullable: true,
+      deprecationReason: 'fetched from signed in user',
+    })
+    _email?: string
   ) {
-    if (!user.emailVerified) {
-      throw new ForbiddenException('Please verify your email first.');
-    }
-
-    const token = await this.token.createToken(
-      TokenType.ChangePassword,
-      user.id
-    );
-
-    const url = new URL(callbackUrl, this.config.baseUrl);
-    url.searchParams.set('token', token);
-
-    const res = await this.auth.sendSetPasswordEmail(
-      user.email,
-      url.toString()
-    );
-    return !res.rejected.length;
+    return this.sendChangePasswordEmail(user, callbackUrl);
   }
 
   // The change email step is:
@@ -195,15 +192,14 @@ export class AuthResolver {
     @Args('email', { nullable: true }) _email?: string
   ) {
     if (!user.emailVerified) {
-      throw new ForbiddenException('Please verify your email first.');
+      throw new EmailVerificationRequired();
     }
 
     const token = await this.token.createToken(TokenType.ChangeEmail, user.id);
 
-    const url = new URL(callbackUrl, this.config.baseUrl);
-    url.searchParams.set('token', token);
+    const url = this.url.link(callbackUrl, { token });
 
-    const res = await this.auth.sendChangeEmail(user.email, url.toString());
+    const res = await this.auth.sendChangeEmail(user.email, url);
     return !res.rejected.length;
   }
 
@@ -214,24 +210,26 @@ export class AuthResolver {
     @Args('email') email: string,
     @Args('callbackUrl') callbackUrl: string
   ) {
+    if (!token) {
+      throw new EmailTokenNotFound();
+    }
+
     validators.assertValidEmail(email);
     const valid = await this.token.verifyToken(TokenType.ChangeEmail, token, {
       credential: user.id,
     });
 
     if (!valid) {
-      throw new ForbiddenException('Invalid token');
+      throw new InvalidEmailToken();
     }
 
     const hasRegistered = await this.user.findUserByEmail(email);
 
     if (hasRegistered) {
       if (hasRegistered.id !== user.id) {
-        throw new BadRequestException(`The email provided has been taken.`);
+        throw new EmailAlreadyUsed();
       } else {
-        throw new BadRequestException(
-          `The email provided is the same as the current email.`
-        );
+        throw new SameEmailProvided();
       }
     }
 
@@ -240,11 +238,8 @@ export class AuthResolver {
       user.id
     );
 
-    const url = new URL(callbackUrl, this.config.baseUrl);
-    url.searchParams.set('token', verifyEmailToken);
-    url.searchParams.set('email', email);
-
-    const res = await this.auth.sendVerifyChangeEmail(email, url.toString());
+    const url = this.url.link(callbackUrl, { token: verifyEmailToken, email });
+    const res = await this.auth.sendVerifyChangeEmail(email, url);
 
     return !res.rejected.length;
   }
@@ -256,10 +251,9 @@ export class AuthResolver {
   ) {
     const token = await this.token.createToken(TokenType.VerifyEmail, user.id);
 
-    const url = new URL(callbackUrl, this.config.baseUrl);
-    url.searchParams.set('token', token);
+    const url = this.url.link(callbackUrl, { token });
 
-    const res = await this.auth.sendVerifyEmail(user.email, url.toString());
+    const res = await this.auth.sendVerifyEmail(user.email, url);
     return !res.rejected.length;
   }
 
@@ -269,7 +263,7 @@ export class AuthResolver {
     @Args('token') token: string
   ) {
     if (!token) {
-      throw new BadRequestException('Invalid token');
+      throw new EmailTokenNotFound();
     }
 
     const valid = await this.token.verifyToken(TokenType.VerifyEmail, token, {
@@ -277,11 +271,27 @@ export class AuthResolver {
     });
 
     if (!valid) {
-      throw new ForbiddenException('Invalid token');
+      throw new InvalidEmailToken();
     }
 
     const { emailVerifiedAt } = await this.auth.setEmailVerified(user.id);
 
     return emailVerifiedAt !== null;
   }
+
+  @Admin()
+  @Mutation(() => String, {
+    description: 'Create change password url',
+  })
+  async createChangePasswordUrl(
+    @Args('userId') userId: string,
+    @Args('callbackUrl') callbackUrl: string
+  ): Promise<string> {
+    const token = await this.token.createToken(
+      TokenType.ChangePassword,
+      userId
+    );
+
+    return this.url.link(callbackUrl, { userId, token });
+  }
 }

packages/backend/server/src/core/auth/service.ts

@@ -1,43 +1,16 @@
-import {
-  BadRequestException,
-  Injectable,
-  NotAcceptableException,
-  OnApplicationBootstrap,
-} from '@nestjs/common';
-import type { User } from '@prisma/client';
+import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
+import { Cron, CronExpression } from '@nestjs/schedule';
+import type { User, UserSession } from '@prisma/client';
 import { PrismaClient } from '@prisma/client';
 import type { CookieOptions, Request, Response } from 'express';
-import { assign, omit } from 'lodash-es';
+import { assign, pick } from 'lodash-es';
 
-import { Config, CryptoHelper, MailService } from '../../fundamentals';
+import { Config, MailService, SignUpForbidden } from '../../fundamentals';
 import { FeatureManagementService } from '../features/management';
 import { QuotaService } from '../quota/service';
 import { QuotaType } from '../quota/types';
 import { UserService } from '../user/service';
-import type { CurrentUser } from './current-user';
-
-export function parseAuthUserSeqNum(value: any) {
-  let seq: number = 0;
-  switch (typeof value) {
-    case 'number': {
-      seq = value;
-      break;
-    }
-    case 'string': {
-      const result = value.match(/^([\d{0, 10}])$/);
-      if (result?.[1]) {
-        seq = Number(result[1]);
-      }
-      break;
-    }
-
-    default: {
-      seq = 0;
-    }
-  }
-
-  return Math.max(0, seq);
-}
+import type { CurrentUser } from './session';
 
 export function sessionUser(
   user: Pick<
@@ -45,13 +18,19 @@ export function sessionUser(
     'id' | 'email' | 'avatarUrl' | 'name' | 'emailVerifiedAt'
   > & { password?: string | null }
 ): CurrentUser {
-  return assign(
-    omit(user, 'password', 'registered', 'emailVerifiedAt', 'createdAt'),
-    {
-      hasPassword: user.password !== null,
-      emailVerified: user.emailVerifiedAt !== null,
-    }
-  );
+  // use pick to avoid unexpected fields
+  return assign(pick(user, 'id', 'email', 'avatarUrl', 'name'), {
+    hasPassword: user.password !== null,
+    emailVerified: user.emailVerifiedAt !== null,
+  });
+}
+
+function extractTokenFromHeader(authorization: string) {
+  if (!/^Bearer\s/i.test(authorization)) {
+    return;
+  }
+
+  return authorization.substring(7);
 }
 
 @Injectable()
@@ -60,10 +39,10 @@ export class AuthService implements OnApplicationBootstrap {
     sameSite: 'lax',
     httpOnly: true,
     path: '/',
-    secure: this.config.https,
+    secure: this.config.server.https,
   };
   static readonly sessionCookieName = 'affine_session';
-  static readonly authUserSeqHeaderName = 'x-auth-user';
+  static readonly userCookieName = 'affine_user_id';
 
   constructor(
     private readonly config: Config,
@@ -71,25 +50,25 @@ export class AuthService implements OnApplicationBootstrap {
     private readonly mailer: MailService,
     private readonly feature: FeatureManagementService,
     private readonly quota: QuotaService,
-    private readonly user: UserService,
-    private readonly crypto: CryptoHelper
+    private readonly user: UserService
   ) {}
 
   async onApplicationBootstrap() {
     if (this.config.node.dev) {
       try {
-        const [email, name, pwd] = ['dev@affine.pro', 'Dev User', 'dev'];
+        const [email, name, password] = ['dev@affine.pro', 'Dev User', 'dev'];
         let devUser = await this.user.findUserByEmail(email);
         if (!devUser) {
-          devUser = await this.user.createUser({
+          devUser = await this.user.createUser_without_verification({
             email,
             name,
-            password: await this.crypto.encryptPassword(pwd),
+            password,
           });
         }
         await this.quota.switchUserQuota(devUser.id, QuotaType.ProPlanV1);
+        await this.feature.addAdmin(devUser.id);
         await this.feature.addCopilot(devUser.id);
-      } catch (e) {
+      } catch {
         // ignore
       }
     }
@@ -99,189 +78,173 @@ export class AuthService implements OnApplicationBootstrap {
     return this.feature.canEarlyAccess(email);
   }
 
-  async signUp(
-    name: string,
-    email: string,
-    password: string
-  ): Promise<CurrentUser> {
-    const user = await this.user.findUserByEmail(email);
-
-    if (user) {
-      throw new BadRequestException('Email was taken');
+  /**
+   * This is a test only helper to quickly signup a user, do not use in production
+   */
+  async signUp(email: string, password: string): Promise<CurrentUser> {
+    if (!this.config.node.test) {
+      throw new SignUpForbidden(
+        'sign up helper is forbidden for non-test environment'
+      );
     }
 
-    const hashedPassword = await this.crypto.encryptPassword(password);
-
     return this.user
-      .createUser({
-        name,
+      .createUser_without_verification({
         email,
-        password: hashedPassword,
+        password,
       })
       .then(sessionUser);
   }
 
-  async signIn(email: string, password: string) {
-    const user = await this.user.findUserWithHashedPasswordByEmail(email);
-
-    if (!user) {
-      throw new NotAcceptableException('Invalid sign in credentials');
-    }
-
-    if (!user.password) {
-      throw new NotAcceptableException(
-        'User Password is not set. Should login through email link.'
-      );
-    }
-
-    const passwordMatches = await this.crypto.verifyPassword(
-      password,
-      user.password
-    );
-
-    if (!passwordMatches) {
-      throw new NotAcceptableException('Invalid sign in credentials');
-    }
-
-    return sessionUser(user);
+  async signIn(email: string, password: string): Promise<CurrentUser> {
+    return this.user.signIn(email, password).then(sessionUser);
   }
 
-  async getUser(
-    token: string,
-    seq = 0
-  ): Promise<{ user: CurrentUser | null; expiresAt: Date | null }> {
-    const session = await this.getSession(token);
+  async signOut(sessionId: string, userId?: string) {
+    // sign out all users in the session
+    if (!userId) {
+      await this.db.session.deleteMany({
+        where: {
+          id: sessionId,
+        },
+      });
+    } else {
+      await this.db.userSession.deleteMany({
+        where: {
+          sessionId,
+          userId,
+        },
+      });
+    }
+  }
+
+  async getUserSession(
+    sessionId: string,
+    userId?: string
+  ): Promise<{ user: CurrentUser; session: UserSession } | null> {
+    const userSession = await this.db.userSession.findFirst({
+      where: {
+        sessionId,
+        userId,
+      },
+      select: {
+        id: true,
+        sessionId: true,
+        userId: true,
+        createdAt: true,
+        expiresAt: true,
+        user: true,
+      },
+      orderBy: {
+        createdAt: 'asc',
+      },
+    });
 
     // no such session
-    if (!session) {
-      return { user: null, expiresAt: null };
-    }
-
-    const userSession = session.userSessions.at(seq);
-
-    // no such user session
     if (!userSession) {
-      return { user: null, expiresAt: null };
+      return null;
     }
 
     // user session expired
     if (userSession.expiresAt && userSession.expiresAt <= new Date()) {
-      return { user: null, expiresAt: null };
-    }
-
-    const user = await this.db.user.findUnique({
-      where: { id: userSession.userId },
-    });
-
-    if (!user) {
-      return { user: null, expiresAt: null };
-    }
-
-    return { user: sessionUser(user), expiresAt: userSession.expiresAt };
-  }
-
-  async getUserList(token: string) {
-    const session = await this.getSession(token);
-
-    if (!session || !session.userSessions.length) {
-      return [];
-    }
-
-    const users = await this.db.user.findMany({
-      where: {
-        id: {
-          in: session.userSessions.map(({ userId }) => userId),
-        },
-      },
-    });
-
-    // TODO(@forehalo): need to separate expired session, same for [getUser]
-    // Session
-    //   | { user: LimitedUser { email, avatarUrl }, expired: true }
-    //   | { user: User, expired: false }
-    return session.userSessions
-      .map(userSession => {
-        // keep users in the same order as userSessions
-        const user = users.find(({ id }) => id === userSession.userId);
-        if (!user) {
-          return null;
-        }
-        return sessionUser(user);
-      })
-      .filter(Boolean) as CurrentUser[];
-  }
-
-  async signOut(token: string, seq = 0) {
-    const session = await this.getSession(token);
-
-    if (session) {
-      // overflow the logged in user
-      if (session.userSessions.length <= seq) {
-        return session;
-      }
-
-      await this.db.userSession.deleteMany({
-        where: { id: session.userSessions[seq].id },
-      });
-
-      // no more user session active, delete the whole session
-      if (session.userSessions.length === 1) {
-        await this.db.session.delete({ where: { id: session.id } });
-        return null;
-      }
-
-      return session;
-    }
-
-    return null;
-  }
-
-  async getSession(token: string) {
-    if (!token) {
       return null;
     }
 
-    return this.db.$transaction(async tx => {
-      const session = await tx.session.findUnique({
+    return { user: sessionUser(userSession.user), session: userSession };
+  }
+
+  async createUserSession(
+    userId: string,
+    sessionId?: string,
+    ttl = this.config.auth.session.ttl
+  ) {
+    // check whether given session is valid
+    if (sessionId) {
+      const session = await this.db.session.findFirst({
         where: {
-          id: token,
-        },
-        include: {
-          userSessions: {
-            orderBy: {
-              createdAt: 'asc',
-            },
-          },
+          id: sessionId,
         },
       });
 
       if (!session) {
-        return null;
+        sessionId = undefined;
       }
+    }
 
-      if (session.expiresAt && session.expiresAt <= new Date()) {
-        await tx.session.delete({
-          where: {
-            id: session.id,
+    if (!sessionId) {
+      const session = await this.createSession();
+      sessionId = session.id;
+    }
+
+    const expiresAt = new Date(Date.now() + ttl * 1000);
+
+    return this.db.userSession.upsert({
+      where: {
+        sessionId_userId: {
+          sessionId,
+          userId,
+        },
+      },
+      update: {
+        expiresAt,
+      },
+      create: {
+        sessionId,
+        userId,
+        expiresAt,
+      },
+    });
+  }
+
+  async getUserList(sessionId: string) {
+    const sessions = await this.db.userSession.findMany({
+      where: {
+        sessionId,
+        OR: [
+          {
+            expiresAt: null,
           },
-        });
+          {
+            expiresAt: {
+              gt: new Date(),
+            },
+          },
+        ],
+      },
+      include: {
+        user: true,
+      },
+      orderBy: {
+        createdAt: 'asc',
+      },
+    });
 
-        return null;
-      }
+    return sessions.map(({ user }) => sessionUser(user));
+  }
 
-      return session;
+  async createSession() {
+    return this.db.session.create({
+      data: {},
+    });
+  }
+
+  async getSession(sessionId: string) {
+    return this.db.session.findFirst({
+      where: {
+        id: sessionId,
+      },
     });
   }
 
   async refreshUserSessionIfNeeded(
-    _req: Request,
     res: Response,
-    sessionId: string,
-    userId: string,
-    expiresAt: Date,
+    session: UserSession,
     ttr = this.config.auth.session.ttr
   ): Promise<boolean> {
-    if (expiresAt && expiresAt.getTime() - Date.now() > ttr * 1000) {
+    if (
+      session.expiresAt &&
+      session.expiresAt.getTime() - Date.now() > ttr * 1000
+    ) {
       // no need to refresh
       return false;
     }
@@ -292,17 +255,14 @@ export class AuthService implements OnApplicationBootstrap {
 
     await this.db.userSession.update({
       where: {
-        sessionId_userId: {
-          sessionId,
-          userId,
-        },
+        id: session.id,
       },
       data: {
         expiresAt: newExpiresAt,
       },
     });
 
-    res.cookie(AuthService.sessionCookieName, sessionId, {
+    res.cookie(AuthService.sessionCookieName, session.sessionId, {
       expires: newExpiresAt,
       ...this.cookieOptions,
     });
@@ -310,121 +270,88 @@ export class AuthService implements OnApplicationBootstrap {
     return true;
   }
 
-  async createUserSession(
-    user: { id: string },
-    existingSession?: string,
-    ttl = this.config.auth.session.ttl
-  ) {
-    const session = existingSession
-      ? await this.getSession(existingSession)
-      : null;
-
-    const expiresAt = new Date(Date.now() + ttl * 1000);
-    if (session) {
-      return this.db.userSession.upsert({
-        where: {
-          sessionId_userId: {
-            sessionId: session.id,
-            userId: user.id,
-          },
-        },
-        update: {
-          expiresAt,
-        },
-        create: {
-          sessionId: session.id,
-          userId: user.id,
-          expiresAt,
-        },
-      });
-    } else {
-      return this.db.userSession.create({
-        data: {
-          expiresAt,
-          session: {
-            create: {},
-          },
-          user: {
-            connect: {
-              id: user.id,
-            },
-          },
-        },
-      });
-    }
-  }
-
-  async revokeUserSessions(userId: string, sessionId?: string) {
+  async revokeUserSessions(userId: string) {
     return this.db.userSession.deleteMany({
       where: {
         userId,
-        sessionId,
       },
     });
   }
 
-  async setCookie(_req: Request, res: Response, user: { id: string }) {
-    const session = await this.createUserSession(
-      user
-      // TODO(@forehalo): enable multi user session
-      // req.cookies[AuthService.sessionCookieName]
-    );
+  getSessionOptionsFromRequest(req: Request) {
+    let sessionId: string | undefined =
+      req.cookies[AuthService.sessionCookieName];
 
-    res.cookie(AuthService.sessionCookieName, session.sessionId, {
-      expires: session.expiresAt ?? void 0,
+    if (!sessionId && req.headers.authorization) {
+      sessionId = extractTokenFromHeader(req.headers.authorization);
+    }
+
+    const userId: string | undefined =
+      req.cookies[AuthService.userCookieName] ||
+      req.headers[AuthService.userCookieName];
+
+    return {
+      sessionId,
+      userId,
+    };
+  }
+
+  async setCookies(req: Request, res: Response, userId: string) {
+    const { sessionId } = this.getSessionOptionsFromRequest(req);
+
+    const userSession = await this.createUserSession(userId, sessionId);
+
+    res.cookie(AuthService.sessionCookieName, userSession.sessionId, {
       ...this.cookieOptions,
+      expires: userSession.expiresAt ?? void 0,
+    });
+
+    this.setUserCookie(res, userId);
+  }
+
+  setUserCookie(res: Response, userId: string) {
+    res.cookie(AuthService.userCookieName, userId, {
+      ...this.cookieOptions,
+      // user cookie is client readable & writable for fast user switch if there are multiple users in one session
+      // it safe to be non-secure & non-httpOnly because server will validate it by `cookie[AuthService.sessionCookieName]`
+      httpOnly: false,
+      secure: false,
     });
   }
 
-  async changePassword(id: string, newPassword: string): Promise<User> {
-    const user = await this.user.findUserById(id);
+  async getUserSessionFromRequest(req: Request) {
+    const { sessionId, userId } = this.getSessionOptionsFromRequest(req);
 
-    if (!user) {
-      throw new BadRequestException('Invalid email');
+    if (!sessionId) {
+      return null;
     }
 
-    const hashedPassword = await this.crypto.encryptPassword(newPassword);
-
-    return this.db.user.update({
-      where: {
-        id: user.id,
-      },
-      data: {
-        password: hashedPassword,
-      },
-    });
+    return this.getUserSession(sessionId, userId);
   }
 
-  async changeEmail(id: string, newEmail: string): Promise<User> {
-    const user = await this.user.findUserById(id);
+  async changePassword(
+    id: string,
+    newPassword: string
+  ): Promise<Omit<User, 'password'>> {
+    return this.user.updateUser(id, { password: newPassword });
+  }
 
-    if (!user) {
-      throw new BadRequestException('Invalid email');
-    }
-
-    return this.db.user.update({
-      where: {
-        id,
-      },
-      data: {
-        email: newEmail,
-        emailVerifiedAt: new Date(),
-      },
+  async changeEmail(
+    id: string,
+    newEmail: string
+  ): Promise<Omit<User, 'password'>> {
+    return this.user.updateUser(id, {
+      email: newEmail,
+      emailVerifiedAt: new Date(),
     });
   }
 
   async setEmailVerified(id: string) {
-    return await this.db.user.update({
-      where: {
-        id,
-      },
-      data: {
-        emailVerifiedAt: new Date(),
-      },
-      select: {
-        emailVerifiedAt: true,
-      },
-    });
+    return await this.user.updateUser(
+      id,
+      { emailVerifiedAt: new Date() },
+      { emailVerifiedAt: true }
+    );
   }
 
   async sendChangePasswordEmail(email: string, callbackUrl: string) {
@@ -448,11 +375,22 @@ export class AuthService implements OnApplicationBootstrap {
 
   async sendSignInEmail(email: string, link: string, signUp: boolean) {
     return signUp
-      ? await this.mailer.sendSignUpMail(link.toString(), {
+      ? await this.mailer.sendSignUpMail(link, {
           to: email,
         })
-      : await this.mailer.sendSignInMail(link.toString(), {
+      : await this.mailer.sendSignInMail(link, {
           to: email,
         });
   }
+
+  @Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT)
+  async cleanExpiredSessions() {
+    await this.db.userSession.deleteMany({
+      where: {
+        expiresAt: {
+          lte: new Date(),
+        },
+      },
+    });
+  }
 }

packages/backend/server/src/core/auth/session.ts

@@ -1,13 +1,9 @@
 import type { ExecutionContext } from '@nestjs/common';
 import { createParamDecorator } from '@nestjs/common';
-import { User } from '@prisma/client';
+import { User, UserSession } from '@prisma/client';
 
 import { getRequestResponseFromContext } from '../../fundamentals';
 
-function getUserFromContext(context: ExecutionContext) {
-  return getRequestResponseFromContext(context).req.user;
-}
-
 /**
  * Used to fetch current user from the request context.
  *
@@ -44,7 +40,7 @@ function getUserFromContext(context: ExecutionContext) {
 // eslint-disable-next-line no-redeclare
 export const CurrentUser = createParamDecorator(
   (_: unknown, context: ExecutionContext) => {
-    return getUserFromContext(context);
+    return getRequestResponseFromContext(context).req.session?.user;
   }
 );
 
@@ -53,3 +49,15 @@ export interface CurrentUser
   hasPassword: boolean | null;
   emailVerified: boolean;
 }
+
+// interface and variable don't conflict
+// eslint-disable-next-line no-redeclare
+export const Session = createParamDecorator(
+  (_: unknown, context: ExecutionContext) => {
+    return getRequestResponseFromContext(context).req.session;
+  }
+);
+
+export type Session = UserSession & {
+  user: CurrentUser;
+};

packages/backend/server/src/core/auth/token.ts

@@ -69,13 +69,9 @@ export class TokenService {
     const valid =
       !expired && (!record.credential || record.credential === credential);
 
-    if ((expired || valid) && !keep) {
-      const deleted = await this.db.verificationToken.deleteMany({
-        where: {
-          token,
-          type,
-        },
-      });
+    // always revoke expired token
+    if (expired || (valid && !keep)) {
+      const deleted = await this.revokeToken(type, token);
 
       // already deleted, means token has been used
       if (!deleted.count) {
@@ -86,9 +82,18 @@ export class TokenService {
     return valid ? record : null;
   }
 
+  async revokeToken(type: TokenType, token: string) {
+    return await this.db.verificationToken.deleteMany({
+      where: {
+        token,
+        type,
+      },
+    });
+  }
+
   @Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT)
-  cleanExpiredTokens() {
-    return this.db.verificationToken.deleteMany({
+  async cleanExpiredTokens() {
+    await this.db.verificationToken.deleteMany({
       where: {
         expiresAt: {
           lte: new Date(),

packages/backend/server/src/core/common/admin-guard.ts

@@ -0,0 +1,55 @@
+import type {
+  CanActivate,
+  ExecutionContext,
+  OnModuleInit,
+} from '@nestjs/common';
+import { Injectable, UseGuards } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+
+import {
+  ActionForbidden,
+  getRequestResponseFromContext,
+} from '../../fundamentals';
+import { FeatureManagementService } from '../features';
+
+@Injectable()
+export class AdminGuard implements CanActivate, OnModuleInit {
+  private feature!: FeatureManagementService;
+
+  constructor(private readonly ref: ModuleRef) {}
+
+  onModuleInit() {
+    this.feature = this.ref.get(FeatureManagementService, { strict: false });
+  }
+
+  async canActivate(context: ExecutionContext) {
+    const { req } = getRequestResponseFromContext(context);
+    let allow = false;
+    if (req.session) {
+      allow = await this.feature.isAdmin(req.session.user.id);
+    }
+
+    if (!allow) {
+      throw new ActionForbidden();
+    }
+
+    return true;
+  }
+}
+
+/**
+ * This guard is used to protect routes/queries/mutations that require a user to be administrator.
+ *
+ * @example
+ *
+ * ```typescript
+ * \@Admin()
+ * \@Mutation(() => UserType)
+ * createAccount(userInput: UserInput) {
+ *   // ...
+ * }
+ * ```
+ */
+export const Admin = () => {
+  return UseGuards(AdminGuard);
+};

packages/backend/server/src/core/common/index.ts

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

packages/backend/server/src/core/config.ts

@@ -1,102 +0,0 @@
-import { Module } from '@nestjs/common';
-import { Field, ObjectType, Query, registerEnumType } from '@nestjs/graphql';
-
-import { DeploymentType } from '../fundamentals';
-import { Public } from './auth';
-
-export enum ServerFeature {
-  Copilot = 'copilot',
-  Payment = 'payment',
-  OAuth = 'oauth',
-}
-
-registerEnumType(ServerFeature, {
-  name: 'ServerFeature',
-});
-
-registerEnumType(DeploymentType, {
-  name: 'ServerDeploymentType',
-});
-
-const ENABLED_FEATURES: Set<ServerFeature> = new Set();
-export function ADD_ENABLED_FEATURES(feature: ServerFeature) {
-  ENABLED_FEATURES.add(feature);
-}
-
-@ObjectType()
-export class PasswordLimitsType {
-  @Field()
-  minLength!: number;
-  @Field()
-  maxLength!: number;
-}
-
-@ObjectType()
-export class CredentialsRequirementType {
-  @Field()
-  password!: PasswordLimitsType;
-}
-
-@ObjectType()
-export class ServerConfigType {
-  @Field({
-    description:
-      'server identical name could be shown as badge on user interface',
-  })
-  name!: string;
-
-  @Field({ description: 'server version' })
-  version!: string;
-
-  @Field({ description: 'server base url' })
-  baseUrl!: string;
-
-  @Field(() => DeploymentType, { description: 'server type' })
-  type!: DeploymentType;
-
-  /**
-   * @deprecated
-   */
-  @Field({ description: 'server flavor', deprecationReason: 'use `features`' })
-  flavor!: string;
-
-  @Field(() => [ServerFeature], { description: 'enabled server features' })
-  features!: ServerFeature[];
-
-  @Field(() => CredentialsRequirementType, {
-    description: 'credentials requirement',
-  })
-  credentialsRequirement!: CredentialsRequirementType;
-
-  @Field({ description: 'enable telemetry' })
-  enableTelemetry!: boolean;
-}
-
-export class ServerConfigResolver {
-  @Public()
-  @Query(() => ServerConfigType, {
-    description: 'server config',
-  })
-  serverConfig(): ServerConfigType {
-    return {
-      name: AFFiNE.serverName,
-      version: AFFiNE.version,
-      baseUrl: AFFiNE.baseUrl,
-      type: AFFiNE.type,
-      // BACKWARD COMPATIBILITY
-      // the old flavors contains `selfhosted` but it actually not flavor but deployment type
-      // this field should be removed after frontend feature flags implemented
-      flavor: AFFiNE.type,
-      features: Array.from(ENABLED_FEATURES),
-      credentialsRequirement: {
-        password: AFFiNE.auth.password,
-      },
-      enableTelemetry: AFFiNE.telemetry.enabled,
-    };
-  }
-}
-
-@Module({
-  providers: [ServerConfigResolver],
-})
-export class ServerConfigModule {}

packages/backend/server/src/core/config/config.ts

@@ -0,0 +1,23 @@
+import { defineRuntimeConfig, ModuleConfig } from '../../fundamentals/config';
+
+export interface ServerFlags {
+  earlyAccessControl: boolean;
+  syncClientVersionCheck: boolean;
+}
+
+declare module '../../fundamentals/config' {
+  interface AppConfig {
+    flags: ModuleConfig<never, ServerFlags>;
+  }
+}
+
+defineRuntimeConfig('flags', {
+  earlyAccessControl: {
+    desc: 'Only allow users with early access features to access the app',
+    default: false,
+  },
+  syncClientVersionCheck: {
+    desc: 'Only allow client with exact the same version with server to establish sync connections',
+    default: false,
+  },
+});

packages/backend/server/src/core/config/index.ts

@@ -0,0 +1,26 @@
+import './config';
+
+import { Module } from '@nestjs/common';
+
+import {
+  ServerConfigResolver,
+  ServerFeatureConfigResolver,
+  ServerRuntimeConfigResolver,
+  ServerServiceConfigResolver,
+} from './resolver';
+import { ServerService } from './service';
+
+@Module({
+  providers: [
+    ServerService,
+    ServerConfigResolver,
+    ServerFeatureConfigResolver,
+    ServerRuntimeConfigResolver,
+    ServerServiceConfigResolver,
+  ],
+  exports: [ServerService],
+})
+export class ServerConfigModule {}
+export { ServerService };
+export { ADD_ENABLED_FEATURES } from './server-feature';
+export { ServerFeature } from './types';

packages/backend/server/src/core/config/resolver.ts

@@ -0,0 +1,273 @@
+import {
+  Args,
+  Field,
+  GraphQLISODateTime,
+  Mutation,
+  ObjectType,
+  Query,
+  registerEnumType,
+  ResolveField,
+  Resolver,
+} from '@nestjs/graphql';
+import { RuntimeConfig, RuntimeConfigType } from '@prisma/client';
+import { GraphQLJSON, GraphQLJSONObject } from 'graphql-scalars';
+
+import { Config, URLHelper } from '../../fundamentals';
+import { Public } from '../auth';
+import { Admin } from '../common';
+import { FeatureType } from '../features';
+import { AvailableUserFeatureConfig } from '../features/resolver';
+import { ServerFlags } from './config';
+import { ENABLED_FEATURES } from './server-feature';
+import { ServerService } from './service';
+import { ServerConfigType } from './types';
+
+@ObjectType()
+export class PasswordLimitsType {
+  @Field()
+  minLength!: number;
+  @Field()
+  maxLength!: number;
+}
+
+@ObjectType()
+export class CredentialsRequirementType {
+  @Field()
+  password!: PasswordLimitsType;
+}
+
+registerEnumType(RuntimeConfigType, {
+  name: 'RuntimeConfigType',
+});
+@ObjectType()
+export class ServerRuntimeConfigType implements Partial<RuntimeConfig> {
+  @Field()
+  id!: string;
+
+  @Field()
+  module!: string;
+
+  @Field()
+  key!: string;
+
+  @Field()
+  description!: string;
+
+  @Field(() => GraphQLJSON)
+  value!: any;
+
+  @Field(() => RuntimeConfigType)
+  type!: RuntimeConfigType;
+
+  @Field(() => GraphQLISODateTime)
+  updatedAt!: Date;
+}
+
+@ObjectType()
+export class ServerFlagsType implements ServerFlags {
+  @Field()
+  earlyAccessControl!: boolean;
+
+  @Field()
+  syncClientVersionCheck!: boolean;
+}
+
+@Resolver(() => ServerConfigType)
+export class ServerConfigResolver {
+  constructor(
+    private readonly config: Config,
+    private readonly url: URLHelper,
+    private readonly server: ServerService
+  ) {}
+
+  @Public()
+  @Query(() => ServerConfigType, {
+    description: 'server config',
+  })
+  serverConfig(): ServerConfigType {
+    return {
+      name: this.config.serverName,
+      version: this.config.version,
+      baseUrl: this.url.home,
+      type: this.config.type,
+      // BACKWARD COMPATIBILITY
+      // the old flavors contains `selfhosted` but it actually not flavor but deployment type
+      // this field should be removed after frontend feature flags implemented
+      flavor: this.config.type,
+      features: Array.from(ENABLED_FEATURES),
+      enableTelemetry: this.config.metrics.telemetry.enabled,
+    };
+  }
+
+  @ResolveField(() => CredentialsRequirementType, {
+    description: 'credentials requirement',
+  })
+  async credentialsRequirement() {
+    const config = await this.config.runtime.fetchAll({
+      'auth/password.max': true,
+      'auth/password.min': true,
+    });
+
+    return {
+      password: {
+        minLength: config['auth/password.min'],
+        maxLength: config['auth/password.max'],
+      },
+    };
+  }
+
+  @ResolveField(() => ServerFlagsType, {
+    description: 'server flags',
+  })
+  async flags(): Promise<ServerFlagsType> {
+    const records = await this.config.runtime.list('flags');
+
+    return records.reduce((flags, record) => {
+      flags[record.key as keyof ServerFlagsType] = record.value as any;
+      return flags;
+    }, {} as ServerFlagsType);
+  }
+
+  @ResolveField(() => Boolean, {
+    description: 'whether server has been initialized',
+  })
+  async initialized() {
+    return this.server.initialized();
+  }
+}
+
+@Resolver(() => ServerConfigType)
+export class ServerFeatureConfigResolver extends AvailableUserFeatureConfig {
+  constructor(config: Config) {
+    super(config);
+  }
+
+  @ResolveField(() => [FeatureType], {
+    description: 'Features for user that can be configured',
+  })
+  override availableUserFeatures() {
+    return super.availableUserFeatures();
+  }
+}
+
+@ObjectType()
+class ServerServiceConfig {
+  @Field()
+  name!: string;
+
+  @Field(() => GraphQLJSONObject)
+  config!: any;
+}
+
+interface ServerServeConfig {
+  https: boolean;
+  host: string;
+  port: number;
+  externalUrl: string;
+}
+
+interface ServerMailerConfig {
+  host?: string | null;
+  port?: number | null;
+  secure?: boolean | null;
+  service?: string | null;
+  sender?: string | null;
+}
+
+interface ServerDatabaseConfig {
+  host: string;
+  port: number;
+  user?: string | null;
+  database: string;
+}
+
+@Admin()
+@Resolver(() => ServerRuntimeConfigType)
+export class ServerRuntimeConfigResolver {
+  constructor(private readonly config: Config) {}
+
+  @Query(() => [ServerRuntimeConfigType], {
+    description: 'get all server runtime configurable settings',
+  })
+  serverRuntimeConfig(): Promise<ServerRuntimeConfigType[]> {
+    return this.config.runtime.list();
+  }
+
+  @Mutation(() => ServerRuntimeConfigType, {
+    description: 'update server runtime configurable setting',
+  })
+  async updateRuntimeConfig(
+    @Args('id') id: string,
+    @Args({ type: () => GraphQLJSON, name: 'value' }) value: any
+  ): Promise<ServerRuntimeConfigType> {
+    return await this.config.runtime.set(id as any, value);
+  }
+
+  @Mutation(() => [ServerRuntimeConfigType], {
+    description: 'update multiple server runtime configurable settings',
+  })
+  async updateRuntimeConfigs(
+    @Args({ type: () => GraphQLJSONObject, name: 'updates' }) updates: any
+  ): Promise<ServerRuntimeConfigType[]> {
+    const keys = Object.keys(updates);
+    const results = await Promise.all(
+      keys.map(key => this.config.runtime.set(key as any, updates[key]))
+    );
+
+    return results;
+  }
+}
+
+@Admin()
+@Resolver(() => ServerServiceConfig)
+export class ServerServiceConfigResolver {
+  constructor(private readonly config: Config) {}
+
+  @Query(() => [ServerServiceConfig])
+  serverServiceConfigs() {
+    return [
+      {
+        name: 'server',
+        config: this.serve(),
+      },
+      {
+        name: 'mailer',
+        config: this.mail(),
+      },
+      {
+        name: 'database',
+        config: this.database(),
+      },
+    ];
+  }
+
+  serve(): ServerServeConfig {
+    return this.config.server;
+  }
+
+  mail(): ServerMailerConfig {
+    const sender =
+      typeof this.config.mailer.from === 'string'
+        ? this.config.mailer.from
+        : this.config.mailer.from?.address;
+
+    return {
+      host: this.config.mailer.host,
+      port: this.config.mailer.port,
+      secure: this.config.mailer.secure,
+      service: this.config.mailer.service,
+      sender,
+    };
+  }
+
+  database(): ServerDatabaseConfig {
+    const url = new URL(this.config.database.datasourceUrl);
+
+    return {
+      host: url.hostname,
+      port: Number(url.port),
+      user: url.username,
+      database: url.pathname.slice(1) ?? url.username,
+    };
+  }
+}

packages/backend/server/src/core/config/server-feature.ts

@@ -0,0 +1,7 @@
+import { ServerFeature } from './types';
+
+export const ENABLED_FEATURES: Set<ServerFeature> = new Set();
+export function ADD_ENABLED_FEATURES(feature: ServerFeature) {
+  ENABLED_FEATURES.add(feature);
+}
+export { ServerFeature };

packages/backend/server/src/core/config/service.ts

@@ -0,0 +1,17 @@
+import { Injectable } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+
+@Injectable()
+export class ServerService {
+  private _initialized: boolean | null = null;
+  constructor(private readonly db: PrismaClient) {}
+
+  async initialized() {
+    if (!this._initialized) {
+      const userCount = await this.db.user.count();
+      this._initialized = userCount > 0;
+    }
+
+    return this._initialized;
+  }
+}

packages/backend/server/src/core/config/types.ts

@@ -0,0 +1,48 @@
+import { Field, ObjectType, registerEnumType } from '@nestjs/graphql';
+
+import { DeploymentType } from '../../fundamentals';
+
+export enum ServerFeature {
+  Captcha = 'captcha',
+  Copilot = 'copilot',
+  Payment = 'payment',
+  OAuth = 'oauth',
+}
+
+registerEnumType(ServerFeature, {
+  name: 'ServerFeature',
+});
+
+registerEnumType(DeploymentType, {
+  name: 'ServerDeploymentType',
+});
+
+@ObjectType()
+export class ServerConfigType {
+  @Field({
+    description:
+      'server identical name could be shown as badge on user interface',
+  })
+  name!: string;
+
+  @Field({ description: 'server version' })
+  version!: string;
+
+  @Field({ description: 'server base url' })
+  baseUrl!: string;
+
+  @Field(() => DeploymentType, { description: 'server type' })
+  type!: DeploymentType;
+
+  /**
+   * @deprecated
+   */
+  @Field({ description: 'server flavor', deprecationReason: 'use `features`' })
+  flavor!: string;
+
+  @Field(() => [ServerFeature], { description: 'enabled server features' })
+  features!: ServerFeature[];
+
+  @Field({ description: 'enable telemetry' })
+  enableTelemetry!: boolean;
+}

packages/backend/server/src/core/doc/adapters/userspace.ts

@@ -0,0 +1,186 @@
+import { Injectable } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+
+import { Mutex } from '../../../fundamentals';
+import { DocStorageOptions } from '../options';
+import { DocRecord, DocStorageAdapter } from '../storage';
+
+@Injectable()
+export class PgUserspaceDocStorageAdapter extends DocStorageAdapter {
+  constructor(
+    private readonly db: PrismaClient,
+    private readonly mutex: Mutex,
+    options: DocStorageOptions
+  ) {
+    super(options);
+  }
+
+  // no updates queue for userspace, directly merge them inplace
+  // no history record for userspace
+  protected async getDocUpdates() {
+    return [];
+  }
+
+  protected async markUpdatesMerged() {
+    return 0;
+  }
+
+  async listDocHistories() {
+    return [];
+  }
+
+  async getDocHistory() {
+    return null;
+  }
+
+  protected async createDocHistory() {
+    return false;
+  }
+
+  override async rollbackDoc() {
+    return;
+  }
+
+  override async getDoc(spaceId: string, docId: string) {
+    return this.getDocSnapshot(spaceId, docId);
+  }
+
+  async pushDocUpdates(
+    userId: string,
+    docId: string,
+    updates: Uint8Array[],
+    editorId?: string
+  ) {
+    if (!updates.length) {
+      return 0;
+    }
+
+    await using _lock = await this.lockDocForUpdate(userId, docId);
+    const snapshot = await this.getDocSnapshot(userId, docId);
+    const now = Date.now();
+    const pendings = updates.map((update, i) => ({
+      bin: update,
+      timestamp: now + i,
+    }));
+
+    const { timestamp, bin } = await this.squash(
+      snapshot ? [snapshot, ...pendings] : pendings
+    );
+
+    await this.setDocSnapshot({
+      spaceId: userId,
+      docId,
+      bin,
+      timestamp,
+      editor: editorId,
+    });
+
+    return timestamp;
+  }
+
+  async deleteDoc(userId: string, docId: string) {
+    await this.db.userSnapshot.deleteMany({
+      where: {
+        userId,
+        id: docId,
+      },
+    });
+  }
+
+  async deleteSpace(userId: string) {
+    await this.db.userSnapshot.deleteMany({
+      where: {
+        userId,
+      },
+    });
+  }
+
+  async getSpaceDocTimestamps(userId: string, after?: number) {
+    const snapshots = await this.db.userSnapshot.findMany({
+      select: {
+        id: true,
+        updatedAt: true,
+      },
+      where: {
+        userId,
+        ...(after
+          ? {
+              updatedAt: {
+                gt: new Date(after),
+              },
+            }
+          : {}),
+      },
+    });
+
+    const result: Record<string, number> = {};
+
+    snapshots.forEach(s => {
+      result[s.id] = s.updatedAt.getTime();
+    });
+
+    return result;
+  }
+
+  protected async getDocSnapshot(userId: string, docId: string) {
+    const snapshot = await this.db.userSnapshot.findUnique({
+      where: {
+        userId_id: {
+          userId,
+          id: docId,
+        },
+      },
+    });
+
+    if (!snapshot) {
+      return null;
+    }
+
+    return {
+      spaceId: userId,
+      docId,
+      bin: snapshot.blob,
+      timestamp: snapshot.updatedAt.getTime(),
+      editor: snapshot.userId,
+    };
+  }
+
+  protected async setDocSnapshot(snapshot: DocRecord) {
+    // we always get lock before writing to user snapshot table,
+    // so a simple upsert without testing on updatedAt is safe
+    await this.db.userSnapshot.upsert({
+      where: {
+        userId_id: {
+          userId: snapshot.spaceId,
+          id: snapshot.docId,
+        },
+      },
+      update: {
+        blob: Buffer.from(snapshot.bin),
+        updatedAt: new Date(snapshot.timestamp),
+      },
+      create: {
+        userId: snapshot.spaceId,
+        id: snapshot.docId,
+        blob: Buffer.from(snapshot.bin),
+        createdAt: new Date(snapshot.timestamp),
+        updatedAt: new Date(snapshot.timestamp),
+      },
+    });
+
+    return true;
+  }
+
+  protected override async lockDocForUpdate(
+    workspaceId: string,
+    docId: string
+  ) {
+    const lock = await this.mutex.lock(`userspace:${workspaceId}:${docId}`);
+
+    if (!lock) {
+      throw new Error('Too many concurrent writings');
+    }
+
+    return lock;
+  }
+}

packages/backend/server/src/core/doc/adapters/workspace.ts

@@ -0,0 +1,618 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+import { chunk } from 'lodash-es';
+
+import {
+  Cache,
+  DocHistoryNotFound,
+  DocNotFound,
+  FailedToSaveUpdates,
+  FailedToUpsertSnapshot,
+  metrics,
+  Mutex,
+} from '../../../fundamentals';
+import { retryable } from '../../../fundamentals/utils/promise';
+import { DocStorageOptions } from '../options';
+import {
+  DocRecord,
+  DocStorageAdapter,
+  DocUpdate,
+  HistoryFilter,
+} from '../storage';
+
+const UPDATES_QUEUE_CACHE_KEY = 'doc:manager:updates';
+
+@Injectable()
+export class PgWorkspaceDocStorageAdapter extends DocStorageAdapter {
+  private readonly logger = new Logger(PgWorkspaceDocStorageAdapter.name);
+
+  constructor(
+    private readonly db: PrismaClient,
+    private readonly mutex: Mutex,
+    private readonly cache: Cache,
+    protected override readonly options: DocStorageOptions
+  ) {
+    super(options);
+  }
+
+  async pushDocUpdates(
+    workspaceId: string,
+    docId: string,
+    updates: Uint8Array[],
+    editorId?: string
+  ) {
+    if (!updates.length) {
+      return 0;
+    }
+
+    let pendings = updates;
+    let done = 0;
+    let timestamp = Date.now();
+    try {
+      await retryable(async () => {
+        if (done !== 0) {
+          pendings = pendings.slice(done);
+        }
+
+        // TODO(@forehalo): remove in next release
+        const lastSeq = await this.getUpdateSeq(
+          workspaceId,
+          docId,
+          updates.length
+        );
+
+        let turn = 0;
+        const batchCount = 10;
+        for (const batch of chunk(pendings, batchCount)) {
+          const now = Date.now();
+          await this.db.update.createMany({
+            data: batch.map((update, i) => {
+              const subSeq = turn * batchCount + i + 1;
+              // `seq` is the last seq num of the batch
+              // example for 11 batched updates, start from seq num 20
+              // seq for first update in the batch should be:
+              // 31             - 11                + subSeq(0        * 10          + 0 + 1) = 21
+              // ^ last seq num   ^ updates.length           ^ turn     ^ batchCount  ^i
+              const seq = lastSeq - updates.length + subSeq;
+              const createdAt = now + subSeq;
+              timestamp = Math.max(timestamp, createdAt);
+
+              return {
+                workspaceId,
+                id: docId,
+                blob: Buffer.from(update),
+                seq,
+                createdAt: new Date(createdAt),
+                createdBy: editorId || null,
+              };
+            }),
+          });
+          turn++;
+          done += batch.length;
+          await this.updateCachedUpdatesCount(workspaceId, docId, batch.length);
+        }
+      });
+    } catch (e) {
+      this.logger.error('Failed to insert doc updates', e);
+      metrics.doc.counter('doc_update_insert_failed').add(1);
+      throw new FailedToSaveUpdates();
+    }
+
+    return timestamp;
+  }
+
+  protected async getDocUpdates(workspaceId: string, docId: string) {
+    const rows = await this.db.update.findMany({
+      where: {
+        workspaceId,
+        id: docId,
+      },
+      orderBy: {
+        createdAt: 'asc',
+      },
+    });
+
+    return rows.map(row => ({
+      bin: row.blob,
+      timestamp: row.createdAt.getTime(),
+      editor: row.createdBy || undefined,
+    }));
+  }
+
+  async deleteDoc(workspaceId: string, docId: string) {
+    const ident = { where: { workspaceId, id: docId } };
+    await this.db.$transaction([
+      this.db.snapshot.deleteMany(ident),
+      this.db.update.deleteMany(ident),
+      this.db.snapshotHistory.deleteMany(ident),
+    ]);
+  }
+
+  async deleteSpace(workspaceId: string) {
+    const ident = { where: { workspaceId } };
+    await this.db.$transaction([
+      this.db.workspace.deleteMany({
+        where: {
+          id: workspaceId,
+        },
+      }),
+      this.db.snapshot.deleteMany(ident),
+      this.db.update.deleteMany(ident),
+      this.db.snapshotHistory.deleteMany(ident),
+    ]);
+  }
+
+  async getSpaceDocTimestamps(workspaceId: string, after?: number) {
+    const snapshots = await this.db.snapshot.findMany({
+      select: {
+        id: true,
+        updatedAt: true,
+      },
+      where: {
+        workspaceId,
+        ...(after
+          ? {
+              updatedAt: {
+                gt: new Date(after),
+              },
+            }
+          : {}),
+      },
+    });
+
+    const updates = await this.db.update.groupBy({
+      where: {
+        workspaceId,
+        ...(after
+          ? {
+              createdAt: {
+                gt: new Date(after),
+              },
+            }
+          : {}),
+      },
+      by: ['id'],
+      _max: {
+        createdAt: true,
+      },
+    });
+
+    const result: Record<string, number> = {};
+
+    snapshots.forEach(s => {
+      result[s.id] = s.updatedAt.getTime();
+    });
+
+    updates.forEach(u => {
+      if (u._max.createdAt) {
+        result[u.id] = u._max.createdAt.getTime();
+      }
+    });
+
+    return result;
+  }
+
+  protected async markUpdatesMerged(
+    workspaceId: string,
+    docId: string,
+    updates: DocUpdate[]
+  ) {
+    const result = await this.db.update.deleteMany({
+      where: {
+        workspaceId,
+        id: docId,
+        createdAt: {
+          in: updates.map(u => new Date(u.timestamp)),
+        },
+      },
+    });
+
+    await this.updateCachedUpdatesCount(workspaceId, docId, -result.count);
+    return result.count;
+  }
+
+  async listDocHistories(
+    workspaceId: string,
+    docId: string,
+    query: HistoryFilter
+  ) {
+    const histories = await this.db.snapshotHistory.findMany({
+      select: {
+        timestamp: true,
+        createdByUser: {
+          select: {
+            name: true,
+            avatarUrl: true,
+          },
+        },
+      },
+      where: {
+        workspaceId,
+        id: docId,
+        timestamp: {
+          lt: query.before ? new Date(query.before) : new Date(),
+        },
+      },
+      orderBy: {
+        timestamp: 'desc',
+      },
+      take: query.limit,
+    });
+
+    return histories.map(h => ({
+      timestamp: h.timestamp.getTime(),
+      editor: h.createdByUser,
+    }));
+  }
+
+  async getDocHistory(workspaceId: string, docId: string, timestamp: number) {
+    const history = await this.db.snapshotHistory.findUnique({
+      where: {
+        workspaceId_id_timestamp: {
+          workspaceId,
+          id: docId,
+          timestamp: new Date(timestamp),
+        },
+      },
+    });
+
+    if (!history) {
+      return null;
+    }
+
+    return {
+      spaceId: workspaceId,
+      docId,
+      bin: history.blob,
+      timestamp,
+      editor: history.createdBy || undefined,
+    };
+  }
+
+  override async rollbackDoc(
+    spaceId: string,
+    docId: string,
+    timestamp: number,
+    editorId?: string
+  ): Promise<void> {
+    await using _lock = await this.lockDocForUpdate(spaceId, docId);
+    const toSnapshot = await this.getDocHistory(spaceId, docId, timestamp);
+    if (!toSnapshot) {
+      throw new DocHistoryNotFound({ spaceId, docId, timestamp });
+    }
+
+    const fromSnapshot = await this.getDocSnapshot(spaceId, docId);
+
+    if (!fromSnapshot) {
+      throw new DocNotFound({ spaceId, docId });
+    }
+
+    // force create a new history record after rollback
+    await this.createDocHistory(
+      {
+        ...fromSnapshot,
+        // override the editor to the one who requested the rollback
+        editor: editorId,
+      },
+      true
+    );
+    // WARN:
+    //  we should never do the snapshot updating in recovering,
+    //  which is not the solution in CRDT.
+    //  let user revert in client and update the data in sync system
+    //    const change = this.generateChangeUpdate(fromSnapshot.bin, toSnapshot.bin);
+    //    await this.pushDocUpdates(spaceId, docId, [change]);
+
+    metrics.doc
+      .counter('history_recovered_counter', {
+        description: 'How many times history recovered request happened',
+      })
+      .add(1);
+  }
+
+  protected async createDocHistory(snapshot: DocRecord, force = false) {
+    const last = await this.lastDocHistory(snapshot.spaceId, snapshot.docId);
+
+    let shouldCreateHistory = false;
+
+    if (!last) {
+      // never created
+      shouldCreateHistory = true;
+    } else {
+      const lastHistoryTimestamp = last.timestamp.getTime();
+      if (lastHistoryTimestamp === snapshot.timestamp) {
+        // no change
+        shouldCreateHistory = false;
+      } else if (
+        // force
+        force ||
+        // last history created before interval in configs
+        lastHistoryTimestamp <
+          snapshot.timestamp - this.options.historyMinInterval(snapshot.spaceId)
+      ) {
+        shouldCreateHistory = true;
+      }
+    }
+
+    if (shouldCreateHistory) {
+      if (this.isEmptyBin(snapshot.bin)) {
+        this.logger.debug(
+          `Doc is empty, skip creating history record for ${snapshot.docId} in workspace ${snapshot.spaceId}`
+        );
+        return false;
+      }
+
+      await this.db.snapshotHistory
+        .create({
+          select: {
+            timestamp: true,
+          },
+          data: {
+            workspaceId: snapshot.spaceId,
+            id: snapshot.docId,
+            timestamp: new Date(snapshot.timestamp),
+            blob: Buffer.from(snapshot.bin),
+            createdBy: snapshot.editor,
+            expiredAt: new Date(
+              Date.now() + (await this.options.historyMaxAge(snapshot.spaceId))
+            ),
+          },
+        })
+        .catch(() => {
+          // safe to ignore
+          // only happens when duplicated history record created in multi processes
+        });
+
+      metrics.doc
+        .counter('history_created_counter', {
+          description: 'How many times the snapshot history created',
+        })
+        .add(1);
+      this.logger.debug(
+        `History created for ${snapshot.docId} in workspace ${snapshot.spaceId}.`
+      );
+      return true;
+    }
+
+    return false;
+  }
+
+  protected async getDocSnapshot(workspaceId: string, docId: string) {
+    const snapshot = await this.db.snapshot.findUnique({
+      where: {
+        id_workspaceId: {
+          workspaceId,
+          id: docId,
+        },
+      },
+    });
+
+    if (!snapshot) {
+      return null;
+    }
+
+    return {
+      spaceId: workspaceId,
+      docId,
+      bin: snapshot.blob,
+      timestamp: snapshot.updatedAt.getTime(),
+      // creator and editor may null if their account is deleted
+      editor: snapshot.updatedBy || snapshot.createdBy || undefined,
+    };
+  }
+
+  protected async setDocSnapshot(snapshot: DocRecord) {
+    const { spaceId, docId, bin, timestamp } = snapshot;
+
+    if (this.isEmptyBin(bin)) {
+      return false;
+    }
+
+    const updatedAt = new Date(timestamp);
+
+    // CONCERNS:
+    //   i. Because we save the real user's last seen action time as `updatedAt`,
+    //      it's possible to simply compare the `updatedAt` to determine if the snapshot is older than the one we are going to save.
+    //
+    //  ii. Prisma doesn't support `upsert` with additional `where` condition along side unique constraint.
+    //      In our case, we need to manually check the `updatedAt` to avoid overriding the newer snapshot.
+    //      where: { id_workspaceId: {}, updatedAt: { lt: updatedAt } }
+    //                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    try {
+      const result: { updatedAt: Date }[] = await this.db.$queryRaw`
+        INSERT INTO "snapshots" ("workspace_id", "guid", "blob", "created_at", "updated_at", "created_by", "updated_by")
+        VALUES (${spaceId}, ${docId}, ${bin}, DEFAULT, ${updatedAt}, ${snapshot.editor}, ${snapshot.editor})
+        ON CONFLICT ("workspace_id", "guid")
+        DO UPDATE SET "blob" = ${bin}, "updated_at" = ${updatedAt}, "updated_by" = ${snapshot.editor}
+        WHERE "snapshots"."workspace_id" = ${spaceId} AND "snapshots"."guid" = ${docId} AND "snapshots"."updated_at" <= ${updatedAt}
+        RETURNING "snapshots"."workspace_id" as "workspaceId", "snapshots"."guid" as "id", "snapshots"."updated_at" as "updatedAt"
+      `;
+
+      // const result = await this.db.snapshot.upsert({
+      //   select: {
+      //     updatedAt: true,
+      //     seq: true,
+      //   },
+      //   where: {
+      //     id_workspaceId: {
+      //       workspaceId,
+      //       id: guid,
+      //     },
+      //     ⬇️ NOT SUPPORTED BY PRISMA YET
+      //     updatedAt: {
+      //       lt: updatedAt,
+      //     },
+      //   },
+      //   update: {
+      //     blob,
+      //     state,
+      //     updatedAt,
+      //   },
+      //   create: {
+      //     workspaceId,
+      //     id: guid,
+      //     blob,
+      //     state,
+      //     updatedAt,
+      //     seq,
+      //   },
+      // });
+
+      // if the condition `snapshot.updatedAt > updatedAt` is true, by which means the snapshot has already been updated by other process,
+      // the updates has been applied to current `doc` must have been seen by the other process as well.
+      // The `updatedSnapshot` will be `undefined` in this case.
+      const updatedSnapshot = result.at(0);
+      return !!updatedSnapshot;
+    } catch (e) {
+      metrics.doc.counter('snapshot_upsert_failed').add(1);
+      this.logger.error('Failed to upsert snapshot', e);
+      throw new FailedToUpsertSnapshot();
+    }
+  }
+
+  protected override async lockDocForUpdate(
+    workspaceId: string,
+    docId: string
+  ) {
+    const lock = await this.mutex.lock(`doc:update:${workspaceId}:${docId}`);
+
+    if (!lock) {
+      throw new Error('Too many concurrent writings');
+    }
+
+    return lock;
+  }
+
+  protected async lastDocHistory(workspaceId: string, id: string) {
+    return this.db.snapshotHistory.findFirst({
+      where: {
+        workspaceId,
+        id,
+      },
+      select: {
+        timestamp: true,
+        state: true,
+      },
+      orderBy: {
+        timestamp: 'desc',
+      },
+    });
+  }
+
+  // for auto merging
+  async randomDoc() {
+    const key = await this.cache.mapRandomKey(UPDATES_QUEUE_CACHE_KEY);
+
+    if (key) {
+      const cachedCount = await this.cache.mapIncrease(
+        UPDATES_QUEUE_CACHE_KEY,
+        key,
+        0
+      );
+
+      if (cachedCount > 0) {
+        const [workspaceId, id] = key.split('::');
+        const count = await this.db.update.count({
+          where: {
+            workspaceId,
+            id,
+          },
+        });
+
+        // FIXME(@forehalo): somehow the update count in cache is not accurate
+        if (count === 0) {
+          metrics.doc
+            .counter('doc_update_count_inconsistent_with_cache')
+            .add(1);
+          await this.cache.mapDelete(UPDATES_QUEUE_CACHE_KEY, key);
+          return null;
+        }
+
+        return { workspaceId, docId: id };
+      }
+    }
+
+    return null;
+  }
+
+  private async updateCachedUpdatesCount(
+    workspaceId: string,
+    guid: string,
+    count: number
+  ) {
+    const result = await this.cache.mapIncrease(
+      UPDATES_QUEUE_CACHE_KEY,
+      `${workspaceId}::${guid}`,
+      count
+    );
+
+    if (result <= 0) {
+      await this.cache.mapDelete(
+        UPDATES_QUEUE_CACHE_KEY,
+        `${workspaceId}::${guid}`
+      );
+    }
+  }
+
+  /**
+   * @deprecated
+   */
+  private readonly seqMap = new Map<string, number>();
+  /**
+   *
+   * @deprecated updates do not rely on seq number anymore
+   *
+   * keep in next release to avoid downtime when upgrading instances
+   */
+  private async getUpdateSeq(workspaceId: string, guid: string, batch = 1) {
+    const MAX_SEQ_NUM = 0x3fffffff; // u31
+
+    try {
+      const { seq } = await this.db.snapshot.update({
+        select: {
+          seq: true,
+        },
+        where: {
+          id_workspaceId: {
+            workspaceId,
+            id: guid,
+          },
+        },
+        data: {
+          seq: {
+            increment: batch,
+          },
+        },
+      });
+
+      if (!seq) {
+        return batch;
+      }
+
+      // reset
+      if (seq >= MAX_SEQ_NUM) {
+        await this.db.snapshot.update({
+          select: {
+            seq: true,
+          },
+          where: {
+            id_workspaceId: {
+              workspaceId,
+              id: guid,
+            },
+          },
+          data: {
+            seq: 0,
+          },
+        });
+      }
+
+      return seq;
+    } catch {
+      // not existing snapshot just count it from 1
+      const last = this.seqMap.get(workspaceId + guid) ?? 0;
+      this.seqMap.set(workspaceId + guid, last + batch);
+      return last + batch;
+    }
+  }
+}

packages/backend/server/src/core/doc/config.ts

@@ -0,0 +1,71 @@
+import {
+  defineRuntimeConfig,
+  defineStartupConfig,
+  ModuleConfig,
+} from '../../fundamentals/config';
+
+interface DocStartupConfigurations {
+  manager: {
+    /**
+     * Whether auto merge updates into doc snapshot.
+     */
+    enableUpdateAutoMerging: boolean;
+
+    /**
+     * How often the [DocManager] will start a new turn of merging pending updates into doc snapshot.
+     *
+     * This is not the latency a new joint client will take to see the latest doc,
+     * but the buffer time we introduced to reduce the load of our service.
+     *
+     * in {ms}
+     */
+    updatePollInterval: number;
+
+    /**
+     * The maximum number of updates that will be pulled from the server at once.
+     * Existing for avoiding the server to be overloaded when there are too many updates for one doc.
+     */
+    maxUpdatesPullCount: number;
+  };
+  history: {
+    /**
+     * How long the buffer time of creating a new history snapshot when doc get updated.
+     *
+     * in {ms}
+     */
+    interval: number;
+  };
+}
+
+interface DocRuntimeConfigurations {
+  /**
+   * Use `y-octo` to merge updates at the same time when merging using Yjs.
+   *
+   * This is an experimental feature, and aimed to check the correctness of JwstCodec.
+   */
+  experimentalMergeWithYOcto: boolean;
+}
+
+declare module '../../fundamentals/config' {
+  interface AppConfig {
+    doc: ModuleConfig<DocStartupConfigurations, DocRuntimeConfigurations>;
+  }
+}
+
+defineStartupConfig('doc', {
+  manager: {
+    enableUpdateAutoMerging: true,
+    updatePollInterval: 3000,
+    maxUpdatesPullCount: 500,
+  },
+  history: {
+    interval: 1000 * 60 * 10 /* 10 mins */,
+  },
+});
+
+defineRuntimeConfig('doc', {
+  experimentalMergeWithYOcto: {
+    desc: 'Use `y-octo` to merge updates at the same time when merging using Yjs.',
+    default: false,
+  },
+});

packages/backend/server/src/core/doc/history.ts

@@ -1,257 +0,0 @@
-import { isDeepStrictEqual } from 'node:util';
-
-import { Injectable, Logger } from '@nestjs/common';
-import { Cron, CronExpression } from '@nestjs/schedule';
-import { PrismaClient } from '@prisma/client';
-
-import type { EventPayload } from '../../fundamentals';
-import { Config, metrics, OnEvent } from '../../fundamentals';
-import { QuotaService } from '../quota';
-import { Permission } from '../workspaces/types';
-import { isEmptyBuffer } from './manager';
-
-@Injectable()
-export class DocHistoryManager {
-  private readonly logger = new Logger(DocHistoryManager.name);
-  constructor(
-    private readonly config: Config,
-    private readonly db: PrismaClient,
-    private readonly quota: QuotaService
-  ) {}
-
-  @OnEvent('workspace.deleted')
-  onWorkspaceDeleted(workspaceId: EventPayload<'workspace.deleted'>) {
-    return this.db.snapshotHistory.deleteMany({
-      where: {
-        workspaceId,
-      },
-    });
-  }
-
-  @OnEvent('snapshot.deleted')
-  onSnapshotDeleted({ workspaceId, id }: EventPayload<'snapshot.deleted'>) {
-    return this.db.snapshotHistory.deleteMany({
-      where: {
-        workspaceId,
-        id,
-      },
-    });
-  }
-
-  @OnEvent('snapshot.updated')
-  async onDocUpdated(
-    { workspaceId, id, previous }: EventPayload<'snapshot.updated'>,
-    forceCreate = false
-  ) {
-    const last = await this.last(workspaceId, id);
-
-    let shouldCreateHistory = false;
-
-    if (!last) {
-      // never created
-      shouldCreateHistory = true;
-    } else if (last.timestamp === previous.updatedAt) {
-      // no change
-      shouldCreateHistory = false;
-    } else if (
-      // force
-      forceCreate ||
-      // last history created before interval in configs
-      last.timestamp.getTime() <
-        previous.updatedAt.getTime() - this.config.doc.history.interval
-    ) {
-      shouldCreateHistory = true;
-    }
-
-    if (shouldCreateHistory) {
-      // skip the history recording when no actual update on snapshot happended
-      if (last && isDeepStrictEqual(last.state, previous.state)) {
-        this.logger.debug(
-          `State matches, skip creating history record for ${id} in workspace ${workspaceId}`
-        );
-        return;
-      }
-
-      if (isEmptyBuffer(previous.blob)) {
-        this.logger.debug(
-          `Doc is empty, skip creating history record for ${id} in workspace ${workspaceId}`
-        );
-        return;
-      }
-
-      await this.db.snapshotHistory
-        .create({
-          select: {
-            timestamp: true,
-          },
-          data: {
-            workspaceId,
-            id,
-            timestamp: previous.updatedAt,
-            blob: previous.blob,
-            state: previous.state,
-            expiredAt: await this.getExpiredDateFromNow(workspaceId),
-          },
-        })
-        .catch(() => {
-          // safe to ignore
-          // only happens when duplicated history record created in multi processes
-        });
-      metrics.doc
-        .counter('history_created_counter', {
-          description: 'How many times the snapshot history created',
-        })
-        .add(1);
-      this.logger.debug(
-        `History created for ${id} in workspace ${workspaceId}.`
-      );
-    }
-  }
-
-  async list(
-    workspaceId: string,
-    id: string,
-    before: Date = new Date(),
-    take: number = 10
-  ) {
-    return this.db.snapshotHistory.findMany({
-      select: {
-        timestamp: true,
-      },
-      where: {
-        workspaceId,
-        id,
-        timestamp: {
-          lt: before,
-        },
-        // only include the ones has not expired
-        expiredAt: {
-          gt: new Date(),
-        },
-      },
-      orderBy: {
-        timestamp: 'desc',
-      },
-      take,
-    });
-  }
-
-  async count(workspaceId: string, id: string) {
-    return this.db.snapshotHistory.count({
-      where: {
-        workspaceId,
-        id,
-        expiredAt: {
-          gt: new Date(),
-        },
-      },
-    });
-  }
-
-  async get(workspaceId: string, id: string, timestamp: Date) {
-    return this.db.snapshotHistory.findUnique({
-      where: {
-        workspaceId_id_timestamp: {
-          workspaceId,
-          id,
-          timestamp,
-        },
-        expiredAt: {
-          gt: new Date(),
-        },
-      },
-    });
-  }
-
-  async last(workspaceId: string, id: string) {
-    return this.db.snapshotHistory.findFirst({
-      where: {
-        workspaceId,
-        id,
-      },
-      select: {
-        timestamp: true,
-        state: true,
-      },
-      orderBy: {
-        timestamp: 'desc',
-      },
-    });
-  }
-
-  async recover(workspaceId: string, id: string, timestamp: Date) {
-    const history = await this.db.snapshotHistory.findUnique({
-      where: {
-        workspaceId_id_timestamp: {
-          workspaceId,
-          id,
-          timestamp,
-        },
-      },
-    });
-
-    if (!history) {
-      throw new Error('Given history not found');
-    }
-
-    const oldSnapshot = await this.db.snapshot.findUnique({
-      where: {
-        id_workspaceId: {
-          id,
-          workspaceId,
-        },
-      },
-    });
-
-    if (!oldSnapshot) {
-      // unreachable actually
-      throw new Error('Given Doc not found');
-    }
-
-    // save old snapshot as one history record
-    await this.onDocUpdated({ workspaceId, id, previous: oldSnapshot }, true);
-    // WARN:
-    //  we should never do the snapshot updating in recovering,
-    //  which is not the solution in CRDT.
-    //  let user revert in client and update the data in sync system
-    //    `await this.db.snapshot.update();`
-    metrics.doc
-      .counter('history_recovered_counter', {
-        description: 'How many times history recovered request happened',
-      })
-      .add(1);
-
-    return history.timestamp;
-  }
-
-  async getExpiredDateFromNow(workspaceId: string) {
-    const permission = await this.db.workspaceUserPermission.findFirst({
-      select: {
-        userId: true,
-      },
-      where: {
-        workspaceId,
-        type: Permission.Owner,
-      },
-    });
-
-    if (!permission) {
-      // unreachable actually
-      throw new Error('Workspace owner not found');
-    }
-
-    const quota = await this.quota.getUserQuota(permission.userId);
-    return quota.feature.historyPeriodFromNow;
-  }
-
-  @Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT /* everyday at 12am */)
-  async cleanupExpiredHistory() {
-    await this.db.snapshotHistory.deleteMany({
-      where: {
-        expiredAt: {
-          lte: new Date(),
-        },
-      },
-    });
-  }
-}

packages/backend/server/src/core/doc/index.ts

@@ -1,14 +1,25 @@
+import './config';
+
 import { Module } from '@nestjs/common';
 
+import { PermissionModule } from '../permission';
 import { QuotaModule } from '../quota';
-import { DocHistoryManager } from './history';
-import { DocManager } from './manager';
+import { PgUserspaceDocStorageAdapter } from './adapters/userspace';
+import { PgWorkspaceDocStorageAdapter } from './adapters/workspace';
+import { DocStorageCronJob } from './job';
+import { DocStorageOptions } from './options';
 
 @Module({
-  imports: [QuotaModule],
-  providers: [DocManager, DocHistoryManager],
-  exports: [DocManager, DocHistoryManager],
+  imports: [QuotaModule, PermissionModule],
+  providers: [
+    DocStorageOptions,
+    PgWorkspaceDocStorageAdapter,
+    PgUserspaceDocStorageAdapter,
+    DocStorageCronJob,
+  ],
+  exports: [PgWorkspaceDocStorageAdapter, PgUserspaceDocStorageAdapter],
 })
-export class DocModule {}
+export class DocStorageModule {}
+export { PgUserspaceDocStorageAdapter, PgWorkspaceDocStorageAdapter };
 
-export { DocHistoryManager, DocManager };
+export { DocStorageAdapter, type Editor } from './storage';

packages/backend/server/src/core/doc/job.ts

@@ -0,0 +1,76 @@
+import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
+import { Cron, CronExpression, SchedulerRegistry } from '@nestjs/schedule';
+import { PrismaClient } from '@prisma/client';
+
+import { CallTimer, Config, metrics } from '../../fundamentals';
+import { PgWorkspaceDocStorageAdapter } from './adapters/workspace';
+
+@Injectable()
+export class DocStorageCronJob implements OnModuleInit {
+  private readonly logger = new Logger(DocStorageCronJob.name);
+  private busy = false;
+
+  constructor(
+    private readonly registry: SchedulerRegistry,
+    private readonly config: Config,
+    private readonly db: PrismaClient,
+    private readonly workspace: PgWorkspaceDocStorageAdapter
+  ) {}
+
+  onModuleInit() {
+    if (this.config.doc.manager.enableUpdateAutoMerging) {
+      this.registry.addInterval(
+        this.autoMergePendingDocUpdates.name,
+        // scheduler registry will clean up the interval when the app is stopped
+        setInterval(() => {
+          if (this.busy) {
+            return;
+          }
+          this.busy = true;
+          this.autoMergePendingDocUpdates()
+            .catch(() => {
+              /* never fail */
+            })
+            .finally(() => {
+              this.busy = false;
+            });
+        }, this.config.doc.manager.updatePollInterval)
+      );
+
+      this.logger.log('Updates pending queue auto merging cron started');
+    }
+  }
+
+  @CallTimer('doc', 'auto_merge_pending_doc_updates')
+  async autoMergePendingDocUpdates() {
+    try {
+      const randomDoc = await this.workspace.randomDoc();
+      if (!randomDoc) {
+        return;
+      }
+
+      await this.workspace.getDoc(randomDoc.workspaceId, randomDoc.docId);
+    } catch (e) {
+      metrics.doc.counter('auto_merge_pending_doc_updates_error').add(1);
+      this.logger.error('Failed to auto merge pending doc updates', e);
+    }
+  }
+
+  @Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT /* everyday at 12am */)
+  async cleanupExpiredHistory() {
+    await this.db.snapshotHistory.deleteMany({
+      where: {
+        expiredAt: {
+          lte: new Date(),
+        },
+      },
+    });
+  }
+
+  @Cron(CronExpression.EVERY_MINUTE)
+  async reportUpdatesQueueCount() {
+    metrics.doc
+      .gauge('updates_queue_count')
+      .record(await this.db.update.count());
+  }
+}

packages/backend/server/src/core/doc/manager.ts

@@ -1,855 +0,0 @@
-import {
-  Injectable,
-  Logger,
-  OnModuleDestroy,
-  OnModuleInit,
-} from '@nestjs/common';
-import { Cron, CronExpression } from '@nestjs/schedule';
-import { PrismaClient, Snapshot, Update } from '@prisma/client';
-import { chunk } from 'lodash-es';
-import { defer, retry } from 'rxjs';
-import {
-  applyUpdate,
-  Doc,
-  encodeStateAsUpdate,
-  encodeStateVector,
-  transact,
-} from 'yjs';
-
-import type { EventPayload } from '../../fundamentals';
-import {
-  Cache,
-  CallTimer,
-  Config,
-  EventEmitter,
-  mergeUpdatesInApplyWay as jwstMergeUpdates,
-  metrics,
-  OnEvent,
-} from '../../fundamentals';
-
-function compare(yBinary: Buffer, jwstBinary: Buffer, strict = false): boolean {
-  if (yBinary.equals(jwstBinary)) {
-    return true;
-  }
-
-  if (strict) {
-    return false;
-  }
-
-  const doc = new Doc();
-  applyUpdate(doc, jwstBinary);
-
-  const yBinary2 = Buffer.from(encodeStateAsUpdate(doc));
-
-  return compare(yBinary, yBinary2, true);
-}
-
-export function isEmptyBuffer(buf: Buffer): boolean {
-  return (
-    buf.length === 0 ||
-    // 0x0000
-    (buf.length === 2 && buf[0] === 0 && buf[1] === 0)
-  );
-}
-
-const MAX_SEQ_NUM = 0x3fffffff; // u31
-const UPDATES_QUEUE_CACHE_KEY = 'doc:manager:updates';
-
-interface DocResponse {
-  doc: Doc;
-  timestamp: number;
-}
-
-interface BinaryResponse {
-  binary: Buffer;
-  timestamp: number;
-}
-
-/**
- * Since we can't directly save all client updates into database, in which way the database will overload,
- * we need to buffer the updates and merge them to reduce db write.
- *
- * And also, if a new client join, it would be nice to see the latest doc asap,
- * so we need to at least store a snapshot of the doc and return quickly,
- * along side all the updates that have not been applies to that snapshot(timestamp).
- */
-@Injectable()
-export class DocManager implements OnModuleInit, OnModuleDestroy {
-  private readonly logger = new Logger(DocManager.name);
-  private job: NodeJS.Timeout | null = null;
-  private readonly seqMap = new Map<string, number>();
-  private busy = false;
-
-  constructor(
-    private readonly db: PrismaClient,
-    private readonly config: Config,
-    private readonly cache: Cache,
-    private readonly event: EventEmitter
-  ) {}
-
-  onModuleInit() {
-    if (this.config.doc.manager.enableUpdateAutoMerging) {
-      this.logger.log('Use Database');
-      this.setup();
-    }
-  }
-
-  onModuleDestroy() {
-    this.destroy();
-  }
-
-  @CallTimer('doc', 'yjs_recover_updates_to_doc')
-  private recoverDoc(...updates: Buffer[]): Promise<Doc> {
-    const doc = new Doc();
-    const chunks = chunk(updates, 10);
-
-    return new Promise(resolve => {
-      const next = () => {
-        const updates = chunks.shift();
-        if (updates?.length) {
-          transact(doc, () => {
-            updates.forEach(u => {
-              try {
-                applyUpdate(doc, u);
-              } catch (e) {
-                this.logger.error('Failed to apply update', e);
-              }
-            });
-          });
-
-          // avoid applying too many updates in single round which will take the whole cpu time like dead lock
-          setImmediate(() => {
-            next();
-          });
-        } else {
-          resolve(doc);
-        }
-      };
-
-      next();
-    });
-  }
-
-  private async applyUpdates(guid: string, ...updates: Buffer[]): Promise<Doc> {
-    const doc = await this.recoverDoc(...updates);
-
-    // test jwst codec
-    if (this.config.doc.manager.experimentalMergeWithYOcto) {
-      metrics.jwst.counter('codec_merge_counter').add(1);
-      const yjsResult = Buffer.from(encodeStateAsUpdate(doc));
-      let log = false;
-      try {
-        const jwstResult = jwstMergeUpdates(updates);
-        if (!compare(yjsResult, jwstResult)) {
-          metrics.jwst.counter('codec_not_match').add(1);
-          this.logger.warn(
-            `jwst codec result doesn't match yjs codec result for: ${guid}`
-          );
-          log = true;
-          if (this.config.node.dev) {
-            this.logger.warn(`Expected:\n  ${yjsResult.toString('hex')}`);
-            this.logger.warn(`Result:\n  ${jwstResult.toString('hex')}`);
-          }
-        }
-      } catch (e) {
-        metrics.jwst.counter('codec_fails_counter').add(1);
-        this.logger.warn(`jwst apply update failed for ${guid}: ${e}`);
-        log = true;
-      } finally {
-        if (log && this.config.node.dev) {
-          this.logger.warn(
-            `Updates: ${updates.map(u => u.toString('hex')).join('\n')}`
-          );
-        }
-      }
-    }
-
-    return doc;
-  }
-
-  /**
-   * setup pending update processing loop
-   */
-  setup() {
-    this.job = setInterval(() => {
-      if (!this.busy) {
-        this.busy = true;
-        this.autoSquash()
-          .catch(() => {
-            /* we handle all errors in work itself */
-          })
-          .finally(() => {
-            this.busy = false;
-          });
-      }
-    }, this.config.doc.manager.updatePollInterval);
-
-    this.logger.log('Automation started');
-    if (this.config.doc.manager.experimentalMergeWithYOcto) {
-      this.logger.warn(
-        'Experimental feature enabled: merge updates with jwst codec is enabled'
-      );
-    }
-  }
-
-  /**
-   * stop pending update processing loop
-   */
-  destroy() {
-    if (this.job) {
-      clearInterval(this.job);
-      this.job = null;
-      this.logger.log('Automation stopped');
-    }
-  }
-
-  @OnEvent('workspace.deleted')
-  async onWorkspaceDeleted(workspaceId: string) {
-    await this.db.snapshot.deleteMany({
-      where: {
-        workspaceId,
-      },
-    });
-    await this.db.update.deleteMany({
-      where: {
-        workspaceId,
-      },
-    });
-  }
-
-  @OnEvent('snapshot.deleted')
-  async onSnapshotDeleted({
-    id,
-    workspaceId,
-  }: EventPayload<'snapshot.deleted'>) {
-    await this.db.update.deleteMany({
-      where: {
-        id,
-        workspaceId,
-      },
-    });
-  }
-
-  /**
-   * add update to manager for later processing.
-   */
-  async push(
-    workspaceId: string,
-    guid: string,
-    update: Buffer,
-    retryTimes = 10
-  ) {
-    const timestamp = await new Promise<number>((resolve, reject) => {
-      defer(async () => {
-        const seq = await this.getUpdateSeq(workspaceId, guid);
-        const { createdAt } = await this.db.update.create({
-          select: {
-            createdAt: true,
-          },
-          data: {
-            workspaceId,
-            id: guid,
-            seq,
-            blob: update,
-          },
-        });
-
-        return createdAt.getTime();
-      })
-        .pipe(retry(retryTimes)) // retry until seq num not conflict
-        .subscribe({
-          next: timestamp => {
-            this.logger.debug(
-              `pushed 1 update for ${guid} in workspace ${workspaceId}`
-            );
-            resolve(timestamp);
-          },
-          error: e => {
-            this.logger.error('Failed to push updates', e);
-            reject(new Error('Failed to push update'));
-          },
-        });
-    });
-
-    await this.updateCachedUpdatesCount(workspaceId, guid, 1);
-
-    return timestamp;
-  }
-
-  async batchPush(
-    workspaceId: string,
-    guid: string,
-    updates: Buffer[],
-    retryTimes = 10
-  ) {
-    const timestamp = await new Promise<number>((resolve, reject) => {
-      defer(async () => {
-        const lastSeq = await this.getUpdateSeq(
-          workspaceId,
-          guid,
-          updates.length
-        );
-        const now = Date.now();
-        let timestamp = now;
-        let turn = 0;
-        const batchCount = 10;
-        for (const batch of chunk(updates, batchCount)) {
-          await this.db.update.createMany({
-            data: batch.map((update, i) => {
-              const subSeq = turn * batchCount + i + 1;
-              // `seq` is the last seq num of the batch
-              // example for 11 batched updates, start from seq num 20
-              // seq for first update in the batch should be:
-              // 31             - 11                + subSeq(0        * 10          + 0 + 1) = 21
-              // ^ last seq num   ^ updates.length           ^ turn     ^ batchCount  ^i
-              const seq = lastSeq - updates.length + subSeq;
-              const createdAt = now + subSeq;
-              timestamp = Math.max(timestamp, createdAt);
-
-              return {
-                workspaceId,
-                id: guid,
-                blob: update,
-                seq,
-                createdAt: new Date(createdAt), // make sure the updates can be ordered by create time
-              };
-            }),
-          });
-          turn++;
-        }
-
-        return timestamp;
-      })
-        .pipe(retry(retryTimes)) // retry until seq num not conflict
-        .subscribe({
-          next: timestamp => {
-            this.logger.debug(
-              `pushed ${updates.length} updates for ${guid} in workspace ${workspaceId}`
-            );
-            resolve(timestamp);
-          },
-          error: e => {
-            this.logger.error('Failed to push updates', e);
-            reject(new Error('Failed to push update'));
-          },
-        });
-    });
-    await this.updateCachedUpdatesCount(workspaceId, guid, updates.length);
-
-    return timestamp;
-  }
-
-  /**
-   * Get latest timestamp of all docs in the workspace.
-   */
-  @CallTimer('doc', 'get_doc_timestamps')
-  async getDocTimestamps(workspaceId: string, after: number | undefined = 0) {
-    const snapshots = await this.db.snapshot.findMany({
-      where: {
-        workspaceId,
-        updatedAt: {
-          gt: new Date(after),
-        },
-      },
-      select: {
-        id: true,
-        updatedAt: true,
-      },
-    });
-
-    const updates = await this.db.update.groupBy({
-      where: {
-        workspaceId,
-        createdAt: {
-          gt: new Date(after),
-        },
-      },
-      by: ['id'],
-      _max: {
-        createdAt: true,
-      },
-    });
-
-    const result: Record<string, number> = {};
-
-    snapshots.forEach(s => {
-      result[s.id] = s.updatedAt.getTime();
-    });
-
-    updates.forEach(u => {
-      if (u._max.createdAt) {
-        result[u.id] = u._max.createdAt.getTime();
-      }
-    });
-
-    return result;
-  }
-
-  /**
-   * get the latest doc with all update applied.
-   */
-  async get(workspaceId: string, guid: string): Promise<DocResponse | null> {
-    const result = await this._get(workspaceId, guid);
-    if (result) {
-      if ('doc' in result) {
-        return result;
-      } else {
-        const doc = await this.recoverDoc(result.binary);
-
-        return {
-          doc,
-          timestamp: result.timestamp,
-        };
-      }
-    }
-
-    return null;
-  }
-
-  /**
-   * get the latest doc binary with all update applied.
-   */
-  async getBinary(
-    workspaceId: string,
-    guid: string
-  ): Promise<BinaryResponse | null> {
-    const result = await this._get(workspaceId, guid);
-    if (result) {
-      if ('doc' in result) {
-        return {
-          binary: Buffer.from(encodeStateAsUpdate(result.doc)),
-          timestamp: result.timestamp,
-        };
-      } else {
-        return result;
-      }
-    }
-
-    return null;
-  }
-
-  /**
-   * get the latest doc state vector with all update applied.
-   */
-  async getDocState(
-    workspaceId: string,
-    guid: string
-  ): Promise<BinaryResponse | null> {
-    const snapshot = await this.getSnapshot(workspaceId, guid);
-    const updates = await this.getUpdates(workspaceId, guid);
-
-    if (updates.length) {
-      const { doc, timestamp } = await this.squash(snapshot, updates);
-      return {
-        binary: Buffer.from(encodeStateVector(doc)),
-        timestamp,
-      };
-    }
-
-    return snapshot?.state
-      ? {
-          binary: snapshot.state,
-          timestamp: snapshot.updatedAt.getTime(),
-        }
-      : null;
-  }
-
-  /**
-   * get the snapshot of the doc we've seen.
-   */
-  async getSnapshot(workspaceId: string, guid: string) {
-    return this.db.snapshot.findUnique({
-      where: {
-        id_workspaceId: {
-          workspaceId,
-          id: guid,
-        },
-      },
-    });
-  }
-
-  /**
-   * get pending updates
-   */
-  async getUpdates(workspaceId: string, guid: string) {
-    const updates = await this.db.update.findMany({
-      where: {
-        workspaceId,
-        id: guid,
-      },
-      // take it ease, we don't want to overload db and or cpu
-      // if we limit the taken number here,
-      // user will never see the latest doc if there are too many updates pending to be merged.
-      take: this.config.doc.manager.maxUpdatesPullCount,
-    });
-
-    // perf(memory): avoid sorting in db
-    return updates.sort((a, b) => (a.createdAt < b.createdAt ? -1 : 1));
-  }
-
-  /**
-   * apply pending updates to snapshot
-   */
-  private async autoSquash() {
-    // find the first update and batch process updates with same id
-    const candidate = await this.getAutoSquashCandidate();
-
-    // no pending updates
-    if (!candidate) {
-      return;
-    }
-
-    const { id, workspaceId } = candidate;
-
-    await this.lockUpdatesForAutoSquash(workspaceId, id, async () => {
-      try {
-        await this._get(workspaceId, id);
-      } catch (e) {
-        this.logger.error(
-          `Failed to apply updates for workspace: ${workspaceId}, guid: ${id}`
-        );
-        this.logger.error(e);
-      }
-    });
-  }
-
-  private async getAutoSquashCandidate() {
-    const cache = await this.getAutoSquashCandidateFromCache();
-
-    if (cache) {
-      return cache;
-    }
-
-    return this.db.update.findFirst({
-      select: {
-        id: true,
-        workspaceId: true,
-      },
-    });
-  }
-
-  /**
-   * @returns whether the snapshot is updated to the latest, `undefined` means the doc to be upserted is outdated.
-   */
-  @CallTimer('doc', 'upsert')
-  private async upsert(
-    workspaceId: string,
-    guid: string,
-    doc: Doc,
-    // we always delay the snapshot update to avoid db overload,
-    // so the value of auto updated `updatedAt` by db will never be accurate to user's real action time
-    updatedAt: Date,
-    seq: number
-  ) {
-    const blob = Buffer.from(encodeStateAsUpdate(doc));
-
-    if (isEmptyBuffer(blob)) {
-      return undefined;
-    }
-
-    const state = Buffer.from(encodeStateVector(doc));
-
-    // CONCERNS:
-    //   i. Because we save the real user's last seen action time as `updatedAt`,
-    //      it's possible to simply compare the `updatedAt` to determine if the snapshot is older than the one we are going to save.
-    //
-    //  ii. Prisma doesn't support `upsert` with additional `where` condition along side unique constraint.
-    //      In our case, we need to manually check the `updatedAt` to avoid overriding the newer snapshot.
-    //      where: { id_workspaceId: {}, updatedAt: { lt: updatedAt } }
-    //                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    //
-    // iii. Only set the seq number when creating the snapshot.
-    //      For updating scenario, the seq number will be updated when updates pushed to db.
-    try {
-      const result: { updatedAt: Date }[] = await this.db.$queryRaw`
-        INSERT INTO "snapshots" ("workspace_id", "guid", "blob", "state", "seq", "created_at", "updated_at")
-        VALUES (${workspaceId}, ${guid}, ${blob}, ${state}, ${seq}, DEFAULT, ${updatedAt})
-        ON CONFLICT ("workspace_id", "guid")
-        DO UPDATE SET "blob" = ${blob}, "state" = ${state}, "updated_at" = ${updatedAt}, "seq" = ${seq}
-        WHERE "snapshots"."workspace_id" = ${workspaceId} AND "snapshots"."guid" = ${guid} AND "snapshots"."updated_at" <= ${updatedAt}
-        RETURNING "snapshots"."workspace_id" as "workspaceId", "snapshots"."guid" as "id", "snapshots"."updated_at" as "updatedAt"
-      `;
-
-      // const result = await this.db.snapshot.upsert({
-      //   select: {
-      //     updatedAt: true,
-      //     seq: true,
-      //   },
-      //   where: {
-      //     id_workspaceId: {
-      //       workspaceId,
-      //       id: guid,
-      //     },
-      //     ⬇️ NOT SUPPORTED BY PRISMA YET
-      //     updatedAt: {
-      //       lt: updatedAt,
-      //     },
-      //   },
-      //   update: {
-      //     blob,
-      //     state,
-      //     updatedAt,
-      //   },
-      //   create: {
-      //     workspaceId,
-      //     id: guid,
-      //     blob,
-      //     state,
-      //     updatedAt,
-      //     seq,
-      //   },
-      // });
-
-      // if the condition `snapshot.updatedAt > updatedAt` is true, by which means the snapshot has already been updated by other process,
-      // the updates has been applied to current `doc` must have been seen by the other process as well.
-      // The `updatedSnapshot` will be `undefined` in this case.
-      const updatedSnapshot = result.at(0);
-
-      if (!updatedSnapshot) {
-        return undefined;
-      }
-
-      return true;
-    } catch (e) {
-      this.logger.error('Failed to upsert snapshot', e);
-      return false;
-    }
-  }
-
-  private async _get(
-    workspaceId: string,
-    guid: string
-  ): Promise<DocResponse | BinaryResponse | null> {
-    const snapshot = await this.getSnapshot(workspaceId, guid);
-    const updates = await this.getUpdates(workspaceId, guid);
-
-    if (updates.length) {
-      return this.squash(snapshot, updates);
-    }
-
-    return snapshot
-      ? { binary: snapshot.blob, timestamp: snapshot.updatedAt.getTime() }
-      : null;
-  }
-
-  /**
-   * Squash updates into a single update and save it as snapshot,
-   * and delete the updates records at the same time.
-   */
-  @CallTimer('doc', 'squash')
-  private async squash(
-    snapshot: Snapshot | null,
-    updates: Update[]
-  ): Promise<DocResponse> {
-    if (!updates.length) {
-      throw new Error('No updates to squash');
-    }
-
-    const last = updates[updates.length - 1];
-    const { id, workspaceId } = last;
-
-    const doc = await this.applyUpdates(
-      id,
-      snapshot ? snapshot.blob : Buffer.from([0, 0]),
-      ...updates.map(u => u.blob)
-    );
-
-    const done = await this.upsert(
-      workspaceId,
-      id,
-      doc,
-      last.createdAt,
-      last.seq
-    );
-
-    if (done) {
-      if (snapshot) {
-        this.event.emit('snapshot.updated', {
-          id,
-          workspaceId,
-          previous: {
-            blob: snapshot.blob,
-            state: snapshot.state,
-            updatedAt: snapshot.updatedAt,
-          },
-        });
-      }
-
-      this.logger.debug(
-        `Squashed ${updates.length} updates for ${id} in workspace ${workspaceId}`
-      );
-    }
-
-    // we will keep the updates only if the upsert failed on unknown reason
-    // `done === undefined` means the updates is outdated(have already been merged by other process), safe to be deleted
-    // `done === true` means the upsert is successful, safe to be deleted
-    if (done !== false) {
-      // always delete updates
-      // the upsert will return false if the state is not newer, so we don't need to worry about it
-      const { count } = await this.db.update.deleteMany({
-        where: {
-          id,
-          workspaceId,
-          seq: {
-            in: updates.map(u => u.seq),
-          },
-        },
-      });
-
-      await this.updateCachedUpdatesCount(workspaceId, id, -count);
-    }
-
-    return { doc, timestamp: last.createdAt.getTime() };
-  }
-
-  private async getUpdateSeq(workspaceId: string, guid: string, batch = 1) {
-    try {
-      const { seq } = await this.db.snapshot.update({
-        select: {
-          seq: true,
-        },
-        where: {
-          id_workspaceId: {
-            workspaceId,
-            id: guid,
-          },
-        },
-        data: {
-          seq: {
-            increment: batch,
-          },
-        },
-      });
-
-      // reset
-      if (seq >= MAX_SEQ_NUM) {
-        await this.db.snapshot.update({
-          select: {
-            seq: true,
-          },
-          where: {
-            id_workspaceId: {
-              workspaceId,
-              id: guid,
-            },
-          },
-          data: {
-            seq: 0,
-          },
-        });
-      }
-
-      return seq;
-    } catch {
-      // not existing snapshot just count it from 1
-      const last = this.seqMap.get(workspaceId + guid) ?? 0;
-      this.seqMap.set(workspaceId + guid, last + batch);
-      return last + batch;
-    }
-  }
-
-  private async updateCachedUpdatesCount(
-    workspaceId: string,
-    guid: string,
-    count: number
-  ) {
-    const result = await this.cache.mapIncrease(
-      UPDATES_QUEUE_CACHE_KEY,
-      `${workspaceId}::${guid}`,
-      count
-    );
-
-    if (result <= 0) {
-      await this.cache.mapDelete(
-        UPDATES_QUEUE_CACHE_KEY,
-        `${workspaceId}::${guid}`
-      );
-    }
-  }
-
-  private async getAutoSquashCandidateFromCache() {
-    const key = await this.cache.mapRandomKey(UPDATES_QUEUE_CACHE_KEY);
-
-    if (key) {
-      const cachedCount = await this.cache.mapIncrease(
-        UPDATES_QUEUE_CACHE_KEY,
-        key,
-        0
-      );
-
-      if (cachedCount > 0) {
-        const [workspaceId, id] = key.split('::');
-        const count = await this.db.update.count({
-          where: {
-            workspaceId,
-            id,
-          },
-        });
-
-        // FIXME(@forehalo): somehow the update count in cache is not accurate
-        if (count === 0) {
-          await this.cache.mapDelete(UPDATES_QUEUE_CACHE_KEY, key);
-
-          return null;
-        }
-        return { id, workspaceId };
-      }
-    }
-
-    return null;
-  }
-
-  private async doWithLock<T>(
-    lockScope: string,
-    lockResource: string,
-    job: () => Promise<T>
-  ) {
-    const lock = `lock:${lockScope}:${lockResource}`;
-    const acquired = await this.cache.setnx(lock, 1, {
-      ttl: 60 * 1000,
-    });
-    metrics.doc.counter('lock').add(1, { scope: lockScope });
-
-    if (!acquired) {
-      metrics.doc.counter('lock_failed').add(1, { scope: lockScope });
-      return;
-    }
-    metrics.doc.counter('lock_required').add(1, { scope: lockScope });
-
-    try {
-      return await job();
-    } finally {
-      await this.cache
-        .delete(lock)
-        .then(() => {
-          metrics.doc.counter('lock_released').add(1, { scope: lockScope });
-        })
-        .catch(e => {
-          metrics.doc
-            .counter('lock_release_failed')
-            .add(1, { scope: lockScope });
-          // safe, the lock will be expired when ttl ends
-          this.logger.error(`Failed to release lock ${lock}`, e);
-        });
-    }
-  }
-
-  private async lockUpdatesForAutoSquash<T>(
-    workspaceId: string,
-    guid: string,
-    job: () => Promise<T>
-  ) {
-    return this.doWithLock(
-      'doc:manager:updates',
-      `${workspaceId}::${guid}`,
-      job
-    );
-  }
-
-  @Cron(CronExpression.EVERY_MINUTE)
-  async reportUpdatesQueueCount() {
-    metrics.doc
-      .gauge('updates_queue_count')
-      .record(await this.db.update.count());
-  }
-}

packages/backend/server/src/core/doc/options.ts

@@ -0,0 +1,130 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { chunk } from 'lodash-es';
+import * as Y from 'yjs';
+
+import {
+  CallTimer,
+  Config,
+  mergeUpdatesInApplyWay as yotcoMergeUpdates,
+  metrics,
+} from '../../fundamentals';
+import { PermissionService } from '../permission';
+import { QuotaService } from '../quota';
+import { DocStorageOptions as IDocStorageOptions } from './storage';
+
+function compare(yBinary: Buffer, jwstBinary: Buffer, strict = false): boolean {
+  if (yBinary.equals(jwstBinary)) {
+    return true;
+  }
+
+  if (strict) {
+    return false;
+  }
+
+  const doc = new Y.Doc();
+  Y.applyUpdate(doc, jwstBinary);
+
+  const yBinary2 = Buffer.from(Y.encodeStateAsUpdate(doc));
+
+  return compare(yBinary, yBinary2, true);
+}
+
+@Injectable()
+export class DocStorageOptions implements IDocStorageOptions {
+  private readonly logger = new Logger('DocStorageOptions');
+
+  constructor(
+    private readonly config: Config,
+    private readonly permission: PermissionService,
+    private readonly quota: QuotaService
+  ) {}
+
+  mergeUpdates = async (updates: Uint8Array[]) => {
+    const useYocto = await this.config.runtime.fetch(
+      'doc/experimentalMergeWithYOcto'
+    );
+
+    if (useYocto) {
+      const doc = await this.recoverDoc(updates);
+
+      metrics.jwst.counter('codec_merge_counter').add(1);
+      const yjsResult = Buffer.from(Y.encodeStateAsUpdate(doc));
+      let log = false;
+      try {
+        const yocto = yotcoMergeUpdates(updates.map(Buffer.from));
+        if (!compare(yjsResult, yocto)) {
+          metrics.jwst.counter('codec_not_match').add(1);
+          this.logger.warn(`yocto codec result doesn't match yjs codec result`);
+          log = true;
+          if (this.config.node.dev) {
+            this.logger.warn(`Expected:\n  ${yjsResult.toString('hex')}`);
+            this.logger.warn(`Result:\n  ${yocto.toString('hex')}`);
+          }
+        }
+      } catch (e) {
+        metrics.jwst.counter('codec_fails_counter').add(1);
+        this.logger.warn(`jwst apply update failed: ${e}`);
+        log = true;
+      }
+
+      if (log && this.config.node.dev) {
+        this.logger.warn(
+          `Updates: ${updates.map(u => Buffer.from(u).toString('hex')).join('\n')}`
+        );
+      }
+
+      return yjsResult;
+    } else {
+      return this.simpleMergeUpdates(updates);
+    }
+  };
+
+  historyMaxAge = async (spaceId: string) => {
+    const owner = await this.permission.getWorkspaceOwner(spaceId);
+    const quota = await this.quota.getUserQuota(owner.id);
+    return quota.feature.historyPeriod;
+  };
+
+  historyMinInterval = (_spaceId: string) => {
+    return this.config.doc.history.interval;
+  };
+
+  @CallTimer('doc', 'yjs_merge_updates')
+  private simpleMergeUpdates(updates: Uint8Array[]) {
+    return Y.mergeUpdates(updates);
+  }
+
+  @CallTimer('doc', 'yjs_recover_updates_to_doc')
+  private recoverDoc(updates: Uint8Array[]): Promise<Y.Doc> {
+    const doc = new Y.Doc();
+    const chunks = chunk(updates, 10);
+    let i = 0;
+
+    return new Promise(resolve => {
+      Y.transact(doc, () => {
+        const next = () => {
+          const updates = chunks.at(i++);
+
+          if (updates?.length) {
+            updates.forEach(u => {
+              try {
+                Y.applyUpdate(doc, u);
+              } catch (e) {
+                this.logger.error('Failed to apply update', e);
+              }
+            });
+
+            // avoid applying too many updates in single round which will take the whole cpu time like dead lock
+            setImmediate(() => {
+              next();
+            });
+          } else {
+            resolve(doc);
+          }
+        };
+
+        next();
+      });
+    });
+  }
+}

packages/backend/server/src/core/doc/storage/blob.ts

@@ -0,0 +1,16 @@
+import { Connection } from './connection';
+
+export interface BlobStorageOptions {}
+
+export interface Blob {
+  key: string;
+  bin: Uint8Array;
+  mimeType: string;
+}
+
+export abstract class BlobStorageAdapter extends Connection {
+  abstract getBlob(spaceId: string, key: string): Promise<Blob | null>;
+  abstract setBlob(spaceId: string, blob: Blob): Promise<string>;
+  abstract deleteBlob(spaceId: string, key: string): Promise<boolean>;
+  abstract listBlobs(spaceId: string): Promise<Blob>;
+}

packages/backend/server/src/core/doc/storage/connection.ts

@@ -0,0 +1,11 @@
+export class Connection {
+  protected connected: boolean = false;
+  connect(): Promise<void> {
+    this.connected = true;
+    return Promise.resolve();
+  }
+  disconnect(): Promise<void> {
+    this.connected = false;
+    return Promise.resolve();
+  }
+}

packages/backend/server/src/core/doc/storage/doc.ts

@@ -0,0 +1,216 @@
+import {
+  applyUpdate,
+  Doc,
+  encodeStateAsUpdate,
+  encodeStateVector,
+  mergeUpdates,
+  UndoManager,
+} from 'yjs';
+
+import { CallTimer } from '../../../fundamentals';
+import { Connection } from './connection';
+import { SingletonLocker } from './lock';
+
+export interface DocRecord {
+  spaceId: string;
+  docId: string;
+  bin: Uint8Array;
+  timestamp: number;
+  editor?: string;
+}
+
+export interface DocUpdate {
+  bin: Uint8Array;
+  timestamp: number;
+  editor?: string;
+}
+
+export interface HistoryFilter {
+  before?: number;
+  limit?: number;
+}
+
+export interface Editor {
+  name: string;
+  avatarUrl: string | null;
+}
+
+export interface DocStorageOptions {
+  mergeUpdates?: (updates: Uint8Array[]) => Promise<Uint8Array> | Uint8Array;
+}
+
+export abstract class DocStorageAdapter extends Connection {
+  private readonly locker = new SingletonLocker();
+
+  constructor(
+    protected readonly options: DocStorageOptions = {
+      mergeUpdates,
+    }
+  ) {
+    super();
+  }
+
+  // open apis
+  isEmptyBin(bin: Uint8Array): boolean {
+    return (
+      bin.length === 0 ||
+      // 0x0 for state vector
+      (bin.length === 1 && bin[0] === 0) ||
+      // 0x00 for update
+      (bin.length === 2 && bin[0] === 0 && bin[1] === 0)
+    );
+  }
+
+  async getDoc(spaceId: string, docId: string): Promise<DocRecord | null> {
+    await using _lock = await this.lockDocForUpdate(spaceId, docId);
+
+    const snapshot = await this.getDocSnapshot(spaceId, docId);
+    const updates = await this.getDocUpdates(spaceId, docId);
+
+    if (updates.length) {
+      const { timestamp, bin, editor } = await this.squash(
+        snapshot ? [snapshot, ...updates] : updates
+      );
+
+      const newSnapshot = {
+        spaceId: spaceId,
+        docId,
+        bin,
+        timestamp,
+        editor,
+      };
+
+      const success = await this.setDocSnapshot(newSnapshot);
+
+      // if there is old snapshot, create a new history record
+      if (success && snapshot) {
+        await this.createDocHistory(snapshot);
+      }
+
+      // always mark updates as merged unless throws
+      await this.markUpdatesMerged(spaceId, docId, updates);
+
+      return newSnapshot;
+    }
+
+    return snapshot;
+  }
+
+  abstract pushDocUpdates(
+    spaceId: string,
+    docId: string,
+    updates: Uint8Array[],
+    editorId?: string
+  ): Promise<number>;
+
+  abstract deleteDoc(spaceId: string, docId: string): Promise<void>;
+  abstract deleteSpace(spaceId: string): Promise<void>;
+  async rollbackDoc(
+    spaceId: string,
+    docId: string,
+    timestamp: number,
+    editorId?: string
+  ): Promise<void> {
+    await using _lock = await this.lockDocForUpdate(spaceId, docId);
+    const toSnapshot = await this.getDocHistory(spaceId, docId, timestamp);
+    if (!toSnapshot) {
+      throw new Error('Can not find the version to rollback to.');
+    }
+
+    const fromSnapshot = await this.getDocSnapshot(spaceId, docId);
+
+    if (!fromSnapshot) {
+      throw new Error('Can not find the current version of the doc.');
+    }
+
+    const change = this.generateChangeUpdate(fromSnapshot.bin, toSnapshot.bin);
+    await this.pushDocUpdates(spaceId, docId, [change], editorId);
+    // force create a new history record after rollback
+    await this.createDocHistory(fromSnapshot, true);
+  }
+
+  abstract getSpaceDocTimestamps(
+    spaceId: string,
+    after?: number
+  ): Promise<Record<string, number> | null>;
+  abstract listDocHistories(
+    spaceId: string,
+    docId: string,
+    query: { skip?: number; limit?: number }
+  ): Promise<{ timestamp: number; editor: Editor | null }[]>;
+  abstract getDocHistory(
+    spaceId: string,
+    docId: string,
+    timestamp: number
+  ): Promise<DocRecord | null>;
+
+  // api for internal usage
+  protected abstract getDocSnapshot(
+    spaceId: string,
+    docId: string
+  ): Promise<DocRecord | null>;
+  protected abstract setDocSnapshot(snapshot: DocRecord): Promise<boolean>;
+  protected abstract getDocUpdates(
+    spaceId: string,
+    docId: string
+  ): Promise<DocUpdate[]>;
+  protected abstract markUpdatesMerged(
+    spaceId: string,
+    docId: string,
+    updates: DocUpdate[]
+  ): Promise<number>;
+
+  protected abstract createDocHistory(
+    snapshot: DocRecord,
+    force?: boolean
+  ): Promise<boolean>;
+
+  @CallTimer('doc', 'squash')
+  protected async squash(updates: DocUpdate[]): Promise<DocUpdate> {
+    const merge = this.options?.mergeUpdates ?? mergeUpdates;
+    const lastUpdate = updates.at(-1);
+    if (!lastUpdate) {
+      throw new Error('No updates to be squashed.');
+    }
+
+    // fast return
+    if (updates.length === 1) {
+      return lastUpdate;
+    }
+
+    const finalUpdate = await merge(updates.map(u => u.bin));
+
+    return {
+      bin: finalUpdate,
+      timestamp: lastUpdate.timestamp,
+      editor: lastUpdate.editor,
+    };
+  }
+
+  protected async lockDocForUpdate(
+    spaceId: string,
+    docId: string
+  ): Promise<AsyncDisposable> {
+    return this.locker.lock(`workspace:${spaceId}:update`, docId);
+  }
+
+  protected generateChangeUpdate(newerBin: Uint8Array, olderBin: Uint8Array) {
+    const newerDoc = new Doc();
+    applyUpdate(newerDoc, newerBin);
+    const olderDoc = new Doc();
+    applyUpdate(olderDoc, olderBin);
+
+    const newerState = encodeStateVector(newerDoc);
+    const olderState = encodeStateVector(olderDoc);
+
+    const diff = encodeStateAsUpdate(newerDoc, olderState);
+
+    const undoManager = new UndoManager(Array.from(newerDoc.share.values()));
+
+    applyUpdate(olderDoc, diff);
+
+    undoManager.undo();
+
+    return encodeStateAsUpdate(olderDoc, newerState);
+  }
+}

packages/backend/server/src/core/doc/storage/index.ts

@@ -0,0 +1,33 @@
+// TODO(@forehalo): share with frontend
+import type { BlobStorageAdapter } from './blob';
+import { Connection } from './connection';
+import type { DocStorageAdapter } from './doc';
+
+export class SpaceStorage extends Connection {
+  constructor(
+    public readonly doc: DocStorageAdapter,
+    public readonly blob: BlobStorageAdapter
+  ) {
+    super();
+  }
+
+  override async connect() {
+    await this.doc.connect();
+    await this.blob.connect();
+  }
+
+  override async disconnect() {
+    await this.doc.disconnect();
+    await this.blob.disconnect();
+  }
+}
+
+export { BlobStorageAdapter, type BlobStorageOptions } from './blob';
+export {
+  type DocRecord,
+  DocStorageAdapter,
+  type DocStorageOptions,
+  type DocUpdate,
+  type Editor,
+  type HistoryFilter,
+} from './doc';

packages/backend/server/src/core/doc/storage/lock.ts

@@ -0,0 +1,42 @@
+export interface Locker {
+  lock(domain: string, resource: string): Promise<Lock>;
+}
+
+export class SingletonLocker implements Locker {
+  lockedResource = new Map<string, Lock>();
+  constructor() {}
+
+  async lock(domain: string, resource: string) {
+    let lock = this.lockedResource.get(`${domain}:${resource}`);
+
+    if (!lock) {
+      lock = new Lock();
+    }
+
+    await lock.acquire();
+
+    return lock;
+  }
+}
+
+export class Lock {
+  private inner: Promise<void> = Promise.resolve();
+  private release: () => void = () => {};
+
+  async acquire() {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    let release: () => void = null!;
+    const nextLock = new Promise<void>(resolve => {
+      release = resolve;
+    });
+
+    await this.inner;
+    this.inner = nextLock;
+    this.release = release;
+  }
+
+  [Symbol.asyncDispose]() {
+    this.release();
+    return Promise.resolve();
+  }
+}

packages/backend/server/src/core/features/feature.ts

@@ -1,12 +1,14 @@
 import { PrismaTransaction } from '../../fundamentals';
 import { Feature, FeatureSchema, FeatureType } from './types';
 
-class FeatureConfig {
-  readonly config: Feature;
+class FeatureConfig<T extends FeatureType> {
+  readonly config: Feature & { feature: T };
 
   constructor(data: any) {
     const config = FeatureSchema.safeParse(data);
+
     if (config.success) {
+      // @ts-expect-error allow
       this.config = config.data;
     } else {
       throw new Error(`Invalid quota config: ${config.error.message}`);
@@ -19,86 +21,18 @@ class FeatureConfig {
   }
 }
 
-export class CopilotFeatureConfig extends FeatureConfig {
-  override config!: Feature & { feature: FeatureType.Copilot };
-  constructor(data: any) {
-    super(data);
-
-    if (this.config.feature !== FeatureType.Copilot) {
-      throw new Error('Invalid feature config: type is not Copilot');
-    }
-  }
-}
-
-export class EarlyAccessFeatureConfig extends FeatureConfig {
-  override config!: Feature & { feature: FeatureType.EarlyAccess };
-
-  constructor(data: any) {
-    super(data);
-
-    if (this.config.feature !== FeatureType.EarlyAccess) {
-      throw new Error('Invalid feature config: type is not EarlyAccess');
-    }
-  }
-}
-
-export class UnlimitedWorkspaceFeatureConfig extends FeatureConfig {
-  override config!: Feature & { feature: FeatureType.UnlimitedWorkspace };
-
-  constructor(data: any) {
-    super(data);
-
-    if (this.config.feature !== FeatureType.UnlimitedWorkspace) {
-      throw new Error('Invalid feature config: type is not UnlimitedWorkspace');
-    }
-  }
-}
-
-export class UnlimitedCopilotFeatureConfig extends FeatureConfig {
-  override config!: Feature & { feature: FeatureType.UnlimitedCopilot };
-
-  constructor(data: any) {
-    super(data);
-
-    if (this.config.feature !== FeatureType.UnlimitedCopilot) {
-      throw new Error('Invalid feature config: type is not AIEarlyAccess');
-    }
-  }
-}
-export class AIEarlyAccessFeatureConfig extends FeatureConfig {
-  override config!: Feature & { feature: FeatureType.AIEarlyAccess };
-
-  constructor(data: any) {
-    super(data);
-
-    if (this.config.feature !== FeatureType.AIEarlyAccess) {
-      throw new Error('Invalid feature config: type is not AIEarlyAccess');
-    }
-  }
-}
-
-const FeatureConfigMap = {
-  [FeatureType.Copilot]: CopilotFeatureConfig,
-  [FeatureType.EarlyAccess]: EarlyAccessFeatureConfig,
-  [FeatureType.AIEarlyAccess]: AIEarlyAccessFeatureConfig,
-  [FeatureType.UnlimitedWorkspace]: UnlimitedWorkspaceFeatureConfig,
-  [FeatureType.UnlimitedCopilot]: UnlimitedCopilotFeatureConfig,
-};
-
-export type FeatureConfigType<F extends FeatureType> = InstanceType<
-  (typeof FeatureConfigMap)[F]
->;
+export type FeatureConfigType<F extends FeatureType> = FeatureConfig<F>;
 
 const FeatureCache = new Map<number, FeatureConfigType<FeatureType>>();
 
 export async function getFeature(prisma: PrismaTransaction, featureId: number) {
-  const cachedQuota = FeatureCache.get(featureId);
+  const cachedFeature = FeatureCache.get(featureId);
 
-  if (cachedQuota) {
-    return cachedQuota;
+  if (cachedFeature) {
+    return cachedFeature;
   }
 
-  const feature = await prisma.features.findFirst({
+  const feature = await prisma.feature.findFirst({
     where: {
       id: featureId,
     },
@@ -107,13 +41,8 @@ export async function getFeature(prisma: PrismaTransaction, featureId: number) {
     // this should unreachable
     throw new Error(`Quota config ${featureId} not found`);
   }
-  const ConfigClass = FeatureConfigMap[feature.feature as FeatureType];
 
-  if (!ConfigClass) {
-    throw new Error(`Feature config ${featureId} not found`);
-  }
-
-  const config = new ConfigClass(feature);
+  const config = new FeatureConfig(feature);
   // we always edit quota config as a new quota config
   // so we can cache it by featureId
   FeatureCache.set(featureId, config);

packages/backend/server/src/core/features/index.ts

@@ -1,6 +1,11 @@
 import { Module } from '@nestjs/common';
 
+import { UserModule } from '../user';
 import { EarlyAccessType, FeatureManagementService } from './management';
+import {
+  AdminFeatureManagementResolver,
+  FeatureManagementResolver,
+} from './resolver';
 import { FeatureService } from './service';
 
 /**
@@ -10,7 +15,13 @@ import { FeatureService } from './service';
  * - feature statistics
  */
 @Module({
-  providers: [FeatureService, FeatureManagementService],
+  imports: [UserModule],
+  providers: [
+    FeatureService,
+    FeatureManagementService,
+    FeatureManagementResolver,
+    AdminFeatureManagementResolver,
+  ],
   exports: [FeatureService, FeatureManagementService],
 })
 export class FeatureModule {}

packages/backend/server/src/core/features/management.ts

@@ -1,11 +1,11 @@
 import { Injectable, Logger } from '@nestjs/common';
-import { PrismaClient } from '@prisma/client';
 
-import { Config } from '../../fundamentals';
+import { Config, type EventPayload, OnEvent } from '../../fundamentals';
+import { UserService } from '../user/service';
 import { FeatureService } from './service';
 import { FeatureType } from './types';
 
-const STAFF = ['@toeverything.info'];
+const STAFF = ['@toeverything.info', '@affine.pro'];
 
 export enum EarlyAccessType {
   App = 'app',
@@ -18,22 +18,30 @@ export class FeatureManagementService {
 
   constructor(
     private readonly feature: FeatureService,
-    private readonly prisma: PrismaClient,
+    private readonly user: UserService,
     private readonly config: Config
   ) {}
 
   // ======== Admin ========
 
-  // todo(@darkskygit): replace this with abac
   isStaff(email: string) {
     for (const domain of STAFF) {
       if (email.endsWith(domain)) {
         return true;
       }
     }
+
     return false;
   }
 
+  isAdmin(userId: string) {
+    return this.feature.hasUserFeature(userId, FeatureType.Admin);
+  }
+
+  addAdmin(userId: string) {
+    return this.feature.addUserFeature(userId, FeatureType.Admin, 'Admin user');
+  }
+
   // ======== Early Access ========
   async addEarlyAccess(
     userId: string,
@@ -69,31 +77,17 @@ export class FeatureManagementService {
   }
 
   async isEarlyAccessUser(
-    email: string,
+    userId: string,
     type: EarlyAccessType = EarlyAccessType.App
   ) {
-    const user = await this.prisma.user.findFirst({
-      where: {
-        email: {
-          equals: email,
-          mode: 'insensitive',
-        },
-      },
-    });
-
-    if (user) {
-      const canEarlyAccess = await this.feature
-        .hasUserFeature(
-          user.id,
-          type === EarlyAccessType.App
-            ? FeatureType.EarlyAccess
-            : FeatureType.AIEarlyAccess
-        )
-        .catch(() => false);
-
-      return canEarlyAccess;
-    }
-    return false;
+    return await this.feature
+      .hasUserFeature(
+        userId,
+        type === EarlyAccessType.App
+          ? FeatureType.EarlyAccess
+          : FeatureType.AIEarlyAccess
+      )
+      .catch(() => false);
   }
 
   /// check early access by email
@@ -101,8 +95,16 @@ export class FeatureManagementService {
     email: string,
     type: EarlyAccessType = EarlyAccessType.App
   ) {
-    if (this.config.featureFlags.earlyAccessPreview && !this.isStaff(email)) {
-      return this.isEarlyAccessUser(email, type);
+    const earlyAccessControlEnabled = await this.config.runtime.fetch(
+      'flags/earlyAccessControl'
+    );
+
+    if (earlyAccessControlEnabled && !this.isStaff(email)) {
+      const user = await this.user.findUserByEmail(email);
+      if (!user) {
+        return false;
+      }
+      return this.isEarlyAccessUser(user.id, type);
     } else {
       return true;
     }
@@ -165,4 +167,9 @@ export class FeatureManagementService {
   async listFeatureWorkspaces(feature: FeatureType) {
     return this.feature.listFeatureWorkspaces(feature);
   }
+
+  @OnEvent('user.admin.created')
+  async onAdminUserCreated({ id }: EventPayload<'user.admin.created'>) {
+    await this.addAdmin(id);
+  }
 }

packages/backend/server/src/core/features/resolver.ts

@@ -0,0 +1,77 @@
+import {
+  Args,
+  Mutation,
+  Parent,
+  registerEnumType,
+  ResolveField,
+  Resolver,
+} from '@nestjs/graphql';
+import { difference } from 'lodash-es';
+
+import { Config } from '../../fundamentals';
+import { Admin } from '../common';
+import { UserType } from '../user/types';
+import { EarlyAccessType, FeatureManagementService } from './management';
+import { FeatureService } from './service';
+import { FeatureType } from './types';
+
+registerEnumType(EarlyAccessType, {
+  name: 'EarlyAccessType',
+});
+
+@Resolver(() => UserType)
+export class FeatureManagementResolver {
+  constructor(private readonly feature: FeatureManagementService) {}
+
+  @ResolveField(() => [FeatureType], {
+    name: 'features',
+    description: 'Enabled features of a user',
+  })
+  async userFeatures(@Parent() user: UserType) {
+    return this.feature.getActivatedUserFeatures(user.id);
+  }
+}
+
+export class AvailableUserFeatureConfig {
+  constructor(private readonly config: Config) {}
+
+  async availableUserFeatures() {
+    return this.config.isSelfhosted
+      ? [FeatureType.Admin]
+      : [FeatureType.EarlyAccess, FeatureType.AIEarlyAccess, FeatureType.Admin];
+  }
+}
+
+@Admin()
+@Resolver(() => Boolean)
+export class AdminFeatureManagementResolver extends AvailableUserFeatureConfig {
+  constructor(
+    config: Config,
+    private readonly feature: FeatureService
+  ) {
+    super(config);
+  }
+
+  @Mutation(() => [FeatureType], {
+    description: 'update user enabled feature',
+  })
+  async updateUserFeatures(
+    @Args('id') id: string,
+    @Args({ name: 'features', type: () => [FeatureType] })
+    features: FeatureType[]
+  ) {
+    const configurableFeatures = await this.availableUserFeatures();
+
+    const removed = difference(configurableFeatures, features);
+    await Promise.all(
+      features.map(feature =>
+        this.feature.addUserFeature(id, feature, 'admin panel')
+      )
+    );
+    await Promise.all(
+      removed.map(feature => this.feature.removeUserFeature(id, feature))
+    );
+
+    return features;
+  }
+}

packages/backend/server/src/core/features/service.ts

@@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { PrismaClient } from '@prisma/client';
 
+import { CannotDeleteAllAdminAccount } from '../../fundamentals';
 import { WorkspaceType } from '../workspaces/types';
 import { FeatureConfigType, getFeature } from './feature';
 import { FeatureKind, FeatureType } from './types';
@@ -8,10 +9,9 @@ import { FeatureKind, FeatureType } from './types';
 @Injectable()
 export class FeatureService {
   constructor(private readonly prisma: PrismaClient) {}
-  async getFeature<F extends FeatureType>(
-    feature: F
-  ): Promise<FeatureConfigType<F> | undefined> {
-    const data = await this.prisma.features.findFirst({
+
+  async getFeature<F extends FeatureType>(feature: F) {
+    const data = await this.prisma.feature.findFirst({
       where: {
         feature,
         type: FeatureKind.Feature,
@@ -21,8 +21,9 @@ export class FeatureService {
         version: 'desc',
       },
     });
+
     if (data) {
-      return getFeature(this.prisma, data.id) as FeatureConfigType<F>;
+      return getFeature(this.prisma, data.id) as Promise<FeatureConfigType<F>>;
     }
     return undefined;
   }
@@ -36,7 +37,7 @@ export class FeatureService {
     expiredAt?: Date | string
   ) {
     return this.prisma.$transaction(async tx => {
-      const latestFlag = await tx.userFeatures.findFirst({
+      const latestFlag = await tx.userFeature.findFirst({
         where: {
           userId,
           feature: {
@@ -53,7 +54,7 @@ export class FeatureService {
       if (latestFlag) {
         return latestFlag.id;
       } else {
-        const featureId = await tx.features
+        const featureId = await tx.feature
           .findFirst({
             where: { feature, type: FeatureKind.Feature },
             orderBy: { version: 'desc' },
@@ -65,7 +66,7 @@ export class FeatureService {
           throw new Error(`Feature ${feature} not found`);
         }
 
-        return tx.userFeatures
+        return tx.userFeature
           .create({
             data: {
               reason,
@@ -81,7 +82,10 @@ export class FeatureService {
   }
 
   async removeUserFeature(userId: string, feature: FeatureType) {
-    return this.prisma.userFeatures
+    if (feature === FeatureType.Admin) {
+      await this.ensureNotLastAdmin(userId);
+    }
+    return this.prisma.userFeature
       .updateMany({
         where: {
           userId,
@@ -98,13 +102,27 @@ export class FeatureService {
       .then(r => r.count);
   }
 
+  async ensureNotLastAdmin(userId: string) {
+    const count = await this.prisma.userFeature.count({
+      where: {
+        userId: { not: userId },
+        feature: { feature: FeatureType.Admin, type: FeatureKind.Feature },
+        activated: true,
+      },
+    });
+
+    if (count === 0) {
+      throw new CannotDeleteAllAdminAccount();
+    }
+  }
+
   /**
    * get user's features, will included inactivated features
    * @param userId user id
    * @returns list of features
    */
   async getUserFeatures(userId: string) {
-    const features = await this.prisma.userFeatures.findMany({
+    const features = await this.prisma.userFeature.findMany({
       where: {
         userId,
         feature: { type: FeatureKind.Feature },
@@ -129,7 +147,7 @@ export class FeatureService {
   }
 
   async getActivatedUserFeatures(userId: string) {
-    const features = await this.prisma.userFeatures.findMany({
+    const features = await this.prisma.userFeature.findMany({
       where: {
         userId,
         feature: { type: FeatureKind.Feature },
@@ -156,7 +174,7 @@ export class FeatureService {
   }
 
   async listFeatureUsers(feature: FeatureType) {
-    return this.prisma.userFeatures
+    return this.prisma.userFeature
       .findMany({
         where: {
           activated: true,
@@ -182,7 +200,7 @@ export class FeatureService {
   }
 
   async hasUserFeature(userId: string, feature: FeatureType) {
-    return this.prisma.userFeatures
+    return this.prisma.userFeature
       .count({
         where: {
           userId,
@@ -206,7 +224,7 @@ export class FeatureService {
     expiredAt?: Date | string
   ) {
     return this.prisma.$transaction(async tx => {
-      const latestFlag = await tx.workspaceFeatures.findFirst({
+      const latestFlag = await tx.workspaceFeature.findFirst({
         where: {
           workspaceId,
           feature: {
@@ -223,7 +241,7 @@ export class FeatureService {
         return latestFlag.id;
       } else {
         // use latest version of feature
-        const featureId = await tx.features
+        const featureId = await tx.feature
           .findFirst({
             where: { feature, type: FeatureKind.Feature },
             select: { id: true },
@@ -235,7 +253,7 @@ export class FeatureService {
           throw new Error(`Feature ${feature} not found`);
         }
 
-        return tx.workspaceFeatures
+        return tx.workspaceFeature
           .create({
             data: {
               reason,
@@ -251,7 +269,7 @@ export class FeatureService {
   }
 
   async removeWorkspaceFeature(workspaceId: string, feature: FeatureType) {
-    return this.prisma.workspaceFeatures
+    return this.prisma.workspaceFeature
       .updateMany({
         where: {
           workspaceId,
@@ -274,7 +292,7 @@ export class FeatureService {
    * @returns list of features
    */
   async getWorkspaceFeatures(workspaceId: string) {
-    const features = await this.prisma.workspaceFeatures.findMany({
+    const features = await this.prisma.workspaceFeature.findMany({
       where: {
         workspace: { id: workspaceId },
         feature: {
@@ -301,7 +319,7 @@ export class FeatureService {
   }
 
   async listFeatureWorkspaces(feature: FeatureType): Promise<WorkspaceType[]> {
-    return this.prisma.workspaceFeatures
+    return this.prisma.workspaceFeature
       .findMany({
         where: {
           activated: true,
@@ -324,7 +342,7 @@ export class FeatureService {
   }
 
   async hasWorkspaceFeature(workspaceId: string, feature: FeatureType) {
-    return this.prisma.workspaceFeatures
+    return this.prisma.workspaceFeature
       .count({
         where: {
           workspaceId,