wip: github links in stacks

Author: ph-fritsche

.github/workflows/ci.yml

@@ -26,9 +26,8 @@ jobs:
           yarn-${{ runner.os }}-
           yarn-
     - run: yarn install --frozen-lockfile
-    - run: yarn setup
-    - run: yarn try
     - run: yarn lint
+    - run: yarn setup
     - run: yarn test
     - uses: codecov/codecov-action@v3
       with:

package.json

@@ -52,8 +52,7 @@
         "test": "node --require ./src/node/experimental.cjs --experimental-loader ./build/loader-src.js --experimental-import-meta-resolve --enable-source-maps ./util/test.ts",
         "typecheck": "tsc && tsc -p test/tsconfig.json",
         "lint": "eslint .",
-        "ui": "node --require ./src/node/experimental.cjs --experimental-loader ./build/loader-src.js --experimental-import-meta-resolve --enable-source-maps --watch ./util/ui.ts",
-        "try": "node --require ./src/node/experimental.cjs --experimental-loader ./build/loader-src.js --experimental-import-meta-resolve --enable-source-maps ./util/link.tsx"
+        "ui": "node --require ./src/node/experimental.cjs --experimental-loader ./build/loader-src.js --experimental-import-meta-resolve --enable-source-maps --watch ./util/ui.ts"
     },
     "files": [
         "dist"

src/error/GitHubResolver.ts

@@ -15,44 +15,65 @@ export class GitHubResolver implements SourceLocationResolver {
                 this.workspaceUrl += '/'
             }
         }
-        if (GITHUB_SHA && GITHUB_REPOSITORY && GITHUB_SERVER_URL) {
-            this.resolvedWorkspaceUrl = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/blob/${GITHUB_SHA}/`
-        }
     }
 
     protected workspaceUrl?: string
-    protected resolvedWorkspaceUrl?: string
+    protected resolvedWorkspaceUrl?: Promise<string>
     protected treeObjects?: Promise<string[]>
 
     async resolve(loc: SourceLocation): Promise<SourceLocation | undefined> {
-        if (!this.workspaceUrl || !this.resolvedWorkspaceUrl || !loc.file?.startsWith(this.workspaceUrl)) {
+        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: this.resolvedWorkspaceUrl + path + (loc.position ? `#L${loc.position.line}` : ''),
+                url: resolvedUrl + '/' + path + (loc.position ? `#L${loc.position.line}` : ''),
             }
         }
     }
 
-    protected getGitTreeObjects(): Promise<string[]> {
+    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', [
-                'ls-tree',
-                '--name-only',
-                '-r',
-                'HEAD',
-            ], {
+            const child = spawn('git', args, {
                 cwd: this.GITHUB_WORKSPACE,
                 stdio: ['ignore', 'pipe', 'pipe'],
             })
@@ -65,10 +86,9 @@ export class GitHubResolver implements SourceLocationResolver {
             })
             child.on('exit', (code, signal) => {
                 if (code || signal) {
-                    rej(`Could not list tree objects:\n` + err)
+                    rej(`Git command failed: ${JSON.stringify(args)}\n` + err)
                 } else {
-                    const list = out.split('\n')
-                    res(list)
+                    res(out.trimEnd())
                 }
             })
         })

src/error/XError.ts

@@ -117,9 +117,9 @@ export class StackEntry {
 
         const pos = e.position ? `:${e.position.line}:${e.position.column}` : ''
         if (useUrl && e.url && e.name) {
-            return `${e.name} (${e.url}${pos})`
+            return `${e.name} (${e.url})`
         } else if (useUrl && e.url) {
-            return `${e.url}${pos}`
+            return `${e.url}`
         } else if (e.name && e.file) {
             return `${e.name} (${e.file}${pos})`
         } else if (e.file) {

src/ui/cli/Error.tsx

@@ -4,7 +4,6 @@ import { useTester } from '../TesterContext'
 import { useSubscribers } from './useSubscribers'
 import { Text } from 'ink'
 import { Block, Line } from './Blocks'
-import { Link } from './Link'
 
 export function StackEntryText({
     entry,
@@ -17,14 +16,12 @@ export function StackEntryText({
     ], [entry])
     tester.resolveErrorStackEntry(entry)
 
-    const {url} = entry.resolved.get()
+    // 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 `}
-        {url
-            ? <Link url={url}>{String(entry)}</Link>
-            : String(entry)
-        }
+        {`at ${entry.toString(true)}`}
     </Text>
 }