Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Include locale in API v2 serializer params plus remove code duplication

Damian Legawiecbeee5ef18926
diff --git a/api/app/controllers/spree/api/v2/base_controller.rb b/api/app/controllers/spree/api/v2/base_controller.rb
index 6da14a03eb..d63e2c3ef4 100644
--- a/api/app/controllers/spree/api/v2/base_controller.rb
+++ b/api/app/controllers/spree/api/v2/base_controller.rb
@@ -130,6 +130,7 @@ module Spree
def serializer_params
{
currency: current_currency,
+ locale: current_locale,
store: current_store,
user: spree_current_user
}
diff --git a/api/app/controllers/spree/api/v2/storefront/countries_controller.rb b/api/app/controllers/spree/api/v2/storefront/countries_controller.rb
index 904d022e0b..7cddf12b98 100644
--- a/api/app/controllers/spree/api/v2/storefront/countries_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/countries_controller.rb
@@ -12,21 +12,12 @@ module Spree
).serializable_hash
end
- def collection_serializer_params
- {
- currency: current_currency,
- store: current_store,
- user: spree_current_user,
- }
+ def serializer_params
+ super.merge(include_states: true)
end
- def serializer_params
- {
- currency: current_currency,
- store: current_store,
- user: spree_current_user,
- include_states: true,
- }
+ def collection_serializer_params
+ serializer_params.merge(include_states: false)
end
def resource
diff --git a/api/app/serializers/spree/api/v2/base_serializer.rb b/api/app/serializers/spree/api/v2/base_serializer.rb
index ad73649663..78208afa4c 100644
--- a/api/app/serializers/spree/api/v2/base_serializer.rb
+++ b/api/app/serializers/spree/api/v2/base_serializer.rb
@@ -12,7 +12,7 @@ module Spree
def self.record_cache_options(options, fieldset, include_list, params)
opts = options.dup
- params_cache_key = [params[:currency], params[:user]&.cache_key_with_version, params[:store]&.cache_key_with_version].join('-')
+ params_cache_key = [params[:currency], params[:locale], params[:user]&.cache_key_with_version, params[:store]&.cache_key_with_version].join('-')
opts[:namespace] += "-#{params_cache_key}"
diff --git a/api/spec/controllers/spree/api/v2/base_controller_spec.rb b/api/spec/controllers/spree/api/v2/base_controller_spec.rb
index 9849cb4fba..2d190a2c13 100644
--- a/api/spec/controllers/spree/api/v2/base_controller_spec.rb
+++ b/api/spec/controllers/spree/api/v2/base_controller_spec.rb
@@ -90,7 +90,6 @@ describe Spree::Api::V2::BaseController, type: :controller do
end
describe '#error_during_processing' do
-
controller(described_class) do
def index
render plain: { 'products' => [] }.to_json
@@ -121,4 +120,46 @@ describe Spree::Api::V2::BaseController, type: :controller do
expect(json_response).to eql('error' => 'foo')
end
end
+
+ describe '#serializer_params' do
+ let(:store) { Spree::Store.default }
+ let(:currency) { store.default_currency }
+ let(:locale) { store.default_locale }
+ let(:user) { nil }
+
+ shared_examples 'returns proper values' do
+ before do
+ allow(dummy_controller).to receive(:current_store).and_return(store)
+ allow(dummy_controller).to receive(:current_currency).and_return(currency)
+ allow(dummy_controller).to receive(:current_locale).and_return(locale)
+ allow(dummy_controller).to receive(:spree_current_user).and_return(user)
+ end
+
+ it { expect(dummy_controller.send(:serializer_params).keys).to eq(%i[currency locale store user]) }
+
+ it do
+ expect(dummy_controller.send(:serializer_params)).to eq(
+ {
+ store: store,
+ currency: currency,
+ user: user,
+ locale: locale
+ }
+ )
+ end
+ end
+
+ context 'default values' do
+ it_behaves_like 'returns proper values'
+ end
+
+ context 'non-default values' do
+ let(:user) { create(:user) }
+ let(:currency) { 'EUR' }
+ let(:locale) { 'de' }
+ let(:store) { create(:store, default_locale: locale, default_currency: currency) }
+
+ it_behaves_like 'returns proper values'
+ end
+ end
end
diff --git a/api/spec/requests/spree/api/v2/caching_spec.rb b/api/spec/requests/spree/api/v2/caching_spec.rb
index 33bab6d94d..5811e2b573 100644
--- a/api/spec/requests/spree/api/v2/caching_spec.rb
+++ b/api/spec/requests/spree/api/v2/caching_spec.rb
@@ -17,7 +17,7 @@ describe 'API v2 Caching spec', type: :request do
end
context 'auto expiration' do
- let(:cache_namespace) { "jsonapi-serializer-USD--#{store.cache_key_with_version}" }
+ let(:cache_namespace) { "jsonapi-serializer-USD-en--#{store.cache_key_with_version}" }
it 'auto expire cache after record being updated' do
get "/api/v2/storefront/products/#{product.id}"
@@ -39,14 +39,15 @@ describe 'API v2 Caching spec', type: :request do
context 'currency and user' do
include_context 'API v2 tokens'
- before { store.update!(supported_currencies: 'USD,EUR') }
+ before { store.update!(supported_currencies: 'USD,EUR', supported_locales: 'en,de') }
let!(:user) { create(:user) }
let(:currency) { 'EUR' }
- let(:cache_namespace) { "jsonapi-serializer-EUR-#{user.cache_key_with_version}-#{store.cache_key_with_version}" }
+ let(:locale) { 'de' }
+ let(:cache_namespace) { "jsonapi-serializer-EUR-de-#{user.cache_key_with_version}-#{store.cache_key_with_version}" }
it 'includes currency and signed user in the cache key' do
- get "/api/v2/storefront/products/#{product.id}?currency=#{currency}", headers: headers_bearer
+ get "/api/v2/storefront/products/#{product.id}?currency=#{currency}&locale=#{locale}", headers: headers_bearer
expect(cache_entry).not_to be_nil
end