Warn when stripe-notify header is present (#2219)

Author: xavdid

src/main/java/com/stripe/net/LiveStripeResponseGetter.java

@@ -21,8 +21,11 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.logging.Logger;
 
 public class LiveStripeResponseGetter implements StripeResponseGetter {
+  private static final Logger logger = Logger.getLogger("Stripe");
+
   private final HttpClient httpClient;
   private final StripeResponseGetterOptions options;
 
@@ -131,6 +134,8 @@ public <T extends StripeObject> T request(ApiRequest apiRequest, Type typeToken)
     StripeResponse response =
         sendWithTelemetry(request, apiRequest.getUsage(), r -> httpClient.requestWithRetries(r));
 
+    maybeEmitStripeNotice(response.headers());
+
     int responseCode = response.code();
     String responseBody = response.body();
     String requestId = response.requestId();
@@ -174,6 +179,8 @@ public InputStream requestStream(ApiRequest apiRequest) throws StripeException {
         sendWithTelemetry(
             request, apiRequest.getUsage(), r -> httpClient.requestStreamWithRetries(r));
 
+    maybeEmitStripeNotice(responseStream.headers());
+
     int responseCode = responseStream.code();
 
     if (responseCode < 200 || responseCode >= 300) {
@@ -255,6 +262,10 @@ public InputStream requestStream(
     return this.requestStream(new ApiRequest(baseAddress, method, path, params, options));
   }
 
+  private static void maybeEmitStripeNotice(HttpHeaders headers) {
+    headers.firstValue("Stripe-Notice").ifPresent(logger::warning);
+  }
+
   private static HttpClient buildDefaultHttpClient() {
     return new HttpURLConnectionClient();
   }

src/test/java/com/stripe/functional/LiveStripeResponseGetterTest.java

@@ -1,9 +1,13 @@
 package com.stripe.functional;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.gson.JsonSyntaxException;
 import com.stripe.BaseStripeTest;
 import com.stripe.exception.ApiException;
@@ -18,12 +22,92 @@
 import com.stripe.net.StripeRequest;
 import com.stripe.net.StripeResponse;
 import com.stripe.net.StripeResponseGetter;
+import java.util.ArrayList;
 import java.util.Collections;
+import java.util.List;
+import java.util.logging.Handler;
+import java.util.logging.Level;
+import java.util.logging.LogRecord;
+import java.util.logging.Logger;
 import org.hamcrest.CoreMatchers;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 public class LiveStripeResponseGetterTest extends BaseStripeTest {
+  private Logger stripeLogger;
+  private CapturingHandler logHandler;
+
+  private static class CapturingHandler extends Handler {
+    final List<LogRecord> records = new ArrayList<>();
+
+    @Override
+    public void publish(LogRecord record) {
+      records.add(record);
+    }
+
+    @Override
+    public void flush() {}
+
+    @Override
+    public void close() {}
+  }
+
+  @BeforeEach
+  public void setUpLogger() {
+    stripeLogger = Logger.getLogger("Stripe");
+    logHandler = new CapturingHandler();
+    logHandler.setLevel(Level.ALL);
+    stripeLogger.addHandler(logHandler);
+    stripeLogger.setLevel(Level.ALL);
+    stripeLogger.setUseParentHandlers(false);
+  }
+
+  @AfterEach
+  public void tearDownLogger() {
+    stripeLogger.removeHandler(logHandler);
+    stripeLogger.setUseParentHandlers(true);
+  }
+
+  @Test
+  public void testStripeNoticeHeaderEmitsWarning() throws StripeException {
+    HttpClient spy = Mockito.spy(new HttpURLConnectionClient());
+    StripeResponseGetter srg = new LiveStripeResponseGetter(spy);
+    ApiResource.setGlobalResponseGetter(srg);
+    StripeResponse response =
+        new StripeResponse(
+            200,
+            HttpHeaders.of(
+                ImmutableMap.of(
+                    "Stripe-Notice",
+                    ImmutableList.of("This API version will be deprecated soon."))),
+            "{\"id\": \"sub_123\", \"object\": \"subscription\"}");
+    Mockito.doReturn(response).when(spy).requestWithRetries(Mockito.<StripeRequest>any());
+    Subscription.retrieve("sub_123");
+
+    assertEquals(1, logHandler.records.size());
+    assertEquals(Level.WARNING, logHandler.records.get(0).getLevel());
+    assertEquals(
+        "This API version will be deprecated soon.", logHandler.records.get(0).getMessage());
+  }
+
+  @Test
+  public void testNoStripeNoticeHeaderEmitsNoWarning() throws StripeException {
+    HttpClient spy = Mockito.spy(new HttpURLConnectionClient());
+    StripeResponseGetter srg = new LiveStripeResponseGetter(spy);
+    ApiResource.setGlobalResponseGetter(srg);
+    StripeResponse response =
+        new StripeResponse(
+            200,
+            HttpHeaders.of(Collections.emptyMap()),
+            "{\"id\": \"sub_123\", \"object\": \"subscription\"}");
+    Mockito.doReturn(response).when(spy).requestWithRetries(Mockito.<StripeRequest>any());
+    Subscription.retrieve("sub_123");
+
+    assertTrue(logHandler.records.isEmpty());
+  }
+
   @Test
   public void testInvalidJson() throws StripeException {
     HttpClient spy = Mockito.spy(new HttpURLConnectionClient());