fix(javascript): do not send user-agent for Predict (#919)

Author: shortcuts

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts

@@ -110,12 +110,15 @@ export function createTransporter({
         : {};
 
     const queryParameters: QueryParameters = {
-      'x-algolia-agent': algoliaAgent.value,
       ...baseQueryParameters,
       ...request.queryParameters,
       ...dataQueryParameters,
     };
 
+    if (algoliaAgent.value) {
+      queryParameters['x-algolia-agent'] = algoliaAgent.value;
+    }
+
     if (requestOptions && requestOptions.queryParameters) {
       for (const key of Object.keys(requestOptions.queryParameters)) {
         // We want to keep `undefined` and `null` values,

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

@@ -121,6 +121,9 @@ private void setDefaultGeneratorOptions() {
     additionalProperties.put("isSearchClient", CLIENT.equals("search"));
     additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
 
+    // PRED-523 - tmp addition until the predict client supports user-agent in their API
+    additionalProperties.put("isPredictClient", CLIENT.equals("predict"));
+
     if (isAlgoliasearchClient) {
       // Files used to create the package.json of the algoliasearch package
       additionalProperties.put("analyticsVersion", Utils.getOpenApiToolsField("javascript", "analytics", "packageVersion"));

generators/src/main/java/com/algolia/codegen/cts/tests/TestsClient.java

@@ -19,7 +19,7 @@ public TestsClient(String language, String client) {
 
   @Override
   public boolean available() {
-    // no `lite` client test for now
+    // no `algoliasearch` client tests for now, only `lite`.
     if (language.equals("javascript") && client.equals("algoliasearch")) {
       return false;
     }
@@ -28,6 +28,15 @@ public boolean available() {
     return templates.exists();
   }
 
+  public boolean isTestAvailable(String testName) {
+    // PRED-523 - tmp addition until the predict client supports user-agent in their API
+    if (client.equals("predict") && testName.equals("calls api with correct user agent")) {
+      return false;
+    }
+
+    return true;
+  }
+
   @Override
   public void addSupportingFiles(List<SupportingFile> supportingFiles, String outputFolder, String extension) {
     if (!available()) {
@@ -50,6 +59,11 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
       for (ClientTestData test : blockEntry.getValue()) {
         Map<String, Object> testOut = new HashMap<>();
         List<Object> steps = new ArrayList<>();
+
+        if (!isTestAvailable(test.testName)) {
+          continue;
+        }
+
         testOut.put("testName", test.testName);
         testOut.put("testIndex", testIndex++);
         testOut.put("autoCreateClient", test.autoCreateClient);

templates/javascript/clients/api-single.mustache

@@ -19,11 +19,14 @@ export function create{{capitalizedApiName}}({
   const transporter = createTransporter({
     hosts: getDefaultHosts({{^hasRegionalHost}}appIdOption{{/hasRegionalHost}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}),
     ...options,
-    algoliaAgent: getAlgoliaAgent({
-      algoliaAgents,
-      client: '{{{algoliaAgent}}}',
-      version: apiClientVersion,
-    }),
+    {{! // PRED-523 - tmp addition until the predict client supports user-agent in their API }}
+    algoliaAgent: 
+      {{#isPredictClient}}
+        {...getAlgoliaAgent({ algoliaAgents, client: '{{{algoliaAgent}}}', version: apiClientVersion }), value: '' },
+      {{/isPredictClient}}
+      {{^isPredictClient}}
+        getAlgoliaAgent({ algoliaAgents, client: '{{{algoliaAgent}}}', version: apiClientVersion }),
+      {{/isPredictClient}}
     baseHeaders: {
       'content-type': 'text/plain',
       ...auth.headers(),