[Behat] Decouple cart setup from interaction – `Given I added` vs `When I add` by Rafikooo · Pull Request #17785 · Sylius/Sylius

Rafikooo · 2025-03-26T17:11:54Z

Q	A
Branch?	2.0
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
License	MIT

Continuation of:

Until now, the checkout-related scenarios have been set up as follows:
• UI – via web actions (e.g. Given I have a product ... actually triggered browser actions to prepare the initial step),
• API – a mix of messenger commands and API calls.

During the development of Sylius 2.0, with the introduction of dynamic components, all scenarios involving product-related actions had to be marked as JS to work correctly. This significantly increased build time and reduced overall stability.

This PR focuses on decoupling the Behat architecture to unify the test setup for both UI and API. The goal is to eliminate most JS tags, which should lead to greater stability. Some performance improvements are already noticeable.

This PR doesn’t yet include all refactored scenarios, but at this stage we already observe the following performance gains:
• For non-JS scenarios, the timing is likely similar — some JS scenarios have been converted to non-JS, but at the same time, we benefit from faster setup thanks to the refactor (using messenger commands instead of API calls or UI interactions to prepare tests).
• For JS scenarios executed via Chromedriver, the same applies — some Panther scenarios have been switched to Chromedriver, and performance remains comparable.

JS with Panther: ~30 min → ~20 min

coderabbitai · 2025-03-26T17:12:02Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-03-26T23:41:53Z

❌ Preview Environment deleted from Bunnyshell

Available commands:

🚀 /bns:deploy to redeploy the environment

GSadee

I believe that my comments could be fixed in the next iteration

GSadee · 2025-03-28T06:00:07Z

...cing_order_on_multi_channel/placing_an_order_on_multiple_channels_with_same_currency.feature

-        And I proceed with "Free" shipping method and "Offline" payment
+        And I added product "PHP T-Shirt" to the cart
+        And I addressed the cart
+        When I proceeded with "Free" shipping method and "Offline" payment method


Suggested change

When I proceeded with "Free" shipping method and "Offline" payment method

When I proceed with "Free" shipping method and "Offline" payment method

GSadee · 2025-03-28T06:01:23Z

...s/shop/account/customer_account/address_book/deleting_address_created_after_checkout.feature

@@ -15,7 +15,7 @@ Feature: Removing an address from my book

    @api @ui @javascript


Could we not remove this js tag?

GSadee · 2025-03-28T06:02:00Z

.../shop/account/customer_account/address_book/viewing_addresses_created_after_checkout.feature

@@ -15,7 +15,7 @@ Feature: Viewing addresses created after checkout

    @api @ui @javascript


The same as above 🤔

GSadee · 2025-03-28T06:03:48Z

features/shop/cart/shopping_cart/changing_display_currency_of_cart.feature

    Scenario: Changing the currency of my cart
-        Given I have product "The Pug Mug" in the cart
-        When I switch to the "GBP" currency
+        When I add product "The Pug Mug" to the cart


This one could be Given and perhaps we wouldn't need the js tag 🤔

GSadee · 2025-03-28T06:04:35Z

features/shop/cart/shopping_cart/changing_quantity_of_product_in_cart.feature

    Scenario: Increasing quantity of an item in cart
-        Given I see the summary of my cart
-        When I change product "T-Shirt banana" quantity to 2 in my cart
+        Given I added product "T-Shirt banana" to the cart


This given step could stay in Background as it is the same for both scenarios here

Adding to that we could also move the summary part to the background as well, just rephrase it to smth like I am viewing the summary of my cart

GSadee · 2025-03-28T10:08:00Z

features/shop/checkout/order_promotion/order_promotion_integrity_validation.feature

        And I am a logged in customer

-    @api @ui @javascript
+    @api @ui @mink:chromedriver


GSadee · 2025-03-28T10:10:04Z

features/shop/checkout/paying_for_order/payment_method_integrity_validation.feature

+    @api @ui @mink:chromedriver
    Scenario: Preventing customer from completing checkout with no longer available payment method
-        Given I have product "PHP T-Shirt" in the cart
+        When I add product "PHP T-Shirt" to the cart


It should stay as Given

GSadee · 2025-03-28T10:13:07Z

