[proto] Replace builtin casts with proto-specific casts for protobuf types. (#45731)

There is a protobuf experiment to "devirtualize"
messages, allowing protobuf to manage the dynamic dispatch of messages.
When enabled, it breaks builtin dynamic/down casts, so the
protobuf-specific alternatives should be preferred.

Risk Level: Low
Testing: unit test
Docs Changes: n/a
Release Notes: n/a
Platform Specific Features: n/a

---------

Signed-off-by: Clayton Knittel <cknit1999@gmail.com>

Author: ClaytonKnittel

source/common/grpc/typed_async_client.h

@@ -77,7 +77,7 @@ template <typename Response> class AsyncRequestCallbacks : public RawAsyncReques
 
 private:
   void onSuccessRaw(Buffer::InstancePtr&& response, Tracing::Span& span) override {
-    auto message = ResponsePtr<Response>(dynamic_cast<Response*>(
+    auto message = ResponsePtr<Response>(Envoy::Protobuf::DynamicCastMessage<Response>(
         Internal::parseMessageUntyped(std::make_unique<Response>(), std::move(response))
             .release()));
     if (!message) {
@@ -98,7 +98,7 @@ template <typename Response> class AsyncStreamCallbacks : public RawAsyncStreamC
 
 private:
   bool onReceiveMessageRaw(Buffer::InstancePtr&& response) override {
-    auto message = ResponsePtr<Response>(dynamic_cast<Response*>(
+    auto message = ResponsePtr<Response>(Envoy::Protobuf::DynamicCastMessage<Response>(
         Internal::parseMessageUntyped(std::make_unique<Response>(), std::move(response))
             .release()));
     if (!message) {

source/common/listener_manager/filter_chain_manager_impl.cc

@@ -53,7 +53,7 @@ class FilterChainNameActionFactory : public Matcher::ActionFactory<FilterChainAc
                                              FilterChainActionFactoryContext&,
                                              ProtobufMessage::ValidationVisitor&) override {
     return std::make_shared<FilterChainNameAction>(
-        dynamic_cast<const Protobuf::StringValue&>(config).value());
+        Envoy::Protobuf::DynamicCastMessage<Protobuf::StringValue>(config).value());
   }
   ProtobufTypes::MessagePtr createEmptyConfigProto() override {
     return std::make_unique<Protobuf::StringValue>();

source/common/listener_manager/lds_api.cc

@@ -90,7 +90,8 @@ LdsApiImpl::onConfigUpdate(const std::vector<Config::DecodedResourceRef>& added_
 
     TRY_ASSERT_MAIN_THREAD {
       const envoy::config::listener::v3::Listener& listener =
-          dynamic_cast<const envoy::config::listener::v3::Listener&>(resource.get().resource());
+          Envoy::Protobuf::DynamicCastMessage<envoy::config::listener::v3::Listener>(
+              resource.get().resource());
       listener_name = listener.name();
       if (!listener_names.insert(listener.name()).second) {
         // NOTE: at this point, the first of these duplicates has already been successfully

source/common/matcher/actions/string_returning_action.cc

@@ -67,7 +67,7 @@ class StringReturningDirectActionFactory
                                              StringReturningActionFactoryContext&,
                                              ProtobufMessage::ValidationVisitor&) override {
     // validate function doesn't exist for StringValue, so just cast.
-    const auto& config = dynamic_cast<const Protobuf::StringValue&>(proto_config);
+    const auto& config = Envoy::Protobuf::DynamicCastMessage<Protobuf::StringValue>(proto_config);
     return std::make_shared<StringReturningDirectActionImpl>(config);
   }
   ProtobufTypes::MessagePtr createEmptyConfigProto() override {

source/common/rds/common/config_traits_impl.h

@@ -22,7 +22,7 @@ class ConfigTraitsImpl : public ConfigTraits {
   ConfigConstSharedPtr createConfig(const Protobuf::Message& rc,
                                     Server::Configuration::ServerFactoryContext& context,
                                     bool validate_clusters_default) const override {
-    ASSERT(dynamic_cast<const RouteConfiguration*>(&rc));
+    ASSERT(Envoy::Protobuf::DynamicCastMessage<RouteConfiguration>(&rc));
     return std::make_shared<const ConfigImpl>(static_cast<const RouteConfiguration&>(rc), context,
                                               validate_clusters_default);
   }

source/common/router/route_config_update_receiver_impl.cc

@@ -43,7 +43,7 @@ Rds::ConfigConstSharedPtr
 ConfigTraitsImpl::createConfig(const Protobuf::Message& rc,
                                Server::Configuration::ServerFactoryContext& factory_context,
                                bool validate_clusters_default) const {
-  ASSERT(dynamic_cast<const envoy::config::route::v3::RouteConfiguration*>(&rc));
+  ASSERT(Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::RouteConfiguration>(&rc));
   return THROW_OR_RETURN_VALUE(
       ConfigImpl::create(static_cast<const envoy::config::route::v3::RouteConfiguration&>(rc),
                          factory_context, validator_, validate_clusters_default),

source/common/router/route_config_update_receiver_impl.h

@@ -66,7 +66,7 @@ class RouteConfigUpdateReceiverImpl : public RouteConfigUpdateReceiver {
     return resource_ids_in_last_update_;
   }
   const envoy::config::route::v3::RouteConfiguration& protobufConfigurationCast() const override {
-    ASSERT(dynamic_cast<const envoy::config::route::v3::RouteConfiguration*>(
+    ASSERT(Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::RouteConfiguration>(
         &RouteConfigUpdateReceiverImpl::protobufConfiguration()));
     return static_cast<const envoy::config::route::v3::RouteConfiguration&>(
         RouteConfigUpdateReceiverImpl::protobufConfiguration());

source/common/router/scoped_rds.cc

@@ -276,7 +276,7 @@ absl::StatusOr<bool> ScopedRdsConfigSubscription::addOrUpdateScopes(
   for (const auto& resource : resources) {
     // Explicit copy so that we can std::move later.
     envoy::config::route::v3::ScopedRouteConfiguration scoped_route_config =
-        dynamic_cast<const envoy::config::route::v3::ScopedRouteConfiguration&>(
+        Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::ScopedRouteConfiguration>(
             resource.get().resource());
     const std::string scope_name = scoped_route_config.name();
     if (const auto& scope_info_iter = scoped_route_map_.find(scope_name);
@@ -510,7 +510,7 @@ ScopedRdsConfigSubscription::detectUpdateConflictAndCleanupRemoved(
   }
   for (const auto& resource : resources) {
     const auto& scoped_route =
-        dynamic_cast<const envoy::config::route::v3::ScopedRouteConfiguration&>(
+        Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::ScopedRouteConfiguration>(
             resource.get().resource());
     updated_or_removed_scopes.insert(scoped_route.name());
   }
@@ -526,7 +526,7 @@ ScopedRdsConfigSubscription::detectUpdateConflictAndCleanupRemoved(
   for (const auto& resource : resources) {
     // Throws (thus rejects all) on any error.
     const auto& scoped_route =
-        dynamic_cast<const envoy::config::route::v3::ScopedRouteConfiguration&>(
+        Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::ScopedRouteConfiguration>(
             resource.get().resource());
     const std::string& scope_name = scoped_route.name();
     auto scope_config_inserted = scoped_routes.try_emplace(scope_name, std::move(scoped_route));
@@ -657,8 +657,8 @@ ConfigProviderPtr ScopedRoutesConfigProviderManager::createXdsConfigProvider(
            &typed_optarg](const uint64_t manager_identifier,
                           ConfigProviderManagerImplBase& config_provider_manager)
               -> Envoy::Config::ConfigSubscriptionCommonBaseSharedPtr {
-            const auto& scoped_rds_config_source = dynamic_cast<
-                const envoy::extensions::filters::network::http_connection_manager::v3::ScopedRds&>(
+            const auto& scoped_rds_config_source = Envoy::Protobuf::DynamicCastMessage<
+                envoy::extensions::filters::network::http_connection_manager::v3::ScopedRds>(
                 config_source_proto);
             return std::make_shared<ScopedRdsConfigSubscription>(
                 scoped_rds_config_source, manager_identifier, typed_optarg.scoped_routes_name_,

source/common/router/vhds.cc

@@ -119,7 +119,8 @@ absl::Status VhdsSubscription::onConfigUpdate(
       continue;
     }
     added_vhosts.emplace_back(
-        dynamic_cast<const envoy::config::route::v3::VirtualHost&>(resource.get().resource()));
+        Envoy::Protobuf::DynamicCastMessage<envoy::config::route::v3::VirtualHost>(
+            resource.get().resource()));
   }
   if (config_update_info_->onVhdsUpdate(added_vhosts, std::move(added_resource_ids),
                                         removed_resources, version_info)) {

source/common/upstream/cds_api_helper.cc

@@ -41,7 +41,8 @@ CdsApiHelper::onConfigUpdate(const std::vector<Config::DecodedResourceRef>& adde
     absl::string_view cluster_name = EMPTY_STRING;
     TRY_ASSERT_MAIN_THREAD {
       const envoy::config::cluster::v3::Cluster& cluster =
-          dynamic_cast<const envoy::config::cluster::v3::Cluster&>(resource.get().resource());
+          Envoy::Protobuf::DynamicCastMessage<envoy::config::cluster::v3::Cluster>(
+              resource.get().resource());
       cluster_name = cluster.name();
       if (!cluster_names.insert(cluster.name()).second) {
         // NOTE: at this point, the first of these duplicates has already been successfully applied.