feat: support for re-usable global functions in workflows

integration-tests/cli/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @openfn/integration-tests-cli
 
+## 1.0.3
+
+### Patch Changes
+
+- @openfn/lightning-mock@2.2.1
+
 ## 1.0.2
 
 ### Patch Changes

integration-tests/cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/integration-tests-cli",
   "private": true,
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "CLI integration tests",
   "author": "Open Function Group <admin@openfn.org>",
   "license": "ISC",

integration-tests/cli/test/errors.test.ts

@@ -88,7 +88,11 @@ test.serial("can't find config referenced in a workflow", async (t) => {
 
   const stdlogs = extractLogs(stdout);
 
-  assertLog(t, stdlogs, /File not found for job 1: does-not-exist.js/i);
+  assertLog(
+    t,
+    stdlogs,
+    /File not found for job configuration 1: does-not-exist.js/i
+  );
   assertLog(
     t,
     stdlogs,

integration-tests/cli/test/execute-workflow.test.ts

@@ -221,3 +221,55 @@ test.serial(
     });
   }
 );
+
+test.serial(`openfn ${jobsPath}/globals-exp.json`, async (t) => {
+  const res = await run(t.title);
+  t.falsy(res.err);
+  const out = getJSON();
+  t.deepEqual(out, {
+    alter: 'heartsfx',
+    data: {},
+    final: 'some-big-valueheartsfx',
+    val: 'some-big-value',
+  });
+});
+
+test.serial(`openfn ${jobsPath}/globals-path.json`, async (t) => {
+  const res = await run(t.title);
+  t.falsy(res.err);
+  const out = getJSON();
+  t.deepEqual(out, {
+    alter: 'heart.path.value',
+    data: {},
+    final: 'path-valueheart.path.value',
+    val: 'path-value',
+  });
+});
+
+test.serial(
+  `openfn ${jobsPath}/globals-job.js --globals="export const suffixer = w => w + '-some-suffix'" -a common`,
+  async (t) => {
+    const res = await run(t.title);
+    t.falsy(res.err);
+    const out = getJSON();
+    t.deepEqual(out, {
+      data: {
+        result: 'love-some-suffix',
+      },
+    });
+  }
+);
+
+test.serial(
+  `openfn ${jobsPath}/globals-job.js --globals ${jobsPath}/globals-path-file.js -a common`,
+  async (t) => {
+    const res = await run(t.title);
+    t.falsy(res.err);
+    const out = getJSON();
+    t.deepEqual(out, {
+      data: {
+        result: 'love-humble-suffix',
+      },
+    });
+  }
+);

integration-tests/cli/test/fixtures/globals-exp.json

@@ -0,0 +1,19 @@
+{
+  "workflow": {
+    "globals": "export const BIG_VAL = 'some-big-value'; export function suffix(name){ return name + 'sfx'}",
+    "steps": [
+      {
+        "adaptor": "common",
+        "expression": "fn(state=> ({val: BIG_VAL, alter: suffix('heart')}))",
+        "next": {
+          "b": true
+        }
+      },
+      {
+        "id": "b",
+        "adaptor": "common",
+        "expression": "fn((state) => { state.final = state.val + state.alter; return state; });"
+      }
+    ]
+  }
+}

integration-tests/cli/test/fixtures/globals-job.js

@@ -0,0 +1,3 @@
+fn(() => {
+  return { data: { result: suffixer('love') } }
+})

integration-tests/cli/test/fixtures/globals-path-file.js

@@ -0,0 +1,7 @@
+export const BIG_VAL = 'path-value';
+
+export function suffix(name) {
+    return name + '.path.value'
+}
+
+export const suffixer = w => w + '-humble-suffix'

integration-tests/cli/test/fixtures/globals-path.json

@@ -0,0 +1,19 @@
+{
+  "workflow": {
+    "globals": "./globals-path-file.js",
+    "steps": [
+      {
+        "adaptor": "common",
+        "expression": "fn(state=> ({val: BIG_VAL, alter: suffix('heart')}))",
+        "next": {
+          "b": true
+        }
+      },
+      {
+        "id": "b",
+        "adaptor": "common",
+        "expression": "fn((state) => { state.final = state.val + state.alter; return state; });"
+      }
+    ]
+  }
+}

