envoyproxy · toddmgreer · May 16, 2019 · Jun 6, 2019 · Jun 7, 2019 · Jun 7, 2019
diff --git a/api/docs/BUILD b/api/docs/BUILD
@@ -38,6 +38,7 @@ proto_library(
         "//envoy/config/filter/accesslog/v2:accesslog",
         "//envoy/config/filter/dubbo/router/v2alpha1:router",
         "//envoy/config/filter/http/buffer/v2:buffer",
+        "//envoy/config/filter/http/cache/v2alpha:cache",
         "//envoy/config/filter/http/csrf/v2:csrf",
         "//envoy/config/filter/http/ext_authz/v2:ext_authz",
         "//envoy/config/filter/http/fault/v2:fault",

diff --git a/api/envoy/config/filter/http/cache/v2alpha/BUILD b/api/envoy/config/filter/http/cache/v2alpha/BUILD
@@ -0,0 +1,8 @@
+load("@envoy_api//bazel:api_build_system.bzl", "api_proto_library_internal")
+
+licenses(["notice"])  # Apache 2
+
+api_proto_library_internal(
+    name = "cache",
+    srcs = ["cache.proto"],
+)
diff --git a/api/envoy/config/filter/http/cache/v2alpha/cache.proto b/api/envoy/config/filter/http/cache/v2alpha/cache.proto
@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package envoy.config.filter.http.cache.v2alpha;
+
+option java_package = "io.envoyproxy.envoy.config.filter.http.cache.v2alpha";
+option java_outer_classname = "CacheProto";
+option java_multiple_files = true;
+// [#protodoc-title: HTTP Cache Filter]
+// `Design<https://docs.google.com/document/d/1WPuim_GzhfdsnIj_tf-fIeutK0jO4aVQfVrLJFoLN3g/view>`_
+// [#proto-status: experimental]
+
+message Cache {
+
+  // Name of cache implementation to use.
+  string name = 1;
+
+  // List of allowed Vary headers. These headers will be provided to caches in lookups, and the
+  // cache filter will only insert responses whose Vary headers (if any) are all in this list. For
+  // example, if an origin supplies "vary:user-agent" in a response, the response will only be
+  // inserted if "user-agent" is in this list.
+  repeated string allowed_vary_headers = 2;
+
+  message KeyCreatorParams {
+    // If true, exclude the URL scheme from the cache key.
+    bool exclude_scheme = 1;
+
+    // If true, exclude the host from the cache key.
+    bool exclude_host = 2;
+
+    // If true, treat query_string_keys as a whitelist.
+    // If false, treat query_string_keys as a blacklist.
+    bool query_string_keys_whitelist = 3;
+
+    // The list of query string keys, to be treated as a whitelist/blacklist
+    // depending on the value of query_string_keys_whitelist.
+    // If your origins ignore all but a few query params, list them here and set
+    // query_string_keys_whitelist to true.
+    // If your origins only pay attention to a few params, list them here and
+    // leave query_string_keys_whitelist as false.
+    // If your origins ignore the query string entirely, leave this empty and
+    // set query_string_keys_whitelist to true.
+    // If you don't know what query params your origins may pay attention to,
+    // leave both query_string fields at their false/empty defaults.
+    repeated string query_string_keys = 4;
+  }
+  KeyCreatorParams key_creator_params = 3;
+}
diff --git a/docs/build.sh b/docs/build.sh
@@ -100,6 +100,7 @@ PROTO_RST="
   /envoy/config/filter/http/health_check/v2/health_check/envoy/config/filter/http/health_check/v2/health_check.proto.rst
   /envoy/config/filter/http/header_to_metadata/v2/header_to_metadata/envoy/config/filter/http/header_to_metadata/v2/header_to_metadata.proto.rst
   /envoy/config/filter/http/ip_tagging/v2/ip_tagging/envoy/config/filter/http/ip_tagging/v2/ip_tagging.proto.rst
+  /envoy/config/filter/http/cache/v2alpha/cache/envoy/config/filter/http/cache/v2alpha/cache.proto.rst
   /envoy/config/filter/http/jwt_authn/v2alpha/jwt_authn/envoy/config/filter/http/jwt_authn/v2alpha/config.proto.rst
   /envoy/config/filter/http/lua/v2/lua/envoy/config/filter/http/lua/v2/lua.proto.rst
   /envoy/config/filter/http/original_src/v2alpha1/original_src/envoy/config/filter/http/original_src/v2alpha1/original_src.proto.rst

diff --git a/include/envoy/http/header_map.h b/include/envoy/http/header_map.h
@@ -273,6 +273,7 @@ class HeaderEntry {
   HEADER_FUNC(AccessControlAllowCredentials)                                                       \
   HEADER_FUNC(AccessControlExposeHeaders)                                                          \
   HEADER_FUNC(AccessControlMaxAge)                                                                 \
+  HEADER_FUNC(Age)                                                                                 \
   HEADER_FUNC(Authorization)                                                                       \
   HEADER_FUNC(CacheControl)                                                                        \
   HEADER_FUNC(ClientTraceId)                                                                       \
@@ -310,6 +311,7 @@ class HeaderEntry {
   HEADER_FUNC(EnvoyUpstreamServiceTime)                                                            \
   HEADER_FUNC(Etag)                                                                                \
   HEADER_FUNC(Expect)                                                                              \
+  HEADER_FUNC(Expires)                                                                             \
   HEADER_FUNC(ForwardedClientCert)                                                                 \
   HEADER_FUNC(ForwardedFor)                                                                        \
   HEADER_FUNC(ForwardedProto)                                                                      \

diff --git a/source/common/http/headers.h b/source/common/http/headers.h
@@ -24,6 +24,7 @@ class HeaderValues {
   const LowerCaseString AccessControlExposeHeaders{"access-control-expose-headers"};
   const LowerCaseString AccessControlMaxAge{"access-control-max-age"};
   const LowerCaseString AccessControlAllowCredentials{"access-control-allow-credentials"};
+  const LowerCaseString Age{"age"};
   const LowerCaseString Authorization{"authorization"};
   const LowerCaseString ProxyAuthenticate{"proxy-authenticate"};
   const LowerCaseString ProxyAuthorization{"proxy-authorization"};
@@ -72,6 +73,7 @@ class HeaderValues {
   const LowerCaseString EnvoyDecoratorOperation{"x-envoy-decorator-operation"};
   const LowerCaseString Etag{"etag"};
   const LowerCaseString Expect{"expect"};
+  const LowerCaseString Expires{"expires"};
   const LowerCaseString ForwardedClientCert{"x-forwarded-client-cert"};
   const LowerCaseString ForwardedFor{"x-forwarded-for"};
   const LowerCaseString ForwardedHost{"x-forwarded-host"};

diff --git a/source/extensions/extensions_build_config.bzl b/source/extensions/extensions_build_config.bzl
@@ -29,6 +29,7 @@ EXTENSIONS = {
     #
 
     "envoy.filters.http.buffer":                        "//source/extensions/filters/http/buffer:config",
+    "envoy.filters.http.cache":                         "//source/extensions/filters/http/cache:config",
     "envoy.filters.http.cors":                          "//source/extensions/filters/http/cors:config",
     "envoy.filters.http.csrf":                          "//source/extensions/filters/http/csrf:config",
     "envoy.filters.http.dynamo":                        "//source/extensions/filters/http/dynamo:config",

diff --git a/source/extensions/filters/http/cache/BUILD b/source/extensions/filters/http/cache/BUILD
@@ -0,0 +1,95 @@
+licenses(["notice"])  # Apache 2
+
+## Pluggable HTTP cache filter
+
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+    "envoy_proto_library",
+)
+
+envoy_package()
+
+envoy_cc_library(
+    name = "cache_filter_lib",
+    srcs = ["cache_filter.cc"],
+    hdrs = ["cache_filter.h"],
+    deps = [
+        ":http_cache_lib",
+        "//include/envoy/registry",
+        "//source/common/common:macros",
+        "//source/common/http:header_map_lib",
+        "//source/common/http:headers_lib",
+        "//source/common/protobuf",
+        "//source/extensions/filters/http/common:pass_through_filter_lib",
+        "@envoy_api//envoy/config/filter/http/cache/v2alpha:cache_cc",
+    ],
+)
+
+envoy_cc_library(
+    name = "config",
+    srcs = ["config.cc"],
+    hdrs = ["config.h"],
+    deps = [
+        ":cache_filter_lib",
+        ":key_cc",
+        "//include/envoy/common:time_interface",
+        "//include/envoy/registry",
+        "//include/envoy/stats:stats_interface",
+        "//source/extensions/filters/http/common:factory_base_lib",
+    ],
+)
+
+envoy_proto_library(
+    name = "key",
+    srcs = ["key.proto"],
+)
+
+envoy_cc_library(
+    name = "http_cache_lib",
+    srcs = ["http_cache.cc"],
+    hdrs = ["http_cache.h"],
+    deps = [
+        ":http_cache_utils_lib",
+        ":key_cc",
+        "//include/envoy/buffer:buffer_interface",
+        "//include/envoy/common:time_interface",
+        "//include/envoy/http:header_map_interface",
+        "//source/common/common:assert_lib",
+        "//source/common/http:headers_lib",
+        "//source/common/protobuf:utility_lib",
+    ],
+)
+
+envoy_cc_library(
+    name = "http_cache_utils_lib",
+    srcs = ["http_cache_utils.cc"],
+    hdrs = ["http_cache_utils.h"],
+    deps = [
+        "//include/envoy/http:header_map_interface",
+        "@com_google_absl//absl/algorithm:container",
+        "@com_google_absl//absl/strings",
+        "@com_google_absl//absl/time",
+    ],
+)
+
+envoy_cc_library(
+    name = "simple_http_cache_lib",
+    srcs = ["simple_http_cache.cc"],
+    hdrs = ["simple_http_cache.h"],
+    deps = [
+        ":http_cache_lib",
+        "//include/envoy/registry",
+        "//include/envoy/runtime:runtime_interface",
+        "//source/common/buffer:buffer_lib",
+        "//source/common/common:macros",
+        "//source/common/common:thread_lib",
+        "//source/common/http:header_map_lib",
+        "//source/common/http:headers_lib",
+        "//source/common/protobuf",
+        "//source/extensions/filters/http/common:pass_through_filter_lib",
+        "@com_google_absl//absl/base:core_headers",
+        "@envoy_api//envoy/config/filter/http/cache/v2alpha:cache_cc",
+    ],
+)