Skip to content

Commit fd9fbaa

Browse files
pujaganipujagani
committed
[java][bidi] Add mechanism to listen to network event - beforeRequestSent
1 parent 83944ed commit fd9fbaa

4 files changed

Lines changed: 182 additions & 6 deletions

File tree

‎java/src/org/openqa/selenium/bidi/Network.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
// Licensed to the Software Freedom Conservancy (SFC) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The SFC licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
package org.openqa.selenium.bidi;
19+
20+
import java.util.Collections;
21+
import java.util.HashSet;
22+
import java.util.Set;
23+
import java.util.function.Consumer;
24+
import org.openqa.selenium.WebDriver;
25+
import org.openqa.selenium.bidi.network.BeforeRequestSent;
26+
import org.openqa.selenium.internal.Require;
27+
28+
public class Network implements AutoCloseable {
29+
30+
private final Set<String> browsingContextIds;
31+
32+
private final BiDi bidi;
33+
34+
private final Event<BeforeRequestSent> beforeRequestSentEvent =
35+
new Event<>("network.beforeRequestSent", BeforeRequestSent::fromJsonMap);
36+
37+
public Network(WebDriver driver) {
38+
this(new HashSet<>(), driver);
39+
}
40+
41+
public Network(String browsingContextId, WebDriver driver) {
42+
this(Collections.singleton(Require.nonNull("Browsing context id", browsingContextId)), driver);
43+
}
44+
45+
public Network(Set<String> browsingContextIds, WebDriver driver) {
46+
Require.nonNull("WebDriver", driver);
47+
Require.nonNull("Browsing context id list", browsingContextIds);
48+
49+
if (!(driver instanceof HasBiDi)) {
50+
throw new IllegalArgumentException("WebDriver instance must support BiDi protocol");
51+
}
52+
53+
this.bidi = ((HasBiDi) driver).getBiDi();
54+
this.browsingContextIds = browsingContextIds;
55+
}
56+
57+
public void onBeforeRequestSent(Consumer<BeforeRequestSent> consumer) {
58+
if (browsingContextIds.isEmpty()) {
59+
this.bidi.addListener(beforeRequestSentEvent, consumer);
60+
} else {
61+
this.bidi.addListener(browsingContextIds, beforeRequestSentEvent, consumer);
62+
}
63+
}
64+
65+
@Override
66+
public void close() {
67+
this.bidi.clearListener(beforeRequestSentEvent);
68+
}
69+
}

‎java/src/org/openqa/selenium/bidi/network/BeforeRequestSent.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package org.openqa.selenium.bidi.network;
22

3+
import java.io.StringReader;
4+
import java.util.Map;
35
import org.openqa.selenium.json.Json;
46
import org.openqa.selenium.json.JsonInput;
57

