test: revert broadcast with HTTP test

Author: grdsdev

Sources/Helpers/Codable.swift

@@ -7,6 +7,7 @@
 
 import ConcurrencyExtras
 import Foundation
+import XCTestDynamicOverlay
 
 extension JSONDecoder {
   /// Default `JSONDecoder` for decoding types from Supabase.
@@ -21,7 +22,8 @@ extension JSONDecoder {
       }
 
       throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
+        in: container,
+        debugDescription: "Invalid date format: \(string)"
       )
     }
     return decoder
@@ -36,6 +38,13 @@ extension JSONEncoder {
       let string = date.iso8601String
       try container.encode(string)
     }
+
+    #if DEBUG
+      if isTesting {
+        encoder.outputFormatting = [.sortedKeys]
+      }
+    #endif
+
     return encoder
   }
 }

Sources/Realtime/RealtimeChannelV2.swift

@@ -295,7 +295,7 @@ public final class RealtimeChannelV2: Sendable, RealtimeChannelProtocol {
     }
     headers[.authorization] = "Bearer \(accessToken)"
 
-    let body = try await JSONEncoder().encode(
+    let body = try await JSONEncoder.supabase().encode(
       BroadcastMessagePayload(
         messages: [
           BroadcastMessagePayload.Message(
@@ -347,13 +347,17 @@ public final class RealtimeChannelV2: Sendable, RealtimeChannelProtocol {
   @MainActor
   public func broadcast(event: String, message: JSONObject) async {
     if status != .subscribed {
-      reportIssue(
-        """
-        Realtime broadcast() is automatically falling back to REST API.
-        This behavior will be deprecated in the future.
-        Please use httpSend() explicitly for REST delivery.
-        """
-      )
+      // Properly expecting issues during tests isn't working as expected, I think because the reportIssue is usually triggered inside an unstructured Task
+      // because of this I'm disabling issue reporting during tests, so we can use it only for advising developers when running their applications.
+      if !isTesting {
+        reportIssue(
+          """
+          Realtime broadcast() is automatically falling back to REST API.
+          This behavior will be deprecated in the future.
+          Please use httpSend() explicitly for REST delivery.
+          """
+        )
+      }
 
       var headers: HTTPFields = [.contentType: "application/json"]
       if let apiKey = socket.options.apikey {
@@ -369,7 +373,7 @@ public final class RealtimeChannelV2: Sendable, RealtimeChannelProtocol {
             url: socket.broadcastURL,
             method: .post,
             headers: headers,
-            body: JSONEncoder().encode(
+            body: JSONEncoder.supabase().encode(
               BroadcastMessagePayload(
                 messages: [
                   BroadcastMessagePayload.Message(

Tests/RealtimeTests/RealtimeTests.swift

@@ -575,6 +575,41 @@ final class RealtimeTests: XCTestCase {
     XCTAssertEqual(heartbeatStatuses.value, [.sent, .timeout])
   }
 
+  func testBroadcastWithHTTP() async throws {
+    await http.when {
+      $0.url.path.hasSuffix("broadcast")
+    } return: { _ in
+      HTTPResponse(
+        data: "{}".data(using: .utf8)!,
+        response: HTTPURLResponse(
+          url: self.sut.broadcastURL,
+          statusCode: 200,
+          httpVersion: nil,
+          headerFields: nil
+        )!
+      )
+    }
+
+    let channel = sut.channel("public:messages") {
+      $0.broadcast.acknowledgeBroadcasts = true
+    }
+
+    try await channel.broadcast(event: "test", message: ["value": 42])
+
+    let request = await http.receivedRequests.last
+    assertInlineSnapshot(of: request?.urlRequest, as: .curl) {
+      #"""
+      curl \
+      	--request POST \
+      	--header "Authorization: Bearer custom.access.token" \
+      	--header "Content-Type: application/json" \
+      	--header "apiKey: anon.api.key" \
+      	--data "{\"messages\":[{\"event\":\"test\",\"payload\":{\"value\":42},\"private\":false,\"topic\":\"realtime:public:messages\"}]}" \
+      	"http://localhost:54321/realtime/v1/api/broadcast"
+      """#
+    }
+  }
+
   func testSetAuth() async {
     let validToken =
       "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyLCJleHAiOjY0MDkyMjExMjAwfQ.GfiEKLl36X8YWcatHg31jRbilovlGecfUKnOyXMSX9c"