Skip to content

Commit 5ebf0d2

Browse files
ericallamericallam
committed
add sdk compat tests
1 parent 808c2c2 commit 5ebf0d2

File tree

22 files changed

+898
-0
lines changed

22 files changed

+898
-0
lines changed

‎.github/workflows/pr_checks.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ jobs:
2929
with:
3030
package: cli-v3
3131
secrets: inherit
32+
33+
sdk-compat:
34+
uses: ./.github/workflows/sdk-compat.yml
35+
secrets: inherit

‎.github/workflows/sdk-compat.yml‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
name: "🔌 SDK Compatibility Tests"
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
workflow_call:
8+
9+
jobs:
10+
node-compat:
11+
name: "Node.js ${{ matrix.node }} (${{ matrix.os }})"
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
os: [ubuntu-latest, macos-latest, windows-latest]
17+
node: ["18.20", "20.20", "22.12"]
18+
exclude:
19+
# Skip Node 18 on macOS/Windows to reduce CI time
20+
# Linux coverage is sufficient for Node 18 compatibility
21+
- os: macos-latest
22+
node: "18.20"
23+
- os: windows-latest
24+
node: "18.20"
25+
26+
steps:
27+
- name: ⬇️ Checkout repo
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0
31+
32+
- name: ⎔ Setup pnpm
33+
uses: pnpm/action-setup@v4
34+
with:
35+
version: 10.23.0
36+
37+
- name: ⎔ Setup node
38+
uses: buildjet/setup-node@v4
39+
with:
40+
node-version: ${{ matrix.node }}
41+
cache: "pnpm"
42+
43+
- name: 📥 Download deps
44+
run: pnpm install --frozen-lockfile
45+
46+
- name: 📀 Generate Prisma Client
47+
run: pnpm run generate
48+
49+
- name: 🔨 Build SDK dependencies
50+
run: pnpm run build --filter @trigger.dev/sdk^...
51+
52+
- name: 🔨 Build SDK
53+
run: pnpm run build --filter @trigger.dev/sdk
54+
55+
- name: 🧪 Run SDK Compatibility Tests
56+
run: pnpm --filter @internal/sdk-compat-tests test
57+
58+
bun-compat:
59+
name: "Bun Runtime"
60+
runs-on: ubuntu-latest
61+
steps:
62+
- name: ⬇️ Checkout repo
63+
uses: actions/checkout@v4
64+
with:
65+
fetch-depth: 0
66+
67+
- name: ⎔ Setup pnpm
68+
uses: pnpm/action-setup@v4
69+
with:
70+
version: 10.23.0
71+
72+
- name: ⎔ Setup node
73+
uses: buildjet/setup-node@v4
74+
with:
75+
node-version: 20.20.0
76+
cache: "pnpm"
77+
78+
- name: 🥟 Setup Bun
79+
uses: oven-sh/setup-bun@v2
80+
with:
81+
bun-version: latest
82+
83+
- name: 📥 Download deps
84+
run: pnpm install --frozen-lockfile
85+
86+
- name: 📀 Generate Prisma Client
87+
run: pnpm run generate
88+
89+
- name: 🔨 Build SDK dependencies
90+
run: pnpm run build --filter @trigger.dev/sdk^...
91+
92+
- name: 🔨 Build SDK
93+
run: pnpm run build --filter @trigger.dev/sdk
94+
95+
- name: 🧪 Run Bun Compatibility Test
96+
working-directory: internal-packages/sdk-compat-tests/src/fixtures/bun
97+
run: bun run test.ts
98+
99+
deno-compat:
100+
name: "Deno Runtime"
101+
runs-on: ubuntu-latest
102+
steps:
103+
- name: ⬇️ Checkout repo
104+
uses: actions/checkout@v4
105+
with:
106+
fetch-depth: 0
107+
108+
- name: ⎔ Setup pnpm
109+
uses: pnpm/action-setup@v4
110+
with:
111+
version: 10.23.0
112+
113+
- name: ⎔ Setup node
114+
uses: buildjet/setup-node@v4
115+
with:
116+
node-version: 20.20.0
117+
cache: "pnpm"
118+
119+
- name: 🦕 Setup Deno
120+
uses: denoland/setup-deno@v2
121+
with:
122+
deno-version: v2.x
123+
124+
- name: 📥 Download deps
125+
run: pnpm install --frozen-lockfile
126+
127+
- name: 📀 Generate Prisma Client
128+
run: pnpm run generate
129+
130+
- name: 🔨 Build SDK dependencies
131+
run: pnpm run build --filter @trigger.dev/sdk^...
132+
133+
- name: 🔨 Build SDK
134+
run: pnpm run build --filter @trigger.dev/sdk
135+
136+
- name: 🔗 Link node_modules for Deno fixture
137+
working-directory: internal-packages/sdk-compat-tests/src/fixtures/deno
138+
run: ln -s ../../../../../node_modules node_modules
139+
140+
- name: 🧪 Run Deno Compatibility Test
141+
working-directory: internal-packages/sdk-compat-tests/src/fixtures/deno
142+
run: deno run --allow-read --allow-env --allow-sys test.ts
143+
144+
cloudflare-compat:
145+
name: "Cloudflare Workers"
146+
runs-on: ubuntu-latest
147+
steps:
148+
- name: ⬇️ Checkout repo
149+
uses: actions/checkout@v4
150+
with:
151+
fetch-depth: 0
152+
153+
- name: ⎔ Setup pnpm
154+
uses: pnpm/action-setup@v4
155+
with:
156+
version: 10.23.0
157+
158+
- name: ⎔ Setup node
159+
uses: buildjet/setup-node@v4
160+
with:
161+
node-version: 20.20.0
162+
cache: "pnpm"
163+
164+
- name: 📥 Download deps
165+
run: pnpm install --frozen-lockfile
166+
167+
- name: 📀 Generate Prisma Client
168+
run: pnpm run generate
169+
170+
- name: 🔨 Build SDK dependencies
171+
run: pnpm run build --filter @trigger.dev/sdk^...
172+
173+
- name: 🔨 Build SDK
174+
run: pnpm run build --filter @trigger.dev/sdk
175+
176+
- name: 📥 Install Cloudflare fixture deps
177+
working-directory: internal-packages/sdk-compat-tests/src/fixtures/cloudflare-worker
178+
run: pnpm install
179+
180+
- name: 🧪 Run Cloudflare Workers Compatibility Test (dry-run)
181+
working-directory: internal-packages/sdk-compat-tests/src/fixtures/cloudflare-worker
182+
run: pnpm exec wrangler deploy --dry-run --outdir dist

