Added quota contoll without the service control client library (#93)

* Added quota contoll without the service control client library * Applied code review * Applied code review * Resolve conflicts * Resolve conflicts * Fixed format error reported by script/check-style * Fixed a bug at Aggregated::GetAuthToken that causes Segmentation Fault * Changed usage of template funcion * Applied latest changes from the repo * Applied latest changes from the repo * Applied latest changes from the repo * Adde comments * Updated log information * Applied #101 * Changed metric_cost_map to metric_cost_vector * Fixed test case compilation error * Fixed test case compilation error
istio · Feb 17, 2017 · c5b9b81 · c5b9b81
1 parent 577dbd7
commit c5b9b81
Show file tree

Hide file tree

Showing 20 changed files with 511 additions and 41 deletions.
diff --git a/contrib/endpoints/include/api_manager/method.h b/contrib/endpoints/include/api_manager/method.h
@@ -89,6 +89,10 @@ class MethodInfo {
 
   // Get the names of url system parameters
   virtual const std::set<std::string> &system_query_parameter_names() const = 0;
+
+  // Get quota metric cost vector
+  virtual const std::vector<std::pair<std::string, int>> &metric_cost_vector()
+      const = 0;
 };
 
 }  // namespace api_manager

diff --git a/contrib/endpoints/src/api_manager/BUILD b/contrib/endpoints/src/api_manager/BUILD
@@ -81,6 +81,8 @@ cc_library(
         "method_impl.cc",
         "path_matcher.cc",
         "path_matcher_node.cc",
+        "quota_control.cc",
+        "quota_control.h",
         "request_handler.cc",
     ],
     linkopts = select({

diff --git a/contrib/endpoints/src/api_manager/auth/service_account_token.h b/contrib/endpoints/src/api_manager/auth/service_account_token.h
@@ -64,6 +64,7 @@ class ServiceAccountToken {
   enum JWT_TOKEN_TYPE {
     JWT_TOKEN_FOR_SERVICE_CONTROL = 0,
     JWT_TOKEN_FOR_CLOUD_TRACING,
+    JWT_TOKEN_FOR_QUOTA_CONTROL,
     JWT_TOKEN_TYPE_MAX,
   };
   // Set audience.  Only calcualtes JWT token with specified audience.

diff --git a/contrib/endpoints/src/api_manager/check_workflow.cc b/contrib/endpoints/src/api_manager/check_workflow.cc
@@ -18,6 +18,7 @@
 #include "contrib/endpoints/src/api_manager/check_auth.h"
 #include "contrib/endpoints/src/api_manager/check_service_control.h"
 #include "contrib/endpoints/src/api_manager/fetch_metadata.h"
+#include "contrib/endpoints/src/api_manager/quota_control.h"
 
 using ::google::api_manager::utils::Status;
 
@@ -33,6 +34,8 @@ void CheckWorkflow::RegisterAll() {
   Register(CheckAuth);
   // Checks service control.
   Register(CheckServiceControl);
+  // Quota control
+  Register(QuotaControl);
 }
 
 void CheckWorkflow::Register(CheckHandler handler) {

diff --git a/contrib/endpoints/src/api_manager/config.h b/contrib/endpoints/src/api_manager/config.h
@@ -25,6 +25,7 @@
 #include "contrib/endpoints/src/api_manager/method_impl.h"
 #include "contrib/endpoints/src/api_manager/path_matcher.h"
 #include "contrib/endpoints/src/api_manager/proto/server_config.pb.h"
+#include "google/api/quota.pb.h"
 #include "google/api/service.pb.h"
 
 namespace google {

diff --git a/contrib/endpoints/src/api_manager/context/request_context.cc b/contrib/endpoints/src/api_manager/context/request_context.cc
@@ -226,6 +226,16 @@ void RequestContext::FillCheckRequestInfo(
   info->allow_unregistered_calls = method()->allow_unregistered_calls();
 }
 
+void RequestContext::FillAllocateQuotaRequestInfo(
+    service_control::QuotaRequestInfo *info) {
+  FillOperationInfo(info);
+
+  info->client_ip = request_->GetClientIP();
+  info->method_name = this->method_call_.method_info->name();
+  info->metric_cost_vector =
+      &this->method_call_.method_info->metric_cost_vector();
+}
+
 void RequestContext::FillReportRequestInfo(
     Response *response, service_control::ReportRequestInfo *info) {
   FillOperationInfo(info);

diff --git a/contrib/endpoints/src/api_manager/context/request_context.h b/contrib/endpoints/src/api_manager/context/request_context.h
@@ -66,6 +66,9 @@ class RequestContext {
   // Fill CheckRequestInfo
   void FillCheckRequestInfo(service_control::CheckRequestInfo *info);
 
+  // FillAllocateQuotaRequestInfo
+  void FillAllocateQuotaRequestInfo(service_control::QuotaRequestInfo *info);
+
   // Fill ReportRequestInfo
   void FillReportRequestInfo(Response *response,
                              service_control::ReportRequestInfo *info);

diff --git a/contrib/endpoints/src/api_manager/mock_method_info.h b/contrib/endpoints/src/api_manager/mock_method_info.h
@@ -48,6 +48,8 @@ class MockMethodInfo : public MethodInfo {
   MOCK_CONST_METHOD0(response_streaming, bool());
   MOCK_CONST_METHOD0(system_query_parameter_names,
                      const std::set<std::string>&());
+  MOCK_CONST_METHOD0(metric_cost_vector,
+                     const std::vector<std::pair<std::string, int>>&());
 };
 
 }  // namespace api_manager

diff --git a/contrib/endpoints/src/api_manager/proto/server_config.proto b/contrib/endpoints/src/api_manager/proto/server_config.proto
@@ -66,6 +66,13 @@ message ServiceControlConfig {
   // The intermediate reports for streaming calls should not be more frequent
   // than this value (in seconds)
   int32 intermediate_report_min_interval = 7;
+
+  // Quota aggregator config
+  QuotaAggregatorConfig quota_aggregator_config = 8;
+
+  // Timeout in milliseconds on service control allocate quota requests.
+  // If the value is <= 0, default timeout is 5000 milliseconds.
+  int32 quota_timeout_ms = 9;
 }
 
 // Check aggregator config
@@ -82,6 +89,17 @@ message CheckAggregatorConfig {
   int32 response_expiration_ms = 3;
 }
 
+// Quota aggregator config
+message QuotaAggregatorConfig {
+  // The maximum number of cache entries that can be kept in the aggregation
+  // cache. Cache is disabled when entries <= 0.
+  int32 cache_entries = 1;
+
+  // The maximum milliseconds before aggregated quota requests are refreshed to
+  // the server.
+  int32 refresh_interval_ms = 2;
+}
+
 // Report aggregator config
 message ReportAggregatorConfig {
   // The maximum number of cache entries that can be kept in the aggregation

diff --git a/contrib/endpoints/src/api_manager/quota_control.cc b/contrib/endpoints/src/api_manager/quota_control.cc
@@ -0,0 +1,54 @@
+// Copyright 2017 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////////
+//
+#include <iostream>
+
+#include "contrib/endpoints/src/api_manager/cloud_trace/cloud_trace.h"
+#include "contrib/endpoints/src/api_manager/quota_control.h"
+#include "google/protobuf/stubs/status.h"
+
+using ::google::api_manager::utils::Status;
+using ::google::protobuf::util::error::Code;
+
+namespace google {
+namespace api_manager {
+
+void QuotaControl(std::shared_ptr<context::RequestContext> context,
+                  std::function<void(Status status)> continuation) {
+  std::shared_ptr<cloud_trace::CloudTraceSpan> trace_span(
+      CreateSpan(context->cloud_trace(), "QuotaControl"));
+
+  if (context->method()->metric_cost_vector().size() == 0) {
+    TRACE(trace_span) << "Quota control check is not needed";
+    continuation(Status::OK);
+    return;
+  }
+
+  service_control::QuotaRequestInfo info;
+  context->FillAllocateQuotaRequestInfo(&info);
+  context->service_context()->service_control()->Quota(
+      info, trace_span.get(),
+      [context, continuation, trace_span](utils::Status status) {
+
+        TRACE(trace_span) << "Quota service control request returned with "
+                          << "status " << status.ToString();
+
+        continuation(status);
+      });
+}
+
+}  // namespace service_control_client
+}  // namespace google
diff --git a/contrib/endpoints/src/api_manager/quota_control.h b/contrib/endpoints/src/api_manager/quota_control.h
@@ -0,0 +1,33 @@
+// Copyright 2017 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////////
+//
+#ifndef API_MANAGER_QUOTA_CONTROL_H_
+#define API_MANAGER_QUOTA_CONTROL_H_
+
+#include "contrib/endpoints/include/api_manager/utils/status.h"
+#include "contrib/endpoints/src/api_manager/context/request_context.h"
+
+namespace google {
+namespace api_manager {
+
+// Call service control quota.
+void QuotaControl(std::shared_ptr<context::RequestContext>,
+                  std::function<void(utils::Status)>);
+
+}  // namespace api_manager
+}  // namespace google
+
+#endif  // API_MANAGER_QUOTA_CONTROL_H_