integration-tests/execute/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @openfn/integration-tests-execute
 
+## 1.0.21
+
+### Patch Changes
+
+- Updated dependencies [9d4ece3]
+  - @openfn/compiler@1.1.0
+  - @openfn/runtime@1.7.0
+
 ## 1.0.20
 
 ### Patch Changes

integration-tests/execute/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/integration-tests-execute",
   "private": true,
-  "version": "1.0.20",
+  "version": "1.0.21",
   "description": "Job execution tests",
   "author": "Open Function Group <admin@openfn.org>",
   "license": "ISC",

integration-tests/worker/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @openfn/integration-tests-worker
 
+## 1.0.89
+
+### Patch Changes
+
+- Updated dependencies [9d4ece3]
+  - @openfn/ws-worker@1.14.0
+  - @openfn/engine-multi@1.6.7
+  - @openfn/lightning-mock@2.2.1
+
 ## 1.0.88
 
 ### Patch Changes

integration-tests/worker/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/integration-tests-worker",
   "private": true,
-  "version": "1.0.88",
+  "version": "1.0.89",
   "description": "Lightning WOrker integration tests",
   "author": "Open Function Group <admin@openfn.org>",
   "license": "ISC",

packages/cli/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @openfn/cli
 
+## 1.13.0
+
+### Minor Changes
+
+- 9d4ece3: Add support for global functions in execution plan
+
+### Patch Changes
+
+- Updated dependencies [9d4ece3]
+  - @openfn/compiler@1.1.0
+  - @openfn/runtime@1.7.0
+
 ## 1.12.1
 
 ### Patch Changes

packages/cli/README.md

@@ -317,6 +317,7 @@ A workflow has a structure like this:
 {
   "workflow": {
     "name": "my-workflow", // human readable name used in logging
+    "globals": "./common-funcs.js", // code or path to functions that can be accessed in any step. globally scoped
     "steps": [
       {
         "name": "a", // human readable name used in logging

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",

packages/cli/src/compile/command.ts

@@ -17,6 +17,7 @@ export type CompileOptions = Pick<
   | 'repoDir'
   | 'path'
   | 'useAdaptorsMonorepo'
+  | 'globals'
 > & {
   workflow?: Opts['workflow'];
   repoDir?: string;

packages/cli/src/compile/compile.ts

@@ -1,4 +1,8 @@
-import compile, { preloadAdaptorExports, Options } from '@openfn/compiler';
+import compile, {
+  preloadAdaptorExports,
+  Options,
+  getExports,
+} from '@openfn/compiler';
 import { getModulePath } from '@openfn/runtime';
 import type {
   ExecutionPlan,
@@ -72,11 +76,14 @@ const compileWorkflow = async (
   opts: CompileOptions,
   log: Logger
 ) => {
+  let globalsIgnoreList: string[] = getExports(plan.workflow.globals);
+
   for (const step of plan.workflow.steps) {
     const job = step as Job;
     const jobOpts = {
       ...opts,
       adaptors: job.adaptors ?? opts.adaptors,
+      ignoreImports: globalsIgnoreList,
     };
     if (job.expression) {
       const { code, map } = await compileJob(

packages/cli/src/execute/command.ts

@@ -33,6 +33,7 @@ export type ExecuteOptions = Required<
     | 'timeout'
     | 'useAdaptorsMonorepo'
     | 'workflowPath'
+    | 'globals'
   >
 > &
   Pick<Opts, 'monorepoPath' | 'repoDir'>;

packages/cli/src/options.ts

@@ -18,6 +18,7 @@ export type Opts = {
   command?: CommandList;
   baseDir?: string;
 
+  globals?: string;
   adaptor?: boolean | string;
   adaptors?: string[];
   apolloUrl?: string;

packages/cli/src/types.ts

@@ -18,6 +18,7 @@ export type CLIExecutionPlan = {
     id?: UUID;
     name?: string;
     steps: Array<CLIJobNode | Trigger>;
+    globals?: string;
   };
 };