Valid address items extension. #15877

zedzior · 2024-04-25T18:31:17Z

I want to merge this change, because there is a need to accept some specific address values, which do not pass i18naddress package's validation.

The PR adds dedicated map, which will be used to replace input value with the one accepted by i18naddress library.

To discuss:
The map embedded in python module will be difficult to maintain.

Issue: https://linear.app/saleor/issue/MERX-258/bug-location-codes-not-mapped-in-i18n-validation-failing-validation

Docs: saleor/saleor-docs#1151

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

db-queries · 2024-04-25T19:02:22Z

Here is the report for 7c5af5a (saleor:merx-258-valid-address-items-extension)
Base comparison is 0d785b4.

Found 39 differences! (click me)

# 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                                                          	         25	         25	             10
  app extensions with filter[filter0]                                     	         24	         24	             10
  app extensions with filter[filter1]                                     	         12	         12	              2
  app extensions with filter[filter2]                                     	         24	         24	             10
  app extensions with filter[filter3]                                     	         12	         12	              2

# 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                                         	         67	         66	              6
- add checkout lines                                                      	         90	         92	             14
- add checkout lines catalogue discount applies                           	        188	        190	             15
- add checkout lines gift discount applies                                	        153	        155	             23
- add checkout lines multiple catalogue discount applies                  	        203	        205	             22
- add checkout lines order discount applies                               	        166	        168	             18
- add checkout lines with external shipping                               	        174	        175	             70
- add checkout lines with reservations                                    	        189	        193	             68
  add delivery to checkout                                                	         83	         83	             13
  add shipping to checkout                                                	         84	         84	             13
  checkout email update                                                   	         45	         45	              2
  checkout payment charge                                                 	         60	         60	             17
- checkout shipping address update                                        	         77	         78	              7
  checkout voucher code                                                   	         90	         90	             13
  complete checkout                                                       	        243	        243	             81
  complete checkout preorder                                              	        238	        238	             82
  complete checkout with digital line                                     	        281	        281	             95
  complete checkout with out of stock webhook                             	        245	        245	             81
  complete checkout with single line                                      	        245	        245	             81
  create checkout                                                         	         70	         70	              4
  create checkout with gift promotion                                     	        107	        107	             13
  create checkout with order promotion                                    	         92	         92	              4
  create checkout with reservations                                       	        159	        159	             28
  customer complete checkout                                              	        256	        256	             87
- customer complete checkout for cc                                       	        230	        231	             77
- update checkout lines                                                   	         83	         85	             14
- update checkout lines with reservations                                 	        195	        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                                                   	         57	         57	              4
  user checkout details with tax app                                      	         83	         83	             27

# 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                                                        	         27	         30	              1

# saleor.graphql.discountbenchmark promotion rule create
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
- promotion rule create                                                   	         20	         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                                                   	         35	         38	              0

# saleor.graphql.discountbenchmark promotion update
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
- promotion update                                                        	         13	         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                                                     	          3	          3	              0
  categories for federation query count                                   	          3	          3	              0
  category delete                                                         	         48	         48	              4
+ category view                                                           	         32	         28	              1

# saleor.graphql.productbenchmark collection
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
- collection add products                                                 	         20	         22	              5
  collection bulk delete                                                  	         27	         27	              3
+ collection view                                                         	         10	          7	              0
  collections for federation query count                                  	          4	          4	              0
- create collection                                                       	         35	         37	              5
- delete collection                                                       	         38	         40	              5
- remove products from collection                                         	         17	         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                                           	          9	          7	              0
+ filter products by boolean attributes                                   	         16	         14	              0
+ filter products by gift card                                            	         14	         12	              1
+ filter products by numeric attributes                                   	         15	         13	              0
  product create                                                          	         48	         48	              3
+ product details                                                         	         45	         41	              1
+ product translations                                                    	          7	          5	              0
+ products for federation query count                                     	         10	          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                                             	         10	          8	              0
+ retrieve product images                                                 	          6	          4	              0
+ retrieve product media                                                  	          6	          4	              0
+ retrive products with product types and attributes                      	          9	          7	              0
- update product                                                          	         69	         71	              5

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

