Add rate limits to info end point (#4514)

Add rate limits to /v3/info

Author: nookala

app/controllers/v3/info_controller.rb

@@ -5,17 +5,7 @@
 class InfoController < ApplicationController
   def v3_info
     info = Info.new
-    config = VCAP::CloudController::Config.config
-
-    info.build = config.get(:info, :build) || ''
-    info.min_cli_version = config.get(:info, :min_cli_version) || ''
-    info.min_recommended_cli_version = config.get(:info, :min_recommended_cli_version) || ''
-    info.custom = config.get(:info, :custom) || {}
-    info.description = config.get(:info, :description) || ''
-    info.name = config.get(:info, :name) || ''
-    info.version = config.get(:info, :version) || 0
-    info.support_address = config.get(:info, :support_address) || ''
-
+    populate_info_fields(info)
     osbapi_version_file = Rails.root.join('config/osbapi_version').to_s
     if File.exist?(osbapi_version_file)
       info.osbapi_version = File.read(osbapi_version_file).strip
@@ -34,8 +24,27 @@ def show_usage_summary
 
     render status: :ok, json: VCAP::CloudController::Presenters::V3::InfoUsageSummaryPresenter.new(summary)
   end
+
+  private
+
+  def populate_info_fields(info)
+    config = VCAP::CloudController::Config.config
+
+    info.build = config.get(:info, :build) || ''
+    info.min_cli_version = config.get(:info, :min_cli_version) || ''
+    info.min_recommended_cli_version = config.get(:info, :min_recommended_cli_version) || ''
+    info.custom = config.get(:info, :custom) || {}
+    info.description = config.get(:info, :description) || ''
+    info.name = config.get(:info, :name) || ''
+    info.version = config.get(:info, :version) || 0
+    info.support_address = config.get(:info, :support_address) || ''
+    info.request_rate_limiter_enabled = config.get(:rate_limiter, :enabled) || false
+    info.request_rate_limiter_general_limit = config.get(:rate_limiter, :per_process_general_limit) || ''
+    info.request_rate_limiter_reset_interval_in_mins = config.get(:rate_limiter, :reset_interval_in_minutes) || ''
+  end
 end
 
 class Info
-  attr_accessor :build, :min_cli_version, :min_recommended_cli_version, :custom, :description, :name, :version, :support_address, :osbapi_version
+  attr_accessor :build, :min_cli_version, :min_recommended_cli_version, :custom, :description, :name, :version, :support_address, :osbapi_version, :request_rate_limiter_enabled,
+                :request_rate_limiter_general_limit, :request_rate_limiter_reset_interval_in_mins
 end

app/presenters/v3/info_presenter.rb

@@ -16,6 +16,11 @@ def to_hash
         name: info.name,
         version: info.version,
         osbapi_version: info.osbapi_version,
+        rate_limits: {
+          enabled: info.request_rate_limiter_enabled,
+          general_limit: info.request_rate_limiter_general_limit,
+          reset_interval_in_minutes: info.request_rate_limiter_reset_interval_in_mins
+        },
         links: {
           self: { href: build_self },
           support: { href: info.support_address }

docs/v3/source/includes/api_resources/_info.erb

@@ -12,6 +12,11 @@
   "name": "Cloud Foundry",
   "version": 123,
   "osbapi_version": "2.15",
+  "rate_limits": {
+    "enabled": true,
+    "general_limit": 2000,
+    "reset_interval_in_minutes": 30
+  },
   "links": {
     "self": { "href": "http://api.example.com/v3/info" } ,
     "support": { "href": "http://support.example.com" }
@@ -31,6 +36,11 @@
   "name": "",
   "version": 0,
   "osbapi_version": "",
+  "rate_limits": {
+    "enabled": false,
+    "general_limit": 2000,
+    "reset_interval_in_minutes": 30
+  },
   "links": {
     "self": { "href": "http://api.example.com/v3/info" } ,
     "support": { "href": "" }

spec/request/info_spec.rb

@@ -15,6 +15,11 @@
         name: TestConfig.config[:info][:name],
         version: TestConfig.config[:info][:version],
         osbapi_version: TestConfig.config[:info][:osbapi_version],
+        rate_limits: {
+          enabled: TestConfig.config[:rate_limiter][:enabled],
+          general_limit: TestConfig.config[:rate_limiter][:per_process_general_limit],
+          reset_interval_in_minutes: TestConfig.config[:rate_limiter][:reset_interval_in_minutes]
+        },
         links: {
           self: { href: "#{link_prefix}/v3/info" },
           support: { href: TestConfig.config[:info][:support_address] }
@@ -48,6 +53,11 @@
           name: '',
           version: 0,
           osbapi_version: '',
+          rate_limits: {
+            enabled: false,
+            general_limit: '',
+            reset_interval_in_minutes: ''
+          },
           links: {
             self: { href: "#{link_prefix}/v3/info" },
             support: { href: '' }
@@ -56,7 +66,7 @@
       end
 
       before do
-        TestConfig.override(info: nil)
+        TestConfig.override(info: nil, rate_limiter: nil)
         allow(File).to receive(:exist?).with(Rails.root.join('config/osbapi_version').to_s).and_return(false)
       end
 
@@ -65,6 +75,52 @@
         expect(Oj.load(last_response.body)).to match_json_response(return_info_json)
       end
     end
+
+    context 'when rate limiter is enabled' do
+      let(:user) { make_user }
+      let(:user_headers) { headers_for(user, email: '[email protected]', user_name: 'Mr. Freeze') }
+
+      before do
+        TestConfig.override(
+          rate_limiter: {
+            enabled: true,
+            per_process_general_limit: 1000,
+            global_general_limit: 2000,
+            reset_interval_in_minutes: 15
+          }
+        )
+      end
+
+      it 'includes rate limiter configuration' do
+        get '/v3/info', nil, user_headers
+        response_json = Oj.load(last_response.body)
+
+        expect(response_json['rate_limits']['enabled']).to be true
+        expect(response_json['rate_limits']['general_limit']).to eq(1000)
+        expect(response_json['rate_limits']['reset_interval_in_minutes']).to eq(15)
+      end
+    end
+
+    context 'when rate limiter is disabled' do
+      before do
+        TestConfig.override(
+          rate_limiter: {
+            enabled: false,
+            per_process_general_limit: 0,
+            reset_interval_in_minutes: 0
+          }
+        )
+      end
+
+      it 'includes disabled rate limiter configuration' do
+        get '/v3/info'
+        response_json = Oj.load(last_response.body)
+
+        expect(response_json['rate_limits']['enabled']).to be false
+        expect(response_json['rate_limits']['general_limit']).to eq(0)
+        expect(response_json['rate_limits']['reset_interval_in_minutes']).to eq(0)
+      end
+    end
   end
 
   describe 'GET /v3/info/usage_summary' do