@kensio/yulin 0.14.0 → 0.16.0

package/dist/util/background/background.d.ts

@@ -1,16 +1,60 @@
 export type BackgroundTask = () => Promise<void>;
 export interface BackgroundScheduler {
+    /**
+     * Wait at a simulator sequencing point.
+     *
+     * The default implementation is deterministic and simply yields to the
+     * microtask queue. Non-deterministic implementations may delay by a random
+     * amount to simulate operations completing out of sequence.
+     */
+    sequence(): Promise<void>;
     schedule(task: BackgroundTask): void;
 }
 export interface BackgroundCompleter {
     complete(): Promise<void>;
 }
 /**
- * Simple async background tasks scheduler, to simulate asynchronous distributed
- * operations occurring in a non-deterministic sequence.
+ * Deterministic async background tasks scheduler.
+ *
+ * Tasks still run asynchronously, outside the current call stack, but dispatch in
+ * the order they were scheduled.
  */
 export declare class BackgroundTasks implements BackgroundScheduler, BackgroundCompleter {
     private readonly pending;
+    /**
+     * Wait at a deterministic sequencing point.
+     */
+    sequence(): Promise<void>;
+    /**
+     * Schedule a task to happen asynchronously in the background.
+     */
+    schedule(task: BackgroundTask): void;
+    /**
+     * Wait until all tasks currently scheduled have finished.
+     * If tasks schedule more tasks, this will continue draining until idle.
+     */
+    complete(): Promise<void>;
+    /**
+     * See how many outstanding background tasks are scheduled.
+     */
+    get size(): number;
+}
+/**
+ * Non-deterministic async background tasks scheduler.
+ *
+ * Use this when you deliberately want to simulate asynchronous distributed
+ * operations completing in a random order.
+ */
+export declare class NonDeterministicBackgroundTasks implements BackgroundScheduler, BackgroundCompleter {
+    private readonly pending;
+    private readonly maxJitterMs;
+    constructor(props?: {
+        maxJitterMs?: number;
+    });
+    /**
+     * Wait at a non-deterministic sequencing point.
+     */
+    sequence(): Promise<void>;
     /**
      * Schedule a task to happen asynchronously in the background.
      */
@@ -24,5 +68,6 @@ export declare class BackgroundTasks implements BackgroundScheduler, BackgroundC
      * See how many outstanding background tasks are scheduled.
      */
     get size(): number;
+    private sleep;
 }
 //# sourceMappingURL=background.d.ts.map

