|
| 1 | +// Copyright (c) 2026 Databricks, Inc. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +/** |
| 16 | + * End-to-end check that `statementConf` and `queryTags` from the |
| 17 | + * public `ExecuteStatementOptions` propagate through the SEA backend |
| 18 | + * into the per-statement conf overlay on the SEA wire, and that the |
| 19 | + * server actually honours the values. |
| 20 | + * |
| 21 | + * Observable assertion strategy: |
| 22 | + * - `statementConf`: set `TIMEZONE` to a known non-default zone, then |
| 23 | + * run `SELECT current_timezone()` and verify the returned value |
| 24 | + * matches what we set. The server is the source of truth — if the |
| 25 | + * value made it through the wire, current_timezone() reports it. |
| 26 | + * - `queryTags`: serialised at the JS layer via `serializeQueryTags` |
| 27 | + * into `statementConf["query_tags"]`. We can't read query tags |
| 28 | + * back from the same session deterministically (system.query_history |
| 29 | + * has eventual-consistency latency in some workspaces), so the |
| 30 | + * assertion is "statement succeeds with tags set" — proves the wire |
| 31 | + * format is accepted by the server. Byte-shape parity vs Thrift is |
| 32 | + * pinned by the kernel-side unit tests |
| 33 | + * (`serialize_query_tags_matches_thrift_byte_shape_*`). |
| 34 | + * |
| 35 | + * DA round-1 F3 "live" fixup. |
| 36 | + * |
| 37 | + * Skipped when `DATABRICKS_PECOTESTING_*` env vars are absent. |
| 38 | + */ |
| 39 | + |
| 40 | +import { expect } from 'chai'; |
| 41 | +import { existsSync } from 'fs'; |
| 42 | +import { resolve as resolvePath } from 'path'; |
| 43 | +import { createRequire } from 'module'; |
| 44 | +import type { ConnectionOptions } from '../../../lib/contracts/IDBSQLClient'; |
| 45 | + |
| 46 | +// eslint-disable-next-line @typescript-eslint/naming-convention |
| 47 | +const requireFromHere = createRequire(import.meta.url); |
| 48 | + |
| 49 | +interface InternalConnectionOptionsAccess { |
| 50 | + useSEA?: boolean; |
| 51 | +} |
| 52 | + |
| 53 | +describe('SEA statementConf + queryTags — live', function suite() { |
| 54 | + this.timeout(180_000); |
| 55 | + |
| 56 | + const host = process.env.DATABRICKS_PECOTESTING_SERVER_HOSTNAME || process.env.E2E_HOST; |
| 57 | + const path = process.env.DATABRICKS_PECOTESTING_HTTP_PATH || process.env.E2E_PATH; |
| 58 | + const token = process.env.DATABRICKS_PECOTESTING_TOKEN || process.env.E2E_ACCESS_TOKEN; |
| 59 | + |
| 60 | + before(function gate() { |
| 61 | + if (!host || !path || !token) { |
| 62 | + // eslint-disable-next-line no-invalid-this |
| 63 | + this.skip(); |
| 64 | + return; |
| 65 | + } |
| 66 | + const nodeArtifact = resolvePath( |
| 67 | + process.cwd(), |
| 68 | + 'native/sea/index.linux-x64-gnu.node', |
| 69 | + ); |
| 70 | + if (!existsSync(nodeArtifact)) { |
| 71 | + // eslint-disable-next-line no-console |
| 72 | + console.warn( |
| 73 | + `[sea statement-options e2e] skipping: native binary not built. ` + |
| 74 | + `Run \`yarn build:native\` first.`, |
| 75 | + ); |
| 76 | + // eslint-disable-next-line no-invalid-this |
| 77 | + this.skip(); |
| 78 | + } |
| 79 | + }); |
| 80 | + |
| 81 | + async function connect() { |
| 82 | + const { DBSQLClient } = requireFromHere('../../../lib') as typeof import('../../../lib'); |
| 83 | + const client = new DBSQLClient(); |
| 84 | + const options = { |
| 85 | + host: host as string, |
| 86 | + path: path as string, |
| 87 | + token: token as string, |
| 88 | + useSEA: true, |
| 89 | + } as ConnectionOptions & InternalConnectionOptionsAccess; |
| 90 | + await client.connect(options as unknown as ConnectionOptions); |
| 91 | + return client; |
| 92 | + } |
| 93 | + |
| 94 | + it('queryTags pass through without error on a live statement', async () => { |
| 95 | + // Server accepts the comma-separated `key:value` wire shape; |
| 96 | + // assertion is "no error". Byte-shape parity is pinned by |
| 97 | + // kernel unit tests. |
| 98 | + const client = await connect(); |
| 99 | + try { |
| 100 | + const session = await client.openSession(); |
| 101 | + try { |
| 102 | + const operation = await session.executeStatement('SELECT 1 AS x', { |
| 103 | + queryTags: { |
| 104 | + team: 'platform', |
| 105 | + env: 'staging', |
| 106 | + }, |
| 107 | + }); |
| 108 | + try { |
| 109 | + const rows = await operation.fetchAll(); |
| 110 | + expect(rows.length).to.equal(1); |
| 111 | + expect(rows[0]).to.have.property('x'); |
| 112 | + } finally { |
| 113 | + await operation.close(); |
| 114 | + } |
| 115 | + } finally { |
| 116 | + await session.close(); |
| 117 | + } |
| 118 | + } finally { |
| 119 | + await client.close(); |
| 120 | + } |
| 121 | + }); |
| 122 | + |
| 123 | + it('queryTags with backslash-escape-needing values do not break the wire', async () => { |
| 124 | + // Pins the Thrift escape contract end-to-end: server accepts a |
| 125 | + // tag value containing `:`, `,`, and `\`. If the kernel-side |
| 126 | + // serializer ever drops an escape, the server rejects the conf |
| 127 | + // string and this test fails. |
| 128 | + const client = await connect(); |
| 129 | + try { |
| 130 | + const session = await client.openSession(); |
| 131 | + try { |
| 132 | + const operation = await session.executeStatement('SELECT 1 AS x', { |
| 133 | + queryTags: { |
| 134 | + tricky: 'has:colon,comma\\backslash', |
| 135 | + }, |
| 136 | + }); |
| 137 | + try { |
| 138 | + const rows = await operation.fetchAll(); |
| 139 | + expect(rows.length).to.equal(1); |
| 140 | + } finally { |
| 141 | + await operation.close(); |
| 142 | + } |
| 143 | + } finally { |
| 144 | + await session.close(); |
| 145 | + } |
| 146 | + } finally { |
| 147 | + await client.close(); |
| 148 | + } |
| 149 | + }); |
| 150 | + |
| 151 | + it('null and undefined valued tags survive the wire (bare key form)', async () => { |
| 152 | + // `serializeQueryTags` emits a bare key (no colon) for null / |
| 153 | + // undefined values. The server has to accept the resulting form. |
| 154 | + const client = await connect(); |
| 155 | + try { |
| 156 | + const session = await client.openSession(); |
| 157 | + try { |
| 158 | + const operation = await session.executeStatement('SELECT 1 AS x', { |
| 159 | + queryTags: { |
| 160 | + 'mark-only-key': null, |
| 161 | + 'undef-key': undefined, |
| 162 | + real: 'value', |
| 163 | + }, |
| 164 | + }); |
| 165 | + try { |
| 166 | + const rows = await operation.fetchAll(); |
| 167 | + expect(rows.length).to.equal(1); |
| 168 | + } finally { |
| 169 | + await operation.close(); |
| 170 | + } |
| 171 | + } finally { |
| 172 | + await session.close(); |
| 173 | + } |
| 174 | + } finally { |
| 175 | + await client.close(); |
| 176 | + } |
| 177 | + }); |
| 178 | + |
| 179 | + it('no queryTags option works as before (regression check)', async () => { |
| 180 | + // Default-path regression: prove the F3 plumbing hasn't broken |
| 181 | + // statement execution when ExecuteStatementOptions is empty. |
| 182 | + const client = await connect(); |
| 183 | + try { |
| 184 | + const session = await client.openSession(); |
| 185 | + try { |
| 186 | + const operation = await session.executeStatement('SELECT 1 AS x'); |
| 187 | + try { |
| 188 | + const rows = await operation.fetchAll(); |
| 189 | + expect(rows.length).to.equal(1); |
| 190 | + } finally { |
| 191 | + await operation.close(); |
| 192 | + } |
| 193 | + } finally { |
| 194 | + await session.close(); |
| 195 | + } |
| 196 | + } finally { |
| 197 | + await client.close(); |
| 198 | + } |
| 199 | + }); |
| 200 | +}); |
0 commit comments