toeverything · graphite-app · May 28, 2024 · May 28, 2024
diff --git a/packages/backend/server/migrations/20240520055805_runtime_setting/migration.sql b/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;
diff --git a/packages/backend/server/schema.prisma b/packages/backend/server/schema.prisma
@@ -22,15 +22,16 @@ model User {
  /// 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 UserFeatures[]
+ customer UserStripeCustomer?
+ subscriptions UserSubscription[]
+ invoices UserInvoice[]
+ workspacePermissions WorkspaceUserPermission[]
+ pagePermissions WorkspacePageUserPermission[]
+ connectedAccounts ConnectedAccount[]
+ sessions UserSession[]
+ aiSessions AiSession[]
+ updatedRuntimeConfigs RuntimeConfig[]
 
  @@index([email])
  @@map("users")
@@ -505,3 +506,28 @@ model DataMigration {
 
  @@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(6)
+ deletedAt DateTime? @map("deleted_at") @db.Timestamptz(6)
+ lastUpdatedBy String? @map("last_updated_by") @db.VarChar(36)
+
+ lastUpdatedByUser User? @relation(fields: [lastUpdatedBy], references: [id])
+
+ @@unique([module, key])
+ @@map("app_runtime_settings")
+}
diff --git a/packages/backend/server/src/app.module.ts b/packages/backend/server/src/app.module.ts
@@ -17,8 +17,11 @@ 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 { EventModule } from './fundamentals/event';
 import { GqlModule } from './fundamentals/graphql';
 import { HelpersModule } from './fundamentals/helpers';
@@ -30,6 +33,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(),
@@ -47,7 +51,7 @@ export const FunctionalityModules = [
 
 export class AppModuleBuilder {
  private readonly modules: AFFiNEModule[] = [];
- constructor(private readonly config: Config) {}
+ constructor(private readonly config: AFFiNEConfig) {}
 
  use(...modules: AFFiNEModule[]): this {
  modules.forEach(m => {
@@ -90,7 +94,7 @@ export class AppModuleBuilder {
  }
 
  useIf(
- predicator: (config: Config) => boolean,
+ predicator: (config: AFFiNEConfig) => boolean,
  ...modules: AFFiNEModule[]
  ): this {
  if (predicator(this.config)) {
@@ -112,6 +116,7 @@ export class AppModuleBuilder {
 }
 
 function buildAppModule() {
+ AFFiNE = mergeConfigOverride(AFFiNE);
  const factor = new AppModuleBuilder(AFFiNE);
 
  factor
@@ -147,8 +152,8 @@ function buildAppModule() {
  );
 
  // 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}`);
  }

diff --git a/packages/backend/server/src/app.ts b/packages/backend/server/src/app.ts
@@ -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;

diff --git a/packages/backend/server/src/config/affine.env.ts b/packages/backend/server/src/config/affine.env.ts
@@ -1,31 +1,22 @@
 // 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',
- 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',
+ 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'],
+ 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_CLIENT_ID: 'plugins.oauth.providers.oidc.clientId',
+ OAUTH_OIDC_CLIENT_SECRET: 'plugins.oauth.providers.oidc.clientSecret',
  METRICS_CUSTOMER_IO_TOKEN: ['metrics.customerIo.token', 'string'],
  COPILOT_OPENAI_API_KEY: 'plugins.copilot.openai.apiKey',
  COPILOT_FAL_API_KEY: 'plugins.copilot.fal.apiKey',
@@ -36,16 +27,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'],
 };
diff --git a/packages/backend/server/src/config/affine.self.ts b/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.use('redis', {
+ host: env.REDIS_SERVER_HOST,
+ db: 0,
+ port: 6379,
+ username: env.REDIS_SERVER_USER,
+ password: env.REDIS_SERVER_PASSWORD,
 });
-AFFiNE.plugins.use('redis');
-AFFiNE.plugins.use('payment', {
+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,7 @@ AFFiNE.plugins.use('payment', {
  },
  },
 });
-AFFiNE.plugins.use('oauth');
+AFFiNE.use('oauth');
 
 if (AFFiNE.deploy) {
  AFFiNE.mailer = {
@@ -68,5 +80,5 @@ if (AFFiNE.deploy) {
  },
  };
 
- AFFiNE.plugins.use('gcloud');
+ AFFiNE.use('gcloud');
 }