Remove writeKey from header, add writeKey on payload(batch) (#408)

* Remove writeKey from header, add writeKey on payload(batch), add instanceId

* Update CHANGELOG with last changes

Author: edsonjab

CHANGELOG.md

@@ -1,3 +1,9 @@
+# Version 3.4.0 (Feb 04, 2023)
+- [Chore] Dependency upgrades
+- [New](https://github.com/segmentio/analytics-java/pull/408) Remove writeKey from header, add writeKey on payload(batch) 
+- [New](https://github.com/segmentio/analytics-java/pull/406) Change exception to identify the limited exceed for the message 
+- [New](https://github.com/segmentio/analytics-java/pull/400) Change method static to public to create a GSON instance 
+
 # Version 3.3.1 (Aug 11, 2022)
 - [Chore] Dependency upgrades
 - [New](https://github.com/segmentio/analytics-java/pull/345) Add option to sentAt field to be null

analytics-core/src/main/java/com/segment/analytics/messages/Batch.java

@@ -12,15 +12,16 @@
 public abstract class Batch {
   private static final AtomicInteger SEQUENCE_GENERATOR = new AtomicInteger();
 
-  public static Batch create(Map<String, ?> context, List<Message> batch) {
+  public static Batch create(Map<String, ?> context, List<Message> batch, String writeKey) {
     Message sentAtNull =
         batch.stream().filter(message -> message.sentAt() != null).findAny().orElse(null);
 
     return new AutoValue_Batch(
         batch,
         sentAtNull == null ? new Date() : sentAtNull.sentAt(),
         context,
-        SEQUENCE_GENERATOR.incrementAndGet());
+        SEQUENCE_GENERATOR.incrementAndGet(),
+        writeKey);
   }
 
   public abstract List<Message> batch();
@@ -30,4 +31,6 @@ public static Batch create(Map<String, ?> context, List<Message> batch) {
   public abstract Map<String, ?> context();
 
   public abstract int sequence();
+
+  public abstract String writeKey();
 }

analytics-core/src/test/java/com/segment/analytics/messages/BatchTest.java

@@ -17,13 +17,15 @@
 @RunWith(BurstJUnit4.class)
 public class BatchTest {
 
+  private static final String writeKey = "writeKey";
+
   @Test
   public void create(TestUtils.MessageBuilderFactory factory) {
     Message message = factory.get().userId("userId").build();
     Map<String, String> context = ImmutableMap.of("foo", "bar");
     List<Message> messages = ImmutableList.of(message);
 
-    Batch batch = Batch.create(context, messages);
+    Batch batch = Batch.create(context, messages, writeKey);
 
     assertThat(batch.batch()).isEqualTo(messages);
     assertThat(batch.context()).isEqualTo(context);
@@ -40,7 +42,7 @@ public void createWithSentAt(TestUtils.MessageBuilderFactory factory) throws Par
     Map<String, String> context = ImmutableMap.of("foo", "bar");
     List<Message> messages = ImmutableList.of(message);
 
-    Batch batch = Batch.create(context, messages);
+    Batch batch = Batch.create(context, messages, writeKey);
 
     assertThat(batch.sentAt()).isEqualTo(messages.get(0).sentAt());
   }
@@ -51,7 +53,7 @@ public void createWithSentAtNull(TestUtils.MessageBuilderFactory factory) throws
     Map<String, String> context = ImmutableMap.of("foo", "bar");
     List<Message> messages = ImmutableList.of(message);
 
-    Batch batch = Batch.create(context, messages);
+    Batch batch = Batch.create(context, messages, writeKey);
 
     assertThat(batch.sentAt()).isEqualToIgnoringHours(new Date());
   }
@@ -62,8 +64,8 @@ public void sequence(TestUtils.MessageBuilderFactory factory) {
     Map<String, String> context = ImmutableMap.of("foo", "bar");
     List<Message> messages = ImmutableList.of(message);
 
-    Batch first = Batch.create(context, messages);
-    Batch second = Batch.create(context, messages);
+    Batch first = Batch.create(context, messages, writeKey);
+    Batch second = Batch.create(context, messages, writeKey);
 
     assertThat(first.sequence() + 1).isEqualTo(second.sequence());
   }

analytics/src/main/java/com/segment/analytics/Analytics.java

@@ -413,7 +413,7 @@ public void log(String message) {
       OkHttpClient.Builder builder =
           client
               .newBuilder()
-              .addInterceptor(new AnalyticsRequestInterceptor(writeKey, userAgent))
+              .addInterceptor(new AnalyticsRequestInterceptor(userAgent))
               .addInterceptor(interceptor);
 
       if (forceTlsV1) {
@@ -449,7 +449,8 @@ public void log(String message) {
               log,
               threadFactory,
               networkExecutor,
-              callbacks);
+              callbacks,
+              writeKey);
 
       return new Analytics(analyticsClient, messageTransformers, messageInterceptors, log);
     }

analytics/src/main/java/com/segment/analytics/AnalyticsRequestInterceptor.java

@@ -2,31 +2,22 @@
 
 import java.io.IOException;
 import javax.annotation.Nonnull;
-import okhttp3.Credentials;
 import okhttp3.Interceptor;
 import okhttp3.Request;
 
 class AnalyticsRequestInterceptor implements Interceptor {
-  private static final String AUTHORIZATION_HEADER = "Authorization";
   private static final String USER_AGENT_HEADER = "User-Agent";
 
-  private final @Nonnull String writeKey;
   private final @Nonnull String userAgent;
 
-  AnalyticsRequestInterceptor(@Nonnull String writeKey, @Nonnull String userAgent) {
-    this.writeKey = writeKey;
+  AnalyticsRequestInterceptor(@Nonnull String userAgent) {
     this.userAgent = userAgent;
   }
 
   @Override
   public okhttp3.Response intercept(Chain chain) throws IOException {
     Request request = chain.request();
-    Request newRequest =
-        request
-            .newBuilder()
-            .addHeader(AUTHORIZATION_HEADER, Credentials.basic(writeKey, ""))
-            .addHeader(USER_AGENT_HEADER, userAgent)
-            .build();
+    Request newRequest = request.newBuilder().addHeader(USER_AGENT_HEADER, userAgent).build();
 
     return chain.proceed(newRequest);
   }

analytics/src/main/java/com/segment/analytics/internal/AnalyticsClient.java

@@ -21,6 +21,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -40,13 +41,15 @@ public class AnalyticsClient {
   private static final int MSG_MAX_SIZE = 1024 * 32;
   private static final Charset ENCODING = StandardCharsets.UTF_8;
   private static Gson gsonInstance;
+  private static final String instanceId = UUID.randomUUID().toString();
 
   static {
     Map<String, String> library = new LinkedHashMap<>();
     library.put("name", "analytics-java");
     library.put("version", AnalyticsVersion.get());
     Map<String, Object> context = new LinkedHashMap<>();
     context.put("library", Collections.unmodifiableMap(library));
+    context.put("instanceId", instanceId);
     CONTEXT = Collections.unmodifiableMap(context);
   }
 
@@ -63,6 +66,7 @@ public class AnalyticsClient {
   private final ExecutorService looperExecutor;
   private final ScheduledExecutorService flushScheduler;
   private final AtomicBoolean isShutDown;
+  private final String writeKey;
 
   public static AnalyticsClient create(
       HttpUrl uploadUrl,
@@ -75,7 +79,8 @@ public static AnalyticsClient create(
       Log log,
       ThreadFactory threadFactory,
       ExecutorService networkExecutor,
-      List<Callback> callbacks) {
+      List<Callback> callbacks,
+      String writeKey) {
     return new AnalyticsClient(
         new LinkedBlockingQueue<Message>(queueCapacity),
         uploadUrl,
@@ -88,7 +93,8 @@ public static AnalyticsClient create(
         threadFactory,
         networkExecutor,
         callbacks,
-        new AtomicBoolean(false));
+        new AtomicBoolean(false),
+        writeKey);
   }
 
   public AnalyticsClient(
@@ -103,7 +109,8 @@ public AnalyticsClient(
       ThreadFactory threadFactory,
       ExecutorService networkExecutor,
       List<Callback> callbacks,
-      AtomicBoolean isShutDown) {
+      AtomicBoolean isShutDown,
+      String writeKey) {
     this.messageQueue = messageQueue;
     this.uploadUrl = uploadUrl;
     this.service = service;
@@ -115,6 +122,7 @@ public AnalyticsClient(
     this.looperExecutor = Executors.newSingleThreadExecutor(threadFactory);
     this.networkExecutor = networkExecutor;
     this.isShutDown = isShutDown;
+    this.writeKey = writeKey;
 
     this.currentQueueSizeInBytes = 0;
 
@@ -296,7 +304,7 @@ public void run() {
           Boolean isOverflow = messages.size() >= size;
 
           if (!messages.isEmpty() && (isOverflow || isBlockingSignal || batchSizeLimitReached)) {
-            Batch batch = Batch.create(CONTEXT, new ArrayList<>(messages));
+            Batch batch = Batch.create(CONTEXT, new ArrayList<>(messages), writeKey);
             log.print(
                 VERBOSE,
                 "Batching %s message(s) into batch %s.",

analytics/src/test/java/com/segment/analytics/AnalyticsRequestInterceptorTest.java

@@ -16,16 +16,14 @@ public class AnalyticsRequestInterceptorTest {
 
   @Test
   public void testInterceptor() throws IOException {
-    AnalyticsRequestInterceptor interceptor =
-        new AnalyticsRequestInterceptor("writeKey", "userAgent");
+    AnalyticsRequestInterceptor interceptor = new AnalyticsRequestInterceptor("userAgent");
 
     final Request request = new Request.Builder().url("https://api.segment.io").get().build();
 
     Chain chain =
         new ChainAdapter(request, mockConnection) {
           @Override
           public Response proceed(Request request) throws IOException {
-            assertThat(request.header("Authorization"), Is.is("Basic d3JpdGVLZXk6"));
             assertThat(request.header("User-Agent"), Is.is("userAgent"));
             return null;
           }

analytics/src/test/java/com/segment/analytics/internal/AnalyticsClientTest.java

@@ -68,6 +68,7 @@ public class AnalyticsClientTest {
       MAX_MSG_SIZE
           - 200; // Once we create msg object with this size it barely below 32 threshold so good
   // for tests
+  private static String writeKey = "writeKey";
 
   Log log = Log.NONE;
 
@@ -103,7 +104,8 @@ AnalyticsClient newClient() {
         threadFactory,
         networkExecutor,
         Collections.singletonList(callback),
-        isShutDown);
+        isShutDown,
+        writeKey);
   }
 
   @Test
@@ -290,7 +292,8 @@ public void flushHowManyTimesNecessaryToStayWithinLimit() throws InterruptedExce
             threadFactory,
             networkExecutor,
             Collections.singletonList(callback),
-            isShutDown);
+            isShutDown,
+            writeKey);
 
     Map<String, String> properties = new HashMap<String, String>();
 
@@ -357,7 +360,8 @@ public void enqueueBeforeMaxDoesNotTriggerFlush() {
   }
 
   static Batch batchFor(Message message) {
-    return Batch.create(Collections.<String, Object>emptyMap(), Collections.singletonList(message));
+    return Batch.create(
+        Collections.<String, Object>emptyMap(), Collections.singletonList(message), writeKey);
   }
 
   @Test
@@ -863,7 +867,8 @@ public void submitBatchBelowThreshold() throws InterruptedException, IllegalArgu
             threadFactory,
             networkExecutor,
             Collections.singletonList(callback),
-            isShutDown);
+            isShutDown,
+            writeKey);
 
     Map<String, String> properties = new HashMap<String, String>();
     properties.put("property3", generateDataOfSizeSpecialChars(MAX_MSG_SIZE, true));
@@ -903,7 +908,8 @@ public void submitBatchAboveThreshold() throws InterruptedException, IllegalArgu
             threadFactory,
             networkExecutor,
             Collections.singletonList(callback),
-            isShutDown);
+            isShutDown,
+            writeKey);
 
     Map<String, String> properties = new HashMap<String, String>();
     properties.put("property3", generateDataOfSizeSpecialChars(MAX_MSG_SIZE, true));
@@ -942,7 +948,8 @@ public void submitManySmallMessagesBatchAboveThreshold() throws InterruptedExcep
             threadFactory,
             networkExecutor,
             Collections.singletonList(callback),
-            isShutDown);
+            isShutDown,
+            writeKey);
 
     Map<String, String> properties = new HashMap<String, String>();
     properties.put("property3", generateDataOfSizeSpecialChars(1024 * 8, true));