2 Problems with setup() method in the RequestUtils class of @wordpress/e2e-test-utils-playwright

[kopepasah]

Description

While I know @wordpress/e2e-test-utils-playwright is under active development, when working with the package it was expected that I could use RequestUtils.setup() to make WP REST API requests; however, I am experiencing two different issues when trying to use this setup method:

Issue 1: Unable to pass custom baseURL

I am unable to change the baseURL by passing a custom url within the RequestUtils.setup( { baseUrl: 'http://example.com' } ). This could be expected behavior, because I can pass the WP_BASE_URL as an environment variable (i.e. WP_BASE_URL=http://example.com npx playwright test), but it seems that this parameter should be overwritten within the setup() method.

You can see an example of this problem within custom-baseURL branch of this repo: https://github.com/kopepasah/wp-playwright-request-utils-test/tree/custom-baseURL

Issue 2: Multiple requests causes random failures

When running requests using RequestUtils.setup() and npx playwright test, I cannot make multiple requests, as one of the two requests will always fail (which one is random). You can see and an example of this problem in the multiple-requests branch of this repo: https://github.com/kopepasah/wp-playwright-request-utils-test/tree/multiple-requests

Now, I can see that the Gutenberg e2e tests are setting up their own requestContext in Playwright, but it seems odd that the RequestUtils class does not perform that setup automatically, as it is expected that RequestUtils.setup() will handle this here. I have not tried the newContext in Playwright (like the Gutenberg e2e tests) way yet, because I was hoping this setup will be handled by the RequestUtils class.

---

Thanks for taking a look, and all help is appreciated!

Step-by-step reproduction instructions

Please visit this repo for reproducing these issues: https://github.com/kopepasah/wp-playwright-request-utils-test/

This repo is a blank plugin, which installs the lates WordPress using @wordpress/env. In addition, it installs and sets up @playwright/test and @wordpress/e2e-test-utils-playwright for testing.

Screenshots, screen recording, code snippet

No response

Environment info

"@playwright/test": "^1.36.2",
"@wordpress/e2e-test-utils-playwright": "^0.6.0"

Regarding this issue, the WordPress and Gutenberg versions are not relevant, and all other code is default WordPress.

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

[kou029w]

Issue 1: Unable to pass custom baseURL

It appears to me that perhaps rewriting this line as follows should solve the problem:

gutenberg/packages/e2e-test-utils-playwright/src/request-utils/rest.ts

Line 27 in e2941e9

const response = await request.head( WP_BASE_URL );

	const response = await request.head( '' );

But I did not know if this method was good or not.

[github-actions]

Hi,
This issue has gone 30 days without any activity. This means it is time for a check-in to make sure it is still relevant. If you are still experiencing this issue with the latest versions, you can help the project by responding to confirm the problem and by providing any updated reproduction steps.
Thanks for helping out.