Add AbortSignal support

src/RequestSender.ts

@@ -590,6 +590,7 @@ export class RequestSender {
         headers: Object.assign({}, headers),
         body: requestData,
         protocol: this._stripe.getApiField('protocol'),
+        signal: options.settings.signal,
       };
 
       authenticator(request)
@@ -604,7 +605,8 @@ export class RequestSender {
               request.headers,
               request.body,
               request.protocol,
-              timeout
+              timeout,
+              request.signal
             );
 
           const requestStartTime = Date.now();

src/Types.d.ts

@@ -48,6 +48,7 @@ export type StripeRequest = {
   headers: RequestHeaders;
   body: string;
   protocol: string;
+  signal?: AbortSignal;
 };
 export type RequestAuthenticator = (request: StripeRequest) => Promise<void>;
 export type RequestCallback = (
@@ -84,7 +85,11 @@ export type RequestOpts = {
   settings: RequestSettings;
   usage: Array<string>;
 };
-export type RequestSettings = {timeout?: number; maxNetworkRetries?: number};
+export type RequestSettings = {
+  timeout?: number;
+  signal?: AbortSignal;
+  maxNetworkRetries?: number;
+};
 export type ResponseEvent = {
   api_version?: string;
   account?: string;

src/net/FetchHttpClient.ts

@@ -76,16 +76,24 @@ export class FetchHttpClient extends HttpClient implements HttpClientInterface {
     fetchFn: typeof fetch
   ): FetchWithTimeout {
     return async (url, init, timeout): Promise<Response> => {
+      let signal = init.signal;
+
       // Use AbortController because AbortSignal.timeout() was added later in Node v17.3.0, v16.14.0
       const abort = new AbortController();
+
+      // fallback to timeout
+      if (!signal) {
+        signal = abort.signal;
+      }
+
       let timeoutId: NodeJS.Timeout | null = setTimeout(() => {
         timeoutId = null;
         abort.abort(HttpClient.makeTimeoutError());
       }, timeout);
       try {
         return await fetchFn(url, {
           ...init,
-          signal: abort.signal,
+          signal,
         });
       } catch (err) {
         // Some implementations, like node-fetch, do not respect the reason passed to AbortController.abort()
@@ -117,7 +125,8 @@ export class FetchHttpClient extends HttpClient implements HttpClientInterface {
     headers: RequestHeaders,
     requestData: string,
     protocol: string,
-    timeout: number
+    timeout: number,
+    signal?: AbortSignal
   ): Promise<HttpClientResponseInterface> {
     const isInsecureConnection = protocol === 'http';
 
@@ -143,6 +152,7 @@ export class FetchHttpClient extends HttpClient implements HttpClientInterface {
         headers,
         // @ts-ignore
         body,
+        signal,
       },
       timeout
     );

src/net/HttpClient.ts

@@ -12,7 +12,8 @@ export interface HttpClientInterface {
     headers: RequestHeaders,
     requestData: string,
     protocol: string,
-    timeout: number
+    timeout: number,
+    signal?: AbortSignal
   ) => Promise<HttpClientResponseInterface>;
 }
 
@@ -50,7 +51,8 @@ export class HttpClient implements HttpClientInterface {
     headers: RequestHeaders,
     requestData: string,
     protocol: string,
-    timeout: number
+    timeout: number,
+    signal?: AbortSignal
   ): Promise<HttpClientResponseInterface> {
     throw new Error('makeRequest not implemented.');
   }

src/net/NodeHttpClient.ts

@@ -45,7 +45,8 @@ export class NodeHttpClient extends HttpClient {
     headers: RequestHeaders,
     requestData: string,
     protocol: string,
-    timeout: number
+    timeout: number,
+    signal?: AbortSignal
   ): Promise<HttpClientResponseInterface> {
     const isInsecureConnection = protocol === 'http';
 
@@ -64,6 +65,7 @@ export class NodeHttpClient extends HttpClient {
           agent,
           headers,
           ciphers: 'DEFAULT:!aNULL:!eNULL:!LOW:!EXPORT:!SSLv2:!MD5',
+          signal,
         });
 
         req.setTimeout(timeout, () => {

src/utils.ts

@@ -18,6 +18,7 @@ const OPTIONS_KEYS = [
   'apiVersion',
   'maxNetworkRetries',
   'timeout',
+  'signal',
   'host',
   'authenticator',
   'stripeContext',
@@ -26,6 +27,7 @@ const OPTIONS_KEYS = [
 
 type Settings = {
   timeout?: number;
+  signal?: AbortSignal;
   maxNetworkRetries?: number;
 };
 
@@ -189,6 +191,9 @@ export function getOptionsFromArgs(args: RequestArgs): Options {
       if (Number.isInteger(params.timeout)) {
         opts.settings.timeout = params.timeout as number;
       }
+      if (params.signal) {
+        opts.settings.signal = params.signal as AbortSignal;
+      }
       if (params.host) {
         opts.host = params.host as string;
       }

test/net/helpers.ts

@@ -55,7 +55,8 @@ export const createHttpClientTestSuite = (createHttpClientFn, extraTestsFn) => {
         options.headers || {},
         options.requestData,
         'http',
-        options.timeout || 1000
+        options.timeout || 1000,
+        options.signal
       );
     };
 
@@ -77,6 +78,21 @@ export const createHttpClientTestSuite = (createHttpClientFn, extraTestsFn) => {
         }
       });
 
+      it('rejects with a timeout error on abort signal', async () => {
+        setupNock().reply(200, 'hello, world!');
+
+        try {
+          const controller = new AbortController();
+
+          controller.abort();
+
+          await sendRequest({signal: controller.signal});
+          fail();
+        } catch (e) {
+          expect(e.code).to.be.equal('ETIMEDOUT');
+        }
+      });
+
       it('forwards any error', async () => {
         setupNock().replyWithError('sample error');
 

test/testUtils.ts

@@ -73,7 +73,8 @@ export const getStripeMockClient = (): StripeClient => {
       headers: RequestHeaders,
       requestData: string,
       _protocol: string,
-      timeout: number
+      timeout: number,
+      signal: AbortSignal
     ): Promise<HttpClientResponseInterface> {
       return super.makeRequest(
         process.env.STRIPE_MOCK_HOST || 'localhost',
@@ -83,7 +84,8 @@ export const getStripeMockClient = (): StripeClient => {
         headers,
         requestData,
         'http',
-        timeout
+        timeout,
+        signal
       );
     }
   }

test/utils.spec.ts

@@ -331,6 +331,23 @@ describe('utils', () => {
       });
     });
 
+    it('parses abort signal settings', () => {
+      const abort = new AbortController();
+      const args = [
+        {
+          signal: abort.signal,
+        },
+      ];
+
+      expect(utils.getOptionsFromArgs(args)).to.deep.equal({
+        host: null,
+        headers: {},
+        settings: {
+          signal: abort.signal,
+        },
+      });
+    });
+
     it('warns if the hash contains something that does not belong', (done) => {
       const args = [
         {foo: 'bar'},

types/lib.d.ts

@@ -147,6 +147,11 @@ declare module 'stripe' {
        */
       timeout?: number;
 
+      /**
+       * Specify an AbortSignal for this request.
+       */
+      signal?: AbortSignal;
+
       /**
        * Specify the host for this request.
        */

types/test/typescriptTest.ts

@@ -166,6 +166,15 @@ stripe = new Stripe('sk_test_123', {
       const rid: string = acct.lastResponse.requestId;
     }
   }
+
+  const abort = new AbortController();
+
+  await stripe.checkout.sessions.create(
+    {},
+    {
+      signal: abort.signal,
+    }
+  );
 })();
 
 const Foo = Stripe.StripeResource.extend({