Add support for passing an AbortSignal to a request (#59)

* chore: pass through abort signal to request * chore: add abort signal test * chore: satisfy linter * chore: satisfy linter
haoliangyu · Mar 12, 2024 · a1853ac · a1853ac
1 parent 1871f96
commit a1853ac
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 10 deletions.
diff --git a/packages/features/src/features.ts b/packages/features/src/features.ts
@@ -55,6 +55,7 @@ export class FeatureService extends Service {
     const result: IGetCollectionsResponse = await request({
       url,
       params: options.params,
+      signal: options.signal,
     });
     return result;
   }
@@ -69,7 +70,11 @@ export class FeatureService extends Service {
     options: IServiceRequestOptions = {}
   ): Promise<ICollection> {
     const url: string = `${this.baseUrl}/collections/${collectionId}`;
-    const result: ICollection = await request({ url, params: options.params });
+    const result: ICollection = await request({
+      url,
+      params: options.params,
+      signal: options.signal,
+    });
     return result;
   }
 
@@ -83,7 +88,11 @@ export class FeatureService extends Service {
     options: IServiceRequestOptions = {}
   ): Promise<IQueryables> {
     const url: string = `${this.baseUrl}/collections/${collectionId}/queryables`;
-    const result: IQueryables = await request({ url, params: options.params });
+    const result: IQueryables = await request({
+      url,
+      params: options.params,
+      signal: options.signal,
+    });
     return result;
   }
 
@@ -101,6 +110,7 @@ export class FeatureService extends Service {
     const result: IGetFeaturesResponse = await request({
       url,
       params,
+      signal: options.signal,
     });
     return result;
   }
@@ -119,6 +129,7 @@ export class FeatureService extends Service {
     const result: IGetFeaturesResponse = await request({
       url,
       params,
+      signal: options.signal,
       method: 'POST',
       headers: { 'content-type': 'application/json' },
     });
@@ -138,7 +149,11 @@ export class FeatureService extends Service {
   ): Promise<IFeature> {
     const params = toGetFeatureRequestParams(options);
     const url: string = `${this.baseUrl}/collections/${collectionId}/items/${featureId}`;
-    const result: IFeature = await request({ url, params });
+    const result: IFeature = await request({
+      url,
+      params,
+      signal: options.signal,
+    });
     return result;
   }
 }

diff --git a/packages/processes/src/processes.ts b/packages/processes/src/processes.ts
@@ -44,7 +44,11 @@ export class ProcessesService extends Service {
     options: IServiceRequestOptions = {}
   ): Promise<IProcess> {
     const url: string = `${this.baseUrl}/processes/${processId}`;
-    const result: IProcess = await request({ url, params: options.params });
+    const result: IProcess = await request({
+      url,
+      signal: options.signal,
+      params: options.params,
+    });
     return result;
   }
 
@@ -77,7 +81,13 @@ export class ProcessesService extends Service {
       headers['prefer'] = 'respond-async';
     }
 
-    const result = await request({ url, headers, params, method: 'POST' });
+    const result = await request({
+      url,
+      headers,
+      params,
+      signal: options.signal,
+      method: 'POST',
+    });
     return result as TExecuteProcessResponse<T>;
   }
 
@@ -97,7 +107,11 @@ export class ProcessesService extends Service {
     if (options.datetime) {
       params.datetime = stringifyDatetime(options.datetime);
     }
-    const result: IJobsResponse = await request({ url, params });
+    const result: IJobsResponse = await request({
+      url,
+      params,
+      signal: options.signal,
+    });
     return result;
   }
 
@@ -112,7 +126,11 @@ export class ProcessesService extends Service {
   ): Promise<IJobInfo> {
     const url: string = `${this.baseUrl}/jobs/${jobId}`;
     const params: IRequestParams = Object.assign({}, options.params);
-    const result: IJobInfo = await request({ url, params });
+    const result: IJobInfo = await request({
+      url,
+      params,
+      signal: options.signal,
+    });
     return result;
   }
 
@@ -130,7 +148,11 @@ export class ProcessesService extends Service {
   ): Promise<TJobResult> {
     const url: string = `${this.baseUrl}/jobs/${jobId}`;
     const params: IRequestParams = Object.assign({}, options.params);
-    const result: TJobResult = await request({ url, params });
+    const result: TJobResult = await request({
+      url,
+      params,
+      signal: options.signal,
+    });
     return result;
   }
 
@@ -145,7 +167,12 @@ export class ProcessesService extends Service {
   ): Promise<IJobInfo> {
     const url: string = `${this.baseUrl}/jobs/${jobId}`;
     const params: IRequestParams = Object.assign({}, options.params);
-    const result: IJobInfo = await request({ url, params, method: 'DELETE' });
+    const result: IJobInfo = await request({
+      url,
+      params,
+      signal: options.signal,
+      method: 'DELETE',
+    });
     return result;
   }
 }

diff --git a/packages/shared/src/request.ts b/packages/shared/src/request.ts
@@ -61,18 +61,26 @@ function toJSON(params: IRequestParams) {
 const getRequestArgsMap: Record<TRequestMethods, TRequestArgsGetter> = {
   GET: ({
     url: baseUrl,
+    signal,
     headers = {},
     params = {},
   }: IRequestOptions): TRequestArgs => {
     const url = `${baseUrl}?${toSearchParams(params).toString()}`;
     const init = {
+      signal,
       headers,
       method: 'GET',
     };
     return { url, init };
   },
-  POST: ({ url, params = {}, headers = {} }: IRequestOptions): TRequestArgs => {
+  POST: ({
+    url,
+    signal,
+    params = {},
+    headers = {},
+  }: IRequestOptions): TRequestArgs => {
     const init = {
+      signal,
       headers,
       method: 'POST',
       body: toBody(params, headers),
@@ -81,11 +89,13 @@ const getRequestArgsMap: Record<TRequestMethods, TRequestArgsGetter> = {
   },
   DELETE: ({
     url: baseUrl,
+    signal,
     params = {},
     headers = {},
   }: IRequestOptions): TRequestArgs => {
     const url = `${baseUrl}?${toSearchParams(params).toString()}`;
     const init = {
+      signal,
       headers,
       method: 'DELETE',
     };
@@ -121,4 +131,5 @@ export interface IRequestOptions {
   params?: IRequestParams;
   headers?: IRequestHeaders;
   method?: TRequestMethods;
+  signal?: AbortSignal;
 }
diff --git a/packages/shared/src/service.ts b/packages/shared/src/service.ts
@@ -33,6 +33,10 @@ export interface IServiceConfig {
  * request options
  */
 export interface IServiceRequestOptions {
+  /**
+   * abort signal passed to fetch.
+   */
+  signal?: AbortSignal;
   /**
    * additional request parameters
    */

diff --git a/packages/shared/test/unit/request.test.ts b/packages/shared/test/unit/request.test.ts
@@ -147,3 +147,20 @@ test('request() should not read body of DELETE request when response status is 2
   });
   expect(result).toBeUndefined();
 });
+
+test('request() should throw AbortError when signal is aborted', async () => {
+  mockRequest('https://www.example.com?f=json', {
+    success: true,
+  });
+
+  const controller = new AbortController();
+  controller.abort();
+
+  expect(
+    async () =>
+      await request({
+        url: 'https://www.example.com',
+        signal: controller.signal,
+      })
+  ).rejects.toThrow(/abort/i);
+});