Skip to content

Commit 99025b1

Browse files
zoomote[bot]roomote
andauthored
[Chore] Cache extension coverage by ownership (#1631)
* ci: split extension coverage into cacheable lanes * ci: serialize duplicate platform cache producers * ci: split extension coverage by ownership * ci: parallelize coverage contract collection --------- Co-authored-by: Roomote <[email protected]>
1 parent ba46d1f commit 99025b1

9 files changed

Lines changed: 345 additions & 15 deletions

‎.github/workflows/code-qa.yml‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@ jobs:
125125
unit-test:
126126
name: platform-unit-test (${{ matrix.name }})
127127
runs-on: ${{ matrix.os }}
128+
concurrency:
129+
# Duplicate runs for one commit must not race the OS-specific Turbo cache save.
130+
group: unit-test-${{ github.repository }}-${{ github.sha }}-${{ matrix.name }}
131+
cancel-in-progress: false
128132
strategy:
129133
matrix:
130134
include:
@@ -152,8 +156,8 @@ jobs:
152156
${{ runner.os }}-turbo-
153157
- name: Run non-extension package coverage
154158
run: pnpm turbo run test:coverage --filter="!@roo-code/core" --filter="!zoo-code" --log-order grouped --output-logs new-only
155-
- name: Run extension unit coverage
156-
run: pnpm turbo run test:coverage:unit --filter="zoo-code" --log-order grouped --output-logs new-only
159+
- name: Run extension coverage lanes
160+
run: pnpm turbo run test:coverage:api test:coverage:core test:coverage:services test:coverage:misc test:coverage:tree-sitter --filter="zoo-code" --concurrency=2 --log-order grouped --output-logs new-only
157161
- name: Verify extension coverage contract
158162
run: pnpm --dir src run verify:coverage-contract
159163
- name: Run extension dist smoke test
@@ -162,8 +166,13 @@ jobs:
162166
run: pnpm turbo run test:coverage:unit --filter="@roo-code/core" --log-order grouped --output-logs new-only
163167
- name: Run core integration coverage
164168
run: pnpm turbo run test:coverage:integration --filter="@roo-code/core" --log-order grouped --output-logs new-only
165-
- name: Verify extension unit coverage report
166-
run: node src/scripts/verify-lcov.mjs src/coverage/unit/lcov.info
169+
- name: Verify extension coverage reports
170+
run: |
171+
node src/scripts/verify-lcov.mjs src/coverage/api/lcov.info
172+
node src/scripts/verify-lcov.mjs src/coverage/core/lcov.info
173+
node src/scripts/verify-lcov.mjs src/coverage/services/lcov.info
174+
node src/scripts/verify-lcov.mjs src/coverage/misc/lcov.info
175+
node src/scripts/verify-lcov.mjs src/coverage/tree-sitter/lcov.info
167176
- name: Save Turbo cache
168177
if: steps.turbo-cache.outputs.cache-hit != 'true'
169178
uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
@@ -185,7 +194,11 @@ jobs:
185194
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
186195
with:
187196
files: >-
188-
src/coverage/unit/lcov.info,
197+
src/coverage/api/lcov.info,
198+
src/coverage/core/lcov.info,
199+
src/coverage/services/lcov.info,
200+
src/coverage/misc/lcov.info,
201+
src/coverage/tree-sitter/lcov.info,
189202
packages/cloud/coverage/lcov.info,
190203
packages/telemetry/coverage/lcov.info,
191204
apps/cli/coverage/lcov.info
@@ -222,7 +235,11 @@ jobs:
222235
with:
223236
name: coverage-reports-${{ matrix.name }}
224237
path: |
225-
src/coverage/unit/lcov.info
238+
src/coverage/api/lcov.info
239+
src/coverage/core/lcov.info
240+
src/coverage/services/lcov.info
241+
src/coverage/misc/lcov.info
242+
src/coverage/tree-sitter/lcov.info
226243
webview-ui/coverage/lcov.info
227244
packages/cloud/coverage/lcov.info
228245
packages/telemetry/coverage/lcov.info

‎src/package.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,11 @@
447447
"test:dist": "vitest run --config vitest.dist.config.ts",
448448
"test:coverage": "vitest run --coverage",
449449
"test:coverage:unit": "vitest run --config vitest.unit.config.ts --coverage",
450+
"test:coverage:api": "vitest run --config vitest.api.config.ts --coverage",
451+
"test:coverage:core": "vitest run --config vitest.core.config.ts --coverage",
452+
"test:coverage:services": "vitest run --config vitest.services.config.ts --coverage",
453+
"test:coverage:misc": "vitest run --config vitest.misc.config.ts --coverage",
454+
"test:coverage:tree-sitter": "vitest run --config vitest.tree-sitter.config.ts --coverage",
450455
"format": "prettier --write .",
451456
"bundle": "node esbuild.mjs",
452457
"vscode:prepublish": "pnpm bundle --production",
Lines changed: 146 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1-
import { spawnSync } from "node:child_process"
1+
import { execFile, spawnSync } from "node:child_process"
2+
import { mkdtempSync, readFileSync, readdirSync, rmSync } from "node:fs"
3+
import { tmpdir } from "node:os"
4+
import { relative, resolve } from "node:path"
25
import process from "node:process"
6+
import { promisify } from "node:util"
37

48
const pnpm = process.platform === "win32" ? process.env.npm_execpath : "pnpm"
59
if (!pnpm) throw new Error("pnpm executable path is unavailable")
610
const command = process.platform === "win32" ? process.execPath : pnpm
711
const args = process.platform === "win32" ? [pnpm] : []
812
const result = spawnSync(
913
command,
10-
[...args, "turbo", "run", "test:coverage:unit", "test:dist", "--filter=zoo-code", "--dry=json"],
14+
[
15+
...args,
16+
"turbo",
17+
"run",
18+
"test:coverage:api",
19+
"test:coverage:core",
20+
"test:coverage:services",
21+
"test:coverage:misc",
22+
"test:coverage:tree-sitter",
23+
"test:dist",
24+
"--filter=zoo-code",
25+
"--dry=json",
26+
],
1127
{ encoding: "utf8" },
1228
)
1329
if (result.status !== 0) {
@@ -16,14 +32,135 @@ if (result.status !== 0) {
1632
}
1733

1834
const graph = JSON.parse(result.stdout)
19-
const coverageTask = graph.tasks.find(({ taskId }) => taskId === "zoo-code#test:coverage:unit")
35+
const ownershipLanes = ["api", "core", "services", "misc"]
36+
const ownershipTasks = ownershipLanes.map((lane) =>
37+
graph.tasks.find(({ taskId }) => taskId === `zoo-code#test:coverage:${lane}`),
38+
)
39+
const treeSitterTask = graph.tasks.find(({ taskId }) => taskId === "zoo-code#test:coverage:tree-sitter")
2040
const distTask = graph.tasks.find(({ taskId }) => taskId === "zoo-code#test:dist")
21-
if (!coverageTask) throw new Error("Unit coverage task missing")
41+
if (ownershipTasks.some((task) => !task) || !treeSitterTask) throw new Error("Extension coverage lane missing")
2242
if (graph.tasks.some(({ taskId }) => taskId === "zoo-code#prepare:tree-sitter-wasms"))
2343
throw new Error("Removed WASM preparation task remains in the graph")
24-
if (coverageTask.dependencies.includes("zoo-code#bundle")) throw new Error("Unit coverage must not depend on bundle")
25-
if (!coverageTask.dependencies.includes("@roo-code/types#build"))
26-
throw new Error("Unit coverage must depend on the types build")
27-
if (!Object.hasOwn(coverageTask.inputs, "package.json")) throw new Error("Unit coverage must hash package.json")
28-
if (!coverageTask.hashOfExternalDependencies) throw new Error("Unit coverage must hash external dependencies")
44+
for (const task of [...ownershipTasks, treeSitterTask]) {
45+
if (task.dependencies.includes("zoo-code#bundle")) throw new Error("Coverage lanes must not depend on bundle")
46+
if (!Object.hasOwn(task.inputs, "package.json")) throw new Error("Coverage lanes must hash package.json")
47+
if (!task.hashOfExternalDependencies) throw new Error("Coverage lanes must hash external dependencies")
48+
}
49+
for (const task of ownershipTasks) {
50+
for (const dependency of [
51+
"@roo-code/cloud",
52+
"@roo-code/core",
53+
"@roo-code/ipc",
54+
"@roo-code/telemetry",
55+
"@roo-code/types",
56+
])
57+
if (!task.dependencies.includes(`${dependency}#build`))
58+
throw new Error(`Ownership coverage lanes must depend on ${dependency}#build`)
59+
}
60+
if (!treeSitterTask.dependencies.includes("@roo-code/types#build"))
61+
throw new Error("Tree-sitter coverage must depend on @roo-code/types#build")
62+
for (const task of ownershipTasks) {
63+
if (!Object.hasOwn(task.inputs, "services/tree-sitter/index.ts"))
64+
throw new Error("Ownership coverage lanes must hash shared tree-sitter production sources")
65+
}
66+
const representativeTests = {
67+
api: "api/providers/__tests__/anthropic.spec.ts",
68+
core: "core/task/__tests__/Task.spec.ts",
69+
services: "services/mcp/__tests__/McpHub.spec.ts",
70+
misc: "utils/__tests__/path.spec.ts",
71+
}
72+
for (const [index, task] of ownershipTasks.entries()) {
73+
for (const [lane, testPath] of Object.entries(representativeTests)) {
74+
const ownsInput = Object.hasOwn(task.inputs, testPath)
75+
if (ownsInput !== (lane === ownershipLanes[index]))
76+
throw new Error(`${ownershipLanes[index]} coverage has incorrect ownership for ${testPath}`)
77+
}
78+
if (Object.hasOwn(task.inputs, "services/tree-sitter/__tests__/wasm.spec.ts"))
79+
throw new Error("Ownership coverage lanes must not hash tree-sitter-owned tests")
80+
}
81+
if (!Object.hasOwn(treeSitterTask.inputs, "services/tree-sitter/index.ts"))
82+
throw new Error("Tree-sitter coverage must hash tree-sitter sources")
83+
if (Object.hasOwn(treeSitterTask.inputs, "core/task/Task.ts"))
84+
throw new Error("Tree-sitter coverage must not hash unrelated core sources")
2985
if (!distTask?.dependencies.includes("zoo-code#bundle")) throw new Error("Dist smoke test must depend on bundle")
86+
87+
const root = resolve(import.meta.dirname, "..")
88+
const testPattern = /\.(?:test|spec)\.(?:[cm]?[jt]sx?)$/
89+
const ignoredDirectories = new Set(["coverage", "dist", "node_modules"])
90+
const testFiles = []
91+
const collectTests = (directory) => {
92+
for (const entry of readdirSync(directory, { withFileTypes: true })) {
93+
if (entry.isDirectory()) {
94+
if (!ignoredDirectories.has(entry.name)) collectTests(resolve(directory, entry.name))
95+
} else if (testPattern.test(entry.name)) {
96+
testFiles.push(relative(root, resolve(directory, entry.name)).replaceAll("\\", "/"))
97+
}
98+
}
99+
}
100+
collectTests(root)
101+
102+
const laneForTest = (file) => {
103+
if (file === "__tests__/dist_assets.spec.ts") return "dist"
104+
if (file.startsWith("services/tree-sitter/")) return "tree-sitter"
105+
for (const lane of ["api", "core", "services"]) if (file.startsWith(`${lane}/`)) return lane
106+
if (
107+
["__tests__", "activate", "extension", "i18n", "integrations", "scripts", "shared", "test-utils", "utils"].some(
108+
(directory) => file.startsWith(`${directory}/`),
109+
)
110+
)
111+
return "misc"
112+
throw new Error(`Unit test is not assigned to a coverage lane: ${file}`)
113+
}
114+
const laneCounts = Object.groupBy(testFiles, laneForTest)
115+
if (Object.values(laneCounts).flat().length !== testFiles.length)
116+
throw new Error("Coverage lanes do not form an exact test partition")
117+
118+
const collectionDirectory = mkdtempSync(resolve(tmpdir(), "zoo-code-coverage-contract-"))
119+
try {
120+
const execFileAsync = promisify(execFile)
121+
const collect = async (config) => {
122+
const output = resolve(collectionDirectory, `${config}.json`)
123+
await execFileAsync(
124+
command,
125+
[
126+
...args,
127+
"exec",
128+
"vitest",
129+
"list",
130+
"--staticParse",
131+
"--config",
132+
`vitest.${config}.config.ts`,
133+
`--json=${output}`,
134+
],
135+
{ maxBuffer: 10 * 1024 * 1024 },
136+
)
137+
return new Set(JSON.parse(readFileSync(output, "utf8")).map(({ file, name }) => `${file}\0${name}`))
138+
}
139+
const collections = ["unit", ...ownershipLanes, "tree-sitter"]
140+
const [unitTests, ...resolvedLanes] = await Promise.all(collections.map(collect))
141+
const laneTests = new Set()
142+
for (const tests of resolvedLanes) {
143+
for (const test of tests) {
144+
if (laneTests.has(test)) throw new Error(`Test belongs to multiple coverage lanes: ${test}`)
145+
laneTests.add(test)
146+
}
147+
}
148+
if (unitTests.size !== laneTests.size || [...unitTests].some((test) => !laneTests.has(test)))
149+
throw new Error("Coverage lane test collection differs from monolithic unit coverage")
150+
} finally {
151+
rmSync(collectionDirectory, { recursive: true, force: true })
152+
}
153+
154+
const coverageSources = new Map()
155+
for (const lane of [...ownershipLanes, "tree-sitter"]) {
156+
let source
157+
for (const line of readFileSync(resolve(root, "coverage", lane, "lcov.info"), "utf8").split(/\r?\n/)) {
158+
if (line.startsWith("SF:")) source = line.slice(3)
159+
if (line.startsWith("LF:")) coverageSources.set(source, Number(line.slice(3)))
160+
}
161+
}
162+
const instrumentedLines = [...coverageSources.values()].reduce((sum, lines) => sum + lines, 0)
163+
if (coverageSources.size !== 469 || instrumentedLines !== 30_229)
164+
throw new Error(
165+
`Coverage source population changed: ${coverageSources.size} records and ${instrumentedLines} lines; verify equivalence and update the baseline deliberately`,
166+
)

‎src/turbo.json‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,90 @@
2020
"inputs": ["$TURBO_DEFAULT$", "!__tests__/dist_assets.spec.ts"],
2121
"outputs": ["coverage/unit/**"]
2222
},
23+
"test:coverage:api": {
24+
"dependsOn": ["^build"],
25+
"inputs": [
26+
"$TURBO_DEFAULT$",
27+
"!core/**/*.{test,spec}.{ts,tsx}",
28+
"!services/**/*.{test,spec}.{ts,tsx}",
29+
"!__tests__/**/*.{test,spec}.{ts,tsx}",
30+
"!activate/**/*.{test,spec}.{ts,tsx}",
31+
"!extension/**/*.{test,spec}.{ts,tsx}",
32+
"!i18n/**/*.{test,spec}.{ts,tsx}",
33+
"!integrations/**/*.{test,spec}.{ts,tsx}",
34+
"!scripts/**/*.{test,spec}.{mjs,ts}",
35+
"!shared/**/*.{test,spec}.{ts,tsx}",
36+
"!test-utils/**/*.{test,spec}.{ts,tsx}",
37+
"!utils/**/*.{test,spec}.{ts,tsx}"
38+
],
39+
"outputs": ["coverage/api/**"]
40+
},
41+
"test:coverage:core": {
42+
"dependsOn": ["^build"],
43+
"inputs": [
44+
"$TURBO_DEFAULT$",
45+
"!api/**/*.{test,spec}.{ts,tsx}",
46+
"!services/**/*.{test,spec}.{ts,tsx}",
47+
"!__tests__/**/*.{test,spec}.{ts,tsx}",
48+
"!activate/**/*.{test,spec}.{ts,tsx}",
49+
"!extension/**/*.{test,spec}.{ts,tsx}",
50+
"!i18n/**/*.{test,spec}.{ts,tsx}",
51+
"!integrations/**/*.{test,spec}.{ts,tsx}",
52+
"!scripts/**/*.{test,spec}.{mjs,ts}",
53+
"!shared/**/*.{test,spec}.{ts,tsx}",
54+
"!test-utils/**/*.{test,spec}.{ts,tsx}",
55+
"!utils/**/*.{test,spec}.{ts,tsx}"
56+
],
57+
"outputs": ["coverage/core/**"]
58+
},
59+
"test:coverage:services": {
60+
"dependsOn": ["^build"],
61+
"inputs": [
62+
"$TURBO_DEFAULT$",
63+
"!api/**/*.{test,spec}.{ts,tsx}",
64+
"!core/**/*.{test,spec}.{ts,tsx}",
65+
"!services/tree-sitter/**/*.{test,spec}.{ts,tsx}",
66+
"!__tests__/**/*.{test,spec}.{ts,tsx}",
67+
"!activate/**/*.{test,spec}.{ts,tsx}",
68+
"!extension/**/*.{test,spec}.{ts,tsx}",
69+
"!i18n/**/*.{test,spec}.{ts,tsx}",
70+
"!integrations/**/*.{test,spec}.{ts,tsx}",
71+
"!scripts/**/*.{test,spec}.{mjs,ts}",
72+
"!shared/**/*.{test,spec}.{ts,tsx}",
73+
"!test-utils/**/*.{test,spec}.{ts,tsx}",
74+
"!utils/**/*.{test,spec}.{ts,tsx}"
75+
],
76+
"outputs": ["coverage/services/**"]
77+
},
78+
"test:coverage:misc": {
79+
"dependsOn": ["^build"],
80+
"inputs": [
81+
"$TURBO_DEFAULT$",
82+
"!api/**/*.{test,spec}.{ts,tsx}",
83+
"!core/**/*.{test,spec}.{ts,tsx}",
84+
"!services/**/*.{test,spec}.{ts,tsx}",
85+
"!__tests__/dist_assets.spec.ts"
86+
],
87+
"outputs": ["coverage/misc/**"]
88+
},
89+
"test:coverage:tree-sitter": {
90+
"dependsOn": ["@roo-code/types#build"],
91+
"inputs": [
92+
"services/tree-sitter/**",
93+
"services/shared/fallback-extensions.ts",
94+
"core/ignore/RooIgnoreController.ts",
95+
"utils/fs.ts",
96+
"utils/path.ts",
97+
"utils/vitest-verbosity.ts",
98+
"__mocks__/**",
99+
"vitest.setup.ts",
100+
"vitest.config.ts",
101+
"vitest.tree-sitter.config.ts",
102+
"package.json",
103+
"tsconfig.json"
104+
],
105+
"outputs": ["coverage/tree-sitter/**"]
106+
},
23107
"bundle": {
24108
"dependsOn": ["^build", "@roo-code/vscode-webview#build"],
25109
"outputs": ["dist/**"]

‎src/vitest.api.config.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import { defineConfig, mergeConfig } from "vitest/config"
2+
3+
import baseConfig from "./vitest.config"
4+
5+
export default mergeConfig(
6+
baseConfig,
7+
defineConfig({
8+
test: {
9+
include: ["api/**/*.{test,spec}.{ts,tsx}"],
10+
coverage: {
11+
reportsDirectory: "coverage/api",
12+
},
13+
},
14+
}),
15+
)

‎src/vitest.core.config.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import { defineConfig, mergeConfig } from "vitest/config"
2+
3+
import baseConfig from "./vitest.config"
4+
5+
export default mergeConfig(
6+
baseConfig,
7+
defineConfig({
8+
test: {
9+
include: ["core/**/*.{test,spec}.{ts,tsx}"],
10+
coverage: {
11+
reportsDirectory: "coverage/core",
12+
},
13+
},
14+
}),
15+
)

0 commit comments

Comments
 (0)