feat: link stack entries to Github blob URLs

Author: ph-fritsche

package.json

@@ -15,6 +15,7 @@
         "react": "^18.3.1",
         "source-map": "^0.7.4",
         "swc-plugin-coverage-instrument": "0.0.20",
+        "terminal-link": "^3.0.0",
         "widest-line": "^5.0.0"
     },
     "devDependencies": {
@@ -59,4 +60,4 @@
     "main": "./dist/index.js",
     "module": "./dist/index.js",
     "types": "./dist/index.d.ts"
-}
+}

src/error/GitHubResolver.ts

@@ -0,0 +1,96 @@
+import { pathToFileURL } from 'node:url'
+import { SourceLocation, SourceLocationResolver } from './ErrorStackResolver'
+import { spawn } from 'node:child_process'
+
+export class GitHubResolver implements SourceLocationResolver {
+    constructor(
+        readonly GITHUB_WORKSPACE = process.env.GITHUB_WORKSPACE,
+        readonly GITHUB_SHA = process.env.GITHUB_SHA,
+        readonly GITHUB_REPOSITORY = process.env.GITHUB_REPOSITORY,
+        readonly GITHUB_SERVER_URL = process.env.GITHUB_SERVER_URL,
+    ) {
+        if (GITHUB_WORKSPACE) {
+            this.workspaceUrl = String(pathToFileURL(GITHUB_WORKSPACE))
+            if (!this.workspaceUrl.endsWith('/')) {
+                this.workspaceUrl += '/'
+            }
+        }
+    }
+
+    protected workspaceUrl?: string
+    protected resolvedWorkspaceUrl?: Promise<string>
+    protected treeObjects?: Promise<string[]>
+
+    async resolve(loc: SourceLocation): Promise<SourceLocation | undefined> {
+        if (!this.workspaceUrl || !loc.file?.startsWith(this.workspaceUrl)) {
+            return undefined
+        }
+        const path = loc.file.substring(this.workspaceUrl.length)
+
+        if (!this.resolvedWorkspaceUrl) {
+            this.resolvedWorkspaceUrl = this.getGitAbbrevSha()
+                .then(abbrev => [
+                    this.GITHUB_SERVER_URL,
+                    this.GITHUB_REPOSITORY,
+                    'blob',
+                    abbrev,
+                ].join('/'))
+        }
+        if (!this.treeObjects) {
+            this.treeObjects = this.getGitTreeObjects()
+        }
+        const resolvedUrl = await this.resolvedWorkspaceUrl
+        const tree = await this.treeObjects
+
+        if (tree.includes(path)) {
+            return {...loc,
+                url: resolvedUrl + '/' + path + (loc.position ? `#L${loc.position.line}` : ''),
+            }
+        }
+    }
+
+    protected getGitAbbrevSha(): Promise<string> {
+        return this.runGitCmd([
+            'rev-parse',
+            '--short',
+            'HEAD',
+        ])
+    }
+
+    protected async getGitTreeObjects(): Promise<string[]> {
+        const out = await this.runGitCmd([
+            'ls-tree',
+            '--name-only',
+            '-r',
+            'HEAD',
+        ])
+        return out.split('\n')
+    }
+
+    protected runGitCmd(args: string[]): Promise<string> {
+        if (!this.GITHUB_WORKSPACE) {
+            return Promise.reject(`GITHUB_WORKSPACE is not set.`)
+        }
+
+        return new Promise((res, rej) => {
+            const child = spawn('git', args, {
+                cwd: this.GITHUB_WORKSPACE,
+                stdio: ['ignore', 'pipe', 'pipe'],
+            })
+            let out = '', err = ''
+            child.stdout.on('data', c => {
+                out += String(c)
+            })
+            child.stderr.on('data', c => {
+                err += String(c)
+            })
+            child.on('exit', (code, signal) => {
+                if (code || signal) {
+                    rej(`Git command failed: ${JSON.stringify(args)}\n` + err)
+                } else {
+                    res(out.trimEnd())
+                }
+            })
+        })
+    }
+}

src/error/XError.ts

