Merge pull request #1141 from OpenFn/export-functions

josephjclark · web-flow · commit 4df8a3510efe · 2025-11-21T15:23:37.000Z
Allow functions to be exported from job code
diff --git a/integration-tests/execute/readme.md b/integration-tests/execute/readme.md
@@ -1,5 +1,5 @@
 This is a suite of examples of jobs.
 
-We don't really have a place where we can just write and test arbtirary job code with compilation.
+We don't really have a place where we can just write and test arbitrary job code with compilation.
 
 You can do it through the CLI or worker but they have significant overheads.
diff --git a/integration-tests/execute/test/execute.test.ts b/integration-tests/execute/test/execute.test.ts
@@ -20,6 +20,18 @@ test.serial('should return state', async (t) => {
   t.deepEqual(state, result);
 });
 
+test.serial('allow export statements and functions', async (t) => {
+  const state = {};
+
+  const job = `
+    export const x = () => ({ x: 90 })
+    fn(() => x())
+  `;
+  const result = await execute(job, state);
+
+  t.deepEqual(result, { x: 90 });
+});
+
 test.serial('should use .then()', async (t) => {
   const state = { data: { x: 1 } };
 
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @openfn/cli
 
+## 1.18.6
+
+### Patch Changes
+
+- Updated dependencies [6bd4210]
+  - @openfn/compiler@1.2.0
+
 ## 1.18.5
 
 ### Patch Changes
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.18.5",
+  "version": "1.18.6",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @openfn/compiler
 
+## 1.2.0
+
+### Minor Changes
+
+- 6bd4210: Allow expressions to export named identifiers
+
 ## 1.1.5
 
 ### Patch Changes
diff --git a/packages/compiler/package.json b/packages/compiler/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/compiler",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "description": "Compiler and language tooling for openfn jobs.",
   "author": "Open Function Group <admin@openfn.org>",
   "license": "ISC",
diff --git a/packages/compiler/src/get-exports.ts b/packages/compiler/src/get-exports.ts
diff --git a/packages/compiler/src/index.ts b/packages/compiler/src/index.ts
@@ -1,5 +1,5 @@
 import compile from './compile';
-export { default as getExports } from './getExports';
+export { default as getExports } from './get-exports';
 
 export * from './util';
 export type { TransformOptions } from './transform';
diff --git a/packages/compiler/src/transforms/ensure-exports.ts b/packages/compiler/src/transforms/ensure-exports.ts
@@ -11,8 +11,11 @@ import type { Transformer } from '../transform';
 
 function visitor(path: NodePath<namedTypes.Program>) {
   // check the export statements
-  // if we find any, we do nothing
-  const currentExport = path.node.body.find(({ type }) => type.match(/Export/));
+  // if we find any export default, assume this code is compiled
+  // and do nothing
+  const currentExport = path.node.body.find(({ type }) =>
+    type.match(/ExportDefault/)
+  );
   if (currentExport) {
     return true;
   }
diff --git a/packages/compiler/test/compile.test.ts b/packages/compiler/test/compile.test.ts
@@ -44,9 +44,9 @@ test('ensure default exports is created', (t) => {
   t.is(result, expected);
 });
 
-test('do not add default exports if exports exist', (t) => {
-  const source = 'export const x = 10;';
-  const expected = 'export const x = 10;';
+test('do not add default exports if default exports exist', (t) => {
+  const source = 'export const x = 10;export default [];';
+  const expected = 'export const x = 10;export default [];';
   const { code: result } = compile(source);
   t.is(result, expected);
 });
diff --git a/packages/compiler/test/get-exports.test.ts b/packages/compiler/test/get-exports.test.ts
@@ -1,5 +1,5 @@
 import test from 'ava';
-import getExports from '../src/getExports';
+import getExports from '../src/get-exports';
 
 test('exported variable', (t) => {
   const source = 'export const BigVal = 56;';
diff --git a/packages/compiler/test/transforms/ensure-exports.test.ts b/packages/compiler/test/transforms/ensure-exports.test.ts
@@ -1,10 +1,10 @@
-import test, { ExecutionContext } from 'ava';
-import { namedTypes, NodePath, builders as b } from 'ast-types';
+import test from 'ava';
+import { NodePath, builders as b } from 'ast-types';
 import parse from '../../src/parse';
+import { print } from 'recast';
 
 import transform from '../../src/transform';
 import visitors from '../../src/transforms/ensure-exports';
-import { assertCodeEqual } from '../util';
 
 // TODO where can I get this info?
 // Representations of ast nodes is a bit of a mess tbh
@@ -82,40 +82,49 @@ fn();`);
 
 test("don't change source with a default export", (t) => {
   const ast = parse('export default [];');
+  const before = print(ast).code;
 
   // There are many kinds of export nodes so as a short hand, let's just check for export keywords
-
   const e = findKeyword(ast, 'export');
   t.truthy(e);
 
   const transformed = transform(ast, [visitors]);
-  assertCodeEqual(t, ast, transformed);
+  const after = print(transformed).code;
+
+  t.true(before === after);
 });
 
-test("don't change source with a named export", (t) => {
+// These behaviours changed in compiler 1.2
+test('do change source with a named export', (t) => {
   const ast = parse('const x = 10; export { x };');
 
   const transformed = transform(ast, [visitors]);
-  assertCodeEqual(t, ast, transformed);
+
+  const last = transformed.program.body.at(-1);
+  t.assert(last.type === 'ExportDefaultDeclaration');
 });
 
-test("don't change source with a named export const ", (t) => {
+test('do change source with a named export const ', (t) => {
   const ast = parse('export const x = 10;');
 
   const transformed = transform(ast, [visitors]);
-  assertCodeEqual(t, ast, transformed);
+
+  const last = transformed.program.body.at(-1);
+  t.assert(last.type === 'ExportDefaultDeclaration');
 });
 
-test("don't change source with a specifier", (t) => {
+test('do change source with a specifier', (t) => {
   const ast = parse('const x = 10; export { x as y };');
 
   const transformed = transform(ast, [visitors]);
-  assertCodeEqual(t, ast, transformed);
+  const last = transformed.program.body.at(-1);
+  t.assert(last.type === 'ExportDefaultDeclaration');
 });
 
-test("don't change source with an export all", (t) => {
+test('do change source with an export all', (t) => {
   const ast = parse('export * from "foo";');
 
   const transformed = transform(ast, [visitors]);
-  assertCodeEqual(t, ast, transformed);
+  const last = transformed.program.body.at(-1);
+  t.assert(last.type === 'ExportDefaultDeclaration');
 });
diff --git a/packages/compiler/test/transforms/top-level-operations.test.ts b/packages/compiler/test/transforms/top-level-operations.test.ts
@@ -1,15 +1,14 @@
 import test from 'ava';
 import { builders as b, namedTypes as n } from 'ast-types';
-
+import { print } from 'recast';
 import transform from '../../src/transform';
 import parse from '../../src/parse';
 import visitors from '../../src/transforms/top-level-operations';
-import { assertCodeEqual } from '../util';
 
-const createProgramWithExports = (statements) =>
+const createProgramWithExports = (statements: any[]) =>
   b.program([...statements, b.exportDefaultDeclaration(b.arrayExpression([]))]);
 
-const createOperationStatement = (name, args: any[] = []) =>
+const createOperationStatement = (name: string, args: any[] = []) =>
   b.expressionStatement(b.callExpression(b.identifier(name), args));
 
 test('visits a Call Expression node', (t) => {
@@ -167,16 +166,19 @@ test('does not move a method call inside an assignment', (t) => {
 
 test("does nothing if there's no export statement", (t) => {
   const ast = b.program([createOperationStatement('fn')]);
+  const before = print(ast).code;
 
   const transformed = transform(ast, [visitors]) as n.Program;
+  const after = print(transformed).code;
+
   // should only be ony top level child
   t.assert(transformed.body.length === 1);
 
   // That child should be an expression statement
   t.assert(n.ExpressionStatement.check(transformed.body[0]));
 
   // In fact the code should be unchanged
-  assertCodeEqual(t, ast, transformed);
+  t.true(before === after);
 });
 
 test('should only take the top of a nested operation call (and preserve its arguments)', (t) => {
diff --git a/packages/compiler/test/util.ts b/packages/compiler/test/util.ts
@@ -1,17 +1,5 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { ExecutionContext } from 'ava';
-import { namedTypes } from 'ast-types';
-import { print } from 'recast';
 
 export const loadAst = (name: string): string =>
   fs.readFileSync(path.resolve(`test/asts/${name}.json`), 'utf8') as string;
-
-// Ensure the code of two asts is equal
-export const assertCodeEqual = (
-  t: ExecutionContext,
-  a: namedTypes.Node,
-  b: namedTypes.Node
-) => {
-  t.assert(print(a).code === print(b).code);
-};
diff --git a/packages/engine-multi/CHANGELOG.md b/packages/engine-multi/CHANGELOG.md
@@ -1,5 +1,12 @@
 # engine-multi
 
+## 1.8.4
+
+### Patch Changes
+
+- Updated dependencies [6bd4210]
+  - @openfn/compiler@1.2.0
+
 ## 1.8.3
 
 ### Patch Changes
diff --git a/packages/engine-multi/package.json b/packages/engine-multi/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/engine-multi",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "description": "Multi-process runtime engine",
   "main": "dist/index.js",
   "type": "module",
diff --git a/packages/lightning-mock/CHANGELOG.md b/packages/lightning-mock/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @openfn/lightning-mock
 
+## 2.3.7
+
+### Patch Changes
+
+- @openfn/engine-multi@1.8.4
+
 ## 2.3.6
 
 ### Patch Changes
diff --git a/packages/lightning-mock/package.json b/packages/lightning-mock/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/lightning-mock",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "private": true,
   "description": "A mock Lightning server",
   "main": "dist/index.js",
diff --git a/packages/ws-worker/CHANGELOG.md b/packages/ws-worker/CHANGELOG.md
@@ -1,5 +1,11 @@
 # ws-worker
 
+## 1.19.6
+
+### Patch Changes
+
+- @openfn/engine-multi@1.8.4
+
 ## 1.19.5
 
 ### Patch Changes
diff --git a/packages/ws-worker/package.json b/packages/ws-worker/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.19.5",
+  "version": "1.19.6",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@openfn/cli",`
`3`		`- "version": "1.18.5",`
	`3`	`+ "version": "1.18.6",`
`4`	`4`	`"description": "CLI devtools for the OpenFn toolchain",`
`5`	`5`	`"engines": {`
`6`	`6`	`"node": ">=18",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@openfn/compiler",`
`3`		`- "version": "1.1.5",`
	`3`	`+ "version": "1.2.0",`
`4`	`4`	`"description": "Compiler and language tooling for openfn jobs.",`
`5`	`5`	`"author": "Open Function Group <admin@openfn.org>",`
`6`	`6`	`"license": "ISC",`