-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement generator-base-entity-changes (#23357)
* implement base-entity-changelog * add config changes * add base-entity-changes to list * update snapshot * update list snapshot
- Loading branch information
Showing
35 changed files
with
640 additions
and
627 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /** | ||
| * Copyright 2013-2023 the original author or authors from the JHipster project. | ||
| * | ||
| * This file is part of the JHipster project, see https://www.jhipster.tech/ | ||
| * for more information. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import { existsSync, readFileSync } from 'fs'; | ||
| import GeneratorBaseApplication from '../base-application/index.mjs'; | ||
| import { PRIORITY_NAMES } from '../base-application/priorities.mjs'; | ||
| import { loadEntitiesAnnotations, loadEntitiesOtherSide } from '../base-application/support/index.mjs'; | ||
| import { relationshipEquals, relationshipNeedsForeignKeyRecreationOnly } from '../liquibase/support/index.mjs'; | ||
| import { addEntitiesOtherRelationships } from '../server/support/index.mjs'; | ||
| import type { BaseChangelog } from './types.js'; | ||
|
|
||
| const { DEFAULT, WRITING_ENTITIES, POST_WRITING_ENTITIES } = PRIORITY_NAMES; | ||
|
|
||
| const baseChangelog: () => Omit<BaseChangelog, 'changelogDate' | 'entityName' | 'entity'> = () => ({ | ||
| newEntity: false, | ||
| changedEntity: false, | ||
| incremental: false, | ||
| previousEntity: undefined, | ||
| addedFields: [], | ||
| removedFields: [], | ||
| addedRelationships: [], | ||
| removedRelationships: [], | ||
| relationshipsToRecreateForeignKeysOnly: [], | ||
| changelogData: {}, | ||
| }); | ||
|
|
||
| /** | ||
| * This is the base class for a generator for every generator. | ||
| */ | ||
| export default abstract class GeneratorBaseEntityChanges extends GeneratorBaseApplication { | ||
| recreateInitialChangelog!: boolean; | ||
| private entityChanges!: any[]; | ||
|
|
||
| abstract isChangelogNew({ entityName, changelogDate }): boolean; | ||
|
|
||
| protected getTaskFirstArgForPriority(priorityName): any { | ||
| const firstArg = super.getTaskFirstArgForPriority(priorityName); | ||
| if ([DEFAULT, WRITING_ENTITIES, POST_WRITING_ENTITIES].includes(priorityName)) { | ||
| this.entityChanges = this.generateIncrementalChanges(); | ||
| } | ||
| if ([DEFAULT].includes(priorityName)) { | ||
| return { ...firstArg, entityChanges: this.entityChanges }; | ||
| } | ||
| if ([WRITING_ENTITIES, POST_WRITING_ENTITIES].includes(priorityName)) { | ||
| // const { entities = [] } = this.options; | ||
| // const filteredEntities = data.entities.filter(entity => entities.includes(entity.name)); | ||
| return { ...firstArg, entityChanges: this.entityChanges }; | ||
| } | ||
| return firstArg; | ||
| } | ||
|
|
||
| /** | ||
| * Generate changelog from differences between the liquibase entity and current entity. | ||
| */ | ||
| protected generateIncrementalChanges(): BaseChangelog[] { | ||
| const recreateInitialChangelog = this.recreateInitialChangelog; | ||
| const { generateBuiltInUserEntity, incrementalChangelog } = this.sharedData.getApplication(); | ||
| const entityNames = this.getExistingEntityNames(); | ||
|
|
||
| const entitiesByName = Object.fromEntries(entityNames.map(entityName => [entityName, this.sharedData.getEntity(entityName)])); | ||
| const entitiesWithExistingChangelog = entityNames.filter( | ||
| entityName => !this.isChangelogNew({ entityName, changelogDate: entitiesByName[entityName].changelogDate }), | ||
| ); | ||
| const previousEntitiesByName = Object.fromEntries( | ||
| entityNames | ||
| .filter(entityName => existsSync(this.getEntityConfigPath(entityName))) | ||
| .map(entityName => [ | ||
| entityName, | ||
| { name: entityName, ...JSON.parse(readFileSync(this.getEntityConfigPath(entityName)).toString()) }, | ||
| ]), | ||
| ); | ||
| if (generateBuiltInUserEntity) { | ||
| const user = this.sharedData.getEntity('User'); | ||
| previousEntitiesByName.User = user; | ||
| } | ||
|
|
||
| const entities: any[] = Object.values(previousEntitiesByName); | ||
| loadEntitiesAnnotations(entities); | ||
| loadEntitiesOtherSide(entities); | ||
| addEntitiesOtherRelationships(entities); | ||
|
|
||
| // Compare entity changes and create changelogs | ||
| return entityNames.map(entityName => { | ||
| const newConfig: any = entitiesByName[entityName]; | ||
| const newFields: any[] = (newConfig.fields || []).filter((field: any) => !field.transient); | ||
| const newRelationships: any[] = newConfig.relationships || []; | ||
|
|
||
| const oldConfig: any = previousEntitiesByName[entityName]; | ||
|
|
||
| if (!oldConfig || recreateInitialChangelog || !incrementalChangelog || !entitiesWithExistingChangelog.includes(entityName)) { | ||
| return { | ||
| ...baseChangelog(), | ||
| incremental: newConfig.incrementalChangelog, | ||
| changelogDate: newConfig.changelogDate, | ||
| newEntity: true, | ||
| entity: newConfig, | ||
| entityName, | ||
| }; | ||
| } | ||
|
|
||
| (this as any)._debug(`Calculating diffs for ${entityName}`); | ||
|
|
||
| const oldFields: any[] = (oldConfig.fields || []).filter((field: any) => !field.transient); | ||
| const oldFieldNames: string[] = oldFields.filter(field => !field.id).map(field => field.fieldName); | ||
| const newFieldNames: string[] = newFields.filter(field => !field.id).map(field => field.fieldName); | ||
|
|
||
| // Calculate new fields | ||
| const addedFieldNames = newFieldNames.filter(fieldName => !oldFieldNames.includes(fieldName)); | ||
| const addedFields = addedFieldNames.map(fieldName => newFields.find(field => fieldName === field.fieldName)); | ||
| // Calculate removed fields | ||
| const removedFieldNames = oldFieldNames.filter(fieldName => !newFieldNames.includes(fieldName)); | ||
| const removedFields = removedFieldNames.map(fieldName => oldFields.find(field => fieldName === field.fieldName)); | ||
|
|
||
| const oldRelationships: any[] = oldConfig.relationships || []; | ||
|
|
||
| // Calculate changed/newly added relationships | ||
| const addedRelationships = newRelationships.filter( | ||
| newRelationship => | ||
| // id changes are not supported | ||
| !newRelationship.id && | ||
| // check if the same relationship wasn't already part of the old config | ||
| !oldRelationships.some(oldRelationship => relationshipEquals(oldRelationship, newRelationship)), | ||
| ); | ||
|
|
||
| // Calculate to be removed relationships | ||
| const removedRelationships = oldRelationships.filter( | ||
| oldRelationship => | ||
| // id changes are not supported | ||
| !oldRelationship.id && | ||
| // check if there are relationships not anymore in the new config | ||
| !newRelationships.some(newRelationship => relationshipEquals(newRelationship, oldRelationship)), | ||
| ); | ||
|
|
||
| // calcualte relationships that only need a foreign key recreation from the ones that are added | ||
| // we need both the added and the removed ones here | ||
| const relationshipsToRecreateForeignKeysOnly = addedRelationships | ||
| .filter(addedRelationship => | ||
| removedRelationships.some(removedRelationship => | ||
| relationshipNeedsForeignKeyRecreationOnly(removedRelationship, addedRelationship), | ||
| ), | ||
| ) | ||
| .concat( | ||
| removedRelationships.filter(removedRelationship => | ||
| addedRelationships.some(addedRelationship => relationshipNeedsForeignKeyRecreationOnly(addedRelationship, removedRelationship)), | ||
| ), | ||
| ); | ||
|
|
||
| return { | ||
| ...baseChangelog(), | ||
| previousEntity: oldConfig, | ||
| entity: newConfig, | ||
| incremental: true, | ||
| changedEntity: true, | ||
| entityName, | ||
| addedFields, | ||
| removedFields, | ||
| addedRelationships, | ||
| removedRelationships, | ||
| relationshipsToRecreateForeignKeysOnly, | ||
| }; | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export type { default } from './index.mjs'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| export type BaseChangelog = { | ||
| newEntity: boolean; | ||
| changedEntity: boolean; | ||
| incremental: boolean; | ||
|
|
||
| entityName: string; | ||
| entity: any; | ||
|
|
||
| changelogDate?: string; | ||
| previousEntity?: any; | ||
|
|
||
| addedFields: any[]; | ||
| removedFields: any[]; | ||
| addedRelationships: any[]; | ||
| removedRelationships: any[]; | ||
| relationshipsToRecreateForeignKeysOnly: any[]; | ||
| changelogData: any; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.