thrift: adding xDS RDS support for thrift proxy.

api/BUILD

@@ -247,6 +247,7 @@ proto_library(
         "//envoy/service/secret/v3:pkg",
         "//envoy/service/status/v3:pkg",
         "//envoy/service/tap/v3:pkg",
+        "//envoy/service/thrift/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,16 @@ enum ProtocolType {
   TWITTER = 4;
 }
 
-// [#next-free-field: 8]
+message Trds {
+  // Configuration source specifier.
+  config.core.v3.ConfigSource config_source = 1 [(validate.rules).message = {required: true}];
+
+  // The name of the route configuration. This allows to use different route
+  // configurations. Tells which route configuration should be fetched from the configuration source.
+  string route_config_name = 2;
+}
+
+// [#next-free-field: 9]
 message ThriftProxy {
   option (udpa.annotations.versioning).previous_message_type =
       "envoy.config.filter.network.thrift_proxy.v2alpha1.ThriftProxy";
@@ -75,7 +86,9 @@ 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;
+  // If trds is also defined this field is ignored.
+  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 +105,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 trds defined, trds has priority.
+  Trds trds = 8 [(udpa.annotations.field_migrate).oneof_promotion = "route_specifier"];
 }
 
 // ThriftFilter configures a Thrift filter.

api/envoy/service/thrift/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/v3/trds.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package envoy.service.thrift.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.v3";
+option java_outer_classname = "TrdsProto";
+option java_multiple_files = true;
+option java_generic_services = true;
+option (udpa.annotations.file_status).package_version_status = ACTIVE;
+
+// [#protodoc-title: TRDS]
+
+// 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 ThriftRouteDiscoveryService {
+  option (envoy.annotations.resource).type =
+      "envoy.extensions.filters.network.thrift_proxy.v3.RouteConfiguration";
+
+  rpc StreamThriftRoutes(stream discovery.v3.DiscoveryRequest)
+      returns (stream discovery.v3.DiscoveryResponse) {
+  }
+
+  rpc DeltaThriftRoutes(stream discovery.v3.DeltaDiscoveryRequest)
+      returns (stream discovery.v3.DeltaDiscoveryResponse) {
+  }
+
+  rpc FetchThriftRoutes(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 TrdsDummy {
+}

api/versioning/BUILD

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

envoy/rds/BUILD

@@ -0,0 +1,19 @@
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+)
+
+licenses(["notice"])  # Apache 2
+
+envoy_package()
+
+envoy_cc_library(
+    name = "rds_interface",
+    hdrs = [
+        "config.h",
+        "config_traits.h",
+        "route_config_provider.h",
+        "route_config_update_receiver.h",
+    ],
+)

envoy/rds/config.h

@@ -0,0 +1,19 @@
+#pragma once
+
+#include <memory>
+
+namespace Envoy {
+namespace Rds {
+
+/**
+ * Base class for router configuration classes used with Rds.
+ */
+class Config {
+public:
+  virtual ~Config() = default;
+};
+
+using ConfigConstSharedPtr = std::shared_ptr<const Config>;
+
+} // namespace Rds
+} // namespace Envoy

envoy/rds/config_traits.h

