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.

Use Store/Admin API serializers in JSON preview in Admin

Damian Legawiec33dfcda76a8a
diff --git a/admin/app/helpers/spree/admin/json_preview_helper.rb b/admin/app/helpers/spree/admin/json_preview_helper.rb
index fcc5cd58f4..a64fb68784 100644
--- a/admin/app/helpers/spree/admin/json_preview_helper.rb
+++ b/admin/app/helpers/spree/admin/json_preview_helper.rb
@@ -18,59 +18,63 @@ module Spree
end
def json_serializers_available?(record)
- storefront_serializer_exists?(record) || platform_serializer_exists?(record)
+ store_serializer_exists?(record) || admin_serializer_exists?(record)
end
- def storefront_serializer_exists?(record)
- storefront_serializer_for(record).present?
+ def store_serializer_exists?(record)
+ store_serializer_for(record).present?
end
- def platform_serializer_exists?(record)
- platform_serializer_for(record).present?
+ def admin_serializer_exists?(record)
+ admin_serializer_for(record).present?
end
- def serialize_to_json(record, api_type: :storefront)
+ def serialize_to_json(record, api_type: :store)
return unless record
serializer = case api_type.to_sym
- when :storefront
- storefront_serializer_for(record)
- when :platform
- platform_serializer_for(record)
+ when :store
+ store_serializer_for(record)
+ when :admin
+ admin_serializer_for(record)
end
return nil unless serializer
- serializable_hash = serializer.new(
+ # Alba serializers use .new(object, params: {}).to_h
+ serialized_hash = serializer.new(
record,
params: serializer_params(record, api_type)
- ).serializable_hash
+ ).to_h
- JSON.pretty_generate(serializable_hash)
+ JSON.pretty_generate(serialized_hash)
end
private
- def storefront_serializer_for(record)
- serializer_for(record, api_type: :storefront, namespace: 'Spree::V2::Storefront')
+ def store_serializer_for(record)
+ serializer_for(record, namespace: 'Spree::Api::V3')
end
- def platform_serializer_for(record)
- serializer_for(record, api_type: :platform, namespace: 'Spree::Api::V2::Platform')
+ def admin_serializer_for(record)
+ serializer_for(record, namespace: 'Spree::Api::V3::Admin')
end
- def serializer_for(record, api_type:, namespace:)
+ def serializer_for(record, namespace:)
class_name = record.class.name.demodulize
- method_name = "#{api_type}_#{class_name.underscore}_serializer"
- if Spree.api.respond_to?(method_name)
- Spree.api.public_send(method_name)
- else
- serializer_class_name = "#{namespace}::#{class_name}Serializer"
- serializer_class_name.safe_constantize
+
+ # First try dependency lookup (without prefix for v3)
+ method_name = "#{class_name.underscore}_serializer"
+ if namespace == 'Spree::Api::V3' && Spree.api.respond_to?(method_name)
+ return Spree.api.public_send(method_name)
end
+
+ # Fall back to direct constant lookup
+ serializer_class_name = "#{namespace}::#{class_name}Serializer"
+ serializer_class_name.safe_constantize
end
- def serializer_params(record, api_type)
+ def serializer_params(_record, api_type)
params = {}
params[:api_type] = api_type
params[:store] = current_store if defined?(current_store) && current_store.present?
diff --git a/admin/app/views/spree/admin/json_previews/show.html.erb b/admin/app/views/spree/admin/json_previews/show.html.erb
index cd2efd9bac..90d146da80 100644
--- a/admin/app/views/spree/admin/json_previews/show.html.erb
+++ b/admin/app/views/spree/admin/json_previews/show.html.erb
@@ -3,15 +3,15 @@
<div class="drawer-body" data-controller="highlight tabs">
<ul class="nav nav-pills mb-3">
<li class="nav-item">
- <a class="nav-link active" data-tabs-target="tab" data-action="click->tabs#select"><%= Spree.t('apis.storefront') %></a>
+ <a class="nav-link active" data-tabs-target="tab" data-action="click->tabs#select"><%= Spree.t('apis.store') %></a>
</li>
<li class="nav-item">
- <a class="nav-link" data-tabs-target="tab" data-action="click->tabs#select"><%= Spree.t('apis.platform') %></a>
+ <a class="nav-link" data-tabs-target="tab" data-action="click->tabs#select"><%= Spree.t('apis.admin') %></a>
</li>
</ul>
<div data-tabs-target="panel" class="animate-fade-in">
- <% if storefront_serializer_exists?(@object) %>
- <%= code_block serialize_to_json(@object, api_type: :storefront), style: 'height: calc(100dvh - 11rem);' %>
+ <% if store_serializer_exists?(@object) %>
+ <%= code_block serialize_to_json(@object, api_type: :store), style: 'height: calc(100dvh - 11rem);' %>
<% else %>
<div class="text-gray-600 p-12 flex items-center w-full justify-center flex-col">
<%= icon 'map-search', class: 'mb-12 opacity-50 text-4xl' %>
@@ -22,8 +22,8 @@
<% end %>
</div>
<div data-tabs-target="panel" class="animate-fade-in" hidden>
- <% if platform_serializer_exists?(@object) %>
- <%= code_block serialize_to_json(@object, api_type: :platform), style: 'height: calc(100dvh - 11rem);' %>
+ <% if admin_serializer_exists?(@object) %>
+ <%= code_block serialize_to_json(@object, api_type: :admin), style: 'height: calc(100dvh - 11rem);' %>
<% else %>
<div class="text-gray-600 p-12 flex items-center w-full justify-center flex-col">
<%= icon 'map-search', class: 'mb-12 opacity-50 text-4xl' %>
diff --git a/admin/spec/helpers/spree/admin/json_preview_helper_spec.rb b/admin/spec/helpers/spree/admin/json_preview_helper_spec.rb
new file mode 100644
index 0000000000..8604cc6f4c
--- /dev/null
+++ b/admin/spec/helpers/spree/admin/json_preview_helper_spec.rb
@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::JsonPreviewHelper, type: :helper do
+ let(:product) { create(:product) }
+ let(:order) { create(:order) }
+
+ describe '#store_serializer_exists?' do
+ it 'returns true for Product' do
+ expect(helper.store_serializer_exists?(product)).to be true
+ end
+
+ it 'returns true for Order' do
+ expect(helper.store_serializer_exists?(order)).to be true
+ end
+ end
+
+ describe '#admin_serializer_exists?' do
+ it 'returns true for Product when admin serializer exists' do
+ expect(helper.admin_serializer_exists?(product)).to be true
+ end
+
+ it 'returns true for Order when admin serializer exists' do
+ expect(helper.admin_serializer_exists?(order)).to be true
+ end
+ end
+
+ describe '#serialize_to_json' do
+ context 'with store api_type' do
+ it 'serializes Product to JSON' do
+ json = helper.serialize_to_json(product, api_type: :store)
+ expect(json).to be_present
+ parsed = JSON.parse(json)
+ expect(parsed['name']).to eq(product.name)
+ expect(parsed['id']).to eq(product.prefix_id)
+ end
+
+ it 'serializes Order to JSON' do
+ json = helper.serialize_to_json(order, api_type: :store)
+ expect(json).to be_present
+ parsed = JSON.parse(json)
+ expect(parsed['number']).to eq(order.number)
+ expect(parsed['id']).to eq(order.prefix_id)
+ end
+ end
+
+ context 'with admin api_type' do
+ it 'serializes Product with admin serializer' do
+ json = helper.serialize_to_json(product, api_type: :admin)
+ expect(json).to be_present
+ parsed = JSON.parse(json)
+ expect(parsed['name']).to eq(product.name)
+ end
+ end
+
+ it 'returns nil for record without serializer' do
+ # Create a mock model that doesn't have a serializer
+ unknown_class = Class.new do
+ def self.name
+ 'Spree::UnknownModel'
+ end
+ end
+ record = unknown_class.new
+
+ expect(helper.serialize_to_json(record, api_type: :store)).to be_nil
+ end
+ end
+end
diff --git a/api/spec/models/spree/api_dependencies_spec.rb b/api/spec/models/spree/api_dependencies_spec.rb
index 05317aba01..b5134f431b 100644
--- a/api/spec/models/spree/api_dependencies_spec.rb
+++ b/api/spec/models/spree/api_dependencies_spec.rb
@@ -1,7 +1,7 @@
require 'spec_helper'
class MyNewSerializer
- include JSONAPI::Serializer
+ include Alba::Resource
attributes :total
end
@@ -17,12 +17,12 @@ describe Spree::Api::ApiDependencies, type: :model do
describe 'backwards compatibility' do
it 'returns the default value as string' do
- expect(deps.storefront_cart_serializer).to eq('Spree::V2::Storefront::CartSerializer')
+ expect(deps.order_serializer).to eq('Spree::Api::V3::OrderSerializer')
end
it 'allows to overwrite the value' do
- deps.storefront_cart_serializer = MyNewSerializer
- expect(deps.storefront_cart_serializer).to eq MyNewSerializer
+ deps.order_serializer = MyNewSerializer
+ expect(deps.order_serializer).to eq MyNewSerializer
end
it 'respects global dependencies' do
@@ -40,12 +40,12 @@ describe Spree::Api::ApiDependencies, type: :model do
describe '#<dependency>_class' do
it 'returns the constantized class for string values' do
- expect(deps.storefront_cart_serializer_class).to eq Spree::V2::Storefront::CartSerializer
+ expect(deps.order_serializer_class).to eq Spree::Api::V3::OrderSerializer
end
it 'returns the class directly when set as class' do
- deps.storefront_cart_serializer = MyNewSerializer
- expect(deps.storefront_cart_serializer_class).to eq MyNewSerializer
+ deps.order_serializer = MyNewSerializer
+ expect(deps.order_serializer_class).to eq MyNewSerializer
end
it 'resolves proc-based dependencies from core' do
@@ -79,12 +79,12 @@ end
describe 'Spree.api accessor' do
describe 'Spree.api.<dependency>' do
it 'returns the resolved class' do
- expect(Spree.api.storefront_cart_serializer).to eq Spree::V2::Storefront::CartSerializer
+ expect(Spree.api.order_serializer).to eq Spree::Api::V3::OrderSerializer
end
it 'responds to dependency methods' do
- expect(Spree.api.respond_to?(:storefront_cart_serializer)).to be true
- expect(Spree.api.respond_to?(:storefront_cart_serializer=)).to be true
+ expect(Spree.api.respond_to?(:order_serializer)).to be true
+ expect(Spree.api.respond_to?(:order_serializer=)).to be true
end
it 'does not respond to non-dependency methods' do
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 1b27e074e5..2f1b22ca98 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -748,7 +748,9 @@ en:
api_key: API Key
api_keys: API Keys
apis:
+ admin: Admin API
platform: Platform API
+ store: Store API
storefront: Storefront API
applied_to: Applied to
apply: Apply