# saleor.graphql.productbenchmark variant
  test name                                                               	left count 	right count	duplicate count
  ------------------------------------------------------------------------	-----------	-----------	---------------
  product variant bulk create                                             	         45	         45	              1
- product variant create                                                  	         59	         61	              3
+ products variants for federation query count                            	          8	          6	              1
+ retrieve variant list                                                   	         36	         34	              1
- update product variant                                                  	         60	         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

saleor/account/tests/test_account.py

korycins

I think, we should mention this change in docs for address-validation part: https://docs.saleor.io/docs/3.x/developer/address

saleor/account/i18n.py

codecov · 2024-05-07T13:13:12Z

Codecov Report

Attention: Patch coverage is 90.00000% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 93.98%. Comparing base (52cb0e0) to head (7c5af5a).
Report is 16 commits behind head on main.

Files	Patch %	Lines
saleor/account/i18n.py	83.33%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #15877      +/-   ##
==========================================
- Coverage   93.98%   93.98%   -0.01%     
==========================================
  Files         933      934       +1     
  Lines       72335    72530     +195     
  Branches     8513     8560      +47     
==========================================
+ Hits        67984    68165     +181     
- Misses       2783     2792       +9     
- Partials     1568     1573       +5

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

zedzior added address merchant Merchant Experience team topics labels Apr 25, 2024

zedzior self-assigned this Apr 25, 2024

zedzior force-pushed the merx-258-valid-address-items-extension branch from e853a0a to 8202225 Compare April 25, 2024 18:41

zedzior requested a review from a team April 25, 2024 19:09

korycins reviewed Apr 26, 2024

View reviewed changes

saleor/account/tests/test_account.py Show resolved Hide resolved

korycins requested a review from a team April 26, 2024 11:26

zedzior force-pushed the merx-258-valid-address-items-extension branch from 8202225 to 8612924 Compare April 26, 2024 12:57

zedzior added 6 commits April 26, 2024 15:02

Add custom address names mapping to expand valid address inputs.

4bf0e16

Add tests.

d0d98e6

Renaming.

3c72915

Add entry to changelog.

e65bd01

Fix lint.

652a9ad

Apply lower() and strip() when matching values with map.

1666460

zedzior force-pushed the merx-258-valid-address-items-extension branch from b7de589 to 1666460 Compare April 26, 2024 13:03

zedzior requested a review from korycins April 26, 2024 14:30

korycins reviewed May 7, 2024

View reviewed changes

saleor/account/i18n.py Outdated Show resolved Hide resolved

8r2y5 requested a review from a team May 7, 2024 11:33

zedzior added 2 commits May 7, 2024 14:18

Adjust map during its initialization.

7340c2f

Fix failing test.

7c5af5a

zedzior mentioned this pull request May 7, 2024

Add info about valid address items extension. saleor/saleor-docs#1151

Merged

zedzior requested a review from korycins May 7, 2024 14:13

8r2y5 approved these changes May 8, 2024

View reviewed changes

korycins approved these changes May 8, 2024

View reviewed changes

zedzior merged commit eabdab1 into main May 8, 2024
7 of 9 checks passed

zedzior deleted the merx-258-valid-address-items-extension branch May 8, 2024 11:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Valid address items extension. #15877

Valid address items extension. #15877

zedzior commented Apr 25, 2024 •

edited

db-queries bot commented Apr 25, 2024 •

edited

korycins left a comment

codecov bot commented May 7, 2024

Valid address items extension. #15877

Valid address items extension. #15877

Conversation

zedzior commented Apr 25, 2024 • edited

Impact

Docs

Pull Request Checklist

db-queries bot commented Apr 25, 2024 • edited

korycins left a comment

Choose a reason for hiding this comment

codecov bot commented May 7, 2024

Codecov Report

zedzior commented Apr 25, 2024 •

edited

db-queries bot commented Apr 25, 2024 •

edited