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

@@ -60,7 +60,7 @@ input CreateCheckoutSessionInput {
idempotencyKey: String!
plan: SubscriptionPlan = Pro
recurring: SubscriptionRecurring = Yearly
successCallbackLink: String
successCallbackLink: String!
}
type CredentialsRequirementType {
@@ -175,6 +175,11 @@ The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://
"""
scalar JSON @specifiedBy(url: "http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf")
"""
The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSONObject @specifiedBy(url: "http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf")
type LimitedUserType {
"""User email"""
email: String!
@@ -234,6 +239,12 @@ type Mutation {
setWorkspaceExperimentalFeature(enable: Boolean!, feature: FeatureType!, workspaceId: String!): Boolean!
sharePage(pageId: String!, workspaceId: String!): Boolean! @deprecated(reason: "renamed to publishPage")
updateProfile(input: UpdateUserInput!): UserType!
"""update server runtime configurable setting"""
updateRuntimeConfig(id: String!, value: JSON!): ServerRuntimeConfigType!
"""update multiple server runtime configurable settings"""
updateRuntimeConfigs(updates: JSONObject!): [ServerRuntimeConfigType!]!
updateSubscriptionRecurring(idempotencyKey: String!, plan: SubscriptionPlan = Pro, recurring: SubscriptionRecurring!): UserSubscription!
"""Update workspace"""
@@ -291,6 +302,9 @@ type Query {
"""server config"""
serverConfig: ServerConfigType!
"""get all server runtime configurable settings"""
serverRuntimeConfig: [ServerRuntimeConfigType!]!
"""Get user by email"""
user(email: String!): UserOrLimitedUser
@@ -323,6 +337,14 @@ type RemoveAvatar {
success: Boolean!
}
enum RuntimeConfigType {
Array
Boolean
Number
Object
String
}
"""
The `SafeInt` scalar type represents non-fractional signed whole numeric values that are considered safe as defined by the ECMAScript specification.
"""
@@ -341,6 +363,9 @@ type ServerConfigType {
"""enabled server features"""
features: [ServerFeature!]!
"""server flags"""
flags: ServerFlagsType!
"""server flavor"""
flavor: String! @deprecated(reason: "use `features`")
@@ -366,6 +391,21 @@ enum ServerFeature {
Payment
}
type ServerFlagsType {
earlyAccessControl: Boolean!
syncClientVersionCheck: Boolean!
}
type ServerRuntimeConfigType {
description: String!
id: String!
key: String!
module: String!
type: RuntimeConfigType!
updatedAt: DateTime!
value: JSON!
}
enum SubscriptionPlan {
AI
Enterprise