emberflow 1.5.0 → 2.0.0

package/lib/tests/index-utils.test.js

@@ -36,9 +36,9 @@ const paths_1 = require("../utils/paths");
 const batch_1 = require("../utils/batch");
 const distribution = __importStar(require("../utils/distribution"));
 const forms = __importStar(require("../utils/forms"));
-const misc = __importStar(require("../utils/misc"));
 const viewLogics = __importStar(require("../logics/view-logics"));
 const view_logics_1 = require("../logics/view-logics");
+const patchLogics = __importStar(require("../logics/patch-logics"));
 const patch_logics_1 = require("../sample-custom/patch-logics");
 var Timestamp = firebase_admin_1.firestore.Timestamp;
 // should mock when using initializeEmberFlow and testing db.doc() calls count
@@ -262,7 +262,7 @@ describe("distributeDoc", () => {
             expect(transactionSetMock).toHaveBeenNthCalledWith(1, dstDocRef, expectedInstructions, { merge: true });
             expect(transactionSetMock).toHaveBeenNthCalledWith(2, dstDocRef, expectedData, { merge: true });
         });
-        it("should not allow submit-form logicResultDoc in transaction", async () => {
+        it("should allow submit-form logicResultDoc in transaction (handled later)", async () => {
             const logicResultDoc = {
                 action: "submit-form",
                 priority: "normal",
@@ -272,10 +272,11 @@ describe("distributeDoc", () => {
                 },
                 dstPath: "/users/test-user-id/documents/test-doc-id",
             };
-            const errorSpy = jest.spyOn(console, "error").mockImplementation();
+            const debugSpy = jest.spyOn(console, "debug").mockImplementation();
             await indexUtils.distributeDoc(logicResultDoc, appVersion, undefined, transactionMock);
-            expect(errorSpy).toHaveBeenCalledWith("Submit-form is not supported in transactional logic result");
+            expect(debugSpy).toHaveBeenCalledWith("Submit-form in transactional logic result will be handled after transaction success");
             expect(transactionSetMock).toHaveBeenCalledTimes(0);
+            debugSpy.mockRestore();
         });
     });
     describe("batched", () => {
@@ -488,7 +489,16 @@ describe("distribute", () => {
                         dstPath: "/users/test-user-id/documents/test-doc-id",
                     }],
             ]]);
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         await indexUtils.distributeFnNonTransactional(userDocsByDstPath, appVersion);
         expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
         expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
