fix: render repository results in search notebooks

Author: olafurpg

src/queries/graphqlQuery.ts

@@ -30,7 +30,6 @@ export function graphqlQueryWithAccessToken<A, B>(
         const headers: any = {
             'Content-Length': data.length,
         }
-        log.appendLine(`token: ${accessToken || 'undefined'}`)
         if (accessToken) {
             headers.Authorization = `token ${accessToken}`
         }

src/queries/searchQuery.ts

@@ -10,32 +10,82 @@ export function searchQueryResult(
 ): Promise<SearchResult | undefined> {
     return graphqlQuery<SearchParameters, SearchResult>(
         gql`
-            query Search($query: String!) {
-                search(query: $query, patternType: ${SearchPatternType[patternType]}) {
+            query ($query: String!) {
+                search(query: $query) {
                     results {
                         results {
+                            __typename
                             ... on FileMatch {
                                 ...FileMatchFields
                             }
+                            ... on CommitSearchResult {
+                                ...CommitSearchResultFields
+                            }
+                            ... on Repository {
+                                ...RepositoryFields
+                            }
                         }
-                        limitHit
-                        matchCount
-                        elapsedMilliseconds
+                        ...SearchResultsAlertFields
                     }
                 }
             }
-
             fragment FileMatchFields on FileMatch {
-                file {
+                repository {
+                    name
                     url
                 }
-                repository {
-                    stars
+                file {
+                    name
+                    path
+                    url
+                    content
+                    commit {
+                        oid
+                    }
                 }
                 lineMatches {
+                    preview
                     lineNumber
                     offsetAndLengths
-                    preview
+                    limitHit
+                }
+            }
+
+            fragment CommitSearchResultFields on CommitSearchResult {
+                commit {
+                    message
+                    author {
+                        person {
+                            name
+                        }
+                    }
+                }
+                matches {
+                    url
+                    body {
+                        text
+                    }
+                    highlights {
+                        character
+                        line
+                        length
+                    }
+                }
+            }
+
+            fragment RepositoryFields on Repository {
+                name
+                stars
+            }
+
+            fragment SearchResultsAlertFields on SearchResults {
+                alert {
+                    title
+                    description
+                    proposedQueries {
+                        description
+                        query
+                    }
                 }
             }
         `,
@@ -89,18 +139,37 @@ export interface SearchResult {
         }
     }
 }
-interface SearchResultNode {
+
+export interface SearchResultNode {
+    __typename: string
+    name?: string
+    stars?: number
     file?: {
         url?: string
     }
     repository?: {
         stars?: number
     }
     lineMatches?: LineMatch[]
+    matches?: CommitMatch[]
 }
 
-interface LineMatch {
+export interface LineMatch {
     lineNumber?: number
     offsetAndLengths?: [number, number][]
     preview?: string
 }
+
+export interface CommitMatch {
+    url?: string
+    body?: {
+        text?: string
+    }
+    highlights?: CommitHighlight[]
+}
+
+export interface CommitHighlight {
+    character?: number
+    line?: number
+    length?: number
+}

src/search/SourcegraphNotebookSerializer.ts

@@ -28,6 +28,9 @@ export class SourcegraphNotebookSerializer implements vscode.NotebookSerializer
             const uriString: unknown = event.message?.uri
             if (event.message?.request === 'openEditor' && typeof uriString === 'string') {
                 let uri = SourcegraphUri.parse(uriString)
+                if (!uri.path) {
+                    uri = await fs.defaultFileUri(uri.repositoryName)
+                }
                 if (!uri.revision) {
                     uri = uri.withRevision((await fs.repositoryMetadata(uri.repositoryName))?.defaultBranch)
                 }

src/search/searchHtml.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode'
 import { SearchPatternType } from './scanner'
-import { searchQueryResult } from '../queries/searchQuery'
+import { searchQueryResult, SearchResultNode } from '../queries/searchQuery'
 
 export async function searchHtml(
     host: string,
@@ -12,70 +12,111 @@ export async function searchHtml(
     const html: string[] = []
     const nodes = result?.data?.search?.results?.results
     for (const node of nodes || []) {
-        const url = node?.file?.url
-        if (!url) {
+        formatFileMatch(host, node, html)
+        formatRepository(host, node, html)
+        formatCommit(host, node, html)
+    }
+    return html.join('')
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function formatCommit(host: string, node: SearchResultNode, html: string[]): void {
+    if (node.__typename !== 'CommitSearchResult') {
+        return
+    }
+    // Not supported
+}
+
+function formatRepository(host: string, node: SearchResultNode, html: string[]): void {
+    if (node.__typename !== 'Repository') {
+        return
+    }
+    if (!node.name) {
+        return
+    }
+    const url = `sourcegraph://${host}/${node.name}`
+    const stars = formatStars(node.stars)
+    html.push('<p>')
+    html.push(
+        `<code><a style='cursor:pointer' class='sourcegraph-location' id="${url}">${node.name}</a>${stars}</code>`
+    )
+    html.push('</p>')
+}
+
+function formatFileMatch(host: string, node: SearchResultNode, html: string[]): void {
+    if (node.__typename !== 'FileMatch') {
+        return
+    }
+    const url = node?.file?.url
+    if (!url) {
+        return
+    }
+    const lineMatches = node.lineMatches || []
+    if (lineMatches.length === 0) {
+        return
+    }
+    let first = true
+    let filenameMatchesCount = 0
+    for (const [lineMatchIndex, lineMatch] of lineMatches.entries()) {
+        const line = lineMatch.lineNumber
+        if (!line) {
             continue
         }
-        const starCount = node?.repository?.stars
-        const stars = starCount ? ` ⭐ ${formatStarCount(starCount)}` : ''
-        const lineMatches = node.lineMatches || []
-        if (lineMatches.length === 0) {
+        const preview = lineMatch.preview
+        if (!preview) {
             continue
         }
-        let first = true
-        let filenameMatchesCount = 0
-        for (const [lineMatchIndex, lineMatch] of lineMatches.entries()) {
-            const line = lineMatch.lineNumber
-            if (!line) {
-                continue
-            }
-            const preview = lineMatch.preview
-            if (!preview) {
-                continue
-            }
-            let index = 0
-            const highlightedPreview: string[] = []
-            if (lineMatchIndex > 0) {
-                highlightedPreview.push('\n')
-            }
-            highlightedPreview.push(`L${line}: `)
-            let character = 0
-            for (const offsetsAndLength of lineMatch.offsetAndLengths || []) {
-                const [start, length] = offsetsAndLength
-                if (!character) {
-                    // Position the cursor at the first match on the line.
-                    character = start
-                }
-                const end = start + length
-                highlightedPreview.push(escapeHtml(preview.slice(index, start)))
-                highlightedPreview.push('<mark>')
-                highlightedPreview.push(escapeHtml(preview.slice(start, end)))
-                highlightedPreview.push('</mark>')
-                index = end
-            }
-            highlightedPreview.push(escapeHtml(preview.slice(index, preview.length)))
-            if (first) {
-                first = false
-                html.push('<p>')
-                html.push(`<code>${url}${stars}</code>`)
-                html.push('<pre>')
-            }
-            const uri = `sourcegraph://${host}${url}?L${line + 1}:${character}`
-            html.push(
-                `<a id='${uri}' style='cursor:pointer' class='sourcegraph-location'>${highlightedPreview.join('')}</a>`
-            )
-            filenameMatchesCount++
-            if (filenameMatchesCount > 5) {
-                break
+        let index = 0
+        const highlightedPreview: string[] = []
+        if (lineMatchIndex > 0) {
+            highlightedPreview.push('\n')
+        }
+        highlightedPreview.push(`L${line}: `)
+        let character = 0
+        for (const offsetsAndLength of lineMatch.offsetAndLengths || []) {
+            const [start, length] = offsetsAndLength
+            if (!character) {
+                // Position the cursor at the first match on the line.
+                character = start
             }
+            const end = start + length
+            highlightedPreview.push(escapeHtml(preview.slice(index, start)))
+            highlightedPreview.push('<mark>')
+            highlightedPreview.push(escapeHtml(preview.slice(start, end)))
+            highlightedPreview.push('</mark>')
+            index = end
+        }
+        highlightedPreview.push(escapeHtml(preview.slice(index, preview.length)))
+        if (first) {
+            first = false
+            html.push('<p>')
+            html.push(`<code>${url}${formatStars(node?.repository?.stars)}</code>`)
+            html.push('<pre>')
+        }
+        const uri = `sourcegraph://${host}${url}?L${line + 1}:${character}`
+        html.push(
+            `<a id='${uri}' style='cursor:pointer' class='sourcegraph-location'>${highlightedPreview.join('')}</a>`
+        )
+        filenameMatchesCount++
+        if (filenameMatchesCount > 5) {
+            break
         }
-        html.push('</pre>')
-        html.push('</p>')
     }
-    return html.join('')
+    html.push('</pre>')
+    html.push('</p>')
 }
 
-function formatStarCount(starCount: number): string {
+function formatStars(starCount: number | undefined): string {
+    const count = formatStarCount(starCount)
+    if (count) {
+        return ` ⭐${count}`
+    }
+    return count
+}
+function formatStarCount(starCount: number | undefined): string {
+    if (!starCount) {
+        return ''
+    }
     if (starCount > 1000) {
         return `${Math.round(starCount / 1000)}k`
     }