[coverage] Conformance findings: TELEMETRY-001,TELEMETRY-002,TELEMETRY-005

Open
#508 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active

Research direction

Start with the TelemetryEvent and emitStatementComplete references in the issue, then inspect the driver code and the listed xfail tests in the coverage PR. Reproduce the TELEMETRY-001, TELEMETRY-002, and TELEMETRY-005 cases for both thrift and sea. Done means terminal events report delivery format and compression, while error telemetry uses a sanitized category without SQL-derived text.

Written by the indexing model from the issue text.

Description

Summary

Surfaced by the multi-language coverage fan-out while conformance-testing these SPEC-IDs against databricks/databricks-sql-nodejs. Each finding is committed as an expected-failure (xfail) test in the coverage PR — the test asserts the CORRECT (post-fix) behavior and stays red until THIS driver (databricks/databricks-sql-nodejs) is fixed, then flips green as a tripwire.

Findings

  • TELEMETRY-001 [thrift, sea]: the terminal statement.complete telemetry event never populates resultFormat or compressed, so the inline-Arrow delivery shape and uncompressed payload are never reported
    • failing test: TELEMETRY-001 — successful sync execute emits exactly one terminal event with operation metadata [thrift], TELEMETRY-001 — successful sync execute emits exactly one terminal event with operation metadata [sea] (see the coverage PR diff under tests/)
  • TELEMETRY-002 [thrift, sea]: statement error telemetry copies the raw server error message and JS stack verbatim, leaking SQL-derived identifiers (sensitive_table) out of the customer process instead of a sanitized error category
    • failing test: TELEMETRY-002 — failed statement emits sanitized error telemetry without SQL text [thrift], TELEMETRY-002 — failed statement emits sanitized error telemetry without SQL text [sea] (see the coverage PR diff under tests/)
  • TELEMETRY-005 [thrift, sea]: for a CloudFetch/external-links result the terminal event still reports no resultFormat/compressed, so EXTERNAL_LINKS delivery and server-declared compression are indistinguishable from an inline result
    • failing test: TELEMETRY-005 — telemetry reports external-links delivery and compression [thrift], TELEMETRY-005 — telemetry reports external-links delivery and compression [sea] (see the coverage PR diff under tests/)
  • TELEMETRY-002: statement error telemetry copies the raw server error message and JS stack verbatim into errorMessage/errorStack, leaking SQL-derived identifiers (table/column names, and any literals the server quotes) out of the customer process; the error descriptor should be sanitized to an aggregatable category/name
  • TELEMETRY-001: the terminal statement.complete telemetry event never populates resultFormat or compressed (both are declared on TelemetryEvent and accepted by emitStatementComplete), so the result-delivery shape of an inline result (INLINE_ARROW, uncompressed) is never reported and downstream delivery-shape aggregates are blind
  • TELEMETRY-005: for a CloudFetch/external-links result the terminal statement.complete event still reports no resultFormat/compressed, so EXTERNAL_LINKS delivery and the server-declared LZ4_FRAME compression are never distinguishable from an inline result in telemetry

Context

Dominant language
TypeScript
Stars
36
Forks
50
Avg merge
1d 6h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databricks/databricks-sql-nodejs

All issues in databricks/databricks-sql-nodejs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.