Skip to content

Commit 1fd33ed

Browse files
pujaganipujagani
committed
[bidi][java] Add network module events - onResponseStarted and onResponseCompleted
1 parent 6c1f5c3 commit 1fd33ed

4 files changed

Lines changed: 111 additions & 6 deletions

File tree

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import java.util.function.Consumer;
2424
import org.openqa.selenium.WebDriver;
2525
import org.openqa.selenium.bidi.network.BeforeRequestSent;
26+
import org.openqa.selenium.bidi.network.ResponseDetails;
2627
import org.openqa.selenium.internal.Require;
2728

2829
public class Network implements AutoCloseable {
@@ -34,6 +35,12 @@ public class Network implements AutoCloseable {
3435
private final Event<BeforeRequestSent> beforeRequestSentEvent =
3536
new Event<>("network.beforeRequestSent", BeforeRequestSent::fromJsonMap);
3637

38+
private final Event<ResponseDetails> responseStarted =
39+
new Event<>("network.responseStarted", ResponseDetails::fromJsonMap);
40+
41+
private final Event<ResponseDetails> responseCompleted =
42+
new Event<>("network.responseStarted", ResponseDetails::fromJsonMap);
43+
3744
public Network(WebDriver driver) {
3845
this(new HashSet<>(), driver);
3946
}
@@ -62,8 +69,26 @@ public void onBeforeRequestSent(Consumer<BeforeRequestSent> consumer) {
6269
}
6370
}
6471

72+
public void onResponseStarted(Consumer<ResponseDetails> consumer) {
73+
if (browsingContextIds.isEmpty()) {
74+
this.bidi.addListener(responseStarted, consumer);
75+
} else {
76+
this.bidi.addListener(browsingContextIds, responseStarted, consumer);
77+
}
78+
}
79+
80+
public void onResponseCompleted(Consumer<ResponseDetails> consumer) {
81+
if (browsingContextIds.isEmpty()) {
82+
this.bidi.addListener(responseCompleted, consumer);
83+
} else {
84+
this.bidi.addListener(browsingContextIds, responseStarted, consumer);
85+
}
86+
}
87+
6588
@Override
6689
public void close() {
6790
this.bidi.clearListener(beforeRequestSentEvent);
91+
this.bidi.clearListener(responseStarted);
92+
this.bidi.clearListener(responseCompleted);
6893
}
6994
}

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class ResponseData {
3636
private final long bytesReceived;
3737
private final long headersSize;
3838
private final long bodySize;
39-
private final long content;
39+
private final Optional<Long> content;
4040
private final Optional<AuthChallenge> authChallenge;
4141

4242
private ResponseData(
@@ -50,7 +50,7 @@ private ResponseData(
5050
long bytesReceived,
5151
long headersSize,
5252
long bodySize,
53-
long content,
53+
Optional<Long> content,
5454
Optional<AuthChallenge> authChallenge) {
5555
this.url = url;
5656
this.protocol = protocol;
@@ -77,7 +77,7 @@ public static ResponseData fromJson(JsonInput input) {
7777
long bytesReceived = 0;
7878
long headersSize = 0;
7979
long bodySize = 0;
80-
long content = 0;
80+
Optional<Long> content = Optional.empty();
8181
Optional<AuthChallenge> authChallenge = Optional.empty();
8282
input.beginObject();
8383
while (input.hasNext()) {
@@ -98,7 +98,7 @@ public static ResponseData fromJson(JsonInput input) {
9898
fromCache = input.read(Boolean.class);
9999
break;
100100
case "headers":
101-
headers = input.read(String.class);
101+
headers = input.read(new TypeToken<List<Header>>() {}.getType());
102102
break;
103103
case "mimeType":
104104
mimeType = input.read(String.class);
@@ -115,7 +115,7 @@ public static ResponseData fromJson(JsonInput input) {
115115
case "content":
116116
Map<String, Long> responseContent =
117117
input.read(new TypeToken<Map<String, Long>>() {}.getType());
118-
content = responseContent.get("size");
118+
content = Optional.ofNullable(responseContent.get("size"));
119119
break;
120120
case "authChallenge":
121121
authChallenge = Optional.of(input.read(AuthChallenge.class));
@@ -182,7 +182,7 @@ public long getBodySize() {
182182
return bodySize;
183183
}
184184

185-
public long getContent() {
185+
public Optional<Long> getContent() {
186186
return content;
187187
}
188188

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package org.openqa.selenium.bidi.network;
2+
3+
import java.io.StringReader;
4+
import java.util.Map;
5+
import org.openqa.selenium.json.Json;
6+
import org.openqa.selenium.json.JsonInput;
7+
8+
public class ResponseDetails extends BaseParameters {
9+
private static final Json JSON = new Json();
10+
11+
private final ResponseData responseData;
12+
13+
private ResponseDetails(BaseParameters baseParameters, ResponseData responseData) {
14+
super(
15+
baseParameters.getBrowsingContextId(),
16+
baseParameters.isBlocked(),
17+
baseParameters.getNavigationId(),
18+
baseParameters.getRedirectCount(),
19+
baseParameters.getRequest(),
20+
baseParameters.getTimestamp(),
21+
baseParameters.getIntercepts());
22+
this.responseData = responseData;
23+
}
24+
25+
public static ResponseDetails fromJsonMap(Map<String, Object> jsonMap) {
26+
try (StringReader baseParameterReader = new StringReader(JSON.toJson(jsonMap));
27+
StringReader responseDataReader = new StringReader(JSON.toJson(jsonMap.get("response")));
28+
JsonInput baseParamsInput = JSON.newInput(baseParameterReader);
29+
JsonInput responseDataInput = JSON.newInput(responseDataReader)) {
30+
return new ResponseDetails(
31+
BaseParameters.fromJson(baseParamsInput), ResponseData.fromJson(responseDataInput));
32+
}
33+
}
34+
35+
public ResponseData getResponseData() {
36+
return responseData;
37+
}
38+
}

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,48 @@ void canListenToBeforeRequestSentEvent()
7070
}
7171
}
7272

73+
@Test
74+
void canListenToResponseStartedEvent()
75+
throws ExecutionException, InterruptedException, TimeoutException {
76+
try (Network network = new Network(driver)) {
77+
CompletableFuture<ResponseDetails> future = new CompletableFuture<>();
78+
network.onResponseStarted(future::complete);
79+
page = server.whereIs("/bidi/logEntryAdded.html");
80+
driver.get(page);
81+
82+
ResponseDetails response = future.get(5, TimeUnit.SECONDS);
83+
String windowHandle = driver.getWindowHandle();
84+
assertThat(response.getBrowsingContextId()).isEqualTo(windowHandle);
85+
assertThat(response.getRequest().getRequestId()).isNotNull();
86+
assertThat(response.getRequest().getMethod()).isEqualToIgnoringCase("get");
87+
assertThat(response.getRequest().getUrl()).isNotNull();
88+
assertThat(response.getResponseData().getHeaders().size()).isGreaterThanOrEqualTo(1);
89+
assertThat(response.getResponseData().getUrl()).contains("/bidi/logEntryAdded.html");
90+
assertThat(response.getResponseData().getStatus()).isEqualTo(200L);
91+
}
92+
}
93+
94+
@Test
95+
void canListenToResponseCompletedEvent()
96+
throws ExecutionException, InterruptedException, TimeoutException {
97+
try (Network network = new Network(driver)) {
98+
CompletableFuture<ResponseDetails> future = new CompletableFuture<>();
99+
network.onResponseCompleted(future::complete);
100+
page = server.whereIs("/bidi/logEntryAdded.html");
101+
driver.get(page);
102+
103+
ResponseDetails response = future.get(5, TimeUnit.SECONDS);
104+
String windowHandle = driver.getWindowHandle();
105+
assertThat(response.getBrowsingContextId()).isEqualTo(windowHandle);
106+
assertThat(response.getRequest().getRequestId()).isNotNull();
107+
assertThat(response.getRequest().getMethod()).isEqualToIgnoringCase("get");
108+
assertThat(response.getRequest().getUrl()).isNotNull();
109+
assertThat(response.getResponseData().getHeaders().size()).isGreaterThanOrEqualTo(1);
110+
assertThat(response.getResponseData().getUrl()).contains("/bidi/logEntryAdded.html");
111+
assertThat(response.getResponseData().getStatus()).isEqualTo(200L);
112+
}
113+
}
114+
73115
@AfterEach
74116
public void quitDriver() {
75117
if (driver != null) {

0 commit comments

Comments
 (0)