@auto-engineer/server-generator-apollo-emmett 1.3.3 → 1.4.0

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

@@ -1036,4 +1036,196 @@ describe('projection.specs.ts.ejs', () => {
       "
     `);
   });
+
+  it('should generate valid projection.ts when When clause is a query action (QueryActionRef)', async () => {
+    const spec: SpecsSchema = {
+      variant: 'specs',
+      narratives: [
+        {
+          name: 'workout-flow',
+          slices: [
+            {
+              type: 'command',
+              name: 'log-workout',
+              stream: 'workouts-${memberId}',
+              client: { specs: [] },
+              server: {
+                description: '',
+                specs: [
+                  {
+                    type: 'gherkin',
+                    feature: 'Log workout command',
+                    rules: [
+                      {
+                        name: 'Should record workouts',
+                        examples: [
+                          {
+                            name: 'User logs workout',
+                            steps: [
+                              {
+                                keyword: 'When',
+                                text: 'LogWorkout',
+                                docString: {
+                                  memberId: 'mem_001',
+                                  caloriesBurned: 250,
+                                },
+                              },
+                              {
+                                keyword: 'Then',
+                                text: 'WorkoutRecorded',
+                                docString: {
+                                  memberId: 'mem_001',
+                                  caloriesBurned: 250,
+                                },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+              },
+            },
+            {
+              type: 'query',
+              name: 'view-workout-history',
+              stream: 'workouts',
+              request:
+                'query GetWorkoutHistory($memberId: ID!) { workoutHistory(memberId: $memberId) { totalCalories } }',
+              client: { specs: [] },
+              server: {
+                description: '',
+                data: {
+                  items: [
+                    {
+                      target: { type: 'State', name: 'WorkoutHistory' },
+                      origin: { type: 'projection', name: 'WorkoutHistoryProjection', idField: 'memberId' },
+                    },
+                  ],
+                },
+                specs: [
+                  {
+                    type: 'gherkin',
+                    feature: 'View workout history query',
+                    rules: [
+                      {
+                        name: 'Workout history projection',
+                        examples: [
+                          {
+                            name: 'Shows calories after workout recorded',
+                            steps: [
+                              {
+                                keyword: 'Given',
+                                text: 'WorkoutRecorded',
+                                docString: { memberId: 'mem_001', caloriesBurned: 250 },
+                              },
+                              { keyword: 'When', text: 'GetWorkoutHistory', docString: { memberId: 'mem_001' } },
+                              {
+                                keyword: 'Then',
+                                text: 'WorkoutHistory',
+                                docString: { memberId: 'mem_001', totalCalories: 250 },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+              },
+            },
+          ],
+        },
+      ],
+      messages: [
+        {
+          type: 'command',
+          name: 'LogWorkout',
+          fields: [
+            { name: 'memberId', type: 'string', required: true },
+            { name: 'caloriesBurned', type: 'number', required: true },
+          ],
+        },
+        {
+          type: 'event',
+          name: 'WorkoutRecorded',
+          source: 'internal',
+          fields: [
+            { name: 'memberId', type: 'string', required: true },
+            { name: 'caloriesBurned', type: 'number', required: true },
+          ],
+        },
+        { type: 'query', name: 'GetWorkoutHistory', fields: [{ name: 'memberId', type: 'string', required: true }] },
+        {
+          type: 'state',
+          name: 'WorkoutHistory',
+          fields: [
+            { name: 'memberId', type: 'string', required: true },
+            { name: 'totalCalories', type: 'number', required: true },
+          ],
+        },
+      ],
+    } as SpecsSchema;
+
+    const plans = await generateScaffoldFilePlans(spec.narratives, spec.messages, undefined, 'src/domain/flows');
+    const projectionFile = plans.find((p) => p.outputPath.endsWith('view-workout-history/projection.ts'));
+
+    expect(projectionFile?.contents).toMatchInlineSnapshot(`
+      "import {
+        inMemorySingleStreamProjection,
+        type ReadEvent,
+        type InMemoryReadEventMetadata,
+      } from '@event-driven-io/emmett';
+      import type { WorkoutHistory } from './state';
+      import type { WorkoutRecorded } from '../log-workout/events';
+
+      type AllEvents = WorkoutRecorded;
+
+      export const projection = inMemorySingleStreamProjection<WorkoutHistory, AllEvents>({
+        collectionName: 'WorkoutHistoryProjection',
+        canHandle: ['WorkoutRecorded'],
+        getDocumentId: (event) => event.data.memberId,
+        evolve: (
+          document: WorkoutHistory | null,
+          event: ReadEvent<AllEvents, InMemoryReadEventMetadata>,
+        ): WorkoutHistory | null => {
+          switch (event.type) {
+            case 'WorkoutRecorded': {
+              /**
+               * ## IMPLEMENTATION INSTRUCTIONS ##
+               * Implement how this event updates the projection.
+               *
+               * **IMPORTANT - Internal State Pattern:**
+               * If you need to track state beyond the public WorkoutHistory type (e.g., to calculate
+               * aggregations, track previous values, etc.), follow this pattern:
+               *
+               * 1. Define an extended interface BEFORE the projection:
+               *    interface InternalWorkoutHistory extends WorkoutHistory {
+               *      internalField: SomeType;
+               *    }
+               *
+               * 2. Cast document parameter to extended type:
+               *    const current: InternalWorkoutHistory = document ?? { ...defaults };
+               *
+               * 3. Cast return values to extended type:
+               *    return { ...allFields, internalField } as InternalWorkoutHistory;
+               *
+               * This keeps internal state separate from the public GraphQL schema.
+               */
+              return {
+                memberId: /* TODO: map from event.data */ '',
+                totalCalories: /* TODO: map from event.data */ 0,
+              };
+            }
+            default:
+              return document;
+          }
+        },
+      });
+
+      export default projection;
+      "
+    `);
+  });
 });

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

@@ -5,6 +5,33 @@ const projName = projectionName || "UnknownProjection";
 const idField = projectionIdField ?? 'id';
 const uniqueEventTypes = allEventTypesArray;
 
+// Extract query name from the slice's request field for query action detection
+function extractQueryName(request) {
+    if (!request) return null;
+    // Match patterns like: query ViewWorkoutPlan($id: ID!) or query viewWorkoutPlan
+    const queryMatch = request.match(/query\s+(\w+)/i);
+    if (queryMatch) return queryMatch[1];
+    // For JSON AST format
+    if (request.startsWith('{') && request.includes('"kind"')) {
+        try {
+            const ast = JSON.parse(request);
+            if (ast?.definitions) {
+                const opDef = ast.definitions.find(d => d.kind === 'OperationDefinition');
+                if (opDef?.name?.value) return opDef.name.value;
+            }
+        } catch (e) {}
+    }
+    return null;
+}
+
+// Detect if a "When" step text is a query action (matches query name from request)
+// If no query name can be extracted, returns false (treats as event - safe default)
+function isQueryAction(whenText, queryName) {
+    if (!whenText || !queryName) return false;
+    return whenText === queryName || whenText.toLowerCase() === queryName.toLowerCase();
+}
+
+const queryName = extractQueryName(slice?.request);
 const ruleGroups = new Map();
 
 if (Array.isArray(slice?.server?.specs)) {
@@ -21,11 +48,19 @@ if (Array.isArray(slice?.server?.specs)) {
                 const whenSteps = example.steps?.filter(step => step.keyword === 'When') || [];
                 const thenSteps = example.steps?.filter(step => step.keyword === 'Then') || [];
 
+                // Check if the first "When" step is a query action
+                const firstWhenText = whenSteps[0]?.text || '';
+                const isQueryActionPattern = isQueryAction(firstWhenText, queryName);
+
                 ruleGroups.get(ruleDescription).push({
                     description: example.name || 'should handle events correctly',
                     given: givenSteps.map(step => ({ eventRef: step.text, exampleData: step.docString || {} })),
-                    when: whenSteps.map(step => ({ eventRef: step.text, exampleData: step.docString || {} })),
-                    then: thenSteps.map(step => ({ stateRef: step.text, exampleData: step.docString || {} }))
+                    // For query action pattern, use empty when array (query actions don't produce events)
+                    when: isQueryActionPattern
+                        ? { queryAction: firstWhenText, args: whenSteps[0]?.docString || {} }
+                        : whenSteps.map(step => ({ eventRef: step.text, exampleData: step.docString || {} })),
+                    then: thenSteps.map(step => ({ stateRef: step.text, exampleData: step.docString || {} })),
+                    isQueryActionPattern
                 });
             }
         }
@@ -39,11 +74,15 @@ if (Array.isArray(slice?.server?.specs)) {
         }
 
         for (const example of rule.examples || []) {
+            // Check if when is already a QueryActionRef
+            const isQueryActionPattern = example.when && !Array.isArray(example.when) && 'queryAction' in example.when;
+
             ruleGroups.get(ruleDescription).push({
                 description: example.description || 'should handle events correctly',
                 given: example.given || [],
                 when: example.when || [],
-                then: example.then || []
+                then: example.then || [],
+                isQueryActionPattern
             });
         }
     }
@@ -70,7 +109,11 @@ describe('<%= ruleDescription %>', () => {
 
 <% for (const testCase of ruleTests) {
   const givenEvents = Array.isArray(testCase.given) ? testCase.given : [];
-  const whenEvents = Array.isArray(testCase.when) ? testCase.when : (testCase.when ? [testCase.when] : []);
+  // For query action pattern, whenEvents is empty since query actions don't produce events
+  const isQueryActionTest = testCase.isQueryActionPattern;
+  const whenEvents = isQueryActionTest
+    ? []
+    : (Array.isArray(testCase.when) ? testCase.when : (testCase.when ? [testCase.when] : []));
   const thenStates = Array.isArray(testCase.then) ? testCase.then : [];
   const allTestEvents = [...givenEvents, ...whenEvents].filter(e => e.eventRef && e.eventRef !== '');
 
@@ -78,7 +121,10 @@ describe('<%= ruleDescription %>', () => {
     const expectedState = thenStates.find(t => t.stateRef === targetName);
     if (!expectedState) continue;
 
-    const description = testCase.description || 'should handle events correctly';
+    // For query action pattern, use a more descriptive test name
+    const description = testCase.description || (isQueryActionTest
+      ? 'should return correct state when queried'
+      : 'should handle events correctly');
 _%>
 
   it('<%= description %>', () =>

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

@@ -80,7 +80,7 @@ switch (event.type) {
     const queryGwt = slice.type === 'query'
             ? queryGwtMapping.find(gwt => {
                     const inGiven = gwt.given && gwt.given.some(g => g.eventRef === event.type);
-                    const inWhen = gwt.when.some(g => g.eventRef === event.type);
+                    const inWhen = Array.isArray(gwt.when) ? gwt.when.some(g => g.eventRef === event.type) : false;
                     return inGiven || inWhen;
             })
             : undefined;

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

@@ -13,7 +13,7 @@ export interface Field {
     required: boolean;
 }
 export interface MessageDefinition {
-    type: 'command' | 'event' | 'state';
+    type: 'command' | 'event' | 'state' | 'query';
     name: string;
     fields?: Array<{
         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,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;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,CAAC;IACpC,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,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;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"}