generator-jhipster 8.3.0 → 8.5.0

package/dist/generators/liquibase/generator.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import fs from 'fs';
-import { min } from 'lodash-es';
+import { escape, min } from 'lodash-es';
 import BaseEntityChangesGenerator from '../base-entity-changes/index.js';
 import { liquibaseFiles } from './files.js';
 import { prepareField as prepareFieldForLiquibase, postPrepareEntity, prepareRelationshipForLiquibase, liquibaseComment, } from './support/index.js';
@@ -97,6 +97,11 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
                     prepareFieldForLiquibase(entity, field);
                 }
             },
+            validateConsistencyOfField({ entity, field }) {
+                if (field.columnRequired && field.liquibaseDefaultValueAttributeValue) {
+                    this.handleCheckFailure(`The field ${field.fieldName} in entity ${entity.name} has both columnRequired and a defaultValue, this can lead to unexpected behaviors.`);
+                }
+            },
         });
     }
     get [BaseEntityChangesGenerator.PREPARING_EACH_ENTITY_FIELD]() {
@@ -178,6 +183,8 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
                                 fieldChangelog: true,
                                 addedRelationships: [],
                                 removedRelationships: [],
+                                removedDefaultValueFields: [],
+                                addedDefaultValueFields: [],
                                 relationshipsToRecreateForeignKeysOnly: [],
                             },
                             application,
