[Blocks] Migrate rating filter to playwright #46583

gigitux · 2024-04-15T10:50:52Z

Warning

This PR is blocked by #46125

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 migrates the Rating Filter tests to the Playwright infrastructure.

How to test the changes in this Pull Request:

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

Ensure that E2E tests are green.

Changelog entry

Automatically create a changelog entry from the details below.

Significance

Patch
Minor
Major

Type

Fix - Fixes an existing bug
Add - Adds functionality
Update - Update existing functionality
Dev - Development related task
Tweak - A minor adjustment to the codebase
Performance - Address performance issues
Enhancement - Improvement to existing functionality

Message

Comment

Migrate Rating filter tests to Playwright

That part is overriding the logged in user state and wipes out the nonce and rootUrl fields.

This reverts commit 987dc47.

This reverts commit c8d008c.

This reverts commit 2684273.

…2e-db-reset

* Load local pickup enabled setting as bool not string * Add changelog * Remove unused import * Update plugins/woocommerce-blocks/assets/js/extensions/shipping-methods/pickup-location/utils.ts Co-authored-by: Niels Lange <info@nielslange.de> * Use strict equality test * try now * try now * add a new sql file * remove default.sql * fix welcome guide tour * fix E2E tests * Fix the template revert tests ...where the template is unreachable due to pagination. * Add changelog entry * improve logic to closeWelcomeGuideModal * fix cart checkout tests * improve flakiness * improve flakiness * fix flaky test * fix company field * fix E2E test * fix E2E tests --------- Co-authored-by: Thomas Roberts <thomas.roberts@automattic.com> Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> Co-authored-by: Niels Lange <info@nielslange.de> Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com>

add ESLint configuration

…2e-db-reset

fix eslint error

… into try/filter-product-by-rating

WunderBart

Just a few comments; otherwise, it looks good! Thanks!

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

WunderBart · 2024-04-16T08:55:50Z

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

+		await page.addInitScript( () => {
+			document.addEventListener( 'DOMContentLoaded', () => {
+				// eslint-disable-next-line dot-notation
+				window[ '__DOMContentLoaded__' ] = true;
+			} );
+		} );


Why do we need this?

I want to ensure that the page is refreshed when the user clicks on the Apply button, so add an eventListener that sets a value at the DOMContentLoaded event.

Can we base the test on any UI change or the URL instead? There has to be some change since we're reloading the page, no?

WunderBart · 2024-04-16T08:57:04Z

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

+		await page.waitForEvent( 'domcontentloaded' );
+
+		const domContentLoaded = await page.evaluate(
+			// eslint-disable-next-line dot-notation
+			() => window[ '__DOMContentLoaded__' ] === true
+		);


This part looks like it might not be necessary. Can we make sure we absolutely need this and why?

Here, I check that the DOMContentLoaded event has been triggered.

Why do we need to check it, though? Do we not trust Playwright? 😛

Yeah, good point! page.waitForEvent( 'dom content loaded' ) is enough! I will update all the E2E tests! Thanks!

I don't think we need the page.waitForEvent( 'domcontentloaded' ). By default, navigation changes in Playwright wait for the load event to kick in, which is used to detect a fully loaded page.

But I want to ensure that the "navigation" is triggered. How can I do it?

Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com>

…/woocommerce into try/filter-product-by-rating

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

* Fix ESLint errors * Add changefile(s) from automation for the following project(s): woocommerce-blocks --------- Co-authored-by: github-actions <github-actions@github.com>

… into try/filter-product-by-rating

WunderBart

🚀

…ilter-product-by-rating

