Refactor eventlogger and use localstorage for server endpoint (#309)

* Refactor eventlogger so that the "shared" EventLogger.ts file doesn't
contain any VSCode-specific logic; move all of that to the "vscode"
event-logger.ts file instead
* Default to `localStorage.endpoint()` for server endpoint values for
logging (`config.serverEndpoint` was deprecated as of 5.1 and now just
returns an empty string in most cases)

The tsconfig updates were automatic when I compiled... If they shouldn't
be included here, please let me know!

## Test plan

* run locally
* verify payload
* test that config updates are caught

---------

Co-authored-by: Beatrix <[email protected]>

Author: dadlerj

lib/shared/src/telemetry/EventLogger.ts

@@ -1,80 +1,31 @@
-import * as vscode from 'vscode'
-
+import { ConfigurationWithAccessToken } from '../configuration'
 import { SourcegraphGraphQLAPIClient } from '../sourcegraph-api/graphql'
 
-function getServerEndpointFromConfig(config: vscode.WorkspaceConfiguration): string {
-    return config.get<string>('cody.serverEndpoint', '')
-}
-
-function getUseContextFromConfig(config: vscode.WorkspaceConfiguration): string {
-    if (!config) {
-        return ''
-    }
-    return config.get<string>('cody.useContext', '')
-}
-
-function getChatPredictionsFromConfig(config: vscode.WorkspaceConfiguration): boolean {
-    if (!config) {
-        return false
-    }
-    return config.get<boolean>('cody.experimental.chatPredictions', false)
-}
-
-function getInlineFromConfig(config: vscode.WorkspaceConfiguration): boolean {
-    if (!config) {
-        return false
-    }
-    return config.get<boolean>('cody.inlineChat.enabled', false)
-}
-
-function getNonStopFromConfig(config: vscode.WorkspaceConfiguration): boolean {
-    if (!config) {
-        return false
-    }
-    return config.get<boolean>('cody.experimental.nonStop', false)
-}
-
-function getSuggestionsFromConfig(config: vscode.WorkspaceConfiguration): boolean {
-    if (!config) {
-        return false
-    }
-    return config.get<boolean>('cody.experimental.suggestions', false)
-}
-
-function getGuardrailsFromConfig(config: vscode.WorkspaceConfiguration): boolean {
-    if (!config) {
-        return false
-    }
-    return config.get<boolean>('cody.experimental.guardrails', false)
+export interface ExtensionDetails {
+    ide: 'VSCode' | 'JetBrains' | 'Neovim' | 'Emacs'
+    ideExtensionType: 'Cody' | 'CodeSearch'
 }
 
 export class EventLogger {
-    private serverEndpoint = getServerEndpointFromConfig(vscode.workspace.getConfiguration())
-    private extensionDetails = { ide: 'VSCode', ideExtensionType: 'Cody' }
-    private constructor(private gqlAPIClient: SourcegraphGraphQLAPIClient) {}
-
-    public static create(gqlAPIClient: SourcegraphGraphQLAPIClient): EventLogger {
-        return new EventLogger(gqlAPIClient)
-    }
+    private gqlAPIClient: SourcegraphGraphQLAPIClient
 
-    public configurationDetails = {
-        contextSelection: getUseContextFromConfig(vscode.workspace.getConfiguration()),
-        chatPredictions: getChatPredictionsFromConfig(vscode.workspace.getConfiguration()),
-        inline: getInlineFromConfig(vscode.workspace.getConfiguration()),
-        nonStop: getNonStopFromConfig(vscode.workspace.getConfiguration()),
-        suggestions: getSuggestionsFromConfig(vscode.workspace.getConfiguration()),
-        guardrails: getGuardrailsFromConfig(vscode.workspace.getConfiguration()),
+    constructor(
+        private serverEndpoint: string,
+        private extensionDetails: ExtensionDetails,
+        private config: ConfigurationWithAccessToken
+    ) {
+        this.gqlAPIClient = new SourcegraphGraphQLAPIClient(this.config)
     }
 
-    public onConfigurationChange(newconfig: vscode.WorkspaceConfiguration): void {
-        this.configurationDetails = {
-            contextSelection: getUseContextFromConfig(newconfig),
-            chatPredictions: getChatPredictionsFromConfig(newconfig),
-            inline: getInlineFromConfig(newconfig),
-            nonStop: getNonStopFromConfig(newconfig),
-            suggestions: getSuggestionsFromConfig(newconfig),
-            guardrails: getGuardrailsFromConfig(newconfig),
-        }
+    public onConfigurationChange(
+        newServerEndpoint: string,
+        newExtensionDetails: ExtensionDetails,
+        newConfig: ConfigurationWithAccessToken
+    ): void {
+        this.serverEndpoint = newServerEndpoint
+        this.extensionDetails = newExtensionDetails
+        this.config = newConfig
+        this.gqlAPIClient.onConfigurationChange(newConfig)
     }
 
     /**
@@ -91,32 +42,37 @@ export class EventLogger {
      * @param publicProperties Public argument information.
      */
     public log(eventName: string, anonymousUserID: string, eventProperties?: any, publicProperties?: any): void {
+        const configurationDetails = {
+            contextSelection: this.config.useContext,
+            chatPredictions: this.config.experimentalChatPredictions,
+            inline: this.config.inlineChat,
+            nonStop: this.config.experimentalNonStop,
+            guardrails: this.config.experimentalGuardrails,
+        }
         const argument = {
             ...eventProperties,
             serverEndpoint: this.serverEndpoint,
             extensionDetails: this.extensionDetails,
-            configurationDetails: this.configurationDetails,
+            configurationDetails,
         }
         const publicArgument = {
             ...publicProperties,
             serverEndpoint: this.serverEndpoint,
             extensionDetails: this.extensionDetails,
-            configurationDetails: this.configurationDetails,
-        }
-        try {
-            this.gqlAPIClient
-                .logEvent({
-                    event: eventName,
-                    userCookieID: anonymousUserID,
-                    source: 'IDEEXTENSION',
-                    url: '',
-                    argument: JSON.stringify(argument),
-                    publicArgument: JSON.stringify(publicArgument),
-                })
-                .then(() => {})
-                .catch(() => {})
-        } catch (error) {
-            console.log(error)
+            configurationDetails,
         }
+        this.gqlAPIClient
+            .logEvent({
+                event: eventName,
+                userCookieID: anonymousUserID,
+                source: 'IDEEXTENSION',
+                url: '',
+                argument: JSON.stringify(argument),
+                publicArgument: JSON.stringify(publicArgument),
+            })
+            .then(() => {})
+            .catch(error => {
+                console.log(error)
+            })
     }
 }

lib/shared/tsconfig.json

@@ -6,6 +6,6 @@
     "outDir": "dist",
     "lib": ["ESNext", "DOM.Iterable"],
   },
-  "include": ["src"],
+  "include": ["src", "src/telemetry/EventLogger.ts"],
   "exclude": ["dist"],
 }

vscode/src/chat/ChatViewProvider.ts

@@ -28,14 +28,14 @@ import { isError } from '@sourcegraph/cody-shared/src/utils'
 import { View } from '../../webviews/NavBar'
 import { getFullConfig } from '../configuration'
 import { VSCodeEditor } from '../editor/vscode-editor'
-import { logEvent } from '../event-logger'
 import { FilenameContextFetcher } from '../local-context/filename-context-fetcher'
 import { LocalKeywordContextFetcher } from '../local-context/local-keyword-context-fetcher'
 import { debug } from '../log'
 import { getRerankWithLog } from '../logged-rerank'
 import { FixupTask } from '../non-stop/FixupTask'
 import { IdleRecipeRunner } from '../non-stop/roles'
 import { AuthProvider } from '../services/AuthProvider'
+import { logEvent } from '../services/EventLogger'
 import { LocalStorage } from '../services/LocalStorageProvider'
 import { SecretStorage } from '../services/SecretStorageProvider'
 import { TestSupport } from '../test-support'

vscode/src/completions/logger.ts

@@ -2,8 +2,8 @@ import { LRUCache } from 'lru-cache'
 import * as vscode from 'vscode'
 
 import { ConfigKeys } from '../configuration-keys'
-import { logEvent } from '../event-logger'
 import { debug } from '../log'
+import { logEvent } from '../services/EventLogger'
 
 interface CompletionEvent {
     params: {

vscode/src/configuration.ts

@@ -8,7 +8,7 @@ import type {
 
 import { DOTCOM_URL } from './chat/protocol'
 import { CONFIG_KEY, ConfigKeys } from './configuration-keys'
-import { logEvent } from './event-logger'
+import { logEvent } from './services/EventLogger'
 import { LocalStorage } from './services/LocalStorageProvider'
 import { getAccessToken, SecretStorage } from './services/SecretStorageProvider'
 

vscode/src/local-context/local-keyword-context-fetcher.ts

@@ -10,8 +10,8 @@ import { ChatClient } from '@sourcegraph/cody-shared/src/chat/chat'
 import { Editor } from '@sourcegraph/cody-shared/src/editor'
 import { ContextResult, KeywordContextFetcher } from '@sourcegraph/cody-shared/src/local-context'
 
-import { logEvent } from '../event-logger'
 import { debug } from '../log'
+import { logEvent } from '../services/EventLogger'
 
 /**
  * Exclude files without extensions and hidden files (starts with '.')

vscode/src/main.ts

@@ -20,13 +20,13 @@ import { createProviderConfig as createUnstableCodeGenProviderConfig } from './c
 import { createProviderConfig as createUnstableHuggingFaceProviderConfig } from './completions/providers/unstable-huggingface'
 import { getConfiguration, getFullConfig, migrateConfiguration } from './configuration'
 import { VSCodeEditor } from './editor/vscode-editor'
-import { eventLogger, logEvent, updateEventLogger } from './event-logger'
 import { configureExternalServices } from './external-services'
 import { MyPromptController } from './my-cody/MyPromptController'
 import { FixupController } from './non-stop/FixupController'
 import { showSetupNotification } from './notifications/setup-notification'
 import { getRgPath } from './rg'
 import { AuthProvider } from './services/AuthProvider'
+import { createOrUpdateEventLogger, logEvent } from './services/EventLogger'
 import { showFeedbackSupportQuickPick } from './services/FeedbackOptions'
 import { GuardrailsProvider } from './services/GuardrailsProvider'
 import { InlineController } from './services/InlineController'
@@ -87,7 +87,7 @@ const register = async (
 }> => {
     const disposables: vscode.Disposable[] = []
 
-    await updateEventLogger(initialConfig, localStorage)
+    await createOrUpdateEventLogger(initialConfig, localStorage)
     // Controller for inline Chat
     const commentController = new InlineController(context.extensionPath)
 
@@ -141,7 +141,9 @@ const register = async (
         }),
         // Update external services when configurationChangeEvent is fired by chatProvider
         chatProvider.configurationChangeEvent.event(async () => {
-            externalServicesOnDidConfigurationChange(await getFullConfig(secretStorage, localStorage))
+            const newConfig = await getFullConfig(secretStorage, localStorage)
+            externalServicesOnDidConfigurationChange(newConfig)
+            createOrUpdateEventLogger(newConfig, localStorage).catch(error => console.error(error))
         })
     )
 
@@ -342,9 +344,7 @@ const register = async (
         onConfigurationChange: newConfig => {
             chatProvider.onConfigurationChange(newConfig)
             externalServicesOnDidConfigurationChange(newConfig)
-            if (eventLogger) {
-                eventLogger.onConfigurationChange(vscode.workspace.getConfiguration())
-            }
+            void createOrUpdateEventLogger(newConfig, localStorage)
         },
     }
 }

vscode/src/services/AuthProvider.ts

@@ -16,10 +16,10 @@ import {
     unauthenticatedStatus,
 } from '../chat/protocol'
 import { newAuthStatus } from '../chat/utils'
-import { logEvent } from '../event-logger'
 import { debug } from '../log'
 
 import { AuthMenu, LoginStepInputBox, TokenInputBox } from './AuthMenus'
+import { logEvent } from './EventLogger'
 import { LocalAppDetector } from './LocalAppDetector'
 import { LocalStorage } from './LocalStorageProvider'
 import { SecretStorage } from './SecretStorageProvider'

vscode/src/event-logger.ts renamed to vscode/src/services/EventLogger.ts

@@ -1,33 +1,34 @@
 import { ConfigurationWithAccessToken } from '@sourcegraph/cody-shared/src/configuration'
-import { SourcegraphGraphQLAPIClient } from '@sourcegraph/cody-shared/src/sourcegraph-api/graphql'
-import { EventLogger } from '@sourcegraph/cody-shared/src/telemetry/EventLogger'
+import { EventLogger, ExtensionDetails } from '@sourcegraph/cody-shared/src/telemetry/EventLogger'
 
-import { version as packageVersion } from '../package.json'
+import { version as packageVersion } from '../../package.json'
+import { debug } from '../log'
 
-import { debug } from './log'
-import { LocalStorage } from './services/LocalStorageProvider'
+import { LocalStorage } from './LocalStorageProvider'
 
-let eventLoggerGQLClient: SourcegraphGraphQLAPIClient
 export let eventLogger: EventLogger | null = null
 let anonymousUserID: string
 
-export async function updateEventLogger(
-    config: Pick<ConfigurationWithAccessToken, 'serverEndpoint' | 'accessToken' | 'customHeaders'>,
+const extensionDetails: ExtensionDetails = { ide: 'VSCode', ideExtensionType: 'Cody' }
+
+export async function createOrUpdateEventLogger(
+    config: ConfigurationWithAccessToken,
     localStorage: LocalStorage
 ): Promise<void> {
     const status = await localStorage.setAnonymousUserID()
     anonymousUserID = localStorage.getAnonymousUserID() || ''
-    if (!eventLoggerGQLClient) {
-        eventLoggerGQLClient = new SourcegraphGraphQLAPIClient(config)
-        eventLogger = EventLogger.create(eventLoggerGQLClient)
+    const serverEndpoint = localStorage?.getEndpoint() || config.serverEndpoint
+
+    if (!eventLogger) {
+        eventLogger = new EventLogger(serverEndpoint, extensionDetails, config)
         if (status === 'installed') {
             logEvent('CodyInstalled')
         } else {
             logEvent('CodyVSCodeExtension:CodySavedLogin:executed')
         }
-    } else {
-        eventLoggerGQLClient.onConfigurationChange(config)
+        return
     }
+    eventLogger?.onConfigurationChange(serverEndpoint, extensionDetails, config)
 }
 
 /**

vscode/src/services/InlineController.ts

@@ -4,10 +4,10 @@ import * as vscode from 'vscode'
 import { ActiveTextEditorSelection } from '@sourcegraph/cody-shared/src/editor'
 import { SURROUNDING_LINES } from '@sourcegraph/cody-shared/src/prompt/constants'
 
-import { logEvent } from '../event-logger'
 import { CodyTaskState } from '../non-stop/utils'
 
 import { CodeLensProvider } from './CodeLensProvider'
+import { logEvent } from './EventLogger'
 import { editDocByUri, getIconPath, updateRangeOnDocChange } from './InlineAssist'
 
 const initPost = new vscode.Position(0, 0)