refactor(core): use globalState abstraction

Author: justinmk3

packages/amazonq/test/unit/amazonq/onboardingPage/walkthrough.test.ts

@@ -5,19 +5,17 @@
 
 import assert from 'assert'
 import { showAmazonQWalkthroughOnce } from 'aws-core-vscode/amazonq'
-import { FakeMemento } from 'aws-core-vscode/test'
 import sinon from 'sinon'
 
 describe('showAmazonQWalkthroughOnce', function () {
     it('only shows once', async function () {
-        const state = new FakeMemento()
         const showWalkthroughStub = sinon.stub()
         assert.deepStrictEqual(showWalkthroughStub.callCount, 0)
-        await showAmazonQWalkthroughOnce(state, showWalkthroughStub)
+        await showAmazonQWalkthroughOnce(showWalkthroughStub)
         // Show walkthrough since our state indicates we haven't shown before
         assert.deepStrictEqual(showWalkthroughStub.callCount, 1)
 
-        await showAmazonQWalkthroughOnce(state, showWalkthroughStub)
+        await showAmazonQWalkthroughOnce(showWalkthroughStub)
         // On the second call we do not show again since we've shown before.
         assert.deepStrictEqual(showWalkthroughStub.callCount, 1)
     })

packages/amazonq/test/unit/codewhisperer/commands/onAcceptance.test.ts

@@ -17,7 +17,7 @@ import {
     AuthUtil,
 } from 'aws-core-vscode/codewhisperer'
 import { resetCodeWhispererGlobalVariables, createMockTextEditor } from 'aws-core-vscode/test'
-import { assertTelemetryCurried, FakeExtensionContext } from 'aws-core-vscode/test'
+import { assertTelemetryCurried } from 'aws-core-vscode/test'
 import { globals } from 'aws-core-vscode/shared'
 import { extensionVersion } from 'aws-core-vscode/shared'
 

packages/amazonq/test/unit/codewhisperer/commands/onInlineAcceptance.test.ts

@@ -8,7 +8,6 @@ import * as vscode from 'vscode'
 import * as sinon from 'sinon'
 import { resetCodeWhispererGlobalVariables, createMockTextEditor } from 'aws-core-vscode/test'
 import { assertTelemetryCurried } from 'aws-core-vscode/test'
-import { FakeMemento } from 'aws-core-vscode/test'
 import {
     onInlineAcceptance,
     RecommendationHandler,
@@ -36,23 +35,19 @@ describe('onInlineAcceptance', function () {
         it('Should dispose inline completion provider', async function () {
             const mockEditor = createMockTextEditor()
             const spy = sinon.spy(RecommendationHandler.instance, 'disposeInlineCompletion')
-            const globalState = new FakeMemento()
-            await onInlineAcceptance(
-                {
-                    editor: mockEditor,
-                    range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
-                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
-                    acceptIndex: 0,
-                    recommendation: "print('Hello World!')",
-                    requestId: '',
-                    sessionId: '',
-                    triggerType: 'OnDemand',
-                    completionType: 'Line',
-                    language: 'python',
-                    references: undefined,
-                },
-                globalState
-            )
+            await onInlineAcceptance({
+                editor: mockEditor,
+                range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                acceptIndex: 0,
+                recommendation: "print('Hello World!')",
+                requestId: '',
+                sessionId: '',
+                triggerType: 'OnDemand',
+                completionType: 'Line',
+                language: 'python',
+                references: undefined,
+            })
             assert.ok(spy.calledWith())
         })
 
@@ -76,23 +71,19 @@ describe('onInlineAcceptance', function () {
             session.triggerType = 'OnDemand'
             session.setCompletionType(0, session.recommendations[0])
             const assertTelemetry = assertTelemetryCurried('codewhisperer_userDecision')
-            const globalState = new FakeMemento()
-            await onInlineAcceptance(
-                {
-                    editor: mockEditor,
-                    range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
-                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
-                    acceptIndex: 0,
-                    recommendation: "print('Hello World!')",
-                    requestId: '',
-                    sessionId: '',
-                    triggerType: 'OnDemand',
-                    completionType: 'Line',
-                    language: 'python',
-                    references: undefined,
-                },
-                globalState
-            )
+            await onInlineAcceptance({
+                editor: mockEditor,
+                range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                acceptIndex: 0,
+                recommendation: "print('Hello World!')",
+                requestId: '',
+                sessionId: '',
+                triggerType: 'OnDemand',
+                completionType: 'Line',
+                language: 'python',
+                references: undefined,
+            })
             assertTelemetry({
                 codewhispererRequestId: 'test',
                 codewhispererSessionId: 'test',

packages/amazonq/test/unit/codewhisperer/service/recommendationHandler.test.ts

@@ -22,7 +22,6 @@ import {
 import {
     assertTelemetryCurried,
     stub,
-    FakeMemento,
     createMockTextEditor,
     resetCodeWhispererGlobalVariables,
 } from 'aws-core-vscode/test'
@@ -41,7 +40,6 @@ describe('recommendationHandler', function () {
     })
 
     describe('getRecommendations', async function () {
-        const fakeMemeto = new FakeMemento()
         const mockClient = stub(DefaultCodeWhispererClient)
         const mockEditor = createMockTextEditor()
         const testStartUrl = 'testStartUrl'
@@ -63,8 +61,7 @@ describe('recommendationHandler', function () {
         it('should assign correct recommendations given input', async function () {
             assert.strictEqual(CodeWhispererCodeCoverageTracker.instances.size, 0)
             assert.strictEqual(
-                CodeWhispererCodeCoverageTracker.getTracker(mockEditor.document.languageId, fakeMemeto)
-                    ?.serviceInvocationCount,
+                CodeWhispererCodeCoverageTracker.getTracker(mockEditor.document.languageId)?.serviceInvocationCount,
                 0
             )
 
@@ -86,8 +83,7 @@ describe('recommendationHandler', function () {
             const expected: RecommendationsList = [{ content: "print('Hello World!')" }, { content: '' }]
             assert.deepStrictEqual(actual, expected)
             assert.strictEqual(
-                CodeWhispererCodeCoverageTracker.getTracker(mockEditor.document.languageId, fakeMemeto)
-                    ?.serviceInvocationCount,
+                CodeWhispererCodeCoverageTracker.getTracker(mockEditor.document.languageId)?.serviceInvocationCount,
                 1
             )
         })

packages/amazonq/test/unit/codewhisperer/tracker/codewhispererCodeCoverageTracker.test.ts

@@ -16,7 +16,7 @@ import {
 } from 'aws-core-vscode/codewhisperer'
 import { createMockDocument, createMockTextEditor, resetCodeWhispererGlobalVariables } from 'aws-core-vscode/test'
 import { globals, extensionVersion } from 'aws-core-vscode/shared'
-import { assertTelemetryCurried, FakeMemento } from 'aws-core-vscode/test'
+import { assertTelemetryCurried } from 'aws-core-vscode/test'
 
 describe('codewhispererCodecoverageTracker', function () {
     const language = 'python'
@@ -64,7 +64,6 @@ describe('codewhispererCodecoverageTracker', function () {
     })
 
     describe('test isActive', function () {
-        const fakeMemeto = new FakeMemento()
         let tracker: CodeWhispererCodeCoverageTracker | undefined
 
         afterEach(async function () {
@@ -77,7 +76,7 @@ describe('codewhispererCodecoverageTracker', function () {
             sinon.stub(TelemetryHelper.instance, 'isTelemetryEnabled').returns(true)
             sinon.stub(AuthUtil.instance, 'isConnected').returns(false)
 
-            tracker = CodeWhispererCodeCoverageTracker.getTracker('python', fakeMemeto)
+            tracker = CodeWhispererCodeCoverageTracker.getTracker('python')
             if (!tracker) {
                 assert.fail()
             }
@@ -89,7 +88,7 @@ describe('codewhispererCodecoverageTracker', function () {
             sinon.stub(TelemetryHelper.instance, 'isTelemetryEnabled').returns(false)
             sinon.stub(AuthUtil.instance, 'isConnected').returns(false)
 
-            tracker = CodeWhispererCodeCoverageTracker.getTracker('java', fakeMemeto)
+            tracker = CodeWhispererCodeCoverageTracker.getTracker('java')
             if (!tracker) {
                 assert.fail()
             }
@@ -101,7 +100,7 @@ describe('codewhispererCodecoverageTracker', function () {
             sinon.stub(TelemetryHelper.instance, 'isTelemetryEnabled').returns(true)
             sinon.stub(AuthUtil.instance, 'isConnected').returns(true)
 
-            tracker = CodeWhispererCodeCoverageTracker.getTracker('javascript', fakeMemeto)
+            tracker = CodeWhispererCodeCoverageTracker.getTracker('javascript')
             if (!tracker) {
                 assert.fail()
             }

packages/core/src/shared/extensionUtilities.ts

@@ -46,8 +46,6 @@ export function commandsPrefix(): string {
     return isAmazonQ() ? 'Amazon Q' : getIdeProperties().company
 }
 
-export const mostRecentVersionKey: string = 'globalsMostRecentVersion'
-
 export enum IDE {
     vscode,
     cloud9,
@@ -172,8 +170,8 @@ export function isCn(): boolean {
  * @param context VS Code Extension Context
  * @param currVersion Current version to compare stored most recent version against (useful for tests)
  */
-export function isDifferentVersion(context: vscode.ExtensionContext, currVersion: string = extensionVersion): boolean {
-    const mostRecentVersion = context.globalState.get<string>(mostRecentVersionKey)
+export function isDifferentVersion(currVersion: string = extensionVersion): boolean {
+    const mostRecentVersion = globals.globalState.tryGet('globalsMostRecentVersion', String)
     if (mostRecentVersion && mostRecentVersion === currVersion) {
         return false
     }
@@ -187,8 +185,8 @@ export function isDifferentVersion(context: vscode.ExtensionContext, currVersion
  *
  * @param context VS Code Extension Context
  */
-export function setMostRecentVersion(context: vscode.ExtensionContext): void {
-    context.globalState.update(mostRecentVersionKey, extensionVersion).then(undefined, (e) => {
+export function setMostRecentVersion(): void {
+    globals.globalState.update('globalsMostRecentVersion', extensionVersion).then(undefined, (e) => {
         getLogger().error('globalState.update() failed: %s', (e as Error).message)
     })
 }
@@ -240,8 +238,8 @@ export function showWelcomeMessage(context: vscode.ExtensionContext): void {
         return
     }
     try {
-        if (isDifferentVersion(context)) {
-            setMostRecentVersion(context)
+        if (isDifferentVersion()) {
+            setMostRecentVersion()
             if (!isCloud9()) {
                 void promptQuickstart()
             }

packages/core/src/shared/globalState.ts

@@ -42,6 +42,7 @@ type globalKey =
     | 'CODEWHISPERER_PERSISTED_CUSTOMIZATIONS'
     | 'CODEWHISPERER_SELECTED_CUSTOMIZATION'
     | 'CODEWHISPERER_USER_GROUP'
+    | 'globalsMostRecentVersion'
     | 'gumby.wasQCodeTransformationUsed'
     | 'isExtensionFirstUse'
     | 'lastExtensionVersion'

packages/core/src/test/shared/extensionUtilities.test.ts

@@ -11,12 +11,7 @@ import * as path from 'path'
 import * as sinon from 'sinon'
 import { DefaultEc2MetadataClient } from '../../shared/clients/ec2MetadataClient'
 import * as vscode from 'vscode'
-import {
-    UserActivity,
-    getComputeRegion,
-    initializeComputeRegion,
-    mostRecentVersionKey,
-} from '../../shared/extensionUtilities'
+import { UserActivity, getComputeRegion, initializeComputeRegion } from '../../shared/extensionUtilities'
 import { isDifferentVersion, setMostRecentVersion } from '../../shared/extensionUtilities'
 import * as filesystemUtilities from '../../shared/filesystemUtilities'
 import { FakeExtensionContext } from '../fakeExtensionContext'
@@ -28,10 +23,11 @@ import { createQuickStartWebview } from '../../shared/extensionStartup'
 
 describe('extensionUtilities', function () {
     describe('createQuickStartWebview', async function () {
-        const context = await FakeExtensionContext.create()
+        let context: FakeExtensionContext
         let tempDir: string | undefined
 
         beforeEach(async function () {
+            context = await FakeExtensionContext.create()
             tempDir = await filesystemUtilities.makeTemporaryToolkitFolder()
             context.extensionPath = tempDir
         })
@@ -76,34 +72,28 @@ describe('extensionUtilities', function () {
     describe('isDifferentVersion', function () {
         it('returns false if the version exists and matches the existing version exactly', async function () {
             const goodVersion = '1.2.3'
-            const extContext = await FakeExtensionContext.create()
-            await extContext.globalState.update(mostRecentVersionKey, goodVersion)
+            await globals.globalState.update('globalsMostRecentVersion', goodVersion)
 
-            assert.strictEqual(isDifferentVersion(extContext, goodVersion), false)
+            assert.strictEqual(isDifferentVersion(goodVersion), false)
         })
 
         it("returns true if a most recent version isn't set", async () => {
-            const extContext = await FakeExtensionContext.create()
-
-            assert.ok(isDifferentVersion(extContext))
+            assert.ok(isDifferentVersion())
         })
 
         it("returns true if a most recent version doesn't match the current version", async () => {
             const oldVersion = '1.2.3'
             const newVersion = '4.5.6'
-            const extContext = await FakeExtensionContext.create()
-            await extContext.globalState.update(mostRecentVersionKey, oldVersion)
+            await globals.globalState.update('globalsMostRecentVersion', oldVersion)
 
-            assert.ok(isDifferentVersion(extContext, newVersion))
+            assert.ok(isDifferentVersion(newVersion))
         })
     })
 
     describe('setMostRecentVersion', function () {
         it('sets the most recent version', async function () {
-            const extContext = await FakeExtensionContext.create()
-            setMostRecentVersion(extContext)
-
-            assert.strictEqual(extContext.globalState.get<string>(mostRecentVersionKey), extensionVersion)
+            setMostRecentVersion()
+            assert.strictEqual(globals.globalState.get('globalsMostRecentVersion'), extensionVersion)
         })
     })
 })