Implement order events #4018

NyanKiyoshi · 2019-04-25T09:59:04Z

For the gql type of OrderEvent we have to include:
- New fields for getting data from the JSON parameters. [2]
- A payment method field taken from the parameters.
- Tests.

The OrderEvent model should have:
- A field user containing who triggered the event. [4]
- (outside) should contain a bunch of functions taking data to generate event(s)

An event should be called to be created and may create other events.
We need to migrate the old events to the new model.
Refactor logic to commit on the go instead of waiting on the user's green light.

[2] Allows to retrieve additional data from an event (e.g., an amount, a quantity, a message, etc.)
[4] We want to know who triggered the event, even if it's the customer itself or a staff user.

[!] Failed payment expected data (payment id, etc. for user support) https://i.imgur.com/ayYrCjr.png

Pull Request Checklist

Privileged views and APIs are guarded by proper permission checks.
All visible strings are translated with proper context.
All data-formatting is locale-aware (dates, numbers, and so on).
Database queries are optimized and the number of queries is constant.
Database migration files are up to date.
The changes are tested.
The code is documented (docstrings, project documentation).
GraphQL schema and type definitions are up to date.
Changes are mentioned in the changelog.

Magic Final Words

Closes #2443.

codecov · 2019-04-26T12:05:49Z

Codecov Report

❗ No coverage uploaded for pull request base (master@0c22560). Click here to learn what that means.
The diff coverage is 92.42%.

@@            Coverage Diff            @@
##             master    #4018   +/-   ##
=========================================
  Coverage          ?   91.38%           
=========================================
  Files             ?      280           
  Lines             ?    15169           
  Branches          ?     1481           
=========================================
  Hits              ?    13862           
  Misses            ?      910           
  Partials          ?      397

Impacted Files	Coverage Δ
saleor/core/views.py	`69.44% <0%> (ø)`
saleor/graphql/shipping/enums.py	`100% <100%> (ø)`
saleor/events/models/__init__.py	`100% <100%> (ø)`
saleor/graphql/order/bulk_mutations/orders.py	`96.29% <100%> (ø)`
saleor/graphql/order/resolvers.py	`82.92% <100%> (ø)`
saleor/graphql/order/mutations/draft_orders.py	`95.79% <100%> (ø)`
saleor/events/__init__.py	`100% <100%> (ø)`
saleor/payment/utils.py	`92.94% <100%> (ø)`
saleor/checkout/utils.py	`82.49% <100%> (ø)`
saleor/graphql/checkout/mutations.py	`93.35% <100%> (ø)`
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c22560...c44aa7c. Read the comment docs.

NyanKiyoshi · 2019-04-29T11:55:46Z

I decided to move the customer events to #4039 as it would make this PR way too big, thus even harder to review.

saleor/events/models/OrderEvent.py

saleor/order/emails.py

auvipy · 2019-05-02T10:22:51Z

Should I expect this feature on April release?

NyanKiyoshi · 2019-05-02T14:44:32Z

@maarcingebala could you double check the OrderEvent model definitions? I'm confused by how the choices are supposed to be populated.

For example, OrderStatus populates the choices with [('status-type', 'status-type-human-readable-through-gettext')], in the database the human readable value is stored instead of the "key". So I'm confused how we should actually proceed with choices, especially as the value can be different depending on what gettext() returned.

But it may work just fine, and seems to be the proper django way. I'm unsure about how django is performing the queries and returning the results, I can't seem to find any piece of documentation on that matter.

NyanKiyoshi · 2019-05-02T14:47:21Z

saleor/graphql/core/enums.py

+    # note this won't work until
+    # https://github.com/graphql-python/graphene/issues/956 is fixed
+    deprecation_reason = getattr(enum_cls, '__deprecation_reason__', None)
+    if deprecation_reason:


Careful here, its not supposed to be actually in a if statement but a simple setdefault. This was made like that because it would otherwise actually crash. For that reason it would be good to wait for the graphql-python/graphene#957 fix to be merged.

codecov · 2019-05-06T11:50:46Z

Codecov Report

❗ No coverage uploaded for pull request base (master@6ba9f78). Click here to learn what that means.
The diff coverage is 94.42%.

@@            Coverage Diff            @@
##             master    #4018   +/-   ##
=========================================
  Coverage          ?   91.55%           
