@izara_project/izara-core-generate-service-code 1.0.67 → 1.0.68

package/test/customFlowApplicationArtifacts.test.js

@@ -163,17 +163,15 @@ test('emits and removes ext-topic handlers declared by custom flow steps', async
   );
 });
 
-test('emits and removes the legacy trigger-cache artifact suite', async () => {
-  const rootPath = await createTriggerCacheProject();
+test('emits and removes the trigger-cache artifact suite when triggerFlowTypes is set', async () => {
+  const rootPath = await createTriggerCacheProject(['OrderCheckout']);
   await generateCustomFlowApplicationArtifacts(rootPath);
   await generateResourceArtifacts(rootPath);
 
   const source = 'app/src/generatedCode/FlowSchemas/Cart/source';
   for (const fileName of [
-    'CartCheckTriggerCacheCartComplete_Main.js',
-    'CartCheckTriggerCacheCartComplete_HdrSqs.js',
-    'CartTriggerCacheCartComplete_Main.js',
-    'CartTriggerCacheCartComplete_HdrSqs.js'
+    'CartCheckTriggerFlows_Main.js',
+    'CartCheckTriggerFlows_HdrSqs.js'
   ]) {
     const path = join(rootPath, source, fileName);
     await access(path);
@@ -181,34 +179,60 @@ test('emits and removes the legacy trigger-cache artifact suite', async () => {
   }
 
   const flowYaml = await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8');
-  for (const functionName of [
-    'CartCheckTriggerCacheCartCompleteHdrSqs',
-    'CartTriggerCacheCartCompleteHdrSqs'
-  ]) {
-    assert.match(flowYaml, new RegExp(`^${functionName}:`, 'm'));
-  }
+  assert.match(flowYaml, /^CartCheckTriggerFlowsHdrSqs:/m);
   assert.match(
-    await readFile(join(rootPath, `${source}/CartCheckTriggerCacheCartComplete_HdrSqs.js`), 'utf8'),
-    /record\.body\.Message\.identifiers/
+    await readFile(join(rootPath, `${source}/CartCheckTriggerFlows_HdrSqs.js`), 'utf8'),
+    /CartCheckTriggerFlowsHdrSqs/
   );
 
   const resources = await readFile(join(rootPath, 'resource/sls_yaml/generatedCode/source/generated-sns-in-sqs.yml'), 'utf8');
   assert.match(resources, /^  CartHdrSqs:/m);
   for (const queueName of [
     'CartHdrSqs',
-    'CartCheckTriggerCacheCartCompleteHdrSqs',
-    'CartTriggerCacheCartCompleteHdrSqs',
-    'CartTriggerCacheCartCompleteHdrDsq'
+    'CartCheckTriggerFlowsHdrSqs'
   ]) assert.match(resources, new RegExp('QueueName: \\$\\{self:custom\\.iz_resourcePrefix\\}' + queueName));
-  const iam = await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/generate-shared-resource.yml'), 'utf8');
 
   await writeFile(join(rootPath, 'app/src/schemas/FlowSchemas/Cart.js'), "export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'none' };\n");
   await generateCustomFlowApplicationArtifacts(rootPath);
   await generateResourceArtifacts(rootPath);
 
-  await assert.rejects(readFile(join(rootPath, `${source}/CartCheckTriggerCacheCartComplete_Main.js`)));
-  assert.doesNotMatch(await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8'), /CartCheckTriggerCacheCartCompleteHdrSqs/);
-  assert.doesNotMatch(await readFile(join(rootPath, 'resource/sls_yaml/generatedCode/source/generated-sns-in-sqs.yml'), 'utf8'), /CartTriggerCacheCartCompleteHdrDsq/);
+  await assert.rejects(readFile(join(rootPath, `${source}/CartCheckTriggerFlows_Main.js`)));
+  assert.doesNotMatch(await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8'), /CartCheckTriggerFlowsHdrSqs/);
+});
+
+test('uses custom CheckTrigger step if provided by developer in flowSteps', async () => {
+  const rootPath = await mkdtemp(join(tmpdir(), 'generate-service-code-v2-trigger-cache-custom-'));
+  roots.add(rootPath);
+  const schemaRoot = join(rootPath, 'app/src/schemas/FlowSchemas');
+  await mkdir(schemaRoot, { recursive: true });
+  await writeFile(
+    join(schemaRoot, 'Cart.js'),
+    "export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'triggerCache', triggerFlowTypes: ['OrderCheckout'], objType: { serviceTag: 'Order' }, flowSteps: [{ stepName: 'start' }, { stepName: 'CheckTriggerCustomStep', event: ['extTopic'] }] };\n"
+  );
+
+  await generateCustomFlowApplicationArtifacts(rootPath);
+  const source = 'app/src/generatedCode/FlowSchemas/Cart/source';
+  const path = join(rootPath, source, 'CartCheckTriggerCustomStep_Main.js');
+  await access(path);
+  await parseAsEsm(path);
+
+  const flowYaml = await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8');
+  assert.match(flowYaml, /^CartCheckTriggerCustomStepHdrSqs:/m);
+});
+
+test('does not emit check trigger-cache artifacts when triggerFlowTypes is empty, null, undefined, or missing', async () => {
+  for (const emptyTriggerFlowTypes of [[], null, undefined]) {
+    const rootPath = await createTriggerCacheProject(emptyTriggerFlowTypes);
+    await generateCustomFlowApplicationArtifacts(rootPath);
+    await generateResourceArtifacts(rootPath);
+
+    const source = 'app/src/generatedCode/FlowSchemas/Cart/source';
+    await assert.rejects(readFile(join(rootPath, `${source}/CartCheckTriggerFlows_Main.js`)));
+    await assert.rejects(readFile(join(rootPath, `${source}/CartCheckTriggerFlows_HdrSqs.js`)));
+
+    const flowYaml = await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8');
+    assert.doesNotMatch(flowYaml, /CartCheckTriggerFlowsHdrSqs/);
+  }
 });
 
 test('rejects an EventBridge schedule without a deployable name and rate', () => {
@@ -284,14 +308,15 @@ async function createStepProject() {
   return rootPath;
 }
 
-async function createTriggerCacheProject() {
+async function createTriggerCacheProject(triggerFlowTypes) {
   const rootPath = await mkdtemp(join(tmpdir(), 'generate-service-code-v2-trigger-cache-'));
   roots.add(rootPath);
   const schemaRoot = join(rootPath, 'app/src/schemas/FlowSchemas');
   await mkdir(schemaRoot, { recursive: true });
+  const triggerFlowTypesAttr = Array.isArray(triggerFlowTypes) && triggerFlowTypes.length > 0 ? `triggerFlowTypes: ${JSON.stringify(triggerFlowTypes)}, ` : '';
   await writeFile(
     join(schemaRoot, 'Cart.js'),
-    "export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'triggerCache', objType: { serviceTag: 'Order' }, flowSteps: [{ stepName: 'start' }, { stepName: 'CheckTriggerCacheCartComplete', checkTriggerType: 'flowType', event: ['extTopic'] }, { stepName: 'TriggerCacheCartComplete', checkTriggerType: 'complete', event: ['extTopic', 'dsq'] }] };\n"
+    `export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'triggerCache', ${triggerFlowTypesAttr}objType: { serviceTag: 'Order' }, flowSteps: [{ stepName: 'start' }] };\n`
   );
   return rootPath;
 }

package/test/dynamicCrudFlowSchemas.test.js

@@ -15,10 +15,10 @@ test('generates dynamic CRUD schemas from local schema modules', async () => {
 
   const result = await generateDynamicCrudFlowSchemas(rootPath);
   assert.deepEqual(result.files.map(file => file.path), [
-    'app/src/schemas/FlowSchemas/generateCode/Create.js',
-    'app/src/schemas/FlowSchemas/generateCode/Update.js',
-    'app/src/schemas/FlowSchemas/generateCode/Delete.js',
-    'app/src/schemas/FlowSchemas/generateCode/Get.js'
+    'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Create.js',
+    'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Update.js',
+    'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Delete.js',
+    'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Get.js'
   ]);
 
   const create = await readGeneratedFlow(rootPath, 'Create');
@@ -127,10 +127,10 @@ function createHookFlow(event) {
 }
 
 async function readGeneratedFlow(rootPath, action) {
-  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode', `${action}.js`);
+  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowObjects', `${action}.js`);
   return import(`${pathToFileURL(filePath).href}?test=${process.hrtime.bigint()}`).then(module => module.default);
 }
 
 function readGeneratedFile(rootPath, action) {
-  return readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode', `${action}.js`), 'utf8');
+  return readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowObjects', `${action}.js`), 'utf8');
 }

package/test/dynamicRbacFlowSchemas.test.js

@@ -30,20 +30,16 @@ test('generates shared and object-specific RBAC flow schemas', async () => {
   const result = await generateDynamicRbacFlowSchemas(rootPath, { serviceTag: 'UserAccount' });
 
   assert.deepEqual(result.files.map(file => file.path), [
-    ...STATIC_ACTIONS.map(action => `app/src/schemas/FlowSchemas/generateCode/${action}.js`),
-    'app/src/schemas/FlowSchemas/generateCode/UserRbacFlow.js'
+    ...STATIC_ACTIONS.map(action => `app/src/schemas/FlowSchemas/generateCode/FlowRbac/${action}.js`),
+    'app/src/schemas/FlowSchemas/generateCode/FlowRbac/UserRbacFlow.js'
   ]);
   const createTargetRole = await readGeneratedFlow(rootPath, 'CreateTargetRole');
-  const listTargetRole = await readGeneratedFlow(rootPath, 'ListTargetRole');
   const user = await readGeneratedFlow(rootPath, 'UserRbacFlow');
   assert.deepEqual(createTargetRole.flowSteps[0].returnValues, {
     properties: ['returnResult'],
     messageAttributes: []
   });
-  assert.deepEqual(listTargetRole.event, ['lambdaSyncApi']);
-  assert.equal(listTargetRole.outputTopic, true);
-  assert.deepEqual(user.objType, { serviceTag: 'UserAccount', objectType: 'user' });
-  assert.deepEqual(user.flowSteps[0].messageAttributes, ['userId', 'correlationId']);
+  assert.deepEqual(user.event, ['ownTopic']);
   assert.equal(user.steps, undefined);
 });
 
@@ -56,8 +52,8 @@ test('removes RBAC schemas when the last RBAC object is removed', async () => {
   const result = await generateDynamicRbacFlowSchemas(rootPath);
 
   assert.deepEqual(result.files, []);
-  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/CreateTargetRole.js')));
-  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/UserRbacFlow.js')));
+  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRbac/CreateTargetRole.js')));
+  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRbac/UserRbacFlow.js')));
 });
 
 test('requires a serviceTag only when RBAC schemas are needed', async () => {
@@ -79,7 +75,7 @@ test('removes object-specific RBAC schemas when the ObjectSchema file is deleted
 
   await generateDynamicRbacFlowSchemas(rootPath);
 
-  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/UserRbacFlow.js')));
+  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRbac/UserRbacFlow.js')));
 });
 
 async function createProject({ hasRbac = false } = {}) {
@@ -89,13 +85,13 @@ async function createProject({ hasRbac = false } = {}) {
   await mkdir(objectDirectory, { recursive: true });
   await writeFile(
     join(objectDirectory, 'User.js'),
-    `export default { objectType: 'user', addOnDataStructure: ${hasRbac ? "[{ type: 'rbac' }]" : '[]'} };\n`
+    `export default { objectType: 'user', fieldNames: [], identifiers: [], addOnDataStructure: ${hasRbac ? "[{ type: 'rbac' }]" : '[]'} };\n`
   );
   return rootPath;
 }
 
 async function readGeneratedFlow(rootPath, flowTag) {
-  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode', `${flowTag}.js`);
+  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRbac', `${flowTag}.js`);
   const module = await import(`${pathToFileURL(filePath).href}?test=${process.hrtime.bigint()}`);
   return module.default;
 }

package/test/dynamicRelationshipFlowSchemas.test.js

@@ -30,7 +30,7 @@ test('generates dynamic relationship schemas even without declared relationships
 
   assert.deepEqual(
     result.files.map(file => file.path),
-    RELATIONSHIP_ACTIONS.map(action => `app/src/schemas/FlowSchemas/generateCode/${action}.js`)
+    RELATIONSHIP_ACTIONS.map(action => `app/src/schemas/FlowSchemas/generateCode/FlowRelationship/${action}.js`)
   );
 
   const create = await readGeneratedFlow(rootPath, 'CreateRelationship');
@@ -74,7 +74,7 @@ test('does not allow options to override the rootPath argument', async () => {
   assert.equal(result.project.rootPath, rootPath);
   assert.equal(result.files.length, 6);
   assert.match(
-    await readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/CreateRelationship.js'), 'utf8'),
+    await readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRelationship/CreateRelationship.js'), 'utf8'),
     /export default/
   );
 });
@@ -93,7 +93,7 @@ async function createProject({ singletonExport = false } = {}) {
 }
 
 async function readGeneratedFlow(rootPath, action) {
-  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode', `${action}.js`);
+  const filePath = join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowRelationship', `${action}.js`);
   const module = await import(`${pathToFileURL(filePath).href}?test=${process.hrtime.bigint()}`);
   return module.default;
 }

package/test/publicApi.test.js

@@ -21,7 +21,7 @@ test('generate commits schemas, application artifacts, and resources in one publ
   const rootPath = await createCrudProject();
   const result = await generate(rootPath);
 
-  assert.strictEqual(result.files.length, 38);
+  assert.strictEqual(result.files.length, 39);
   assert.equal(result.project.rootPath, rootPath);
   assert.match(
     await readFile(join(rootPath, 'app/src/generatedCode/FlowObjects/Create/source/Create_Main.js'), 'utf8'),
@@ -99,23 +99,21 @@ test('generate commits the system WebSocket completion path for own-topic flows'
   assert.match(webSocketHandler, /addCallingFlowToPassOnProperties/);
 });
 
-test('generate commits the legacy trigger-cache suite with its queues', async () => {
+test('generate commits the trigger-cache suite with its queues when triggerFlowTypes is set', async () => {
   const rootPath = await createTriggerCacheProject();
   const result = await generate(rootPath);
 
   for (const path of [
-    'app/src/generatedCode/FlowSchemas/Cart/source/CartCheckTriggerCacheCartComplete_HdrSqs.js',
-    'app/src/generatedCode/FlowSchemas/Cart/source/CartCheckTriggerCacheCartComplete_Main.js',
-    'app/src/generatedCode/FlowSchemas/Cart/source/CartTriggerCacheCartComplete_HdrSqs.js',
-    'app/src/generatedCode/FlowSchemas/Cart/source/CartTriggerCacheCartComplete_Main.js'
+    'app/src/generatedCode/FlowSchemas/Cart/source/CartCheckTriggerFlows_HdrSqs.js',
+    'app/src/generatedCode/FlowSchemas/Cart/source/CartCheckTriggerFlows_Main.js'
   ]) assert.ok(result.files.some(file => file.path === path));
   assert.match(
     await readFile(join(rootPath, 'app/sls_yaml/generatedCode/source/flow-schema.yml'), 'utf8'),
-    /CartCheckTriggerCacheCartCompleteHdrSqs:[\s\S]*CartTriggerCacheCartCompleteHdrSqs:/
+    /CartCheckTriggerFlowsHdrSqs:/
   );
   assert.match(
     await readFile(join(rootPath, 'resource/sls_yaml/generatedCode/source/generated-sns-in-sqs.yml'), 'utf8'),
-    /CartCheckTriggerCacheCartCompleteHdrSqs:[\s\S]*CartTriggerCacheCartCompleteHdrSqs/
+    /CartCheckTriggerFlowsHdrSqs/
   );
 });
 
@@ -142,7 +140,7 @@ test('generate rolls back every slice when one output target conflicts', async (
     generate(rootPath),
     /not a file/
   );
-  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/Create.js')));
+  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Create.js')));
 });
 
 test('generate removes stale CRUD schemas and application artifacts', async () => {
@@ -155,8 +153,8 @@ test('generate removes stale CRUD schemas and application artifacts', async () =
 
   const result = await generate(rootPath);
 
-  assert.equal(result.files.length, 10);
-  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/Create.js')));
+  assert.equal(result.files.length, 11);
+  await assert.rejects(readFile(join(rootPath, 'app/src/schemas/FlowSchemas/generateCode/FlowObjects/Create.js')));
   await assert.rejects(readFile(join(rootPath, 'app/src/generatedCode/FlowObjects/Create/source/Create_Main.js')));
   assert.match(
     await readFile(join(rootPath, 'resource/sls_yaml/generatedCode/source/generated-dynamoDB-table.yml'), 'utf8'),
@@ -203,7 +201,7 @@ async function createTriggerCacheProject() {
   await mkdir(flowDirectory, { recursive: true });
   await writeFile(
     join(flowDirectory, 'Cart.js'),
-    "export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'triggerCache', objType: { serviceTag: 'Order' }, flowSteps: [{ stepName: 'CheckTriggerCacheCartComplete', event: ['extTopic'], checkTriggerType: 'flowType' }, { stepName: 'TriggerCacheCartComplete', event: ['extTopic'], checkTriggerType: 'complete' }] };\n"
+    "export default { flowTag: 'cart', event: ['ownTopic'], statusType: 'triggerCache', triggerFlowTypes: ['OrderCheckout'], objType: { serviceTag: 'Order' }, flowSteps: [{ stepName: 'start' }] };\n"
   );
   return rootPath;
 }

package/test/resourceArtifacts.test.js

@@ -13,7 +13,7 @@ test('emits queues, topics, tables, and IAM roles from schema data', async () =>
   const rootPath = await createProject();
   const result = await generateResourceArtifacts(rootPath);
 
-  assert.equal(result.files.length, 4);
+  assert.equal(result.files.length, 5);
   const resources = await readFile(join(rootPath, 'resource/sls_yaml/generatedCode/source/generated-sns-in-sqs.yml'), 'utf8');
   assert.match(resources, /InCreate:/);
   for (const queueName of ['FindDataHdrSqs', 'ProcessLogicalHdrSqs', 'PaginateProcessLogicalHdrDsq', 'PaginateProcessLogicalHdrSqs']) {
@@ -47,11 +47,21 @@ test('emits queues, topics, tables, and IAM roles from schema data', async () =>
   assert.doesNotMatch(roleBlock(iam, 'RegisterRole'), /dynamodb:|sqs:|sns:/);
   assert.doesNotMatch(iam, /s3:GetObjectVersion|s3:ListBucket|sqs:DeleteMessageBatch|sqs:GetQueueUrl/);
   assert.match(iam, /#<#\/\w+StatementHookCode#>\n\n  \w+Role:/);
+
+  const lambdaRoleConfig = await readFile(join(rootPath, 'app/initial_setup/generatedCode/source/generatedLambdaRoleServiceConfig.js'), 'utf8');
+  assert.match(lambdaRoleConfig, /roleName: 'FlowObjects'/);
+  assert.match(lambdaRoleConfig, /roleName: 'ProcFindData'/);
+  assert.match(lambdaRoleConfig, /roleName: 'FlowRelationship'/);
+  assert.doesNotMatch(lambdaRoleConfig, /roleName: 'FlowObjectsRole'/);
+  assert.doesNotMatch(lambdaRoleConfig, /roleName: 'ProcFindDataRole'/);
+  assert.doesNotMatch(lambdaRoleConfig, /roleName: 'FlowRelationshipRole'/);
+
   for (const filePath of [
     'resource/sls_yaml/generatedCode/source/generated-sns-in-sqs.yml',
     'resource/sls_yaml/generatedCode/source/generated-sns-out.yml',
     'resource/sls_yaml/generatedCode/source/generated-dynamoDB-table.yml',
-    'app/sls_yaml/generatedCode/source/generate-shared-resource.yml'
+    'app/sls_yaml/generatedCode/source/generate-shared-resource.yml',
+    'app/initial_setup/generatedCode/source/generatedLambdaRoleServiceConfig.js'
   ]) {
     assert.doesNotMatch(await readFile(join(rootPath, filePath), 'utf8'), /\n\n$/);
   }

package/src/emit/rbac/templates/UserRbacFlow_HdrInv.ejs

@@ -1,10 +0,0 @@
-import { middlewareHandler as middleware } from '@izara_project/izara-middleware';
-import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
-import Process<%- flowTag %> from './Process<%- flowTag %>_Main.js';
-
-middleware.setValidatorSchema({});
-export const main = middleware.wrap(async event => Process<%- flowTag %>(
-  event._izContext,
-  event,
-  callingFlowSharedLib.addCallingFlowToPassOnProperties(event)
-));