6-
import java.io.StringReader;
7-
88
public class BeforeRequestSent extends BaseParameters {
99
private static final Json JSON = new Json();
1010

@@ -22,12 +22,11 @@ private BeforeRequestSent(BaseParameters baseParameters, Initiator initiator) {
2222
this.initiator = initiator;
2323
}
2424

25-
public static BeforeRequestSent fromJsonString(String jsonString) {
26-
try (StringReader baseParameterReader = new StringReader(jsonString);
27-
StringReader initiatorReader = new StringReader(jsonString);
25+
public static BeforeRequestSent fromJsonMap(Map<String, Object> jsonMap) {
26+
try (StringReader baseParameterReader = new StringReader(JSON.toJson(jsonMap));
27+
StringReader initiatorReader = new StringReader(JSON.toJson(jsonMap.get("initiator")));
2828
JsonInput baseParamsInput = JSON.newInput(baseParameterReader);
2929
JsonInput initiatorInput = JSON.newInput(initiatorReader)) {
30-
3130
return new BeforeRequestSent(
3231
BaseParameters.fromJson(baseParamsInput), Initiator.fromJson(initiatorInput));
3332
}

‎java/test/org/openqa/selenium/bidi/network/BUILD.bazel‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
load("@rules_jvm_external//:defs.bzl", "artifact")
2+
load("//java:defs.bzl", "JUNIT5_DEPS", "java_selenium_test_suite")
3+
4+
java_selenium_test_suite(
5+
name = "large-tests",
6+
size = "large",
7+
srcs = glob(["*Test.java"]),
8+
browsers = [
9+
"firefox",
10+
],
11+
tags = [
12+
"selenium-remote",
13+
],
14+
deps = [
15+
"//java/src/org/openqa/selenium/bidi",
16+
"//java/src/org/openqa/selenium/firefox",
17+
"//java/src/org/openqa/selenium/grid/security",
18+
"//java/src/org/openqa/selenium/json",
19+
"//java/src/org/openqa/selenium/remote",
20+
"//java/src/org/openqa/selenium/support",
21+
"//java/test/org/openqa/selenium/environment",
22+
"//java/test/org/openqa/selenium/testing:annotations",
23+
"//java/test/org/openqa/selenium/testing:test-base",
24+
"//java/test/org/openqa/selenium/testing/drivers",
25+
artifact("org.junit.jupiter:junit-jupiter-api"),
26+
artifact("org.assertj:assertj-core"),
27+
] + JUNIT5_DEPS,
28+
)

‎java/test/org/openqa/selenium/bidi/network/NetworkEventsTest.java‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// Licensed to the Software Freedom Conservancy (SFC) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The SFC licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
package org.openqa.selenium.bidi.network;
19+
20+
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
21+
import static org.openqa.selenium.testing.Safely.safelyCall;
22+
23+
import java.util.concurrent.CompletableFuture;
24+
import java.util.concurrent.ExecutionException;
25+
import java.util.concurrent.TimeUnit;
26+
import java.util.concurrent.TimeoutException;
27+
import org.junit.jupiter.api.AfterEach;
28+
import org.junit.jupiter.api.BeforeEach;
29+
import org.junit.jupiter.api.Test;
30+
import org.openqa.selenium.bidi.Network;
31+
import org.openqa.selenium.environment.webserver.AppServer;
32+
import org.openqa.selenium.environment.webserver.NettyAppServer;
33+
import org.openqa.selenium.firefox.FirefoxDriver;
34+
import org.openqa.selenium.firefox.FirefoxOptions;
35+
import org.openqa.selenium.testing.drivers.Browser;
36+
37+
class NetworkEventsTest {
38+
39+
private String page;
40+
private AppServer server;
41+
private FirefoxDriver driver;
42+
43+
@BeforeEach
44+
public void setUp() {
45+
FirefoxOptions options = (FirefoxOptions) Browser.FIREFOX.getCapabilities();
46+
options.setCapability("webSocketUrl", true);
47+
48+
driver = new FirefoxDriver(options);
49+
50+
server = new NettyAppServer();
51+
server.start();
52+
}
53+
54+
@Test
55+
void canListenToBeforeRequestSentEvent()
56+
throws ExecutionException, InterruptedException, TimeoutException {
57+
try (Network network = new Network(driver)) {
58+
CompletableFuture<BeforeRequestSent> future = new CompletableFuture<>();
59+
network.onBeforeRequestSent(future::complete);
60+
page = server.whereIs("/bidi/logEntryAdded.html");
61+
driver.get(page);
62+
63+
BeforeRequestSent requestSent = future.get(5, TimeUnit.SECONDS);
64+
String windowHandle = driver.getWindowHandle();
65+
assertThat(requestSent.getBrowsingContextId()).isEqualTo(windowHandle);
66+
assertThat(requestSent.getRequest().getRequestId()).isNotNull();
67+
assertThat(requestSent.getRequest().getMethod()).isEqualToIgnoringCase("get");
68+
assertThat(requestSent.getRequest().getUrl()).isNotNull();
69+
assertThat(requestSent.getInitiator().getType().toString()).isEqualToIgnoringCase("other");
70+
}
71+
}
72+
73+
@AfterEach
74+
public void quitDriver() {
75+
if (driver != null) {
76+
driver.quit();
77+
}
78+
safelyCall(server::stop);
79+
}
80+
}

0 commit comments

Comments
 (0)