Add waitForURL in frame and page

[ankur22]

What?

This adds support for a asked for API from Playwright -- page.waitForURL. This API does a few things more than the equivalent page.waitForNavigation({ url: ... }):

1. It will compare the current page's URL to see if it matches the input url;
2. If there's a match it will then wait for the load state of the navigation;
3. Otherwise it will use page.waitForNavigation({ url: ... }).

Why?

This is a more robust API than page.waitForNavigation when a user wants to wait for a specific URL, since it builds on page.waitForNavigation to prevent race conditions where a page completes navigation before page.waitForNavigation is setup.

It's just another convenient way of waiting for something specific when a navigation occurs, which is especially important when many redirects occur.

Note: It's still recommended that the user wait for specific elements or just work with the locator API which auto waits when the page does navigate to the specified URL.

Example usage:

  await Promise.all([
    page.waitForURL('https://quickpizza.grafana.com/login'),
    page.locator('a[href="Login/Profile"]').click()
  ]);

Checklist

• I have performed a self-review of my code.
• I have commented on my code, particularly in hard-to-understand areas.
• I have added tests for my changes.
• I have run linter and tests locally (make check) and all pass.

Checklist: Documentation (only for k6 maintainers and if relevant)

Please do not merge this PR until the following items are filled out.

• I have added the correct milestone and labels to the PR.
• I have updated the release notes: link
• I have updated or added an issue to the k6-documentation: grafana/k6-docs#NUMBER if applicable
• I have updated or added an issue to the TypeScript definitions: grafana/k6-DefinitelyTyped#NUMBER if applicable

Related PR(s)/Issue(s)

#4385

[ankur22]

I will refactor this into a helper method once this PR is merged in. There are several other PRs which work with similar/same logic to differentiate between regex and strings.

[AgnesToulet]

Great work! 🚀

Do we plan to deprecate WaitForNavigation (and maybe remove it in the next major version)? If so, do we have/should we have an issue to plan for that? I see it's deprecated in PW doc and I think it makes sense to remove it from our API as our goal is to have a simpler API.

[AgnesToulet]

Nit: It might be clearer to split this into several tests (the %s are not easy to map with the actual value and if one test fails here, it won't let the others to continue, which helps with debugging and fixing all the failing tests faster).

[ankur22]

Yeah, i agree. I will refactor the test in a refactoring PR along with this change i want to make.

[ankur22]

Do we plan to deprecate WaitForNavigation (and maybe remove it in the next major version)? If so, do we have/should we have an issue to plan for that? I see it's deprecated in PW doc and I think it makes sense to remove it from our API as our goal is to have a simpler API.

I'm not 100% sure what the next steps are for WaitForNavigation, it's probably worth having a discussion first. I like the idea of streamlining the APIs in general though. I have added an issue to track this idea here 👍