fix(globalState): log update() errors

Author: justinmk3

packages/core/src/codewhisperer/models/model.ts

@@ -92,7 +92,7 @@ export class CodeSuggestionsState {
     async toggleSuggestions() {
         const autoTriggerEnabled = this.isSuggestionsEnabled()
         const toSet: boolean = !autoTriggerEnabled
-        await globals.globalState.tryUpdate('CODEWHISPERER_AUTO_TRIGGER_ENABLED', toSet)
+        await globals.globalState.update('CODEWHISPERER_AUTO_TRIGGER_ENABLED', toSet)
         this.#onDidChangeState.fire(toSet)
         return toSet
     }
@@ -131,7 +131,7 @@ export class CodeScansState {
     async toggleScans() {
         const autoScansEnabled = this.isScansEnabled()
         const toSet: boolean = !autoScansEnabled
-        await globals.globalState.tryUpdate('CODEWHISPERER_AUTO_SCANS_ENABLED', toSet)
+        await globals.globalState.update('CODEWHISPERER_AUTO_SCANS_ENABLED', toSet)
         this.#onDidChangeState.fire(toSet)
         return toSet
     }

packages/core/src/codewhisperer/util/customizationUtil.ts

@@ -134,7 +134,7 @@ export const setSelectedCustomization = async (customization: Customization) =>
     selectedCustomizationObj[AuthUtil.instance.conn.label] = customization
     getLogger().debug(`Selected customization ${customization.name} for ${AuthUtil.instance.conn.label}`)
 
-    await globals.globalState.tryUpdate('CODEWHISPERER_SELECTED_CUSTOMIZATION', selectedCustomizationObj)
+    await globals.globalState.update('CODEWHISPERER_SELECTED_CUSTOMIZATION', selectedCustomizationObj)
     vsCodeState.isFreeTierLimitReached = false
     await Commands.tryExecute('aws.amazonq.refreshStatusBar')
 }
@@ -161,15 +161,15 @@ export const setPersistedCustomizations = async (customizations: Customization[]
         {}
     )
     persistedCustomizationsObj[AuthUtil.instance.conn.label] = customizations
-    await globals.globalState.tryUpdate('CODEWHISPERER_PERSISTED_CUSTOMIZATIONS', persistedCustomizationsObj)
+    await globals.globalState.update('CODEWHISPERER_PERSISTED_CUSTOMIZATIONS', persistedCustomizationsObj)
 }
 
 export const getNewCustomizationsAvailable = () => {
     return globals.globalState.tryGet('aws.amazonq.codewhisperer.newCustomizations', Number, 0)
 }
 
 export const setNewCustomizationsAvailable = async (num: number) => {
-    await globals.globalState.tryUpdate('aws.amazonq.codewhisperer.newCustomizations', num)
+    await globals.globalState.update('aws.amazonq.codewhisperer.newCustomizations', num)
     vsCodeState.isFreeTierLimitReached = false
 }
 

packages/core/src/codewhisperer/views/lineAnnotationController.ts

@@ -308,7 +308,7 @@ export class LineAnnotationController implements vscode.Disposable {
     async dismissTutorial() {
         this._currentState = new EndState()
         await setContext('aws.codewhisperer.tutorial.workInProgress', false)
-        await globals.globalState.tryUpdate(inlinehintKey, this._currentState.id)
+        await globals.globalState.update(inlinehintKey, this._currentState.id)
     }
 
     private async onActiveLinesChanged(e: LinesChangeEvent) {
@@ -422,7 +422,7 @@ export class LineAnnotationController implements vscode.Disposable {
 
         decorationOptions.range = range
 
-        await globals.globalState.tryUpdate(inlinehintKey, this._currentState.id)
+        await globals.globalState.update(inlinehintKey, this._currentState.id)
         await setContext('aws.codewhisperer.tutorial.workInProgress', true)
         editor.setDecorations(this.cwLineHintDecoration, [decorationOptions])
     }

packages/core/src/shared/filesystemUtilities.ts

@@ -267,9 +267,9 @@ export async function getDefaultDownloadPath(): Promise<string> {
 export async function setDefaultDownloadPath(downloadPath: string) {
     try {
         if (await fs.existsDir(downloadPath)) {
-            globals.globalState.tryUpdate('aws.downloadPath', downloadPath)
+            await globals.globalState.update('aws.downloadPath', downloadPath)
         } else {
-            globals.globalState.tryUpdate('aws.downloadPath', path.dirname(downloadPath))
+            await globals.globalState.update('aws.downloadPath', path.dirname(downloadPath))
         }
     } catch (err) {
         getLogger().error('Error while setting "aws.downloadPath"', err as Error)

packages/core/src/shared/globalState.ts

@@ -118,18 +118,25 @@ export class GlobalState implements vscode.Memento {
         }
     }
 
-    /** Asynchronously updates globalState, or logs an error on failure. */
-    tryUpdate(key: globalKey, value: any) {
-        return this.memento.update(key, value).then(
-            undefined, // TODO: log.debug() ?
-            (e) => {
-                getLogger().error('GlobalState: failed to set "%s": %s', key, (e as Error).message)
-            }
-        )
+    /**
+     * Asynchronously updates globalState, or logs an error on failure.
+     *
+     * Only for callers that cannot `await` or don't care about errors and race conditions. Prefer
+     * `await update()` where possible.
+     */
+    tryUpdate(key: globalKey, value: any): void {
+        this.update(key, value).then(undefined, () => {
+            // Errors are logged by update().
+        })
     }
 
-    update(key: globalKey, value: any): Thenable<void> {
-        return this.memento.update(key, value)
+    async update(key: globalKey, value: any): Promise<void> {
+        try {
+            await this.memento.update(key, value)
+        } catch (e) {
+            getLogger().error('GlobalState: failed to set "%s": %s', key, (e as Error).message)
+            throw e
+        }
     }
 
     clear() {