@factorearth/recordmiddleware-errorhandler 0.0.1-alpha.12 → 0.0.1-alpha.13

package/dist/backOff.d.ts

@@ -1 +1,28 @@
-export declare const backOff: () => Promise<void>;
+interface BackoffOptions {
+    /**
+     * The initial delay you want to apply. Default to 100ms
+     */
+    delay?: number;
+    /**
+     * The number of times you want to attempt the function. Default 10
+     */
+    numberOfAttempts?: number;
+    /**
+     * An optional max delay
+     */
+    maxDelay?: number;
+    /**
+     * An initial multiplier to be taken to the power of the attempt number when deciding how long to wait. Default value of 2
+     */
+    timeMultiple?: number;
+}
+/**
+ * Given a task, attempts to execute it a designated number of times, returning the eventual response
+ * @author Eric Webb <ewebb@factorearth.com>
+ * @param task The task we want to retry potentially
+ * @param evaluator A function to evaluate if the task executed successfully, or if it needs to be retried. Needs to return boolean
+ * @param options The configurable options for the module
+ * @returns The result of the function
+ */
+export declare function backoff<TaskResult, TaskArguments extends any[]>(task: (...args: TaskArguments) => Promise<TaskResult>, evaluator: (taskResult: TaskResult) => boolean, options?: BackoffOptions, ...taskArguments: TaskArguments): Promise<TaskResult | void>;
+export {};

package/dist/backOff.js

@@ -1,2 +1,37 @@
-export const backOff = async () => { };
+import { delay } from "./delay";
+// Default values
+const DELAY = 100;
+const NUMBER_OF_ATTEMPTS = 10;
+const MAX_DELAY = Infinity;
+const TIME_MULTIPLE = 2;
+/**
+ * Given a task, attempts to execute it a designated number of times, returning the eventual response
+ * @author Eric Webb <ewebb@factorearth.com>
+ * @param task The task we want to retry potentially
+ * @param evaluator A function to evaluate if the task executed successfully, or if it needs to be retried. Needs to return boolean
+ * @param options The configurable options for the module
+ * @returns The result of the function
+ */
+export async function backoff(task, evaluator, options, ...taskArguments) {
+    let attemptNumber = 0;
+    const maxAttempts = options?.numberOfAttempts || NUMBER_OF_ATTEMPTS;
+    const initialDelay = options?.delay || DELAY;
+    const maxDelay = options?.maxDelay || MAX_DELAY;
+    const timeMultiple = options?.timeMultiple || TIME_MULTIPLE;
+    while (attemptNumber < maxAttempts) {
+        const calculatedDelay = initialDelay * Math.pow(timeMultiple, attemptNumber);
+        const delayTime = Math.min(calculatedDelay, maxDelay);
+        await delay(delayTime);
+        try {
+            const taskResult = await task(...taskArguments);
+            const evaluatorResult = evaluator(taskResult);
+            if (evaluatorResult || !(attemptNumber + 1 < maxAttempts))
+                return taskResult;
+        }
+        catch (err) {
+            // recordSentry({ error: err, msg: "Error executing backoff task" });
+        }
+        attemptNumber++;
+    }
+}
 //# sourceMappingURL=backOff.js.map

package/dist/backOff.js.map

@@ -1 +1 @@
-{"version":3,"file":"backOff.js","sourceRoot":"","sources":["../lib/backOff.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE,GAAE,CAAC,CAAC"}
+{"version":3,"file":"backOff.js","sourceRoot":"","sources":["../lib/backOff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAqBhC,iBAAiB;AACjB,MAAM,KAAK,GAAG,GAAG,CAAC;AAClB,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC;AAC3B,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAA0C,IAAqD,EAAE,SAA8C,EAAE,OAAwB,EAAE,GAAG,aAA4B;IACtO,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,MAAM,WAAW,GAAG,OAAO,EAAE,gBAAgB,IAAI,kBAAkB,CAAC;IACpE,MAAM,YAAY,GAAG,OAAO,EAAE,KAAK,IAAI,KAAK,CAAC;IAC7C,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,SAAS,CAAC;IAChD,MAAM,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,aAAa,CAAC;IAC5D,OAAO,aAAa,GAAG,WAAW,EAAE,CAAC;QACpC,MAAM,eAAe,GAAG,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;QACvB,IAAI,CAAC;YACJ,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9C,IAAI,eAAe,IAAI,CAAC,CAAC,aAAa,GAAG,CAAC,GAAG,WAAW,CAAC;gBAAE,OAAO,UAAU,CAAC;QAC9E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,qEAAqE;QACtE,CAAC;QACD,aAAa,EAAE,CAAC;IACjB,CAAC;AACF,CAAC"}

package/dist/delay.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Creates a promise that resolvers after a provided number of ms
+ * @author Eric Webb <ewebb@factorearth.com>
+ * @param millis The number of ms you want to sleep
+ * @returns A void promise
+ */
+export declare function delay(millis: number): Promise<any>;

package/dist/delay.js

@@ -0,0 +1,10 @@
+/**
+ * Creates a promise that resolvers after a provided number of ms
+ * @author Eric Webb <ewebb@factorearth.com>
+ * @param millis The number of ms you want to sleep
+ * @returns A void promise
+ */
+export function delay(millis) {
+    return new Promise((resolve, _reject) => setTimeout(resolve, millis));
+}
+//# sourceMappingURL=delay.js.map

package/dist/delay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.js","sourceRoot":"","sources":["../lib/delay.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,MAAc;IACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@factorearth/recordmiddleware-errorhandler",
-	"version": "0.0.1-alpha.12",
+	"version": "0.0.1-alpha.13",
 	"description": "A module for handling CRUD errors in lambda",
 	"author": "madtrx <marlin.makori@gmail.com>",
 	"homepage": "https://github.com/FactorEarth/RecordMiddleware#readme",
@@ -25,5 +25,5 @@
 		"access": "public",
 		"registry": "https://registry.npmjs.org/"
 	},
-	"gitHead": "8498879d10c3f30d5167ce8fb5b9fe0d21d863e3"
+	"gitHead": "ac74f89b3c1db1ce3433cbafc2752b586d4270a0"
 }