feat: token creation callback page (#35826)

Co-authored-by: TJ Kandala <[email protected]>
Co-authored-by: Stephen Gutekanst <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -50,6 +50,7 @@ All notable changes to Sourcegraph are documented in this file.
 - Batch Changes are now supported on [Bitbucket Cloud](https://bitbucket.org/). [#24199](https://github.com/sourcegraph/sourcegraph/issues/24199)
 - Pings for server-side batch changes [#34308](https://github.com/sourcegraph/sourcegraph/pull/34308)
 - Indexed search will detect when it is misconfigured and has multiple replicas writing to the same directory. [#35513](https://github.com/sourcegraph/sourcegraph/pull/35513)
+- A new token creation callback feature that sends a token back to a trusted program automatically after the user has signed in [#35339](https://github.com/sourcegraph/sourcegraph/pull/35339)
 
 ### Changed
 

client/vscode/CHANGELOG.md

@@ -7,10 +7,12 @@ The Sourcegraph extension uses major.EVEN_NUMBER.patch (eg. 2.0.1) for release v
 ### Changes
 
 - Update Access Token headers setting method --thanks @ptxmac for the contribution! [issues/34338](https://github.com/sourcegraph/sourcegraph/issues/34338)
+- Add ability to import Sourcegraph Access token automatically after logging in on Sourcegraph Cloud [issues/28311](https://github.com/sourcegraph/sourcegraph/issues/28311)
 
 ### Fixes
 
 - Windows file path issue [issues/34788](https://github.com/sourcegraph/sourcegraph/issues/34788)
+- Sourcegraph icon in help sidebar now shows on light theme [issues/35672](https://github.com/sourcegraph/sourcegraph/issues/35672)
 
 ## 2.2.2
 

client/vscode/src/backend/instanceVersion.ts

@@ -12,30 +12,38 @@ import { requestGraphQLFromVSCode } from './requestGraphQl'
  * This function will return the EventSource Type based
  * on the instance version
  */
-export function initializeInstantVersionNumber(localStorageService: LocalStorageService): EventSource {
-    requestGraphQLFromVSCode<SiteVersionResult>(siteVersionQuery, {})
-        .then(async siteVersionResult => {
-            if (siteVersionResult.data) {
-                // assume instance version longer than 8 is using insider version
-                const flattenVersion =
-                    siteVersionResult.data.site.productVersion.length > 8
-                        ? '999999'
-                        : siteVersionResult.data.site.productVersion.split('.').join('')
-                if (flattenVersion < '3320') {
-                    displayWarning(
-                        'Your Sourcegraph instance version is not fully compatible with the Sourcegraph extension. Please ask your site admin to upgrade to version 3.32.0 or above. Read more about version support in our [troubleshooting docs](https://docs.sourcegraph.com/admin/how-to/troubleshoot-sg-extension#unsupported-features-by-sourcegraph-version).'
-                    ).catch(() => {})
+export function initializeInstanceVersionNumber(
+    localStorageService: LocalStorageService,
+    instanceURL: string,
+    accessToken: string | undefined
+): EventSource {
+    // Check only if a user is trying to connect to a private instance with a valid access token provided
+    if (instanceURL !== 'https://sourcegraph.com' && accessToken) {
+        requestGraphQLFromVSCode<SiteVersionResult>(siteVersionQuery, {})
+            .then(async siteVersionResult => {
+                if (siteVersionResult.data) {
+                    // assume instance version longer than 8 is using insider version
+                    const flattenVersion =
+                        siteVersionResult.data.site.productVersion.length > 8
+                            ? '999999'
+                            : siteVersionResult.data.site.productVersion.split('.').join('')
+                    if (flattenVersion < '3320') {
+                        displayWarning(
+                            'Your Sourcegraph instance version is not fully compatible with the Sourcegraph extension. Please ask your site admin to upgrade to version 3.32.0 or above. Read more about version support in our [troubleshooting docs](https://docs.sourcegraph.com/admin/how-to/troubleshoot-sg-extension#unsupported-features-by-sourcegraph-version).'
+                        ).catch(() => {})
+                    }
+                    await localStorageService.setValue(INSTANCE_VERSION_NUMBER_KEY, flattenVersion)
                 }
-                await localStorageService.setValue(INSTANCE_VERSION_NUMBER_KEY, flattenVersion)
-            }
-        })
-        .catch(error => {
-            console.error('Failed to get instance version from host:', error)
-            displayWarning('Cannot determine instance version number').catch(() => {})
-        })
-    const versionNumber = localStorageService.getValue(INSTANCE_VERSION_NUMBER_KEY)
-    // instances below 3.38.0 does not support EventSource.IDEEXTENSION and should fallback to BACKEND source
-    return versionNumber >= '3380' ? EventSource.IDEEXTENSION : EventSource.BACKEND
+            })
+            .catch(error => {
+                console.error('Failed to get instance version from host:', error)
+                displayWarning('Cannot determine instance version number').catch(() => {})
+            })
+        const versionNumber = localStorageService.getValue(INSTANCE_VERSION_NUMBER_KEY)
+        // instances below 3.38.0 does not support EventSource.IDEEXTENSION and should fallback to BACKEND source
+        return versionNumber >= '3380' ? EventSource.IDEEXTENSION : EventSource.BACKEND
+    }
+    return EventSource.IDEEXTENSION
 }
 
 const siteVersionQuery = gql`

client/vscode/src/backend/requestGraphQl.ts

@@ -47,6 +47,7 @@ export const requestGraphQLFromVSCode = async <R, V = object>(
                     query: request,
                     variables,
                 }),
+                credentials: 'include',
                 method: 'POST',
                 headers,
             })

client/vscode/src/common/links.ts

@@ -0,0 +1,59 @@
+/**
+ * All Sourcegraph Cloud related links
+ */
+// MAIN
+const VSCE_CALLBACK_CODE = 'VSCEAUTH'
+export const VSCE_LINK_DOTCOM = 'https://sourcegraph.com'
+export const VSCE_LINK_TOKEN_CALLBACK =
+    'https://sourcegraph.com/sign-in?returnTo=user/settings/tokens/new/callback?requestFrom=VSCEAUTH'
+export const VSCE_LINK_TOKEN_CALLBACK_TEST =
+    'https://sourcegraph.test:3443/sign-in?returnTo=user/settings/tokens/new/callback?requestFrom=VSCEAUTH'
+
+// PARAMS
+export const VSCE_SIDEBAR_PARAMS = '?utm_medium=VSCODE&utm_source=sidebar&utm_campaign=vsce-sign-up&utm_content=sign-up'
+const VSCE_LINK_PARAMS_TOKEN_REDIRECT = {
+    returnTo: `user/settings/tokens/new/callback?requestFrom=${VSCE_CALLBACK_CODE}`,
+}
+const VSCE_LINK_PARAMS_EDITOR = { editor: 'vscode' }
+// UTM for Commands
+const VSCE_LINK_PARAMS_UTM_COMMANDS = {
+    utm_campaign: 'vscode-extension',
+    utm_medium: 'direct_traffic',
+    utm_source: 'vscode-extension',
+    utm_content: 'vsce-commands',
+}
+// UTM for Sidebar actions
+const VSCE_LINK_PARAMS_UTM_SIDEBAR = {
+    utm_campaign: 'vsce-sign-up',
+    utm_medium: 'VSCODE',
+    utm_source: 'sidebar',
+    utm_content: 'sign-up',
+}
+export const VSCE_COMMANDS_PARAMS = new URLSearchParams({ ...VSCE_LINK_PARAMS_UTM_COMMANDS }).toString()
+
+// MISC
+export const VSCE_LINK_MARKETPLACE = 'https://marketplace.visualstudio.com/items?itemName=sourcegraph.sourcegraph'
+export const VSCE_LINK_USER_DOCS =
+    'https://docs.sourcegraph.com/cli/how-tos/creating_an_access_token' + VSCE_SIDEBAR_PARAMS
+export const VSCE_LINK_FEEDBACK = 'https://github.com/sourcegraph/sourcegraph/discussions/categories/feedback'
+export const VSCE_LINK_ISSUES =
+    'https://github.com/sourcegraph/sourcegraph/issues/new?labels=team/integrations,vscode-extension&title=VSCode+Bug+report:+&projects=Integrations%20Project%20Board'
+export const VSCE_LINK_TROUBLESHOOT =
+    'https://docs.sourcegraph.com/admin/how-to/troubleshoot-sg-extension#vs-code-extension'
+export const VSCE_SG_LOGOMARK_LIGHT =
+    'https://raw.githubusercontent.com/sourcegraph/sourcegraph/fd431743e811ba756490e5e7bd88aa2362b6453e/client/vscode/images/logomark_light.svg'
+export const VSCE_SG_LOGOMARK_DARK =
+    'https://raw.githubusercontent.com/sourcegraph/sourcegraph/2636c64c9f323d78281a68dd4bdf432d9a97835a/client/vscode/images/logomark_dark.svg'
+
+// Generate sign-in and sign-up links using the above params
+export const VSCE_LINK_AUTH = (mode: 'sign-in' | 'sign-up'): string => {
+    const uri = new URL(VSCE_LINK_DOTCOM)
+    const parameters = new URLSearchParams({
+        ...VSCE_LINK_PARAMS_UTM_SIDEBAR,
+        ...VSCE_LINK_PARAMS_EDITOR,
+        ...VSCE_LINK_PARAMS_TOKEN_REDIRECT,
+    }).toString()
+    uri.pathname = mode
+    uri.search = parameters
+    return uri.href
+}

client/vscode/src/contract.ts

@@ -56,15 +56,23 @@ export interface ExtensionCoreAPI {
      * Used to send current query from panel to sidebar.
      */
     setSidebarQueryState: (queryState: VSCEQueryState) => void
-
+    /**
+     * Local Storage Item
+     */
     getLocalStorageItem: (key: string) => string
     setLocalStorageItem: (key: string, value: string) => Promise<boolean>
-
-    // For Telemetry Service
+    /**
+     * For Telemetry Service / logging
+     */
     logEvents: (variables: Event) => void
-
-    // Get EventSource Type to use based on instance version
+    /**
+     * Get EventSource Type to use based on instance version
+     */
     getEventSource: EventSource
+    /**
+     * Get EventSource Type to use based on instance version
+     */
+    getEditorTheme: string
 }
 
 export interface SearchPanelAPI {

client/vscode/src/extension.ts

@@ -9,7 +9,7 @@ import { fetchStreamSuggestions } from '@sourcegraph/shared/src/search/suggestio
 
 import { observeAuthenticatedUser } from './backend/authenticatedUser'
 import { logEvent } from './backend/eventLogger'
-import { initializeInstantVersionNumber } from './backend/instanceVersion'
+import { initializeInstanceVersionNumber } from './backend/instanceVersion'
 import { requestGraphQLFromVSCode } from './backend/requestGraphQl'
 import { initializeSearchContexts } from './backend/searchContexts'
 import { initializeSourcegraphSettings } from './backend/sourcegraphSettings'
@@ -63,14 +63,14 @@ export function activate(context: vscode.ExtensionContext): void {
     const stateMachine = createVSCEStateMachine({ localStorageService })
     invalidateContextOnSettingsChange({ context, stateMachine })
     initializeSearchContexts({ localStorageService, stateMachine, context })
-    const eventSourceType = initializeInstantVersionNumber(localStorageService)
     const sourcegraphSettings = initializeSourcegraphSettings({ context })
     const authenticatedUser = observeAuthenticatedUser({ context })
     const initialInstanceURL = endpointSetting()
-
+    const initialAccessToken = accessTokenSetting()
+    const editorTheme = vscode.ColorThemeKind[vscode.window.activeColorTheme.kind]
+    const eventSourceType = initializeInstanceVersionNumber(localStorageService, initialInstanceURL, initialAccessToken)
     // Sets global `EventSource` for Node, which is required for streaming search.
     // Used for VS Code web as well to be able to add Authorization header.
-    const initialAccessToken = accessTokenSetting()
     // Add custom headers to `EventSource` Authorization header when provided
     const customHeaders = endpointRequestHeadersSetting()
     polyfillEventSource(initialAccessToken ? { Authorization: `token ${initialAccessToken}`, ...customHeaders } : {})
@@ -132,8 +132,8 @@ export function activate(context: vscode.ExtensionContext): void {
         setLocalStorageItem: (key: string, value: string) => localStorageService.setValue(key, value),
         logEvents: (variables: Event) => logEvent(variables),
         getEventSource: eventSourceType,
+        getEditorTheme: editorTheme,
     }
-
     // Also initializes code intel.
     registerWebviews({
         context,

client/vscode/src/link-commands/initialize.ts

@@ -4,6 +4,7 @@ import { EventSource } from '@sourcegraph/shared/src/graphql-operations'
 
 import { version } from '../../package.json'
 import { logEvent } from '../backend/eventLogger'
+import { VSCE_COMMANDS_PARAMS } from '../common/links'
 import { SourcegraphUri } from '../file-system/SourcegraphUri'
 import { LocalStorageService, ANONYMOUS_USER_ID_KEY } from '../settings/LocalStorageService'
 
@@ -56,8 +57,7 @@ export function initializeCodeSharingCommands(
     }
 }
 
-export const vsceUtms =
-    '&utm_campaign=vscode-extension&utm_medium=direct_traffic&utm_source=vscode-extension&utm_content=vsce-commands'
+export const vsceUtms = '&' + VSCE_COMMANDS_PARAMS
 
 export function generateSourcegraphBlobLink(
     uri: vscode.Uri,

client/vscode/src/settings/accessTokenSetting.ts

@@ -26,6 +26,7 @@ export async function handleAccessTokenError(badToken?: string): Promise<void> {
 }
 
 export async function updateAccessTokenSetting(newToken: string): Promise<boolean> {
+    // TODO: STORE TOKEN IN KEYCHAIN AND REMOVE FROM USER CONFIG
     try {
         await readConfiguration().update('accessToken', newToken, vscode.ConfigurationTarget.Global)
         return true

client/vscode/src/webview/commands.ts

@@ -37,6 +37,26 @@ export function registerWebviews({
     // TODO if remote files are open from previous session, we need
     // to focus search sidebar to activate code intel (load extension host)
 
+    // Register URI Handler to resolve data sending back from Browser
+    const handleUri = async (uri: vscode.Uri): Promise<void> => {
+        const token = new URLSearchParams(uri.query).get('code')
+        // const returnedNonce = new URLSearchParams(uri.query).get('nonce')
+        // TODO: Decrypt token
+        // TODO: Match returnedNonce to stored nonce
+        if (token && token.length > 8) {
+            await vscode.workspace
+                .getConfiguration('sourcegraph')
+                .update('accessToken', token, vscode.ConfigurationTarget.Global)
+            await vscode.window.showInformationMessage('Token has been retreived and updated successfully')
+        }
+    }
+
+    context.subscriptions.push(
+        vscode.window.registerUriHandler({
+            handleUri,
+        })
+    )
+
     // Open Sourcegraph search tab on `sourcegraph.search` command.
     context.subscriptions.push(
         vscode.commands.registerCommand('sourcegraph.search', async () => {

client/vscode/src/webview/search-panel/SearchResultsView.tsx

@@ -25,6 +25,7 @@ import { LATEST_VERSION, RepositoryMatch, SearchMatch } from '@sourcegraph/share
 import { globbingEnabledFromSettings } from '@sourcegraph/shared/src/util/globbing'
 import { buildSearchURLQuery } from '@sourcegraph/shared/src/util/url'
 
+import { VSCE_LINK_AUTH } from '../../common/links'
 import { DISMISS_SEARCH_CTA_KEY } from '../../settings/LocalStorageService'
 import { SearchResultsState } from '../../state'
 import { WebviewPageProps } from '../platform/context'
@@ -392,8 +393,7 @@ export const SearchResultsView: React.FunctionComponent<React.PropsWithChildren<
                 searches and more."
                             cta={{
                                 label: 'Get started',
-                                href:
-                                    'https://sourcegraph.com/sign-up?editor=vscode&utm_medium=VSCODE&utm_source=sidebar&utm_campaign=vsce-sign-up&utm_content=sign-up',
+                                href: VSCE_LINK_AUTH('sign-up'),
                                 onClick: onSignUpClick,
                             }}
                             icon={<SearchBetaIcon />}