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.

Changed typed preferences code to share one path per job

Damian Legawiecdd3c056c2873
diff --git a/packages/dashboard-core/src/components/preferences-form.tsx b/packages/dashboard-core/src/components/preferences-form.tsx
index 2d1ca5da69..a57e6b1040 100644
--- a/packages/dashboard-core/src/components/preferences-form.tsx
+++ b/packages/dashboard-core/src/components/preferences-form.tsx
@@ -52,6 +52,23 @@ export interface PreferenceFieldDef {
}
const DECIMAL_PATTERN = '^-?\\d+(\\.\\d+)?$'
+const DECIMAL_REGEX = new RegExp(DECIMAL_PATTERN)
+
+/**
+ * The schema with only the settings `keep` accepts — for a form that edits
+ * the others with a control of its own.
+ */
+export function filterPreferenceSchema(
+ schema: PreferenceSchema,
+ keep: (key: string, property: PreferencePropertySchema) => boolean,
+): PreferenceSchema {
+ return {
+ ...schema,
+ properties: Object.fromEntries(
+ Object.entries(schema.properties).filter(([key, property]) => keep(key, property)),
+ ),
+ }
+}
function fieldType(property: PreferencePropertySchema): string {
if (property['x-spree-secret']) return 'password'
@@ -501,7 +518,7 @@ function NumberPreferenceInput({
if (Number.isInteger(number)) onChange(number)
return
}
- onChange(new RegExp(DECIMAL_PATTERN).test(trimmed) ? trimmed : String(number))
+ onChange(DECIMAL_REGEX.test(trimmed) ? trimmed : String(number))
}
return (
diff --git a/packages/dashboard/src/components/spree/shipping/delivery-method-form.tsx b/packages/dashboard/src/components/spree/shipping/delivery-method-form.tsx
index 2c8434b9d2..2bb9420149 100644
--- a/packages/dashboard/src/components/spree/shipping/delivery-method-form.tsx
+++ b/packages/dashboard/src/components/spree/shipping/delivery-method-form.tsx
@@ -12,6 +12,7 @@ import {
Can,
currencyParts,
defaultPreferences,
+ filterPreferenceSchema,
PreferencesForm,
ResourceMultiAutocomplete,
Subject,
@@ -1039,17 +1040,13 @@ function PricingCard({ form }: { form: UseFormReturn<DeliveryMethodFormValues> }
// rendered by the editor below rather than one-by-one from the schema. The
// rest of its preferences (weight and total bounds) still render generically.
const amountBased = AMOUNT_BASED_CALCULATORS.includes(calculatorType ?? '')
- const genericSchema =
- amountBased && preferenceSchema
- ? {
- ...preferenceSchema,
- properties: Object.fromEntries(
- Object.entries(preferenceSchema.properties).filter(
- ([key]) => !CURRENCY_AMOUNT_KEYS.includes(key),
- ),
- ),
- }
- : preferenceSchema
+ const genericSchema = useMemo(
+ () =>
+ amountBased && preferenceSchema
+ ? filterPreferenceSchema(preferenceSchema, (key) => !CURRENCY_AMOUNT_KEYS.includes(key))
+ : preferenceSchema,
+ [amountBased, preferenceSchema],
+ )
const taxCategoryOptions = [
{ value: '', label: t('admin.common.none') },
diff --git a/packages/dashboard/src/schemas/delivery-method.ts b/packages/dashboard/src/schemas/delivery-method.ts
index 5415714ca3..35aa79bed3 100644
--- a/packages/dashboard/src/schemas/delivery-method.ts
+++ b/packages/dashboard/src/schemas/delivery-method.ts
@@ -86,6 +86,14 @@ export const DELIVERY_METHOD_DEFAULTS: DeliveryMethodFormValues = {
services: [],
}
+/** The `calculator` part of a write, or nothing when the form names neither a type nor a setting. */
+function calculatorParams({ type, preferences }: DeliveryMethodFormValues['calculator']) {
+ const hasPreferences = !!preferences && Object.keys(preferences).length > 0
+ if (!type && !hasPreferences) return {}
+ return {
+ calculator: { type: type || undefined, preferences: hasPreferences ? preferences : undefined },
+ }
+}
export function deliveryMethodValuesToParams(values: DeliveryMethodFormValues) {
return {
name: values.name,
@@ -103,18 +111,7 @@ export function deliveryMethodValuesToParams(values: DeliveryMethodFormValues) {
? Number(values.estimated_transit_business_days_max)
: null,
tax_category_id: values.tax_category_id || null,
- ...(values.calculator.type ||
- (values.calculator.preferences && Object.keys(values.calculator.preferences).length > 0)
- ? {
- calculator: {
- ...(values.calculator.type ? { type: values.calculator.type } : {}),
- ...(values.calculator.preferences &&
- Object.keys(values.calculator.preferences).length > 0
- ? { preferences: values.calculator.preferences }
- : {}),
- },
- }
- : {}),
+ ...calculatorParams(values.calculator),
delivery_zone_id: values.delivery_zone_id || null,
stock_location_ids: values.stock_location_ids,
// Rules ride along with the method so one request saves the whole page.
diff --git a/packages/seller-dashboard/src/pages/delivery-methods.tsx b/packages/seller-dashboard/src/pages/delivery-methods.tsx
index 6536154f3b..7ab569dd34 100644
--- a/packages/seller-dashboard/src/pages/delivery-methods.tsx
+++ b/packages/seller-dashboard/src/pages/delivery-methods.tsx
@@ -1,5 +1,6 @@
import {
defaultPreferences,
+ filterPreferenceSchema,
PageHeader,
PreferencesForm,
type ResourceSearch,
@@ -642,8 +643,8 @@ function DeliveryMethodSheet({
function renderableSchema(schema: PreferenceSchema | undefined): PreferenceSchema | undefined {
if (!schema) return undefined
- const properties = Object.entries(schema.properties).filter(
- ([, property]) => typeof property.additionalProperties !== 'object',
+ return filterPreferenceSchema(
+ schema,
+ (_key, property) => typeof property.additionalProperties !== 'object',
)
- return { ...schema, properties: Object.fromEntries(properties) }
}
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb
index f8a3ba72eb..3c06b5820c 100644
--- a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb
+++ b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb
@@ -290,11 +290,8 @@ module Spree
# A setting the API reads and writes under its plain name reports its
# errors under that name too, never the `preferred_` one the model uses.
def wire_error_attribute(errors, attribute)
- name = attribute.to_s.delete_prefix('preferred_')
- return attribute if name == attribute.to_s
-
record_class = errors.objects.first&.base&.class
- record_class.respond_to?(:exposed_preference?) && record_class.exposed_preference?(name) ? name.to_sym : attribute
+ (record_class.exposed_preference_name(attribute) if record_class.respond_to?(:exposed_preference_name)) || attribute
end
# Infer error code from context
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/legacy_preference_params.rb b/spree/api/app/controllers/concerns/spree/api/v3/legacy_preference_params.rb
index a069a4d608..4d044a35b1 100644
--- a/spree/api/app/controllers/concerns/spree/api/v3/legacy_preference_params.rb
+++ b/spree/api/app/controllers/concerns/spree/api/v3/legacy_preference_params.rb
@@ -19,8 +19,8 @@ module Spree
def translate_legacy_preference_params(model)
params.keys.each do |key|
- name = key.to_s.delete_prefix('preferred_')
- next if name == key.to_s || params.key?(name) || !model.exposed_preference?(name)
+ name = model.exposed_preference_name(key)&.to_s
+ next if name.nil? || params.key?(name)
Spree::Deprecation.warn("The `#{key}` parameter is deprecated and will be removed in Spree 6.1. Send `#{name}` instead.")
params[name] = params.delete(key)
diff --git a/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
index 3bf0c0a28e..25d4bca70f 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
@@ -80,7 +80,7 @@ module Spree
def create
@resource = model_class.new(assignable_params)
authorize_resource!(@resource, :create)
- assign_calculator(@resource)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
if @resource.errors.empty? && @resource.save
render json: serialize_resource(@resource), status: :created
@@ -91,7 +91,7 @@ module Spree
def update
@resource.assign_attributes(assignable_params)
- assign_calculator(@resource)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
if @resource.errors.empty? && @resource.save
render json: serialize_resource(@resource)
@@ -200,40 +200,6 @@ module Spree
where(id: decode_prefixed_ids(ids)).
pluck(:id)
end
-
- def assign_calculator(delivery_method)
- calculator_type = permitted_params.dig(:calculator, :type)
- preferences = permitted_params.dig(:calculator, :preferences)
-
- if calculator_type.present? && delivery_method.calculator&.class&.api_type != calculator_type
- selected_calculator_class = Spree::DeliveryMethod.calculators.find do |klass|
- klass.api_type == calculator_type
- end
- unless selected_calculator_class
- delivery_method.errors.add(:calculator, :invalid)
- return
- end
-
- delivery_method.calculator = selected_calculator_class.new
- end
-
- return if preferences.blank?
-
- # A payload may carry preferences without naming a calculator —
- # editing the amount on a method that already has one, or creating
- # with the default. The model only builds the default calculator
- # at validation, so without this the preferences land on nothing
- # and the amount the merchant typed is silently replaced by a free
- # rate.
- delivery_method.ensure_calculator
- return if delivery_method.calculator.nil?
-
- begin
- delivery_method.calculator.assign_preferences(preferences)
- rescue Spree::Preferences::InvalidPreferences => e
- raise e.within('/calculator')
- end
- end
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/seller/delivery_methods_controller.rb b/spree/api/app/controllers/spree/api/v3/seller/delivery_methods_controller.rb
index dedc4251aa..e621062774 100644
--- a/spree/api/app/controllers/spree/api/v3/seller/delivery_methods_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/seller/delivery_methods_controller.rb
@@ -64,7 +64,7 @@ module Spree
@resource.assign_attributes(assignable_params)
authorize_resource!(@resource, :create)
rederive_origin_group(@resource)
- assign_calculator(@resource)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
if @resource.errors.empty? && @resource.save
render json: serialize_resource(@resource), status: :created
@@ -76,7 +76,7 @@ module Spree
def update
@resource.assign_attributes(assignable_params)
rederive_origin_group(@resource)
- assign_calculator(@resource)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
if @resource.errors.empty? && @resource.save
render json: serialize_resource(@resource)
@@ -217,46 +217,6 @@ module Spree
row
end
end
-
- def assign_calculator(delivery_method)
- calculator_type = permitted_params.dig(:calculator, :type)
- preferences = permitted_params.dig(:calculator, :preferences)
-
- if calculator_type.present? && delivery_method.calculator&.class&.api_type != calculator_type
- registered = Spree::DeliveryMethod.calculators.find do |klass|
- klass.api_type == calculator_type
- end
- unless registered
- delivery_method.errors.add(:calculator, :invalid)
- return
- end
-
- # Resolved from the registry entry's OWN name, never the
- # request's: nothing user-supplied reaches `constantize`. Going
- # back through the name rather than instantiating `registered`
- # directly is what survives a reload — in development the
- # registry holds a class from an earlier one, and an instance of
- # it fails the association's type check.
- delivery_method.calculator = registered.to_s.constantize.new
- end
-
- return if preferences.blank?
-
- # A payload may carry preferences without naming a calculator —
- # editing the amount on a method that already has one, or creating
- # with the default. The model only builds the default calculator
- # at validation, so without this the preferences land on nothing
- # and the amount the merchant typed is silently replaced by a free
- # rate.
- delivery_method.ensure_calculator
- return if delivery_method.calculator.nil?
-
- begin
- delivery_method.calculator.assign_preferences(preferences)
- rescue Spree::Preferences::InvalidPreferences => e
- raise e.within('/calculator')
- end
- end
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
index 911fb7310f..043e3f7919 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
@@ -10,7 +10,7 @@ module Spree
attributes created_at: :iso8601, updated_at: :iso8601
- preference_attributes Spree::Channel, :storefront_access, :guest_checkout
+ preference_attributes Spree::Channel, except: %i[order_routing_strategy]
api_type_attributes :order_routing_strategy
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
index 23426dae33..a88945c941 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
@@ -32,23 +32,10 @@ module Spree
api_type_attributes :order_routing_strategy, :payout_provider
- preference_attributes Spree::Store,
- :storefront_url, :send_consumer_transactional_emails, :email_accent_color,
- :email_background_color, :email_card_color, :email_text_color, :email_heading_color,
- :email_font, :admin_locale, :timezone, :weight_unit, :unit_system, :storefront_access,
- :guest_checkout, :always_include_confirm_step, :company_field_enabled,
- :address_requires_company, :address_requires_phone, :capture_method,
- :track_inventory_levels, :stock_reservations_enabled, :low_stock_threshold,
- :tax_using_ship_address, :track_price_history, :show_products_without_price,
- :disable_sku_validation, :pricing_provider, :inventory_provider,
- :pricing_provider_failure_policy, :inventory_provider_failure_policy,
- :default_payouts_schedule_interval,
- :auto_approve_sellers, :auto_approve_seller_products,
- :send_seller_transactional_emails,
- :document_number_format, :order_number_prefix, :order_number_suffix,
- :order_number_sequence_start, :limit_digital_download_count,
- :digital_asset_authorized_clicks, :limit_digital_download_days,
- :digital_asset_authorized_days
+ # The first two read through `api_type_attributes` above; the money
+ # and rate settings are formatted below.
+ preference_attributes Spree::Store, except: %i[order_routing_strategy payout_provider
+ default_minimum_payout_amount default_commission_tax_rate]
# Once the counter has issued a number the starting value no longer
# applies, so the settings page can say that instead of accepting a
diff --git a/spree/api/app/serializers/spree/api/v3/base_serializer.rb b/spree/api/app/serializers/spree/api/v3/base_serializer.rb
index 4bd9bfdc2f..a3ec20a139 100644
--- a/spree/api/app/serializers/spree/api/v3/base_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/base_serializer.rb
@@ -88,17 +88,20 @@ module Spree
end
# Declares a model's settings under their plain names (see
- # `exposes_preferences`), typed from their declarations so the
- # generated SDK types never drift from the model. Each reads the
- # stored setting, never a reader the model overrides with a fallback.
+ # `exposes_preferences`) — every exposed one unless named — typed from
+ # their declarations so the generated SDK types never drift from the
+ # model. Each reads the stored setting, never a reader the model
+ # overrides with a fallback.
#
- # preference_attributes Spree::Store, :guest_checkout, :timezone
- def self.preference_attributes(model, *names)
+ # preference_attributes Spree::Store, except: %i[payout_provider]
+ def self.preference_attributes(model, *names, except: [])
+ names = model.exposed_preference_names.to_a - except if names.empty?
definitions = model.preference_definitions
names.each do |name|
typelize name => preference_type_hint(Spree::PreferenceSchema::JsonSchema.property_schema(definitions.fetch(name)))
+ reader = :"preferred_#{name}"
attribute(name) do |object|
- value = object.public_send(:"preferred_#{name}")
+ value = object.public_send(reader)
value.is_a?(BigDecimal) ? value.to_s('F') : value
end
end
diff --git a/spree/api/spec/lib/spree/api/preference_conformance_spec.rb b/spree/api/spec/lib/spree/api/preference_conformance_spec.rb
index 479018a8a6..6bc7c39fc3 100644
--- a/spree/api/spec/lib/spree/api/preference_conformance_spec.rb
+++ b/spree/api/spec/lib/spree/api/preference_conformance_spec.rb
@@ -22,7 +22,7 @@ RSpec.describe 'Preference contract conformance' do
it 'refuses a key the schema does not list' do
classes.each do |klass|
- expect { klass.new.assign_preferences('not_a_setting' => 'x') }
+ expect { klass.new.assign_preferences({ 'not_a_setting' => 'x' }) }
.to raise_error(Spree::Preferences::InvalidPreferences), "#{klass.name} accepted an unknown key"
end
end
@@ -32,7 +32,7 @@ RSpec.describe 'Preference contract conformance' do
klass.preference_json_schema['properties'].each do |key, property|
next unless property.dig('items', 'format') == 'prefixed-id'
- expect { klass.new.assign_preferences(key => ['zz_86Rf07xd4z']) }
+ expect { klass.new.assign_preferences({ key => ['zz_86Rf07xd4z'] }) }
.to raise_error(Spree::Preferences::InvalidPreferences, %r{/preferences/#{key}/0}), "#{klass.name}##{key} accepted a foreign id"
end
end
@@ -47,10 +47,10 @@ RSpec.describe 'Preference contract conformance' do
record.set_preference(key, 'sk_test_0123456789')
masked = Spree::Preferences::Masking.serialize(record)[key]
- record.assign_preferences(key => masked)
+ record.assign_preferences({ key => masked })
expect(record.get_preference(key)).to eq('sk_test_0123456789'), "#{klass.name}##{key} overwrote a secret with its mask"
- record.assign_preferences(key => nil)
+ record.assign_preferences({ key => nil })
expect(Spree::Preferences::Masking.serialize(record)[key]).to be_nil, "#{klass.name}##{key} kept a secret set to null"
end
end
diff --git a/spree/core/app/models/concerns/spree/calculated_adjustments.rb b/spree/core/app/models/concerns/spree/calculated_adjustments.rb
index b57eae51f5..668b30f05b 100644
--- a/spree/core/app/models/concerns/spree/calculated_adjustments.rb
+++ b/spree/core/app/models/concerns/spree/calculated_adjustments.rb
@@ -32,21 +32,34 @@ module Spree
end
# API v3 writer for the `calculator: { type:, preferences: {} }`
- # payload. Preferences are checked against the calculator's schema and
- # written through its typed writers.
- def assign_calculator_attributes(attrs)
+ # payload. A type the registry does not list is an error on
+ # `calculator`; preferences are checked against the calculator's schema
+ # and written through its typed writers.
+ #
+ # @param attrs [Hash, ActionController::Parameters, nil]
+ # @param pointer [String] where the calculator sits in the request
+ # @return [void]
+ def assign_calculator_attributes(attrs, pointer: '/calculator')
return if attrs.nil?
attrs = attrs.to_h.with_indifferent_access
- self.calculator_type = attrs[:type] if attrs[:type].present?
+ type = attrs[:type].to_s
+ if type.present? && calculator&.class&.api_type != type
+ registry = self.class.respond_to?(:calculators) ? self.class.calculators : []
+ registered = registry.find { |klass| klass.api_type == type }
+ return errors.add(:calculator, :invalid) unless registered
- return if calculator.nil? || attrs[:preferences].blank?
-
- begin
- calculator.assign_preferences(attrs[:preferences])
- rescue Spree::Preferences::InvalidPreferences => e
- raise e.within('/calculator')
+ # Resolved from the registry entry's own name, never the request's:
+ # in development the registry can hold a class from an earlier
+ # reload, whose instances fail the association's type check.
+ self.calculator = registered.to_s.constantize.new
end
+ return if attrs[:preferences].blank?
+
+ # Preferences sent without a type land on the default calculator
+ # rather than on nothing, where the model builds one.
+ ensure_calculator if respond_to?(:ensure_calculator, true)
+ calculator&.assign_preferences(attrs[:preferences], pointer: "#{pointer}/preferences")
end
private
diff --git a/spree/core/app/models/concerns/spree/preference_schema.rb b/spree/core/app/models/concerns/spree/preference_schema.rb
index ce6475c8b5..84209049a8 100644
--- a/spree/core/app/models/concerns/spree/preference_schema.rb
+++ b/spree/core/app/models/concerns/spree/preference_schema.rb
@@ -78,12 +78,11 @@ module Spree
# @return [Array<Hash{Symbol => String}>] `{ pointer:, message: }` per failure, empty when it matches
def preference_failures(values)
schema = preference_json_schema
- # Rebuilt whenever the schema is, so a schema computed before the
- # database was up is not validated against for the life of the process.
- @preference_schemer = nil unless @preference_schemer_source.equal?(schema)
- @preference_schemer_source = schema
- @preference_schemer ||= JSONSchemer.schema(schema)
- @preference_schemer.validate(values).map do |error|
+ # Keyed by the schema itself, so one computed before the database was
+ # up is not validated against for the life of the process.
+ @preference_schemers = {}.compare_by_identity unless @preference_schemers&.key?(schema)
+ schemer = @preference_schemers[schema] ||= JSONSchemer.schema(schema)
+ schemer.validate(values).map do |error|
{ pointer: error['data_pointer'], message: error['error'] }
end
end
diff --git a/spree/core/app/models/concerns/spree/typed_associations.rb b/spree/core/app/models/concerns/spree/typed_associations.rb
index 010e9e3006..dc94c832ca 100644
--- a/spree/core/app/models/concerns/spree/typed_associations.rb
+++ b/spree/core/app/models/concerns/spree/typed_associations.rb
@@ -79,11 +79,9 @@ module Spree
deferred_ids, scalar_attrs = attrs.partition { |k, _| record.new_record? && k.to_s.end_with?('_ids') }
record.assign_attributes(scalar_attrs.to_h) if scalar_attrs.any?
- begin
- record.assign_preferences(preferences) if preferences
- record.assign_calculator_attributes(calculator) if calculator.present? && record.respond_to?(:assign_calculator_attributes)
- rescue Spree::Preferences::InvalidPreferences => e
- raise e.within(pointer)
+ record.assign_preferences(preferences, pointer: "#{pointer}/preferences") if preferences
+ if calculator.present? && record.respond_to?(:assign_calculator_attributes)
+ record.assign_calculator_attributes(calculator, pointer: "#{pointer}/calculator")
end
# Always save — `record.changed?` doesn't reflect preferences
diff --git a/spree/core/lib/spree/core/preferences/invalid_preferences.rb b/spree/core/lib/spree/core/preferences/invalid_preferences.rb
index 352fc83aac..1142797ea0 100644
--- a/spree/core/lib/spree/core/preferences/invalid_preferences.rb
+++ b/spree/core/lib/spree/core/preferences/invalid_preferences.rb
@@ -13,15 +13,6 @@ module Spree
@failures = failures.map { |failure| failure.merge(pointer: "#{prefix}#{failure[:pointer]}") }
super(@failures.map { |failure| "#{failure[:pointer]}: #{failure[:message]}" }.join('; '))
end
-
- # The same failures, for preferences nested deeper in the request — a
- # rule in a list (`/rules/1`) or a calculator (`/calculator`).
- #
- # @param prefix [String]
- # @return [InvalidPreferences]
- def within(prefix)
- self.class.new(failures, prefix: prefix)
- end
end
end
end
diff --git a/spree/core/lib/spree/core/preferences/preferable.rb b/spree/core/lib/spree/core/preferences/preferable.rb
index 7a0b75ce07..859f56e43f 100644
--- a/spree/core/lib/spree/core/preferences/preferable.rb
+++ b/spree/core/lib/spree/core/preferences/preferable.rb
@@ -18,9 +18,14 @@ require 'spree/core/preferences/preferable_class_methods'
module Spree::Preferences::Preferable
extend ActiveSupport::Concern
+ BOOLEAN_TYPE = ActiveModel::Type::Boolean.new
+
included do
serialize :preferences, coder: Spree::Metadata::HashSerializer
extend Spree::Preferences::PreferableClassMethods
+
+ # The preferences read and written under their plain names (see `exposes_preferences`).
+ class_attribute :exposed_preference_names, instance_accessor: false, default: Set.new.freeze
end
# JSON keeps decimals and times as strings; the declared type turns them
@@ -159,13 +164,15 @@ module Spree::Preferences::Preferable
# sent back masked, as it was read, keeps the stored one; `null` clears it.
#
# @param values [Hash, ActionController::Parameters]
+ # @param pointer [String] where the preferences object sits in the request,
+ # e.g. `/rules/1/preferences`, so a failure names its place
# @raise [Spree::Preferences::InvalidPreferences] naming every value that does not match
# @return [void]
- def assign_preferences(values)
+ def assign_preferences(values, pointer: '/preferences')
values = values.respond_to?(:to_unsafe_h) ? values.to_unsafe_h : values.to_h
values = values.deep_stringify_keys
failures = self.class.preference_failures(values)
- raise Spree::Preferences::InvalidPreferences, failures if failures.any?
+ raise Spree::Preferences::InvalidPreferences.new(failures, prefix: pointer) if failures.any?
values.each do |key, value|
next if secret_preference?(key) && Spree::Preferences::Masking.masked?(value)
@@ -173,7 +180,7 @@ module Spree::Preferences::Preferable
begin
set_preference(key, value)
rescue ActiveRecord::RecordNotFound => e
- raise Spree::Preferences::InvalidPreferences, [{ pointer: "/#{key}", message: e.message }]
+ raise Spree::Preferences::InvalidPreferences.new([{ pointer: "/#{key}", message: e.message }], prefix: pointer)
end
end
end
@@ -188,8 +195,7 @@ module Spree::Preferences::Preferable
# @return [Object]
def wire_preference_value(value, definition)
return BigDecimal(value.to_s).as_json if definition[:type] == :decimal && value.is_a?(Numeric)
- return value if value.nil? || definition[:of] == :id
- return value if definition[:type] == :array && !value.is_a?(Array)
+ return value if value.nil? || (definition[:type] == :array && !value.is_a?(Array))
cast_preference_contents(value, definition)
end
@@ -281,7 +287,7 @@ module Spree::Preferences::Preferable
when :string then value.to_s
when :integer then Integer(value.to_s, 10, exception: false) || value
when :decimal, :money then BigDecimal(value.to_s, exception: false)&.as_json || value
- when :boolean then ActiveModel::Type::Boolean.new.cast(value)
+ when :boolean then BOOLEAN_TYPE.cast(value)
else value
end
end
@@ -302,11 +308,8 @@ module Spree::Preferences::Preferable
# @raise [ActiveRecord::RecordNotFound] naming the ids that were not found
def decode_preference_ids(values, definition)
model = Spree::Preferences::Preferable.preference_model(definition)
- prefix = "#{model._prefix_id_prefix}_"
ids = split_preference_list(values).map(&:to_s).map do |id|
- next id unless Spree::PrefixedId.prefixed_id?(id)
-
- id.start_with?(prefix) ? Spree::PrefixedId.decode_prefixed_id(id).to_s : id
+ Spree::PrefixedId.prefixed_id?(id) ? (model.decode_prefixed_id(id)&.to_s || id) : id
end
return ids if ids.empty?
diff --git a/spree/core/lib/spree/core/preferences/preferable_class_methods.rb b/spree/core/lib/spree/core/preferences/preferable_class_methods.rb
index 136ab5fc80..a51dc95ad0 100644
--- a/spree/core/lib/spree/core/preferences/preferable_class_methods.rb
+++ b/spree/core/lib/spree/core/preferences/preferable_class_methods.rb
@@ -38,10 +38,9 @@ module Spree::Preferences
end
# The value types a list item, a hash value or an object property may
- # declare, and the formats a string may carry. They are what
- # {Spree::PreferenceSchema::JsonSchema} compiles to JSON Schema.
+ # declare — what {Spree::PreferenceSchema::JsonSchema} compiles to JSON
+ # Schema, along with its `FORMATS`.
ITEM_TYPES = %i[string integer decimal money boolean id object].freeze
- FORMATS = %i[currency iso_country timezone locale url color].freeze
# Declares a typed preference with a `preferred_<name>` reader and writer
# and a `prefers_<name>?` query. On a model, the value lives in the
@@ -68,7 +67,7 @@ module Spree::Preferences
# @option options [Symbol] :values the type of a `:hash`'s values
# @option options [Hash{Symbol => Symbol}] :properties the fields of each `of: :object` item
# @option options [Boolean] :money a `:decimal` that is an amount of money
- # @option options [Symbol] :format a string's domain format (see {FORMATS})
+ # @option options [Symbol] :format a string's domain format (see {Spree::PreferenceSchema::JsonSchema::FORMATS})
# @option options [String, Proc] :model the record class an `of: :id` list points at
# @option options [Proc] :scope `->(owner) { relation }` the ids must be found in
# @option options [Array, Proc] :choices the fixed set a value must come from
@@ -150,18 +149,18 @@ module Spree::Preferences
define_method(name) { public_send(:"preferred_#{name}") }
define_method(:"#{name}=") { |value| public_send(:"preferred_#{name}=", value) }
- own_exposed_preference_names << name
end
+ self.exposed_preference_names = (exposed_preference_names | names.map(&:to_sym)).freeze
end
- # Whether the preference is read and written under its plain name, so an
- # error on `preferred_<name>` can be reported as `<name>`.
+ # The plain name an exposed preference goes by, for a key still using the
+ # DSL's `preferred_` prefix — an error key or a 5.x request parameter.
#
- # @param name [Symbol, String]
- # @return [Boolean]
- def exposed_preference?(name)
- own_exposed_preference_names.include?(name.to_sym) ||
- (superclass.respond_to?(:exposed_preference?) && superclass.exposed_preference?(name))
+ # @param key [Symbol, String] e.g. `preferred_guest_checkout`
+ # @return [Symbol, nil] e.g. `:guest_checkout`, or nil when the key names no exposed preference
+ def exposed_preference_name(key)
+ name = key.to_s.delete_prefix('preferred_')
+ name.to_sym if name != key.to_s && exposed_preference_names.include?(name.to_sym)
end
private
@@ -182,7 +181,9 @@ module Spree::Preferences
[options[:of], options[:values], *options[:properties]&.values].compact.each do |item_type|
raise ArgumentError, "Unknown item type `#{item_type}` on preference `#{name}`" unless ITEM_TYPES.include?(item_type)
end
- raise ArgumentError, "Unknown format `#{options[:format]}` on preference `#{name}`" if options[:format] && FORMATS.exclude?(options[:format])
+ if options[:format] && !Spree::PreferenceSchema::JsonSchema::FORMATS.key?(options[:format])
+ raise ArgumentError, "Unknown format `#{options[:format]}` on preference `#{name}`"
+ end
raise ArgumentError, "`of: :id` needs `model:` on preference `#{name}`" if options[:of] == :id && options[:model].blank?
raise ArgumentError, "`of: :object` needs `properties:` on preference `#{name}`" if options[:of] == :object && options[:properties].blank?
@@ -199,10 +200,6 @@ module Spree::Preferences
)
end
- def own_exposed_preference_names
- @own_exposed_preference_names ||= Set.new
- end
-
def own_preference_definitions
@own_preference_definitions ||= {}
end
diff --git a/spree/core/spec/models/spree/preferences/preferable_spec.rb b/spree/core/spec/models/spree/preferences/preferable_spec.rb
index d440630c61..8c2f169594 100644
--- a/spree/core/spec/models/spree/preferences/preferable_spec.rb
+++ b/spree/core/spec/models/spree/preferences/preferable_spec.rb
@@ -490,28 +490,28 @@ describe Spree::Preferences::Preferable, type: :model do
describe '#assign_preferences' do
it 'writes a payload that matches the schema' do
- record.assign_preferences('quantities' => [1, 2], 'channel_ids' => [channel.prefixed_id])
+ record.assign_preferences({ 'quantities' => [1, 2], 'channel_ids' => [channel.prefixed_id] })
expect(record.preferred_quantities).to eq([1, 2])
expect(record.preferences[:channel_ids]).to eq([channel.id.to_s])
end
it 'refuses the whole payload, naming each failing value, when any value does not match' do
- expect { record.assign_preferences('flavor' => 'mint', 'quantities' => ['many'], 'colour' => 'red') }.to raise_error(
+ expect { record.assign_preferences({ 'flavor' => 'mint', 'quantities' => ['many'], 'colour' => 'red' }) }.to raise_error(
Spree::Preferences::InvalidPreferences
) { |error| expect(error.failures.pluck(:pointer)).to contain_exactly('/preferences/quantities/0', '/preferences/colour') }
expect(record.preferred_flavor).to eq('vanilla')
end
it 'refuses an id of another model by its prefix' do
- expect { record.assign_preferences('channel_ids' => ["mkt_#{Spree::PrefixedId::SQIDS.encode([channel.id])}"]) }
+ expect { record.assign_preferences({ 'channel_ids' => ["mkt_#{Spree::PrefixedId::SQIDS.encode([channel.id])}"] }) }
.to raise_error(Spree::Preferences::InvalidPreferences, %r{/preferences/channel_ids/0})
end
it 'refuses an id outside the declared scope' do
other_channel = create(:channel, store: create(:store))
- expect { record.assign_preferences('channel_ids' => [other_channel.prefixed_id]) }
+ expect { record.assign_preferences({ 'channel_ids' => [other_channel.prefixed_id] }) }
.to raise_error(Spree::Preferences::InvalidPreferences, %r{/preferences/channel_ids})
end
end