remove instances of fs-extra

Author: Hweinstock

packages/core/src/lambda/config/templates.ts

@@ -11,12 +11,12 @@ import * as _path from 'path'
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import * as fsUtils from '../../shared/filesystemUtilities'
-import * as fsExtra from 'fs-extra'
 import { getLogger, Logger } from '../../shared/logger'
 import { ReadonlyJsonObject } from '../../shared/sam/debugger/awsSamDebugConfiguration'
 import { getTabSizeSetting } from '../../shared/utilities/editorUtilities'
 import { getNormalizedRelativePath } from '../../shared/utilities/pathUtils'
 import { saveDocumentIfDirty } from '../../shared/utilities/textDocumentUtilities'
+import { access } from 'fs/promises'
 import { fs } from '../../shared'
 
 const localize = nls.loadMessageBundle()
@@ -200,7 +200,7 @@ export function showTemplatesConfigurationError(
 export async function ensureTemplatesConfigFileExists(path: string): Promise<void> {
     await fs.mkdir(_path.dirname(path))
     try {
-        await fsExtra.access(path)
+        await access(path)
     } catch {
         await fs.writeFile(path, '{}')
     }

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

@@ -4,12 +4,12 @@
  */
 
 import * as vscode from 'vscode'
-import { readFileSync } from 'fs-extra'
 import { VSCODE_EXTENSION_ID } from '../extensions'
 import { getLogger } from '../logger/logger'
 import { getIdeProperties } from '../extensionUtilities'
 import { activateExtension } from '../utilities/vsCodeUtils'
 import { AWS_SCHEME } from '../constants'
+import * as fs2 from 'fs'
 
 // sourced from https://github.com/redhat-developer/vscode-yaml/blob/3d82d61ea63d3e3a9848fe6b432f8f1f452c1bec/src/schema-extension-api.ts
 // removed everything that is not currently being used
@@ -52,7 +52,8 @@ export async function activateYamlExtension(): Promise<YamlExtension | undefined
             try {
                 // SLOW: This request happens on every keystroke! (5MB+ read from filesystem).
                 // This is a design flaw in this registerContributor() API.
-                return readFileSync(vscode.Uri.parse(uri).fsPath).toString()
+                // TODO: this function is non-async preventing us from using our fs module.
+                return fs2.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/shared/sam/debugger/awsSamDebugger.ts

@@ -5,7 +5,6 @@
 
 import * as semver from 'semver'
 import * as vscode from 'vscode'
-import * as fs from 'fs-extra'
 import * as nls from 'vscode-nls'
 import {
     getCodeRoot,
@@ -67,6 +66,7 @@ import { Logging } from '../../logger/commands'
 import { credentialHelpUrl, samTroubleshootingUrl } from '../../constants'
 import { Auth } from '../../../auth/auth'
 import { openUrl } from '../../utilities/vsCodeUtils'
+import fs from '../../fs/fs'
 
 const localize = nls.loadMessageBundle()
 
@@ -460,7 +460,7 @@ export class SamDebugConfigProvider implements vscode.DebugConfigurationProvider
         const handlerName = await getHandlerName(folder, config)
 
         config.baseBuildDir = resolve(folder.uri.fsPath, config.sam?.buildDir ?? (await makeTemporaryToolkitFolder()))
-        await fs.ensureDir(config.baseBuildDir)
+        await fs.mkdir(config.baseBuildDir)
 
         if (templateInvoke?.templatePath) {
             // Normalize to absolute path.

packages/core/src/shared/sam/debugger/csharpSamDebug.ts

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { chmod, ensureDir, writeFile } from 'fs-extra'
 import * as os from 'os'
 import * as path from 'path'
 import {
@@ -24,6 +23,8 @@ import { getLogger } from '../../logger'
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import globals from '../../extensionGlobals'
+import fs from '../../fs/fs'
+import { chmod } from 'fs/promises'
 const localize = nls.loadMessageBundle()
 
 /**
@@ -109,7 +110,7 @@ function getDebuggerPath(parentFolder: string): string {
 }
 
 async function _installDebugger({ debuggerPath }: InstallDebuggerArgs): Promise<void> {
-    await ensureDir(debuggerPath)
+    await fs.mkdir(debuggerPath)
 
     try {
         getLogger().info(
@@ -202,7 +203,7 @@ async function downloadInstallScript(debuggerPath: string): Promise<string> {
         throw Error(`Failed to download ${installScriptUrl}`)
     }
 
-    await writeFile(installScriptPath, installScript, 'utf8')
+    await fs.writeFile(installScriptPath, installScript, 'utf8')
     await chmod(installScriptPath, 0o700)
 
     return installScriptPath
@@ -224,7 +225,7 @@ export async function makeDotnetDebugConfiguration(
     }
     const pipeArgs = ['-c', `docker exec -i $(docker ps -q -f publish=${config.debugPort}) \${debuggerCommand}`]
     config.debuggerPath = pathutil.normalize(getDebuggerPath(codeUri))
-    await ensureDir(config.debuggerPath)
+    await fs.mkdir(config.debuggerPath)
 
     const isImageLambda = await isImageLambdaConfig(config)
 

packages/core/src/shared/sam/debugger/goSamDebug.ts

@@ -15,8 +15,8 @@ import { DefaultSamLocalInvokeCommand, waitForDebuggerMessages } from '../cli/sa
 import { runLambdaFunction } from '../localLambdaRunner'
 import { SamLaunchRequestArgs } from './awsSamDebugger'
 import { getLogger } from '../../logger'
-import * as fs from 'fs-extra'
-import fs2 from '../../fs/fs'
+import fs from '../../fs/fs'
+import { chmod, unlink } from 'fs/promises'
 import { ChildProcess } from '../../utilities/processUtils'
 import { Timeout } from '../../utilities/timeoutUtils'
 import { execFileSync, SpawnOptions } from 'child_process'
@@ -212,7 +212,7 @@ async function makeInstallScript(debuggerPath: string, isWindows: boolean): Prom
 
     delveVersion = delveVersion.replace('v', '-')
     const installScriptPath: string = path.join(debuggerPath, `install${delveVersion}.${scriptExt}`)
-    const alreadyInstalled = await fs2.exists(installScriptPath)
+    const alreadyInstalled = await fs.exists(installScriptPath)
 
     if (alreadyInstalled && delveVersion !== '') {
         return undefined
@@ -224,7 +224,7 @@ async function makeInstallScript(debuggerPath: string, isWindows: boolean): Prom
     script += `go build -o "${delvePath}" "${delveRepo}/cmd/dlv"\n`
 
     await fs.writeFile(installScriptPath, script, 'utf8')
-    await fs.chmod(installScriptPath, 0o755)
+    await chmod(installScriptPath, 0o755)
 
     return { path: installScriptPath, options: installOptions }
 }
@@ -236,7 +236,7 @@ async function makeInstallScript(debuggerPath: string, isWindows: boolean): Prom
  * @returns False when installation fails
  */
 async function installDebugger(debuggerPath: string): Promise<boolean> {
-    await fs.ensureDir(debuggerPath)
+    await fs.mkdir(debuggerPath)
     const isWindows: boolean = os.platform() === 'win32'
     let installScript: InstallScript | undefined
 
@@ -254,16 +254,16 @@ async function installDebugger(debuggerPath: string): Promise<boolean> {
         })
 
         const code = install.exitCode
-        if (!fs.existsSync(path.join(debuggerPath, 'dlv'))) {
+        if (!(await fs.exists(path.join(debuggerPath, 'dlv')))) {
             throw new Error(`Install script did not generate the Delve binary: exit code ${code}`)
         } else if (code) {
             getLogger().warn(`Install script did not sucessfully run, using old Delve binary...`)
         } else {
             getLogger().info(`Installed Delve debugger in ${debuggerPath}`)
         }
     } catch (e) {
-        if (installScript && (await fs2.exists(installScript.path))) {
-            fs.unlinkSync(installScript.path) // Removes the install script since it failed
+        if (installScript && (await fs.exists(installScript.path))) {
+            await unlink(installScript.path) // Removes the install script since it failed
         }
         getLogger().error('Failed to cross-compile Delve debugger: %O', e as Error)
         return false

packages/core/src/shared/sam/debugger/pythonSamDebug.ts

@@ -4,7 +4,6 @@
  */
 
 import { Runtime } from 'aws-sdk/clients/lambda'
-import { writeFile } from 'fs-extra'
 import * as os from 'os'
 import * as path from 'path'
 import {
@@ -26,6 +25,7 @@ import { getWorkspaceRelativePath } from '../../utilities/workspaceUtils'
 import { DefaultSamLocalInvokeCommand, waitForDebuggerMessages } from '../cli/samCliLocalInvoke'
 import { runLambdaFunction } from '../localLambdaRunner'
 import { SamLaunchRequestArgs } from './awsSamDebugger'
+import fs from '../../fs/fs'
 
 /** SAM will mount the --debugger-path to /tmp/lambci_debug_files */
 const debugpyWrapperPath = '/tmp/lambci_debug_files/py_debug_wrapper.py'
@@ -56,14 +56,14 @@ async function makePythonDebugManifest(params: {
     if (params.useIkpdb) {
         manifestText = manifestText.replace(/[ \t]*ikp3db\b[^\r\n]*/, '')
         manifestText += `${os.EOL}ikp3db`
-        await writeFile(debugManifestPath, manifestText)
+        await fs.writeFile(debugManifestPath, manifestText)
         return debugManifestPath
     }
 
     // TODO: If another module name includes the string "debugpy", this will be skipped...
     if (!params.useIkpdb && !manifestText.includes('debugpy')) {
         manifestText += `${os.EOL}debugpy>=1.0,<2`
-        await writeFile(debugManifestPath, manifestText)
+        await fs.writeFile(debugManifestPath, manifestText)
 
         return debugManifestPath
     }

packages/core/src/shared/sam/debugger/typescriptSamDebug.ts

@@ -4,7 +4,6 @@
  */
 
 import { existsSync, PathLike, readFileSync } from 'fs'
-import { writeFileSync } from 'fs-extra'
 import * as path from 'path'
 import * as vscode from 'vscode'
 import { isImageLambdaConfig, NodejsDebugConfiguration } from '../../../lambda/local/debugConfiguration'
@@ -18,6 +17,7 @@ import { DefaultSamLocalInvokeCommand, waitForDebuggerMessages } from '../cli/sa
 import { runLambdaFunction, waitForPort } from '../localLambdaRunner'
 import { SamLaunchRequestArgs } from './awsSamDebugger'
 import { findTypescriptCompiler } from '../../utilities/pathFind'
+import fs from '../../fs/fs'
 
 const tsConfigFile = 'aws-toolkit-tsconfig.json'
 
@@ -202,7 +202,7 @@ async function compileTypeScript(config: SamLaunchRequestArgs): Promise<void> {
     types.push('node')
     compilerOptions.types = [...new Set(types)]
 
-    writeFileSync(tsConfigPath, JSON.stringify(tsConfig, undefined, 4))
+    await fs.writeFile(tsConfigPath, JSON.stringify(tsConfig, undefined, 4))
 
     // resolve ts lambda handler to point into build directory relative to codeRoot
     const tsLambdaHandler = path.relative(config.codeRoot, path.join(tsBuildDir, config.invokeTarget.lambdaHandler))

packages/core/src/shared/sam/localLambdaRunner.ts

@@ -9,7 +9,6 @@ import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import * as pathutil from '../utilities/pathUtils'
 import got, { OptionsOfTextResponseBody, RequestError } from 'got'
-import { copyFile, readFile, remove, writeFile } from 'fs-extra'
 import { isImageLambdaConfig } from '../../lambda/local/debugConfiguration'
 import { getFamily, RuntimeFamily } from '../../lambda/models/samLambdaRuntime'
 import { ExtContext } from '../extensions'
@@ -31,6 +30,7 @@ import { sleep } from '../utilities/timeoutUtils'
 import { showMessageWithCancel } from '../utilities/messages'
 import { ToolkitError, UnknownError } from '../errors'
 import { SamCliError } from './cli/samCliInvokerUtils'
+import fs from '../fs/fs'
 
 const localize = nls.loadMessageBundle()
 
@@ -259,7 +259,7 @@ async function invokeLambdaHandler(
             throw ToolkitError.chain(err, msg)
         } finally {
             if (config.sam?.buildDir === undefined) {
-                await remove(config.templatePath)
+                await fs.delete(config.templatePath)
             }
         }
     }
@@ -307,7 +307,7 @@ export async function runLambdaFunction(
         const payload =
             config.eventPayloadFile === undefined
                 ? undefined
-                : JSON.parse(await readFile(config.eventPayloadFile, { encoding: 'utf-8' }))
+                : JSON.parse(await fs.readFileAsString(config.eventPayloadFile))
 
         apiRequest = requestLocalApi(timer, config.api!, config.apiPort!, payload)
     }
@@ -571,14 +571,14 @@ export async function makeJsonFiles(config: SamLaunchRequestArgs): Promise<void>
     if (Object.keys(configEnv).length !== 0) {
         const env = JSON.stringify(getEnvironmentVariables(makeResourceName(config), configEnv))
         config.envFile = path.join(config.baseBuildDir!, 'env-vars.json')
-        await writeFile(config.envFile, env)
+        await fs.writeFile(config.envFile, env)
     }
 
     // container-env-vars.json
     if (config.containerEnvVars) {
         config.containerEnvFile = path.join(config.baseBuildDir!, 'container-env-vars.json')
         const containerEnv = JSON.stringify(config.containerEnvVars)
-        await writeFile(config.containerEnvFile, containerEnv)
+        await fs.writeFile(config.containerEnvFile, containerEnv)
     }
 
     // event.json
@@ -594,12 +594,12 @@ export async function makeJsonFiles(config: SamLaunchRequestArgs): Promise<void>
     if (payloadPath) {
         const fullpath = tryGetAbsolutePath(config.workspaceFolder, payloadPath)
         try {
-            JSON.parse(await readFile(fullpath, { encoding: 'utf-8' }))
+            JSON.parse(await fs.readFileAsString(fullpath))
         } catch (e) {
             throw Error(`Invalid JSON in payload file: ${payloadPath}`)
         }
-        await copyFile(fullpath, config.eventPayloadFile)
+        await fs.copy(fullpath, config.eventPayloadFile)
     } else {
-        await writeFile(config.eventPayloadFile, JSON.stringify(payloadObj || {}))
+        await fs.writeFile(config.eventPayloadFile, JSON.stringify(payloadObj || {}))
     }
 }

packages/core/src/shared/templates/sam/samTemplateGenerator.ts

@@ -3,13 +3,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { mkdirp, writeFile } from 'fs-extra'
 import * as yaml from 'js-yaml'
 import * as path from 'path'
 import { Architecture } from '../../../lambda/models/samLambdaRuntime'
 import * as filesystemUtilities from '../../../shared/filesystemUtilities'
 import * as CloudFormation from '../../cloudformation/cloudformation'
 import ZipResourceProperties = CloudFormation.ZipResourceProperties
+import fs from '../../fs/fs'
 
 export class SamTemplateGenerator {
     private resourceName?: string
@@ -128,8 +128,8 @@ export class SamTemplateGenerator {
 
         const parentDirectory: string = path.dirname(filename)
         if (!(await filesystemUtilities.fileExists(parentDirectory))) {
-            await mkdirp(parentDirectory)
+            await fs.mkdir(parentDirectory)
         }
-        await writeFile(filename, templateAsYaml, 'utf8')
+        await fs.writeFile(filename, templateAsYaml, 'utf8')
     }
 }

packages/core/src/shared/ui/common/variablesPrompter.ts

@@ -4,13 +4,13 @@
  */
 
 import * as vscode from 'vscode'
-import * as fs from 'fs-extra'
 import { showViewLogsMessage } from '../../utilities/messages'
 import { WIZARD_RETRY } from '../../wizards/wizard'
 import { createQuickPick, DataQuickPickItem, QuickPickPrompter } from '../pickerPrompter'
 import * as nls from 'vscode-nls'
 import { PrompterButtons } from '../buttons'
 import { promisifyThenable } from '../../utilities/vsCodeUtils'
+import fs from '../../fs/fs'
 
 const localize = nls.loadMessageBundle()
 
@@ -72,7 +72,7 @@ export function createVariablesPrompter(
                 throw new Error('Closed dialog')
             }
             const path = resp[0].fsPath
-            const contents = await fs.promises.readFile(path)
+            const contents = await fs.readFile(path)
             return parseEnvFile(contents.toString())
         } catch (err) {
             if ((err as Error).message !== 'Closed dialog') {