feat: add support for experience id. (#647)

arriolac · Justin Poehnelt · web-flow · commit b229806526c9 · 2020-01-21T11:44:28.000-08:00
* feat: add support for experience id

* Adding setter and getter for experience ID.

* Reformat code based on google-java-format

* Adding tests.

* Fix formatting.

* Adding sample tags.

* Fix formatting.

Co-authored-by: Justin Poehnelt &lt;jpoehnelt@google.com&gt;
diff --git a/src/main/java/com/google/maps/GaeRequestHandler.java b/src/main/java/com/google/maps/GaeRequestHandler.java
@@ -28,6 +28,7 @@
 import com.google.maps.internal.ApiResponse;
 import com.google.maps.internal.ExceptionsAllowedToRetry;
 import com.google.maps.internal.GaePendingResult;
+import com.google.maps.internal.HttpHeaders;
 import java.net.MalformedURLException;
 import java.net.Proxy;
 import java.net.URL;
@@ -51,6 +52,7 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handle(
       String hostName,
       String url,
       String userAgent,
+      String experienceIdHeaderValue,
       Class<R> clazz,
       FieldNamingPolicy fieldNamingPolicy,
       long errorTimeout,
@@ -60,6 +62,10 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handle(
     HTTPRequest req;
     try {
       req = new HTTPRequest(new URL(hostName + url), HTTPMethod.POST, fetchOptions);
+      if (experienceIdHeaderValue != null) {
+        req.setHeader(
+            new HTTPHeader(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID, experienceIdHeaderValue));
+      }
     } catch (MalformedURLException e) {
       LOG.error("Request: {}{}", hostName, url, e);
       throw (new RuntimeException(e));
@@ -75,6 +81,7 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handlePost(
       String url,
       String payload,
       String userAgent,
+      String experienceIdHeaderValue,
       Class<R> clazz,
       FieldNamingPolicy fieldNamingPolicy,
       long errorTimeout,
@@ -85,6 +92,10 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handlePost(
     try {
       req = new HTTPRequest(new URL(hostName + url), HTTPMethod.POST, fetchOptions);
       req.setHeader(new HTTPHeader("Content-Type", "application/json; charset=utf-8"));
+      if (experienceIdHeaderValue != null) {
+        req.setHeader(
+            new HTTPHeader(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID, experienceIdHeaderValue));
+      }
       req.setPayload(payload.getBytes(UTF_8));
     } catch (MalformedURLException e) {
       LOG.error("Request: {}{}", hostName, url, e);
diff --git a/src/main/java/com/google/maps/GeoApiContext.java b/src/main/java/com/google/maps/GeoApiContext.java
@@ -21,6 +21,8 @@
 import com.google.maps.internal.ApiConfig;
 import com.google.maps.internal.ApiResponse;
 import com.google.maps.internal.ExceptionsAllowedToRetry;
+import com.google.maps.internal.HttpHeaders;
+import com.google.maps.internal.StringJoin;
 import com.google.maps.internal.UrlSigner;
 import java.io.UnsupportedEncodingException;
 import java.net.Proxy;
@@ -61,6 +63,7 @@ public class GeoApiContext {
   private final ExceptionsAllowedToRetry exceptionsAllowedToRetry;
   private final Integer maxRetries;
   private final UrlSigner urlSigner;
+  private String experienceIdHeaderValue;
 
   /* package */
   GeoApiContext(
@@ -72,7 +75,8 @@ public class GeoApiContext {
       long errorTimeout,
       ExceptionsAllowedToRetry exceptionsAllowedToRetry,
       Integer maxRetries,
-      UrlSigner urlSigner) {
+      UrlSigner urlSigner,
+      String... experienceIdHeaderValue) {
     this.requestHandler = requestHandler;
     this.apiKey = apiKey;
     this.baseUrlOverride = baseUrlOverride;
@@ -82,6 +86,7 @@ public class GeoApiContext {
     this.exceptionsAllowedToRetry = exceptionsAllowedToRetry;
     this.maxRetries = maxRetries;
     this.urlSigner = urlSigner;
+    setExperienceId(experienceIdHeaderValue);
   }
 
   /**
@@ -98,6 +103,7 @@ <T, R extends ApiResponse<T>> PendingResult<T> handle(
         String hostName,
         String url,
         String userAgent,
+        String experienceIdHeaderValue,
         Class<R> clazz,
         FieldNamingPolicy fieldNamingPolicy,
         long errorTimeout,
@@ -109,6 +115,7 @@ <T, R extends ApiResponse<T>> PendingResult<T> handlePost(
         String url,
         String payload,
         String userAgent,
+        String experienceIdHeaderValue,
         Class<R> clazz,
         FieldNamingPolicy fieldNamingPolicy,
         long errorTimeout,
@@ -136,6 +143,34 @@ interface Builder {
     }
   }
 
+  /**
+   * Sets the value for the HTTP header field name {@link HttpHeaders#X_GOOG_MAPS_EXPERIENCE_ID} to
+   * be used on subsequent API calls. Calling this method with {@code null} is equivalent to calling
+   * {@link #clearExperienceId()}.
+   *
+   * @param experienceId The experience ID if set, otherwise null
+   */
+  public void setExperienceId(String... experienceId) {
+    if (experienceId == null || experienceId.length == 0) {
+      experienceIdHeaderValue = null;
+      return;
+    }
+    experienceIdHeaderValue = StringJoin.join(",", experienceId);
+  }
+
+  /** @return Returns the experience ID if set, otherwise, null */
+  public String getExperienceId() {
+    return experienceIdHeaderValue;
+  }
+
+  /**
+   * Clears the experience ID if set the HTTP header field {@link
+   * HttpHeaders#X_GOOG_MAPS_EXPERIENCE_ID} will be omitted from subsequent calls.
+   */
+  public void clearExperienceId() {
+    experienceIdHeaderValue = null;
+  }
+
   /**
    * Shut down this GeoApiContext instance, reclaiming resources. After shutdown() has been called,
    * no further queries may be done against this instance.
@@ -240,6 +275,7 @@ <T, R extends ApiResponse<T>> PendingResult<T> post(
         url.toString(),
         params.get("_payload").get(0),
         USER_AGENT,
+        experienceIdHeaderValue,
         clazz,
         config.fieldNamingPolicy,
         errorTimeout,
@@ -280,6 +316,7 @@ private <T, R extends ApiResponse<T>> PendingResult<T> getWithPath(
         hostName,
         url.toString(),
         USER_AGENT,
+        experienceIdHeaderValue,
         clazz,
         fieldNamingPolicy,
         errorTimeout,
@@ -312,6 +349,7 @@ public static class Builder {
     private ExceptionsAllowedToRetry exceptionsAllowedToRetry = new ExceptionsAllowedToRetry();
     private Integer maxRetries;
     private UrlSigner urlSigner;
+    private String[] experienceIdHeaderValue;
 
     /** Builder pattern for the enclosing {@code GeoApiContext}. */
     public Builder() {
@@ -533,6 +571,18 @@ public Builder proxyAuthentication(String proxyUserName, String proxyUserPasswor
       return this;
     }
 
+    /**
+     * Sets the value for the HTTP header field name {@link HttpHeaders#X_GOOG_MAPS_EXPERIENCE_ID}
+     * HTTP header value for the field name on subsequent API calls.
+     *
+     * @param experienceId The experience ID
+     * @return Returns this builder for call chaining.
+     */
+    public Builder experienceId(String... experienceId) {
+      this.experienceIdHeaderValue = experienceId;
+      return this;
+    }
+
     /**
      * Converts this builder into a {@code GeoApiContext}.
      *
@@ -548,7 +598,8 @@ public GeoApiContext build() {
           errorTimeout,
           exceptionsAllowedToRetry,
           maxRetries,
-          urlSigner);
+          urlSigner,
+          experienceIdHeaderValue);
     }
   }
 }
diff --git a/src/main/java/com/google/maps/OkHttpRequestHandler.java b/src/main/java/com/google/maps/OkHttpRequestHandler.java
@@ -19,6 +19,7 @@
 import com.google.maps.GeoApiContext.RequestHandler;
 import com.google.maps.internal.ApiResponse;
 import com.google.maps.internal.ExceptionsAllowedToRetry;
+import com.google.maps.internal.HttpHeaders;
 import com.google.maps.internal.OkHttpPendingResult;
 import com.google.maps.internal.RateLimitExecutorService;
 import java.io.IOException;
@@ -55,13 +56,17 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handle(
       String hostName,
       String url,
       String userAgent,
+      String experienceIdHeaderValue,
       Class<R> clazz,
       FieldNamingPolicy fieldNamingPolicy,
       long errorTimeout,
       Integer maxRetries,
       ExceptionsAllowedToRetry exceptionsAllowedToRetry) {
-    Request req =
-        new Request.Builder().get().header("User-Agent", userAgent).url(hostName + url).build();
+    Request.Builder builder = new Request.Builder().get().header("User-Agent", userAgent);
+    if (experienceIdHeaderValue != null) {
+      builder = builder.header(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID, experienceIdHeaderValue);
+    }
+    Request req = builder.url(hostName + url).build();
 
     return new OkHttpPendingResult<>(
         req, client, clazz, fieldNamingPolicy, errorTimeout, maxRetries, exceptionsAllowedToRetry);
@@ -73,18 +78,19 @@ public <T, R extends ApiResponse<T>> PendingResult<T> handlePost(
       String url,
       String payload,
       String userAgent,
+      String experienceIdHeaderValue,
       Class<R> clazz,
       FieldNamingPolicy fieldNamingPolicy,
       long errorTimeout,
       Integer maxRetries,
       ExceptionsAllowedToRetry exceptionsAllowedToRetry) {
     RequestBody body = RequestBody.create(JSON, payload);
-    Request req =
-        new Request.Builder()
-            .post(body)
-            .header("User-Agent", userAgent)
-            .url(hostName + url)
-            .build();
+    Request.Builder builder = new Request.Builder().post(body).header("User-Agent", userAgent);
+
+    if (experienceIdHeaderValue != null) {
+      builder = builder.header(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID, experienceIdHeaderValue);
+    }
+    Request req = builder.url(hostName + url).build();
 
     return new OkHttpPendingResult<>(
         req, client, clazz, fieldNamingPolicy, errorTimeout, maxRetries, exceptionsAllowedToRetry);
diff --git a/src/main/java/com/google/maps/internal/HttpHeaders.java b/src/main/java/com/google/maps/internal/HttpHeaders.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 Google Inc. All rights reserved.
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
+ * file except in compliance with the License. You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+ * ANY KIND, either express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package com.google.maps.internal;
+
+/** Contains HTTP header name constants. */
+public final class HttpHeaders {
+
+  /** The HTTP {@code X-Goog-Maps-Experience-ID} header field name. */
+  public static final String X_GOOG_MAPS_EXPERIENCE_ID = "X-Goog-Maps-Experience-ID";
+}
diff --git a/src/test/java/com/google/maps/GeoApiContextTest.java b/src/test/java/com/google/maps/GeoApiContextTest.java
@@ -19,19 +19,22 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.mockito.Mockito.mock;
 
 import com.google.maps.errors.OverQueryLimitException;
 import com.google.maps.internal.ApiConfig;
 import com.google.maps.internal.ApiResponse;
+import com.google.maps.internal.HttpHeaders;
 import com.google.maps.model.GeocodingResult;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 import okhttp3.Headers;
 import okhttp3.mockwebserver.MockResponse;
@@ -299,6 +302,99 @@ public void testToggleIfExceptionIsAllowedToRetry() throws Exception {
     fail("OverQueryLimitException was expected but not observed.");
   }
 
+  @Test
+  public void testSingleExperienceId() {
+    final String experienceId = "experienceId";
+    final GeoApiContext context = builder.experienceId(experienceId).build();
+    assertEquals(experienceId, context.getExperienceId());
+  }
+
+  @Test
+  public void testMultipleExperienceId() {
+    final String experienceId1 = "experienceId1";
+    final String experienceId2 = "experienceId2";
+    final GeoApiContext context = builder.experienceId(experienceId1, experienceId2).build();
+    assertEquals(experienceId1 + "," + experienceId2, context.getExperienceId());
+  }
+
+  @Test
+  public void testNoExperienceId() {
+    final GeoApiContext context = builder.build();
+    assertNull(context.getExperienceId());
+  }
+
+  @Test
+  public void testClearingExperienceId() {
+    final String experienceId = "experienceId";
+    final GeoApiContext context = builder.experienceId(experienceId).build();
+    assertEquals(experienceId, context.getExperienceId());
+
+    context.clearExperienceId();
+    assertNull(context.getExperienceId());
+  }
+
+  @Test
+  public void testExperienceIdIsInHeader() throws Exception {
+    final String experienceId = "exp1";
+    final RecordedRequest request = makeMockRequest(experienceId);
+    assertEquals(experienceId, request.getHeader(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID));
+  }
+
+  @Test
+  public void testExperienceIdNotInHeader() throws Exception {
+    final RecordedRequest request = makeMockRequest();
+    final String value = request.getHeader(HttpHeaders.X_GOOG_MAPS_EXPERIENCE_ID);
+    assertNull(value);
+  }
+
+  @Test
+  public void testExperienceIdSample() {
+    // [START maps_experience_id]
+    final String experienceId = UUID.randomUUID().toString();
+
+    // instantiate context with experience id
+    final GeoApiContext context =
+        new GeoApiContext.Builder().apiKey("AIza-Maps-API-Key").experienceId(experienceId).build();
+
+    // clear the current experience id
+    context.clearExperienceId();
+
+    // set a new experience id
+    final String otherExperienceId = UUID.randomUUID().toString();
+    context.setExperienceId(experienceId, otherExperienceId);
+
+    // make API request, the client will set the header
+    // X-GOOG-MAPS-EXPERIENCE-ID: experienceId,otherExperienceId
+
+    // get current experience id
+    final String ids = context.getExperienceId();
+    // [END maps_experience_id]
+
+    assertEquals(experienceId + "," + otherExperienceId, ids);
+  }
+
+  @SuppressWarnings("unchecked")
+  private RecordedRequest makeMockRequest(String... experienceId) throws Exception {
+    // Set up a mock request
+    ApiResponse<Object> fakeResponse = mock(ApiResponse.class);
+    String path = "/";
+    Map<String, List<String>> params = new HashMap<>();
+    params.put("key", Collections.singletonList("value"));
+
+    // Set up the fake web server
+    server.enqueue(new MockResponse());
+    server.start();
+    setMockBaseUrl();
+
+    // Build & execute the request using our context
+    final GeoApiContext context = builder.experienceId(experienceId).build();
+    context.get(new ApiConfig(path), fakeResponse.getClass(), params).awaitIgnoreError();
+
+    // Read the header
+    server.shutdown();
+    return server.takeRequest();
+  }
+
   @Test
   public void testShutdown() throws InterruptedException {
     GeoApiContext context = builder.build();
