houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Workspace schema migration runner v2 - Fix Enums and Create TsVector (#13955)

Browse Source 
## Context
- Adding ts-vector generatedType/asExpression as TS_VECTOR settings
- Using those settings to setup properly tsVector searchVector column
through the new migration runner
- Fix enum creation/suppression

Note: regarding the new tsVector, we should implement a command to
update existing fields

TODO: 
- TS_VECTOR search vector column update (note: should be properly
updated whenever the object labelIdentifier is updated or a new TEXT
field is added to the object to follow the current logic)
- relation type fields and columns are not implemented yet 
- index migrations
This commit is contained in:
Weiko
2025-08-18 16:33:51 +02:00
committed by GitHub
parent 3d3191425e
commit 43bb8d6043
16 changed files with 280 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/services/workspace-schema-enum-manager.service.ts
+36 -21
View File
@@ -137,13 +137,15 @@ export class WorkspaceSchemaEnumManagerService {
schemaName,
tableName,
columnDefinition,
enumValues,
oldToNewEnumOptionMap,
}: {
queryRunner: QueryRunner;
schemaName: string;
tableName: string;
columnDefinition: WorkspaceSchemaColumnDefinition;
oldToNewEnumOptionMap?: Record<string, string>;
enumValues: string[];
oldToNewEnumOptionMap: Record<string, string>;
}): Promise<void> {
const isTransactionAlreadyActive = queryRunner.isTransactionActive;
@@ -151,10 +153,7 @@ export class WorkspaceSchemaEnumManagerService {
await queryRunner.startTransaction();
}
if (
!columnDefinition.enumValues ||
columnDefinition.enumValues.length === 0
) {
if (!enumValues || enumValues.length === 0) {
throw new WorkspaceSchemaManagerException(
`Cannot alter enum values for column ${columnDefinition.name} because it has no enum values`,
WorkspaceSchemaManagerExceptionCode.ENUM_OPERATION_FAILED,
@@ -182,7 +181,7 @@ export class WorkspaceSchemaEnumManagerService {
queryRunner,
schemaName,
enumName,
values: columnDefinition.enumValues,
values: enumValues,
});
const oldColumnName = `${columnName}_old`;
@@ -217,13 +216,13 @@ export class WorkspaceSchemaEnumManagerService {
});
}
await this.dropEnum({ queryRunner, schemaName, enumName: oldEnumName });
await this.dropColumn({
queryRunner,
schemaName,
tableName,
columnName: oldColumnName,
});
await this.dropEnum({ queryRunner, schemaName, enumName: oldEnumName });
if (!isTransactionAlreadyActive) {
await queryRunner.commitTransaction();
@@ -271,12 +270,14 @@ export class WorkspaceSchemaEnumManagerService {
columnDefinition: WorkspaceSchemaColumnDefinition;
enumTypeName: string;
}): Promise<void> {
const columnDef = buildSqlColumnDefinition({
...columnDefinition,
type: enumTypeName,
});
const safeSchemaName = removeSqlDDLInjection(schemaName);
const safeTableName = removeSqlDDLInjection(tableName);
const columnDef = buildSqlColumnDefinition({
...columnDefinition,
type: `"${safeSchemaName}"."${enumTypeName}"`,
});
const sql = `ALTER TABLE "${safeSchemaName}"."${safeTableName}" ADD COLUMN ${columnDef}`;
await queryRunner.query(sql);
@@ -322,22 +323,36 @@ export class WorkspaceSchemaEnumManagerService {
const safeOldColumnName = removeSqlDDLInjection(oldColumnName);
const safeNewColumnName = removeSqlDDLInjection(newColumnName);
const newEnumTypeName = computePostgresEnumName({
tableName,
columnName: newColumnName,
});
if (Object.keys(oldToNewEnumOptionMap).length === 0) {
return;
}
const caseStatements = Object.entries(oldToNewEnumOptionMap)
.map(
([oldEnumOption, newEnumOption]) =>
`WHEN '${removeSqlDDLInjection(oldEnumOption)}' THEN '${removeSqlDDLInjection(newEnumOption)}'`,
`WHEN '${removeSqlDDLInjection(oldEnumOption)}' THEN '${removeSqlDDLInjection(newEnumOption)}'::"${safeSchemaName}"."${newEnumTypeName}"`,
)
.join(' ');
const updateSql = `
UPDATE "${safeSchemaName}"."${safeTableName}"
SET "${safeNewColumnName}" =
CASE "${safeOldColumnName}"
${caseStatements}
ELSE "${safeOldColumnName}"
END
WHERE "${safeOldColumnName}" IS NOT NULL`;
const mappedValuesCondition = Object.keys(oldToNewEnumOptionMap)
.map((oldValue) => `'${removeSqlDDLInjection(oldValue)}'`)
.join(', ');
await queryRunner.query(updateSql);
// Update rows with mapped enum values
const updateMappedSql = `
UPDATE "${safeSchemaName}"."${safeTableName}"
SET "${safeNewColumnName}" =
CASE "${safeOldColumnName}"::text
${caseStatements}
END
WHERE "${safeOldColumnName}" IS NOT NULL
AND "${safeOldColumnName}"::text IN (${mappedValuesCondition})`;
await queryRunner.query(updateMappedSql);
}
}
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/types/workspace-schema-column-definition.type.ts
-1
View File
@@ -8,5 +8,4 @@ export type WorkspaceSchemaColumnDefinition = {
isArray?: boolean;
asExpression?: string;
generatedType?: 'STORED' | 'VIRTUAL';
enumValues?: string[];
};
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/utils/__tests__/sanitize-default-value.util.spec.ts
+29 -103
View File
@@ -2,26 +2,15 @@ import { sanitizeDefaultValue } from 'src/engine/twenty-orm/workspace-schema-man
describe('sanitizeDefaultValue', () => {
describe('allowed functions', () => {
it('should allow gen_random_uuid() function', () => {
// Prepare
const input = 'gen_random_uuid()';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('gen_random_uuid()');
});
it('should allow uuid_generate_v4() function', () => {
// Prepare
const input = 'uuid_generate_v4()';
const input = 'public.uuid_generate_v4()';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('uuid_generate_v4()');
expect(result).toBe('public.uuid_generate_v4()');
});
it('should allow now() function', () => {
@@ -35,71 +24,10 @@ describe('sanitizeDefaultValue', () => {
expect(result).toBe('now()');
});
it('should allow current_timestamp function', () => {
// Prepare
const input = 'current_timestamp';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('current_timestamp');
});
it('should allow current_date function', () => {
// Prepare
const input = 'current_date';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('current_date');
});
it('should allow current_time function', () => {
// Prepare
const input = 'current_time';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('current_time');
});
it('should allow localtime function', () => {
// Prepare
const input = 'localtime';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('localtime');
});
it('should allow localtimestamp function', () => {
// Prepare
const input = 'localtimestamp';
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('localtimestamp');
});
it('should be case insensitive for allowed functions', () => {
// Act & Assert
expect(sanitizeDefaultValue('GEN_RANDOM_UUID()')).toBe(
'GEN_RANDOM_UUID()',
);
expect(sanitizeDefaultValue('NOW()')).toBe('NOW()');
expect(sanitizeDefaultValue('CURRENT_TIMESTAMP')).toBe(
'CURRENT_TIMESTAMP',
);
expect(sanitizeDefaultValue('Current_Date')).toBe('Current_Date');
});
});
@@ -115,7 +43,7 @@ describe('sanitizeDefaultValue', () => {
expect(result).not.toContain('DROP TABLE');
expect(result).not.toContain(';');
expect(result).not.toContain('--');
expect(result).toBe('DROPTABLEusers');
expect(result).toBe("'DROPTABLEusers'");
});
it('should sanitize quotes in string values', () => {
@@ -127,7 +55,7 @@ describe('sanitizeDefaultValue', () => {
// Assert
expect(result).not.toContain('"');
expect(result).toBe('testvalue');
expect(result).toBe("'testvalue'");
});
it('should sanitize parentheses in non-function values', () => {
@@ -140,7 +68,7 @@ describe('sanitizeDefaultValue', () => {
// Assert
expect(result).not.toContain('(');
expect(result).not.toContain(')');
expect(result).toBe('testvalue');
expect(result).toBe("'testvalue'");
});
it('should sanitize backslashes', () => {
@@ -152,7 +80,7 @@ describe('sanitizeDefaultValue', () => {
// Assert
expect(result).not.toContain('\\');
expect(result).toBe('testvalue');
expect(result).toBe("'testvalue'");
});
it('should sanitize SQL comment patterns', () => {
@@ -165,7 +93,7 @@ describe('sanitizeDefaultValue', () => {
// Assert
expect(result).not.toContain('/*');
expect(result).not.toContain('*/');
expect(result).toBe('valuecommenttest');
expect(result).toBe("'valuecommenttest'");
});
it('should remove non-alphanumeric characters but preserve SQL keywords in alphanumeric form', () => {
@@ -176,7 +104,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(inputWithKeywords);
// Assert
expect(result).toBe('SELECTFROMusers');
expect(result).toBe("'SELECTFROMusers'");
expect(result).not.toContain('*');
expect(result).not.toContain(' ');
});
@@ -191,24 +119,24 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('simple_value');
expect(result).toBe("'simple_value'");
});
it('should preserve numeric string values', () => {
it('should preserve numeric values', () => {
// Prepare
const input = '12345';
const input = 12345;
// Act
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('12345');
expect(result).toBe(12345);
});
it('should preserve boolean string values', () => {
it('should preserve boolean values', () => {
// Act & Assert
expect(sanitizeDefaultValue('true')).toBe('true');
expect(sanitizeDefaultValue('false')).toBe('false');
expect(sanitizeDefaultValue(true)).toBe(true);
expect(sanitizeDefaultValue(false)).toBe(false);
});
it('should handle empty string', () => {
@@ -219,7 +147,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('');
expect(result).toBe("''");
});
it('should remove whitespace but preserve alphanumeric and underscores', () => {
@@ -230,7 +158,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('test');
expect(result).toBe("'test'");
});
it('should preserve alphanumeric values with underscores', () => {
@@ -241,7 +169,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(input);
// Assert
expect(result).toBe('test_value_123');
expect(result).toBe("'test_value_123'");
});
});
@@ -249,14 +177,14 @@ describe('sanitizeDefaultValue', () => {
it('should distinguish between allowed functions and similar strings', () => {
// Act & Assert
expect(sanitizeDefaultValue('now()')).toBe('now()');
expect(sanitizeDefaultValue('now_test')).toBe('now_test');
expect(sanitizeDefaultValue('not_now()')).toBe('not_now');
expect(sanitizeDefaultValue('now_test')).toBe("'now_test'");
expect(sanitizeDefaultValue('not_now()')).toBe("'not_now'");
});
it('should handle functions with different casing but sanitize non-functions normally', () => {
// Act & Assert
expect(sanitizeDefaultValue('NOW()')).toBe('NOW()');
expect(sanitizeDefaultValue('now_function')).toBe('now_function');
expect(sanitizeDefaultValue('now_function')).toBe("'now_function'");
});
it('should handle complex mixed input', () => {
@@ -267,7 +195,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(complexInput);
// Assert
expect(result).toBe('testvalueDROPTABLEuserscommentnow');
expect(result).toBe("'testvalueDROPTABLEuserscommentnow'");
expect(result).not.toContain(';');
expect(result).not.toContain('"');
expect(result).not.toContain('/*');
@@ -277,18 +205,16 @@ describe('sanitizeDefaultValue', () => {
});
describe('edge cases', () => {
it('should handle null-like strings', () => {
it('should handle null', () => {
// Act & Assert
expect(sanitizeDefaultValue('null')).toBe('null');
expect(sanitizeDefaultValue('NULL')).toBe('NULL');
expect(sanitizeDefaultValue('undefined')).toBe('undefined');
expect(sanitizeDefaultValue(null)).toBe('NULL');
});
it('should handle strings that start with allowed function names', () => {
// Act & Assert
expect(sanitizeDefaultValue('now_extended')).toBe('now_extended');
expect(sanitizeDefaultValue('now_extended')).toBe("'now_extended'");
expect(sanitizeDefaultValue('gen_random_uuid_custom')).toBe(
'gen_random_uuid_custom',
"'gen_random_uuid_custom'",
);
});
@@ -300,7 +226,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(specialChars);
// Assert
expect(result).toBe('');
expect(result).toBe("''");
});
it('should handle very long strings', () => {
@@ -311,7 +237,7 @@ describe('sanitizeDefaultValue', () => {
const result = sanitizeDefaultValue(longString);
// Assert
expect(result).toBe('a'.repeat(1000) + 'DROPTABLEusers');
expect(result).toBe(`'${'a'.repeat(1000)}DROPTABLEusers'`);
expect(result).not.toContain(';');
expect(result).not.toContain(' ');
});
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/utils/build-sql-column-definition.util.ts
+23 -19
View File
@@ -1,3 +1,5 @@
import { isDefined } from 'twenty-shared/utils';
import { type WorkspaceSchemaColumnDefinition } from 'src/engine/twenty-orm/workspace-schema-manager/types/workspace-schema-column-definition.type';
import { sanitizeDefaultValue } from 'src/engine/twenty-orm/workspace-schema-manager/utils/sanitize-default-value.util';
import { removeSqlDDLInjection } from 'src/engine/workspace-manager/workspace-migration-runner/utils/remove-sql-injection.util';
@@ -8,33 +10,35 @@ export const buildSqlColumnDefinition = (
const safeName = removeSqlDDLInjection(column.name);
const parts = [`"${safeName}"`];
if (column.asExpression) {
parts.push(`AS (${column.asExpression})`); // TODO: to sanitize
parts.push(column.isArray ? `${column.type}[]` : column.type);
if (column.asExpression && column.type === 'tsvector') {
parts.push(`GENERATED ALWAYS AS (${column.asExpression})`); // TODO: to sanitize
if (column.generatedType) {
parts.push(column.generatedType);
}
} else {
const safeType = removeSqlDDLInjection(column.type);
}
parts.push(column.isArray ? `${safeType}[]` : safeType);
if (column.isPrimary) {
parts.push('PRIMARY KEY');
}
if (column.isPrimary) {
parts.push('PRIMARY KEY');
}
if (column.isNullable === false) {
parts.push('NOT NULL');
}
if (column.isNullable === false) {
parts.push('NOT NULL');
}
if (column.isUnique) {
parts.push('UNIQUE');
}
if (column.isUnique) {
parts.push('UNIQUE');
}
if (
isDefined(column.default) &&
column.default !== '' &&
column.type !== 'tsvector'
) {
const safeDefault = sanitizeDefaultValue(column.default);
if (column.default !== undefined) {
const safeDefault = sanitizeDefaultValue(column.default);
parts.push(`DEFAULT ${safeDefault}`);
}
parts.push(`DEFAULT ${safeDefault}`);
}
return parts.join(' ');
packages/twenty-server/src/engine/twenty-orm/workspace-schema-manager/utils/sanitize-default-value.util.ts
+2 -11
View File
@@ -7,23 +7,14 @@ export const sanitizeDefaultValue = (
return 'NULL';
}
const allowedFunctions = [
'gen_random_uuid()',
'uuid_generate_v4()',
'now()',
'current_timestamp',
'current_date',
'current_time',
'localtime',
'localtimestamp',
];
const allowedFunctions = ['public.uuid_generate_v4()', 'now()'];
if (typeof defaultValue === 'string') {
if (allowedFunctions.includes(defaultValue.toLowerCase())) {
return defaultValue;
}
return removeSqlDDLInjection(defaultValue);
return `'${removeSqlDDLInjection(defaultValue)}'`;
}
return defaultValue;