Remove code column from spree_promotions table #3028

kennyadsl · 2019-01-06T21:15:19Z

Description

This PR removes code column form Spree::Promotion since promotions are now tied to multiple codes via Spree::PromotionCode.

Ref. #2979

TODO:

Remove columns method on Spree::Promotion. This should be done in sync with Fix spree_promotions.code not being ignored properly #3000

Checklist:

Pull Request guidelines are respected
Documentation/Readme have been updated accordingly
Changes are covered by tests (if possible)
Each commit has a meaningful message attached that described WHAT changed, and WHY

aitbw

LGTM! 💪

kennyadsl · 2019-01-16T16:39:04Z

I have to add a guard to let people know that they have to remove data from the column before running the migration. Also, I need to add a changelog entry

CHANGELOG.md

mdesantis · 2019-01-21T14:15:18Z

core/db/migrate/20190106184413_remove_code_from_spree_promotions.rb

+        migration_context.say "Creating Spree::PromotionCode with value '#{promotion.code}' "\
+          "for Spree::Promotion with id '#{promotion.id}'"
+
+        promotion.codes.create(value: promotion.code)


What about create!?

Thanks for pointing this out @mdesantis !

There's a uniqueness validation on value so if that value is already used (let's say the code has been already moved manually into the Spree::PromotionCode) it will raise an exception.

What about using Spree::PromotionCode.find_or_create_by!(value: value, promotion_id: promotion.id) instead?
I think this way it will only raise if the value is not unique and that value has been used on a Spree::PromotionCode associated with another Spree::Promotion. It will do nothing if the current Spree::Promotion already has a Spree::PromotionCode with the same value.

I totally agree with that 👍

spaghetticode · 2019-01-21T15:41:28Z

core/db/migrate/20190106184413_remove_code_from_spree_promotions.rb

+      # This is another possible approach, it will convert Spree::Promotion#code
+      # to a Spree::PromotionCode before removing the `code` field.
+      #
+      promotions.each do |promotion|


I suppose the number of promotions might be quite high in some databases. In that case find_each should work better than each

elia · 2019-01-21T17:22:42Z

core/db/migrate/20190106184413_remove_code_from_spree_promotions.rb

+      # You have some promotions with "code" field present! This is not good
+      # since we are going to remove that column.
+      #
+      self.class.promotions_with_code_handler.new(self, promotions_with_code).call


I think it would be better to use a simple callable instead of a class that responds to #call and pass options directly to call, also a constant would be more straightforward than a method:

Suggested change

self.class.promotions_with_code_handler.new(self, promotions_with_code).call

deprecated_code_handler = StopWithError

# deprecated_code_handler = DoNothing

# deprecated_code_handler = MoveToSpreePromotionCode

deprecated_code_handler.call(self, promotions_with_code)

and then below:

# Please note that this will block the current migration and rollback all # the previous ones run with the same "rails db:migrate" command. StopWithError = ->(migration, promotions) { raise StandardError, "You are trying to drop 'code' column from "\ "spree_promotions table but you have at least one record with that "\ "column filled. Please take care of that or you could lose data. See:" \ "\n" \ "https://github.com/solidusio/solidus/pull/3028"\ "\n" }

This is much simpler and has the advantage of having the configuration near the error location, making it easier to find

This is very similar to what I did first but to test all the possible proposed approaches I ended up creating a method. I know it's not ideal but I can't think to other solutions for this. Feel free to suggest how can I keep this code tested reducing its complexity.

I like Elias idea of using simple callables, but Albertos approach is working well and is tested (not that easy with lambdas), so I think it's fine. The outcome is the same.

What I do care about is the very thoughtful work that is done here and want to give an extra appreciation! Very nicely done, Alberto! 👏

tvdeyen

Thanks for working on this. Especially the very thoughtful way of handling the data migration. Really great work. Also the commit messages are 👌

spaghetticode · 2019-01-22T08:05:36Z

core/db/migrate/20190106184413_remove_code_from_spree_promotions.rb

+      # This approach will delete all codes without taking any action. At
+      # least we could print a message to track what we are deleting.
+      #
+      promotions.each do |promotion|


There's also this instance of each that can be replaced with find_each. Sorry for not finding it earlier.

kennyadsl · 2019-01-22T16:15:00Z

There's some issue with the database in test environment when it tries to roll back to the previous state after the test ends, I need to investigate more on why it's happening.

jacobherrington

LGTM! Thanks Alberto 👍

spaghetticode

@kennyadsl great job!

ericsaupe

LGTM!

Promotions are now tied to multiple code records so this scope does does not make sense anymore.

Since it includes a reference to promotion.code that is no more valid

We can't use a simple `change` method here since we also want to remove the index and we should respect the order of these actions.

