Discountable amounts by adjustments #6371

mamhoff · 2025-11-17T06:48:16Z

Summary

This PR changes the new promotion system to calculate discounts entirely via adjustments rather than using in-memory ItemDiscount objects.

The advantage of this approach is that it allows to a) calculate discountable amounts for line items outside of the DiscountOrder loop. This is useful for calculating discounted prices, a feature I have on the roadmap. It specifically covers needs like the one addressed in this commit. This way, we have one system of record, not two.

The other advantage is that we can remove the pretty complex PersistDiscountedOrder code, and just rely on order.save! to do the right thing.

It also dovetails nicely with the work on the in-memory order updater.

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

I agree that my PR will be published under the same license as Solidus.
I have written a thorough PR description.
I have kept my commits small and atomic.
I have localized any and all user-facing strings that I added to the source code.
I have used clear, explanatory commit messages.

The following are not always needed:

📖 I have updated the README to account for my changes.
📑 I have documented new code with YARD.
🛣️ I have opened a PR to update the guides.
✅ I have added automated tests to cover my changes.
📸 I have attached screenshots to demo visual changes.

codecov · 2025-11-17T06:50:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.49%. Comparing base (f8779d6) to head (ac699f3).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6371      +/-   ##
==========================================
+ Coverage   89.48%   89.49%   +0.01%     
==========================================
  Files         980      981       +1     
  Lines       20438    20471      +33     
==========================================
+ Hits        18289    18321      +32     
- Misses       2149     2150       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

promotions/spec/models/solidus_promotions/order_adjuster_spec.rb

core/app/models/spree/order.rb

promotions/app/models/concerns/solidus_promotions/discountable.rb

promotions/app/models/solidus_promotions/benefits/adjust_shipment.rb

