Add shipping partner suggestions api #37155

moon0326 · 2023-03-09T22:02:00Z

All Submissions:

Have you followed the WooCommerce Contributing guideline?
Does your code follow the WordPress' coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

This PR adds /wp-json/wp-admin/shipping-partner-suggestions. The endpoint is designed to be used with the shipping cost task.

Default shipping list test

When woocommerce_show_marketplace_suggestions option is set to no, the endpoint should use the default shipping partner list

Make sure _transient_woocommerce_admin_shipping_partner_suggestions_specs optoin does not exist.
Set woocommerce_show_marketplace_suggestions option to no
Acces /wp-json/wp-admin/shipping-partner-suggestions
Confirm the endpoint returns a valid JSON.
Confirm _transient_woocommerce_admin_shipping_partner_suggestions_specs option still does not exist.

Getting the list from WCCOM

Setup your local WCCOM env with https://github.com/Automattic/woocommerce.com/pull/16291 branch.
Open this file and change the DATA_SOURCES to your local WCCOM.
Make sure woocommerce_show_marketplace_suggestions is set to yes
Make sure _transient_woocommerce_admin_shipping_partner_suggestions_specs does not exist.
Acces /wp-json/wp-admin/shipping-partner-suggestions
Confirm the endpoint returns a valid JSON
Confirm _transient_woocommerce_admin_shipping_partner_suggestions_specs exists.

*Depending on your local setup, you might need to set WP_PROXY_HOST to access your local WCCOM env from your WooCommerce dev.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you created a changelog file for each project being changed, ie pnpm --filter=<project> changelog add?
Have you included testing instructions?

FOR PR REVIEWER ONLY:

I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

github-actions · 2023-03-09T22:15:16Z

Test Results Summary

Commit SHA: 9ff33fe

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	1m 5s
E2E Tests	191	0	0	10	0	201	14m 27s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

codecov · 2023-03-09T22:34:53Z

Codecov Report

Merging #37155 (9ff33fe) into trunk (be43265) will decrease coverage by 0.0%.
The diff coverage is 27.5%.

Additional details and impacted files

@@            Coverage Diff             @@
##             trunk   #37155     +/-   ##
==========================================
- Coverage     46.7%    46.7%   -0.0%     
- Complexity   17183    17197     +14     
==========================================
  Files          429      429             
  Lines        64799    64893     +94     
==========================================
+ Hits         30251    30287     +36     
- Misses       34548    34606     +58

Impacted Files	Coverage Δ
...mmerce/includes/admin/class-wc-admin-importers.php	`0.0% <0.0%> (ø)`
...rters/class-wc-product-csv-importer-controller.php	`36.1% <28.6%> (ø)`
.../includes/import/class-wc-product-csv-importer.php	`75.1% <44.4%> (+0.2%)`	⬆️
...e/includes/import/abstract-wc-product-importer.php	`63.7% <100.0%> (ø)`

... and 16 files with indirect coverage changes

chihsuan

Thanks for working on it! @moon0326

I just left some comments and I think we should replace DefaultPaymentGateways with DefaultShippingPartners.

chihsuan · 2023-03-13T04:33:09Z

plugins/woocommerce/src/Admin/Features/ShippingPartnerSuggestions/DefaultShippingPartners.php

+				'is_visible'        => array(
+					self::get_rules_for_countries( array( 'MX', 'CO' ) ),
+				),
+				'available_layouts' => array( 'single' ),


Should it be "row" layout?

@chihsuan Thank you for catching it 🙏

Updated in 302ffe0

...ins/woocommerce/src/Admin/Features/ShippingPartnerSuggestions/ShippingPartnerSuggestions.php

plugins/woocommerce/src/Admin/API/ShippingPartnerSuggestions.php

chihsuan · 2023-03-13T04:38:40Z

plugins/woocommerce/src/Admin/API/ShippingPartnerSuggestions.php

