Edit: Track events per diagnostic (#3692)

sourcegraph · Apr 5, 2024 · b898b0e · b898b0e
1 parent b854832
commit b898b0e
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 12 deletions.
diff --git a/vscode/src/edit/execute.ts b/vscode/src/edit/execute.ts
@@ -2,7 +2,7 @@ import * as vscode from 'vscode'
 
 import type { ChatEventSource, ContextItem, ContextMessage, EditModel } from '@sourcegraph/cody-shared'
 
-import type { FixupTask } from '../non-stop/FixupTask'
+import type { FixupTask, FixupTelemetryMetadata } from '../non-stop/FixupTask'
 import type { EditIntent, EditMode } from './types'
 
 export interface ExecuteEditArguments {
@@ -20,9 +20,7 @@ export interface ExecuteEditArguments {
         insertionPoint?: vscode.Position
     }
     source?: ChatEventSource
-    telemetryMetadata?: {
-        [key: string]: unknown
-    }
+    telemetryMetadata?: FixupTelemetryMetadata
 }
 
 /**

diff --git a/vscode/src/edit/manager.ts b/vscode/src/edit/manager.ts
@@ -122,7 +122,8 @@ export class EditManager implements vscode.Disposable {
                 model,
                 source,
                 configuration.destinationFile,
-                configuration.insertionPoint
+                configuration.insertionPoint,
+                telemetryMetadata
             )
         } else {
             task = await this.controller.promptUserForTask(
@@ -132,7 +133,8 @@ export class EditManager implements vscode.Disposable {
                 mode,
                 model,
                 intent,
-                source
+                source,
+                telemetryMetadata
             )
         }
 

diff --git a/vscode/src/non-stop/FixupController.ts b/vscode/src/non-stop/FixupController.ts
@@ -25,7 +25,7 @@ import { FixupDocumentEditObserver } from './FixupDocumentEditObserver'
 import type { FixupFile } from './FixupFile'
 import { FixupFileObserver } from './FixupFileObserver'
 import { FixupScheduler } from './FixupScheduler'
-import { FixupTask, type FixupTaskID } from './FixupTask'
+import { FixupTask, type FixupTaskID, type FixupTelemetryMetadata } from './FixupTask'
 import { type Diff, computeDiff } from './diff'
 import type { FixupActor, FixupFileCollection, FixupIdleTaskRunner, FixupTextChanged } from './roles'
 import { CodyTaskState, getMinimumDistanceToRangeBoundary } from './utils'
@@ -154,6 +154,7 @@ export class FixupController
             mode: task.mode,
             source: task.source,
             ...countCode(replacementText),
+            ...task.telemetryMetadata,
         }
         const { metadata, privateMetadata } = splitSafeMetadata(legacyMetadata)
         if (!editOk) {
@@ -270,7 +271,8 @@ export class FixupController
         mode: EditMode,
         model: EditModel,
         intent: EditIntent,
-        source: ChatEventSource
+        source: ChatEventSource,
+        telemetryMetadata?: FixupTelemetryMetadata
     ): Promise<FixupTask | null> {
         const input = await getInput(
             document,
@@ -295,7 +297,10 @@ export class FixupController
             input.intent,
             mode,
             input.model,
-            source
+            source,
+            undefined,
+            undefined,
+            telemetryMetadata
         )
 
         // Return focus to the editor
@@ -314,7 +319,8 @@ export class FixupController
         model: EditModel,
         source?: ChatEventSource,
         destinationFile?: vscode.Uri,
-        insertionPoint?: vscode.Position
+        insertionPoint?: vscode.Position,
+        telemetryMetadata?: FixupTelemetryMetadata
     ): Promise<FixupTask> {
         const fixupFile = this.files.forUri(document.uri)
         const task = new FixupTask(
@@ -327,7 +333,8 @@ export class FixupController
             model,
             source,
             destinationFile,
-            insertionPoint
+            insertionPoint,
+            telemetryMetadata
         )
         this.tasks.set(task.id, task)
         return task
@@ -414,6 +421,7 @@ export class FixupController
             mode: task.mode,
             source: task.source,
             ...countCode(task.replacement || ''),
+            ...task.telemetryMetadata,
         }
         const { metadata, privateMetadata } = splitSafeMetadata(legacyMetadata)
         if (!editOk) {
@@ -478,6 +486,7 @@ export class FixupController
                 model: task.model,
                 mode: task.mode,
                 intent: task.intent,
+                ...task.telemetryMetadata,
             },
         })
     }

diff --git a/vscode/src/non-stop/FixupTask.ts b/vscode/src/non-stop/FixupTask.ts
@@ -11,6 +11,13 @@ import { CodyTaskState } from './utils'
 
 export type FixupTaskID = string
 
+/**
+ * Arbitrary metadata that will be included in telemetry events for this task.
+ */
+export type FixupTelemetryMetadata = {
+    [key: string]: unknown
+}
+
 export class FixupTask {
     public id: FixupTaskID
     public state_: CodyTaskState = CodyTaskState.idle
@@ -65,7 +72,8 @@ export class FixupTask {
         public source?: ChatEventSource,
         /* The file to write the edit to. If not provided, the edit will be applied to the fixupFile. */
         public destinationFile?: vscode.Uri,
-        public insertionPoint?: vscode.Position
+        public insertionPoint?: vscode.Position,
+        public readonly telemetryMetadata: FixupTelemetryMetadata = {}
     ) {
         this.id = Date.now().toString(36).replaceAll(/\d+/g, '')
         this.instruction = instruction.replace(/^\/(edit|fix)/, '').trim()