feat: impl unlimited features (#5659)

Co-authored-by: xiaoxin <hongtao.lye@toeverything.info>

.eslintrc.js

@@ -217,6 +217,7 @@ const config = {
     'unicorn/no-useless-promise-resolve-reject': 'error',
     'unicorn/no-new-array': 'error',
     'unicorn/new-for-builtins': 'error',
+    'unicorn/prefer-node-protocol': 'error',
     'sonarjs/no-all-duplicated-branches': 'error',
     'sonarjs/no-element-overwrite': 'error',
     'sonarjs/no-empty-collection': 'error',

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

@@ -37,7 +37,7 @@ runs:
         echo "TARGET_CC=clang" >> "$GITHUB_ENV"
 
     - name: Cache cargo
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           ~/.cargo/registry/index/

.github/actions/deploy/deploy.mjs

@@ -65,8 +65,16 @@ const createHelmCommand = ({ isDryRun }) => {
         ]
       : [];
   const webReplicaCount = isProduction ? 3 : isBeta ? 2 : 2;
-  const graphqlReplicaCount = isProduction ? 10 : isBeta ? 5 : 2;
-  const syncReplicaCount = isProduction ? 10 : isBeta ? 5 : 2;
+  const graphqlReplicaCount = isProduction
+    ? Number(process.env.PRODUCTION_GRAPHQL_REPLICA) || 3
+    : isBeta
+      ? Number(process.env.isBeta_GRAPHQL_REPLICA) || 2
+      : 2;
+  const syncReplicaCount = isProduction
+    ? Number(process.env.PRODUCTION_SYNC_REPLICA) || 3
+    : isBeta
+      ? Number(process.env.BETA_SYNC_REPLICA) || 2
+      : 2;
   const namespace = isProduction
     ? 'production'
     : isBeta

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

@@ -63,7 +63,7 @@ runs:
       run: node -e "const p = $(yarn config cacheFolder --json).effective; console.log('yarn_global_cache=' + p)" >> $GITHUB_OUTPUT
 
     - name: Cache non-full yarn cache on Linux
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       if: ${{ inputs.full-cache != 'true' && runner.os == 'Linux' }}
       with:
         path: |
@@ -75,7 +75,7 @@ runs:
     # and the decompression performance on Windows is very terrible
     # so we reduce the number of cached files on non-Linux systems by remove node_modules from cache path.
     - name: Cache non-full yarn cache on non-Linux
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       if: ${{ inputs.full-cache != 'true' && runner.os != 'Linux' }}
       with:
         path: |
@@ -83,7 +83,7 @@ runs:
         key: node_modules-cache-${{ github.job }}-${{ runner.os }}
 
     - name: Cache full yarn cache on Linux
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       if: ${{ inputs.full-cache == 'true' && runner.os == 'Linux' }}
       with:
         path: |
@@ -92,7 +92,7 @@ runs:
         key: node_modules-cache-full-${{ runner.os }}
 
     - name: Cache full yarn cache on non-Linux
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       if: ${{ inputs.full-cache == 'true' && runner.os != 'Linux' }}
       with:
         path: |
@@ -134,7 +134,7 @@ runs:
       # Note: Playwright's cache directory is hard coded because that's what it
       # says to do in the docs. There doesn't appear to be a command that prints
       # it out for us.
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       id: playwright-cache
       if: ${{ inputs.playwright-install == 'true' }}
       with:
@@ -167,7 +167,7 @@ runs:
       run: |
         echo "version=$(yarn why --json electron | grep -h 'workspace:.' | jq --raw-output '.children[].locator' | sed -e 's/@playwright\/test@.*://' | head -n 1)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       id: electron-cache
       if: ${{ inputs.electron-install == 'true' }}
       with:

.github/deployment/self-host/compose.yaml

@@ -1,13 +1,9 @@
 services:
   affine:
     image: ghcr.io/toeverything/affine-graphql:beta
-    container_name: affine
+    container_name: affine_selfhosted
     command:
-      [
-        'sh',
-        '-c',
-        './node_modules/.bin/dotenv -e /root/.affine/.env -- npm run predeploy && node --es-module-specifier-resolution=node ./dist/index.js',
-      ]
+      ['sh', '-c', 'node ./scripts/self-host-predeploy && node ./dist/index.js']
     ports:
       - '3010:3010'
       - '5555:5555'
@@ -17,23 +13,31 @@ services:
       postgres:
         condition: service_healthy
     volumes:
-      - ~/.affine/storage:/root/.affine/storage
-      - ~/.affine/.env:/root/.affine/.env
+      # custom configurations
+      - ~/.affine/self-host/config:/root/.affine/config
+      # blob storage
+      - ~/.affine/self-host/storage:/root/.affine/storage
     logging:
       driver: 'json-file'
       options:
         max-size: '1000m'
     restart: unless-stopped
     environment:
+      - NODE_OPTIONS=--es-module-specifier-resolution node
+      - AFFINE_CONFIG_PATH=/root/.affine/config
+      - REDIS_SERVER_HOST=redis
+      - DATABASE_URL=postgres://affine:affine@postgres:5432/affine
       - DISABLE_TELEMETRY=true
       - NODE_ENV=production
       - SERVER_FLAVOR=selfhosted
+      - AFFINE_ADMIN_EMAIL=${AFFINE_ADMIN_EMAIL}
+      - AFFINE_ADMIN_PASSWORD=${AFFINE_ADMIN_PASSWORD}
   redis:
     image: redis
-    container_name: redis
+    container_name: affine_redis
     restart: unless-stopped
     volumes:
-      - ~/.affine/redis:/data
+      - ~/.affine/self-host/redis:/data
     healthcheck:
       test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
       interval: 10s
@@ -41,10 +45,10 @@ services:
       retries: 5
   postgres:
     image: postgres
-    container_name: postgres
+    container_name: affine_postgres
     restart: unless-stopped
     volumes:
-      - ~/.affine/postgres:/var/lib/postgresql/data
+      - ~/.affine/self-host/postgres:/var/lib/postgresql/data
     healthcheck:
       test: ['CMD-SHELL', 'pg_isready -U affine']
       interval: 10s

.github/helm/affine/Chart.yaml

@@ -3,4 +3,4 @@ name: affine
 description: AFFiNE cloud chart
 type: application
 version: 0.0.0
-appVersion: "0.11.0"
+appVersion: "0.12.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.11.0"
+appVersion: "0.12.0"
 dependencies:
   - name: gcloud-sql-proxy
     version: 0.0.0

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

@@ -73,7 +73,7 @@ spec:
             value: "{{ .Values.app.path }}"
           - name: AFFINE_SERVER_HOST
             value: "{{ .Values.app.host }}"
-          - name: AFFINE_SERVER_HOST
+          - name: AFFINE_SERVER_HTTPS
             value: "{{ .Values.app.https }}"
           - name: ENABLE_R2_OBJECT_STORAGE
             value: "{{ .Values.app.objectStorage.r2.enabled }}"
@@ -147,6 +147,8 @@ spec:
                 key: turnstileSecret
           {{ end }}
           {{ if .Values.app.oauth.google.enabled }}
+          - name: OAUTH_GOOGLE_ENABLED
+            value: "true"
           - name: OAUTH_GOOGLE_CLIENT_ID
             valueFrom:
               secretKeyRef:

.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.11.0"
+appVersion: "0.12.0"
 dependencies:
   - name: gcloud-sql-proxy
     version: 0.0.0

.github/renovate.json

@@ -70,6 +70,7 @@
   "commitMessageAction": "bump up",
   "commitMessageTopic": "{{depName}} version",
   "ignoreDeps": [],
+  "postUpdateOptions": ["yarnDedupeHighest"],
   "lockFileMaintenance": {
     "enabled": true,
     "extends": ["schedule:weekly"]

.github/workflows/build-test.yml

@@ -19,6 +19,7 @@ env:
   MACOSX_DEPLOYMENT_TARGET: '10.13'
   NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
   PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/node_modules/.cache/ms-playwright
+  DISABLE_TELEMETRY: true
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -95,6 +96,8 @@ jobs:
         run: |
           git checkout .yarnrc.yml
           yarn lint:prettier
+      - name: Yarn Dedupe
+        run: yarn dedupe --check
       - name: Run Type Check
         run: yarn typecheck
 

.github/workflows/publish-ui-storybook.yml

@@ -0,0 +1,51 @@
+name: Publish UI Storybook
+
+env:
+  NODE_OPTIONS: --max-old-space-size=4096
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - canary
+  pull_request:
+    branches:
+      - canary
+    paths-ignore:
+      - README.md
+      - .github/**
+      - packages/backend/server
+      - packages/frontend/electron
+      - '!.github/workflows/publish-storybook.yml'
+
+jobs:
+  publish-ui-storybook:
+    name: Publish UI Storybook
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          # This is required to fetch all commits for chromatic
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+        with:
+          electron-install: false
+      - uses: chromaui/action-next@v1
+        with:
+          workingDir: packages/frontend/component
+          buildScriptName: build:storybook
+          exitOnceUploaded: true
+          onlyChanged: false
+          diagnostics: true
+        env:
+          CHROMATIC_PROJECT_TOKEN: ${{ secrets.CHROMATIC_UI_PROJECT_TOKEN }}
+          NODE_OPTIONS: ${{ env.NODE_OPTIONS }}
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: chromatic-build-artifacts-${{ github.run_id }}
+          path: |
+            chromatic-diagnostics.json
+            **/build-storybook.log

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 yarn lint-staged && yarn lint:ox

README.md

@@ -138,24 +138,6 @@ We would like to express our gratitude to all the individuals who have already c
   <img alt="contributors" src="https://opencollective.com/affine/contributors.svg?width=890&button=false" />
 </a>
 
-## Data Compatibility
-
-Data compatibility is a very important issue for us. We will try our best to ensure that the data is compatible with the previous version.
-
-If you encounter any problems when upgrading the version, please feel free to [contact us](mailto:developer@toeverything.info).
-
-| AFFiNE Version  | Export/Import workspace | Data auto migration |
-| --------------- | ----------------------- | ------------------- |
-| <= 0.5.4        | ❌️                     | ❌                  |
-| 0.6.x           | ✅️                     | ✅                  |
-| 0.7.x           | ✅️                     | ✅                  |
-| 0.8.x (current) | ✅                      | ✅                  |
-| 0.9.x (next)    | 🚧                      | 🚧                  |
-
-- ❌️: Not compatible
-- ✅: Compatible
-- 🚧: Work in progress
-
 ## Self-Host
 
 > We know that the self-host version has been out of date for a long time.

docs/reference/package.json

@@ -19,5 +19,5 @@
     ],
     "ext": "ts,md,json"
   },
-  "version": "0.10.3-canary.2"
+  "version": "0.12.0"
 }

