refactor(server): plugin modules (#5630)

- [x] separates modules into `fundamental`, `core`, `plugins`
- [x] optional modules with `@OptionalModule` decorator to install modules with requirements met(`requires`, `if`)
- [x] `module.contributesTo` defines optional features that will be enabled if module registered
- [x] `AFFiNE.plugins.use('payment', {})` to enable a optional/plugin module
- [x] `PaymentModule` is the first plugin module
- [x] GraphQLSchema will not be generated for non-included modules
- [x] Frontend can use `ServerConfigType` query to detect which features are enabled
- [x] override existing provider globally

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,32 +1,38 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 // Custom configurations
 const env = process.env;
-const node = AFFiNE.node;
 
 // TODO(@forehalo): detail explained
-if (node.prod) {
-  // 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}`;
+// 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: {
+    apiVersion: '2023-10-16',
+  },
+});
+AFFiNE.plugins.use('redis');
+// Plugins Section end
+
 export default AFFiNE;