Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
[SD-1171] Set API v2 per page limit and do not allow for 0 value (#10768)
Agnieszka Jacek1190859e85ae
diff --git a/api/app/models/spree/api_configuration.rb b/api/app/models/spree/api_configuration.rbindex c25465b6ed..6632f4bcfd 100644--- a/api/app/models/spree/api_configuration.rb+++ b/api/app/models/spree/api_configuration.rb@@ -2,5 +2,6 @@ module Spreeclass ApiConfiguration < Preferences::Configurationpreference :requires_authentication, :boolean, default: truepreference :api_v2_content_type, :string, default: 'application/vnd.api+json'+ preference :api_v2_per_page_limit, :integer, default: 100endenddiff --git a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rbindex 37010676b1..cb65c5c4f2 100644--- a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb@@ -4,6 +4,8 @@ describe 'Storefront API v2 Orders spec', type: :request dolet!(:user) { create(:user_with_addresses) }let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }+ before { Spree::Api::Config[:api_v2_per_page_limit] = 2 }+include_context 'API v2 tokens'describe 'orders#index' do@@ -49,29 +51,55 @@ describe 'Storefront API v2 Orders spec', type: :request doendend- context 'with specified pagination params' do+ context 'when per_page is between 1 and default value' dolet!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }let!(:order_1) { create(:order, state: 'complete', user: user, completed_at: Time.current + 1.day) }let!(:order_2) { create(:order, state: 'complete', user: user, completed_at: Time.current + 2.days) }let!(:order_3) { create(:order, state: 'complete', user: user, completed_at: Time.current + 3.days) }- before { get '/api/v2/storefront/account/orders?page=1&per_page=2', headers: headers_bearer }+ context 'with specified pagination params' do+ before { get '/api/v2/storefront/account/orders?page=1&per_page=2', headers: headers_bearer }- it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns 200 HTTP status'- it 'returns specified amount orders' do- expect(json_response['data'].count).to eq 2+ it 'returns specified amount orders' do+ expect(json_response['data'].count).to eq 2+ end++ it 'returns proper meta data' do+ expect(json_response['meta']['count']).to eq 2+ expect(json_response['meta']['total_count']).to eq Spree::Order.count+ end++ it 'returns proper links data' do+ expect(json_response['links']['self']).to include('/api/v2/storefront/account/orders?page=1&per_page=2')+ expect(json_response['links']['next']).to include('/api/v2/storefront/account/orders?page=2&per_page=2')+ expect(json_response['links']['prev']).to include('/api/v2/storefront/account/orders?page=1&per_page=2')+ endend- it 'returns proper meta data' do- expect(json_response['meta']['count']).to eq 2- expect(json_response['meta']['total_count']).to eq Spree::Order.count+ context 'when per_page is above the default value' do+ before { get '/api/v2/storefront/account/orders?page=1&per_page=10', headers: headers_bearer }++ it 'returns the default number of orders' do+ expect(json_response['data'].count).to eq 4+ endend- it 'returns proper links data' do- expect(json_response['links']['self']).to include('/api/v2/storefront/account/orders?page=1&per_page=2')- expect(json_response['links']['next']).to include('/api/v2/storefront/account/orders?page=2&per_page=2')- expect(json_response['links']['prev']).to include('/api/v2/storefront/account/orders?page=1&per_page=2')+ context 'when per_page is less than 0' do+ before { get '/api/v2/storefront/account/orders?page=1&per_page=-1', headers: headers_bearer }++ it 'returns the default number of orders' do+ expect(json_response['data'].count).to eq 4+ end+ end++ context 'when per_page is equal 0' do+ before { get '/api/v2/storefront/account/orders?page=1&per_page=0', headers: headers_bearer }++ it 'returns the default number of orders' do+ expect(json_response['data'].count).to eq 4+ endendenddiff --git a/api/spec/requests/spree/api/v2/storefront/products_spec.rb b/api/spec/requests/spree/api/v2/storefront/products_spec.rbindex b7bf64d4e3..cca3b63ead 100644--- a/api/spec/requests/spree/api/v2/storefront/products_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/products_spec.rb@@ -16,6 +16,8 @@ describe 'API V2 Storefront Products Spec', type: :request dolet!(:discontinued_product) { create(:product, discontinue_on: Time.current - 1.day) }let!(:not_available_product) { create(:product, available_on: nil) }+ before { Spree::Api::Config[:api_v2_per_page_limit] = 4 }+describe 'products#index' docontext 'with no params' dobefore { get '/api/v2/storefront/products' }@@ -192,23 +194,49 @@ describe 'API V2 Storefront Products Spec', type: :request docontext 'paginate products' docontext 'with specified pagination params' do- before { get '/api/v2/storefront/products?page=1&per_page=2' }+ context 'when per_page is between 1 and default value' do+ before { get '/api/v2/storefront/products?page=1&per_page=2' }- it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns 200 HTTP status'- it 'returns specified amount products' do- expect(json_response['data'].count).to eq 2+ it 'returns the default number of products' do+ expect(json_response['data'].count).to eq 2+ end++ it 'returns proper meta data' do+ expect(json_response['meta']['count']).to eq 2+ expect(json_response['meta']['total_count']).to eq Spree::Product.available.count+ end++ it 'returns proper links data' do+ expect(json_response['links']['self']).to include('/api/v2/storefront/products?page=1&per_page=2')+ expect(json_response['links']['next']).to include('/api/v2/storefront/products?page=2&per_page=2')+ expect(json_response['links']['prev']).to include('/api/v2/storefront/products?page=1&per_page=2')+ endend- it 'returns proper meta data' do- expect(json_response['meta']['count']).to eq 2- expect(json_response['meta']['total_count']).to eq Spree::Product.available.count+ context 'when per_page is above the default value' do+ before { get '/api/v2/storefront/products?page=1&per_page=10' }++ it 'returns the default number of products' do+ expect(json_response['data'].count).to eq 6+ endend- it 'returns proper links data' do- expect(json_response['links']['self']).to include('/api/v2/storefront/products?page=1&per_page=2')- expect(json_response['links']['next']).to include('/api/v2/storefront/products?page=2&per_page=2')- expect(json_response['links']['prev']).to include('/api/v2/storefront/products?page=1&per_page=2')+ context 'when per_page is less than 0' do+ before { get '/api/v2/storefront/products?page=1&per_page=-1' }++ it 'returns the default number of products' do+ expect(json_response['data'].count).to eq 6+ end+ end++ context 'when per_page is equal 0' do+ before { get '/api/v2/storefront/products?page=1&per_page=0' }++ it 'returns the default number of products' do+ expect(json_response['data'].count).to eq 6+ endendenddiff --git a/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb b/api/spec/requests/spree/api/v2/storefront/taxons_spec.rbindex af1708db90..d90116d057 100644--- a/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb@@ -4,6 +4,8 @@ describe 'Taxons Spec', type: :request dolet!(:taxonomy) { create(:taxonomy) }let!(:taxons) { create_list(:taxon, 2, taxonomy: taxonomy, parent_id: taxonomy.root.id) }+ before { Spree::Api::Config[:api_v2_per_page_limit] = 2 }+shared_examples 'returns valid taxon resource JSON' doit 'returns a valid taxon resource JSON response' doexpect(response.status).to eq(200)@@ -89,23 +91,49 @@ describe 'Taxons Spec', type: :request docontext 'paginate taxons' docontext 'with specified pagination params' do- before { get '/api/v2/storefront/taxons?page=1&per_page=1' }+ context 'when per_page is between 1 and default value' do+ before { get '/api/v2/storefront/taxons?page=1&per_page=1' }- it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns 200 HTTP status'- it 'returns specified amount of taxons' do- expect(json_response['data'].count).to eq 1+ it 'returns specified amount of taxons' do+ expect(json_response['data'].count).to eq 1+ end++ it 'returns proper meta data' do+ expect(json_response['meta']['count']).to eq 1+ expect(json_response['meta']['total_count']).to eq Spree::Taxon.count+ end++ it 'returns proper links data' do+ expect(json_response['links']['self']).to include('/api/v2/storefront/taxons?page=1&per_page=1')+ expect(json_response['links']['next']).to include('/api/v2/storefront/taxons?page=2&per_page=1')+ expect(json_response['links']['prev']).to include('/api/v2/storefront/taxons?page=1&per_page=1')+ endend- it 'returns proper meta data' do- expect(json_response['meta']['count']).to eq 1- expect(json_response['meta']['total_count']).to eq Spree::Taxon.count+ context 'when per_page is above the default value' do+ before { get '/api/v2/storefront/taxons?page=1&per_page=10' }++ it 'returns the default number of taxons' do+ expect(json_response['data'].count).to eq 3+ endend- it 'returns proper links data' do- expect(json_response['links']['self']).to include('/api/v2/storefront/taxons?page=1&per_page=1')- expect(json_response['links']['next']).to include('/api/v2/storefront/taxons?page=2&per_page=1')- expect(json_response['links']['prev']).to include('/api/v2/storefront/taxons?page=1&per_page=1')+ context 'when per_page is less than 0' do+ before { get '/api/v2/storefront/taxons?page=1&per_page=-1' }++ it 'returns the default number of taxons' do+ expect(json_response['data'].count).to eq 3+ end+ end++ context 'when per_page is equal 0' do+ before { get '/api/v2/storefront/taxons?page=1&per_page=0' }++ it 'returns the default number of taxons' do+ expect(json_response['data'].count).to eq 3+ endendenddiff --git a/core/app/paginators/spree/shared/paginate.rb b/core/app/paginators/spree/shared/paginate.rbindex d771da8ed1..9ce1fedbbc 100644--- a/core/app/paginators/spree/shared/paginate.rb+++ b/core/app/paginators/spree/shared/paginate.rb@@ -4,7 +4,14 @@ module Spreedef initialize(collection, params)@collection = collection@page = params[:page]- @per_page = params[:per_page]++ per_page_limit = Spree::Api::Config[:api_v2_per_page_limit]++ @per_page = if params[:per_page].to_i.between?(1, per_page_limit)+ params[:per_page]+ else+ Kaminari.config.default_per_page+ endenddef call