Skip to content

[pull] master from cube-js:master - #710

Merged
pull[bot] merged 1 commit into
code:masterfrom
cube-js:master
Sep 3, 2026
Merged

[pull] master from cube-js:master#710
pull[bot] merged 1 commit into
code:masterfrom
cube-js:master

Conversation

@pull

@pull pull Bot commented Sep 3, 2026

Copy link
Copy Markdown

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.4)

Can you help keep this open source service alive? πŸ’– Please sponsor : )

…#11735)

* feat(client-core): forward `usedPreAggregations` on `cubeSql` results

#11591 exposes `usedPreAggregations` on the SQL API's data responses so a client
can match a result to the pre-aggregation build behind it, and the SQL API does
emit it β€” `node_export.rs` inserts it into the schema line next to
`lastRefreshTime` and `external`. But `cubeSql` builds its result by whitelisting
`{ schema, data, lastRefreshTime }` off that line, so the field never reaches the
caller. Consumers that read the SQL API through this client (rather than
`/v1/load`) therefore cannot see it at all.

Forward it, on both `cubeSql` and `cubeSqlStream`, and type it on
`CubeSqlResult` / the stream's schema chunk. Absent stays absent: a query that
hit no pre-aggregation, or a deployment older than the field, omits the key
rather than reporting an empty object.

The spread that picks these fields off the schema line existed in three copies β€”
`cubeSql`, and `cubeSqlStream` for both its per-chunk and its trailing-buffer
path β€” which is exactly the shape that loses the next field to a missed call
site, silently and while still type-checking. It is now one
`pickCubeSqlResultMetadata` helper feeding all three, and the tests cover the
trailing-buffer path specifically.

* fix(client-core): forward `external` too, and tighten the metadata docs

Review follow-up. `external` is the third result-level field the SQL API writes
onto the schema line, and it was being dropped for the same reason
`usedPreAggregations` was β€” so a helper that exists to stop exactly that had left
two of three fields covered. Forwarded and typed alongside the others; the
negative test now asserts BOTH stay absent rather than becoming explicit
`undefined` keys.

Also: state the helper's invariant (cover every field the writer emits; absent
stays absent) instead of narrating the refactor, and document `targetTableName`
as a dev-mode/Playground-only extra so the record shape doesn't read as complete.

* docs(client-core): trim the metadata helper's JSDoc to its invariant

Review follow-up: the paragraph narrating why the spread was consolidated is
already in the git log and the PR description. What the comment needs to carry is
the rule a future field has to satisfy.
@pull pull Bot locked and limited conversation to collaborators Sep 3, 2026
@pull
pull Bot merged commit fca1d73 into code:master Sep 3, 2026
6 of 7 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant