v3: fix pagination href when fields feature in use

[#173248802]

Author: blgm

app/messages/base_message.rb

@@ -42,12 +42,20 @@ def audit_hash(exclude: [])
       request.deep_stringify_keys
     end
 
-    def to_param_hash(opts={ exclude: [] })
+    def to_param_hash(exclude: [], fields: [])
       params = {}
-      (requested_keys - opts[:exclude]).each do |key|
+      (requested_keys - exclude).each do |key|
         val = self.try(key)
-        params[key] = val.is_a?(Array) ? val.map { |v| v.gsub(',', CGI.escape(',')) }.join(',') : val
+
+        if fields.include?(key)
+          val.each do |resource, selectors|
+            params["#{key}[#{resource}]".to_sym] = selectors.join(',')
+          end
+        else
+          params[key] = val.is_a?(Array) ? val.map { |v| v.gsub(',', CGI.escape(',')) }.join(',') : val
+        end
       end
+
       params
     end
 

app/messages/list_message.rb

@@ -25,8 +25,8 @@ def initialize(params={})
       super(params)
     end
 
-    def to_param_hash(exclude: [])
-      super(exclude: ALLOWED_PAGINATION_KEYS + exclude)
+    def to_param_hash(exclude: [], fields: [])
+      super(exclude: ALLOWED_PAGINATION_KEYS + exclude, fields: fields)
     end
 
     class PaginationOrderValidator < ActiveModel::Validator

app/messages/service_instances_list_message.rb

@@ -37,6 +37,10 @@ def self.from_params(params)
       super(params, @array_keys.map(&:to_s), fields: %w(fields))
     end
 
+    def to_param_hash
+      super(fields: [:fields])
+    end
+
     def valid_order_by_values
       super << :name
     end

app/messages/service_offerings_list_message.rb

@@ -30,5 +30,9 @@ class ServiceOfferingsListMessage < MetadataListMessage
     def self.from_params(params)
       super(params, @array_keys.map(&:to_s), fields: %w(fields))
     end
+
+    def to_param_hash
+      super(fields: [:fields])
+    end
   end
 end

app/messages/service_plans_list_message.rb

@@ -36,6 +36,10 @@ def self.from_params(params)
       super(params, @array_keys.map(&:to_s), fields: %w(fields))
     end
 
+    def to_param_hash
+      super(fields: [:fields])
+    end
+
     def available?
       requested?(:available) && available == 'true'
     end

spec/field_message_spec_shared_examples.rb

@@ -56,3 +56,9 @@
     ))
   end
 end
+
+RSpec.shared_examples 'fields to_param_hash' do |resource, keys|
+  it 'correctly formats the fields' do
+    expect(message.to_param_hash).to include("fields[#{resource}]": keys)
+  end
+end

spec/request/service_instances_spec.rb

@@ -241,6 +241,10 @@
     describe 'pagination' do
       let(:resources) { [msi_1, msi_2, upsi_1, upsi_2, ssi] }
       it_behaves_like 'paginated response', '/v3/service_instances'
+
+      it_behaves_like 'paginated fields response', '/v3/service_instances', 'space', 'guid,name,relationships.organization'
+
+      it_behaves_like 'paginated fields response', '/v3/service_instances', 'space.organization', 'name,guid'
     end
 
     describe 'filters' do

spec/request/service_offerings_spec.rb

@@ -466,6 +466,8 @@
 
       let(:resources) { [service_offering_1, service_offering_2] }
       it_behaves_like 'paginated response', '/v3/service_offerings'
+
+      it_behaves_like 'paginated fields response', '/v3/service_offerings', 'service_broker', 'guid,name'
     end
 
     context 'when the service offerings have labels and annotations' do

spec/request/service_plans_spec.rb

@@ -291,6 +291,8 @@
 
       let(:resources) { [service_plan_1, service_plan_2] }
       it_behaves_like 'paginated response', '/v3/service_plans'
+
+      it_behaves_like 'paginated fields response', '/v3/service_plans', 'service_offering.service_broker', 'name,guid'
     end
 
     describe 'filters' do

spec/request_spec_shared_examples.rb

@@ -41,6 +41,20 @@ def expect_filtered_resources(endpoint, filter, list)
   end
 end
 
+RSpec.shared_examples 'paginated fields response' do |endpoint, resource, keys|
+  it 'presents the fields correctly in first, last and next' do
+    filter = "fields[#{resource}]=#{keys}&per_page=1"
+    get "#{endpoint}?#{filter}", nil, admin_headers
+    expect(last_response).to have_status_code(200)
+
+    keys = keys.split(/,/).join('%2C')
+    last_page = resources.length
+    expect(parsed_response['pagination']['first']['href']).to include("#{endpoint}?fields%5B#{resource}%5D=#{keys}&page=1&per_page=1")
+    expect(parsed_response['pagination']['next']['href']).to include("#{endpoint}?fields%5B#{resource}%5D=#{keys}&page=2&per_page=1")
+    expect(parsed_response['pagination']['last']['href']).to include("#{endpoint}?fields%5B#{resource}%5D=#{keys}&page=#{last_page}&per_page=1")
+  end
+end
+
 RSpec.shared_examples 'permissions for list endpoint' do |roles|
   roles.each do |role|
     describe "as an #{role}" do