package/dist/util/background/background.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"background.d.ts","sourceRoot":"","sources":["../../../src/util/background/background.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,eACX,YAAW,mBAAmB,EAAE,mBAAmB;IAEnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IAEpD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAsBpC;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;CACF"}
+{"version":3,"file":"background.d.ts","sourceRoot":"","sources":["../../../src/util/background/background.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjD,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;;;;GAKG;AACH,qBAAa,eACX,YAAW,mBAAmB,EAAE,mBAAmB;IAEnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IAEpD;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAsBpC;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;CACF;AAED;;;;;GAKG;AACH,qBAAa,+BACX,YAAW,mBAAmB,EAAE,mBAAmB;IAEnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;gBAEzB,KAAK,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO;IAKhD;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAoBpC;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;YAEa,KAAK;CAKpB"}

package/dist/util/background/background.js

@@ -1,21 +1,29 @@
 /**
- * Simple async background tasks scheduler, to simulate asynchronous distributed
- * operations occurring in a non-deterministic sequence.
+ * Deterministic async background tasks scheduler.
+ *
+ * Tasks still run asynchronously, outside the current call stack, but dispatch in
+ * the order they were scheduled.
  */
 export class BackgroundTasks {
     pending = new Set();
+    /**
+     * Wait at a deterministic sequencing point.
+     */
+    sequence() {
+        return Promise.resolve();
+    }
     /**
      * Schedule a task to happen asynchronously in the background.
      */
     schedule(task) {
         const promise = new Promise((resolve) => {
-            setTimeout(resolve, Math.random());
+            setTimeout(resolve, 0);
         })
             .then(task)
             .then(() => {
             //
         }, (error) => {
-            // Keep the promise rejected so drain() can surface failures
+            // Keep the promise rejected so complete() can surface failures
             // deterministically.
             throw error;
         })
@@ -41,4 +49,63 @@ export class BackgroundTasks {
         return this.pending.size;
     }
 }
+/**
+ * Non-deterministic async background tasks scheduler.
+ *
+ * Use this when you deliberately want to simulate asynchronous distributed
+ * operations completing in a random order.
+ */
+export class NonDeterministicBackgroundTasks {
+    pending = new Set();
+    maxJitterMs;
+    constructor(props = {}) {
+        const { maxJitterMs = 5 } = props;
+        this.maxJitterMs = maxJitterMs;
+    }
+    /**
+     * Wait at a non-deterministic sequencing point.
+     */
+    async sequence() {
+        await this.sleep(Math.random() * this.maxJitterMs);
+    }
+    /**
+     * Schedule a task to happen asynchronously in the background.
+     */
+    schedule(task) {
+        const promise = this.sequence()
+            .then(task)
+            .then(() => {
+            //
+        }, (error) => {
+            // Keep the promise rejected so complete() can surface failures
+            // deterministically.
+            throw error;
+        })
+            .finally(() => {
+            this.pending.delete(promise);
+        });
+        this.pending.add(promise);
+    }
+    /**
+     * Wait until all tasks currently scheduled have finished.
+     * If tasks schedule more tasks, this will continue draining until idle.
+     */
+    async complete() {
+        while (this.pending.size > 0) {
+            // eslint-disable-next-line no-await-in-loop
+            await Promise.all(this.pending);
+        }
+    }
+    /**
+     * See how many outstanding background tasks are scheduled.
+     */
+    get size() {
+        return this.pending.size;
+    }
+    async sleep(ms = 0) {
+        await new Promise((resolve) => {
+            setTimeout(resolve, ms);
+        });
+    }
+}
 //# sourceMappingURL=background.js.map

package/dist/util/background/background.js.map

@@ -1 +1 @@
-{"version":3,"file":"background.js","sourceRoot":"","sources":["../../../src/util/background/background.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,OAAO,eAAe;IAGT,OAAO,GAAG,IAAI,GAAG,EAAiB,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,IAAoB;QAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAC5C,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC;aACC,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,CACH,GAAG,EAAE;YACH,EAAE;QACJ,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,4DAA4D;YAC5D,qBAAqB;YACrB,MAAM,KAAK,CAAC;QACd,CAAC,CACF;aACA,OAAO,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC7B,4CAA4C;YAC5C,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"background.js","sourceRoot":"","sources":["../../../src/util/background/background.ts"],"names":[],"mappings":"AAmBA;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAGT,OAAO,GAAG,IAAI,GAAG,EAAiB,CAAC;IAEpD;;OAEG;IACH,QAAQ;QACN,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,IAAoB;QAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAC5C,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC;aACC,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,CACH,GAAG,EAAE;YACH,EAAE;QACJ,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,+DAA+D;YAC/D,qBAAqB;YACrB,MAAM,KAAK,CAAC;QACd,CAAC,CACF;aACA,OAAO,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC7B,4CAA4C;YAC5C,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,+BAA+B;IAGzB,OAAO,GAAG,IAAI,GAAG,EAAiB,CAAC;IACnC,WAAW,CAAS;IAErC,YAAY,QAAkC,EAAE;QAC9C,MAAM,EAAE,WAAW,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,IAAoB;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE;aAC5B,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,CACH,GAAG,EAAE;YACH,EAAE;QACJ,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,+DAA+D;YAC/D,qBAAqB;YACrB,MAAM,KAAK,CAAC;QACd,CAAC,CACF;aACA,OAAO,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC7B,4CAA4C;YAC5C,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;QACxB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kensio/yulin",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "AWS system behaviour simulation for isolated unit testing",
   "repository": {
     "type": "git",
@@ -18,7 +18,6 @@
     "isolated"
   ],
   "exports": {
-    "./package.json": "./package.json",
     ".": {
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
@@ -35,6 +34,11 @@
       "import": "./dist/service/dynamodb/index.js",
       "types": "./dist/service/dynamodb/index.d.ts"
     },
+    "./eslint": {
+      "import": "./dist/config/eslint/index.js",
+      "types": "./dist/config/eslint/index.d.ts"
+    },
+    "./package.json": "./package.json",
     "./s3": {
       "import": "./dist/service/s3/index.js",
       "types": "./dist/service/s3/index.d.ts"
@@ -83,6 +87,18 @@
     "@kensio/part-factory": "^0.1.1",
     "lodash-es": "^4.18.1"
   },
+  "peerDependencies": {
+    "eslint": "^10.4.1",
+    "typescript-eslint": "^8.60.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    }
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "build:check": "tsc -p tsconfig.json --noEmit",