test(storage): increase code coverage

Author: grdsdev

.swiftpm/xcode/xcshareddata/xcschemes/Storage.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1510"
-   version = "1.7">
+   version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES">
@@ -26,8 +26,29 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "Storage"
+            BuildableName = "Storage"
+            BlueprintName = "Storage"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "StorageTests"
+               BuildableName = "StorageTests"
+               BlueprintName = "StorageTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Sources/Helpers/Codable.swift

@@ -0,0 +1,36 @@
+//
+//  Codable.swift
+//  Supabase
+//
+//  Created by Guilherme Souza on 20/01/25.
+//
+
+import ConcurrencyExtras
+import Foundation
+
+extension JSONDecoder {
+  private static let supportedDateFormatters: [UncheckedSendable<ISO8601DateFormatter>] = [
+    ISO8601DateFormatter.iso8601WithFractionalSeconds,
+    ISO8601DateFormatter.iso8601,
+  ]
+
+  /// Default `JSONDecoder` for decoding types from Supabase.
+  package static let `default`: JSONDecoder = {
+    let decoder = JSONDecoder()
+    decoder.dateDecodingStrategy = .custom { decoder in
+      let container = try decoder.singleValueContainer()
+      let string = try container.decode(String.self)
+
+      for formatter in supportedDateFormatters {
+        if let date = formatter.value.date(from: string) {
+          return date
+        }
+      }
+
+      throw DecodingError.dataCorruptedError(
+        in: container, debugDescription: "Invalid date format: \(string)"
+      )
+    }
+    return decoder
+  }()
+}

Sources/Helpers/HTTP/HTTPFields.swift

@@ -1,37 +1,70 @@
 import HTTPTypes
 
