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 third review findings in the typed preferences contract

Damian Legawiec85faf6764df5
diff --git a/docs/developer/upgrades/5.6-to-6.0.mdx b/docs/developer/upgrades/5.6-to-6.0.mdx
index 2c2a77e569..aad2920a4c 100644
--- a/docs/developer/upgrades/5.6-to-6.0.mdx
+++ b/docs/developer/upgrades/5.6-to-6.0.mdx
@@ -549,7 +549,7 @@ Settings no longer reach the Admin and Seller APIs in the shape of Ruby's prefer
**Id lists read as prefixed ids.** Preferences listing records, such as a rule's `channel_ids` or `customer_group_ids`, now return prefixed ids rather than database ids, the same form a write accepts.
-**Delivery methods nest their calculator.** `calculator_type` and `calculator_preferences` are replaced by `calculator: { type, preferences }` on read and write, the shape promotion actions already use. Writes still accept the old two parameters until Spree 6.1, with a deprecation warning.
+**Delivery methods nest their calculator.** `calculator_type` and `calculator_preferences` are replaced by `calculator: { type, preferences }` on read and write, the shape promotion actions already use. Writes still accept the old two parameters until Spree 6.1, with a deprecation warning; their values follow the new rules (decimals as strings).
A preference marked deprecated, such as a flat rate calculator's `minimum_item_total`, is still accepted on write until its removal, with its deprecation warning, but is not read back.
diff --git a/packages/dashboard-core/src/components/preferences-form.tsx b/packages/dashboard-core/src/components/preferences-form.tsx
index f448c6ca0e..a57e6b1040 100644
--- a/packages/dashboard-core/src/components/preferences-form.tsx
+++ b/packages/dashboard-core/src/components/preferences-form.tsx
@@ -94,18 +94,15 @@ function fieldType(property: PreferencePropertySchema): string {
export function preferenceFields(
schema: PreferenceSchema | null | undefined,
): PreferenceFieldDef[] {
- // A deprecated setting is still accepted on write, but no form offers it.
- return Object.entries(schema?.properties ?? {})
- .filter(([, property]) => !property.deprecated)
- .map(([key, property]) => ({
- key,
- type: fieldType(property),
- format: property.format ?? property.items?.format,
- default: property.default ?? null,
- choices: property.enum?.filter((choice): choice is string => typeof choice === 'string'),
- nullable: Array.isArray(property.type) && property.type.includes('null'),
- schema: property,
- }))
+ return Object.entries(schema?.properties ?? {}).map(([key, property]) => ({
+ key,
+ type: fieldType(property),
+ format: property.format ?? property.items?.format,
+ default: property.default ?? null,
+ choices: property.enum?.filter((choice): choice is string => typeof choice === 'string'),
+ nullable: Array.isArray(property.type) && property.type.includes('null'),
+ schema: property,
+ }))
}
/**
diff --git a/packages/sdk-core/src/types.ts b/packages/sdk-core/src/types.ts
index aef101082d..38eff7dfd9 100644
--- a/packages/sdk-core/src/types.ts
+++ b/packages/sdk-core/src/types.ts
@@ -144,8 +144,6 @@ export interface PreferencePropertySchema {
'x-spree-prefix'?: string
/** A longer text, best edited in a multi-line field. */
'x-spree-widget'?: 'textarea'
- /** Still accepted on write until its removal, but never read back; don't offer it. */
- deprecated?: boolean
}
/**
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/admin/subclassed_resource.rb b/spree/api/app/controllers/concerns/spree/api/v3/admin/subclassed_resource.rb
index ea8ddeabf8..e353bac64f 100644
--- a/spree/api/app/controllers/concerns/spree/api/v3/admin/subclassed_resource.rb
+++ b/spree/api/app/controllers/concerns/spree/api/v3/admin/subclassed_resource.rb
@@ -62,11 +62,16 @@ module Spree
permitted = permitted_params_for(@resource.class)
attrs, preferences, calculator = extract_subclass_params(permitted)
- @resource.assign_attributes(attrs)
- apply_preferences(@resource, preferences) if preferences.present?
- apply_calculator(@resource, calculator) if calculator.present?
+ # A new calculator replaces the stored one as soon as it is
+ # assigned, so the whole update rolls back if anything is refused.
+ saved = model_class.transaction do
+ @resource.assign_attributes(attrs)
+ apply_preferences(@resource, preferences) if preferences.present?
+ apply_calculator(@resource, calculator) if calculator.present?
+ @resource.save || raise(ActiveRecord::Rollback)
+ end
- if @resource.save
+ if saved
render json: serialize_resource(@resource)
else
render_validation_error(@resource.errors)
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 4b8b7e43a1..02d03caf75 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
@@ -86,7 +86,7 @@ module Spree
authorize_resource!(@resource, :create)
@resource.assign_calculator_attributes(permitted_params[:calculator])
- if @resource.errors.empty? && @resource.save
+ if @resource.save
render json: serialize_resource(@resource), status: :created
else
render_validation_error(@resource.errors)
@@ -94,10 +94,15 @@ module Spree
end
def update
- @resource.assign_attributes(assignable_params)
- @resource.assign_calculator_attributes(permitted_params[:calculator])
+ # A new calculator replaces the stored one as soon as it is
+ # assigned, so the whole update rolls back if anything is refused.
+ saved = model_class.transaction do
+ @resource.assign_attributes(assignable_params)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
+ @resource.save || raise(ActiveRecord::Rollback)
+ end
- if @resource.errors.empty? && @resource.save
+ if saved
render json: serialize_resource(@resource)
else
render_validation_error(@resource.errors)
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 f55d9a741e..588f7848c6 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
@@ -70,7 +70,7 @@ module Spree
rederive_origin_group(@resource)
@resource.assign_calculator_attributes(permitted_params[:calculator])
- if @resource.errors.empty? && @resource.save
+ if @resource.save
render json: serialize_resource(@resource), status: :created
else
render_validation_error(@resource.errors)
@@ -78,11 +78,16 @@ module Spree
end
def update
- @resource.assign_attributes(assignable_params)
- rederive_origin_group(@resource)
- @resource.assign_calculator_attributes(permitted_params[:calculator])
+ # A new calculator replaces the stored one as soon as it is
+ # assigned, so the whole update rolls back if anything is refused.
+ saved = model_class.transaction do
+ @resource.assign_attributes(assignable_params)
+ rederive_origin_group(@resource)
+ @resource.assign_calculator_attributes(permitted_params[:calculator])
+ @resource.save || raise(ActiveRecord::Rollback)
+ end
- if @resource.errors.empty? && @resource.save
+ if saved
render json: serialize_resource(@resource)
else
render_validation_error(@resource.errors)
diff --git a/spree/api/lib/spree/api/preference_types.rb b/spree/api/lib/spree/api/preference_types.rb
index b93554a463..f85acdb646 100644
--- a/spree/api/lib/spree/api/preference_types.rb
+++ b/spree/api/lib/spree/api/preference_types.rb
@@ -63,8 +63,7 @@ module Spree
label = family.titleize.downcase
parts = members.map do |type, schema|
name = PreferenceFamilies.member_name(family, type)
- # Deprecated settings are still accepted on write but never read back.
- properties = schema['properties'].reject { |_key, property| property['deprecated'] }
+ properties = schema['properties']
next "/** Settings of the `#{type}` #{label}: none. */\nexport type #{name} = Record<string, never>\n" if properties.empty?
fields = properties.map { |key, property| "#{field_comment(property)} #{key}: #{ts_type(property)}\n" }.join
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/delivery_methods_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/delivery_methods_controller_spec.rb
index 3971eef92b..0e6189ce93 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/delivery_methods_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/delivery_methods_controller_spec.rb
@@ -248,6 +248,19 @@ RSpec.describe Spree::Api::V3::Admin::DeliveryMethodsController, type: :controll
expect(delivery_method.reload.calculator).to eq(calculator)
end
+ it 'keeps the current calculator when the rest of the update is refused' do
+ calculator = delivery_method.calculator
+
+ patch :update, params: {
+ id: delivery_method.prefixed_id,
+ name: '',
+ calculator: { type: 'flexi_rate', preferences: { first_item: '5' } }
+ }, as: :json
+
+ expect(response).to have_http_status(:unprocessable_content)
+ expect(delivery_method.reload.calculator).to eq(calculator)
+ end
+
it 'still accepts the pre-6.0 calculator parameters for one release' do
expect(Spree::Deprecation).to receive(:warn).with(/`calculator_type` and `calculator_preferences` parameters are deprecated/)
diff --git a/spree/core/app/models/concerns/spree/calculated_adjustments.rb b/spree/core/app/models/concerns/spree/calculated_adjustments.rb
index 55961a2cae..27638abfc9 100644
--- a/spree/core/app/models/concerns/spree/calculated_adjustments.rb
+++ b/spree/core/app/models/concerns/spree/calculated_adjustments.rb
@@ -31,12 +31,14 @@ module Spree
end
# API v3 writer for the `calculator: { type:, preferences: {} }`
- # 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.
+ # payload. A type the registry does not list raises a validation 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
+ # @raise [ActiveRecord::RecordInvalid] for a calculator type the registry does not list
+ # @raise [Spree::Preferences::InvalidPreferences] for preferences that do not match its schema
# @return [void]
def assign_calculator_attributes(attrs, pointer: '/calculator')
return if attrs.nil?
@@ -46,7 +48,11 @@ module Spree
target = calculator
if type.present? && calculator&.class&.api_type != type
klass = registered_calculator_class(type)
- return errors.add(:calculator, :invalid) unless klass
+ unless klass
+ # Raised rather than only recorded: saving would clear the error.
+ errors.add(:calculator, :invalid)
+ raise ActiveRecord::RecordInvalid, self
+ end
target = klass.new
end
diff --git a/spree/core/app/models/concerns/spree/preference_schema.rb b/spree/core/app/models/concerns/spree/preference_schema.rb
index 84209049a8..315a69f1aa 100644
--- a/spree/core/app/models/concerns/spree/preference_schema.rb
+++ b/spree/core/app/models/concerns/spree/preference_schema.rb
@@ -72,16 +72,16 @@ module Spree
schema
end
- # Checks a `preferences` payload against {#preference_json_schema}.
+ # Checks a `preferences` payload against {#preference_json_schema}, which
+ # also accepts deprecated preferences until their removal.
#
# @param values [Hash{String => Object}]
# @return [Array<Hash{Symbol => String}>] `{ pointer:, message: }` per failure, empty when it matches
def preference_failures(values)
- schema = preference_json_schema
- # 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)
+ # The published schema plus deprecated preferences, which a write
+ # still accepts until their removal. Memoized like the published one.
+ schemer = @preference_schemer || JSONSchemer.schema(Spree::PreferenceSchema::JsonSchema.for(self, writable: true))
+ @preference_schemer = schemer if @preference_schema
schemer.validate(values).map do |error|
{ pointer: error['data_pointer'], message: error['error'] }
end
diff --git a/spree/core/app/models/concerns/spree/preference_schema/json_schema.rb b/spree/core/app/models/concerns/spree/preference_schema/json_schema.rb
index 3eb30d2160..918fe42a65 100644
--- a/spree/core/app/models/concerns/spree/preference_schema/json_schema.rb
+++ b/spree/core/app/models/concerns/spree/preference_schema/json_schema.rb
@@ -19,18 +19,17 @@ module Spree
}.freeze
# @param klass [Class] a class including {Spree::PreferenceSchema}
+ # @param writable [Boolean] also list deprecated preferences, which a
+ # write still accepts until their removal but no read returns
# @return [Hash] a JSON Schema object (string keys)
- def self.for(klass)
+ def self.for(klass, writable: false)
fields = klass.preference_schema
definitions = klass.preference_definitions
properties = fields.to_h do |field|
[field[:key].to_s, property_schema(definitions.fetch(field[:key]), default: field[:default])]
end
- # A deprecated preference is still written until its removal, so it
- # stays in the schema, marked, though no form offers it and no read
- # returns it.
definitions.each do |name, definition|
- next unless definition[:deprecated] && !definition[:internal]
+ next unless writable && definition[:deprecated] && !definition[:internal]
properties[name.to_s] = property_schema(definition).merge('deprecated' => true)
end
diff --git a/spree/core/app/models/concerns/spree/typed_associations.rb b/spree/core/app/models/concerns/spree/typed_associations.rb
index edb8402dda..dc94c832ca 100644
--- a/spree/core/app/models/concerns/spree/typed_associations.rb
+++ b/spree/core/app/models/concerns/spree/typed_associations.rb
@@ -82,8 +82,6 @@ module Spree
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")
- # Saving runs validation, which would clear an unknown-type error.
- raise ActiveRecord::RecordInvalid, record if record.errors.any?
end
# Always save — `record.changed?` doesn't reflect preferences
diff --git a/spree/core/lib/spree/core/preferences/preferable.rb b/spree/core/lib/spree/core/preferences/preferable.rb
index 79df977fa3..6869671827 100644
--- a/spree/core/lib/spree/core/preferences/preferable.rb
+++ b/spree/core/lib/spree/core/preferences/preferable.rb
@@ -196,7 +196,9 @@ 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 cast_preference_item(value, definition[:type]) if %i[integer boolean].include?(definition[:type]) && value.is_a?(String)
+ if %i[integer boolean].include?(definition[:type]) && value.is_a?(String)
+ return convert_preference_value(value, definition[:type], nullable: definition[:nullable])
+ end
return value if value.nil? || (definition[:type] == :array && !value.is_a?(Array))
cast_preference_contents(value, definition)
@@ -245,8 +247,8 @@ module Spree::Preferences::Preferable
# Spree 6.0 bridge, removed with incomplete declarations in 6.1: an id list
# an extension declared without `of: :id` still has its prefixed ids
# decoded, as the API did for every `*_ids` key before.
- if definition[:type] == :array && definition[:of].nil? && name.to_s.end_with?('_ids')
- value = Array.wrap(value).map { |id| Spree::PrefixedId.prefixed_id?(id) ? Spree::PrefixedId.decode_prefixed_id(id) : id }
+ if definition[:type] == :array && definition[:of].nil? && name.to_s.end_with?('_ids') && value.is_a?(Array)
+ value = value.map { |id| (Spree::PrefixedId.decode_prefixed_id(id) if Spree::PrefixedId.prefixed_id?(id)) || id }
end
value = convert_preference_value(value, definition[:type], nullable: definition[:nullable])
value = cast_preference_contents(value, definition)
diff --git a/spree/core/spec/models/spree/preference_schema/json_schema_spec.rb b/spree/core/spec/models/spree/preference_schema/json_schema_spec.rb
index fc1eea55bf..3ec2203376 100644
--- a/spree/core/spec/models/spree/preference_schema/json_schema_spec.rb
+++ b/spree/core/spec/models/spree/preference_schema/json_schema_spec.rb
@@ -50,8 +50,8 @@ describe Spree::PreferenceSchema::JsonSchema do
expect(secret).not_to have_key('default')
end
- it 'keeps a deprecated preference writable until its removal, marked deprecated' do
- expect(property(Spree::Calculator::Shipping::FlatRate, :minimum_item_total)).to include('deprecated' => true)
+ it 'keeps a deprecated preference writable until its removal, without publishing it' do
+ expect(Spree::Calculator::Shipping::FlatRate.preference_json_schema['properties']).not_to have_key('minimum_item_total')
calculator = Spree::Calculator::Shipping::FlatRate.new
Spree::Deprecation.silence { calculator.assign_preferences({ 'minimum_item_total' => '10' }) }