Skip to content

Commit 26eb7d2

Browse files
d-csd-cs
committed
test(run-engine): route waitpoint tests through a shared engine factory
Adds the factory the two-arm parameterization needs, and moves the six waitpoint-subject files onto it. The arm defaults to legacy, so this commit changes no behaviour and every one of these tests still asserts what it did. The factory takes the arm at construction rather than per call, because an engine with no store configured cannot reach the store path at all, which is what an unflipped deployment actually looks like. Two helpers ship with it. freshRunFriendlyId keeps a store-arm test from triggering with a legacy run id, which would mint a legacy waitpoint and assert nothing about the store. assertStoreResident is the same guard stated at the assertion site, for tests that are supposed to mint into the store.
1 parent a8654cb commit 26eb7d2

7 files changed

Lines changed: 104 additions & 37 deletions

File tree

‎internal-packages/run-engine/src/engine/tests/batchTriggerAndWait.test.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import {
55
import { trace } from "@internal/tracing";
66
import { expect, describe } from "vitest";
77
import { RunEngine } from "../index.js";
8+
import { createTestEngine } from "./helpers/engineFactory.js";
89
import { setTimeout } from "node:timers/promises";
910
import { generateFriendlyId, BatchId } from "@trigger.dev/core/v3/isomorphic";
1011
import { setupAuthenticatedEnvironment, setupBackgroundWorker } from "./setup.js";
@@ -17,7 +18,7 @@ describe("RunEngine batchTriggerAndWait", () => {
1718
//create environment
1819
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
1920

20-
const engine = new RunEngine({
21+
const engine = createTestEngine({
2122
prisma,
2223
worker: {
2324
redis: redisOptions,
@@ -366,7 +367,7 @@ describe("RunEngine batchTriggerAndWait", () => {
366367
//create environment
367368
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
368369

369-
const engine = new RunEngine({
370+
const engine = createTestEngine({
370371
prisma,
371372
worker: {
372373
redis: redisOptions,
@@ -587,7 +588,7 @@ describe("RunEngine batchTriggerAndWait", () => {
587588
// Create environment
588589
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
589590

590-
const engine = new RunEngine({
591+
const engine = createTestEngine({
591592
prisma,
592593
worker: {
593594
redis: redisOptions,
@@ -883,7 +884,7 @@ describe("RunEngine batchTriggerAndWait", () => {
883884
// Create environment
884885
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
885886

886-
const engine = new RunEngine({
887+
const engine = createTestEngine({
887888
prisma,
888889
worker: {
889890
redis: redisOptions,

‎internal-packages/run-engine/src/engine/tests/helpers/engineFactory.ts‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
import type { RedisOptions } from "@internal/redis";
2+
import { generateRunOpsId, parseWaitpointId, RunId } from "@trigger.dev/core/v3/isomorphic";
3+
import { RunEngine } from "../../index.js";
4+
import type { RunEngineOptions } from "../../types.js";
5+
6+
/** Which waitpoint coordinator the engine under test routes through. */
7+
export type WaitpointArm = "legacy" | "store";
8+
9+
export type CreateTestEngineOptions = Omit<RunEngineOptions, "waitpointStore"> & {
10+
/** Defaults to legacy, which is the behaviour every pre-existing test expects. */
11+
waitpointArm?: WaitpointArm;
12+
/** Redis for the store arm. Defaults to the run lock's, which is what tests already pass. */
13+
waitpointStoreRedis?: RedisOptions;
14+
};
15+
16+
/**
17+
* Build a RunEngine for a test, with the waitpoint arm selectable.
18+
*
19+
* The arm is a constructor concern rather than a per-call one: an engine with no store
20+
* configured cannot reach the store path at all, which is what an unflipped deployment
21+
* looks like. Tests that also want to exercise the mint flag pass `waitpointMintKind` at
22+
* the call site, as production does.
23+
*/
24+
export function createTestEngine(options: CreateTestEngineOptions): RunEngine {
25+
const { waitpointArm = "legacy", waitpointStoreRedis, ...engineOptions } = options;
26+
27+
return new RunEngine({
28+
...engineOptions,
29+
waitpointStore:
30+
waitpointArm === "store"
31+
? { redis: waitpointStoreRedis ?? engineOptions.runLock.redis }
32+
: undefined,
33+
});
34+
}
35+
36+
/**
37+
* A run friendly id whose shape suits the arm.
38+
*
39+
* A store RUN or BATCH waitpoint derives its id from the anchor's id body, so a store-arm
40+
* test that triggers with a legacy id mints a LEGACY waitpoint, passes every assertion,
41+
* and proves nothing. Use this rather than a literal.
42+
*/
43+
export function freshRunFriendlyId(arm: WaitpointArm): string {
44+
return arm === "store" ? RunId.toFriendlyId(generateRunOpsId()) : RunId.generate().friendlyId;
45+
}
46+
47+
/**
48+
* Assert a store-arm test actually minted into the store.
49+
*
50+
* The failure this catches is a test that runs green on both arms while the store arm
51+
* quietly did nothing, which is the most plausible way for this migration to look
52+
* finished and not be. Call it where a test is expected to mint.
53+
*/
54+
export function assertStoreResident(waitpointId: string): void {
55+
if (parseWaitpointId(waitpointId).format !== "b32hexW") {
56+
throw new Error(
57+
`expected ${waitpointId} to be store resident; a store-arm test that mints a legacy ` +
58+
`waitpoint asserts nothing about the store path`
59+
);
60+
}
61+
}

‎internal-packages/run-engine/src/engine/tests/lazyWaitpoint.test.ts‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { containerTest, assertNonNullable } from "@internal/testcontainers";
22
import { trace } from "@internal/tracing";
33
import { expect } from "vitest";
44
import { RunEngine } from "../index.js";
5+
import { createTestEngine } from "./helpers/engineFactory.js";
56
import { setTimeout } from "node:timers/promises";
67
import { setupAuthenticatedEnvironment, setupBackgroundWorker } from "./setup.js";
78

@@ -13,7 +14,7 @@ describe("RunEngine lazy waitpoint creation", () => {
1314
async ({ prisma, redisOptions }) => {
1415
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
1516

16-
const engine = new RunEngine({
17+
const engine = createTestEngine({
1718
prisma,
1819
worker: {
1920
redis: redisOptions,
@@ -90,7 +91,7 @@ describe("RunEngine lazy waitpoint creation", () => {
9091
containerTest("Waitpoint created for triggerAndWait", async ({ prisma, redisOptions }) => {
9192
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
9293

93-
const engine = new RunEngine({
94+
const engine = createTestEngine({
9495
prisma,
9596
worker: {
9697
redis: redisOptions,
@@ -199,7 +200,7 @@ describe("RunEngine lazy waitpoint creation", () => {
199200
containerTest("Completion without waitpoint succeeds", async ({ prisma, redisOptions }) => {
200201
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
201202

202-
const engine = new RunEngine({
203+
const engine = createTestEngine({
203204
prisma,
204205
worker: {
205206
redis: redisOptions,
@@ -301,7 +302,7 @@ describe("RunEngine lazy waitpoint creation", () => {
301302
containerTest("Cancellation without waitpoint succeeds", async ({ prisma, redisOptions }) => {
302303
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
303304

304-
const engine = new RunEngine({
305+
const engine = createTestEngine({
305306
prisma,
306307
worker: {
307308
redis: redisOptions,
@@ -386,7 +387,7 @@ describe("RunEngine lazy waitpoint creation", () => {
386387
containerTest("TTL expiration without waitpoint succeeds", async ({ prisma, redisOptions }) => {
387388
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
388389

389-
const engine = new RunEngine({
390+
const engine = createTestEngine({
390391
prisma,
391392
worker: {
392393
redis: redisOptions,
@@ -485,7 +486,7 @@ describe("RunEngine lazy waitpoint creation", () => {
485486
async ({ prisma, redisOptions }) => {
486487
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
487488

488-
const engine = new RunEngine({
489+
const engine = createTestEngine({
489490
prisma,
490491
worker: {
491492
redis: redisOptions,
@@ -606,7 +607,7 @@ describe("RunEngine lazy waitpoint creation", () => {
606607
async ({ prisma, redisOptions }) => {
607608
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
608609

609-
const engine = new RunEngine({
610+
const engine = createTestEngine({
610611
prisma,
611612
worker: {
612613
redis: redisOptions,
@@ -701,7 +702,7 @@ describe("RunEngine lazy waitpoint creation", () => {
701702
async ({ prisma, redisOptions }) => {
702703
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
703704

704-
const engine = new RunEngine({
705+
const engine = createTestEngine({
705706
prisma,
706707
worker: {
707708
redis: redisOptions,
@@ -818,7 +819,7 @@ describe("RunEngine lazy waitpoint creation", () => {
818819
async ({ prisma, redisOptions }) => {
819820
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
820821

821-
const engine = new RunEngine({
822+
const engine = createTestEngine({
822823
prisma,
823824
worker: {
824825
redis: redisOptions,
@@ -930,7 +931,7 @@ describe("RunEngine lazy waitpoint creation", () => {
930931
async ({ prisma, redisOptions }) => {
931932
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
932933

933-
const engine = new RunEngine({
934+
const engine = createTestEngine({
934935
prisma,
935936
worker: {
936937
redis: redisOptions,
@@ -1029,7 +1030,7 @@ describe("RunEngine lazy waitpoint creation", () => {
10291030
async ({ prisma, redisOptions }) => {
10301031
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
10311032

1032-
const engine = new RunEngine({
1033+
const engine = createTestEngine({
10331034
prisma,
10341035
worker: {
10351036
redis: redisOptions,
@@ -1190,7 +1191,7 @@ describe("RunEngine lazy waitpoint creation", () => {
11901191
async ({ prisma, redisOptions }) => {
11911192
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
11921193

1193-
const engine = new RunEngine({
1194+
const engine = createTestEngine({
11941195
prisma,
11951196
worker: {
11961197
redis: redisOptions,

‎internal-packages/run-engine/src/engine/tests/triggerAndWait.test.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { assertNonNullable, containerTest } from "@internal/testcontainers";
22
import { trace } from "@internal/tracing";
33
import { expect } from "vitest";
44
import { RunEngine } from "../index.js";
5+
import { createTestEngine } from "./helpers/engineFactory.js";
56
import { setTimeout } from "node:timers/promises";
67
import { setupAuthenticatedEnvironment, setupBackgroundWorker } from "./setup.js";
78
import { RunDuplicateIdempotencyKeyError } from "../errors.js";
@@ -13,7 +14,7 @@ describe("RunEngine triggerAndWait", () => {
1314
//create environment
1415
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
1516

16-
const engine = new RunEngine({
17+
const engine = createTestEngine({
1718
prisma,
1819
worker: {
1920
redis: redisOptions,
@@ -203,7 +204,7 @@ describe("RunEngine triggerAndWait", () => {
203204
//create environment
204205
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
205206

206-
const engine = new RunEngine({
207+
const engine = createTestEngine({
207208
prisma,
208209
worker: {
209210
redis: redisOptions,
@@ -460,7 +461,7 @@ describe("RunEngine triggerAndWait", () => {
460461
//create environment
461462
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
462463

463-
const engine = new RunEngine({
464+
const engine = createTestEngine({
464465
prisma,
465466
worker: {
466467
redis: redisOptions,

‎internal-packages/run-engine/src/engine/tests/waitpointPublicRouter.test.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { generateFriendlyId } from "@trigger.dev/core/v3/isomorphic";
55
import { expect } from "vitest";
66
import { setTimeout } from "node:timers/promises";
77
import { RunEngine } from "../index.js";
8+
import { createTestEngine } from "./helpers/engineFactory.js";
89
import type { CrossSeamGuardHook } from "../types.js";
910
import { setupAuthenticatedEnvironment, setupBackgroundWorker } from "./setup.js";
1011

@@ -130,7 +131,7 @@ describe("RunEngine public waitpoint router", () => {
130131
prisma,
131132
readOnlyPrisma: prisma,
132133
});
133-
const engine = new RunEngine(engineOptions(redisOptions, prisma, { store }));
134+
const engine = createTestEngine(engineOptions(redisOptions, prisma, { store }));
134135

135136
try {
136137
const { waitpoint } = await engine.createManualWaitpoint({
@@ -189,7 +190,7 @@ describe("RunEngine public waitpoint router", () => {
189190
prisma,
190191
readOnlyPrisma: prisma,
191192
});
192-
const engine = new RunEngine(engineOptions(redisOptions, prisma, { store }));
193+
const engine = createTestEngine(engineOptions(redisOptions, prisma, { store }));
193194

194195
try {
195196
await setupBackgroundWorker(engine, environment, "test-task");
@@ -247,7 +248,7 @@ describe("RunEngine public waitpoint router", () => {
247248
prisma,
248249
readOnlyPrisma: prisma,
249250
});
250-
const engine = new RunEngine(engineOptions(redisOptions, prisma, { store }));
251+
const engine = createTestEngine(engineOptions(redisOptions, prisma, { store }));
251252

252253
try {
253254
await setupBackgroundWorker(engine, environment, "test-task");
@@ -281,7 +282,7 @@ describe("RunEngine public waitpoint router", () => {
281282
"delegators (create/block/getOrCreate) work through the public API",
282283
async ({ prisma, redisOptions }) => {
283284
const environment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
284-
const engine = new RunEngine(engineOptions(redisOptions, prisma));
285+
const engine = createTestEngine(engineOptions(redisOptions, prisma));
285286

286287
try {
287288
await setupBackgroundWorker(engine, environment, "test-task");
@@ -338,7 +339,7 @@ describe("RunEngine public waitpoint router", () => {
338339
const environment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
339340

340341
const seen: Array<{ waitpointId: string; routeKind: string }> = [];
341-
const engine = new RunEngine(
342+
const engine = createTestEngine(
342343
engineOptions(redisOptions, prisma, {
343344
crossSeamGuard: async ({ waitpointId, routeKind }) => {
344345
seen.push({ waitpointId, routeKind });
@@ -375,7 +376,7 @@ describe("RunEngine public waitpoint router", () => {
375376
"completeWaitpoint with a throwing guard does not apply (loud, no silent local apply)",
376377
async ({ prisma, redisOptions }) => {
377378
const environment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
378-
const engine = new RunEngine(
379+
const engine = createTestEngine(
379380
engineOptions(redisOptions, prisma, {
380381
crossSeamGuard: async () => {
381382
throw new Error("UnclassifiableRunId");
@@ -407,7 +408,7 @@ describe("RunEngine public waitpoint router", () => {
407408
async ({ prisma, redisOptions }) => {
408409
const environment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
409410
// default single PostgresRunStore (no injected store), no crossSeamGuard
410-
const engine = new RunEngine(engineOptions(redisOptions, prisma));
411+
const engine = createTestEngine(engineOptions(redisOptions, prisma));
411412

412413
try {
413414
await setupBackgroundWorker(engine, environment, "test-task");
@@ -463,7 +464,7 @@ describe("RunEngine public waitpoint router", () => {
463464
"FK-drop app-integrity: routed waitpoint round-trip is well-formed and FK-independent",
464465
async ({ prisma, redisOptions }) => {
465466
const environment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
466-
const engine = new RunEngine(engineOptions(redisOptions, prisma));
467+
const engine = createTestEngine(engineOptions(redisOptions, prisma));
467468

468469
try {
469470
await setupBackgroundWorker(engine, environment, "test-task");

‎internal-packages/run-engine/src/engine/tests/waitpointRace.test.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { containerTest } from "@internal/testcontainers";
22
import { trace } from "@internal/tracing";
33
import { expect } from "vitest";
44
import { RunEngine } from "../index.js";
5+
import { createTestEngine } from "./helpers/engineFactory.js";
56
import { setupAuthenticatedEnvironment, setupBackgroundWorker } from "./setup.js";
67
import { setTimeout } from "timers/promises";
78

@@ -12,7 +13,7 @@ describe("RunEngine Waitpoints – race condition", () => {
1213
"join-row removed before run continues (failing race)",
1314
async ({ prisma, redisOptions }) => {
1415
const env = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
15-
const engine = new RunEngine({
16+
const engine = createTestEngine({
1617
prisma,
1718
worker: { redis: redisOptions, workers: 1, tasksPerWorker: 10, pollIntervalMs: 100 },
1819
queue: {

0 commit comments

Comments
 (0)