browser: remove "got" in codewhisperer #4291

`got` package is not available in the browser. Replace usage with common `fetch` from `request.ts`

Also:
- refactor request.ts fetch for testing and current usages of the common fetch.
- minor code refactors around some usage of the fetch code.

Author: hayemaxi

src/amazonqFeatureDev/util/upload.ts

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import got from 'got'
-
+import request, { RequestError } from '../../common/request'
 import { getLogger } from '../../shared/logger/logger'
 import { featureName } from '../constants'
 
@@ -17,8 +16,7 @@ import { UploadCodeError } from '../errors'
  */
 export async function uploadCode(url: string, buffer: Buffer, checksumSha256: string, kmsKeyArn?: string) {
     try {
-        await got(url, {
-            method: 'PUT',
+        await request.fetch('PUT', url, {
             body: buffer,
             headers: {
                 'Content-Type': 'application/zip',
@@ -29,9 +27,11 @@ export async function uploadCode(url: string, buffer: Buffer, checksumSha256: st
                     'x-amz-server-side-encryption': 'aws:kms',
                 }),
             },
-        })
+        }).response
     } catch (e: any) {
         getLogger().error(`${featureName}: failed to upload code to s3: ${(e as Error).message}`)
-        throw new UploadCodeError(e instanceof got.HTTPError ? `${e.response.statusCode}` : 'Unknown')
+        throw new UploadCodeError(
+            e instanceof RequestError ? `${e.response.status}: ${e.response.statusText}` : 'Unknown'
+        )
     }
 }

src/applicationcomposer/webviewManager.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
-import fetch from '../common/request'
+import request from '../common/request'
 import { ApplicationComposer } from './composerWebview'
 import { getLogger } from '../shared/logger'
 
