Merge pull request #23804 from mshima/skip_ci-entity

Rework entity generator
jhipster · Oct 10, 2023 · 4ce09cf · 4ce09cf
2 parents cf11a94 + 4477fce
commit 4ce09cf
Show file tree

Hide file tree

Showing 10 changed files with 181 additions and 151 deletions.
diff --git a/generators/base-application/generator.mts b/generators/base-application/generator.mts
@@ -36,6 +36,7 @@ import { mutateApplication } from '../base/support/config.mjs';
 const {
   LOADING,
   PREPARING,
+  POST_PREPARING,
   CONFIGURING_EACH_ENTITY,
   LOADING_ENTITIES,
   PREPARING_EACH_ENTITY,
@@ -341,6 +342,7 @@ export default class BaseApplicationGenerator<
       ![
         LOADING,
         PREPARING,
+        POST_PREPARING,
 
         CONFIGURING_EACH_ENTITY,
         LOADING_ENTITIES,

diff --git a/generators/base-application/generator.spec.mts b/generators/base-application/generator.spec.mts
@@ -62,6 +62,7 @@ describe(`generator - ${generator}`, () => {
     // application arg
     const loading = esmocha.fn();
     const preparing = esmocha.fn();
+    const postPreparing = esmocha.fn();
     const writing = esmocha.fn();
     const postWriting = esmocha.fn();
     const install = esmocha.fn();
@@ -106,6 +107,10 @@ describe(`generator - ${generator}`, () => {
         return { preparing };
       }
 
+      get [Generator.POST_PREPARING]() {
+        return { postPreparing };
+      }
+
       get [Generator.CONFIGURING_EACH_ENTITY]() {
         return { configuringEachEntity };
       }
@@ -236,6 +241,7 @@ describe(`generator - ${generator}`, () => {
       expect(configuring).toBeCalledWith(controlArg);
       expect(composing).toBeCalledWith(controlArg);
       expect(loading).toBeCalledWith(applicationDefaultsArg);
+      expect(postPreparing).toBeCalledWith(applicationSourceArg);
 
       expect(configuringEachEntity).toBeCalledTimes(3);
       expect(configuringEachEntity).toHaveBeenNthCalledWith(1, { ...entityConfiguringArg, entityName: 'One' });

diff --git a/generators/base-application/tasks.d.mts b/generators/base-application/tasks.d.mts
@@ -84,7 +84,13 @@ export type BaseApplicationGeneratorDefinition<
   // Add application to existing priorities
   Record<'loadingTaskParam' | 'preparingTaskParam', ApplicationTaskParam<Definition> & ApplicationDefaultsTaskParam> &
   Record<
-    'defaultTaskParam' | 'postWritingTaskParam' | 'preConflictsTaskParam' | 'installTaskParam' | 'postInstallTaskParam' | 'endTaskParam',
+    | 'postPreparingTaskParam'
+    | 'defaultTaskParam'
+    | 'postWritingTaskParam'
+    | 'preConflictsTaskParam'
+    | 'installTaskParam'
+    | 'postInstallTaskParam'
+    | 'endTaskParam',
     ApplicationTaskParam<Definition>
   > &
   Record<'writingTaskParam', ApplicationTaskParam<Definition> & { configChanges?: Record<string, { newValue: any; oldValue: any }> }> &

diff --git a/generators/base-core/generator.mts b/generators/base-core/generator.mts
@@ -58,8 +58,21 @@ import { GENERATOR_JHIPSTER, YO_RC_FILE } from '../generator-constants.mjs';
 import { convertConfigToOption } from '../../lib/internal/index.mjs';
 
 const { merge, get, set } = _;
-const { INITIALIZING, PROMPTING, CONFIGURING, COMPOSING, LOADING, PREPARING, DEFAULT, WRITING, POST_WRITING, INSTALL, POST_INSTALL, END } =
-  PRIORITY_NAMES;
+const {
+  INITIALIZING,
+  PROMPTING,
+  CONFIGURING,
+  COMPOSING,
+  LOADING,
+  PREPARING,
+  POST_PREPARING,
+  DEFAULT,
+  WRITING,
+  POST_WRITING,
+  INSTALL,
+  POST_INSTALL,
+  END,
+} = PRIORITY_NAMES;
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -89,6 +102,8 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
 
   static PREPARING = asPriority(PREPARING);
 
+  static POST_PREPARING = asPriority(POST_PREPARING);
+
   static DEFAULT = asPriority(DEFAULT);
 
   static WRITING = asPriority(WRITING);
@@ -218,7 +233,7 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
    */
   getArgsForPriority(priorityName: string) {
     const control = this.sharedData.getControl();
-    if (priorityName === POST_WRITING || priorityName === PREPARING) {
+    if (priorityName === POST_WRITING || priorityName === PREPARING || priorityName === POST_PREPARING) {
       const source = this.sharedData.getSource();
       return [{ control, source }];
     }

diff --git a/generators/base/generator.mts b/generators/base/generator.mts
@@ -255,6 +255,24 @@ export default class JHipsterBaseBlueprintGenerator<
     return taskGroup;
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Preparing should be used to generate derived properties.
+   */
+  get postPreparing(): GenericTaskGroup<this, Definition['preparingTaskParam']> {
+    return this.asPreparingTaskGroup({});
+  }
+
+  /**
+   * Utility method to get typed objects for autocomplete.
+   */
+  asPostPreparingTaskGroup(
+    taskGroup: GenericTaskGroup<this, Definition['postPreparingTaskParam']>,
+  ): GenericTaskGroup<this, Definition['postPreparingTaskParam']> {
+    return taskGroup;
+  }
+
   /**
    * Priority API stub for blueprints.
    *

diff --git a/generators/base/priorities.mjs b/generators/base/priorities.mjs
@@ -50,6 +50,9 @@ const LOADING_QUEUE = `${QUEUE_PREFIX}${LOADING}`;
 const PREPARING = 'preparing';
 const PREPARING_QUEUE = `${QUEUE_PREFIX}${PREPARING}`;
 
+const POST_PREPARING = 'postPreparing';
+const POST_PREPARING_QUEUE = `${QUEUE_PREFIX}${POST_PREPARING}`;
+
 const MULTISTEP_TRANSFORM = 'multistepTransform';
 const MULTISTEP_TRANSFORM_QUEUE = `${QUEUE_PREFIX}${MULTISTEP_TRANSFORM}`;
 
@@ -98,9 +101,15 @@ export const CUSTOM_PRIORITIES = [
   {
     priorityName: PREPARING,
     queueName: PREPARING_QUEUE,
-    before: DEFAULT,
+    before: POST_PREPARING,
     args: generator => generator.getArgsForPriority(PREPARING),
   },
+  {
+    priorityName: POST_PREPARING,
+    queueName: POST_PREPARING_QUEUE,
+    before: DEFAULT,
+    args: generator => generator.getArgsForPriority(POST_PREPARING),
+  },
   {
     priorityName: DEFAULT,
     args: generator => generator.getArgsForPriority(DEFAULT),
@@ -153,6 +162,7 @@ export const PRIORITY_NAMES = {
   COMPOSING,
   LOADING,
   PREPARING,
+  POST_PREPARING,
 
   DEFAULT,
   WRITING,
@@ -172,6 +182,7 @@ export const PRIORITY_NAMES_LIST = [
   COMPOSING,
   LOADING,
   PREPARING,
+  POST_PREPARING,
 
   DEFAULT,
   WRITING,
@@ -190,6 +201,7 @@ export const QUEUES = {
   COMPOSING_QUEUE,
   LOADING_QUEUE,
   PREPARING_QUEUE,
+  POST_PREPARING_QUEUE,
 
   DEFAULT_QUEUE: DEFAULT,
   WRITING_QUEUE: WRITING,

diff --git a/generators/base/tasks.d.mts b/generators/base/tasks.d.mts
@@ -29,5 +29,4 @@ export type BaseGeneratorDefinition<Definition extends GenericSourceTypeDefiniti
   | 'endTaskParam',
   ControlTaskParam
 > &
-  Record<'postWritingTaskParam', SourceTaskParam<Definition>> &
-  Record<'preparingTaskParam', SourceTaskParam<Definition>>;
+  Record<'preparingTaskParam' | 'postPreparingTaskParam' | 'postWritingTaskParam', SourceTaskParam<Definition>>;