@@ -525,7 +535,16 @@ describe("distribute", () => {
 describe("distributeLater", () => {
     let queueForDistributionLaterSpy;
     beforeEach(() => {
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         queueForDistributionLaterSpy = jest.spyOn(distribution, "queueForDistributionLater").mockResolvedValue();
     });
     afterEach(() => {
@@ -557,7 +576,16 @@ describe("distributeLater", () => {
 });
 describe("validateForm", () => {
     beforeEach(() => {
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
     });
     const targetVersion = "2.5";
     const entity = "user";
@@ -594,7 +622,16 @@ describe("validateForm", () => {
                 version: "02.04.06",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const document = {
             name: "John Doe",
             email: "johndoe@example.com",
@@ -642,7 +679,16 @@ describe("validateForm", () => {
                 version: "2.0.0",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const document = {
             name: "John Doe",
         };
@@ -690,7 +736,16 @@ describe("getSecurityFn", () => {
                 version: "02.04.06",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, securityConfigs, validators_1.validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const result = await indexUtils.getSecurityFn(entity, targetVersion);
         expect(result).toEqual(userSecurityFnV2);
     });
@@ -709,7 +764,16 @@ describe("getSecurityFn", () => {
                 version: "2.0.0",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, securityConfigs, validators_1.validatorConfigs, [], patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const entity = "user";
         // targetVersion is 1.0.0, even if app is 2.0.0
         const result = await indexUtils.getSecurityFn(entity, "1.0.0");
@@ -768,7 +832,16 @@ describe("delayFormSubmissionAndCheckIfCancelled", () => {
     });
 });
 describe("groupDocsByTargetDocPath", () => {
-    (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, [], [], [], []);
+    (0, index_1.initializeEmberFlow)({
+        projectConfig,
+        admin,
+        dbStructure: db_structure_1.dbStructure,
+        Entity: db_structure_1.Entity,
+        securityConfigs: [],
+        validatorConfigs: [],
+        logicConfigs: [],
+        patchLogicConfigs: [],
+    });
     const docsByDstPath = new Map([
         ["users/user123/document1", [{ action: "merge", priority: "normal", dstPath: "users/user123/document1", doc: { field1: "value1", field2: "value2" } }]],
         ["users/user123/document1/threads/thread1", [{ action: "merge", priority: "normal", dstPath: "users/user123/document1/threads/thread1", doc: { field3: "value3", field6: "value6" } }]],
@@ -811,7 +884,7 @@ describe("runBusinessLogics", () => {
             docId: "document123",
             formId: "form123",
             docPath: "users/user123",
-            entity: entity,
+            entity,
         },
         actionType,
         document: {
@@ -919,7 +992,16 @@ describe("runBusinessLogics", () => {
                 obsoleteStartingFromVersion: "2", // Obsolete after appVersion
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const txnGet = { get: jest.fn() };
         const { logicResults } = await indexUtils.runBusinessLogics(txnGet, action, appVersion);
         expect(logicResults.length).toBe(2);
@@ -943,7 +1025,16 @@ describe("runBusinessLogics", () => {
                 obsoleteStartingFromVersion: "1", // Is obsolete
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const txnGet = { get: jest.fn() };
         const result = await indexUtils.runBusinessLogics(txnGet, action, appVersion);
         expect(result.logicResults.length).toBe(0);
@@ -975,7 +1066,16 @@ describe("runBusinessLogics", () => {
                 version: "1",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, patch_logics_1.patchLogicConfigs);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: patch_logics_1.patchLogicConfigs,
+        });
         const runStatus = await indexUtils.runBusinessLogics(txnGet, action, "2");
         expect(logicFn1).toHaveBeenCalledWith(txnGet, action, new Map());
         expect(logicFn2).toHaveBeenCalledWith(txnGet, action, new Map());
@@ -1045,7 +1145,16 @@ describe("runBusinessLogics", () => {
                 version: "1",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, []);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: [],
+        });
         const newAction = Object.assign(Object.assign({}, action), { modifiedFields: {
                 shouldRun: true,
             } });
@@ -1152,7 +1261,16 @@ describe("runBusinessLogics", () => {
                 obsoleteAfterVersion: "2.4.9",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, []);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: [],
+        });
         const newAction = Object.assign(Object.assign({}, action), { modifiedFields: {
                 field1: true,
             } });
@@ -1218,7 +1336,16 @@ describe("runBusinessLogics", () => {
                 version: "1",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, []);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: [],
+        });
         const runStatus = await indexUtils.runBusinessLogics(txnGet, action, "1");
         expect(logicFn1).not.toHaveBeenCalled();
         expect(logicFn2).not.toHaveBeenCalled();
@@ -1272,7 +1399,16 @@ describe("runBusinessLogics", () => {
                 version: "1",
             },
         ];
-        (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, logics, []);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: logics,
+            patchLogicConfigs: [],
+        });
         const runStatus = await indexUtils.runBusinessLogics(txnGet, action, "1");
         expect(logicFn1).toHaveBeenCalledWith(txnGet, action, expectedSharedMap);
         expect(logicFn2).toHaveBeenCalledWith(txnGet, action, expectedSharedMap);
@@ -1634,46 +1770,6 @@ describe("createMetricExecution", () => {
         });
     });
 });
-describe("cleanMetricExecutions", () => {
-    let colGetMock;
-    let deleteCollectionSpy;
-    beforeEach(() => {
-        colGetMock = jest.fn().mockResolvedValue({
-            docs: [
-                {
-                    ref: {
-                        collection: jest.fn().mockReturnValue({
-                            where: jest.fn().mockReturnValue({}),
-                        }),
-                    },
-                },
-            ],
-        });
-        jest.spyOn(admin.firestore(), "collection").mockReturnValue({
-            get: colGetMock,
-        });
-        deleteCollectionSpy = jest.spyOn(misc, "deleteCollection")
-            .mockImplementation(async (query, callback) => {
-            if (callback) {
-                await callback({ size: 1 });
-            }
-            return Promise.resolve();
-        });
-    });
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-    it("should clean metric executions", async () => {
-        jest.spyOn(console, "info").mockImplementation();
-        await (0, index_utils_1.cleanMetricExecutions)({});
-        expect(console.info).toHaveBeenCalledWith("Running cleanMetricExecutions");
-        expect(admin.firestore().collection).toHaveBeenCalledTimes(1);
-        expect(admin.firestore().collection).toHaveBeenCalledWith("@metrics");
-        expect(colGetMock).toHaveBeenCalledTimes(1);
-        expect(deleteCollectionSpy).toHaveBeenCalled();
-        expect(console.info).toHaveBeenCalledWith("Cleaned 1 logic metric executions");
-    });
-});
 describe("createMetricComputation", () => {
     let colGetMock;
     let setMock;
@@ -1786,44 +1882,209 @@ describe("createMetricComputation", () => {
         });
     });
 });
-describe("cleanMetricComputations", () => {
+describe("patchGroupDocs", () => {
+    const collectionPath = "/users/user1/feeds";
+    let docGetMock;
+    let docSetMock;
     let colGetMock;
-    let deleteCollectionSpy;
+    let limitMock;
+    let startAfterMock;
+    let orderByMock;
+    let batchUpdateMock;
+    let batchCommitMock;
+    let queueGroupPatchSpy;
+    let runPatchLogicsSpy;
+    function makeDoc(id, data = {}) {
+        return {
+            id,
+            data: () => data,
+            ref: {
+                path: `${collectionPath.slice(1)}/${id}`,
+                update: jest.fn(),
+            },
+        };
+    }
     beforeEach(() => {
-        colGetMock = jest.fn().mockResolvedValue({
-            docs: [
-                {
-                    ref: {
-                        collection: jest.fn().mockReturnValue({
-                            where: jest.fn().mockReturnValue({}),
-                        }),
-                    },
-                },
-            ],
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: [],
         });
+        docGetMock = jest.fn().mockResolvedValue({ exists: false, data: () => undefined });
+        docSetMock = jest.fn().mockResolvedValue({});
+        jest.spyOn(admin.firestore(), "doc").mockReturnValue({
+            get: docGetMock,
+            set: docSetMock,
+        });
+        colGetMock = jest.fn();
+        limitMock = jest.fn().mockReturnValue({ get: colGetMock });
+        startAfterMock = jest.fn().mockReturnValue({ limit: limitMock });
+        orderByMock = jest.fn().mockReturnValue({ limit: limitMock, startAfter: startAfterMock });
         jest.spyOn(admin.firestore(), "collection").mockReturnValue({
-            get: colGetMock,
+            orderBy: orderByMock,
         });
-        deleteCollectionSpy = jest.spyOn(misc, "deleteCollection")
-            .mockImplementation(async (query, callback) => {
-            if (callback) {
-                await callback({ size: 1 });
-            }
-            return Promise.resolve();
+        batchUpdateMock = jest.fn();
+        batchCommitMock = jest.fn().mockResolvedValue({});
+        jest.spyOn(admin.firestore(), "batch").mockReturnValue({
+            update: batchUpdateMock,
+            commit: batchCommitMock,
         });
+        queueGroupPatchSpy = jest.spyOn(distribution, "queueGroupPatch").mockResolvedValue();
+        runPatchLogicsSpy = jest.spyOn(patchLogics, "runPatchLogics").mockResolvedValue();
     });
     afterEach(() => {
         jest.restoreAllMocks();
     });
-    it("should clean metric computations", async () => {
-        jest.spyOn(console, "info").mockImplementation();
-        await (0, index_utils_1.cleanMetricComputations)({});
-        expect(console.info).toHaveBeenCalledWith("Running cleanMetricComputations");
-        expect(admin.firestore().collection).toHaveBeenCalledTimes(1);
-        expect(admin.firestore().collection).toHaveBeenCalledWith("@metrics");
-        expect(colGetMock).toHaveBeenCalledTimes(1);
-        expect(deleteCollectionSpy).toHaveBeenCalled();
-        expect(console.info).toHaveBeenCalledWith("Cleaned 1 logic metric computations");
+    it("marks the patch as completed and does not reschedule when there are no more docs", async () => {
+        colGetMock.mockResolvedValue({ empty: true, docs: [] });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "back-fill", backFillPatchName: "ancestor-ids" });
+        expect(docSetMock).toHaveBeenCalledWith(expect.objectContaining({ status: "completed" }), { merge: true });
+        expect(queueGroupPatchSpy).not.toHaveBeenCalled();
+    });
+    it("skips processing entirely when the status is already completed", async () => {
+        docGetMock.mockResolvedValue({ exists: true, data: () => ({ status: "completed" }) });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "back-fill", backFillPatchName: "ancestor-ids" });
+        expect(admin.firestore().collection).not.toHaveBeenCalled();
+        expect(queueGroupPatchSpy).not.toHaveBeenCalled();
+    });
+    it("runs the built-in ancestor-ids back-fill unchanged: bulk single-batch commit, only undefined keys patched", async () => {
+        const doc1 = makeDoc("feed1");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "back-fill", backFillPatchName: "ancestor-ids" });
+        expect(admin.firestore().batch).toHaveBeenCalledTimes(1);
+        expect(batchUpdateMock).toHaveBeenCalledWith(doc1.ref, { "@entity": "feed", "@user": "user1" });
+        expect(batchCommitMock).toHaveBeenCalledTimes(1);
+        expect(docSetMock).toHaveBeenCalledWith(expect.objectContaining({ status: "running", count: 1, lastPatchedId: "feed1" }), { merge: true });
+        expect(queueGroupPatchSpy).toHaveBeenCalledWith({
+            path: collectionPath,
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+            appVersion: undefined,
+            lastPatchedId: "feed1",
+        });
+    });
+    it("does not patch keys that are already defined on the document", async () => {
+        const doc1 = makeDoc("feed1", { "@entity": "feed", "@user": "user1" });
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "back-fill", backFillPatchName: "ancestor-ids" });
+        expect(batchUpdateMock).not.toHaveBeenCalled();
+        expect(batchCommitMock).not.toHaveBeenCalled();
+    });
+    it("dispatches to a custom back-fill config registered via initializeEmberFlow options", async () => {
+        const customPatchFn = jest.fn().mockResolvedValue(undefined);
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: [],
+            backFillPatchConfigs: [{ name: "custom-back-fill", patchFn: customPatchFn }],
+        });
+        const doc1 = makeDoc("feed1");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "back-fill", backFillPatchName: "custom-back-fill" });
+        expect(customPatchFn).toHaveBeenCalledWith(collectionPath, [doc1]);
+        expect(queueGroupPatchSpy).toHaveBeenCalledWith(expect.objectContaining({ backFillPatchName: "custom-back-fill" }));
+    });
+    it("dispatches to runPatchLogics per doc when patchType is patch-logics", async () => {
+        const doc1 = makeDoc("feed1");
+        const doc2 = makeDoc("feed2");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1, doc2] });
+        await indexUtils.patchGroupDocs({ collectionPath, patchType: "patch-logics", appVersion: "1.2.3" });
+        expect(runPatchLogicsSpy).toHaveBeenCalledTimes(2);
+        expect(runPatchLogicsSpy).toHaveBeenNthCalledWith(1, "1.2.3", `/${doc1.ref.path}`);
+        expect(runPatchLogicsSpy).toHaveBeenNthCalledWith(2, "1.2.3", `/${doc2.ref.path}`);
+        expect(queueGroupPatchSpy).toHaveBeenCalledWith(expect.objectContaining({
+            patchType: "patch-logics",
+            appVersion: "1.2.3",
+            lastPatchedId: "feed2",
+        }));
+    });
+    it("marks the run as error (no silent default) when appVersion is missing for patch-logics", async () => {
+        jest.spyOn(console, "error").mockImplementation();
+        const doc1 = makeDoc("feed1");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await expect(indexUtils.patchGroupDocs({ collectionPath, patchType: "patch-logics" })).rejects.toThrow();
+        expect(docSetMock).toHaveBeenCalledWith(expect.objectContaining({ status: "error" }), { merge: true });
+        expect(runPatchLogicsSpy).not.toHaveBeenCalled();
+        expect(queueGroupPatchSpy).not.toHaveBeenCalled();
+    });
+    it("marks the run as error (no silent default) when the back-fill name is unresolved", async () => {
+        jest.spyOn(console, "error").mockImplementation();
+        const doc1 = makeDoc("feed1");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await expect(indexUtils.patchGroupDocs({
+            collectionPath,
+            patchType: "back-fill",
+            backFillPatchName: "does-not-exist",
+        })).rejects.toThrow();
+        expect(docSetMock).toHaveBeenCalledWith(expect.objectContaining({ status: "error", error: expect.stringContaining("does-not-exist") }), { merge: true });
+        expect(queueGroupPatchSpy).not.toHaveBeenCalled();
+    });
+    it("marks the run as error (no silent default) for an unknown patchType", async () => {
+        jest.spyOn(console, "error").mockImplementation();
+        const doc1 = makeDoc("feed1");
+        colGetMock.mockResolvedValue({ empty: false, docs: [doc1] });
+        await expect(indexUtils.patchGroupDocs({
+            collectionPath,
+            patchType: "unknown-type",
+        })).rejects.toThrow();
+        expect(docSetMock).toHaveBeenCalledWith(expect.objectContaining({ status: "error" }), { merge: true });
+        expect(queueGroupPatchSpy).not.toHaveBeenCalled();
+    });
+});
+describe("ancestorIdsPatchConfig", () => {
+    it("is auto-registered as a built-in BackFillPatchConfig named \"ancestor-ids\"", () => {
+        (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: [],
+        });
+        const registered = indexUtils._mockable.getOneTimePatchConfigs()
+            .find((config) => config.name === "ancestor-ids");
+        expect(registered).toBe(indexUtils.ancestorIdsPatchConfig);
+    });
+    it("throws when a custom BackFillPatchConfig reuses the built-in \"ancestor-ids\" name", () => {
+        expect(() => (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: [],
+            backFillPatchConfigs: [{ name: "ancestor-ids", patchFn: jest.fn() }],
+        })).toThrow();
+    });
+    it("throws when two custom BackFillPatchConfigs share the same name", () => {
+        expect(() => (0, index_1.initializeEmberFlow)({
+            projectConfig,
+            admin,
+            dbStructure: db_structure_1.dbStructure,
+            Entity: db_structure_1.Entity,
+            securityConfigs: security_1.securityConfigs,
+            validatorConfigs: validators_1.validatorConfigs,
+            logicConfigs: [],
+            patchLogicConfigs: [],
+            backFillPatchConfigs: [
+                { name: "dup", patchFn: jest.fn() },
+                { name: "dup", patchFn: jest.fn() },
+            ],
+        })).toThrow();
     });
 });
 //# sourceMappingURL=index-utils.test.js.map