fix: handle the case when the access token is invalid

Previously, the extension would get stuck if the provided access token
was invalid. Now, the extension prompts the user to update the access
token if it's invalid.

Author: olafurpg

src/queries/graphqlQuery.ts

@@ -3,7 +3,7 @@ import { CancellationToken } from 'vscode'
 import { log } from '../log'
 import { debugEnabledSetting } from '../settings/debugEnabledSetting'
 import { endpointHostnameSetting, endpointSetting } from '../settings/endpointSetting'
-import { accessTokenSetting } from '../settings/accessTokenSetting'
+import { accessTokenSetting, promptUserForAccessTokenSetting } 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))
@@ -31,38 +31,53 @@ export function graphqlQueryWithAccessToken<A, B>(
                 'Content-Length': data.length,
             },
         }
+        const curlCommand = (): string => {
+            const data: string = JSON.stringify({ query: query.replace(/\s+/g, '  '), variables })
+            return `curl -H 'Authorization: token ${accessToken}' -d '${data}' ${endpointSetting()}/.api/graphql`
+        }
+        const onReject = async (error: any) => {
+            if (error === 'Invalid access token.\n') {
+                // Prompt the user to update the access token setting and try again with the new setting.
+                try {
+                    const newToken = await promptUserForAccessTokenSetting('Invalid Sourcegraph Access Token')
+                    const newResult = await graphqlQueryWithAccessToken<A, B>(query, variables, token, newToken)
+                    resolve(newResult)
+                } catch (newError) {
+                    reject(newError)
+                }
+            } else {
+                reject(error)
+            }
+        }
         const req = request(options, res => {
             const body: Uint8Array[] = []
             res.on('data', json => {
                 body.push(json)
             })
-            res.on('error', reject)
+            res.on('error', onReject)
             const onClose = () => {
+                const json = Buffer.concat(body).toString()
                 if (res.statusCode === 200) {
                     try {
-                        const json = Buffer.concat(body).toString()
                         const parsed: B = JSON.parse(json)
                         resolve(parsed)
                     } catch (error) {
-                        log.error(`graphql(${data})`, error)
-                        reject(error)
+                        log.error(`graphql(${curlCommand()})`, error)
+                        onReject(error)
                     }
                 } else {
-                    log.error(`graphql(${data}), statusCode=${res.statusCode}`, body)
-                    reject(body.join(''))
+                    log.error(`graphql(${curlCommand()}), statusCode=${res.statusCode}`, json)
+                    onReject(json)
                 }
             }
             res.on('close', onClose)
             res.on('end', onClose)
         })
-        req.on('error', reject)
+        req.on('error', onReject)
         req.write(data)
         req.end()
         if (debugEnabledSetting()) {
-            const data: string = JSON.stringify({ query: query.replace(/\s+/g, '  '), variables })
-            log.appendLine(
-                `curl -H 'Authorization: token ${accessToken}' -d '${data}' ${endpointSetting()}/.api/graphql`
-            )
+            log.appendLine(curlCommand())
         }
         token.onCancellationRequested(() => {
             req.destroy()

src/settings/accessTokenSetting.ts

@@ -8,18 +8,30 @@ import { readConfiguration } from './readConfiguration'
 let cachedAccessToken: Promise<string> | undefined
 
 export function accessTokenSetting(): Promise<string> {
+    const fromSettings = readConfiguration().get<string>('accessToken', '')
+    if (fromSettings) {
+        return Promise.resolve(fromSettings)
+    }
+
     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)
+    return promptUserForAccessTokenSetting()
+}
+
+export async function deleteAccessTokenSetting(tokenValueToDelete: string): Promise<void> {
+    const currentValue = readConfiguration().get<string>('accessToken')
+    if (currentValue === tokenValueToDelete) {
+        cachedAccessToken = undefined
+        await readConfiguration().update('accessToken', undefined)
     }
+}
 
+export async function promptUserForAccessTokenSetting(title?: string): Promise<string> {
     if (!cachedAccessToken) {
-        cachedAccessToken = askUserToCreateAccessToken()
+        cachedAccessToken = unconditionallyPromptUserForAccessTokenSetting(title)
         cachedAccessToken.then(
             () => {},
             error => {
@@ -30,36 +42,42 @@ export function accessTokenSetting(): Promise<string> {
     }
     return cachedAccessToken
 }
-
-async function askUserToCreateAccessToken(): Promise<string> {
+async function unconditionallyPromptUserForAccessTokenSetting(title?: string): Promise<string> {
     const openBrowserMessage = 'Open browser to create an access token'
     const learnMore = 'Learn more about access tokens'
+    const pasteAccessToken = 'Paste existing access token'
     const userChoice = await vscode.window.showErrorMessage(
-        'Missing Sourcegraph Access Token',
+        title || '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
+        learnMore,
+        pasteAccessToken
     )
-    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)
+    if (userChoice) {
+        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}'`)
+                const successMessage = `Successfully logged into Sourcegraph as user '${currentUser}'`
+                log.appendLine(successMessage)
+                await vscode.window.showInformationMessage(successMessage)
                 await readConfiguration().update('accessToken', token, vscode.ConfigurationTarget.Global)
+                cachedAccessToken = undefined
                 return token
             } catch {
                 await vscode.window.showErrorMessage(
@@ -74,3 +92,7 @@ async function askUserToCreateAccessToken(): Promise<string> {
     }
     throw new Error('No access token')
 }
+
+export async function updateAccessTokenSetting(newValue?: string): Promise<void> {
+    await readConfiguration().update('accessToken', newValue)
+}