Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call `DRAFT_ORDER_UPDATED` event when nothing changed #17532

IKarbowiak · 2025-03-25T09:02:31Z

Refactor DraftOrderUpdate and DraftOrderCreate - do not inherit from draftOrderCreate in draftOrderUpdate mutation.
Save only changed fields in DraftOrderUpdate.
Introduce DraftOrderCleaner to encapsulate DraftOrderCreate and DraftOrderUpdate clean methods
Do not inherit from ShippingMethodUpdateMixin - use just methods from Mixin

Port of #17498

⚠️
Include additional change:

DRAFT_ORDER_UPDATED is not called in case nothing changed in DraftOrderUpdate mutation

Impact

New migrations
New/Updated API fields or mutations
Deprecated API fields or mutations
Removed API types, fields, or mutations

Docs

Link to documentation: Update upgrade guide - DraftOrderUpdate and OrderUpdate do not call webhooks anymore if nothing changed saleor-docs#1511

Pull Request Checklist

Privileged queries and mutations are either absent or guarded by proper permission checks
Database queries are optimized and the number of queries is constant
Database migrations are either absent or optimized for zero downtime
The changes are covered by test cases
All new fields/inputs/mutations have proper labels added (ADDED_IN_X, PREVIEW_FEATURE, etc.)
All migrations have proper dependencies
All indexes are added concurrently in migrations
All RunSql and RunPython migrations have revert option defined

