Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Warnings
- This test has a WPT meta file that expects 3 subtest issues.
- This WPT test may be referenced by the following Test IDs:
- /webdriver/tests/bidi/browsing_context/navigation_started/navigation_started.py - WPT Dashboard Interop Dashboard
import pytest
from tests.support.sync import AsyncPoll
from webdriver.error import TimeoutException
from webdriver.bidi.error import UnknownErrorException
from webdriver.bidi.modules.script import ContextTarget
from ... import int_interval
from .. import assert_navigation_info
pytestmark = pytest.mark.asyncio
NAVIGATION_STARTED_EVENT = "browsingContext.navigationStarted"
PAGE_EMPTY = "/webdriver/tests/bidi/browsing_context/support/empty.html"
PAGE_REDIRECT_HTTP_EQUIV = (
"/webdriver/tests/bidi/network/support/redirect_http_equiv.html"
)
PAGE_REDIRECTED_HTML = "/webdriver/tests/bidi/network/support/redirected.html"
async def test_unsubscribe(bidi_session):
await bidi_session.session.subscribe(events=[NAVIGATION_STARTED_EVENT])
await bidi_session.session.unsubscribe(events=[NAVIGATION_STARTED_EVENT])
# Track all received browsingContext.navigationStarted events in the events array
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
await bidi_session.browsing_context.create(type_hint="tab")
wait = AsyncPoll(bidi_session, timeout=0.5)
with pytest.raises(TimeoutException):
await wait.until(lambda _: len(events) > 0)
remove_listener()
async def test_subscribe(
bidi_session, subscribe_events, inline, new_tab, wait_for_event, wait_for_future_safe
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
url = inline("<div>foo</div>")
result = await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url
)
event = await wait_for_future_safe(on_entry)
assert_navigation_info(
event,
{
"context": new_tab["context"],
"navigation": result["navigation"],
"url": url,
},
)
async def test_timestamp(
bidi_session, current_time, subscribe_events, inline, new_tab, wait_for_event, wait_for_future_safe
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
time_start = await current_time()
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
url = inline("<div>foo</div>")
result = await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url
)
event = await wait_for_future_safe(on_entry)
time_end = await current_time()
assert_navigation_info(
event,
{
"context": new_tab["context"],
"navigation": result["navigation"],
"timestamp": int_interval(time_start, time_end),
},
)
async def test_iframe(
bidi_session, subscribe_events, top_context, test_page_same_origin_frame, test_page
):
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
result = await bidi_session.browsing_context.navigate(
context=top_context["context"], url=test_page_same_origin_frame, wait="complete"
)
# Check that 2 navigation-started events were received, one for the top context
# and one for the iframe.
assert len(events) == 2
contexts = await bidi_session.browsing_context.get_tree(root=top_context["context"])
assert len(contexts) == 1
root_info = contexts[0]
children_info = root_info["children"]
assert len(children_info) == 1
# First navigation-started event comes from the top-level browsing context.
assert_navigation_info(
events[0],
{
"context": top_context["context"],
"navigation": result["navigation"],
"url": test_page_same_origin_frame,
},
)
assert_navigation_info(
events[1],
{
"context": children_info[0]["context"],
"url": test_page,
},
)
assert events[1]["navigation"] is not None
assert events[1]["navigation"] != result["navigation"]
remove_listener()
async def test_nested_iframes(
bidi_session,
subscribe_events,
top_context,
test_page_nested_frames,
test_page_same_origin_frame,
test_page,
):
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
result = await bidi_session.browsing_context.navigate(
context=top_context["context"], url=test_page_nested_frames, wait="complete"
)
# Check that 3 navigation-started events were received, one for the top context
# and one for each of the 2 iframes.
assert len(events) == 3
contexts = await bidi_session.browsing_context.get_tree(root=top_context["context"])
assert len(contexts) == 1
root_info = contexts[0]
assert len(root_info["children"]) == 1
child1_info = root_info["children"][0]
assert len(child1_info["children"]) == 1
child2_info = child1_info["children"][0]
assert_navigation_info(
events[0],
{
"context": root_info["context"],
"navigation": result["navigation"],
"url": test_page_nested_frames,
},
)
assert_navigation_info(
events[1],
{
"context": child1_info["context"],
"url": test_page_same_origin_frame,
},
)
assert events[1]["navigation"] is not None
assert events[1]["navigation"] != result["navigation"]
assert_navigation_info(
events[2],
{
"context": child2_info["context"],
"url": test_page,
},
)
assert events[2]["navigation"] is not None
assert events[2]["navigation"] != result["navigation"]
assert events[2]["navigation"] != events[1]["navigation"]
remove_listener()
@pytest.mark.parametrize("type_hint", ["tab", "window"])
async def test_new_context(bidi_session, subscribe_events, wait_for_event, wait_for_future_safe, type_hint):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
top_level_context = await bidi_session.browsing_context.create(type_hint="tab")
navigation_info = await wait_for_future_safe(on_entry)
assert_navigation_info(
navigation_info,
{
"context": top_level_context["context"],
"url": "about:blank",
},
)
async def test_same_document_navigation(bidi_session, new_tab, url, subscribe_events):
await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url(PAGE_EMPTY), wait="complete"
)
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
# Track all received browsingContext.navigationStarted events in the events array
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url(PAGE_EMPTY + "#foo"), wait="complete"
)
remove_listener()
async def test_window_open(bidi_session, subscribe_events, wait_for_event, wait_for_future_safe, top_context):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
await bidi_session.script.evaluate(
expression="""window.open('about:blank');""",
target=ContextTarget(top_context["context"]),
await_promise=False,
)
navigation_info = await wait_for_future_safe(on_entry)
assert_navigation_info(
navigation_info,
{
"url": "about:blank",
},
)
assert navigation_info["navigation"] is not None
# Retrieve all contexts to get the context for the new window.
contexts = await bidi_session.browsing_context.get_tree()
assert navigation_info["context"] == contexts[-1]["context"]
async def test_document_write(bidi_session, subscribe_events, top_context):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
# Track all received browsingContext.navigationStarted events in the events array
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
await bidi_session.script.evaluate(
expression="""document.open(); document.write("<h1>Replaced</h1>"); document.close();""",
target=ContextTarget(top_context["context"]),
await_promise=False,
)
wait = AsyncPoll(bidi_session, timeout=0.5)
with pytest.raises(TimeoutException):
await wait.until(lambda _: len(events) > 0)
remove_listener()
async def test_page_with_base_tag(
bidi_session, subscribe_events, inline, new_tab, wait_for_event, wait_for_future_safe
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
url = inline("""<base href="/relative-path">""")
result = await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url
)
event = await wait_for_future_safe(on_entry)
assert_navigation_info(
event,
{"context": new_tab["context"], "navigation": result["navigation"], "url": url},
)
@pytest.mark.parametrize(
"url",
[
"thisprotocoldoesnotexist://",
],
ids=[
"protocol",
"host",
],
)
async def test_invalid_navigation(
bidi_session, new_tab, subscribe_events, wait_for_event, wait_for_future_safe, url
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
with pytest.raises(UnknownErrorException):
await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url, wait="complete"
)
navigation_info = await wait_for_future_safe(on_entry)
assert_navigation_info(
navigation_info,
{
"context": new_tab["context"],
"url": url,
},
)
assert navigation_info["navigation"] is not None
await bidi_session.session.unsubscribe(events=[NAVIGATION_STARTED_EVENT])
async def test_redirect_http_equiv(
bidi_session, subscribe_events, top_context, url
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
# Track all received browsingContext.navigationStarted events in the events array
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
# PAGE_REDIRECT_HTTP_EQUIV should redirect to PAGE_REDIRECTED_HTML immediately
http_equiv_url = url(PAGE_REDIRECT_HTTP_EQUIV)
redirected_url = url(PAGE_REDIRECTED_HTML)
await bidi_session.browsing_context.navigate(
context=top_context["context"],
url=http_equiv_url,
wait="complete",
)
# Wait until we receive two events, one for the initial navigation and one
# for the http-equiv "redirect".
wait = AsyncPoll(bidi_session, timeout=2)
await wait.until(lambda _: len(events) >= 2)
assert len(events) == 2
assert_navigation_info(
events[0],
{
"context": top_context["context"],
"url": http_equiv_url,
},
)
assert_navigation_info(
events[1],
{
"context": top_context["context"],
"url": redirected_url,
},
)
remove_listener()
async def test_redirect_navigation(
bidi_session, subscribe_events, top_context, url
):
await subscribe_events(events=[NAVIGATION_STARTED_EVENT])
# Track all received browsingContext.navigationStarted events in the events array
events = []
async def on_event(method, data):
events.append(data)
remove_listener = bidi_session.add_event_listener(
NAVIGATION_STARTED_EVENT, on_event
)
html_url = url(PAGE_EMPTY)
redirect_url = url(
f"/webdriver/tests/support/http_handlers/redirect.py?location={html_url}"
)
await bidi_session.browsing_context.navigate(
context=top_context["context"],
url=redirect_url,
wait="complete",
)
assert len(events) == 1
assert_navigation_info(
events[0],
{
"context": top_context["context"],
"url": redirect_url,
},
)
remove_listener()
async def test_navigate_history_pushstate(
bidi_session, inline, new_tab, subscribe_events, wait_for_event, wait_for_future_safe
):
await subscribe_events([NAVIGATION_STARTED_EVENT])
on_entry = wait_for_event(NAVIGATION_STARTED_EVENT)
url = inline("""
<script>
window.addEventListener('DOMContentLoaded', () => {
history.pushState({}, '', '#1');
});
</script>""")
result = await bidi_session.browsing_context.navigate(
context=new_tab["context"], url=url, wait="complete"
)
event = await wait_for_future_safe(on_entry)
assert event["navigation"] == result["navigation"]