HCK-14285: Implement CREATE/DROP logic for tables and table columns (#79)

<!--do not remove this marker, its needed to replace info when ticket
title is updated -->
<!--jira-description-action-hidden-marker-start-->

<table>
<td>
<a href="https://hackolade.atlassian.net/browse/HCK-14285"
title="HCK-14285" target="_blank"><img alt="Sub-task"
src="https://hackolade.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10316?size=medium"
/>HCK-14285</a> [DB2] Implement CREATE/DROP logic for tables and table
columns
  </td></table>
  <br />
 

<!--jira-description-action-hidden-marker-end-->
## Content

Added logic to generate scripts for
- CREATE/DROP table,
- CREATE/DROP/RENAME/CHANGE TYPE table column
- Fix deletion of FK

Author: Nightlngale

forward_engineering/alterScript/alterScriptFromDeltaHelper.js

@@ -1,25 +1,28 @@
+/**
+ * @typedef {import('../../shared/types').App} App
+ * @typedef {import('./types/AlterScriptDto').AlterScriptDto} AlterScriptDto
+ */
 const { getContainersScripts } = require('./alterScriptHelpers/alterContainerHelper');
-const {
-	getModifyCollectionScriptDtos,
-	getModifyCollectionKeysScriptDtos,
-	getModifyColumnScriptDtos,
-} = require('./alterScriptHelpers/alterEntityHelper');
+const { getEntitiesScripts } = require('./alterScriptHelpers/alterEntityHelper');
 const {
 	getDeleteForeignKeyScriptDtos,
 	getAddForeignKeyScriptDtos,
 	getModifyForeignKeyScriptDtos,
 } = require('./alterScriptHelpers/alterForeignKeyHelper');
 const { getModifyViewScriptDtos } = require('./alterScriptHelpers/alterViewHelper');
 
+/**
+ * @param {T} data
+ * @return {Array<T>}
+ */
 const getItems = data => [data?.items].flat().filter(Boolean);
 
 /**
- * @param dto {{
+ * @param {{
  *     collection: Object,
  *     app: App
- * }}
- * @return {AlterScriptDto[]}
- * */
+ * }} param
+ */
 const getAlterContainersScriptDtos = ({ collection, app }) => {
 	const { added, deleted, modified } = collection.properties?.containers?.properties || {};
 	const addedContainers = getItems(added);
@@ -29,41 +32,86 @@ const getAlterContainersScriptDtos = ({ collection, app }) => {
 	const { getAddContainerScriptDto, getDeleteContainerScriptDto, getModifyContainerScriptDto } =
 		getContainersScripts(app);
 
-	const addContainersScriptDtos = addedContainers
+	const addedContainersScriptDtos = addedContainers
 		.map(container => Object.values(container.properties)[0])
 		.flatMap(getAddContainerScriptDto);
 
-	const deleteContainersScriptDtos = deletedContainers
+	const deletedContainersScriptDtos = deletedContainers
 		.map(container => Object.values(container.properties)[0])
 		.flatMap(getDeleteContainerScriptDto);
 
-	const modifyContainersScriptDtos = modifiedContainers
+	const modifiedContainersScriptDtos = modifiedContainers
 		.map(containerWrapper => Object.values(containerWrapper.properties)[0])
 		.flatMap(getModifyContainerScriptDto);
 
-	return [...addContainersScriptDtos, ...deleteContainersScriptDtos, ...modifyContainersScriptDtos].filter(Boolean);
+	// Schemas can only be dropped after all contained tables are removed,
+	// so container cleanup must happen last.
+	return {
+		deletedContainersScriptDtos,
+		upsertedContainersScriptDtos: [...addedContainersScriptDtos, ...modifiedContainersScriptDtos],
+	};
 };
 
+/**
+ * @param {{collection: Object, app: App, modelDefinitions: Object, internalDefinitions: Object, externalDefinitions: Object, inlineDeltaRelationships?: any[]}} param
+ * @return {Array<AlterScriptDto>}
+ */
 const getAlterCollectionScriptDtos = ({
 	collection,
 	app,
 	modelDefinitions,
 	internalDefinitions,
 	externalDefinitions,
+	inlineDeltaRelationships = [],
 }) => {
-	const modifyScriptsData = getItems(collection.properties?.entities?.properties?.modified).map(
-		item => Object.values(item.properties)[0],
-	);
+	const { added, deleted, modified } = collection.properties?.entities?.properties || {};
+	const addedCollections = getItems(added).map(item => Object.values(item.properties)[0]);
+	const deletedCollections = getItems(deleted).map(item => Object.values(item.properties)[0]);
+	const modifyScriptsData = getItems(modified).map(item => Object.values(item.properties)[0]);
+
+	const {
+		getAddCollectionScriptDto,
+		getDeleteCollectionScriptDto,
+		getModifyCollectionScriptDtos,
+		getModifyCollectionKeysScriptDtos,
+		getModifyColumnScriptDtos,
+		getAddColumnScriptDtos,
+		getDeleteColumnScriptDtos,
+	} = getEntitiesScripts(app, inlineDeltaRelationships);
+
+	const addedCollectionScriptDtos = addedCollections
+		.filter(collection => collection.role.compMod.created)
+		.map(getAddCollectionScriptDto);
+
+	const addedColumnScriptDtos = addedCollections.flatMap(getAddColumnScriptDtos);
+
+	const deletedCollectionScriptDtos = deletedCollections
+		.filter(collection => collection.role.compMod.deleted)
+		.map(getDeleteCollectionScriptDto);
+
+	const deletedColumnScriptDtos = deletedCollections
+		.filter(collection => !collection.role.compMod.deleted)
+		.flatMap(getDeleteColumnScriptDtos);
 
 	const modifyCollectionScriptDtos = modifyScriptsData.flatMap(getModifyCollectionScriptDtos);
 	const modifyCollectionKeysScriptDtos = modifyScriptsData.flatMap(getModifyCollectionKeysScriptDtos);
 	const modifyColumnScriptDtos = modifyScriptsData.flatMap(getModifyColumnScriptDtos);
 
-	return [...modifyCollectionScriptDtos, ...modifyColumnScriptDtos, ...modifyCollectionKeysScriptDtos].filter(
-		Boolean,
-	);
+	return [
+		...deletedCollectionScriptDtos,
+		...addedCollectionScriptDtos,
+		...modifyCollectionScriptDtos,
+		...deletedColumnScriptDtos,
+		...addedColumnScriptDtos,
+		...modifyColumnScriptDtos,
+		...modifyCollectionKeysScriptDtos,
+	].filter(Boolean);
 };
 
+/**
+ * @param {Object} collection
+ * @return {Array<AlterScriptDto>}
+ */
 const getAlterViewScriptDtos = collection => {
 	const modifyViewScriptDtos = getItems(collection.properties?.views?.properties?.modified)
 		.map(viewWrapper => Object.values(viewWrapper.properties)[0])
@@ -73,6 +121,10 @@ const getAlterViewScriptDtos = collection => {
 	return [...modifyViewScriptDtos].filter(Boolean);
 };
 
+/**
+ * @param {{collection: Object, app: App, ignoreRelationshipIDs?: string[]}} param
+ * @return {Array<AlterScriptDto>}
+ */
 const getAlterRelationshipsScriptDtos = ({ collection, app, ignoreRelationshipIDs = [] }) => {
 	const addedRelationships = getItems(collection.properties?.relationships?.properties?.added)
 		.filter(Boolean)
@@ -105,6 +157,10 @@ const getAlterRelationshipsScriptDtos = ({ collection, app, ignoreRelationshipID
 	return [...deleteFkScriptDtos, ...addFkScriptDtos, ...modifiedFkScriptDtos].filter(Boolean);
 };
 
+/**
+ * @param {{collection: Object, options: Object}} param
+ * @return {Array<Object>}
+ */
 const getInlineRelationships = ({ collection, options }) => {
 	if (options?.scriptGenerationOptions?.feActiveOptions?.foreignKeys !== 'inline') {
 		return [];
@@ -121,13 +177,17 @@ const getInlineRelationships = ({ collection, options }) => {
 	return addedRelationships;
 };
 
+/**
+ * @param {AlterScriptDto} dto
+ * @return {AlterScriptDto | undefined}
+ */
 const prettifyAlterScriptDto = dto => {
 	if (!dto) {
 		return undefined;
 	}
 	/**
 	 * @type {Array<ModificationScript>}
-	 * */
+	 */
 	const nonEmptyScriptModificationDtos = dto.scripts
 		.map(scriptDto => ({
 			...scriptDto,
@@ -143,6 +203,11 @@ const prettifyAlterScriptDto = dto => {
 	};
 };
 
+/**
+ * @param {Object} data
+ * @param {App} app
+ * @return {Array<AlterScriptDto>}
+ */
 const getAlterScriptDtos = (data, app) => {
 	const collection = JSON.parse(data.jsonSchema);
 
@@ -159,14 +224,18 @@ const getAlterScriptDtos = (data, app) => {
 	const inlineDeltaRelationships = getInlineRelationships({ collection, options: data.options });
 	const ignoreRelationshipIDs = inlineDeltaRelationships.map(relationship => relationship.role.id);
 
-	const containersScriptDtos = getAlterContainersScriptDtos({ collection, app });
+	const { deletedContainersScriptDtos, upsertedContainersScriptDtos } = getAlterContainersScriptDtos({
+		collection,
+		app,
+	});
 
 	const collectionsScriptDtos = getAlterCollectionScriptDtos({
 		collection,
 		app,
 		modelDefinitions,
 		internalDefinitions,
 		externalDefinitions,
+		inlineDeltaRelationships,
 	});
 
 	const viewScriptDtos = getAlterViewScriptDtos(collection);
@@ -177,7 +246,13 @@ const getAlterScriptDtos = (data, app) => {
 		ignoreRelationshipIDs,
 	});
 
-	return [...containersScriptDtos, ...collectionsScriptDtos, ...viewScriptDtos, ...relationshipScriptDtos]
+	return [
+		...upsertedContainersScriptDtos,
+		...collectionsScriptDtos,
+		...viewScriptDtos,
+		...relationshipScriptDtos,
+		...deletedContainersScriptDtos,
+	]
 		.filter(Boolean)
 		.map(dto => dto && prettifyAlterScriptDto(dto))
 		.filter(Boolean);