Merge pull request #125 from groupon/abort

feat: support AbortController signal

.github/workflows/node.js.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x] # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node-version: [12.x, 14.x, 16.x] # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
     - uses: actions/checkout@v2

API.md

@@ -57,6 +57,7 @@ const { fetch } = require('gofer');
 * `keepAlive`: if set to `true`, enables HTTP keep-alive
   ⚠ Enabling `keepAlive` can lead to `MaxListenersExceededWarning: Possible EventEmitter memory leak detected.` warnings.
 * `captureAsyncStack`: Extends error trace with stack trace before call. (Default: `false`) **Capturing the stack is expensive! Set only for debugging purposes**
+* `signal` - AbortController signal (Node 15+)
 
 [basicauth]: https://en.wikipedia.org/wiki/Basic_access_authentication
 [tls]: https://nodejs.org/api/tls.html#tls_new_tls_tlssocket_socket_options

lib/fetch.js

@@ -215,6 +215,7 @@ function fetchUrlObj(urlObj, options) {
   updateSearch(urlObj.searchParams, qs);
 
   const method = options.method || 'GET';
+
   return request({
     agent,
     protocol: urlObj.protocol,
@@ -241,6 +242,7 @@ function fetchUrlObj(urlObj, options) {
     methodName: options.methodName || method.toLowerCase(),
     pathParams: options.pathParams,
     captureAsyncStack: options.captureAsyncStack,
+    signal: options.signal,
   });
 }
 

lib/url.js

@@ -33,15 +33,15 @@
 'use strict';
 
 /**
- * @typedef {string | QSVal[] | { [name: string]: QSVal }} QSVal
- *
  * @param {URLSearchParams} query
- * @param {{ [name: string]: QSVal }} qs
+ * @param {Record<string, any> | URLSearchParams} qs
  * @param {Array<string>} [path]
  */
 function updateSearch(query, qs, path = []) {
   if (qs instanceof URLSearchParams) {
-    for (const [key, val] of qs.entries()) query.append(key, val);
+    for (const [key, val] of qs.entries()) {
+      query.append(key, val);
+    }
     return query;
   }
 
@@ -58,8 +58,8 @@ function updateSearch(query, qs, path = []) {
 exports.updateSearch = updateSearch;
 
 /**
- * @param {string} pathname
- * @param {{ [name: string]: string }} pathParams
+ * @param {URL.pathname} pathname
+ * @param {Record<string, string>} pathParams
  */
 function replacePathParams(pathname, pathParams) {
   pathParams = pathParams || {};
@@ -78,6 +78,6 @@ function replacePathParams(pathname, pathParams) {
     return encodeURIComponent(value);
   }
 
-  return pathname.replace(/{(\w+)}|%7B(\w+)%7D/g, onPlaceHolder);
+  return (pathname || '').replace(/{(\w+)}|%7B(\w+)%7D/g, onPlaceHolder);
 }
 exports.replacePathParams = replacePathParams;