Skip address validation. #16008

zedzior · 2024-05-16T12:12:57Z

I want to merge this change, because there is a need to skip Saleor's default address validation.

This PR introduces skipValidation field in AddressInput type, with default value = False.

It adds validation_skipped to Address model, to indicate if validation has been omitted for particular address.

Validation skipping is allowed only for mutations specified in SKIP_ADDRESS_VALIDATION_PERMISSION_MAP with proper permissions.

This PR also refactors a bit warehouseCreate, warehouseUpdate and customerBulkUpdate mutations. They used to use validate_address_form instead of validate_address function, what was inconsistent among other mutations.

Issue: https://linear.app/saleor/project/address-validation-skipping-flags-530aa688d867

Impact

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

Docs

Link to documentation:

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

…ping.

…mutations; allow using 'AuthorizationFilters'.

db-queries · 2024-05-16T15:52:12Z

Here is the report for 7cb23cb (saleor:merx-442-skip-address-validation)
Missing base report (1cfa3ee). The results couldn't be compared.

No differences were found.

# saleor.graphql.accountbenchmark account
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  addresses for federation query count                                    	          9	          9	              2
  customers query                                                         	         51	         51	              0
  delete staff members                                                    	         40	         40	              0
  query staff user                                                        	         22	         22	              3
  staff create                                                            	         22	         22	              3
  staff update groups and permissions                                     	         35	         35	              5
  users for federation query count                                        	          8	          8	              3

# saleor.graphql.accountbenchmark permission group
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  groups for federation query count                                       	          3	          3	              0
  permission group create                                                 	         24	         24	              0
  permission group delete                                                 	         29	         29	              3
  permission group query                                                  	         14	         14	              0
  permission group update                                                 	         43	         43	              2
  permission group update remove users with manage staff                  	         35	         35	              3

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

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

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

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

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

# saleor.graphql.checkoutbenchmark checkout mutations
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  add billing address to checkout                                         	         80	         80	             10
  add checkout lines                                                      	         92	         92	             14
  add checkout lines catalogue discount applies                           	        190	        190	             15
  add checkout lines gift discount applies                                	        155	        155	             23
  add checkout lines multiple catalogue discount applies                  	        205	        205	             20
  add checkout lines order discount applies                               	        168	        168	             18
  add checkout lines with external shipping                               	        194	        194	             77
  add checkout lines with reservations                                    	        193	        193	             66
  add delivery to checkout                                                	         88	         88	             14
  add shipping to checkout                                                	         98	         98	             19
  checkout email update                                                   	         46	         46	              2
  checkout payment charge                                                 	         60	         60	             17
  checkout shipping address update                                        	         92	         92	             11
  checkout voucher code                                                   	        105	        105	             17
  complete checkout                                                       	        244	        244	             81
  complete checkout preorder                                              	        239	        239	             82
  complete checkout with digital line                                     	        282	        282	             95
  complete checkout with out of stock webhook                             	        246	        246	             81
  complete checkout with single line                                      	        246	        246	             81
  create checkout                                                         	         87	         87	              9
  create checkout with gift promotion                                     	        127	        127	             19
  create checkout with order promotion                                    	        109	        109	              9
  create checkout with reservations                                       	        159	        159	             28
  customer complete checkout                                              	        257	        257	             87
  customer complete checkout for cc                                       	        232	        232	             77
  update checkout lines                                                   	         85	         85	             14
  update checkout lines with reservations                                 	        199	        199	             79

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

# saleor.graphql.checkoutbenchmark homepage
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  user checkout details                                                   	         64	         64	              6
  user checkout details with tax app                                      	         85	         85	             28

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

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

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

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

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

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

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

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

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

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

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

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

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

# saleor.graphql.orderbenchmark fulfillment refund and return products
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fulfillment refund products order lines                                 	         61	         61	              0
  fulfillment return products order lines                                 	        103	        103	              7

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

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

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

# saleor.graphql.orderbenchmark order lines create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  order lines create                                                      	         95	         95	             17
  order lines create variants on promotion                                	        154	        154	             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                                                         	         18	         18	              6
  query page types                                                        	         25	         25	             12

# saleor.graphql.paymentbenchmark payment transactions
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  payment transactions                                                    	         54	         54	             20

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

