feat: support new get events method

Author: jlipps

src/main/java/io/appium/java_client/LogsEvents.java

@@ -16,10 +16,19 @@
 
 package io.appium.java_client;
 
+import static io.appium.java_client.MobileCommand.GET_EVENTS;
 import static io.appium.java_client.MobileCommand.LOG_EVENT;
 
-import java.util.HashMap;
+import com.google.common.collect.ImmutableMap;
+import io.appium.java_client.serverevents.CommandEvent;
+import io.appium.java_client.serverevents.ServerEvent;
+import io.appium.java_client.serverevents.ServerEvents;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+import org.openqa.selenium.json.Json;
+import org.openqa.selenium.remote.Response;
 
 public interface LogsEvents extends ExecutesMethod {
 
@@ -32,9 +41,44 @@ public interface LogsEvents extends ExecutesMethod {
      * @throws org.openqa.selenium.WebDriverException if there was a failure while executing the script
      */
     default void logEvent(String vendor, String eventName) {
-        Map<String, Object> data = new HashMap<>();
-        data.put("vendor", vendor);
-        data.put("event", eventName);
-        execute(LOG_EVENT, data);
+        execute(LOG_EVENT, ImmutableMap.of("vendor", vendor, "event", eventName));
+    }
+
+    /**
+     * Log a custom event on the Appium server.
+     *
+     * @since Appium 1.16
+     * @return ServerEvents object wrapping up the various command and event timestamps
+     * @throws org.openqa.selenium.WebDriverException if there was a failure while executing the script
+     */
+    default ServerEvents getEvents() {
+        Response response = execute(GET_EVENTS);
+        ArrayList<CommandEvent> commands = new ArrayList<>();
+        ArrayList<ServerEvent> events = new ArrayList<>();
+        String jsonData = new Json().toJson(response.getValue());
+        //noinspection unchecked
+        Map<String, Object> value = (Map<String, Object>) response.getValue();
+        for (String name : value.keySet()) {
+            if (name.equals("commands")) {
+                //noinspection unchecked
+                ArrayList<Map<String, Object>> cmds = (ArrayList<Map<String, Object>>) value.get(name);
+                for (Map<String, Object> cmd : cmds) {
+                    commands.add(new CommandEvent(
+                        (String) cmd.get("cmd"),
+                        ((Long) cmd.get("startTime")).intValue(),
+                        ((Long) cmd.get("endTime")).intValue()
+                    ));
+                }
+            } else {
+                //noinspection unchecked
+                ArrayList<Long> timestamps = (ArrayList<Long>) value.get(name);
+                List<Integer> intStamps = timestamps
+                    .stream()
+                    .map(Long::intValue)
+                    .collect(Collectors.toList());
+                events.add(new ServerEvent(name, intStamps));
+            }
+        }
+        return new ServerEvents(commands, events, jsonData);
     }
 }

src/main/java/io/appium/java_client/MobileCommand.java

@@ -52,6 +52,7 @@ public class MobileCommand {
     protected static final String GET_DEVICE_TIME;
     protected static final String GET_SESSION;
     protected static final String LOG_EVENT;
+    protected static final String GET_EVENTS;
 
     //region Applications Management
     protected static final String IS_APP_INSTALLED;
@@ -130,6 +131,7 @@ public class MobileCommand {
         GET_DEVICE_TIME = "getDeviceTime";
         GET_SESSION = "getSession";
         LOG_EVENT = "logCustomEvent";
+        GET_EVENTS = "getLogEvents";
 
         //region Applications Management
         IS_APP_INSTALLED = "isAppInstalled";
@@ -216,6 +218,10 @@ public class MobileCommand {
                 postC("/session/:sessionId/appium/start_recording_screen"));
         commandRepository.put(STOP_RECORDING_SCREEN,
                 postC("/session/:sessionId/appium/stop_recording_screen"));
+        commandRepository.put(GET_EVENTS,
+                postC("/session/:sessionId/appium/events"));
+        commandRepository.put(LOG_EVENT,
+                postC("/session/:sessionId/appium/log_event"));
 
         //region Applications Management
         commandRepository.put(IS_APP_INSTALLED, postC("/session/:sessionId/appium/device/app_installed"));

src/main/java/io/appium/java_client/serverevents/CommandEvent.java

@@ -0,0 +1,13 @@
+package io.appium.java_client.serverevents;
+
+public class CommandEvent {
+    public final String name;
+    public Integer startTimestamp;
+    public final Integer endTimestamp;
+
+    public CommandEvent(String name, Integer startTimestamp, Integer endTimestamp) {
+        this.name = name;
+        this.startTimestamp = startTimestamp;
+        this.endTimestamp = endTimestamp;
+    }
+}

src/main/java/io/appium/java_client/serverevents/ServerEvent.java

@@ -0,0 +1,13 @@
+package io.appium.java_client.serverevents;
+
+import java.util.List;
+
+public class ServerEvent {
+    public final String name;
+    public final List<Integer> occurrences;
+
+    public ServerEvent(String name, List<Integer> occurrences) {
+        this.name = name;
+        this.occurrences = occurrences;
+    }
+}

src/main/java/io/appium/java_client/serverevents/ServerEvents.java

@@ -0,0 +1,23 @@
+package io.appium.java_client.serverevents;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+
+public class ServerEvents {
+
+    public final List<CommandEvent> commands;
+    public final List<ServerEvent> events;
+    public final String jsonData;
+
+    public ServerEvents(List<CommandEvent> commands, List<ServerEvent> events, String jsonData) {
+        this.commands = commands;
+        this.events = events;
+        this.jsonData = jsonData;
+    }
+
+    public void save(Path output) throws IOException  {
+        Files.write(output, this.jsonData.getBytes());
+    }
+}

src/test/java/io/appium/java_client/android/LogEventTest.java

@@ -16,27 +16,38 @@
 
 package io.appium.java_client.android;
 
-import io.appium.java_client.driverscripts.ScriptOptions;
-import io.appium.java_client.driverscripts.ScriptType;
-import io.appium.java_client.driverscripts.ScriptValue;
-import org.junit.Test;
-
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-
-import static org.hamcrest.Matchers.equalTo;
-import static org.hamcrest.core.Is.is;
-import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+
+import io.appium.java_client.serverevents.CommandEvent;
+import io.appium.java_client.serverevents.ServerEvent;
+import io.appium.java_client.serverevents.ServerEvents;
+import org.hamcrest.Matchers;
+import org.junit.Test;
 
 public class LogEventTest extends BaseAndroidTest {
 
     @Test
     public void verifyLoggingCustomEvents() {
         driver.logEvent("appium", "funEvent");
-        Object value = driver.getSessionDetail("events");
-        //noinspection unchecked
-        assertNotNull(((Map<String, Object>) value).get("appium:funEvent"));
+        ServerEvents events = driver.getEvents();
+        boolean hasCustomEvent = false;
+        boolean hasCommandName = false;
+        for (ServerEvent event : events.events) {
+            if (event.name.equals("appium:funEvent")) {
+                assertThat(event.occurrences.get(0), Matchers.greaterThan(0));
+                hasCustomEvent = true;
+                break;
+            }
+        }
+        for (CommandEvent cmd : events.commands) {
+            if (cmd.name.equals("logCustomEvent")) {
+                hasCommandName = true;
+                break;
+            }
+        }
+        assertTrue(hasCustomEvent);
+        assertTrue(hasCommandName);
+        assertThat(events.jsonData, Matchers.containsString("\"appium:funEvent\""));
     }
 }