feat: provide analysisContext key (getAnalysis request) for better tracking/logging on backend

Author: ArtsiomCh

CHANGELOG.md

@@ -5,6 +5,7 @@
 - fix: avoid remove operation for empty immutable List
 - fix: check file in marker for nullability before proceed
 - feat: provide unique (per project) `shard` to getAnalysis call
+- feat: provide `analysisContext` key (`getAnalysis` request) for better tracking/logging on backend
 - chore: reshape/refactor REST API wrapper to be replaceable through constructor base DI
 
 ## [2.2.1] - 2021-12-10

src/integTest/java/ai/deepcode/javaclient/DeepCodeRestApiImplTest.java

@@ -372,7 +372,15 @@ private GetAnalysisResponse doAnalysisAndWait(List<String> analysedFiles, Intege
       throws InterruptedException {
     GetAnalysisResponse response = null;
     for (int i = 0; i < 120; i++) {
-      response = restApiClient.getAnalysis(loggedToken, bundleId, severity, analysedFiles, bundleId);
+      response = restApiClient.getAnalysis(
+        loggedToken,
+        bundleId,
+        severity,
+        analysedFiles,
+        bundleId,
+        "test-java-client",
+        "test-java-client"
+      );
       if (response.getStatus().equals("COMPLETE")) break;
       Thread.sleep(1000);
     }

src/main/java/ai/deepcode/javaclient/DeepCodeRestApi.java

@@ -57,7 +57,14 @@ void setBaseUrl(
    * @return {@link GetAnalysisResponse} instance}
    */
   @NotNull GetAnalysisResponse getAnalysis(
-    String token, String bundleId, Integer severity, List<String> filesToAnalyse, String shard);
+    String token,
+    String bundleId,
+    Integer severity,
+    List<String> filesToAnalyse,
+    String shard,
+    String ideProductName,
+    String orgDisplayName
+  );
 
   /**
    * Requests current filtering options for uploaded bundles.

src/main/java/ai/deepcode/javaclient/DeepCodeRestApiImpl.java

@@ -335,12 +335,19 @@ Call<GetAnalysisResponse> doGetAnalysis(
   @Override
   @NotNull
   public GetAnalysisResponse getAnalysis(
-    String token, String bundleId, Integer severity, List<String> filesToAnalyse, String shard) {
+    String token,
+    String bundleId,
+    Integer severity,
+    List<String> filesToAnalyse,
+    String shard,
+    String ideProductName,
+    String orgDisplayName
+  ) {
     GetAnalysisCall getAnalysisCall = retrofit.create(GetAnalysisCall.class);
     try {
       Response<GetAnalysisResponse> retrofitResponse =
           getAnalysisCall
-              .doGetAnalysis(token, new GetAnalysisRequest(bundleId, filesToAnalyse, severity, shard))
+              .doGetAnalysis(token, new GetAnalysisRequest(bundleId, filesToAnalyse, severity, shard, ideProductName, orgDisplayName))
               .execute();
       GetAnalysisResponse result = retrofitResponse.body();
       if (result == null) result = new GetAnalysisResponse();

src/main/java/ai/deepcode/javaclient/core/AnalysisDataBase.java

@@ -593,8 +593,9 @@ private GetAnalysisResponse doGetAnalysis(
               bundleId,
               deepCodeParams.getMinSeverity(),
               filesToAnalyse,
-              HashContentUtilsBase.calculateHash(pdUtils.getProjectName(project))
-          );
+              HashContentUtilsBase.calculateHash(pdUtils.getProjectName(project)),
+              deepCodeParams.getIdeProductName(),
+              deepCodeParams.getOrgDisplayName());
 
       pdUtils.progressCheckCanceled(progress);
       dcLogger.logInfo(response.toString());

src/main/java/ai/deepcode/javaclient/core/DeepCodeParamsBase.java

@@ -18,6 +18,7 @@ public abstract class DeepCodeParamsBase {
   // Inner params
   private String loginUrl;
   private String ideProductName;
+  private String orgDisplayName;
   private Supplier<Long> getTimeoutForGettingAnalysesMs;
   private final DeepCodeRestApi restApi;
 
@@ -30,7 +31,7 @@ protected DeepCodeParamsBase(
     String sessionToken,
     String loginUrl,
     String ideProductName,
-    Supplier<Long> getTimeoutForGettingAnalysesMs,
+    String orgDisplayName, Supplier<Long> getTimeoutForGettingAnalysesMs,
     DeepCodeRestApi restApi
   ) {
     this.isEnable = isEnable;
@@ -41,6 +42,7 @@ protected DeepCodeParamsBase(
     this.sessionToken = sessionToken;
     this.loginUrl = loginUrl;
     this.ideProductName = ideProductName;
+    this.orgDisplayName = orgDisplayName;
     this.getTimeoutForGettingAnalysesMs = getTimeoutForGettingAnalysesMs;
     this.restApi = restApi;
   }
@@ -134,4 +136,8 @@ public String getIdeProductName() {
   public long getTimeoutForGettingAnalysesMs() {
     return getTimeoutForGettingAnalysesMs.get();
   }
+
+  public String getOrgDisplayName() {
+    return orgDisplayName;
+  }
 }

src/main/java/ai/deepcode/javaclient/requests/GetAnalysisRequest.java

@@ -5,15 +5,18 @@
 
 public class GetAnalysisRequest {
   private GetAnalysisKey key;
+  private AnalysisContext analysisContext;
   private Integer severity;
   private boolean prioritized;
   private boolean legacy;
 
   /**
    * @param bundleHash
-   * @param limitToFiles list of filePath
+   * @param limitToFiles   list of filePath
    * @param severity
-   * @param shard uniq String (hash) per Project to optimize jobs on backend (run on the same worker to reuse caches)
+   * @param shard          uniq String (hash) per Project to optimize jobs on backend (run on the same worker to reuse caches)
+   * @param ideProductName specific IDE
+   * @param orgDisplayName client’s snyk organization name
    * @param prioritized
    * @param legacy
    */
@@ -22,17 +25,25 @@ public GetAnalysisRequest(
     List<String> limitToFiles,
     Integer severity,
     String shard,
-    boolean prioritized,
+    String ideProductName, String orgDisplayName, boolean prioritized,
     boolean legacy
   ) {
     this.key = new GetAnalysisKey(bundleHash, limitToFiles, shard);
+    this.analysisContext = new AnalysisContext(ideProductName, orgDisplayName);
     this.severity = severity;
     this.prioritized = prioritized;
     this.legacy = legacy;
   }
 
-  public GetAnalysisRequest(String bundleHash, List<String> limitToFiles, Integer severity, String shard) {
-    this(bundleHash, limitToFiles, severity, shard, false, true);
+  public GetAnalysisRequest(
+    String bundleHash,
+    List<String> limitToFiles,
+    Integer severity,
+    String shard,
+    String ideProductName,
+    String orgDisplayName
+  ) {
+    this(bundleHash, limitToFiles, severity, shard, ideProductName, orgDisplayName, false, true);
   }
 
   private static class GetAnalysisKey {
@@ -65,27 +76,72 @@ public boolean equals(Object o) {
       if (o == null || getClass() != o.getClass()) return false;
       GetAnalysisKey that = (GetAnalysisKey) o;
       return type.equals(that.type)
-          && hash.equals(that.hash)
-          && Objects.equals(limitToFiles, that.limitToFiles);
+        && hash.equals(that.hash)
+        && Objects.equals(limitToFiles, that.limitToFiles);
     }
 
     @Override
     public String toString() {
       return "GetAnalysisKey{"
-          + "type='"
-          + type
-          + '\''
-          + ", hash='"
-          + hash
-          + '\''
-          + ", limitToFiles="
-          + limitToFiles
-          + '}';
+        + "type='"
+        + type
+        + '\''
+        + ", hash='"
+        + hash
+        + '\''
+        + ", limitToFiles="
+        + limitToFiles
+        + '}';
     }
 
     @Override
     public int hashCode() {
       return Objects.hash(type, hash, limitToFiles);
     }
   }
+
+  private static class AnalysisContext {
+    private final String flow;
+    private final String initiator = "IDE";
+    private final String orgDisplayName;
+
+    public AnalysisContext(String flow, String orgDisplayName) {
+      this.flow = flow;
+      this.orgDisplayName = orgDisplayName;
+    }
+
+    public String getFlow() {
+      return flow;
+    }
+
+    public String getOrgDisplayName() {
+      return orgDisplayName;
+    }
+
+    public String getInitiator() {
+      return initiator;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+      if (this == o) return true;
+      if (o == null || getClass() != o.getClass()) return false;
+      AnalysisContext that = (AnalysisContext) o;
+      return Objects.equals(flow, that.flow) && Objects.equals(orgDisplayName, that.orgDisplayName);
+    }
+
+    @Override
+    public int hashCode() {
+      return Objects.hash(flow, orgDisplayName);
+    }
+
+    @Override
+    public String toString() {
+      return "AnalysisContext{" +
+        "flow='" + flow + '\'' +
+        ", initiator='" + initiator + '\'' +
+        ", orgDisplayName='" + orgDisplayName + '\'' +
+        '}';
+    }
+  }
 }

src/test/java/ai/deepcode/javaclient/core/AnalysisDataTest.java

@@ -104,7 +104,15 @@ public void reupload_files_if_initial_upload_does_not_succeed() {
   public void if_file_upload_fail_getAnalysis_should_not_be_invoked() {
     restApi = new RestApiMockWithBrokenFileUpload() {
       @Override
-      public @NotNull GetAnalysisResponse getAnalysis(String token, String bundleId, Integer severity, List<String> filesToAnalyse, String shard) {
+      public @NotNull GetAnalysisResponse getAnalysis(
+        String token,
+        String bundleId,
+        Integer severity,
+        List<String> filesToAnalyse,
+        String shard,
+        String ideProductName,
+        String orgDisplayName
+      ) {
         throw new RuntimeException("getAnalysis should NOT be invoked");
       }
     };
@@ -158,7 +166,15 @@ public void getAnalysis_recover_during_polling_if_operation_sometimes_does_not_s
       }
 
       @Override
-      public @NotNull GetAnalysisResponse getAnalysis(String token, String bundleId, Integer severity, List<String> filesToAnalyse, String shard) {
+      public @NotNull GetAnalysisResponse getAnalysis(
+        String token,
+        String bundleId,
+        Integer severity,
+        List<String> filesToAnalyse,
+        String shard,
+        String ideProductName,
+        String orgDisplayName
+      ) {
         final GetAnalysisResponse response = Objects.requireNonNull(responses.poll());
         if (response.getStatus().equals(COMPLETE)) {
           isCompleted[0] = true;

src/test/java/ai/deepcode/javaclient/core/mocks/DeepCodeParamsMock.java

@@ -7,7 +7,7 @@
 public class DeepCodeParamsMock extends DeepCodeParamsBase {
 
   public DeepCodeParamsMock(DeepCodeRestApi restApi) {
-    super(true, "", false, false, 1, "", "", "", () -> 1000L, restApi);
+    super(true, "", false, false, 1, "", "", "", "", () -> 1000L, restApi);
   }
 
   @Override

src/test/java/ai/deepcode/javaclient/core/mocks/DeepCodeRestApiMock.java

@@ -36,7 +36,15 @@ public void setBaseUrl(@Nullable String baseUrl, boolean disableSslVerification,
   }
 
   @Override
-  public @NotNull GetAnalysisResponse getAnalysis(String token, String bundleId, Integer severity, List<String> filesToAnalyse, String shard) {
+  public @NotNull GetAnalysisResponse getAnalysis(
+    String token,
+    String bundleId,
+    Integer severity,
+    List<String> filesToAnalyse,
+    String shard,
+    String ideProductName,
+    String orgDisplayName
+  ) {
     throw new UnsupportedOperationException();
   }