nx.json

@@ -1,12 +1,13 @@
 {
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "npmScope": "toeverything",
+  "nxCloudAccessToken": "MzUwNTU4YWItZGFhYi00YjE2LWIxODAtODk4NmIwYjMwYzZkfHJlYWQ=",
   "tasksRunnerOptions": {
     "default": {
       "runner": "nx-cloud",
       "options": {
         "cacheableOperations": ["build", "test", "e2e", "lint"],
-        "accessToken": "YmQ2NTg1ODktZTk5Mi00YzhiLTk2ZmUtNWQzMDg0NDBkOWM3fHJlYWQtb25seQ=="
+        "runtimeCacheInputs": ["node -v"]
       }
     }
   },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affine/monorepo",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "private": true,
   "author": "toeverything",
   "license": "MIT",
@@ -37,7 +37,8 @@
     "test:ui": "vitest --ui",
     "test:coverage": "vitest run --coverage",
     "typecheck": "tsc -b tsconfig.json --diagnostics",
-    "postinstall": "node ./scripts/check-version.mjs && yarn i18n-codegen gen && yarn husky install"
+    "postinstall": "node ./scripts/check-version.mjs && yarn i18n-codegen gen && yarn husky install",
+    "prepare": "husky"
   },
   "lint-staged": {
     "*": "prettier --write --ignore-unknown --cache",
@@ -61,8 +62,7 @@
     "@istanbuljs/schema": "^0.1.3",
     "@magic-works/i18n-codegen": "^0.5.0",
     "@nx/vite": "17.2.8",
-    "@perfsee/sdk": "^1.9.0",
-    "@playwright/test": "^1.40.0",
+    "@playwright/test": "^1.41.0",
     "@taplo/cli": "^0.5.2",
     "@testing-library/react": "^14.1.2",
     "@toeverything/infra": "workspace:*",
@@ -76,7 +76,7 @@
     "@vitejs/plugin-react-swc": "^3.5.0",
     "@vitest/coverage-istanbul": "1.1.3",
     "@vitest/ui": "1.1.3",
-    "electron": "^27.1.0",
+    "electron": "^28.1.4",
     "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-i": "^2.29.0",
@@ -88,13 +88,12 @@
     "eslint-plugin-unused-imports": "^3.0.0",
     "eslint-plugin-vue": "^9.18.1",
     "fake-indexeddb": "5.0.2",
-    "happy-dom": "^12.10.3",
-    "husky": "^8.0.3",
+    "happy-dom": "^13.0.0",
+    "husky": "^9.0.6",
     "lint-staged": "^15.1.0",
     "msw": "^2.0.8",
     "nanoid": "^5.0.3",
-    "nx": "^17.1.3",
-    "nx-cloud": "^16.5.2",
+    "nx": "^17.2.8",
     "nyc": "^15.1.0",
     "oxlint": "0.0.22",
     "prettier": "^3.1.0",

packages/backend/server/.env.example

@@ -1,8 +1,4 @@
-DATABASE_URL="postgresql://affine@localhost:5432/affine"
-NEXTAUTH_URL="http://localhost:8080"
-OAUTH_EMAIL_SENDER="noreply@toeverything.info"
-OAUTH_EMAIL_LOGIN=""
-OAUTH_EMAIL_PASSWORD=""
-ENABLE_LOCAL_EMAIL="true"
-STRIPE_API_KEY=
-STRIPE_WEBHOOK_KEY=
+# AFFINE_SERVER_PORT=3010
+# AFFINE_SERVER_HOST=app.affine.pro
+# AFFINE_SERVER_HTTPS=true
+# DATABASE_URL="postgres://affine@localhost:5432/affine"

packages/backend/server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@affine/server",
   "private": true,
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Affine Node.js server",
   "type": "module",
   "bin": {
@@ -14,15 +14,16 @@
     "test": "ava --concurrency 1 --serial",
     "test:coverage": "c8 ava --concurrency 1 --serial",
     "postinstall": "prisma generate",
-    "data-migration": "node --loader ts-node/esm/transpile-only.mjs --es-module-specifier-resolution node ./src/data/app.ts",
-    "predeploy": "yarn prisma migrate deploy && node --es-module-specifier-resolution node ./dist/data/app.js run"
+    "data-migration": "node --loader ts-node/esm/transpile-only.mjs --es-module-specifier-resolution node ./src/data/index.ts",
+    "predeploy": "yarn prisma migrate deploy && node --es-module-specifier-resolution node ./dist/data/index.js run"
   },
   "dependencies": {
     "@apollo/server": "^4.9.5",
     "@auth/prisma-adapter": "^1.0.7",
-    "@aws-sdk/client-s3": "^3.454.0",
+    "@aws-sdk/client-s3": "^3.499.0",
     "@google-cloud/opentelemetry-cloud-monitoring-exporter": "^0.17.0",
     "@google-cloud/opentelemetry-cloud-trace-exporter": "^2.1.0",
+    "@google-cloud/opentelemetry-resource-util": "^2.1.0",
     "@keyv/redis": "^2.8.0",
     "@nestjs/apollo": "^12.0.11",
     "@nestjs/common": "^10.2.10",
@@ -39,20 +40,21 @@
     "@node-rs/crc32": "^1.7.2",
     "@node-rs/jsonwebtoken": "^0.3.0",
     "@opentelemetry/api": "^1.7.0",
-    "@opentelemetry/core": "^1.19.0",
-    "@opentelemetry/exporter-prometheus": "^0.46.0",
-    "@opentelemetry/exporter-zipkin": "^1.19.0",
+    "@opentelemetry/core": "^1.20.0",
+    "@opentelemetry/exporter-prometheus": "^0.47.0",
+    "@opentelemetry/exporter-zipkin": "^1.20.0",
     "@opentelemetry/host-metrics": "^0.34.0",
-    "@opentelemetry/instrumentation": "^0.46.0",
+    "@opentelemetry/instrumentation": "^0.47.0",
     "@opentelemetry/instrumentation-graphql": "^0.36.0",
-    "@opentelemetry/instrumentation-http": "^0.46.0",
+    "@opentelemetry/instrumentation-http": "^0.47.0",
     "@opentelemetry/instrumentation-ioredis": "^0.36.0",
     "@opentelemetry/instrumentation-nestjs-core": "^0.33.3",
     "@opentelemetry/instrumentation-socket.io": "^0.35.0",
-    "@opentelemetry/resources": "^1.19.0",
-    "@opentelemetry/sdk-metrics": "^1.19.0",
-    "@opentelemetry/sdk-node": "^0.46.0",
-    "@opentelemetry/sdk-trace-node": "^1.19.0",
+    "@opentelemetry/resources": "^1.20.0",
+    "@opentelemetry/sdk-metrics": "^1.20.0",
+    "@opentelemetry/sdk-node": "^0.47.0",
+    "@opentelemetry/sdk-trace-node": "^1.20.0",
+    "@opentelemetry/semantic-conventions": "^1.20.0",
     "@prisma/client": "^5.7.1",
     "@prisma/instrumentation": "^5.7.1",
     "@socket.io/redis-adapter": "^8.2.1",
@@ -63,6 +65,7 @@
     "file-type": "^19.0.0",
     "get-stream": "^8.0.1",
     "graphql": "^16.8.1",
+    "graphql-scalars": "^1.22.4",
     "graphql-type-json": "^0.3.2",
     "graphql-upload": "^16.0.2",
     "ioredis": "^5.3.2",

packages/backend/server/scripts/self-host-predeploy.js

@@ -0,0 +1,51 @@
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
+const SELF_HOST_CONFIG_DIR = '/root/.affine/config';
+/**
+ * @type {Array<{ from: string; to?: string, modifier?: (content: string): string }>}
+ */
+const configFiles = [
+  { from: './.env.example', to: '.env' },
+  { from: './dist/config/affine.js', modifier: configCleaner },
+  { from: './dist/config/affine.env.js', modifier: configCleaner },
+];
+
+function configCleaner(content) {
+  return content.replace(/(\/\/#.*$)|(\/\/\s+TODO.*$)/gm, '');
+}
+
+function prepare() {
+  fs.mkdirSync(SELF_HOST_CONFIG_DIR, { recursive: true });
+
+  for (const { from, to, modifier } of configFiles) {
+    const targetFileName = to ?? path.parse(from).base;
+    const targetFilePath = path.join(SELF_HOST_CONFIG_DIR, targetFileName);
+    if (!fs.existsSync(targetFilePath)) {
+      console.log(`creating config file [${targetFilePath}].`);
+      if (modifier) {
+        const content = fs.readFileSync(from, 'utf-8');
+        fs.writeFileSync(targetFilePath, modifier(content), 'utf-8');
+      } else {
+        fs.cpSync(from, targetFilePath, {
+          force: false,
+        });
+      }
+    }
+  }
+}
+
+function runPredeployScript() {
+  console.log('running predeploy script.');
+  execSync('yarn predeploy', {
+    env: {
+      ...process.env,
+      NODE_OPTIONS:
+        (process.env.NODE_OPTIONS ?? '') + ' --import ./dist/prelude.js',
+    },
+  });
+}
+
+prepare();
+runPredeployScript();

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

@@ -11,6 +11,7 @@ export class AppController {
     return {
       compatibility: this.config.version,
       message: `AFFiNE ${this.config.version} Server`,
+      flavor: this.config.flavor,
     };
   }
 }

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

@@ -0,0 +1,169 @@
+import { join } from 'node:path';
+
+import { Logger, Module } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+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 { FeatureModule } from './core/features';
+import { QuotaModule } from './core/quota';
+import { StorageModule } from './core/storage';
+import { SyncModule } from './core/sync';
+import { UsersModule } from './core/users';
+import { WorkspaceModule } from './core/workspaces';
+import { getOptionalModuleMetadata } from './fundamentals';
+import { CacheInterceptor, CacheModule } from './fundamentals/cache';
+import {
+  type AvailablePlugins,
+  Config,
+  ConfigModule,
+} from './fundamentals/config';
+import { EventModule } from './fundamentals/event';
+import { GqlModule } from './fundamentals/graphql';
+import { MailModule } from './fundamentals/mailer';
+import { MetricsModule } from './fundamentals/metrics';
+import { PrismaModule } from './fundamentals/prisma';
+import { SessionModule } from './fundamentals/session';
+import { RateLimiterModule } from './fundamentals/throttler';
+import { WebSocketModule } from './fundamentals/websocket';
+import { pluginsMap } from './plugins';
+
+export const FunctionalityModules = [
+  ConfigModule.forRoot(),
+  ScheduleModule.forRoot(),
+  EventModule,
+  CacheModule,
+  PrismaModule,
+  MetricsModule,
+  RateLimiterModule,
+  SessionModule,
+  MailModule,
+];
+
+export class AppModuleBuilder {
+  private readonly modules: AFFiNEModule[] = [];
+  constructor(private readonly config: Config) {}
+
+  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 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,
+    ...modules: AFFiNEModule[]
+  ): this {
+    if (predicator(this.config)) {
+      this.use(...modules);
+    }
+
+    return this;
+  }
+
+  compile() {
+    @Module({
+      providers: [
+        {
+          provide: APP_INTERCEPTOR,
+          useClass: CacheInterceptor,
+        },
+      ],
+      imports: this.modules,
+      controllers: this.config.flavor.selfhosted ? [] : [AppController],
+    })
+    class AppModule {}
+
+    return AppModule;
+  }
+}
+
+function buildAppModule() {
+  const factor = new AppModuleBuilder(AFFiNE);
+
+  factor
+    // common fundamental modules
+    .use(...FunctionalityModules)
+    // auth
+    .use(AuthModule)
+
+    // business modules
+    .use(DocModule)
+
+    // sync server only
+    .useIf(config => config.flavor.sync, SyncModule)
+
+    // main server only
+    .useIf(
+      config => config.flavor.main,
+      ServerConfigModule,
+      WebSocketModule,
+      GqlModule,
+      StorageModule,
+      UsersModule,
+      WorkspaceModule,
+      FeatureModule,
+      QuotaModule
+    )
+
+    // self hosted server only
+    .useIf(
+      config => config.flavor.selfhosted,
+      ServeStaticModule.forRoot({
+        rootPath: join('/app', 'static'),
+      })
+    );
+
+  // plugin modules
+  AFFiNE.plugins.enabled.forEach(name => {
+    const plugin = pluginsMap.get(name as AvailablePlugins);
+    if (!plugin) {
+      throw new Error(`Unknown plugin ${name}`);
+    }
+
+    factor.use(plugin);
+  });
+
+  return factor.compile();
+}
+
+export const AppModule = buildAppModule();

packages/backend/server/src/app.ts

@@ -1,38 +1,48 @@
-import { DynamicModule, Module, Type } from '@nestjs/common';
-import { APP_INTERCEPTOR } from '@nestjs/core';
+import { Type } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+import type { NestExpressApplication } from '@nestjs/platform-express';
+import cookieParser from 'cookie-parser';
+import graphqlUploadExpress from 'graphql-upload/graphqlUploadExpress.mjs';
 
-import { AppController } from './app.controller';
-import { CacheInterceptor, CacheModule } from './fundamentals/cache';
-import { ConfigModule } from './fundamentals/config';
-import { EventModule } from './fundamentals/event';
-import { MailModule } from './fundamentals/mailer';
-import { MetricsModule } from './fundamentals/metrics';
-import { PrismaModule } from './fundamentals/prisma';
-import { SessionModule } from './fundamentals/session';
-import { RateLimiterModule } from './fundamentals/throttler';
-import { BusinessModules } from './modules';
-import { AuthModule } from './modules/auth';
+import { SocketIoAdapter } from './fundamentals';
+import { SocketIoAdapterImpl } from './fundamentals/websocket';
+import { ExceptionLogger } from './middleware/exception-logger';
+import { serverTimingAndCache } from './middleware/timing';
 
-export const FunctionalityModules: Array<Type | DynamicModule> = [
-  ConfigModule.forRoot(),
-  CacheModule,
-  PrismaModule,
-  MetricsModule,
-  EventModule,
-  SessionModule,
-  RateLimiterModule,
-  AuthModule,
-  MailModule,
-];
+export async function createApp() {
+  const { AppModule } = await import('./app.module');
 
-@Module({
-  providers: [
-    {
-      provide: APP_INTERCEPTOR,
-      useClass: CacheInterceptor,
-    },
-  ],
-  imports: [...FunctionalityModules, ...BusinessModules],
-  controllers: [AppController],
-})
-export class AppModule {}
+  const app = await NestFactory.create<NestExpressApplication>(AppModule, {
+    cors: true,
+    rawBody: true,
+    bodyParser: true,
+    logger: AFFiNE.affine.stable ? ['log'] : ['verbose'],
+  });
+
+  app.use(serverTimingAndCache);
+
+  app.use(
+    graphqlUploadExpress({
+      // TODO: dynamic limit by quota
+      maxFileSize: 100 * 1024 * 1024,
+      maxFiles: 5,
+    })
+  );
+
+  app.useGlobalFilters(new ExceptionLogger());
+  app.use(cookieParser());
+
+  if (AFFiNE.flavor.sync) {
+    const SocketIoAdapter = app.get<Type<SocketIoAdapter>>(
+      SocketIoAdapterImpl,
+      {
+        strict: false,
+      }
+    );
+
+    const adapter = new SocketIoAdapter(app);
+    app.useWebSocketAdapter(adapter);
+  }
+
+  return app;
+}

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

@@ -21,20 +21,19 @@ AFFiNE.ENV_MAP = {
   OAUTH_EMAIL_PASSWORD: 'auth.email.password',
   THROTTLE_TTL: ['rateLimiter.ttl', 'int'],
   THROTTLE_LIMIT: ['rateLimiter.limit', 'int'],
-  REDIS_SERVER_ENABLED: ['redis.enabled', 'boolean'],
-  REDIS_SERVER_HOST: 'redis.host',
-  REDIS_SERVER_PORT: ['redis.port', 'int'],
-  REDIS_SERVER_USER: 'redis.username',
-  REDIS_SERVER_PASSWORD: 'redis.password',
-  REDIS_SERVER_DATABASE: ['redis.database', 'int'],
+  REDIS_SERVER_HOST: 'plugins.redis.host',
+  REDIS_SERVER_PORT: ['plugins.redis.port', 'int'],
+  REDIS_SERVER_USER: 'plugins.redis.username',
+  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.experimentalMergeWithJwstCodec',
     'boolean',
   ],
   ENABLE_LOCAL_EMAIL: ['auth.localEmail', 'boolean'],
-  STRIPE_API_KEY: 'payment.stripe.keys.APIKey',
-  STRIPE_WEBHOOK_KEY: 'payment.stripe.keys.webhookKey',
+  STRIPE_API_KEY: 'plugins.payment.stripe.keys.APIKey',
+  STRIPE_WEBHOOK_KEY: 'plugins.payment.stripe.keys.webhookKey',
   FEATURES_EARLY_ACCESS_PREVIEW: ['featureFlags.earlyAccessPreview', 'boolean'],
 };
 

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

@@ -1,36 +1,39 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 // Custom configurations
 const env = process.env;
-const node = AFFiNE.node;
 
 // TODO(@forehalo): detail explained
-AFFiNE.host = 'localhost';
-AFFiNE.port = 3010;
+// Storage
+if (env.R2_OBJECT_STORAGE_ACCOUNT_ID) {
+  AFFiNE.storage.providers.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 = 'r2';
+  AFFiNE.storage.storages.avatar.bucket = 'account-avatar';
+  AFFiNE.storage.storages.avatar.publicLinkFactory = key =>
+    `https://avatar.affineassets.com/${key}`;
 
-if (node.prod) {
-  AFFiNE.host = '0.0.0.0';
-  // Storage
-  if (env.R2_OBJECT_STORAGE_ACCOUNT_ID) {
-    AFFiNE.storage.providers.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 = 'r2';
-    AFFiNE.storage.storages.avatar.bucket = 'account-avatar';
-    AFFiNE.storage.storages.avatar.publicLinkFactory = key =>
-      `https://avatar.affineassets.com/${key}`;
-
-    AFFiNE.storage.storages.blob.provider = 'r2';
-    AFFiNE.storage.storages.blob.bucket = `workspace-blobs-${
-      AFFiNE.affine.canary ? 'canary' : 'prod'
-    }`;
-  }
-
-  // Metrics
-  AFFiNE.metrics.enabled = true;
+  AFFiNE.storage.storages.blob.provider = 'r2';
+  AFFiNE.storage.storages.blob.bucket = `workspace-blobs-${
+    AFFiNE.affine.canary ? 'canary' : 'prod'
+  }`;
 }
 
+// Metrics
+AFFiNE.metrics.enabled = true;
+
+// Plugins Section Start
+AFFiNE.plugins.use('payment', {
+  stripe: {
+    keys: {},
+    apiVersion: '2023-10-16',
+  },
+});
+AFFiNE.plugins.use('redis');
+// Plugins Section end
+
 export default AFFiNE;

packages/backend/server/src/core/auth/next-auth-options.ts

@@ -15,7 +15,7 @@ import {
   SessionService,
 } from '../../fundamentals';
 import { FeatureType } from '../features';
-import { Quota_FreePlanV1 } from '../quota';
+import { Quota_FreePlanV1_1 } from '../quota';
 import {
   decode,
   encode,
@@ -52,7 +52,7 @@ export const NextAuthOptionsProvider: FactoryProvider<NextAuthOptions> = {
             activated: true,
             feature: {
               connect: {
-                feature_version: Quota_FreePlanV1,
+                feature_version: Quota_FreePlanV1_1,
               },
             },
           },

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

@@ -17,7 +17,7 @@ import {
   PrismaService,
   verifyChallengeResponse,
 } from '../../fundamentals';
-import { Quota_FreePlanV1 } from '../quota';
+import { Quota_FreePlanV1_1 } from '../quota';
 
 export type UserClaim = Pick<
   User,
@@ -201,7 +201,7 @@ export class AuthService {
             activated: true,
             feature: {
               connect: {
-                feature_version: Quota_FreePlanV1,
+                feature_version: Quota_FreePlanV1_1,
               },
             },
           },
@@ -231,7 +231,7 @@ export class AuthService {
             activated: true,
             feature: {
               connect: {
-                feature_version: Quota_FreePlanV1,
+                feature_version: Quota_FreePlanV1_1,
               },
             },
           },

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

@@ -0,0 +1,58 @@
+import { Module } from '@nestjs/common';
+import { Field, ObjectType, Query, registerEnumType } from '@nestjs/graphql';
+
+export enum ServerFeature {
+  Payment = 'payment',
+}
+
+registerEnumType(ServerFeature, {
+  name: 'ServerFeature',
+});
+
+const ENABLED_FEATURES: ServerFeature[] = [];
+export function ADD_ENABLED_FEATURES(feature: ServerFeature) {
+  ENABLED_FEATURES.push(feature);
+}
+
+@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;
+
+  /**
+   * @deprecated
+   */
+  @Field({ description: 'server flavor', deprecationReason: 'use `features`' })
+  flavor!: string;
+
+  @Field(() => [ServerFeature], { description: 'enabled server features' })
+  features!: ServerFeature[];
+}
+export class ServerConfigResolver {
+  @Query(() => ServerConfigType, {
+    description: 'server config',
+  })
+  serverConfig(): ServerConfigType {
+    return {
+      name: AFFiNE.serverName,
+      version: AFFiNE.version,
+      baseUrl: AFFiNE.baseUrl,
+      flavor: AFFiNE.flavor.type,
+      features: ENABLED_FEATURES,
+    };
+  }
+}
+
+@Module({
+  providers: [ServerConfigResolver],
+})
+export class ServerConfigModule {}

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

@@ -4,6 +4,7 @@ import {
   OnModuleDestroy,
   OnModuleInit,
 } from '@nestjs/common';
+import { Cron, CronExpression } from '@nestjs/schedule';
 import { Snapshot, Update } from '@prisma/client';
 import { chunk } from 'lodash-es';
 import { defer, retry } from 'rxjs';
@@ -83,6 +84,7 @@ export function isEmptyBuffer(buf: Buffer): boolean {
 }
 
 const MAX_SEQ_NUM = 0x3fffffff; // u31
+const UPDATES_QUEUE_CACHE_KEY = 'doc:manager:updates';
 
 /**
  * Since we can't directly save all client updates into database, in which way the database will overload,
@@ -667,26 +669,44 @@ export class DocManager implements OnModuleInit, OnModuleDestroy {
     count: number
   ) {
     const result = await this.cache.mapIncrease(
-      `doc:manager:updates`,
+      UPDATES_QUEUE_CACHE_KEY,
       `${workspaceId}::${guid}`,
       count
     );
 
     if (result <= 0) {
       await this.cache.mapDelete(
-        `doc:manager:updates`,
+        UPDATES_QUEUE_CACHE_KEY,
         `${workspaceId}::${guid}`
       );
     }
   }
 
   private async getAutoSquashCandidateFromCache() {
-    const key = await this.cache.mapRandomKey('doc:manager:updates');
+    const key = await this.cache.mapRandomKey(UPDATES_QUEUE_CACHE_KEY);
 
     if (key) {
-      const count = await this.cache.mapGet<number>('doc:manager:updates', key);
-      if (typeof count === 'number' && count > 0) {
+      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 };
       }
     }
@@ -694,22 +714,38 @@ export class DocManager implements OnModuleInit, OnModuleDestroy {
     return null;
   }
 
-  private async doWithLock<T>(lock: string, job: () => Promise<T>) {
+  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).catch(e => {
-        // safe, the lock will be expired when ttl ends
-        this.logger.error(`Failed to release lock ${lock}`, e);
-      });
+      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);
+        });
     }
   }
 
@@ -719,7 +755,8 @@ export class DocManager implements OnModuleInit, OnModuleDestroy {
     job: () => Promise<T>
   ) {
     return this.doWithLock(
-      `doc:manager:updates-lock:${workspaceId}::${guid}`,
+      'doc:manager:updates',
+      `${workspaceId}::${guid}`,
       job
     );
   }
@@ -730,8 +767,16 @@ export class DocManager implements OnModuleInit, OnModuleDestroy {
     job: () => Promise<T>
   ) {
     return this.doWithLock(
-      `doc:manager:snapshot-lock:${workspaceId}::${guid}`,
+      'doc:manager:snapshot',
+      `${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/features/feature.ts

@@ -50,7 +50,7 @@ export class UnlimitedWorkspaceFeatureConfig extends FeatureConfig {
     super(data);
 
     if (this.config.feature !== FeatureType.UnlimitedWorkspace) {
-      throw new Error('Invalid feature config: type is not EarlyAccess');
+      throw new Error('Invalid feature config: type is not UnlimitedWorkspace');
     }
   }
 }

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

@@ -47,22 +47,26 @@ export class FeatureManagementService {
     return this.feature.listFeatureUsers(FeatureType.EarlyAccess);
   }
 
+  async isEarlyAccessUser(email: string) {
+    const user = await this.prisma.user.findFirst({
+      where: {
+        email,
+      },
+    });
+    if (user) {
+      const canEarlyAccess = await this.feature
+        .hasUserFeature(user.id, FeatureType.EarlyAccess)
+        .catch(() => false);
+
+      return canEarlyAccess;
+    }
+    return false;
+  }
+
   /// check early access by email
   async canEarlyAccess(email: string) {
     if (this.config.featureFlags.earlyAccessPreview && !this.isStaff(email)) {
-      const user = await this.prisma.user.findFirst({
-        where: {
-          email,
-        },
-      });
-      if (user) {
-        const canEarlyAccess = await this.feature
-          .hasUserFeature(user.id, FeatureType.EarlyAccess)
-          .catch(() => false);
-
-        return canEarlyAccess;
-      }
-      return false;
+      return this.isEarlyAccessUser(email);
     } else {
       return true;
     }

packages/backend/server/src/core/features/types/early-access.ts

@@ -4,5 +4,8 @@ import { FeatureType } from './common';
 
 export const featureEarlyAccess = z.object({
   feature: z.literal(FeatureType.EarlyAccess),
-  configs: z.object({}),
+  configs: z.object({
+    // field polyfill, make it optional in the future
+    whitelist: z.string().array(),
+  }),
 });

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

@@ -42,7 +42,9 @@ export const Features: Feature[] = [
     feature: FeatureType.EarlyAccess,
     type: FeatureKind.Feature,
     version: 2,
-    configs: {},
+    configs: {
+      whitelist: [],
+    },
   },
   {
     feature: FeatureType.UnlimitedWorkspace,

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

@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
 
+import { FeatureModule } from '../features';
 import { StorageModule } from '../storage';
 import { PermissionService } from '../workspaces/permission';
 import { QuotaService } from './service';
@@ -12,13 +13,12 @@ import { QuotaManagementService } from './storage';
  * - quota statistics
  */
 @Module({
-  // FIXME: Quota really need to know `Storage`?
-  imports: [StorageModule],
+  imports: [FeatureModule, StorageModule],
   providers: [PermissionService, QuotaService, QuotaManagementService],
   exports: [QuotaService, QuotaManagementService],
 })
 export class QuotaModule {}
 
 export { QuotaManagementService, QuotaService };
-export { Quota_FreePlanV1, Quota_ProPlanV1, Quotas } from './schema';
-export { QuotaType } from './types';
+export { Quota_FreePlanV1_1, Quota_ProPlanV1, Quotas } from './schema';
+export { QuotaQueryType, QuotaType } from './types';

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

@@ -44,6 +44,10 @@ export class QuotaConfig {
     }
   }
 
+  get version() {
+    return this.config.version;
+  }
+
   /// feature name of quota
   get name() {
     return this.config.feature;

packages/backend/server/src/core/quota/schema.ts

@@ -54,11 +54,28 @@ export const Quotas: Quota[] = [
       memberLimit: 10,
     },
   },
+  {
+    feature: QuotaType.FreePlanV1,
+    type: FeatureKind.Quota,
+    version: 2,
+    configs: {
+      // quota name
+      name: 'Free',
+      // single blob limit 10MB
+      blobLimit: 100 * OneMB,
+      // total blob limit 10GB
+      storageQuota: 10 * OneGB,
+      // history period of validity 7 days
+      historyPeriod: 7 * OneDay,
+      // member limit 3
+      memberLimit: 3,
+    },
+  },
 ];
 