# saleor.graphql.productbenchmark collection
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  collection add products                                                 	         22	         22	              5
  collection bulk delete                                                  	         27	         27	              3
  collection view                                                         	          7	          7	              0
  collections for federation query count                                  	          4	          4	              0
  create collection                                                       	         37	         37	              5
  delete collection                                                       	         40	         40	              5
  remove products from collection                                         	         19	         19	              5
  retrieve collection channel listings                                    	          5	          5	              0

# saleor.graphql.productbenchmark homepage
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  report product sales                                                    	         10	         10	              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                                            	         12	         12	              1
  filter products by numeric attributes                                   	         13	         13	              0
  product create                                                          	         48	         48	              3
  product details                                                         	         41	         41	              1
  product translations                                                    	          5	          5	              0
  products for federation query count                                     	          6	          6	              1
  products media for federation query count                               	          5	          5	              0
  products types for federation query count                               	          2	          2	              0
  retrieve channel listings                                               	         20	         20	              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                                                          	         71	         71	              5

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

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

# saleor.graphql.productbenchmark variant stocks
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  product variants stocks create                                          	         28	         28	              4
  product variants stocks create with single webhook called               	         27	         27	              4
  product variants stocks delete by id                                    	         29	         29	              4
  product variants stocks delete by sku                                   	         29	         29	              4
  product variants stocks delete with out of stock webhook many calls     	         25	         25	              3
  product variants stocks update by sku                                   	         27	         27	              4
  product variants stocks update byid                                     	         27	         27	              4
  query product variants stocks                                           	         10	         10	              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                                        	          7	          7	              0
  vouchers query without channel slug                                     	          7	          7	              0

# saleor.graphql.shippingbenchmark shipping zones
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  shipping zones query                                                    	          6	          6	              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                                        	         31	         31	              5

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

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

# saleor.orderbenchmark fetch order prices
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fetch order prices catalogue discount                                   	         45	         45	              6
  fetch order prices multiple catalogue discounts                         	        107	        107	             20

# saleor.ordertest fetch
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  fetch draft order lines info                                            	         18	         18	              1

…rom queries.

korycins · 2024-05-20T11:28:38Z

saleor/graphql/checkout/mutations/checkout_complete.py

-                    enable_normalization=True,
-                    instance=shipping_address,
-                )
+                if not shipping_address.validation_skipped:


What about case:

Update of checkout's address with proper permission and validation_skipped = True

Then update of the checkout's address but without proper permission.

Will we make a validation on checkoutComplete in that case or not?

Updating the address without skipping the validation will turn the validation_skipped flag to False. You can check the behaviour in test_address_update_address_with_skipped_validation.

korycins · 2024-05-20T11:33:51Z

saleor/graphql/account/types.py

+            "By default, Saleor accepts only address inputs matching ruleset from "
+            "[Google Address Data]{https://chromium-i18n.appspot.com/ssl-address), "
+            "using [i18naddress](https://github.com/mirumee/google-i18n-address) "
+            "library."


I thing that would be great to have here an additional hint, that for using the field, additional permission could be required, and each mutation that allows you to skip mutation will have more info about required permission.
WDYT?

I enriched the description as suggested.

zedzior added 14 commits May 16, 2024 14:06

Add 'skip_validation' field to 'AddressInput'.

438ccf7

Embed skipping validation inside AddressForm.

9fd9f27

Add more tests.

6d6c366

Change descriptions; update changelog."

c6335ca

Check permissions if requester is allowed to skip the validation.

03c7e98

Reafctor warehouse mutations.

2eec27c

Refactor 'createWarehouse' mutation to enable address validation skip…

d91203f

…ping.

Refactor 'updateWarehouse' mutation to enable address validation skip…

82e0858

…ping.

Return 'PERMISSION_DENIED' if perms not met; handle 'accountAddress' …

36f4561

…mutations; allow using 'AuthorizationFilters'.

Handle checkout mutations.

1efc357

Handle 'shopAddressUpdate' and 'acountUpdate' mutations.

794e66f

Handle 'orderUpdate' and 'bulkOrderUpdate' mutations.

e69abfa

Turn off address validation skipping for account* mutations.

b7a8a14

Add test for i18n.

1a0a2b4

