refactor(schemas): use globalState abstraction

Author: justinmk3

packages/core/src/shared/globalState.ts

@@ -11,6 +11,8 @@ import { TypeConstructor, cast } from './utilities/typeConstructors'
 type ToolId = 'codecatalyst' | 'codewhisperer' | 'testId'
 export type ToolIdStateKey = `${ToolId}.savedConnectionId`
 
+export type JsonSchemasKey = 'devfileSchemaVersion' | 'samAndCfnSchemaVersion'
+
 type samInitStateKey =
     | 'ACTIVATION_TEMPLATE_PATH_KEY'
     | 'ACTIVATION_LAUNCH_PATH_KEY'
@@ -24,6 +26,7 @@ type globalKey =
     | samInitStateKey
     | stepFunctionsKey
     | ToolIdStateKey
+    | JsonSchemasKey
     | 'aws.amazonq.codewhisperer.newCustomizations'
     | 'aws.amazonq.hasShownWalkthrough'
     | 'aws.amazonq.showTryChatCodeLens'

packages/core/src/shared/schemas.ts

@@ -18,6 +18,7 @@ import { AWS_SCHEME } from './constants'
 import fs from '../shared/fs/fs'
 import { normalizeVSCodeUri } from './utilities/vsCodeUtils'
 import { telemetry } from './telemetry/telemetry'
+import { JsonSchemasKey } from './globalState'
 
 // Note: this file is currently 12+ MB. When requesting it, specify compression/gzip.
 export const samAndCfnSchemaUrl =
@@ -150,7 +151,6 @@ export async function getDefaultSchemas(): Promise<Schemas | undefined> {
 
     // Sam schema is a superset of Cfn schema, so we can use it for both
     const samAndCfnSchemaDestinationUri = GlobalStorage.samAndCfnSchemaDestinationUri()
-    const samAndCfnCacheKey = 'samAndCfnSchemaVersion'
 
     const schemas: Schemas = {}
 
@@ -159,8 +159,7 @@ export async function getDefaultSchemas(): Promise<Schemas | undefined> {
             destination: samAndCfnSchemaDestinationUri,
             eTag: undefined,
             url: samAndCfnSchemaUrl,
-            cacheKey: samAndCfnCacheKey,
-            extensionContext: globals.context,
+            cacheKey: 'samAndCfnSchemaVersion',
             title: schemaPrefix + 'cloudformation.schema.json',
         })
         schemas['cfn'] = samAndCfnSchemaDestinationUri
@@ -173,8 +172,7 @@ export async function getDefaultSchemas(): Promise<Schemas | undefined> {
             destination: samAndCfnSchemaDestinationUri,
             eTag: undefined,
             url: samAndCfnSchemaUrl,
-            cacheKey: samAndCfnCacheKey,
-            extensionContext: globals.context,
+            cacheKey: 'samAndCfnSchemaVersion',
             title: schemaPrefix + 'sam.schema.json',
         })
         schemas['sam'] = samAndCfnSchemaDestinationUri
@@ -188,7 +186,6 @@ export async function getDefaultSchemas(): Promise<Schemas | undefined> {
             version: devfileSchemaVersion,
             url: `https://raw.githubusercontent.com/devfile/api/${devfileSchemaVersion}/schemas/latest/devfile.json`,
             cacheKey: 'devfileSchemaVersion',
-            extensionContext: globals.context,
             title: schemaPrefix + 'devfile.schema.json',
         })
         schemas['devfile'] = devfileSchemaUri
@@ -206,17 +203,15 @@ export async function getDefaultSchemas(): Promise<Schemas | undefined> {
  * @param params.version Remote version
  * @param params.url Url to fetch from
  * @param params.cacheKey Cache key to check version against
- * @param params.extensionContext VSCode extension context
  */
 export async function updateSchemaFromRemote(params: {
     destination: vscode.Uri
     version?: string
     url: string
-    cacheKey: string
-    extensionContext: vscode.ExtensionContext
+    cacheKey: JsonSchemasKey
     title: string
 }): Promise<void> {
-    const cachedVersion = params.extensionContext.globalState.get<string>(params.cacheKey)
+    const cachedVersion = globals.globalState.get<string>(params.cacheKey)
     const outdated = params.version && params.version !== cachedVersion
 
     // Check that the cached file actually can be fetched. Else we might
@@ -257,17 +252,15 @@ export async function updateSchemaFromRemote(params: {
  * @param params.eTag E-Tag to send with fetch request. If this matches the url's it means we can use our cache.
  * @param params.url Url to fetch from
  * @param params.cacheKey Cache key to check version against
- * @param params.extensionContext VSCode extension context
  */
 export async function updateSchemaFromRemoteETag(params: {
     destination: vscode.Uri
     eTag?: string
     url: string
-    cacheKey: string
-    extensionContext: vscode.ExtensionContext
+    cacheKey: JsonSchemasKey
     title: string
 }): Promise<void> {
-    const cachedETag = params.extensionContext.globalState.get<string>(params.cacheKey)
+    const cachedETag = globals.globalState.get<string>(params.cacheKey)
 
     // Check that the cached file actually can be fetched. Else we might
     // never update the cache.
@@ -320,18 +313,15 @@ async function doCacheContent(
         destination: vscode.Uri
         version?: string
         url: string
-        cacheKey: string
-        extensionContext: vscode.ExtensionContext
+        cacheKey: JsonSchemasKey
         title: string
     }
 ): Promise<void> {
     const parsedFile = { ...JSON.parse(content), title: params.title }
     const dir = vscode.Uri.joinPath(params.destination, '..')
     await fs.mkdir(dir)
     await fs.writeFile(params.destination.fsPath, JSON.stringify(parsedFile))
-    await params.extensionContext.globalState.update(params.cacheKey, params.version).then(undefined, (err) => {
-        getLogger().warn(`schemas: failed to update cache key for "${params.title}": ${err?.message}`)
-    })
+    await globals.globalState.update(params.cacheKey, params.version)
 }
 
 /**