gristlabs_grist-core/app/gen-server/migration/1727747249153-Configs.ts

67 lines
1.7 KiB
TypeScript
Raw Normal View History

(core) Add installation/site configuration endpoints Summary: A new set of endpoints for managing installation and site configuration have been added: - GET `/api/install/configs/:key` - get the value of the configuration item with the specified key - PUT `/api/install/configs/:key` - set the value of the configuration item with the specified key - body: the JSON value of the configuration item - DELETE `/api/install/configs/:key` - delete the configuration item with the specified key - GET `/api/orgs/:oid/configs/:key` - get the value of the configuration item with the specified key - PUT `/api/orgs/:oid/configs/:key` - set the value of the configuration item with the specified key - body: the JSON value of the configuration item - DELETE `/api/orgs/:oid/configs/:key` - delete the configuration item with the specified key Configuration consists of key/value pairs, where keys are strings (e.g. `"audit_logs_streaming_destinations"`) and values are JSON, including literals like numbers and strings. Only installation admins and site owners are permitted to modify installation and site configuration, respectively. The endpoints are planned to be used in an upcoming feature for enabling audit log streaming for an installation and/or site. Future functionality may use the endpoints as well, which may require extending the current capabilities (e.g. adding support for storing secrets, additional metadata fields, etc.). Test Plan: Server tests Reviewers: paulfitz, jarek Reviewed By: paulfitz, jarek Subscribers: jarek Differential Revision: https://phab.getgrist.com/D4377
2024-10-16 00:45:10 +00:00
import { nativeValues } from "app/gen-server/lib/values";
import * as sqlUtils from "app/gen-server/sqlUtils";
import { MigrationInterface, QueryRunner, Table } from "typeorm";
export class Configs1727747249153 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise<any> {
const dbType = queryRunner.connection.driver.options.type;
const datetime = sqlUtils.datetime(dbType);
const now = sqlUtils.now(dbType);
await queryRunner.createTable(
new Table({
name: "configs",
columns: [
{
name: "id",
type: "integer",
isGenerated: true,
generationStrategy: "increment",
isPrimary: true,
},
{
name: "org_id",
type: "integer",
isNullable: true,
},
{
name: "key",
type: "varchar",
},
{
name: "value",
type: nativeValues.jsonType,
},
{
name: "created_at",
type: datetime,
default: now,
},
{
name: "updated_at",
type: datetime,
default: now,
},
],
foreignKeys: [
{
columnNames: ["org_id"],
referencedColumnNames: ["id"],
referencedTableName: "orgs",
onDelete: "CASCADE",
},
],
})
);
await queryRunner.manager.query(
'CREATE UNIQUE INDEX "configs__key__org_id" ON "configs" ' +
"(key, COALESCE(org_id, 0))"
);
}
public async down(queryRunner: QueryRunner): Promise<any> {
await queryRunner.dropTable("configs");
}
}