@@ -187,7 +194,10 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
                 // Relationships needs to be added later to make sure every related field is already added.
                 for (const databaseChangelog of changes) {
                     if (databaseChangelog.incremental &&
-                        (databaseChangelog.addedRelationships.length > 0 || databaseChangelog.removedRelationships.length > 0)) {
+                        (databaseChangelog.addedRelationships.length > 0 ||
+                            databaseChangelog.removedRelationships.length > 0 ||
+                            databaseChangelog.removedDefaultValueFields.length > 0 ||
+                            databaseChangelog.addedDefaultValueFields.length > 0)) {
                         this.databaseChangelogs.push(this.prepareChangelog({
                             databaseChangelog: {
                                 ...databaseChangelog,
@@ -490,7 +500,7 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
      * Write files for updated entities.
      */
     _writeUpdateFiles({ context: writeContext, changelogData }) {
-        const { addedFields, allFields, removedFields, addedRelationships, removedRelationships, hasFieldConstraint, hasRelationshipConstraint, shouldWriteAnyRelationship, relationshipsToRecreateForeignKeysOnly, } = changelogData;
+        const { addedFields, allFields, removedFields, addedRelationships, removedRelationships, hasFieldConstraint, hasRelationshipConstraint, shouldWriteAnyRelationship, relationshipsToRecreateForeignKeysOnly, hasDefaultValueChange, removedDefaultValueFields, addedDefaultValueFields, } = changelogData;
         const context = {
             ...writeContext,
             skipFakeData: changelogData.skipFakeData,
@@ -505,29 +515,45 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
             hasRelationshipConstraint,
             shouldWriteAnyRelationship,
             relationshipsToRecreateForeignKeysOnly,
+            hasDefaultValueChange,
+            removedDefaultValueFields,
+            addedDefaultValueFields,
         };
         const promises = [];
-        promises.push(this.writeFiles({ sections: updateEntityFiles, context }));
-        if (!changelogData.skipFakeData && (changelogData.addedFields.length > 0 || shouldWriteAnyRelationship)) {
+        if (this._isBasicEntityUpdate(changelogData)) {
+            promises.push(this.writeFiles({ sections: updateEntityFiles, context }));
+        }
+        if (this._requiresWritingFakeData(changelogData)) {
             promises.push(this.writeFiles({ sections: fakeFiles, context }));
             promises.push(this.writeFiles({ sections: updateMigrateFiles, context }));
         }
-        if (hasFieldConstraint || shouldWriteAnyRelationship) {
+        if (this._requiresConstraintUpdates(changelogData)) {
             promises.push(this.writeFiles({ sections: updateConstraintsFiles, context }));
         }
         return Promise.all(promises);
     }
+    _requiresConstraintUpdates(changelogData) {
+        return changelogData.hasFieldConstraint || changelogData.addedRelationships.length > 0 || changelogData.hasDefaultValueChange;
+    }
+    _isBasicEntityUpdate(changelogData) {
+        return changelogData.addedFields.length > 0 || changelogData.removedFields.length > 0 || changelogData.shouldWriteAnyRelationship;
+    }
+    _requiresWritingFakeData(changelogData) {
+        return !changelogData.skipFakeData && (changelogData.addedFields.length || changelogData.addedRelationships.length);
+    }
     /**
      * Write files for updated entities.
      */
     _addUpdateFilesReferences({ entity, databaseChangelog, changelogData, source }) {
-        source.addLiquibaseIncrementalChangelog({ changelogName: `${databaseChangelog.changelogDate}_updated_entity_${entity.entityClass}` });
-        if (!changelogData.skipFakeData && (changelogData.addedFields.length > 0 || changelogData.shouldWriteAnyRelationship)) {
+        if (this._isBasicEntityUpdate(changelogData)) {
+            source.addLiquibaseIncrementalChangelog({ changelogName: `${databaseChangelog.changelogDate}_updated_entity_${entity.entityClass}` });
+        }
+        if (this._requiresWritingFakeData(changelogData)) {
             source.addLiquibaseIncrementalChangelog({
                 changelogName: `${databaseChangelog.changelogDate}_updated_entity_migrate_${entity.entityClass}`,
             });
         }
-        if (changelogData.hasFieldConstraint || changelogData.shouldWriteAnyRelationship) {
+        if (this._requiresConstraintUpdates(changelogData)) {
             source.addLiquibaseIncrementalChangelog({
                 changelogName: `${databaseChangelog.changelogDate}_updated_entity_constraints_${entity.entityClass}`,
             });
@@ -544,6 +570,19 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
     formatAsLiquibaseRemarks(text, addRemarksTag = false) {
         return liquibaseComment(text, addRemarksTag);
     }
+    /**
+     * @private
+     * Create the fitting liquibase default value attribute for a field.
+     * @param field
+     * @param leadingWhitespace
+     * @returns
+     */
+    createDefaultValueLiquibaseAttribute(field, leadingWhitespace = false) {
+        if (field.liquibaseDefaultValueAttributeValue === undefined) {
+            return '';
+        }
+        return `${leadingWhitespace ? ' ' : ''}${field.liquibaseDefaultValueAttributeName}="${escape(field.liquibaseDefaultValueAttributeValue)}"`;
+    }
     prepareChangelog({ databaseChangelog, application }) {
         if (!databaseChangelog.changelogDate) {
             databaseChangelog.changelogDate = this.dateFormatForLiquibase();
@@ -610,6 +649,8 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
             entityChanges.addedRelationships = databaseChangelog.addedRelationships;
             entityChanges.removedRelationships = databaseChangelog.removedRelationships;
             entityChanges.relationshipsToRecreateForeignKeysOnly = databaseChangelog.relationshipsToRecreateForeignKeysOnly;
+            entityChanges.removedDefaultValueFields = databaseChangelog.removedDefaultValueFields;
+            entityChanges.addedDefaultValueFields = databaseChangelog.addedDefaultValueFields;
         }
         /* Required by the templates */
         databaseChangelog.writeContext = {
@@ -631,11 +672,17 @@ export default class LiquibaseGenerator extends BaseEntityChangesGenerator {
             entityChanges.addedFields.length > 0 ||
                 entityChanges.removedFields.length > 0 ||
                 entityChanges.addedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable) ||
-                entityChanges.removedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable);
+                entityChanges.removedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable) ||
+                entityChanges.addedDefaultValueFields.length > 0 ||
+                entityChanges.removedDefaultValueFields.length > 0;
         if (entityChanges.requiresUpdateChangelogs) {
-            entityChanges.hasFieldConstraint = entityChanges.addedFields.some(field => field.unique || !field.nullable);
+            entityChanges.hasFieldConstraint = entityChanges.addedFields.some(field => field.unique || (field.columnRequired && !field.liquibaseDefaultValueAttributeValue) || field.shouldCreateContentType);
+            entityChanges.hasDefaultValueChange =
+                entityChanges.addedDefaultValueFields.length > 0 || entityChanges.removedDefaultValueFields.length > 0;
             entityChanges.hasRelationshipConstraint = entityChanges.addedRelationships.some(relationship => (relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable) && (relationship.unique || !relationship.nullable));
-            entityChanges.shouldWriteAnyRelationship = entityChanges.addedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable);
+            entityChanges.shouldWriteAnyRelationship =
+                entityChanges.addedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable) ||
+                    entityChanges.removedRelationships.some(relationship => relationship.shouldWriteRelationship || relationship.shouldWriteJoinTable);
         }
         return databaseChangelog;
     }

package/dist/generators/liquibase/support/prepare-field.js

@@ -114,11 +114,26 @@ export default function prepareField(entity, field) {
     mutateData(field, {
         __override__: false,
         columnType: data => parseLiquibaseColumnType(entity, data),
-        shouldDropDefaultValue: data => data.fieldType === ZONED_DATE_TIME || data.fieldType === INSTANT,
+        liquibaseDefaultValueAttributeValue: ({ defaultValue, defaultValueComputed }) => defaultValueComputed ?? defaultValue?.toString(),
+        liquibaseDefaultValueAttributeName: ({ defaultValueComputed, liquibaseDefaultValueAttributeValue }) => {
+            if (liquibaseDefaultValueAttributeValue === undefined)
+                return undefined;
+            if (defaultValueComputed)
+                return 'defaultValueComputed';
+            if (field.fieldTypeNumeric)
+                return 'defaultValueNumeric';
+            if (field.fieldTypeDateTime)
+                return 'defaultValueDate';
+            if (field.fieldTypeBoolean)
+                return 'defaultValueBoolean';
+            return 'defaultValue';
+        },
+        shouldDropDefaultValue: data => !data.liquibaseDefaultValueAttributeValue && (data.fieldType === ZONED_DATE_TIME || data.fieldType === INSTANT),
         shouldCreateContentType: data => data.fieldType === BYTES && data.fieldTypeBlobContent !== TEXT,
         columnRequired: data => data.nullable === false || (data.fieldValidate === true && data.fieldValidateRules.includes('required')),
         nullable: data => !data.columnRequired,
         loadColumnType: data => parseLiquibaseLoadColumnType(entity, data),
+        liquibaseGenerateFakeData: true,
     });
     return field;
 }

package/dist/generators/liquibase/support/relationship.js

@@ -65,6 +65,7 @@ export function prepareRelationshipForLiquibase(entity, relationship) {
         __override__: false,
         columnDataType: data => data.otherEntity.columnType,
         columnRequired: data => data.nullable === false || data.relationshipRequired,
+        liquibaseGenerateFakeData: data => data.columnRequired && data.persistableRelationship && !data.collection,
     });
     return relationship;
 }

package/dist/generators/liquibase/templates/src/main/resources/config/liquibase/changelog/added_entity.xml.ejs

@@ -30,7 +30,7 @@
     <changeSet id="<%= changelogDate %>-1" author="jhipster">
         <createTable tableName="<%= entity.entityTableName %>"<%- this.formatAsLiquibaseRemarks(entity.documentation, true) %>>
 <%_ for (field of fields) { _%>
-            <column name="<%= field.columnName %>" type="<%= field.columnType %>"<%- this.formatAsLiquibaseRemarks(field.documentation, true) %><% if (field.id && field.liquibaseAutoIncrement) { %> autoIncrement="true" startWith="1500"<%_ } %>>
+            <column name="<%= field.columnName %>" type="<%= field.columnType %>"<%- this.createDefaultValueLiquibaseAttribute(field, true) -%><%- this.formatAsLiquibaseRemarks(field.documentation, true) %><% if (field.id && field.liquibaseAutoIncrement) { %> autoIncrement="true" startWith="1500"<%_ } %>>
     <%_ if (field.id) { _%>
                 <constraints primaryKey="true" nullable="false"/>
     <%_ } else if (field.unique) { _%>

package/dist/generators/liquibase/templates/src/main/resources/config/liquibase/changelog/updated_entity.xml.ejs

@@ -25,15 +25,15 @@
     <changeSet id="<%= changelogDate %>-1-add-columns" author="jhipster">
         <addColumn tableName="<%= entity.entityTableName %>">
     <%_ for (field of addedFields) { _%>
-            <column name="<%= field.columnName %>" type="<%= field.columnType %>"<%- this.formatAsLiquibaseRemarks(field.documentation, true) %>/>
+            <column name="<%= field.columnName %>" type="<%= field.columnType %>"<%- this.createDefaultValueLiquibaseAttribute(field, true) -%><%- this.formatAsLiquibaseRemarks(field.documentation, true) %>/>
         <%_ if (field.shouldCreateContentType) { _%>
             <column name="<%= field.columnName %>_content_type" type="varchar(255)"/>
         <%_ }
     } // End for (field of addedFields) _%>
         </addColumn>
     <%_ for (field of addedFields) {
-        if (field.fieldType === 'ZonedDateTime' || field.fieldType === 'Instant') { _%>
-        <dropDefaultValue tableName="<%= entity.entityTableName %>" columnName="<%= field.columnName %>" columnDataType="datetime"/>
+        if (field.shouldDropDefaultValue) { _%>
+        <dropDefaultValue tableName="<%= entity.entityTableName %>" columnName="<%= field.columnName %>" columnDataType="${datetimeType}"/>
         <%_ } _%>
     <%_ } _%>
     </changeSet>

package/dist/generators/liquibase/templates/src/main/resources/config/liquibase/changelog/updated_entity_constraints.xml.ejs

@@ -48,6 +48,31 @@ if (hasFieldConstraint) { _%>
     } _%>
     </changeSet>
 <% } _%>
+<%_ if (removedDefaultValueFields && removedDefaultValueFields.length) { _%>
+    <!--
+        Removed the default value for the fields for entity <%= entityClass %>.
+    -->
+    <changeSet id="<%= changelogDate %>-fields-remove-default-value" author="jhipster">
+    <%_ for (field of removedDefaultValueFields) { _%>
+        <dropDefaultValue tableName="<%= entityTableName %>"
+            columnName="<%= field.columnName %>"
+            columnDataType="<%= field.columnType %>"/>
+    <%_ } _%>
+    </changeSet>
+<% } _%>
+<%_ if (addedDefaultValueFields && addedDefaultValueFields.length) { _%>
+    <!--
+        Added the default value for the fields for entity <%= entityClass %>.
+    -->
+    <changeSet id="<%= changelogDate %>-fields-add-default-value" author="jhipster">
+    <%_ for (field of addedDefaultValueFields) { _%>
+        <addDefaultValue tableName="<%= entityTableName %>"
+            columnName="<%= field.columnName %>"
+            columnDataType="<%= field.columnType %>"
+            <%- this.createDefaultValueLiquibaseAttribute(field) -%>/>
+    <%_ } _%>
+    </changeSet>
+<% } _%>
 <%_ if (hasRelationshipConstraint) { _%>
 
     <!--
@@ -74,7 +99,7 @@ if (hasFieldConstraint) { _%>
      } _%>
     </changeSet>
 <%_ } _%>
-<%_ if (shouldWriteAnyRelationship) { %>
+<%_ if (addedRelationships && addedRelationships.length) { %>
 
     <!--
         Added the relationship constraints for entity <%= entityClass %>.

package/dist/generators/liquibase/templates/src/main/resources/config/liquibase/fake-data/table_entity.csv.ejs

@@ -21,14 +21,14 @@ let table = [];
 
 // Generate CSV header
 let header = [];
-const fieldsToGenerate = [...allFields.filter(f => f.id), ...fields.filter(f => !f.id)];
+const fieldsToGenerate = [...allFields.filter(f => f.id), ...fields.filter(f => !f.id)].filter(field => field.liquibaseGenerateFakeData);
 for (field of fieldsToGenerate) {
   header.push(field.columnName);
   if (field.shouldCreateContentType) {
     header.push(field.columnName + '_content_type');
   }
 }
-for (relationship of relationships.filter(relationship => relationship.columnRequired && relationship.persistableRelationship && !relationship.collection)) {
+for (relationship of relationships.filter(relationship => relationship.liquibaseGenerateFakeData)) {
   const { joinColumnNames } = relationship;
   header.push(joinColumnNames[0]);
 }
@@ -57,7 +57,7 @@ for (lineNb = 0; lineNb < entity.fakeDataCount; lineNb++) {
     }
   }
 
-  for (relationship of relationships.filter(relationship => relationship.columnRequired && relationship.persistableRelationship && !relationship.collection)) {
+  for (relationship of relationships.filter(relationship => relationship.liquibaseGenerateFakeData)) {
     const relationshipType = relationship.relationshipType;
     const otherLiquibaseFakeData = relationship.otherEntity.liquibaseFakeData;
     let relationshipRow = lineNb;

package/dist/generators/maven/templates/.mvn/wrapper/maven-wrapper.properties

@@ -14,5 +14,5 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
+wrapperVersion=3.3.2
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip