use Alamofire for encoding query string

Author: grdsdev

Sources/Functions/Types.swift

@@ -8,17 +8,13 @@ public enum FunctionsError: Error, LocalizedError {
   /// Error indicating a non-2xx status code returned by the Edge Function.
   case httpError(code: Int, data: Data)
 
-  case unknown(any Error)
-
   /// A localized description of the error.
   public var errorDescription: String? {
     switch self {
     case .relayError:
       "Relay Error invoking the Edge Function"
     case let .httpError(code, _):
       "Edge Function returned a non-2xx status code: \(code)"
-    case let .unknown(error):
-      "Unkown error: \(error.localizedDescription)"
     }
   }
 }

Sources/Helpers/AnyJSON/AnyJSON.swift

@@ -96,10 +96,10 @@ public enum AnyJSON: Sendable, Codable, Hashable {
       self = .string(string)
     } else if let bool = try? container.decode(Bool.self) {
       self = .bool(bool)
-    } else if let double = try? container.decode(Double.self) {
-      self = .double(double)
     } else if let int = try? container.decode(Int.self) {
       self = .integer(int)
+    } else if let double = try? container.decode(Double.self) {
+      self = .double(double)
     } else if container.decodeNil() {
       self = .null
     } else {

Sources/Helpers/FoundationExtensions.swift

@@ -5,6 +5,7 @@
 //  Created by Guilherme Souza on 23/04/24.
 //
 
+import Alamofire
 import Foundation
 
 #if canImport(FoundationNetworking)
@@ -16,15 +17,15 @@ import Foundation
 
 extension Result {
   package var value: Success? {
-    if case let .success(value) = self {
+    if case .success(let value) = self {
       value
     } else {
       nil
     }
   }
 
   package var error: Failure? {
-    if case let .failure(error) = self {
+    if case .failure(let error) = self {
       error
     } else {
       nil
@@ -51,16 +52,20 @@ extension URL {
       return
     }
 
-    let currentQueryItems = components.percentEncodedQueryItems ?? []
+    let encoding = URLEncoding.queryString
 
-    components.percentEncodedQueryItems =
-      currentQueryItems
-      + queryItems.map {
-        URLQueryItem(
-          name: escape($0.name),
-          value: $0.value.map(escape)
-        )
+    func query(_ parameters: [URLQueryItem]) -> String {
+      var components: [(String, String)] = []
+
+      for param in parameters.sorted(by: { $0.name < $1.name }) {
+        components += encoding.queryComponents(fromKey: param.name, value: param.value!)
       }
+      return components.map { "\($0)=\($1)" }.joined(separator: "&")
+    }
+
+    let percentEncodedQuery =
+      (components.percentEncodedQuery.map { $0 + "&" } ?? "") + query(queryItems)
+    components.percentEncodedQuery = percentEncodedQuery
 
     if let newURL = components.url {
       self = newURL
@@ -72,63 +77,4 @@ extension URL {
     url.appendQueryItems(queryItems)
     return url
   }
-
-  // package mutating func appendOrUpdateQueryItems(_ queryItems: [URLQueryItem]) {
-  //   guard !queryItems.isEmpty else {
-  //     return
-  //   }
-
-  //   guard var components = URLComponents(url: self, resolvingAgainstBaseURL: false) else {
-  //     return
-  //   }
-
-  //   var currentQueryItems = components.percentEncodedQueryItems ?? []
-
-  //   for var queryItem in queryItems {
-  //     queryItem.name = escape(queryItem.name)
-  //     queryItem.value = queryItem.value.map(escape)
-  //     if let index = currentQueryItems.firstIndex(where: { $0.name == queryItem.name }) {
-  //       currentQueryItems[index] = queryItem
-  //     } else {
-  //       currentQueryItems.append(queryItem)
-  //     }
-  //   }
-
-  //   components.percentEncodedQueryItems = currentQueryItems
-
-  //   if let newURL = components.url {
-  //     self = newURL
-  //   }
-  // }
-
-  // package func appendingOrUpdatingQueryItems(_ queryItems: [URLQueryItem]) -> URL {
-  //   var url = self
-  //   url.appendOrUpdateQueryItems(queryItems)
-  //   return url
-  // }
-}
-
-func escape(_ string: String) -> String {
-  string.addingPercentEncoding(withAllowedCharacters: .sbURLQueryAllowed) ?? string
-}
-
-extension CharacterSet {
-  /// Creates a CharacterSet from RFC 3986 allowed characters.
-  ///
-  /// RFC 3986 states that the following characters are "reserved" characters.
-  ///
-  /// - General Delimiters: ":", "#", "[", "]", "@", "?", "/"
-  /// - Sub-Delimiters: "!", "$", "&", "'", "(", ")", "*", "+", ",", ";", "="
-  ///
-  /// In RFC 3986 - Section 3.4, it states that the "?" and "/" characters should not be escaped to allow
-  /// query strings to include a URL. Therefore, all "reserved" characters with the exception of "?" and "/"
-  /// should be percent-escaped in the query string.
-  static let sbURLQueryAllowed: CharacterSet = {
-    let generalDelimitersToEncode = ":#[]@"  // does not include "?" or "/" due to RFC 3986 - Section 3.4
-    let subDelimitersToEncode = "!$&'()*+,;="
-    let encodableDelimiters = CharacterSet(
-      charactersIn: "\(generalDelimitersToEncode)\(subDelimitersToEncode)")
-
-    return CharacterSet.urlQueryAllowed.subtracting(encodableDelimiters)
-  }()
 }

Tests/FunctionsTests/FunctionsClientTests.swift

@@ -156,14 +156,12 @@ final class FunctionsClientTests: XCTestCase {
     } catch {
       assertInlineSnapshot(of: error, as: .customDump) {
         """
-        FunctionsError.unknown(
-          .keyNotFound(
-            .CodingKeys(stringValue: "status", intValue: nil),
-            DecodingError.Context(
-              codingPath: [],
-              debugDescription: #"No value associated with key CodingKeys(stringValue: "status", intValue: nil) ("status")."#,
-              underlyingError: nil
-            )
+        DecodingError.keyNotFound(
+          .CodingKeys(stringValue: "status", intValue: nil),
+          DecodingError.Context(
+            codingPath: [],
+            debugDescription: #"No value associated with key CodingKeys(stringValue: "status", intValue: nil) ("status")."#,
+            underlyingError: nil
           )
         )
         """
@@ -294,7 +292,7 @@ final class FunctionsClientTests: XCTestCase {
   func testInvoke_shouldThrow_error() async throws {
     Mock(
       url: url.appendingPathComponent("hello_world"),
-      statusCode: 200,
+      statusCode: 204,
       data: [.post: Data()],
       requestError: URLError(.badServerResponse)
     )
@@ -312,13 +310,10 @@ final class FunctionsClientTests: XCTestCase {
     do {
       try await sut.invoke("hello_world")
       XCTFail("Invoke should fail.")
-    } catch let FunctionsError.unknown(error) {
-      guard case let AFError.sessionTaskFailed(underlyingError as URLError) = error else {
-        XCTFail()
-        return
-      }
-
+    } catch let AFError.sessionTaskFailed(underlyingError as URLError) {
       XCTAssertEqual(underlyingError.code, .badServerResponse)
+    } catch {
+      XCTFail("Unexpected error \(error)")
     }
   }
 
@@ -345,7 +340,7 @@ final class FunctionsClientTests: XCTestCase {
     } catch {
       assertInlineSnapshot(of: error, as: .description) {
         """
-        httpError(code: 300, data: 0 bytes)
+        responseValidationFailed(reason: Alamofire.AFError.ResponseValidationFailureReason.customValidationFailed(error: Functions.FunctionsError.httpError(code: 300, data: 0 bytes)))
         """
       }
     }
@@ -377,7 +372,7 @@ final class FunctionsClientTests: XCTestCase {
     } catch {
       assertInlineSnapshot(of: error, as: .description) {
         """
-        relayError
+        responseValidationFailed(reason: Alamofire.AFError.ResponseValidationFailureReason.customValidationFailed(error: Functions.FunctionsError.relayError))
         """
       }
     }
@@ -441,7 +436,7 @@ final class FunctionsClientTests: XCTestCase {
     } catch {
       assertInlineSnapshot(of: error, as: .description) {
         """
-        httpError(code: 300, data: 0 bytes)
+        responseValidationFailed(reason: Alamofire.AFError.ResponseValidationFailureReason.customValidationFailed(error: Functions.FunctionsError.httpError(code: 300, data: 0 bytes)))
         """
       }
     }
@@ -476,7 +471,7 @@ final class FunctionsClientTests: XCTestCase {
     } catch {
       assertInlineSnapshot(of: error, as: .description) {
         """
-        relayError
+        responseValidationFailed(reason: Alamofire.AFError.ResponseValidationFailureReason.customValidationFailed(error: Functions.FunctionsError.relayError))
         """
       }
     }