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>
This commit is contained in:
forehalo
2024-05-28 06:43:53 +00:00
parent 9d296c4b62
commit 638fc62601
116 changed files with 1907 additions and 1106 deletions

View File

@@ -130,7 +130,7 @@ test('should not be able to sign in if forbidden', async t => {
await request(app.getHttpServer())
.post('/api/auth/sign-in')
.send({ email: u1.email })
.expect(HttpStatus.PAYMENT_REQUIRED);
.expect(HttpStatus.BAD_REQUEST);
t.true(mailer.sendSignInMail.notCalled);

View File

@@ -1,15 +1,13 @@
import { Test, TestingModule } from '@nestjs/testing';
import { TestingModule } from '@nestjs/testing';
import test from 'ava';
import { Cache, CacheModule } from '../src/fundamentals/cache';
import { ConfigModule } from '../src/fundamentals/config';
import { Cache } from '../src/fundamentals/cache';
import { createTestingModule } from './utils';
let cache: Cache;
let module: TestingModule;
test.beforeEach(async () => {
module = await Test.createTestingModule({
imports: [ConfigModule.forRoot(), CacheModule],
}).compile();
module = await createTestingModule();
const prefix = Math.random().toString(36).slice(2, 7);
cache = new Proxy(module.get(Cache), {
get(target, prop) {

View File

@@ -1,14 +1,13 @@
import { Test, TestingModule } from '@nestjs/testing';
import { TestingModule } from '@nestjs/testing';
import test from 'ava';
import { Config, ConfigModule } from '../src/fundamentals/config';
import { createTestingModule } from './utils';
let config: Config;
let module: TestingModule;
test.beforeEach(async () => {
module = await Test.createTestingModule({
imports: [ConfigModule.forRoot()],
}).compile();
module = await createTestingModule();
config = module.get(Config);
});
@@ -17,19 +16,21 @@ test.afterEach.always(async () => {
});
test('should be able to get config', t => {
t.true(typeof config.host === 'string');
t.true(typeof config.server.host === 'string');
t.is(config.NODE_ENV, 'test');
});
test('should be able to override config', async t => {
const module = await Test.createTestingModule({
const module = await createTestingModule({
imports: [
ConfigModule.forRoot({
host: 'testing',
server: {
host: 'testing',
},
}),
],
}).compile();
});
const config = module.get(Config);
t.is(config.host, 'testing');
t.is(config.server.host, 'testing');
});

View File

@@ -10,7 +10,7 @@ import { DocManager, DocModule } from '../src/core/doc';
import { QuotaModule } from '../src/core/quota';
import { StorageModule } from '../src/core/storage';
import { Config } from '../src/fundamentals/config';
import { createTestingModule, initTestingDB } from './utils';
import { createTestingModule } from './utils';
const createModule = () => {
return createTestingModule({
@@ -28,7 +28,6 @@ test.beforeEach(async () => {
});
m = await createModule();
await m.init();
await initTestingDB(m.get(PrismaClient));
});
test.afterEach.always(async () => {

View File

@@ -15,7 +15,7 @@ import {
import { UserType } from '../src/core/user/types';
import { WorkspaceResolver } from '../src/core/workspaces/resolvers';
import { Permission } from '../src/core/workspaces/types';
import { ConfigModule } from '../src/fundamentals/config';
import { Config, ConfigModule } from '../src/fundamentals/config';
import { createTestingApp } from './utils';
@Injectable()
@@ -51,10 +51,9 @@ test.beforeEach(async t => {
const { app } = await createTestingApp({
imports: [
ConfigModule.forRoot({
host: 'example.org',
https: true,
featureFlags: {
earlyAccessPreview: true,
server: {
host: 'example.org',
https: true,
},
}),
FeatureModule,
@@ -67,6 +66,8 @@ test.beforeEach(async t => {
},
});
const config = app.get(Config);
await config.runtime.set('flags/earlyAccessControl', true);
t.context.app = app;
t.context.auth = app.get(AuthService);
t.context.feature = app.get(FeatureService);

View File

@@ -4,13 +4,13 @@ import {
INestApplication,
} from '@nestjs/common';
import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
import { Test } from '@nestjs/testing';
import testFn, { TestFn } from 'ava';
import request from 'supertest';
import { ConfigModule } from '../src/fundamentals/config';
import { GqlModule } from '../src/fundamentals/graphql';
import { Public } from '../src/core/auth';
import { createTestingApp } from './utils';
@Public()
@Resolver(() => String)
class TestResolver {
greating = 'hello world';
@@ -47,16 +47,15 @@ function gql(app: INestApplication, query: string) {
}
test.beforeEach(async ctx => {
const module = await Test.createTestingModule({
imports: [ConfigModule.forRoot(), GqlModule],
const { app } = await createTestingApp({
providers: [TestResolver],
}).compile();
});
ctx.context.app = await module
.createNestApplication({
logger: false,
})
.init();
ctx.context.app = app;
});
test.afterEach.always(async ctx => {
await ctx.context.app.close();
});
test('should be able to execute query', async t => {

View File

@@ -97,9 +97,11 @@ test.beforeEach(async t => {
const { app } = await createTestingApp({
imports: [
ConfigModule.forRoot({
rateLimiter: {
ttl: 60,
limit: 120,
throttler: {
default: {
ttl: 60,
limit: 120,
},
},
}),
AppModule,

View File

@@ -10,10 +10,11 @@ import { AppModule } from '../../src/app.module';
import { CurrentUser } from '../../src/core/auth';
import { AuthService } from '../../src/core/auth/service';
import { UserService } from '../../src/core/user';
import { Config, ConfigModule } from '../../src/fundamentals/config';
import { URLHelper } from '../../src/fundamentals';
import { ConfigModule } from '../../src/fundamentals/config';
import { OAuthProviderName } from '../../src/plugins/oauth/config';
import { GoogleOAuthProvider } from '../../src/plugins/oauth/providers/google';
import { OAuthService } from '../../src/plugins/oauth/service';
import { OAuthProviderName } from '../../src/plugins/oauth/types';
import { createTestingApp, getSession } from '../utils';
const test = ava as TestFn<{
@@ -71,7 +72,7 @@ test("should be able to redirect to oauth provider's login page", async t => {
t.is(redirect.searchParams.get('client_id'), 'google-client-id');
t.is(
redirect.searchParams.get('redirect_uri'),
app.get(Config).baseUrl + '/oauth/callback'
app.get(URLHelper).link('/oauth/callback')
);
t.is(redirect.searchParams.get('response_type'), 'code');
t.is(redirect.searchParams.get('prompt'), 'select_account');

View File

@@ -1,3 +1,5 @@
import '../../src/plugins/payment';
import { INestApplication } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';
import ava, { TestFn } from 'ava';

View File

@@ -100,8 +100,7 @@ export async function createTestingModule(
const prisma = m.get(PrismaClient);
if (prisma instanceof PrismaClient) {
await flushDB(prisma);
await initFeatureConfigs(prisma);
await initTestingDB(prisma);
}
return m;