@auto-engineer/server-generator-apollo-emmett 1.144.0 → 1.146.0

package/dist/src/codegen/templates/command/handle.specs.ts

@@ -579,4 +579,205 @@ describe('generateScaffoldFilePlans', () => {
       "
     `);
   });
+  it('should generate aggregateStream pre-loading for cross-scene Given events', async () => {
+    const spec: SpecsSchema = {
+      variant: 'specs',
+      scenes: [
+        {
+          name: 'Workouts management',
+          moments: [
+            {
+              type: 'command',
+              name: 'Create workout',
+              stream: 'workout-${workoutId}',
+              client: { specs: [] },
+              server: {
+                description: '',
+                specs: [
+                  {
+                    type: 'gherkin',
+                    feature: 'Create workout',
+                    rules: [
+                      {
+                        name: 'Should create',
+                        examples: [
+                          {
+                            name: 'Workout created',
+                            steps: [
+                              { keyword: 'When', text: 'CreateWorkout', docString: { workoutId: 'w1', name: 'Legs' } },
+                              {
+                                keyword: 'Then',
+                                text: 'WorkoutCreated',
+                                docString: { workoutId: 'w1', name: 'Legs' },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+                data: {
+                  items: [
+                    {
+                      target: { type: 'Event', name: 'WorkoutCreated' },
+                      destination: { type: 'stream', pattern: 'workout-${workoutId}' },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
+        },
+        {
+          name: 'Profile and progress',
+          moments: [
+            {
+              type: 'command',
+              name: 'Record progress',
+              stream: 'progress-${progressId}',
+              client: { specs: [] },
+              server: {
+                description: '',
+                specs: [
+                  {
+                    type: 'gherkin',
+                    feature: 'Record progress',
+                    rules: [
+                      {
+                        name: 'Should record progress',
+                        examples: [
+                          {
+                            name: 'Progress recorded after workout',
+                            steps: [
+                              {
+                                keyword: 'Given',
+                                text: 'WorkoutCreated',
+                                docString: { workoutId: 'w1', name: 'Legs' },
+                              },
+                              {
+                                keyword: 'When',
+                                text: 'RecordProgress',
+                                docString: { workoutId: 'w1', date: '2024-01-01' },
+                              },
+                              {
+                                keyword: 'Then',
+                                text: 'ProgressRecorded',
+                                docString: { workoutId: 'w1', date: '2024-01-01' },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+                data: {
+                  items: [
+                    {
+                      target: { type: 'Event', name: 'ProgressRecorded' },
+                      destination: { type: 'stream', pattern: 'progress-${progressId}' },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
+        },
+      ],
+      messages: [
+        {
+          type: 'command',
+          name: 'CreateWorkout',
+          fields: [
+            { name: 'workoutId', type: 'string', required: true },
+            { name: 'name', type: 'string', required: true },
+          ],
+        },
+        {
+          type: 'command',
+          name: 'RecordProgress',
+          fields: [
+            { name: 'workoutId', type: 'string', required: true },
+            { name: 'date', type: 'Date', required: true },
+          ],
+        },
+        {
+          type: 'event',
+          name: 'WorkoutCreated',
+          source: 'internal',
+          fields: [
+            { name: 'workoutId', type: 'string', required: true },
+            { name: 'name', type: 'string', required: true },
+          ],
+        },
+        {
+          type: 'event',
+          name: 'ProgressRecorded',
+          source: 'internal',
+          fields: [
+            { name: 'workoutId', type: 'string', required: true },
+            { name: 'date', type: 'Date', required: true },
+          ],
+        },
+      ],
+    };
+
+    const { plans } = await generateScaffoldFilePlans(spec.scenes, spec.messages, undefined, 'src/domain/narratives');
+
+    const recordProgressHandle = plans.find(
+      (p) => p.outputPath.includes('record-progress') && p.outputPath.endsWith('handle.ts'),
+    );
+    expect(recordProgressHandle?.contents).toMatchInlineSnapshot(`
+      "import { randomUUID } from 'node:crypto';
+
+      import { CommandHandler, type EventStore, type MessageHandlerResult } from '@event-driven-io/emmett';
+      import { evolve } from './evolve';
+      import { initialState } from './state';
+      import { decide } from './decide';
+      import type { RecordProgress } from './commands';
+
+      export const handle = async (eventStore: EventStore, command: RecordProgress): Promise<MessageHandlerResult> => {
+        const streamId = \`progress-\${randomUUID()}\`;
+
+        const { state: preLoadedState } = await eventStore.aggregateStream(\`workout-\${command.data.workoutId}\`, {
+          evolve,
+          initialState: initialState,
+        });
+
+        const handler = CommandHandler({
+          evolve,
+          initialState: () => preLoadedState,
+        });
+
+        await handler(eventStore, streamId, (state) => decide(command, state));
+        return undefined;
+      };
+      "
+    `);
+
+    const createWorkoutHandle = plans.find(
+      (p) => p.outputPath.includes('create-workout') && p.outputPath.endsWith('handle.ts'),
+    );
+    expect(createWorkoutHandle?.contents).toMatchInlineSnapshot(`
+      "import { CommandHandler, type EventStore, type MessageHandlerResult } from '@event-driven-io/emmett';
+      import { evolve } from './evolve';
+      import { initialState } from './state';
+      import { decide } from './decide';
+      import type { CreateWorkout } from './commands';
+
+      const handler = CommandHandler({
+        evolve,
+        initialState,
+      });
+
+      export const handle = async (eventStore: EventStore, command: CreateWorkout): Promise<MessageHandlerResult> => {
+        const streamId = \`workout-\${command.data.workoutId}\`;
+
+        await handler(eventStore, streamId, (state) => decide(command, state));
+        return undefined;
+      };
+      "
+    `);
+  });
 });

