Add compatibility with protobuf 28 (#541)

* Add compatibility with protobuf 28 Signed-off-by: Ramir Sultanov <[email protected]> * Add message verification after message down casts Signed-off-by: Ramir Sultanov <[email protected]> --------- Signed-off-by: Ramir Sultanov <[email protected]>
gazebosim · Nov 5, 2024 · 6256a56 · 6256a56
1 parent f6b65f0
commit 6256a56
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 2 deletions.
diff --git a/include/gz/transport/RepHandler.hh b/include/gz/transport/RepHandler.hh
@@ -141,7 +141,12 @@ namespace gz
           return false;
         }
 
-#if GOOGLE_PROTOBUF_VERSION >= 4022000
+#if GOOGLE_PROTOBUF_VERSION >= 5028000
+        const auto msgReq =
+          google::protobuf::DynamicCastMessage<Req>(&_msgReq);
+        auto msgRep =
+          google::protobuf::DynamicCastMessage<Rep>(&_msgRep);
+#elif GOOGLE_PROTOBUF_VERSION >= 4022000
         auto msgReq =
           google::protobuf::internal::DownCast<const Req*>(&_msgReq);
         auto msgRep = google::protobuf::internal::DownCast<Rep*>(&_msgRep);
@@ -154,6 +159,45 @@ namespace gz
         auto msgRep = google::protobuf::internal::down_cast<Rep*>(&_msgRep);
 #endif
 
+        // Verify the dynamically casted messages are valid
+        if (msgReq == nullptr || msgRep == nullptr)
+        {
+          if (msgReq == nullptr)
+          {
+            if (_msgReq.GetDescriptor() != nullptr)
+            {
+              std::cerr << "RepHandler::RunLocalCallback() error: "
+                        << "Failed to cast the request of the type "
+                        << _msgReq.GetDescriptor()->full_name()
+                        << " to the specified type" << '\n';
+            }
+            else
+            {
+              std::cerr << "RepHandler::RunLocalCallback() error: "
+                        << "Failed to cast the request of an unknown type"
+                        << " to the specified type" << '\n';
+            }
+          }
+          if (msgRep == nullptr)
+          {
+            if (_msgRep.GetDescriptor() != nullptr)
+            {
+              std::cerr << "RepHandler::RunLocalCallback() error: "
+                        << "Failed to cast the response of the type "
+                        << _msgRep.GetDescriptor()->full_name()
+                        << " to the specified type" << '\n';
+            }
+            else
+            {
+              std::cerr << "RepHandler::RunLocalCallback() error: "
+                        << "Failed to cast the response of an unknown type"
+                        << " to the specified type" << '\n';
+            }
+          }
+          std::cerr.flush();
+          return false;
+        }
+
         return this->cb(*msgReq, *msgRep);
       }
 

diff --git a/include/gz/transport/SubscriptionHandler.hh b/include/gz/transport/SubscriptionHandler.hh
@@ -214,14 +214,36 @@ namespace gz
         if (!this->UpdateThrottling())
           return true;
 
-#if GOOGLE_PROTOBUF_VERSION >= 4022000
+#if GOOGLE_PROTOBUF_VERSION >= 5028000
+        auto msgPtr = google::protobuf::DynamicCastMessage<T>(&_msg);
+#elif GOOGLE_PROTOBUF_VERSION >= 4022000
         auto msgPtr = google::protobuf::internal::DownCast<const T*>(&_msg);
 #elif GOOGLE_PROTOBUF_VERSION >= 3000000
         auto msgPtr = google::protobuf::down_cast<const T*>(&_msg);
 #else
         auto msgPtr = google::protobuf::internal::down_cast<const T*>(&_msg);
 #endif
 
+        // Verify the dynamically casted message is valid
+        if (msgPtr == nullptr)
+        {
+          if (_msg.GetDescriptor() != nullptr)
+          {
+            std::cerr << "SubscriptionHandler::RunLocalCallback() error: "
+                      << "Failed to cast the message of the type "
+                      << _msg.GetDescriptor()->full_name()
+                      << " to the specified type" << '\n';
+          }
+          else
+          {
+            std::cerr << "SubscriptionHandler::RunLocalCallback() error: "
+                      << "Failed to cast the message of an unknown type"
+                      << " to the specified type" << '\n';
+          }
+          std::cerr.flush();
+          return false;
+        }
+
         this->cb(*msgPtr, _info);
         return true;
       }