generator-jhipster 7.3.0 → 7.5.0

package/generators/entities/index.js

@@ -21,8 +21,6 @@ const { JHIPSTER_CONFIG_DIR } = require('../generator-constants');
 const { SQL } = require('../../jdl/jhipster/database-types');
 const { GENERATOR_ENTITIES, GENERATOR_ENTITIES_CLIENT, GENERATOR_ENTITY, GENERATOR_DATABASE_CHANGELOG } = require('../generator-list');
 
-let useBlueprints;
-
 module.exports = class extends BaseBlueprintGenerator {
   constructor(args, options, features) {
     super(args, options, { unique: 'namespace', ...features });
@@ -75,10 +73,12 @@ module.exports = class extends BaseBlueprintGenerator {
       defaults: true,
       hide: true,
     });
+  }
 
-    if (this.options.help) return;
-
-    useBlueprints = !this.fromBlueprint && this.instantiateBlueprints(GENERATOR_ENTITIES);
+  async _postConstruct() {
+    if (!this.fromBlueprint) {
+      await this.composeWithBlueprints(GENERATOR_ENTITIES);
+    }
 
     if (this.options.entitiesToImport) {
       const entities = this.jhipsterConfig.entities || [];
@@ -123,28 +123,31 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get initializing() {
-    return useBlueprints ? undefined : this._initializing();
+    if (this.delegateToBlueprint) return {};
+    return this._initializing();
   }
 
   // Public API method used by the getter and also by Blueprints
   _composing() {
     return {
-      composeEachEntity() {
-        this.getExistingEntityNames().forEach(entityName => {
-          if (this.options.composedEntities && this.options.composedEntities.includes(entityName)) return;
-          const selectedEntity = this.options.entities.includes(entityName);
-          const { regenerate = !selectedEntity } = this.options;
-          this.composeWithJHipster(GENERATOR_ENTITY, [entityName], {
-            skipWriting: !this.options.writeEveryEntity && !selectedEntity,
-            regenerate,
-            skipDbChangelog: this.jhipsterConfig.databaseType === SQL || this.options.skipDbChangelog,
-            skipInstall: true,
-            skipPrompts: this.options.skipPrompts,
-          });
-        });
+      async composeEachEntity() {
+        return Promise.all(
+          this.getExistingEntityNames().map(async entityName => {
+            if (this.options.composedEntities && this.options.composedEntities.includes(entityName)) return;
+            const selectedEntity = this.options.entities.includes(entityName);
+            const { regenerate = !selectedEntity } = this.options;
+            await this.composeWithJHipster(GENERATOR_ENTITY, [entityName], {
+              skipWriting: !this.options.writeEveryEntity && !selectedEntity,
+              regenerate,
+              skipDbChangelog: this.jhipsterConfig.databaseType === SQL || this.options.skipDbChangelog,
+              skipInstall: true,
+              skipPrompts: this.options.skipPrompts,
+            });
+          })
+        );
       },
 
-      databaseChangelog() {
+      async databaseChangelog() {
         if (this.jhipsterConfig.skipServer || this.jhipsterConfig.databaseType !== SQL || this.options.skipDbChangelog) {
           return;
         }
@@ -153,19 +156,23 @@ module.exports = class extends BaseBlueprintGenerator {
           return;
         }
 
-        this.composeWithJHipster(GENERATOR_DATABASE_CHANGELOG, this.options.writeEveryEntity ? existingEntities : this.options.entities);
+        await this.composeWithJHipster(
+          GENERATOR_DATABASE_CHANGELOG,
+          this.options.writeEveryEntity ? existingEntities : this.options.entities
+        );
       },
     };
   }
 
   get composing() {
-    return useBlueprints ? undefined : this._composing();
+    if (this.delegateToBlueprint) return {};
+    return this._composing();
   }
 
   // Public API method used by the getter and also by Blueprints
   _default() {
     return {
-      composeEntitiesClient() {
+      async composeEntitiesClient() {
         if (this.options.entities.length !== this.jhipsterConfig.entities.length) return;
         const clientEntities = this.getExistingEntityNames()
           .map(entityName => {
@@ -177,7 +184,7 @@ module.exports = class extends BaseBlueprintGenerator {
           })
           .filter(entity => !entity.skipClient);
         if (clientEntities.length === 0) return;
-        this.composeWithJHipster(GENERATOR_ENTITIES_CLIENT, clientEntities, {
+        await this.composeWithJHipster(GENERATOR_ENTITIES_CLIENT, clientEntities, {
           skipInstall: this.options.skipInstall,
         });
       },
@@ -185,7 +192,8 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get default() {
-    return useBlueprints ? undefined : this._default();
+    if (this.delegateToBlueprint) return {};
+    return this._default();
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -194,6 +202,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get writing() {
-    return useBlueprints ? undefined : this._writing();
+    if (this.delegateToBlueprint) return {};
+    return this._writing();
   }
 };

package/generators/entities-client/index.js

@@ -19,14 +19,17 @@
 const BaseBlueprintGenerator = require('../generator-base-blueprint');
 const { GENERATOR_ENTITIES_CLIENT } = require('../generator-list');
 
-let useBlueprints;
-
 module.exports = class extends BaseBlueprintGenerator {
   constructor(args, options, features) {
     super(args, options, features);
     if (this.options.help) return;
     this.clientEntities = this.options.clientEntities;
-    useBlueprints = !this.fromBlueprint && this.instantiateBlueprints(GENERATOR_ENTITIES_CLIENT);
+  }
+
+  async _postConstruct() {
+    if (!this.fromBlueprint) {
+      await this.composeWithBlueprints(GENERATOR_ENTITIES_CLIENT);
+    }
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -39,7 +42,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get initializing() {
-    return useBlueprints ? undefined : this._initializing();
+    return this.delegateToBlueprint ? undefined : this._initializing();
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -52,7 +55,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get loading() {
-    return useBlueprints ? undefined : this._loading();
+    return this.delegateToBlueprint ? undefined : this._loading();
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -67,7 +70,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get default() {
-    return useBlueprints ? undefined : this._default();
+    return this.delegateToBlueprint ? undefined : this._default();
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -82,6 +85,6 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get end() {
-    return useBlueprints ? undefined : this._end();
+    return this.delegateToBlueprint ? undefined : this._end();
   }
 };

package/generators/entity/index.js

@@ -38,6 +38,8 @@ const { prepareFieldForTemplates, fieldIsEnum } = require('../../utils/field');
 const { prepareRelationshipForTemplates } = require('../../utils/relationship');
 const { stringify } = require('../../utils');
 const { GATEWAY, MICROSERVICE } = require('../../jdl/jhipster/application-types');
+const { NO: CLIENT_FRAMEWORK_NO } = require('../../jdl/jhipster/client-framework-types');
+const { NO: SEARCH_ENGINE_NO } = require('../../jdl/jhipster/search-engine-types');
 const { CASSANDRA, COUCHBASE, MONGODB, NEO4J, ORACLE, SQL } = require('../../jdl/jhipster/database-types');
 const {
   GENERATOR_ENTITIES,
@@ -65,8 +67,6 @@ const SUPPORTED_VALIDATION_RULES = constants.SUPPORTED_VALIDATION_RULES;
 const ANGULAR = constants.SUPPORTED_CLIENT_FRAMEWORKS.ANGULAR;
 const JHIPSTER_CONFIG_DIR = constants.JHIPSTER_CONFIG_DIR;
 
-let useBlueprints;
-
 class EntityGenerator extends BaseBlueprintGenerator {
   constructor(args, options, features) {
     super(args, options, { unique: 'argument', ...features });
@@ -148,11 +148,9 @@ class EntityGenerator extends BaseBlueprintGenerator {
       desc: 'Regenerate only a single entity, relationships can be not correctly generated',
       type: Boolean,
     });
+  }
 
-    if (this.options.help) {
-      return;
-    }
-
+  async _postConstruct() {
     const name = _.upperFirst(this.options.name).replace('.json', '');
     this.entityStorage = this.getEntityConfig(name, true);
     this.entityConfig = this.entityStorage.createProxy();
@@ -169,14 +167,15 @@ class EntityGenerator extends BaseBlueprintGenerator {
       configurationFileExists: this.fs.exists(this.destinationPath(filename)),
     };
 
-    this._setupEntityOptions(this, this, this.context);
-    useBlueprints =
-      !this.fromBlueprint &&
-      this.instantiateBlueprints(GENERATOR_ENTITY, {
+    if (!this.fromBlueprint) {
+      await this.composeWithBlueprints(GENERATOR_ENTITY, {
         entityExisted,
         configExisted,
         arguments: [name],
       });
+    }
+
+    this._setupEntityOptions(this, this, this.context);
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -207,7 +206,6 @@ class EntityGenerator extends BaseBlueprintGenerator {
         const context = this.context;
 
         if (this.jhipsterConfig.applicationType === MICROSERVICE) {
-          context.skipClient = context.skipClient || !this.jhipsterConfig.microfrontend;
           context.microserviceName = this.entityConfig.microserviceName = this.jhipsterConfig.baseName;
           if (!this.entityConfig.clientRootFolder) {
             context.clientRootFolder = this.entityConfig.clientRootFolder = this.entityConfig.microserviceName;
@@ -235,6 +233,15 @@ class EntityGenerator extends BaseBlueprintGenerator {
               ? ''
               : this.entityConfig.microserviceName;
           }
+
+          if (this.jhipsterConfig.applications && !this.entityConfig.skipClient) {
+            const remoteConfig = this.jhipsterConfig.applications[this.entityConfig.microserviceName];
+            if (remoteConfig && remoteConfig.clientFramework && remoteConfig.clientFramework !== CLIENT_FRAMEWORK_NO) {
+              // Gateway requires entities to discover a microfrontend.
+              // Microfrontends is generated at the microservice side, so skip it at gateway side.
+              this.entityConfig.skipClient = true;
+            }
+          }
         }
       },
 
@@ -304,7 +311,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get initializing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._initializing();
   }
 
@@ -326,7 +333,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get prompting() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._prompting();
   }
 
@@ -356,8 +363,34 @@ class EntityGenerator extends BaseBlueprintGenerator {
           throw new Error(validation);
         }
 
+        if (this.entityConfig.searchEngine === undefined) {
+          const backendOnlyMicroservice =
+            context.applicationType === MICROSERVICE && (!context.clientFramework || context.clientFramework === CLIENT_FRAMEWORK_NO);
+          if (backendOnlyMicroservice && context.searchEngine && context.searchEngine !== SEARCH_ENGINE_NO && !context.entityExisted) {
+            // Propagate searchEngine to the entity, it's opt-in and should be propagated to gateway
+            this.entityConfig.searchEngine = true;
+          }
+        } else if (
+          (!context.searchEngine || context.searchEngine === SEARCH_ENGINE_NO) &&
+          (context.applicationType !== GATEWAY || !this.entityConfig.microserviceName)
+        ) {
+          if (this.entityConfig.searchEngine === SEARCH_ENGINE_NO) {
+            // Convert to boolean.
+            this.entityConfig.searchEngine = false;
+          }
+          // If search engine is disabled at application, and unless it's a gateway publishing a microservice entity.
+          if (this.entityConfig.searchEngine) {
+            this.warning('Search engine disabled at application, cannot be enabled at entity, disabling');
+            this.entityConfig.searchEngine = false;
+          }
+        }
+
         this.entityConfig.name = this.entityConfig.name || context.name;
-        if (![SQL, MONGODB, COUCHBASE, NEO4J].includes(context.databaseType)) {
+        // disable pagination if there is no database, unless it’s a microservice entity published by a gateway
+        if (
+          ![SQL, MONGODB, COUCHBASE, NEO4J].includes(context.databaseType) &&
+          (context.applicationType !== GATEWAY || !this.entityConfig.microserviceName)
+        ) {
           this.entityConfig.pagination = NO_PAGINATION;
         }
 
@@ -456,16 +489,16 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get configuring() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._configuring();
   }
 
   // Public API method used by the getter and also by Blueprints
   _composing() {
     return {
-      composeEntities() {
+      async composeEntities() {
         // We need to compose with others entities to update relationships.
-        this.composeWithJHipster(
+        await this.composeWithJHipster(
           GENERATOR_ENTITIES,
           {
             entities: this.options.singleEntity ? [this.context.name] : undefined,
@@ -482,7 +515,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get composing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._composing();
   }
 
@@ -490,13 +523,25 @@ class EntityGenerator extends BaseBlueprintGenerator {
   _loading() {
     return {
       loadEntity() {
+        loadRequiredConfigIntoEntity(this.context, this.jhipsterConfig);
         // Update current context with config from file.
         Object.assign(this.context, this.entityStorage.getAll());
         this.loadDerivedAppConfig(this.context);
+
+        // Entity searchEngine support should opt-in instead of opt-out for gateway/microservice.
+        // The entity definition should take precedence so frontend and backend are in sync.
+        // Doesn't apply to microfrontends.
+        if (
+          this.entityConfig.searchEngine === undefined &&
+          !this.context.microfrontend &&
+          (this.context.applicationTypeMicroservice || (this.entityConfig.microserviceName && this.context.applicationTypeGateway))
+        ) {
+          this.info(`searchEngine is missing in .jhipster/${this.entityConfig.name}.json, should opt-in for gateway/microservice entities`);
+          this.context.searchEngine = false;
+        }
         this.loadDerivedClientConfig(this.context);
         this.loadDerivedServerConfig(this.context);
         this.loadDerivedPlatformConfig(this.context);
-        loadRequiredConfigIntoEntity(this.context, this.jhipsterConfig);
         if (this.context.fields) {
           this.context.fields
             .filter(field => field.options)
@@ -520,22 +565,22 @@ class EntityGenerator extends BaseBlueprintGenerator {
         this.configOptions.sharedEntities[this.context.name] = this.context;
       },
 
-      composing() {
+      async composing() {
         if (this.options.skipWriting) return;
         const context = this.context;
         if (!context.skipServer) {
-          this.composeWithJHipster(GENERATOR_ENTITY_SERVER, this.arguments, {
+          await this.composeWithJHipster(GENERATOR_ENTITY_SERVER, this.arguments, {
             context,
           });
         }
 
         if (!context.skipClient || this.jhipsterConfig.applicationType === GATEWAY) {
-          this.composeWithJHipster(GENERATOR_ENTITY_CLIENT, this.arguments, {
+          await this.composeWithJHipster(GENERATOR_ENTITY_CLIENT, this.arguments, {
             context,
             skipInstall: this.options.skipInstall,
           });
           if (this.jhipsterConfig.enableTranslation) {
-            this.composeWithJHipster(GENERATOR_ENTITY_I_18_N, this.arguments, {
+            await this.composeWithJHipster(GENERATOR_ENTITY_I_18_N, this.arguments, {
               context,
               skipInstall: this.options.skipInstall,
             });
@@ -546,7 +591,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get loading() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._loading();
   }
 
@@ -594,7 +639,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
         let { entityAbsolutePackage = packageName, entityAbsoluteFolder = packageFolder } = entity;
         if (entityPackage) {
           entityAbsolutePackage = [packageName, entityPackage].join('.');
-          entityAbsoluteFolder = path.join(packageFolder, entityPackage);
+          entityAbsoluteFolder = path.join(packageFolder, entityPackage.replace(/\./g, '/'));
         }
         entity.entityAbsolutePackage = entityAbsolutePackage;
         entity.entityAbsoluteFolder = entityAbsoluteFolder;
@@ -604,7 +649,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get preparingFields() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._preparingFields();
   }
 
@@ -630,7 +675,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get preparing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._preparing();
   }
 
@@ -737,7 +782,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get preparingRelationships() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._preparingRelationships();
   }
 
@@ -752,6 +797,10 @@ class EntityGenerator extends BaseBlueprintGenerator {
         this.context.user = this.configOptions.sharedEntities.User;
       },
 
+      loadOtherEntities() {
+        this.context.otherEntities = _.uniq(this.context.relationships.map(rel => rel.otherEntity));
+      },
+
       processOtherReferences() {
         this.context.otherReferences = this.context.otherRelationships.map(relationship => relationship.reference);
         this.context.allReferences
@@ -834,7 +883,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get default() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._default();
   }
 
@@ -860,7 +909,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get writing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._writing();
   }
 
@@ -890,7 +939,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get install() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._install();
   }
 
@@ -904,7 +953,7 @@ class EntityGenerator extends BaseBlueprintGenerator {
   }
 
   get end() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._end();
   }
 

package/generators/entity-client/files.js

@@ -437,11 +437,7 @@ function addSampleRegexTestingStrings(generator) {
 function writeFiles() {
   return {
     writeClientFiles() {
-      if (
-        this.skipClient ||
-        (this.jhipsterConfig.microfrontend && this.jhipsterConfig.applicationType === 'gateway' && this.microserviceName)
-      )
-        return undefined;
+      if (this.skipClient || (this.microfrontend && this.applicationTypeGateway && this.microserviceName)) return undefined;
       if (this.protractorTests) {
         addSampleRegexTestingStrings(this);
       }
@@ -483,7 +479,7 @@ function addToMenu() {
   if (!this.embedded) {
     this.addEntityToModule();
     this.addEntityToMenu(
-      this.entityStateName,
+      this.entityPage,
       this.enableTranslation,
       this.clientFramework,
       this.entityTranslationKeyMenu,
@@ -494,17 +490,12 @@ function addToMenu() {
 
 function replaceTranslations() {
   if (this.clientFramework === VUE && !this.enableTranslation) {
+    utils.vueReplaceTranslation(this, [
+      `app/entities/${this.entityFolderName}/${this.entityFileName}.vue`,
+      `app/entities/${this.entityFolderName}/${this.entityFileName}-details.vue`,
+    ]);
     if (!this.readOnly) {
-      utils.vueReplaceTranslation(this, [
-        `app/entities/${this.entityFolderName}/${this.entityFileName}.vue`,
-        `app/entities/${this.entityFolderName}/${this.entityFileName}-update.vue`,
-        `app/entities/${this.entityFolderName}/${this.entityFileName}-details.vue`,
-      ]);
-    } else {
-      utils.vueReplaceTranslation(this, [
-        `app/entities/${this.entityFolderName}/${this.entityFileName}.vue`,
-        `app/entities/${this.entityFolderName}/${this.entityFileName}-details.vue`,
-      ]);
+      utils.vueReplaceTranslation(this, [`app/entities/${this.entityFolderName}/${this.entityFileName}-update.vue`]);
     }
   }
 }

package/generators/entity-client/index.js

@@ -27,8 +27,7 @@ const {
   SUPPORTED_CLIENT_FRAMEWORKS: { ANGULAR, REACT },
 } = require('../generator-constants');
 const { GENERATOR_ENTITY_CLIENT } = require('../generator-list');
-
-let useBlueprints;
+const { POSTGRESQL, MARIADB } = require('../../jdl/jhipster/database-types');
 
 module.exports = class extends BaseBlueprintGenerator {
   constructor(args, options, features) {
@@ -36,8 +35,12 @@ module.exports = class extends BaseBlueprintGenerator {
 
     this.entity = this.options.context;
     this.jhipsterContext = this.options.jhipsterContext || this.options.context;
+  }
 
-    useBlueprints = !this.fromBlueprint && this.instantiateBlueprints(GENERATOR_ENTITY_CLIENT, { context: this.options.context });
+  async _postConstruct() {
+    if (!this.fromBlueprint) {
+      await this.composeWithBlueprints(GENERATOR_ENTITY_CLIENT, { context: this.options.context });
+    }
   }
 
   // Public API method used by the getter and also by Blueprints
@@ -50,7 +53,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get preparing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._preparing();
   }
 
@@ -68,11 +71,22 @@ module.exports = class extends BaseBlueprintGenerator {
           this.tsKeyType = this.getTypescriptKeyType(this.primaryKey.type);
         }
       },
+
+      setupCypress() {
+        // Blueprints may disable cypress relationships by setting to false.
+        this.cypressBootstrapEntities = true;
+
+        const entity = this.entity;
+        // Reactive with PostgreSQL doesn't allow insertion without data.
+        this.workaroundRelationshipReactivePostgress = entity.reactive && entity.prodDatabaseType === POSTGRESQL;
+        // Reactive with MariaDB doesn't allow null value at Instant fields.
+        this.workaroundInstantReactiveMariaDB = entity.reactive && entity.prodDatabaseType === MARIADB;
+      },
     };
   }
 
   get default() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._default();
   }
 
@@ -131,7 +145,7 @@ module.exports = class extends BaseBlueprintGenerator {
   }
 
   get writing() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._writing();
   }
 
@@ -143,18 +157,14 @@ module.exports = class extends BaseBlueprintGenerator {
       },
 
       replaceTranslations() {
-        if (
-          this.skipClient ||
-          (this.jhipsterConfig.microfrontend && this.jhipsterConfig.applicationType === 'gateway' && this.microserviceName)
-        )
-          return undefined;
+        if (this.skipClient || (this.microfrontend && this.applicationTypeGateway && this.microserviceName)) return undefined;
         return replaceTranslations.call(this);
       },
     };
   }
 
   get postWriting() {
-    if (useBlueprints) return;
+    if (this.delegateToBlueprint) return {};
     return this._postWriting();
   }