fix: add columns query param to insert and upsert methods

grdsdev · grdsdev · commit 7a99c47dc9ca · 2023-12-20T05:40:21.000-03:00
diff --git a/Sources/PostgREST/NullEncodable.swift b/Sources/PostgREST/NullEncodable.swift
diff --git a/Sources/PostgREST/PostgrestQueryBuilder.swift b/Sources/PostgREST/PostgrestQueryBuilder.swift
@@ -69,6 +69,11 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
       if !prefersHeaders.isEmpty {
         $0.request.headers["Prefer"] = prefersHeaders.joined(separator: ",")
       }
+      if let body = $0.request.body, let jsonObject = try JSONSerialization.jsonObject(with: body) as? [[String: Any]] {
+        let allKeys = jsonObject.flatMap(\.keys)
+        let uniqueKeys = Set(allKeys).sorted()
+        $0.request.query.append(URLQueryItem(name: "columns", value: uniqueKeys.joined(separator: ",")))
+      }
     }
 
     return PostgrestFilterBuilder(self)
@@ -109,6 +114,12 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {
       if !prefersHeaders.isEmpty {
         $0.request.headers["Prefer"] = prefersHeaders.joined(separator: ",")
       }
+
+      if let body = $0.request.body, let jsonObject = try JSONSerialization.jsonObject(with: body) as? [[String: Any]] {
+        let allKeys = jsonObject.flatMap(\.keys)
+        let uniqueKeys = Set(allKeys).sorted()
+        $0.request.query.append(URLQueryItem(name: "columns", value: uniqueKeys.joined(separator: ",")))
+      }
     }
     return PostgrestFilterBuilder(self)
   }
diff --git a/Tests/PostgRESTTests/BuildURLRequestTests.swift b/Tests/PostgRESTTests/BuildURLRequestTests.swift
@@ -10,6 +10,11 @@ import XCTest
   import FoundationNetworking
 #endif
 
+struct User: Encodable {
+  var email: String
+  var username: String?
+}
+
 @MainActor
 final class BuildURLRequestTests: XCTestCase {
   let url = URL(string: "https://example.supabase.co")!
@@ -55,7 +60,16 @@ final class BuildURLRequestTests: XCTestCase {
       },
       TestCase(name: "insert new user") { client in
         try await client.from("users")
-          .insert(["email": "johndoe@supabase.io"])
+          .insert(User(email: "johndoe@supabase.io"))
+      },
+      TestCase(name: "bulk insert users") { client in
+        try await client.from("users")
+          .insert(
+            [
+              User(email: "johndoe@supabase.io"),
+              User(email: "johndoe2@supabase.io", username: "johndoe2"),
+            ]
+          )
       },
       TestCase(name: "call rpc") { client in
         try await client.rpc("test_fcn", params: ["KEY": "VALUE"])
@@ -89,11 +103,20 @@ final class BuildURLRequestTests: XCTestCase {
       },
       TestCase(name: "test upsert not ignoring duplicates") { client in
         try await client.from("users")
-          .upsert(["email": "johndoe@supabase.io"])
+          .upsert(User(email: "johndoe@supabase.io"))
+      },
+      TestCase(name: "bulk upsert") { client in
+        try await client.from("users")
+          .upsert(
+            [
+              User(email: "johndoe@supabase.io"),
+              User(email: "johndoe2@supabase.io", username: "johndoe2"),
+            ]
+          )
       },
       TestCase(name: "test upsert ignoring duplicates") { client in
         try await client.from("users")
-          .upsert(["email": "johndoe@supabase.io"], ignoreDuplicates: true)
+          .upsert(User(email: "johndoe@supabase.io"), ignoreDuplicates: true)
       },
       TestCase(name: "query with + character") { client in
         await client.from("users")
diff --git a/Tests/PostgRESTTests/NullEncodableTests.swift b/Tests/PostgRESTTests/NullEncodableTests.swift
diff --git a/Tests/PostgRESTTests/__Snapshots__/BuildURLRequestTests/testBuildRequest.bulk-insert-users.txt b/Tests/PostgRESTTests/__Snapshots__/BuildURLRequestTests/testBuildRequest.bulk-insert-users.txt
@@ -0,0 +1,7 @@
+curl \
+	--request POST \
+	--header "Accept: application/json" \
+	--header "Content-Type: application/json" \
+	--header "X-Client-Info: postgrest-swift/x.y.z" \
+	--data "[{\"email\":\"johndoe@supabase.io\"},{\"email\":\"johndoe2@supabase.io\",\"username\":\"johndoe2\"}]" \
+	"https://example.supabase.co/users?columns=email,username"
diff --git a/Tests/PostgRESTTests/__Snapshots__/BuildURLRequestTests/testBuildRequest.bulk-upsert.txt b/Tests/PostgRESTTests/__Snapshots__/BuildURLRequestTests/testBuildRequest.bulk-upsert.txt
@@ -0,0 +1,8 @@
+curl \
+	--request POST \
+	--header "Accept: application/json" \
+	--header "Content-Type: application/json" \
+	--header "Prefer: resolution=merge-duplicates,return=representation" \
+	--header "X-Client-Info: postgrest-swift/x.y.z" \
+	--data "[{\"email\":\"johndoe@supabase.io\"},{\"email\":\"johndoe2@supabase.io\",\"username\":\"johndoe2\"}]" \
+	"https://example.supabase.co/users?columns=email,username"

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,11 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {`
`69`	`69`	`if !prefersHeaders.isEmpty {`
`70`	`70`	`$0.request.headers["Prefer"] = prefersHeaders.joined(separator: ",")`
`71`	`71`	`}`
	`72`	`+ if let body = $0.request.body, let jsonObject = try JSONSerialization.jsonObject(with: body) as? [[String: Any]] {`
	`73`	`+ let allKeys = jsonObject.flatMap(\.keys)`
	`74`	`+ let uniqueKeys = Set(allKeys).sorted()`
	`75`	`+ $0.request.query.append(URLQueryItem(name: "columns", value: uniqueKeys.joined(separator: ",")))`
	`76`	`+ }`
`72`	`77`	`}`
`73`	`78`
`74`	`79`	`return PostgrestFilterBuilder(self)`
`@@ -109,6 +114,12 @@ public final class PostgrestQueryBuilder: PostgrestBuilder {`
`109`	`114`	`if !prefersHeaders.isEmpty {`
`110`	`115`	`$0.request.headers["Prefer"] = prefersHeaders.joined(separator: ",")`
`111`	`116`	`}`
	`117`	`+`
	`118`	`+ if let body = $0.request.body, let jsonObject = try JSONSerialization.jsonObject(with: body) as? [[String: Any]] {`
	`119`	`+ let allKeys = jsonObject.flatMap(\.keys)`
	`120`	`+ let uniqueKeys = Set(allKeys).sorted()`
	`121`	`+ $0.request.query.append(URLQueryItem(name: "columns", value: uniqueKeys.joined(separator: ",")))`
	`122`	`+ }`
`112`	`123`	`}`
`113`	`124`	`return PostgrestFilterBuilder(self)`
`114`	`125`	`}`