Prior to this, the `adjustment_label` method on `SolidusPromotions::Benefit` could only output a relatively static string. This commit allows calculators to define one of these methods: - `#line_item_adjustment_label(line_item, options = {})` - `#shipment_adjustment_label(shipment, options = {})` - `#shipping_rate_adjustment_label(shipping_rate, options = {})` - `#price_adjustment_label(price, options = {})` These have access to the inner workings of the calculator, so they can provide dynamic labels (to reflect e.g. which tier a promotion chooses, making that transparent to the customer.

If a promotion calculator implements a dynamic `#{adjustable}_adjustment_label` method, we need to update the adjustment label when it changes. This makes sure that is the case.

tvdeyen

This is a really great improvement. I have some nits about naming and overall API design, because I would like to make sure that the introduced classes are not used publicly.

promotions/app/models/solidus_promotions/order_adjuster/nullify_order_discounts.rb

promotions/app/models/solidus_promotions/benefits/adjust_line_item.rb

promotions/spec/models/solidus_promotions/benefits/create_discounted_item_spec.rb

promotions/app/models/solidus_promotions/order_adjuster/clean_discounted_order.rb

promotions/app/models/solidus_promotions/order_adjuster/recalculate_promo_totals.rb

promotions/app/models/solidus_promotions/order_adjuster/clean_discounted_order.rb

promotions/app/models/solidus_promotions/order_adjuster/discount_order.rb

mamhoff

Added some comments after rebasing

promotions/spec/models/solidus_promotions/benefits/create_discounted_item_spec.rb

promotions/app/models/solidus_promotions/order_adjuster/nullify_order_discounts.rb

promotions/app/models/solidus_promotions/order_adjuster/clean_discounted_order.rb

promotions/app/models/solidus_promotions/order_adjuster/recalculate_promo_totals.rb

promotions/app/models/solidus_promotions/order_adjuster/discount_order.rb

tvdeyen

Reads extremely well and is a great change

tvdeyen · 2025-12-22T14:22:45Z

promotions/app/models/solidus_promotions/order_adjuster/set_discounts_to_zero.rb

+
+module SolidusPromotions
+  class OrderAdjuster
+    class SetDiscountsToZero


This could now be a module, no?

This module recalculates all promo totals after promotion calculation has finished, and marks any adjustments with an amount of zero for destruction.

Now that the promotion order adjuster does not persist things to the database any longer, we can calculate promo totals even in dry runs (and get better results). The `PersistDiscountedOrder` class is slated for deletion, but that is the next commit.

This service object sets all discounts on an order - adjustments on shipments and line items, and shipping rate discounts on shipping rates - to an amount of zero. This service module is intended to run within the order adjuster, before promotion calculation. Promotion calculation will then re-calculate the amounts, with the effect that adjustments that need to change will be changed, while adjustments that do not need to change will not have changes (and will therefore also not be saved).

We want the individual benefits to issue exactly the kind of object that will discount the adjustable object, so we need to generate the right kind of discount object for each adjustable type. This allows us to remove the `PersistDiscountedOrder` class, and it makes the promotion system more understandable and more in line with the rest of Solidus. Specifically, we can now check for adjustments when calculating promotion discounts (this is pretty big!), and `promotion.discounted_amount` can be called from outside the promotion calculation loop.

github-actions bot added changelog:solidus_core Changes to the solidus_core gem changelog:solidus_promotions Changes to the solidus_promotions gem labels Nov 17, 2025

tvdeyen reviewed Nov 17, 2025

View reviewed changes

This was referenced Nov 17, 2025

Add a global per-promotion amount limit #6370

Closed

Remove inverse_of from Spree::Adjustment#order #6373

Merged

mamhoff force-pushed the discountable-amounts-by-adjustments branch from 5f2c828 to fc5b38b Compare November 20, 2025 21:15

This was referenced Nov 20, 2025

Remove benefit "level" mixins #6378

Merged

Add #discounted_amount by adjustments #6379

Merged

mamhoff force-pushed the discountable-amounts-by-adjustments branch from fc5b38b to bd24d6b Compare November 22, 2025 11:19

github-actions bot removed the changelog:solidus_core Changes to the solidus_core gem label Nov 22, 2025

mamhoff force-pushed the discountable-amounts-by-adjustments branch 2 times, most recently from 67487b3 to ea30703 Compare December 3, 2025 13:49

mamhoff added 2 commits December 20, 2025 17:03

Promotion order adjuster: update adjustment labels

1b399a2

If a promotion calculator implements a dynamic `#{adjustable}_adjustment_label` method, we need to update the adjustment label when it changes. This makes sure that is the case.

mamhoff force-pushed the discountable-amounts-by-adjustments branch 2 times, most recently from 96fab42 to 00fec51 Compare December 20, 2025 16:38

mamhoff marked this pull request as ready for review December 20, 2025 16:38

mamhoff requested a review from a team as a code owner December 20, 2025 16:38

mamhoff force-pushed the discountable-amounts-by-adjustments branch from 00fec51 to e3c0bbf Compare December 20, 2025 17:12

tvdeyen reviewed Dec 22, 2025

View reviewed changes

mamhoff force-pushed the discountable-amounts-by-adjustments branch 2 times, most recently from b3e5d37 to 7872e08 Compare December 22, 2025 13:44

mamhoff commented Dec 22, 2025

View reviewed changes

mamhoff force-pushed the discountable-amounts-by-adjustments branch from 7872e08 to 5377e72 Compare December 22, 2025 13:49

tvdeyen approved these changes Dec 22, 2025

View reviewed changes

tvdeyen added this to the 4.7 milestone Dec 22, 2025

github-project-automation bot added this to Solidus Public Roadmap Dec 22, 2025

tvdeyen moved this to In Progress in Solidus Public Roadmap Dec 22, 2025

Add RecalculatePromoTotals module

84a34a4

This module recalculates all promo totals after promotion calculation has finished, and marks any adjustments with an amount of zero for destruction.

mamhoff added 3 commits December 23, 2025 10:15

mamhoff force-pushed the discountable-amounts-by-adjustments branch from 5377e72 to ac699f3 Compare December 23, 2025 09:16

Uh oh!

Discountable amounts by adjustments #6371

Are you sure you want to change the base?

Discountable amounts by adjustments #6371

Conversation

mamhoff commented Nov 17, 2025

Summary

Checklist

Uh oh!

codecov bot commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tvdeyen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mamhoff left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tvdeyen left a comment

Choose a reason for hiding this comment

Uh oh!

tvdeyen Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Nov 17, 2025 •

edited

Loading