AFFiNE/packages/backend/server/src/plugins/registry.ts
forehalo 638fc62601
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>
2024-05-28 06:43:53 +00:00

31 lines
929 B
TypeScript

import { get, merge, omit, set } from 'lodash-es';
import { OptionalModule, OptionalModuleMetadata } from '../fundamentals/nestjs';
import { AvailablePlugins } from './config';
export const REGISTERED_PLUGINS = new Map<AvailablePlugins, AFFiNEModule>();
export const ENABLED_PLUGINS = new Set<AvailablePlugins>();
function registerPlugin(plugin: AvailablePlugins, module: AFFiNEModule) {
REGISTERED_PLUGINS.set(plugin, module);
}
interface PluginModuleMetadata extends OptionalModuleMetadata {
name: AvailablePlugins;
}
export const Plugin = (options: PluginModuleMetadata) => {
return (target: any) => {
registerPlugin(options.name, target);
return OptionalModule(omit(options, 'name'))(target);
};
};
export function enablePlugin(plugin: AvailablePlugins, config: any = {}) {
config = merge(get(AFFiNE.plugins, plugin), config);
set(AFFiNE.plugins, plugin, config);
ENABLED_PLUGINS.add(plugin);
}