test(storage): integration tests (#371)

feat(storage): move objects between buckets

feat(storage): copy objects between buckets

.env.example

@@ -2,3 +2,4 @@
 
 SUPABASE_URL=https://mysupabasereference.supabase.co
 SUPABASE_ANON_KEY=my.supabase.anon.key
+SUPABASE_SERVICE_ROLE_KEY=my.supabase.service.role.key

.github/workflows/integration-tests.yml

@@ -26,4 +26,4 @@ jobs:
         env:
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_ANON_KEY: ${{ secrets.SUPABASE_ANON_KEY }}
-          SUPABASE_SERVICE_KEY: ${{ secrets.SUPABASE_SERVICE_KEY }}
+          SUPABASE_SERVICE_ROLE_KEY: ${{ secrets.SUPABASE_SERVICE_ROLE_KEY }}

Makefile

@@ -12,6 +12,7 @@ define SECRETS
 enum DotEnv {
   static let SUPABASE_URL = "$(SUPABASE_URL)"
   static let SUPABASE_ANON_KEY = "$(SUPABASE_ANON_KEY)"
+  static let SUPABASE_SERVICE_ROLE_KEY = "$(SUPABASE_SERVICE_ROLE_KEY)"
 }
 endef
 

Package.swift

@@ -84,6 +84,7 @@ let package = Package(
         "TestHelpers",
         "PostgREST",
         "Realtime",
+        "Storage",
       ]
     ),
     .target(

Sources/PostgREST/Types.swift

@@ -32,7 +32,7 @@ public struct PostgrestResponse<T: Sendable>: Sendable {
     self.count = count
     self.value = value
   }
-  
+
   /// Returns the response converting the returned Data into Unicode characters using a given encoding.
   public func string(encoding: String.Encoding = .utf8) -> String? {
     String(data: data, encoding: encoding)

Sources/Storage/BucketOptions.swift

@@ -2,10 +2,10 @@ import Foundation
 
 public struct BucketOptions: Sendable {
   public let `public`: Bool
-  public let fileSizeLimit: Int?
+  public let fileSizeLimit: String?
   public let allowedMimeTypes: [String]?
 
-  public init(public: Bool = false, fileSizeLimit: Int? = nil, allowedMimeTypes: [String]? = nil) {
+  public init(public: Bool = false, fileSizeLimit: String? = nil, allowedMimeTypes: [String]? = nil) {
     self.public = `public`
     self.fileSizeLimit = fileSizeLimit
     self.allowedMimeTypes = allowedMimeTypes

Sources/Storage/Deprecated.swift

@@ -30,3 +30,39 @@ extension StorageClientConfiguration {
     )
   }
 }
+
+extension StorageFileApi {
+  @_disfavoredOverload
+  @available(*, deprecated, message: "Please use method that returns FileUploadResponse.")
+  @discardableResult
+  public func upload(
+    path: String,
+    file: Data,
+    options: FileOptions = FileOptions()
+  ) async throws -> String {
+    try await upload(path: path, file: file, options: options).fullPath
+  }
+
+  @_disfavoredOverload
+  @available(*, deprecated, message: "Please use method that returns FileUploadResponse.")
+  @discardableResult
+  public func update(
+    path: String,
+    file: Data,
+    options: FileOptions = FileOptions()
+  ) async throws -> String {
+    try await update(path: path, file: file, options: options).fullPath
+  }
+
+  @_disfavoredOverload
+  @available(*, deprecated, message: "Please use method that returns FileUploadResponse.")
+  @discardableResult
+  public func uploadToSignedURL(
+    path: String,
+    token: String,
+    file: Data,
+    options: FileOptions = FileOptions()
+  ) async throws -> String {
+    try await uploadToSignedURL(path: path, token: token, file: file, options: options).fullPath
+  }
+}

Sources/Storage/StorageBucketApi.swift

@@ -35,7 +35,7 @@ public class StorageBucketApi: StorageApi {
     var id: String
     var name: String
     var `public`: Bool
-    var fileSizeLimit: Int?
+    var fileSizeLimit: String?
     var allowedMimeTypes: [String]?
   }
 

Sources/Storage/StorageFileApi.swift

@@ -24,10 +24,6 @@ public class StorageFileApi: StorageApi {
     super.init(configuration: configuration)
   }
 
-  private struct UploadResponse: Decodable {
-    let Key: String
-  }
-
   private struct MoveResponse: Decodable {
     let message: String
   }
@@ -41,7 +37,7 @@ public class StorageFileApi: StorageApi {
     path: String,
     file: Data,
     options: FileOptions
-  ) async throws -> String {
+  ) async throws -> FileUploadResponse {
     let contentType = options.contentType
     var headers = HTTPHeaders([
       "x-upsert": "\(options.upsert)",
@@ -56,7 +52,12 @@ public class StorageFileApi: StorageApi {
       file: File(name: fileName, data: file, fileName: fileName, contentType: contentType)
     )
 
-    return try await execute(
+    struct UploadResponse: Decodable {
+      let Key: String
+      let Id: String
+    }
+
+    let response = try await execute(
       HTTPRequest(
         url: configuration.url.appendingPathComponent("object/\(bucketId)/\(path)"),
         method: method,
@@ -66,7 +67,13 @@ public class StorageFileApi: StorageApi {
         headers: headers
       )
     )
-    .decoded(as: UploadResponse.self, decoder: configuration.decoder).Key
+    .decoded(as: UploadResponse.self, decoder: configuration.decoder)
+
+    return FileUploadResponse(
+      id: response.Id,
+      path: path,
+      fullPath: response.Key
+    )
   }
 
   /// Uploads a file to an existing bucket.
@@ -80,7 +87,7 @@ public class StorageFileApi: StorageApi {
     path: String,
     file: Data,
     options: FileOptions = FileOptions()
-  ) async throws -> String {
+  ) async throws -> FileUploadResponse {
     try await uploadOrUpdate(method: .post, path: path, file: file, options: options)
   }
 
@@ -95,16 +102,20 @@ public class StorageFileApi: StorageApi {
     path: String,
     file: Data,
     options: FileOptions = FileOptions()
-  ) async throws -> String {
+  ) async throws -> FileUploadResponse {
     try await uploadOrUpdate(method: .put, path: path, file: file, options: options)
   }
 
   /// Moves an existing file, optionally renaming it at the same time.
   /// - Parameters:
-  ///   - from: The original file path, including the current file name. For example
-  /// `folder/image.png`.
-  ///   - to: The new file path, including the new file name. For example `folder/image-copy.png`.
-  public func move(from source: String, to destination: String) async throws {
+  ///   - source: The original file path, including the current file name. For example `folder/image.png`.
+  ///   - destination: The new file path, including the new file name. For example `folder/image-copy.png`.
+  ///   - options: The destination options.
+  public func move(
+    from source: String,
+    to destination: String,
+    options: DestinationOptions? = nil
+  ) async throws {
     try await execute(
       HTTPRequest(
         url: configuration.url.appendingPathComponent("object/move"),
@@ -114,6 +125,7 @@ public class StorageFileApi: StorageApi {
             "bucketId": bucketId,
             "sourceKey": source,
             "destinationKey": destination,
+            "destinationBucket": options?.destinationBucket
           ]
         )
       )
@@ -122,12 +134,20 @@ public class StorageFileApi: StorageApi {
 
   /// Copies an existing file to a new path in the same bucket.
   /// - Parameters:
-  ///   - from: The original file path, including the current file name. For example
-  /// `folder/image.png`.
-  ///   - to: The new file path, including the new file name. For example `folder/image-copy.png`.
+  ///   - source: The original file path, including the current file name. For example `folder/image.png`.
+  ///   - destination: The new file path, including the new file name. For example `folder/image-copy.png`.
+  ///   - options: The destination options.
   @discardableResult
-  public func copy(from source: String, to destination: String) async throws -> String {
-    try await execute(
+  public func copy(
+    from source: String,
+    to destination: String,
+    options: DestinationOptions? = nil
+  ) async throws -> String {
+    struct UploadResponse: Decodable {
+      let Key: String
+    }
+
+    return try await execute(
       HTTPRequest(
         url: configuration.url.appendingPathComponent("object/copy"),
         method: .post,
@@ -136,6 +156,7 @@ public class StorageFileApi: StorageApi {
             "bucketId": bucketId,
             "sourceKey": source,
             "destinationKey": destination,
+            "destinationBucket": options?.destinationBucket
           ]
         )
       )
@@ -393,15 +414,24 @@ public class StorageFileApi: StorageApi {
   ///
   /// - Note: Signed upload URLs can be used to upload files to the bucket without further
   /// authentication. They are valid for 2 hours.
-  public func createSignedUploadURL(path: String) async throws -> SignedUploadURL {
+  public func createSignedUploadURL(
+    path: String,
+    options: CreateSignedUploadURLOptions? = nil
+  ) async throws -> SignedUploadURL {
     struct Response: Decodable {
       let url: URL
     }
 
+    var headers = HTTPHeaders()
+    if let upsert = options?.upsert, upsert {
+      headers["x-upsert"] = "true"
+    }
+
     let response = try await execute(
       HTTPRequest(
         url: configuration.url.appendingPathComponent("object/upload/sign/\(bucketId)/\(path)"),
-        method: .post
+        method: .post,
+        headers: headers
       )
     )
     .decoded(as: Response.self, decoder: configuration.decoder)
@@ -441,7 +471,7 @@ public class StorageFileApi: StorageApi {
     token: String,
     file: Data,
     options: FileOptions = FileOptions()
-  ) async throws -> String {
+  ) async throws -> SignedURLUploadResponse {
     let contentType = options.contentType
     var headers = HTTPHeaders([
       "x-upsert": "\(options.upsert)",
@@ -458,7 +488,11 @@ public class StorageFileApi: StorageApi {
       contentType: contentType
     ))
 
-    return try await execute(
+    struct UploadResponse: Decodable {
+      let Key: String
+    }
+
+    let fullPath = try await execute(
       HTTPRequest(
         url: configuration.url
           .appendingPathComponent("object/upload/sign/\(bucketId)/\(path)"),
@@ -471,6 +505,8 @@ public class StorageFileApi: StorageApi {
     )
     .decoded(as: UploadResponse.self, decoder: configuration.decoder)
     .Key
+
+    return SignedURLUploadResponse(path: path, fullPath: fullPath)
   }
 }
 

Sources/Storage/TransformOptions.swift

@@ -10,9 +10,9 @@ public struct TransformOptions: Encodable, Sendable {
   public init(
     width: Int? = nil,
     height: Int? = nil,
-    resize: String? = "cover",
+    resize: String? = nil,
     quality: Int? = 80,
-    format: String? = "origin"
+    format: String? = nil
   ) {
     self.width = width
     self.height = height

Sources/Storage/Types.swift

@@ -92,3 +92,30 @@ public struct SignedUploadURL: Sendable {
   public let path: String
   public let token: String
 }
+
+public struct FileUploadResponse: Sendable {
+  public let id: String
+  public let path: String
+  public let fullPath: String
+}
+
+public struct SignedURLUploadResponse: Sendable {
+  public let path: String
+  public let fullPath: String
+}
+
+public struct CreateSignedUploadURLOptions: Sendable {
+  public var upsert: Bool
+
+  public init(upsert: Bool) {
+    self.upsert = upsert
+  }
+}
+
+public struct DestinationOptions: Sendable {
+  public var destinationBucket: String?
+
+  public init(destinationBucket: String? = nil) {
+    self.destinationBucket = destinationBucket
+  }
+}

Tests/FunctionsTests/FunctionsClientTests.swift

@@ -62,7 +62,7 @@ final class FunctionsClientTests: XCTestCase {
     let http = HTTPClientMock().any { _ in try .stub(body: Empty()) }
 
     let sut = FunctionsClient(
-      url: self.url,
+      url: url,
       headers: ["Apikey": apiKey],
       region: nil,
       http: http

Tests/IntegrationTests/Fixtures/Upload/file-2.txt

@@ -0,0 +1 @@
+supabase txt file 2