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
Manually specify `event_serializer_class` for Reports/Exports/Imports (#13523)
Damian Legawiecdc75c4a7254d
diff --git a/core/app/models/spree/export.rb b/core/app/models/spree/export.rbindex d738c91a84..04c7f790f6 100644--- a/core/app/models/spree/export.rb+++ b/core/app/models/spree/export.rb@@ -57,6 +57,10 @@ module Spree#attribute :record_selection, :string, default: 'filtered'+ def event_serializer_class+ Spree::Events::ExportSerializer+ end+def done?attachment.present? && attachment.attached?end@@ -196,7 +200,7 @@ module Spreedef model_classklass = "Spree::#{to_s.demodulize.singularize}".safe_constantize- raise NameError, "Missing model class for #{to_s}" unless klass+ raise NameError, "Missing model class for #{self}" unless klassklassenddiff --git a/core/app/models/spree/import.rb b/core/app/models/spree/import.rbindex 2b3123e7b3..dfee95a2e5 100644--- a/core/app/models/spree/import.rb+++ b/core/app/models/spree/import.rb@@ -225,6 +225,10 @@ module Spree@current_ability ||= Spree.ability_class.new(user, { store: store })end+ def event_serializer_class+ Spree::Events::ImportSerializer+ end+class << self# Returns the available types for the import# @return [Array<Class>]diff --git a/core/app/models/spree/report.rb b/core/app/models/spree/report.rbindex 359200ff5e..fa648e1436 100644--- a/core/app/models/spree/report.rb+++ b/core/app/models/spree/report.rb@@ -31,6 +31,10 @@ module Spree#has_one_attached :attachment, service: Spree.private_storage_service_name+ def event_serializer_class+ Spree::Events::ReportSerializer+ end+def self.report_typename.demodulize.underscoreenddiff --git a/core/spec/models/spree/export_spec.rb b/core/spec/models/spree/export_spec.rbindex d902c5341d..eef15ae2d5 100644--- a/core/spec/models/spree/export_spec.rb+++ b/core/spec/models/spree/export_spec.rb@@ -9,6 +9,12 @@ RSpec.describe Spree::Export, :job, type: :model dolet(:search_params) { nil }let(:export) { build(:product_export, store: store, user: user, format: 'csv', search_params: search_params) }+ describe '#event_serializer_class' do+ it 'returns the correct event serializer class' do+ expect(export.event_serializer_class).to eq(Spree::Events::ExportSerializer)+ end+ end+describe '#model_class' doit 'returns the correct record class' doexpect(export.model_class).to eq(Spree::Product)diff --git a/core/spec/models/spree/import_spec.rb b/core/spec/models/spree/import_spec.rbindex ac3cd410a7..dd021f08b2 100644--- a/core/spec/models/spree/import_spec.rb+++ b/core/spec/models/spree/import_spec.rb@@ -139,52 +139,52 @@ RSpec.describe Spree::Import, :job, type: :model dodescribe '#csv_headers' doit 'returns the CSV headers' doexpect(import.csv_headers).to eq([- 'slug',- 'sku',- 'name',- 'status',- 'vendor_name',- 'brand_name',- 'description',- 'meta_title',- 'meta_description',- 'meta_keywords',- 'tags',- 'labels',- 'price',- 'compare_at_price',- 'currency',- 'width',- 'height',- 'depth',- 'dimensions_unit',- 'weight',- 'weight_unit',- 'available_on',- 'discontinue_on',- 'track_inventory',- 'inventory_count',- 'inventory_backorderable',- 'tax_category',- 'digital',- 'image1_src',- 'image2_src',- 'image3_src',- 'option1_name',- 'option1_value',- 'option2_name',- 'option2_value',- 'option3_name',- 'option3_value',- 'category1',- 'category2',- 'category3',- 'metafield.properties.fit',- 'metafield.properties.manufacturer',- 'metafield.properties.material',- 'metafield.custom.brand',- 'metafield.custom.material'- ])+ 'slug',+ 'sku',+ 'name',+ 'status',+ 'vendor_name',+ 'brand_name',+ 'description',+ 'meta_title',+ 'meta_description',+ 'meta_keywords',+ 'tags',+ 'labels',+ 'price',+ 'compare_at_price',+ 'currency',+ 'width',+ 'height',+ 'depth',+ 'dimensions_unit',+ 'weight',+ 'weight_unit',+ 'available_on',+ 'discontinue_on',+ 'track_inventory',+ 'inventory_count',+ 'inventory_backorderable',+ 'tax_category',+ 'digital',+ 'image1_src',+ 'image2_src',+ 'image3_src',+ 'option1_name',+ 'option1_value',+ 'option2_name',+ 'option2_value',+ 'option3_name',+ 'option3_value',+ 'category1',+ 'category2',+ 'category3',+ 'metafield.properties.fit',+ 'metafield.properties.manufacturer',+ 'metafield.properties.material',+ 'metafield.custom.brand',+ 'metafield.custom.material'+ ])endcontext 'with custom delimiter' do@@ -307,7 +307,7 @@ RSpec.describe Spree::Import, :job, type: :model doendit 'returns columns that are not mapped' do- expect(import.unmapped_file_columns).to include("vendor_name", "brand_name", "labels", "metafield.properties.fit", "metafield.properties.manufacturer", "metafield.properties.material")+ expect(import.unmapped_file_columns).to include('vendor_name', 'brand_name', 'labels', 'metafield.properties.fit', 'metafield.properties.manufacturer', 'metafield.properties.material')expect(import.unmapped_file_columns).not_to include('slug')endend@@ -383,7 +383,13 @@ RSpec.describe Spree::Import, :job, type: :model doendend- describe 'custom events', events: true do+ describe '#event_serializer_class' do+ it 'returns the correct event serializer class' do+ expect(import.event_serializer_class).to eq(Spree::Events::ImportSerializer)+ end+ end++ describe 'custom events', :events dodescribe 'import.completed' dobefore doimport.save!diff --git a/core/spec/models/spree/report_spec.rb b/core/spec/models/spree/report_spec.rbindex a2bc7bfbc9..914b76a211 100644--- a/core/spec/models/spree/report_spec.rb+++ b/core/spec/models/spree/report_spec.rb@@ -12,7 +12,7 @@ RSpec.describe Spree::Report, type: :model doit 'returns formatted name with store, dates and report type' doexpected_name = [- "Sales total",+ 'Sales total',store.name,report.date_from.strftime('%Y-%m-%d'),report.date_to.strftime('%Y-%m-%d')@@ -22,6 +22,12 @@ RSpec.describe Spree::Report, type: :model doendend+ describe '#event_serializer_class' do+ it 'returns the correct serializer class' do+ expect(report.event_serializer_class).to eq(Spree::Events::ReportSerializer)+ end+ end+describe '#generate' dobefore { report.save! }