commit 8299d3e32489592fc07764bb593629ba401e2331
author Jordan Bayles <jophba@chromium.org> Tue Jun 09 15:04:08 2020 -0700
committer Commit Bot <commit-bot@chromium.org> Wed Jun 10 17:58:35 2020 +0000
tree fbbb283eeb469eba1b989e8970af5997f3c48fba
parent 492f486ddb403fcbae8d6d488e5507854edd6031

Improve receiver session verbose logging

The current logging set is not very helpful for debugging OFFER/ANSWER bugs. This patch improves the logging statements.

Change-Id: I2e9f09b242daa87927d0af9d30599ba95a13c5e0
Reviewed-on: https://chromium-review.googlesource.com/c/openscreen/+/2238946
Reviewed-by: Ryan Keane <rwkeane@google.com>
Commit-Queue: Jordan Bayles <jophba@chromium.org>

cast/streaming/receiver_session.cc

diff --git a/cast/streaming/receiver_session.cc b/cast/streaming/receiver_session.cc
index 6c7c98f..a9aad41 100644
--- a/cast/streaming/receiver_session.cc
+++ b/cast/streaming/receiver_session.cc
@@ -84,7 +84,7 @@
     const std::string codec_name = CodecToString(codec);
     for (const Stream& offered_stream : offered_streams) {
       if (offered_stream.stream.codec_name == codec_name) {
-        OSP_DVLOG << "Selected " << codec_name << " as codec for streaming.";
+        OSP_DVLOG << "Selected " << codec_name << " as codec for streaming";
         return &offered_stream;
       }
     }
@@ -163,6 +163,7 @@
     OSP_DLOG_WARN << "Received an invalid message: " << message;
     return;
   }
+  OSP_DVLOG << "Received a message: " << message;
 
   // TODO(jophba): add sender connected/disconnected messaging.
   int sequence_number;
@@ -193,8 +194,7 @@
 }
 
 void ReceiverSession::OnError(Error error) {
-  OSP_DLOG_WARN << "ReceiverSession's message port encountered an error: "
-                << error;
+  OSP_DLOG_WARN << "ReceiverSession message port error: " << error;
 }
 
 void ReceiverSession::OnOffer(Message* message) {
@@ -222,6 +222,7 @@
   if (!selected_audio_stream && !selected_video_stream) {
     message->body = CreateInvalidAnswerMessage(
         Error(Error::Code::kParseError, "No selected streams"));
+    OSP_DLOG_WARN << "Failed to select any streams from OFFER";
     SendMessage(message);
     return;
   }
@@ -231,6 +232,7 @@
   if (!answer.IsValid()) {
     message->body = CreateInvalidAnswerMessage(
         Error(Error::Code::kParseError, "Invalid answer message"));
+    OSP_DLOG_WARN << "Failed to construct an ANSWER message";
     SendMessage(message);
     return;
   }
@@ -336,9 +338,14 @@
 
   auto body_or_error = json::Stringify(message->body);
   if (body_or_error.is_value()) {
+    OSP_DVLOG << "Sending message: SENDER[" << message->sender_id
+              << "], NAMESPACE[" << message->message_namespace << "], BODY:\n"
+              << body_or_error.value();
     message_port_->PostMessage(message->sender_id, message->message_namespace,
                                body_or_error.value());
   } else {
+    OSP_DLOG_WARN << "Sending message failed with error:\n"
+                  << body_or_error.error();
     client_->OnError(this, body_or_error.error());
   }
 }