=========================================
  Files             ?      277           
  Lines             ?    15106           
  Branches          ?     1474           
=========================================
  Hits              ?    13830           
  Misses            ?      878           
  Partials          ?      398

Impacted Files	Coverage Δ
saleor/order/events.py	`100% <100%> (ø)`
saleor/graphql/checkout/mutations.py	`93.35% <100%> (ø)`
saleor/order/models.py	`89.62% <100%> (ø)`
saleor/graphql/payment/enums.py	`90% <100%> (ø)`
saleor/graphql/shipping/enums.py	`100% <100%> (ø)`
saleor/graphql/account/enums.py	`100% <100%> (ø)`
saleor/graphql/order/bulk_mutations/orders.py	`95.83% <100%> (ø)`
saleor/graphql/order/resolvers.py	`82.92% <100%> (ø)`
saleor/graphql/order/mutations/draft_orders.py	`95.75% <100%> (ø)`
saleor/graphql/order/types.py	`84.31% <100%> (ø)`
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ba9f78...03ad801. Read the comment docs.

auvipy · 2019-05-06T11:54:07Z

seems another rebase needed?

saleor/events/migrations/0067_replace_old_enum_namings.py

saleor/checkout/utils.py

docs/architecture/events.rst

saleor/checkout/utils.py

saleor/events/bases.py

maarcingebala · 2019-05-06T13:39:04Z

saleor/graphql/core/enums.py

@@ -11,6 +11,35 @@ class ReportingPeriod(graphene.Enum):
    THIS_MONTH = 'THIS_MONTH'


+def to_enum(enum_cls, *, type_name=None, **options) -> graphene.Enum:


Why do we need this function and what were the consequences of not having it before? Are there any problems with enums currently?

It avoids to repetitively have around each graphql package:

graphene.Enum('something', str_to_enum(code.upper()), code) for code, name in enum_cls.CHOICES)

It would make it more readable and easier to maintain.

saleor/events/__init__.py

docs/architecture/events.rst

saleor/dashboard/order/views.py

saleor/graphql/checkout/mutations.py

auvipy

great job.

maarcingebala · 2019-05-07T13:00:19Z

🎉 Thanks @NyanKiyoshi, great effort!

NyanKiyoshi added in progress graphql Issues related to the GraphQL API labels Apr 25, 2019

NyanKiyoshi self-assigned this Apr 25, 2019

NyanKiyoshi force-pushed the gql/feature/order-events branch from ec9d9a9 to d763cb8 Compare April 26, 2019 08:16

NyanKiyoshi marked this pull request as ready for review April 26, 2019 11:50

NyanKiyoshi force-pushed the gql/feature/order-events branch 3 times, most recently from f2c65a0 to a3b6f58 Compare April 29, 2019 10:47

NyanKiyoshi changed the title ~~Implement order and some customer events~~ Implement order events Apr 29, 2019

NyanKiyoshi mentioned this pull request Apr 29, 2019

Implement customer events #4039

Closed

maarcingebala reviewed Apr 30, 2019

View reviewed changes

NyanKiyoshi force-pushed the gql/feature/order-events branch 2 times, most recently from 7f11133 to 81e1885 Compare April 30, 2019 14:18

NyanKiyoshi commented May 2, 2019

View reviewed changes

NyanKiyoshi force-pushed the gql/feature/order-events branch from 8d881d5 to b4d3e24 Compare May 6, 2019 10:48

NyanKiyoshi requested a review from maarcingebala May 6, 2019 10:50

NyanKiyoshi force-pushed the gql/feature/order-events branch 2 times, most recently from 43daed1 to c44aa7c Compare May 6, 2019 11:17

NyanKiyoshi removed the in progress label May 6, 2019

NyanKiyoshi force-pushed the gql/feature/order-events branch from c44aa7c to 32cf150 Compare May 6, 2019 11:33

auvipy reviewed May 6, 2019

View reviewed changes

saleor/events/migrations/0067_replace_old_enum_namings.py Outdated Show resolved Hide resolved

korycins reviewed May 6, 2019

View reviewed changes

saleor/checkout/utils.py Outdated Show resolved Hide resolved

maarcingebala reviewed May 6, 2019

View reviewed changes

korycins reviewed May 7, 2019

View reviewed changes

saleor/events/__init__.py Outdated Show resolved Hide resolved

