refactor(telemetry): use globalState abstraction

Author: justinmk3

packages/core/src/codewhisperer/client/codewhisperer.ts

@@ -256,7 +256,7 @@ export class DefaultCodeWhispererClient {
                 ideCategory: 'VSCODE',
                 operatingSystem: getOperatingSystem(),
                 product: 'CodeWhisperer', // TODO: update this?
-                clientId: getClientId(globals.context.globalState),
+                clientId: getClientId(globals.globalState),
                 ideVersion: extensionVersion,
             },
         }
@@ -273,7 +273,7 @@ export class DefaultCodeWhispererClient {
                 ideCategory: 'VSCODE',
                 operatingSystem: getOperatingSystem(),
                 product: 'CodeWhisperer', // TODO: update this?
-                clientId: getClientId(globals.context.globalState),
+                clientId: getClientId(globals.globalState),
                 ideVersion: extensionVersion,
             },
         }

packages/core/src/shared/globalState.ts

@@ -35,20 +35,20 @@ type globalKey =
     | 'aws.toolkit.separationPromptCommand'
     | 'aws.toolkit.separationPromptDismissed'
     // Deprecated/legacy names. New keys should start with "aws.".
+    | '#sessionCreationDates' // Legacy name from `ssoAccessTokenProvider.ts`.
     | 'CODECATALYST_RECONNECT'
     | 'CODEWHISPERER_AUTO_SCANS_ENABLED'
     | 'CODEWHISPERER_AUTO_TRIGGER_ENABLED'
     | 'CODEWHISPERER_HINT_DISPLAYED'
     | 'CODEWHISPERER_PERSISTED_CUSTOMIZATIONS'
     | 'CODEWHISPERER_SELECTED_CUSTOMIZATION'
     | 'CODEWHISPERER_USER_GROUP'
+    | 'awsTelemetryNoticeVersionAck'
     | 'globalsMostRecentVersion'
     | 'gumby.wasQCodeTransformationUsed'
+    | 'hasAlreadyOpenedAmazonQ'
     | 'isExtensionFirstUse'
     | 'lastExtensionVersion'
-    | 'hasAlreadyOpenedAmazonQ'
-    // Legacy name from `ssoAccessTokenProvider.ts`.
-    | '#sessionCreationDates'
 
 /**
  * Extension-local (not visible to other vscode extensions) shared state which persists after IDE

packages/core/src/shared/telemetry/activation.ts

@@ -24,9 +24,6 @@ import { Commands } from '../vscode/commands2'
 export const noticeResponseViewSettings = localize('AWS.telemetry.notificationViewSettings', 'Settings')
 export const noticeResponseOk = localize('AWS.telemetry.notificationOk', 'OK')
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED = 'awsTelemetryNoticeVersionAck'
-
 // Telemetry Notice Versions
 // Versioning the users' notice acknowledgement is forward looking, and allows us to better
 // track scenarios when we may need to re-prompt the user about telemetry.
@@ -83,8 +80,8 @@ export async function activate(
         }
 
         // Prompt user about telemetry if they haven't been
-        if (!isCloud9() && !hasUserSeenTelemetryNotice(extensionContext)) {
-            showTelemetryNotice(extensionContext)
+        if (!isCloud9() && !hasUserSeenTelemetryNotice()) {
+            showTelemetryNotice()
         }
         await setupTelemetryId(extensionContext)
         await globals.telemetry.start()
@@ -100,23 +97,20 @@ export async function activate(
     }
 }
 
-export function hasUserSeenTelemetryNotice(extensionContext: vscode.ExtensionContext): boolean {
-    return (
-        extensionContext.globalState.get<number>(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED, 0) >=
-        CURRENT_TELEMETRY_NOTICE_VERSION
-    )
+export function hasUserSeenTelemetryNotice(): boolean {
+    return globals.globalState.tryGet('awsTelemetryNoticeVersionAck', Number, 0) >= CURRENT_TELEMETRY_NOTICE_VERSION
 }
 
-export async function setHasUserSeenTelemetryNotice(extensionContext: vscode.ExtensionContext): Promise<void> {
-    await extensionContext.globalState.update(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED, CURRENT_TELEMETRY_NOTICE_VERSION)
+export async function setHasUserSeenTelemetryNotice(): Promise<void> {
+    await globals.globalState.update('awsTelemetryNoticeVersionAck', CURRENT_TELEMETRY_NOTICE_VERSION)
     getLogger().verbose('Telemetry notice has been shown')
 }
 
 /**
  * Prompts user to Enable/Disable/Defer on Telemetry, then
  * handles the response appropriately.
  */
