feat(chat): add mailbox helpers for custom agents - #4644
Open
gtremper wants to merge 2 commits into
Open
Conversation
🦋 Changeset detectedLatest commit: 5b39fb8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 29 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
WalkthroughThe change adds durable session stream records with stable IDs, sequence numbers, and payloads. Session stream managers now support record retrieval, predicate filtering, peeking, cursor tracking, and redelivery. The chat SDK exposes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
Hi @gtremper, thanks for your interest in contributing! This project requires that pull request authors are vouched, and you are not in the list of vouched users. This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details. |
gtremper
changed the title
matt-aitken
marked this pull request as ready for review
August 17, 2026 08:38
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 6d2aa983-654c-4fc6-a128-9c35fd1ec226
📒 Files selected for processing (15)
.changeset/tidy-mailboxes-wait.mddocs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdxpackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/apiClient/runStream.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/sessionStreams/types.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/test/test-session-stream-manager.tspackages/trigger-sdk/src/v3/ai.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
Included review availability: Your plan includes up to 10 reviews per rolling hour; 8 remain after this review.
📜 Review details
⏰ Context from checks skipped due to timeout. (33)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 12)
- GitHub Check: e2e / 🧪 CLI v3 tests (warp-windows-latest-x64-8x - pnpm)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 12)
- GitHub Check: e2e / 🧪 CLI v3 tests (warp-ubuntu-latest-x64-4x - npm)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (12, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (11, 12)
- GitHub Check: e2e / 🧪 CLI v3 tests (warp-ubuntu-latest-x64-4x - pnpm)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 12)
- GitHub Check: e2e / 🧪 CLI v3 tests (warp-windows-latest-x64-8x - npm)
- GitHub Check: sdk-compat / Node.js 24.18 (warp-ubuntu-latest-x64-4x)
- GitHub Check: sdk-compat / Node.js 26.4 (warp-ubuntu-latest-x64-4x)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 12)
- GitHub Check: sdk-compat / Node.js 22.23 (warp-ubuntu-latest-x64-4x)
- GitHub Check: sdk-compat / Node.js 20.20 (warp-ubuntu-latest-x64-4x)
- GitHub Check: sdk-compat / Cloudflare Workers
- GitHub Check: sdk-compat / Deno Runtime
- GitHub Check: packages / 🧪 Unit Tests: Packages (3, 3)
- GitHub Check: packages / 🧪 Unit Tests: Packages (1, 3)
- GitHub Check: sdk-compat / Bun Runtime
- GitHub Check: packages / 🧪 Unit Tests: Packages (2, 3)
- GitHub Check: fk-cascade-guard / fk-cascade-guard
- GitHub Check: internal / 🧪 Unit Tests: Internal
- GitHub Check: runops-guard / runops-guard
- GitHub Check: typecheck / typecheck
- GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
- GitHub Check: code-quality / code-quality
- GitHub Check: check-broken-links
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/*.{ts,tsx}: Use types over interfaces for TypeScript
Avoid using enums; prefer string unions or const objects instead
**/*.{ts,tsx}: Prefer static imports over dynamic imports. Only use dynamicimport()when:
- Circular dependencies cannot be resolved otherwise
- Code splitting is genuinely needed for performance
- The module must be loaded conditionally at runtime
Zod is pinned to a single version across the entire monorepo (currently3.25.76). When adding zod to a new or existing package, use the exact same version as the rest of the repo - never a different version or a range. Mismatched zod versions cause runtime type incompatibilities (e.g., schemas from one package can't be used as body validators in another).
Do not reintroduce V1.
Add crumbs as you write code — not just when debugging.
Do not invent new namespaces — pick from this table or ask first.
Files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
{packages/core,apps/webapp}/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use zod for validation in packages/core and apps/webapp
Files:
packages/core/src/v3/apiClient/runStream.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use function declarations instead of default exports
Files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
**/*.ts
📄 CodeRabbit inference engine (.cursor/rules/otel-metrics.mdc)
**/*.ts: When creating or editing OTEL metrics (counters, histograms, gauges), ensure metric attributes have low cardinality by using only enums, booleans, bounded error codes, or bounded shard IDs
Do not use high-cardinality attributes in OTEL metrics such as UUIDs/IDs (envId, userId, runId, projectId, organizationId), unbounded integers (itemCount, batchSize, retryCount), timestamps (createdAt, startTime), or free-form strings (errorMessage, taskName, queueName)
When exporting OTEL metrics via OTLP to Prometheus, be aware that the exporter automatically adds unit suffixes to metric names (e.g., 'my_duration_ms' becomes 'my_duration_ms_milliseconds', 'my_counter' becomes 'my_counter_total'). Account for these transformations when writing Grafana dashboards or Prometheus queries
Files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
packages/core/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (packages/core/CLAUDE.md)
Never import the root package (
@trigger.dev/core). Always use subpath imports such as@trigger.dev/core/v3,@trigger.dev/core/v3/utils,@trigger.dev/core/logger, or@trigger.dev/core/schemas
Files:
packages/core/src/v3/apiClient/runStream.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
packages/**/*.{ts,tsx}: - Public packages (packages/*): Usebuild.
Always import from@trigger.dev/sdk. Never use@trigger.dev/sdk/v3or deprecatedclient.defineJob.
Files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
packages/core/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
- packages/core (
@trigger.dev/core): Shared types. Import subpaths only (never root).
Files:
packages/core/src/v3/apiClient/runStream.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
packages/trigger-sdk/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
In the Trigger.dev SDK (packages/trigger-sdk), prefer isomorphic code like fetch and ReadableStream instead of Node.js-specific code
Files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.ts
**/*.{test,spec}.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use vitest for all tests in the Trigger.dev repository
We use vitest exclusively. Never mock anything - use testcontainers instead.
Files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
packages/trigger-sdk/**/*.{js,ts,jsx,tsx}
📄 CodeRabbit inference engine (packages/trigger-sdk/CLAUDE.md)
Always import from
@trigger.dev/sdk. Never use@trigger.dev/sdk/v3(deprecated path alias)
Files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.ts
**/*.test.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
Test files go next to source files (e.g.,
MyService.ts->MyService.test.ts).
Files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
docs/**/*.mdx
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from@trigger.dev/sdkin code examples (never from@trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences:typescript,bash,json
Files:
docs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdx
🧠 Learnings (21)
📚 Learning: 2026-03-22T13:26:12.060Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3244
File: apps/webapp/app/components/code/TextEditor.tsx:81-86
Timestamp: 2026-03-22T13:26:12.060Z
Learning: In the triggerdotdev/trigger.dev codebase, do not flag `navigator.clipboard.writeText(...)` calls for `missing-await`/`unhandled-promise` issues. These clipboard writes are intentionally invoked without `await` and without `catch` handlers across the project; keep that behavior consistent when reviewing TypeScript/TSX files (e.g., usages like in `apps/webapp/app/components/code/TextEditor.tsx`).
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-03-22T19:24:14.403Z
Learnt from: matt-aitken
Repo: triggerdotdev/trigger.dev PR: 3187
File: apps/webapp/app/v3/services/alerts/deliverErrorGroupAlert.server.ts:200-204
Timestamp: 2026-03-22T19:24:14.403Z
Learning: In the triggerdotdev/trigger.dev codebase, webhook URLs are not expected to contain embedded credentials/secrets (e.g., fields like `ProjectAlertWebhookProperties` should only hold credential-free webhook endpoints). During code review, if you see logging or inclusion of raw webhook URLs in error messages, do not automatically treat it as a credential-leak/secrets-in-logs issue by default—first verify the URL does not contain embedded credentials (for example, no username/password in the URL, no obvious secret/token query params or fragments). If the URL is credential-free per this project’s conventions, allow the logging.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-05-18T08:21:27.694Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3632
File: apps/webapp/sentry.server.ts:4-21
Timestamp: 2026-05-18T08:21:27.694Z
Learning: When handling Prisma error P1001 ("Can't reach database server") in TypeScript, don’t assume a single error shape. Prisma can surface P1001 via two different error classes/fields: `PrismaClientKnownRequestError` exposes it as `err.code === "P1001"` (common during mid-query connection drops), while `PrismaClientInitializationError` exposes it as `err.errorCode === "P1001"` (common on client startup failure). Therefore, predicates should use `err.code === "P1001" || err.errorCode === "P1001"`. Do not flag `err.code === "P1001"` as “unreachable/never matches,” as it is expected in production.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-05-18T08:21:27.694Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3632
File: apps/webapp/sentry.server.ts:4-21
Timestamp: 2026-05-18T08:21:27.694Z
Learning: When handling Prisma errors for P1001 ("Can't reach database server"), do not assume it only appears under a single property name. Prisma may surface P1001 via either `PrismaClientKnownRequestError` (`err.code === "P1001"`, e.g., mid-query connection drops) or `PrismaClientInitializationError` (`err.errorCode === "P1001"`, e.g., client startup connection failure). To reliably detect the condition, check `err.code === "P1001" || err.errorCode === "P1001"`, and avoid review rules that would incorrectly flag `err.code === "P1001"` as unreachable/never-matching.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-06-13T19:53:13.759Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3937
File: packages/trigger-sdk/skills/realtime-and-frontend/SKILL.md:258-260
Timestamp: 2026-06-13T19:53:13.759Z
Learning: When reviewing code that uses `trigger.dev/react-hooks`’s `useRealtimeRun`, preserve the call signature where the first argument is the full realtime handle object (not `handle.id`). This is intentional to maintain type-safety and is consistent with the official docs; do not suggest changing the first argument from the handle object to `handle.id`.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-06-17T17:13:49.929Z
Learnt from: matt-aitken
Repo: triggerdotdev/trigger.dev PR: 3948
File: apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.bulk-actions.$bulkActionParam/route.tsx:48-62
Timestamp: 2026-06-17T17:13:49.929Z
Learning: In triggerdotdev/trigger.dev, within `dashboardLoader`/`dashboardAction` (or similar context resolver code) whenever you resolve an organization ID from an organization slug for RBAC/enterprise authorization scope, always read from the primary Prisma client (`prisma`), not `$replica`. Using `$replica` can hit replica-lag and cause the RBAC lookup/authorization to run without the correct org scope (bypassing intended role enforcement). Implement the slug→org lookup with `prisma.organization.findFirst(...)` (or equivalent primary-client query) and add an inline comment documenting why the primary client is required (replica lag could lead to unscoped RBAC checks).
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-06-23T13:04:21.413Z
Learnt from: carderne
Repo: triggerdotdev/trigger.dev PR: 4023
File: apps/webapp/app/services/upsertBranch.server.ts:14-18
Timestamp: 2026-06-23T13:04:21.413Z
Learning: In TypeScript, it’s valid to `import { type X }` and then use `typeof X` in a type-only position, e.g. `type Alias = z.infer<typeof X>`. The `type` modifier suppresses the runtime import, but the type checker still has the full exported type so `z.infer<typeof X>` can resolve correctly. In code reviews, don’t flag this as a TypeScript compile error as long as `typeof X` is used in a type context (e.g., with `z.infer`, `type` aliases, generics), not as a runtime value.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-06-04T18:16:35.386Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3836
File: apps/supervisor/src/backpressure/backpressureMonitor.ts:3-5
Timestamp: 2026-06-04T18:16:35.386Z
Learning: When reviewing TypeScript in this repo, apply the rule “prefer type aliases over interfaces” only to data/object shapes and union/intersection type modeling. If an interface is being used as a behavioral contract for collaborators to implement (e.g., method-shape interfaces that define required behavior, such as `BackpressureLogger` / `BackpressureSignalSource` in `apps/supervisor/src/backpressure/backpressureMonitor.ts`), keep it as an `interface` and do not flag it as a type-alias-vs-interface violation.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-06-09T17:58:04.699Z
Learnt from: 0ski
Repo: triggerdotdev/trigger.dev PR: 3879
File: apps/webapp/app/models/vercelIntegration.server.ts:619-630
Timestamp: 2026-06-09T17:58:04.699Z
Learning: In this codebase, outbound raw `fetch` calls should typically rely on Node/undici’s default request timeout (about ~300s) rather than adding a per-call `AbortController` + `setTimeout` wrapper inside individual functions (e.g. in files like `apps/webapp/app/models/vercelIntegration.server.ts`). During code review, do not flag the absence of a per-call timeout on a single `fetch` as an issue; if per-call timeouts are needed, they should be implemented via a codebase-wide convention (e.g., a shared fetch wrapper or documented pattern) rather than ad-hoc per-function changes.
Applied to files:
packages/core/src/v3/apiClient/runStream.tspackages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/test/mock-task-context.tspackages/core/src/v3/sessionStreams/noopManager.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/index.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/core/src/v3/sessionStreams/types.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.tspackages/core/src/v3/sessionStreams/manager.tspackages/core/src/v3/test/test-session-stream-manager.ts
📚 Learning: 2026-05-18T14:40:02.173Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3658
File: packages/core/src/v3/realtimeStreams/manager.test.ts:1-147
Timestamp: 2026-05-18T14:40:02.173Z
Learning: In this repo’s trigger.dev codebase, the “never mock — use testcontainers” guideline should only be applied to integration tests that talk to real external services (e.g., Redis, Postgres, S2). For unit tests that validate in-memory logic (e.g., deduplication/cache behavior in StandardRealtimeStreamsManager and similar module-boundary call counting), it is allowed to use Vitest mocks like `vi.fn()` and to stub/mock `ApiClient` objects to count calls or simulate in-process collaborators. Do not flag `vi.fn()`-based mocks as policy violations in these unit-test scenarios; reserve the rule for true external-service integration tests.
Applied to files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
📚 Learning: 2026-05-18T14:40:02.173Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3658
File: packages/core/src/v3/realtimeStreams/manager.test.ts:1-147
Timestamp: 2026-05-18T14:40:02.173Z
Learning: In the triggerdotdev/trigger.dev repo, the policy “Never mock anything — use testcontainers instead” should only be enforced for integration tests that interact with real external services (e.g., Redis, Postgres) via actual infrastructure. For unit tests that exercise pure in-memory logic (e.g., cache semantics) it is OK to stub collaborators such as `ApiClient` using Vitest (`vi.fn()`) to assert call counts or control behavior. Do not flag `vi.fn()`-based `ApiClient` stubs in unit tests as violations of the testcontainers policy.
Applied to files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
📚 Learning: 2026-05-19T22:37:47.286Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3671
File: packages/trigger-sdk/test/recovery-boot.test.ts:456-457
Timestamp: 2026-05-19T22:37:47.286Z
Learning: In `packages/trigger-sdk` (Trigger.dev SDK), `logger.warn` (and other SDK logger methods) should route to the Trigger.dev structured logger sink, not to `console.warn`. In SDK tests, `vi.spyOn(console, "warn")` (or similar console spies) should only be used to suppress stray console output; reviewers should not suggest asserting on `console.warn` spies to verify SDK-internal warning/fallback log behavior. Use the SDK’s structured-logger outputs/capture approach instead of console spies.
Applied to files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/trigger-sdk/test/mockChatAgent.test.tspackages/trigger-sdk/src/v3/ai.ts
📚 Learning: 2026-06-16T09:19:47.637Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3960
File: apps/webapp/test/prismaInfrastructureErrorCapture.test.ts:0-0
Timestamp: 2026-06-16T09:19:47.637Z
Learning: In this repo’s Vitest setup, `vitest.config.ts` uses `globals: true`, so identifiers like `vi`, `describe`, `it`, and `expect` are available as globals in Vitest test files. During code review, do not flag missing `vi`/`describe`/`it`/`expect` imports as a runtime error or correctness issue when they’re used in `*.test.ts/tsx` or `*.spec.ts/tsx` files. Explicit imports are still preferred for consistency, but they’re not required for runtime behavior.
Applied to files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/core/src/v3/apiClient/runStream.test.tspackages/core/src/v3/sessionStreams/manager.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
📚 Learning: 2026-08-16T18:36:58.179Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 4537
File: packages/trigger-sdk/test/normalizeKeyString.test.ts:1-2
Timestamp: 2026-08-16T18:36:58.179Z
Learning: For related SDK `chat.agent` tests in the Trigger.dev repository—including chat channels, handover, snapshot, and transport-event coverage—keep new test files under `packages/trigger-sdk/test/` rather than colocating them with the `packages/trigger-sdk/src/v3/` source files.
Applied to files:
packages/trigger-sdk/test/chat-messages-mailbox.test.tspackages/trigger-sdk/test/mockChatAgent.test.ts
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.
Applied to files:
docs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdx
📚 Learning: 2026-04-30T20:30:29.458Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.
Applied to files:
docs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdx
📚 Learning: 2026-06-16T13:14:09.440Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3964
File: docs/ai-chat/reference.mdx:482-482
Timestamp: 2026-06-16T13:14:09.440Z
Learning: When documenting or reviewing usage of `ChatTurn.complete(source?)` (in `packages/trigger-sdk/src/v3/ai.ts`), note that `source` is optional (`source?: UIMessageStreamable`). Calling `complete()` with no `source` is valid specifically for a final head-start handover (`handover.isFinal`), because the warm partial already contains the response. If examples or guidance omit `source`, ensure they are in this final-hand-over context so they remain correct.
Applied to files:
docs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdx
📚 Learning: 2026-06-16T13:14:14.382Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3964
File: docs/ai-chat/reference.mdx:478-478
Timestamp: 2026-06-16T13:14:14.382Z
Learning: When reviewing RC-gated `ai-chat` docs under `docs/ai-chat/`, don’t immediately flag missing SDK type fields or implementation details just because the field isn’t present on the docs branch yet. Instead, find and cross-check the companion implementation PR that’s intended to land alongside the docs PR, and only report missing/incorrect fields if they are also absent in the companion SDK/type changes.
Applied to files:
docs/ai-chat/custom-agents.mdxdocs/ai-chat/reference.mdx
📚 Learning: 2026-03-31T21:37:27.212Z
Learnt from: isshaddad
Repo: triggerdotdev/trigger.dev PR: 3283
File: docs/migration-n8n.mdx:19-21
Timestamp: 2026-03-31T21:37:27.212Z
Learning: When reviewing code in `packages/trigger-sdk/src/v3`, treat `tasks.triggerAndWait()` and `tasks.batchTriggerAndWait()` as real exported APIs. They are defined in `shared.ts` and re-exported via the `tasks` object in `tasks.ts`, and they take the task ID string as their first argument (not a task instance). This is distinct from the instance methods `yourTask.triggerAndWait()` and `yourTask.batchTriggerAndWait()`. Do not flag calls to `tasks.triggerAndWait()` or `tasks.batchTriggerAndWait()` as non-existent or incorrectly invoked.
Applied to files:
packages/trigger-sdk/src/v3/ai.ts
📚 Learning: 2026-05-17T08:08:12.370Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3644
File: packages/trigger-sdk/src/v3/ai.ts:8695-8746
Timestamp: 2026-05-17T08:08:12.370Z
Learning: In the Trigger v3 session resume/streams logic, ensure session resumption uses sequence cursors rather than timestamps. Specifically: for each turn-complete control record written to `session.out`, include a `session-in-event-id` header whose value is the committed-consume cursor (`session.in.lastDispatchedSeqNum`). On boot/resume, scan `session.out` for the latest turn-complete record, read the `session-in-event-id` header, and seed the `sessionStreams` manager for `.in` using both `lastSeqNum` and `lastDispatchedSeqNum` so previously processed user messages are not replayed. Do not use `setMinTimestamp`/`lastOutTimestamp` for resume ordering in this flow.
Applied to files:
packages/trigger-sdk/src/v3/ai.ts
📚 Learning: 2026-05-18T14:19:56.437Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3655
File: packages/trigger-sdk/src/v3/ai.ts:8667-8731
Timestamp: 2026-05-18T14:19:56.437Z
Learning: In the Trigger SDK (v3) when making raw `fetch` calls to the Trigger API (including override paths such as `createChatStartSessionAction`), set the request headers to match `ApiClient`: `Content-Type`, `Authorization`, and `x-trigger-source: "sdk"`. Also forward the current preview branch by setting `x-trigger-branch` to `apiClientManager.branchName`. Prefer using the shared `overrideRequestHeaders(accessToken)` helper instead of manually constructing headers, so requests route correctly to preview environments.
Applied to files:
packages/trigger-sdk/src/v3/ai.ts
🪛 LanguageTool
docs/ai-chat/custom-agents.mdx
[style] ~252-~252: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...is Session's .in channel. - payload is the existing ChatTaskWirePayload deli...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (15)
packages/core/src/v3/test/mock-task-context.ts (1)
116-121: LGTM!Also applies to: 285-287
packages/core/src/v3/test/test-session-stream-manager.ts (1)
64-83: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winConsume the first predicate-compatible buffered record.
If the buffer contains a non-message record followed by a message record,
onceRecordWhere(...isChatMessageRecord)checks only the first record. It then queues a waiter.#drainOnceWaitersFromBuffer()also stops at that first nonmatching record. The message waiter can time out even though a matching message is already buffered.Search the buffer for the first record that matches the predicate. Remove only that record. Keep nonmatching records in their original order. Apply the same selection logic while draining pending waiters.
Proposed fix
- const next = buffered[0]!; - if (!predicate || predicate(next)) { - buffered.shift(); + const index = predicate ? buffered.findIndex(predicate) : 0; + if (index !== -1) { + const [next] = buffered.splice(index, 1); if (buffered.length === 0) this.buffer.delete(key); - this.#advanceLastDispatched(key, next.seqNum); + this.#advanceLastDispatched(key, next!.seqNum); this.#drainOnceWaitersFromBuffer(key); - resolve({ ok: true, output: next }); + resolve({ ok: true, output: next! }); return; }The supplied mailbox contract requires filtered consumption while retaining nonmatching records.
Also applies to: 142-150, 351-389
⛔ Skipped due to learnings
Learnt from: ericallam Repo: triggerdotdev/trigger.dev PR: 3417 File: apps/webapp/app/services/sessionsRepository/clickhouseSessionsRepository.server.ts:27-40 Timestamp: 2026-04-20T15:08:59.789Z Learning: In `apps/webapp/app/services/sessionsRepository/clickhouseSessionsRepository.server.ts`, the cursor predicate in `listSessionIds` compares only `session_id` while the `ORDER BY` clause uses `(created_at, session_id)`. This is intentional and consistent with the same pattern in `ClickHouseRunsRepository` and the waitpoints repository. Do not flag this as a skip/duplicate pagination bug in isolation — any fix must land across all three repositories at once as a shared follow-up.Learnt from: matt-aitken Repo: triggerdotdev/trigger.dev PR: 4540 File: packages/redis-worker/src/fair-queue/index.ts:1254-1257 Timestamp: 2026-08-08T20:52:01.055Z Learning: In `packages/redis-worker/src/fair-queue/index.ts`, `FairQueue.completeMessage()` and `FairQueue.releaseMessage()` must build the `QueueDescriptor` by preferring `queueDescriptorCache`, then using the in-flight `StoredMessage` tenant ID and metadata. `ConcurrencyManager.release()` derives group IDs from descriptor metadata, so an empty metadata object can release against the incorrect default group for metadata-derived concurrency groups. In split producer/consumer deployments, a cold `queueDescriptorCache` and a missing in-flight record make that metadata unrecoverable; the release becomes a no-op, and full recovery requires reconciliation or per-member expiry.Learnt from: d-cs Repo: triggerdotdev/trigger.dev PR: 4285 File: internal-packages/run-engine/src/engine/tests/runAttemptSystemReplicaLag.guard.test.ts:30-92 Timestamp: 2026-07-18T18:31:43.376Z Learning: In `internal-packages/run-engine/src/engine/tests/runAttemptSystemReplicaLag.guard.test.ts`, retain the bespoke `laggingReadReplica` proxy for the retry-decision and usage read-modify-write tests. It must fabricate distinct stale `taskRun.findFirst` scalar snapshots only for their exact `select` shapes while all other reads remain live; the shared `laggingReplica` primitive cannot express projection-specific lag. Use the shared primitive separately for whole-row missing replica behavior.Learnt from: ericallam Repo: triggerdotdev/trigger.dev PR: 4234 File: apps/webapp/app/routes/realtime.v1.sessions.$session.$io.append.ts:159-164 Timestamp: 2026-07-11T08:52:32.250Z Learning: In `apps/webapp/app/routes/realtime.v1.sessions.$session.$io.append.ts`, when the idempotency claim via `claimSessionStreamPart()` is lost (i.e., `wonClaim` is false, indicating a duplicate/retried append with the same client-supplied part id), the response omits `seq`, so the SDK's `appendInputChunk()` falls back to the legacy no-baseline behavior for turn-complete correlation in `packages/trigger-sdk/src/v3/chat.ts`. This is accepted as a known, narrow limitation (not a regression) rather than being fixed immediately: `claimSessionStreamPart()` currently only returns a boolean and cannot recover the already-committed seq. The tracked follow-up fix is to have the winner record the committed seq in the dedupe key so the loser can read it back on a lost claim.Learnt from: d-cs Repo: triggerdotdev/trigger.dev PR: 4285 File: internal-packages/run-store/src/runOpsStore.presentersWaitpointReadView.replicaLag.test.ts:24-65 Timestamp: 2026-07-18T18:31:37.633Z Learning: In `triggerdotdev/trigger.dev`’s `internal-packages/run-store/src/runOpsStore.presentersWaitpointReadView.replicaLag.test.ts`, retain the local real-Testcontainers Prisma proxy rather than requiring the shared `laggingReplica` helper: the test must simulate lag for `waitpointTag` reads and for `findWaitpointConnectedRunIds`, which uses `$queryRaw`. The shared primitive intercepts configured Prisma models but not raw queries, so replacing the proxy would allow the live raw join to observe primary data and invalidate the replica-lag guard. The related taskRun-only tests (`runOpsStore.realtimeServicesReadView.replicaLag.test.ts`, `runOpsStore.replayReadAfterWrite.replicaLag.test.ts`, and `runOpsStore.resolveRunForMutationReplicaLag.test.ts`) can use the shared primitive with `{ model: "taskRun", mode: "missing" }`.Learnt from: d-cs Repo: triggerdotdev/trigger.dev PR: 4285 File: internal-packages/run-store/src/runOpsStore.sessionRunProbeReadAfterWrite.test.ts:154-182 Timestamp: 2026-07-18T18:17:26.381Z Learning: For session-run replica-lag coverage, `internal-packages/run-store/src/runOpsStore.sessionRunProbeReadAfterWrite.test.ts` intentionally characterizes only the `RoutingRunStore.findRun` store seam: an owning-replica miss followed by a writer read recovers the live run. The behavioral no-double-trigger contract belongs in `apps/webapp/test/realtimeServices.replicaLag.test.ts`, which invokes the real exported `ensureRunForSession` and asserts reuse (`triggered: false`) with zero `TriggerTaskService` calls.Learnt from: d-cs Repo: triggerdotdev/trigger.dev PR: 3756 File: apps/webapp/app/v3/services/resetIdempotencyKey.server.ts:65-94 Timestamp: 2026-06-01T15:01:35.175Z Learning: In `apps/webapp/app/v3/services/resetIdempotencyKey.server.ts` (triggerdotdev/trigger.dev), a transient `buffer.resetIdempotency()` failure when `pgCount > 0` does NOT warrant a 503 and should return success. The mollifier `ack` and `fail` Lua scripts always DEL the idempotency lookup key as part of the run's natural lifecycle (drain→ack or terminal→fail or cancel-bifurcation), so stale buffered idempotency lookups converge automatically without caller retries. Only when `pgCount === 0 && bufferResetFailed` is a 503 appropriate, because then the run's existence is genuinely unobservable (the buffer outage hides a potentially matching buffered run). The test "returns success when PG cleared >=1 run, even if the buffer reset throws" documents this contract explicitly.packages/core/src/v3/sessionStreams/types.ts (1)
15-29: LGTM!Also applies to: 60-90
packages/core/src/v3/apiClient/runStream.ts (1)
172-176: LGTM!Also applies to: 505-514
packages/core/src/v3/apiClient/runStream.test.ts (1)
494-498: LGTM!Also applies to: 552-552
packages/core/src/v3/sessionStreams/index.ts (1)
3-9: LGTM!Also applies to: 52-99
packages/core/src/v3/sessionStreams/manager.ts (1)
6-11: LGTM!Also applies to: 21-23, 53-53, 120-158, 160-206, 249-262, 286-286, 306-311, 487-594
packages/core/src/v3/sessionStreams/manager.test.ts (1)
13-14: LGTM!Also applies to: 163-284
packages/core/src/v3/sessionStreams/noopManager.ts (1)
3-8: LGTM!Also applies to: 29-64
packages/trigger-sdk/src/v3/ai.ts (1)
1546-1570: LGTM!Also applies to: 1634-1664
packages/trigger-sdk/test/chat-messages-mailbox.test.ts (1)
1-242: LGTM!packages/trigger-sdk/test/mockChatAgent.test.ts (1)
1881-1884: LGTM!docs/ai-chat/custom-agents.mdx (1)
216-263: LGTM!docs/ai-chat/reference.mdx (1)
509-509: LGTM!.changeset/tidy-mailboxes-wait.md (1)
1-6: LGTM!
Comment on lines
+207
to
+213
| if (predicate && options?.timeoutMs === 0) { | ||
| resolve({ | ||
| ok: false, | ||
| error: new InputStreamTimeoutError(key, 0), | ||
| }); | ||
| return; | ||
| } |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Handle zero timeout for onceRecord().
When onceRecord() has no predicate and the buffer is empty, timeoutMs: 0 bypasses this branch. Line 230 also skips the timer because zero is falsy. The promise then remains pending. Resolve an immediate timeout for any zero timeout after checking the buffer.
Proposed fix
- if (predicate && options?.timeoutMs === 0) {
+ if (options?.timeoutMs === 0) {Add a test for manager.onceRecord(sessionId, io, { timeoutMs: 0 }).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| if (predicate && options?.timeoutMs === 0) { | |
| resolve({ | |
| ok: false, | |
| error: new InputStreamTimeoutError(key, 0), | |
| }); | |
| return; | |
| } | |
| if (options?.timeoutMs === 0) { | |
| resolve({ | |
| ok: false, | |
| error: new InputStreamTimeoutError(key, 0), | |
| }); | |
| return; | |
| } |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Comment on lines
+1634
to
+1637
| async hasPending() { | ||
| const session = getChatSession(); | ||
| return sessionStreams.peekRecordWhere(session.id, "in", isChatMessageRecord) !== undefined; | ||
| }, |
Contributor
There was a problem hiding this comment.
🟡 Pending-input check can report a waiting message that the take-one call never hands back
The pending-input check reports a waiting message anywhere in the buffered queue (peekRecordWhere at packages/trigger-sdk/src/v3/ai.ts:1636) while the take-one call only ever returns the very first buffered item, so a loop can be told input is waiting yet never receive it.
Impact: A custom agent that polls for pending input and then takes one message can spin forever, or stop responding to the user entirely, when an unrelated record sits ahead of the message.
Head-of-line blocking between hasPending() and next()
hasPending() calls sessionStreams.peekRecordWhere(...), which does buffer.find(predicate) (packages/core/src/v3/sessionStreams/manager.ts:262) — it matches a message record at any position in the buffer.
next() calls onceRecordWhere, whose buffered fast-path only inspects buffered[0] (packages/core/src/v3/sessionStreams/manager.ts:190-201). If the head is a non-message record (a stop chunk when the loop never called chat.createStopSignal(), or a handover when nothing consumes it), the predicate fails and the call falls through to a waiter that is only ever satisfied by #drainOnceWaitersFromBuffer after the head is consumed by someone else.
Consequences:
while (await chat.messages.hasPending()) { await chat.messages.next({ timeoutInSeconds: 0 }) }busy-loops:hasPending()staystrue,next()keeps returningundefined.await chat.messages.next()with no timeout never resolves, and because nothing else in a hand-rolledchat.customAgentloop consumes the blocking head record, every later user message stays stuck behind it.
The caller also has no way to distinguish "nothing pending" from "blocked behind a record I do not own", since both surface as undefined.
Prompt for agents
chat.messages.hasPending() (packages/trigger-sdk/src/v3/ai.ts) scans the whole buffered queue via sessionStreams.peekRecordWhere (buffer.find in StandardSessionStreamManager.peekRecordWhere), but chat.messages.next() only consumes the buffer head via onceRecordWhere (StandardSessionStreamManager.#onceRecord only tests buffered[0] against the predicate). When a non-message record (e.g. a stop chunk in a loop that never called chat.createStopSignal, or an unconsumed handover) sits at the head, hasPending() keeps returning true while next() returns undefined on timeout or never resolves without one — producing a busy-loop or a permanently wedged mailbox with no way for the caller to tell 'empty' from 'blocked'. Consider aligning the two: either make hasPending() head-scoped so it agrees with what next() can actually deliver, or give next() a way to signal 'blocked by a foreign record' (distinct return/state) so loops can drain or skip the blocking record instead of spinning.
Was this helpful? React with 👍 or 👎 to provide feedback.
Comment on lines
541
to
545
| // so a subsequent `once()` can still pick them up. | ||
| const consumed = this.#invokeHandlers(key, data); | ||
| const consumed = this.#invokeHandlers(key, record.data); | ||
| if (consumed) { | ||
| if (seqNum !== undefined) { | ||
| this.#advanceLastDispatched(key, seqNum); | ||
| } | ||
| this.#advanceLastDispatched(key, record.seqNum); | ||
| return; |
Contributor
There was a problem hiding this comment.
🔍 Committed input cursor can still leapfrog an unconsumed buffered message
The new docs claim "Each next() call commits only the record it returns, so a loop that owns its own turn sequencing never advances past input it has not taken" (docs/ai-chat/custom-agents.mdx:254-258). That guarantee only holds for the next() path itself. #advanceLastDispatched is a monotonic max, and the handler-consumption branch in #dispatch advances it for any later record a persistent handler consumes, even while earlier records sit unconsumed in the buffer (this branch also runs when existingBuffer is non-empty, so no waiter is offered first).
Concrete sequence with the new mailbox API: a message lands at seq 50 and stays buffered because the loop only called hasPending(); the user then presses stop, the stop record at seq 51 is consumed by the chat.createStopSignal() handler, and lastDispatchedSeqNum jumps to 51. chat.writeTurnComplete() persists that value as session-in-event-id, so a crash/upgrade boot resumes .in after 51 and the buffered message at 50 (which lives only in process memory) is silently lost.
The mechanism is pre-existing (the old code did the same #advanceLastDispatched(key, seqNum) on handler consumption), but the new API makes deliberately leaving records buffered a first-class pattern, so it is now much easier to hit. Worth confirming whether the cursor should instead be clamped to the lowest unconsumed buffered seq.
Was this helpful? React with 👍 or 👎 to provide feedback.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds two helpers for raw
chat.customAgent()loops:chat.messages.hasPending()checks for unread messages without consuming them.chat.messages.next()consumes one message at a time, with an optional timeout.This lets custom agents process input one message at a time without advancing past messages they have not handled.
Records returned by
next()also expose stableidandseqNumfields, which can be used to identify redeliveries.Existing behavior for
peek(),on(), andwaitWithIdleTimeout()is unchanged.next()returnsundefinedwhen it times out.Testing
pnpm run build --filter @trigger.dev/core --filter @trigger.dev/sdkpnpm --filter @trigger.dev/core exec vitest run src/v3/sessionStreams/manager.test.ts src/v3/apiClient/runStream.test.tspnpm --filter @trigger.dev/sdk exec vitest runpnpm run lintpnpm run formatChangelog
Custom agents can now check for pending chat messages and consume them one at a time.
Checklist