NyanKiyoshi added 11 commits May 7, 2019 13:53

Remove dead code from the model definition

4469c3a

Rename the user 'source' parameters to 'user' and fix detected issues

1425309

Move events enums to the package's init file

b2f8cba

Remove redundant order creation function

30fe37d

Mock checkout deletion during order placement testings

3e62072

Drop enums on events

8c9d49f

Update the GraphQL schema

d42a694

Implement the new event manager, allowing simple bulk/single creation

d0bf9c6

Update changelog

c8c02ed

Update migrations

e5d9475

Move the order events to the order package

09b7a2a

NyanKiyoshi force-pushed the gql/feature/order-events branch from 61d389b to a7bcce5 Compare May 7, 2019 11:54

NyanKiyoshi requested review from korycins and maarcingebala May 7, 2019 11:54

Update migration files

c18bb40

NyanKiyoshi force-pushed the gql/feature/order-events branch from a7bcce5 to c18bb40 Compare May 7, 2019 12:01

maarcingebala reviewed May 7, 2019

View reviewed changes

docs/architecture/events.rst Outdated Show resolved Hide resolved

maarcingebala reviewed May 7, 2019

View reviewed changes

saleor/dashboard/order/views.py Outdated Show resolved Hide resolved

maarcingebala reviewed May 7, 2019

View reviewed changes

saleor/dashboard/order/views.py Outdated Show resolved Hide resolved

maarcingebala reviewed May 7, 2019

View reviewed changes

saleor/graphql/checkout/mutations.py Outdated Show resolved Hide resolved

Update documentation and reorganize imports

03ad801

NyanKiyoshi force-pushed the gql/feature/order-events branch from 913b24b to 03ad801 Compare May 7, 2019 12:39

NyanKiyoshi requested a review from maarcingebala May 7, 2019 12:40

maarcingebala approved these changes May 7, 2019

View reviewed changes

auvipy approved these changes May 7, 2019

View reviewed changes

maarcingebala merged commit e3af84f into saleor:master May 7, 2019

NyanKiyoshi deleted the gql/feature/order-events branch May 7, 2019 16:41

jxltom mentioned this pull request May 9, 2019

Update order events and order email events names in typescripts #4089

Merged

9 tasks

maarcingebala mentioned this pull request Aug 9, 2019

Enhance order history events log in Dashboard 2.0 saleor/saleor-dashboard#37

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement order events #4018

Implement order events #4018

NyanKiyoshi commented Apr 25, 2019 •

edited

Loading

codecov bot commented Apr 26, 2019 •

edited

Loading

NyanKiyoshi commented Apr 29, 2019

auvipy commented May 2, 2019

NyanKiyoshi commented May 2, 2019

NyanKiyoshi May 2, 2019

codecov bot commented May 6, 2019 •

edited

Loading

auvipy commented May 6, 2019

maarcingebala May 6, 2019

NyanKiyoshi May 6, 2019 •

edited

Loading

auvipy left a comment

maarcingebala commented May 7, 2019

		@@ -11,6 +11,35 @@ class ReportingPeriod(graphene.Enum):
		THIS_MONTH = 'THIS_MONTH'


		def to_enum(enum_cls, , type_name=None, *options) -> graphene.Enum:

Implement order events #4018

Implement order events #4018

Conversation

NyanKiyoshi commented Apr 25, 2019 • edited Loading

Pull Request Checklist

Magic Final Words

codecov bot commented Apr 26, 2019 • edited Loading

Codecov Report

NyanKiyoshi commented Apr 29, 2019

auvipy commented May 2, 2019

NyanKiyoshi commented May 2, 2019

NyanKiyoshi May 2, 2019

Choose a reason for hiding this comment

codecov bot commented May 6, 2019 • edited Loading

Codecov Report

auvipy commented May 6, 2019

maarcingebala May 6, 2019

Choose a reason for hiding this comment

NyanKiyoshi May 6, 2019 • edited Loading

Choose a reason for hiding this comment

auvipy left a comment

Choose a reason for hiding this comment

maarcingebala commented May 7, 2019

NyanKiyoshi commented Apr 25, 2019 •

edited

Loading

codecov bot commented Apr 26, 2019 •

edited

Loading

codecov bot commented May 6, 2019 •

edited

Loading

NyanKiyoshi May 6, 2019 •

edited

Loading