Skip to content

update KeyValuePairType enum and add IS_CONFIG_VAR_IN_DB_ENABLED config var #11476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/twenty-server/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,5 @@ FRONTEND_URL=http://localhost:3001
# SSL_CERT_PATH="./certs/your-cert.crt"
# CLOUDFLARE_API_KEY=
# CLOUDFLARE_ZONE_ID=
# CLOUDFLARE_WEBHOOK_SECRET=
# CLOUDFLARE_WEBHOOK_SECRET=
# IS_CONFIG_VAR_IN_DB_ENABLED=false
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { MigrationInterface, QueryRunner } from 'typeorm';

export class UpdateKeyValuePairTypeEnum1743085000787
implements MigrationInterface
{
name = 'UpdateKeyValuePairTypeEnum1743085000787';

public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" DROP DEFAULT`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" TYPE text USING "type"::text`,
);

await queryRunner.query(
`UPDATE "core"."keyValuePair" SET "type" = 'USER_VARIABLE' WHERE "type" = 'USER_VAR'`,
);
await queryRunner.query(
`UPDATE "core"."keyValuePair" SET "type" = 'CONFIG_VARIABLE' WHERE "type" = 'SYSTEM_VAR'`,
);

await queryRunner.query(`DROP TYPE "core"."keyValuePair_type_enum"`);

await queryRunner.query(
`CREATE TYPE "core"."keyValuePair_type_enum" AS ENUM('USER_VARIABLE', 'FEATURE_FLAG', 'CONFIG_VARIABLE')`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" TYPE "core"."keyValuePair_type_enum" USING "type"::"core"."keyValuePair_type_enum"`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" SET DEFAULT 'USER_VARIABLE'`,
);
}

public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" DROP DEFAULT`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" TYPE text USING "type"::text`,
);

await queryRunner.query(
`UPDATE "core"."keyValuePair" SET "type" = 'USER_VAR' WHERE "type" = 'USER_VARIABLE'`,
);
await queryRunner.query(
`UPDATE "core"."keyValuePair" SET "type" = 'SYSTEM_VAR' WHERE "type" = 'CONFIG_VARIABLE'`,
);

await queryRunner.query(`DROP TYPE "core"."keyValuePair_type_enum"`);

await queryRunner.query(
`CREATE TYPE "core"."keyValuePair_type_enum" AS ENUM('USER_VAR', 'FEATURE_FLAG', 'SYSTEM_VAR')`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" TYPE "core"."keyValuePair_type_enum" USING "type"::"core"."keyValuePair_type_enum"`,
);

await queryRunner.query(
`ALTER TABLE "core"."keyValuePair" ALTER COLUMN "type" SET DEFAULT 'USER_VAR'`,
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ import { User } from 'src/engine/core-modules/user/user.entity';
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';

export enum KeyValuePairType {
USER_VAR = 'USER_VAR',
USER_VARIABLE = 'USER_VARIABLE',
FEATURE_FLAG = 'FEATURE_FLAG',
SYSTEM_VAR = 'SYSTEM_VAR',
CONFIG_VARIABLE = 'CONFIG_VARIABLE',
}

@Entity({ name: 'keyValuePair', schema: 'core' })
Expand Down Expand Up @@ -75,7 +75,7 @@ export class KeyValuePair {
type: 'enum',
enum: Object.values(KeyValuePairType),
nullable: false,
default: KeyValuePairType.USER_VAR,
default: KeyValuePairType.USER_VARIABLE,
})
type: KeyValuePairType;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -693,6 +693,15 @@ export class ConfigVariables {
@IsOptional()
PG_SSL_ALLOW_SELF_SIGNED = false;

@ConfigVariablesMetadata({
group: ConfigVariablesGroup.ServerConfig,
description: 'Enable configuration variables to be stored in the database',
})
@CastToBoolean()
@IsBoolean()
@IsOptional()
IS_CONFIG_VAR_IN_DB_ENABLED = false;

@ConfigVariablesMetadata({
group: ConfigVariablesGroup.TokensDuration,
description: 'Time-to-live for cache storage in seconds',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class UserVarsService<

if (workspaceId) {
userVarWorkspaceLevel = await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId: null,
workspaceId,
key,
Expand All @@ -40,7 +40,7 @@ export class UserVarsService<

if (userId) {
userVarUserLevel = await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId,
workspaceId: null,
key,
Expand All @@ -55,7 +55,7 @@ export class UserVarsService<

if (userId && workspaceId) {
userVarWorkspaceAndUserLevel = await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId,
workspaceId,
key,
Expand Down Expand Up @@ -88,7 +88,7 @@ export class UserVarsService<
result = [
...result,
...(await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId,
workspaceId: null,
})),
Expand All @@ -99,7 +99,7 @@ export class UserVarsService<
result = [
...result,
...(await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId: null,
workspaceId,
})),
Expand All @@ -110,7 +110,7 @@ export class UserVarsService<
result = [
...result,
...(await this.keyValuePairService.get({
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
userId,
workspaceId,
})),
Expand All @@ -136,7 +136,7 @@ export class UserVarsService<
workspaceId,
key: key,
value,
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
});
}

Expand All @@ -153,7 +153,7 @@ export class UserVarsService<
userId,
workspaceId,
key,
type: KeyValuePairType.USER_VAR,
type: KeyValuePairType.USER_VARIABLE,
});
}
}