test(integ): fix getDefaultSchemas() #3236

Problem:
Test fails in CI because of unpredictable telemetry and extension
activation.

Solution:
- Avoid `FakeExtensionContext` in integ tests.
- In test 1: assert telemetry from extension activation.
- In test 2: clear telemetry.

Author: justinmk3

src/extension.ts

@@ -119,7 +119,7 @@ export async function activate(context: vscode.ExtensionContext) {
         globals.loginManager = loginManager
         globals.awsContextCommands = new AwsContextCommands(regionProvider, Auth.instance)
         globals.sdkClientBuilder = new DefaultAWSClientBuilder(awsContext)
-        globals.schemaService = new SchemaService(context)
+        globals.schemaService = new SchemaService()
         globals.resourceManager = new AwsResourceManager(context)
 
         const settings = Settings.instance

src/integrationTest/schema/schema.test.ts

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import globals from '../../shared/extensionGlobals'
 import { getDefaultSchemas, samAndCfnSchemaUrl } from '../../shared/schemas'
-import { FakeExtensionContext } from '../../test/fakeExtensionContext'
 import {
     getCITestSchemas,
     JSONObject,
@@ -66,14 +66,10 @@ describe('Sam Schema Regression', function () {
 })
 
 describe('getDefaultSchemas()', () => {
-    let extensionContext: FakeExtensionContext
-
-    beforeEach(async () => {
-        extensionContext = await FakeExtensionContext.create()
-    })
+    beforeEach(async () => {})
 
     it('uses cache on subsequent request for CFN/SAM schema', async () => {
-        await getDefaultSchemas(extensionContext)
+        await getDefaultSchemas()
 
         // IMPORTANT: Since CFN and SAM use the same schema, the order their schema is retrieved is irrelevant
 
@@ -92,20 +88,24 @@ describe('getDefaultSchemas()', () => {
     })
 
     it('uses cache for all requests on second function call', async () => {
-        await getDefaultSchemas(extensionContext)
+        globals.telemetry.telemetryEnabled = true
+        globals.telemetry.clearRecords()
+        globals.telemetry.logger.clear()
+
+        await getDefaultSchemas()
         // Call a second time
-        await getDefaultSchemas(extensionContext)
+        await getDefaultSchemas()
 
         // Only cache is used
         assertTelemetry(
             'toolkit_getExternalResource',
             { url: samAndCfnSchemaUrl, passive: true, result: 'Cancelled', reason: 'Cache hit' },
-            2
+            0
         )
         assertTelemetry(
             'toolkit_getExternalResource',
             { url: samAndCfnSchemaUrl, passive: true, result: 'Cancelled', reason: 'Cache hit' },
-            3
+            1
         )
     })
 })

src/shared/schemas.ts

@@ -19,8 +19,9 @@ import { SystemUtilities } from './systemUtilities'
 import { normalizeVSCodeUri } from './utilities/vsCodeUtils'
 import { telemetry } from './telemetry/telemetry'
 
-// Note: this file is currently 12+ MB. When requesting it, specify compression/gzip. 
-export const samAndCfnSchemaUrl = 'https://raw.githubusercontent.com/aws/serverless-application-model/main/samtranslator/schema/schema.json'
+// Note: this file is currently 12+ MB. When requesting it, specify compression/gzip.
+export const samAndCfnSchemaUrl =
+    'https://raw.githubusercontent.com/aws/serverless-application-model/main/samtranslator/schema/schema.json'
 const devfileManifestUrl = 'https://api.github.com/repos/devfile/api/releases/latest'
 const schemaPrefix = `${AWS_SCHEME}://`
 
@@ -53,15 +54,12 @@ export class SchemaService {
     private schemas?: Schemas
     private handlers: Map<SchemaType, SchemaHandler>
 
-    public constructor(
-        private readonly extensionContext: vscode.ExtensionContext,
-        opts?: {
-            /** Assigned in start(). */
-            schemas?: Schemas
-            updatePeriod?: number
-            handlers?: Map<SchemaType, SchemaHandler>
-        }
-    ) {
+    public constructor(opts?: {
+        /** Assigned in start(). */
+        schemas?: Schemas
+        updatePeriod?: number
+        handlers?: Map<SchemaType, SchemaHandler>
+    }) {
         this.updatePeriod = opts?.updatePeriod ?? SchemaService.defaultUpdatePeriodMillis
         this.schemas = opts?.schemas
         this.handlers =
@@ -82,7 +80,7 @@ export class SchemaService {
     }
 
     public async start(): Promise<void> {
-        getDefaultSchemas(this.extensionContext).then(schemas => (this.schemas = schemas))
+        getDefaultSchemas().then(schemas => (this.schemas = schemas))
         await this.startTimer()
     }
 
@@ -139,14 +137,13 @@ export class SchemaService {
  * Checks manifest and downloads new schemas if the manifest version has been bumped.
  * Uses local, predownloaded version if up-to-date or network call fails
  * If the user has not previously used the toolkit and cannot pull the manifest, does not provide template autocomplete.
- * @param extensionContext VSCode extension context
  */
-export async function getDefaultSchemas(extensionContext: vscode.ExtensionContext): Promise<Schemas | undefined> {
-    const devfileSchemaUri = vscode.Uri.joinPath(extensionContext.globalStorageUri, 'devfile.schema.json')
+export async function getDefaultSchemas(): Promise<Schemas | undefined> {
+    const devfileSchemaUri = vscode.Uri.joinPath(globals.context.globalStorageUri, 'devfile.schema.json')
     const devfileSchemaVersion = await getPropertyFromJsonUrl(devfileManifestUrl, 'tag_name')
 
     // Sam schema is a superset of Cfn schema, so we can use it for both
-    const samAndCfnSchemaDestinationUri = vscode.Uri.joinPath(extensionContext.globalStorageUri, 'sam.schema.json')
+    const samAndCfnSchemaDestinationUri = vscode.Uri.joinPath(globals.context.globalStorageUri, 'sam.schema.json')
     const samAndCfnCacheKey = 'samAndCfnSchemaVersion'
 
     const schemas: Schemas = {}
@@ -157,7 +154,7 @@ export async function getDefaultSchemas(extensionContext: vscode.ExtensionContex
             eTag: undefined,
             url: samAndCfnSchemaUrl,
             cacheKey: samAndCfnCacheKey,
-            extensionContext,
+            extensionContext: globals.context,
             title: schemaPrefix + 'cloudformation.schema.json',
         })
         schemas['cfn'] = samAndCfnSchemaDestinationUri
@@ -171,7 +168,7 @@ export async function getDefaultSchemas(extensionContext: vscode.ExtensionContex
             eTag: undefined,
             url: samAndCfnSchemaUrl,
             cacheKey: samAndCfnCacheKey,
-            extensionContext,
+            extensionContext: globals.context,
             title: schemaPrefix + 'sam.schema.json',
         })
         schemas['sam'] = samAndCfnSchemaDestinationUri
@@ -185,7 +182,7 @@ export async function getDefaultSchemas(extensionContext: vscode.ExtensionContex
             version: devfileSchemaVersion,
             url: `https://raw.githubusercontent.com/devfile/api/${devfileSchemaVersion}/schemas/latest/devfile.json`,
             cacheKey: 'devfileSchemaVersion',
-            extensionContext,
+            extensionContext: globals.context,
             title: schemaPrefix + 'devfile.schema.json',
         })
         schemas['devfile'] = devfileSchemaUri

src/test/shared/schemas.test.ts

@@ -6,7 +6,6 @@
 import * as vscode from 'vscode'
 import * as assert from 'assert'
 import { anything, deepEqual, instance, mock, verify } from '../utilities/mockito'
-import { ExtensionContext } from 'vscode'
 import { YamlExtension } from '../../shared/extensions/yaml'
 import {
     JsonSchemaHandler,
@@ -16,23 +15,20 @@ import {
     SchemaType,
     YamlSchemaHandler,
 } from '../../shared/schemas'
-import { FakeExtensionContext } from '../fakeExtensionContext'
 import { Settings } from '../../shared/settings'
 
 describe('SchemaService', function () {
     let service: SchemaService
-    let fakeExtensionContext: ExtensionContext
     let config: Settings
     let fakeYamlExtension: YamlExtension
     const cfnSchema = vscode.Uri.file('cfn')
     const samSchema = vscode.Uri.file('sam')
 
     beforeEach(async function () {
-        fakeExtensionContext = await FakeExtensionContext.create()
         fakeYamlExtension = mock()
         config = new Settings(vscode.ConfigurationTarget.Workspace)
 
-        service = new SchemaService(fakeExtensionContext, {
+        service = new SchemaService({
             schemas: {
                 cfn: cfnSchema,
                 sam: samSchema,
@@ -105,7 +101,7 @@ describe('SchemaService', function () {
 
     it('processes no updates if schemas are unavailable', async function () {
         fakeYamlExtension = mock()
-        service = new SchemaService(fakeExtensionContext, {
+        service = new SchemaService({
             handlers: new Map<SchemaType, SchemaHandler>([
                 ['json', new JsonSchemaHandler()],
                 ['yaml', new YamlSchemaHandler(instance(fakeYamlExtension))],
@@ -123,7 +119,7 @@ describe('SchemaService', function () {
 
     it('processes no updates if yaml extension unavailable', async function () {
         fakeYamlExtension = mock()
-        service = new SchemaService(fakeExtensionContext)
+        service = new SchemaService()
 
         service.registerMapping({
             uri: vscode.Uri.parse('/foo'),