feat(S3): select recent folders in "Upload Files" wizard #3183

Problem:
"AWS: Upload Files..." command only allows selecting a bucket, not a folder.

Solution:
- Remember the last-expanded and last-uploaded-to folders.
- Show them in the wizard.

Co-authored-by: Justin M. Keyes <[email protected]>

Author: gsweetwood

.changes/next-release/Feature-a45b6094-92f4-4ff3-a495-1fcd4f2a1901.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "S3: Choose last-touched and last-uploaded-to S3 folders in the Upload Files wizard."
+}

src/awsexplorer/activation.ts

@@ -31,6 +31,7 @@ import { once } from '../shared/utilities/functionUtils'
 import { Auth, AuthNode } from '../credentials/auth'
 import { CodeCatalystRootNode } from '../codecatalyst/explorer'
 import { CodeCatalystAuthenticationProvider } from '../codecatalyst/auth'
+import { S3FolderNode } from '../s3/explorer/s3FolderNode'
 
 /**
  * Activates the AWS Explorer UI and related functionality.
@@ -47,6 +48,14 @@ export async function activate(args: {
         treeDataProvider: awsExplorer,
         showCollapseAll: true,
     })
+    view.onDidExpandElement(element => {
+        if (element.element instanceof S3FolderNode) {
+            globals.context.globalState.update('aws.lastTouchedS3Folder', {
+                bucket: element.element.bucket,
+                folder: element.element.folder,
+            })
+        }
+    })
     globals.context.subscriptions.push(view)
 
     await registerAwsExplorerCommands(args.context, awsExplorer, args.toolkitOutputChannel)

src/s3/commands/uploadFile.ts

@@ -6,6 +6,7 @@
 import * as path from 'path'
 import * as mime from 'mime-types'
 import * as vscode from 'vscode'
+import * as semver from 'semver'
 import { statSync } from 'fs'
 import { S3 } from 'aws-sdk'
 import { getLogger } from '../../shared/logger'
@@ -16,7 +17,7 @@ import { localize } from '../../shared/utilities/vsCodeUtils'
 import { showOutputMessage } from '../../shared/utilities/messages'
 import { createQuickPick, promptUser, verifySinglePickerOutput } from '../../shared/ui/picker'
 import { addCodiconToString } from '../../shared/utilities/textUtilities'
-import { S3Client } from '../../shared/clients/s3Client'
+import { Bucket, Folder, S3Client } from '../../shared/clients/s3Client'
 import { createBucketCommand } from './createBucket'
 import { S3BucketNode } from '../explorer/s3BucketNode'
 import { S3FolderNode } from '../explorer/s3FolderNode'
@@ -102,6 +103,12 @@ export async function uploadFileCommand(
                 return fileToUploadRequest(node!.bucket.name, key, file)
             })
         )
+        if (node instanceof S3FolderNode) {
+            globals.context.globalState.update('aws.lastUploadedToS3Folder', {
+                bucket: node.bucket,
+                folder: node.folder,
+            })
+        }
     } else {
         while (true) {
             const filesToUpload = await getFile(document)
@@ -145,18 +152,28 @@ export async function uploadFileCommand(
                 return
             }
 
-            const bucketName = bucketResponse.Name
+            const bucketName = bucketResponse.bucket!.Name
             if (!bucketName) {
                 throw Error(`bucketResponse is not a S3.Bucket`)
             }
 
             uploadRequests.push(
                 ...filesToUpload.map(file => {
-                    const key = path.basename(file.fsPath)
+                    const key =
+                        bucketResponse.folder !== undefined
+                            ? bucketResponse.folder.path + path.basename(file.fsPath)
+                            : path.basename(file.fsPath)
                     return fileToUploadRequest(bucketName, key, file)
                 })
             )
 
+            if (bucketResponse.folder) {
+                globals.context.globalState.update('aws.lastUploadedToS3Folder', {
+                    bucket: bucketResponse.bucket,
+                    folder: bucketResponse.folder,
+                })
+            }
+
             break
         }
     }
@@ -280,7 +297,6 @@ async function uploadBatchOfFiles(
                     localize('AWS.s3.uploadFile.startUpload', 'Uploading file {0} to {1}', fileName, destinationPath),
                     outputChannel
                 )
-
                 let remainder = 0
                 let lastLoaded = 0
                 // TODO: don't use `withProgress`, it makes it hard to have control over the individual outputs
@@ -374,8 +390,14 @@ async function uploadWithProgress(
     return (request.ongoingUpload = undefined)
 }
 
-interface BucketQuickPickItem extends vscode.QuickPickItem {
+export interface BucketQuickPickItem extends vscode.QuickPickItem {
     bucket: S3.Bucket | undefined
+    folder?: Folder | undefined
+}
+
+interface SavedFolder {
+    bucket: Bucket
+    folder: Folder
 }
 
 // TODO:: extract and reuse logic from sam deploy wizard (bucket selection)
@@ -391,7 +413,7 @@ export async function promptUserForBucket(
     s3client: S3Client,
     promptUserFunction = promptUser,
     createBucket = createBucketCommand
-): Promise<S3.Bucket | 'cancel' | 'back'> {
+): Promise<BucketQuickPickItem | 'cancel' | 'back'> {
     let allBuckets: S3.Bucket[]
     try {
         allBuckets = await s3client.listAllBuckets()
@@ -418,15 +440,77 @@ export async function promptUserForBucket(
         }
     })
 
+    const lastTouchedFolder = globals.context.globalState.get<SavedFolder | undefined>('aws.lastTouchedS3Folder')
+    let lastFolderItem: BucketQuickPickItem | undefined = undefined
+    if (lastTouchedFolder) {
+        lastFolderItem = {
+            label: lastTouchedFolder.folder.name,
+            description: '(last opened S3 folder)',
+            bucket: { Name: lastTouchedFolder.bucket.name },
+            folder: lastTouchedFolder.folder,
+        }
+    }
+
+    const lastUploadedToFolder = globals.context.globalState.get<SavedFolder | undefined>('aws.lastUploadedToS3Folder')
+    let lastUploadedFolderItem: BucketQuickPickItem | undefined = undefined
+    if (lastUploadedToFolder) {
+        lastUploadedFolderItem = {
+            label: lastUploadedToFolder.folder.name,
+            description: '(last uploaded-to S3 folder)',
+            bucket: { Name: lastUploadedToFolder.bucket.name },
+            folder: lastUploadedToFolder.folder,
+        }
+    }
+
+    const folderItems = []
+    if (lastUploadedFolderItem !== undefined) {
+        folderItems.push(lastUploadedFolderItem)
+    }
+    // de-dupe if folders are the same
+    if (
+        lastFolderItem !== undefined &&
+        (lastUploadedFolderItem === undefined || lastFolderItem.folder?.path !== lastUploadedFolderItem.folder?.path)
+    ) {
+        folderItems.push(lastFolderItem)
+    }
+
+    // Remove this stub after we bump minimum to vscode 1.64
+    const QuickPickItemKind = semver.gte(vscode.version, '1.64.0') ? (vscode as any).QuickPickItemKind : undefined
+    const items: BucketQuickPickItem[] = [
+        // vscode 1.64 supports QuickPickItemKind.Separator.
+        // https://github.com/microsoft/vscode/commit/eb416b4f9ebfda1c798aa7c8b2f4e81c6ce1984f
+        ...(QuickPickItemKind && folderItems.length > 0
+            ? [
+                  {
+                      label: localize('AWS.s3.uploadFile.folderSeparator', 'Folders'),
+                      kind: QuickPickItemKind.Separator,
+                      bucket: undefined,
+                  } as BucketQuickPickItem,
+              ]
+            : []),
+        ...folderItems,
+        ...(!QuickPickItemKind
+            ? []
+            : [
+                  {
+                      label: localize('AWS.s3.uploadFile.bucketSeparator', 'Buckets'),
+                      kind: QuickPickItemKind.Separator,
+                      bucket: undefined,
+                  } as BucketQuickPickItem,
+              ]),
+        ...bucketItems,
+        createNewBucket,
+    ]
+
     const picker = createQuickPick({
         options: {
             canPickMany: false,
             ignoreFocusOut: true,
-            title: localize('AWS.message.selectBucket', 'Select an S3 bucket to upload to'),
+            title: localize('AWS.message.selectBucket', 'Select an S3 bucket or folder to upload to'),
             step: 2,
             totalSteps: 2,
         },
-        items: [...bucketItems, createNewBucket],
+        items,
         buttons: [vscode.QuickInputButtons.Back],
     })
     const response = verifySinglePickerOutput(
@@ -459,7 +543,7 @@ export async function promptUserForBucket(
             return promptUserForBucket(s3client)
         }
     } else {
-        return response.bucket
+        return response
     }
     return 'cancel'
 }

src/test/s3/commands/uploadFile.test.ts

@@ -11,6 +11,7 @@ import {
     getFilesToUpload,
     promptUserForBucket,
     uploadFileCommand,
+    BucketQuickPickItem,
 } from '../../../s3/commands/uploadFile'
 import { S3Node } from '../../../s3/explorer/s3Nodes'
 import { S3BucketNode } from '../../../s3/explorer/s3BucketNode'
@@ -27,10 +28,21 @@ describe('uploadFileCommand', function () {
     const sizeBytes = 16
     const fileLocation = vscode.Uri.file('/file.jpg')
     const statFile: FileSizeBytes = _file => sizeBytes
+    const bucketResponse = { label: 'label', bucket: { Name: bucketName } }
+    const folderResponse = {
+        label: 'label',
+        bucket: { Name: bucketName },
+        folder: { name: 'folderA', path: 'folderA/', arn: 'arn' },
+    }
+    const getFolder: (s3client: S3Client) => Promise<BucketQuickPickItem | 'cancel' | 'back'> = s3Client => {
+        return new Promise((resolve, reject) => {
+            resolve(folderResponse)
+        })
+    }
     let outputChannel: MockOutputChannel
     let s3: S3Client
     let bucketNode: S3BucketNode
-    let getBucket: (s3client: S3Client) => Promise<S3.Bucket | 'cancel' | 'back'>
+    let getBucket: (s3client: S3Client) => Promise<BucketQuickPickItem | 'cancel' | 'back'>
     let getFile: (document?: vscode.Uri) => Promise<vscode.Uri[] | undefined>
     let commands: Commands
     let mockedUpload: S3.ManagedUpload
@@ -109,7 +121,7 @@ describe('uploadFileCommand', function () {
 
             getBucket = s3Client => {
                 return new Promise((resolve, reject) => {
-                    resolve({ Name: bucketName })
+                    resolve(bucketResponse)
                 })
             }
         })
@@ -157,21 +169,25 @@ describe('uploadFileCommand', function () {
 
     getBucket = s3Client => {
         return new Promise((resolve, reject) => {
-            resolve({ Name: bucketName })
+            resolve(bucketResponse)
         })
     }
 
-    it('successfully upload file', async function () {
+    it('successfully upload file or folder', async function () {
         when(s3.uploadFile(anything())).thenResolve(instance(mockedUpload))
         when(mockedUpload.promise()).thenResolve()
-
         getTestWindow().onDidShowDialog(d => d.selectItem(fileLocation))
 
+        // Upload to bucket.
         await uploadFileCommand(instance(s3), fileLocation, statFile, getBucket, getFile, outputChannel, commands)
+        // Upload to folder.
+        await uploadFileCommand(instance(s3), fileLocation, statFile, getFolder, getFile, outputChannel, commands)
 
         assert.deepStrictEqual(outputChannel.lines, [
             'Uploading file file.jpg to s3://bucket-name/file.jpg',
             `Uploaded 1/1 files`,
+            'Uploading file file.jpg to s3://bucket-name/folderA/file.jpg',
+            `Uploaded 1/1 files`,
         ])
     })
 
@@ -293,7 +309,7 @@ describe('promptUserForBucket', async function () {
         when(s3.listAllBuckets()).thenResolve(buckets)
 
         const response = await promptUserForBucket(instance(s3), promptSelect)
-        assert.deepStrictEqual(response, buckets[0])
+        assert.deepStrictEqual(response, selection)
     })
 
     it('Returns "back" when selected', async function () {