feat(generators): allow per-spec timeouts

Author: shortcuts

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

@@ -203,6 +203,7 @@ private void setDefaultGeneratorOptions() {
   public void processOpenAPI(OpenAPI openAPI) {
     super.processOpenAPI(openAPI);
     Helpers.generateServers(super.fromServers(openAPI.getServers()), additionalProperties);
+    Timeouts.enrichBundle((HashMap<String, Object>) openAPI.getExtensions().get("x-timeouts"), additionalProperties);
   }
 
   @Override

generators/src/main/java/com/algolia/codegen/utils/Timeouts.java

@@ -0,0 +1,51 @@
+package com.algolia.codegen.utils;
+
+import com.algolia.codegen.exceptions.*;
+import com.fasterxml.jackson.databind.*;
+import java.util.*;
+
+public class Timeouts {
+
+  /** Inject timeouts info into the client bundle at x-timeouts */
+  public static void enrichBundle(HashMap<String, Object> timeouts, Map<String, Object> bundle) throws ConfigException {
+    HashMap<String, Object> xtimeouts = new HashMap<>();
+
+    HashMap<String, Object> browser = new HashMap<>();
+    HashMap<String, Object> server = new HashMap<>();
+
+    if (timeouts != null) {
+      browser = (HashMap<String, Object>) timeouts.getOrDefault("browser", new HashMap<>());
+      server = (HashMap<String, Object>) timeouts.getOrDefault("server", new HashMap<>());
+    }
+
+    HashMap<String, Object> defaultBrowser = new HashMap<>();
+    defaultBrowser.put("connect", 1000);
+    defaultBrowser.put("read", 2000);
+    defaultBrowser.put("write", 30000);
+
+    HashMap<String, Object> defaultServer = new HashMap<>();
+    defaultServer.put("connect", 2000);
+    defaultServer.put("read", 5000);
+    defaultServer.put("write", 30000);
+
+    if (browser == null) {
+      xtimeouts.put("browser", defaultBrowser);
+    } else {
+      browser.put("connect", browser.getOrDefault("connect", defaultBrowser.get("connect")));
+      browser.put("read", browser.getOrDefault("read", defaultBrowser.get("read")));
+      browser.put("write", browser.getOrDefault("write", defaultBrowser.get("write")));
+      xtimeouts.put("browser", browser);
+    }
+
+    if (server == null) {
+      xtimeouts.put("server", defaultServer);
+    } else {
+      server.put("connect", server.getOrDefault("connect", defaultServer.get("connect")));
+      server.put("read", server.getOrDefault("read", defaultServer.get("read")));
+      server.put("write", server.getOrDefault("write", defaultServer.get("write")));
+      xtimeouts.put("server", server);
+    }
+
+    bundle.put("x-timeouts", xtimeouts);
+  }
+}

playground/javascript/node/analytics.ts

@@ -14,7 +14,7 @@ async function testAnalytics() {
     const res = await client.getTopFilterForAttribute({
       attribute: 'myAttribute1,myAttribute2',
       index: analyticsIndex,
-    });
+    }, {timeouts: {read:20000, write: 30000}});
 
     console.log(`[OK]`, res);
   } catch (e) {

specs/ingestion/spec.yml

@@ -95,6 +95,15 @@ x-tagGroups:
       - sources
       - tasks
       - transformations
+x-timeouts:
+  browser:
+    connect: 25000
+    read: 25000
+    write: 25000
+  server:
+    connect: 25000
+    read: 25000
+    write: 25000
 paths:
   # ######################
   # ### Custom request ###

templates/javascript/clients/client/builds/browser.mustache

@@ -5,9 +5,9 @@
     appId,
     apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
     timeouts: {
-      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
-      read: DEFAULT_READ_TIMEOUT_BROWSER,
-      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+      connect: {{#x-timeouts.browser.connect}}{{{.}}}{{/x-timeouts.browser.connect}},
+      read: {{#x-timeouts.browser.read}}{{{.}}}{{/x-timeouts.browser.read}},
+      write: {{#x-timeouts.browser.write}}{{{.}}}{{/x-timeouts.browser.write}},
     },
     logger: createNullLogger(),
     requester: createXhrRequester(),

templates/javascript/clients/client/builds/fetch.mustache

@@ -8,9 +8,9 @@ export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnTyp
       appId,
       apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
       timeouts: {
-        connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-        read: DEFAULT_READ_TIMEOUT_NODE,
-        write: DEFAULT_WRITE_TIMEOUT_NODE,
+        connect: {{#x-timeouts.server.connect}}{{{.}}}{{/x-timeouts.server.connect}},
+        read: {{#x-timeouts.server.read}}{{{.}}}{{/x-timeouts.server.read}},
+        write: {{#x-timeouts.server.write}}{{{.}}}{{/x-timeouts.server.write}},
       },
       logger: createNullLogger(),
       algoliaAgents: [{ segment: 'Fetch' }],

templates/javascript/clients/client/builds/liteNode.mustache

@@ -7,9 +7,9 @@ export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnTyp
     appId,
     apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
     timeouts: {
-      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-      read: DEFAULT_READ_TIMEOUT_NODE,
-      write: DEFAULT_WRITE_TIMEOUT_NODE,
+      connect: {{#x-timeouts.server.connect}}{{{.}}}{{/x-timeouts.server.connect}},
+      read: {{#x-timeouts.server.read}}{{{.}}}{{/x-timeouts.server.read}},
+      write: {{#x-timeouts.server.write}}{{{.}}}{{/x-timeouts.server.write}},
     },
     logger: createNullLogger(),
     requester: createHttpRequester(),

templates/javascript/clients/client/builds/node.mustache

@@ -8,9 +8,9 @@ export type {{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}} = ReturnTyp
       appId,
       apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
       timeouts: {
-        connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-        read: DEFAULT_READ_TIMEOUT_NODE,
-        write: DEFAULT_WRITE_TIMEOUT_NODE,
+        connect: {{#x-timeouts.server.connect}}{{{.}}}{{/x-timeouts.server.connect}},
+        read: {{#x-timeouts.server.read}}{{{.}}}{{/x-timeouts.server.read}},
+        write: {{#x-timeouts.server.write}}{{{.}}}{{/x-timeouts.server.write}},
       },
       logger: createNullLogger(),
       requester: createHttpRequester(),