[java][cdp] Ensure console events return args as it is (#11435)

pujagani · web-flow · commit 431f7757b1c5 · 2022-12-16T13:14:51.000+05:30
Fixes #11377
diff --git a/java/src/org/openqa/selenium/devtools/events/ConsoleEvent.java b/java/src/org/openqa/selenium/devtools/events/ConsoleEvent.java
@@ -23,18 +23,21 @@
 
 import java.time.Instant;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 public class ConsoleEvent {
 
   private final String type;
   private final Instant timestamp;
+  private final List<Object> modifiedArgs;
   private final List<Object> args;
 
-  public ConsoleEvent(String type, Instant timestamp, Object... args) {
+  public ConsoleEvent(String type, Instant timestamp, List<Object> modifiedArgs, Object... args) {
     this.type = type;
     this.timestamp = timestamp;
+    this.modifiedArgs = modifiedArgs;
     this.args = ImmutableList.copyOf(args);
   }
 
@@ -51,11 +54,10 @@ public List<Object> getArgs() {
   }
 
   public List<String> getMessages() {
-    return args.stream()
-      .map(List.class::cast)
-      .map(lst -> lst.get(0))
+    return modifiedArgs.stream()
       .map(RemoteObject.class::cast)
       .map(RemoteObject::getValue)
+      .filter(Objects::nonNull)
       .map(Object::toString)
       .collect(Collectors.toList());
   }
diff --git a/java/src/org/openqa/selenium/devtools/v105/V105Events.java b/java/src/org/openqa/selenium/devtools/v105/V105Events.java
@@ -74,7 +74,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {
     return new ConsoleEvent(
       event.getType().toString(),
       Instant.ofEpochMilli(ts),
-      modifiedArgs);
+      modifiedArgs,
+      event.getArgs());
   }
 
   @Override
diff --git a/java/src/org/openqa/selenium/devtools/v106/V106Events.java b/java/src/org/openqa/selenium/devtools/v106/V106Events.java
@@ -74,7 +74,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {
     return new ConsoleEvent(
       event.getType().toString(),
       Instant.ofEpochMilli(ts),
-      modifiedArgs);
+      modifiedArgs,
+      event.getArgs());
   }
 
   @Override
diff --git a/java/src/org/openqa/selenium/devtools/v107/V107Events.java b/java/src/org/openqa/selenium/devtools/v107/V107Events.java
@@ -75,7 +75,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {
     return new ConsoleEvent(
       event.getType().toString(),
       Instant.ofEpochMilli(ts),
-      modifiedArgs);
+      modifiedArgs,
+      event.getArgs());
   }
 
   @Override
diff --git a/java/src/org/openqa/selenium/devtools/v108/V108Events.java b/java/src/org/openqa/selenium/devtools/v108/V108Events.java
@@ -75,7 +75,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {
     return new ConsoleEvent(
       event.getType().toString(),
       Instant.ofEpochMilli(ts),
-      modifiedArgs);
+      modifiedArgs,
+      event.getArgs());
   }
 
   @Override
diff --git a/java/src/org/openqa/selenium/devtools/v85/V85Events.java b/java/src/org/openqa/selenium/devtools/v85/V85Events.java
@@ -75,7 +75,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {
     return new ConsoleEvent(
       event.getType().toString(),
       Instant.ofEpochMilli(ts),
-      modifiedArgs);
+      modifiedArgs,
+      event.getArgs());
   }
 
   @Override
diff --git a/java/test/org/openqa/selenium/devtools/ConsoleEventsTest.java b/java/test/org/openqa/selenium/devtools/ConsoleEventsTest.java
@@ -22,9 +22,11 @@
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.devtools.events.ConsoleEvent;
+import org.openqa.selenium.devtools.idealized.runtime.model.RemoteObject;
 import org.openqa.selenium.environment.webserver.Page;
 import org.openqa.selenium.testing.Ignore;
 
+import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
@@ -33,7 +35,6 @@
 class ConsoleEventsTest extends DevToolsTestBase {
 
   @Test
-  @Ignore(gitHubActions = true)
   public void canWatchConsoleEvents() throws InterruptedException, ExecutionException, TimeoutException {
     String page = appServer.create(
       new Page()
@@ -50,4 +51,23 @@ public void canWatchConsoleEvents() throws InterruptedException, ExecutionExcept
     assertThat(event.getMessages()).containsExactly("Hello, world!");
   }
 
+  @Test
+  public void canWatchConsoleEventsWithArgs() throws InterruptedException, ExecutionException, TimeoutException {
+    String page = appServer.create(
+      new Page()
+        .withBody("<div id='button' onclick='helloWorld()'>click me</div>")
+        .withScripts("function helloWorld() { console.log(\"array\", [1, 2, 3]) }"));
+    driver.get(page);
+
+    CompletableFuture<ConsoleEvent> future = new CompletableFuture<>();
+    devTools.getDomains().events().addConsoleListener(future::complete);
+    driver.findElement(By.id("button")).click();
+    ConsoleEvent event = future.get(5, TimeUnit.SECONDS);
+
+    assertThat(event.getType()).isEqualTo("log");
+    List<Object> args = event.getArgs();
+    // Ensure args returned by CDP protocol are maintained
+    assertThat(args).isNotInstanceOf((RemoteObject.class));
+  }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {`
`74`	`74`	`return new ConsoleEvent(`
`75`	`75`	`event.getType().toString(),`
`76`	`76`	`Instant.ofEpochMilli(ts),`
`77`		`- modifiedArgs);`
	`77`	`+ modifiedArgs,`
	`78`	`+ event.getArgs());`
`78`	`79`	`}`
`79`	`80`
`80`	`81`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,8 @@ protected ConsoleEvent toConsoleEvent(ConsoleAPICalled event) {`
`75`	`75`	`return new ConsoleEvent(`
`76`	`76`	`event.getType().toString(),`
`77`	`77`	`Instant.ofEpochMilli(ts),`
`78`		`- modifiedArgs);`
	`78`	`+ modifiedArgs,`
	`79`	`+ event.getArgs());`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`@Override`