‎internal-packages/sdk-compat-tests/package.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "@internal/sdk-compat-tests",
3+
"private": true,
4+
"version": "0.0.1",
5+
"type": "module",
6+
"scripts": {
7+
"test": "vitest --run",
8+
"test:watch": "vitest",
9+
"typecheck": "tsc --noEmit"
10+
},
11+
"dependencies": {
12+
"@trigger.dev/sdk": "workspace:*"
13+
},
14+
"devDependencies": {
15+
"esbuild": "^0.24.0",
16+
"execa": "^9.3.0",
17+
"typescript": "^5.5.0",
18+
"vitest": "^2.0.5"
19+
}
20+
}

‎internal-packages/sdk-compat-tests/src/fixtures/bun/package.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "bun-fixture",
3+
"private": true,
4+
"type": "module"
5+
}

‎internal-packages/sdk-compat-tests/src/fixtures/bun/test.ts‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/**
2+
* Bun Import Test Fixture
3+
*
4+
* Tests that the SDK works correctly with Bun runtime.
5+
* Bun has high Node.js compatibility but uses its own module resolver.
6+
*/
7+
8+
import { task, logger, schedules, runs, configure, queue, retry, wait } from "@trigger.dev/sdk";
9+
10+
// Validate exports exist
11+
const checks: [string, boolean][] = [
12+
["task", typeof task === "function"],
13+
["logger", typeof logger === "object" && typeof logger.info === "function"],
14+
["schedules", typeof schedules === "object"],
15+
["runs", typeof runs === "object"],
16+
["configure", typeof configure === "function"],
17+
["queue", typeof queue === "function"],
18+
["retry", typeof retry === "object"],
19+
["wait", typeof wait === "object"],
20+
];
21+
22+
let failed = false;
23+
for (const [name, passed] of checks) {
24+
if (!passed) {
25+
console.error(`FAIL: ${name} export check failed`);
26+
failed = true;
27+
}
28+
}
29+
30+
// Test task definition with types
31+
interface Payload {
32+
message: string;
33+
}
34+
35+
const myTask = task({
36+
id: "bun-test-task",
37+
run: async (payload: Payload) => {
38+
return { received: payload.message };
39+
},
40+
});
41+
42+
if (myTask.id !== "bun-test-task") {
43+
console.error(`FAIL: task.id mismatch`);
44+
failed = true;
45+
}
46+
47+
// Test queue definition
48+
const myQueue = queue({
49+
name: "bun-test-queue",
50+
concurrencyLimit: 5,
51+
});
52+
53+
if (!myQueue) {
54+
console.error(`FAIL: queue creation failed`);
55+
failed = true;
56+
}
57+
58+
if (failed) {
59+
process.exit(1);
60+
}
61+
62+
console.log("SUCCESS: Bun imports validated");

