feat(clients): add usage client

config/clients.config.json

@@ -9,7 +9,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-csharp",
     "gitRepoId": "algoliasearch-client-csharp",
@@ -70,7 +71,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-go",
     "gitRepoId": "algoliasearch-client-go",
@@ -97,7 +99,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-java",
     "gitRepoId": "algoliasearch-client-java",
@@ -155,6 +158,10 @@
       {
         "name": "search",
         "output": "clients/algoliasearch-client-javascript/packages/client-search"
+      },
+      {
+        "name": "usage",
+        "output": "clients/algoliasearch-client-javascript/packages/client-usage"
       }
     ],
     "folder": "clients/algoliasearch-client-javascript",
@@ -183,7 +190,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-kotlin",
     "gitRepoId": "algoliasearch-client-kotlin",
@@ -210,7 +218,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-php",
     "gitRepoId": "algoliasearch-client-php",
@@ -237,7 +246,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-python",
     "gitRepoId": "algoliasearch-client-python",
@@ -264,7 +274,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-ruby",
     "gitRepoId": "algoliasearch-client-ruby",
@@ -291,7 +302,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-scala",
     "gitRepoId": "algoliasearch-client-scala",
@@ -318,7 +330,8 @@
       "personalization",
       "query-suggestions",
       "recommend",
-      "search"
+      "search",
+      "usage"
     ],
     "folder": "clients/algoliasearch-client-swift",
     "gitRepoId": "algoliasearch-client-swift",

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

@@ -121,6 +121,10 @@ public String toEnumVarName(String value, String datatype) {
         return "GREATER_THAN";
       case ">=":
         return "GREATER_EQUALS";
+      case "90p_processing_time":
+        return "NINETY_P_PROCESSING_TIME";
+      case "99p_processing_time":
+        return "NINETY_NINE_P_PROCESSING_TIME";
       case "mappingkit/v1":
         return "MAPPINGKIT_V1";
     }

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

@@ -195,6 +195,15 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
   @Override
   public String toEnumVarName(String value, String datatype) {
     if (!"String".equals(datatype)) return super.toEnumVarName(value, datatype);
+    // In some cases, the API might accept characters instead of the textual notation, we will
+    // replace it internally so that it doesn't output the character itself.
+    switch (value) {
+      case "90p_processing_time":
+        return "NinetypProcessingTime";
+      case "99p_processing_time":
+        return "NinetyNinepProcessingTime";
+    }
+
     String enumVarName = value.replace("-", "_");
     return super.toEnumVarName(enumVarName, datatype);
   }

scripts/pre-gen/removeExistingCodegen.ts

@@ -1,7 +1,7 @@
 import fsp from 'fs/promises';
 import path from 'path';
 
-import { createClientName, run, toAbsolutePath, toSnakeCase } from '../common.js';
+import { createClientName, toAbsolutePath, toSnakeCase } from '../common.js';
 import { getLanguageApiFolder, getLanguageFolder, getLanguageModelFolder } from '../config.js';
 import type { Generator } from '../types.js';
 
@@ -87,14 +87,14 @@ export async function removeExistingCodegen({
   }
 
   // Delete client model folder/file
-  await run(`rm -rf ${path.join(baseModelFolder, clientModel)}`, {
-    cwd: folder,
-    language,
+  await fsp.rm(path.join(folder, baseModelFolder, clientModel), {
+    force: true,
+    recursive: true,
   });
 
   // Delete client api folder/file
-  await run(`rm -rf ${path.join(baseApiFolder, clientApi)}`, {
-    cwd: folder,
-    language,
+  await fsp.rm(path.join(folder, path.join(baseApiFolder, clientApi)), {
+    force: true,
+    recursive: true,
   });
 }

snippets/javascript/package.json

@@ -9,6 +9,7 @@
     "@algolia/client-personalization": "link:../../clients/algoliasearch-client-javascript/packages/client-personalization",
     "@algolia/client-query-suggestions": "link:../../clients/algoliasearch-client-javascript/packages/client-query-suggestions",
     "@algolia/client-search": "link:../../clients/algoliasearch-client-javascript/packages/client-search",
+    "@algolia/client-usage": "link:../../clients/algoliasearch-client-javascript/packages/client-usage",
     "@algolia/ingestion": "link:../../clients/algoliasearch-client-javascript/packages/ingestion",
     "@algolia/monitoring": "link:../../clients/algoliasearch-client-javascript/packages/monitoring",
     "@algolia/recommend": "link:../../clients/algoliasearch-client-javascript/packages/recommend",

specs/usage/spec.yml

@@ -56,6 +56,15 @@ tags:
     x-displayName: Usage statistics
     description: Get various metrics related to the usage of your Algolia applications.
 paths:
+  # ######################
+  # ### Custom request ###
+  # ######################
+  /{path}:
+    $ref: '../common/paths/customRequest.yml'
+
+  # ##################################
+  # ######## Usage  Endpoints ########
+  # ##################################
   /1/usage/{statistic}:
     $ref: 'paths/statistic.yml'
   /1/usage/{statistic}/{indexName}:

tests/CTS/client/usage/api.json

@@ -0,0 +1,54 @@
+[
+  {
+    "testName": "calls api with correct read host",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "customGet",
+        "parameters": {
+          "path": "test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "test-app-id-dsn.algolia.net"
+        }
+      }
+    ]
+  },
+  {
+    "testName": "calls api with correct write host",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "customPost",
+        "parameters": {
+          "path": "test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "test-app-id.algolia.net"
+        }
+      }
+    ]
+  }
+]

tests/CTS/client/usage/parameters.json

@@ -0,0 +1,32 @@
+[
+  {
+    "testName": "client throws with invalid parameters",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "expected": {
+          "error": "`appId` is missing."
+        }
+      },
+      {
+        "type": "createClient",
+        "parameters": {
+          "apiKey": "my-api-key"
+        },
+        "expected": {
+          "error": "`appId` is missing."
+        }
+      },
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id"
+        },
+        "expected": {
+          "error": "`apiKey` is missing."
+        }
+      }
+    ]
+  }
+]

tests/CTS/requests/usage/getIndexUsage.json

@@ -0,0 +1,19 @@
+[
+  {
+    "testName": "getIndexUsage with minimal parameters",
+    "parameters": {
+      "statistic": "queries_operations",
+      "indexName": "myIndexName",
+      "startDate": "2024-04-03T12:46:43Z",
+      "endDate": "2024-04-05T12:46:43Z"
+    },
+    "request": {
+      "path": "/1/usage/queries_operations/myIndexName",
+      "method": "GET",
+      "queryParameters": {
+        "startDate": "2024-04-03T12%3A46%3A43Z",
+        "endDate": "2024-04-05T12%3A46%3A43Z"
+      }
+    }
+  }
+]

tests/CTS/requests/usage/getUsage.json

@@ -0,0 +1,18 @@
+[
+  {
+    "testName": "getUsage with minimal parameters",
+    "parameters": {
+      "statistic": "queries_operations",
+      "startDate": "2024-04-03T12:46:43Z",
+      "endDate": "2024-04-05T12:46:43Z"
+    },
+    "request": {
+      "path": "/1/usage/queries_operations",
+      "method": "GET",
+      "queryParameters": {
+        "startDate": "2024-04-03T12%3A46%3A43Z",
+        "endDate": "2024-04-05T12%3A46%3A43Z"
+      }
+    }
+  }
+]