Adding cancelable promise

Author: ferdikoomen

package.json

@@ -84,6 +84,7 @@
         "@types/qs": "6.9.6",
         "@typescript-eslint/eslint-plugin": "4.17.0",
         "@typescript-eslint/parser": "4.17.0",
+        "abort-controller": "3.0.0",
         "codecov": "3.8.1",
         "eslint": "7.21.0",
         "eslint-config-prettier": "8.1.0",

src/templates/core/CancelablePromise.hbs

@@ -0,0 +1,10 @@
+export class CancelablePromise<T> extends Promise<T> {
+
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void) {
+        super(executor);
+    }
+
+    public cancel() {
+        //
+    }
+}

src/templates/core/fetch/request.hbs

@@ -3,6 +3,7 @@
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
+import type { CancelablePromise } from './CancelablePromise';
 import { OpenAPI } from './OpenAPI';
 
 {{>functions/isDefined}}
@@ -53,9 +54,10 @@ import { OpenAPI } from './OpenAPI';
  * @returns ApiResult
  * @throws ApiError
  */
-export async function request(options: ApiRequestOptions): Promise<ApiResult> {
+export async function request(options: ApiRequestOptions): CancelablePromise<ApiResult> {
+    const controller = new AbortController();
     const url = getUrl(options);
-    const response = await sendRequest(options, url);
+    const response = await sendRequest(options, url, controller.signal);
     const responseBody = await getResponseBody(response);
     const responseHeader = getResponseHeader(response, options.responseHeader);
 

src/templates/core/fetch/sendRequest.hbs

@@ -1,8 +1,9 @@
-async function sendRequest(options: ApiRequestOptions, url: string): Promise<Response> {
+async function sendRequest(options: ApiRequestOptions, url: string, signal: AbortSignal): Promise<Response> {
     const request: RequestInit = {
         method: options.method,
         headers: await getHeaders(options),
         body: getRequestBody(options),
+        signal,
     };
     if (OpenAPI.WITH_CREDENTIALS) {
         request.credentials = 'include';

src/templates/core/node/request.hbs

@@ -1,12 +1,14 @@
 {{>header}}
 
+import { AbortController, AbortSignal } from 'abort-controller';
 import FormData from 'form-data';
 import fetch, { BodyInit, Headers, RequestInit, Response } from 'node-fetch';
 import { types } from 'util';
 
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
+import type { CancelablePromise } from './CancelablePromise';
 import { OpenAPI } from './OpenAPI';
 
 {{>functions/isDefined}}
@@ -57,9 +59,10 @@ import { OpenAPI } from './OpenAPI';
  * @returns ApiResult
  * @throws ApiError
  */
-export async function request(options: ApiRequestOptions): Promise<ApiResult> {
+export async function request(options: ApiRequestOptions): CancelablePromise<ApiResult> {
+    const controller = new AbortController();
     const url = getUrl(options);
-    const response = await sendRequest(options, url);
+    const response = await sendRequest(options, url, controller.signal);
     const responseBody = await getResponseBody(response);
     const responseHeader = getResponseHeader(response, options.responseHeader);
 

src/templates/core/node/sendRequest.hbs

@@ -1,8 +1,9 @@
-async function sendRequest(options: ApiRequestOptions, url: string): Promise<Response> {
+async function sendRequest(options: ApiRequestOptions, url: string, signal: AbortSignal): Promise<Response> {
     const request: RequestInit = {
         method: options.method,
         headers: await getHeaders(options),
         body: getRequestBody(options),
+        signal,
     };
     return await fetch(url, request);
 }

src/templates/core/xhr/request.hbs

@@ -3,6 +3,7 @@
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
+import type { CancelablePromise } from './CancelablePromise';
 import { OpenAPI } from './OpenAPI';
 
 {{>functions/isDefined}}
@@ -56,7 +57,7 @@ import { OpenAPI } from './OpenAPI';
  * @returns ApiResult
  * @throws ApiError
  */
-export async function request(options: ApiRequestOptions): Promise<ApiResult> {
+export async function request(options: ApiRequestOptions): CancelablePromise<ApiResult> {
     const url = getUrl(options);
     const response = await sendRequest(options, url);
     const responseBody = getResponseBody(response);

src/templates/exportService.hbs

@@ -5,6 +5,7 @@
 import type { {{{this}}} } from '../models/{{{this}}}';
 {{/each}}
 {{/if}}
+import type { CancelablePromise } from '../core/CancelablePromise';
 import { request as __request } from '../core/request';
 {{#if @root.useVersion}}
 import { OpenAPI } from '../core/OpenAPI';
@@ -35,7 +36,7 @@ export class {{{name}}} {
     {{/each}}
      * @throws ApiError
      */
-    public static async {{{name}}}({{>parameters}}): Promise<{{>result}}> {
+    public static async {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
         const result = await __request({
             method: '{{{method}}}',
             path: `{{{path}}}`,

src/templates/index.hbs

@@ -2,6 +2,7 @@
 {{#if @root.exportCore}}
 
 export { ApiError } from './core/ApiError';
+export type { CancelablePromise } from './core/CancelablePromise';
 export { OpenAPI } from './core/OpenAPI';
 {{/if}}
 {{#if @root.exportModels}}

src/utils/registerHandlebarTemplates.ts

@@ -28,6 +28,7 @@ import nodeGetResponseHeader from '../templates/core/node/getResponseHeader.hbs'
 import nodeRequest from '../templates/core/node/request.hbs';
 import nodeSendRequest from '../templates/core/node/sendRequest.hbs';
 import templateCoreSettings from '../templates/core/OpenAPI.hbs';
+import templateCancelablePromise from '../templates/core/CancelablePromise.hbs';
 import templateCoreRequest from '../templates/core/request.hbs';
 import xhrGetHeaders from '../templates/core/xhr/getHeaders.hbs';
 import xhrGetRequestBody from '../templates/core/xhr/getRequestBody.hbs';
@@ -80,6 +81,7 @@ export interface Templates {
         apiError: Handlebars.TemplateDelegate;
         apiRequestOptions: Handlebars.TemplateDelegate;
         apiResult: Handlebars.TemplateDelegate;
+        cancelablePromise: Handlebars.TemplateDelegate;
         request: Handlebars.TemplateDelegate;
     };
 }
@@ -104,6 +106,7 @@ export function registerHandlebarTemplates(root: { httpClient: HttpClient; useOp
             apiError: Handlebars.template(templateCoreApiError),
             apiRequestOptions: Handlebars.template(templateCoreApiRequestOptions),
             apiResult: Handlebars.template(templateCoreApiResult),
+            cancelablePromise: Handlebars.template(templateCancelablePromise),
             request: Handlebars.template(templateCoreRequest),
         },
     };