features/shop/checkout/registering_account_after_checkout.feature

@@ -13,10 +13,10 @@ Feature: Registering a new account after checkout
    @no-api @ui @javascript


Js tag shouldn't be needed here

GSadee · 2025-03-28T10:13:34Z

features/shop/checkout/seeing_order_summary/seeing_addresses_on_order_summary_page.feature

    @api @ui @javascript
    Scenario: Seeing the same shipping and billing address on order summary
-        Given I have product "Lannister Coat" in the cart
+        When I add product "Lannister Coat" to the cart


It could be Given

GSadee · 2025-03-28T10:14:05Z

features/shop/checkout/seeing_order_summary/seeing_order_locale.feature

@@ -21,8 +21,8 @@ Feature: Seeing order locale on order summary page

    @no-api @ui @javascript


Not needed js tag

NoResponseMate · 2025-03-28T10:39:59Z

...order/managing_orders/browsing_orders/seeing_orders_with_different_currency_on_index.feature

        Given I changed my current channel to "United States"
-        And I have product "Angel T-Shirt" in the cart
-        And I specified the billing address as "Los Angeles", "Frost Alley", "90210", "United States" for "Lucifer Morningstar"
-        And I proceed with "Free" shipping method and "Offline" payment
+        And I added product "Angel T-Shirt" to the cart
+        And I addressed the cart
+        When I proceed with "Free" shipping method and "Offline" payment
        And I confirm my order
        And I changed my current channel to "Great Britain"
-        And I had product "Angel T-Shirt" in the cart
+        And I have product "Angel T-Shirt" in the cart
        And I specified the billing address as "Los Angeles", "Frost Alley", "90210", "United States" for "Lucifer Morningstar"
        And I proceed with "Free" shipping method and "Offline" payment
        When I confirm my order


As it is, we have doubled Whens.
Everything up to I change my current channel could be done in the setup.

NoResponseMate · 2025-03-28T10:43:18Z

.../shop/account/customer_account/address_book/viewing_addresses_created_after_checkout.feature

+        When I add product "PHP T-Shirt" to the cart
        And I am at the checkout addressing step
        And my billing address is fulfilled automatically through default address
        When I specify the first and last name as "Mike Ross" for billing address


Doubled When;
Quite frankly, we could setup everything up to I confirm my order or better yet I complete the checkout or something like that.

NoResponseMate · 2025-03-28T10:45:44Z

features/shop/cart/shopping_cart/adding_product_to_cart.feature

+        And I added product "T-Shirt banana" to the cart
        When I add this product to the cart


Suggested change

And I added product "T-Shirt banana" to the cart

When I add this product to the cart

And I have product "T-Shirt banana" in the cart

When I add this product to the cart again

NoResponseMate · 2025-03-28T10:47:19Z

features/shop/cart/shopping_cart/changing_quantity_of_product_in_cart.feature

    Scenario: Increasing quantity of an item in cart
-        Given I see the summary of my cart
-        When I change product "T-Shirt banana" quantity to 2 in my cart
+        Given I added product "T-Shirt banana" to the cart


Adding to that we could also move the summary part to the background as well, just rephrase it to smth like I am viewing the summary of my cart

NoResponseMate · 2025-03-28T10:52:09Z

features/shop/checkout/addressing_order/sign_in_during_addressing_step.feature

+        When I add product "PHP T-Shirt" to the cart
+        And I go to the checkout addressing step
        When I specify the email as "francis@underwood.com"


Doubled Whens; many such cases(tm) in this file.

NoResponseMate · 2025-03-28T11:01:59Z

src/Sylius/Behat/Context/Setup/CartContext.php

+     * @Given /^I added (\d+) of (them) to (?:the|my) (cart)$/
     */
-    public function iHaveAddedProductsToTheCart(int $quantity, ProductInterface $product, ?string $tokenValue): void
+    public function iAddedGivenQuantityOfProductsToTheCart(int $quantity, ProductInterface $product, ?string $tokenValue): void


Why, the original template is still in place, there's no need for this change

NoResponseMate · 2025-03-28T11:04:38Z

src/Sylius/Behat/Context/Setup/ShopSecurityContext.php

