|
| 1 | +/** |
| 2 | + * This scripts helps finding the original source file and line number for a |
| 3 | + * given file and line number in the compiled extension. It currently only |
| 4 | + * works with released extensions. |
| 5 | + * |
| 6 | + * Usage: npx ts-node scripts/source-map.ts <version-number> <filename>:<line>:<column> |
| 7 | + * For example: npx ts-node scripts/source-map.ts v1.7.8 "/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131164:13" |
| 8 | + * |
| 9 | + * Alternative usage: npx ts-node scripts/source-map.ts <version-number> <multi-line-stacktrace> |
| 10 | + * For example: npx ts-node scripts/source-map.ts v1.7.8 'Error: Failed to find CodeQL distribution. |
| 11 | + * at CodeQLCliServer.getCodeQlPath (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131164:13) |
| 12 | + * at CodeQLCliServer.launchProcess (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131169:24) |
| 13 | + * at CodeQLCliServer.runCodeQlCliInternal (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131194:24) |
| 14 | + * at CodeQLCliServer.runJsonCodeQlCliCommand (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131330:20) |
| 15 | + * at CodeQLCliServer.resolveRam (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131455:12) |
| 16 | + * at QueryServerClient2.startQueryServerImpl (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:138618:21)' |
| 17 | + */ |
| 18 | + |
| 19 | +import { spawnSync } from "child_process"; |
| 20 | +import { basename, resolve } from "path"; |
| 21 | +import { pathExists, readJSON } from "fs-extra"; |
| 22 | +import { RawSourceMap, SourceMapConsumer } from "source-map"; |
| 23 | +import { Open } from "unzipper"; |
| 24 | + |
| 25 | +if (process.argv.length !== 4) { |
| 26 | + console.error( |
| 27 | + "Expected 2 arguments - the version number and the filename:line number", |
| 28 | + ); |
| 29 | +} |
| 30 | + |
| 31 | +const stackLineRegex = |
| 32 | + /at (?<name>.*)? \((?<file>.*):(?<line>\d+):(?<column>\d+)\)/gm; |
| 33 | + |
| 34 | +const versionNumber = process.argv[2].startsWith("v") |
| 35 | + ? process.argv[2] |
| 36 | + : `v${process.argv[2]}`; |
| 37 | +const stacktrace = process.argv[3]; |
| 38 | + |
| 39 | +async function extractSourceMap() { |
| 40 | + const releaseAssetsDirectory = resolve( |
| 41 | + __dirname, |
| 42 | + "..", |
| 43 | + "release-assets", |
| 44 | + versionNumber, |
| 45 | + ); |
| 46 | + const sourceMapsDirectory = resolve( |
| 47 | + __dirname, |
| 48 | + "..", |
| 49 | + "artifacts", |
| 50 | + "source-maps", |
| 51 | + versionNumber, |
| 52 | + ); |
| 53 | + |
| 54 | + if (!(await pathExists(sourceMapsDirectory))) { |
| 55 | + console.log("Downloading source maps..."); |
| 56 | + |
| 57 | + const release = runGhJSON<Release>([ |
| 58 | + "release", |
| 59 | + "view", |
| 60 | + versionNumber, |
| 61 | + "--json", |
| 62 | + "id,name,assets", |
| 63 | + ]); |
| 64 | + |
| 65 | + const sourcemapAsset = release.assets.find( |
| 66 | + (asset) => asset.name === `vscode-codeql-sourcemaps-${versionNumber}.zip`, |
| 67 | + ); |
| 68 | + |
| 69 | + if (sourcemapAsset) { |
| 70 | + // This downloads a ZIP file of the source maps |
| 71 | + runGh([ |
| 72 | + "release", |
| 73 | + "download", |
| 74 | + versionNumber, |
| 75 | + "--pattern", |
| 76 | + sourcemapAsset.name, |
| 77 | + "--dir", |
| 78 | + releaseAssetsDirectory, |
| 79 | + ]); |
| 80 | + |
| 81 | + const file = await Open.file( |
| 82 | + resolve(releaseAssetsDirectory, sourcemapAsset.name), |
| 83 | + ); |
| 84 | + await file.extract({ path: sourceMapsDirectory }); |
| 85 | + } else { |
| 86 | + const workflowRuns = runGhJSON<WorkflowRunListItem[]>([ |
| 87 | + "run", |
| 88 | + "list", |
| 89 | + "--workflow", |
| 90 | + "release.yml", |
| 91 | + "--branch", |
| 92 | + versionNumber, |
| 93 | + "--json", |
| 94 | + "databaseId,number", |
| 95 | + ]); |
| 96 | + |
| 97 | + if (workflowRuns.length !== 1) { |
| 98 | + throw new Error( |
| 99 | + `Expected exactly one workflow run for ${versionNumber}, got ${workflowRuns.length}`, |
| 100 | + ); |
| 101 | + } |
| 102 | + |
| 103 | + const workflowRun = workflowRuns[0]; |
| 104 | + |
| 105 | + runGh([ |
| 106 | + "run", |
| 107 | + "download", |
| 108 | + workflowRun.databaseId.toString(), |
| 109 | + "--name", |
| 110 | + "vscode-codeql-sourcemaps", |
| 111 | + "--dir", |
| 112 | + sourceMapsDirectory, |
| 113 | + ]); |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + if (stacktrace.includes("at")) { |
| 118 | + const rawSourceMaps = new Map<string, RawSourceMap>(); |
| 119 | + |
| 120 | + const mappedStacktrace = await replaceAsync( |
| 121 | + stacktrace, |
| 122 | + stackLineRegex, |
| 123 | + async (match, name, file, line, column) => { |
| 124 | + if (!rawSourceMaps.has(file)) { |
| 125 | + const rawSourceMap: RawSourceMap = await readJSON( |
| 126 | + resolve(sourceMapsDirectory, `${basename(file)}.map`), |
| 127 | + ); |
| 128 | + rawSourceMaps.set(file, rawSourceMap); |
| 129 | + } |
| 130 | + |
| 131 | + const originalPosition = await SourceMapConsumer.with( |
| 132 | + rawSourceMaps.get(file) as RawSourceMap, |
| 133 | + null, |
| 134 | + async function (consumer) { |
| 135 | + return consumer.originalPositionFor({ |
| 136 | + line: parseInt(line, 10), |
| 137 | + column: parseInt(column, 10), |
| 138 | + }); |
| 139 | + }, |
| 140 | + ); |
| 141 | + |
| 142 | + if (!originalPosition.source) { |
| 143 | + return match; |
| 144 | + } |
| 145 | + |
| 146 | + const originalFilename = resolve(file, "..", originalPosition.source); |
| 147 | + |
| 148 | + return `at ${originalPosition.name ?? name} (${originalFilename}:${ |
| 149 | + originalPosition.line |
| 150 | + }:${originalPosition.column})`; |
| 151 | + }, |
| 152 | + ); |
| 153 | + |
| 154 | + console.log(mappedStacktrace); |
| 155 | + } else { |
| 156 | + // This means it's just a filename:line:column |
| 157 | + const [filename, line, column] = stacktrace.split(":", 3); |
| 158 | + |
| 159 | + const fileBasename = basename(filename); |
| 160 | + |
| 161 | + const sourcemapName = `${fileBasename}.map`; |
| 162 | + const sourcemapPath = resolve(sourceMapsDirectory, sourcemapName); |
| 163 | + |
| 164 | + if (!(await pathExists(sourcemapPath))) { |
| 165 | + throw new Error(`No source map found for ${fileBasename}`); |
| 166 | + } |
| 167 | + |
| 168 | + const rawSourceMap: RawSourceMap = await readJSON(sourcemapPath); |
| 169 | + |
| 170 | + const originalPosition = await SourceMapConsumer.with( |
| 171 | + rawSourceMap, |
| 172 | + null, |
| 173 | + async function (consumer) { |
| 174 | + return consumer.originalPositionFor({ |
| 175 | + line: parseInt(line, 10), |
| 176 | + column: parseInt(column, 10), |
| 177 | + }); |
| 178 | + }, |
| 179 | + ); |
| 180 | + |
| 181 | + if (!originalPosition.source) { |
| 182 | + throw new Error(`No source found for ${stacktrace}`); |
| 183 | + } |
| 184 | + |
| 185 | + const originalFilename = resolve(filename, "..", originalPosition.source); |
| 186 | + |
| 187 | + console.log( |
| 188 | + `${originalFilename}:${originalPosition.line}:${originalPosition.column}`, |
| 189 | + ); |
| 190 | + } |
| 191 | +} |
| 192 | + |
| 193 | +extractSourceMap().catch((e: unknown) => { |
| 194 | + console.error(e); |
| 195 | + process.exit(2); |
| 196 | +}); |
| 197 | + |
| 198 | +function runGh(args: readonly string[]): string { |
| 199 | + const gh = spawnSync("gh", args); |
| 200 | + if (gh.status !== 0) { |
| 201 | + throw new Error( |
| 202 | + `Failed to get the source map for ${versionNumber}: ${gh.stderr}`, |
| 203 | + ); |
| 204 | + } |
| 205 | + return gh.stdout.toString("utf-8"); |
| 206 | +} |
| 207 | + |
| 208 | +function runGhJSON<T>(args: readonly string[]): T { |
| 209 | + return JSON.parse(runGh(args)); |
| 210 | +} |
| 211 | + |
| 212 | +type ReleaseAsset = { |
| 213 | + id: string; |
| 214 | + name: string; |
| 215 | +}; |
| 216 | + |
| 217 | +type Release = { |
| 218 | + id: string; |
| 219 | + name: string; |
| 220 | + assets: ReleaseAsset[]; |
| 221 | +}; |
| 222 | + |
| 223 | +type WorkflowRunListItem = { |
| 224 | + databaseId: number; |
| 225 | + number: number; |
| 226 | +}; |
| 227 | + |
| 228 | +async function replaceAsync( |
| 229 | + str: string, |
| 230 | + regex: RegExp, |
| 231 | + replacer: (substring: string, ...args: any[]) => Promise<string>, |
| 232 | +) { |
| 233 | + const promises: Array<Promise<string>> = []; |
| 234 | + str.replace(regex, (match, ...args) => { |
| 235 | + const promise = replacer(match, ...args); |
| 236 | + promises.push(promise); |
| 237 | + return match; |
| 238 | + }); |
| 239 | + const data = await Promise.all(promises); |
| 240 | + return str.replace(regex, () => data.shift() as string); |
| 241 | +} |
0 commit comments