Codestin Search App

AgnesToulet · 2025-09-08T07:45:01Z

What?

Implement the following frameLocator.getBy* APIs which are the preferred way of working with selectors:

frameLocator.getByAltText
frameLocator.getByLabel
frameLocator.getByPlaceholder
frameLocator.getByRole
frameLocator.getByTestId
frameLocator.getByText
frameLocator.getByTitle

Why?

Because we have already implemented all those methods for page, frame, and locator, and we want to implement them as well for frameLocator as a way to increase our compatibility with Playwright, as described in #5036.

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)

Closes #5036

inancgumus

It's a lovely idea to move the boilerplate testing code into testBrowser 👏. Not related to this PR, but I wonder why we need to load IFrames using an HTTP server when we could do it with a simple iframe srcdoc... I've only added some minor suggestions.

inancgumus · 2025-09-08T19:59:41Z

internal/js/modules/k6/browser/tests/test_browser.go


+// withIFrameContent sets up a handler for /iframe that serves a page embedding
+// an iframe with the given content.
+func (tb *testBrowser) withIframeContent(iframeHTML string) {


IFrame instead of Iframe?

Should this method and withIFrameURL be options that are passed to newTestBrowser, as with other options, for consistency?

tb := newTestBrowser(t, withHTTPServer(), withIFrameContent(...))

Good idea! withIFrameURL can't be an option because the URL is sometimes known after the testBrowser gets initialized (see https://github.com/grafana/k6/pull/5135/files#diff-7ec25e41d5b272a1ab43d25bb03d48bdd68072ac9632c3295c27f14ce4370011R572-R573) but I refactored withIFrameContent to be an option as it simplifies a bit the locator tests (in 62090aa).

👍 Hmm, don't we already initialize testBrowser before applying the options? The only issue is with withIFrameURL, we'd need to pass that after withHTTPServer.

k6/internal/js/modules/k6/browser/tests/test_browser.go

Lines 76 to 83 in 62090aa

tbr.applyDefaultOptions()

tbr.applyOptions(opts...) // apply pre-init stage options.

tbr.vu, tbr.cancel = newTestBrowserVU(tb, tbr)

tbr.browserType = chromium.NewBrowserType(tbr.vu)

tbr.vu.ActivateVU()

tbr.isBrowserTypeInitialized = true // some option require the browser type to be initialized.

tbr.applyOptions(opts...) // apply post-init stage options.

internal/js/modules/k6/browser/tests/test_browser.go

inancgumus · 2025-09-08T20:09:03Z

internal/js/modules/k6/browser/tests/test_browser.go

+		<html>
+		<head></head>
+		<body>
+			<iframe id="frameB" src="%s"></iframe>


Do we need the frameB id?

Yes, it's used in the tests with the Locator function to retrieve the iframe.

I'd explicitly pass the frame ID to that helper then, as it creates a temporal coupling issue. We'd have to look at that helper code to see why frameB is used in the test every time.

Updated in 91affdd

internal/js/modules/k6/browser/tests/test_browser.go

inancgumus · 2025-09-08T20:11:22Z

internal/js/modules/k6/browser/tests/get_by_test.go

-		"page":    any(p).(T),
-		"frame":   any(p.MainFrame()).(T),
-		"locator": any(p.Locator(":root", nil)).(T),
+		pageImpl:         any(p).(T),


Not related to this PR, but I wonder why we use generics here when we could do the same with interfaces, or use a much simpler approach. A task for another time, I guess.

AgnesToulet · 2025-09-09T08:50:53Z

Not related to this PR, but I wonder why we need to load IFrames using an HTTP server when we could do it with a simple iframe srcdoc

I've tested this approach and I like how it simplifies the tests but, I'm not sure why, it makes one test (TestVisibilityWithCORS/visible) in locator_test.go fails. I'll do some other tests with Playwright to see if it's a bug or an expected behavior but I don't think it should be handled in this PR.
@ankur22 Have you looked into this while working on those tests?

inancgumus · 2025-09-09T14:49:50Z

@AgnesToulet

I've tested this approach and I like how it simplifies the tests but, I'm not sure why, it makes one test (TestVisibilityWithCORS/visible) in locator_test.go fails. I'll do some other tests with Playwright to see if it's a bug or an expected behavior but I don't think it should be handled in this PR.

Adding the allow-same-origin and allow-scripts attributes to the sandbox attribute of iframe can likely solve that issue (e.g., <iframe srcdoc='..' sandbox='allow-same-origin'></iframe>).

ankur22 · 2025-09-10T13:54:10Z

Not related to this PR, but I wonder why we need to load IFrames using an HTTP server when we could do it with a simple iframe srcdoc

I've tested this approach and I like how it simplifies the tests but, I'm not sure why, it makes one test (TestVisibilityWithCORS/visible) in locator_test.go fails. I'll do some other tests with Playwright to see if it's a bug or an expected behavior but I don't think it should be handled in this PR.
@ankur22 Have you looked into this while working on those tests?

Might have misunderstood the question, but the reason why we're working with a HTTP server is to mimic a different origin i.e. CORS. Anything in injected_script.js can read from an iframe from the same origin, but if it is a different origin then chrome will prevent it due to CORS. So if we're working with the iframe srcdoc attribute, wouldn't the iframe be from the same origin as the main frame? The assumption in browser is that all content from an iframe is form a different origin. If there's a less complex way then great 👍

ankur22

LGTM 🚀 Thank you! 🙇

AgnesToulet added 3 commits September 8, 2025 09:31

Implement frameLocator.getBy*

5d6666f

Add tests for frameLocator.getBy*

cd7ee51

Refactor locator tests to reduce duplication

d9f2019

AgnesToulet requested a review from a team as a code owner September 8, 2025 07:45

AgnesToulet requested review from inancgumus and mstoykov and removed request for a team September 8, 2025 07:45

AgnesToulet added area: browser browser: playwright related to Playwright compatibility documentation-needed A PR which will need a separate PR for documentation labels Sep 8, 2025

AgnesToulet added this to the v1.3.0 milestone Sep 8, 2025

mstoykov previously approved these changes Sep 8, 2025

View reviewed changes

inancgumus previously approved these changes Sep 8, 2025

View reviewed changes

AgnesToulet added 2 commits September 9, 2025 10:41

Rename GoTo -> Goto

e270527

refactor withIFrameContent

62090aa

AgnesToulet dismissed stale reviews from inancgumus and mstoykov via 62090aa September 9, 2025 08:42

mstoykov previously approved these changes Sep 9, 2025

View reviewed changes

Refactor iframeID to be a parameter

91affdd

AgnesToulet dismissed mstoykov’s stale review via 91affdd September 11, 2025 06:59

AgnesToulet temporarily deployed to azure-trusted-signing September 11, 2025 07:05 — with GitHub Actions Inactive

AgnesToulet temporarily deployed to azure-trusted-signing September 11, 2025 07:06 — with GitHub Actions Inactive

ankur22 approved these changes Sep 11, 2025

View reviewed changes

codebien approved these changes Sep 12, 2025

View reviewed changes

AgnesToulet merged commit 8799e29 into master Sep 12, 2025
39 checks passed

AgnesToulet deleted the add/frameLocator-getBy branch September 12, 2025 08:18

BrewTestBot mentioned this pull request Sep 23, 2025

k6 1.3.0 Homebrew/homebrew-core#245369

Merged

ankur22 mentioned this pull request Nov 5, 2025

Fix flakey browser tests for CI #5367

Open

	tbr.applyDefaultOptions()
	tbr.applyOptions(opts...) // apply pre-init stage options.
	tbr.vu, tbr.cancel = newTestBrowserVU(tb, tbr)
	tbr.browserType = chromium.NewBrowserType(tbr.vu)
	tbr.vu.ActivateVU()
	tbr.isBrowserTypeInitialized = true // some option require the browser type to be initialized.
	tbr.applyOptions(opts...) // apply post-init stage options.

Comments

Conversation

AgnesToulet commented Sep 8, 2025 • edited by ankur22 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

Checklist

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

Related PR(s)/Issue(s)

Uh oh!

inancgumus left a comment

Choose a reason for hiding this comment

Uh oh!

inancgumus Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

AgnesToulet Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inancgumus Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

inancgumus Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

AgnesToulet Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

inancgumus Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AgnesToulet Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

inancgumus Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AgnesToulet commented Sep 9, 2025

Uh oh!

inancgumus commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ankur22 commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ankur22 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AgnesToulet commented Sep 8, 2025 •

edited by ankur22

Loading

AgnesToulet Sep 9, 2025 •

edited

Loading

inancgumus Sep 9, 2025 •

edited

Loading

inancgumus Sep 8, 2025 •

edited

Loading

inancgumus commented Sep 9, 2025 •

edited

Loading

ankur22 commented Sep 10, 2025 •

edited

Loading