+					'args'                => array(
+						'force_default_suggestions' => array(
+							'type'        => 'boolean',
+							'description' => __( 'Return the default shipping partner suggestions when woocommerce_show_shipping_partner_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no', 'woocommerce' ),


Do you know where we set woocommerce_show_shipping_partner_suggestions options? And I guess we don't need woocommerce_setting_payments_recommendations_hidden?

That description needs an update 😄 It only works when woocommerce_show_marketplace_suggestions is set to false and force_default_suggestions is set to true

Code is here: https://github.com/woocommerce/woocommerce/pull/37155/files#diff-d0513d5e143fc2d4484715f024daa474107356bc224e4fa6e20bea70c04c03fdR97

@chihsuan Updated in 6625537 🙏

Co-authored-by: Chi-Hsuan Huang <chihsuan.tw@gmail.com>

…ons/ShippingPartnerSuggestions.php Co-authored-by: Chi-Hsuan Huang <chihsuan.tw@gmail.com>

moon0326 · 2023-03-13T23:45:03Z

plugins/woocommerce/src/Admin/API/ShippingPartnerSuggestions.php

+					'type'        => 'array',
+					'items'       => array(
+						'type' => 'string',
+						'enum' => array( 'row', 'column' ),


FYI, I borrowed row and column concept from CSS flex-direction.

Layout row represents a smaller banner (?) that can be placed with other smaller banners in a single row.
Layout column represents a banner that takes the whole row width.

I think i'd go with 'narrow' and 'wide' but no objections to this way either 😀

chihsuan · 2023-03-14T02:03:54Z

plugins/woocommerce/src/Admin/API/ShippingPartnerSuggestions.php

+				),
+				'is_visible'        => array(
+					'description' => __( 'Suggestion visibility.', 'woocommerce' ),
+					'type'        => 'boolean',


@moon0326 I just noticed that is_visible is not a boolean value in the API response. Should we change it to boolean?

Good catch!

It should be set to boolean after rule evaluation. Updated in 88bf071

chihsuan · 2023-03-14T02:19:04Z

BTW, looks like PHP linting is failing (also WCCOM side).

chihsuan

Nice work! Looks good to me and tested well. 💯

rjchow · 2023-03-17T05:17:01Z

plugins/woocommerce/src/Admin/Features/ShippingPartnerSuggestions/DefaultShippingPartners.php

+	 * @return array Default specs.
+	 */
+	public static function get_all() {
+		$asset_base_url      = WC()->plugin_url() . 'assets/images/shipping_partners/';


I think there's a missing slash between woocommerce and assets in the path - I get a 404 with the URL that's generated but its found if i add the slash

rjchow

Left two comments but lgtm overall, thanks! We can iterate on this with the UI work next 😄

chihsuan

Looks good!

Add wp-json/wc-admin/shipping-partner-suggestions API endpoint

a8ef481

moon0326 requested review from a team, adrianduffell and rjchow March 9, 2023 22:02

github-actions bot added focus: react admin [team:Ghidorah] plugin: woocommerce Issues related to the WooCommerce Core plugin. labels Mar 9, 2023

lint fix

ddf78c8

lint fix

e23dfff

chihsuan requested changes Mar 13, 2023

View reviewed changes

moon0326 and others added 5 commits March 13, 2023 16:03

Update plugins/woocommerce/src/Admin/API/ShippingPartnerSuggestions.php

1edc288

Co-authored-by: Chi-Hsuan Huang <chihsuan.tw@gmail.com>

Update plugins/woocommerce/src/Admin/Features/ShippingPartnerSuggesti…

f043308

…ons/ShippingPartnerSuggestions.php Co-authored-by: Chi-Hsuan Huang <chihsuan.tw@gmail.com>

Change row to column and column to row -- I put them incorrectly

302ffe0

Fix force_default_suggestions description

6625537

Chagne row to colmun and column to row

77f78f8

moon0326 commented Mar 13, 2023

View reviewed changes

chihsuan reviewed Mar 14, 2023

View reviewed changes

Override is_visible value after evaluation

88bf071

chihsuan previously approved these changes Mar 16, 2023

View reviewed changes

rjchow reviewed Mar 17, 2023

View reviewed changes

rjchow previously approved these changes Mar 17, 2023

View reviewed changes

Lint fix

3d43434

moon0326 dismissed stale reviews from rjchow and chihsuan via 3d43434 March 20, 2023 04:14

moon0326 added 2 commits March 19, 2023 21:34

Lint fix

80a11bb

Correct asset path

9ff33fe

chihsuan approved these changes Mar 20, 2023

View reviewed changes

moon0326 merged commit 1aa899a into trunk Mar 20, 2023
18 of 20 checks passed

moon0326 deleted the add/36281-shipping-partners-suggestion-api branch March 20, 2023 05:37

github-actions bot added this to the 7.6.0 milestone Mar 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add shipping partner suggestions api #37155

Add shipping partner suggestions api #37155

moon0326 commented Mar 9, 2023 •

edited by chihsuan

github-actions bot commented Mar 9, 2023 •

edited

codecov bot commented Mar 9, 2023 •

edited

chihsuan left a comment

chihsuan Mar 13, 2023

moon0326 Mar 13, 2023

moon0326 Mar 13, 2023

chihsuan Mar 13, 2023

moon0326 Mar 13, 2023

moon0326 Mar 13, 2023

moon0326 Mar 13, 2023 •

edited

rjchow Mar 17, 2023

chihsuan Mar 14, 2023

moon0326 Mar 16, 2023

chihsuan commented Mar 14, 2023

chihsuan left a comment

rjchow Mar 17, 2023

rjchow left a comment

chihsuan left a comment

Add shipping partner suggestions api #37155

Add shipping partner suggestions api #37155

Conversation

moon0326 commented Mar 9, 2023 • edited by chihsuan

All Submissions:

Changes proposed in this Pull Request:

Other information:

FOR PR REVIEWER ONLY:

github-actions bot commented Mar 9, 2023 • edited

Test Results Summary

codecov bot commented Mar 9, 2023 • edited

Codecov Report

chihsuan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moon0326 Mar 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chihsuan commented Mar 14, 2023

chihsuan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rjchow left a comment

Choose a reason for hiding this comment

chihsuan left a comment

Choose a reason for hiding this comment

moon0326 commented Mar 9, 2023 •

edited by chihsuan

github-actions bot commented Mar 9, 2023 •

edited

codecov bot commented Mar 9, 2023 •

edited

moon0326 Mar 13, 2023 •

edited