fix(storage): add metadata support

aws-amplify · Oct 12, 2023 · 72aaddf · 72aaddf
1 parent efc0061
commit 72aaddf
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 6 deletions.
diff --git a/...ugins/Storage/Sources/AWSS3StoragePlugin/Dependency/AWSS3PreSignedURLBuilderAdapter.swift b/...ugins/Storage/Sources/AWSS3StoragePlugin/Dependency/AWSS3PreSignedURLBuilderAdapter.swift
@@ -34,6 +34,7 @@ class AWSS3PreSignedURLBuilderAdapter: AWSS3PreSignedURLBuilderBehavior {
     /// - Returns: Pre-Signed URL
     func getPreSignedURL(key: String,
                          signingOperation: AWSS3SigningOperation,
+                         metadata: [String: String]? = nil,
                          accelerate: Bool? = nil,
                          expires: Int64? = nil) async throws -> URL {
         let expiresDate = Date(timeIntervalSinceNow: Double(expires ?? defaultExpiration))
@@ -47,7 +48,7 @@ class AWSS3PreSignedURLBuilderAdapter: AWSS3PreSignedURLBuilderBehavior {
                 config: config,
                 expiration: expiration)
         case .putObject:
-            let input = PutObjectInput(bucket: bucket, key: key)
+            let input = PutObjectInput(bucket: bucket, key: key, metadata: metadata)
             preSignedUrl = try await input.presignURL(
                 config: config,
                 expiration: expiration)

diff --git a/...gins/Storage/Sources/AWSS3StoragePlugin/Dependency/AWSS3PreSignedURLBuilderBehavior.swift b/...gins/Storage/Sources/AWSS3StoragePlugin/Dependency/AWSS3PreSignedURLBuilderBehavior.swift
@@ -41,6 +41,7 @@ protocol AWSS3PreSignedURLBuilderBehavior {
     /// - Tag: AWSS3PreSignedURLBuilderBehavior.getPreSignedURL
     func getPreSignedURL(key: String,
                          signingOperation: AWSS3SigningOperation,
+                         metadata: [String: String]?,
                          accelerate: Bool?,
                          expires: Int64?) async throws -> URL
 

diff --git a/...age/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+DownloadBehavior.swift b/...age/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+DownloadBehavior.swift
@@ -30,6 +30,7 @@ extension AWSS3StorageService {
             do {
                 let preSignedURL = try await preSignedURLBuilder.getPreSignedURL(key: serviceKey,
                                                                                  signingOperation: .getObject,
+                                                                                 metadata: nil,
                                                                                  accelerate: accelerate,
                                                                                  expires: nil)
                 startDownload(preSignedURL: preSignedURL, transferTask: transferTask)

diff --git a/...rces/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+GetPreSignedURLBehavior.swift b/...rces/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+GetPreSignedURLBehavior.swift
@@ -14,11 +14,13 @@ extension AWSS3StorageService {
 
     func getPreSignedURL(serviceKey: String,
                          signingOperation: AWSS3SigningOperation,
+                         metadata: [String: String]?,
                          accelerate: Bool?,
                          expires: Int) async throws -> URL {
         return try await preSignedURLBuilder.getPreSignedURL(
             key: serviceKey,
             signingOperation: signingOperation,
+            metadata: metadata,
             accelerate: nil,
             expires: Int64(expires)
         )

diff --git a/...orage/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+UploadBehavior.swift b/...orage/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService+UploadBehavior.swift
@@ -36,6 +36,7 @@ extension AWSS3StorageService {
             do {
                 let preSignedURL = try await preSignedURLBuilder.getPreSignedURL(key: serviceKey,
                                                                                  signingOperation: .putObject,
+                                                                                 metadata: metadata,
                                                                                  accelerate: accelerate,
                                                                                  expires: nil)
                 startUpload(preSignedURL: preSignedURL,

diff --git a/...gins/Storage/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageServiceBehavior.swift b/...gins/Storage/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageServiceBehavior.swift
@@ -44,6 +44,7 @@ protocol AWSS3StorageServiceBehavior {
 
     func getPreSignedURL(serviceKey: String,
                          signingOperation: AWSS3SigningOperation,
+                         metadata: [String: String]?,
                          accelerate: Bool?,
                          expires: Int) async throws -> URL
 

diff --git a/...ns/Storage/Sources/AWSS3StoragePlugin/Support/Internal/StorageMultipartUploadClient.swift b/...ns/Storage/Sources/AWSS3StoragePlugin/Support/Internal/StorageMultipartUploadClient.swift
@@ -135,6 +135,7 @@ class DefaultStorageMultipartUploadClient: StorageMultipartUploadClient {
                     let preSignedURL = try await serviceProxy.preSignedURLBuilder.getPreSignedURL(
                         key: self.key,
                         signingOperation: operation,
+                        metadata: nil,
                         accelerate: nil,
                         expires: nil
                     )

diff --git a/...ifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Mocks/MockAWSS3PreSignedURLBuilder.swift b/...ifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Mocks/MockAWSS3PreSignedURLBuilder.swift
@@ -22,9 +22,15 @@ extension MockAWSS3PreSignedURLBuilder: AWSS3PreSignedURLBuilderBehavior {
     func getPreSignedURL(
         key: String,
         signingOperation: AWSS3SigningOperation,
+        metadata: [String : String]?,
         accelerate: Bool?,
         expires: Int64?) async throws -> URL {
-            interactions.append("\(#function) \(key) \(signingOperation) \(String(describing: expires))")
+            if let metadata = metadata {
+                interactions.append("\(#function) \(key) \(signingOperation) \(metadata) \(String(describing: expires))")
+            } else {
+                interactions.append("\(#function) \(key) \(signingOperation) \(String(describing: expires))")
+            }
+
             return try await getPreSignedURLHandler(key, signingOperation, expires)
         }
 }
diff --git a/AmplifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Mocks/MockAWSS3StorageService.swift b/AmplifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Mocks/MockAWSS3StorageService.swift
@@ -80,9 +80,10 @@ public class MockAWSS3StorageService: AWSS3StorageServiceBehavior {
     public func getPreSignedURL(
         serviceKey: String,
         signingOperation: AWSS3SigningOperation,
+        metadata: [String: String]?,
         accelerate: Bool?,
         expires: Int) async throws -> URL {
-            interactions.append("\(#function) \(serviceKey) \(signingOperation) \(expires)")
+            interactions.append("\(#function) \(serviceKey) \(signingOperation) \(String(describing: metadata)) \(expires)")
             return try await getPreSignedURLHandler(serviceKey, signingOperation, expires)
         }
 

diff --git a/...3StoragePluginTests/Service/Storage/AWSS3StorageServiceGetPreSignedURLBehaviorTests.swift b/...3StoragePluginTests/Service/Storage/AWSS3StorageServiceGetPreSignedURLBehaviorTests.swift
@@ -68,11 +68,12 @@ class AWSS3StorageServiceGetPreSignedURLBehaviorTests: XCTestCase {
     func testForGetObject() async throws {
         let url = try await systemUnderTest.getPreSignedURL(serviceKey: serviceKey,
                                                             signingOperation: .getObject,
+                                                            metadata: nil,
                                                             accelerate: nil,
                                                             expires: expires)
         XCTAssertEqual(url, presignedURL)
         XCTAssertEqual(builder.interactions, [
-            "getPreSignedURL(key:signingOperation:accelerate:expires:) \(serviceKey ?? "") \(AWSS3SigningOperation.getObject) \(String(describing: expires))"
+            "getPreSignedURL(key:signingOperation:metadata:accelerate:expires:) \(serviceKey ?? "") \(AWSS3SigningOperation.getObject) \(String(describing: expires))"
         ])
     }
 
@@ -82,11 +83,28 @@ class AWSS3StorageServiceGetPreSignedURLBehaviorTests: XCTestCase {
     func testForPutObject() async throws {
         let url = try await systemUnderTest.getPreSignedURL(serviceKey: serviceKey,
                                                             signingOperation: .putObject,
+                                                            metadata: nil,
                                                             accelerate: nil,
                                                             expires: expires)
         XCTAssertEqual(url, presignedURL)
         XCTAssertEqual(builder.interactions, [
-            "getPreSignedURL(key:signingOperation:accelerate:expires:) \(serviceKey ?? "") \(AWSS3SigningOperation.putObject) \(String(describing: expires))"
+            "getPreSignedURL(key:signingOperation:metadata:accelerate:expires:) \(serviceKey ?? "") \(AWSS3SigningOperation.putObject) \(String(describing: expires))"
+        ])
+    }
+
+    /// - Given: A storage service configured to use a AWSS3PreSignedURLBuilder
+    /// - When: A presigned URL is requested for a **AWSS3SigningOperation.putObject** operation with metadata
+    /// - Then: A valid URL is returned
+    func testForPutObjectWithMetadata() async throws {
+        let metadata = ["test": "value"]
+        let url = try await systemUnderTest.getPreSignedURL(serviceKey: serviceKey,
+                                                            signingOperation: .putObject,
+                                                            metadata: metadata,
+                                                            accelerate: nil,
+                                                            expires: expires)
+        XCTAssertEqual(url, presignedURL)
+        XCTAssertEqual(builder.interactions, [
+            "getPreSignedURL(key:signingOperation:metadata:accelerate:expires:) \(serviceKey ?? "") \(AWSS3SigningOperation.putObject) \(metadata) \(String(describing: expires))"
         ])
     }
 
@@ -97,11 +115,12 @@ class AWSS3StorageServiceGetPreSignedURLBehaviorTests: XCTestCase {
         let operation = AWSS3SigningOperation.uploadPart(partNumber: 0, uploadId: UUID().uuidString)
         let url = try await systemUnderTest.getPreSignedURL(serviceKey: serviceKey,
                                                             signingOperation: operation,
+                                                            metadata: nil,
                                                             accelerate: nil,
                                                             expires: expires)
         XCTAssertEqual(url, presignedURL)
         XCTAssertEqual(builder.interactions, [
-            "getPreSignedURL(key:signingOperation:accelerate:expires:) \(serviceKey ?? "") \(operation) \(String(describing: expires))"
+            "getPreSignedURL(key:signingOperation:metadata:accelerate:expires:) \(serviceKey ?? "") \(operation) \(String(describing: expires))"
         ])
     }