feat(server): sql-tools support for class level composite fk (#19242)

* feat: support for class level composite fk

* chore: clean up

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>

server/src/sql-tools/from-code/decorators/foreign-key-column.decorator.ts

@@ -1,11 +1,10 @@
 import { ColumnBaseOptions } from 'src/sql-tools/from-code/decorators/column.decorator';
+import { ForeignKeyAction } from 'src/sql-tools/from-code/decorators/foreign-key-constraint.decorator';
 import { register } from 'src/sql-tools/from-code/register';
 
-type Action = 'CASCADE' | 'SET NULL' | 'SET DEFAULT' | 'RESTRICT' | 'NO ACTION';
-
 export type ForeignKeyColumnOptions = ColumnBaseOptions & {
-  onUpdate?: Action;
-  onDelete?: Action;
+  onUpdate?: ForeignKeyAction;
+  onDelete?: ForeignKeyAction;
   constraintName?: string;
 };
 

server/src/sql-tools/from-code/decorators/foreign-key-constraint.decorator.ts

@@ -0,0 +1,23 @@
+import { register } from 'src/sql-tools/from-code/register';
+
+export type ForeignKeyAction = 'CASCADE' | 'SET NULL' | 'SET DEFAULT' | 'RESTRICT' | 'NO ACTION';
+
+export type ForeignKeyConstraintOptions = {
+  name?: string;
+  index?: boolean;
+  indexName?: string;
+  columns: string[];
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+  referenceTable: () => Function;
+  referenceColumns?: string[];
+  onUpdate?: ForeignKeyAction;
+  onDelete?: ForeignKeyAction;
+  synchronize?: boolean;
+};
+
+export const ForeignKeyConstraint = (options: ForeignKeyConstraintOptions): ClassDecorator => {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+  return (target: Function) => {
+    register({ type: 'foreignKeyConstraint', item: { object: target, options } });
+  };
+};

server/src/sql-tools/from-code/index.ts

@@ -5,7 +5,8 @@ import { processConfigurationParameters } from 'src/sql-tools/from-code/processo
 import { processDatabases } from 'src/sql-tools/from-code/processors/database.processor';
 import { processEnums } from 'src/sql-tools/from-code/processors/enum.processor';
 import { processExtensions } from 'src/sql-tools/from-code/processors/extension.processor';
-import { processForeignKeyConstraints } from 'src/sql-tools/from-code/processors/foreign-key-constriant.processor';
+import { processForeignKeyColumns } from 'src/sql-tools/from-code/processors/foreign-key-column.processor';
+import { processForeignKeyConstraints } from 'src/sql-tools/from-code/processors/foreign-key-constraint.processor';
 import { processFunctions } from 'src/sql-tools/from-code/processors/function.processor';
 import { processIndexes } from 'src/sql-tools/from-code/processors/index.processor';
 import { processPrimaryKeyConstraints } from 'src/sql-tools/from-code/processors/primary-key-contraint.processor';
@@ -32,10 +33,11 @@ const processors: Processor[] = [
   processFunctions,
   processTables,
   processColumns,
+  processForeignKeyColumns,
+  processForeignKeyConstraints,
   processUniqueConstraints,
   processCheckConstraints,
   processPrimaryKeyConstraints,
-  processForeignKeyConstraints,
   processIndexes,
   processTriggers,
 ];

server/src/sql-tools/from-code/processors/column.processor.ts

@@ -1,7 +1,7 @@
 import { ColumnOptions } from 'src/sql-tools/from-code/decorators/column.decorator';
 import { onMissingTable, resolveTable } from 'src/sql-tools/from-code/processors/table.processor';
 import { Processor, SchemaBuilder } from 'src/sql-tools/from-code/processors/type';
-import { asMetadataKey, fromColumnValue } from 'src/sql-tools/helpers';
+import { addWarning, asMetadataKey, fromColumnValue } from 'src/sql-tools/helpers';
 import { DatabaseColumn } from 'src/sql-tools/types';
 
 export const processColumns: Processor = (builder, items) => {
@@ -81,7 +81,7 @@ export const onMissingColumn = (
   propertyName?: symbol | string,
 ) => {
   const label = object.constructor.name + (propertyName ? '.' + String(propertyName) : '');
-  builder.warnings.push(`[${context}] Unable to find column (${label})`);
+  addWarning(builder, context, `Unable to find column (${label})`);
 };
 
 const METADATA_KEY = asMetadataKey('table-metadata');

server/src/sql-tools/from-code/processors/foreign-key-column.processor.ts

@@ -1,10 +1,10 @@
 import { onMissingColumn, resolveColumn } from 'src/sql-tools/from-code/processors/column.processor';
 import { onMissingTable, resolveTable } from 'src/sql-tools/from-code/processors/table.processor';
 import { Processor } from 'src/sql-tools/from-code/processors/type';
-import { asKey } from 'src/sql-tools/helpers';
+import { asForeignKeyConstraintName, asKey } from 'src/sql-tools/helpers';
 import { DatabaseActionType, DatabaseConstraintType } from 'src/sql-tools/types';
 
-export const processForeignKeyConstraints: Processor = (builder, items) => {
+export const processForeignKeyColumns: Processor = (builder, items) => {
   for (const {
     item: { object, propertyName, options, target },
   } of items.filter((item) => item.type === 'foreignKeyColumn')) {
@@ -34,13 +34,16 @@ export const processForeignKeyConstraints: Processor = (builder, items) => {
       column.type = referenceColumns[0].type;
     }
 
+    const referenceColumnNames = referenceColumns.map((column) => column.name);
+    const name = options.constraintName || asForeignKeyConstraintName(table.name, columnNames);
+
     table.constraints.push({
-      name: options.constraintName || asForeignKeyConstraintName(table.name, columnNames),
+      name,
       tableName: table.name,
       columnNames,
       type: DatabaseConstraintType.FOREIGN_KEY,
       referenceTableName: referenceTable.name,
-      referenceColumnNames: referenceColumns.map((column) => column.name),
+      referenceColumnNames,
       onUpdate: options.onUpdate as DatabaseActionType,
       onDelete: options.onDelete as DatabaseActionType,
       synchronize: options.synchronize ?? true,
@@ -58,5 +61,4 @@ export const processForeignKeyConstraints: Processor = (builder, items) => {
   }
 };
 
-const asForeignKeyConstraintName = (table: string, columns: string[]) => asKey('FK_', table, columns);
 const asRelationKeyConstraintName = (table: string, columns: string[]) => asKey('REL_', table, columns);

server/src/sql-tools/from-code/processors/foreign-key-constraint.processor.ts

@@ -0,0 +1,86 @@
+import { onMissingTable, resolveTable } from 'src/sql-tools/from-code/processors/table.processor';
+import { Processor } from 'src/sql-tools/from-code/processors/type';
+import { addWarning, asForeignKeyConstraintName, asIndexName } from 'src/sql-tools/helpers';
+import { DatabaseActionType, DatabaseConstraintType } from 'src/sql-tools/types';
+
+export const processForeignKeyConstraints: Processor = (builder, items, config) => {
+  for (const {
+    item: { object, options },
+  } of items.filter((item) => item.type === 'foreignKeyConstraint')) {
+    const table = resolveTable(builder, object);
+    if (!table) {
+      onMissingTable(builder, '@ForeignKeyConstraint', { name: 'referenceTable' });
+      continue;
+    }
+
+    const referenceTable = resolveTable(builder, options.referenceTable());
+    if (!referenceTable) {
+      const referenceTableName = options.referenceTable()?.name;
+      addWarning(
+        builder,
+        '@ForeignKeyConstraint.referenceTable',
+        `Unable to find table` + (referenceTableName ? ` (${referenceTableName})` : ''),
+      );
+      continue;
+    }
+
+    let missingColumn = false;
+
+    for (const columnName of options.columns) {
+      if (!table.columns.some(({ name }) => name === columnName)) {
+        addWarning(
+          builder,
+          '@ForeignKeyConstraint.columns',
+          `Unable to find column (${table.metadata.object.name}.${columnName})`,
+        );
+        missingColumn = true;
+      }
+    }
+
+    for (const columnName of options.referenceColumns || []) {
+      if (!referenceTable.columns.some(({ name }) => name === columnName)) {
+        addWarning(
+          builder,
+          '@ForeignKeyConstraint.referenceColumns',
+          `Unable to find column (${referenceTable.metadata.object.name}.${columnName})`,
+        );
+        missingColumn = true;
+      }
+    }
+
+    if (missingColumn) {
+      continue;
+    }
+
+    const referenceColumns =
+      options.referenceColumns || referenceTable.columns.filter(({ primary }) => primary).map(({ name }) => name);
+
+    const name = options.name || asForeignKeyConstraintName(table.name, options.columns);
+
+    table.constraints.push({
+      type: DatabaseConstraintType.FOREIGN_KEY,
+      name,
+      tableName: table.name,
+      columnNames: options.columns,
+      referenceTableName: referenceTable.name,
+      referenceColumnNames: referenceColumns,
+      onUpdate: options.onUpdate as DatabaseActionType,
+      onDelete: options.onDelete as DatabaseActionType,
+      synchronize: options.synchronize ?? true,
+    });
+
+    if (options.index === false) {
+      continue;
+    }
+
+    if (options.index || options.indexName || config.createForeignKeyIndexes) {
+      table.indexes.push({
+        name: options.indexName || asIndexName(table.name, options.columns),
+        tableName: table.name,
+        columnNames: options.columns,
+        unique: false,
+        synchronize: options.synchronize ?? true,
+      });
+    }
+  }
+};

server/src/sql-tools/from-code/processors/index.processor.ts

@@ -1,7 +1,7 @@
 import { onMissingColumn, resolveColumn } from 'src/sql-tools/from-code/processors/column.processor';
 import { onMissingTable, resolveTable } from 'src/sql-tools/from-code/processors/table.processor';
 import { Processor } from 'src/sql-tools/from-code/processors/type';
-import { asKey } from 'src/sql-tools/helpers';
+import { asIndexName } from 'src/sql-tools/helpers';
 
 export const processIndexes: Processor = (builder, items, config) => {
   for (const {
@@ -75,16 +75,3 @@ export const processIndexes: Processor = (builder, items, config) => {
     });
   }
 };
-
-const asIndexName = (table: string, columns?: string[], where?: string) => {
-  const items: string[] = [];
-  for (const columnName of columns ?? []) {
-    items.push(columnName);
-  }
-
-  if (where) {
-    items.push(where);
-  }
-
-  return asKey('IDX_', table, items);
-};

server/src/sql-tools/from-code/processors/table.processor.ts

@@ -1,6 +1,6 @@
 import { TableOptions } from 'src/sql-tools/from-code/decorators/table.decorator';
 import { Processor, SchemaBuilder } from 'src/sql-tools/from-code/processors/type';
-import { asMetadataKey, asSnakeCase } from 'src/sql-tools/helpers';
+import { addWarning, asMetadataKey, asSnakeCase } from 'src/sql-tools/helpers';
 
 export const processTables: Processor = (builder, items) => {
   for (const {
@@ -45,7 +45,7 @@ export const onMissingTable = (
   propertyName?: symbol | string,
 ) => {
   const label = object.constructor.name + (propertyName ? '.' + String(propertyName) : '');
-  builder.warnings.push(`[${context}] Unable to find table (${label})`);
+  addWarning(builder, context, `Unable to find table (${label})`);
 };
 
 const METADATA_KEY = asMetadataKey('table-metadata');

server/src/sql-tools/from-code/register-item.ts

@@ -4,6 +4,7 @@ import { ConfigurationParameterOptions } from 'src/sql-tools/from-code/decorator
 import { DatabaseOptions } from 'src/sql-tools/from-code/decorators/database.decorator';
 import { ExtensionOptions } from 'src/sql-tools/from-code/decorators/extension.decorator';
 import { ForeignKeyColumnOptions } from 'src/sql-tools/from-code/decorators/foreign-key-column.decorator';
+import { ForeignKeyConstraintOptions } from 'src/sql-tools/from-code/decorators/foreign-key-constraint.decorator';
 import { IndexOptions } from 'src/sql-tools/from-code/decorators/index.decorator';
 import { TableOptions } from 'src/sql-tools/from-code/decorators/table.decorator';
 import { TriggerOptions } from 'src/sql-tools/from-code/decorators/trigger.decorator';
@@ -25,5 +26,6 @@ export type RegisterItem =
   | { type: 'trigger'; item: ClassBased<{ options: TriggerOptions }> }
   | { type: 'extension'; item: ClassBased<{ options: ExtensionOptions }> }
   | { type: 'configurationParameter'; item: ClassBased<{ options: ConfigurationParameterOptions }> }
-  | { type: 'foreignKeyColumn'; item: PropertyBased<{ options: ForeignKeyColumnOptions; target: () => object }> };
+  | { type: 'foreignKeyColumn'; item: PropertyBased<{ options: ForeignKeyColumnOptions; target: () => object }> }
+  | { type: 'foreignKeyConstraint'; item: ClassBased<{ options: ForeignKeyConstraintOptions }> };
 export type RegisterItemType<T extends RegisterItem['type']> = Extract<RegisterItem, { type: T }>['item'];

server/src/sql-tools/helpers.ts

@@ -1,5 +1,6 @@
 import { createHash } from 'node:crypto';
 import { ColumnValue } from 'src/sql-tools/from-code/decorators/column.decorator';
+import { SchemaBuilder } from 'src/sql-tools/from-code/processors/type';
 import {
   Comparer,
   DatabaseColumn,
@@ -211,3 +212,22 @@ export const asColumnComment = (tableName: string, columnName: string, comment:
 };
 
 export const asColumnList = (columns: string[]) => columns.map((column) => `"${column}"`).join(', ');
+
+export const asForeignKeyConstraintName = (table: string, columns: string[]) => asKey('FK_', table, [...columns]);
+
+export const asIndexName = (table: string, columns?: string[], where?: string) => {
+  const items: string[] = [];
+  for (const columnName of columns ?? []) {
+    items.push(columnName);
+  }
+
+  if (where) {
+    items.push(where);
+  }
+
+  return asKey('IDX_', table, items);
+};
+
+export const addWarning = (builder: SchemaBuilder, context: string, message: string) => {
+  builder.warnings.push(`[${context}] ${message}`);
+};

server/src/sql-tools/public_api.ts

@@ -12,6 +12,7 @@ export * from 'src/sql-tools/from-code/decorators/delete-date-column.decorator';
 export * from 'src/sql-tools/from-code/decorators/extension.decorator';
 export * from 'src/sql-tools/from-code/decorators/extensions.decorator';
 export * from 'src/sql-tools/from-code/decorators/foreign-key-column.decorator';
+export * from 'src/sql-tools/from-code/decorators/foreign-key-constraint.decorator';
 export * from 'src/sql-tools/from-code/decorators/generated-column.decorator';
 export * from 'src/sql-tools/from-code/decorators/index.decorator';
 export * from 'src/sql-tools/from-code/decorators/primary-column.decorator';