Skip to content

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

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.

Sign up for GitHub

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

Merged
Nightlngale merged 14 commits into from
Jan 19, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f2d6ec7
HCK-14285: Add logic to display added/dropped tables
Nightlngale Jan 14, 2026
cb6c4cc
HCK-14285: Fix deleting of wrong tables
Nightlngale Jan 14, 2026
2461552
HCK-14285: Add logic to create/drop table column
Nightlngale Jan 15, 2026
765c995
HCK-14285: Do not render columns of deleted tables
Nightlngale Jan 15, 2026
3e5894b
HCK-14285: Add logic to change column's data type
Nightlngale Jan 15, 2026
89dddd4
Merge branch 'develop' into HCK-14285
Nightlngale Jan 15, 2026
aa74dcf
Merge branch 'develop' into HCK-14285
Nightlngale Jan 16, 2026
c472253
HCK-14285: Add logic to rename columns
Nightlngale Jan 17, 2026
d3fbbdc
HCK-14285: Add JS doc
Nightlngale Jan 17, 2026
7626cd4
HCK-14285: Fix drop FK logic
Nightlngale Jan 18, 2026
0a78867
Fix SQ warnings
Nightlngale Jan 19, 2026
36c59f3
Fix SQ warnings
Nightlngale Jan 19, 2026
47ff708
HCK-14324: Add explanation on why DROP SCHEMA is executed afterward
Nightlngale Jan 19, 2026
ff0fe66
Fix comments
Nightlngale Jan 19, 2026
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
119 changes: 97 additions & 22 deletions forward_engineering/alterScript/alterScriptFromDeltaHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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);
Expand All @@ -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])
Expand All @@ -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)
Expand Down Expand Up @@ -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 [];
Expand All @@ -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,
Expand All @@ -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);

Expand All @@ -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);
Expand All @@ -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);
Expand Down
Loading