Fix flaky E2E test: "should refresh the page only if the user clicks on button" #60100

dinhtungdu · 2025-07-30T09:16:16Z

Submission Review Guidelines

I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have reviewed my code for security best practices.
Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request

This PR fixes a flaky E2E test that intermittently fails with "socket hang up" errors during template compilation in the price filter block tests.

Changes:

Added retry logic with exponential backoff to the templateCompiler fixture in price-filter.block_theme.spec.ts
Implemented network error detection to only retry on transient network issues (socket hang up, ECONNRESET, ETIMEDOUT, ENOTFOUND)
Added up to 3 retry attempts with 200ms, 400ms, 800ms backoff delays

Why This Change:
The test "should refresh the page only if the user clicks on button" was failing intermittently during CI runs when requestUtils.createTemplateFromFile() encountered network connectivity issues while making REST API calls to create WordPress templates. This caused the GitHub Actions flaky test reporter to automatically create issues when tests passed after auto-retrying.

Closes WOOPLUG-3414.

How to test the changes in this Pull Request

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

Verify CI passes without retrying the flaky test on shard 4/10.

Changelog entry

Automatically create a changelog entry from the details below.
This Pull Request does not require a changelog entry. (Comment required below)

Changelog Entry Comment

Comment

This PR only fixes test flakiness and does not change any user-facing functionality or API behavior. Test infrastructure improvements do not require changelog entries as they don't affect end users or developers using WooCommerce.

github-actions · 2025-07-30T09:16:41Z

Testing Guidelines

Hi @Aljullu ,

Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed.

Reminder: PR reviewers are required to document testing performed. This includes:

🖼️ Screenshots or screen recordings.
📝 List of functionality tested / steps followed.
🌐 Site details (environment attributes such as hosting type, plugins, theme, store size, store age, and relevant settings).
🔍 Any analysis performed, such as assessing potential impacts on environment attributes and other plugins, conducting performance profiling, or using LLM/AI-based analysis.

⚠️ Within the testing details you provide, please ensure that no sensitive information (such as API keys, passwords, user data, etc.) is included in this public issue.

coderabbitai · 2025-07-30T09:19:50Z

📝 Walkthrough

Walkthrough

The test setup for the price filter block theme now includes retry logic when creating a template from a file. If transient network errors occur, the process is retried up to three times with exponential backoff delays. No changes were made to exported or public entities.

Changes

Cohort / File(s)	Change Summary
Test Retry Logic Enhancement `plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts`	Added retry logic with exponential backoff for template creation in the test fixture to handle transient network errors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a9612c and ccdb022.

📒 Files selected for processing (1)

plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{php,js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/code-quality.mdc)

**/*.{php,js,jsx,ts,tsx}: Guard against unexpected inputs
Sanitize and validate any potentially dangerous inputs
Ensure code is backwards compatible
Write code that is readable and intuitive
Ensure code has unit or E2E tests where applicable

Files:

plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts

**/*.{php,js,ts,jsx,tsx}

⚙️ CodeRabbit Configuration File

