test(postgrest): increase code coverage (#651)

* test(postgrest): increase code coverage

* move deprecated code to Deprecated.swift file

Author: grdsdev

.swiftpm/xcode/xcshareddata/xcschemes/PostgREST.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 = "PostgREST"
+            BuildableName = "PostgREST"
+            BlueprintName = "PostgREST"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "PostgRESTTests"
+               BuildableName = "PostgRESTTests"
+               BlueprintName = "PostgRESTTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Sources/PostgREST/PostgrestBuilder.swift

@@ -106,11 +106,7 @@ public class PostgrestBuilder: @unchecked Sendable {
       }
 
       if let count = $0.fetchOptions.count {
-        if let prefer = $0.request.headers[.prefer] {
-          $0.request.headers[.prefer] = "\(prefer),count=\(count.rawValue)"
-        } else {
-          $0.request.headers[.prefer] = "count=\(count.rawValue)"
-        }
+        $0.request.headers.appendOrUpdate(.prefer, value: "count=\(count.rawValue)")
       }
 
       if $0.request.headers[.accept] == nil {

Sources/PostgREST/PostgrestTransformBuilder.swift

@@ -23,20 +23,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
     .joined(separator: "")
     mutableState.withValue {
       $0.request.query.appendOrUpdate(URLQueryItem(name: "select", value: cleanedColumns))
-
-      if let prefer = $0.request.headers[.prefer] {
-        var components = prefer.components(separatedBy: ",")
-
-        if let index = components.firstIndex(where: { $0.hasPrefix("return=") }) {
-          components[index] = "return=representation"
-        } else {
-          components.append("return=representation")
-        }
-
-        $0.request.headers[.prefer] = components.joined(separator: ",")
-      } else {
-        $0.request.headers[.prefer] = "return=representation"
-      }
+      $0.request.headers.appendOrUpdate(.prefer, value: "return=representation")
     }
     return self
   }
@@ -64,7 +51,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
         "\(column).\(ascending ? "asc" : "desc").\(nullsFirst ? "nullsfirst" : "nullslast")"
 
       if let existingOrderIndex,
-         let currentValue = $0.request.query[existingOrderIndex].value
+        let currentValue = $0.request.query[existingOrderIndex].value
       {
         $0.request.query[existingOrderIndex] = URLQueryItem(
           name: key,
@@ -85,11 +72,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
   public func limit(_ count: Int, referencedTable: String? = nil) -> PostgrestTransformBuilder {
     mutableState.withValue {
       let key = referencedTable.map { "\($0).limit" } ?? "limit"
-      if let index = $0.request.query.firstIndex(where: { $0.name == key }) {
-        $0.request.query[index] = URLQueryItem(name: key, value: "\(count)")
-      } else {
-        $0.request.query.append(URLQueryItem(name: key, value: "\(count)"))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: key, value: "\(count)"))
     }
     return self
   }
@@ -113,24 +96,10 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
     let keyLimit = referencedTable.map { "\($0).limit" } ?? "limit"
 
     mutableState.withValue {
-      if let index = $0.request.query.firstIndex(where: { $0.name == keyOffset }) {
-        $0.request.query[index] = URLQueryItem(name: keyOffset, value: "\(from)")
-      } else {
-        $0.request.query.append(URLQueryItem(name: keyOffset, value: "\(from)"))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: keyOffset, value: "\(from)"))
 
       // Range is inclusive, so add 1
-      if let index = $0.request.query.firstIndex(where: { $0.name == keyLimit }) {
-        $0.request.query[index] = URLQueryItem(
-          name: keyLimit,
-          value: "\(to - from + 1)"
-        )
-      } else {
-        $0.request.query.append(URLQueryItem(
-          name: keyLimit,
-          value: "\(to - from + 1)"
-        ))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: keyLimit, value: "\(to - from + 1)"))
     }
 
     return self
@@ -195,7 +164,8 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
       .compactMap { $0 }
       .joined(separator: "|")
       let forMediaType = $0.request.headers[.accept] ?? "application/json"
-      $0.request.headers[.accept] = "application/vnd.pgrst.plan+\"\(format)\"; for=\(forMediaType); options=\(options);"
+      $0.request.headers[.accept] =
+        "application/vnd.pgrst.plan+\"\(format)\"; for=\(forMediaType); options=\(options);"
     }
 
     return self

Sources/PostgREST/URLQueryRepresentable.swift

@@ -68,20 +68,15 @@ extension Optional: URLQueryRepresentable where Wrapped: URLQueryRepresentable {
 extension JSONObject: URLQueryRepresentable {
   public var queryValue: String {
     let value = mapValues(\.value)
-    return JSONSerialization.stringfy(value)
+    return JSONSerialization.stringfy(value)!
   }
 }
 
 extension JSONSerialization {
-  static func stringfy(_ object: Any) -> String {
-    guard
-      let data = try? data(
-        withJSONObject: object, options: [.withoutEscapingSlashes, .sortedKeys]
-      ),
-      let string = String(data: data, encoding: .utf8)
-    else {
-      return "{}"
-    }
-    return string
+  static func stringfy(_ object: Any) -> String? {
+    let data = try? data(
+      withJSONObject: object, options: [.withoutEscapingSlashes, .sortedKeys]
+    )
+    return data.flatMap { String(data: $0, encoding: .utf8) }
   }
 }

Tests/PostgRESTTests/PostgresQueryTests.swift

@@ -0,0 +1,55 @@
+//
+//  PostgrestQueryTests.swift
+//  Supabase
+//
+//  Created by Guilherme Souza on 21/01/25.
+//
+
+import InlineSnapshotTesting
+import Mocker
+import PostgREST
+import TestHelpers
+import XCTest
+
+class PostgrestQueryTests: XCTestCase {
+  let url = URL(string: "http://localhost:54321/rest/v1")!
+
+  let sessionConfiguration: URLSessionConfiguration = {
+    let configuration = URLSessionConfiguration.default
+    configuration.protocolClasses = [MockingURLProtocol.self]
+    return configuration
+  }()
+
+  lazy var session = URLSession(configuration: sessionConfiguration)
+
+  lazy var sut = PostgrestClient(
+    url: url,
+    headers: [
+      "apikey":
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0"
+    ],
+    logger: nil,
+    fetch: {
+      try await self.session.data(for: $0)
+    },
+    encoder: {
+      let encoder = PostgrestClient.Configuration.jsonEncoder
+      encoder.outputFormatting = [.sortedKeys]
+      return encoder
+    }()
+  )
+
+  struct User: Codable {
+    let id: Int
+    let username: String
+  }
+
+  struct Country: Decodable {
+    let name: String
+    let cities: [City]
+
+    struct City: Decodable {
+      let name: String
+    }
+  }
+}