Skip to content

feat: add support for originalOpener in BrowsingContext.Info #2318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 17, 2024
Merged

feat: add support for originalOpener in BrowsingContext.Info #2318

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0be113
build(spec): update WebDriverBidi types
browser-automation-bot Jun 14, 2024
8f26e8d
feat: add support for `originalOpener` in BrowsingContext.Info
Lightning00Blade Jun 14, 2024
5c53deb
chore: update E2E tests
Lightning00Blade Jun 17, 2024
2bd67e1
chore: fix format
Lightning00Blade Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/bidiMapper/modules/cdp/CdpTarget.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ export class CdpTarget {
this.#browsingContextStorage,
this.#realmStorage,
frame.url,
undefined,
this.#logger
);
}
Expand Down
2 changes: 2 additions & 0 deletions src/bidiMapper/modules/cdp/CdpTargetManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ export class CdpTargetManager {
// At this point, we don't know the URL of the frame yet, so it will be updated
// later.
'about:blank',
undefined,
this.#logger
);
}
Expand Down Expand Up @@ -187,6 +188,7 @@ export class CdpTargetManager {
// https://html.spec.whatwg.org/multipage/document-sequences.html#creating-browsing-contexts
// TODO: check who to deal with non-null creator and its `creatorOrigin`.
targetInfo.url === '' ? 'about:blank' : targetInfo.url,
targetInfo.openerId,
this.#logger
);
}
Expand Down
8 changes: 8 additions & 0 deletions src/bidiMapper/modules/context/BrowsingContextImpl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ export class BrowsingContextImpl {
// Keeps track of the previously set viewport.
#previousViewport: {width: number; height: number} = {width: 0, height: 0};

#originalOpener?: string;

private constructor(
id: BrowsingContext.BrowsingContext,
parentId: BrowsingContext.BrowsingContext | null,
Expand All @@ -88,6 +90,7 @@ export class BrowsingContextImpl {
browsingContextStorage: BrowsingContextStorage,
realmStorage: RealmStorage,
url: string,
originalOpener?: string,
logger?: LoggerFn
) {
this.#cdpTarget = cdpTarget;
Expand All @@ -99,6 +102,8 @@ export class BrowsingContextImpl {
this.#realmStorage = realmStorage;
this.#logger = logger;
this.#url = url;

this.#originalOpener = originalOpener;
}

static create(
Expand All @@ -110,6 +115,7 @@ export class BrowsingContextImpl {
browsingContextStorage: BrowsingContextStorage,
realmStorage: RealmStorage,
url: string,
originalOpener?: string,
logger?: LoggerFn
): BrowsingContextImpl {
const context = new BrowsingContextImpl(
Expand All @@ -121,6 +127,7 @@ export class BrowsingContextImpl {
browsingContextStorage,
realmStorage,
url,
originalOpener,
logger
);

Expand Down Expand Up @@ -305,6 +312,7 @@ export class BrowsingContextImpl {
context: this.#id,
url: this.url,
userContext: this.userContext,
originalOpener: this.#originalOpener ?? null,
children:
maxDepth > 0
? this.directChildren.map((c) =>
Expand Down
4 changes: 4 additions & 0 deletions src/protocol-parser/generated/webdriver-bidi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,10 @@ export namespace BrowsingContext {
z.object({
children: z.union([BrowsingContext.InfoListSchema, z.null()]),
context: BrowsingContext.BrowsingContextSchema,
originalOpener: z.union([
BrowsingContext.BrowsingContextSchema,
z.null(),
]),
url: z.string(),
userContext: Browser.UserContextSchema,
parent: z
Expand Down
1 change: 1 addition & 0 deletions src/protocol/generated/webdriver-bidi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,7 @@ export namespace BrowsingContext {
export type Info = {
children: BrowsingContext.InfoList | null;
context: BrowsingContext.BrowsingContext;
originalOpener: BrowsingContext.BrowsingContext | null;
url: string;
userContext: Browser.UserContext;
parent?: BrowsingContext.BrowsingContext | null;
Expand Down
1 change: 1 addition & 0 deletions tests/browsing_context/__snapshots__/test_close.ambr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
'method': 'browsingContext.contextDestroyed',
'params': dict({
'children': None,
'originalOpener': None,
'parent': None,
'url': "data:text/html,%0A <script>%0A window.addEventListener('beforeunload', event => {%0A event.returnValue = 'Leave?%27;%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20event.preventDefault();%0A%20%20%20%20%20%20%20%20%20%20%20%20});%0A%20%20%20%20%20%20%20%20%3C/script%3E",
'userContext': 'default',
Expand Down
6 changes: 3 additions & 3 deletions tests/browsing_context/test_close.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# limitations under the License.
import pytest
from syrupy.filters import paths
from test_helpers import (execute_command, get_tree, goto_url,
from test_helpers import (AnyExtending, execute_command, get_tree, goto_url,
read_JSON_message, send_JSON_command, subscribe,
wait_for_event)

Expand All @@ -32,7 +32,7 @@ async def test_browsingContext_close(websocket, context_id):

# Assert "browsingContext.contextCreated" event emitted.
resp = await read_JSON_message(websocket)
assert resp == {
assert resp == AnyExtending({
'type': 'event',
"method": "browsingContext.contextDestroyed",
"params": {
Expand All @@ -42,7 +42,7 @@ async def test_browsingContext_close(websocket, context_id):
"children": None,
"userContext": "default"
}
}
})

resp = await read_JSON_message(websocket)
assert resp == {"type": "success", "id": command_id, "result": {}}
Expand Down
27 changes: 16 additions & 11 deletions tests/browsing_context/test_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ async def test_browsingContext_create_eventContextCreatedEmitted(
"url": "about:blank",
"children": None,
"parent": None,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}
} == context_created_event

Expand Down Expand Up @@ -132,18 +133,21 @@ async def test_browsingContext_createWithNestedSameOriginContexts_eventContextCr
"parent": None,
"url": top_level_page,
"userContext": "default",
"originalOpener": None,
"children": [
{
"context": ANY_STR,
# It's not guaranteed the nested page is already loaded.
"url": ANY_STR,
"userContext": "default",
"originalOpener": None,
"children": [{
"context": ANY_STR,
# It's not guaranteed the nested page is already loaded.
"url": ANY_STR,
"userContext": "default",
"children": []
"children": [],
"originalOpener": None
}]
},
]
Expand All @@ -154,7 +158,7 @@ async def test_browsingContext_createWithNestedSameOriginContexts_eventContextCr
"context"]
nested_iframe_context_id = \
tree["contexts"][0]["children"][0]["children"][0]["context"]
assert events[0] == {
assert events[0] == AnyExtending({
'type': 'event',
"method": "browsingContext.contextCreated",
"params": {
Expand All @@ -164,9 +168,9 @@ async def test_browsingContext_createWithNestedSameOriginContexts_eventContextCr
'url': 'about:blank',
'userContext': 'default'
}
}
})

assert events[1] == {
assert events[1] == AnyExtending({
'type': 'event',
"method": "browsingContext.contextCreated",
"params": {
Expand All @@ -176,7 +180,7 @@ async def test_browsingContext_createWithNestedSameOriginContexts_eventContextCr
'url': 'about:blank',
'userContext': 'default'
}
}
})


@pytest.mark.asyncio
Expand Down Expand Up @@ -235,7 +239,8 @@ async def test_browsingContext_create_withUserGesture_eventsEmitted(
'url': 'about:blank',
'children': None,
'parent': None,
'userContext': 'default'
'userContext': 'default',
'originalOpener': ANY_STR,
}
}, {
'type': 'event',
Expand Down Expand Up @@ -287,13 +292,13 @@ async def test_browsingContext_create_withUserContext(websocket, type):

assert len(tree['contexts']) == 2

assert tree["contexts"][1] == {
assert tree["contexts"][1] == AnyExtending({
'context': result['context'],
'url': 'about:blank',
'userContext': user_context["userContext"],
'children': [],
'parent': None
}
})


@pytest.mark.asyncio
Expand All @@ -314,8 +319,8 @@ async def test_browsingContext_subscribe_to_contextCreated_emits_for_existing(
],
# Missing "contexts" means global subscription.
**({} if global_subscription else {
"contexts": [another_context_id]
})
"contexts": [another_context_id]
})
}
})

Expand Down
24 changes: 16 additions & 8 deletions tests/browsing_context/test_get_tree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ async def test_browsingContext_getTree_contextReturned(websocket, context_id):
"children": [],
"parent": None,
"url": "about:blank",
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
}

Expand All @@ -54,7 +55,8 @@ async def test_browsingContext_getTreeWithRoot_contextReturned(websocket):
"parent": None,
"url": "about:blank",
"children": [],
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
}

Expand All @@ -78,11 +80,13 @@ async def test_browsingContext_afterNavigation_getTreeWithNestedCrossOriginConte
"context": ANY_STR,
"url": another_example_url,
"children": [],
"userContext": "default"
"userContext": "default",
"originalOpener": None
}],
"parent": None,
"url": another_page_with_nested_iframe,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -108,11 +112,13 @@ async def test_browsingContext_afterNavigation_getTreeWithNestedContexts_context
"context": ANY_STR,
"url": nested_iframe,
"children": [],
"userContext": "default"
"userContext": "default",
"originalOpener": None
}],
"parent": None,
"url": page_with_nested_iframe,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -127,10 +133,12 @@ async def test_browsingContext_afterNavigation_getTreeWithNestedContexts_context
"context": ANY_STR,
"url": another_nested_iframe,
"children": [],
"userContext": "default"
"userContext": "default",
"originalOpener": None
}],
"parent": None,
"url": another_page_with_nested_iframe,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result
17 changes: 11 additions & 6 deletions tests/browsing_context/test_navigate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@ async def test_browsingContext_navigateSameDocumentNavigation_waitInteractive_na
"children": [],
"parent": None,
"url": url_with_hash_1,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -251,7 +252,8 @@ async def test_browsingContext_navigateSameDocumentNavigation_waitInteractive_na
"children": [],
"parent": None,
"url": url_with_hash_2,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -277,7 +279,8 @@ async def test_browsingContext_navigateSameDocumentNavigation_waitComplete_navig
"children": [],
"parent": None,
"url": url_with_hash_1,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -292,7 +295,8 @@ async def test_browsingContext_navigateSameDocumentNavigation_waitComplete_navig
"children": [],
"parent": None,
"url": url_with_hash_2,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
} == result

Expand All @@ -314,7 +318,8 @@ async def test_navigateToPageWithHash_contextInfoUpdated(
"children": [],
"parent": None,
"url": url_with_hash_1,
"userContext": "default"
"userContext": "default",
"originalOpener": None
}]
}

Expand Down Expand Up @@ -448,7 +453,7 @@ async def test_browsingContext_navigateBadSsl_notNavigated(
'acceptInsecureCerts': True
}
}],
indirect=['websocket'])
indirect=['websocket'])
async def test_browsingContext_navigateBadSslAndAcceptInsecureCerts_navigated(
websocket, context_id, bad_ssl_url):
await execute_command(
Expand Down
Loading
Loading