browser: remove some uses of fs-extra (#4230)

Author: nkomonen-amazon

.eslintrc.js

@@ -115,5 +115,13 @@ module.exports = {
             { lineEndings: 'unix' },
         ],
         'aws-toolkits/no-only-in-tests': 'error',
+        // The following will place an error on the `fs-extra` import since we do not want it to be used for browser compatibility reasons.
+        // "no-restricted-imports": [
+        //     "error",
+        //     {
+        //         "name": "fs-extra",
+        //         "message": "Avoid fs-extra, use FileSystemCommon. Notify the Toolkit team if your required functionality is not available."
+        //     }
+        // ],
     },
 }

src/amazonqFeatureDev/util/files.ts

@@ -12,7 +12,7 @@ import { Uri } from 'vscode'
 import { GitIgnoreFilter } from './gitignore'
 
 import AdmZip from 'adm-zip'
-import { FileSystemCommon } from '../../srcShared/fs'
+import { fsCommon } from '../../srcShared/fs'
 import { TelemetryHelper } from './telemetryHelper'
 import { PrepareRepoFailedError } from '../errors'
 import { getLogger } from '../../shared/logger/logger'
@@ -133,6 +133,5 @@ export async function prepareRepoData(
 
 export async function getSourceCodePath(workspaceRoot: string, projectRoot: string) {
     const srcRoot = path.join(workspaceRoot, projectRoot)
-    const srcFound = await FileSystemCommon.instance.stat(srcRoot)
-    return srcFound !== undefined ? srcRoot : workspaceRoot
+    return (await fsCommon.existsDir(srcRoot)) ? srcRoot : workspaceRoot
 }

src/auth/providers/sharedCredentialsProviderFactory.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import * as fs from 'fs-extra'
+import { fsCommon } from '../../srcShared/fs'
 import { getLogger, Logger } from '../../shared/logger'
 import { loadSharedCredentialsSections, updateAwsSdkLoadConfigEnvVar } from '../credentials/sharedCredentials'
 import { CredentialsProviderType } from './credentials'
@@ -80,9 +80,8 @@ export class SharedCredentialsProviderFactory extends BaseCredentialsProviderFac
 
     private async getLastModifiedMillis(filepath: string): Promise<number | undefined> {
         try {
-            const stat = await fs.stat(filepath)
-
-            return stat.mtimeMs
+            const stat = await fsCommon.stat(filepath)
+            return stat.mtime
         } catch (err) {
             return undefined
         }

src/cloudWatchLogs/commands/saveCurrentLogDataContent.ts

@@ -10,7 +10,7 @@ const localize = nls.loadMessageBundle()
 import { SystemUtilities } from '../../shared/systemUtilities'
 import { isLogStreamUri, parseCloudWatchLogsUri } from '../cloudWatchLogsUtils'
 import { telemetry, CloudWatchResourceType, Result } from '../../shared/telemetry/telemetry'
-import { FileSystemCommon } from '../../srcShared/fs'
+import { fsCommon } from '../../srcShared/fs'
 
 /** Prompts the user to select a file location to save the currently visible "aws-cwl:" document to. */
 export async function saveCurrentLogDataContent(): Promise<void> {
@@ -45,7 +45,7 @@ export async function saveCurrentLogDataContent(): Promise<void> {
 
         if (selectedUri && content) {
             try {
-                await FileSystemCommon.instance.writeFile(selectedUri, content)
+                await fsCommon.writeFile(selectedUri, content)
             } catch (e) {
                 result = 'Failed'
                 const err = e as Error

src/codewhisperer/commands/basicCommands.ts

@@ -28,7 +28,7 @@ import {
 } from '../util/customizationUtil'
 import { applyPatch } from 'diff'
 import { closeSecurityIssueWebview, showSecurityIssueWebview } from '../views/securityIssue/securityIssueWebview'
-import { FileSystemCommon } from '../../srcShared/fs'
+import { fsCommon } from '../../srcShared/fs'
 import { Mutable } from '../../shared/utilities/tsUtils'
 import { CodeWhispererSource } from './types'
 import { showManageConnections } from '../../auth/ui/vue/show'
@@ -315,7 +315,7 @@ export const applySecurityFix = Commands.declare(
             }
 
             // writing the patch applied version of document into the file
-            await FileSystemCommon.instance.writeFile(filePath, updatedContent)
+            await fsCommon.writeFile(filePath, updatedContent)
             void vscode.window
                 .showInformationMessage(CodeWhispererConstants.codeFixAppliedSuccessMessage, {
                     title: CodeWhispererConstants.runSecurityScanButtonTitle,

src/codewhisperer/vue/backend.ts

@@ -11,7 +11,7 @@ import { VueWebview } from '../../webviews/main'
 import { isCloud9 } from '../../shared/extensionUtilities'
 import globals from '../../shared/extensionGlobals'
 import { telemetry, CodewhispererLanguage, CodewhispererGettingStartedTask } from '../../shared/telemetry/telemetry'
-import { FileSystemCommon } from '../../srcShared/fs'
+import { fsCommon } from '../../srcShared/fs'
 import { getLogger } from '../../shared/logger'
 import { PromptSettings } from '../../shared/settings'
 import { CodeWhispererSource } from '../commands/types'
@@ -39,7 +39,7 @@ export class CodeWhispererWebview extends VueWebview {
         const fileContent = name[1]
 
         const localFilePath = this.getLocalFilePath(fileName)
-        if ((await FileSystemCommon.instance.fileExists(localFilePath)) && this.isFileSaved) {
+        if ((await fsCommon.existsFile(localFilePath)) && this.isFileSaved) {
             const fileUri = vscode.Uri.file(localFilePath)
             await vscode.workspace.openTextDocument(fileUri).then(async doc => {
                 await vscode.window.showTextDocument(doc, vscode.ViewColumn.Active).then(editor => {
@@ -58,7 +58,7 @@ export class CodeWhispererWebview extends VueWebview {
     // This function saves and open the file in the editor.
     private async saveFileLocally(localFilePath: string, fileContent: string): Promise<void> {
         try {
-            await FileSystemCommon.instance.writeFile(localFilePath, fileContent)
+            await fsCommon.writeFile(localFilePath, fileContent)
             this.isFileSaved = true
             // Opening the text document
             await vscode.workspace.openTextDocument(localFilePath).then(async doc => {

src/dynamicResources/awsResourceManager.ts

@@ -157,7 +157,7 @@ export class AwsResourceManager {
         await this.initialize()
 
         const normalizedTypeName = getNormalizedTypeName(typeName)
-        const filename = getNonexistentFilename(
+        const filename = await getNonexistentFilename(
             this.folder!,
             encodeURIComponent(identifier),
             `.${normalizedTypeName}.awsResource.json`

src/extension.ts

@@ -27,7 +27,6 @@ import {
     initializeComputeRegion,
     isCloud9,
     isSageMaker,
-    showQuickStartWebview,
     showWelcomeMessage,
 } from './shared/extensionUtilities'
 import { getLogger, Logger } from './shared/logger/logger'
@@ -78,6 +77,7 @@ import { ChildProcess } from './shared/utilities/childProcess'
 import { initializeNetworkAgent } from './codewhisperer/client/agent'
 import { Timeout } from './shared/utilities/timeoutUtils'
 import { submitFeedback } from './feedback/vue/submitFeedback'
+import { showQuickStartWebview } from './shared/extensionStartup'
 
 let localize: nls.LocalizeFunc
 

src/lambda/wizards/samInitWizard.ts

@@ -28,7 +28,6 @@ import {
 } from '../models/samTemplates'
 import * as semver from 'semver'
 import { minSamCliVersionForArmSupport, minSamCliVersionForImageSupport } from '../../shared/sam/cli/samCliValidator'
-import * as fsutil from '../../shared/filesystemUtilities'
 import { Wizard } from '../../shared/wizards/wizard'
 import { createFolderPrompt } from '../../shared/ui/common/location'
 import { createInputBox, InputBoxPrompter } from '../../shared/ui/inputPrompter'
@@ -37,6 +36,7 @@ import { createRegionPrompter } from '../../shared/ui/common/region'
 import { Region } from '../../shared/regions/endpoints'
 import { createCommonButtons } from '../../shared/ui/buttons'
 import { createExitPrompter } from '../../shared/ui/common/exitPrompter'
+import { getNonexistentFilenameSync } from '../../shared/filesystemUtilities'
 
 const localize = nls.loadMessageBundle()
 
@@ -274,12 +274,7 @@ export class CreateNewSamAppWizard extends Wizard<CreateNewSamAppWizardForm> {
 
         this.form.name.bindPrompter(state =>
             createNamePrompter(
-                fsutil.getNonexistentFilename(
-                    state.location!.fsPath,
-                    `lambda-${state.runtimeAndPackage!.runtime}`,
-                    '',
-                    99
-                )
+                getNonexistentFilenameSync(state.location!.fsPath, `lambda-${state.runtimeAndPackage!.runtime}`, '', 99)
             )
         )
     }

src/s3/commands/downloadFileAs.ts

@@ -110,7 +110,7 @@ export async function downloadFileAsCommand(node: S3FileNode, outputChannel = gl
     const sourcePath = readablePath(node)
 
     await telemetry.s3_downloadObject.run(async () => {
-        const downloadPath = getDefaultDownloadPath()
+        const downloadPath = await getDefaultDownloadPath()
 
         const saveLocation = await promptForSaveLocation(file.name, downloadPath)
         if (!saveLocation) {