@fatcherjs/middleware-aborter 1.3.0 → 1.5.0

package/README.md

@@ -67,6 +67,22 @@ Aborted request will throw a DOMException which can use `isAbortError` to confir
 
 A callback when aborting this request.
 
+### concurrency
+
+-   Type: `boolean`
+-   DefaultValue: `false`
+-   Description:
+
+Request concurrency restrictions
+
+### groupBy
+
+-   Type: `(context: Readonly<Context>) => string;`
+-   DefaultValue: `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`
+-   Description:
+
+Concurrency key.
+
 ## License
 
 [MIT](https://github.com/fatcherjs/fatcher/blob/master/LICENSE)

package/dist/aborter.d.ts

@@ -1,5 +1,13 @@
-import { Middleware } from 'fatcher';
+import { Context, Middleware } from 'fatcher';
 
+declare type AbortReason = 'concurrency' | 'timeout' | 'manual';
+declare type AbortEventHandler = (type: AbortReason) => void;
+declare type RoadSign = {
+    abort: (type: AbortReason) => void;
+    timer: NodeJS.Timeout | null;
+    signal: AbortSignal;
+};
+declare type RoadMap = Record<string, RoadSign[]>;
 interface AborterOptions {
     /**
      * Request timeout
@@ -14,7 +22,17 @@ interface AborterOptions {
      *
      * @default null
      */
-    onAbort?: (() => void) | null;
+    onAbort?: AbortEventHandler | null;
+    /**
+     * Request concurrency restrictions
+     *
+     * @default false
+     */
+    concurrency?: boolean;
+    /**
+     * Concurrency key.
+     */
+    groupBy?: (context: Readonly<Context>) => string;
 }
 
 /**
@@ -24,4 +42,11 @@ interface AborterOptions {
  */
 declare function aborter(options?: AborterOptions): Middleware;
 
-export { AborterOptions, aborter };
+/**
+ * Confirm an error whether is DOMException
+ * @param error
+ * @returns
+ */
+declare function isAbortError(error: unknown): error is DOMException;
+
+export { AbortEventHandler, AbortReason, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };

package/dist/aborter.esm.js

@@ -1,29 +1,55 @@
+const roadMap = {};
 function aborter(options = {}) {
-  const { timeout = 0, onAbort = null } = options;
+  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
   let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout <= 0) {
+  if (isNaN(timeout) || ~~timeout < 0) {
     console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
     _timeout = 0;
   }
   return {
     name: "fatcher-middleware-aborter",
     async use(context, next) {
+      var _a, _b, _c;
       const abortController = new AbortController();
-      const requestTask = next({
-        signal: abortController.signal
-      });
-      if (!_timeout) {
-        return requestTask;
+      const { abort, signal } = abortController;
+      const requestTask = next({ signal });
+      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
+      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
+        roadMap[group].forEach((item) => {
+          item.abort("concurrency");
+        });
       }
-      const timer = setTimeout(() => {
-        abortController.abort();
-        onAbort == null ? void 0 : onAbort();
-      }, _timeout);
-      const response = await requestTask;
-      clearTimeout(timer);
-      return response;
+      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
+      const trigger = (reason) => {
+        abort.call(abortController);
+        onAbort == null ? void 0 : onAbort(reason);
+      };
+      roadMap[group].push({
+        abort: trigger,
+        timer: _timeout ? setTimeout(() => trigger("timeout"), _timeout) : null,
+        signal
+      });
+      signal.addEventListener("abort", () => {
+        roadMap[group] = roadMap[group].filter((item) => {
+          if (item.signal === signal) {
+            if (item.timer) {
+              clearTimeout(item.timer);
+            }
+            return false;
+          }
+          return true;
+        });
+        if (!roadMap[group].length) {
+          delete roadMap[group];
+        }
+      });
+      return requestTask;
     }
   };
 }
 
-export { aborter };
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
+export { aborter, isAbortError };

package/dist/aborter.js

@@ -2,32 +2,59 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const roadMap = {};
 function aborter(options = {}) {
-  const { timeout = 0, onAbort = null } = options;
+  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
   let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout <= 0) {
+  if (isNaN(timeout) || ~~timeout < 0) {
     console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
     _timeout = 0;
   }
   return {
     name: "fatcher-middleware-aborter",
     async use(context, next) {
+      var _a, _b, _c;
       const abortController = new AbortController();
-      const requestTask = next({
-        signal: abortController.signal
-      });
-      if (!_timeout) {
-        return requestTask;
+      const { abort, signal } = abortController;
+      const requestTask = next({ signal });
+      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
+      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
+        roadMap[group].forEach((item) => {
+          item.abort("concurrency");
+        });
       }
-      const timer = setTimeout(() => {
-        abortController.abort();
-        onAbort == null ? void 0 : onAbort();
-      }, _timeout);
-      const response = await requestTask;
-      clearTimeout(timer);
-      return response;
+      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
+      const trigger = (reason) => {
+        abort.call(abortController);
+        onAbort == null ? void 0 : onAbort(reason);
+      };
+      roadMap[group].push({
+        abort: trigger,
+        timer: _timeout ? setTimeout(() => trigger("timeout"), _timeout) : null,
+        signal
+      });
+      signal.addEventListener("abort", () => {
+        roadMap[group] = roadMap[group].filter((item) => {
+          if (item.signal === signal) {
+            if (item.timer) {
+              clearTimeout(item.timer);
+            }
+            return false;
+          }
+          return true;
+        });
+        if (!roadMap[group].length) {
+          delete roadMap[group];
+        }
+      });
+      return requestTask;
     }
   };
 }
 
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
 exports.aborter = aborter;
+exports.isAbortError = isAbortError;

package/dist/aborter.min.js

@@ -1 +1 @@
-(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.FatcherMiddlewareAborter={}))})(this,function(e){"use strict";function t(a={}){const{timeout:o=0,onAbort:r=null}=a;let n=o;return(isNaN(o)||~~o<=0)&&(console.warn("[fatcher-middleware-aborter] Timeout is not a valid number."),n=0),{name:"fatcher-middleware-aborter",async use(c,u){const i=new AbortController,s=u({signal:i.signal});if(!n)return s;const l=setTimeout(()=>{i.abort(),r?.()},n),d=await s;return clearTimeout(l),d}}}e.aborter=t,Object.defineProperty(e,"__esModule",{value:!0})});
+(function(t,e){typeof exports=="object"&&typeof module!="undefined"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(t=typeof globalThis!="undefined"?globalThis:t||self,e(t.FatcherMiddlewareAborter={}))})(this,function(t){"use strict";const e={};function p(o={}){const{timeout:u=0,onAbort:s=null,concurrency:_,groupBy:c}=o;let l=u;return(isNaN(u)||~~u<0)&&(console.warn("[fatcher-middleware-aborter] Timeout is not a valid number."),l=0),{name:"fatcher-middleware-aborter",async use(i,v){var d,f,b;const m=new AbortController,{abort:y,signal:a}=m,w=v({signal:a}),r=(d=c==null?void 0:c(i))!=null?d:`${i.url}_${i.method}_${new URLSearchParams(i.params).toString()}`;((f=e[r])==null?void 0:f.length)&&_&&e[r].forEach(n=>{n.abort("concurrency")}),(b=e[r])!=null||(e[r]=[]);const h=n=>{y.call(m),s==null||s(n)};return e[r].push({abort:h,timer:l?setTimeout(()=>h("timeout"),l):null,signal:a}),a.addEventListener("abort",()=>{e[r]=e[r].filter(n=>n.signal===a?(n.timer&&clearTimeout(n.timer),!1):!0),e[r].length||delete e[r]}),w}}}function g(o){return o instanceof DOMException&&o.name==="AbortError"}t.aborter=p,t.isAbortError=g,Object.defineProperty(t,"__esModule",{value:!0})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "main": "dist/aborter.js",
   "module": "dist/aborter.esm.js",
   "browser": "dist/aborter.min.js",