Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Graduate __experimental_woocommerce_blocks_checkout_update_order_from_request action to stable #5015

Merged
merged 5 commits into from
Nov 2, 2021
Merged

Graduate __experimental_woocommerce_blocks_checkout_update_order_from_request action to stable #5015

merged 5 commits into from
Nov 2, 2021

Conversation

opr
Copy link
Contributor

@opr opr commented Oct 27, 2021 •
edited
Loading

This PR will deprecate the __experimental_woocommerce_blocks_checkout_update_order_from_request action and replace it with woocommerce_blocks_checkout_update_order_from_request.

It also updates the docs relating to this hook. All references to the now deprecated hook have been replaced with the new hook, besides the one in the experimental interfaces document, which has changed to note that the prefixed hook is now deprecated.

Fixes #4997

Manual Testing

How to test the changes in this Pull Request:

  1. Add the following code somewhere that it'll be executed, for example your theme's functions.php file:
add_action( '__experimental_woocommerce_blocks_checkout_update_order_from_request', function( $order, $request ) { return; }, 10, 2 );

add_action( 'woocommerce_blocks_checkout_update_order_from_request', function( $order, $request ) {
	// For testing purposes, set the customer note to the user-agent from the request.
	$order->set_customer_note( $request->get_header('User-agent') );
	$order->save();
}, 10, 2 );
  1. Add the following directives to your wp-config.php file:
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
  1. Add a product to your cart and check out using the Checkout block. Ensure it goes through correctly.
  2. Check your debug.log file and ensure there's a deprecation message logged for __experimental_woocommerce_blocks_checkout_update_order_from_request.
  3. Ensure the order contains a customer note that is your browser's user agent.

Changelog

Deprecate the __experimental_woocommerce_blocks_checkout_update_order_from_request action in favour of woocommerce_blocks_checkout_update_order_from_request.

@rubikuserbot rubikuserbot requested review from a team and mikejolley and removed request for a team October 27, 2021 14:39
@opr opr added focus: blocks Specific work involving or impacting how blocks behave. focus: rest api Work impacting REST api routes. focus: documentation This issue is a request for better documentation. block: checkout Issues related to the checkout block. labels Oct 27, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2021 •
edited
Loading

Size Change: 0 B

Total Size: 1.12 MB

