fix(java): use addAlgoliaAgent (#652)

algolia · Jun 8, 2022 · cbd81a2 · cbd81a2
1 parent bec6ee5
commit cbd81a2
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 447 deletions.
diff --git a/...s/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/ApiClient.java b/...s/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/ApiClient.java
@@ -19,15 +19,13 @@ public abstract class ApiClient {
 
   private boolean debugging = false;
   private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
+  private AlgoliaAgent algoliaAgent;
 
   private String contentType;
 
   private Requester requester;
 
-  /*
-   * Constructor for ApiClient with custom Requester
-   */
-  public ApiClient(String appId, String apiKey, String clientName, ClientOptions options) {
+  public ApiClient(String appId, String apiKey, String clientName, String version, ClientOptions options) {
     if (appId == null || appId.length() == 0) {
       throw new AlgoliaRuntimeException("`appId` is missing.");
     }
@@ -37,34 +35,51 @@ public ApiClient(String appId, String apiKey, String clientName, ClientOptions o
 
     this.contentType = "application/json";
 
-    AlgoliaAgent ua = new AlgoliaAgent("4.0.0-SNAPSHOT");
-    ua.addSegment(new AlgoliaAgent.Segment(clientName, "4.0.0-SNAPSHOT"));
+    this.algoliaAgent = new AlgoliaAgent(version);
+    this.algoliaAgent.addSegment(new AlgoliaAgent.Segment(clientName, version));
     if (options.getAlgoliaAgentSegments() != null) {
       for (AlgoliaAgent.Segment segment : options.getAlgoliaAgentSegments()) {
-        ua.addSegment(segment);
+        this.algoliaAgent.addSegment(segment);
       }
     }
-    setAlgoliaAgent(ua.toString());
+    refreshUserAgent();
 
-    defaultHeaderMap.put("X-Algolia-Application-Id", appId);
-    defaultHeaderMap.put("X-Algolia-API-Key", apiKey);
-    defaultHeaderMap.put("Accept", this.contentType);
-    defaultHeaderMap.put("Content-Type", this.contentType);
+    addDefaultHeader("X-Algolia-Application-Id", appId);
+    addDefaultHeader("X-Algolia-API-Key", apiKey);
+    addDefaultHeader("Accept", this.contentType);
+    addDefaultHeader("Content-Type", this.contentType);
 
     this.requester = options.getRequester();
     if (this.requester == null) {
       this.requester = new HttpRequester();
     }
   }
 
+  private void refreshUserAgent() {
+    addDefaultHeader("User-Agent", this.algoliaAgent.toString());
+  }
+
+  /**
+   * Add a custom user agent segment
+   *
+   * @param segment Algolia Agent Segment
+   * @return ApiClient
+   */
+  public ApiClient addAlgoliaAgent(AlgoliaAgent.Segment segment) {
+    algoliaAgent.addSegment(segment);
+    refreshUserAgent();
+    return this;
+  }
+
   /**
-   * Set the User-Agent header's value (by adding to the default header map).
+   * Remove a user agent segment
    *
-   * @param algoliaAgent HTTP request's user agent
+   * @param segment Algolia Agent Segment
    * @return ApiClient
    */
-  public ApiClient setAlgoliaAgent(String algoliaAgent) {
-    addDefaultHeader("User-Agent", algoliaAgent);
+  public ApiClient removeAlgoliaAgent(AlgoliaAgent.Segment segment) {
+    algoliaAgent.removeSegment(segment);
+    refreshUserAgent();
     return this;
   }
 

diff --git a/...search-client-java-2/algoliasearch-core/src/main/java/com/algolia/utils/AlgoliaAgent.java b/...search-client-java-2/algoliasearch-core/src/main/java/com/algolia/utils/AlgoliaAgent.java
@@ -25,6 +25,10 @@ public String addSegment(Segment seg) {
     return finalValue;
   }
 
+  public boolean removeSegment(Segment seg) {
+    return segments.remove(seg.toString());
+  }
+
   @Override
   public String toString() {
     return finalValue;

diff --git a/config/generation.config.js b/config/generation.config.js
@@ -11,7 +11,6 @@ module.exports = {
     // Java
     '!clients/algoliasearch-client-java-2/**',
     'clients/algoliasearch-client-java-2/gradle.properties',
-    'clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/ApiClient.java',
     'clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/api/**',
     'clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/**',
 

diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -42,6 +42,7 @@ public void processOpts() {
       file.getTemplateFile().equals("build.gradle.mustache") ||
       file.getTemplateFile().equals("settings.gradle.mustache") ||
       file.getTemplateFile().equals("gitignore.mustache") ||
+      file.getTemplateFile().equals("ApiClient.mustache") ||
       file.getTemplateFile().equals("ApiCallback.mustache") ||
       file.getTemplateFile().equals("ApiResponse.mustache") ||
       file.getTemplateFile().equals("JSON.mustache") ||

diff --git a/scripts/ci/husky/pre-commit.js b/scripts/ci/husky/pre-commit.js
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable no-console */
 /* eslint-disable import/no-commonjs */
 /* eslint-disable @typescript-eslint/no-var-requires */
 const chalk = require('chalk');
@@ -26,8 +27,15 @@ function getPatterns() {
 
 async function preCommit() {
   // when merging, we want to stage all the files
-  if ((await run('git merge HEAD')) !== 'Already up to date.') {
-    return;
+  try {
+    await run('git merge HEAD');
+  } catch (e) {
+    if (e.exitCode === 128) {
+      console.log(
+        'Skipping the pre-commit check because a merge is in progress'
+      );
+      return;
+    }
   }
 
   const stagedFiles = (
@@ -37,7 +45,6 @@ async function preCommit() {
   const toUnstage = micromatch.match(stagedFiles, getPatterns());
 
   for (const file of toUnstage) {
-    // eslint-disable-next-line no-console
     console.log(
       chalk.black.bgYellow('[INFO]'),
       `Generated file found, unstaging: ${file}`