**/*.{php,js,ts,jsx,tsx}: Don't trust that extension developers will follow the best practices, make sure the code:

Guards against unexpected inputs.

Sanitizes and validates any potentially dangerous inputs.

Is backwards compatible.

Is readable and intuitive.

Has unit or E2E tests where applicable.

Files:

plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts

🧠 Learnings (2)

📓 Common learnings

Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Provide clear, step-by-step instructions for how to test the changes in the PR description.

Learnt from: gigitux
PR: woocommerce/woocommerce#58846
File: plugins/woocommerce/client/blocks/tests/e2e/tests/all-products/all-products.block_theme.spec.ts:41-52
Timestamp: 2025-06-16T09:20:22.981Z
Learning: In WooCommerce E2E tests, the database is reset to the initial state for each test, so there's no need to manually restore global template changes (like clearing the header template) as the test infrastructure handles cleanup automatically.

Learnt from: samueljseay
PR: woocommerce/woocommerce#58716
File: plugins/woocommerce/client/blocks/assets/js/blocks/mini-cart/iapi-frontend.ts:83-101
Timestamp: 2025-06-17T07:07:53.443Z
Learning: In WooCommerce blocks, when porting existing code patterns that have known issues (like parseInt truncating decimal money values), maintain consistency with existing implementation rather than making isolated fixes. The preference is for systematic refactoring approaches (like broader Dinero adoption) over piecemeal changes.

Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.

Learnt from: lysyjan
PR: woocommerce/woocommerce#59632
File: packages/js/email-editor/src/layouts/flex-email.tsx:116-122
Timestamp: 2025-07-14T10:41:46.200Z
Learning: In WooCommerce projects, formatting suggestions should respect the project's Prettier configuration and linting rules. Changes that would break the lint job should be avoided, even if they appear to improve readability.

plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts (3)

Learnt from: gigitux
PR: #58846
File: plugins/woocommerce/client/blocks/tests/e2e/tests/all-products/all-products.block_theme.spec.ts:41-52
Timestamp: 2025-06-16T09:20:22.981Z
Learning: In WooCommerce E2E tests, the database is reset to the initial state for each test, so there's no need to manually restore global template changes (like clearing the header template) as the test infrastructure handles cleanup automatically.

Learnt from: dinhtungdu
PR: #59900
File: plugins/woocommerce/client/blocks/assets/js/blocks/product-filters/inner-blocks/attribute-filter/inspector.tsx:0-0
Timestamp: 2025-07-24T05:37:00.907Z
Learning: The DisplayStyleSwitcher component in plugins/woocommerce/client/blocks/assets/js/blocks/product-filters/components/display-style-switcher/index.tsx has been updated so that its onChange prop accepts only a string type (not string | number | undefined), eliminating the need for type assertions when using this component.

Learnt from: samueljseay
PR: #58716
File: plugins/woocommerce/client/blocks/assets/js/blocks/mini-cart/iapi-frontend.ts:83-101
Timestamp: 2025-06-17T07:07:53.443Z
Learning: In WooCommerce blocks, when porting existing code patterns that have known issues (like parseInt truncating decimal money values), maintain consistency with existing implementation rather than making isolated fixes. The preference is for systematic refactoring approaches (like broader Dinero adoption) over piecemeal changes.

🔇 Additional comments (1)

plugins/woocommerce/client/blocks/tests/e2e/tests/price-filter/price-filter.block_theme.spec.ts (1)

25-70: Excellent implementation of retry logic with exponential backoff.

The retry mechanism properly handles transient network errors with several good practices:

Uses optional chaining (error?.message) to safely access error properties

Only retries on specific network-related errors, avoiding infinite loops on permanent failures

Implements correct exponential backoff (200ms, 400ms, 800ms)

Properly exits the retry loop on success and throws errors when appropriate

Guards against edge cases with the final compiler validation

This should effectively resolve the flaky test issues caused by intermittent network connectivity problems.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch wooplug-3414-flaky-test-should-refresh-the-page-only-if-the-user-clicks

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

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.

Aljullu

It sounds good to me to try this approach to reduce the test flakiness. 👍

test: fix flaky test for template compiler

ccdb022

github-actions bot added focus: e2e tests Issues related to e2e tests plugin: woocommerce Issues related to the WooCommerce Core plugin. labels Jul 30, 2025

woocommercebot requested review from a team and Aljullu and removed request for a team July 30, 2025 09:16

Aljullu approved these changes Jul 30, 2025

View reviewed changes

dinhtungdu merged commit e1cc769 into trunk Jul 31, 2025
42 of 43 checks passed

dinhtungdu deleted the wooplug-3414-flaky-test-should-refresh-the-page-only-if-the-user-clicks branch July 31, 2025 01:39

github-actions bot added this to the 10.2.0 milestone Jul 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix flaky E2E test: "should refresh the page only if the user clicks on button" #60100

Fix flaky E2E test: "should refresh the page only if the user clicks on button" #60100

Uh oh!

dinhtungdu commented Jul 30, 2025

Uh oh!

github-actions bot commented Jul 30, 2025

Uh oh!

coderabbitai bot commented Jul 30, 2025

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Aljullu left a comment

Uh oh!

Uh oh!

Uh oh!

Fix flaky E2E test: "should refresh the page only if the user clicks on button" #60100

Fix flaky E2E test: "should refresh the page only if the user clicks on button" #60100

Uh oh!

Conversation

dinhtungdu commented Jul 30, 2025

Submission Review Guidelines

Changes proposed in this Pull Request

How to test the changes in this Pull Request

Changelog entry

Comment

Uh oh!

github-actions bot commented Jul 30, 2025

Testing Guidelines

Uh oh!

coderabbitai bot commented Jul 30, 2025

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Aljullu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!