-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
feat(sdk,core): offload large trigger payloads via object storage #4470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
ed41f0a
023c3fd
93aa053
8b684e1
737ad56
c97cbcc
aa90db9
f5ce2bc
8c986db
82f198f
9a3e8d0
e101f8e
d01d438
aafb736
7fa3a16
4e6461a
4b5db51
5365936
d35bf04
d95d2bc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/core": patch | ||
| --- | ||
|
|
||
| Fix: ConsoleInterceptor now delegates to original console methods to preserve log chain when other interceptors (like Sentry) are present. (#2900) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/cli-v3": patch | ||
| --- | ||
|
|
||
| Fix: Native build server failed with Docker Hub rate limits. Added support for checking checking `DOCKER_USERNAME` and `DOCKER_PASSWORD` in environment variables and logging into Docker Hub before building. (#2911) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/cli-v3": patch | ||
| --- | ||
|
|
||
| Fix: Ignore engine checks during deployment install phase to prevent failure on build server when Node version mismatch exists. (#2913) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/cli-v3": patch | ||
| --- | ||
|
|
||
| Fix: `trigger.dev dev` command left orphaned worker processes when exited via Ctrl+C (SIGINT). Added signal handlers to ensure proper cleanup of child processes and lockfiles. (#2909) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/cli-v3": patch | ||
| --- | ||
|
|
||
| Fix Sentry OOM: Allow disabling `source-map-support` via `TRIGGER_SOURCE_MAPS=false`. Also supports `node` for native source maps. (#2920) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| "@trigger.dev/core": patch | ||
| "@trigger.dev/sdk": patch | ||
| --- | ||
|
|
||
| Offload large trigger payloads to object storage before sending the trigger API request. The SDK uploads packets at or above the existing 128KB limit and sends an `application/store` pointer instead of embedding large JSON in the request body. `TriggerTaskRequestBody` now validates that `application/store` payloads are non-empty storage paths. | ||
|
|
||
| Payload uploads use the same resolved `ApiClient` as the trigger call (including `requestOptions.clientConfig`), not only the global `apiClientManager.client` — so custom `baseURL`, access token, and preview branch apply to both presign and trigger. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| area: webapp | ||
| type: fix | ||
| --- | ||
|
|
||
| Runs and sessions replication services now auto-recover from stream errors (e.g. after a Postgres failover) instead of silently leaving replication stopped. Behaviour is configurable per service — reconnect (default), exit so a process supervisor can restart the host, or log. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| import { Logger } from "@trigger.dev/core/logger"; | ||
|
|
||
| // When the LogicalReplicationClient's WAL stream errors (e.g. after a | ||
| // Postgres failover) it calls stop() on itself and stays stopped. The host | ||
| // service has to decide how to recover. Three strategies are available: | ||
| // | ||
| // - "reconnect" — re-subscribe in-process with exponential backoff. Default; | ||
| // works without a process supervisor. | ||
| // - "exit" — exit the process so an external supervisor (Docker | ||
| // restart=always, ECS, systemd, k8s, ...) replaces it. Recommended when a | ||
| // supervisor is present because it gets a clean slate every time. | ||
| // - "log" — preserve the historical no-op behaviour. Useful for | ||
| // debugging or in test environments where you want to observe the | ||
| // silent-death failure mode. | ||
| export type ReplicationErrorRecoveryStrategy = | ||
| | { | ||
| type: "reconnect"; | ||
| initialDelayMs?: number; | ||
| maxDelayMs?: number; | ||
| // 0 (or undefined) means retry forever. | ||
| maxAttempts?: number; | ||
| } | ||
| | { | ||
| type: "exit"; | ||
| exitDelayMs?: number; | ||
| exitCode?: number; | ||
| } | ||
| | { type: "log" }; | ||
|
|
||
| export type ReplicationErrorRecoveryDeps = { | ||
| strategy: ReplicationErrorRecoveryStrategy; | ||
| logger: Logger; | ||
| // Re-subscribe the underlying replication client. Implementations should | ||
| // call client.subscribe(...) and resolve once the stream is started. | ||
| reconnect: () => Promise<void>; | ||
| // True once the host service has begun graceful shutdown — recovery | ||
| // suppresses all work in that state. | ||
| isShuttingDown: () => boolean; | ||
| }; | ||
|
|
||
| export type ReplicationErrorRecovery = { | ||
| // Called from the replication client's "error" event handler. | ||
| handle(error: unknown): void; | ||
| // Called from the replication client's "start" event handler. Resets the | ||
| // reconnect attempt counter so the next failure starts from initialDelayMs. | ||
| notifyStreamStarted(): void; | ||
| // Called from the replication client's "leaderElection" event handler with | ||
| // isLeader=false. Only the reconnect strategy acts on this; exit and log | ||
| // strategies treat losing the lock as a normal multi-instance state (an | ||
| // "exit" instance would otherwise restart-loop whenever a peer holds it). | ||
| notifyLeaderElectionLost(error: unknown): void; | ||
| // Cancel any pending reconnect/exit timer. Called from shutdown(). | ||
| dispose(): void; | ||
| }; | ||
|
|
||
| export function createReplicationErrorRecovery( | ||
| deps: ReplicationErrorRecoveryDeps | ||
| ): ReplicationErrorRecovery { | ||
| const { strategy, logger, reconnect, isShuttingDown } = deps; | ||
| let attempt = 0; | ||
| let pendingReconnect: NodeJS.Timeout | null = null; | ||
| let pendingExit: NodeJS.Timeout | null = null; | ||
| let exiting = false; | ||
|
|
||
| function scheduleReconnect(error: unknown): void { | ||
| if (strategy.type !== "reconnect") return; | ||
| if (pendingReconnect) return; | ||
|
|
||
| attempt += 1; | ||
| const maxAttempts = strategy.maxAttempts ?? 0; | ||
| if (maxAttempts > 0 && attempt > maxAttempts) { | ||
| logger.error("Replication reconnect exceeded maxAttempts; giving up", { | ||
| attempt, | ||
| maxAttempts, | ||
| error, | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| const initialDelay = strategy.initialDelayMs ?? 1_000; | ||
| const maxDelay = strategy.maxDelayMs ?? 60_000; | ||
| const delay = Math.min(initialDelay * Math.pow(2, attempt - 1), maxDelay); | ||
|
|
||
| logger.error("Replication stream lost — scheduling reconnect", { | ||
| attempt, | ||
| delayMs: delay, | ||
| error, | ||
| }); | ||
|
|
||
| pendingReconnect = setTimeout(async () => { | ||
| pendingReconnect = null; | ||
| if (isShuttingDown()) return; | ||
|
|
||
| try { | ||
| await reconnect(); | ||
| // Success path is handled by notifyStreamStarted, which fires from | ||
| // the replication client's "start" event after the stream is live. | ||
| } catch (err) { | ||
| // subscribe() can throw without first emitting an "error" event — | ||
| // notably when the initial pg client.connect() fails because Postgres | ||
| // is still unreachable mid-failover. Schedule the next attempt | ||
| // ourselves so recovery doesn't silently stop. If subscribe() did | ||
| // also emit an "error" event, handle() will call scheduleReconnect() | ||
| // first; the guard on pendingReconnect makes this idempotent. | ||
| logger.error("Replication reconnect attempt failed", { | ||
| attempt, | ||
| error: err, | ||
| }); | ||
| scheduleReconnect(err); | ||
| } | ||
| }, delay); | ||
| } | ||
|
|
||
| function scheduleExit(): void { | ||
| if (strategy.type !== "exit") return; | ||
| if (exiting) return; | ||
| exiting = true; | ||
|
|
||
| const delay = strategy.exitDelayMs ?? 5_000; | ||
| const code = strategy.exitCode ?? 1; | ||
|
|
||
| logger.error("Fatal replication error — exiting to let process supervisor restart", { | ||
| exitCode: code, | ||
| exitDelayMs: delay, | ||
| }); | ||
|
|
||
| pendingExit = setTimeout(() => { | ||
| // eslint-disable-next-line no-process-exit | ||
| process.exit(code); | ||
| }, delay); | ||
| // Don't hold a clean shutdown back on this timer. | ||
| pendingExit.unref(); | ||
| } | ||
|
|
||
| return { | ||
| handle(error) { | ||
| if (isShuttingDown()) return; | ||
| switch (strategy.type) { | ||
| case "log": | ||
| return; | ||
| case "exit": | ||
| return scheduleExit(); | ||
| case "reconnect": | ||
| return scheduleReconnect(error); | ||
| } | ||
| }, | ||
| notifyStreamStarted() { | ||
| if (attempt > 0) { | ||
| logger.info("Replication reconnect succeeded", { attempt }); | ||
| attempt = 0; | ||
| } | ||
| }, | ||
| notifyLeaderElectionLost(error) { | ||
| if (isShuttingDown()) return; | ||
| // Only the reconnect strategy should react. For exit, losing the | ||
| // lock to a peer would otherwise trigger a restart loop. For log, | ||
| // we keep historical no-op semantics. | ||
| if (strategy.type !== "reconnect") return; | ||
| scheduleReconnect(error); | ||
| }, | ||
| dispose() { | ||
| if (pendingReconnect) { | ||
| clearTimeout(pendingReconnect); | ||
| pendingReconnect = null; | ||
| } | ||
| if (pendingExit) { | ||
| clearTimeout(pendingExit); | ||
| pendingExit = null; | ||
| } | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| // Shape of the env-driven configuration object the instance bootstrap files | ||
| // build from process.env. Kept separate from the strategy union above so the | ||
| // instance code can pass a single object regardless of which strategy is set. | ||
| export type ReplicationErrorRecoveryEnv = { | ||
| strategy: "reconnect" | "exit" | "log"; | ||
| reconnectInitialDelayMs?: number; | ||
| reconnectMaxDelayMs?: number; | ||
| reconnectMaxAttempts?: number; | ||
| exitDelayMs?: number; | ||
| exitCode?: number; | ||
| }; | ||
|
|
||
| export function strategyFromEnv( | ||
| env: ReplicationErrorRecoveryEnv | ||
| ): ReplicationErrorRecoveryStrategy { | ||
| switch (env.strategy) { | ||
| case "exit": | ||
| return { | ||
| type: "exit", | ||
| exitDelayMs: env.exitDelayMs, | ||
| exitCode: env.exitCode, | ||
| }; | ||
| case "log": | ||
| return { type: "log" }; | ||
| case "reconnect": | ||
| default: | ||
| return { | ||
| type: "reconnect", | ||
| initialDelayMs: env.reconnectInitialDelayMs, | ||
| maxDelayMs: env.reconnectMaxDelayMs, | ||
| maxAttempts: env.reconnectMaxAttempts, | ||
| }; | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,11 @@ import EventEmitter from "node:events"; | |
| import pLimit from "p-limit"; | ||
| import { detectBadJsonStrings } from "~/utils/detectBadJsonStrings"; | ||
| import { calculateErrorFingerprint } from "~/utils/errorFingerprinting"; | ||
| import { | ||
| createReplicationErrorRecovery, | ||
| type ReplicationErrorRecovery, | ||
| type ReplicationErrorRecoveryStrategy, | ||
| } from "./replicationErrorRecovery.server"; | ||
|
|
||
| interface TransactionEvent<T = any> { | ||
| tag: "insert" | "update" | "delete"; | ||
|
|
@@ -73,6 +78,9 @@ export type RunsReplicationServiceOptions = { | |
| insertMaxDelayMs?: number; | ||
| disablePayloadInsert?: boolean; | ||
| disableErrorFingerprinting?: boolean; | ||
| // What to do when the replication client errors (e.g. after a Postgres | ||
| // failover). Defaults to in-process reconnect with exponential backoff. | ||
| errorRecovery?: ReplicationErrorRecoveryStrategy; | ||
| }; | ||
|
|
||
| type PostgresTaskRun = TaskRun & { masterQueue: string }; | ||
|
|
@@ -119,6 +127,7 @@ export class RunsReplicationService { | |
| private _insertStrategy: "insert" | "insert_async"; | ||
| private _disablePayloadInsert: boolean; | ||
| private _disableErrorFingerprinting: boolean; | ||
| private _errorRecovery: ReplicationErrorRecovery; | ||
|
|
||
| // Metrics | ||
| private _replicationLagHistogram: Histogram; | ||
|
|
@@ -250,14 +259,25 @@ export class RunsReplicationService { | |
| } | ||
| }); | ||
|
|
||
| this._errorRecovery = createReplicationErrorRecovery({ | ||
| strategy: options.errorRecovery ?? { type: "reconnect" }, | ||
| logger: this.logger, | ||
| reconnect: async () => { | ||
| await this._replicationClient.subscribe(this._latestCommitEndLsn ?? undefined); | ||
| }, | ||
| isShuttingDown: () => this._isShuttingDown || this._isShutDownComplete, | ||
| }); | ||
|
|
||
| this._replicationClient.events.on("error", (error) => { | ||
| this.logger.error("Replication client error", { | ||
| error, | ||
| }); | ||
| this._errorRecovery.handle(error); | ||
| }); | ||
|
|
||
| this._replicationClient.events.on("start", () => { | ||
| this.logger.info("Replication client started"); | ||
| this._errorRecovery.notifyStreamStarted(); | ||
| }); | ||
|
|
||
| this._replicationClient.events.on("acknowledge", ({ lsn }) => { | ||
|
|
@@ -266,6 +286,16 @@ export class RunsReplicationService { | |
|
|
||
| this._replicationClient.events.on("leaderElection", (isLeader) => { | ||
| this.logger.info("Leader election", { isLeader }); | ||
| if (!isLeader) { | ||
| // Failed leader election doesn't throw or emit an "error" event — | ||
| // subscribe() just emits leaderElection(false), calls stop(), and | ||
| // returns. Route through a dedicated handler so only the reconnect | ||
| // strategy acts; the exit strategy must not restart-loop when | ||
| // another instance holds the lock. | ||
| this._errorRecovery.notifyLeaderElectionLost( | ||
| new Error("Failed to acquire replication leader lock") | ||
| ); | ||
| } | ||
|
Comment on lines
288
to
+298
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔍 Losing the leader lock triggers an endless reconnect loop by design — verify the log volume
Was this helpful? React with 👍 or 👎 to provide feedback. |
||
| }); | ||
|
|
||
| // Initialize retry configuration | ||
|
|
@@ -278,6 +308,7 @@ export class RunsReplicationService { | |
| if (this._isShuttingDown) return; | ||
|
|
||
| this._isShuttingDown = true; | ||
| this._errorRecovery.dispose(); | ||
|
Comment on lines
310
to
+311
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 Stopped replication service can resurrect itself through a pending reconnect timer A scheduled retry of the database replication stream is only cancelled during full shutdown ( Paths that don't dispose
Prompt for agentsWas this helpful? React with 👍 or 👎 to provide feedback. |
||
|
|
||
| this.logger.info("Initiating shutdown of runs replication service"); | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Reconnect does not restart the acknowledge interval or reset transaction state
The reconnect callback only calls
this._replicationClient.subscribe(this._latestCommitEndLsn ?? undefined), unlikestart()which also creates the acknowledge interval and starts the flush scheduler. That is fine when recovery follows a mid-life stream error (both are already running), but if the very firststart()fails at leader election, the recovery path resubscribes without those having been (re)initialised in the failure case, and any partially accumulated_currentTransactionfrom the dropped stream is not cleared before the new stream replays from the last commit LSN — worth confirming the client emits a freshbeginbefore any further events.Was this helpful? React with 👍 or 👎 to provide feedback.