thrift: adding xDS RDS support for thrift proxy.

api/BUILD

@@ -244,6 +244,7 @@ proto_library(
         "//envoy/service/secret/v3:pkg",
         "//envoy/service/status/v3:pkg",
         "//envoy/service/tap/v3:pkg",
+        "//envoy/service/thrift_route/v3:pkg",
         "//envoy/service/trace/v3:pkg",
         "//envoy/type/http/v3:pkg",
         "//envoy/type/matcher/v3:pkg",

api/envoy/extensions/filters/network/thrift_proxy/v3/thrift_proxy.proto

@@ -2,11 +2,13 @@ syntax = "proto3";
 
 package envoy.extensions.filters.network.thrift_proxy.v3;
 
+import "envoy/config/core/v3/config_source.proto";
 import "envoy/extensions/filters/network/thrift_proxy/v3/route.proto";
 
 import "google/protobuf/any.proto";
 import "google/protobuf/wrappers.proto";
 
+import "udpa/annotations/migrate.proto";
 import "udpa/annotations/status.proto";
 import "udpa/annotations/versioning.proto";
 import "validate/validate.proto";
@@ -58,7 +60,7 @@ enum ProtocolType {
   TWITTER = 4;
 }
 
-// [#next-free-field: 8]
+// [#next-free-field: 9]
 message ThriftProxy {
   option (udpa.annotations.versioning).previous_message_type =
       "envoy.config.filter.network.thrift_proxy.v2alpha1.ThriftProxy";
@@ -75,7 +77,8 @@ message ThriftProxy {
   string stat_prefix = 1 [(validate.rules).string = {min_len: 1}];
 
   // The route table for the connection manager is static and is specified in this property.
-  RouteConfiguration route_config = 4;
+  RouteConfiguration route_config = 4
+      [(udpa.annotations.field_migrate).oneof_promotion = "route_specifier"];
 
   // A list of individual Thrift filters that make up the filter chain for requests made to the
   // Thrift proxy. Order matters as the filters are processed sequentially. For backwards
@@ -92,6 +95,9 @@ message ThriftProxy {
 
   // Optional maximum requests for a single downstream connection. If not specified, there is no limit.
   google.protobuf.UInt32Value max_requests_per_connection = 7;
+
+  // Use xDS to fetch the route configuration. If both route_config and rds defined, rds has priority.
+  Rds rds = 8 [(udpa.annotations.field_migrate).oneof_promotion = "route_specifier"];
 }
 
 // ThriftFilter configures a Thrift filter.
@@ -138,3 +144,9 @@ message ThriftProtocolOptions {
   // which is the default, causes the proxy to use the same protocol as the downstream connection.
   ProtocolType protocol = 2 [(validate.rules).enum = {defined_only: true}];
 }
+
+message Rds {
+  config.core.v3.ConfigSource config_source = 1 [(validate.rules).message = {required: true}];
+
+  string route_config_name = 2;
+}

api/envoy/service/thrift_route/v3/BUILD

@@ -0,0 +1,14 @@
+# DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py.
+
+load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package")
+
+licenses(["notice"])  # Apache 2
+
+api_proto_package(
+    has_services = True,
+    deps = [
+        "//envoy/annotations:pkg",
+        "//envoy/service/discovery/v3:pkg",
+        "@com_github_cncf_udpa//udpa/annotations:pkg",
+    ],
+)

api/envoy/service/thrift_route/v3/rds.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package envoy.service.thrift_route.v3;
+
+import "envoy/service/discovery/v3/discovery.proto";
+
+import "google/api/annotations.proto";
+
+import "envoy/annotations/resource.proto";
+import "udpa/annotations/status.proto";
+import "udpa/annotations/versioning.proto";
+
+option java_package = "io.envoyproxy.envoy.service.thrift_route.v3";
+option java_outer_classname = "RdsProto";
+option java_multiple_files = true;
+option java_generic_services = true;
+option (udpa.annotations.file_status).package_version_status = ACTIVE;
+
+// [#protodoc-title: THRIFT_RDS]
+
+// The resource_names field in DiscoveryRequest specifies a route configuration.
+// This allows an Envoy configuration with multiple Thrift listeners (and
+// associated Thrift proxy filters) to use different route
+// configurations. Each listener will bind its Thrift proxy filter to
+// a route table via this identifier.
+service RouteDiscoveryService {
+  option (envoy.annotations.resource).type =
+      "envoy.extensions.filters.network.thrift_proxy.v3.RouteConfiguration";
+
+  rpc StreamRoutes(stream discovery.v3.DiscoveryRequest)
+      returns (stream discovery.v3.DiscoveryResponse) {
+  }
+
+  rpc DeltaRoutes(stream discovery.v3.DeltaDiscoveryRequest)
+      returns (stream discovery.v3.DeltaDiscoveryResponse) {
+  }
+
+  rpc FetchRoutes(discovery.v3.DiscoveryRequest) returns (discovery.v3.DiscoveryResponse) {
+    option (google.api.http).post = "/v3/discovery:thrift_routes";
+    option (google.api.http).body = "*";
+  }
+}
+
+// [#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing
+// services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
+message RdsDummy {
+}

api/versioning/BUILD

@@ -196,6 +196,7 @@ proto_library(
         "//envoy/service/secret/v3:pkg",
         "//envoy/service/status/v3:pkg",
         "//envoy/service/tap/v3:pkg",
+        "//envoy/service/thrift_route/v3:pkg",
         "//envoy/service/trace/v3:pkg",
         "//envoy/type/http/v3:pkg",
         "//envoy/type/matcher/v3:pkg",

envoy/router/BUILD

@@ -19,6 +19,7 @@ envoy_cc_library(
     deps = [
         ":router_interface",
         "//envoy/http:filter_interface",
+        "//envoy/router:rds_template_interface",
         "@envoy_api//envoy/config/route/v3:pkg_cc_proto",
     ],
 )
@@ -129,3 +130,11 @@ envoy_cc_library(
         "//source/common/common:minimal_logger_lib",
     ],
 )
+
+envoy_cc_library(
+    name = "rds_template_interface",
+    hdrs = [
+        "rds/route_config_provider.h",
+        "rds/route_config_update_receiver.h",
+    ],
+)

envoy/router/rds.h

@@ -4,58 +4,15 @@
 
 #include "envoy/config/route/v3/route.pb.h"
 #include "envoy/http/filter.h"
+#include "envoy/router/rds/route_config_provider.h"
 #include "envoy/router/router.h"
 
 namespace Envoy {
 namespace Router {
 
-/**
- * A provider for constant route configurations.
- */
-class RouteConfigProvider {
+class RouteConfigProvider
+    : public Rds::RouteConfigProvider<envoy::config::route::v3::RouteConfiguration, Config> {
 public:
-  struct ConfigInfo {
-    // A reference to the currently loaded route configuration. Do not hold this reference beyond
-    // the caller of configInfo()'s scope.
-    const envoy::config::route::v3::RouteConfiguration& config_;
-
-    // The discovery version that supplied this route. This will be set to "" in the case of
-    // static clusters.
-    std::string version_;
-  };
-
-  virtual ~RouteConfigProvider() = default;
-
-  /**
-   * @return Router::ConfigConstSharedPtr a route configuration for use during a single request. The
-   * returned config may be different on a subsequent call, so a new config should be acquired for
-   * each request flow.
-   */
-  virtual Router::ConfigConstSharedPtr config() PURE;
-
-  /**
-   * @return the configuration information for the currently loaded route configuration. Note that
-   * if the provider has not yet performed an initial configuration load, no information will be
-   * returned.
-   */
-  virtual absl::optional<ConfigInfo> configInfo() const PURE;
-
-  /**
-   * @return the last time this RouteConfigProvider was updated. Used for config dumps.
-   */
-  virtual SystemTime lastUpdated() const PURE;
-
-  /**
-   * Callback used to notify RouteConfigProvider about configuration changes.
-   */
-  virtual void onConfigUpdate() PURE;
-
-  /**
-   * Validate if the route configuration can be applied to the context of the route config provider.
-   */
-  virtual void
-  validateConfig(const envoy::config::route::v3::RouteConfiguration& config) const PURE;
-
   /**
    * Callback used to request an update to the route configuration from the management server.
    * @param for_domain supplies the domain name that virtual hosts must match on

envoy/router/rds/route_config_provider.h

@@ -0,0 +1,68 @@
+#pragma once
+
+#include <memory>
+
+#include "envoy/common/time.h"
+
+#include "absl/types/optional.h"
+
+namespace Envoy {
+namespace Router {
+namespace Rds {
+
+/**
+ * A provider for constant route configurations.
+ */
+template <class RouteConfiguration, class Config> class RouteConfigProvider {
+public:
+  struct ConfigInfo {
+    // A reference to the currently loaded route configuration. Do not hold this reference beyond
+    // the caller of configInfo()'s scope.
+    const RouteConfiguration& config_;
+
+    // The discovery version that supplied this route. This will be set to "" in the case of
+    // static clusters.
+    std::string version_;
+  };
+
+  virtual ~RouteConfigProvider() = default;
+
+  /**
+   * @return Router::ConfigConstSharedPtr a route configuration for use during a single request. The
+   * returned config may be different on a subsequent call, so a new config should be acquired for
+   * each request flow.
+   */
+  virtual std::shared_ptr<const Config> config() PURE;
+
+  /**
+   * @return the configuration information for the currently loaded route configuration. Note that
+   * if the provider has not yet performed an initial configuration load, no information will be
+   * returned.
+   */
+  virtual absl::optional<ConfigInfo> configInfo() const PURE;
+
+  /**
+   * @return the last time this RouteConfigProvider was updated. Used for config dumps.
+   */
+  virtual SystemTime lastUpdated() const PURE;
+
+  /**
+   * Callback used to notify RouteConfigProvider about configuration changes.
+   */
+  virtual void onConfigUpdate() PURE;
+
+  /**
+   * Validate if the route configuration can be applied to the context of the route config provider.
+   */
+  virtual void validateConfig(const RouteConfiguration& config) const PURE;
+};
+
+template <class RouteConfiguration, class Config>
+using RouteConfigProviderPtr = std::unique_ptr<RouteConfigProvider<RouteConfiguration, Config>>;
+template <class RouteConfiguration, class Config>
+using RouteConfigProviderSharedPtr =
+    std::shared_ptr<RouteConfigProvider<RouteConfiguration, Config>>;
+
+} // namespace Rds
+} // namespace Router
+} // namespace Envoy

envoy/router/rds/route_config_update_receiver.h

@@ -0,0 +1,75 @@
+#pragma once
+
+#include <memory>
+
+#include "envoy/common/pure.h"
+#include "envoy/common/time.h"
+#include "envoy/router/rds/route_config_provider.h"
+
+#include "absl/types/optional.h"
+
+namespace Envoy {
+namespace Router {
+namespace Rds {
+
+/**
+ * A primitive that keeps track of updates to a RouteConfiguration.
+ */
+template <class RouteConfiguration, class Config> class RouteConfigUpdateReceiver {
+public:
+  virtual ~RouteConfigUpdateReceiver() = default;
+
+  /**
+   * Called on updates via RDS.
+   * @param rc supplies the RouteConfiguration.
+   * @param version_info supplies RouteConfiguration version.
+   * @return bool whether RouteConfiguration has been updated.
+   */
+  virtual bool onRdsUpdate(const RouteConfiguration& rc, const std::string& version_info) PURE;
+
+  /**
+   * @return std::string& the name of RouteConfiguration.
+   */
+  virtual const std::string& routeConfigName() const PURE;
+
+  /**
+   * @return std::string& the version of RouteConfiguration.
+   */
+  virtual const std::string& configVersion() const PURE;
+
+  /**
+   * @return uint64_t the hash value of RouteConfiguration.
+   */
+  virtual uint64_t configHash() const PURE;
+
+  /**
+   * @return absl::optional<RouteConfigProvider::ConfigInfo> containing an instance of
+   * RouteConfigProvider::ConfigInfo if RouteConfiguration has been updated at least once. Otherwise
+   * returns an empty absl::optional<RouteConfigProvider::ConfigInfo>.
+   */
+  virtual absl::optional<typename RouteConfigProvider<RouteConfiguration, Config>::ConfigInfo>
+  configInfo() const PURE;
+
+  /**
+   * @return envoy::config::route::v3::RouteConfiguration& current RouteConfiguration.
+   */
+  virtual const RouteConfiguration& protobufConfiguration() PURE;
+
+  /**
+   * @return Router::ConfigConstSharedPtr a parsed and validated copy of current RouteConfiguration.
+   * @see protobufConfiguration()
+   */
+  virtual std::shared_ptr<const Config> parsedConfiguration() const PURE;
+
+  /**
+   * @return SystemTime the time of the last update.
+   */
+  virtual SystemTime lastUpdated() const PURE;
+};
+
+template <class RouteConfiguration, class Config>
+using RouteConfigUpdatePtr = std::unique_ptr<RouteConfigUpdateReceiver<RouteConfiguration, Config>>;
+
+} // namespace Rds
+} // namespace Router
+} // namespace Envoy