‎internal-packages/sdk-compat-tests/src/fixtures/cjs-require/package.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "cjs-require-fixture",
3+
"private": true
4+
}

‎internal-packages/sdk-compat-tests/src/fixtures/cjs-require/test.cjs‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/**
2+
* CJS Require Test Fixture
3+
*
4+
* This file validates that the SDK can be required using CommonJS syntax.
5+
* This is critical for:
6+
* - Node.js < 22.12.0 (where require(ESM) is not enabled by default)
7+
* - AWS Lambda (intentionally disables require(ESM))
8+
* - Legacy Node.js applications
9+
*/
10+
11+
// Test main export
12+
const sdk = require("@trigger.dev/sdk");
13+
14+
// Test /v3 subpath
15+
const sdkV3 = require("@trigger.dev/sdk/v3");
16+
17+
// Validate exports exist
18+
const checks = [
19+
["task", typeof sdk.task === "function"],
20+
["taskV3", typeof sdkV3.task === "function"],
21+
["logger", typeof sdk.logger === "object" && typeof sdk.logger.info === "function"],
22+
["schedules", typeof sdk.schedules === "object"],
23+
["runs", typeof sdk.runs === "object"],
24+
["configure", typeof sdk.configure === "function"],
25+
["queue", typeof sdk.queue === "function"],
26+
["retry", typeof sdk.retry === "object"],
27+
["wait", typeof sdk.wait === "object"],
28+
["metadata", typeof sdk.metadata === "object"],
29+
["tags", typeof sdk.tags === "object"],
30+
];
31+
32+
let failed = false;
33+
for (const [name, passed] of checks) {
34+
if (!passed) {
35+
console.error(`FAIL: ${name} export check failed`);
36+
failed = true;
37+
}
38+
}
39+
40+
// Test task definition works
41+
const myTask = sdk.task({
42+
id: "cjs-test-task",
43+
run: async (payload) => {
44+
return { received: payload };
45+
},
46+
});
47+
48+
if (myTask.id !== "cjs-test-task") {
49+
console.error(`FAIL: task.id mismatch: expected "cjs-test-task", got "${myTask.id}"`);
50+
failed = true;
51+
}
52+
53+
if (failed) {
54+
process.exit(1);
55+
}
56+
57+
console.log("SUCCESS: All CJS requires validated");

‎internal-packages/sdk-compat-tests/src/fixtures/cloudflare-worker/package.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "cloudflare-worker-fixture",
3+
"private": true,
4+
"type": "module",
5+
"scripts": {
6+
"build": "wrangler deploy --dry-run --outdir dist"
7+
},
8+
"devDependencies": {
9+
"wrangler": "^3.0.0"
10+
}
11+
}

‎internal-packages/sdk-compat-tests/src/fixtures/cloudflare-worker/src/index.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/**
2+
* Cloudflare Worker Test Fixture
3+
*
4+
* Tests that the SDK can be bundled for Cloudflare Workers (workerd runtime).
5+
* This validates the bundling process works - actual execution would require
6+
* a Trigger.dev API connection.
7+
*/
8+
9+
import { task, runs, configure } from "@trigger.dev/sdk";
10+
11+
// Define a task (won't execute in worker, but validates import)
12+
const myTask = task({
13+
id: "cloudflare-test-task",
14+
run: async (payload: { message: string }) => {
15+
return { received: payload.message };
16+
},
17+
});
18+
19+
export default {
20+
async fetch(request: Request, env: unknown, ctx: ExecutionContext): Promise<Response> {
21+
// Validate SDK imports work
22+
const checks = {
23+
taskDefined: typeof task === "function",
24+
runsDefined: typeof runs === "object",
25+
configureDefined: typeof configure === "function",
26+
taskIdCorrect: myTask.id === "cloudflare-test-task",
27+
};
28+
29+
const allPassed = Object.values(checks).every((v) => v === true);
30+
31+
return new Response(
32+
JSON.stringify({
33+
success: allPassed,
34+
checks,
35+
}),
36+
{
37+
headers: { "Content-Type": "application/json" },
38+
}
39+
);
40+
},
41+
};

0 commit comments

Comments
 (0)