-function showTelemetryNotice(extensionContext: vscode.ExtensionContext) {
+function showTelemetryNotice() {
     getLogger().verbose('Showing telemetry notice')
 
     const telemetryNoticeText: string = localize(
@@ -128,13 +122,10 @@ function showTelemetryNotice(extensionContext: vscode.ExtensionContext) {
     // Don't wait for a response
     void vscode.window
         .showInformationMessage(telemetryNoticeText, noticeResponseViewSettings, noticeResponseOk)
-        .then(async (response) => handleTelemetryNoticeResponse(response, extensionContext))
+        .then(async (response) => handleTelemetryNoticeResponse(response))
 }
 
-export async function handleTelemetryNoticeResponse(
-    response: string | undefined,
-    extensionContext: vscode.ExtensionContext
-) {
+export async function handleTelemetryNoticeResponse(response: string | undefined) {
     try {
         getLogger().verbose(`Telemetry notice response: ${response}`)
 
@@ -143,7 +134,7 @@ export async function handleTelemetryNoticeResponse(
             return
         }
 
-        await setHasUserSeenTelemetryNotice(extensionContext)
+        await setHasUserSeenTelemetryNotice()
 
         // noticeResponseOk is a no-op
 

packages/core/src/shared/telemetry/telemetryService.ts

@@ -216,7 +216,7 @@ export class DefaultTelemetryService {
     private async createDefaultPublisher(): Promise<TelemetryPublisher | undefined> {
         try {
             // grab our clientId and generate one if it doesn't exist
-            const clientId = getClientId(this.context.globalState)
+            const clientId = getClientId(globals.globalState)
             // grab our Cognito identityId
             const poolId = DefaultTelemetryClient.config.identityPool
             const identityMapJson = this.context.globalState.get<string>(

packages/core/src/shared/telemetry/util.ts

@@ -241,7 +241,7 @@ export async function setupTelemetryId(extensionContext: vscode.ExtensionContext
                 getLogger().debug(`telemetry: Write telemetry client id to env ${currentClientId}`)
                 process.env[telemetryClientIdEnvKey] = currentClientId
             } else {
-                const clientId = getClientId(globals.context.globalState)
+                const clientId = getClientId(globals.globalState)
                 getLogger().debug(`telemetry: Setup telemetry client id ${clientId}`)
                 process.env[telemetryClientIdEnvKey] = clientId
             }

packages/core/src/test/shared/telemetry/activation.test.ts

@@ -4,89 +4,52 @@
  */
 
 import assert from 'assert'
-import * as sinon from 'sinon'
-import * as vscode from 'vscode'
-
-import { FakeExtensionContext } from '../../fakeExtensionContext'
 import {
     handleTelemetryNoticeResponse,
     noticeResponseViewSettings,
     noticeResponseOk,
-    TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED,
     hasUserSeenTelemetryNotice,
     setHasUserSeenTelemetryNotice,
 } from '../../../shared/telemetry/activation'
+import globals from '../../../shared/extensionGlobals'
 
 describe('handleTelemetryNoticeResponse', function () {
-    let extensionContext: vscode.ExtensionContext
-    let sandbox: sinon.SinonSandbox
-
-    before(function () {
-        sandbox = sinon.createSandbox()
-    })
-
-    after(function () {
-        sandbox.restore()
-    })
-
-    beforeEach(async function () {
-        extensionContext = await FakeExtensionContext.create()
-    })
-
     it('does nothing when notice is discarded', async function () {
-        await handleTelemetryNoticeResponse(undefined, extensionContext)
-
+        await handleTelemetryNoticeResponse(undefined)
         assert.strictEqual(
-            extensionContext.globalState.get(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED),
+            globals.globalState.get('awsTelemetryNoticeVersionAck'),
             undefined,
             'Expected opt out shown state to remain unchanged'
         )
     })
 
     it('handles View Settings response', async function () {
-        const executeCommand = sandbox.stub(vscode.commands, 'executeCommand')
-
-        await handleTelemetryNoticeResponse(noticeResponseViewSettings, extensionContext)
-
-        assert.ok(executeCommand.calledOnce, 'Expected to trigger View Settings')
+        await handleTelemetryNoticeResponse(noticeResponseViewSettings)
         assert.strictEqual(
-            extensionContext.globalState.get(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED),
+            globals.globalState.get('awsTelemetryNoticeVersionAck'),
             2,
             'Expected opt out shown state to be set'
         )
     })
 
     it('handles Ok response', async function () {
-        await handleTelemetryNoticeResponse(noticeResponseOk, extensionContext)
+        await handleTelemetryNoticeResponse(noticeResponseOk)
 
         assert.strictEqual(
-            extensionContext.globalState.get(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED),
+            globals.globalState.get('awsTelemetryNoticeVersionAck'),
             2,
             'Expected opt out shown state to be set'
         )
     })
 })
 
 describe('hasUserSeenTelemetryNotice', async function () {
-    let extensionContext: vscode.ExtensionContext
-    let sandbox: sinon.SinonSandbox
-
-    before(function () {
-        sandbox = sinon.createSandbox()
-    })
-
-    after(function () {
-        sandbox.restore()
-    })
-
-    beforeEach(async function () {
-        extensionContext = await FakeExtensionContext.create()
-    })
+    beforeEach(async function () {})
 
     it('is affected by setHasUserSeenTelemetryNotice', async function () {
-        assert.ok(!hasUserSeenTelemetryNotice(extensionContext))
-        await setHasUserSeenTelemetryNotice(extensionContext)
-        assert.ok(hasUserSeenTelemetryNotice(extensionContext))
+        assert.ok(!hasUserSeenTelemetryNotice())
+        await setHasUserSeenTelemetryNotice()
+        assert.ok(hasUserSeenTelemetryNotice())
     })
 
     const scenarios = [
@@ -98,8 +61,8 @@ describe('hasUserSeenTelemetryNotice', async function () {
 
     scenarios.forEach((scenario) => {
         it(scenario.desc, async () => {
-            await extensionContext.globalState.update(TELEMETRY_NOTICE_VERSION_ACKNOWLEDGED, scenario.currentState)
-            assert.strictEqual(hasUserSeenTelemetryNotice(extensionContext), scenario.expectedHasSeen)
+            await globals.globalState.update('awsTelemetryNoticeVersionAck', scenario.currentState)
+            assert.strictEqual(hasUserSeenTelemetryNotice(), scenario.expectedHasSeen)
         })
     })
 })

packages/core/src/threatComposer/threatComposerEditorProvider.ts

@@ -130,7 +130,7 @@ export class ThreatComposerEditorProvider implements vscode.CustomTextEditorProv
             }
 
             if (clientId === '') {
-                clientId = getClientId(globals.context.globalState)
+                clientId = getClientId(globals.globalState)
             }
             // Attempt to retrieve existing visualization if it exists.
             const existingVisualization = this.getExistingVisualization(document.uri.fsPath)