initial work

Author: Hweinstock

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

@@ -17,7 +17,7 @@ import {
 import assert from 'assert'
 import sinon from 'sinon'
 import * as vscode from 'vscode'
-import fs from 'fs'
+import * as fs from 'fs'
 
 const mockCodeScanFindings = JSON.stringify([
     {
@@ -72,7 +72,7 @@ describe('securityScanHandler', function () {
         let mockClient: Stub<DefaultCodeWhispererClient>
         beforeEach(function () {
             mockClient = stub(DefaultCodeWhispererClient)
-            sinon.stub(fs, 'existsSync').returns(true)
+            sinon.stub(fs, 'existsSync').resolves(true)
             sinon.stub(fs, 'statSync').returns({ isFile: () => true } as fs.Stats)
         })
 

packages/core/src/amazonqGumby/chat/controller/controller.ts

@@ -5,7 +5,6 @@
  * This class is responsible for responding to UI events by calling
  * the Gumby extension.
  */
-import nodefs from 'fs'
 import path from 'path'
 import * as vscode from 'vscode'
 import { GumbyNamedMessages, Messenger } from './messenger/messenger'
@@ -56,6 +55,7 @@ import { getAuthType } from '../../../codewhisperer/service/transformByQ/transfo
 import DependencyVersions from '../../models/dependencies'
 import { getStringHash } from '../../../shared/utilities/textUtilities'
 import { getVersionData } from '../../../codewhisperer/service/transformByQ/transformMavenHandler'
+import { fs } from '../../../shared'
 
 // These events can be interactions within the chat,
 // or elsewhere in the IDE
@@ -488,7 +488,7 @@ export class GumbyController {
         const session = this.sessionStorage.getSession()
         switch (session.conversationState) {
             case ConversationState.PROMPT_JAVA_HOME: {
-                const pathToJavaHome = extractPath(data.message)
+                const pathToJavaHome = await extractPath(data.message)
 
                 if (pathToJavaHome) {
                     await this.prepareProjectForSubmission({
@@ -562,7 +562,7 @@ export class GumbyController {
  * @param text
  * @returns the absolute path if path points to existing folder, otherwise undefined
  */
-function extractPath(text: string): string | undefined {
+async function extractPath(text: string): Promise<string | undefined> {
     const resolvedPath = path.resolve(text.trim())
-    return nodefs.existsSync(resolvedPath) ? resolvedPath : undefined
+    return (await fs.exists(resolvedPath)) ? resolvedPath : undefined
 }

packages/core/src/awsService/accessanalyzer/vue/iamPolicyChecks.ts

@@ -4,7 +4,6 @@
  */
 
 import * as vscode from 'vscode'
-import * as fs from 'fs'
 import * as path from 'path'
 import { getLogger, Logger } from '../../../shared/logger'
 import { localize } from '../../../shared/utilities/vsCodeUtils'
@@ -15,7 +14,7 @@ import { AccessAnalyzer, SharedIniFileCredentials } from 'aws-sdk'
 import { execFileSync } from 'child_process'
 import { ToolkitError } from '../../../shared/errors'
 import { makeTemporaryToolkitFolder, tryRemoveFolder } from '../../../shared/filesystemUtilities'
-import { globals } from '../../../shared'
+import { fs, globals } from '../../../shared'
 import {
     IamPolicyChecksConstants,
     PolicyChecksCheckType,
@@ -331,7 +330,7 @@ export class IamPolicyChecksWebview extends VueWebview {
         const document = IamPolicyChecksWebview.editedDocumentFileName
         customPolicyCheckDiagnosticCollection.clear()
         if (referenceDocument !== '') {
-            fs.writeFileSync(tempFilePath, referenceDocument)
+            await fs.writeFile(tempFilePath, referenceDocument)
         } else {
             this.onCustomPolicyCheckResponse.fire([
                 IamPolicyChecksConstants.MissingReferenceDocError,
@@ -807,8 +806,8 @@ export async function renderIamPolicyChecks(context: ExtContext): Promise<VueWeb
 
 // Helper function to get document contents from a path
 export async function _readCustomChecksFile(input: string): Promise<string> {
-    if (fs.existsSync(input)) {
-        return fs.readFileSync(input).toString()
+    if (await fs.exists(input)) {
+        return (await fs.readFileBytes(input)).toString()
     } else {
         try {
             const [region, bucket, key] = parseS3Uri(input)

packages/core/src/codewhisperer/commands/startTransformByQ.ts

@@ -4,7 +4,6 @@
  */
 
 import * as vscode from 'vscode'
-import * as fs from 'fs'
 import * as os from 'os'
 import path from 'path'
 import { getLogger } from '../../shared/logger'
@@ -72,7 +71,7 @@ import DependencyVersions from '../../amazonqGumby/models/dependencies'
 import { dependencyNoAvailableVersions } from '../../amazonqGumby/models/constants'
 import { HumanInTheLoopManager } from '../service/transformByQ/humanInTheLoopManager'
 import { setContext } from '../../shared/vscode/setContext'
-import { makeTemporaryToolkitFolder } from '../../shared'
+import { fs, makeTemporaryToolkitFolder } from '../../shared'
 import globals from '../../shared/extensionGlobals'
 
 function getFeedbackCommentData() {
@@ -95,7 +94,7 @@ export async function processTransformFormInput(
 export async function setMaven() {
     let mavenWrapperExecutableName = os.platform() === 'win32' ? 'mvnw.cmd' : 'mvnw'
     const mavenWrapperExecutablePath = path.join(transformByQState.getProjectPath(), mavenWrapperExecutableName)
-    if (fs.existsSync(mavenWrapperExecutablePath)) {
+    if (await fs.exists(mavenWrapperExecutablePath)) {
         if (mavenWrapperExecutableName === 'mvnw') {
             mavenWrapperExecutableName = './mvnw' // add the './' for non-Windows
         } else if (mavenWrapperExecutableName === 'mvnw.cmd') {
@@ -234,8 +233,8 @@ export async function parseBuildFile() {
         const alias = path.basename(os.homedir())
         absolutePaths.push(alias)
         const buildFilePath = path.join(transformByQState.getProjectPath(), 'pom.xml')
-        if (fs.existsSync(buildFilePath)) {
-            const buildFileContents = fs.readFileSync(buildFilePath).toString().toLowerCase()
+        if (await fs.exists(buildFilePath)) {
+            const buildFileContents = (await fs.readFileBytes(buildFilePath)).toString().toLowerCase()
             const detectedPaths = []
             for (const absolutePath of absolutePaths) {
                 if (buildFileContents.includes(absolutePath)) {
@@ -599,7 +598,7 @@ export async function pollTransformationStatusUntilPlanReady(jobId: string) {
             throw e
         }
 
-        if (fs.existsSync(pathToLog) && !transformByQState.isCancelled()) {
+        if ((await fs.exists(pathToLog)) && !transformByQState.isCancelled()) {
             throw new TransformationPreBuildError()
         } else {
             // not strictly needed to reset path here and above; doing it just to represent unavailable logs
@@ -620,7 +619,7 @@ export async function pollTransformationStatusUntilPlanReady(jobId: string) {
 
     if (plan !== undefined) {
         const planFilePath = path.join(transformByQState.getProjectPath(), 'transformation-plan.md')
-        fs.writeFileSync(planFilePath, plan)
+        await fs.writeFile(planFilePath, plan)
         await vscode.commands.executeCommand('markdown.showPreview', vscode.Uri.file(planFilePath))
         transformByQState.setPlanFilePath(planFilePath)
         await setContext('gumby.isPlanAvailable', true)
@@ -752,7 +751,7 @@ export async function postTransformationJob() {
     }
 
     if (transformByQState.getPayloadFilePath() !== '') {
-        fs.rmSync(transformByQState.getPayloadFilePath(), { recursive: true, force: true }) // delete ZIP if it exists
+        await fs.delete(transformByQState.getPayloadFilePath(), { recursive: true, force: true }) // delete ZIP if it exists
     }
 }
 

packages/core/src/codewhisperer/service/securityScanHandler.ts

@@ -16,7 +16,7 @@ import {
 import { sleep } from '../../shared/utilities/timeoutUtils'
 import * as codewhispererClient from '../client/codewhisperer'
 import * as CodeWhispererConstants from '../models/constants'
-import { existsSync, statSync, readFileSync } from 'fs'
+import { existsSync, statSync } from 'fs'
 import { RawCodeScanIssue } from '../models/model'
 import * as crypto from 'crypto'
 import path = require('path')
@@ -39,6 +39,7 @@ import {
     UploadArtifactToS3Error,
 } from '../models/errors'
 import { getTelemetryReasonDesc } from '../../shared/errors'
+import { fs } from '../../shared'
 
 export async function listScanResults(
     client: DefaultCodeWhispererClient,
@@ -220,7 +221,7 @@ export async function getPresignedUrlAndUpload(
         throw new InvalidSourceZipError()
     }
     const srcReq: CreateUploadUrlRequest = {
-        contentMd5: getMd5(zipMetadata.zipFilePath),
+        contentMd5: await getMd5(zipMetadata.zipFilePath),
         artifactType: 'SourceCode',
         uploadIntent: getUploadIntent(scope),
         uploadContext: {
@@ -251,9 +252,9 @@ function getUploadIntent(scope: CodeWhispererConstants.CodeAnalysisScope): Uploa
         : CodeWhispererConstants.projectScanUploadIntent
 }
 
-function getMd5(fileName: string) {
+async function getMd5(fileName: string) {
     const hasher = crypto.createHash('md5')
-    hasher.update(readFileSync(fileName))
+    hasher.update(await fs.readFileBytes(fileName))
     return hasher.digest('base64')
 }
 
@@ -288,7 +289,7 @@ export async function uploadArtifactToS3(
     const logger = getLoggerForScope(scope)
     const encryptionContext = `{"uploadId":"${resp.uploadId}"}`
     const headersObj: Record<string, string> = {
-        'Content-MD5': getMd5(fileName),
+        'Content-MD5': await 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'),
@@ -300,7 +301,7 @@ export async function uploadArtifactToS3(
 
     try {
         const response = await request.fetch('PUT', resp.uploadUrl, {
-            body: readFileSync(fileName),
+            body: await fs.readFileBytes(fileName),
             headers: resp?.requestHeaders ?? headersObj,
         }).response
         logger.debug(`StatusCode: ${response.status}, Text: ${response.statusText}`)

packages/core/src/codewhisperer/service/transformByQ/transformApiHandler.ts

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import * as vscode from 'vscode'
-import * as nodefs from 'fs'
 import * as path from 'path'
 import * as os from 'os'
 import * as codeWhisperer from '../../client/codewhisperer'
@@ -47,6 +46,7 @@ import { ExportIntent, TransformationDownloadArtifactType } from '@amzn/codewhis
 import fs from '../../../shared/fs/fs'
 import { ChatSessionManager } from '../../../amazonqGumby/chat/storages/chatSession'
 import { convertToTimeString, encodeHTML } from '../../../shared/utilities/textUtilities'
+import { readdirSync } from 'fs'
 
 export function getSha256(buffer: Buffer) {
     const hasher = crypto.createHash('sha256')
@@ -109,7 +109,7 @@ export async function uploadArtifactToS3(
 ) {
     throwIfCancelled()
     try {
-        const uploadFileByteSize = (await nodefs.promises.stat(fileName)).size
+        const uploadFileByteSize = (await fs.stat(fileName)).size
         getLogger().info(
             `Uploading project artifact at %s with checksum %s using uploadId: %s and size %s kB`,
             fileName,
@@ -249,7 +249,7 @@ function isExcludedDependencyFile(path: string): boolean {
  * getFilesRecursively on the source code folder.
  */
 function getFilesRecursively(dir: string, isDependenciesFolder: boolean): string[] {
-    const entries = nodefs.readdirSync(dir, { withFileTypes: true })
+    const entries = readdirSync(dir, { withFileTypes: true })
     const files = entries.flatMap((entry) => {
         const res = path.resolve(dir, entry.name)
         // exclude 'target' directory from ZIP (except if zipping dependencies) due to issues in backend
@@ -301,14 +301,14 @@ export async function zipCode({ dependenciesFolder, humanInTheLoopFlag, modulePa
             const sourceFiles = getFilesRecursively(modulePath, false)
             let sourceFilesSize = 0
             for (const file of sourceFiles) {
-                if (nodefs.statSync(file).isDirectory()) {
+                if (await fs.existsDir(file)) {
                     getLogger().info('CodeTransformation: Skipping directory, likely a symlink')
                     continue
                 }
                 const relativePath = path.relative(modulePath, file)
                 const paddedPath = path.join('sources', relativePath)
                 zip.addLocalFile(file, path.dirname(paddedPath))
-                sourceFilesSize += (await nodefs.promises.stat(file)).size
+                sourceFilesSize += (await fs.stat(file)).size
             }
             getLogger().info(`CodeTransformation: source code files size = ${sourceFilesSize}`)
         }
@@ -330,7 +330,7 @@ export async function zipCode({ dependenciesFolder, humanInTheLoopFlag, modulePa
                 // const paddedPath = path.join(`dependencies/${dependenciesFolder.name}`, relativePath)
                 const paddedPath = path.join(`dependencies/`, relativePath)
                 zip.addLocalFile(file, path.dirname(paddedPath))
-                dependencyFilesSize += (await nodefs.promises.stat(file)).size
+                dependencyFilesSize += (await fs.stat(file)).size
             }
             getLogger().info(`CodeTransformation: dependency files size = ${dependencyFilesSize}`)
             dependenciesCopied = true
@@ -365,7 +365,7 @@ export async function zipCode({ dependenciesFolder, humanInTheLoopFlag, modulePa
         }
     }
 
-    const zipSize = (await nodefs.promises.stat(tempFilePath)).size
+    const zipSize = (await fs.stat(tempFilePath)).size
 
     const exceedsLimit = zipSize > CodeWhispererConstants.uploadZipSizeLimitInBytes
 
@@ -408,8 +408,8 @@ export async function startJob(uploadId: string) {
     }
 }
 
-export function getImageAsBase64(filePath: string) {
-    const fileContents = nodefs.readFileSync(filePath, { encoding: 'base64' })
+export async function getImageAsBase64(filePath: string) {
+    const fileContents = Buffer.from(await fs.readFileBytes(filePath)).toString('base64')
     return `data:image/svg+xml;base64,${fileContents}`
 }
 
@@ -418,7 +418,7 @@ export function getImageAsBase64(filePath: string) {
  * ex. getIcon('transform-file') returns the 'transform-file-light.svg' icon if user has a light theme enabled,
  * otherwise 'transform-file-dark.svg' is returned.
  */
-export function getTransformationIcon(name: string) {
+export async function getTransformationIcon(name: string) {
     let iconPath = ''
     switch (name) {
         case 'linesOfCode':
@@ -448,7 +448,7 @@ export function getTransformationIcon(name: string) {
     } else {
         iconPath += '-dark.svg'
     }
-    return getImageAsBase64(globals.context.asAbsolutePath(path.join('resources/icons/aws/amazonq', iconPath)))
+    return await getImageAsBase64(globals.context.asAbsolutePath(path.join('resources/icons/aws/amazonq', iconPath)))
 }
 
 export function getFormattedString(s: string) {
@@ -495,17 +495,17 @@ export function getTableMapping(stepZeroProgressUpdates: ProgressUpdates) {
     return map
 }
 
-export function getJobStatisticsHtml(jobStatistics: any) {
+export async function getJobStatisticsHtml(jobStatistics: any) {
     let htmlString = ''
     if (jobStatistics.length === 0) {
         return htmlString
     }
     htmlString += `<div style="flex: 1; margin-left: 20px; border: 1px solid #424750; border-radius: 8px; padding: 10px;">`
-    jobStatistics.forEach((stat: { name: string; value: string }) => {
-        htmlString += `<p style="margin-bottom: 4px"><img src="${getTransformationIcon(
+    for (const stat of jobStatistics) {
+        htmlString += `<p style="margin-bottom: 4px"><img src="${await getTransformationIcon(
             stat.name
         )}" style="vertical-align: middle;"> ${getFormattedString(stat.name)}: ${stat.value}</p>`
-    })
+    }
     htmlString += `</div>`
     return htmlString
 }
@@ -533,9 +533,9 @@ export async function getTransformationPlan(jobId: string) {
         const jobStatistics = JSON.parse(tableMapping['0']).rows // ID of '0' reserved for job statistics table
 
         // get logo directly since we only use one logo regardless of color theme
-        const logoIcon = getTransformationIcon('transformLogo')
+        const logoIcon = await getTransformationIcon('transformLogo')
 
-        const arrowIcon = getTransformationIcon('upArrow')
+        const arrowIcon = await getTransformationIcon('upArrow')
 
         let plan = `<style>table {border: 1px solid #424750;}</style>\n\n<a id="top"></a><br><p style="font-size: 24px;"><img src="${logoIcon}" style="margin-right: 15px; vertical-align: middle;"></img><b>${CodeWhispererConstants.planTitle}</b></p><br>`
         const authType = await getAuthType()
@@ -547,7 +547,7 @@ export async function getTransformationPlan(jobId: string) {
         }
         plan += `<div style="display: flex;"><div style="flex: 1; border: 1px solid #424750; border-radius: 8px; padding: 10px;"><p>${
             CodeWhispererConstants.planIntroductionMessage
-        }</p></div>${getJobStatisticsHtml(jobStatistics)}</div>`
+        }</p></div>${await getJobStatisticsHtml(jobStatistics)}</div>`
         plan += `<div style="margin-top: 32px; border: 1px solid #424750; border-radius: 8px; padding: 10px;"><p style="font-size: 18px; margin-bottom: 4px;"><b>${CodeWhispererConstants.planHeaderMessage}</b></p><i>${CodeWhispererConstants.planDisclaimerMessage} <a href="https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/code-transformation.html">Read more.</a></i><br><br>`
         response.transformationPlan.transformationSteps.slice(1).forEach((step) => {
             plan += `<div style="border: 1px solid #424750; border-radius: 8px; padding: 20px;"><div style="display:flex; justify-content:space-between; align-items:center;"><p style="font-size: 16px; margin-bottom: 4px;">${step.name}</p><a href="#top">Scroll to top <img src="${arrowIcon}" style="vertical-align: middle"></a></div><p>${step.description}</p>`

packages/core/src/codewhisperer/service/transformByQ/transformFileHandler.ts

@@ -8,7 +8,6 @@ import * as path from 'path'
 import * as os from 'os'
 import xml2js = require('xml2js')
 import * as CodeWhispererConstants from '../../models/constants'
-import { existsSync, writeFileSync } from 'fs'
 import { BuildSystem, FolderInfo, transformByQState } from '../../models/model'
 import { IManifestFile } from '../../../amazonqFeatureDev/models'
 import fs from '../../../shared/fs/fs'
@@ -25,13 +24,13 @@ export function getDependenciesFolderInfo(): FolderInfo {
 
 export async function writeLogs() {
     const logFilePath = path.join(os.tmpdir(), 'build-logs.txt')
-    writeFileSync(logFilePath, transformByQState.getErrorLog())
+    await fs.writeFile(logFilePath, transformByQState.getErrorLog())
     return logFilePath
 }
 
 export async function checkBuildSystem(projectPath: string) {
     const mavenBuildFilePath = path.join(projectPath, 'pom.xml')
-    if (existsSync(mavenBuildFilePath)) {
+    if (await fs.exists(mavenBuildFilePath)) {
         return BuildSystem.Maven
     }
     return BuildSystem.Unknown
@@ -55,7 +54,7 @@ export async function createPomCopy(
 export async function replacePomVersion(pomFileVirtualFileReference: vscode.Uri, version: string, delimiter: string) {
     const pomFileText = await fs.readFileText(pomFileVirtualFileReference.fsPath)
     const pomFileTextWithNewVersion = pomFileText.replace(delimiter, version)
-    writeFileSync(pomFileVirtualFileReference.fsPath, pomFileTextWithNewVersion)
+    await fs.writeFile(pomFileVirtualFileReference.fsPath, pomFileTextWithNewVersion)
 }
 
 export async function getJsonValuesFromManifestFile(