@@ -94,6 +94,7 @@ function* genStackEntries(stack: string) {
 
 export type SourceLocation = {
     file?: string
+    url?: string
     position?: Position
     name?: string
 }
@@ -109,11 +110,17 @@ export class StackEntry {
     }
     readonly resolved
 
-    toString() {
+    toString(
+        useUrl = false,
+    ) {
         const e = this.resolved.get()
 
         const pos = e.position ? `:${e.position.line}:${e.position.column}` : ''
-        if (e.name && e.file) {
+        if (useUrl && e.url && e.name) {
+            return `${e.name} (${e.url})`
+        } else if (useUrl && e.url) {
+            return `${e.url}`
+        } else if (e.name && e.file) {
             return `${e.name} (${e.file}${pos})`
         } else if (e.file) {
             return `${e.file}${pos}`

src/index.ts

@@ -20,6 +20,7 @@ import { TesterCli } from './ui/cli/TesterCli'
 import { ErrorStackResolver, SourceLocation, SourceLocationResolver } from './error/ErrorStackResolver'
 import { SourceMapResolver } from './error/SourceMapResolver'
 import { PathResolver } from './error/PathResolver'
+import { GitHubResolver } from './error/GitHubResolver'
 
 export type { TestContext } from './runner/TestContext'
 
@@ -373,6 +374,7 @@ export async function setupToolboxTester(
     const errorStackResolver = new ErrorStackResolver([
         new SourceMapResolver(String(await fileServer.url), fileServer.provider),
         runner,
+        new GitHubResolver(),
         new PathResolver(String(pathToFileURL(projectDir)), ''),
     ])
 

src/ui/cli/Error.tsx

@@ -16,7 +16,13 @@ export function StackEntryText({
     ], [entry])
     tester.resolveErrorStackEntry(entry)
 
-    return <Text color="redBright" dimColor>at {String(entry)}</Text>
+    // A clickable link would be preferable,
+    // but GitHub Actions logs don't support the escape sequence for hyperlinks.
+    // See https://github.com/orgs/community/discussions/119709
+
+    return <Text color="redBright" dimColor>
+        {`at ${entry.toString(true)}`}
+    </Text>
 }
 
 export function XErrorComponent({
@@ -36,7 +42,11 @@ export function XErrorComponent({
             </Line>
         ))}
         {error.stackEntries?.map((entry, i, a) => (
-            <Line key={`stack-${i}`}>
+            <Line key={`stack-${i}`}
+                // If overflowX is set, Links are truncated although the box measurements are correct.
+                overflow="visible"
+                overflowY="hidden"
+            >
                 {border && (<Text color="grey" dimColor>{
                     (i === a.length - 1) ? '╰ ' : '╎ '
                 }</Text>)}

yarn.lock

@@ -685,6 +685,13 @@ ansi-colors@^4.1.3:
   resolved "https://registry.yarnpkg.com/ansi-colors/-/ansi-colors-4.1.3.tgz#37611340eb2243e70cc604cad35d63270d48781b"
   integrity sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==
 
+ansi-escapes@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-5.0.0.tgz#b6a0caf0eef0c41af190e9a749e0c00ec04bb2a6"
+  integrity sha512-5GFMVX8HqE/TB+FuBJGuO5XG0WrsA6ptUqoODaT/n9mmUaZFkqnBueB4leqGBCmrUHnCnC4PCZTCd0E7QQ83bA==
+  dependencies:
+    type-fest "^1.0.2"
+
 ansi-escapes@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-7.0.0.tgz#00fc19f491bbb18e1d481b97868204f92109bfe7"
@@ -3231,13 +3238,21 @@ supports-color@^5.3.0:
   dependencies:
     has-flag "^3.0.0"
 
-supports-color@^7.1.0:
+supports-color@^7.0.0, supports-color@^7.1.0:
   version "7.2.0"
   resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da"
   integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==
   dependencies:
     has-flag "^4.0.0"
 
+supports-hyperlinks@^2.2.0:
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz#3943544347c1ff90b15effb03fc14ae45ec10624"
+  integrity sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==
+  dependencies:
+    has-flag "^4.0.0"
+    supports-color "^7.0.0"
+
 supports-preserve-symlinks-flag@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09"
@@ -3266,6 +3281,14 @@ tar-stream@^3.1.5:
     fast-fifo "^1.2.0"
     streamx "^2.15.0"
 
+terminal-link@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/terminal-link/-/terminal-link-3.0.0.tgz#91c82a66b52fc1684123297ce384429faf72ac5c"
+  integrity sha512-flFL3m4wuixmf6IfhFJd1YPiLiMuxEc8uHRM1buzIeZPm22Au2pDqBJQgdo7n1WfPU1ONFGv7YDwpFBmHGF6lg==
+  dependencies:
+    ansi-escapes "^5.0.0"
+    supports-hyperlinks "^2.2.0"
+
 text-table@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4"
@@ -3329,6 +3352,11 @@ type-fest@^0.20.2:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4"
   integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
 
+type-fest@^1.0.2:
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.4.0.tgz#e9fb813fe3bf1744ec359d55d1affefa76f14be1"
+  integrity sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==
+
 type-fest@^4.27.0:
   version "4.31.0"
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.31.0.tgz#a3de630c96eb77c281b6ba2affa5dae5fb3c326c"