mongodash 2.5.2 → 2.6.0

package/dist/lib/testing/waitUntilReactiveTasksIdle.js

@@ -5,60 +5,87 @@ const _debug = require("debug");
 const reactiveTasks_1 = require("../reactiveTasks");
 const waitUntil_1 = require("./waitUntil");
 const debug = _debug('mongodash:testing');
-/**
- * Waits until the reactive task system is idle.
- * "Idle" means:
- * 1. No changes are buffered in the Planner.
- * 2. No workers are currently executing tasks (active count is 0).
- * 3. No tasks in the database are in a pending or processing state.
- *
- * This enables robust E2E testing by ensuring that all side effects and cascading tasks have finished.
- */
 async function waitUntilReactiveTasksIdle(customOptions = {}) {
     const options = Object.assign({ timeoutMs: 10000, pollIntervalMs: 50, stabilityDurationMs: 200 }, customOptions);
+    const hasWhitelist = customOptions.whitelist && customOptions.whitelist.length > 0;
     await (0, waitUntil_1.waitUntil)(async () => {
-        // 1. Check Internal Buffers (Planner)
-        // Accessing private planner via exposed getter for testing
+        // Access scheduler internals
         const planner = reactiveTasks_1._scheduler.taskPlannerInstance;
+        const runner = reactiveTasks_1._scheduler.concurrentRunnerInstance;
+        const registry = reactiveTasks_1._scheduler.getRegistry();
+        // --- 1. Global Checks (Always run) ---
+        // 1. Check Internal Buffers (Planner)
         if (planner && !planner.isEmpty) {
             debug('Planner not empty');
             return false;
         }
         // 2. Check Active Workers (Runner)
-        const runner = reactiveTasks_1._scheduler.concurrentRunnerInstance;
         if (runner && runner.activeWorkers > 0) {
             debug(`Active workers: ${runner.activeWorkers}`);
             return false;
         }
-        // 3. Check Database
-        const registry = reactiveTasks_1._scheduler.getRegistry();
+        // --- 2. Check Database ---
         const entries = registry.getAllEntries();
         // Optimized check: If any collection has pending work, we are not idle.
         for (const entry of entries) {
-            // We count documents that are "active"
-            // status IN [pending, processing, processing_dirty]
-            // AND dueAt <= Now (approx) - actually, for "settled" we might want to wait for EVERYTHING?
-            // Usually we want to wait for anything that is currently actionable.
-            // If a task is scheduled for tomorrow, we shouldn't wait for it.
-            // However, the user requirement is "guarantees that all reactive tasks that are currently planned... have been completed".
-            // "Currently planned" usually implies "executable now".
-            // But if we ignore future tasks, we are safe.
-            const horizon = Date.now() + (options.timeoutMs || 0) + (options.stabilityDurationMs || 0) + 100;
-            // We count documents that are "active"
-            // ONE OF:
-            // 1. status IN [processing, processing_dirty] (always active)
-            // 2. status = pending AND (nextRunAt <= horizon OR nextRunAt IS NULL)
-            //    (NULL nextRunAt usually means "now" or "asap" in some contexts, or "never",
-            //     but for pending it usually means "ready").
-            const count = await entry.tasksCollection.countDocuments({
+            // If whitelisting is active, we only check tasks that match the whitelist
+            let whitelistFilter = null;
+            if (hasWhitelist) {
+                const rules = customOptions.whitelist.filter((rule) => rule.collection === entry.sourceCollection.collectionName);
+                if (rules.length === 0) {
+                    continue;
+                }
+                const criteria = [];
+                let matchAll = false;
+                for (const rule of rules) {
+                    let ruleIds = null;
+                    if (rule.filter) {
+                        // If we have a filter, we need to find which docs match it.
+                        // We can't filter tasks directly by source properties efficiently without joining,
+                        // so we find the matching source docs first.
+                        const matchingDocs = (await entry.sourceCollection.find(rule.filter, { projection: { _id: 1 } }).toArray());
+                        ruleIds = matchingDocs.map((d) => d._id);
+                    }
+                    if (ruleIds === null && !rule.task) {
+                        // One rule validates 'all', so we wait for everything in this collection
+                        matchAll = true;
+                        break;
+                    }
+                    if (rule.task) {
+                        criteria.push({ task: rule.task });
+                    }
+                    if (ruleIds !== null) {
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        criteria.push({ sourceDocId: { $in: ruleIds } });
+                    }
+                }
+                if (!matchAll) {
+                    if (criteria.length > 0) {
+                        whitelistFilter = { $or: criteria };
+                    }
+                    else {
+                        // Whitelist is active, but we have rules that result in effectively "nothing"
+                        // (e.g. filter returned no docs).
+                        // If we have NO criteria and NO matchAll, it implies we wait for nothing on this collection?
+                        // Or should we treat it as blocking?
+                        // If filter didn't match any doc, then we effectively wait for nothing for that rule.
+                        // If ALL rules resulted in nothing, we continue to next entry.
+                        continue;
+                    }
+                }
+            }
+            const stableThresholdMs = (options.timeoutMs || 0) + (options.stabilityDurationMs || 0) + 100;
+            const baseQuery = {
                 $or: [
                     { status: { $in: ['processing', 'processing_dirty'] } },
                     {
                         status: 'pending',
-                        $or: [{ nextRunAt: { $lte: new Date(horizon) } }, { nextRunAt: null }],
+                        $or: [{ nextRunAt: { $lte: new Date(Date.now() + stableThresholdMs) } }, { nextRunAt: null }],
                     },
                 ],
-            });
+            };
+            const query = whitelistFilter ? { $and: [baseQuery, whitelistFilter] } : baseQuery;
+            const count = await entry.tasksCollection.countDocuments(query);
             if (count > 0) {
                 debug(`Collection ${entry.tasksCollection.collectionName} has ${count} active tasks`);
                 return false;

package/dist/lib/testing/waitUntilReactiveTasksIdle.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitUntilReactiveTasksIdle.js","sourceRoot":"","sources":["../../../src/testing/waitUntilReactiveTasksIdle.ts"],"names":[],"mappings":";;AAeA,gEAmEC;AAlFD,gCAAgC;AAChC,oDAAkE;AAClE,2CAA0D;AAE1D,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAE1C;;;;;;;;GAQG;AACI,KAAK,UAAU,0BAA0B,CAAC,gBAA2C,EAAE;IAC1F,MAAM,OAAO,mBACT,SAAS,EAAE,KAAK,EAChB,cAAc,EAAE,EAAE,EAClB,mBAAmB,EAAE,GAAG,IACrB,aAAa,CACnB,CAAC;IAEF,MAAM,IAAA,qBAAS,EAAC,KAAK,IAAI,EAAE;QACvB,sCAAsC;QACtC,2DAA2D;QAC3D,MAAM,OAAO,GAAG,0BAAU,CAAC,mBAAmB,CAAC;QAC/C,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC9B,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAC3B,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,mCAAmC;QACnC,MAAM,MAAM,GAAG,0BAAU,CAAC,wBAAwB,CAAC;QACnD,IAAI,MAAM,IAAI,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;YACrC,KAAK,CAAC,mBAAmB,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,oBAAoB;QACpB,MAAM,QAAQ,GAAG,0BAAU,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QAEzC,wEAAwE;QACxE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,uCAAuC;YACvC,oDAAoD;YACpD,4FAA4F;YAC5F,qEAAqE;YACrE,iEAAiE;YAEjE,2HAA2H;YAC3H,wDAAwD;YACxD,8CAA8C;YAE9C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;YAEjG,uCAAuC;YACvC,UAAU;YACV,8DAA8D;YAC9D,sEAAsE;YACtE,iFAAiF;YACjF,iDAAiD;YAEjD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC;gBACrD,GAAG,EAAE;oBACD,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,kBAAkB,CAAyB,EAAE,EAAE;oBAC/E;wBACI,MAAM,EAAE,SAAS;wBACjB,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;qBACzE;iBACJ;aACJ,CAAC,CAAC;YAEH,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACZ,KAAK,CAAC,cAAc,KAAK,CAAC,eAAe,CAAC,cAAc,QAAQ,KAAK,eAAe,CAAC,CAAC;gBACtF,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC,EAAE,OAAO,CAAC,CAAC;AAChB,CAAC"}
+{"version":3,"file":"waitUntilReactiveTasksIdle.js","sourceRoot":"","sources":["../../../src/testing/waitUntilReactiveTasksIdle.ts"],"names":[],"mappings":";;AAoCA,gEAgHC;AApJD,gCAAgC;AAEhC,oDAAkE;AAClE,2CAA0D;AAE1D,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;AA+BnC,KAAK,UAAU,0BAA0B,CAAC,gBAAmD,EAAE;IAClG,MAAM,OAAO,mBACT,SAAS,EAAE,KAAK,EAChB,cAAc,EAAE,EAAE,EAClB,mBAAmB,EAAE,GAAG,IACrB,aAAa,CACnB,CAAC;IAEF,MAAM,YAAY,GAAG,aAAa,CAAC,SAAS,IAAI,aAAa,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAEnF,MAAM,IAAA,qBAAS,EAAC,KAAK,IAAI,EAAE;QACvB,6BAA6B;QAC7B,MAAM,OAAO,GAAG,0BAAU,CAAC,mBAAmB,CAAC;QAC/C,MAAM,MAAM,GAAG,0BAAU,CAAC,wBAAwB,CAAC;QACnD,MAAM,QAAQ,GAAG,0BAAU,CAAC,WAAW,EAAE,CAAC;QAE1C,wCAAwC;QACxC,sCAAsC;QACtC,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC9B,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAC3B,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,mCAAmC;QACnC,IAAI,MAAM,IAAI,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;YACrC,KAAK,CAAC,mBAAmB,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,4BAA4B;QAC5B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QAEzC,wEAAwE;QACxE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,0EAA0E;YAC1E,IAAI,eAAe,GAAsC,IAAI,CAAC;YAE9D,IAAI,YAAY,EAAE,CAAC;gBACf,MAAM,KAAK,GAAG,aAAa,CAAC,SAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;gBAEnH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrB,SAAS;gBACb,CAAC;gBAED,MAAM,QAAQ,GAAsC,EAAE,CAAC;gBACvD,IAAI,QAAQ,GAAG,KAAK,CAAC;gBAErB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACvB,IAAI,OAAO,GAAqB,IAAI,CAAC;oBAErC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;wBACd,4DAA4D;wBAC5D,mFAAmF;wBACnF,6CAA6C;wBAC7C,MAAM,YAAY,GAAG,CAAC,MAAM,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAe,CAAC;wBAC1H,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;oBAC7C,CAAC;oBAED,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBACjC,yEAAyE;wBACzE,QAAQ,GAAG,IAAI,CAAC;wBAChB,MAAM;oBACV,CAAC;oBAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;wBACZ,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;oBACvC,CAAC;oBACD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;wBACnB,8DAA8D;wBAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,OAAgB,EAAE,EAAE,CAAC,CAAC;oBAC9D,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACZ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACtB,eAAe,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACJ,8EAA8E;wBAC9E,kCAAkC;wBAClC,6FAA6F;wBAC7F,qCAAqC;wBACrC,sFAAsF;wBACtF,+DAA+D;wBAC/D,SAAS;oBACb,CAAC;gBACL,CAAC;YACL,CAAC;YAED,MAAM,iBAAiB,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;YAE9F,MAAM,SAAS,GAA+B;gBAC1C,GAAG,EAAE;oBACD,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,kBAAkB,CAAC,EAAE,EAAE;oBACvD;wBACI,MAAM,EAAE,SAAS;wBACjB,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;qBAChG;iBACJ;aACJ,CAAC;YAEF,MAAM,KAAK,GAA+B,eAAe,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAE/G,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAEhE,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACZ,KAAK,CAAC,cAAc,KAAK,CAAC,eAAe,CAAC,cAAc,QAAQ,KAAK,eAAe,CAAC,CAAC;gBACtF,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC,EAAE,OAAO,CAAC,CAAC;AAChB,CAAC"}

package/dist/types/testing/waitUntilReactiveTasksIdle.d.ts

@@ -1,3 +1,4 @@
+import { Document, Filter } from 'mongodb';
 import { WaitUntilOptions } from './waitUntil';
 /**
  * Waits until the reactive task system is idle.
@@ -8,4 +9,23 @@ import { WaitUntilOptions } from './waitUntil';
  *
  * This enables robust E2E testing by ensuring that all side effects and cascading tasks have finished.
  */
-export declare function waitUntilReactiveTasksIdle(customOptions?: Partial<WaitUntilOptions>): Promise<void>;
+export interface WaitUntilReactiveTasksIdleOptions extends Partial<WaitUntilOptions> {
+    /**
+     * If provided, the function will only wait for tasks related to these specific entities.
+     * Global checks (Planner buffer, Active workers) are SKIPPED in this mode to ensure isolation
+     * from other running tests.
+     */
+    whitelist?: Array<{
+        collection: string;
+        /**
+         * Filter to find relevant documents.
+         * If not provided, ALL documents in the collection are considered (use carefully!).
+         */
+        filter?: Filter<Document>;
+        /**
+         * Optional task name filter.
+         */
+        task?: string;
+    }>;
+}
+export declare function waitUntilReactiveTasksIdle(customOptions?: WaitUntilReactiveTasksIdleOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mongodash",
-    "version": "2.5.2",
+    "version": "2.6.0",
     "type": "commonjs",
     "description": "An utility library delivering super-useful and super-simple tools using MongoDB",
     "main": "./dist/lib/index.js",