@fatcherjs/middleware-aborter 1.8.0 → 2.0.0

package/README.md

@@ -2,6 +2,12 @@
 
 A middleware for aborting fatcher request.
 
+[![codecov](https://codecov.io/gh/fatcherjs/middleware-aborter/branch/master/graph/badge.svg?token=TFKUGW6YNI)](https://codecov.io/gh/fatcherjs/middleware-aborter)
+[![install size](https://packagephobia.com/badge?p=@fatcherjs/middleware-aborter)](https://packagephobia.com/result?p=@fatcherjs/middleware-aborter)
+<a href="https://unpkg.com/@fatcherjs/middleware-aborter"><img alt="Size" src="https://img.badgesize.io/https://unpkg.com/@fatcherjs/middleware-aborter"></a>
+<a href="https://npmjs.com/package/@fatcherjs/middleware-aborter"><img src="https://img.shields.io/npm/v/@fatcherjs/middleware-aborter.svg" alt="npm package"></a>
+<a href="https://github.com/fatcherjs/middleware-aborter/actions/workflows/ci.yml"><img src="https://github.com/fatcherjs/middleware-aborter/actions/workflows/ci.yml/badge.svg?branch=master" alt="build status"></a>
+
 ## Install
 
 ### NPM
@@ -19,8 +25,8 @@ A middleware for aborting fatcher request.
 ## Usage
 
 ```ts
-import { aborter } from '@fatcherjs/middleware-aborter';
-import { fatcher, isAbortError } from 'fatcher';
+import { aborter, isAbortError } from '@fatcherjs/middleware-aborter';
+import { fatcher } from 'fatcher';
 
 fatcher({
     url: '/bar/foo',

package/dist/aborter.d.ts

@@ -1,13 +1,20 @@
-import { Context, Middleware } from 'fatcher';
+import * as fatcher from 'fatcher';
+import { Context } 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;
+    abort: () => void;
     signal: AbortSignal;
 };
 declare type RoadMap = Record<string, RoadSign[]>;
+interface AborterMiddlewareContext extends Readonly<Context> {
+    /**
+     * Provides with aborter
+     *
+     * @require `@fatcherjs/middleware-aborter`
+     */
+    abort: () => void;
+    signal: AbortSignal;
+}
 interface AborterOptions {
     /**
      * Request timeout
@@ -22,7 +29,7 @@ interface AborterOptions {
      *
      * @default null
      */
-    onAbort?: AbortEventHandler | null;
+    onAbort?: (() => void) | null;
     /**
      * Request concurrency restrictions
      *
@@ -40,7 +47,7 @@ interface AborterOptions {
  * @param options
  * @returns
  */
-declare function aborter(options?: AborterOptions): Middleware;
+declare function aborter(options?: AborterOptions): fatcher.Middleware[];
 
 /**
  * Confirm an error whether is DOMException
@@ -49,4 +56,4 @@ declare function aborter(options?: AborterOptions): Middleware;
  */
 declare function isAbortError(error: unknown): error is DOMException;
 
-export { AbortEventHandler, AbortReason, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };
+export { AborterMiddlewareContext, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };

package/dist/aborter.esm.js

@@ -1,51 +1,68 @@
+import { defineMiddleware } from 'fatcher';
+
 const roadMap = {};
 function aborter(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 { 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 baseAborter = defineMiddleware(async (context, next) => {
+    const abortController = new AbortController();
+    if (onAbort) {
+      abortController.signal.addEventListener("abort", () => onAbort());
+    }
+    return next({
+      signal: abortController.signal,
+      abort: abortController.abort.bind(abortController)
+    });
+  }, "fatcher-middleware-aborter");
+  const timeoutAborter = defineMiddleware(async (context, next) => {
+    const { signal, abort } = context;
+    let timer = setTimeout(abort, _timeout);
+    const release = () => {
+      if (timer) {
+        clearTimeout(timer);
       }
-      (_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;
+      timer = null;
+    };
+    signal.addEventListener("abort", release);
+    const result = await next();
+    release();
+    return result;
+  }, "fatcher-middleware-timeout-aborter");
+  const concurrencyAborter = defineMiddleware(async (context, next) => {
+    const { signal, abort } = context;
+    const group = groupBy ? groupBy(context) : `${context.url}_${context.method}_${new URLSearchParams(context.params)}`;
+    if (roadMap[group] && roadMap[group].length) {
+      roadMap[group].forEach((item) => item.abort());
+    }
+    if (!roadMap[group]) {
+      roadMap[group] = [];
     }
-  };
+    roadMap[group].push({ abort, signal });
+    const release = () => {
+      roadMap[group] = roadMap[group].filter((item) => {
+        return item.signal !== signal;
+      });
+      if (!roadMap[group].length) {
+        delete roadMap[group];
+      }
+    };
+    signal.addEventListener("abort", release);
+    const result = await next();
+    release();
+    return result;
+  }, "fatcher-middleware-concurrency-aborter");
+  const middlewares = [baseAborter];
+  if (_timeout) {
+    middlewares.push(timeoutAborter);
+  }
+  if (concurrency) {
+    middlewares.push(concurrencyAborter);
+  }
+  return middlewares;
 }
 
 function isAbortError(error) {

package/dist/aborter.js

@@ -2,54 +2,71 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var fatcher = require('fatcher');
+
 const roadMap = {};
 function aborter(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 { 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 baseAborter = fatcher.defineMiddleware(async (context, next) => {
+    const abortController = new AbortController();
+    if (onAbort) {
+      abortController.signal.addEventListener("abort", () => onAbort());
+    }
+    return next({
+      signal: abortController.signal,
+      abort: abortController.abort.bind(abortController)
+    });
+  }, "fatcher-middleware-aborter");
+  const timeoutAborter = fatcher.defineMiddleware(async (context, next) => {
+    const { signal, abort } = context;
+    let timer = setTimeout(abort, _timeout);
+    const release = () => {
+      if (timer) {
+        clearTimeout(timer);
       }
-      (_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;
+      timer = null;
+    };
+    signal.addEventListener("abort", release);
+    const result = await next();
+    release();
+    return result;
+  }, "fatcher-middleware-timeout-aborter");
+  const concurrencyAborter = fatcher.defineMiddleware(async (context, next) => {
+    const { signal, abort } = context;
+    const group = groupBy ? groupBy(context) : `${context.url}_${context.method}_${new URLSearchParams(context.params)}`;
+    if (roadMap[group] && roadMap[group].length) {
+      roadMap[group].forEach((item) => item.abort());
+    }
+    if (!roadMap[group]) {
+      roadMap[group] = [];
     }
-  };
+    roadMap[group].push({ abort, signal });
+    const release = () => {
+      roadMap[group] = roadMap[group].filter((item) => {
+        return item.signal !== signal;
+      });
+      if (!roadMap[group].length) {
+        delete roadMap[group];
+      }
+    };
+    signal.addEventListener("abort", release);
+    const result = await next();
+    release();
+    return result;
+  }, "fatcher-middleware-concurrency-aborter");
+  const middlewares = [baseAborter];
+  if (_timeout) {
+    middlewares.push(timeoutAborter);
+  }
+  if (concurrency) {
+    middlewares.push(concurrencyAborter);
+  }
+  return middlewares;
 }
 
 function isAbortError(error) {

package/dist/aborter.min.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "version": "1.8.0",
+  "version": "2.0.0",
   "main": "dist/aborter.js",
   "module": "dist/aborter.esm.js",
   "browser": "dist/aborter.min.js",
@@ -14,12 +14,36 @@
     "type": "git",
     "url": "git+https://github.com/fatcherjs/fatcher.git"
   },
-  "dependencies": {
-    "fatcher": "^1.8.0"
+  "devDependencies": {
+    "@fansy/eslint-config": "^1.1.0",
+    "@fansy/prettier-config": "^1.0.0",
+    "@jest/types": "^29.1.2",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@types/jest": "^29.1.2",
+    "@types/node": "^18.8.5",
+    "esbuild": "^0.15.10",
+    "fatcher": "^2.0.0",
+    "jest": "^29.1.2",
+    "jest-fetch-mock": "^3.0.3",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-dts": "^4.2.3",
+    "rollup-plugin-esbuild": "^4.10.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  },
+  "peerDependencies": {
+    "fatcher": "^2.0.0"
   },
   "scripts": {
     "dev": "rimraf dist && rollup -c rollup.config.ts -w",
     "build": "rimraf dist && rollup -c rollup.config.ts",
-    "deploy": "pnpm run build && pnpm publish --no-git-check"
+    "deploy": "pnpm run build && pnpm publish --no-git-check",
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "eslint": "eslint .",
+    "tsc": "tsc --noEmit",
+    "ci": "npm run eslint && npm run tsc && npm run build && npm run test"
   }
 }