@lokalise/node-core 6.1.0 → 6.2.0

package/README.md

@@ -201,3 +201,22 @@ It's up to the caller of the function to handle the received error or throw an e
 Read [this article](https://antman-does-software.com/stop-catching-errors-in-typescript-use-the-either-type-to-make-your-code-predictable) for more information on how `Either` works and its benefits.
 
 Additionally, `DefineEither` is also provided. It is a variation of the aforementioned `Either`, which may or may not have `error` set, but always has `result`.
+
+### waitAndRetry
+
+There is helper function available for writing event-driven assertions in automated tests, which rely on something eventually happening:
+
+```ts
+import {waitAndRetry} from "@lokalise/node-core";
+
+const result = await waitAndRetry(
+        () => {
+          return someEventEmitter.emittedEvents.length > 0
+        },
+        20, // sleepTime between attempts
+        30, // maxRetryCount before timeout
+)
+
+expect(result).toBe(false) // resolves to what the last attempt has returned
+expect(someEventEmitter.emittedEvents.length).toBe(1)
+```

package/dist/index.d.ts

@@ -19,3 +19,4 @@ export type { AppLoggerConfig } from './src/logging/loggerConfigResolver';
 export type { ErrorReport, ErrorReporter, ErrorResolver } from './src/errors/errorReporterTypes';
 export { executeAsyncAndHandleGlobalErrors, executeAndHandleGlobalErrors, globalLogger, resolveGlobalErrorLogObject, } from './src/errors/globalErrorHandler';
 export type { MayOmit } from './src/common/may-omit';
+export { waitAndRetry } from './src/utils/waitUtils';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveGlobalErrorLogObject = exports.globalLogger = exports.executeAndHandleGlobalErrors = exports.executeAsyncAndHandleGlobalErrors = exports.resolveLoggerConfiguration = exports.hasMessage = exports.isPublicNonRecoverableError = exports.isObject = exports.isStandardizedError = exports.isInternalError = exports.isEmptyObject = exports.copyWithoutUndefined = exports.pickWithoutUndefined = exports.pick = exports.groupBy = exports.callChunked = exports.chunk = exports.createRangeValidator = exports.ensureClosingSlashTransformer = exports.ConfigScope = exports.ResponseStatusError = exports.InternalError = exports.PublicNonRecoverableError = exports.buildClient = exports.httpClient = exports.sendPost = exports.sendGet = exports.sendPatch = exports.sendDelete = exports.sendPutBinary = exports.sendPut = void 0;
+exports.waitAndRetry = exports.resolveGlobalErrorLogObject = exports.globalLogger = exports.executeAndHandleGlobalErrors = exports.executeAsyncAndHandleGlobalErrors = exports.resolveLoggerConfiguration = exports.hasMessage = exports.isPublicNonRecoverableError = exports.isObject = exports.isStandardizedError = exports.isInternalError = exports.isEmptyObject = exports.copyWithoutUndefined = exports.pickWithoutUndefined = exports.pick = exports.groupBy = exports.callChunked = exports.chunk = exports.createRangeValidator = exports.ensureClosingSlashTransformer = exports.ConfigScope = exports.ResponseStatusError = exports.InternalError = exports.PublicNonRecoverableError = exports.buildClient = exports.httpClient = exports.sendPost = exports.sendGet = exports.sendPatch = exports.sendDelete = exports.sendPutBinary = exports.sendPut = void 0;
 var httpClient_1 = require("./src/http/httpClient");
 Object.defineProperty(exports, "sendPut", { enumerable: true, get: function () { return httpClient_1.sendPut; } });
 Object.defineProperty(exports, "sendPutBinary", { enumerable: true, get: function () { return httpClient_1.sendPutBinary; } });
@@ -44,4 +44,6 @@ Object.defineProperty(exports, "executeAsyncAndHandleGlobalErrors", { enumerable
 Object.defineProperty(exports, "executeAndHandleGlobalErrors", { enumerable: true, get: function () { return globalErrorHandler_1.executeAndHandleGlobalErrors; } });
 Object.defineProperty(exports, "globalLogger", { enumerable: true, get: function () { return globalErrorHandler_1.globalLogger; } });
 Object.defineProperty(exports, "resolveGlobalErrorLogObject", { enumerable: true, get: function () { return globalErrorHandler_1.resolveGlobalErrorLogObject; } });
+var waitUtils_1 = require("./src/utils/waitUtils");
+Object.defineProperty(exports, "waitAndRetry", { enumerable: true, get: function () { return waitUtils_1.waitAndRetry; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,oDAS8B;AAR5B,qGAAA,OAAO,OAAA;AACP,2GAAA,aAAa,OAAA;AACb,wGAAA,UAAU,OAAA;AACV,uGAAA,SAAS,OAAA;AACT,qGAAA,OAAO,OAAA;AACP,sGAAA,QAAQ,OAAA;AACR,wGAAA,UAAU,OAAA;AACV,yGAAA,WAAW,OAAA;AASb,oFAAkF;AAAzE,sIAAA,yBAAyB,OAAA;AAGlC,4DAA0D;AAAjD,8GAAA,aAAa,OAAA;AACtB,wEAAsE;AAA7D,0HAAA,mBAAmB,OAAA;AAG5B,wDAAsD;AAA7C,0GAAA,WAAW,OAAA;AACpB,sEAA+E;AAAtE,mIAAA,6BAA6B,OAAA;AACtC,kEAAoE;AAA3D,wHAAA,oBAAoB,OAAA;AAU7B,qDAA2D;AAAlD,mGAAA,KAAK,OAAA;AAAE,yGAAA,WAAW,OAAA;AAC3B,uDAMgC;AAL9B,sGAAA,OAAO,OAAA;AACP,mGAAA,IAAI,OAAA;AACJ,mHAAA,oBAAoB,OAAA;AACpB,mHAAA,oBAAoB,OAAA;AACpB,4GAAA,aAAa,OAAA;AAGf,mDAM8B;AAL5B,4GAAA,eAAe,OAAA;AACf,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,wHAAA,2BAA2B,OAAA;AAC3B,uGAAA,UAAU,OAAA;AAIZ,2EAA+E;AAAtE,kIAAA,0BAA0B,OAAA;AAInC,sEAKwC;AAJtC,uIAAA,iCAAiC,OAAA;AACjC,kIAAA,4BAA4B,OAAA;AAC5B,kHAAA,YAAY,OAAA;AACZ,iIAAA,2BAA2B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,oDAS8B;AAR5B,qGAAA,OAAO,OAAA;AACP,2GAAA,aAAa,OAAA;AACb,wGAAA,UAAU,OAAA;AACV,uGAAA,SAAS,OAAA;AACT,qGAAA,OAAO,OAAA;AACP,sGAAA,QAAQ,OAAA;AACR,wGAAA,UAAU,OAAA;AACV,yGAAA,WAAW,OAAA;AASb,oFAAkF;AAAzE,sIAAA,yBAAyB,OAAA;AAGlC,4DAA0D;AAAjD,8GAAA,aAAa,OAAA;AACtB,wEAAsE;AAA7D,0HAAA,mBAAmB,OAAA;AAG5B,wDAAsD;AAA7C,0GAAA,WAAW,OAAA;AACpB,sEAA+E;AAAtE,mIAAA,6BAA6B,OAAA;AACtC,kEAAoE;AAA3D,wHAAA,oBAAoB,OAAA;AAU7B,qDAA2D;AAAlD,mGAAA,KAAK,OAAA;AAAE,yGAAA,WAAW,OAAA;AAC3B,uDAMgC;AAL9B,sGAAA,OAAO,OAAA;AACP,mGAAA,IAAI,OAAA;AACJ,mHAAA,oBAAoB,OAAA;AACpB,mHAAA,oBAAoB,OAAA;AACpB,4GAAA,aAAa,OAAA;AAGf,mDAM8B;AAL5B,4GAAA,eAAe,OAAA;AACf,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,wHAAA,2BAA2B,OAAA;AAC3B,uGAAA,UAAU,OAAA;AAIZ,2EAA+E;AAAtE,kIAAA,0BAA0B,OAAA;AAInC,sEAKwC;AAJtC,uIAAA,iCAAiC,OAAA;AACjC,kIAAA,4BAA4B,OAAA;AAC5B,kHAAA,YAAY,OAAA;AACZ,iIAAA,2BAA2B,OAAA;AAK7B,mDAAoD;AAA3C,yGAAA,YAAY,OAAA"}

package/dist/src/utils/waitUtils.d.ts

@@ -0,0 +1 @@
+export declare const waitAndRetry: <T>(predicateFn: () => T, sleepTime?: number, maxRetryCount?: number) => Promise<T>;

package/dist/src/utils/waitUtils.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitAndRetry = void 0;
+const waitAndRetry = async (predicateFn, sleepTime = 20, maxRetryCount = 15) => {
+    return new Promise((resolve, reject) => {
+        let retryCount = 0;
+        function performCheck() {
+            // amount of retries exceeded
+            if (maxRetryCount !== 0 && retryCount > maxRetryCount) {
+                resolve(predicateFn());
+            }
+            // Try executing predicateFn
+            Promise.resolve()
+                .then(() => {
+                return predicateFn();
+            })
+                .then((result) => {
+                if (result) {
+                    resolve(result);
+                }
+                else {
+                    retryCount++;
+                    setTimeout(performCheck, sleepTime);
+                }
+            })
+                .catch((err) => {
+                reject(err);
+            });
+        }
+        performCheck();
+    });
+};
+exports.waitAndRetry = waitAndRetry;
+//# sourceMappingURL=waitUtils.js.map

package/dist/src/utils/waitUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitUtils.js","sourceRoot":"","sources":["../../../src/utils/waitUtils.ts"],"names":[],"mappings":";;;AAAO,MAAM,YAAY,GAAG,KAAK,EAC/B,WAAoB,EACpB,SAAS,GAAG,EAAE,EACd,aAAa,GAAG,EAAE,EACN,EAAE;IACd,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,SAAS,YAAY;YACnB,6BAA6B;YAC7B,IAAI,aAAa,KAAK,CAAC,IAAI,UAAU,GAAG,aAAa,EAAE;gBACrD,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;aACvB;YAED,4BAA4B;YAC5B,OAAO,CAAC,OAAO,EAAE;iBACd,IAAI,CAAC,GAAG,EAAE;gBACT,OAAO,WAAW,EAAE,CAAA;YACtB,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,IAAI,MAAM,EAAE;oBACV,OAAO,CAAC,MAAM,CAAC,CAAA;iBAChB;qBAAM;oBACL,UAAU,EAAE,CAAA;oBACZ,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;iBACpC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;QACN,CAAC;QAED,YAAY,EAAE,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAjCY,QAAA,YAAY,gBAiCxB"}

package/dist/src/utils/waitUtils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/utils/waitUtils.spec.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const waitUtils_1 = require("./waitUtils");
+class Counter {
+    timeOfSucces;
+    executionCounter;
+    constructor(msecsTillSuccess) {
+        this.timeOfSucces = Date.now() + msecsTillSuccess;
+        this.executionCounter = 0;
+    }
+    process() {
+        this.executionCounter++;
+        return Date.now() >= this.timeOfSucces;
+    }
+}
+(0, vitest_1.describe)('waitUtils', () => {
+    (0, vitest_1.describe)('waitAndRetry', () => {
+        it('executes once if there is an instant condition match', async () => {
+            const counter = new Counter(0);
+            const result = await (0, waitUtils_1.waitAndRetry)(() => {
+                return counter.process();
+            });
+            (0, vitest_1.expect)(result).toBe(true);
+            (0, vitest_1.expect)(counter.executionCounter).toBe(1);
+        });
+        it('executes until there is a condition match', async () => {
+            const counter = new Counter(1000);
+            const result = await (0, waitUtils_1.waitAndRetry)(() => {
+                return counter.process();
+            }, 50, 30);
+            (0, vitest_1.expect)(result).toBe(true);
+            (0, vitest_1.expect)(counter.executionCounter > 0).toBe(true);
+        });
+        it('times out of there is never a condition match', async () => {
+            const counter = new Counter(1000);
+            const result = await (0, waitUtils_1.waitAndRetry)(() => {
+                return counter.process();
+            }, 20, 30);
+            (0, vitest_1.expect)(result).toBe(false);
+            (0, vitest_1.expect)(counter.executionCounter > 0).toBe(true);
+        });
+        it('handles an error', async () => {
+            await (0, vitest_1.expect)((0, waitUtils_1.waitAndRetry)(() => {
+                throw new Error('it broke');
+            })).rejects.toThrowError('it broke');
+        });
+    });
+});
+//# sourceMappingURL=waitUtils.spec.js.map

package/dist/src/utils/waitUtils.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitUtils.spec.js","sourceRoot":"","sources":["../../../src/utils/waitUtils.spec.ts"],"names":[],"mappings":";;AAAA,mCAAyC;AAEzC,2CAA0C;AAE1C,MAAM,OAAO;IACM,YAAY,CAAQ;IAC9B,gBAAgB,CAAQ;IAC/B,YAAY,gBAAwB;QAClC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,CAAA;QACjD,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAA;IAC3B,CAAC;IAED,OAAO;QACL,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,CAAA;IACxC,CAAC;CACF;AAED,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAA,iBAAQ,EAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAA;YAE9B,MAAM,MAAM,GAAG,MAAM,IAAA,wBAAY,EAAC,GAAG,EAAE;gBACrC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC1B,CAAC,CAAC,CAAA;YAEF,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACzB,IAAA,eAAM,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;YAEjC,MAAM,MAAM,GAAG,MAAM,IAAA,wBAAY,EAC/B,GAAG,EAAE;gBACH,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC1B,CAAC,EACD,EAAE,EACF,EAAE,CACH,CAAA;YAED,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACzB,IAAA,eAAM,EAAC,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;YAEjC,MAAM,MAAM,GAAG,MAAM,IAAA,wBAAY,EAC/B,GAAG,EAAE;gBACH,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC1B,CAAC,EACD,EAAE,EACF,EAAE,CACH,CAAA;YAED,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC1B,IAAA,eAAM,EAAC,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAChC,MAAM,IAAA,eAAM,EACV,IAAA,wBAAY,EAAC,GAAG,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAA;YAC7B,CAAC,CAAC,CACH,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/node-core",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "author": {
     "name": "Lokalise",
     "url": "https://lokalise.com/"