Allow defining default values on entity fields

Fix jhipster#25094
OmarHawk · Apr 12, 2024 · b467379 · b467379
1 parent 2ee82c4
commit b467379
Show file tree

Hide file tree

Showing 13 changed files with 1,229 additions and 112 deletions.
diff --git a/generators/angular/generator.ts b/generators/angular/generator.ts
@@ -160,6 +160,42 @@ export default class AngularGenerator extends BaseApplicationGenerator {
     return this.delegateTasksToBlueprint(() => this.preparingEachEntity);
   }
 
+  get preparingEachEntityField() {
+    return this.asPreparingEachEntityFieldTaskGroup({
+      prepareField({ field }) {
+        mutateData(field, {
+          fieldTsDefaultValue: ({ fieldTsDefaultValue, defaultValue, fieldTypeCharSequence, fieldTypeTimed }) => {
+            let returnValue: string | undefined;
+            if (fieldTsDefaultValue !== undefined || defaultValue !== undefined) {
+              let fieldDefaultValue;
+              if (fieldTsDefaultValue !== undefined) {
+                fieldDefaultValue = fieldTsDefaultValue;
+              } else {
+                fieldDefaultValue = defaultValue;
+              }
+
+              fieldDefaultValue = String(fieldDefaultValue).replace(/'/g, "\\'");
+
+              if (fieldTypeCharSequence) {
+                returnValue = `'${fieldDefaultValue}'`;
+              } else if (fieldTypeTimed) {
+                returnValue = `dayjs('${fieldDefaultValue}')`;
+              } else {
+                returnValue = fieldDefaultValue;
+              }
+            }
+
+            return returnValue;
+          },
+        });
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.PREPARING_EACH_ENTITY_FIELD]() {
+    return this.delegateTasksToBlueprint(() => this.preparingEachEntityField);
+  }
+
   get default() {
     return this.asDefaultTaskGroup({
       loadEntities() {

diff --git a/...lates/src/main/webapp/app/entities/_entityFolder_/update/_entityFile_-form.service.ts.ejs b/...lates/src/main/webapp/app/entities/_entityFolder_/update/_entityFile_-form.service.ts.ejs
@@ -200,12 +200,16 @@ _%>
   <%_ for (field of fields) {
         const { fieldName, fieldTypeBoolean, fieldTypeTimed, fieldTypeLocalDate } = field;
   _%>
-    <%_ if (field.id) { _%>
-      <%= fieldName %>: null,
-    <%_ } else if (fieldTypeBoolean) { _%>
-      <%= fieldName %>: false,
-    <%_ } else if (fieldTypeTimed) { _%>
-      <%= fieldName %>: currentTime,
+    <%_ if (field.fieldTsDefaultValue) { _%>
+        <%= fieldName %>: <%- field.fieldTsDefaultValue %>,
+    <%_ } else { _%>
+      <%_ if (field.id) { _%>
+        <%= fieldName %>: null,
+      <%_ } else if (fieldTypeBoolean) { _%>
+        <%= fieldName %>: false,
+      <%_ } else if (fieldTypeTimed) { _%>
+        <%= fieldName %>: currentTime,
+      <%_ } _%>
     <%_ } _%>
   <%_ } _%>
   <%_ for (const relationship of relationships.filter(({ persistableRelationship }) => persistableRelationship)) {

diff --git a/generators/base-application/support/prepare-field.js b/generators/base-application/support/prepare-field.js
@@ -242,7 +242,7 @@ function _derivedProperties(field) {
       fieldType === INTEGER || fieldType === LONG || fieldType === FLOAT || fieldType === DOUBLE || fieldType === BIG_DECIMAL,
     fieldTypeBinary: fieldType === BYTES || fieldType === BYTE_BUFFER,
     fieldTypeTimed: fieldType === ZONED_DATE_TIME || fieldType === INSTANT,
-    fieldTypeCharSequence: fieldType === STRING || fieldType === UUID,
+    fieldTypeCharSequence: fieldType === STRING || fieldType === UUID || fieldType === TEXT_BLOB,
     fieldTypeTemporal: fieldType === ZONED_DATE_TIME || fieldType === INSTANT || fieldType === LOCAL_DATE,
     fieldValidationRequired: validationRules.includes(REQUIRED),
     fieldValidationMin: validationRules.includes(MIN),

diff --git a/generators/base-entity-changes/generator.ts b/generators/base-entity-changes/generator.ts
@@ -36,6 +36,8 @@ const baseChangelog: () => Omit<BaseChangelog, 'changelogDate' | 'entityName' |
   addedRelationships: [],
   removedRelationships: [],
   relationshipsToRecreateForeignKeysOnly: [],
+  removedDefaultValueFields: [],
+  addedDefaultValueFields: [],
   changelogData: {},
 });
 
@@ -164,6 +166,33 @@ export default abstract class GeneratorBaseEntityChanges extends GeneratorBaseAp
           ),
         );
 
+      const oldFieldsWithDefaultValues = oldFields.filter(field => this.hasAnyDefaultValue(field));
+      const newFieldsWithDefaultValues = newFields.filter(field => this.hasAnyDefaultValue(field));
+
+      // find the old fields that have not been deleted anyway or otherwise where the default value is different on the same new field
+      const removedDefaultValueFields = oldFieldsWithDefaultValues
+        .filter(oldField => !removedFieldNames.includes(oldField.fieldName))
+        .filter(
+          // field was not removed, so check its default value
+          oldField =>
+            this.doDefaultValuesDiffer(
+              oldField,
+              newFields.find(newField => newField.fieldName === oldField.fieldName),
+            ),
+        );
+
+      // find the new fields that have not been added newly anyway or otherwise where the old field had a different default value
+      const addedDefaultValueFields = newFieldsWithDefaultValues
+        .filter(newField => !addedFieldNames.includes(newField.fieldName))
+        .filter(
+          // field was not added newly, so check its default value
+          newField =>
+            this.doDefaultValuesDiffer(
+              oldFields.find(oldField => oldField.fieldName === newField.fieldName),
+              newField,
+            ),
+        );
+
       return {
         ...baseChangelog(),
         previousEntity: oldConfig,
@@ -176,7 +205,17 @@ export default abstract class GeneratorBaseEntityChanges extends GeneratorBaseAp
         addedRelationships,
         removedRelationships,
         relationshipsToRecreateForeignKeysOnly,
+        removedDefaultValueFields,
+        addedDefaultValueFields,
       };
     });
   }
+
+  private hasAnyDefaultValue(field) {
+    return field.defaultValue !== undefined || field.defaultValueComputed;
+  }
+
+  private doDefaultValuesDiffer(field1, field2) {
+    return field1.defaultValue !== field2.defaultValue || field1.defaultValueComputed !== field2.defaultValueComputed;
+  }
 }
diff --git a/generators/base-entity-changes/types.d.ts b/generators/base-entity-changes/types.d.ts
@@ -14,5 +14,7 @@ export type BaseChangelog = {
   addedRelationships: any[];
   removedRelationships: any[];
   relationshipsToRecreateForeignKeysOnly: any[];
+  removedDefaultValueFields: any[];
+  addedDefaultValueFields: any[];
   changelogData: any;
 };
diff --git a/generators/bootstrap-application/generator.spec.ts b/generators/bootstrap-application/generator.spec.ts
@@ -275,6 +275,8 @@ describe(`generator - ${generator}`, () => {
       "createRandexp": Any<Function>,
       "dynamic": false,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Id",
       "fieldIsEnum": false,
       "fieldName": "id",
@@ -331,6 +333,8 @@ describe(`generator - ${generator}`, () => {
       "jpaGeneratedValue": true,
       "jpaGeneratedValueIdentity": false,
       "jpaGeneratedValueSequence": false,
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "\${uuidType}",
       "nullable": true,
       "path": [
@@ -359,6 +363,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(50)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Login",
       "fieldIsEnum": false,
       "fieldName": "login",
@@ -418,6 +424,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""login1"",
       "javaValueSample2": ""login2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 50,
       "nullable": false,
@@ -446,6 +454,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(50)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "FirstName",
       "fieldIsEnum": false,
       "fieldName": "firstName",
@@ -501,6 +511,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""firstName1"",
       "javaValueSample2": ""firstName2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 50,
       "nullable": true,
@@ -528,6 +540,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(50)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "LastName",
       "fieldIsEnum": false,
       "fieldName": "lastName",
@@ -583,6 +597,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""lastName1"",
       "javaValueSample2": ""lastName2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 50,
       "nullable": true,
@@ -610,6 +626,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(191)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Email",
       "fieldIsEnum": false,
       "fieldName": "email",
@@ -669,6 +687,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""email1"",
       "javaValueSample2": ""email2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 191,
       "nullable": false,
@@ -697,6 +717,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(256)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "ImageUrl",
       "fieldIsEnum": false,
       "fieldName": "imageUrl",
@@ -752,6 +774,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""imageUrl1"",
       "javaValueSample2": ""imageUrl2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 256,
       "nullable": true,
@@ -780,6 +804,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "boolean",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Activated",
       "fieldIsEnum": false,
       "fieldName": "activated",
@@ -828,6 +854,8 @@ describe(`generator - ${generator}`, () => {
       "fieldWithContentType": false,
       "generateFakeData": Any<Function>,
       "javaFieldType": "Boolean",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "boolean",
       "nullable": true,
       "path": [
@@ -854,6 +882,8 @@ describe(`generator - ${generator}`, () => {
       "columnType": "varchar(10)",
       "createRandexp": Any<Function>,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "LangKey",
       "fieldIsEnum": false,
       "fieldName": "langKey",
@@ -909,6 +939,8 @@ describe(`generator - ${generator}`, () => {
       "javaValueGenerator": "UUID.randomUUID().toString()",
       "javaValueSample1": ""langKey1"",
       "javaValueSample2": ""langKey2"",
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "string",
       "maxlength": 10,
       "nullable": true,
@@ -1140,6 +1172,8 @@ describe(`generator - ${generator}`, () => {
       "createRandexp": Any<Function>,
       "dynamic": false,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Id",
       "fieldIsEnum": false,
       "fieldName": "id",
@@ -1195,6 +1229,8 @@ describe(`generator - ${generator}`, () => {
       "jpaGeneratedValue": true,
       "jpaGeneratedValueIdentity": false,
       "jpaGeneratedValueSequence": false,
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "\${uuidType}",
       "nullable": true,
       "path": [
@@ -1479,6 +1515,8 @@ describe(`generator - ${generator}`, () => {
       "createRandexp": Any<Function>,
       "dynamic": false,
       "entity": Any<Object>,
+      "fieldDefaultValueDefined": false,
+      "fieldHasAnyDefaultValue": false,
       "fieldInJavaBeanMethod": "Id",
       "fieldIsEnum": false,
       "fieldName": "id",
@@ -1534,6 +1572,8 @@ describe(`generator - ${generator}`, () => {
       "jpaGeneratedValue": true,
       "jpaGeneratedValueIdentity": false,
       "jpaGeneratedValueSequence": false,
+      "liquibaseDefaultValueAttributeName": undefined,
+      "liquibaseDefaultValueAttributeValue": undefined,
       "loadColumnType": "\${uuidType}",
       "nullable": true,
       "path": [