Merge pull request #40 from snyk/feat/code-encode

michelkaporin · web-flow · commit 2029585878b6 · 2022-05-23T09:53:22.000+02:00
feat: encode and compress POST/PUT requests to Code API [ROAD-909]
diff --git a/src/main/java/ai/deepcode/javaclient/DeepCodeRestApiImpl.java b/src/main/java/ai/deepcode/javaclient/DeepCodeRestApiImpl.java
@@ -1,5 +1,6 @@
 package ai.deepcode.javaclient;
 
+import ai.deepcode.javaclient.core.Base64EncodeRequestInterceptor;
 import ai.deepcode.javaclient.requests.ExtendBundleWithContentRequest;
 import ai.deepcode.javaclient.requests.ExtendBundleWithHashRequest;
 import ai.deepcode.javaclient.requests.FileContentRequest;
@@ -47,7 +48,7 @@ public class DeepCodeRestApiImpl implements DeepCodeRestApi {
 
   // Create simple REST adapter which points the baseUrl.
   private static Retrofit buildRetrofit(
-      String baseUrl, boolean disableSslVerification, boolean requestLogging) {
+    String baseUrl, boolean disableSslVerification, boolean requestLogging) {
     HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
     // set your desired log level
     if (requestLogging) {
@@ -57,15 +58,16 @@ private static Retrofit buildRetrofit(
     }
 
     OkHttpClient.Builder builder =
-        new OkHttpClient.Builder()
-            .connectTimeout(100, TimeUnit.SECONDS)
-            .writeTimeout(100, TimeUnit.SECONDS)
-            .readTimeout(100, TimeUnit.SECONDS)
-            .addInterceptor(logging);
+      new OkHttpClient.Builder()
+        .connectTimeout(100, TimeUnit.SECONDS)
+        .writeTimeout(100, TimeUnit.SECONDS)
+        .readTimeout(100, TimeUnit.SECONDS)
+        .addInterceptor(logging)
+        .addInterceptor(new Base64EncodeRequestInterceptor());
 
     if (disableSslVerification) {
       X509TrustManager x509TrustManager = buildUnsafeTrustManager();
-      final TrustManager[] trustAllCertificates = new TrustManager[] {x509TrustManager};
+      final TrustManager[] trustAllCertificates = new TrustManager[]{x509TrustManager};
 
       try {
         final String sslProtocol = "SSL";
@@ -82,24 +84,26 @@ private static Retrofit buildRetrofit(
 
     OkHttpClient client = builder.build();
     return new Retrofit.Builder()
-        .baseUrl(baseUrl)
-        .client(client)
-        .addConverterFactory(GsonConverterFactory.create())
-        .build();
+      .baseUrl(baseUrl)
+      .client(client)
+      .addConverterFactory(GsonConverterFactory.create())
+      .build();
   }
 
   @NotNull
   private static X509TrustManager buildUnsafeTrustManager() {
     return new X509TrustManager() {
       @Override
-      public void checkClientTrusted(X509Certificate[] chain, String authType) {}
+      public void checkClientTrusted(X509Certificate[] chain, String authType) {
+      }
 
       @Override
-      public void checkServerTrusted(X509Certificate[] chain, String authType) {}
+      public void checkServerTrusted(X509Certificate[] chain, String authType) {
+      }
 
       @Override
       public X509Certificate[] getAcceptedIssuers() {
-        return new X509Certificate[] {};
+        return new X509Certificate[]{};
       }
     };
   }
@@ -108,28 +112,28 @@ public X509Certificate[] getAcceptedIssuers() {
    * Re-set baseUrl for retrofit instance
    *
    * @param baseUrl new baseUrl. <b>Null</b> or empty "" value will reset to default {@code
-   *     #API_URL}
+   *                #API_URL}
    */
   @Override
   public void setBaseUrl(
     @Nullable String baseUrl, boolean disableSslVerification, boolean requestLogging) {
     retrofit =
-        buildRetrofit(
-            (baseUrl == null || baseUrl.isEmpty()) ? API_URL : baseUrl,
-            disableSslVerification,
-            requestLogging);
+      buildRetrofit(
+        (baseUrl == null || baseUrl.isEmpty()) ? API_URL : baseUrl,
+        disableSslVerification,
+        requestLogging);
   }
 
   private interface CreateBundleCall {
     @retrofit2.http.Headers("Content-Type: application/json")
     @POST("bundle")
     Call<CreateBundleResponse> doCreateBundle(
-        @Header("Session-Token") String token, @Body FileContentRequest files);
+      @Header("Session-Token") String token, @Body FileContentRequest files);
 
     @retrofit2.http.Headers("Content-Type: application/json")
     @POST("bundle")
     Call<CreateBundleResponse> doCreateBundle(
-        @Header("Session-Token") String token, @Body FileHashRequest files);
+      @Header("Session-Token") String token, @Body FileHashRequest files);
   }
 
   private static <Req> CreateBundleResponse doCreateBundle(String token, Req request) {
@@ -138,10 +142,10 @@ private static <Req> CreateBundleResponse doCreateBundle(String token, Req reque
     try {
       if (request instanceof FileContentRequest)
         retrofitResponse =
-            createBundleCall.doCreateBundle(token, (FileContentRequest) request).execute();
+          createBundleCall.doCreateBundle(token, (FileContentRequest) request).execute();
       else if (request instanceof FileHashRequest)
         retrofitResponse =
-            createBundleCall.doCreateBundle(token, (FileHashRequest) request).execute();
+          createBundleCall.doCreateBundle(token, (FileHashRequest) request).execute();
       else throw new IllegalArgumentException();
     } catch (IOException e) {
       return new CreateBundleResponse();
@@ -200,8 +204,8 @@ private interface CheckBundleCall {
     //    @retrofit2.http.Headers("Content-Type: application/json")
     @GET("bundle/{bundleId}")
     Call<CreateBundleResponse> doCheckBundle(
-        @Header("Session-Token") String token,
-        @Path(value = "bundleId", encoded = true) String bundleId);
+      @Header("Session-Token") String token,
+      @Path(value = "bundleId", encoded = true) String bundleId);
   }
 
   /**
@@ -249,16 +253,16 @@ private interface ExtendBundleCall {
     @retrofit2.http.Headers("Content-Type: application/json")
     @PUT("bundle/{bundleId}")
     Call<CreateBundleResponse> doExtendBundle(
-        @Header("Session-Token") String token,
-        @Path(value = "bundleId", encoded = true) String bundleId,
-        @Body ExtendBundleWithHashRequest extendBundleWithHashRequest);
+      @Header("Session-Token") String token,
+      @Path(value = "bundleId", encoded = true) String bundleId,
+      @Body ExtendBundleWithHashRequest extendBundleWithHashRequest);
 
     @retrofit2.http.Headers("Content-Type: application/json")
     @PUT("bundle/{bundleId}")
     Call<CreateBundleResponse> doExtendBundle(
-        @Header("Session-Token") String token,
-        @Path(value = "bundleId", encoded = true) String bundleId,
-        @Body ExtendBundleWithContentRequest extendBundleWithContentRequest);
+      @Header("Session-Token") String token,
+      @Path(value = "bundleId", encoded = true) String bundleId,
+      @Body ExtendBundleWithContentRequest extendBundleWithContentRequest);
   }
 
   /**
@@ -276,14 +280,14 @@ public <Req> CreateBundleResponse extendBundle(
     try {
       if (request instanceof ExtendBundleWithHashRequest)
         retrofitResponse =
-            extendBundleCall
-                .doExtendBundle(token, bundleId, (ExtendBundleWithHashRequest) request)
-                .execute();
+          extendBundleCall
+            .doExtendBundle(token, bundleId, (ExtendBundleWithHashRequest) request)
+            .execute();
       else if (request instanceof ExtendBundleWithContentRequest)
         retrofitResponse =
-            extendBundleCall
-                .doExtendBundle(token, bundleId, (ExtendBundleWithContentRequest) request)
-                .execute();
+          extendBundleCall
+            .doExtendBundle(token, bundleId, (ExtendBundleWithContentRequest) request)
+            .execute();
       else throw new IllegalArgumentException();
     } catch (IOException e) {
       return new CreateBundleResponse();
@@ -299,7 +303,7 @@ else if (request instanceof ExtendBundleWithContentRequest)
         break;
       case 400:
         result.setStatusDescription(
-            "Attempted to extend a git bundle, or ended up with an empty bundle after the extension");
+          "Attempted to extend a git bundle, or ended up with an empty bundle after the extension");
         break;
       case 401:
         result.setStatusDescription("Missing sessionToken or incomplete login process");
@@ -324,7 +328,7 @@ private interface GetAnalysisCall {
     @retrofit2.http.Headers("Content-Type: application/json")
     @POST("analysis")
     Call<GetAnalysisResponse> doGetAnalysis(
-        @Header("Session-Token") String token, @Body GetAnalysisRequest filesToAnalyse);
+      @Header("Session-Token") String token, @Body GetAnalysisRequest filesToAnalyse);
   }
 
   /**
@@ -346,9 +350,9 @@ public GetAnalysisResponse getAnalysis(
     GetAnalysisCall getAnalysisCall = retrofit.create(GetAnalysisCall.class);
     try {
       Response<GetAnalysisResponse> retrofitResponse =
-          getAnalysisCall
-              .doGetAnalysis(token, new GetAnalysisRequest(bundleId, filesToAnalyse, severity, shard, ideProductName, orgDisplayName))
-              .execute();
+        getAnalysisCall
+          .doGetAnalysis(token, new GetAnalysisRequest(bundleId, filesToAnalyse, severity, shard, ideProductName, orgDisplayName))
+          .execute();
       GetAnalysisResponse result = retrofitResponse.body();
       if (result == null) result = new GetAnalysisResponse();
       result.setStatusCode(retrofitResponse.code());
diff --git a/src/main/java/ai/deepcode/javaclient/core/Base64EncodeRequestInterceptor.java b/src/main/java/ai/deepcode/javaclient/core/Base64EncodeRequestInterceptor.java
@@ -0,0 +1,63 @@
+package ai.deepcode.javaclient.core;
+
+import okhttp3.Interceptor;
+import okhttp3.MediaType;
+import okhttp3.Request;
+import okhttp3.RequestBody;
+import okhttp3.Response;
+import okio.Buffer;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.Base64;
+import java.util.Objects;
+import java.util.zip.GZIPOutputStream;
+
+public class Base64EncodeRequestInterceptor implements Interceptor {
+  private static final String CONTENT_ENCODING_HEADER = "Content-Encoding";
+  private static final String MEDIA_TYPE_OCTET_STREAM = "application/octet-stream";
+  private static final String MEDIA_TYPE_OCTET_STREAM_GZIP = "gzip";
+
+  @Override
+  public @NotNull Response intercept(Interceptor.Chain chain) throws IOException {
+    Request originalRequest = chain.request();
+    Request.Builder builder = originalRequest.newBuilder();
+
+    if (originalRequest.method().equalsIgnoreCase("POST") ||
+      originalRequest.method().equalsIgnoreCase("PUT")) {
+
+      try (Buffer buffer = new Buffer()) {
+        Objects.requireNonNull(originalRequest.body()).writeTo(buffer);
+
+        byte[] encoded = encodeToBase64(buffer.readByteArray());
+        byte[] compressed = compress(encoded);
+
+        RequestBody body = RequestBody.create(compressed, MediaType.parse(MEDIA_TYPE_OCTET_STREAM));
+
+        builder = originalRequest.newBuilder()
+          .header(CONTENT_ENCODING_HEADER, MEDIA_TYPE_OCTET_STREAM_GZIP)
+          .method(originalRequest.method(), body);
+      }
+    }
+
+    Request request = builder.build();
+
+    return chain.proceed(request);
+  }
+
+  byte[] encodeToBase64(byte[] bytes) {
+    return Base64.getEncoder().encode(bytes);
+  }
+
+  byte[] compress(byte[] bytes) throws IOException {
+    byte[] compressed;
+    try (ByteArrayOutputStream bos = new ByteArrayOutputStream(bytes.length);
+         GZIPOutputStream gzip = new GZIPOutputStream(bos)) {
+      gzip.write(bytes);
+      gzip.finish();
+      compressed = bos.toByteArray();
+    }
+    return compressed;
+  }
+}
diff --git a/src/test/java/ai/deepcode/javaclient/core/Base64EncodeRequestInterceptorTest.java b/src/test/java/ai/deepcode/javaclient/core/Base64EncodeRequestInterceptorTest.java
@@ -0,0 +1,51 @@
+package ai.deepcode.javaclient.core;
+
+import org.junit.Test;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.zip.GZIPInputStream;
+
+import static org.junit.Assert.assertEquals;
+
+public class Base64EncodeRequestInterceptorTest {
+
+  @Test
+  public void encodesCorrectly() {
+    String jsonStr = "{\"src/app.ts\"}:{\"console.log(\\\"hello\\\"}\"\n";
+    Base64EncodeRequestInterceptor interceptor = new Base64EncodeRequestInterceptor();
+
+    byte[] encodedBytes = interceptor.encodeToBase64(jsonStr.getBytes());
+
+    assertEquals("eyJzcmMvYXBwLnRzIn06eyJjb25zb2xlLmxvZyhcImhlbGxvXCJ9Igo=", new String(encodedBytes));
+  }
+
+  @Test
+  public void compressesCorrectly() throws IOException {
+    String base64Str = "eyJzcmMvYXBwLnRzIn06eyJjb25zb2xlLmxvZyhcImhlbGxvXCJ9Igo=";
+    Base64EncodeRequestInterceptor interceptor = new Base64EncodeRequestInterceptor();
+
+    byte[] compressedBytes = interceptor.compress(base64Str.getBytes());
+
+    assertEquals(base64Str, new String(decompress(compressedBytes)));
+  }
+
+  private byte[] decompress(byte[] gzip) throws IOException {
+    try (
+      ByteArrayInputStream byteIn = new ByteArrayInputStream(gzip);
+      GZIPInputStream gzIn = new GZIPInputStream(byteIn);
+      ByteArrayOutputStream byteOut = new ByteArrayOutputStream()) {
+      int res = 0;
+      byte[] buf = new byte[1024];
+      while (res >= 0) {
+        res = gzIn.read(buf, 0, buf.length);
+        if (res > 0) {
+          byteOut.write(buf, 0, res);
+        }
+      }
+      return byteOut.toByteArray();
+    }
+  }
+}
+
