bermudalamb
ae8f0eb12c
SonarQube was analysing none of frontend/src. All 34 files were indexed and reported ncloc 0, so the quality gate had been measuring roughly a third of the codebase while appearing to cover it. The scanner log gives the cause: frontend/tsconfig.json sets "moduleResolution": "bundler", which is correct for Vite, and the TypeScript bundled with SonarQube 9.9 predates 5.0 and rejects it. Building the frontend program throws, every frontend file is dropped, and the scan still exits EXECUTION SUCCESS — which is why a green job hid this indefinitely. Adds frontend/tsconfig.sonar.json, an analysis-only mirror that differs only in using "node", and points the scan at it via sonar.typescript.tsconfigPaths. The app's own tsconfig is deliberately untouched: "bundler" is right for the build, and changing it to satisfy an old analyser would let the tool dictate the build. The mirror cannot use `extends` — the old compiler validates the base file while reading it, so the error just moves to pointing at tsconfig.json. Verified locally against a scratch project: 59/59 files analysed, no skips. Analysed lines go from 2,069 to 5,481, code smells from 2 to 14, security hotspots from 3 to 4, and technical debt from 21 to 85 minutes. The frontend had been hiding twelve code smells and a hotspot, which is part of why the React problems behind #60 and #62 had to be found by hand. A standalone copy drifts, and drift here does not fail anything — it silently returns to skipping the frontend while reporting success. scripts/check-sonar-tsconfig.js compares the two and fails when they diverge in anything but moduleResolution, and runs before the scan so the scan is never what discovers it. Confirmed it catches drift by introducing some. Moves scan settings into sonar-project.properties at the repo root so a local scan and the CI scan analyse the same thing, leaving only the host and token in secrets. Adds scripts/scan-local.sh, which runs the scanner in Docker because it needs Java 11+ and the dev machine has Java 8, and which defaults to a scratch project key: the server is Community edition with no branch analysis, so any scan overwrites the single main analysis of whichever key it is given. Closes #67
62 lines
2.8 KiB
JavaScript
62 lines
2.8 KiB
JavaScript
#!/usr/bin/env node
|
|
// frontend/tsconfig.sonar.json is a standalone copy of frontend/tsconfig.json
|
|
// that exists only so SonarQube 9.9 can build a TypeScript program — see #67.
|
|
// It cannot use `extends`, because the analyser's bundled compiler validates the
|
|
// base file while reading it and rejects "moduleResolution": "bundler" before
|
|
// any override applies.
|
|
//
|
|
// A copy drifts. When it does, the scan does not fail: it goes back to skipping
|
|
// every frontend file and still reports EXECUTION SUCCESS, which is exactly the
|
|
// silent failure #67 was about. So the copy is checked rather than trusted.
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const dir = path.join(__dirname, '..', 'frontend');
|
|
const REAL = path.join(dir, 'tsconfig.json');
|
|
const SONAR = path.join(dir, 'tsconfig.sonar.json');
|
|
|
|
// The one option the copy is allowed to differ on — the whole reason it exists.
|
|
const ALLOWED_DIFF = 'moduleResolution';
|
|
|
|
// Strips comments and the "//" documentation key so the two are compared on
|
|
// their actual settings.
|
|
function load(file) {
|
|
const text = fs.readFileSync(file, 'utf-8').replace(/^\s*\/\/.*$/gm, '');
|
|
const parsed = JSON.parse(text);
|
|
delete parsed['//'];
|
|
return parsed;
|
|
}
|
|
|
|
const real = load(REAL);
|
|
const sonar = load(SONAR);
|
|
const problems = [];
|
|
|
|
const realOpts = real.compilerOptions || {};
|
|
const sonarOpts = sonar.compilerOptions || {};
|
|
|
|
for (const key of new Set([...Object.keys(realOpts), ...Object.keys(sonarOpts)])) {
|
|
if (key === ALLOWED_DIFF) continue;
|
|
const a = JSON.stringify(realOpts[key]);
|
|
const b = JSON.stringify(sonarOpts[key]);
|
|
if (a !== b) problems.push(`compilerOptions.${key}: tsconfig.json has ${a}, tsconfig.sonar.json has ${b}`);
|
|
}
|
|
|
|
if (JSON.stringify(real.include) !== JSON.stringify(sonar.include)) {
|
|
problems.push(`include: tsconfig.json has ${JSON.stringify(real.include)}, tsconfig.sonar.json has ${JSON.stringify(sonar.include)}`);
|
|
}
|
|
|
|
// A copy that no longer overrides the option it exists to override is worse than
|
|
// no copy at all — the scan would silently fall back to skipping the frontend.
|
|
if (sonarOpts[ALLOWED_DIFF] === 'bundler' || sonarOpts[ALLOWED_DIFF] === undefined) {
|
|
problems.push(`compilerOptions.${ALLOWED_DIFF} in tsconfig.sonar.json must be a value SonarQube 9.9 accepts ('node', 'classic', 'node16', 'nodenext'), not ${JSON.stringify(sonarOpts[ALLOWED_DIFF])}`);
|
|
}
|
|
|
|
if (problems.length) {
|
|
console.error('frontend/tsconfig.sonar.json has drifted from frontend/tsconfig.json:\n');
|
|
for (const problem of problems) console.error(` - ${problem}`);
|
|
console.error(`\nBring them back into step. Everything except "${ALLOWED_DIFF}" must match, or SonarQube analyses the frontend against settings the app is not built with. See #67.`);
|
|
process.exit(1);
|
|
}
|
|
|
|
console.log(`frontend/tsconfig.sonar.json matches tsconfig.json (differing only on ${ALLOWED_DIFF}, as intended).`);
|