Add cancellation support

api.d.ts

@@ -12,6 +12,7 @@ export interface XHROptions {
     data?: string;
     strictSSL?: boolean;
     followRedirects?: number;
+    token?: import("vscode-jsonrpc").CancellationToken;
     agent?: HttpProxyAgent | HttpsProxyAgent;
 }
 
@@ -39,4 +40,4 @@ export type Headers = { [header: string]: string | string[] | undefined };
 export declare const configure: XHRConfigure;
 export declare const xhr: XHRRequest;
 
-export declare function getErrorStatusDescription(status: number): string;
+export declare function getErrorStatusDescription(status: number): string;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "request-light",
-  "version": "0.5.8",
+  "version": "0.6.0",
   "description": "Lightweight request library. Promise based, with proxy support.",
   "main": "./lib/node/main.js",
   "browser": {
@@ -20,6 +20,7 @@
     "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.0",
     "vscode-nls": "^5.0.0",
+    "vscode-jsonrpc": "^5.0.0",
     "typescript": "^4.5.4",
     "@types/node": "13.7.6",
     "rimraf": "^3.0.2",

src/browser/main.ts

@@ -8,47 +8,58 @@ import { XHRRequest, XHRConfigure, XHROptions, XHRResponse } from '../../api';
 export const configure: XHRConfigure = (_proxyUrl: string, _strictSSL: boolean) => { };
 
 export const xhr: XHRRequest = async (options: XHROptions): Promise<XHRResponse> => {
-	const requestHeaders = new Headers();
-	if (options.headers) {
-		for (const key in options.headers) {
-			const value = options.headers[key];
-			if (Array.isArray(value)) {
-				value.forEach(v => requestHeaders.set(key, v))
-			} else {
-				requestHeaders.set(key, value);
-			}
-		}
-	}
-	if (options.user && options.password) {
-		requestHeaders.set('Authorization', 'Basic ' + btoa(options.user + ":" + options.password));
-	}
-	const requestInit: RequestInit = {
-		method: options.type,
-		redirect: options.followRedirects > 0 ? 'follow' : 'manual',
-		mode: 'cors',
-		headers: requestHeaders
-	};
-	if (options.data) {
-		requestInit.body = options.data;
-	}
+    const requestHeaders = new Headers();
+    if (options.headers) {
+        for (const key in options.headers) {
+            const value = options.headers[key];
+            if (Array.isArray(value)) {
+                value.forEach(v => requestHeaders.set(key, v))
+            } else {
+                requestHeaders.set(key, value);
+            }
+        }
+    }
+    if (options.user && options.password) {
+        requestHeaders.set('Authorization', 'Basic ' + btoa(options.user + ":" + options.password));
+    }
+    const requestInit: RequestInit = {
+        method: options.type,
+        redirect: options.followRedirects > 0 ? 'follow' : 'manual',
+        mode: 'cors',
+        headers: requestHeaders
+    };
+    if (options.data) {
+        requestInit.body = options.data;
+    }
+    if (options.token) {
+        const controller = new AbortController();
+        if (options.token.isCancellationRequested) {
+            // see https://github.com/microsoft/TypeScript/issues/49609
+            (controller as any).abort();
+        }
+        options.token.onCancellationRequested(() => {
+            (controller as any).abort();
+        });
+        requestInit.signal = controller.signal;
+    }
 
-	const requestInfo = new Request(options.url, requestInit);
-	const response = await fetch(requestInfo);
-	const resposeHeaders: any = {};
-	response.headers.forEach((value, key) => {
-		resposeHeaders[key] = value;
-	});
+    const requestInfo = new Request(options.url, requestInit);
+    const response = await fetch(requestInfo);
+    const resposeHeaders: any = {};
+    response.headers.forEach((value, key) => {
+        resposeHeaders[key] = value;
+    });
 
-	const buffer = await response.arrayBuffer();
+    const buffer = await response.arrayBuffer();
 
-	return new class {
-		get responseText() { return new TextDecoder().decode(buffer); };
-		get body() { return new Uint8Array(buffer) };
-		readonly status = response.status;
-		readonly headers = resposeHeaders;
-	}
+    return new class {
+        get responseText() { return new TextDecoder().decode(buffer); };
+        get body() { return new Uint8Array(buffer) };
+        readonly status = response.status;
+        readonly headers = resposeHeaders;
+    }
 }
 
 export function getErrorStatusDescription(status: number): string {
-	return String(status);
-}
+    return String(status);
+}