+    }
+
+    /** Set the token in the shared storage to have access both in UI and API to resources created in the setup context */
+    private function storeUserToken(UserInterface $user): void


Suggested change

private function storeUserToken(UserInterface $user): void

private function saveUserToken(UserInterface $user): void

🤷
Although, could we add the user saving in here as well? Would be a bit cleaner

NoResponseMate · 2025-03-28T11:07:51Z

src/Sylius/Behat/Context/Setup/ShopSecurityContext.php


        $this->securityService->logInWithRememberMe($user);
+
+        $this->storeUserToken($user);


Don't think this one is necessary;
Can you even use remember me through the API?

NoResponseMate · 2025-03-28T11:09:57Z

src/Sylius/Behat/Context/Transform/CartContext.php

    {
        $carts = $this->orderRepository->findBy(
-            ['state' => OrderInterface::STATE_CART],
+            ['state' => OrderCheckoutStates::STATE_CART],


To be reverted.
Although the value is the same, the field we're using is state, not checkout_state

NoResponseMate · 2025-03-28T11:11:29Z

src/Sylius/Behat/Service/SharedStorage.php

    {
        if (!isset($this->clipboard[$key])) {
-            throw new \InvalidArgumentException(sprintf('There is no current resource for "%s"!', $key));
+            throw new SharedStorageElementNotFoundException($key);


👌

Similar should be made for ::getLatestResource or just 2 factory methods within the exception 🤷

…en I add` - Promotion & Some other scenarios (#17818) | Q | A |-----------------|----- | Branch? | 2.0  | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no  | License | MIT Continuation of: - #17785 - #17782 - #17783 Until now, the checkout-related scenarios have been set up as follows: • UI – via web actions (e.g. `Given I have a product ...` actually triggered browser actions to prepare the initial step), • API – a mix of messenger commands and API calls. During the development of Sylius 2.0, with the introduction of dynamic components, all scenarios involving product-related actions had to be marked as JS to work correctly. This significantly increased build time and reduced overall stability. This PR focuses on decoupling the Behat architecture to unify the test setup for both UI and API. The goal is to eliminate most JS tags, which should lead to greater stability. Some performance improvements are already noticeable. This PR doesn’t yet include all refactored scenarios, but at this stage we already observe the following performance gains: • For non-JS scenarios, the timing is likely similar — some JS scenarios have been converted to non-JS, but at the same time, we benefit from faster setup thanks to the refactor (using messenger commands instead of API calls or UI interactions to prepare tests). • For JS scenarios executed via Chromedriver, the same applies — some Panther scenarios have been switched to Chromedriver, and performance remains comparable. JS with Panther: **~30 min → ~20 min**

…` and related scenarios) (#17816) | Q | A |-----------------|----- | Branch? | 2.0  | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no  | License | MIT Continuation of: - #17785 - #17782 - #17783 Until now, the checkout-related scenarios have been set up as follows: • UI – via web actions (e.g. `Given I have a product ...` actually triggered browser actions to prepare the initial step), • API – a mix of messenger commands and API calls. During the development of Sylius 2.0, with the introduction of dynamic components, all scenarios involving product-related actions had to be marked as JS to work correctly. This significantly increased build time and reduced overall stability. This PR focuses on decoupling the Behat architecture to unify the test setup for both UI and API. The goal is to eliminate most JS tags, which should lead to greater stability. Some performance improvements are already noticeable. This PR doesn’t yet include all refactored scenarios, but at this stage we already observe the following performance gains: • For non-JS scenarios, the timing is likely similar — some JS scenarios have been converted to non-JS, but at the same time, we benefit from faster setup thanks to the refactor (using messenger commands instead of API calls or UI interactions to prepare tests). • For JS scenarios executed via Chromedriver, the same applies — some Panther scenarios have been switched to Chromedriver, and performance remains comparable. JS with Panther: **~30 min → ~20 min**

Rafikooo requested review from a team as code owners March 26, 2025 17:11

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch from 4a35a6b to 724a723 Compare March 26, 2025 23:40

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch 2 times, most recently from 1dd96d6 to 430476e Compare March 27, 2025 10:35

probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Mar 27, 2025

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch 6 times, most recently from 416c871 to ac60b69 Compare March 27, 2025 18:26

Rafikooo added 4 commits March 27, 2025 19:56

[Behat] Refactor complex promotions scenarios

117e94c

[Behat] Refactor token storage logic in ShopSecurityContext

d354adb

[Behat] Fix cart transformer to retrieve only carts

86ec93a

[Behat] Fix shared storage cart token usages

f26d041

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch from ac60b69 to 4feaa16 Compare March 27, 2025 19:50

Rafikooo added 11 commits March 27, 2025 20:59

[Behat] Refactor Cart and Checkout contexts

f1f9d5b

[Behat] Mark one cart scenario as non-api

181cb32

[Behat] Fix email check scenario

6f1c247

[Behat][UI] Add new required contexts to checkout suite

9e0ca38

[Behat] Refactor checkout addressing steps

0cafaee

[Behat] Refactor checkout payment steps

c7cf44c

[Behat] Refactor checkout order summary steps

31daa3b

[Behat] Refactor checkout shipping order steps

58ed4ec

[Shop] Change test attribute location

469c879

[Behat] Refactor several checkout scenarios

fbbd1cf

[Behat] Refactor applying shipping fee scenarios

edb8630

Rafikooo added 12 commits March 27, 2025 21:00

[Behat] Refactor checkout and cart context classes

6effd78

[Behat] Refactor viewing order history scenario

09a351d

[Behat] Refactor reapplying promotion on cart change scenarios

51f3338

[Behat] Refactor admin order details scenario

cef6130

[Behat] Refactor reverting previously applied discount scenarios

172f232

[Behat] Refactor removing promotion coupon scenario

264ec00

[Behat] Refactor seeing order summary scenario

4d8a4a8

[Behat] Refactor several cart scenarios

7746489

[Behat][UI] Add missing setup cart context to paying for order suite

1afad69

[Behat] Refactor several cart inventory scenarios

79dcb0e

[Behat] Refactor several receiving discount scenarios

f7e5961

[Behat] Refactor viewing shipping methods scenarios

c7426b6

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch from 4feaa16 to a4e5f66 Compare March 27, 2025 21:33

Rafikooo added 2 commits March 27, 2025 22:42

[Behat] Refactor several checkout scenarios

8176964

[Behat] Refactor several paying for order scenarios

f306dca

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch 2 times, most recently from d042431 to 03a556a Compare March 27, 2025 23:12

Rafikooo added 4 commits March 28, 2025 00:53

[Behat] Refactor other scenarios

84ebb80

[Behat] Change driver to chromedriver in paying for order scenarios

eeac9d7

[Behat] Fix product integrity validation scenarios

87aa0b9

[Behat] Fix the rest of scenarios

b3d1308

Rafikooo force-pushed the SYL-4545/decouple-product-addition-setup-and-action branch from 03a556a to b3d1308 Compare March 27, 2025 23:54

GSadee approved these changes Mar 28, 2025

View reviewed changes

NoResponseMate approved these changes Mar 28, 2025

View reviewed changes

GSadee merged commit 7cc3b13 into Sylius:2.0 Mar 28, 2025
27 checks passed

	When I proceeded with "Free" shipping method and "Offline" payment method
	When I proceed with "Free" shipping method and "Offline" payment method

		@@ -15,7 +15,7 @@ Feature: Removing an address from my book

		@api @ui @javascript

		@@ -15,7 +15,7 @@ Feature: Viewing addresses created after checkout

		@api @ui @javascript

		@@ -13,10 +13,10 @@ Feature: Registering a new account after checkout
		@no-api @ui @javascript

		@@ -21,8 +21,8 @@ Feature: Seeing order locale on order summary page

		@no-api @ui @javascript

		And I added product "T-Shirt banana" to the cart
		When I add this product to the cart

	private function storeUserToken(UserInterface $user): void
	private function saveUserToken(UserInterface $user): void


		$this->securityService->logInWithRememberMe($user);

		$this->storeUserToken($user);

Uh oh!

Conversation

Rafikooo commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 26, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Preview Environment deleted from Bunnyshell

Uh oh!

GSadee left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Rafikooo commented Mar 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Mar 26, 2025 •

edited

Loading