feat(headers): rename userAgent to algoliaAgent

I've not changed anything in `clients/`, as i thought that is generated

Author: Haroenv

generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java

@@ -59,7 +59,7 @@ private void setDefaultGeneratorOptions() {
 
     additionalProperties.put("apiName", apiName);
     additionalProperties.put("capitalizedApiName", Utils.capitalize(apiName));
-    additionalProperties.put("userAgent", Utils.capitalize(CLIENT));
+    additionalProperties.put("algoliaAgent", Utils.capitalize(CLIENT));
     additionalProperties.put("gitRepoId", "algoliasearch-client-javascript");
   }
 

playground/java/src/main/java/com/algolia/playground/Insights.java

@@ -5,7 +5,7 @@
 import com.algolia.exceptions.AlgoliaRuntimeException;
 import com.algolia.model.insights.*;
 import com.algolia.api.InsightsClient;
-import com.algolia.utils.UserAgent;
+import com.algolia.utils.AlgoliaAgent;
 import io.github.cdimascio.dotenv.Dotenv;
 
 public class Insights {
@@ -15,10 +15,10 @@ public static void main(String[] args) {
     InsightsClient client = new InsightsClient(
       dotenv.get("ALGOLIA_APPLICATION_ID"),
       dotenv.get("ALGOLIA_SEARCH_KEY"),
-      new UserAgent.Segment[] {
-        new UserAgent.Segment("test", "8.0.0"),
-        new UserAgent.Segment("JVM", "11.0.14"),
-        new UserAgent.Segment("no version"),
+      new AlgoliaAgent.Segment[] {
+        new AlgoliaAgent.Segment("test", "8.0.0"),
+        new AlgoliaAgent.Segment("JVM", "11.0.14"),
+        new AlgoliaAgent.Segment("no version"),
       }
     );
 

playground/java/src/main/java/com/algolia/playground/Search.java

@@ -5,7 +5,7 @@
 import com.algolia.exceptions.AlgoliaRuntimeException;
 import com.algolia.model.search.*;
 import com.algolia.api.SearchClient;
-import com.algolia.utils.UserAgent;
+import com.algolia.utils.AlgoliaAgent;
 import io.github.cdimascio.dotenv.Dotenv;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
@@ -19,10 +19,10 @@ public static void main(String[] args) {
     SearchClient client = new SearchClient(
       dotenv.get("ALGOLIA_APPLICATION_ID"),
       dotenv.get("ALGOLIA_SEARCH_KEY"),
-      new UserAgent.Segment[] {
-        new UserAgent.Segment("test", "8.0.0"),
-        new UserAgent.Segment("JVM", "11.0.14"),
-        new UserAgent.Segment("no version"),
+      new AlgoliaAgent.Segment[] {
+        new AlgoliaAgent.Segment("test", "8.0.0"),
+        new AlgoliaAgent.Segment("JVM", "11.0.14"),
+        new AlgoliaAgent.Segment("no version"),
       }
     );
 

playground/javascript/browser/app.ts

@@ -4,7 +4,7 @@ import './app.css';
 
 const client = searchClient('QPBQ67WNIG', 'b590ae1153bf574215ca1605c19eb1fe');
 
-client.addUserAgent('Browser playground', '0.0.1');
+client.addAlgoliaAgent('Browser playground', '0.0.1');
 
 const searchButton = document.querySelector('#search');
 

playground/javascript/node/algoliasearch.ts

@@ -27,7 +27,7 @@ const personalizationApiKey =
 // Init client with appId and apiKey
 const client = algoliasearch(appId, apiKey);
 
-client.addUserAgent('algoliasearch node playground', '0.0.1');
+client.addAlgoliaAgent('algoliasearch node playground', '0.0.1');
 
 async function testAlgoliasearch() {
   try {

playground/javascript/node/search.ts

@@ -13,7 +13,7 @@ const searchQuery = process.env.SEARCH_QUERY || 'test_query';
 // Init client with appId and apiKey
 const client = searchClient(appId, apiKey);
 
-client.addUserAgent('Node playground', '0.0.1');
+client.addAlgoliaAgent('Node playground', '0.0.1');
 
 async function testSearch() {
   try {

templates/java/libraries/okhttp-gson/ApiClient.mustache

@@ -2,7 +2,7 @@ package {{invokerPackage}};
 
 import com.algolia.utils.Requester;
 import com.algolia.exceptions.*;
-import com.algolia.utils.UserAgent;
+import com.algolia.utils.AlgoliaAgent;
 import com.algolia.utils.JSON;
 import com.algolia.utils.RequestOptions;
 
@@ -37,17 +37,17 @@ public class ApiClient {
     /*
      * Constructor for ApiClient with custom Requester
      */
-    public ApiClient(String appId, String apiKey, Requester requester, String clientName, UserAgent.Segment[] segments) {
+    public ApiClient(String appId, String apiKey, Requester requester, String clientName, AlgoliaAgent.Segment[] segments) {
       this.contentType = "application/json";
 
-      UserAgent ua = new UserAgent("{{packageVersion}}");
-      ua.addSegment(new UserAgent.Segment(clientName, "{{packageVersion}}"));
+      AlgoliaAgent ua = new AlgoliaAgent("{{packageVersion}}");
+      ua.addSegment(new AlgoliaAgent.Segment(clientName, "{{packageVersion}}"));
       if(segments != null) {
-        for(UserAgent.Segment segment : segments) {
+        for(AlgoliaAgent.Segment segment : segments) {
           ua.addSegment(segment);
         }
       }
-      setUserAgent(ua.toString());
+      setAlgoliaAgent(ua.toString());
 
       defaultHeaderMap.put("X-Algolia-Application-Id", appId);
       defaultHeaderMap.put("X-Algolia-API-Key", apiKey);
@@ -64,11 +64,11 @@ public class ApiClient {
     /**
      * Set the User-Agent header's value (by adding to the default header map).
      *
-     * @param userAgent HTTP request's user agent
+     * @param algoliaAgent HTTP request's user agent
      * @return ApiClient
      */
-    public ApiClient setUserAgent(String userAgent) {
-        addDefaultHeader("User-Agent", userAgent);
+    public ApiClient setAlgoliaAgent(String algoliaAgent) {
+        addDefaultHeader("User-Agent", algoliaAgent);
         return this;
     }
 

templates/java/libraries/okhttp-gson/api.mustache

@@ -36,17 +36,17 @@ public class {{classname}} extends ApiClient {
         this(appId, apiKey, new HttpRequester(getDefaultHosts(null)), null);
     }
 
-    public {{classname}}(String appId, String apiKey, UserAgent.Segment[] userAgentSegments) {
-        this(appId, apiKey, new HttpRequester(getDefaultHosts(null)), userAgentSegments);
+    public {{classname}}(String appId, String apiKey, AlgoliaAgent.Segment[] algoliaAgentSegments) {
+        this(appId, apiKey, new HttpRequester(getDefaultHosts(null)), algoliaAgentSegments);
     }
 
     {{/fallbackToAliasHost}}
     public {{classname}}(String appId, String apiKey, String region) {
         this(appId, apiKey, new HttpRequester(getDefaultHosts(region)), null);
     }
 
-    public {{classname}}(String appId, String apiKey, String region, UserAgent.Segment[] userAgentSegments) {
-        this(appId, apiKey, new HttpRequester(getDefaultHosts(region)), userAgentSegments);
+    public {{classname}}(String appId, String apiKey, String region, AlgoliaAgent.Segment[] algoliaAgentSegments) {
+        this(appId, apiKey, new HttpRequester(getDefaultHosts(region)), algoliaAgentSegments);
     }
     {{/hasRegionalHost}}
 
@@ -55,17 +55,17 @@ public class {{classname}} extends ApiClient {
         this(appId, apiKey, new HttpRequester(getDefaultHosts(appId)), null);
     }
 
-    public {{classname}}(String appId, String apiKey, UserAgent.Segment[] userAgentSegments) {
-        this(appId, apiKey, new HttpRequester(getDefaultHosts(appId)), userAgentSegments);
+    public {{classname}}(String appId, String apiKey, AlgoliaAgent.Segment[] algoliaAgentSegments) {
+        this(appId, apiKey, new HttpRequester(getDefaultHosts(appId)), algoliaAgentSegments);
     }
     {{/hasRegionalHost}}
 
     public {{classname}}(String appId, String apiKey, Requester requester) {
         this(appId, apiKey, requester, null);
     }
 
-    public {{classname}}(String appId, String apiKey, Requester requester, UserAgent.Segment[] userAgentSegments) {
-        super(appId, apiKey, requester, "{{{baseName}}}", userAgentSegments);
+    public {{classname}}(String appId, String apiKey, Requester requester, AlgoliaAgent.Segment[] algoliaAgentSegments) {
+        super(appId, apiKey, requester, "{{{baseName}}}", algoliaAgentSegments);
     }
 
     {{^hasRegionalHost}}

templates/javascript/api-single.mustache

@@ -1,7 +1,7 @@
 import {
   createAuth,
   createTransporter,
-  getUserAgent,
+  getAlgoliaAgent,
   shuffle,
 } from '@experimental-api-clients-automation/client-common';
 import type {
@@ -89,21 +89,21 @@ export function create{{capitalizedApiName}}(options: CreateClientOptions{{#hasR
       ...auth.headers(),
     },
     baseQueryParameters: auth.queryParameters(),
-    userAgent: getUserAgent({
-      userAgents: options.userAgents,
-      client: '{{{userAgent}}}',
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents: options.algoliaAgents,
+      client: '{{{algoliaAgent}}}',
       version: apiClientVersion,
     }),
     timeouts: options.timeouts,
     requester: options.requester,
   });
 
-  function addUserAgent(segment: string, version?: string): void {
-    transporter.userAgent.add({ segment, version });
+  function addAlgoliaAgent(segment: string, version?: string): void {
+    transporter.algoliaAgent.add({ segment, version });
   }
 
   return {
-    addUserAgent,
+    addAlgoliaAgent,
     {{#operation}}
     /**
     {{#notes}}

templates/javascript/browser.mustache

@@ -41,7 +41,7 @@ export function {{apiName}}(
       write: 30,
     },
     requester: options?.requester ?? createXhrRequester(),
-    userAgents: [{ segment: 'Browser' }],
+    algoliaAgents: [{ segment: 'Browser' }],
     authMode: 'WithinQueryParameters',
     responsesCache: options?.responsesCache ?? createMemoryCache(),
     requestsCache: options?.requestsCache ?? createMemoryCache({ serializable: false }),

templates/javascript/node.mustache

@@ -41,7 +41,7 @@ export function {{apiName}}(
       write: 30,
     },
     requester: options?.requester ?? createHttpRequester(),
-    userAgents: [{ segment: 'Node.js', version: process.versions.node }],
+    algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
     responsesCache: options?.responsesCache ?? createNullCache(),
     requestsCache: options?.requestsCache ?? createNullCache(),
     hostsCache: options?.hostsCache ?? createMemoryCache(),

templates/php/Configuration.mustache

@@ -30,7 +30,7 @@ abstract class Configuration
      *
      * @var string
      */
-    protected $userAgent = null;
+    protected $algoliaAgent = null;
 
     /**
      * Debug switch (default set to false)
@@ -252,19 +252,19 @@ abstract class Configuration
     /**
      * Sets the user agent of the api client
      *
-     * @param string $userAgent the user agent of the api client
+     * @param string $algoliaAgent the user agent of the api client
      *
      * @throws \InvalidArgumentException
      *
      * @return $this
      */
-    public function setUserAgent($userAgent)
+    public function setAlgoliaAgent($algoliaAgent)
     {
-        if (!is_string($userAgent)) {
+        if (!is_string($algoliaAgent)) {
             throw new \InvalidArgumentException('User-agent must be a string.');
         }
 
-        $this->userAgent = $userAgent;
+        $this->algoliaAgent = $algoliaAgent;
 
         return $this;
     }
@@ -274,8 +274,8 @@ abstract class Configuration
      *
      * @return string user agent
      */
-    public function getUserAgent()
+    public function getAlgoliaAgent()
     {
-        return $this->userAgent;
+        return $this->algoliaAgent;
     }
 }

tests/CTS/client/abtesting/api.json

@@ -19,7 +19,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/analytics/api.json

@@ -12,7 +12,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/insights/api.json

@@ -12,7 +12,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/personalization/api.json

@@ -8,7 +8,7 @@
         "path": "getPersonalizationStrategy",
         "parameters": [],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/predict/api.json

@@ -17,7 +17,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/query-suggestions/api.json

@@ -10,7 +10,7 @@
           {}
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/recommend/api.json

@@ -34,7 +34,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/search/api.json

@@ -36,7 +36,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/CTS/client/sources/api.json

@@ -50,7 +50,7 @@
           }
         ],
         "expected": {
-          "testSubject": "actual.userAgent",
+          "testSubject": "actual.algoliaAgent",
           "match": {
             "regexp": "/Algolia%20for%20(.+)%20\\(\\d+\\.\\d+\\.\\d+\\)/"
           }

tests/output/javascript/src/client/abtesting.test.ts

@@ -28,7 +28,7 @@ describe('api', () => {
       actual = await actual;
     }
 
-    expect(actual.userAgent).toMatch(
+    expect(actual.algoliaAgent).toMatch(
       /Algolia%20for%20(.+)%20\(\d+\.\d+\.\d+\)/
     );
   });

tests/output/javascript/src/client/analytics.test.ts

@@ -24,7 +24,7 @@ describe('api', () => {
       actual = await actual;
     }
 
-    expect(actual.userAgent).toMatch(
+    expect(actual.algoliaAgent).toMatch(
       /Algolia%20for%20(.+)%20\(\d+\.\d+\.\d+\)/
     );
   });

tests/output/javascript/src/client/insights.test.ts

@@ -24,7 +24,7 @@ describe('api', () => {
       actual = await actual;
     }
 
-    expect(actual.userAgent).toMatch(
+    expect(actual.algoliaAgent).toMatch(
       /Algolia%20for%20(.+)%20\(\d+\.\d+\.\d+\)/
     );
   });

tests/output/javascript/src/client/personalization.test.ts

@@ -26,7 +26,7 @@ describe('api', () => {
       actual = await actual;
     }
 
-    expect(actual.userAgent).toMatch(
+    expect(actual.algoliaAgent).toMatch(
       /Algolia%20for%20(.+)%20\(\d+\.\d+\.\d+\)/
     );
   });

tests/output/javascript/src/client/predict.test.ts

@@ -27,7 +27,7 @@ describe('api', () => {
       actual = await actual;
     }
 
-    expect(actual.userAgent).toMatch(
+    expect(actual.algoliaAgent).toMatch(
       /Algolia%20for%20(.+)%20\(\d+\.\d+\.\d+\)/
     );
   });