feat: prompt user to create an access token if it's missing

Author: olafurpg

package.json

@@ -198,6 +198,13 @@
           "default": "https://sourcegraph.com",
           "description": "The base URL of the Sourcegraph instance to use."
         },
+        "sourcegraph.accessToken": {
+          "type": [
+            "string"
+          ],
+          "default": "",
+          "description": "The access token to query the Sourcegraph API. Create a new access token at https://sourcegraph.com/users/settings/tokens"
+        },
         "sourcegraph.remoteUrlReplacements": {
           "type": [
             "object"

src/commands/searchSelectionCommand.ts

@@ -1,3 +1,4 @@
+import open from 'open'
 import * as vscode from 'vscode'
 import { repoInfo } from '../git'
 import { endpointSetting } from '../settings/endpointSetting'
@@ -22,7 +23,7 @@ export async function searchSelectionCommand(extensionVersion: string): Promise<
     }
 
     // Search in browser.
-    open(
+    await open(
         `${endpointSetting()}/-/editor` +
             `?remote_url=${encodeURIComponent(remoteURL)}` +
             `&branch=${encodeURIComponent(branch)}` +

src/file-system/SourcegraphFileSystemProvider.ts

@@ -40,22 +40,12 @@ export class SourcegraphFileSystemProvider implements vscode.FileSystemProvider
     private didChangeFile = new vscode.EventEmitter<vscode.FileChangeEvent[]>() // Never used.
     public readonly onDidChangeFile: vscode.Event<vscode.FileChangeEvent[]> = this.didChangeFile.event
     public async stat(uri: vscode.Uri): Promise<vscode.FileStat> {
-        try {
-            const blob = await this.fetchBlob(this.sourcegraphUri(uri))
-            return {
-                mtime: blob.time,
-                ctime: blob.time,
-                size: blob.byteSize,
-                type: blob.type,
-            }
-        } catch {
-            const time = new Date().getMilliseconds()
-            return {
-                mtime: time,
-                ctime: time,
-                size: 0,
-                type: vscode.FileType.Directory,
-            }
+        const blob = await this.fetchBlob(this.sourcegraphUri(uri))
+        return {
+            mtime: blob.time,
+            ctime: blob.time,
+            size: blob.byteSize,
+            type: blob.type,
         }
     }
 
@@ -76,7 +66,7 @@ export class SourcegraphFileSystemProvider implements vscode.FileSystemProvider
         const children = tree.directChildren(uri.path || '')
         return children.map(childUri => {
             const child = SourcegraphUri.parse(childUri)
-            const type = child.isDirectory() ? vscode.FileType.Directory : vscode.FileType.File
+            const type = child.isDirectory ? vscode.FileType.Directory : vscode.FileType.File
             return [child.basename(), type]
         })
     }

src/file-system/SourcegraphUri.ts

@@ -11,7 +11,8 @@ export class SourcegraphUri {
         public readonly repositoryName: string,
         public readonly revision: string | undefined,
         public readonly path: string | undefined,
-        public readonly position: Position | undefined
+        public readonly position: Position | undefined,
+        public readonly isDirectory: boolean
     ) {}
 
     public withRevision(newRevision: string | undefined): SourcegraphUri {
@@ -49,10 +50,6 @@ export class SourcegraphUri {
         return undefined
     }
 
-    public isDirectory(): boolean {
-        return typeof this.path === 'string' && this.uri.includes('/-/tree/')
-    }
-
     public isFile(): boolean {
         return typeof this.path === 'string' && this.uri.includes('/-/blob/')
     }
@@ -68,15 +65,15 @@ export class SourcegraphUri {
         }
     ): SourcegraphUri {
         const revisionPart = optional?.revision ? `@${optional.revision}` : ''
-        const directoryPart = optional?.isDirectory ? 'tree' : 'blob'
-        const pathPart = optional?.path ? `/-/${directoryPart}/${optional?.path}` : ''
+        const pathPart = optional?.path ? `/-/blob/${optional?.path}` : ''
         return new SourcegraphUri(
             `sourcegraph://${host}/${repositoryName}${revisionPart}${pathPart}`,
             host,
             repositoryName,
             optional?.revision,
             optional?.path,
-            optional?.position
+            optional?.position,
+            optional?.isDirectory || false
         )
     }
     public repositoryUri(): string {

src/queries/currentUserQuery.ts

@@ -0,0 +1,25 @@
+import { emptyCancelationToken } from '../file-system/emptyCancelationToken'
+import { graphqlQueryWithAccessToken } from './graphqlQuery'
+
+export async function currentUserQuery(accessToken: string): Promise<string> {
+    const result = await graphqlQueryWithAccessToken<CurrentUserParameters, CurrentUserResult>(
+        'query { currentUser { username }}',
+        {},
+        emptyCancelationToken(),
+        accessToken
+    )
+    const username = result?.data?.currentUser?.username
+    if (username) {
+        return username
+    }
+    throw new Error(`invalid access token ${accessToken}`)
+}
+
+interface CurrentUserParameters {}
+interface CurrentUserResult {
+    data?: {
+        currentUser?: {
+            username?: string
+        }
+    }
+}

src/queries/graphqlQuery.ts

@@ -3,14 +3,24 @@ import { CancellationToken } from 'vscode'
 import { log } from '../log'
 import { debugEnabledSetting } from '../settings/debugEnabledSetting'
 import { endpointHostnameSetting } from '../settings/endpointSetting'
+import { accessTokenSetting } from '../settings/accessTokenSetting'
 
 export function graphqlQuery<A, B>(query: string, variables: A, token: CancellationToken): Promise<B | undefined> {
+    return accessTokenSetting().then(accessToken => graphqlQueryWithAccessToken(query, variables, token, accessToken))
+}
+
+export function graphqlQueryWithAccessToken<A, B>(
+    query: string,
+    variables: A,
+    token: CancellationToken,
+    accessToken: string
+): Promise<B | undefined> {
+    log.appendLine(`accessToken ${accessToken}`)
     return new Promise<B | undefined>((resolve, reject) => {
         const data = JSON.stringify({
             query,
             variables,
         })
-        const accessToken = process.env.SRC_ACCESS_TOKEN || ''
         const options: RequestOptions = {
             hostname: endpointHostnameSetting(),
             port: 443,

src/settings/accessTokenSetting.ts

@@ -0,0 +1,76 @@
+import open from 'open'
+import * as vscode from 'vscode'
+import { log } from '../log'
+import { currentUserQuery } from '../queries/currentUserQuery'
+import { endpointSetting } from './endpointSetting'
+import { readConfiguration } from './readConfiguration'
+
+let cachedAccessToken: Promise<string> | undefined
+
+export function accessTokenSetting(): Promise<string> {
+    const environmentVariable = process.env.SRC_ACCESS_TOKEN
+    if (environmentVariable) {
+        return Promise.resolve(environmentVariable)
+    }
+
+    const fromSettings = readConfiguration().get<string>('accessToken', '')
+    if (fromSettings) {
+        return Promise.resolve(fromSettings)
+    }
+
+    if (!cachedAccessToken) {
+        cachedAccessToken = askUserToCreateAccessToken()
+        cachedAccessToken.then(
+            () => {},
+            error => {
+                log.error('askUserToCreateAccessToken', error)
+                cachedAccessToken = undefined
+            }
+        )
+    }
+    return cachedAccessToken
+}
+
+async function askUserToCreateAccessToken(): Promise<string> {
+    const openBrowserMessage = 'Open browser to create an access token'
+    const learnMore = 'Learn more about access tokens'
+    const userChoice = await vscode.window.showErrorMessage(
+        'Missing Sourcegraph Access Token',
+        {
+            modal: true,
+            detail: 'An access token is required to use the Sourcegraph extension. To fix this problem, create a new access token on the Sourcegraph website or set the $SRC_ACCESS_TOKEN environment variable and restart VS Code.',
+        },
+        openBrowserMessage,
+        learnMore
+    )
+    const openUrl =
+        userChoice === openBrowserMessage
+            ? `${endpointSetting()}/user/settings/tokens`
+            : userChoice === learnMore
+            ? 'https://docs.sourcegraph.com/cli/how-tos/creating_an_access_token'
+            : undefined
+    if (openUrl) {
+        await open(openUrl)
+        const token = await vscode.window.showInputBox({
+            title: 'Paste your Sourcegraph access token here',
+            ignoreFocusOut: true,
+        })
+        if (token) {
+            try {
+                const currentUser = await currentUserQuery(token)
+                log.appendLine(`Logged in successfully as '${currentUser}'`)
+                await readConfiguration().update('accessToken', token, vscode.ConfigurationTarget.Global)
+                return token
+            } catch {
+                await vscode.window.showErrorMessage(
+                    "Invalid Access Token. To fix this problem, update the 'sourcegraph.accessToken' setting and try again"
+                )
+            }
+        } else {
+            log.error('askUserToCreateAccessToken - The user provided an empty access token')
+        }
+    } else {
+        log.error('askUserToCreateAccessToken - The user decided not to open the browser')
+    }
+    throw new Error('No access token')
+}