Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/docs/internal-developers/blocks/feature-flags-and-experimen...

115 lines
15 KiB
Markdown
Raw Normal View History

Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
# Features Flags and Experimental Interfaces <!-- omit in toc -->
## Table of contents <!-- omit in toc -->
Correct broken *.md links (https://github.com/woocommerce/woocommerce-blocks/pull/7108)
2022-09-12 04:29:24 +00:00
- [Blocks behind flags](#blocks-behind-flags)
- [Feature plugin flag](#feature-plugin-flag)
- [Experimental flag](#experimental-flag)
- [Features behind flags](#features-behind-flags)
- [Feature plugin flag](#feature-plugin-flag-1)
- [Experimental plugin flag](#experimental-plugin-flag)
- [Processes and commands that use a flag](#processes-and-commands-that-use-a-flag)
- [Usages of `__experimental` prefix](#usages-of-__experimental-prefix)
- [PHP filters and actions](#php-filters-and-actions)
- [JS methods](#js-methods)
- [Slots](#slots)
- [Misc](#misc)
- [Usages of `experimental` prefix](#usages-of-experimental-prefix)
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
We have feature gating system setup in our plugin that defines what is accessible to the public and what is not, it has three phases:
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
- **Core flag `WOOCOMMERCE_BLOCKS_PHASE=1`:** anything that is not hidden behind a flag, falls under this category, and it contains all of the code that runs on WooCommerce Core plugin.
- **Feature plugin flag `WOOCOMMERCE_BLOCKS_PHASE=2`**: anything that is behind this flag is code that is shipped to our [feature plugin](https://wordpress.org/plugins/woo-gutenberg-products-block/), the files of blocks behind this flag are also present in WooCommerce Core, just not active.
- **Experimental flag `WOOCOMMERCE_BLOCKS_PHASE=3`**: This flag contains things that we're not shipping yet, so unfinished work mostly. These features are only available in developer builds of the plugin.
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
We also use an `__experimental` prefix for any experimental interfaces. This is a signal to those reading our code that it should not be implemented in for production use. Currently this prefix is used in the following ways:
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
- Prefixing references that are experimental. An example would be PHP action or filter slugs.
- Prefixing functions or methods that are experimental.
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
## Blocks behind flags
The majority of our feature flagging is blocks, this is a list of them:
### Feature plugin flag
### Experimental flag
Foundation of New Product Collection Block (https://github.com/woocommerce/woocommerce-blocks/pull/9352) * Add Products Collection block scaffolding This commit adds the initial scaffolding for the new Products Collection block. It includes the creation of new files (block.json, edit.tsx, index.tsx and ProductsCollection.php) and additions to existing files (webpack-entries.js and BlockTypesController.php). The block is marked as experimental and currently displays a static "Product collection" text in both the editor and the frontend. * Add Product Template block and integrate with Products Collection block This commit introduces the new Product Template block and integrates it with the existing Products Collection block. The changes include: - Creation of the Product Template block, including its block.json, edit.tsx, icon.tsx, index.tsx, and save.tsx files. - Modification of the Products Collection block, adding an icon.tsx file and updating its edit.tsx and index.tsx files. - Updates to the webpack-entries.js file to include the new Product Template block. - Addition of the ProductTemplate class in the src/BlockTypes directory. - Inclusion of the ProductTemplate class in the src/BlockTypesController.php file. * Enhance product-template block with context and styling This commit adds various enhancements to the product-template block. It includes: - Introduce `usesContext` and `supports` properties to the block.json file - Update the edit.tsx file to use BlockContextProvider and add query logic - Add an editor.scss file for styling the product-template block in the editor - Extend the products-collection block.json file with new properties - Modify the products-collection edit.tsx file to include instanceId and useEffect These changes improve the product-template block by providing better context handling and styling options. * Add 'woocommerce/product-template' to supported inner blocks and improve product-template editing This commit adds 'woocommerce/product-template' as a supported inner block for various product elements, including button, image, rating, sale-badge, SKU, and stock-indicator. It also improves the editing experience for the product-template block by memoizing the block previews and rendering them more efficiently. This should lead to a smoother editing experience and better performance in the block editor. * Add product title and summary variations for Products Collection block - Add default spacing between product elements in `style.scss` - Register product title and summary element variations in `products-collection` block - Create utility for registering element variations - Extend core elements with WooCommerce namespace * Set inherit to false by default and other improvements This commit introduces several changes to the ProductsCollection block: 1. Set the "inherit" property to false in block.json, disabling inheritance by default. 2. Remove the default styles for inner blocks in the edit.tsx file. 3. Add a save function in the index.tsx file, and create a save.tsx file to handle saving the block. 4. Update the ProductTemplate.php file to properly render the block content based on the changes. 5. Remove the render function from the ProductsCollection.php file, as it is no longer necessary. These changes improve the functionality and flexibility of the ProductsCollection block, allowing for better customization and control over the block's appearance and behavior. * Fix pagination issue * Minor code quality improvments * Register product blocks only in experimental builds - Wrap registerBlockType calls in product-template and products-collection with isExperimentalBuild check to enable block registration only in experimental builds. - Update the default value for the perPage property in products-collection/block.json from null to 9, setting a default display of 9 items per page. * Add experimental flag to PHP file * Update documentation for feature flags - Add Products Collection and Product Template blocks to the list of experimental flags in the feature-flags-and-experimental-interfaces.md file. - Include references to PHP and webpack flags for both blocks. * Change default order and orderBy values in block.json - Update the default 'order' value from 'desc' to 'asc'. - Update the default 'orderBy' value from 'date' to 'title'. * Refactor experimental block registration and remove unused file - Replace `isExperimentalBuild()` with `registerExperimentalBlockType()` in product-template/index.tsx. - Remove unused file types.ts in product-template directory. - Add `get_block_type_script()` function to ProductTemplate.php and ProductsCollection.php to return null. * Update variation names in product summary and product title elements Updated variation names for product summary and product title elements to match the new products-collection namespace. The previous variation names used the product-query namespace which will be deprecated. This change ensures that the correct variation names are used for these elements in the products-collection block. * Rename 'Products Collection' to 'Product Collection' - Renamed all instances of "products-collection" to "product-collection" across multiple files. - Adjusted related types and method calls to match the new naming convention. - Updated documentation and feature flags to reflect the name change. - Made necessary changes in `BlockTypesController.php` and `bin/webpack-entries.js`. * Hide product-template block from inserter - Added "woocommerce/product-collection" to the list of parent blocks in `product-template/block.json`. - Added `"inserter": false` to the "supports" section to disable the option of inserting this block through the editor inserter component. * Fix Eslint error
2023-05-15 08:51:49 +00:00
- Product Collection ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/17007169ea5f61e36903d7ca79902794cbb45100/src/BlockTypesController.php#L228) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/17007169ea5f61e36903d7ca79902794cbb45100/bin/webpack-entries.js#L71-L73)).
Update experimental flags
2023-07-10 14:50:05 +00:00
- Product Gallery ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/e3fe996251b270d45ecc73207ea4ad587c2dbc78/src/BlockTypesController.php#L232) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/e3fe996251b270d45ecc73207ea4ad587c2dbc78/bin/webpack-entries.js#L50-L52C3)).
Foundation of New Product Collection Block (https://github.com/woocommerce/woocommerce-blocks/pull/9352) * Add Products Collection block scaffolding This commit adds the initial scaffolding for the new Products Collection block. It includes the creation of new files (block.json, edit.tsx, index.tsx and ProductsCollection.php) and additions to existing files (webpack-entries.js and BlockTypesController.php). The block is marked as experimental and currently displays a static "Product collection" text in both the editor and the frontend. * Add Product Template block and integrate with Products Collection block This commit introduces the new Product Template block and integrates it with the existing Products Collection block. The changes include: - Creation of the Product Template block, including its block.json, edit.tsx, icon.tsx, index.tsx, and save.tsx files. - Modification of the Products Collection block, adding an icon.tsx file and updating its edit.tsx and index.tsx files. - Updates to the webpack-entries.js file to include the new Product Template block. - Addition of the ProductTemplate class in the src/BlockTypes directory. - Inclusion of the ProductTemplate class in the src/BlockTypesController.php file. * Enhance product-template block with context and styling This commit adds various enhancements to the product-template block. It includes: - Introduce `usesContext` and `supports` properties to the block.json file - Update the edit.tsx file to use BlockContextProvider and add query logic - Add an editor.scss file for styling the product-template block in the editor - Extend the products-collection block.json file with new properties - Modify the products-collection edit.tsx file to include instanceId and useEffect These changes improve the product-template block by providing better context handling and styling options. * Add 'woocommerce/product-template' to supported inner blocks and improve product-template editing This commit adds 'woocommerce/product-template' as a supported inner block for various product elements, including button, image, rating, sale-badge, SKU, and stock-indicator. It also improves the editing experience for the product-template block by memoizing the block previews and rendering them more efficiently. This should lead to a smoother editing experience and better performance in the block editor. * Add product title and summary variations for Products Collection block - Add default spacing between product elements in `style.scss` - Register product title and summary element variations in `products-collection` block - Create utility for registering element variations - Extend core elements with WooCommerce namespace * Set inherit to false by default and other improvements This commit introduces several changes to the ProductsCollection block: 1. Set the "inherit" property to false in block.json, disabling inheritance by default. 2. Remove the default styles for inner blocks in the edit.tsx file. 3. Add a save function in the index.tsx file, and create a save.tsx file to handle saving the block. 4. Update the ProductTemplate.php file to properly render the block content based on the changes. 5. Remove the render function from the ProductsCollection.php file, as it is no longer necessary. These changes improve the functionality and flexibility of the ProductsCollection block, allowing for better customization and control over the block's appearance and behavior. * Fix pagination issue * Minor code quality improvments * Register product blocks only in experimental builds - Wrap registerBlockType calls in product-template and products-collection with isExperimentalBuild check to enable block registration only in experimental builds. - Update the default value for the perPage property in products-collection/block.json from null to 9, setting a default display of 9 items per page. * Add experimental flag to PHP file * Update documentation for feature flags - Add Products Collection and Product Template blocks to the list of experimental flags in the feature-flags-and-experimental-interfaces.md file. - Include references to PHP and webpack flags for both blocks. * Change default order and orderBy values in block.json - Update the default 'order' value from 'desc' to 'asc'. - Update the default 'orderBy' value from 'date' to 'title'. * Refactor experimental block registration and remove unused file - Replace `isExperimentalBuild()` with `registerExperimentalBlockType()` in product-template/index.tsx. - Remove unused file types.ts in product-template directory. - Add `get_block_type_script()` function to ProductTemplate.php and ProductsCollection.php to return null. * Update variation names in product summary and product title elements Updated variation names for product summary and product title elements to match the new products-collection namespace. The previous variation names used the product-query namespace which will be deprecated. This change ensures that the correct variation names are used for these elements in the products-collection block. * Rename 'Products Collection' to 'Product Collection' - Renamed all instances of "products-collection" to "product-collection" across multiple files. - Adjusted related types and method calls to match the new naming convention. - Updated documentation and feature flags to reflect the name change. - Made necessary changes in `BlockTypesController.php` and `bin/webpack-entries.js`. * Hide product-template block from inserter - Added "woocommerce/product-collection" to the list of parent blocks in `product-template/block.json`. - Added `"inserter": false` to the "supports" section to disable the option of inserting this block through the editor inserter component. * Fix Eslint error
2023-05-15 08:51:49 +00:00
- Product Template ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/17007169ea5f61e36903d7ca79902794cbb45100/src/BlockTypesController.php#L229) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/17007169ea5f61e36903d7ca79902794cbb45100/bin/webpack-entries.js#L74-L76)).
Add new `Product Average Rating` block (https://github.com/woocommerce/woocommerce-blocks/pull/10207) * Add new Product Average Rating block * Add new blocks to the feature flag docs * Translate 'No ratings' * Fix condition * Small improvements after review * Avoid duplication of styles * Update supports in php class
2023-07-19 09:21:30 +00:00
- Product Average Rating ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/1111e2fb9d6f5074df96a444b99e2fc00e4eb8d1/src/BlockTypesController.php#L229) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/1111e2fb9d6f5074df96a444b99e2fc00e4eb8d1/bin/webpack-entries.js#L68-L70))
- Product Rating Stars ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/trunk/src/BlockTypesController.php#L230) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/trunk/bin/webpack-entries.js#L68-L70))
- Product Rating Counter ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/trunk/src/BlockTypesController.php#L229) | [webpack flag](https://github.com/woocommerce/woocommerce-blocks/blob/trunk/bin/webpack-entries.js#L71-L73))
Update feature flags documentation (https://github.com/woocommerce/woocommerce-blocks/pull/9013) * Update feature flags documentation * removed doc for unused cart and checkout experimental flags (https://github.com/woocommerce/woocommerce-blocks/pull/9015) --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>
2023-04-13 07:26:55 +00:00
- ⚛️ Add to cart ([JS flag](https://github.com/woocommerce/woocommerce-blocks/blob/dfd2902bd8a247b5d048577db6753c5e901fc60f/assets/js/atomic/blocks/product-elements/add-to-cart/index.ts#L26-L29)).
Add an endpoint for getting pay for order orders (https://github.com/woocommerce/woocommerce-blocks/pull/8960) (https://github.com/woocommerce/woocommerce-blocks/pull/10199) * Register order route * Get order it * Add order schema * Check authorization for getting the order * Add order data to the response * Add order schema for the endpoint * Move validation check to order controller * Update the error codes * Add order item schema * Check if the order is associated with current user * Update order schema to match cart schema * Update order item schema to match cart item schema * Add product item trait * Update sold individually property * Allow guests to pay for order * Update wording for logged out customers * Allow getting all orders from the endpoint * Add inline explanation for pay_for_order capability * Remove unused $user_id and $order variables * Remove duplicate pay_for_order capability check from validate_order_key * Update exception wording when missing order id or key, or user mismatch * Ensure $order_key is not null to avoid fatal error when left blank * Resolve linting errors in order route class * Adjust order ID description * Create an abstract item schema * Remove unused properties * Remove unused properties * Add billing email validation * Allow to use the order endpoint in dev build only * Add order status property * Fix coupon and fee handling * Update documentation for feature flags * Update typo in total fees tax * Update typo in tax lines * Add missing payment methods to cart response --------- Co-authored-by: Mike Jolley <mike.jolley@me.com>
2023-07-19 13:49:46 +00:00
- Order Route ([PHP flag](https://github.com/woocommerce/woocommerce-blocks/blob/b4a9dc9334f82c09f533b0f88c947b5c34e4e546/src/StoreApi/RoutesController.php#L65-L67))
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
## Features behind flags
We also have individual features or code blocks behind a feature flag, this is a list of them:
### Feature plugin flag
Update feature flags documentation (https://github.com/woocommerce/woocommerce-blocks/pull/9013) * Update feature flags documentation * removed doc for unused cart and checkout experimental flags (https://github.com/woocommerce/woocommerce-blocks/pull/9015) --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>
2023-04-13 07:26:55 +00:00
- ⚛️ Product Price new controls ([JS flag](https://github.com/woocommerce/woocommerce-blocks/blob/74badf254ecfe0c7811713a0f847a87f139c69c3/assets/js/atomic/blocks/product-elements/price/supports.ts#L14-L37)).
- ⚛️ Product Title new controls ([JS flag 1](https://github.com/woocommerce/woocommerce-blocks/blob/fd8eeb7f49f0454d746d581bc892cf3c2d9e30cc/assets/js/atomic/blocks/product-elements/title/attributes.ts#L25-L32) | [JS flag 2-1](https://github.com/woocommerce/woocommerce-blocks/blob/df6d820bb47459d56c1329729ab8c364a1b8fddc/assets/js/atomic/blocks/product-elements/title/block.tsx#L84) | [JS flag 2-2](https://github.com/woocommerce/woocommerce-blocks/blob/df6d820bb47459d56c1329729ab8c364a1b8fddc/assets/js/atomic/blocks/product-elements/title/block.tsx#L88) | [JS flag 2-3](https://github.com/woocommerce/woocommerce-blocks/blob/df6d820bb47459d56c1329729ab8c364a1b8fddc/assets/js/atomic/blocks/product-elements/title/block.tsx#L110) | [JS flag 2-4](https://github.com/woocommerce/woocommerce-blocks/blob/df6d820bb47459d56c1329729ab8c364a1b8fddc/assets/js/atomic/blocks/product-elements/title/block.tsx#L114) | [JS flag 3-1](https://github.com/woocommerce/woocommerce-blocks/blob/c734f3e846b8da7d49a03347d92354efd786251f/assets/js/atomic/blocks/product-elements/title/edit.tsx#L45-L52) | [JS flag 3-2](https://github.com/woocommerce/woocommerce-blocks/blob/c734f3e846b8da7d49a03347d92354efd786251f/assets/js/atomic/blocks/product-elements/title/edit.tsx#L98)).
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
## Processes and commands that use a flag
Allow extensions to filter Total label (https://github.com/woocommerce/woocommerce-blocks/pull/3716) * Allow extensions to filter totals label * Add docs
2021-01-21 14:45:31 +00:00
- `npm run build:deploy` uses the feature plugin flag ([env flag](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/c0de18ec0a798c072420c67a689e4cc4d3ac77c9/package.json#L28)).
Update experimental flags documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4017)
2021-04-01 09:34:09 +00:00
- GitHub actions uses the experimental flag when running automated tests ([env flags 1](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4cedb65367be0d1c4c1f9dd9c016e3b1325cf92e/.github/workflows/php-js-e2e-tests.yml) | [env flags 2](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4cedb65367be0d1c4c1f9dd9c016e3b1325cf92e/.github/workflows/unit-tests.yml)).
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- webpack creates a `blocks.ini` when running ([env flag](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/bin/webpack-configs.js#L110-L119)).
Allow extensions to filter Total label (https://github.com/woocommerce/woocommerce-blocks/pull/3716) * Allow extensions to filter totals label * Add docs
2021-01-21 14:45:31 +00:00
- webpack filters out experimental blocks when building. ([env flag](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/b3a9753d8b7dae18b36025d09fbff835b8365de0/bin/webpack-entries.js#L61-L66)).
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- certain E2E tests are skipped if the environment is not met ([env flag 1](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/backend/cart.test.js#L26) | [env flag 2](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/backend/checkout.test.js#L26) | [env flag 3](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/backend/mini-cart.test.js#L18) | [env flag 4](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/backend/single-product.test.js#L8) | [env flag 5](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/frontend/cart.test.js#L29) | [env flag 6](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/961c0c476d4228a218859c658c42f9b6eebfdec4/tests/e2e/specs/frontend/checkout.test.js#L32)).
Add new doc referencing feature flags and experimental interfaces. (https://github.com/woocommerce/woocommerce-blocks/pull/3348) * add doc for feature flag and experimental interfaces * add new doc to TOC * update pull request template to include checklist item for experimental/feature flag items * tweak wording for experimental prefix * fix bad formatting of bold for lines * fix double slash in url * add missing sentence case * remove account signup as that is not included in Cart and Checkout block logic. * Fix typo
2020-10-30 14:35:50 +00:00
## Usages of `__experimental` prefix
Add missing experimental hook to docs (https://github.com/woocommerce/woocommerce-blocks/pull/3508)
2020-12-07 11:46:22 +00:00
Update feature flags and experimental interfaces document. (https://github.com/woocommerce/woocommerce-blocks/pull/4750) * add missing blocks and update old links * features behind a feature flag * update filters and JS methods * Apply suggestions from code review Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com> Co-authored-by: Darren Ethier <darren@roughsmootheng.in> Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com>
2021-09-16 18:50:33 +00:00
### PHP filters and actions
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
Add Typescript to /blocks-registry/payment-methods (https://github.com/woocommerce/woocommerce-blocks/pull/4702) * Type payment method under /block-registry * Type assertions and add them back to PaymentMethodConfig * Type ExpressPaymentMethodConfig * Fix comment on payments types * Fix CanMakePayment type * Fix assertion for payment methods and the savedTokenComponent property Because class properties come from the config object, they will never be null except if somebody explicitly adds them the the object with a value of null. Which is not the case for savedTokenComponent for example, because it's optional and that's why we check it like this paymentMethods[ activePaymentMethod ]?.savedTokenComponent * Add the complete CanMakePaymentReturnType and account for null for PaymentMethod.icons - canMakePayment can also return a Promise and this was not included in the type definition - in PaymentMethodConfig's constructor we also need to account for extensions passing {icons: null}. * Revert Fix assertion for payment methods and the savedTokenComponent property * Fix failing tests because of savedTokenComponent I've reverted my changes and left the initialization of savedTokenComponent as it was. * Rename types for more clarity * Fix ExtensionNamespace and PaymentMethodName types * Rename Supports and *PaymentMethodOptions type for better clarity
2021-09-15 16:36:02 +00:00
- `__experimental_woocommerce_blocks_payment_gateway_features_list` hook that allows modification of the features supported by PayPal Standard. ([experimental hook](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4cedb65367be0d1c4c1f9dd9c016e3b1325cf92e/src/Payments/Integrations/PayPal.php#L86)).
Graduate `__experimental_woocommerce_blocks_checkout_update_order_meta` action to stable (https://github.com/woocommerce/woocommerce-blocks/pull/5017) * Deprecate __experimental_woocommerce_blocks_checkout_update_order_meta * Update docs to show new action and remove deprecated one * Amend deprecated tag and add version numbers * Resolve conflict where old hook name was included in example docs
2021-11-02 10:15:12 +00:00
- **Deprecated** - `__experimental_woocommerce_blocks_checkout_update_order_meta` hook when the draft order has been created or updated from the cart and is now ready for extensions to modify the metadata ([experimental hook](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3686/files#diff-af2c90fa556cc086b780c8fad99b68373d87fd6007e6e2ff1b4c68ebe9ccb551R377-R393)). [Deprecated in PR 5017](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/5017).
Graduate `__experimental_woocommerce_blocks_checkout_update_order_from_request` action to stable (https://github.com/woocommerce/woocommerce-blocks/pull/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
2021-11-02 09:21:51 +00:00
- **Deprecated** - `__experimental_woocommerce_blocks_checkout_update_order_from_request` hook gives extensions the chance to update orders based on the data in the request ([deprecated experimental hook](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/d469a45d572f2c52d7917707c492dfb905ddfac0/src/StoreApi/Routes/Checkout.php#L466-L477)). [Deprecated in PR 5015](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/5015).
Graduate `__experimental_woocommerce_blocks_checkout_order_processed` action to stable (https://github.com/woocommerce/woocommerce-blocks/pull/5014) * Deprecate __experimental_woocommerce_blocks_checkout_order_processed * Update docs to reflect new hook name I also mentioned this hook is deprecated in the experimental interfaces doc. * Update deprecated tag in docblock * Fix typo in deprecated docblock * Send args to do_action_deprecated in an array * Amend deprecated tag and add version numbers
2021-11-02 08:46:54 +00:00
- **Deprecated** - `__experimental_woocommerce_blocks_checkout_order_processed` hook when order has completed processing and is ready for payment ([deprecated experimental hook](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/accd1bbf402e043b9fc322f118ab614ba7437c92/src/StoreApi/Routes/Checkout.php#L237)). [Deprecated in PR 5014](https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/5014).
Update feature flags and experimental interfaces document. (https://github.com/woocommerce/woocommerce-blocks/pull/4750) * add missing blocks and update old links * features behind a feature flag * update filters and JS methods * Apply suggestions from code review Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com> Co-authored-by: Darren Ethier <darren@roughsmootheng.in> Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com>
2021-09-16 18:50:33 +00:00
- `__experimental_woocommerce_blocks_add_data_attributes_to_namespace` hook that allows 3PD to add a namespace of blocks to receive block attributes as `data-` attributes ([experimental property](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4a1ee97eb97011458174e93e44a9b7ad2f10ca36/src/BlockTypesController.php#L88)).
- `__experimental_woocommerce_blocks_add_data_attributes_to_block` hook that allows 3PD to add a block to recieve block attributes as `data-` attributes ([experimental property](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4a1ee97eb97011458174e93e44a9b7ad2f10ca36/src/BlockTypesController.php#L97)).
### JS methods
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
Correct broken *.md links (https://github.com/woocommerce/woocommerce-blocks/pull/7108)
2022-09-12 04:29:24 +00:00
- `__experimentalDeRegisterPaymentMethod` function used to deregister a payment method, only used in tests ([experimental function](https://github.com/woocommerce/woocommerce-blocks/blob/f27456dd00fa0b21b29a935943defb18351edf48/assets/js/blocks-registry/payment-methods/registry.ts#L110-L114)).
- `__experimentalDeRegisterExpressPaymentMethod` function used to deregister an express payment method, only used in tests ([experimental function](https://github.com/woocommerce/woocommerce-blocks/blob/f27456dd00fa0b21b29a935943defb18351edf48/assets/js/blocks-registry/payment-methods/registry.ts#L116-L120)).
Update experimental flags documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4017)
2021-04-01 09:34:09 +00:00
### Slots
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
Add documentation for __experimentalDiscountsMeta slot (https://github.com/woocommerce/woocommerce-blocks/pull/4349)
2021-06-15 08:30:13 +00:00
- `__experimentalOrderMeta` slot that allows extensions to add content to the order meta in the Cart and Checkout blocks ([experimental slot](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4cedb65367be0d1c4c1f9dd9c016e3b1325cf92e/packages/checkout/order-meta/index.js#L12)).
- `__experimentalOrderShippingPackages` slot that allows extensions to add content to the shipping packages in the Cart and Checkout blocks ([experimental slot](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/4cedb65367be0d1c4c1f9dd9c016e3b1325cf92e/packages/checkout/order-shipping-packages/index.js#L12)).
- `__experimentalDiscountsMeta` slot that allows extensions to add content to the shipping packages in the Cart and Checkout blocks ([experimental slot](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/b6a9cc6342696f47cc08686522bdaca7989a6bc7/packages/checkout/discounts-meta/index.js)).
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
Update feature flags and experimental interfaces document. (https://github.com/woocommerce/woocommerce-blocks/pull/4750) * add missing blocks and update old links * features behind a feature flag * update filters and JS methods * Apply suggestions from code review Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com> Co-authored-by: Darren Ethier <darren@roughsmootheng.in> Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com>
2021-09-16 18:50:33 +00:00
### Misc
Clarify __experimental_woocommerce_blocks_hidden (https://github.com/woocommerce/woocommerce-blocks/pull/8414)
2023-02-14 10:08:10 +00:00
- `__experimental_woocommerce_blocks_hidden` property allows overwriting the `hidden` property for cart item data. This is useful to make some cart item data visible/hidden depending if it needs to be displayed in the Cart Block or the Cart Shortcode ([experimental property](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/9c4288b0ee46960bdc2bf8ef351d05ac23073b0c/src/StoreApi/Schemas/CartItemSchema.php#L439-L441)). This was added in [this PR](https://github.com/woocommerce/woocommerce-blocks/pull/3732) to resolve [this issue with Subscriptions](https://github.com/woocommerce/woocommerce-blocks/issues/3731). This property will not be needed if the blocks replace the shortcode experience, since in that scenario, the `hidden` property would be sufficient.
Update feature flags and experimental interfaces document. (https://github.com/woocommerce/woocommerce-blocks/pull/4750) * add missing blocks and update old links * features behind a feature flag * update filters and JS methods * Apply suggestions from code review Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com> Co-authored-by: Darren Ethier <darren@roughsmootheng.in> Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com>
2021-09-16 18:50:33 +00:00
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
## Usages of `experimental` prefix
`useStoreEvents` makes use of an `experimental__` prefix for wp-hook actions (since `__experimental` is not a valid prefix in that context).
- `experimental__woocommerce_blocks-` is used for store events.
- `experimental__woocommerce_blocks-checkout-` is used for checkout events.
Current list of events:
- `experimental__woocommerce_blocks-cart-add-item` - Fired when an item is added to the cart.
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- `experimental__woocommerce_blocks-cart-set-item-quantity` - Fired when cart item quantity is changed by the customer.
- `experimental__woocommerce_blocks-cart-remove-item` - Fired when a cart item is removed from the cart.
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
- `experimental__woocommerce_blocks-product-view-link` - Fired when a product link is clicked.
- `experimental__woocommerce_blocks-product-list-render` - Fired when a product list is rendered.
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- `experimental__woocommerce_blocks-product-search` - Fired when a search is submitted.
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
- `experimental__woocommerce_blocks-store-notice-create` - Fired when a store notice is created.
- `experimental__woocommerce_blocks-product-render` - Fired when a single product block is rendered.
- `experimental__woocommerce_blocks-checkout-submit` - Fired when the checkout form is submitted.
- `experimental__woocommerce_blocks-checkout-set-selected-shipping-rate` - Fired when a shipping rate is chosen on checkout.
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- `experimental__woocommerce_blocks-checkout-set-active-payment-method` - Fired when a payment method is chosen on checkout.
Enable Google Analytics Integration (https://github.com/woocommerce/woocommerce-blocks/pull/4020) * Remove experimental flag * Add experimental docs
2021-04-06 11:59:31 +00:00
- `experimental__woocommerce_blocks-checkout-render-checkout-form` - Fired when the checkout form is rendered.
- `experimental__woocommerce_blocks-checkout-set-email-address` - Fired when an email address is added during checkout.
- `experimental__woocommerce_blocks-checkout-set-shipping-address` - Fired when a shipping address is added during checkout.
- `experimental__woocommerce_blocks-checkout-set-billing-address` - Fired when a billing address is added during checkout.
Register as experimental the Cart i2 blocks and update the feature flag documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4936) * Use registerExperimentalBlockType for registering Cart i2 related blocks * Update feature flags and experimental interfaces doc
2021-10-14 12:44:46 +00:00
- `experimental__woocommerce_blocks-checkout-set-phone-number` - Fired when a phone number is added during checkout.