feat(server): runtime setting support (#5602)

---

<details open="true"><summary>Generated summary (powered by <a href="https://app.graphite.dev">Graphite</a>)</summary>

> ## TL;DR
> This pull request adds a new migration file, a new model, and new modules related to runtime settings. It also introduces a new `Runtime` service that allows getting, setting, and updating runtime configurations.
>
> ## What changed
> - Added a new migration file `migration.sql` that creates a table called `application_settings` with columns `key` and `value`.
> - Added a new model `ApplicationSetting` with properties `key` and `value`.
> - Added a new module `RuntimeSettingModule` that exports the `Runtime` service.
> - Added a new service `Runtime` that provides methods for getting, setting, and updating runtime configurations.
> - Modified the `app.module.ts` file to import the `RuntimeSettingModule`.
> - Modified the `index.ts` file in the `fundamentals` directory to export the `Runtime` service.
> - Added a new file `def.ts` in the `runtime` directory that defines the runtime configurations and provides a default implementation.
> - Added a new file `service.ts` in the `runtime` directory that implements the `Runtime` service.
>
> ## How to test
> 1. Run the migration script to create the `application_settings` table.
> 2. Use the `Runtime` service to get, set, and update runtime configurations.
> 3. Verify that the runtime configurations are stored correctly in the database and can be retrieved and modified using the `Runtime` service.
>
> ## Why make this change
> This change introduces a new feature related to runtime settings. The `Runtime` service allows the application to dynamically manage and modify runtime configurations without requiring a restart. This provides flexibility and allows for easier customization and configuration of the application.
</details>

packages/backend/server/src/plugins/copilot/config.ts

@@ -0,0 +1,26 @@
+import type { ClientOptions as OpenAIClientOptions } from 'openai';
+
+import { defineStartupConfig, ModuleConfig } from '../../fundamentals/config';
+import { StorageConfig } from '../../fundamentals/storage/config';
+import type { FalConfig } from './providers/fal';
+
+export interface CopilotStartupConfigurations {
+  openai?: OpenAIClientOptions;
+  fal?: FalConfig;
+  test?: never;
+  unsplashKey?: string;
+  storage: StorageConfig;
+}
+
+declare module '../config' {
+  interface PluginsConfig {
+    copilot: ModuleConfig<CopilotStartupConfigurations>;
+  }
+}
+
+defineStartupConfig('plugins.copilot', {
+  storage: {
+    provider: 'fs',
+    bucket: 'copilot',
+  },
+});

packages/backend/server/src/plugins/copilot/index.ts

@@ -1,3 +1,5 @@
+import './config';
+
 import { ServerFeature } from '../../core/config';
 import { FeatureModule } from '../../core/features';
 import { QuotaModule } from '../../core/quota';
@@ -43,5 +45,3 @@ registerCopilotProvider(OpenAIProvider);
   },
 })
 export class CopilotModule {}
-
-export type { CopilotConfig } from './types';

packages/backend/server/src/plugins/copilot/providers/index.ts

@@ -2,16 +2,17 @@ import assert from 'node:assert';
 
 import { Injectable, Logger } from '@nestjs/common';
 
-import { Config } from '../../../fundamentals';
+import { AFFiNEConfig, Config } from '../../../fundamentals';
+import { CopilotStartupConfigurations } from '../config';
 import {
   CapabilityToCopilotProvider,
   CopilotCapability,
-  CopilotConfig,
   CopilotProvider,
   CopilotProviderType,
 } from '../types';
 
-type CopilotProviderConfig = CopilotConfig[keyof CopilotConfig];
+type CopilotProviderConfig =
+  CopilotStartupConfigurations[keyof CopilotStartupConfigurations];
 
 interface CopilotProviderDefinition<C extends CopilotProviderConfig> {
   // constructor signature
@@ -37,7 +38,10 @@ const PROVIDER_CAPABILITY_MAP = new Map<
 >();
 
 // config assertions for providers
-const ASSERT_CONFIG = new Map<CopilotProviderType, (config: Config) => void>();
+const ASSERT_CONFIG = new Map<
+  CopilotProviderType,
+  (config: AFFiNEConfig) => void
+>();
 
 export function registerCopilotProvider<
   C extends CopilotProviderConfig = CopilotProviderConfig,
@@ -69,7 +73,7 @@ export function registerCopilotProvider<
     PROVIDER_CAPABILITY_MAP.set(capability, providers);
   }
   // register the provider config assertion
-  ASSERT_CONFIG.set(type, (config: Config) => {
+  ASSERT_CONFIG.set(type, (config: AFFiNEConfig) => {
     assert(config.plugins.copilot);
     const providerConfig = config.plugins.copilot[type];
     if (!providerConfig) return false;
@@ -89,7 +93,7 @@ export function unregisterCopilotProvider(type: CopilotProviderType) {
 }
 
 /// Asserts that the config is valid for any registered providers
-export function assertProvidersConfigs(config: Config) {
+export function assertProvidersConfigs(config: AFFiNEConfig) {
   return (
     Array.from(ASSERT_CONFIG.values()).findIndex(assertConfig =>
       assertConfig(config)

packages/backend/server/src/plugins/copilot/storage.ts

@@ -9,6 +9,7 @@ import {
   type FileUpload,
   type StorageProvider,
   StorageProviderFactory,
+  URLHelper,
 } from '../../fundamentals';
 
 @Injectable()
@@ -17,10 +18,13 @@ export class CopilotStorage {
 
   constructor(
     private readonly config: Config,
+    private readonly url: URLHelper,
     private readonly storageFactory: StorageProviderFactory,
     private readonly quota: QuotaManagementService
   ) {
-    this.provider = this.storageFactory.create('copilot');
+    this.provider = this.storageFactory.create(
+      this.config.plugins.copilot.storage
+    );
   }
 
   async put(
@@ -35,7 +39,7 @@ export class CopilotStorage {
       // return image base64url for dev environment
       return `data:image/png;base64,${blob.toString('base64')}`;
     }
-    return `${this.config.baseUrl}/api/copilot/blob/${name}`;
+    return this.url.link(`/api/copilot/blob/${name}`);
   }
 
   async get(userId: string, workspaceId: string, key: string) {

packages/backend/server/src/plugins/copilot/types.ts

@@ -1,18 +1,9 @@
 import { type Tokenizer } from '@affine/server-native';
 import { AiPromptRole } from '@prisma/client';
-import type { ClientOptions as OpenAIClientOptions } from 'openai';
 import { z } from 'zod';
 
 import { fromModelName } from '../../native';
 import type { ChatPrompt } from './prompt';
-import type { FalConfig } from './providers/fal';
-
-export interface CopilotConfig {
-  openai: OpenAIClientOptions;
-  fal: FalConfig;
-  unsplashKey: string;
-  test: never;
-}
 
 export enum AvailableModels {
   // text to text