Added absl::optional dependency to replace current optional implement…

…ation of envoy (#2688)

Fixes #2651.

Risk Level: Low

Signed-off-by: sri kailash <sri.gandebathula@booking.com>

bazel/repositories.bzl

@@ -324,6 +324,10 @@ def _com_google_absl():
         name = "abseil_int128",
         actual = "@com_google_absl//absl/numeric:int128",
     )
+    native.bind(
+        name = "abseil_optional",
+        actual = "@com_google_absl//absl/types:optional",
+    )
 
 def _com_google_protobuf():
     _repository_impl("com_google_protobuf")

include/envoy/common/BUILD

@@ -28,11 +28,6 @@ envoy_cc_library(
     hdrs = ["interval_set.h"],
 )
 
-envoy_cc_library(
-    name = "optional",
-    hdrs = ["optional.h"],
-)
-
 envoy_cc_library(
     name = "callback",
     hdrs = ["callback.h"],

include/envoy/grpc/BUILD

@@ -11,9 +11,9 @@ envoy_package()
 envoy_cc_library(
     name = "async_client_interface",
     hdrs = ["async_client.h"],
+    external_deps = ["abseil_optional"],
     deps = [
         ":status",
-        "//include/envoy/common:optional",
         "//include/envoy/http:header_map_interface",
         "//include/envoy/tracing:http_tracer_interface",
         "//source/common/protobuf",

include/envoy/grpc/async_client.h

@@ -2,14 +2,15 @@
 
 #include <chrono>
 
-#include "envoy/common/optional.h"
 #include "envoy/common/pure.h"
 #include "envoy/grpc/status.h"
 #include "envoy/http/header_map.h"
 #include "envoy/tracing/http_tracer.h"
 
 #include "common/protobuf/protobuf.h"
 
+#include "absl/types/optional.h"
+
 namespace Envoy {
 namespace Grpc {
 
@@ -194,7 +195,7 @@ class AsyncClient {
   virtual AsyncRequest* send(const Protobuf::MethodDescriptor& service_method,
                              const Protobuf::Message& request, AsyncRequestCallbacks& callbacks,
                              Tracing::Span& parent_span,
-                             const Optional<std::chrono::milliseconds>& timeout) PURE;
+                             const absl::optional<std::chrono::milliseconds>& timeout) PURE;
 
   /**
    * Start a gRPC stream asynchronously.

include/envoy/http/BUILD

@@ -11,9 +11,9 @@ envoy_package()
 envoy_cc_library(
     name = "async_client_interface",
     hdrs = ["async_client.h"],
+    external_deps = ["abseil_optional"],
     deps = [
         ":message_interface",
-        "//include/envoy/common:optional",
         "//include/envoy/event:dispatcher_interface",
     ],
 )

include/envoy/http/async_client.h

@@ -3,10 +3,11 @@
 #include <chrono>
 #include <memory>
 
-#include "envoy/common/optional.h"
 #include "envoy/event/dispatcher.h"
 #include "envoy/http/message.h"
 
+#include "absl/types/optional.h"
+
 namespace Envoy {
 namespace Http {
 
@@ -140,7 +141,7 @@ class AsyncClient {
    *         handle should just be used to cancel.
    */
   virtual Request* send(MessagePtr&& request, Callbacks& callbacks,
-                        const Optional<std::chrono::milliseconds>& timeout) PURE;
+                        const absl::optional<std::chrono::milliseconds>& timeout) PURE;
 
   /**
    * Start an HTTP stream asynchronously.
@@ -156,7 +157,7 @@ class AsyncClient {
    *         the handle can be used to send more messages or close the stream.
    */
   virtual Stream* start(StreamCallbacks& callbacks,
-                        const Optional<std::chrono::milliseconds>& timeout,
+                        const absl::optional<std::chrono::milliseconds>& timeout,
                         bool buffer_body_for_retry) PURE;
 
   /**

include/envoy/ratelimit/BUILD

@@ -11,8 +11,8 @@ envoy_package()
 envoy_cc_library(
     name = "ratelimit_interface",
     hdrs = ["ratelimit.h"],
+    external_deps = ["abseil_optional"],
     deps = [
-        "//include/envoy/common:optional",
         "//include/envoy/tracing:http_tracer_interface",
     ],
 )

include/envoy/ratelimit/ratelimit.h

@@ -5,10 +5,11 @@
 #include <string>
 #include <vector>
 
-#include "envoy/common/optional.h"
 #include "envoy/common/pure.h"
 #include "envoy/tracing/http_tracer.h"
 
+#include "absl/types/optional.h"
+
 namespace Envoy {
 namespace RateLimit {
 
@@ -92,7 +93,7 @@ class ClientFactory {
   /**
    * Return a new rate limit client.
    */
-  virtual ClientPtr create(const Optional<std::chrono::milliseconds>& timeout) PURE;
+  virtual ClientPtr create(const absl::optional<std::chrono::milliseconds>& timeout) PURE;
 };
 
 typedef std::unique_ptr<ClientFactory> ClientFactoryPtr;

include/envoy/request_info/BUILD

@@ -11,8 +11,8 @@ envoy_package()
 envoy_cc_library(
     name = "request_info_interface",
     hdrs = ["request_info.h"],
+    external_deps = ["abseil_optional"],
     deps = [
-        "//include/envoy/common:optional",
         "//include/envoy/common:time_interface",
         "//include/envoy/http:protocol_interface",
         "//include/envoy/upstream:upstream_interface",

include/envoy/request_info/request_info.h

@@ -4,12 +4,13 @@
 #include <cstdint>
 #include <string>
 
-#include "envoy/common/optional.h"
 #include "envoy/common/pure.h"
 #include "envoy/common/time.h"
 #include "envoy/http/protocol.h"
 #include "envoy/upstream/upstream.h"
 
+#include "absl/types/optional.h"
+
 namespace Envoy {
 
 namespace Router {
@@ -75,7 +76,7 @@ class RequestInfo {
   /**
    * @return the protocol of the request.
    */
-  virtual Optional<Http::Protocol> protocol() const PURE;
+  virtual absl::optional<Http::Protocol> protocol() const PURE;
 
   /**
    * @param protocol the request's protocol.
@@ -85,7 +86,7 @@ class RequestInfo {
   /**
    * @return the response code.
    */
-  virtual Optional<uint32_t> responseCode() const PURE;
+  virtual absl::optional<uint32_t> responseCode() const PURE;
 
   /**
    * @return the time that the first byte of the request was received.
@@ -102,7 +103,7 @@ class RequestInfo {
    * @return the duration between the last byte of the request was received and the start of the
    * request.
    */
-  virtual Optional<std::chrono::nanoseconds> lastDownstreamRxByteReceived() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> lastDownstreamRxByteReceived() const PURE;
 
   /**
    * Sets the time when the last byte of the request was received.
@@ -114,7 +115,7 @@ class RequestInfo {
    * the request. There may be a considerable delta between lastDownstreamByteReceived and this
    * value due to filters.
    */
-  virtual Optional<std::chrono::nanoseconds> firstUpstreamTxByteSent() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> firstUpstreamTxByteSent() const PURE;
 
   /**
    * Sets the time when the first byte of the request was sent upstream.
@@ -125,7 +126,7 @@ class RequestInfo {
    * @return the duration between the last bye of the request was sent upstream and the start of the
    * request.
    */
-  virtual Optional<std::chrono::nanoseconds> lastUpstreamTxByteSent() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> lastUpstreamTxByteSent() const PURE;
 
   /**
    * Sets the time when the last bye of the request was sent upstream.
@@ -136,7 +137,7 @@ class RequestInfo {
    * @return the duration between the first byte of the response is received from upstream and the
    * start of the request.
    */
-  virtual Optional<std::chrono::nanoseconds> firstUpstreamRxByteReceived() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> firstUpstreamRxByteReceived() const PURE;
 
   /**
    * Sets the time when the first byte of the response is received from
@@ -148,7 +149,7 @@ class RequestInfo {
    * @return the duration between the last byte of the response is received from upstream and the
    * start of the request.
    */
-  virtual Optional<std::chrono::nanoseconds> lastUpstreamRxByteReceived() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> lastUpstreamRxByteReceived() const PURE;
 
   /**
    * Sets the time when the last byte of the response is received from
@@ -161,7 +162,7 @@ class RequestInfo {
    * the request. There may be a considerable delta between lastUpstreamByteReceived and this value
    * due to filters.
    */
-  virtual Optional<std::chrono::nanoseconds> firstDownstreamTxByteSent() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> firstDownstreamTxByteSent() const PURE;
 
   /**
    * Sets the time when the first byte of the response is sent downstream.
@@ -172,7 +173,7 @@ class RequestInfo {
    * @return the duration between the last byte of the response is sent downstream and the start of
    * the request.
    */
-  virtual Optional<std::chrono::nanoseconds> lastDownstreamTxByteSent() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> lastDownstreamTxByteSent() const PURE;
 
   /**
    * Sets the time when the last byte of the response is sent downstream.
@@ -183,7 +184,7 @@ class RequestInfo {
    * @return the total duration of the request (i.e., when the request's ActiveStream is destroyed)
    * and may be longer than lastDownstreamTxByteSent.
    */
-  virtual Optional<std::chrono::nanoseconds> requestComplete() const PURE;
+  virtual absl::optional<std::chrono::nanoseconds> requestComplete() const PURE;
 
   /**
    * Sets the end time for the request. This method is called once the request has been fully

include/envoy/router/BUILD

@@ -34,9 +34,9 @@ envoy_cc_library(
 envoy_cc_library(
     name = "router_interface",
     hdrs = ["router.h"],
+    external_deps = ["abseil_optional"],
     deps = [
         "//include/envoy/access_log:access_log_interface",
-        "//include/envoy/common:optional",
         "//include/envoy/http:codec_interface",
         "//include/envoy/http:codes_interface",
         "//include/envoy/http:header_map_interface",

include/envoy/router/router.h

@@ -10,7 +10,6 @@
 
 #include "envoy/access_log/access_log.h"
 #include "envoy/api/v2/core/base.pb.h"
-#include "envoy/common/optional.h"
 #include "envoy/http/codec.h"
 #include "envoy/http/codes.h"
 #include "envoy/http/header_map.h"
@@ -20,6 +19,8 @@
 #include "common/protobuf/protobuf.h"
 #include "common/protobuf/utility.h"
 
+#include "absl/types/optional.h"
+
 namespace Envoy {
 namespace Router {
 
@@ -111,9 +112,9 @@ class CorsPolicy {
   virtual const std::string& maxAge() const PURE;
 
   /**
-   * @return const Optional<bool>& Whether access-control-allow-credentials should be true.
+   * @return const absl::optional<bool>& Whether access-control-allow-credentials should be true.
    */
-  virtual const Optional<bool>& allowCredentials() const PURE;
+  virtual const absl::optional<bool>& allowCredentials() const PURE;
 
   /**
    * @return bool Whether CORS is enabled for the route or virtual host.
@@ -186,7 +187,7 @@ class RetryState {
    *         called. Calling code should proceed with error handling.
    */
   virtual RetryStatus shouldRetry(const Http::HeaderMap* response_headers,
-                                  const Optional<Http::StreamResetReason>& reset_reason,
+                                  const absl::optional<Http::StreamResetReason>& reset_reason,
                                   DoRetryCallback callback) PURE;
 };
 
@@ -282,12 +283,12 @@ class HashPolicy {
    * @param headers stores the HTTP headers for the stream
    * @param add_cookie is called to add a set-cookie header on the reply sent to the downstream
    * host
-   * @return Optional<uint64_t> an optional hash value to route on. A hash value might not be
+   * @return absl::optional<uint64_t> an optional hash value to route on. A hash value might not be
    * returned if for example the specified HTTP header does not exist.
    */
-  virtual Optional<uint64_t> generateHash(const std::string& downstream_address,
-                                          const Http::HeaderMap& headers,
-                                          AddCookieCallback add_cookie) const PURE;
+  virtual absl::optional<uint64_t> generateHash(const std::string& downstream_address,
+                                                const Http::HeaderMap& headers,
+                                                AddCookieCallback add_cookie) const PURE;
 };
 
 class MetadataMatchCriterion {