blob: 2d54ee0a93f4cd0226bdb1b5e8860ce3499cc0de [file] [log] [blame]
// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Package webutil contains shared code for dealing with web content.
package webutil
import (
"context"
"fmt"
"time"
"chromiumos/tast/errors"
"chromiumos/tast/local/chrome"
"chromiumos/tast/local/chrome/uiauto"
"chromiumos/tast/testing"
)
// WaitForYoutubeVideo waits for a YouTube video to start on the given chrome.Conn.
func WaitForYoutubeVideo(ctx context.Context, conn *chrome.Conn, timeout time.Duration) error {
// Wait for <video> tag to show up.
return conn.WaitForExprFailOnErrWithTimeout(ctx, `
(function() {
const v = document.querySelector('video');
if (!v) {
return false;
}
const bounds = v.getBoundingClientRect();
return bounds.width > 0 && bounds.height > 0;
})()`, timeout)
}
// WaitForQuiescence waits for the given chrome.Conn gets quiescence.
func WaitForQuiescence(ctx context.Context, conn *chrome.Conn, timeout time.Duration) error {
// Each resourceTimings element contains the load start time and load end time
// for a resource. If a load has not completed yet, the end time is set to
// the current time. Then we can tell that a load has completed by detecting
// that the end time diverges from the current time.
//
// resourceTimings is sorted by event start time, so we need to look through
// the entire array to find the latest activity.
return conn.WaitForExprFailOnErrWithTimeout(ctx, `
(function() {
if (document.readyState !== 'complete') {
return false;
}
const QUIESCENCE_TIMEOUT_MS = 2000;
let lastEventTime = performance.timing.loadEventEnd -
performance.timing.navigationStart;
const resourceTimings = performance.getEntriesByType('resource');
lastEventTime = resourceTimings.reduce(
(current, timing) => Math.max(current, timing.responseEnd),
lastEventTime);
return performance.now() >= lastEventTime + QUIESCENCE_TIMEOUT_MS;
})()`, timeout)
}
// WaitForRender waits for the tab connected to the given chrome.Conn is rendered.
func WaitForRender(ctx context.Context, conn *chrome.Conn, timeout time.Duration) error {
ctx, cancel := context.WithTimeout(ctx, timeout)
defer cancel()
// We wait for two calls to requestAnimationFrame. When the first
// requestAnimationFrame is called, we know that a frame is in the
// pipeline. When the second requestAnimationFrame is called, we know that
// the first frame has reached the screen.
return conn.Eval(ctx, `(async () => {
await new Promise(window.requestAnimationFrame);
await new Promise(window.requestAnimationFrame);
})()`, nil)
}
// NavigateToURLInApp navigate to a particular sub page in app via changing URL in javascript.
// It uses a condition check to make sure the function completes correctly.
// It is high recommended to use UI validation in condition check.
func NavigateToURLInApp(conn *chrome.Conn, url string, condition uiauto.Action, timeout time.Duration) uiauto.Action {
return uiauto.Retry(3, func(ctx context.Context) error {
// Eval javascript function to change page url.
if err := conn.Eval(ctx, fmt.Sprintf("window.location = %q", url), nil); err != nil {
return errors.Wrap(err, "failed to run javascript to set window location")
}
// Wait for condition after changing location.
if err := testing.Poll(ctx, condition, &testing.PollOptions{Timeout: 20 * time.Second, Interval: 200 * time.Millisecond}); err != nil {
return errors.Wrap(err, "failed to match condition after changing page location in javascript")
}
return nil
})
}