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.

Fixed Storefront Menu API

Damian Legawiec2a68f8d7e0f3
diff --git a/api/app/controllers/spree/api/v2/storefront/menus_controller.rb b/api/app/controllers/spree/api/v2/storefront/menus_controller.rb
index e4ad87909c..15a34c8047 100644
--- a/api/app/controllers/spree/api/v2/storefront/menus_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/menus_controller.rb
@@ -5,17 +5,6 @@ module Spree
class MenusController < ::Spree::Api::V2::ResourceController
private
- def serialize_collection(collection)
- collection_serializer.new(
- collection,
- collection_options(collection).merge(params: serializer_params)
- ).serializable_hash
- end
-
- def resource
- @resource ||= scope.find_by(location: params[:location])
- end
-
def resource_serializer
Spree::Api::Dependencies.storefront_menu_serializer.constantize
end
@@ -33,7 +22,11 @@ module Spree
end
def scope
- super.by_store(current_store).by_locale(I18n.locale)
+ super.by_locale(I18n.locale)
+ end
+
+ def scope_includes
+ { menu_items: [:children, :parent, :icon] }
end
end
end
diff --git a/api/app/serializers/spree/api/v2/platform/menu_item_serializer.rb b/api/app/serializers/spree/api/v2/platform/menu_item_serializer.rb
index a46e3da35e..b89b7a93ee 100644
--- a/api/app/serializers/spree/api/v2/platform/menu_item_serializer.rb
+++ b/api/app/serializers/spree/api/v2/platform/menu_item_serializer.rb
@@ -11,11 +11,10 @@ module Spree
record_type: :image,
serializer: :image
- belongs_to :menu
+ belongs_to :menu, serializer: :menu
belongs_to :parent, record_type: :menu_item, serializer: :menu_item
-
+ belongs_to :linked_resource, polymorphic: true
has_many :children, record_type: :menu_item, serializer: :menu_item
- end
end
end
end
diff --git a/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb b/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb
index e7ea668620..914449a6c5 100644
--- a/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/menu_item_serializer.rb
@@ -28,9 +28,8 @@ module Spree
record_type: :image,
serializer: :image
- belongs_to :menu
belongs_to :parent, record_type: :menu_item, serializer: :menu_item
-
+ belongs_to :linked_resource, polymorphic: true
has_many :children, record_type: :menu_item, serializer: :menu_item
end
end
diff --git a/api/config/routes.rb b/api/config/routes.rb
index 9c11da3b34..abf213d19e 100644
--- a/api/config/routes.rb
+++ b/api/config/routes.rb
@@ -164,8 +164,7 @@ Spree::Core::Engine.add_routes do
resources :taxons, only: %i[index show], id: /.+/
get '/stores/:code', to: 'stores#show', as: :store
- resources :menus, only: %i[index]
- get '/menus/:location', to: 'menus#show', as: :menu
+ resources :menus, only: %i[index show]
resources :cms_pages, only: %i[index show], path: '/pages'
end
diff --git a/api/spec/requests/spree/api/v2/storefront/menus_spec.rb b/api/spec/requests/spree/api/v2/storefront/menus_spec.rb
new file mode 100644
index 0000000000..7b90e5f989
--- /dev/null
+++ b/api/spec/requests/spree/api/v2/storefront/menus_spec.rb
@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe 'Storefront API v2 Menus spec', type: :request do
+ let(:store) { Spree::Store.default }
+
+ before do
+ store.update(supported_locales: 'en,fr')
+ end
+
+ describe 'menus#index' do
+ let!(:header_en) { create(:menu, store: store, location: 'Header') }
+ let!(:footer_en) { create(:menu, store: store, location: 'Footer') }
+ let!(:header_fr) { create(:menu, store: store, location: 'Header', locale: 'fr') }
+ let!(:footer_fr) { create(:menu, store: store, location: 'Footer', locale: 'fr') }
+ let!(:header_store_2) { create(:menu, store: create(:store), location: 'Header') }
+ let(:menu) { header_en }
+
+ shared_examples 'returns proper JSON structure' do
+ it 'with menu attributes and relationships' do
+ expect(json_response['data'][0]).to have_type('menu')
+ expect(json_response['data'][0]).to have_relationships(:menu_items)
+ expect(json_response['data'][0]['id']).to eq(menu.id.to_s)
+ expect(json_response['data'][0]['attributes']['name']).to eq menu.name
+ expect(json_response['data'][0]['attributes']['location']).to eq menu.location
+ expect(json_response['data'][0]['attributes']['locale']).to eq menu.locale
+ end
+ end
+
+ context 'with no params' do
+ before { get '/api/v2/storefront/menus' }
+
+ it_behaves_like 'returns 200 HTTP status'
+ it_behaves_like 'returns proper JSON structure'
+
+ it 'returns all menus for the current store and locale' do
+ expect(json_response['data'].pluck(:id)).to contain_exactly(header_en.id.to_s, footer_en.id.to_s)
+ end
+ end
+
+ context 'with locale param' do
+ let(:menu) { header_fr }
+
+ before { get '/api/v2/storefront/menus?locale=fr' }
+
+ it_behaves_like 'returns 200 HTTP status'
+ it_behaves_like 'returns proper JSON structure'
+
+ it 'returns all menus for the current store and specified locale' do
+ expect(json_response['data'].pluck(:id)).to contain_exactly(header_fr.id.to_s, footer_fr.id.to_s)
+ end
+ end
+
+ context 'including menu items with linked resources' do
+ let(:taxonomy) { create(:taxonomy, store: store) }
+ let(:taxon) { create(:taxon, taxonomy: taxonomy) }
+ let!(:menu_item) { create(:menu_item, menu: header_en, linked_resource: taxon) }
+
+ before { get '/api/v2/storefront/menus?include=menu_items.linked_resource' }
+
+ it_behaves_like 'returns 200 HTTP status'
+ it_behaves_like 'returns proper JSON structure'
+
+ it 'returns menu items and their associations' do
+ expect(json_response['included']).to include(have_type('taxon').and(have_id(taxon.id.to_s)))
+ expect(json_response['included']).to include(
+ have_type('menu_item').
+ and(
+ have_id(menu_item.id.to_s).
+ and(have_relationship(:image, :menu, :parent, :children, :linked_resource)).
+ and(have_jsonapi_attributes(:name, :code, :subtitle, :link, :new_window, :lft, :rgt, :depth, :is_container, :is_root, :is_child, :is_leaf))
+ )
+ )
+ end
+
+ context 'filtering by location' do
+ before { get '/api/v2/storefront/menus?filter[location]=header' }
+
+ it_behaves_like 'returns 200 HTTP status'
+
+ it 'returns menus for the current store and specified location' do
+ expect(json_response['data'].pluck(:id)).to contain_exactly(header_en.id.to_s)
+ end
+ end
+ end
+ end
+
+ describe 'menus#show' do
+ context 'with valid menu ID' do
+ let!(:menu) { create(:menu, store: store) }
+ let(:taxonomy) { create(:taxonomy, store: store) }
+ let(:taxon) { create(:taxon, taxonomy: taxonomy) }
+ let!(:menu_item) { create(:menu_item, menu: menu, linked_resource: taxon) }
+
+ before { get "/api/v2/storefront/menus/#{menu.id}?include=menu_items.linked_resource" }
+
+ it_behaves_like 'returns 200 HTTP status'
+
+ it 'returns menu attributes and relationships' do
+ expect(json_response['data']['id']).to eq(menu.id.to_s)
+ expect(json_response['data']['attributes']['name']).to eq menu.name
+ expect(json_response['data']['attributes']['location']).to eq menu.location
+ expect(json_response['data']['attributes']['locale']).to eq menu.locale
+
+ expect(json_response['included']).to include(have_type('taxon').and(have_id(taxon.id.to_s)))
+ expect(json_response['included']).to include(have_type('menu_item').and(have_id(menu_item.id.to_s).and(have_relationship(:image, :menu, :parent, :children, :linked_resource))))
+ end
+ end
+
+ context 'with menu from different store' do
+ let!(:menu) { create(:menu, store: create(:store)) }
+
+ before { get "/api/v2/storefront/menus/#{menu.id}" }
+
+ it_behaves_like 'returns 404 HTTP status'
+ end
+
+ context 'with non-existing menu ID' do
+ before { get '/api/v2/storefront/menus/0' }
+
+ it_behaves_like 'returns 404 HTTP status'
+ end
+ end
+end
diff --git a/core/app/finders/spree/menus/find.rb b/core/app/finders/spree/menus/find.rb
index d8f6ad61d4..cc8cc3a3c7 100644
--- a/core/app/finders/spree/menus/find.rb
+++ b/core/app/finders/spree/menus/find.rb
@@ -2,7 +2,7 @@ module Spree
module Menus
class Find < ::Spree::BaseFinder
def execute
- return scope.where(location: params[:filter]['location']) if params[:filter].present?
+ return scope.where(location: params[:filter]['location']) if params[:filter].present? && params[:filter]['location'].present?
scope
end
diff --git a/core/app/models/spree/menu_item.rb b/core/app/models/spree/menu_item.rb
index 0b29396d34..c42f1db850 100644
--- a/core/app/models/spree/menu_item.rb
+++ b/core/app/models/spree/menu_item.rb
@@ -8,7 +8,8 @@ module Spree
belongs_to :linked_resource, polymorphic: true
before_create :ensure_item_belongs_to_root
- before_save :reset_link_attributes, :paremeterize_code
+ before_update :reset_link_attributes
+ before_save :paremeterize_code
after_save :touch_ancestors_and_menu
after_touch :touch_ancestors_and_menu
@@ -22,8 +23,7 @@ module Spree
LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
- validates :name, presence: true
- validates :menu, presence: true
+ validates :name, :menu, presence: true
validates :item_type, inclusion: { in: ITEM_TYPE }
validates :linked_resource_type, inclusion: { in: LINKED_RESOURCE_TYPE }
diff --git a/core/lib/spree/testing_support/factories/menu_factory.rb b/core/lib/spree/testing_support/factories/menu_factory.rb
index 6ccd93cfb2..cf059c445a 100644
--- a/core/lib/spree/testing_support/factories/menu_factory.rb
+++ b/core/lib/spree/testing_support/factories/menu_factory.rb
@@ -2,7 +2,7 @@ FactoryBot.define do
factory :menu, class: Spree::Menu do
name { generate(:random_string) }
locale { 'en' }
- location {'Header'}
+ location { 'Header' }
before(:create) do |menu|
if menu.store.nil?