eugeneo17 commented on code in PR #43303: URL: https://github.com/apache/superset/pull/43303#discussion_r4004754393
########## superset-frontend/src/backend-querycontext/parity.test.ts: ########## @@ -0,0 +1,75 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/** + * Parity golden-writer (Apache Superset #33615). + * + * For each shared input fixture in `__fixtures__/formdata/<viz>.json`, run the + * exact backend code path (`generateQueryContext`) and record the resulting + * query_context to `__fixtures__/expected/<viz>.json`. The Python parity test + * (`tests/unit_tests/charts/commands/importers/v1/query_context_parity_test.py`) + * then runs the SAME `generateQueryContext` in V8 over the SAME inputs and + * asserts byte-equality with these goldens — proving the backend synthesis is + * pixel-faithful to the frontend `buildQuery`. + * + * FOUNDATION: 2 viz types today (pivot_table_v2, echarts_timeseries) — the + * cases where the generic Python derivation diverges. Full "perfect" coverage = + * a fixture per registered viz type (follow-on, ideally code-generated). + */ +import fs from 'fs'; +import path from 'path'; +import { generateQueryContext, VIZ_TYPES } from './entry'; + +const FORMDATA_DIR = path.join(__dirname, '__fixtures__', 'formdata'); +const EXPECTED_DIR = path.join(__dirname, '__fixtures__', 'expected'); + +describe('backend query-context parity goldens', () => { + beforeAll(() => { + fs.mkdirSync(EXPECTED_DIR, { recursive: true }); + }); + + const fixtures = fs + .readdirSync(FORMDATA_DIR) + .filter(f => f.endsWith('.json')) + .map(f => f.replace(/\.json$/, '')); + + it.each(fixtures)('records + validates query_context for %s', vizType => { + const formData = JSON.parse( + fs.readFileSync(path.join(FORMDATA_DIR, `${vizType}.json`), 'utf8'), + ); + const raw = generateQueryContext(vizType, JSON.stringify(formData)); + const result = JSON.parse(raw); Review Comment: Acknowledged, and it is noted in the test docstring: the JS golden guards runtime and serialization consistency, and the actual frontend/backend parity is enforced by the Python parity test that asserts the pure-Python fallback matches these goldens. Seeding goldens from an independent frontend execution is reasonable hardening, but I would prefer to track it separately. OK to keep the two-sided setup for this PR? ########## superset-frontend/scripts/gen-qc-registry.mjs: ########## @@ -0,0 +1,216 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Deterministic, re-runnable codegen: maps every plugin `buildQuery` module to the +// viz_type key(s) it is registered under, and emits registry.generated.ts consumed +// by entry.ts. Join: buildQuery module <- (index.ts that imports it) -> plugin class +// name -> MainPreset `.configure({ key: VizType.X })` -> VizType enum string. +// A single builder legitimately maps to several keys (e.g. echarts_timeseries + _line/_bar/...). +import { readFileSync, writeFileSync, readdirSync, statSync, existsSync } from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const FE = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); +const PLUGINS = path.join(FE, 'plugins'); +const OUT = path.join(FE, 'src', 'backend-querycontext', 'registry.generated.ts'); + +// --- 1. VizType enum: EnumName -> 'string_value' --- +const vizTypeSrc = readFileSync( + path.join(FE, 'packages/superset-ui-core/src/chart/types/VizType.ts'), + 'utf8', +); +const VIZ_ENUM = {}; +for (const m of vizTypeSrc.matchAll(/(\w+)\s*=\s*['"]([\w-]+)['"]/g)) VIZ_ENUM[m[1]] = m[2]; + +// --- 2. MainPreset: ClassName -> viz string --- +const mainPreset = readFileSync( + path.join(FE, 'src/visualizations/presets/MainPreset.js'), Review Comment: Fixed: the generator reads MainPreset.ts (the .js path was stale and exited with ENOENT). Regeneration is enforced by check:backend-querycontext-registry in CI. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
