feat(server): runtime setting support

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

@@ -0,0 +1,7 @@
+-- CreateTable
+CREATE TABLE "application_settings" (
+ "key" VARCHAR(36) NOT NULL,
+ "value" TEXT NOT NULL,
+
+ CONSTRAINT "application_settings_pkey" PRIMARY KEY ("key")
+);

packages/backend/server/schema.prisma

@@ -429,3 +429,11 @@ model DataMigration {
 
  @@map("_data_migrations")
 }
+
+model ApplicationSetting {
+ key String @id @db.VarChar(36)
+ // JSON strinfied value
+ value String @db.Text
+
+ @@map("application_settings")
+}

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

@@ -29,6 +29,7 @@ import { HelpersModule } from './fundamentals/helpers';
 import { MailModule } from './fundamentals/mailer';
 import { MetricsModule } from './fundamentals/metrics';
 import { PrismaModule } from './fundamentals/prisma';
+import { RuntimeSettingModule } from './fundamentals/runtime';
 import { StorageProviderModule } from './fundamentals/storage';
 import { RateLimiterModule } from './fundamentals/throttler';
 import { WebSocketModule } from './fundamentals/websocket';
@@ -45,6 +46,7 @@ export const FunctionalityModules = [
  MailModule,
  StorageProviderModule,
  HelpersModule,
+ RuntimeSettingModule,
 ];
 
 export class AppModuleBuilder {

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

@@ -22,6 +22,7 @@ export {
  GlobalExceptionFilter,
  OptionalModule,
 } from './nestjs';
+export { Runtime } from './runtime';
 export * from './storage';
 export { type StorageProvider, StorageProviderFactory } from './storage';
 export { AuthThrottlerGuard, CloudThrottlerGuard, Throttle } from './throttler';

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

@@ -0,0 +1,36 @@
+import { Injectable, Provider } from '@nestjs/common';
+
+import { Config } from '../config';
+
+export interface RuntimeConfigs {
+ enablePayment: boolean;
+ defaultPasswordLogin: boolean;
+}
+
+export type RuntimeConfigKey = keyof RuntimeConfigs;
+export type RuntimeConfig<T extends RuntimeConfigKey> = RuntimeConfigs[T];
+
+@Injectable()
+export class DefaultRuntimeConfigs implements RuntimeConfigs {
+ enablePayment = true;
+ enableQuota = true;
+ defaultPasswordLogin = false;
+}
+
+export class SelfHostDefaultRuntimeConfigs extends DefaultRuntimeConfigs {
+ override enablePayment = false;
+ override enableQuota = false;
+ override defaultPasswordLogin = true;
+}
+
+export const DefaultRuntimeConfigsProvider: Provider = {
+ provide: DefaultRuntimeConfigs,
+ useFactory: (config: Config) => {
+ if (config.flavor === 'selfhosted') {
+ return new SelfHostDefaultRuntimeConfigs();
+ } else {
+ return new DefaultRuntimeConfigs();
+ }
+ },
+ inject: [Config],
+};

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

@@ -0,0 +1,12 @@
+import { Global, Module } from '@nestjs/common';
+
+import { DefaultRuntimeConfigsProvider } from './def';
+import { Runtime } from './service';
+
+@Global()
+@Module({
+ providers: [Runtime, DefaultRuntimeConfigsProvider],
+ exports: [Runtime],
+})
+export class RuntimeSettingModule {}
+export { Runtime };

packages/backend/server/src/fundamentals/runtime/service.ts

@@ -0,0 +1,107 @@
+import { PrismaClient } from '@prisma/client';
+
+import { Cache } from '../cache';
+import { Config } from '../config';
+import {
+ DefaultRuntimeConfigs,
+ type RuntimeConfig,
+ type RuntimeConfigKey,
+} from './def';
+
+/**
+ * runtime.get(k)
+ * runtime.set(k, v)
+ * runtime.update(k, (v) => {
+ *
+ * })
+ */
+export class Runtime {
+ constructor(
+ public readonly config: Config,
+ private readonly db: PrismaClient,
+ private readonly cache: Cache,
+ private readonly defaultConfigs: DefaultRuntimeConfigs
+ ) {}
+
+ async get<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K
+ ): Promise<V> {
+ const cached = await this.loadCache<K, V>(k);
+
+ if (cached) {
+ return cached;
+ }
+
+ const dbValue = await this.loadDb<K, V>(k);
+
+ if (!dbValue) {
+ throw new Error(`Runtime config ${k} not found`);
+ }
+
+ await this.setCache(k, dbValue);
+
+ return dbValue;
+ }
+
+ async set<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K,
+ v: V
+ ) {
+ await this.db.applicationSetting.upsert({
+ where: {
+ key: k,
+ },
+ create: {
+ key: k,
+ value: JSON.stringify(v),
+ },
+ update: {
+ value: JSON.stringify(v),
+ },
+ });
+
+ await this.setCache(k, v);
+ }
+
+ async update<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K,
+ modifier: (v: V) => V | Promise<V>
+ ) {
+ const data = await this.loadDb<K, V>(k);
+
+ const updated = await modifier(data);
+
+ await this.set(k, updated);
+
+ return updated;
+ }
+
+ async loadDb<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K
+ ): Promise<V> {
+ const v = await this.db.applicationSetting.findUnique({
+ where: {
+ key: k,
+ },
+ });
+
+ if (v) {
+ return JSON.parse(v.value);
+ } else {
+ return this.defaultConfigs[k] as V;
+ }
+ }
+
+ async loadCache<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K
+ ): Promise<V | undefined> {
+ return this.cache.get<V>(`runtime:${k}`);
+ }
+
+ async setCache<K extends RuntimeConfigKey, V extends RuntimeConfig<K>>(
+ k: K,
+ v: V
+ ): Promise<boolean> {
+ return this.cache.set<V>(k, v, { ttl: 60 * 1000 });
+ }
+}