This code needs to be removed for 2 reasons: 1. it didn't work, it should be on a class level (`def self.columns`) see issue solidusio#2979, which can be closed when this is merged. 2. is not used anymore since we are removing the `code` column at all from the database.

By default we raise and error to give users a notice that we code column will be removed from spree_promotions table and they will lose their data. We are also providing another 2 options that can be activated by changing `promotions_with_code_handler` class method content making it return another class. Users can also create their own class directly into the migration and handle this how they prefer.

kennyadsl added the WIP label Jan 6, 2019

kennyadsl self-assigned this Jan 6, 2019

kennyadsl mentioned this pull request Jan 6, 2019

Fix spree_promotions.code not being ignored properly #3000

Closed

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch 2 times, most recently from f773bb7 to 1a1729f Compare January 6, 2019 21:28

kennyadsl mentioned this pull request Jan 6, 2019

Calling Spree::Order#promotions calls code which raises an error #2979

Closed

kennyadsl removed the WIP label Jan 8, 2019

aitbw approved these changes Jan 9, 2019

View reviewed changes

kennyadsl added Needs Core Team Decision type:bug Error, flaw or fault labels Jan 12, 2019

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch from d5ab562 to 9c1741f Compare January 21, 2019 14:02

mdesantis reviewed Jan 21, 2019

View reviewed changes

spaghetticode reviewed Jan 21, 2019

View reviewed changes

elia requested changes Jan 21, 2019

View reviewed changes

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch 2 times, most recently from c544736 to 2c2318f Compare January 21, 2019 19:00

tvdeyen approved these changes Jan 22, 2019

View reviewed changes

spaghetticode reviewed Jan 22, 2019

View reviewed changes

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch 2 times, most recently from f0adae8 to 9d22219 Compare January 22, 2019 13:38

kennyadsl added WIP and removed Needs Core Team Decision labels Jan 22, 2019

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch 4 times, most recently from 5d20dfc to 66d3c63 Compare January 28, 2019 09:57

kennyadsl removed the WIP label Jan 28, 2019

jacobherrington approved these changes Jan 28, 2019

View reviewed changes

spaghetticode approved these changes Jan 28, 2019

View reviewed changes

ericsaupe approved these changes Jan 28, 2019

View reviewed changes

kennyadsl added 6 commits January 28, 2019 19:37

Fix Spree::Promotion.coupons scope

7330cc2

Promotions are now tied to multiple code records so this scope does does not make sense anymore.

Remove an api checkout spec comment

885f505

Since it includes a reference to promotion.code that is no more valid

Add a migration to remove code from spree_promotions

6fbd2f5

We can't use a simple `change` method here since we also want to remove the index and we should respect the order of these actions.

Add a CHANGELOG entry for removing code column change

3435a9b

kennyadsl force-pushed the kennyadsl/remove-code-promotions branch from 66d3c63 to 3435a9b Compare January 28, 2019 18:39

kennyadsl merged commit fc84ef8 into solidusio:master Jan 29, 2019

kennyadsl deleted the kennyadsl/remove-code-promotions branch January 29, 2019 09:46

kennyadsl mentioned this pull request Feb 18, 2019

Fix remove code from promotions migration #3108

Merged

3 tasks

kennyadsl mentioned this pull request Feb 28, 2019

Remove code setter/getter from Spree::Promotion #3127

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove code column from spree_promotions table #3028

Remove code column from spree_promotions table #3028

kennyadsl commented Jan 6, 2019 •

edited

Loading

aitbw left a comment

kennyadsl commented Jan 16, 2019

mdesantis Jan 21, 2019

kennyadsl Jan 21, 2019

mdesantis Jan 21, 2019

spaghetticode Jan 21, 2019

elia Jan 21, 2019

kennyadsl Jan 21, 2019

tvdeyen Jan 22, 2019

tvdeyen left a comment

spaghetticode Jan 22, 2019

kennyadsl commented Jan 22, 2019

jacobherrington left a comment

spaghetticode left a comment

ericsaupe left a comment

-      self.class.promotions_with_code_handler.new(self, promotions_with_code).call
+      deprecated_code_handler = StopWithError
+      # deprecated_code_handler = DoNothing
+      # deprecated_code_handler = MoveToSpreePromotionCode
+      deprecated_code_handler.call(self, promotions_with_code)

Remove code column from spree_promotions table #3028

Remove code column from spree_promotions table #3028

Conversation

kennyadsl commented Jan 6, 2019 • edited Loading

Description

TODO:

Checklist:

aitbw left a comment

Choose a reason for hiding this comment

kennyadsl commented Jan 16, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tvdeyen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kennyadsl commented Jan 22, 2019

jacobherrington left a comment

Choose a reason for hiding this comment

spaghetticode left a comment

Choose a reason for hiding this comment

ericsaupe left a comment

Choose a reason for hiding this comment

kennyadsl commented Jan 6, 2019 •

edited

Loading