HCK-9538: Computed Columns: Add support of constraints (#127)

* HCK-9538: Add support of constrains to computed columns

* HCK-9538: improve validation

* HCK-9538: code clean up

* HCK-9538: Rename key

* HCK-9538: improve validation

Author: Nightlngale

forward_engineering/configs/templates.js

@@ -12,7 +12,7 @@ module.exports = {
 
 	columnDefinition:
 		'[${name}] ${type}${primary_key}${temporalTableTime}${sparse}${maskedWithFunction}${identity}${default}${collation}${not_null}${encryptedWith}',
-	computedColumnDefinition: '[${name}] AS ${expression}${persisted}',
+	computedColumnDefinition: '[${name}] AS ${expression}${persisted}${key}${not_null}',
 
 	index:
 		'CREATE${unique}${clustered}${columnstore} INDEX ${name}\n' +
@@ -83,8 +83,6 @@ module.exports = {
 
 	alterColumn: 'ALTER COLUMN [${name}] ${type}${collation}${not_null}',
 
-	alterComputedColumn: 'ADD [${name}] AS ${expression}${persisted}',
-
 	renameColumn: "EXEC sp_rename '${fullTableName}.${oldColumnName}', '${newColumnName}', 'COLUMN';${terminator}",
 
 	dropView: 'DROP VIEW IF EXISTS ${name}${terminator}',

forward_engineering/ddlProvider.js

@@ -177,11 +177,19 @@ module.exports = (baseProvider, options, app) => {
 				: fullTableStatement;
 		},
 
-		createComputedColumn({ name, computedExpression, persisted }) {
+		createComputedColumn({ name, computedExpression, persisted, primaryKey, unique, notNull }) {
+			let key = persisted ? primaryKey : '';
+
+			if (!key) {
+				key = unique;
+			}
+
 			return assignTemplates(templates.computedColumnDefinition, {
 				name,
-				expression: wrapInBracketsIfNecessary(computedExpression),
+				expression: wrapInBracketsIfNecessary(computedExpression.trim()),
 				persisted: persisted ? ' PERSISTED' : '',
+				key,
+				not_null: notNull,
 			});
 		},
 
@@ -223,6 +231,9 @@ module.exports = (baseProvider, options, app) => {
 							name,
 							computedExpression,
 							persisted,
+							primaryKey,
+							unique,
+							notNull,
 						})
 					: assignTemplates(templates.columnDefinition, {
 							name,
@@ -750,13 +761,9 @@ module.exports = (baseProvider, options, app) => {
 			});
 		},
 
-		alterComputedColumn(fullTableName, columnName, columnDefinition) {
-			const { computedExpression, persisted } = columnDefinition;
-
-			const command = assignTemplates(templates.alterComputedColumn, {
-				name: columnName,
-				expression: wrapInBracketsIfNecessary(computedExpression),
-				persisted: persisted ? ' PERSISTED' : '',
+		alterComputedColumn(fullTableName, name, columnDefinition) {
+			const command = assignTemplates(templates.addColumn, {
+				script: this.convertColumnDefinition(columnDefinition),
 			});
 
 			return assignTemplates(templates.alterTable, {

forward_engineering/helpers/alterScriptHelpers/columnHelpers/alterComputedColumnHelpr.js

@@ -5,6 +5,7 @@ const _ = require('lodash');
 module.exports = (app, ddlProvider) => {
 	const { createColumnDefinitionBySchema } = require('./createColumnDefinition')(_);
 	const { AlterScriptDto } = require('../types/AlterScriptDto');
+	const { compareObjectsByProperties } = require('../../../utils/general')(_);
 
 	const changeToComputed = (fullName, columnName, columnDefinition) => {
 		return [
@@ -24,13 +25,17 @@ module.exports = (app, ddlProvider) => {
 		];
 	};
 
+	const propsToDetectChange = ['computed', 'computedExpression', 'persisted', 'unique', 'primaryKey'];
+
 	const generateSqlAlterScript = ({
 		collectionSchema,
 		prevJsonSchema,
 		jsonSchema,
 		fullName,
 		columnName,
 		schemaName,
+		toAddNotNull,
+		toRemoveNotNull,
 	}) => {
 		const schemaData = { schemaName };
 		const columnDefinition = createColumnDefinitionBySchema({
@@ -40,6 +45,7 @@ module.exports = (app, ddlProvider) => {
 			ddlProvider,
 			schemaData,
 		});
+		columnDefinition.nullable = toRemoveNotNull;
 
 		let sqlScripts = [];
 
@@ -48,8 +54,9 @@ module.exports = (app, ddlProvider) => {
 		const isComputedModified =
 			prevJsonSchema.computed &&
 			jsonSchema.computed &&
-			(prevJsonSchema.computedExpression !== jsonSchema.computedExpression ||
-				prevJsonSchema.persisted !== jsonSchema.persisted);
+			(compareObjectsByProperties(prevJsonSchema, jsonSchema, propsToDetectChange) ||
+				toAddNotNull ||
+				toRemoveNotNull);
 
 		if ((isComputedRemoved || isComputedModified) && !jsonSchema.computedExpression) {
 			sqlScripts = changeToNonComputed(fullName, columnName, columnDefinition);
@@ -67,6 +74,14 @@ module.exports = (app, ddlProvider) => {
 			_.toPairs(collection.properties).reduce((result, [columnName, jsonSchema]) => {
 				const oldJsonSchema = _.omit(collection.role?.properties?.[columnName], ['compMod']);
 
+				const currentRequiredColumnNames = collection.required || [];
+				const previousRequiredColumnNames = collection.role.required || [];
+
+				const toAddNotNull =
+					_.difference(currentRequiredColumnNames, previousRequiredColumnNames).indexOf(columnName) !== -1;
+				const toRemoveNotNull =
+					_.difference(previousRequiredColumnNames, currentRequiredColumnNames).indexOf(columnName) !== -1;
+
 				result.push(
 					generateSqlAlterScript({
 						collectionSchema,
@@ -75,6 +90,8 @@ module.exports = (app, ddlProvider) => {
 						fullName,
 						columnName,
 						schemaName,
+						toAddNotNull,
+						toRemoveNotNull,
 					}),
 				);
 

forward_engineering/helpers/alterScriptHelpers/columnHelpers/notNullConstraintsHelper.js

@@ -22,7 +22,7 @@ const getModifyNonNullColumnsScriptDtos = (_, ddlProvider) => (collection, colle
 			const oldName = jsonSchema.compMod.oldField.name;
 			const shouldRemoveForOldName = columnNamesToRemoveNotNullConstraint.includes(oldName);
 			const shouldAddForNewName = columnNamesToAddNotNullConstraint.includes(name);
-			return shouldAddForNewName && !shouldRemoveForOldName;
+			return shouldAddForNewName && !shouldRemoveForOldName && !jsonSchema.computed;
 		})
 		.map(([columnName, jsonSchema]) => {
 			const columnDefinition = createColumnDefinitionBySchema({
@@ -42,7 +42,8 @@ const getModifyNonNullColumnsScriptDtos = (_, ddlProvider) => (collection, colle
 			const oldName = jsonSchema.compMod.oldField.name;
 			const shouldRemoveForOldName = columnNamesToRemoveNotNullConstraint.includes(oldName);
 			const shouldAddForNewName = columnNamesToAddNotNullConstraint.includes(name);
-			return shouldRemoveForOldName && !shouldAddForNewName;
+
+			return shouldRemoveForOldName && !shouldAddForNewName && !jsonSchema.computed;
 		})
 		.map(([name, jsonSchema]) => {
 			const columnDefinition = createColumnDefinitionBySchema({

forward_engineering/utils/general.js

@@ -197,6 +197,10 @@ module.exports = _ => {
 			return !_.isEqual(newProperty, oldProperty);
 		};
 
+	const compareObjectsByProperties = (obj1, obj2, properties) => {
+		return properties.some(prop => obj1[prop] !== obj2[prop]);
+	};
+
 	const getSchemaOfAlterCollection = collection => {
 		return { ...collection, ...(_.omit(collection?.role, 'properties') || {}) };
 	};
@@ -231,5 +235,6 @@ module.exports = _ => {
 		getSchemaOfAlterCollection,
 		getNamePrefixedWithSchemaName,
 		buildDefaultPKName,
+		compareObjectsByProperties,
 	};
 };