…rUpdate` (#17498) * Update DraftOrderCreate and DraftOrderUpdate, save only changed fields * Call change_user_address in draftOrderCreate and draftOrderUpdate * Update save_address method * Clean DraftOrderCreate * Update ShippingMethodUpdateMixin * Apply code review suggestions

…changed

…and-create-main

db-queries · 2025-03-27T11:35:35Z

Here is the report for 7586172 (saleor:ext-2001-ext-2010-update-draft-order-update-and-create-main)
Base comparison is d7b8487.

No differences were found.

# saleor.graphql.accountbenchmark account
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  addresses for federation query count                                    	         11	         11	              2
  customers query                                                         	         53	         53	              0
  delete staff members                                                    	         42	         42	              0
  query staff user                                                        	         24	         24	              3
  staff create                                                            	         24	         24	              3
  staff update groups and permissions                                     	         37	         37	              6
  users for federation query count                                        	         10	         10	              3

# saleor.graphql.accountbenchmark permission group
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  groups for federation query count                                       	          3	          3	              1
  permission group create                                                 	         26	         26	              0
  permission group delete                                                 	         31	         31	              3
  permission group query                                                  	         16	         16	              0
  permission group update                                                 	         45	         45	              2
  permission group update remove users with manage staff                  	         37	         37	              3

# saleor.graphql.appbenchmarks app extensions
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  app extensions                                                          	         27	         27	             10
  app extensions with filter[filter0]                                     	         26	         26	             10
  app extensions with filter[filter1]                                     	         14	         14	              2
  app extensions with filter[filter2]                                     	         26	         26	             10
  app extensions with filter[filter3]                                     	         14	         14	              2

# saleor.graphql.appbenchmarks apps
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  apps for federation query count                                         	         11	         11	              3
  apps with tokens and webhooks                                           	         11	         11	              0

# saleor.graphql.attributebenchmark attribute
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  attribute translation                                                   	          8	          8	              0
  attribute value translation                                             	         22	         22	              0
  query attribute                                                         	          8	          8	              0
  query attributes                                                        	         10	         10	              0

# saleor.graphql.channelbenchmark channel
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  channels query                                                          	          7	          7	              0

# saleor.graphql.channelmutations channel update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  channel update mutation remove warehouse                                	         41	         41	              6

# saleor.graphql.checkoutbenchmark checkout mutations
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  add billing address to checkout                                         	         74	         74	              7
  add checkout lines                                                      	        105	        105	             15
  add checkout lines catalogue discount applies                           	        202	        202	             16
  add checkout lines gift discount applies                                	        166	        166	             24
  add checkout lines multiple catalogue discount applies                  	        217	        217	             21
  add checkout lines order discount applies                               	        179	        179	             19
  add checkout lines with external shipping                               	        186	        186	             73
  add checkout lines with reservations                                    	        215	        215	             76
  add delivery to checkout                                                	         88	         88	             10
  add shipping to checkout                                                	         90	         90	             17
  checkout customer note update                                           	         53	         53	              4
  checkout email update                                                   	         52	         52	              3
  checkout payment charge                                                 	         69	         69	             19
  checkout shipping address update                                        	         85	         85	              9
  checkout voucher code                                                   	         94	         94	             13
  complete checkout                                                       	        205	        205	             59
  complete checkout preorder                                              	        216	        216	             63
  complete checkout with digital line                                     	        244	        244	             65
  complete checkout with out of stock webhook                             	        207	        207	             59
  complete checkout with single line                                      	        207	        207	             59
  create checkout                                                         	         81	         81	              5
  create checkout with gift promotion                                     	        118	        118	             14
  create checkout with order promotion                                    	        105	        105	              5
  create checkout with reservations                                       	        181	        181	             37
  customer complete checkout                                              	        218	        218	             65
  customer complete checkout for cc                                       	        243	        243	             74
  update checkout lines                                                   	         95	         95	             15
  update checkout lines with reservations                                 	        228	        228	             91

# saleor.graphql.checkoutbenchmark checkouts
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  staff multiple checkouts                                                	          8	          8	              0

# saleor.graphql.checkoutbenchmark homepage
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  user checkout details                                                   	         65	         65	              5
  user checkout details with tax app                                      	         98	         98	             33

# saleor.graphql.discountbenchmark promotion create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotion create                                                        	         25	         25	              1
  promotion create order promotion                                        	         39	         39	              7

# saleor.graphql.discountbenchmark promotion delete
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  gift promotion delete                                                   	         27	         27	              1
  promotion delete                                                        	         32	         32	              1

# saleor.graphql.discountbenchmark promotion rule create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotion rule create                                                   	         25	         25	              1
  promotion rule create gift                                              	        135	        135	              7

# saleor.graphql.discountbenchmark promotion rule delete
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotion rule delete                                                   	         25	         25	              0

# saleor.graphql.discountbenchmark promotion rule update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotion rule update                                                   	         40	         40	              0

# saleor.graphql.discountbenchmark promotion update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotion update                                                        	         18	         18	              0

# saleor.graphql.discountbenchmark promotions
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  promotions querytest promotions query                                   	         11	         11	              0

# saleor.graphql.discountbenchmark sales
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  sales query with channel slug                                           	         11	         11	              0
  sales query without channel slug                                        	          9	          9	              0

# saleor.graphql.discountbenchmark voucher code bulk delete
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  voucher code bulk delete queries                                        	         22	         22	              3

# saleor.graphql.discountbenchmark vouchers
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  vouchers query with channel slug                                        	         22	         22	              0
  vouchers query withot channel slug                                      	         21	         21	              0

# saleor.graphql.giftcardbenchmark gift card mutations
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  create never expiry gift card                                           	         29	         29	              4
  gift card bulk activate by staff                                        	         17	         17	              3
  update gift card                                                        	         37	         37	              4

# saleor.graphql.giftcardbenchmark gift card queries
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  filter gift cards by products                                           	         16	         16	              3
  filter gift cards by tags                                               	         14	         14	              3
  filter gift cards by used by user                                       	         15	         15	              3
  query gift card details                                                 	         16	         16	              3
  query gift cards                                                        	         14	         14	              3

# saleor.graphql.orderbenchmark fulfillment
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fulfillment query                                                       	          8	          8	              0

# saleor.graphql.orderbenchmark fulfillment refund and return products
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fulfillment refund products order lines                                 	         50	         50	              0
  fulfillment return products order lines                                 	         95	         95	              3

# saleor.graphql.orderbenchmark order
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  staff multiple draft orders                                             	          9	          9	              0
  staff multiple orders                                                   	          9	          9	              0
  staff order details                                                     	         55	         55	              7
  user order details                                                      	         52	         52	              8

# saleor.graphql.orderbenchmark order bulk create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  order bulk create                                                       	         23	         23	              2

# saleor.graphql.orderbenchmark order fulfill
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  order fulfill                                                           	         15	         15	              0
  order fulfill with gift cards                                           	         15	         15	              0

# saleor.graphql.orderbenchmark order lines create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  order lines create                                                      	        100	        100	             17
  order lines create variants on promotion                                	        161	        161	             22

# saleor.graphql.pagebenchmark page type
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  page types for federation query count                                   	          3	          3	              0
  query page type                                                         	         20	         20	              6
  query page types                                                        	         27	         27	             12

# saleor.graphql.paymentbenchmark payment transactions
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  payment transactions                                                    	         26	         26	              0

# saleor.graphql.productbenchmark category
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  categories children                                                     	          4	          4	              1
  categories for federation query count                                   	          3	          3	              0
  category delete                                                         	         32	         32	              3
  category view                                                           	         28	         28	              1

# saleor.graphql.productbenchmark collection
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  collection add products                                                 	         24	         24	              5
  collection bulk delete                                                  	         29	         29	              4
  collection view                                                         	          7	          7	              0
  collections for federation query count                                  	          4	          4	              1
  create collection                                                       	         25	         25	              6
  delete collection                                                       	         28	         28	              5
  remove products from collection                                         	         21	         21	              5
  retrieve collection channel listings                                    	          7	          7	              0

# saleor.graphql.productbenchmark homepage
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  report product sales                                                    	         12	         12	              3
  retrieve product list                                                   	          4	          4	              0

# saleor.graphql.productbenchmark product
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  filter products by attributes                                           	          7	          7	              0
  filter products by boolean attributes                                   	         14	         14	              0
  filter products by gift card                                            	         14	         14	              1
  filter products by numeric attributes                                   	         13	         13	              0
  product create                                                          	         45	         45	              3
  product details                                                         	         40	         40	              2
  product translations                                                    	          5	          5	              0
  products for federation query count                                     	          6	          6	              2
  products media for federation query count                               	          5	          5	              0
  products types for federation query count                               	          2	          2	              0
  retrieve channel listings                                               	         23	         23	              0
  retrieve product attributes                                             	          8	          8	              0
  retrieve product images                                                 	          4	          4	              0
  retrieve product media                                                  	          4	          4	              0
  retrive products with product types and attributes                      	          7	          7	              0
  update product                                                          	         59	         59	              4

# saleor.graphql.productbenchmark product variant channel listing update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  variant channel listing update                                          	         37	         37	              3

# saleor.graphql.productbenchmark variant
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  product variant bulk create                                             	         47	         47	              1
  product variant create                                                  	         63	         63	              3
  products variants for federation query count                            	          6	          6	              2
  retrieve variant list                                                   	         34	         34	              1
  update product variant                                                  	         61	         61	              6

# saleor.graphql.productbenchmark variant stocks
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  product variants stocks create                                          	         27	         27	              4
  product variants stocks create with single webhook called               	         27	         27	              4
  product variants stocks delete by id                                    	         32	         32	              4
  product variants stocks delete by sku                                   	         32	         32	              4
  product variants stocks delete with out of stock webhook many calls     	         28	         28	              3
  product variants stocks update by sku                                   	         30	         30	              4
  product variants stocks update byid                                     	         30	         30	              4
  query product variants stocks                                           	         12	         12	              0

# saleor.graphql.producttest product sorting attributes
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  sort product not having attribute data                                  	         20	         20	              0

# saleor.graphql.shippingbenchmark shipping methods
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  vouchers query with channel slug                                        	          9	          9	              0
  vouchers query without channel slug                                     	          9	          9	              0

# saleor.graphql.shippingbenchmark shipping zones
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  shipping zones query                                                    	          8	          8	              0

# saleor.graphql.shopbenchmark homepage
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  retrieve shop                                                           	          2	          2	              0

# saleor.graphql.warehousebenchmark stock bulk update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  stocks bulk update queries count                                        	         33	         33	              6

# saleor.graphql.warehousebenchmark stocks
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  stocks query                                                            	          7	          7	              0

# saleor.graphql.webhookbenchmark webhook events
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  webhooks                                                                	          8	          8	              0

# saleor.orderbenchmark fetch order prices
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fetch order prices                                                      	         32	         32	              6

# saleor.ordertest fetch
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fetch draft order lines info                                            	         16	         16	              1
  fetch draft order lines info extended                                   	         23	         23	              3

codecov · 2025-03-27T11:35:45Z

Codecov Report

Attention: Patch coverage is 95.53571% with 10 lines in your changes missing coverage. Please review.

Project coverage is 96.47%. Comparing base (d7b8487) to head (7586172).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...leor/graphql/order/mutations/draft_order_update.py	95.68%	5 Missing ⚠️
...eor/graphql/order/mutations/draft_order_cleaner.py	93.65%	4 Missing ⚠️
...leor/graphql/order/mutations/draft_order_create.py	96.15%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #17532   +/-   ##
=======================================
  Coverage   96.47%   96.47%           
=======================================
  Files         953      954    +1     
  Lines       76436    76493   +57     
=======================================
+ Hits        73738    73797   +59     
+ Misses       2698     2696    -2

☔ 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.

IKarbowiak self-assigned this Mar 25, 2025

IKarbowiak added skip changelog main labels Mar 25, 2025

IKarbowiak added 2 commits March 25, 2025 10:13

Update ShippingMethodUpdateMixin.process_shipping_method

13448b8

Ensure the DRAFT_ORDER_UPDATED webhook is not called in case nothing …

903a3ab

…changed

IKarbowiak changed the title ~~Update order mutations - explicitly save changed fields in DraftOrderUpdate~~ Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call DRAFT_ORDER_UPDATED event when nothing changed Mar 25, 2025

Update changelog

1010758

IKarbowiak mentioned this pull request Mar 25, 2025

Update upgrade guide - DraftOrderUpdate and OrderUpdate do not call webhooks anymore if nothing changed saleor/saleor-docs#1511

Merged

IKarbowiak added 2 commits March 25, 2025 11:11

Do not called user_Changed_address plugin method

ef341f5

Merge branch 'main' into ext-2001-ext-2010-update-draft-order-update-…

7586172

…and-create-main

IKarbowiak force-pushed the ext-2001-ext-2010-update-draft-order-update-and-create-main branch from bb91eee to 7586172 Compare March 27, 2025 11:20

IKarbowiak marked this pull request as ready for review March 27, 2025 11:58

IKarbowiak requested a review from a team March 27, 2025 11:58

korycins approved these changes Mar 31, 2025

View reviewed changes

korycins requested a review from a team March 31, 2025 07:38

fowczarek approved these changes Mar 31, 2025

View reviewed changes

IKarbowiak merged commit 108b617 into main Mar 31, 2025
13 of 14 checks passed

IKarbowiak deleted the ext-2001-ext-2010-update-draft-order-update-and-create-main branch March 31, 2025 08:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call `DRAFT_ORDER_UPDATED` event when nothing changed #17532

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call `DRAFT_ORDER_UPDATED` event when nothing changed #17532

IKarbowiak commented Mar 25, 2025 •

edited

Loading

db-queries bot commented Mar 27, 2025

codecov bot commented Mar 27, 2025 •

edited

Loading

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call DRAFT_ORDER_UPDATED event when nothing changed #17532

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call DRAFT_ORDER_UPDATED event when nothing changed #17532

Conversation

IKarbowiak commented Mar 25, 2025 • edited Loading

Impact

Docs

Pull Request Checklist

db-queries bot commented Mar 27, 2025

codecov bot commented Mar 27, 2025 • edited Loading

Codecov Report

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call `DRAFT_ORDER_UPDATED` event when nothing changed #17532

Update order mutations - explicitly save changed fields in DraftOrderUpdate, do not call `DRAFT_ORDER_UPDATED` event when nothing changed #17532

IKarbowiak commented Mar 25, 2025 •

edited

Loading

codecov bot commented Mar 27, 2025 •

edited

Loading