-export const Quota_FreePlanV1 = {
-  feature: Quotas[0].feature,
-  version: Quotas[0].version,
+export const Quota_FreePlanV1_1 = {
+  feature: Quotas[3].feature,
+  version: Quotas[3].version,
 };
 
 export const Quota_ProPlanV1 = {

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

@@ -1,10 +1,12 @@
 import { Injectable } from '@nestjs/common';
 
-import { PrismaService } from '../../fundamentals';
+import { type EventPayload, OnEvent, PrismaService } from '../../fundamentals';
 import { FeatureKind } from '../features';
 import { QuotaConfig } from './quota';
 import { QuotaType } from './types';
 
+type Transaction = Parameters<Parameters<PrismaService['$transaction']>[0]>[0];
+
 @Injectable()
 export class QuotaService {
   constructor(private readonly prisma: PrismaService) {}
@@ -83,6 +85,13 @@ export class QuotaService {
     expiredAt?: Date
   ) {
     await this.prisma.$transaction(async tx => {
+      const hasSameActivatedQuota = await this.hasQuota(userId, quota, tx);
+
+      if (hasSameActivatedQuota) {
+        // don't need to switch
+        return;
+      }
+
       const latestPlanVersion = await tx.features.aggregate({
         where: {
           feature: quota,
@@ -130,8 +139,10 @@ export class QuotaService {
     });
   }
 
-  async hasQuota(userId: string, quota: QuotaType) {
-    return this.prisma.userFeatures
+  async hasQuota(userId: string, quota: QuotaType, transaction?: Transaction) {
+    const executor = transaction ?? this.prisma;
+
+    return executor.userFeatures
       .count({
         where: {
           userId,
@@ -144,4 +155,26 @@ export class QuotaService {
       })
       .then(count => count > 0);
   }
+
+  @OnEvent('user.subscription.activated')
+  async onSubscriptionUpdated({
+    userId,
+  }: EventPayload<'user.subscription.activated'>) {
+    await this.switchUserQuota(
+      userId,
+      QuotaType.ProPlanV1,
+      'subscription activated'
+    );
+  }
+
+  @OnEvent('user.subscription.canceled')
+  async onSubscriptionCanceled(
+    userId: EventPayload<'user.subscription.canceled'>
+  ) {
+    await this.switchUserQuota(
+      userId,
+      QuotaType.FreePlanV1,
+      'subscription canceled'
+    );
+  }
 }

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

@@ -1,12 +1,16 @@
 import { Injectable, NotFoundException } from '@nestjs/common';
 
+import { FeatureService, FeatureType } from '../features';
 import { WorkspaceBlobStorage } from '../storage';
 import { PermissionService } from '../workspaces/permission';
+import { OneGB } from './constant';
 import { QuotaService } from './service';
+import { formatSize, QuotaQueryType } from './types';
 
 @Injectable()
 export class QuotaManagementService {
   constructor(
+    private readonly feature: FeatureService,
     private readonly quota: QuotaService,
     private readonly permissions: PermissionService,
     private readonly storage: WorkspaceBlobStorage
@@ -40,21 +44,64 @@ export class QuotaManagementService {
 
   // get workspace's owner quota and total size of used
   // quota was apply to owner's account
-  async getWorkspaceUsage(workspaceId: string) {
+  async getWorkspaceUsage(workspaceId: string): Promise<QuotaQueryType> {
     const { user: owner } =
       await this.permissions.getWorkspaceOwner(workspaceId);
     if (!owner) throw new NotFoundException('Workspace owner not found');
-    const { storageQuota, blobLimit } = await this.getUserQuota(owner.id);
+    const {
+      feature: {
+        name,
+        blobLimit,
+        historyPeriod,
+        memberLimit,
+        storageQuota,
+        humanReadable,
+      },
+    } = await this.quota.getUserQuota(owner.id);
     // get all workspaces size of owner used
-    const usageSize = await this.getUserUsage(owner.id);
+    const usedSize = await this.getUserUsage(owner.id);
 
-    return { quota: storageQuota, size: usageSize, limit: blobLimit };
+    const quota = {
+      name,
+      blobLimit,
+      historyPeriod,
+      memberLimit,
+      storageQuota,
+      humanReadable,
+      usedSize,
+    };
+
+    // relax restrictions if workspace has unlimited feature
+    // todo(@darkskygit): need a mechanism to allow feature as a middleware to edit quota
+    const unlimited = await this.feature.hasWorkspaceFeature(
+      workspaceId,
+      FeatureType.UnlimitedWorkspace
+    );
+    if (unlimited) {
+      return this.mergeUnlimitedQuota(quota);
+    }
+
+    return quota;
+  }
+
+  private mergeUnlimitedQuota(orig: QuotaQueryType) {
+    return {
+      ...orig,
+      storageQuota: 1000 * OneGB,
+      memberLimit: 1000,
+      humanReadable: {
+        ...orig.humanReadable,
+        name: 'Unlimited',
+        storageQuota: formatSize(1000 * OneGB),
+        memberLimit: '1000',
+      },
+    };
   }
 
   async checkBlobQuota(workspaceId: string, size: number) {
-    const { quota, size: usageSize } =
+    const { storageQuota, usedSize } =
       await this.getWorkspaceUsage(workspaceId);
 
-    return quota - (size + usageSize);
+    return storageQuota - (size + usedSize);
   }
 }

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

@@ -1,3 +1,5 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+import { SafeIntResolver } from 'graphql-scalars';
 import { z } from 'zod';
 
 import { commonFeatureSchema, FeatureKind } from '../features';
@@ -5,6 +7,13 @@ import { ByteUnit, OneDay, OneKB } from './constant';
 
 /// ======== quota define ========
 
+/**
+ * naming rule:
+ * we append Vx to the end of the feature name to indicate the version of the feature
+ * x is a number, start from 1, this number will be change only at the time we change the schema of config
+ * for example, we change the value of `blobLimit` from 10MB to 100MB, then we will only change `version` field from 1 to 2
+ * but if we remove the `blobLimit` field or rename it, then we will change the Vx to Vx+1
+ */
 export enum QuotaType {
   FreePlanV1 = 'free_plan_v1',
   ProPlanV1 = 'pro_plan_v1',
@@ -37,6 +46,50 @@ export const QuotaSchema = commonFeatureSchema
 
 export type Quota = z.infer<typeof QuotaSchema>;
 
+/// ======== query types ========
+
+@ObjectType()
+export class HumanReadableQuotaType {
+  @Field(() => String)
+  name!: string;
+
+  @Field(() => String)
+  blobLimit!: string;
+
+  @Field(() => String)
+  storageQuota!: string;
+
+  @Field(() => String)
+  historyPeriod!: string;
+
+  @Field(() => String)
+  memberLimit!: string;
+}
+
+@ObjectType()
+export class QuotaQueryType {
+  @Field(() => String)
+  name!: string;
+
+  @Field(() => SafeIntResolver)
+  blobLimit!: number;
+
+  @Field(() => SafeIntResolver)
+  historyPeriod!: number;
+
+  @Field(() => SafeIntResolver)
+  memberLimit!: number;
+
+  @Field(() => SafeIntResolver)
+  storageQuota!: number;
+
+  @Field(() => HumanReadableQuotaType)
+  humanReadable!: HumanReadableQuotaType;
+
+  @Field(() => SafeIntResolver)
+  usedSize!: number;
+}
+
 /// ======== utils ========
 
 export function formatSize(bytes: number, decimals: number = 2): string {

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

@@ -1,7 +1,4 @@
-import { Readable } from 'node:stream';
-
-import type { Storage } from '@affine/storage';
-import { Injectable, OnModuleInit } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 
 import type {
   BlobInputType,
@@ -12,20 +9,13 @@ import {
   Config,
   createStorageProvider,
   EventEmitter,
-  OctoBaseStorageModule,
   OnEvent,
-  toBuffer,
 } from '../../../fundamentals';
 
 @Injectable()
-export class WorkspaceBlobStorage implements OnModuleInit {
+export class WorkspaceBlobStorage {
   public readonly provider: StorageProvider;
 
-  /**
-   * @deprecated for backwards compatibility, need to be removed in next stable release
-   */
-  private octobase: Storage | null = null;
-
   constructor(
     private readonly event: EventEmitter,
     private readonly config: Config
@@ -33,42 +23,12 @@ export class WorkspaceBlobStorage implements OnModuleInit {
     this.provider = createStorageProvider(this.config.storage, 'blob');
   }
 
-  async onModuleInit() {
-    if (!this.config.node.test) {
-      this.octobase = await OctoBaseStorageModule.Storage.connect(
-        this.config.db.url
-      );
-    }
-  }
-
   async put(workspaceId: string, key: string, blob: BlobInputType) {
-    const buf = await toBuffer(blob);
-    await this.provider.put(`${workspaceId}/${key}`, buf);
-    if (this.octobase) {
-      await this.octobase.uploadBlob(workspaceId, buf);
-    }
+    await this.provider.put(`${workspaceId}/${key}`, blob);
   }
 
   async get(workspaceId: string, key: string) {
-    const result = await this.provider.get(`${workspaceId}/${key}`);
-    if (!result.body && this.octobase) {
-      const blob = await this.octobase.getBlob(workspaceId, key);
-
-      if (!blob) {
-        return result;
-      }
-
-      return {
-        body: Readable.from(blob.data),
-        metadata: {
-          contentType: blob.contentType,
-          contentLength: blob.size,
-          lastModified: new Date(blob.lastModified),
-        },
-      };
-    }
-
-    return result;
+    return this.provider.get(`${workspaceId}/${key}`);
   }
 
   async list(workspaceId: string) {

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

@@ -112,6 +112,9 @@ export class UserResolver {
     const user = await this.users.findUserByEmail(email);
     if (currentUser) return user;
 
+    // return empty response when user not exists
+    if (!user) return null;
+
     // only return limited info when not logged in
     return {
       email: user?.email,

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

@@ -1,5 +1,6 @@
-import { createUnionType, Field, Float, ID, ObjectType } from '@nestjs/graphql';
+import { createUnionType, Field, ID, ObjectType } from '@nestjs/graphql';
 import type { User } from '@prisma/client';
+import { SafeIntResolver } from 'graphql-scalars';
 
 @ObjectType('UserQuotaHumanReadable')
 export class UserQuotaHumanReadableType {
@@ -24,13 +25,13 @@ export class UserQuotaType {
   @Field({ name: 'name' })
   name!: string;
 
-  @Field(() => Float, { name: 'blobLimit' })
+  @Field(() => SafeIntResolver, { name: 'blobLimit' })
   blobLimit!: number;
 
-  @Field(() => Float, { name: 'storageQuota' })
+  @Field(() => SafeIntResolver, { name: 'storageQuota' })
   storageQuota!: number;
 
-  @Field(() => Float, { name: 'historyPeriod' })
+  @Field(() => SafeIntResolver, { name: 'historyPeriod' })
   historyPeriod!: number;
 
   @Field({ name: 'memberLimit' })

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

@@ -119,7 +119,8 @@ export class WorkspaceManagementResolver {
   async availableFeatures(
     @CurrentUser() user: UserType
   ): Promise<FeatureType[]> {
-    if (await this.feature.canEarlyAccess(user.email)) {
+    const isEarlyAccessUser = await this.feature.isEarlyAccessUser(user.email);
+    if (isEarlyAccessUser) {
       return [FeatureType.Copilot];
     } else {
       return [];

packages/backend/server/src/core/workspaces/resolvers/blob.ts

@@ -1,7 +1,6 @@
 import { HttpStatus, Logger, UseGuards } from '@nestjs/common';
 import {
   Args,
-  Float,
   Int,
   Mutation,
   Parent,
@@ -10,6 +9,7 @@ import {
   Resolver,
 } from '@nestjs/graphql';
 import { GraphQLError } from 'graphql';
+import { SafeIntResolver } from 'graphql-scalars';
 import GraphQLUpload from 'graphql-upload/GraphQLUpload.mjs';
 
 import {
@@ -100,7 +100,7 @@ export class WorkspaceBlobResolver {
   async checkBlobSize(
     @CurrentUser() user: UserType,
     @Args('workspaceId') workspaceId: string,
-    @Args('size', { type: () => Float }) blobSize: number
+    @Args('size', { type: () => SafeIntResolver }) blobSize: number
   ) {
     const canWrite = await this.permissions.tryCheckWorkspace(
       workspaceId,
@@ -128,7 +128,7 @@ export class WorkspaceBlobResolver {
       Permission.Write
     );
 
-    const { quota, size, limit } =
+    const { storageQuota, usedSize, blobLimit } =
       await this.quota.getWorkspaceUsage(workspaceId);
 
     const unlimited = await this.feature.hasWorkspaceFeature(
@@ -137,7 +137,7 @@ export class WorkspaceBlobResolver {
     );
 
     const checkExceeded = (recvSize: number) => {
-      if (!quota) {
+      if (!storageQuota) {
         throw new GraphQLError('cannot find user quota', {
           extensions: {
             status: HttpStatus[HttpStatus.FORBIDDEN],
@@ -145,13 +145,15 @@ export class WorkspaceBlobResolver {
           },
         });
       }
-      const total = size + recvSize;
+      const total = usedSize + recvSize;
       // only skip total storage check if workspace has unlimited feature
-      if (total > quota && !unlimited) {
-        this.logger.log(`storage size limit exceeded: ${total} > ${quota}`);
+      if (total > storageQuota && !unlimited) {
+        this.logger.log(
+          `storage size limit exceeded: ${total} > ${storageQuota}`
+        );
         return true;
-      } else if (recvSize > limit) {
-        this.logger.log(`blob size limit exceeded: ${recvSize} > ${limit}`);
+      } else if (recvSize > blobLimit) {
+        this.logger.log(`blob size limit exceeded: ${recvSize} > ${blobLimit}`);
         return true;
       } else {
         return false;

packages/backend/server/src/core/workspaces/resolvers/workspace.ts

@@ -30,8 +30,7 @@ import {
 } from '../../../fundamentals';
 import { Auth, CurrentUser, Public } from '../../auth';
 import { AuthService } from '../../auth/service';
-import { FeatureManagementService, FeatureType } from '../../features';
-import { QuotaManagementService } from '../../quota';
+import { QuotaManagementService, QuotaQueryType } from '../../quota';
 import { WorkspaceBlobStorage } from '../../storage';
 import { UsersService, UserType } from '../../users';
 import { PermissionService } from '../permission';
@@ -60,7 +59,6 @@ export class WorkspaceResolver {
     private readonly mailer: MailService,
     private readonly prisma: PrismaService,
     private readonly permissions: PermissionService,
-    private readonly feature: FeatureManagementService,
     private readonly quota: QuotaManagementService,
     private readonly users: UsersService,
     private readonly event: EventEmitter,
@@ -149,6 +147,15 @@ export class WorkspaceResolver {
       }));
   }
 
+  @ResolveField(() => QuotaQueryType, {
+    name: 'quota',
+    description: 'quota of workspace',
+    complexity: 2,
+  })
+  workspaceQuota(@Parent() workspace: WorkspaceType) {
+    return this.quota.getWorkspaceUsage(workspace.id);
+  }
+
   @Query(() => Boolean, {
     description: 'Get is owner of workspace',
     complexity: 2,
@@ -329,26 +336,20 @@ export class WorkspaceResolver {
       throw new ForbiddenException('Cannot change owner');
     }
 
-    const unlimited = await this.feature.hasWorkspaceFeature(
-      workspaceId,
-      FeatureType.UnlimitedWorkspace
-    );
-    if (!unlimited) {
-      // member limit check
-      const [memberCount, quota] = await Promise.all([
-        this.prisma.workspaceUserPermission.count({
-          where: { workspaceId },
-        }),
-        this.quota.getUserQuota(user.id),
-      ]);
-      if (memberCount >= quota.memberLimit) {
-        throw new GraphQLError('Workspace member limit reached', {
-          extensions: {
-            status: HttpStatus[HttpStatus.PAYLOAD_TOO_LARGE],
-            code: HttpStatus.PAYLOAD_TOO_LARGE,
-          },
-        });
-      }
+    // member limit check
+    const [memberCount, quota] = await Promise.all([
+      this.prisma.workspaceUserPermission.count({
+        where: { workspaceId },
+      }),
+      this.quota.getWorkspaceUsage(workspaceId),
+    ]);
+    if (memberCount >= quota.memberLimit) {
+      throw new GraphQLError('Workspace member limit reached', {
+        extensions: {
+          status: HttpStatus[HttpStatus.PAYLOAD_TOO_LARGE],
+          code: HttpStatus.PAYLOAD_TOO_LARGE,
+        },
+      });
     }
 
     let target = await this.users.findUserByEmail(email);

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

@@ -1,6 +1,5 @@
 import {
   Field,
-  Float,
   ID,
   InputType,
   ObjectType,
@@ -10,6 +9,7 @@ import {
   registerEnumType,
 } from '@nestjs/graphql';
 import type { Workspace } from '@prisma/client';
+import { SafeIntResolver } from 'graphql-scalars';
 
 import { UserType } from '../users/types';
 
@@ -78,7 +78,7 @@ export class InvitationWorkspaceType {
 
 @ObjectType()
 export class WorkspaceBlobSizes {
-  @Field(() => Float)
+  @Field(() => SafeIntResolver)
   size!: number;
 }
 

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

@@ -1,9 +1,6 @@
-import '../prelude';
+import { Module } from '@nestjs/common';
 
-import { Logger, Module } from '@nestjs/common';
-import { CommandFactory } from 'nest-commander';
-
-import { AppModule as BusinessAppModule } from '../app';
+import { AppModule as BusinessAppModule } from '../app.module';
 import { ConfigModule } from '../fundamentals/config';
 import { CreateCommand, NameQuestion } from './commands/create';
 import { RevertCommand, RunCommand } from './commands/run';
@@ -16,19 +13,12 @@ import { RevertCommand, RunCommand } from './commands/run';
           enableUpdateAutoMerging: false,
         },
       },
+      metrics: {
+        enabled: false,
+      },
     }),
     BusinessAppModule,
   ],
   providers: [NameQuestion, CreateCommand, RunCommand, RevertCommand],
 })
-class AppModule {}
-
-async function bootstrap() {
-  await CommandFactory.run(AppModule, new Logger()).catch(e => {
-    console.error(e);
-    process.exit(1);
-  });
-  process.exit(0);
-}
-
-await bootstrap();
+export class CliAppModule {}

packages/backend/server/src/data/index.ts

@@ -0,0 +1,16 @@
+import '../prelude';
+
+import { Logger } from '@nestjs/common';
+import { CommandFactory } from 'nest-commander';
+
+import { CliAppModule } from './app';
+
+async function bootstrap() {
+  await CommandFactory.run(CliAppModule, new Logger()).catch(e => {
+    console.error(e);
+    process.exit(1);
+  });
+  process.exit(0);
+}
+
+await bootstrap();

packages/backend/server/src/data/migrations/1605053000403-self-host-admin.ts

@@ -0,0 +1,39 @@
+import { ModuleRef } from '@nestjs/core';
+import { hash } from '@node-rs/argon2';
+import { PrismaClient } from '@prisma/client';
+
+import { Config } from '../../fundamentals';
+
+export class SelfHostAdmin1605053000403 {
+  // do the migration
+  static async up(db: PrismaClient, ref: ModuleRef) {
+    const config = ref.get(Config, { strict: false });
+    if (config.flavor.selfhosted) {
+      if (
+        !process.env.AFFINE_ADMIN_EMAIL ||
+        !process.env.AFFINE_ADMIN_PASSWORD
+      ) {
+        throw new Error(
+          'You have to set AFFINE_ADMIN_EMAIL and AFFINE_ADMIN_PASSWORD environment variables to generate the initial user for self-hosted AFFiNE Server.'
+        );
+      }
+      await db.user.create({
+        data: {
+          name: 'AFFINE First User',
+          email: process.env.AFFINE_ADMIN_EMAIL,
+          emailVerified: new Date(),
+          password: await hash(process.env.AFFINE_ADMIN_PASSWORD),
+        },
+      });
+    }
+  }
+
+  // revert the migration
+  static async down(db: PrismaClient) {
+    await db.user.deleteMany({
+      where: {
+        email: process.env.AFFINE_ADMIN_EMAIL ?? 'admin@example.com',
+      },
+    });
+  }
+}

packages/backend/server/src/data/migrations/1698398506533-guid.ts

@@ -1,7 +1,7 @@
 import { PrismaClient } from '@prisma/client';
 import { applyUpdate, Doc, encodeStateAsUpdate } from 'yjs';
 
-import { DocID } from '../../modules/utils/doc';
+import { DocID } from '../../core/utils/doc';
 
 export class Guid1698398506533 {
   // do the migration

packages/backend/server/src/data/migrations/1698652531198-user-features-init.ts

@@ -1,7 +1,7 @@
 import { PrismaClient } from '@prisma/client';
 
-import { Features } from '../../modules/features';
-import { Quotas } from '../../modules/quota/schema';
+import { Features } from '../../core/features';
+import { Quotas } from '../../core/quota/schema';
 import { migrateNewFeatureTable, upsertFeature } from './utils/user-features';
 
 export class UserFeaturesInit1698652531198 {

packages/backend/server/src/data/migrations/1702620653283-old-user-feature.ts

@@ -1,6 +1,6 @@
 import { PrismaClient } from '@prisma/client';
 
-import { QuotaType } from '../../modules/quota/types';
+import { QuotaType } from '../../core/quota/types';
 export class OldUserFeature1702620653283 {
   // do the migration
   static async up(db: PrismaClient) {
@@ -16,7 +16,6 @@ export class OldUserFeature1702620653283 {
         where: { NOT: { features: { some: { NOT: { id: { gt: 0 } } } } } },
         select: { id: true },
       });
-      console.log(`migrating ${userIds.join('|')} users`);
 
       await tx.userFeatures.createMany({
         data: userIds.map(({ id: userId }) => ({

packages/backend/server/src/data/migrations/1703756315970-unamed-account.ts

@@ -1,6 +1,4 @@
-import { PrismaClient } from '@prisma/client';
-
-import type { UserType } from '../../modules/users';
+import { PrismaClient, type User } from '@prisma/client';
 
 export class UnamedAccount1703756315970 {
   // do the migration
@@ -8,7 +6,7 @@ export class UnamedAccount1703756315970 {
     await db.$transaction(async tx => {
       // only find users with empty names
       const users = await db.$queryRaw<
-        UserType[]
+        User[]
       >`SELECT * FROM users WHERE name ~ E'^[\\s\\u2000-\\u200F]*$';`;
       console.log(
         `renaming ${users.map(({ email }) => email).join('|')} users`

packages/backend/server/src/data/migrations/1703828796699-workspace-blobs.ts

@@ -1,7 +1,7 @@
 import { ModuleRef } from '@nestjs/core';
 import { PrismaClient } from '@prisma/client';
 
-import { WorkspaceBlobStorage } from '../../modules/storage';
+import { WorkspaceBlobStorage } from '../../core/storage';
 
 export class WorkspaceBlobs1703828796699 {
   // do the migration

packages/backend/server/src/data/migrations/1704352562369-refresh-user-features.ts

@@ -1,6 +1,6 @@
 import { PrismaClient } from '@prisma/client';
 
-import { Features } from '../../modules/features';
+import { Features } from '../../core/features';
 import { upsertFeature } from './utils/user-features';
 
 export class RefreshUserFeatures1704352562369 {

packages/backend/server/src/data/migrations/1705395933447-new-free-plan.ts

@@ -0,0 +1,67 @@
+import { PrismaClient } from '@prisma/client';
+
+import { FeatureKind } from '../../core/features';
+import { Quotas } from '../../core/quota';
+import { upsertFeature } from './utils/user-features';
+
+export class NewFreePlan1705395933447 {
+  // do the migration
+  static async up(db: PrismaClient) {
+    // add new free plan
+    await upsertFeature(db, Quotas[3]);
+    // migrate all free plan users to new free plan
+    await db.$transaction(async tx => {
+      const latestFreePlan = await tx.features.findFirstOrThrow({
+        where: { feature: Quotas[3].feature },
+        orderBy: { version: 'desc' },
+        select: { id: true },
+      });
+
+      // find all users that have old free plan
+      const userIds = await db.user.findMany({
+        where: {
+          features: {
+            every: {
+              feature: {
+                type: FeatureKind.Quota,
+                feature: Quotas[3].feature,
+                version: { lt: Quotas[3].version },
+              },
+              activated: true,
+            },
+          },
+        },
+        select: { id: true },
+      });
+
+      // deactivate all old quota for the user
+      await tx.userFeatures.updateMany({
+        where: {
+          id: undefined,
+          userId: {
+            in: userIds.map(({ id }) => id),
+          },
+          feature: {
+            type: FeatureKind.Quota,
+          },
+          activated: true,
+        },
+        data: {
+          activated: false,
+        },
+      });
+
+      await tx.userFeatures.createMany({
+        data: userIds.map(({ id: userId }) => ({
+          userId,
+          featureId: latestFreePlan.id,
+          reason: 'free plan 1.0 migration',
+          activated: true,
+        })),
+      });
+    });
+  }
+
+  // revert the migration
+  static async down(_db: PrismaClient) {}
+}

packages/backend/server/src/data/migrations/utils/user-features.ts

@@ -4,7 +4,7 @@ import {
   CommonFeature,
   FeatureKind,
   FeatureType,
-} from '../../../modules/features';
+} from '../../../core/features';
 
 // upgrade features from lower version to higher version
 export async function upsertFeature(

packages/backend/server/src/fundamentals/cache/def.ts

@@ -0,0 +1,51 @@
+export interface CacheSetOptions {
+  /**
+   * in milliseconds
+   */
+  ttl?: number;
+}
+
+// extends if needed
+export interface Cache {
+  // standard operation
+  get<T = unknown>(key: string): Promise<T | undefined>;
+  set<T = unknown>(
+    key: string,
+    value: T,
+    opts?: CacheSetOptions
+  ): Promise<boolean>;
+  setnx<T = unknown>(
+    key: string,
+    value: T,
+    opts?: CacheSetOptions
+  ): Promise<boolean>;
+  increase(key: string, count?: number): Promise<number>;
+  decrease(key: string, count?: number): Promise<number>;
+  delete(key: string): Promise<boolean>;
+  has(key: string): Promise<boolean>;
+  ttl(key: string): Promise<number>;
+  expire(key: string, ttl: number): Promise<boolean>;
+
+  // list operations
+  pushBack<T = unknown>(key: string, ...values: T[]): Promise<number>;
+  pushFront<T = unknown>(key: string, ...values: T[]): Promise<number>;
+  len(key: string): Promise<number>;
+  list<T = unknown>(key: string, start: number, end: number): Promise<T[]>;
+  popFront<T = unknown>(key: string, count?: number): Promise<T[]>;
+  popBack<T = unknown>(key: string, count?: number): Promise<T[]>;
+
+  // map operations
+  mapSet<T = unknown>(
+    map: string,
+    key: string,
+    value: T,
+    opts: CacheSetOptions
+  ): Promise<boolean>;
+  mapIncrease(map: string, key: string, count?: number): Promise<number>;
+  mapDecrease(map: string, key: string, count?: number): Promise<number>;
+  mapGet<T = unknown>(map: string, key: string): Promise<T | undefined>;
+  mapDelete(map: string, key: string): Promise<boolean>;
+  mapKeys(map: string): Promise<string[]>;
+  mapRandomKey(map: string): Promise<string | undefined>;
+  mapLen(map: string): Promise<number>;
+}

packages/backend/server/src/fundamentals/cache/index.ts

@@ -1,35 +1,13 @@
-import { Global, Module, Provider, Type } from '@nestjs/common';
-import { Redis } from 'ioredis';
+import { Global, Module } from '@nestjs/common';
 
-import { SessionCache, ThrottlerCache } from './instances';
-import { LocalCache } from './providers/cache';
-import { RedisCache } from './providers/redis';
-import { CacheRedis, RedisModule, SessionRedis, ThrottlerRedis } from './redis';
-
-function makeCacheProvider(CacheToken: Type, RedisToken: Type): Provider {
-  return {
-    provide: CacheToken,
-    useFactory: (redis?: Redis) => {
-      return redis ? new RedisCache(redis) : new LocalCache();
-    },
-    inject: [{ token: RedisToken, optional: true }],
-  };
-}
-
-const CacheProvider = makeCacheProvider(LocalCache, CacheRedis);
-const SessionCacheProvider = makeCacheProvider(SessionCache, SessionRedis);
-const ThrottlerCacheProvider = makeCacheProvider(
-  ThrottlerCache,
-  ThrottlerRedis
-);
+import { Cache, SessionCache } from './instances';
 
 @Global()
 @Module({
-  imports: AFFiNE.redis.enabled ? [RedisModule] : [],
-  providers: [CacheProvider, SessionCacheProvider, ThrottlerCacheProvider],
-  exports: [CacheProvider, SessionCacheProvider, ThrottlerCacheProvider],
+  providers: [Cache, SessionCache],
+  exports: [Cache, SessionCache],
 })
 export class CacheModule {}
-export { LocalCache as Cache, SessionCache, ThrottlerCache };
+export { Cache, SessionCache };
 
 export { CacheInterceptor, MakeCache, PreventCache } from './interceptor';

packages/backend/server/src/fundamentals/cache/instances.ts

@@ -1,4 +1,13 @@
-import { LocalCache } from './providers/cache';
+import { Injectable } from '@nestjs/common';
 
-export class SessionCache extends LocalCache {}
-export class ThrottlerCache extends LocalCache {}
+import { LocalCache } from './local';
+
+@Injectable()
+export class Cache extends LocalCache {}
+
+@Injectable()
+export class SessionCache extends LocalCache {
+  constructor() {
+    super({ namespace: 'session' });
+  }
+}

packages/backend/server/src/fundamentals/cache/interceptor.ts

@@ -10,7 +10,7 @@ import { Reflector } from '@nestjs/core';
 import { GqlContextType, GqlExecutionContext } from '@nestjs/graphql';
 import { mergeMap, Observable, of } from 'rxjs';
 
-import { LocalCache } from './providers/cache';
+import { Cache } from './instances';
 
 export const MakeCache = (key: string[], args?: string[]) =>
   SetMetadata('cacheKey', [key, args]);
@@ -24,7 +24,7 @@ export class CacheInterceptor implements NestInterceptor {
   private readonly logger = new Logger(CacheInterceptor.name);
   constructor(
     private readonly reflector: Reflector,
-    private readonly cache: LocalCache
+    private readonly cache: Cache
   ) {}
   async intercept(
     ctx: ExecutionContext,
@@ -40,9 +40,9 @@ export class CacheInterceptor implements NestInterceptor {
     );
 
     if (preventKey) {
-      this.logger.debug(`prevent cache: ${JSON.stringify(preventKey)}`);
       const key = await this.getCacheKey(ctx, preventKey);
       if (key) {
+        this.logger.debug(`cache ${key} staled`);
         await this.cache.delete(key);
       }
 
@@ -60,12 +60,12 @@ export class CacheInterceptor implements NestInterceptor {
     const cachedData = await this.cache.get(cacheKey);
 
     if (cachedData) {
-      this.logger.debug('cache hit', cacheKey, cachedData);
+      this.logger.debug(`cache ${cacheKey} hit`);
       return of(cachedData);
     } else {
+      this.logger.debug(`cache ${cacheKey} miss`);
       return next.handle().pipe(
         mergeMap(async result => {
-          this.logger.debug('cache miss', cacheKey, result);
           await this.cache.set(cacheKey, result);
 
           return result;

packages/backend/server/src/fundamentals/cache/local.ts

@@ -1,57 +1,7 @@
-import { Injectable } from '@nestjs/common';
 import Keyv from 'keyv';
 
-export interface CacheSetOptions {
-  // in milliseconds
-  ttl?: number;
-}
+import type { Cache, CacheSetOptions } from './def';
 
-// extends if needed
-export interface Cache {
-  // standard operation
-  get<T = unknown>(key: string): Promise<T | undefined>;
-  set<T = unknown>(
-    key: string,
-    value: T,
-    opts?: CacheSetOptions
-  ): Promise<boolean>;
-  setnx<T = unknown>(
-    key: string,
-    value: T,
-    opts?: CacheSetOptions
-  ): Promise<boolean>;
-  increase(key: string, count?: number): Promise<number>;
-  decrease(key: string, count?: number): Promise<number>;
-  delete(key: string): Promise<boolean>;
-  has(key: string): Promise<boolean>;
-  ttl(key: string): Promise<number>;
-  expire(key: string, ttl: number): Promise<boolean>;
-
-  // list operations
-  pushBack<T = unknown>(key: string, ...values: T[]): Promise<number>;
-  pushFront<T = unknown>(key: string, ...values: T[]): Promise<number>;
-  len(key: string): Promise<number>;
-  list<T = unknown>(key: string, start: number, end: number): Promise<T[]>;
-  popFront<T = unknown>(key: string, count?: number): Promise<T[]>;
-  popBack<T = unknown>(key: string, count?: number): Promise<T[]>;
-
-  // map operations
-  mapSet<T = unknown>(
-    map: string,
-    key: string,
-    value: T,
-    opts: CacheSetOptions
-  ): Promise<boolean>;
-  mapIncrease(map: string, key: string, count?: number): Promise<number>;
-  mapDecrease(map: string, key: string, count?: number): Promise<number>;
-  mapGet<T = unknown>(map: string, key: string): Promise<T | undefined>;
-  mapDelete(map: string, key: string): Promise<boolean>;
-  mapKeys(map: string): Promise<string[]>;
-  mapRandomKey(map: string): Promise<string | undefined>;
-  mapLen(map: string): Promise<number>;
-}
-
-@Injectable()
 export class LocalCache implements Cache {
   private readonly kv: Keyv;
 

packages/backend/server/src/fundamentals/cache/redis/index.ts

@@ -1,38 +0,0 @@
-import { Global, Injectable, Module, OnModuleDestroy } from '@nestjs/common';
-import { Redis as IORedis } from 'ioredis';
-
-import { Config } from '../../config';
-
-class Redis extends IORedis implements OnModuleDestroy {
-  onModuleDestroy() {
-    this.disconnect();
-  }
-}
-
-@Injectable()
-export class CacheRedis extends Redis {
-  constructor(config: Config) {
-    super({ ...config.redis, db: config.redis.database });
-  }
-}
-
-@Injectable()
-export class ThrottlerRedis extends Redis {
-  constructor(config: Config) {
-    super({ ...config.redis, db: config.redis.database + 1 });
-  }
-}
-
-@Injectable()
-export class SessionRedis extends Redis {
-  constructor(config: Config) {
-    super({ ...config.redis, db: config.redis.database + 2 });
-  }
-}
-
-@Global()
-@Module({
-  providers: [CacheRedis, ThrottlerRedis, SessionRedis],
-  exports: [CacheRedis, ThrottlerRedis, SessionRedis],
-})
-export class RedisModule {}

packages/backend/server/src/fundamentals/config/def.ts

@@ -18,22 +18,28 @@ export enum ExternalAccount {
   firebase = 'firebase',
 }
 
-export type ServerFlavor = 'allinone' | 'graphql' | 'sync' | 'selfhosted';
-type ConfigPaths = LeafPaths<
+export type ServerFlavor =
+  | 'allinone'
+  | 'main'
+  // @deprecated
+  | 'graphql'
+  | 'sync'
+  | 'selfhosted';
+export type ConfigPaths = LeafPaths<
   Omit<
     AFFiNEConfig,
     | 'ENV_MAP'
     | 'version'
-    | 'baseUrl'
-    | 'origin'
-    | 'prod'
-    | 'dev'
-    | 'test'
+    | 'flavor'
+    | 'env'
+    | 'affine'
     | 'deploy'
     | 'node'
+    | 'baseUrl'
+    | 'origin'
   >,
   '',
-  '....'
+  '.....'
 >;
 
 /**
@@ -45,15 +51,28 @@ export interface AFFiNEConfig {
   /**
    * Server Identity
    */
-  readonly serverId: string;
+  serverId: string;
+
+  /**
+   * Name may show on the UI
+   */
+  serverName: string;
+
   /**
    * System version
    */
   readonly version: string;
+
   /**
    * Server flavor
    */
-  readonly flavor: ServerFlavor;
+  get flavor(): {
+    type: string;
+    main: boolean;
+    sync: boolean;
+    selfhosted: boolean;
+  };
+
   /**
    * Deployment environment
    */
@@ -165,38 +184,6 @@ export interface AFFiNEConfig {
     limit: number;
   };
 
-  /**
-   * Redis Config
-   *
-   * whether to use redis as Socket.IO adapter
-   */
-  redis: {
-    /**
-     * if not enabled, use in-memory adapter by default
-     */
-    enabled: boolean;
-    /**
-     * url of redis host
-     */
-    host: string;
-    /**
-     * port of redis
-     */
-    port: number;
-    username: string;
-    password: string;
-    /**
-     * redis database index
-     *
-     * Rate Limiter scope: database + 1
-     *
-     * Session scope: database + 2
-     *
-     * @default 0
-     */
-    database: number;
-  };
-
   /**
    * authentication config
    */
@@ -334,15 +321,6 @@ export interface AFFiNEConfig {
   metrics: {
     enabled: boolean;
   };
-
-  payment: {
-    stripe: {
-      keys: {
-        APIKey: string;
-        webhookKey: string;
-      };
-    } & import('stripe').Stripe.StripeConfig;
-  };
 }
 
 export * from './storage';

packages/backend/server/src/fundamentals/config/default.ts

@@ -2,6 +2,7 @@
 
 import { createPrivateKey, createPublicKey } from 'node:crypto';
 
+import { merge } from 'lodash-es';
 import parse from 'parse-duration';
 
 import pkg from '../../../package.json' assert { type: 'json' };
@@ -46,11 +47,22 @@ const jwtKeyPair = (function () {
 
 export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => {
   let isHttps: boolean | null = null;
-  const flavor = (process.env.SERVER_FLAVOR ?? 'allinone') as ServerFlavor;
+  let flavor = (process.env.SERVER_FLAVOR ?? 'allinone') as ServerFlavor;
   const defaultConfig = {
     serverId: 'affine-nestjs-server',
+    serverName: flavor === 'selfhosted' ? 'Self-Host Cloud' : 'AFFiNE Cloud',
     version: pkg.version,
-    flavor,
+    get flavor() {
+      if (flavor === 'graphql') {
+        flavor = 'main';
+      }
+      return {
+        type: flavor,
+        main: flavor === 'main' || flavor === 'allinone',
+        sync: flavor === 'sync' || flavor === 'allinone',
+        selfhosted: flavor === 'selfhosted',
+      };
+    },
     ENV_MAP: {},
     affineEnv: 'dev',
     get affine() {
@@ -92,7 +104,9 @@ export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => {
       return this.node.dev
         ? 'http://localhost:8080'
         : `${this.https ? 'https' : 'http'}://${this.host}${
-            this.host === 'localhost' ? `:${this.port}` : ''
+            this.host === 'localhost' || this.host === '0.0.0.0'
+              ? `:${this.port}`
+              : ''
           }`;
     },
     get baseUrl() {
@@ -140,15 +154,7 @@ export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => {
     storage: getDefaultAFFiNEStorageConfig(),
     rateLimiter: {
       ttl: 60,
-      limit: 60,
-    },
-    redis: {
-      enabled: false,
-      host: '127.0.0.1',
-      port: 6379,
-      username: '',
-      password: '',
-      database: 0,
+      limit: 120,
     },
     doc: {
       manager: {
@@ -160,18 +166,16 @@ export const getDefaultAFFiNEConfig: () => AFFiNEConfig = () => {
         interval: 1000 * 60 * 10 /* 10 mins */,
       },
     },
-    payment: {
-      stripe: {
-        keys: {
-          APIKey: '',
-          webhookKey: '',
-        },
-        apiVersion: '2023-10-16',
-      },
-    },
     metrics: {
       enabled: false,
     },
+    plugins: {
+      enabled: [],
+      use(plugin, config) {
+        this[plugin] = merge(this[plugin], config || {});
+        this.enabled.push(plugin);
+      },
+    },
   } satisfies AFFiNEConfig;
 
   return defaultConfig;