package/dist/src/codegen/templates/command/handle.ts.ejs

@@ -66,6 +66,10 @@ const needsStreamGuard = streamVars.length > 0 && !allCmdFieldSets.every(fs => s
 const varInAnyCommand = (v) => allCmdFieldSets.some(fs => fs.has(v));
 const guardVars = needsStreamGuard ? streamVars.filter(v => varInAnyCommand(v)) : [];
 const uuidVars = needsStreamGuard ? streamVars.filter(v => !varInAnyCommand(v)) : [];
+
+const csGivens = (crossSceneGivens || []);
+const resolvedCsGivens = csGivens.filter(g => g.allVarsResolved);
+const hasCrossScene = resolvedCsGivens.length > 0;
 %>
 
 <% if (uuidVars.length > 0) { -%>
@@ -92,11 +96,13 @@ import type { <%= commands.map(c => pascalCase(c.type)).join(', ') %> } from './
     */
 <% } -%>
 
+<% if (!hasCrossScene) { -%>
 const handler = CommandHandler({
 evolve,
 initialState,
 });
 
+<% } -%>
 export const handle = async (
 eventStore: EventStore,
 command: <%= commands.map(c => pascalCase(c.type)).join(' | ') %>
@@ -122,6 +128,34 @@ command: <%= commands.map(c => pascalCase(c.type)).join(' | ') %>
         const streamId = '<%= stream?.pattern ?? 'unknown-stream' %>';
     <% } -%>
 
+    <% if (hasCrossScene) { -%>
+        <% resolvedCsGivens.forEach((csg, i) => {
+            const stateVar = resolvedCsGivens.length === 1
+                ? 'preLoadedState'
+                : `preLoadedState${i}`;
+            const prevInitial = i === 0
+                ? 'initialState'
+                : resolvedCsGivens.length === 1
+                    ? '() => preLoadedState'
+                    : `() => preLoadedState${i - 1}`;
+            const resolvedPattern = csg.sourceStreamPattern.replace(
+                /\$\{([^}]+)\}/g, (_, key) => {
+                    const link = csg.linkingFields.find(l => l.streamVar === key);
+                    return '${command.data.' + link.commandField + '}';
+                }
+            );
+        -%>
+        const { state: <%= stateVar %> } = await eventStore.aggregateStream(`<%= resolvedPattern %>`, { evolve, initialState: <%= prevInitial %> });
+        <% }) -%>
+
+        const handler = CommandHandler({
+            evolve,
+            initialState: () => <%= resolvedCsGivens.length === 1
+                ? 'preLoadedState'
+                : `preLoadedState${resolvedCsGivens.length - 1}` %>,
+        });
+    <% } -%>
+
     <% integrationCalls.forEach(({ call }) => { -%>
         <%= call %>
 

package/dist/src/codegen/templates/query/projection.specs.ts

@@ -400,21 +400,14 @@ describe('projection.ts.ejs', () => {
 
       @Resolver()
       export class ViewWishlistQueryResolver {
-        @Query(() => [Wishlist])
+        @Query(() => Wishlist, { nullable: true })
         async wishlist(
           @Ctx() ctx: GraphQLContext,
           @Arg('sessionId', () => ID, { nullable: true }) sessionId?: string,
-        ): Promise<Wishlist[]> {
+        ): Promise<Wishlist | null> {
           const model = new ReadModel<Wishlist>(ctx.database, 'WishlistProjection');
 
-          // ReadModel API:
-          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
-          // - model.findOne(filterFn) → T | null  returns the first match
-          //
-          // The scaffolded code below uses find() returning an array.
-          // If this query should return a single item, switch to findOne().
-
-          return model.find((item) => {
+          return model.findOne((item) => {
             if (sessionId !== undefined && item.sessionId !== sessionId) return false;
 
             return true;

package/dist/src/codegen/templates/query/query.resolver.specs.ts

@@ -224,21 +224,14 @@ describe('query.resolver.ts.ejs', () => {
 
       @Resolver()
       export class ViewsSuggestedItemsQueryResolver {
-        @Query(() => [SuggestedItems])
+        @Query(() => SuggestedItems, { nullable: true })
         async suggestedItems(
           @Ctx() ctx: GraphQLContext,
           @Arg('sessionId', () => ID, { nullable: true }) sessionId?: string,
-        ): Promise<SuggestedItems[]> {
+        ): Promise<SuggestedItems | null> {
           const model = new ReadModel<SuggestedItems>(ctx.database, 'SuggestedItemsProjection');
 
-          // ReadModel API:
-          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
-          // - model.findOne(filterFn) → T | null  returns the first match
-          //
-          // The scaffolded code below uses find() returning an array.
-          // If this query should return a single item, switch to findOne().
-
-          return model.find((item) => {
+          return model.findOne((item) => {
             if (sessionId !== undefined && item.sessionId !== sessionId) return false;
 
             return true;
@@ -1393,21 +1386,14 @@ describe('query.resolver.ts.ejs', () => {
 
       @Resolver()
       export class ViewWorkoutQueryResolver {
-        @Query(() => [WorkoutView])
+        @Query(() => WorkoutView, { nullable: true })
         async workout(
           @Ctx() ctx: GraphQLContext,
           @Arg('workoutId', () => ID, { nullable: true }) workoutId?: string,
-        ): Promise<WorkoutView[]> {
+        ): Promise<WorkoutView | null> {
           const model = new ReadModel<WorkoutView>(ctx.database, 'WorkoutProjection');
 
-          // ReadModel API:
-          // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
-          // - model.findOne(filterFn) → T | null  returns the first match
-          //
-          // The scaffolded code below uses find() returning an array.
-          // If this query should return a single item, switch to findOne().
-
-          return model.find((item) => {
+          return model.findOne((item) => {
             if (workoutId !== undefined && item.id !== workoutId) return false;
 
             return true;

package/dist/src/codegen/templates/query/query.resolver.ts.ejs

@@ -44,6 +44,15 @@ const usedArgNames = isSingleton
   : new Set((parsedRequest?.args ?? []).filter(a => stateFieldNames.has(a.name) || argFieldMap[a.name]).map(a => a.name));
 const hasMatchingArgs = usedArgNames.size > 0;
 
+const isIdLookup = !isSingleton
+  && typeof projectionIdField === 'string'
+  && (parsedRequest?.args ?? []).some(a => {
+       const mapping = argFieldMap[a.name];
+       const mappedField = mapping ? mapping.field : (stateFieldNames.has(a.name) ? a.name : null);
+       const op = mapping ? mapping.operator : 'eq';
+       return mappedField === projectionIdField && op === 'eq';
+     });
+
 const resolveArgTypes = (arg) => {
     const isCustom = !KNOWN_GQL_SCALARS.has(arg.graphqlType);
     return {
@@ -162,7 +171,7 @@ async <%= queryName %>(
   return result;
 }
 <% } else { %>
-@Query(() => [<%= viewType %>])
+@Query(() => <%= isIdLookup ? viewType + ', { nullable: true }' : '[' + viewType + ']' %>)
 async <%= queryName %>(
 @Ctx() ctx: GraphQLContext<% if (parsedRequest?.args?.length) { %>,
 <%   for (let i = 0; i < parsedRequest.args.length; i++) {
@@ -170,17 +179,17 @@ async <%= queryName %>(
     const { gqlType, tsType } = resolveArgTypes(arg);
 %>    @Arg('<%= arg.name %>', () => <%= gqlType %>, { nullable: true }) <%= usedArgNames.has(arg.name) ? arg.name : '_' + arg.name %>?: <%= tsType %><%= i < parsedRequest.args.length - 1 ? ',' : '' %>
 <%   } } %>
-): Promise<<%= viewType %>[]> {
+): Promise<<%= isIdLookup ? viewType + ' | null' : viewType + '[]' %>> {
 const model = new ReadModel<<%= viewType %>>(ctx.database, '<%= collectionName %>');
-
+<% if (!isIdLookup) { %>
 // ReadModel API:
 // - model.find(filterFn?)  → T[]       returns all matches (or all documents if no filter)
 // - model.findOne(filterFn) → T | null  returns the first match
 //
 // The scaffolded code below uses find() returning an array.
 // If this query should return a single item, switch to findOne().
-
-return model.find((<%= hasMatchingArgs ? 'item' : '_item' %>) => {
+<% } %>
+return model.<%= isIdLookup ? 'findOne' : 'find' %>((<%= hasMatchingArgs ? 'item' : '_item' %>) => {
 <% if (parsedRequest?.args?.length) {
         for (const arg of parsedRequest.args) {
             const mapping = argFieldMap[arg.name];

package/dist/src/codegen/templates/react/react.specs.ts.ejs

@@ -39,7 +39,7 @@ for (const eventType of allUsedEvents) {
     if (event) {
         const isCrossScene = event.sourceSceneName && event.sourceSceneName !== sceneName;
         const importPath = isCrossScene
-            ? `../../${toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}/events`
+            ? `../../${event.sourceSceneDirName || toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}/events`
             : event.sourceMomentName ? `../${toKebabCase(event.sourceMomentName)}/events` : './events';
         if (!eventImportGroups.has(importPath)) {
             eventImportGroups.set(importPath, []);
@@ -53,7 +53,7 @@ for (const commandType of allUsedCommands) {
     if (command) {
         const isCrossScene = command.sourceSceneName && command.sourceSceneName !== sceneName;
         const importPath = isCrossScene
-            ? `../../${toKebabCase(command.sourceSceneName)}/${toKebabCase(command.sourceMomentName)}/commands`
+            ? `../../${command.sourceSceneDirName || toKebabCase(command.sourceSceneName)}/${toKebabCase(command.sourceMomentName)}/commands`
             : command.sourceMomentName ? `../${toKebabCase(command.sourceMomentName)}/commands` : './commands';
         if (!commandImportGroups.has(importPath)) {
             commandImportGroups.set(importPath, []);

package/dist/src/codegen/templates/react/react.ts.ejs

@@ -8,7 +8,7 @@ for (const pair of eventCommandPairs) {
   const event = events.find(e => e.type === pair.eventType);
   const isCrossScene = event?.sourceSceneName && event.sourceSceneName !== sceneName;
   const importBase = isCrossScene
-    ? `../../${toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}`
+    ? `../../${event.sourceSceneDirName || toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}`
     : event?.sourceMomentName ? `../${toKebabCase(event.sourceMomentName)}` : '.';
   if (!importGroups.has(importBase)) importGroups.set(importBase, []);
   const typeName = pascalCase(pair.eventType);

package/dist/src/codegen/templates/react/register.ts.ejs

@@ -8,7 +8,7 @@ for (const pair of eventCommandPairs) {
   const event = events.find(e => e.type === pair.eventType);
   const isCrossScene = event?.sourceSceneName && event.sourceSceneName !== sceneName;
   const importBase = isCrossScene
-    ? `../../${toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}`
+    ? `../../${event.sourceSceneDirName || toKebabCase(event.sourceSceneName)}/${toKebabCase(event.sourceMomentName)}`
     : event?.sourceMomentName ? `../${toKebabCase(event.sourceMomentName)}` : '.';
   if (!importGroups.has(importBase)) importGroups.set(importBase, []);
   const typeName = pascalCase(pair.eventType);

package/dist/src/codegen/types.d.ts

@@ -6,6 +6,7 @@ export interface Message {
     source?: 'when' | 'given' | 'then';
     sourceSceneName?: string;
     sourceMomentName?: string;
+    sourceSceneDirName?: string;
 }
 export interface Field {
     name: string;

package/dist/src/codegen/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/codegen/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErF,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAEzD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC,CAAC;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,IAAI,EAAE,UAAU,GAAG,QAAQ,EAAE,CAAC;IAC9B,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/codegen/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErF,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAEzD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC,CAAC;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,IAAI,EAAE,UAAU,GAAG,QAAQ,EAAE,CAAC;IAC9B,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B"}