@sap-cloud-sdk/resilience 2.11.1-20221215201002.0

package/README.md

@@ -0,0 +1,61 @@
+<!-- sap-cloud-sdk-logo -->
+<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+<a href="https://sap.com/s4sdk"><img src="https://help.sap.com/doc/2324e9c3b28748a4ae2ad08166d77675/1.0/en-US/logo-with-js.svg" alt="SAP Cloud SDK for JavaScript Logo" height="122.92" width="226.773"/></a>
+<!-- sap-cloud-sdk-logo-stop -->
+
+# @sap-cloud-sdk/resilience
+
+This package contains implementations for the resilience middlewares like a timeout or circuit breaker middleware. 
+This concept of middlewares is totally generic, and you can use it for non-resilience use cases.
+
+## Installation
+
+```
+$ npm install @sap-cloud-sdk/resilience
+```
+
+## Usage
+
+Add a timeout middleware to a request.
+
+```
+executeHttpRequest(destination, { middleware: [ timeout() ] }, httpRequestOptions);
+```
+<!-- TODO v3 put better link when documentation is done -->
+For more detailed overview visit our [resilience documentation](https://sap.github.io/cloud-sdk/docs/js/).
+
+<!-- sap-cloud-sdk-common-readme -->
+<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+## Support
+
+The recommended way to get in touch with us is to create an issue on [GitHub](https://github.com/SAP/cloud-sdk-js/issues).
+Select the issue category **Bug**, **Feature**, or **Question** depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
+
+## Contribute
+
+If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our [contributing guidelines](https://github.com/SAP/cloud-sdk-js/blob/main/CONTRIBUTING.md) and follow the given instructions.
+
+## Links
+- [Official support channel](https://github.com/SAP/cloud-sdk-js/issues/new/choose)
+
+<br>
+
+- [Github](https://github.com/SAP/cloud-sdk-js)
+
+<br>
+
+- [SAP Cloud SDK Documentation portal](https://sap.github.io/cloud-sdk)
+- [SAP Cloud SDK Documentation portal - Getting started guide](https://sap.github.io/cloud-sdk/docs/js/getting-started)
+- [SAP Cloud SDK Documentation portal - API documentation](https://sap.github.io/cloud-sdk/api/latest)
+- [SAP Cloud SDK Documentation portal - Error handling](https://sap.github.io/cloud-sdk/docs/js/features/error-handling)
+- [SAP Cloud SDK Documentation portal - Release notes](https://sap.github.io/cloud-sdk/docs/js/release-notes-sap-cloud-sdk-for-javascript-and-typescript)
+
+<br>
+
+- [Sample repository](https://github.com/SAP-samples/cloud-sdk-js)
+
+## License
+
+The SAP Cloud SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
+<!-- sap-cloud-sdk-common-readme-stop -->

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { timeout } from './timeout';
+export { Middleware, MiddlewareIn, MiddlewareOut, Context, SkipNext } from './middleware';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,UAAU,EACV,YAAY,EACZ,aAAa,EACb,OAAO,EACP,QAAQ,EACT,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timeout = void 0;
+var timeout_1 = require("./timeout");
+Object.defineProperty(exports, "timeout", { enumerable: true, get: function () { return timeout_1.timeout; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAA3B,kGAAA,OAAO,OAAA"}

package/dist/internal.d.ts

@@ -0,0 +1,3 @@
+export * from './timeout';
+export * from './middleware';
+//# sourceMappingURL=internal.d.ts.map

package/dist/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/dist/internal.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./timeout"), exports);
+__exportStar(require("./middleware"), exports);
+//# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,+CAA6B"}

package/dist/middleware.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Input parameter of a middleware.
+ */
+export interface MiddlewareIn<ReturnT, ContextT extends Context> {
+    /**
+     * Initial function enriched by the middleware e.g. axios request getting a timeout.
+     */
+    fn: () => Promise<ReturnT>;
+    /**
+     * Context of the execution e.g. the request context or URL.
+     */
+    context: ContextT;
+    /**
+     * Call this method to disable all following middlewares.
+     */
+    skipNext: SkipNext;
+}
+/**
+ * Type of the skip next method.
+ */
+export interface SkipNext {
+    (): void;
+    /**
+     * Initially the called property is false and becomes true after invocation.
+     */
+    called: boolean;
+}
+/**
+ * Return type of middlewares.
+ */
+export type MiddlewareOut<ReturnT> = () => Promise<ReturnT>;
+/**
+ * Minimal Context of the middleware.
+ */
+export interface Context {
+    /**
+     * Arguments used in the function.
+     */
+    args: unknown[];
+    /**
+     * URI of the function passed to the middleware.
+     */
+    uri: string;
+}
+/**
+ * Middleware type - This function takes some initial function and returns a function.
+ * The input is the MiddlewareIn containing the initial function and some context information e.g. axios request and the request context.
+ * It returns a new functions with some additional feature e.g. timeout.
+ */
+export type Middleware<ReturnT, ContextT extends Context> = (options: MiddlewareIn<ReturnT, ContextT>) => MiddlewareOut<ReturnT>;
+/**
+ * Helper function to join a list of middlewares given an initial input.
+ * @param middlewares - Middlewares to be layered around the function.
+ * @param context - Context for the middleware execution.
+ * @param fn - Function around which the middlewares are added.
+ * @returns Function with middlewares layered around it.
+ * @internal
+ */
+export declare function executeWithMiddleware<ReturnT, ContextT extends Context>(middlewares: Middleware<ReturnT, ContextT>[] | undefined, context: ContextT, fn: () => Promise<ReturnT>): Promise<ReturnT>;
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,OAAO,EAAE,QAAQ,SAAS,OAAO;IAC7D;;OAEG;IACH,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,IAAI,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,OAAO,EAAE,QAAQ,SAAS,OAAO,IAAI,CAC1D,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,KACrC,aAAa,CAAC,OAAO,CAAC,CAAC;AAE5B;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,QAAQ,SAAS,OAAO,EACrE,WAAW,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,GAAG,SAAS,EACxD,OAAO,EAAE,QAAQ,EACjB,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GACzB,OAAO,CAAC,OAAO,CAAC,CAiBlB"}

package/dist/middleware.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeWithMiddleware = void 0;
+/**
+ * Helper function to join a list of middlewares given an initial input.
+ * @param middlewares - Middlewares to be layered around the function.
+ * @param context - Context for the middleware execution.
+ * @param fn - Function around which the middlewares are added.
+ * @returns Function with middlewares layered around it.
+ * @internal
+ */
+function executeWithMiddleware(middlewares, context, fn) {
+    if (!middlewares?.length) {
+        return fn();
+    }
+    // The skipNext function is called in the middleware to skip the next middlewares
+    const skipNext = function () {
+        skipNext.called = true;
+    };
+    skipNext.called = false;
+    const initial = { context, fn, skipNext };
+    const functionWithMiddlewares = addMiddlewaresToInitialFunction(middlewares, initial);
+    return functionWithMiddlewares();
+}
+exports.executeWithMiddleware = executeWithMiddleware;
+/**
+ * .
+ *
+ * This functions adds the middlewares to the initial functions.
+ * You start with a function (axios request function) and add a timeout, circuit-breaker etc..
+ * The result is new a function containing a timeout, circuit-breaker etc..
+ * Note that the actual function is not executed.
+ * @param middlewares - Middlwares added to the function.
+ * @param initial - Initial function and context.
+ * @returns The funciton with the middlewares added.
+ */
+function addMiddlewaresToInitialFunction(middlewares, initial) {
+    const { context, skipNext } = initial;
+    const functionWithMiddlewares = middlewares.reduce((prev, curr) => {
+        const middlewareAdded = skipNext.called ? prev.fn : curr(prev);
+        return { fn: middlewareAdded, context, skipNext };
+    }, initial);
+    return functionWithMiddlewares.fn;
+}
+//# sourceMappingURL=middleware.js.map

package/dist/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":";;;AA0DA;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,WAAwD,EACxD,OAAiB,EACjB,EAA0B;IAE1B,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE;QACxB,OAAO,EAAE,EAAE,CAAC;KACb;IAED,iFAAiF;IACjF,MAAM,QAAQ,GAAG;QACf,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC,CAAC;IACF,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC;IAExB,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;IAC1C,MAAM,uBAAuB,GAAG,+BAA+B,CAC7D,WAAW,EACX,OAAO,CACR,CAAC;IACF,OAAO,uBAAuB,EAAE,CAAC;AACnC,CAAC;AArBD,sDAqBC;AAED;;;;;;;;;;GAUG;AACH,SAAS,+BAA+B,CACtC,WAA4C,EAC5C,OAAwC;IAExC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAEtC,MAAM,uBAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QAChE,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpD,CAAC,EAAE,OAAO,CAAC,CAAC;IACZ,OAAO,uBAAuB,CAAC,EAAE,CAAC;AACpC,CAAC"}

package/dist/timeout.d.ts

@@ -0,0 +1,15 @@
+import { Context, Middleware } from './middleware';
+/**
+ * Helper method to build a timout middleware.
+ * @param timeoutValue - Timeout in milliseconds. Default value are 10 seconds.
+ * @returns The middleware adding a timeout to the function.
+ */
+export declare function timeout<ReturnType, ContextType extends Context>(timeoutValue?: number): Middleware<ReturnType, ContextType>;
+/**
+ * TODO make non public once change to middleware is complete.
+ * @param promise - Promise
+ * @param timeoutValue - Value for the timeout in milliseconds.
+ * @internal
+ */
+export declare function wrapInTimeout<T>(promise: Promise<T>, timeoutValue: number, message: string): Promise<T>;
+//# sourceMappingURL=timeout.d.ts.map

package/dist/timeout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout.d.ts","sourceRoot":"","sources":["../src/timeout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAA+B,MAAM,cAAc,CAAC;AAIhF;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,UAAU,EAAE,WAAW,SAAS,OAAO,EAC7D,YAAY,GAAE,MAAuB,GACpC,UAAU,CAAC,UAAU,EAAE,WAAW,CAAC,CAOrC;AAoBD;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,CAAC,CAWZ"}

package/dist/timeout.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapInTimeout = exports.timeout = void 0;
+const defaultTimeout = 10000;
+/**
+ * Helper method to build a timout middleware.
+ * @param timeoutValue - Timeout in milliseconds. Default value are 10 seconds.
+ * @returns The middleware adding a timeout to the function.
+ */
+function timeout(timeoutValue = defaultTimeout) {
+    return function (options) {
+        const message = `Request to URL: ${options.context.uri} ran into a timeout after ${timeoutValue}ms.`;
+        return () => wrapInTimeout(options.fn(), timeoutValue, message);
+    };
+}
+exports.timeout = timeout;
+/**
+ * Creates a promise for a timeout race.
+ * @internal
+ * @param timeoutValue - Value for the timeout in milliseconds.
+ * message: string - Error message thrown when timeout is exceeded.
+ * @returns A promise which times out after the given time and the node timout instance to clear the timeout if not needed anymore.
+ */
+function getTimeoutPromise(timeoutValue, message) {
+    let timeoutNode;
+    const promise = new Promise((resolve, reject) => {
+        timeoutNode = setTimeout(() => reject(new Error(message)), timeoutValue);
+    });
+    return [promise, timeoutNode];
+}
+/**
+ * TODO make non public once change to middleware is complete.
+ * @param promise - Promise
+ * @param timeoutValue - Value for the timeout in milliseconds.
+ * @internal
+ */
+async function wrapInTimeout(promise, timeoutValue, message) {
+    const [timeoutPromise, timeoutInstance] = getTimeoutPromise(timeoutValue, message);
+    // Clear the timeout if the original promise is resolve or reject to avoid open handlers.
+    const withClearTimeout = promise.finally(() => {
+        clearTimeout(timeoutInstance);
+    });
+    return Promise.race([withClearTimeout, timeoutPromise]);
+}
+exports.wrapInTimeout = wrapInTimeout;
+//# sourceMappingURL=timeout.js.map

package/dist/timeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout.js","sourceRoot":"","sources":["../src/timeout.ts"],"names":[],"mappings":";;;AAEA,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B;;;;GAIG;AACH,SAAgB,OAAO,CACrB,eAAuB,cAAc;IAErC,OAAO,UACL,OAA8C;QAE9C,MAAM,OAAO,GAAG,mBAAmB,OAAO,CAAC,OAAO,CAAC,GAAG,6BAA6B,YAAY,KAAK,CAAC;QACrG,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC;AACJ,CAAC;AATD,0BASC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CACxB,YAAoB,EACpB,OAAe;IAEf,IAAI,WAAuC,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACjD,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CACjC,OAAmB,EACnB,YAAoB,EACpB,OAAe;IAEf,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,GAAG,iBAAiB,CACzD,YAAY,EACZ,OAAO,CACR,CAAC;IACF,yFAAyF;IACzF,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;QAC5C,YAAY,CAAC,eAAe,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC,CAAC;AAC1D,CAAC;AAfD,sCAeC"}

package/internal.js

@@ -0,0 +1,15 @@
+'use strict';
+function __export(m) {
+  for (const p in m) {
+    if (!exports.hasOwnProperty(p)) {
+      exports[p] = m[p];
+    }
+  }
+}
+Object.defineProperty(exports, '__esModule', { value: true });
+/**
+ * @packageDocumentation
+ * @experimental The internal module is related to sdk-metadata types which are used only internally.
+ */
+__export(require('./dist/internal'));
+// # sourceMappingURL=internal.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@sap-cloud-sdk/resilience",
+  "version": "2.11.1-20221215201002.0",
+  "description": "SAP Cloud SDK for JavaScript resilience",
+  "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
+  "license": "Apache-2.0",
+  "keywords": [
+    "sap-cloud-sdk",
+    "cloud-sdk",
+    "sap-cloud-platform",
+    "middlewares",
+    "resilience"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "internal.js",
+    "internal.d.ts"
+  ],
+  "repository": "github:SAP/cloud-sdk-js",
+  "scripts": {
+    "compile": "tsc -b",
+    "prepublishOnly": "yarn compile && yarn readme",
+    "test": "yarn test:unit",
+    "test:unit": "jest",
+    "coverage": "jest --coverage",
+    "lint": "eslint --ext .ts . && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -c",
+    "lint:fix": "set TIMING=1 && eslint --ext .ts . --fix --quiet && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --loglevel error",
+    "check:dependencies": "depcheck .",
+    "check:public-api": "ts-node ../../scripts/check-public-api-cli.ts",
+    "readme": "ts-node ../../scripts/replace-common-readme.ts"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "axios": "^0.27.1",
+    "nock": "^13.2.9",
+    "typescript": "~4.9.4"
+  }
+}