feat: log workflowGroup from the exit-handler TDE-1230

package.json

@@ -20,7 +20,7 @@
     "build": "tsc",
     "lint": "npx eslint . --ignore-path .gitignore",
     "format": "npx prettier . -w",
-    "test": "node --import tsx --test infra/**/*.test.ts"
+    "test": "node --import tsx --test infra/**/*.test.ts templates/common/__test__/*.test.mjs"
   },
   "devDependencies": {
     "@aws-cdk/lambda-layer-kubectl-v28": "^2.1.0",

templates/common/README.md

@@ -50,6 +50,7 @@ The script ran by this template is generating a log, including the status of the
 ### Template usage
 
 The information to pass to this `WorkflowTemplate` is the status and the parameters of the workflow (`workflow.status` & `workflow.parameters`).
+If a workflow parameter contains a `source` parameter, it will be parsed to determine a workflow group (such as `land` or `sea`).
 
 As the `onExit` event [does not handle a `templateRef`](https://github.com/argoproj/argo-workflows/issues/3188),
 an additional template called by the `onExit` event has to be added to the templates so it can finally call the `tpl-exit-handler` template.

templates/common/__test__/exit.handler.test.mjs

@@ -0,0 +1,98 @@
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { describe, it } from 'node:test';
+
+/**
+ * Read the workflow YAML file and create a function from the script inside.
+ * replacing {{ inputs.* }} with ctx
+ *
+ * @param {*} ctx
+ * @returns Function that requires a `context` and `core` parameter
+ */
+function createTestFunction(ctx) {
+  const func = fs.readFileSync('./templates/common/exit.handler.yml', 'utf-8').split('source: |')[1];
+
+  const newFunc = func
+    // Replace inputs
+    .replace('{{= inputs.parameters.workflow_parameters }}', `${ctx.workflowParameters ?? '[]'}`)
+    .replace('{{inputs.parameters.workflow_status}}', `${ctx.workflowStatus ?? 'Failed'}`)
+    .split('\n')
+    .join('\n');
+  return new Function('context', newFunc);
+}
+
+function runScript(ctx) {
+  return createTestFunction(ctx)();
+}
+
+describe('exit handler script template', () => {
+  it('should log workflow status and parameters', (t) => {
+    const spy = t.mock.method(console, 'log');
+
+    runScript({
+      workflowParameters: JSON.stringify([
+        { name: 'source', value: 's3://linz-topographic-upload/abc/', description: 'Source bucket' },
+        { name: 'ticket', value: 'GDE-123', description: 'JIRA Ticket' },
+      ]),
+      workflowStatus: `Succeeded`,
+    });
+
+    assert.equal(spy.mock.callCount(), 1);
+
+    const logOutputDict = JSON.parse(spy.mock.calls[0].arguments[0]);
+    // override time
+    logOutputDict.time = 1724037007216;
+
+    assert.deepEqual(logOutputDict, {
+      time: 1724037007216,
+      level: 20,
+      pid: 1,
+      msg: 'Workflow:Done',
+      workflowStatus: 'Succeeded',
+      workflowGroup: 'land',
+      parameters: { source: 's3://linz-topographic-upload/abc/', ticket: 'GDE-123' },
+    });
+  });
+
+  it('should log workflowGroup as land', (t) => {
+    const spy = t.mock.method(console, 'log');
+
+    runScript({
+      workflowParameters: JSON.stringify([{ name: 'source', value: 's3://linz-topographic-upload/abc/' }]),
+    });
+
+    assert.equal(spy.mock.callCount(), 1);
+
+    const logOutputDict = JSON.parse(spy.mock.calls[0].arguments[0]);
+
+    assert.equal(logOutputDict.workflowGroup, 'land');
+  });
+
+  it('should log workflowGroup as sea', (t) => {
+    const spy = t.mock.method(console, 'log');
+
+    runScript({
+      workflowParameters: JSON.stringify([{ name: 'source', value: 's3://linz-hydrographic-upload/abc/' }]),
+    });
+
+    assert.equal(spy.mock.callCount(), 1);
+
+    const logOutputDict = JSON.parse(spy.mock.calls[0].arguments[0]);
+
+    assert.equal(logOutputDict.workflowGroup, 'sea');
+  });
+
+  it('should log workflowGroup as unknown', (t) => {
+    const spy = t.mock.method(console, 'log');
+
+    runScript({
+      workflowParameters: JSON.stringify([{ name: 'source', value: 's3://linz-bucket/abc/' }]),
+    });
+
+    assert.equal(spy.mock.callCount(), 1);
+
+    const logOutputDict = JSON.parse(spy.mock.calls[0].arguments[0]);
+
+    assert.equal(logOutputDict.workflowGroup, 'unknown');
+  });
+});

templates/common/exit.handler.yml

@@ -29,13 +29,28 @@ spec:
           let parameters = {};
           {{= inputs.parameters.workflow_parameters }}.forEach((pair) => (parameters[pair.name] = pair.value));
 
+          function guessWorkflowGroup() {
+            const source = parameters['source'];
+            if (typeof(source) !== 'string') {
+              return 'unknown';
+            }
+            if (source.startsWith('s3://linz-topographic-upload')) {
+              return 'land';
+            }
+            if (source.startsWith('s3://linz-hydrographic-upload')) {
+              return 'sea';
+            }
+            return 'unknown';
+          }
+
           console.log(
             JSON.stringify({
               time: Date.now(),
               level: 20,
               pid: 1,
               msg: 'Workflow:Done',
               workflowStatus: '{{inputs.parameters.workflow_status}}', 
+              workflowGroup: guessWorkflowGroup(),
               parameters,
             }),
           );