@manablox/workflows 0.2.0

package/test/validate.test.ts

@@ -0,0 +1,129 @@
+import { ManabloxError, type WorkflowStep } from '@manablox/core';
+import { describe, expect, it } from 'vitest';
+import { validateWorkflow, type WorkflowInput } from '../src/validate.js';
+
+const env = { typeExists: (id: string) => id === 'page' };
+
+const email: WorkflowStep = {
+  id: '',
+  name: '',
+  enabled: true,
+  continueOnError: false,
+  type: 'email',
+  to: ['x@example.com'],
+  toRoles: [],
+  subject: 'Hi',
+  body: '',
+  html: false,
+};
+
+const valid: WorkflowInput = {
+  name: 'Notify',
+  trigger: { kind: 'event', events: ['content.saved'], typeIds: ['page'], locales: [] },
+  steps: [email],
+};
+
+function problems(input: WorkflowInput): string[] {
+  try {
+    validateWorkflow(input, env);
+    return [];
+  } catch (error) {
+    if (!ManabloxError.is(error)) throw error;
+    return error.details.map((detail) => `${detail.key}@${(detail.path ?? []).join('.')}`);
+  }
+}
+
+describe('validateWorkflow', () => {
+  it('passes a sound workflow and assigns step ids', () => {
+    const out = validateWorkflow(valid, env);
+    expect(out.steps[0]?.id).toMatch(/^[0-9a-f-]{36}$/);
+    expect(out.enabled).toBe(false);
+  });
+
+  it('reports every problem with its path', () => {
+    expect(
+      problems({
+        name: ' ',
+        trigger: { kind: 'event', events: [], typeIds: ['nope'], locales: [] },
+        steps: [],
+      }),
+    ).toEqual([
+      'workflow.name.required@name',
+      'workflow.trigger.eventsRequired@trigger.events',
+      'workflow.trigger.typeNotFound@trigger.typeIds.0',
+      'workflow.steps.required@steps',
+    ]);
+  });
+
+  it('checks a schedule', () => {
+    expect(
+      problems({
+        ...valid,
+        trigger: {
+          kind: 'schedule',
+          cron: '* * *',
+          timezone: 'Nowhere/Land',
+          selection: null,
+          perDocument: false,
+        },
+      }),
+    ).toEqual([
+      'workflow.trigger.cronInvalid@trigger.cron',
+      'workflow.trigger.timezoneInvalid@trigger.timezone',
+    ]);
+  });
+
+  it('checks each step type', () => {
+    expect(problems({ ...valid, steps: [{ ...email, to: [], subject: '' }] })).toEqual([
+      'workflow.step.email.recipientRequired@steps.0.to',
+      'workflow.step.email.subjectRequired@steps.0.subject',
+    ]);
+    expect(problems({ ...valid, steps: [{ ...email, to: ['not-an-address'] }] })).toEqual([
+      'workflow.step.email.recipientInvalid@steps.0.to.0',
+    ]);
+    expect(problems({ ...valid, steps: [{ ...email, to: ['{{ actor.email }}'] }] })).toEqual([]);
+    expect(
+      problems({
+        ...valid,
+        steps: [
+          {
+            id: '',
+            name: '',
+            enabled: true,
+            continueOnError: false,
+            type: 'http',
+            method: 'POST',
+            url: 'ftp://x',
+            headers: [{ name: 'bad header', value: 'x' }],
+            body: { mode: 'event', template: '' },
+            secret: null,
+            timeoutMs: 10_000,
+          },
+        ],
+      }),
+    ).toEqual([
+      'workflow.step.http.urlInvalid@steps.0.url',
+      'workflow.step.http.headerNameInvalid@steps.0.headers.0.name',
+    ]);
+    expect(
+      problems({
+        ...valid,
+        steps: [
+          {
+            id: '',
+            name: '',
+            enabled: true,
+            continueOnError: false,
+            type: 'condition',
+            match: 'all',
+            rules: [],
+          },
+          { id: '', name: '', enabled: true, continueOnError: false, type: 'delay', minutes: 0 },
+        ],
+      }),
+    ).toEqual([
+      'workflow.step.condition.rulesRequired@steps.0.rules',
+      'workflow.step.delay.minutesInvalid@steps.1.minutes',
+    ]);
+  });
+});

package/tsconfig.json

@@ -0,0 +1 @@
+{ "extends": "@manablox/config-typescript/library.json", "include": ["src", "test"] }

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config';
+export default defineConfig({
+  test: {
+    environment: 'node',
+    include: ['test/**/*.test.ts'],
+    testTimeout: 60_000,
+    hookTimeout: 60_000,
+  },
+});