CHANGE @W-17526120@ Telemetry for A4D events #187
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import { DiffHunk } from "../../shared/UnifiedDiff"; | ||
| import { TelemetryService } from "../core-extension-service"; | ||
| import * as Constants from '../constants'; | ||
|
|
||
| export type DiffAcceptCallback = (diffHunk?: DiffHunk) => Promise<number>; | ||
|
|
||
| export type DiffAcceptDependencies = { | ||
| callback: DiffAcceptCallback; | ||
| telemetryService: TelemetryService; | ||
| }; | ||
|
|
||
| export class DiffAcceptAction { | ||
| private readonly commandName: string; | ||
| private readonly callback: DiffAcceptCallback; | ||
| private readonly telemetryService: TelemetryService; | ||
|
|
||
| public constructor(commandName: string, dependencies: DiffAcceptDependencies) { | ||
| this.commandName = commandName; | ||
| this.callback = dependencies.callback; | ||
| this.telemetryService = dependencies.telemetryService; | ||
| } | ||
|
|
||
| public async run(diffHunk?: DiffHunk): Promise<void> { | ||
| const startTime = Date.now(); | ||
| try { | ||
| const lines: number = await this.callback(diffHunk); | ||
| this.telemetryService.sendCommandEvent(Constants.TELEM_DIFF_ACCEPT, { | ||
| commandSource: this.commandName, | ||
|
There was a problem hiding this comment. Can you make this instead? Ideally we should be sending the context which initiated the diff from our A4D quick fix button. That is, we should be updating this line: |
||
| completionNumLines: lines.toString(), | ||
| languageType: 'apex' // The only rules that the CodeAnalyzer A4D integration supports are Apex-based | ||
| }); | ||
| } catch (e) { | ||
| const errMsg = e instanceof Error ? e.message : e as string; | ||
| this.telemetryService.sendException(Constants.TELEM_DIFF_ACCEPT_FAILED, errMsg, { | ||
| executedCommand: this.commandName, | ||
| duration: (Date.now() - startTime).toString() | ||
| }) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import {TelemetryService} from '../core-extension-service'; | ||
| import * as Constants from '../constants'; | ||
|
|
||
| export type DiffCreateCallback = (code: string, file?: string) => Promise<void>; | ||
|
|
||
| export type DiffCreateDependencies = { | ||
| callback: DiffCreateCallback; | ||
| telemetryService: TelemetryService; | ||
| }; | ||
|
|
||
| export class DiffCreateAction { | ||
| private readonly commandName: string; | ||
| private readonly callback: DiffCreateCallback; | ||
| private readonly telemetryService: TelemetryService; | ||
|
|
||
| public constructor(commandName: string, dependencies: DiffCreateDependencies) { | ||
| this.commandName = commandName; | ||
| this.callback = dependencies.callback; | ||
| this.telemetryService = dependencies.telemetryService; | ||
| } | ||
|
|
||
| public async run(code: string, file?: string): Promise<void> { | ||
| const startTime = Date.now(); | ||
| try { | ||
| await this.callback(code, file); | ||
| this.telemetryService.sendCommandEvent(Constants.TELEM_DIFF_SUGGESTION, { | ||
| commandSource: this.commandName, | ||
|
|
||
| languageType: 'apex' // The only rules that the CodeAnalyzer A4D integration supports are Apex-based | ||
| }); | ||
| } catch (e) { | ||
| const errMsg = e instanceof Error ? e.message : e as string; | ||
| this.telemetryService.sendException(Constants.TELEM_DIFF_SUGGESTION_FAILED, errMsg, { | ||
| executedCommand: this.commandName, | ||
| duration: (Date.now() - startTime).toString() | ||
| }); | ||
|
Comment on lines
+32
to
+35
There was a problem hiding this comment. Out of curiosity, what does this do? Where does the exception go? There was a problem hiding this comment. It sends a telemetry event indicating that we got an exception. I'm not entirely sure where they go, but we've already been doing this style of telemetry for when SFCA fails. |
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import { DiffHunk } from "../../shared/UnifiedDiff"; | ||
| import { TelemetryService } from "../core-extension-service"; | ||
| import * as Constants from '../constants'; | ||
|
|
||
| export type DiffRejectCallback = (diffHunk?: DiffHunk) => Promise<void>; | ||
|
|
||
| export type DiffRejectDependencies = { | ||
| callback: DiffRejectCallback; | ||
| telemetryService: TelemetryService; | ||
| }; | ||
|
|
||
| export class DiffRejectAction { | ||
| private readonly commandName: string; | ||
| private readonly callback: DiffRejectCallback; | ||
| private readonly telemetryService: TelemetryService; | ||
|
|
||
| public constructor(commandName: string, dependencies: DiffRejectDependencies) { | ||
| this.commandName = commandName; | ||
|
|
||
| this.callback = dependencies.callback; | ||
| this.telemetryService = dependencies.telemetryService; | ||
| } | ||
|
|
||
| public async run(diffHunk?: DiffHunk): Promise<void> { | ||
| const startTime = Date.now(); | ||
| try { | ||
| await this.callback(diffHunk); | ||
| this.telemetryService.sendCommandEvent(Constants.TELEM_DIFF_REJECT, { | ||
| commandSource: this.commandName, | ||
| languageType: 'apex' // The only rules that the CodeAnalyzer A4D integration supports are Apex-based | ||
| }); | ||
| } catch (e) { | ||
| const errMsg = e instanceof Error ? e.message : e as string; | ||
| this.telemetryService.sendException(Constants.TELEM_DIFF_REJECT_FAILED, errMsg, { | ||
| executedCommand: this.commandName, | ||
| duration: (Date.now() - startTime).toString() | ||
| }) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| import { Properties, TelemetryService } from "../../../lib/core-extension-service"; | ||
| import { DiffHunk } from "../../../shared/UnifiedDiff"; | ||
| import { DiffAcceptAction } from '../../../lib/actions/diff-accept-action'; | ||
| import * as Constants from '../../../lib/constants'; | ||
|
|
||
|
|
||
| describe('DiffAcceptAction', () => { | ||
| describe('Telemetry events', () => { | ||
| it('Generates telemetry event for failed suggestion acceptance', async () => { | ||
| const stubTelemetryService: StubTelemetryService = new StubTelemetryService(); | ||
| const diffAcceptAction: DiffAcceptAction = new DiffAcceptAction('fakeName', { | ||
| callback: (_diffHunk?: DiffHunk) => Promise.reject(new Error('Forced error')), | ||
| telemetryService: stubTelemetryService | ||
| }); | ||
| await diffAcceptAction.run(); | ||
|
|
||
| expect(stubTelemetryService.getSentCommandEvents()).toHaveLength(0); | ||
| expect(stubTelemetryService.getSentExceptions()).toHaveLength(1); | ||
| expect(stubTelemetryService.getSentExceptions()[0].name).toEqual(Constants.TELEM_DIFF_ACCEPT_FAILED); | ||
| expect(stubTelemetryService.getSentExceptions()[0].message).toEqual('Forced error'); | ||
| expect(stubTelemetryService.getSentExceptions()[0].data).toHaveProperty('executedCommand', 'fakeName'); | ||
| }); | ||
|
|
||
| it('Generates telemetry event for successful suggestion acceptance', async () => { | ||
| const stubTelemetryService: StubTelemetryService = new StubTelemetryService(); | ||
| const diffAcceptAction: DiffAcceptAction = new DiffAcceptAction('fakeName', { | ||
| callback: (_diffHunk?: DiffHunk) => Promise.resolve(5), | ||
| telemetryService: stubTelemetryService | ||
| }); | ||
| await diffAcceptAction.run(); | ||
|
|
||
| expect(stubTelemetryService.getSentExceptions()).toHaveLength(0); | ||
| expect(stubTelemetryService.getSentCommandEvents()).toHaveLength(1); | ||
| expect(stubTelemetryService.getSentCommandEvents()[0].key).toEqual(Constants.TELEM_DIFF_ACCEPT); | ||
| expect(stubTelemetryService.getSentCommandEvents()[0].data.commandSource).toEqual('fakeName'); | ||
| expect(stubTelemetryService.getSentCommandEvents()[0].data.completionNumLines).toEqual('5'); | ||
| expect(stubTelemetryService.getSentCommandEvents()[0].data.languageType).toEqual('apex'); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| type TelemetryCommandEventData = { | ||
| key: string; | ||
| data?: Properties; | ||
| }; | ||
|
|
||
| type TelemetryExceptionData = { | ||
| name: string; | ||
| message: string; | ||
| data?: Record<string, string>; | ||
| }; | ||
|
|
||
| class StubTelemetryService implements TelemetryService { | ||
| private commandEventCalls: TelemetryCommandEventData[] = []; | ||
| private exceptionCalls: TelemetryExceptionData[] = []; | ||
|
|
||
| public sendExtensionActivationEvent(_hrStart: [number, number]): void { | ||
| // NO-OP | ||
| } | ||
|
|
||
| public sendCommandEvent(key: string, data: Properties): void { | ||
| this.commandEventCalls.push({ | ||
| key, | ||
| data | ||
| }); | ||
| } | ||
|
|
||
| public sendException(name: string, message: string, data?: Record<string, string>): void { | ||
| this.exceptionCalls.push({ | ||
| name, | ||
| message, | ||
| data | ||
| }); | ||
| } | ||
|
|
||
| public getSentCommandEvents(): TelemetryCommandEventData[] { | ||
| return this.commandEventCalls; | ||
| } | ||
|
|
||
| public getSentExceptions(): TelemetryExceptionData[] { | ||
| return this.exceptionCalls; | ||
| } | ||
|
|
||
| public dispose(): void { | ||
| // NO-OP | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any advantage of having this dependencies type instead of just passing in the telemetry service and callback directly into the constructor?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The object keeps the invocation clean and means I don't have to worry about parameters. It also means we can make any of them optional without needing to reorder them or anything like that.