@@ -34,7 +34,7 @@ export class ApplicationComposerManager {
 
     private async fetchWebviewHtml() {
         const source = isLocalDev ? localhost : cdn
-        const response = await fetch('GET', `${source}/index.html`).response
+        const response = await request.fetch('GET', `${source}/index.html`).response
         this.webviewHtml = await response.text()
         for (const visualization of this.managedVisualizations.values()) {
             await visualization.refreshPanel(this.extensionContext)

src/codewhisperer/service/securityScanHandler.ts

@@ -11,13 +11,13 @@ import * as codewhispererClient from '../client/codewhisperer'
 import * as CodeWhispererConstants from '../models/constants'
 import { existsSync, statSync, readFileSync } from 'fs'
 import { RawCodeScanIssue } from '../models/model'
-import got from 'got'
 import * as crypto from 'crypto'
 import path = require('path')
 import { pageableToCollection } from '../../shared/utilities/collectionUtils'
 import { ArtifactMap, CreateUploadUrlRequest, CreateUploadUrlResponse } from '../client/codewhispereruserclient'
 import { Truncation } from '../util/dependencyGraph/dependencyGraph'
 import { TelemetryHelper } from '../util/telemetryHelper'
+import request from '../../common/request'
 
 export async function listScanResults(
     client: DefaultCodeWhispererClient,
@@ -176,25 +176,20 @@ export function throwIfCancelled() {
 
 export async function uploadArtifactToS3(fileName: string, resp: CreateUploadUrlResponse) {
     const encryptionContext = `{"uploadId":"${resp.uploadId}"}`
-    const headersObj =
-        resp.kmsKeyArn !== '' || resp.kmsKeyArn !== undefined
-            ? {
-                  'Content-MD5': getMd5(fileName),
-                  'x-amz-server-side-encryption': 'aws:kms',
-                  'Content-Type': 'application/zip',
-                  'x-amz-server-side-encryption-aws-kms-key-id': resp.kmsKeyArn,
-                  'x-amz-server-side-encryption-context': Buffer.from(encryptionContext, 'utf8').toString('base64'),
-              }
-            : {
-                  'Content-MD5': getMd5(fileName),
-                  'x-amz-server-side-encryption': 'aws:kms',
-                  'Content-Type': 'application/zip',
-                  'x-amz-server-side-encryption-context': Buffer.from(encryptionContext, 'utf8').toString('base64'),
-              }
-    const response = await got(resp.uploadUrl, {
-        method: 'PUT',
+    const headersObj: Record<string, string> = {
+        'Content-MD5': getMd5(fileName),
+        'x-amz-server-side-encryption': 'aws:kms',
+        'Content-Type': 'application/zip',
+        'x-amz-server-side-encryption-context': Buffer.from(encryptionContext, 'utf8').toString('base64'),
+    }
+
+    if (resp.kmsKeyArn !== '' && resp.kmsKeyArn !== undefined) {
+        headersObj['x-amz-server-side-encryption-aws-kms-key-id'] = resp.kmsKeyArn
+    }
+
+    const response = await request.fetch('PUT', resp.uploadUrl, {
         body: readFileSync(fileName),
         headers: headersObj,
-    })
-    getLogger().debug(`StatusCode: ${response.statusCode}`)
+    }).response
+    getLogger().debug(`StatusCode: ${response.status}, Text: ${response.statusText}`)
 }

src/codewhisperer/service/transformByQHandler.ts

@@ -16,14 +16,14 @@ import * as os from 'os'
 import * as vscode from 'vscode'
 import { spawnSync } from 'child_process'
 import AdmZip from 'adm-zip'
-import fetch from '../../common/request'
 import globals from '../../shared/extensionGlobals'
 import { CodeTransformMavenBuildCommand, telemetry } from '../../shared/telemetry/telemetry'
 import { ToolkitError } from '../../shared/errors'
 import { codeTransformTelemetryState } from '../../amazonqGumby/telemetry/codeTransformTelemetryState'
 import { calculateTotalLatency, javapOutputToTelemetryValue } from '../../amazonqGumby/telemetry/codeTransformTelemetry'
 import { TransformByQJavaProjectNotFound } from '../../amazonqGumby/models/model'
 import { MetadataResult } from '../../shared/telemetry/telemetryClient'
+import request from '../../common/request'
 
 /* TODO: once supported in all browsers and past "experimental" mode, use Intl DurationFormat:
  * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DurationFormat#browser_compatibility
@@ -178,8 +178,10 @@ export async function uploadArtifactToS3(fileName: string, resp: CreateUploadUrl
     throwIfCancelled()
     try {
         const apiStartTime = Date.now()
-        const response = await fetch('PUT', resp.uploadUrl, { body: fs.readFileSync(fileName), headers: headersObj })
-            .response
+        const response = await request.fetch('PUT', resp.uploadUrl, {
+            body: fs.readFileSync(fileName),
+            headers: headersObj,
+        }).response
         telemetry.codeTransform_logApiLatency.emit({
             codeTransformApiNames: 'UploadZip',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),

src/common/request.ts

@@ -5,25 +5,28 @@
 
 import crossFetch from 'cross-fetch'
 
-/**
- * Make a fetch request.
- *
- * @example
- * const request = fetch('GET', 'https://example.com')
- * setTimeout(() => request.cancel(), 10_000)
- * const response = await request.response
- * const text = await response.text()
- *
- * @param wrappedFetch - The actual fetch implementation
- */
-export default function fetch(
-    method: RequestMethod,
-    url: string,
-    params?: RequestParamsArg,
-    wrappedFetch = crossFetch
-): FetchRequest {
-    return new FetchRequest(url, { ...params, method }, wrappedFetch)
+const request = {
+    /**
+     * Make a fetch request.
+     *
+     * @example
+     * const request = fetch('GET', 'https://example.com')
+     * setTimeout(() => request.cancel(), 10_000)
+     * const response = await request.response
+     * const text = await response.text()
+     *
+     * @param wrappedFetch - The actual fetch implementation
+     */
+    fetch: function (
+        method: RequestMethod,
+        url: string,
+        params?: RequestParamsArg,
+        wrappedFetch = crossFetch
+    ): FetchRequest {
+        return new FetchRequest(url, { ...params, method }, wrappedFetch)
+    },
 }
+export default request
 
 type RequestMethod = 'GET' | 'POST' | 'PUT'
 /** All possible params of a fetch request (eg: headers) */

src/test/amazonqFeatureDev/session/sessionState.test.ts

@@ -6,7 +6,6 @@
 import * as vscode from 'vscode'
 import assert from 'assert'
 import sinon from 'sinon'
-import * as got from 'got'
 import { RefinementState, PrepareRefinementState } from '../../../amazonqFeatureDev/session/sessionState'
 import { SessionStateConfig, SessionStateAction } from '../../../amazonqFeatureDev/types'
 import { Messenger } from '../../../amazonqFeatureDev/controllers/chat/messenger/messenger'
@@ -16,6 +15,7 @@ import { FeatureDevClient } from '../../../amazonqFeatureDev/client/featureDev'
 import { PrepareRepoFailedError } from '../../../amazonqFeatureDev/errors'
 import { TelemetryHelper } from '../../../amazonqFeatureDev/util/telemetryHelper'
 import { assertTelemetry } from '../../testUtil'
+import { getFetchStubWithResponse } from '../../common/request.test'
 
 const mockSessionStateAction = (msg?: string): SessionStateAction => {
     return {
@@ -75,7 +75,7 @@ describe('sessionState', () => {
             sinon.stub(vscode.workspace, 'findFiles').resolves([])
             mockCreateUploadUrl = sinon.stub().resolves({ uploadId: '', uploadUrl: '' })
             mockGeneratePlan = sinon.stub().resolves(testApproach)
-            sinon.stub(got, 'default').resolves({ statusCode: 200 })
+            getFetchStubWithResponse({ status: 200 })
 
             const testAction = mockSessionStateAction()
             await new PrepareRefinementState(testConfig, testApproach, tabId).interact(testAction)

src/test/codewhisperer/commands/startSecurityScan.test.ts

@@ -6,7 +6,6 @@
 import assert from 'assert'
 import * as vscode from 'vscode'
 import * as sinon from 'sinon'
-import * as got from 'got'
 import * as semver from 'semver'
 import { DefaultCodeWhispererClient } from '../../../codewhisperer/client/codewhisperer'
 import * as startSecurityScan from '../../../codewhisperer/commands/startSecurityScan'
@@ -21,14 +20,14 @@ import { HttpResponse } from 'aws-sdk'
 import { getTestWindow } from '../../shared/vscode/window'
 import { SeverityLevel } from '../../shared/vscode/message'
 import { cancel } from '../../../shared/localizedText'
-import { sleep } from '../../../shared/utilities/timeoutUtils'
 import {
     codeScanLogsOutputChannelId,
     showScannedFilesMessage,
     stopScanMessage,
 } from '../../../codewhisperer/models/constants'
 import * as model from '../../../codewhisperer/models/model'
 import { CodewhispererSecurityScan } from '../../../shared/telemetry/telemetry.gen'
+import { getFetchStubWithResponse } from '../../common/request.test'
 
 const mockCreateCodeScanResponse = {
     $response: {
@@ -177,7 +176,7 @@ describe('startSecurityScan', function () {
     })
 
     it('Should render security scan result', async function () {
-        sinon.stub(got, 'default').resolves({ statusCode: 200 })
+        getFetchStubWithResponse({ status: 200, statusText: 'testing stub' })
         const commandSpy = sinon.spy(vscode.commands, 'executeCommand')
         const securityScanRenderSpy = sinon.spy(diagnosticsProvider, 'initSecurityScanRender')
 
@@ -194,11 +193,7 @@ describe('startSecurityScan', function () {
     })
 
     it('Should stop security scan', async function () {
-        sinon.stub(got, 'default').callsFake(() => {
-            return sleep(1000).then(() => {
-                return { statusCode: 200 }
-            }) as any
-        })
+        getFetchStubWithResponse({ status: 200, statusText: 'testing stub' })
         const securityScanRenderSpy = sinon.spy(diagnosticsProvider, 'initSecurityScanRender')
         const securityScanStoppedErrorSpy = sinon.spy(model, 'CodeScanStoppedError')
         const testWindow = getTestWindow()
@@ -223,11 +218,7 @@ describe('startSecurityScan', function () {
     })
 
     it('Should not stop security scan when not confirmed', async function () {
-        sinon.stub(got, 'default').callsFake(() => {
-            return sleep(1000).then(() => {
-                return { statusCode: 200 }
-            }) as any
-        })
+        getFetchStubWithResponse({ status: 200, statusText: 'testing stub' })
         const securityScanRenderSpy = sinon.spy(diagnosticsProvider, 'initSecurityScanRender')
         const securityScanStoppedErrorSpy = sinon.spy(model, 'CodeScanStoppedError')
         const testWindow = getTestWindow()
@@ -256,7 +247,7 @@ describe('startSecurityScan', function () {
             this.skip()
         }
         const commandSpy = sinon.spy(vscode.commands, 'executeCommand')
-        sinon.stub(got, 'default').resolves({ statusCode: 200 })
+        getFetchStubWithResponse({ status: 200, statusText: 'testing stub' })
         const testWindow = getTestWindow()
         testWindow.onDidShowMessage(message => {
             if (message.message.includes('Security scan completed')) {

src/test/common/request.test.ts

@@ -6,9 +6,14 @@
 import { SinonStub, stub } from 'sinon'
 import assert from 'assert'
 import crossFetch from 'cross-fetch'
-import fetch, { RequestCancelledError, RequestError } from '../../common/request'
+import request, { RequestCancelledError, RequestError } from '../../common/request'
 import globals from '../../shared/extensionGlobals'
 
+// Returns a stubbed fetch for other tests.
+export function getFetchStubWithResponse(response: Partial<Response>) {
+    return stub(request, 'fetch').returns({ response: new Promise((res, _) => res(response)) } as any)
+}
+
 describe('fetch()', function () {
     /** We built a wrapper around an actual fetch implementation, this is a fake stub of it for testing. */
     let wrappedFetch: SinonStub<Parameters<typeof crossFetch>, Promise<Response>>
@@ -25,7 +30,7 @@ describe('fetch()', function () {
     })
 
     it('passes the expected arguments to the wrapped fetch implementation', async function () {
-        const response = await fetch('GET', 'http://test.com', { mode: 'cors' }, wrappedFetch).response
+        const response = await request.fetch('GET', 'http://test.com', { mode: 'cors' }, wrappedFetch).response
 
         assert.strictEqual(wrappedFetch.callCount, 1)
         assert.deepStrictEqual(wrappedFetch.getCall(0).args, [
@@ -44,10 +49,10 @@ describe('fetch()', function () {
             status: testStatusCode,
         } as Response)
 
-        const request = fetch('GET', 'http://test.com', {}, wrappedFetch)
+        const req = request.fetch('GET', 'http://test.com', {}, wrappedFetch)
 
         await assert.rejects(async () => {
-            await request.response
+            await req.response
         }, RequestError)
     })
 
@@ -64,16 +69,16 @@ describe('fetch()', function () {
         // - Once all microTasks are completed/exhausted, only then will the event loop
         //   pickup a single macrotask. This process then repeats.
 
-        const request = fetch('GET', 'https://aws.amazon.com/', {})
+        const req = request.fetch('GET', 'https://aws.amazon.com/', {})
 
         // cancel() call is part of the macrotask queue.
         globals.clock.setTimeout(() => {
-            request.cancel()
+            req.cancel()
         }, 0)
 
         // The response and the wrapped fetch request pushed to the microtask queue.
         await assert.rejects(
-            () => request.response,
+            () => req.response,
             e => {
                 return e instanceof RequestCancelledError
             }

src/testE2E/amazonqGumby/transformByQ.test.ts

@@ -5,7 +5,7 @@
 
 import assert from 'assert'
 import { getSha256, uploadArtifactToS3, zipCode } from '../../codewhisperer/service/transformByQHandler'
-import fetch from '../../common/request'
+import request from '../../common/request'
 import * as CodeWhispererConstants from '../../codewhisperer/models/constants'
 import * as codeWhisperer from '../../codewhisperer/client/codewhisperer'
 import * as os from 'os'
@@ -54,7 +54,7 @@ describe('transformByQ', async function () {
         }
         await assert.rejects(
             () =>
-                fetch('PUT', response.uploadUrl, { body: fs.readFileSync(zippedCodePath), headers: headersObj })
+                request.fetch('PUT', response.uploadUrl, { body: fs.readFileSync(zippedCodePath), headers: headersObj })
                     .response
         )
     })

src/testInteg/common/request.ts

@@ -4,12 +4,12 @@
  */
 
 import { endpointsFileUrl } from '../../shared/constants'
-import fetch from '../../common/request'
+import request from '../../common/request'
 import assert from 'assert'
 
 describe('fetch()', function () {
     it('makes a fetch request', async function () {
-        const response = await fetch('GET', endpointsFileUrl).response
+        const response = await request.fetch('GET', endpointsFileUrl).response
         assert.strictEqual(response.ok, true)
         assert.strictEqual(response.status, 200)
     })