fix(tsql): make JSON functions work on the output and error columns#4221
Merged
matt-aitken merged 2 commits intoJul 10, 2026
Conversation
JSONExtract*, JSONHas, JSONLength, and JSONType expect a String containing JSON, but the compiler printed them against native JSON columns (like a run's output), which ClickHouse rejects with "illegal type: JSON". Print the column's String companion (its textColumn) for the first argument of these functions when it is a bare JSON field, mirroring the existing SELECT and WHERE behavior.
|
Contributor
WalkthroughUpdates ClickHouse SQL printing so JSON functions use a JSON column’s configured text companion, including qualified references and passthrough wrappers while preserving string literals and stringified JSON. Adds printer tests for these cases. Extends ClickHouse fixtures with a native 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
internal-packages/clickhouse/src/tsqlFunctions.test.ts (1)
582-597: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winConsider asserting return values for the JSON function cases.
assertQueryExecutesonly verifies the query runs without error. SincedataPrefix: "data"unwraps the JSON payload, a routing or prefix bug could produce a query that executes successfully but returns wrong or null values. The fixture already has known values (count: 42,label: "ok",ratio: 1.5,enabled: true), so adding a few key assertions would catch that class of defect.♻️ Example: separate value-assertion block for key JSON functions
+ // Verify JSON functions return correct values from the text companion, + // not just that they execute without error. + const [valError, valRows] = await executeTSQL(client, { + name: "func-test-values", + query: + "SELECT JSONExtractInt(output, 'count') AS count, " + + "JSONExtractString(output, 'label') AS label, " + + "JSONExtractFloat(output, 'ratio') AS ratio, " + + "JSONExtractBool(output, 'enabled') AS enabled " + + "FROM task_runs", + schema: z.object({ + count: z.number(), + label: z.string(), + ratio: z.number(), + enabled: z.number(), + }), + enforcedWhereClause, + tableSchema: [taskRunsSchema], + }); + + expect(valError).toBeNull(); + expect(valRows![0].count).toBe(42); + expect(valRows![0].label).toBe("ok"); + expect(valRows![0].ratio).toBe(1.5); + expect(valRows![0].enabled).toBe(1);
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 990a9d1e-5248-498a-b5a4-e72f9c15baf3
📒 Files selected for processing (4)
.server-changes/trql-json-extract-on-output.mdinternal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.test.tsinternal-packages/tsql/src/query/printer.ts
📜 Review details
⏰ Context from checks skipped due to timeout. (24)
- GitHub Check: internal / 🧪 Unit Tests: Internal (10, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (11, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (7, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (3, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (12, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (5, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (2, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (1, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (9, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (8, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 10)
- GitHub Check: internal / 🧪 Unit Tests: Internal (4, 12)
- GitHub Check: internal / 🧪 Unit Tests: Internal (6, 12)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 10)
- GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 10)
- GitHub Check: typecheck / typecheck
- GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
🧰 Additional context used
📓 Path-based instructions (6)
{.changeset/**/*.md,.server-changes/**/*.md}
📄 CodeRabbit inference engine (AGENTS.md)
In changesets and
.server-changes/notes, write the description for users rather than maintainers, leading with what changed for the user in one plain sentence and avoiding internal tool or infrastructure names.
Files:
.server-changes/trql-json-extract-on-output.md
**/*.{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
Files:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.test.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use function declarations instead of default exports
**/*.{ts,tsx,js,jsx}: Prefer static imports over dynamicimport(); only use dynamic imports when resolving circular dependencies, enabling real code splitting, or conditionally loading a module at runtime.
Always import from@trigger.dev/sdk; never use@trigger.dev/sdk/v3or the deprecatedclient.defineJob.
Files:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.test.ts
**/*.{test,spec}.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use vitest for all tests in the Trigger.dev repository
Files:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.test.ts
**/*.test.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (AGENTS.md)
Place test files next to their source files, e.g.
MyService.ts->MyService.test.ts.
Files:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.test.ts
🧠 Learnings (13)
📚 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/trql-json-extract-on-output.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.tsinternal-packages/tsql/src/query/printer.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:
internal-packages/clickhouse/src/tsqlFunctions.test.tsinternal-packages/tsql/src/query/printer.test.ts
📚 Learning: 2026-07-03T09:41:46.517Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 4131
File: internal-packages/metrics-pipeline/src/types.ts:0-0
Timestamp: 2026-07-03T09:41:46.517Z
Learning: When generating ClickHouse `UInt64`-backed ordering keys from epoch-derived values (e.g., `ms` and `seq`), avoid JS `number` arithmetic that can exceed the safe-integer range (2^53). Compute the key using `BigInt` (e.g., `BigInt(ms) * 100000n + BigInt(seq)`) and return it as a `string` (via `.toString()`) to preserve exact ordering. Ensure the corresponding Zod schema for the raw input (e.g., `QueueMetricsRawV1Input.order_key`) accepts/preserves this exact value (typically via `z.union([z.string(), z.number()]).optional()`), so callers can assign the computed value directly into the ClickHouse `UInt64` column without precision loss or misordering.
Applied to files:
internal-packages/clickhouse/src/tsqlFunctions.test.ts
🪛 ast-grep (0.44.1)
internal-packages/tsql/src/query/printer.test.ts
[warning] 858-858: Regular expression constructed from variable input detected. This can lead to Regular Expression Denial of Service (ReDoS) attacks if the variable contains malicious patterns. Use libraries like 'recheck' to validate regex safety or use static patterns.
Context: new RegExp(${fn}\\(output,)
Note: [CWE-1333] Inefficient Regular Expression Complexity
(regexp-from-variable)
🔇 Additional comments (10)
internal-packages/tsql/src/query/printer.ts (4)
1982-1985: LGTM!
2514-2531: LGTM!
2984-3004: LGTM!
3022-3028: LGTM!internal-packages/tsql/src/query/printer.test.ts (4)
826-833: LGTM!
835-862: LGTM!
864-871: LGTM!
873-882: LGTM!internal-packages/clickhouse/src/tsqlFunctions.test.ts (1)
31-37: LGTM!Also applies to: 75-75
.server-changes/trql-json-extract-on-output.md (1)
1-7: LGTM!
…ative JSON columns A JSON function whose JSON argument is wrapped in a value-preserving passthrough (e.g. JSONExtractArrayRaw(assumeNotNull(output), 'x')) still printed against the native JSON column and failed with "illegal type: JSON". Descend through those wrappers so the text-column swap applies inside them, while leaving value-changing wrappers like toJSONString on the native column.
|
Preview Deployment
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
ericallam
changed the title
d-cs
approved these changes
Jul 10, 2026
matt-aitken
approved these changes
Jul 10, 2026
matt-aitken
deleted the
feature/tri-11931-fixtsql-jsonextract-on-the-native-json-output-column-fails
branch
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
3 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
A Query page (TRQL) query that pulls fields out of a run's
outputwith JSON functions (JSONExtractString,JSONExtractInt,JSONHas, and the rest of the family) failed with "The first argument of function ... should be a string containing JSON, illegal type: JSON". Those queries now work.Root cause and fix
outputis a native ClickHouseJSONcolumn, butJSONExtract*,JSONHas,JSONLength, andJSONTypeall expect a String containing JSON text. The compiler already swaps in the column's String companion (output_text) when a JSON column is selected or compared, but not inside function-call arguments, so it emittedJSONExtractInt(output, 'x')against the native column.The fix prints the companion column for the first argument of these functions when it resolves to a bare JSON field, keeping the table alias when qualified (so it works in JOINs):
It also reaches through value-preserving passthrough wrappers like
assumeNotNull(...), while leaving value-changing wrappers liketoJSONString(output)on the native column (that argument is already a String). The swap is also semantically correct, not just a type fix:output_textis the unwrapped data JSON that the TRQLoutputmodel already represents, so field paths line up.Covered by printer unit tests and a ClickHouse integration test that runs the whole family (plus the wrapped and
toJSONStringcases) against a real native-JSON column. Both new cases fail with the exact "illegal type: JSON" error without the fix.