@@ -0,0 +1,72 @@
+#pragma once
+
+#include <memory>
+
+#include "envoy/common/pure.h"
+#include "envoy/rds/config.h"
+
+#include "source/common/protobuf/protobuf.h"
+
+namespace Envoy {
+namespace Rds {
+
+/**
+ * Traits of the protocol specific route configuration and proto.
+ * The generic rds classes will call the methods of this interface
+ * to get information which are not visible for them directly.
+ */
+class ConfigTraits {
+public:
+  virtual ~ConfigTraits() = default;
+
+  /**
+   * Give the full name of the route configuration proto description.
+   * For example 'envoy.config.route.v3.RouteConfiguration'
+   */
+  virtual std::string resourceType() const PURE;
+
+  /**
+   * Create a dummy config object without actual route configuration.
+   * This object will be used before the first valid route configuration is fetched.
+   */
+  virtual ConfigConstSharedPtr createConfig() const PURE;
+
+  /**
+   * Create an empty route configuration proto object.
+   */
+  virtual ProtobufTypes::MessagePtr createProto() const PURE;
+
+  /**
+   * Runtime check if the provided proto message object is really a route configuration instance.
+   * Throw an std::bad_cast exception if not.
+   * Every other method below this assumes the proto message is already
+   * validated and and doesn't do any further runtime check.
+   */
+  virtual const Protobuf::Message& validateResourceType(const Protobuf::Message& rc) const PURE;
+
+  /**
+   * Check if a valid config object can be made based on the provided route configuration proto.
+   * Throw an exception if not.
+   */
+  virtual const Protobuf::Message& validateConfig(const Protobuf::Message& rc) const PURE;
+
+  /**
+   * Gives back the value of the name field  Check if a valid config object can be made
+   * based on the provided route configuration proto.
+   * The object behind the returned reference has to have the same lifetime like the proto.
+   */
+  virtual const std::string& resourceName(const Protobuf::Message& rc) const PURE;
+
+  /**
+   * Create a config object based on a route configuration.
+   */
+  virtual ConfigConstSharedPtr createConfig(const Protobuf::Message& rc) const PURE;
+
+  /**
+   * Clones the route configuration proto.
+   */
+  virtual ProtobufTypes::MessagePtr cloneProto(const Protobuf::Message& rc) const PURE;
+};
+
+} // namespace Rds
+} // namespace Envoy

envoy/rds/route_config_provider.h

@@ -0,0 +1,63 @@
+#pragma once
+
+#include <memory>
+
+#include "envoy/common/time.h"
+#include "envoy/rds/config.h"
+
+#include "source/common/protobuf/protobuf.h"
+
+#include "absl/types/optional.h"
+
+namespace Envoy {
+namespace Rds {
+
+/**
+ * A provider for constant route configurations.
+ */
+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 Protobuf::Message& config_;
+
+    const std::string& name_;
+
+    // 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 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 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;
+};
+
+using RouteConfigProviderPtr = std::unique_ptr<RouteConfigProvider>;
+using RouteConfigProviderSharedPtr = std::shared_ptr<RouteConfigProvider>;
+
+} // namespace Rds
+} // namespace Envoy

envoy/rds/route_config_update_receiver.h

@@ -0,0 +1,74 @@
+#pragma once
+
+#include <memory>
+
+#include "envoy/common/pure.h"
+#include "envoy/common/time.h"
+#include "envoy/rds/config_traits.h"
+#include "envoy/rds/route_config_provider.h"
+
+#include "absl/types/optional.h"
+
+namespace Envoy {
+namespace Rds {
+
+/**
+ * A primitive that keeps track of updates to a RouteConfiguration.
+ */
+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 Protobuf::Message& 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<RouteConfigProvider::ConfigInfo> configInfo() const PURE;
+
+  /**
+   * @return envoy::config::route::v3::RouteConfiguration& current RouteConfiguration.
+   */
+  virtual const Protobuf::Message& protobufConfiguration() PURE;
+
+  /**
+   * @return ConfigConstSharedPtr a parsed and validated copy of current RouteConfiguration.
+   * @see protobufConfiguration()
+   */
+  virtual ConfigConstSharedPtr parsedConfiguration() const PURE;
+
+  /**
+   * @return SystemTime the time of the last update.
+   */
+  virtual SystemTime lastUpdated() const PURE;
+
+  virtual const ConfigTraits& configTraits() const PURE;
+};
+
+using RouteConfigUpdatePtr = std::unique_ptr<RouteConfigUpdateReceiver>;
+
+} // namespace Rds
+} // namespace Envoy

envoy/router/BUILD

@@ -19,6 +19,7 @@ envoy_cc_library(
     deps = [
         ":router_interface",
         "//envoy/http:filter_interface",
+        "//envoy/rds:rds_interface",
         "@envoy_api//envoy/config/route/v3:pkg_cc_proto",
     ],
 )
@@ -70,6 +71,7 @@ envoy_cc_library(
         "//envoy/http:conn_pool_interface",
         "//envoy/http:hash_policy_interface",
         "//envoy/http:header_map_interface",
+        "//envoy/rds:rds_interface",
         "//envoy/tcp:conn_pool_interface",
         "//envoy/tracing:http_tracer_interface",
         "//envoy/upstream:resource_manager_interface",