apollo-link-timeout 4.0.0 → 5.0.1

package/README.md

@@ -12,7 +12,7 @@ yarn add apollo-link-timeout
 ```
 
 ## Usage
-```
+```javascript
 import ApolloLinkTimeout from 'apollo-link-timeout';
 import { createHttpLink } from 'apollo-link-http';
 import { ApolloClient } from 'apollo-client';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apollo-link-timeout",
-  "version": "4.0.0",
+  "version": "5.0.1",
   "description": "Abort requests that take longer than a specified timeout period",
   "peerDependencies": {
     "@apollo/client": "^3.0.0"
@@ -11,15 +11,21 @@
     "@types/node": "^10.3.4",
     "graphql": "^15.3.0",
     "graphql-tag": "^2.11.0",
-    "jest": "^23.1.0",
-    "react": "^16.13.1",
-    "ts-jest": "^22.4.6",
-    "ts-loader": "^4.4.1",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "^28.1.3",
+    "ts-jest": "^28.0.8",
     "tslint": "^5.8.0",
-    "typescript": "^2.9.2"
+    "typescript": "^4.9.5"
+  },
+  "main": "./lib/cjs/cjs.js",
+  "types": "./lib/types/timeoutLink.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/timeoutLink.js",
+      "require": "./lib/cjs/cjs.js",
+      "types": "./lib/types/timeoutLink.d.ts"
+    }
   },
-  "main": "lib/timeoutLink.js",
-  "types": "lib/timeoutLink.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/drcallaway/apollo-link-timeout"
@@ -28,10 +34,15 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > lib/cjs/package.json",
+    "build:esm": "tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > lib/esm/package.json && node scripts/fix_apollo_import.mjs",
+    "build:types": "tsc -p tsconfig.types.json",
     "lint": "tslint src/*.ts* src/**/*.ts*",
-    "test": "jest",
-    "prepublish": "yarn lint && yarn test && yarn build",
+    "test": "yarn test:unit && yarn test:integration",
+    "test:integration": "node __tests__/integration/run.mjs",
+    "test:unit": "jest",
+    "prepublish": "yarn lint && yarn test:unit && yarn build",
     "deploy": "yarn publish && git push"
   },
   "keywords": [
@@ -43,22 +54,33 @@
   "author": "Dustin Callaway <drcallaway@gmail.com>",
   "license": "MIT",
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "jest": {
-    "transform": {
-      ".(ts|tsx)": "ts-jest"
+    "globals": {
+      "ts-jest": {
+          "useESM": true
+      }
     },
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
     "moduleFileExtensions": [
       "ts",
       "tsx",
       "js",
       "json"
     ],
+    "moduleNameMapper": {
+      "(.+)\\.js": "$1"
+    },
+    "testEnvironment": "jsdom",
     "testPathIgnorePatterns": [
+      "__tests__/integration/",
       "/node_modules/",
       "/lib/"
-    ]
+    ],
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    }
   }
 }

package/src/TimeoutError.ts

@@ -0,0 +1,10 @@
+export default class TimeoutError extends Error {
+  public timeout: number;
+  public statusCode: number;
+
+  constructor(message: string, timeout: number, statusCode: number = 408) {
+    super(message);
+    this.timeout = timeout;
+    this.statusCode = statusCode;
+  }
+}

package/src/cjs.ts

@@ -0,0 +1,4 @@
+import TimeoutLink from "./timeoutLink.js";
+
+module.exports = TimeoutLink;
+module.exports.default = TimeoutLink;

package/src/timeoutLink.ts

@@ -0,0 +1,121 @@
+// note, this import is modified when building for ESM via `script/fix_apollo_import.mjs`
+import { ApolloLink, Observable, type Operation, type NextLink } from '@apollo/client/core';
+import type { DefinitionNode } from 'graphql';
+import TimeoutError from './TimeoutError.js';
+
+const DEFAULT_TIMEOUT: number = 15000;
+
+/**
+ * Aborts the request if the timeout expires before the response is received.
+ */
+export default class TimeoutLink extends ApolloLink {
+  private timeout: number;
+  private statusCode?: number;
+
+  /**
+   * Creates a new TimeoutLink instance.
+   * Aborts the request if the timeout expires before the response is received.
+   *
+   * @param timeout - The timeout in milliseconds for the request. Default is 15000ms (15 seconds).
+   * @param statusCode - The HTTP status code to return when a timeout occurs. Default is 408 (Request Timeout).
+   */
+  constructor(timeout?: number, statusCode?: number) {
+    super();
+    this.timeout = timeout || DEFAULT_TIMEOUT;
+    this.statusCode = statusCode;
+  }
+
+  public request(operation: Operation, forward: NextLink) {
+    let controller: AbortController;
+    let ourController: AbortController;
+
+    // override timeout from query context
+    const requestTimeout = operation.getContext().timeout || this.timeout;
+
+    // add abort controller and signal object to fetchOptions if they don't already exist
+    if (typeof AbortController !== 'undefined') {
+      const context = operation.getContext();
+      let fetchOptions = context.fetchOptions || {};
+
+      ourController = new AbortController();
+      controller = fetchOptions.controller || ourController;
+
+      fetchOptions = { ...fetchOptions, controller, signal: controller.signal };
+      operation.setContext({ fetchOptions });
+    }
+
+    const chainObservable = forward(operation); // observable for remaining link chain
+
+    const operationType = (operation.query.definitions as any).find(
+      (def: DefinitionNode) => def.kind === 'OperationDefinition'
+    ).operation;
+
+    if (requestTimeout <= 0 || operationType === 'subscription') {
+      return chainObservable; // skip this link if timeout is zero or it's a subscription request
+    }
+
+    // create local observable with timeout functionality (unsubscibe from chain observable and
+    // return an error if the timeout expires before chain observable resolves)
+    const localObservable = new Observable(observer => {
+      let timer: any;
+
+      // listen to chainObservable for result and pass to localObservable if received before timeout
+      const subscription = chainObservable.subscribe(
+        result => {
+          clearTimeout(timer);
+          observer.next(result);
+          observer.complete();
+        },
+        error => {
+          clearTimeout(timer);
+          observer.error(error);
+          observer.complete();
+        }
+      );
+
+      // if timeout expires before observable completes, abort call, unsubscribe, and return error
+      timer = setTimeout(() => {
+        if (controller) {
+          if (controller.signal.aborted) {
+            // already aborted from somewhere else
+            return;
+          }
+
+          controller.abort(); // abort fetch operation
+
+          // if the AbortController in the operation context is one we created,
+          // it's now "used up", so we need to remove it to avoid blocking any
+          // future retry of the operation.
+          const context = operation.getContext();
+          const fetchOptions = context.fetchOptions || {};
+          if(fetchOptions.controller === ourController && fetchOptions.signal === ourController.signal) {
+             operation.setContext({ ...fetchOptions, controller: undefined, signal: undefined });
+          }
+        }
+
+        observer.error(new TimeoutError('Timeout exceeded', requestTimeout, this.statusCode));
+        subscription.unsubscribe();
+      }, requestTimeout);
+
+      const cancelTimeout = () => {
+        clearTimeout(timer);
+        subscription.unsubscribe();
+      };
+
+      const ctxRef = operation.getContext().timeoutRef;
+      if (ctxRef) {
+        ctxRef({ unsubscribe: cancelTimeout });
+      }
+
+      // cancel timeout if aborted from somewhere else
+      controller.signal.addEventListener("abort", () => {
+        cancelTimeout();
+      }, { once: true });
+
+      // this function is called when a client unsubscribes from localObservable
+      return cancelTimeout;
+    });
+
+    return localObservable;
+  }
+}

package/lib/TimeoutError.d.ts

@@ -1,5 +0,0 @@
-export default class TimeoutError extends Error {
-    timeout: number;
-    statusCode: number;
-    constructor(message: string, timeout: number, statusCode?: number);
-}

package/lib/TimeoutError.js

@@ -1,25 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var TimeoutError = /** @class */ (function (_super) {
-    __extends(TimeoutError, _super);
-    function TimeoutError(message, timeout, statusCode) {
-        if (statusCode === void 0) { statusCode = 408; }
-        var _this = _super.call(this, message) || this;
-        _this.timeout = timeout;
-        _this.statusCode = statusCode;
-        return _this;
-    }
-    return TimeoutError;
-}(Error));
-exports.default = TimeoutError;
-//# sourceMappingURL=TimeoutError.js.map

package/lib/TimeoutError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TimeoutError.js","sourceRoot":"","sources":["../src/TimeoutError.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;IAA0C,gCAAK;IAI7C,sBAAY,OAAe,EAAE,OAAe,EAAE,UAAwB;QAAxB,2BAAA,EAAA,gBAAwB;QAAtE,YACE,kBAAM,OAAO,CAAC,SAGf;QAFC,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,KAAI,CAAC,UAAU,GAAG,UAAU,CAAC;;IAC/B,CAAC;IACH,mBAAC;AAAD,CAAC,AATD,CAA0C,KAAK,GAS9C"}

package/lib/timeoutLink.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="zen-observable" />
-import { ApolloLink, Observable, Operation, NextLink } from '@apollo/client/core';
-/**
- * Aborts the request if the timeout expires before the response is received.
- */
-export default class TimeoutLink extends ApolloLink {
-    private timeout;
-    private statusCode?;
-    constructor(timeout: number, statusCode?: number);
-    request(operation: Operation, forward: NextLink): Observable<{}>;
-}

package/lib/timeoutLink.js

@@ -1,104 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __assign = (this && this.__assign) || Object.assign || function(t) {
-    for (var s, i = 1, n = arguments.length; i < n; i++) {
-        s = arguments[i];
-        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-            t[p] = s[p];
-    }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var core_1 = require("@apollo/client/core");
-var TimeoutError_1 = require("./TimeoutError");
-var DEFAULT_TIMEOUT = 15000;
-/**
- * Aborts the request if the timeout expires before the response is received.
- */
-var TimeoutLink = /** @class */ (function (_super) {
-    __extends(TimeoutLink, _super);
-    function TimeoutLink(timeout, statusCode) {
-        var _this = _super.call(this) || this;
-        _this.timeout = timeout || DEFAULT_TIMEOUT;
-        _this.statusCode = statusCode;
-        return _this;
-    }
-    TimeoutLink.prototype.request = function (operation, forward) {
-        var _this = this;
-        var controller;
-        // override timeout from query context
-        var requestTimeout = operation.getContext().timeout || this.timeout;
-        // add abort controller and signal object to fetchOptions if they don't already exist
-        if (typeof AbortController !== 'undefined') {
-            var context = operation.getContext();
-            var fetchOptions = context.fetchOptions || {};
-            controller = fetchOptions.controller || new AbortController();
-            fetchOptions = __assign({}, fetchOptions, { controller: controller, signal: controller.signal });
-            operation.setContext({ fetchOptions: fetchOptions });
-        }
-        var chainObservable = forward(operation); // observable for remaining link chain
-        var operationType = operation.query.definitions.find(function (def) { return def.kind === 'OperationDefinition'; }).operation;
-        if (requestTimeout <= 0 || operationType === 'subscription') {
-            return chainObservable; // skip this link if timeout is zero or it's a subscription request
-        }
-        // create local observable with timeout functionality (unsubscibe from chain observable and
-        // return an error if the timeout expires before chain observable resolves)
-        var localObservable = new core_1.Observable(function (observer) {
-            var timer;
-            // listen to chainObservable for result and pass to localObservable if received before timeout
-            var subscription = chainObservable.subscribe(function (result) {
-                clearTimeout(timer);
-                observer.next(result);
-                observer.complete();
-            }, function (error) {
-                clearTimeout(timer);
-                observer.error(error);
-                observer.complete();
-            });
-            // if timeout expires before observable completes, abort call, unsubscribe, and return error
-            timer = setTimeout(function () {
-                if (controller) {
-                    controller.abort(); // abort fetch operation
-                    // if the AbortController in the operation context is one we created,
-                    // it's now "used up", so we need to remove it to avoid blocking any
-                    // future retry of the operation.
-                    var context = operation.getContext();
-                    var fetchOptions = context.fetchOptions || {};
-                    if (fetchOptions.controller === controller && fetchOptions.signal === controller.signal) {
-                        fetchOptions = __assign({}, fetchOptions, { controller: null, signal: null });
-                        operation.setContext({ fetchOptions: fetchOptions });
-                    }
-                }
-                observer.error(new TimeoutError_1.default('Timeout exceeded', requestTimeout, _this.statusCode));
-                subscription.unsubscribe();
-            }, requestTimeout);
-            var ctxRef = operation.getContext().timeoutRef;
-            if (ctxRef) {
-                ctxRef({
-                    unsubscribe: function () {
-                        clearTimeout(timer);
-                        subscription.unsubscribe();
-                    }
-                });
-            }
-            // this function is called when a client unsubscribes from localObservable
-            return function () {
-                clearTimeout(timer);
-                subscription.unsubscribe();
-            };
-        });
-        return localObservable;
-    };
-    return TimeoutLink;
-}(core_1.ApolloLink));
-exports.default = TimeoutLink;
-//# sourceMappingURL=timeoutLink.js.map

package/lib/timeoutLink.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"timeoutLink.js","sourceRoot":"","sources":["../src/timeoutLink.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,4CAAkF;AAElF,+CAA0C;AAE1C,IAAM,eAAe,GAAW,KAAK,CAAC;AAEtC;;GAEG;AACH;IAAyC,+BAAU;IAIjD,qBAAY,OAAe,EAAE,UAAmB;QAAhD,YACE,iBAAO,SAGR;QAFC,KAAI,CAAC,OAAO,GAAG,OAAO,IAAI,eAAe,CAAC;QAC1C,KAAI,CAAC,UAAU,GAAG,UAAU,CAAC;;IAC/B,CAAC;IAEM,6BAAO,GAAd,UAAe,SAAoB,EAAE,OAAiB;QAAtD,iBAqFC;QApFC,IAAI,UAA2B,CAAC;QAEhC,sCAAsC;QACtC,IAAM,cAAc,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QAEtE,qFAAqF;QACrF,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE;YAC1C,IAAM,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;YACvC,IAAI,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;YAE9C,UAAU,GAAG,YAAY,CAAC,UAAU,IAAI,IAAI,eAAe,EAAE,CAAC;YAE9D,YAAY,gBAAQ,YAAY,IAAE,UAAU,YAAA,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,GAAE,CAAC;YAC1E,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY,cAAA,EAAE,CAAC,CAAC;SACxC;QAED,IAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,sCAAsC;QAElF,IAAM,aAAa,GAAI,SAAS,CAAC,KAAK,CAAC,WAAmB,CAAC,IAAI,CAC7D,UAAC,GAAmB,IAAK,OAAA,GAAG,CAAC,IAAI,KAAK,qBAAqB,EAAlC,CAAkC,CAC5D,CAAC,SAAS,CAAC;QAEZ,IAAI,cAAc,IAAI,CAAC,IAAI,aAAa,KAAK,cAAc,EAAE;YAC3D,OAAO,eAAe,CAAC,CAAC,mEAAmE;SAC5F;QAED,2FAA2F;QAC3F,2EAA2E;QAC3E,IAAM,eAAe,GAAG,IAAI,iBAAU,CAAC,UAAA,QAAQ;YAC7C,IAAI,KAAU,CAAC;YAEf,8FAA8F;YAC9F,IAAM,YAAY,GAAG,eAAe,CAAC,SAAS,CAC5C,UAAA,MAAM;gBACJ,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtB,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACtB,CAAC,EACD,UAAA,KAAK;gBACH,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACtB,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACtB,CAAC,CACF,CAAC;YAEF,4FAA4F;YAC5F,KAAK,GAAG,UAAU,CAAC;gBACjB,IAAI,UAAU,EAAE;oBACd,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,wBAAwB;oBAE5C,qEAAqE;oBACrE,oEAAoE;oBACpE,iCAAiC;oBACjC,IAAM,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;oBACvC,IAAI,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;oBAC9C,IAAG,YAAY,CAAC,UAAU,KAAK,UAAU,IAAI,YAAY,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE;wBACrF,YAAY,gBAAQ,YAAY,IAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,CAAC;wBACnE,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY,cAAA,EAAE,CAAC,CAAC;qBACzC;iBACF;gBAED,QAAQ,CAAC,KAAK,CAAC,IAAI,sBAAY,CAAC,kBAAkB,EAAE,cAAc,EAAE,KAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBACtF,YAAY,CAAC,WAAW,EAAE,CAAC;YAC7B,CAAC,EAAE,cAAc,CAAC,CAAC;YAEnB,IAAI,MAAM,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC;YAE/C,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC;oBACL,WAAW,EAAE;wBACX,YAAY,CAAC,KAAK,CAAC,CAAC;wBACpB,YAAY,CAAC,WAAW,EAAE,CAAC;oBAC7B,CAAC;iBACF,CAAC,CAAC;aACJ;YAED,0EAA0E;YAC1E,OAAO;gBACL,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,YAAY,CAAC,WAAW,EAAE,CAAC;YAC7B,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IACH,kBAAC;AAAD,CAAC,AAhGD,CAAyC,iBAAU,GAgGlD"}