ℹ️ View Unchanged
Filename Size
build/active-filters-frontend.js 8.33 kB
build/active-filters.js 8.01 kB
build/all-products-frontend.js 23.3 kB
build/all-products.js 38 kB
build/all-reviews.js 9.57 kB
build/atomic-block-components/add-to-cart--atomic-block-components/button--atomic-block-components/image---a7e2bb9b.js 3.19 kB
build/atomic-block-components/add-to-cart--atomic-block-components/button.js 1.82 kB
build/atomic-block-components/add-to-cart--atomic-block-components/image--atomic-block-components/title.js 334 B
build/atomic-block-components/add-to-cart-frontend.js 8.51 kB
build/atomic-block-components/add-to-cart.js 7.84 kB
build/atomic-block-components/button-frontend.js 1.74 kB
build/atomic-block-components/button.js 875 B
build/atomic-block-components/category-list-frontend.js 465 B
build/atomic-block-components/category-list.js 470 B
build/atomic-block-components/image-frontend.js 1.88 kB
build/atomic-block-components/image.js 1.35 kB
build/atomic-block-components/price-frontend.js 2.14 kB
build/atomic-block-components/price.js 2.11 kB
build/atomic-block-components/rating-frontend.js 561 B
build/atomic-block-components/rating.js 565 B
build/atomic-block-components/sale-badge-frontend.js 859 B
build/atomic-block-components/sale-badge.js 869 B
build/atomic-block-components/sku-frontend.js 391 B
build/atomic-block-components/sku.js 392 B
build/atomic-block-components/stock-indicator-frontend.js 612 B
build/atomic-block-components/stock-indicator.js 611 B
build/atomic-block-components/summary-frontend.js 906 B
build/atomic-block-components/summary.js 912 B
build/atomic-block-components/tag-list-frontend.js 466 B
build/atomic-block-components/tag-list.js 471 B
build/atomic-block-components/title-frontend.js 1.64 kB
build/atomic-block-components/title.js 1.46 kB
build/attribute-filter-frontend.js 18.3 kB
build/attribute-filter.js 12.1 kB
build/blocks-checkout.js 21.1 kB
build/cart-blocks/accepted-payment-methods-frontend.js 1.38 kB
build/cart-blocks/checkout-button-frontend.js 1.23 kB
build/cart-blocks/empty-cart-frontend.js 349 B
build/cart-blocks/express-payment--checkout-blocks/express-payment--checkout-blocks/payment-frontend.js 4.73 kB
build/cart-blocks/express-payment-frontend.js 1.58 kB
build/cart-blocks/filled-cart-frontend.js 806 B
build/cart-blocks/items-frontend.js 303 B
build/cart-blocks/line-items-frontend.js 5.86 kB
build/cart-blocks/order-summary--checkout-blocks/billing-address--checkout-blocks/shipping-address-frontend.js 3.69 kB
build/cart-blocks/order-summary-frontend.js 7.42 kB
build/cart-blocks/totals-frontend.js 323 B
build/cart-frontend.js 52.9 kB
build/cart.js 50.6 kB
build/checkout-blocks/actions-frontend.js 1.51 kB
build/checkout-blocks/billing-address-frontend.js 2.67 kB
build/checkout-blocks/contact-information-frontend.js 3.89 kB
build/checkout-blocks/express-payment-frontend.js 1.93 kB
build/checkout-blocks/fields-frontend.js 346 B
build/checkout-blocks/order-note-frontend.js 1.56 kB
build/checkout-blocks/order-summary-frontend.js 12.8 kB
build/checkout-blocks/payment-frontend.js 4.58 kB
build/checkout-blocks/shipping-address-frontend.js 3.06 kB
build/checkout-blocks/shipping-methods-frontend.js 5.55 kB
build/checkout-blocks/terms-frontend.js 1.65 kB
build/checkout-blocks/totals-frontend.js 329 B
build/checkout-frontend.js 55.1 kB
build/checkout.js 54 kB
build/featured-category.js 7.73 kB
build/featured-product.js 9.42 kB
build/handpicked-products.js 6.27 kB
build/legacy-template.js 1.45 kB
build/mini-cart-component-frontend.js 45 kB
build/mini-cart-frontend.js 2.33 kB
build/mini-cart.js 5.72 kB
build/price-filter-frontend.js 14.4 kB
build/price-filter.js 9.65 kB
build/price-format.js 1.37 kB
build/product-best-sellers.js 6.62 kB
build/product-categories.js 3.38 kB
build/product-category.js 7.49 kB
build/product-new.js 6.77 kB
build/product-on-sale.js 7.11 kB
build/product-search.js 2.68 kB
build/product-tag.js 6.6 kB
build/product-top-rated.js 6.74 kB
build/products-by-attribute.js 7.7 kB
build/reviews-by-category.js 11.4 kB
build/reviews-by-product.js 13 kB
build/reviews-frontend.js 8.96 kB
build/single-product-frontend.js 26.6 kB
build/single-product.js 9.77 kB
build/stock-filter-frontend.js 8.77 kB
build/stock-filter.js 7.81 kB
build/vendors--atomic-block-components/add-to-cart--cart-blocks/order-summary--checkout-blocks/billing-ad--c5eb4dcd-frontend.js 16.1 kB
build/vendors--atomic-block-components/add-to-cart-frontend.js 4.77 kB
build/vendors--atomic-block-components/price--cart-blocks/line-items--cart-blocks/order-summary--checkout--8a3571de-frontend.js 5.71 kB
build/vendors--cart-blocks/line-items--checkout-blocks/order-summary-frontend.js 3.14 kB
build/vendors--cart-blocks/order-summary--checkout-blocks/billing-address--checkout-blocks/order-summary---eb4d2cec-frontend.js 5.02 kB
build/wc-blocks-data.js 11.3 kB
build/wc-blocks-editor-style-rtl.css 15.6 kB
build/wc-blocks-editor-style.css 15.6 kB
build/wc-blocks-google-analytics.js 1.98 kB
build/wc-blocks-middleware.js 1.47 kB
build/wc-blocks-registry.js 3.71 kB
build/wc-blocks-shared-context.js 1.54 kB
build/wc-blocks-shared-hocs.js 1.75 kB
build/wc-blocks-style-rtl.css 21.1 kB
build/wc-blocks-style.css 21 kB
build/wc-blocks-vendors-style-rtl.css 1.37 kB
build/wc-blocks-vendors-style.css 1.37 kB
build/wc-blocks-vendors.js 254 kB
build/wc-blocks.js 3.49 kB
build/wc-payment-method-bacs.js 806 B
build/wc-payment-method-cheque.js 806 B
build/wc-payment-method-cod.js 898 B
build/wc-payment-method-paypal.js 839 B
build/wc-payment-method-stripe.js 12.2 kB
build/wc-settings.js 2.91 kB

