prefer nodefs to fs2 across changes

Author: Hweinstock

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

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import * as vscode from 'vscode'
-import * as fs from 'fs'
+import * as nodefs from 'fs'
 import * as path from 'path'
 import * as os from 'os'
 import * as codeWhisperer from '../../client/codewhisperer'
@@ -44,7 +44,7 @@ import { AuthUtil } from '../../util/authUtil'
 import { createCodeWhispererChatStreamingClient } from '../../../shared/clients/codewhispererChatClient'
 import { downloadExportResultArchive } from '../../../shared/utilities/download'
 import { ExportIntent, TransformationDownloadArtifactType } from '@amzn/codewhisperer-streaming'
-import fs2 from '../../../shared/fs/fs'
+import fs from '../../../shared/fs/fs'
 import { ChatSessionManager } from '../../../amazonqGumby/chat/storages/chatSession'
 import { convertToTimeString, encodeHTML } from '../../../shared/utilities/textUtilities'
 
@@ -109,7 +109,7 @@ export async function uploadArtifactToS3(
 ) {
     throwIfCancelled()
     try {
-        const uploadFileByteSize = (await fs.promises.stat(fileName)).size
+        const uploadFileByteSize = (await nodefs.promises.stat(fileName)).size
         getLogger().info(
             `Uploading project artifact at %s with checksum %s using uploadId: %s and size %s kB`,
             fileName,
@@ -177,7 +177,7 @@ export async function stopJob(jobId: string) {
 }
 
 export async function uploadPayload(payloadFileName: string, uploadContext?: UploadContext) {
-    const buffer = fs.readFileSync(payloadFileName)
+    const buffer = Buffer.from(await fs.readFile(payloadFileName))
     const sha256 = getSha256(buffer)
 
     throwIfCancelled()
@@ -249,7 +249,7 @@ function isExcludedDependencyFile(path: string): boolean {
  * getFilesRecursively on the source code folder.
  */
 function getFilesRecursively(dir: string, isDependenciesFolder: boolean): string[] {
-    const entries = fs.readdirSync(dir, { withFileTypes: true })
+    const entries = nodefs.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,22 +301,22 @@ export async function zipCode({ dependenciesFolder, humanInTheLoopFlag, modulePa
             const sourceFiles = getFilesRecursively(modulePath, false)
             let sourceFilesSize = 0
             for (const file of sourceFiles) {
-                if (fs.statSync(file).isDirectory()) {
+                if (nodefs.statSync(file).isDirectory()) {
                     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 fs.promises.stat(file)).size
+                sourceFilesSize += (await nodefs.promises.stat(file)).size
             }
             getLogger().info(`CodeTransformation: source code files size = ${sourceFilesSize}`)
         }
 
         throwIfCancelled()
 
         let dependencyFiles: string[] = []
-        if (fs.existsSync(dependenciesFolder.path)) {
+        if (await fs.exists(dependenciesFolder.path)) {
             dependencyFiles = getFilesRecursively(dependenciesFolder.path, true)
         }
 
@@ -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 fs.promises.stat(file)).size
+                dependencyFilesSize += (await nodefs.promises.stat(file)).size
             }
             getLogger().info(`CodeTransformation: dependency files size = ${dependencyFilesSize}`)
             dependenciesCopied = true
@@ -353,19 +353,19 @@ export async function zipCode({ dependenciesFolder, humanInTheLoopFlag, modulePa
         }
 
         tempFilePath = path.join(os.tmpdir(), 'zipped-code.zip')
-        fs.writeFileSync(tempFilePath, zip.toBuffer())
-        if (fs.existsSync(dependenciesFolder.path)) {
-            fs.rmSync(dependenciesFolder.path, { recursive: true, force: true })
+        await fs.writeFile(tempFilePath, zip.toBuffer())
+        if (await fs.exists(dependenciesFolder.path)) {
+            await fs.delete(dependenciesFolder.path, { recursive: true, force: true })
         }
     } catch (e: any) {
         throw Error('Failed to zip project')
     } finally {
         if (logFilePath) {
-            fs.rmSync(logFilePath)
+            await fs.delete(logFilePath)
         }
     }
 
-    const zipSize = (await fs.promises.stat(tempFilePath)).size
+    const zipSize = (await nodefs.promises.stat(tempFilePath)).size
 
     const exceedsLimit = zipSize > CodeWhispererConstants.uploadZipSizeLimitInBytes
 
@@ -409,7 +409,7 @@ export async function startJob(uploadId: string) {
 }
 
 export function getImageAsBase64(filePath: string) {
-    const fileContents = fs.readFileSync(filePath, { encoding: 'base64' })
+    const fileContents = nodefs.readFileSync(filePath, { encoding: 'base64' })
     return `data:image/svg+xml;base64,${fileContents}`
 }
 
@@ -725,9 +725,9 @@ export async function downloadAndExtractResultArchive(
     pathToArchiveDir: string,
     downloadArtifactType: TransformationDownloadArtifactType
 ) {
-    const archivePathExists = await fs2.existsDir(pathToArchiveDir)
+    const archivePathExists = await fs.existsDir(pathToArchiveDir)
     if (!archivePathExists) {
-        await fs2.mkdir(pathToArchiveDir)
+        await fs.mkdir(pathToArchiveDir)
     }
 
     const pathToArchive = path.join(pathToArchiveDir, 'ExportResultsArchive.zip')

packages/core/src/shared/extensions/yaml.ts

@@ -53,7 +53,7 @@ export async function activateYamlExtension(): Promise<YamlExtension | undefined
                 // SLOW: This request happens on every keystroke! (5MB+ read from filesystem).
                 // This is a design flaw in this registerContributor() API.
                 // TODO: this function is non-async preventing us from using our fs module.
-                return fs2.readFileSync(vscode.Uri.parse(uri).fsPath).toString()
+                return nodefs.readFileSync(vscode.Uri.parse(uri).fsPath).toString()
             } catch (e) {
                 getLogger().error(`YAML Extension: failed to read schema URI "${uri}": ${e}`)
                 throw new Error(`${getIdeProperties().company} Toolkit could not parse JSON schema URI: ${uri}`)

packages/core/src/test/testUtil.ts

@@ -14,7 +14,7 @@ import globals from '../shared/extensionGlobals'
 import { waitUntil } from '../shared/utilities/timeoutUtils'
 import { MetricName, MetricShapes } from '../shared/telemetry/telemetry'
 import { keys, selectFrom } from '../shared/utilities/tsUtils'
-import fs2 from '../shared/fs/fs'
+import fs from '../shared/fs/fs'
 import { DeclaredCommand } from '../shared/vscode/commands2'
 import { mkdirSync, existsSync } from 'fs'
 import * as nodefs from 'fs/promises'
@@ -31,15 +31,15 @@ export async function toFile(o: any, filepath: string | vscode.Uri) {
     const file = typeof filepath === 'string' ? filepath : filepath.fsPath
     const text = o === undefined ? '' : o.toString()
     const dir = path.dirname(file)
-    await fs2.mkdir(dir)
-    await fs2.writeFile(file, text)
+    await fs.mkdir(dir)
+    await fs.writeFile(file, text)
 }
 
 /**
  * Gets the contents of `filepath` as UTF-8 encoded string.
  */
 export async function fromFile(filepath: string): Promise<string> {
-    return fs2.readFileAsString(filepath)
+    return await fs.readFileAsString(filepath)
 }
 
 /** Gets the full path to the Toolkit source root on this machine. */
@@ -155,7 +155,7 @@ export async function createTestFile(fileName: string): Promise<vscode.Uri> {
     const tempFolder = await makeTemporaryToolkitFolder()
     testTempDirs.push(tempFolder) // ensures this is deleted at the end
     const tempFilePath = path.join(tempFolder, fileName)
-    await fs2.writeFile(tempFilePath, '')
+    await fs.writeFile(tempFilePath, '')
     return vscode.Uri.file(tempFilePath)
 }
 
@@ -203,7 +203,7 @@ export async function createTestWorkspace(
 
     do {
         const tempFilePath = path.join(workspace.uri.fsPath, `${fileNamePrefix}${n}${fileNameSuffix}`)
-        await fs2.writeFile(tempFilePath, fileContent)
+        await fs.writeFile(tempFilePath, fileContent)
     } while (--n > 0)
 
     return workspace
@@ -234,7 +234,7 @@ export function assertEqualPaths(actual: string, expected: string, message?: str
  * Asserts that UTF-8 contents of `file` are equal to `expected`.
  */
 export async function assertFileText(file: string, expected: string, message?: string | Error) {
-    const actualContents = await fs2.readFileAsString(file)
+    const actualContents = await fs.readFileAsString(file)
     assert.strictEqual(actualContents, expected, message)
 }
 
@@ -248,11 +248,11 @@ export async function tickPromise<T>(promise: Promise<T>, clock: FakeTimers.Inst
  * Creates an executable file (including any parent directories) with the given contents.
  */
 export async function createExecutableFile(filepath: string, contents: string): Promise<void> {
-    await fs2.mkdir(path.dirname(filepath))
+    await fs.mkdir(path.dirname(filepath))
     if (process.platform === 'win32') {
-        await fs2.writeFile(filepath, `@echo OFF$\r\n${contents}\r\n`)
+        await fs.writeFile(filepath, `@echo OFF$\r\n${contents}\r\n`)
     } else {
-        await fs2.writeFile(filepath, `#!/bin/sh\n${contents}`)
+        await fs.writeFile(filepath, `#!/bin/sh\n${contents}`)
         nodeFsSync.chmodSync(filepath, 0o744)
     }
 }