fix(s3): filesystem provider is not case-sensitive #3277

Problem:
The s3 filesystem provider is not case-sensitive, so requesting a path
like /aws/Test/temp.json matches /aws/test/temp.json.

Solution:
Set the case sensitive flag when registering the filesystem provider.

Signed-off-by: Nikolas Komonen <[email protected]>

Author: nkomonen-amazon

src/s3/activation.ts

@@ -39,8 +39,8 @@ export async function activate(ctx: ExtContext): Promise<void> {
 
     ctx.extensionContext.subscriptions.push(manager)
     ctx.extensionContext.subscriptions.push(
-        vscode.workspace.registerFileSystemProvider(s3EditScheme, fs),
-        vscode.workspace.registerFileSystemProvider(s3ReadScheme, fs, { isReadonly: true }),
+        vscode.workspace.registerFileSystemProvider(s3EditScheme, fs, { isCaseSensitive: true }),
+        vscode.workspace.registerFileSystemProvider(s3ReadScheme, fs, { isReadonly: true, isCaseSensitive: true }),
         Commands.register('aws.s3.copyPath', async (node: S3FolderNode | S3FileNode) => {
             await copyPathCommand(node)
         }),

src/test/s3/util/fileViewerManager.test.ts

@@ -187,6 +187,13 @@ describe('FileViewerManager', function () {
         return window.visibleTextEditors.filter(e => e.document.fileName.endsWith(documentName))
     }
 
+    function registerFileSystemProviders(isCaseSensitive: boolean = true): vscode.Disposable[] {
+        return [
+            vscode.workspace.registerFileSystemProvider(editScheme, fs, { isCaseSensitive }),
+            vscode.workspace.registerFileSystemProvider(readScheme, fs, { isReadonly: true, isCaseSensitive }),
+        ]
+    }
+
     beforeEach(function () {
         s3 = createS3()
         fs = new VirualFileSystem()
@@ -196,10 +203,7 @@ describe('FileViewerManager', function () {
             edit: editScheme,
         })
 
-        disposables = [
-            vscode.workspace.registerFileSystemProvider(editScheme, fs),
-            vscode.workspace.registerFileSystemProvider(readScheme, fs, { isReadonly: true }),
-        ]
+        disposables = registerFileSystemProviders()
     })
 
     afterEach(async function () {
@@ -303,5 +307,47 @@ describe('FileViewerManager', function () {
             const err = await fileViewerManager.openInReadMode({ ...file, bucket }).catch(e => e)
             assert.ok(err instanceof ToolkitError)
         })
+
+        it('is case-sensitive for file names', async function () {
+            // Create and assert content of file with lowercase name
+            const lowerCaseFileContent = 'lowercaseContent'
+            const lowerCaseFile = makeFile('myFile.txt', Buffer.from(lowerCaseFileContent, 'utf-8'))
+            s3.addFile(lowerCaseFile)
+            await fileViewerManager.openInReadMode({ ...lowerCaseFile, bucket })
+            await assertTextEditorContains(lowerCaseFileContent)
+
+            // Create similarily named file, but with different uppercase in name
+            const upperCaseFileContent = 'uppercaseContent'
+            const upperCaseFile = makeFile('MyFile.txt', Buffer.from(upperCaseFileContent, 'utf-8'))
+            s3.addFile(upperCaseFile)
+            await fileViewerManager.openInReadMode({ ...upperCaseFile, bucket })
+            await assertTextEditorContains(upperCaseFileContent)
+        })
+    })
+
+    describe('file uri case insensitivity', function () {
+        beforeEach(function () {
+            vscode.Disposable.from(...disposables).dispose()
+            // Case insensitive file system providers
+            disposables = registerFileSystemProviders(false)
+        })
+
+        it('opens an existing file since names are the same', async function () {
+            // Create and assert content of file with lowercase name
+            const lowerCaseFileContent = 'lowercaseContent'
+            const lowerCaseFile = makeFile('file.txt', Buffer.from(lowerCaseFileContent, 'utf-8'))
+            s3.addFile(lowerCaseFile)
+            await fileViewerManager.openInReadMode({ ...lowerCaseFile, bucket })
+            await assertTextEditorContains(lowerCaseFileContent)
+
+            // Create similarily named file, but with uppercase character
+            const upperCaseFileContent = 'uppercaseContent'
+            const upperCaseFile = makeFile('File.txt', Buffer.from(upperCaseFileContent, 'utf-8'))
+            s3.addFile(upperCaseFile)
+
+            // Attempt to open uppercase file opens existing lowercase file instead
+            await fileViewerManager.openInReadMode({ ...upperCaseFile, bucket })
+            await assertTextEditorContains(lowerCaseFileContent)
+        })
     })
 })