* try db reset in page teardown * move reset to setup step * Use wp db cli * Fix global setup That part is overriding the logged in user state and wipes out the nonce and rootUrl fields. * Try importing instead from a generated dump * Revert "Try importing instead from a generated dump" This reverts commit 987dc47. * Revert "Revert "Try importing instead from a generated dump"" This reverts commit c8d008c. * Don't bypass visitSiteEditor so that the Welcome Guide is closed * use createNewPost * Revert "Revert "Revert "Try importing instead from a generated dump""" This reverts commit 2684273. * [Blocks]: Fix E2E tests (#46344) * Load local pickup enabled setting as bool not string * Add changelog * Remove unused import * Update plugins/woocommerce-blocks/assets/js/extensions/shipping-methods/pickup-location/utils.ts Co-authored-by: Niels Lange <info@nielslange.de> * Use strict equality test * try now * try now * add a new sql file * remove default.sql * fix welcome guide tour * fix E2E tests * Fix the template revert tests ...where the template is unreachable due to pagination. * Add changelog entry * improve logic to closeWelcomeGuideModal * fix cart checkout tests * improve flakiness * improve flakiness * fix flaky test * fix company field * fix E2E test * fix E2E tests --------- Co-authored-by: Thomas Roberts <thomas.roberts@automattic.com> Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> Co-authored-by: Niels Lange <info@nielslange.de> Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com> * Replace beforeAll w/ beforeEach + remove all after* hooks * Fix broken hooks * Activate plugins via requestUtils API * [Blocks - E2E]: Add `playwright/no-hooks` ESlint rule (#46432) add ESLint configuration * Clean up console logs * Remove obsolete language setup steps * Remove more unnecessary setup steps * Remove even more obsolete setup steps * tmp: add the LYS fix * Try stabilizing the company field test * Use canvas param instead of manually entering edit mode * Remove double site editor redirect * Blocks: Migrate rating filter to playwright * Add changefile(s) from automation for the following project(s): woocommerce-blocks, woocommerce * remove not necessary changelog * Revert "Use canvas param instead of manually entering edit mode" This reverts commit 5e6cc17. * Revert "Remove double site editor redirect" This reverts commit 69a57a8. * Fix flaky products sorting test * Blocks: Fix ESLint errors (#46595) fix eslint error * improve tests * use visitSiteEditor util Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com> * use locator.fill * Fix ESLint errors (#46626) * Fix ESLint errors * Add changefile(s) from automation for the following project(s): woocommerce-blocks --------- Co-authored-by: github-actions <github-actions@github.com> * address feedback * remove not necessary changelog --------- Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com> Co-authored-by: Thomas Roberts <thomas.roberts@automattic.com> Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> Co-authored-by: Niels Lange <info@nielslange.de> Co-authored-by: github-actions <github-actions@github.com>

WunderBart and others added 29 commits April 2, 2024 15:43

try db reset in page teardown

3617e52

move reset to setup step

323ce03

Use wp db cli

be10e33

Fix global setup

4cdb118

That part is overriding the logged in user state and wipes out the nonce and rootUrl fields.

Try importing instead from a generated dump

987dc47

Revert "Try importing instead from a generated dump"

c8d008c

This reverts commit 987dc47.

Revert "Revert "Try importing instead from a generated dump""

2684273

This reverts commit c8d008c.

Don't bypass visitSiteEditor so that the Welcome Guide is closed

7e02319

use createNewPost

969186e

Revert "Revert "Revert "Try importing instead from a generated dump"""

f9b285b

This reverts commit 2684273.

Merge remote-tracking branch 'origin' into try/e2e-db-reset

34669c1

Merge remote-tracking branch 'origin' into try/e2e-db-reset

565ee2c

Merge branch 'trunk' of github.com:woocommerce/woocommerce into try/e…

d53882d

…2e-db-reset

Replace beforeAll w/ beforeEach + remove all after* hooks

d399dce

Fix broken hooks

5879028

Activate plugins via requestUtils API

d7f6536