compressed-size-action

@opr opr changed the title Update/graduate update order from request Graduate __experimental_woocommerce_blocks_checkout_update_order_from_request action to stable Oct 27, 2021
@opr opr self-assigned this Oct 27, 2021
@opr opr marked this pull request as ready for review October 27, 2021 15:23
mikejolley
mikejolley approved these changes Oct 28, 2021
View reviewed changes
Copy link
Member

@mikejolley mikejolley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good here aside from missing versions which I assume you're adding before merging. Remember to regen docs too after doing that! Pre-approving with comments.

src/StoreApi/Routes/Checkout.php Outdated Show resolved Hide resolved
src/StoreApi/Routes/Checkout.php Outdated Show resolved Hide resolved
@github-actions github-actions bot added this to the 6.3.0 milestone Oct 28, 2021
@opr opr force-pushed the update/graduate-update-order-from-request branch from 7e36d2a to 80f6579 Compare November 2, 2021 09:02
@opr opr merged commit 9f1c8a7 into trunk Nov 2, 2021
@opr opr deleted the update/graduate-update-order-from-request branch November 2, 2021 09:21
@nielslange nielslange added type: enhancement The issue is a request for an enhancement. skip-changelog PRs that you don't want to appear in the changelog. and removed skip-changelog PRs that you don't want to appear in the changelog. labels Nov 16, 2021
@nielslange nielslange mentioned this pull request Nov 18, 2021
Merged
jonny-bull pushed a commit to jonny-bull/woocommerce-gutenberg-products-block that referenced this pull request Dec 14, 2021
@opr @jonny-bull
Graduate `__experimental_woocommerce_blocks_checkout_update_order_fro…
f7e5600 
…m_request` action to stable (woocommerce#5015)

* Deprecate __experimental_woocommerce_blocks_checkout_update_order_from_request

* Update docs to show new action and remove deprecated one

* Ensure correct args are passed to deprecated hook and update message

* Amend deprecated tag and add version numbers

* Remove incorrectly updated file from this PR
jonny-bull pushed a commit to jonny-bull/woocommerce-gutenberg-products-block that referenced this pull request Dec 16, 2021
@opr @jonny-bull
Graduate `__experimental_woocommerce_blocks_checkout_update_order_fro…
cca9728 
…m_request` action to stable (woocommerce#5015)

* Deprecate __experimental_woocommerce_blocks_checkout_update_order_from_request

* Update docs to show new action and remove deprecated one

* Ensure correct args are passed to deprecated hook and update message

* Amend deprecated tag and add version numbers

* Remove incorrectly updated file from this PR
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mikejolley mikejolley mikejolley approved these changes

Assignees

@opr opr

Labels
block: checkout Issues related to the checkout block. focus: blocks Specific work involving or impacting how blocks behave. focus: documentation This issue is a request for better documentation. focus: rest api Work impacting REST api routes. type: enhancement The issue is a request for an enhancement.
Projects
None yet
Milestone
6.3.0
Development

Successfully merging this pull request may close these issues.

Graduate __experimental_woocommerce_blocks_checkout_update_order_from_request PHP action to stable.
3 participants
@opr @mikejolley @nielslange