Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

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

未關閉
#508 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
52/100
Issue 類型
缺陷
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
nodejs, sql, typescript

研究方向

先從 issue 中對 TelemetryEvent 和 emitStatementComplete 的參照開始,接著檢查 driver 程式碼以及 coverage PR 中列出的 xfail 測試。針對 thrift 和 sea 分別重現 TELEMETRY-001、TELEMETRY-002 與 TELEMETRY-005 案例。完成的標準是:終端事件回報傳遞格式與壓縮,而錯誤 telemetry 使用不含 SQL 衍生文字的已清理類別。

由索引模型根據 Issue 內容生成。

描述

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

主要語言
TypeScript
星號
37
分支
51
平均合併
5 小時 56 分鐘
30 天內合併 PR
9

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

databricks/databricks-sql-nodejs 的其他 Issue

查看 databricks/databricks-sql-nodejs 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。