-package extension HTTPFields {
-  init(_ dictionary: [String: String]) {
+extension HTTPFields {
+  package init(_ dictionary: [String: String]) {
     self.init(dictionary.map { .init(name: .init($0.key)!, value: $0.value) })
   }
-  
-  var dictionary: [String: String] {
+
+  package var dictionary: [String: String] {
     let keyValues = self.map {
       ($0.name.rawName, $0.value)
     }
-    
+
     return .init(keyValues, uniquingKeysWith: { $1 })
   }
-  
-  mutating func merge(with other: Self) {
+
+  package mutating func merge(with other: Self) {
     for field in other {
       self[field.name] = field.value
     }
   }
-  
-  func merging(with other: Self) -> Self {
+
+  package func merging(with other: Self) -> Self {
     var copy = self
-    
+
     for field in other {
       copy[field.name] = field.value
     }
 
     return copy
   }
+
+  /// Append or update a value in header.
+  ///
+  /// Example:
+  /// ```swift
+  /// var headers: HTTPFields = [
+  ///   "Prefer": "count=exact,return=representation"
+  /// ]
+  ///
+  /// headers.appendOrUpdate(.prefer, value: "return=minimal")
+  /// #expect(headers == ["Prefer": "count=exact,return=minimal"]
+  /// ```
+  package mutating func appendOrUpdate(
+    _ name: HTTPField.Name,
+    value: String,
+    separator: String = ","
+  ) {
+    if let currentValue = self[name] {
+      var components = currentValue.components(separatedBy: separator)
+
+      if let key = value.split(separator: "=").first,
+        let index = components.firstIndex(where: { $0.hasPrefix("\(key)=") })
+      {
+        components[index] = value
+      } else {
+        components.append(value)
+      }
+
+      self[name] = components.joined(separator: separator)
+    } else {
+      self[name] = value
+    }
+  }
 }
 
-package extension HTTPField.Name {
-  static let xClientInfo = HTTPField.Name("X-Client-Info")!
-  static let xRegion = HTTPField.Name("x-region")!
-  static let xRelayError = HTTPField.Name("x-relay-error")!
+extension HTTPField.Name {
+  package static let xClientInfo = HTTPField.Name("X-Client-Info")!
+  package static let xRegion = HTTPField.Name("x-region")!
+  package static let xRelayError = HTTPField.Name("x-relay-error")!
 }

Sources/Storage/Codable.swift

@@ -9,34 +9,19 @@ import ConcurrencyExtras
 import Foundation
 
 extension JSONEncoder {
+  @available(*, deprecated, message: "Access to storage encoder is going to be removed.")
   public static let defaultStorageEncoder: JSONEncoder = {
     let encoder = JSONEncoder()
     encoder.keyEncodingStrategy = .convertToSnakeCase
     return encoder
   }()
+
+  static let unconfiguredEncoder: JSONEncoder = .init()
 }
 
 extension JSONDecoder {
-  public static let defaultStorageDecoder: JSONDecoder = {
-    let decoder = JSONDecoder()
-    let formatter = LockIsolated(ISO8601DateFormatter())
-    formatter.withValue {
-      $0.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
-    }
-
-    decoder.dateDecodingStrategy = .custom { decoder in
-      let container = try decoder.singleValueContainer()
-      let string = try container.decode(String.self)
-
-      if let date = formatter.withValue({ $0.date(from: string) }) {
-        return date
-      }
-
-      throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
-      )
-    }
-
-    return decoder
-  }()
+  @available(*, deprecated, message: "Access to storage decoder is going to be removed.")
+  public static var defaultStorageDecoder: JSONDecoder {
+    .default
+  }
 }

Sources/Storage/Deprecated.swift

@@ -11,7 +11,8 @@ extension StorageClientConfiguration {
   @available(
     *,
     deprecated,
-    message: "Replace usages of this initializer with new init(url:headers:encoder:decoder:session:logger)"
+    message:
+      "Replace usages of this initializer with new init(url:headers:encoder:decoder:session:logger)"
   )
   public init(
     url: URL,
@@ -101,7 +102,8 @@ extension StorageFileApi {
 @available(
   *,
   deprecated,
-  message: "File was deprecated and it isn't used in the package anymore, if you're using it on your application, consider replacing it as it will be removed on the next major release."
+  message:
+    "File was deprecated and it isn't used in the package anymore, if you're using it on your application, consider replacing it as it will be removed on the next major release."
 )
 public struct File: Hashable, Equatable {
   public var name: String
@@ -121,7 +123,8 @@ public struct File: Hashable, Equatable {
   *,
   deprecated,
   renamed: "MultipartFormData",
-  message: "FormData was deprecated in favor of MultipartFormData, and it isn't used in the package anymore, if you're using it on your application, consider replacing it as it will be removed on the next major release."
+  message:
+    "FormData was deprecated in favor of MultipartFormData, and it isn't used in the package anymore, if you're using it on your application, consider replacing it as it will be removed on the next major release."
 )
 public class FormData {
   var files: [File] = []

Sources/Storage/Helpers.swift

@@ -27,7 +27,7 @@ import Helpers
           kUTTagClassFilenameExtension, pathExtension as CFString, nil
         )?.takeRetainedValue(),
           let contentType = UTTypeCopyPreferredTagWithClass(id, kUTTagClassMIMEType)?
-          .takeRetainedValue()
+            .takeRetainedValue()
         {
           return contentType as String
         }
@@ -43,7 +43,7 @@ import Helpers
           kUTTagClassFilenameExtension, pathExtension as CFString, nil
         )?.takeRetainedValue(),
           let contentType = UTTypeCopyPreferredTagWithClass(id, kUTTagClassMIMEType)?
-          .takeRetainedValue()
+            .takeRetainedValue()
         {
           return contentType as String
         }
@@ -62,7 +62,7 @@ import Helpers
         kUTTagClassFilenameExtension, pathExtension as CFString, nil
       )?.takeRetainedValue(),
         let contentType = UTTypeCopyPreferredTagWithClass(id, kUTTagClassMIMEType)?
-        .takeRetainedValue()
+          .takeRetainedValue()
       {
         return contentType as String
       }

Sources/Storage/StorageApi.swift

@@ -1,6 +1,6 @@
 import Foundation
-import Helpers
 import HTTPTypes
+import Helpers
 
 #if canImport(FoundationNetworking)
   import FoundationNetworking
@@ -36,7 +36,7 @@ public class StorageApi: @unchecked Sendable {
 
     let response = try await http.send(request)
 
-    guard (200 ..< 300).contains(response.statusCode) else {
+    guard (200..<300).contains(response.statusCode) else {
       if let error = try? configuration.decoder.decode(
         StorageError.self,
         from: response.data

Sources/Storage/StorageError.swift

@@ -5,7 +5,7 @@ public struct StorageError: Error, Decodable, Sendable {
   public var message: String
   public var error: String?
 
-  public init(statusCode: String?, message: String, error: String?) {
+  public init(statusCode: String? = nil, message: String, error: String? = nil) {
     self.statusCode = statusCode
     self.message = message
     self.error = error

Sources/Storage/StorageFileApi.swift

@@ -70,7 +70,7 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
   }
 
   private struct SignedURLResponse: Decodable {
-    let signedURL: URL
+    let signedURL: String
   }
 
   private func _uploadOrUpdate(
@@ -274,7 +274,7 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
       let transform: TransformOptions?
     }
 
-    let encoder = JSONEncoder()
+    let encoder = JSONEncoder.unconfiguredEncoder
 
     let response = try await execute(
       HTTPRequest(
@@ -325,7 +325,7 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
       let paths: [String]
     }
 
-    let encoder = JSONEncoder()
+    let encoder = JSONEncoder.unconfiguredEncoder
 
     let response = try await execute(
       HTTPRequest(
@@ -354,25 +354,25 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
     try await createSignedURLs(paths: paths, expiresIn: expiresIn, download: download ? "" : nil)
   }
 
-  private func makeSignedURL(_ signedURL: URL, download: String?) throws -> URL {
-    guard
-      let signedURLComponents = URLComponents(
-        url: signedURL,
-        resolvingAgainstBaseURL: false
-      ),
-      var baseURLComponents = URLComponents(url: configuration.url, resolvingAgainstBaseURL: false)
+  private func makeSignedURL(_ signedURL: String, download: String?) throws -> URL {
+    guard let signedURLComponents = URLComponents(string: signedURL),
+      var baseComponents = URLComponents(
+        url: configuration.url, resolvingAgainstBaseURL: false)
     else {
       throw URLError(.badURL)
     }
 
-    baseURLComponents.path += signedURLComponents.path
-    baseURLComponents.queryItems = signedURLComponents.queryItems ?? []
+    baseComponents.path +=
+      signedURLComponents.path.hasPrefix("/")
+      ? signedURLComponents.path : "/\(signedURLComponents.path)"
+    baseComponents.queryItems = signedURLComponents.queryItems
 
     if let download {
-      baseURLComponents.queryItems!.append(URLQueryItem(name: "download", value: download))
+      baseComponents.queryItems = baseComponents.queryItems ?? []
+      baseComponents.queryItems!.append(URLQueryItem(name: "download", value: download))
     }
 
-    guard let signedURL = baseURLComponents.url else {
+    guard let signedURL = baseComponents.url else {
       throw URLError(.badURL)
     }
 
@@ -402,7 +402,7 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
     path: String? = nil,
     options: SearchOptions? = nil
   ) async throws -> [FileObject] {
-    let encoder = JSONEncoder()
+    let encoder = JSONEncoder.unconfiguredEncoder
 
     var options = options ?? defaultSearchOptions
     options.prefix = path ?? ""
@@ -545,7 +545,7 @@ public class StorageFileApi: StorageApi, @unchecked Sendable {
     options: CreateSignedUploadURLOptions? = nil
   ) async throws -> SignedUploadURL {
     struct Response: Decodable {
-      let url: URL
+      let url: String
     }
 
     var headers = HTTPFields()

Tests/StorageTests/BucketOptionsTests.swift

@@ -0,0 +1,25 @@
+import XCTest
+
+@testable import Storage
+
+final class BucketOptionsTests: XCTestCase {
+  func testDefaultInitialization() {
+    let options = BucketOptions()
+
+    XCTAssertFalse(options.public)
+    XCTAssertNil(options.fileSizeLimit)
+    XCTAssertNil(options.allowedMimeTypes)
+  }
+
+  func testCustomInitialization() {
+    let options = BucketOptions(
+      public: true,
+      fileSizeLimit: "5242880",
+      allowedMimeTypes: ["image/jpeg", "image/png"]
+    )
+
+    XCTAssertTrue(options.public)
+    XCTAssertEqual(options.fileSizeLimit, "5242880")
+    XCTAssertEqual(options.allowedMimeTypes, ["image/jpeg", "image/png"])
+  }
+}