feat(webapp): query boundary pinned end-to-end and a capped query retry - #4549
feat(webapp): query boundary pinned end-to-end and a capped query retry#4549kathiekiwi wants to merge 9 commits into
Conversation
The read-only guard was enforced by the TRQL grammar and a parser test, but nothing proved the route itself refuses a write; a route test now drives api.v1.query with a signed environment JWT and asserts nothing reaches ClickHouse. readonly=1 is no longer overridable by a caller's clickhouseSettings. run_query gives up after three consecutive failures so a broken query can't burn a whole agent turn. TRI-11165
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe webapp now rejects mutating query statements and enforces 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
🛠️ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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: 7972357f-dffb-4b70-b548-ceac54cd7305
📒 Files selected for processing (5)
.server-changes/query-boundary-and-retry-cap.mdapps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-api.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
📜 Review details
⏰ Context from checks skipped due to timeout. (14)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (11, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (12, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 12)
- GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
- GitHub Check: internal / 🧪 Unit Tests: Internal
🧰 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 dynamicimport(); use dynamic imports only for unresolvable circular dependencies, genuine performance code splitting, or conditional runtime loading.
Import Trigger.dev tasks from@trigger.dev/sdk; never use@trigger.dev/sdk/v3or deprecatedclient.defineJob.
Add agentcrumbs while writing code using approved namespaces; mark lines with//@Crumbsor blocks with `// `#region` `@crumbs, and strip them before merging.
Files:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use function declarations instead of default exports
Files:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
apps/webapp/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/webapp.mdc)
apps/webapp/**/*.{ts,tsx}: Access environment variables through theenvexport ofenv.server.tsinstead of directly accessingprocess.env
Use subpath exports from@trigger.dev/corepackage instead of importing from the root@trigger.dev/corepathDo not reintroduce the removed v1 execution path;
RunEngineVersion.V1branches may only reject or finalize gracefully so v3 clients receive a clean 4xx, never a 5xx.
Files:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.ts
apps/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
For apps, use
typecheckfor verification and never usebuildas the correctness check.
Files:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.ts
apps/webapp/app/**/*.{ts,tsx}
📄 CodeRabbit inference engine (apps/webapp/CLAUDE.md)
apps/webapp/app/**/*.{ts,tsx}: For dashboard changes, visually verify the running Remix app with Chrome DevTools MCP, using snapshots, screenshots, interaction, and console-message checks as appropriate.
UseuseCallbackanduseMemoonly for context provider values, expensive derived data used as a dependency, or stable references required by dependency arrays; do not wrap ordinary event handlers or trivial computations.
Use named constants for sentinel or placeholder values instead of scattering raw string literals across comparisons.
Files:
apps/webapp/app/services/queryService.server.ts
apps/webapp/app/**/*.ts
📄 CodeRabbit inference engine (apps/webapp/CLAUDE.md)
apps/webapp/app/**/*.ts: Never userequest.signalto detect client disconnects. UsegetRequestAbortSignal()fromapp/services/httpAsyncStorage.server.ts, which is wired to Express response close events.
Access environment variables through theenvexport fromapp/env.server.ts; never useprocess.envdirectly.
Always use PrismafindFirstinstead offindUnique.
Always use the$transactionhelper from~/db.server, never callprisma.$transactionor$replica.$transactiondirectly. Pass isolation levels as strings, useSerializablefor correctness-critical read-then-write invariants, and guard possibly undefined helper results when a definite value is required.
Files:
apps/webapp/app/services/queryService.server.ts
internal-packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
For internal packages, use
typecheckfor verification and never usebuildas the correctness check.
Files:
internal-packages/dashboard-agent/src/tool-api.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
**/*.{test,spec}.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use vitest for all tests in the Trigger.dev repository
**/*.{test,spec}.{ts,tsx}: Use Vitest exclusively and never mock dependencies; use Testcontainers for integration dependencies.
Place test files next to the source files they test.
Files:
apps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
apps/webapp/**/*.test.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/webapp.mdc)
Do not import
env.server.tsdirectly or indirectly into test files; instead pass environment-dependent values through options/parameters to make code testable
Files:
apps/webapp/test/queryRouteReadOnly.test.ts
apps/webapp/**/*.{test,spec}.{ts,tsx}
📄 CodeRabbit inference engine (apps/webapp/CLAUDE.md)
Test files must not import
app/env.server.ts; pass configuration as options instead.
Files:
apps/webapp/test/queryRouteReadOnly.test.ts
🧠 Learnings (22)
📚 Learning: 2026-05-14T14:54:39.095Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3545
File: .server-changes/agent-view-sessions.md:10-10
Timestamp: 2026-05-14T14:54:39.095Z
Learning: In the `trigger.dev` repository, do not flag inconsistent dot vs slash notation in route/path strings inside `.server-changes/*.md` files. These markdown files are consumed verbatim into the changelog, so the mixed notation (e.g., `resources.orgs.../runs.$runParam/...`) is intentional and should be preserved as-is.
Applied to files:
.server-changes/query-boundary-and-retry-cap.md
📚 Learning: 2026-07-26T13:14:02.968Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 4378
File: .server-changes/realtime-run-reads-from-primary.md:0-0
Timestamp: 2026-07-26T13:14:02.968Z
Learning: For files in the .server-changes directory, the body text is published verbatim as dashboard-facing user release notes. Write entries in terms of user-visible behavior (what users can do/see), and avoid implementation-oriented details such as environment-variable names, internal mechanisms, or configuration knobs. If you need to include operational/configuration specifics, put those details in the PR description instead of the .server-changes entry.
Applied to files:
.server-changes/query-boundary-and-retry-cap.md
📚 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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
📚 Learning: 2026-03-26T09:02:07.973Z
Learnt from: myftija
Repo: triggerdotdev/trigger.dev PR: 3274
File: apps/webapp/app/services/runsReplicationService.server.ts:922-924
Timestamp: 2026-03-26T09:02:07.973Z
Learning: When parsing Trigger.dev task run annotations in server-side services, keep `TaskRun.annotations` strictly conforming to the `RunAnnotations` schema from `trigger.dev/core/v3`. If the code already uses `RunAnnotations.safeParse` (e.g., in a `#parseAnnotations` helper), treat that as intentional/necessary for atomic, schema-accurate annotation handling. Do not recommend relaxing the annotation payload schema or using a permissive “passthrough” parse path, since the annotations are expected to be written atomically in one operation and should not contain partial/legacy payloads that would require a looser parser.
Applied to files:
apps/webapp/app/services/queryService.server.ts
📚 Learning: 2026-05-05T09:38:02.512Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3523
File: apps/webapp/app/routes/api.v3.batches.ts:178-181
Timestamp: 2026-05-05T09:38:02.512Z
Learning: When reviewing code that catches `ServiceValidationError` in `*.server.ts` files, do not blindly forward `error.status` to HTTP responses, because SVEs may be thrown with non-default statuses (e.g., 400/500) and forwarding them can cause client-visible behavioral regressions (e.g., surfacing 500s to clients). Prefer a safe default response status of `error.status ?? 422`, but only after confirming via the reachable call graph that the caught `ServiceValidationError` instances are expected to carry those non-default statuses; otherwise, normalize to `422` to avoid unexpected client-visible 5xx behavior.
Applied to files:
apps/webapp/app/services/queryService.server.ts
📚 Learning: 2026-05-12T21:04:05.815Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3542
File: apps/webapp/app/components/sessions/v1/SessionStatus.tsx:1-3
Timestamp: 2026-05-12T21:04:05.815Z
Learning: In this Remix + TypeScript codebase, do not flag a server/client boundary violation when a file imports only types from a module matching `*.server`.
Specifically, it’s safe to import types using `import type { Foo } from "*.server"` or `import { type Foo } from "*.server"` because TypeScript erases type-only imports at compile time and they emit no JavaScript, so they won’t cross the Remix server/client bundle boundary.
Only raise the boundary concern for value imports (e.g., `import { Foo }` without `type`, or `import Foo`), since those produce JavaScript output.
Applied to files:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.ts
📚 Learning: 2026-06-25T18:21:51.905Z
Learnt from: carderne
Repo: triggerdotdev/trigger.dev PR: 4039
File: apps/webapp/app/routes/invite-revoke.tsx:0-0
Timestamp: 2026-06-25T18:21:51.905Z
Learning: During the Zod v4 migration in the triggerdotdev/trigger.dev webapp, ensure any imports from `conform-to/zod` use the Zod-4 subpath: `conform-to/zod/v4` (e.g., `import { parseWithZod } from "conform-to/zod/v4"`). Do not import from the package root `conform-to/zod`, because it is the Zod 3 implementation and may load Zod-3-only symbols (e.g., `ZodBranded`, `ZodEffects`), which can throw at module load (notably with `zod4.4.3`). This should be enforced across `apps/webapp/**/*` where helpers like `parseWithZod` and `conformZodMessage` are used.
Applied to files:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.ts
📚 Learning: 2026-07-03T17:10:21.498Z
Learnt from: 0ski
Repo: triggerdotdev/trigger.dev PR: 4148
File: apps/webapp/app/models/orgMember.server.ts:149-168
Timestamp: 2026-07-03T17:10:21.498Z
Learning: In triggerdotdev/trigger.dev, `User.email` (Prisma schema: `internal-packages/database/prisma/schema.prisma`) currently does NOT use `citext` and does NOT have a `lower(email)` functional unique index. Therefore, do not introduce Prisma queries like `where: { email: { equals: <value>, mode: "insensitive" } }` (or any case-insensitive lookup) against `User.email`, because it can force sequential scans of the `users` table under load. During review, ensure email is normalized (e.g., lowercased/trimmed) before both writes and subsequent lookups, and if true case-insensitive behavior/uniqueness is required, implement it via a separate app-wide migration (e.g., switch to `citext` and/or add a functional unique index with backfill) rather than bolting it onto individual feature PRs.
Applied to files:
apps/webapp/app/services/queryService.server.tsapps/webapp/test/queryRouteReadOnly.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/app/services/queryService.server.tsinternal-packages/dashboard-agent/src/tool-api.tsapps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
📚 Learning: 2026-05-07T12:25:18.271Z
Learnt from: d-cs
Repo: triggerdotdev/trigger.dev PR: 3531
File: apps/webapp/test/sentryTraceContext.server.test.ts:9-47
Timestamp: 2026-05-07T12:25:18.271Z
Learning: In the triggerdotdev/trigger.dev webapp test suite, it is acceptable to leave `createInMemoryTracing()` calls that register a global `NodeTracerProvider` without `afterEach`/`afterAll` teardown. Do not flag this as a test-ordering risk when the code follows the established pattern used across webapp tests (e.g., replication service/benchmark/backfiller tests). This is considered safe because `trace.getActiveSpan()` when called outside a `context.with(...)` block reads `AsyncLocalStorage.getStore()` (undefined when no `run()` scope exists), so it falls back to `ROOT_CONTEXT` with no attached span—regardless of which provider is registered.
Applied to files:
apps/webapp/test/queryRouteReadOnly.test.ts
📚 Learning: 2026-05-28T20:02:10.647Z
Learnt from: myftija
Repo: triggerdotdev/trigger.dev PR: 3772
File: apps/webapp/test/findOrCreateBackgroundWorker.test.ts:1-1
Timestamp: 2026-05-28T20:02:10.647Z
Learning: In the triggerdotdev/trigger.dev monorepo, for the `apps/webapp` package use the established convention of storing Vitest tests (unit, integration, and e2e) under `apps/webapp/test/` rather than colocating them next to source files. Do not flag files located in `apps/webapp/test/` as violating any rule that says to colocate tests with source.
Applied to files:
apps/webapp/test/queryRouteReadOnly.test.ts
📚 Learning: 2026-07-30T18:43:56.874Z
Learnt from: 0ski
Repo: triggerdotdev/trigger.dev PR: 4426
File: apps/webapp/test/memberDevEnvironments.server.test.ts:124-125
Timestamp: 2026-07-30T18:43:56.874Z
Learning: In the `apps/webapp` test suite (`apps/webapp/test/**`), respect the established test harness in `apps/webapp/test/setup.ts`: it loads `.env` and provides default values for required environment variables so that transitive imports (e.g., `~/env.server`) work without production-style wiring.
During code review, do not require dependency injection/refactoring solely to avoid this existing import path. Only introduce configuration injection if it delivers production-level value (for example, a more general `createEnvironment` abstraction that improves runtime behavior beyond test setup).
Applied to files:
apps/webapp/test/queryRouteReadOnly.test.ts
📚 Learning: 2026-08-08T12:49:17.489Z
Learnt from: kathiekiwi
Repo: triggerdotdev/trigger.dev PR: 4525
File: apps/webapp/test/dashboardAgentWatchAlertOwnerScope.test.ts:101-109
Timestamp: 2026-08-08T12:49:17.489Z
Learning: In apps/webapp/test, every test suite that creates a client with createDashboardAgentDb(connectionUri, ...) must close the DashboardAgentDbClient in afterEach. Although postgresTest drops cloned databases with WITH (FORCE), it does not clean up client-side postgres-js pool sockets or idle timers, so explicitly closing the client prevents resource leaks and test interference.
Applied to files:
apps/webapp/test/queryRouteReadOnly.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:
apps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.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:
apps/webapp/test/queryRouteReadOnly.test.tsinternal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts
🔇 Additional comments (5)
apps/webapp/app/services/queryService.server.ts (1)
400-400: LGTM!.server-changes/query-boundary-and-retry-cap.md (1)
6-6: LGTM!internal-packages/dashboard-agent/src/tool-api.ts (1)
180-196: LGTM!Also applies to: 353-362
internal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts (1)
1-73: LGTM!apps/webapp/test/queryRouteReadOnly.test.ts (1)
121-121: 🎯 Functional CorrectnessNo change needed for the
queryWithStatsmock.
reader.queryWithStats(...)returns a query function, and the implementation calls that function withparamsbefore awaiting the result, so returning an async function is correct here.
| const mocks = vi.hoisted(() => ({ | ||
| runtimeEnvironmentFindFirst: vi.fn(), | ||
| queryWithStats: vi.fn(), | ||
| customerQueryCreate: vi.fn(), | ||
| })); | ||
|
|
||
| vi.mock("~/db.server", () => { | ||
| const client = { | ||
| runtimeEnvironment: { | ||
| findFirst: mocks.runtimeEnvironmentFindFirst, | ||
| findMany: async () => [], | ||
| }, | ||
| revokedApiKey: { findMany: async () => [], findFirst: async () => null }, | ||
| project: { findMany: async () => [] }, | ||
| customerQuery: { findFirst: async () => null, create: mocks.customerQueryCreate }, | ||
| }; | ||
| return { prisma: client, $replica: client }; | ||
| }); | ||
| vi.mock("~/env.server", () => ({ | ||
| env: { | ||
| SESSION_SECRET: "test-session-secret", | ||
| QUERY_CLICKHOUSE_MAX_EXECUTION_TIME: "30", | ||
| QUERY_CLICKHOUSE_MAX_MEMORY_USAGE: 1000000, | ||
| QUERY_CLICKHOUSE_MAX_AST_ELEMENTS: 50000, | ||
| QUERY_CLICKHOUSE_MAX_EXPANDED_AST_ELEMENTS: 500000, | ||
| QUERY_CLICKHOUSE_MAX_BYTES_BEFORE_EXTERNAL_GROUP_BY: 1000000, | ||
| QUERY_CLICKHOUSE_MAX_RETURNED_ROWS: 1000, | ||
| }, | ||
| })); | ||
| vi.mock("~/services/clickhouse/clickhouseFactoryInstance.server", () => ({ | ||
| clickhouseFactory: { | ||
| getClickhouseForOrganization: async () => ({ | ||
| reader: { queryWithStats: mocks.queryWithStats }, | ||
| }), | ||
| }, | ||
| })); | ||
| vi.mock("~/services/platform.v3.server", () => ({ getLimit: async () => 30 })); | ||
| vi.mock("~/services/queryConcurrencyLimiter.server", () => ({ | ||
| queryConcurrencyLimiter: { | ||
| acquire: async () => ({ success: true }), | ||
| release: async () => {}, | ||
| }, | ||
| DEFAULT_ORG_CONCURRENCY_LIMIT: 10, | ||
| GLOBAL_CONCURRENCY_LIMIT: 100, | ||
| })); | ||
| vi.mock("~/services/logger.server", () => ({ | ||
| logger: { debug: vi.fn(), error: vi.fn(), warn: vi.fn(), info: vi.fn() }, | ||
| })); | ||
| vi.mock("~/v3/services/worker/workerGroupTokenService.server", () => ({ | ||
| WorkerGroupTokenService: class {}, | ||
| })); | ||
| vi.mock("~/v3/services/common.server", () => ({ ServiceValidationError: class extends Error {} })); | ||
| vi.mock("@internal/run-engine", () => ({ EngineServiceValidationError: class extends Error {} })); |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | 🏗️ Heavy lift
Use real integration dependencies for this route-level suite.
This test replaces the Prisma and ClickHouse boundaries with mocks. It cannot detect integration failures in authentication, query dispatch, or ClickHouse settings serialization.
Use Testcontainers for the database and ClickHouse dependencies. If the intent is only grammar validation, extract that behavior into a pure unit test.
As per coding guidelines, “Use Vitest exclusively and never mock dependencies; use Testcontainers for integration dependencies.”
Source: Coding guidelines
…65' into feat/query-safety-tri-11165
@trigger.dev/build
trigger.dev
@trigger.dev/core
@trigger.dev/python
@trigger.dev/react-hooks
@trigger.dev/redis-worker
@trigger.dev/rsc
@trigger.dev/schema-to-json
@trigger.dev/sdk
commit: |
…65' into feat/query-safety-tri-11165
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| vi.mock("~/db.server", () => { | ||
| const client = { | ||
| runtimeEnvironment: { | ||
| findFirst: mocks.runtimeEnvironmentFindFirst, | ||
| findMany: async () => [], | ||
| }, | ||
| revokedApiKey: { findMany: async () => [], findFirst: async () => null }, | ||
| project: { findMany: async () => [] }, | ||
| customerQuery: { findFirst: async () => null, create: mocks.customerQueryCreate }, | ||
| }; | ||
| return { prisma: client, $replica: client }; | ||
| }); |
There was a problem hiding this comment.
🟡 New tests rely on mocks, which the repository's testing rules forbid
The new test files replace real dependencies with stand-ins (vi.mock("~/db.server", ...) at apps/webapp/test/queryRouteReadOnly.test.ts:37-48, plus mocks of the environment config, ClickHouse factory, limiter and logger, and vi.fn() fakes in internal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts:58-64), which the project's testing rules prohibit.
Impact: The checked-in tests conflict with the repository's stated testing approach, so they may need rewriting before they can be trusted as coverage.
Rule text and where it is violated
AGENTS.md states: "We use vitest exclusively. Never mock anything - use testcontainers instead." and ai/references/tests.md (referenced by .cursor/rules/writing-tests.mdc) repeats: "Do not mock anything. Do not use mocks in tests. Do not use spies in tests."
apps/webapp/test/queryRouteReadOnly.test.ts:31-83 builds a hoisted mock registry and mocks ~/db.server, ~/env.server, ~/services/clickhouse/clickhouseFactoryInstance.server, ~/services/platform.v3.server, ~/services/queryConcurrencyLimiter.server, ~/services/logger.server, and two service modules. internal-packages/dashboard-agent/src/tool-query-retry-cap.test.ts uses vi.fn() spies for postQuery.
(Note that many existing webapp tests use vi.mock too, so this is a widespread pre-existing deviation rather than something unique to this PR.)
Was this helpful? React with 👍 or 👎 to provide feedback.
| // A failed query hands the model the database error to fix, and it usually does. When it | ||
| // doesn't, the only other limit is the turn's 10 steps, so one broken query can eat the | ||
| // whole turn and leave the user with no answer at all. This tool set is built per turn, | ||
| // so the counter caps consecutive failures within one turn. | ||
| let consecutiveQueryFailures = 0; |
There was a problem hiding this comment.
🔍 Counter lifetime depends on the tools hook being invoked once per turn
The counter's per-turn scope rests on buildTurnTools being called once per turn: dashboard-agent.ts:381 wires it into the agent's tools hook, and agent-runtime.ts:388 only reads locals.get(dashboardAgentToolsKey) (set solely by tests/evals) before building a fresh set — so nothing memoizes the tool set. If the SDK ever invokes the tools hook per step rather than per turn, each run_query call would get a fresh counter and the cap would never fire; conversely if the set were cached per chat, stale failure counts would leak into later turns. Worth confirming against the chat SDK's hook contract. Note watch-actions.ts:780 builds its own independent tool set, so watch-driven queries have a separate counter.
Was this helpful? React with 👍 or 👎 to provide feedback.
| // A failed query hands the model the database error to fix, and it usually does. When it | ||
| // doesn't, the only other limit is the turn's 10 steps, so one broken query can eat the | ||
| // whole turn and leave the user with no answer at all. This tool set is built per turn, | ||
| // so the counter caps consecutive failures within one turn. | ||
| let consecutiveQueryFailures = 0; |
There was a problem hiding this comment.
🔍 Chart-query validation failures bypass the same cap
render_view validates chart queries through the same postQuery seam (internal-packages/dashboard-agent/src/tool-api.ts:407) but does not touch consecutiveQueryFailures, so a model that loops on a broken chart query can still burn the whole turn — the failure mode the cap was added to prevent, just through a different tool. Also note the counter lives on the closure, so it only caps a turn if buildApiTools really is invoked once per turn (internal-packages/dashboard-agent/src/dashboard-agent.ts:381); the eval path injects a fixed tool set via dashboardAgentToolsKey and would share one counter across turns.
Was this helpful? React with 👍 or 👎 to provide feedback.
1 participant
What & why
The agent's query tool is read-only, but that was true by three separate facts and only one of them had a test. This proves the boundary holds by contract rather than by prompt, and stops a broken query from burning a whole agent turn.
Two small guards, the rest is tests. TRI-11165.
Stack
Stacked on #4548 (watch-mode keepalive). Merge that first.
What's inside
apps/webapp/test/queryRouteReadOnly.test.ts) that drivesapi.v1.querywith a real signed environment JWT: a multi-statement write and a mutating statement are both refused before anything reaches ClickHouse, and a plain read passes so the seam stays live.readonly=1made non-overridable inqueryService.server.ts— callerclickhouseSettingswere spread after the defaults and could clear it.run_querytool (internal-packages/dashboard-agent/src/tool-api.ts): three consecutive failures returns a terminal "stop and answer with what you have".Key decisions
readonly=1, and the org/project/env scoping is injected server-side from the credential. The request body can't widen scope or turn a read into a write.Testing
queryRouteReadOnly.test.ts— write statements → 400, ClickHouse never called; a read passes.tool-query-retry-cap.test.ts— terminal at the third consecutive failure, counter resets on a success.