zedzior added address 3.19 labels May 16, 2024

zedzior self-assigned this May 16, 2024

Change permissions for skipping the validation in checkout mutations.

dce179f

zedzior marked this pull request as ready for review May 16, 2024 14:13

zedzior force-pushed the merx-442-skip-address-validation branch from f70548e to 5d596cb Compare May 16, 2024 14:28

zedzior mentioned this pull request May 16, 2024

Skip address validation. #15985

Closed

13 tasks

Self review.

881a9ec

zedzior force-pushed the merx-442-skip-address-validation branch from 5d596cb to 881a9ec Compare May 16, 2024 15:28

zedzior requested review from a team May 16, 2024 16:07

zedzior added test deployment Deploy test environment for pull request labels May 17, 2024

github-actions bot temporarily deployed to merx-442-skip-address-validation May 17, 2024 08:07 Inactive

zedzior added 3 commits May 17, 2024 16:09

Set 'validation_skipped' flag; cover with tests."

66c960b

Handle 'checkoutComplete'.

9613759

Replace invalid city with invalid postal code in tests.

ddf99e5

github-actions bot temporarily deployed to merx-442-skip-address-validation May 17, 2024 15:56 Inactive

zedzior removed the test deployment Deploy test environment for pull request label May 17, 2024

zedzior added 2 commits May 17, 2024 19:02

Update changelog; update test descriptions; remove redundant fields f…

cd56c94

…rom queries.

Fix tests.

8758287

zedzior force-pushed the merx-442-skip-address-validation branch from d1fa265 to 8758287 Compare May 17, 2024 18:04

8r2y5 approved these changes May 20, 2024

View reviewed changes

Add description to address inputs in 'checkoutCreateInput'

e583797

yellowee added the test deployment Deploy test environment for pull request label May 20, 2024

github-actions bot temporarily deployed to merx-442-skip-address-validation May 20, 2024 11:25 Inactive

korycins reviewed May 20, 2024

View reviewed changes

Correct omitting address validation.

ff818a9

github-actions bot temporarily deployed to merx-442-skip-address-validation May 20, 2024 17:21 Inactive

zedzior added 2 commits May 21, 2024 12:53

Skip phone validation.

c45b7ec

Move _meta.exclude initialization from ModelMutation to BaseMutation.

e9c3b5a

github-actions bot temporarily deployed to merx-442-skip-address-validation May 21, 2024 13:12 Inactive

zedzior added 2 commits May 21, 2024 15:48

Enhance descriptions.

31001ff

Add more tests.

5fc7be8

github-actions bot temporarily deployed to merx-442-skip-address-validation May 21, 2024 14:38 Inactive

Skip address.phone formatting, when calling 'Address.as_data'.

7cb23cb

github-actions bot temporarily deployed to merx-442-skip-address-validation May 21, 2024 16:17 Inactive

yellowee added test deployment Deploy test environment for pull request and removed test deployment Deploy test environment for pull request labels May 22, 2024

github-actions bot temporarily deployed to merx-442-skip-address-validation May 22, 2024 05:38 Inactive

zedzior merged commit 140b683 into 3.19 May 22, 2024
11 checks passed

zedzior deleted the merx-442-skip-address-validation branch May 22, 2024 11:18

zedzior mentioned this pull request May 22, 2024

Skip address validation. #16034

Draft

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Skip address validation. #16008

Skip address validation. #16008

zedzior commented May 16, 2024 •

edited

db-queries bot commented May 16, 2024 •

edited

korycins May 20, 2024 •

edited

zedzior May 21, 2024

korycins May 20, 2024

zedzior May 21, 2024

Skip address validation. #16008

Skip address validation. #16008

Conversation

zedzior commented May 16, 2024 • edited

Impact

Docs

Pull Request Checklist

db-queries bot commented May 16, 2024 • edited

korycins May 20, 2024 • edited

Choose a reason for hiding this comment

zedzior May 21, 2024

Choose a reason for hiding this comment

korycins May 20, 2024

Choose a reason for hiding this comment

zedzior May 21, 2024

Choose a reason for hiding this comment

zedzior commented May 16, 2024 •

edited

db-queries bot commented May 16, 2024 •

edited

korycins May 20, 2024 •

edited