Merge pull request #198 from shiguredo/feature/fix-signaling-connect-…

…custom-encode

SignalingConnect の `metadata`, `signaling_notify_metadata` が nil なのに送信データに {} が含まれる問題を修正

CHANGES.md

@@ -17,6 +17,8 @@
   - CocoaPods 1.8 からソースリポジトリのデフォルトが `https://cdn.cocoapods.org/` になった
   - https://blog.cocoapods.org/CocoaPods-1.8.0-beta/
   - @zztkm
+- [FIX] SignalingConnect の `metadata`, `signaling_notify_metadata` が nil の場合に {} として送信されてしまう問題を修正する
+  - @zztkm
 
 ## 2024.2.0
 

Sora/Signaling.swift

@@ -807,10 +807,20 @@ extension SignalingConnect: Codable {
         try container.encodeIfPresent(clientId, forKey: .client_id)
         try container.encodeIfPresent(bundleId, forKey: .bundle_id)
         try container.encodeIfPresent(sdp, forKey: .sdp)
-        let metadataEnc = container.superEncoder(forKey: .metadata)
-        try metadata?.encode(to: metadataEnc)
-        let notifyEnc = container.superEncoder(forKey: .signaling_notify_metadata)
-        try notifyMetadata?.encode(to: notifyEnc)
+
+        // try metadata?.encode(to: metadataEnc) で metadata が nil の時はエンコードが実行されないように実装しても、
+        // container.superEncoder(forKey: .metadata) の呼び出し時点で子要素の準備までしてしまっているので
+        // metadata が nil の場合でも、`"metadata": {}` になってしまう。
+        // これを回避するために metadata が nil でない場合のみ、container.superEncoder(forKey: .metadata) を呼び出して
+        // encode(to:) を実行するような実装にしている。
+        if let metadata {
+            let metadataEnc = container.superEncoder(forKey: .metadata)
+            try metadata.encode(to: metadataEnc)
+        }
+        if let notifyMetadata {
+            let notifyEnc = container.superEncoder(forKey: .signaling_notify_metadata)
+            try notifyMetadata.encode(to: notifyEnc)
+        }
         try container.encodeIfPresent(multistreamEnabled,
                                       forKey: .multistream)
         try container.encodeIfPresent(soraClient, forKey: .sora_client)