java: Implementing both integer (legacy) and string (standard) response status

Author: barancev

java/client/src/org/openqa/selenium/remote/ErrorCodes.java

@@ -116,6 +116,18 @@ public class ErrorCodes {
       .put(XPATH_LOOKUP_ERROR, "invalid selector")
       .build();
 
+  private static Map<String, Integer> stateToStatus;
+  static {
+    ImmutableMap.Builder<String, Integer> builder = ImmutableMap.<String, Integer>builder();
+    for (Map.Entry<Integer, String> pair : statusToState.entrySet()) {
+      // Ignore duplicate "invalid selector" codes
+      if (! pair.getValue().equals("invalid selector") || pair.getKey() == INVALID_SELECTOR_ERROR) {
+        builder.put(pair.getValue(), pair.getKey());
+      }
+    }
+    stateToStatus = builder.build();
+  }
+
   /**
    * Returns the exception type that corresponds to the given {@code statusCode}. All unrecognized
    * status codes will be mapped to {@link WebDriverException WebDriverException.class}.
@@ -236,8 +248,11 @@ public boolean isMappableError(Throwable thrown) {
     return statusCode != SUCCESS && statusCode != UNHANDLED_ERROR;
   }
 
-  @Beta
-  public String toState(int status) {
+  public static String toState(int status) {
     return statusToState.get(status);
   }
+
+  public static int toStatus(String state) {
+    return stateToStatus.get(state);
+  }
 }

java/client/src/org/openqa/selenium/remote/JsonToBeanConverter.java

@@ -106,6 +106,33 @@ private <T> T convert(Class<T> clazz, Object text, int depth) {
       return (T) new Command(sessionId, name);
     }
 
+    if (Response.class.equals(clazz)) {
+      Response response = new Response();
+      JsonObject json = new JsonParser().parse((String) text).getAsJsonObject();
+
+      if (json.has("state") && ! json.get("state").isJsonNull()) {
+        String state = json.get("state").getAsString();
+        response.setState(state);
+        response.setStatus(ErrorCodes.toStatus(state));
+      }
+      if (json.has("status") && ! json.get("status").isJsonNull()) {
+        JsonElement status = json.get("status");
+        if (status.getAsJsonPrimitive().isString()) {
+          String state = status.getAsString();
+          response.setState(state);
+          response.setStatus(ErrorCodes.toStatus(state));
+        } else {
+          int intStatus = status.getAsInt();
+          response.setState(ErrorCodes.toState(intStatus));
+          response.setStatus(intStatus);
+        }
+      }
+
+      response.setValue(convert(Object.class, json.get("value")));
+
+      return (T) response;
+    }
+
     if (SessionId.class.equals(clazz)) {
       // Stupid heuristic to tell if we are dealing with a selenium 2 or 3 session id.
       JsonElement json = text instanceof String

java/client/test/org/openqa/selenium/remote/JsonToBeanConverterTest.java

@@ -380,6 +380,42 @@ public void testDecodingResponseWithNumbersInValueObject() {
     assertEquals(46.19140625, value.get("height").doubleValue(), 0.00001);
   }
 
+  @Test
+  public void testShouldRecognizeNumericStatus() {
+    Response response = new JsonToBeanConverter()
+      .convert(Response.class, "{\"status\":0,\"value\":\"cheese\"}");
+
+    assertEquals(0, response.getStatus());
+    assertEquals(ErrorCodes.toState(0), response.getState());
+    @SuppressWarnings("unchecked")
+    String value = (String) response.getValue();
+    assertEquals("cheese", value);
+  }
+
+  @Test
+  public void testShouldRecognizeStringStatus() {
+    Response response = new JsonToBeanConverter()
+      .convert(Response.class, "{\"status\":\"success\",\"value\":\"cheese\"}");
+
+    assertEquals(0, response.getStatus());
+    assertEquals(ErrorCodes.toState(0), response.getState());
+    @SuppressWarnings("unchecked")
+    String value = (String) response.getValue();
+    assertEquals("cheese", value);
+  }
+
+  @Test
+  public void testShouldRecognizeStringState() {
+    Response response = new JsonToBeanConverter()
+      .convert(Response.class, "{\"state\":\"success\",\"value\":\"cheese\"}");
+
+    assertEquals("success", response.getState());
+    assertEquals(0, response.getStatus());
+    @SuppressWarnings("unchecked")
+    String value = (String) response.getValue();
+    assertEquals("cheese", value);
+  }
+
   public static class SimpleBean {
 
     private String value;