Expose new signal configuration for timeout (#484)

* Expose new signal config

* Add doc

Author: therve

.generator/templates/http/http.mustache

@@ -25,6 +25,27 @@ export * from './jquery';
 {{/deno}}
 {{/platforms}}
 
+/**
+ * Interface for aborting fetch requests.
+ */
+export interface AbortSignal {
+    aborted: boolean;
+
+    addEventListener: (type: "abort", listener: ((this: AbortSignal, event: any) => any), options?: boolean | {
+        capture?: boolean,
+        once?: boolean,
+        passive?: boolean
+    }) => void;
+
+    removeEventListener: (type: "abort", listener: ((this: AbortSignal, event: any) => any), options?: boolean | {
+        capture?: boolean
+    }) => void;
+
+    dispatchEvent: (event: any) => boolean;
+
+    onabort?: null | ((this: AbortSignal, event: any) => void);
+}
+
 /**
  * Represents an HTTP method.
  */
@@ -109,6 +130,7 @@ export type RequestBody = undefined | string | Buffer | FormData;
  */
 export interface HttpConfiguration {
     compress?: boolean;
+    signal?: AbortSignal;
 }
 
 /**

.generator/templates/http/isomorphic-fetch.mustache

@@ -35,6 +35,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
             body: body as any,
             headers: headers,
             compress: compress,
+            signal: request.getHttpConfig().signal,
             {{#platforms}}
             {{#browser}}
             credentials: "same-origin"

README.md

@@ -92,6 +92,37 @@ const configurationOpts = {
 const configuration = v1.createConfiguration(configurationOpts);
 ```
 
+### Adding timeout to requests
+
+To add timeout or other mechanism to cancel requests, you need an abort
+controller, for example the one implemented by
+[abort-controller](https://www.npmjs.com/package/abort-controller). You can
+then pass the `signal method to the HTTP configuration options:
+
+```typescript
+import { v1 } from '@datadog/datadog-api-client';
+import AbortController from 'abort-controller';
+
+const controller = new AbortController();
+const timeout = setTimeout(
+  () => { controller.abort(); },
+  1000,
+);
+const configurationOpts = {
+  httpConfig: {
+    signal: controller.signal
+  },
+};
+
+const configuration = v1.createConfiguration(configurationOpts);
+
+const apiInstance = new v1.MonitorsApi(configuration);
+apiInstance.listMonitors().then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error)).finally(() => clearTimeout(timeout));
+```
+
+
 ## Documentation
 
 Documentation for API endpoints can be found under the docs subdirectories, in [v1](/docs/v1/)

packages/datadog-api-client-v1/http/http.ts

@@ -6,6 +6,39 @@ import { Observable, from } from "../rxjsStub";
 
 export * from "./isomorphic-fetch";
 
+/**
+ * Interface for aborting fetch requests.
+ */
+export interface AbortSignal {
+  aborted: boolean;
+
+  addEventListener: (
+    type: "abort",
+    listener: (this: AbortSignal, event: any) => any,
+    options?:
+      | boolean
+      | {
+          capture?: boolean;
+          once?: boolean;
+          passive?: boolean;
+        }
+  ) => void;
+
+  removeEventListener: (
+    type: "abort",
+    listener: (this: AbortSignal, event: any) => any,
+    options?:
+      | boolean
+      | {
+          capture?: boolean;
+        }
+  ) => void;
+
+  dispatchEvent: (event: any) => boolean;
+
+  onabort?: null | ((this: AbortSignal, event: any) => void);
+}
+
 /**
  * Represents an HTTP method.
  */
@@ -45,6 +78,7 @@ export type RequestBody = undefined | string | Buffer | FormData;
  */
 export interface HttpConfiguration {
   compress?: boolean;
+  signal?: AbortSignal;
 }
 
 /**

packages/datadog-api-client-v1/http/isomorphic-fetch.ts

@@ -27,6 +27,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
       body: body as any,
       headers: headers,
       compress: compress,
+      signal: request.getHttpConfig().signal,
     }).then((resp: any) => {
       const headers: { [name: string]: string } = {};
       resp.headers.forEach((value: string, name: string) => {

packages/datadog-api-client-v2/http/http.ts

@@ -6,6 +6,39 @@ import { Observable, from } from "../rxjsStub";
 
 export * from "./isomorphic-fetch";
 
+/**
+ * Interface for aborting fetch requests.
+ */
+export interface AbortSignal {
+  aborted: boolean;
+
+  addEventListener: (
+    type: "abort",
+    listener: (this: AbortSignal, event: any) => any,
+    options?:
+      | boolean
+      | {
+          capture?: boolean;
+          once?: boolean;
+          passive?: boolean;
+        }
+  ) => void;
+
+  removeEventListener: (
+    type: "abort",
+    listener: (this: AbortSignal, event: any) => any,
+    options?:
+      | boolean
+      | {
+          capture?: boolean;
+        }
+  ) => void;
+
+  dispatchEvent: (event: any) => boolean;
+
+  onabort?: null | ((this: AbortSignal, event: any) => void);
+}
+
 /**
  * Represents an HTTP method.
  */
@@ -45,6 +78,7 @@ export type RequestBody = undefined | string | Buffer | FormData;
  */
 export interface HttpConfiguration {
   compress?: boolean;
+  signal?: AbortSignal;
 }
 
 /**

packages/datadog-api-client-v2/http/isomorphic-fetch.ts

@@ -27,6 +27,7 @@ export class IsomorphicFetchHttpLibrary implements HttpLibrary {
       body: body as any,
       headers: headers,
       compress: compress,
+      signal: request.getHttpConfig().signal,
     }).then((resp: any) => {
       const headers: { [name: string]: string } = {};
       resp.headers.forEach((value: string, name: string) => {