[Blocks - E2E]: Add playwright/no-hooks ESlint rule (#46432)

668863c

add ESLint configuration

Clean up console logs

a08a363

Remove obsolete language setup steps

28524b4

Remove more unnecessary setup steps

3b3eadc

Remove even more obsolete setup steps

792206a

tmp: add the LYS fix

5f6c188

Merge branch 'trunk' of github.com:woocommerce/woocommerce into try/e…

0bea677

…2e-db-reset

Merge branch 'trunk' of github.com:woocommerce/woocommerce into try/e…

017fc62

…2e-db-reset

Try stabilizing the company field test

25bc03f

Use canvas param instead of manually entering edit mode

5e6cc17

Remove double site editor redirect

69a57a8

Blocks: Migrate rating filter to playwright

fe79019

gigitux added the focus: e2e tests Issues related to e2e tests label Apr 15, 2024

gigitux added 2 commits April 15, 2024 17:02

Blocks: Fix ESLint errors (#46595)

0a9c281

fix eslint error

Merge branch 'try/e2e-db-reset' of github.com:woocommerce/woocommerce…

26725f2

… into try/filter-product-by-rating

gigitux force-pushed the try/filter-product-by-rating branch from 5b8ac55 to 3a583aa Compare April 15, 2024 17:03

improve tests

ffac689

gigitux force-pushed the try/filter-product-by-rating branch from 3a583aa to ffac689 Compare April 16, 2024 07:20

WunderBart requested changes Apr 16, 2024

View reviewed changes

gigitux and others added 3 commits April 16, 2024 11:00

use visitSiteEditor util

01a6f94

Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com>

use locator.fill

2a06f5e

Merge branch 'try/filter-product-by-rating' of github.com:woocommerce…

370f2d3

…/woocommerce into try/filter-product-by-rating

WunderBart reviewed Apr 16, 2024

View reviewed changes

plugins/woocommerce-blocks/tests/e2e/tests/rating-filter/rating-filter.block_theme.spec.ts Outdated Show resolved Hide resolved

Fix ESLint errors (#46626)

f1d619a

* Fix ESLint errors * Add changefile(s) from automation for the following project(s): woocommerce-blocks --------- Co-authored-by: github-actions <github-actions@github.com>

WunderBart approved these changes Apr 16, 2024

View reviewed changes

gigitux added 2 commits April 16, 2024 15:06

address feedback

a901363

Merge branch 'try/e2e-db-reset' of github.com:woocommerce/woocommerce…

eace94d

… into try/filter-product-by-rating

gigitux force-pushed the try/filter-product-by-rating branch from 27d762c to eace94d Compare April 16, 2024 13:06

gigitux marked this pull request as ready for review April 16, 2024 13:22

woocommercebot requested a review from a team April 16, 2024 13:28

WunderBart approved these changes Apr 16, 2024

View reviewed changes

gigitux mentioned this pull request Apr 17, 2024

Blocks: Delete Jest-Puppeteer infrastructure #46672

Merged

11 tasks

opr removed their request for review April 17, 2024 18:29

Base automatically changed from try/e2e-db-reset to trunk April 26, 2024 09:39

gigitux added 2 commits April 26, 2024 12:09

Merge branch 'trunk' of github.com:woocommerce/woocommerce into try/f…

2bc57ab

…ilter-product-by-rating

remove not necessary changelog

c2fd8b1

gigitux merged commit 24c2832 into trunk Apr 26, 2024
34 checks passed

gigitux deleted the try/filter-product-by-rating branch April 26, 2024 10:53

github-actions bot added this to the 9.0.0 milestone Apr 26, 2024

github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Apr 26, 2024

rodelgc added status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Blocks] Migrate rating filter to playwright #46583

[Blocks] Migrate rating filter to playwright #46583

gigitux commented Apr 15, 2024 •

edited

Loading

WunderBart left a comment

WunderBart Apr 16, 2024

gigitux Apr 16, 2024 •

edited

Loading

WunderBart Apr 16, 2024

WunderBart Apr 16, 2024

gigitux Apr 16, 2024

WunderBart Apr 16, 2024

gigitux Apr 16, 2024

WunderBart Apr 16, 2024

gigitux Apr 16, 2024

WunderBart left a comment

[Blocks] Migrate rating filter to playwright #46583

[Blocks] Migrate rating filter to playwright #46583

Conversation

gigitux commented Apr 15, 2024 • edited Loading

Submission Review Guidelines:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Changelog entry

Significance

Type

Message

Comment

WunderBart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gigitux Apr 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WunderBart left a comment

Choose a reason for hiding this comment

gigitux commented Apr 15, 2024 •

edited

Loading

gigitux Apr 16, 2024 •

edited

Loading