grafana/k6

Add `ElementHandle.isInViewport()`

Open

#4,423 opened on Aug 12, 2022

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Go (30,564 stars) (1,537 forks)batch import
area: browserfeaturegood first issuehacktoberfesttriage

Description

From this discussion in grafana/xk6-browser#467, we wanted to change TestWaitForFrameNavigationWithinDocument to also check whether an element is visible within the viewport after a navigation in the same document happens.

To do that it would be helpful if there was an ElementHandle.isInViewport() method, similar to the one described here. Playwright doesn't have such a method, but Puppeteer has ElementHandle.isIntersectingViewport(). isInViewport seems like a slightly better name, so let's go with that.

Suggested solution

We already have ElementHandle.boundingBox() in Go, though if we want to reduce the amount of JS evaluations and CDP calls, we could just wrap ElementHandle.eval() and do a single CDP call for this.

See grafana/k6#4424 for the test change to use this method.

Contributor guide

Tech stack
gojavascript
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GoJavaScriptCDP concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the existing ElementHandle implementation in the xk6 browser extension, particularly the boundingBox() and eval() methods. Consider using a single CDP call via eval() to check viewport intersection. Look at the discussion in PR #467 for context. Then implement isInViewport() method and ensure it is tested as referenced in issue #4424.