emberflow 1.5.1 → 2.0.0

package/lib/tests/utils/cleanup.test.js

@@ -0,0 +1,243 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const admin = __importStar(require("firebase-admin"));
+const index_1 = require("../../index");
+const db_structure_1 = require("../../sample-custom/db-structure");
+const security_1 = require("../../sample-custom/security");
+const validators_1 = require("../../sample-custom/validators");
+const patch_logics_1 = require("../../sample-custom/patch-logics");
+const misc = __importStar(require("../../utils/misc"));
+const cleanup_1 = require("../../utils/cleanup");
+const projectConfig = {
+    projectId: "your-project-id",
+    region: "asia-southeast1",
+    rtdbName: "your-rtdb-name",
+    budgetAlertTopicName: "budget-alerts",
+    maxCostLimitPerFunction: 100,
+    specialCostLimitPerFunction: {
+        function1: 50,
+        function2: 75,
+        function3: 120,
+    },
+};
+admin.initializeApp({
+    databaseURL: "https://test-project.firebaseio.com",
+});
+const projectCleanupConfigs = [
+    {
+        collectionPath: "askJaris",
+        isCollectionGroup: true,
+        timestampField: "createdAt",
+        olderThan: { value: 1, unit: "months" },
+        conditions: [
+            { fieldName: "hasTopic", operator: "==", value: false },
+        ],
+    },
+];
+function initWithCleanupConfigs(cleanupConfigs) {
+    (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,
+        cleanupConfigs,
+    });
+}
+describe("computeCutoffDate", () => {
+    beforeEach(() => {
+        jest.useFakeTimers();
+    });
+    afterEach(() => {
+        jest.useRealTimers();
+    });
+    it("subtracts hours via millisecond math", () => {
+        jest.setSystemTime(new Date("2023-06-15T12:00:00.000Z"));
+        const result = (0, cleanup_1.computeCutoffDate)(2, "hours");
+        expect(result.getTime()).toBe(Date.now() - 2 * 3600000);
+    });
+    it("subtracts days via millisecond math", () => {
+        jest.setSystemTime(new Date("2023-06-15T12:00:00.000Z"));
+        const result = (0, cleanup_1.computeCutoffDate)(3, "days");
+        expect(result.getTime()).toBe(Date.now() - 3 * 86400000);
+    });
+    it("subtracts months using calendar arithmetic", () => {
+        jest.setSystemTime(new Date(2023, 5, 15, 12, 0, 0));
+        const result = (0, cleanup_1.computeCutoffDate)(1, "months");
+        expect(result.getFullYear()).toBe(2023);
+        expect(result.getMonth()).toBe(4); // May
+        expect(result.getDate()).toBe(15);
+    });
+    it("uses calendar arithmetic (not fixed 30 days) for month overflow", () => {
+        // Mar 31 minus 1 month => Feb 31 which rolls forward into March,
+        // demonstrating Date.setMonth calendar arithmetic rather than fixed ms.
+        jest.setSystemTime(new Date(2023, 2, 31, 12, 0, 0));
+        const result = (0, cleanup_1.computeCutoffDate)(1, "months");
+        expect(result.getMonth()).toBe(2); // rolled back into March
+    });
+});
+describe("getInternalCleanupConfigs", () => {
+    it("returns the five built-in entries", () => {
+        const configs = (0, cleanup_1.getInternalCleanupConfigs)();
+        expect(configs).toHaveLength(5);
+        const byPath = (path) => configs.find((c) => c.collectionPath === path);
+        expect(byPath("processedIds")).toMatchObject({
+            isCollectionGroup: true,
+            timestampField: "timestamp",
+            olderThan: { value: 7, unit: "days" },
+            recursive: false,
+        });
+        expect(byPath("executions")).toMatchObject({
+            isCollectionGroup: true,
+            timestampField: "execDate",
+            olderThan: { value: 7, unit: "days" },
+            recursive: false,
+        });
+        expect(byPath("computations")).toMatchObject({
+            isCollectionGroup: true,
+            timestampField: "createdAt",
+            olderThan: { value: 30, unit: "days" },
+            recursive: false,
+        });
+        expect(byPath("@emberflow/internal/viewLogicExecutions")).toMatchObject({
+            timestampField: "execDate",
+            olderThan: { value: 7, unit: "days" },
+        });
+        const actionsEntry = byPath("@actions");
+        expect(actionsEntry).toMatchObject({
+            timestampField: "timeCreated",
+            olderThan: { value: 7, unit: "days" },
+        });
+        expect(typeof (actionsEntry === null || actionsEntry === void 0 ? void 0 : actionsEntry.onBatchDeleted)).toBe("function");
+    });
+});
+describe("cleanupCollections", () => {
+    let query;
+    let collectionMock;
+    let collectionGroupMock;
+    let deleteCollectionSpy;
+    let deleteCollectionRecursiveSpy;
+    let rtdbUpdateMock;
+    const snapshot = {
+        size: 2,
+        docs: [
+            { data: () => ({ eventContext: { formId: "f1", uid: "u1" } }) },
+            { data: () => ({ eventContext: { formId: "f2", uid: "u2" } }) },
+        ],
+    };
+    beforeEach(() => {
+        initWithCleanupConfigs(projectCleanupConfigs);
+        query = { where: jest.fn() };
+        query.where.mockReturnValue(query);
+        collectionMock = jest.fn().mockReturnValue(query);
+        collectionGroupMock = jest.fn().mockReturnValue(query);
+        jest.spyOn(admin.firestore(), "collection").mockImplementation(collectionMock);
+        jest.spyOn(admin.firestore(), "collectionGroup").mockImplementation(collectionGroupMock);
+        rtdbUpdateMock = jest.fn().mockResolvedValue(undefined);
+        jest.spyOn(admin.database(), "ref").mockReturnValue({
+            update: rtdbUpdateMock,
+        });
+        deleteCollectionSpy = jest.spyOn(misc, "deleteCollection")
+            .mockImplementation(async (q, callback) => {
+            if (callback) {
+                await callback(snapshot);
+            }
+        });
+        deleteCollectionRecursiveSpy = jest.spyOn(misc, "deleteCollectionRecursive")
+            .mockImplementation(async (q, callback) => {
+            if (callback) {
+                await callback(snapshot);
+            }
+        });
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it("processes both internal and project entries in one pass", async () => {
+        await (0, cleanup_1.cleanupCollections)({});
+        // Internal collection-group entries
+        expect(collectionGroupMock).toHaveBeenCalledWith("processedIds");
+        expect(collectionGroupMock).toHaveBeenCalledWith("executions");
+        expect(collectionGroupMock).toHaveBeenCalledWith("computations");
+        // Internal exact-path entries
+        expect(collectionMock).toHaveBeenCalledWith("@emberflow/internal/viewLogicExecutions");
+        expect(collectionMock).toHaveBeenCalledWith("@actions");
+        // Project entry (collection group)
+        expect(collectionGroupMock).toHaveBeenCalledWith("askJaris");
+    });
+    it("builds the age threshold and extra conditions in one query", async () => {
+        await (0, cleanup_1.cleanupCollections)({});
+        expect(query.where).toHaveBeenCalledWith("createdAt", "<", expect.any(Date));
+        expect(query.where).toHaveBeenCalledWith("timeCreated", "<", expect.any(Date));
+        // project askJaris condition is chained onto the timestamp filter
+        expect(query.where).toHaveBeenCalledWith("hasTopic", "==", false);
+    });
+    it("deletes recursively by default and flatly when recursive is false", async () => {
+        await (0, cleanup_1.cleanupCollections)({});
+        // flat: processedIds, executions, computations (recursive: false)
+        expect(deleteCollectionSpy).toHaveBeenCalledTimes(3);
+        // recursive (default): viewLogicExecutions, @actions, askJaris
+        expect(deleteCollectionRecursiveSpy).toHaveBeenCalledTimes(3);
+    });
+    it("runs the @actions RTDB hook to null forms/{uid}/{formId}", async () => {
+        await (0, cleanup_1.cleanupCollections)({});
+        expect(rtdbUpdateMock).toHaveBeenCalledTimes(1);
+        expect(rtdbUpdateMock).toHaveBeenCalledWith({
+            "forms/u1/f1": null,
+            "forms/u2/f2": null,
+        });
+    });
+    it("logs the number of deleted documents per entry", async () => {
+        const infoSpy = jest.spyOn(console, "info").mockImplementation();
+        await (0, cleanup_1.cleanupCollections)({});
+        expect(infoSpy).toHaveBeenCalledWith("cleanupCollections: deleted 2 from @actions");
+        expect(infoSpy).toHaveBeenCalledWith("cleanupCollections: deleted 2 from askJaris");
+    });
+    it("isolates per-entry failures and continues processing", async () => {
+        const errorSpy = jest.spyOn(console, "error").mockImplementation();
+        collectionGroupMock.mockImplementation((name) => {
+            if (name === "executions") {
+                throw new Error("boom");
+            }
+            return query;
+        });
+        await (0, cleanup_1.cleanupCollections)({});
+        expect(errorSpy).toHaveBeenCalledWith("cleanupCollections failed for executions", expect.any(Error));
+        // later entries still processed
+        expect(collectionMock).toHaveBeenCalledWith("@actions");
+        expect(collectionGroupMock).toHaveBeenCalledWith("askJaris");
+    });
+    it("runs internal entries only when no project configs are supplied", async () => {
+        initWithCleanupConfigs([]);
+        await (0, cleanup_1.cleanupCollections)({});
+        expect(collectionGroupMock).not.toHaveBeenCalledWith("askJaris");
+        expect(collectionMock).toHaveBeenCalledWith("@actions");
+    });
+});
+//# sourceMappingURL=cleanup.test.js.map

package/lib/tests/utils/cleanup.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanup.test.js","sourceRoot":"","sources":["../../../src/tests/utils/cleanup.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,sDAAwC;AACxC,uCAAgD;AAChD,mEAAqE;AACrE,2DAA6D;AAC7D,+DAAgE;AAChE,mEAAmE;AACnE,uDAAyC;AAEzC,iDAI6B;AAE7B,MAAM,aAAa,GAAkB;IACnC,SAAS,EAAE,iBAAiB;IAC5B,MAAM,EAAE,iBAAiB;IACzB,QAAQ,EAAE,gBAAgB;IAC1B,oBAAoB,EAAE,eAAe;IACrC,uBAAuB,EAAE,GAAG;IAC5B,2BAA2B,EAAE;QAC3B,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,GAAG;KACf;CACF,CAAC;AACF,KAAK,CAAC,aAAa,CAAC;IAClB,WAAW,EAAE,qCAAqC;CACnD,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAoB;IAC7C;QACE,cAAc,EAAE,UAAU;QAC1B,iBAAiB,EAAE,IAAI;QACvB,cAAc,EAAE,WAAW;QAC3B,SAAS,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAC;QACrC,UAAU,EAAE;YACV,EAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAC;SACtD;KACF;CACF,CAAC;AAEF,SAAS,sBAAsB,CAAC,cAA+B;IAC7D,IAAA,2BAAmB,EAAC;QAClB,aAAa;QACb,KAAK;QACL,WAAW,EAAX,0BAAW;QACX,MAAM,EAAN,qBAAM;QACN,eAAe,EAAf,0BAAe;QACf,gBAAgB,EAAhB,6BAAgB;QAChB,YAAY,EAAE,EAAE;QAChB,iBAAiB,EAAjB,gCAAiB;QACjB,cAAc;KACf,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,OAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAU,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM;QACzC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,iEAAiE;QACjE,wEAAwE;QACxE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,yBAAyB;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,OAAO,GAAG,IAAA,mCAAyB,GAAE,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,KAAK,IAAI,CAAC,CAAC;QAEhF,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC;YAC3C,iBAAiB,EAAE,IAAI;YACvB,cAAc,EAAE,WAAW;YAC3B,SAAS,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAC;YACnC,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC;YACzC,iBAAiB,EAAE,IAAI;YACvB,cAAc,EAAE,UAAU;YAC1B,SAAS,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAC;YACnC,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC;YAC3C,iBAAiB,EAAE,IAAI;YACvB,cAAc,EAAE,WAAW;YAC3B,SAAS,EAAE,EAAC,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAC;YACpC,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAAC,CAAC,aAAa,CAAC;YACtE,cAAc,EAAE,UAAU;YAC1B,SAAS,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAC;SACpC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC;YACjC,cAAc,EAAE,aAAa;YAC7B,SAAS,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAC;SACpC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,cAAc,CAAA,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,KAAyB,CAAC;IAC9B,IAAI,cAAyB,CAAC;IAC9B,IAAI,mBAA8B,CAAC;IACnC,IAAI,mBAAqC,CAAC;IAC1C,IAAI,4BAA8C,CAAC;IACnD,IAAI,cAAyB,CAAC;IAE9B,MAAM,QAAQ,GAAG;QACf,IAAI,EAAE,CAAC;QACP,IAAI,EAAE;YACJ,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,YAAY,EAAE,EAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAC,EAAC,CAAC,EAAC;YACzD,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,YAAY,EAAE,EAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAC,EAAC,CAAC,EAAC;SAC1D;KAC4C,CAAC;IAEhD,UAAU,CAAC,GAAG,EAAE;QACd,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;QAE9C,KAAK,GAAG,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAC,CAAC;QAC3B,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACnC,cAAc,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClD,mBAAmB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC,kBAAkB,CAAC,cAAqB,CAAC,CAAC;QACtF,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,iBAAiB,CAAC,CAAC,kBAAkB,CAAC,mBAA0B,CAAC,CAAC;QAEhG,cAAc,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC;YAClD,MAAM,EAAE,cAAc;SACgB,CAAC,CAAC;QAE1C,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC;aACvD,kBAAkB,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;YACxC,IAAI,QAAQ,EAAE;gBACZ,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;QACL,4BAA4B,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC;aACzE,kBAAkB,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;YACxC,IAAI,QAAQ,EAAE;gBACZ,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,oCAAoC;QACpC,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACjE,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QACjE,8BAA8B;QAC9B,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,yCAAyC,CAAC,CAAC;QACvF,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACxD,mCAAmC;QACnC,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/E,kEAAkE;QAClE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,kEAAkE;QAClE,MAAM,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACrD,+DAA+D;QAC/D,MAAM,CAAC,4BAA4B,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,MAAM,CAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC;YAC1C,aAAa,EAAE,IAAI;YACnB,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACjE,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,6CAA6C,CAAC,CAAC;QACpF,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,6CAA6C,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACnE,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAY,EAAE,EAAE;YACtD,IAAI,IAAI,KAAK,YAAY,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;aACzB;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,0CAA0C,EAC1C,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAClB,CAAC;QACF,gCAAgC;QAChC,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACxD,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,IAAA,4BAAkB,EAAC,EAAoB,CAAC,CAAC;QAE/C,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/tests/utils/distribution.test.js

@@ -70,7 +70,16 @@ admin.initializeApp({
     databaseURL: "https://test-project.firebaseio.com",
 });
 jest.spyOn(paths._mockable, "doesPathExists").mockResolvedValue(true);
-(0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfigs, validators_1.validatorConfigs, [], []);
+(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: [],
+});
 describe("queueForDistributionLater", () => {
     let publishMessageSpy;
     beforeEach(() => {
@@ -934,4 +943,250 @@ describe("instructionsReducer", () => {
         expect(reducedInstructions.get(doc1.dstPath)).toStrictEqual(expectedReducedInstructions);
     });
 });
+describe("getGroupPatchStatusPath", () => {
+    it("computes independent status paths per patch type/backFillPatchName on the same collection", () => {
+        const collectionPath = "/users/user1/feeds";
+        const ancestorIdsPath = distribution.getGroupPatchStatusPath(collectionPath, "back-fill", "ancestor-ids");
+        const customBackFillPath = distribution.getGroupPatchStatusPath(collectionPath, "back-fill", "custom-back-fill");
+        const patchLogicsPath = distribution.getGroupPatchStatusPath(collectionPath, "patch-logics");
+        expect(ancestorIdsPath).not.toEqual(customBackFillPath);
+        expect(ancestorIdsPath).not.toEqual(patchLogicsPath);
+        expect(customBackFillPath).not.toEqual(patchLogicsPath);
+        expect(ancestorIdsPath).toContain("back-fill_ancestor-ids");
+        expect(customBackFillPath).toContain("back-fill_custom-back-fill");
+        expect(patchLogicsPath).toContain("patch-logics");
+    });
+});
+describe("queueGroupPatch", () => {
+    let publishMessageSpy;
+    let runTransactionSpy;
+    let txnGetMock;
+    let txnSetMock;
+    beforeEach(() => {
+        jest.restoreAllMocks();
+        publishMessageSpy = jest.spyOn(index_1.GROUP_PATCH_TOPIC, "publishMessage")
+            .mockImplementation(() => {
+            return Promise.resolve("message-id");
+        });
+        txnGetMock = jest.fn().mockResolvedValue({ exists: false });
+        txnSetMock = jest.fn();
+        runTransactionSpy = jest.spyOn(admin.firestore(), "runTransaction")
+            .mockImplementation(async (fn) => fn({ get: txnGetMock, set: txnSetMock }));
+    });
+    it("locks the status doc and publishes when there is no lastPatchedId", async () => {
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds/feed1",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        expect(runTransactionSpy).toHaveBeenCalledTimes(1);
+        expect(txnSetMock).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({
+            status: "queued",
+            collectionPath: "/users/user1/feeds",
+            count: 0,
+            lastPatchedId: null,
+        }), { merge: true });
+        expect(publishMessageSpy).toHaveBeenCalledWith({
+            json: {
+                collectionPath: "/users/user1/feeds",
+                patchType: "back-fill",
+                backFillPatchName: "ancestor-ids",
+                appVersion: undefined,
+                lastPatchedId: undefined,
+            },
+        });
+    });
+    it("does not publish when a patch is already queued and not in error/reset state", async () => {
+        txnGetMock.mockResolvedValue({ exists: true, data: () => ({ status: "running" }) });
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        expect(publishMessageSpy).not.toHaveBeenCalled();
+    });
+    it("re-locks and publishes when the previous status is error", async () => {
+        txnGetMock.mockResolvedValue({ exists: true, data: () => ({ status: "error" }) });
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        expect(txnSetMock).toHaveBeenCalled();
+        expect(publishMessageSpy).toHaveBeenCalled();
+    });
+    it("skips locking and publishes directly when lastPatchedId is provided", async () => {
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds",
+            patchType: "patch-logics",
+            appVersion: "1.0.0",
+            lastPatchedId: "feed5",
+        });
+        expect(runTransactionSpy).not.toHaveBeenCalled();
+        expect(publishMessageSpy).toHaveBeenCalledWith({
+            json: {
+                collectionPath: "/users/user1/feeds",
+                patchType: "patch-logics",
+                backFillPatchName: undefined,
+                appVersion: "1.0.0",
+                lastPatchedId: "feed5",
+            },
+        });
+    });
+    it("tracks independent locks for different patch types/back-fills on the same collection", async () => {
+        const docSpy = jest.spyOn(admin.firestore(), "doc");
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        await distribution.queueGroupPatch({
+            path: "/users/user1/feeds",
+            patchType: "patch-logics",
+            appVersion: "1.0.0",
+        });
+        const calledPaths = docSpy.mock.calls.map((call) => call[0]);
+        expect(new Set(calledPaths).size).toBe(calledPaths.length);
+        expect(publishMessageSpy).toHaveBeenCalledTimes(2);
+    });
+});
+describe("onMessageGroupPatchQueue", () => {
+    let patchGroupDocsSpy;
+    beforeEach(() => {
+        isProcessedMock.mockResolvedValue(false);
+        patchGroupDocsSpy = jest.spyOn(indexUtils, "patchGroupDocs").mockResolvedValue();
+    });
+    it("skips already processed messages", async () => {
+        isProcessedMock.mockResolvedValue(true);
+        const event = {
+            id: "test-event",
+            data: { message: { json: { collectionPath: "/users/user1/feeds", patchType: "back-fill", backFillPatchName: "ancestor-ids" } } },
+        };
+        await distribution.onMessageGroupPatchQueue(event);
+        expect(patchGroupDocsSpy).not.toHaveBeenCalled();
+    });
+    it("dispatches to patchGroupDocs for non-placeholder collection paths", async () => {
+        const event = {
+            id: "test-event",
+            data: {
+                message: {
+                    json: {
+                        collectionPath: "/users/user1/feeds",
+                        patchType: "back-fill",
+                        backFillPatchName: "ancestor-ids",
+                        lastPatchedId: "feed1",
+                    },
+                },
+            },
+        };
+        await distribution.onMessageGroupPatchQueue(event);
+        expect(patchGroupDocsSpy).toHaveBeenCalledWith({
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+            appVersion: undefined,
+            lastPatchedId: "feed1",
+        });
+        expect(trackProcessedIdsMock).toHaveBeenCalledWith(index_1.GROUP_PATCH_TOPIC_NAME, event.id);
+    });
+    it("dispatches to patchGroupDocs for patch-logics messages", async () => {
+        const event = {
+            id: "test-event",
+            data: {
+                message: {
+                    json: {
+                        collectionPath: "/users/user1/feeds",
+                        patchType: "patch-logics",
+                        appVersion: "1.0.0",
+                    },
+                },
+            },
+        };
+        await distribution.onMessageGroupPatchQueue(event);
+        expect(patchGroupDocsSpy).toHaveBeenCalledWith({
+            collectionPath: "/users/user1/feeds",
+            patchType: "patch-logics",
+            backFillPatchName: undefined,
+            appVersion: "1.0.0",
+            lastPatchedId: undefined,
+        });
+    });
+});
+describe("getGroupPatchProgress", () => {
+    let docGetMock;
+    beforeEach(() => {
+        docGetMock = jest.fn();
+        jest.spyOn(admin.firestore(), "doc").mockReturnValue({
+            get: docGetMock,
+        });
+    });
+    it("returns undefined when the status doc does not exist", async () => {
+        docGetMock.mockResolvedValue({ exists: false });
+        const progress = await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        expect(progress).toBeUndefined();
+    });
+    it("returns a running progress", async () => {
+        docGetMock.mockResolvedValue({
+            exists: true,
+            data: () => ({ status: "running", count: 500, lastPatchedId: "doc500" }),
+        });
+        const progress = await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        expect(progress).toEqual(expect.objectContaining({
+            status: "running",
+            patchedCount: 500,
+            lastPatchedId: "doc500",
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        }));
+    });
+    it("returns a completed progress", async () => {
+        docGetMock.mockResolvedValue({
+            exists: true,
+            data: () => ({ status: "completed", count: 1000 }),
+        });
+        const progress = await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "patch-logics",
+        });
+        expect(progress).toEqual(expect.objectContaining({ status: "completed", patchedCount: 1000 }));
+    });
+    it("returns an error progress with the error message", async () => {
+        docGetMock.mockResolvedValue({
+            exists: true,
+            data: () => ({ status: "error", error: "Something went wrong" }),
+        });
+        const progress = await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "custom-back-fill",
+        });
+        expect(progress).toEqual(expect.objectContaining({ status: "error", error: "Something went wrong" }));
+    });
+    it("tracks independent progress per patch type on the same collection", async () => {
+        const docSpy = jest.spyOn(admin.firestore(), "doc").mockReturnValue({
+            get: docGetMock,
+        });
+        docGetMock.mockResolvedValue({ exists: true, data: () => ({ status: "running", count: 1 }) });
+        await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "back-fill",
+            backFillPatchName: "ancestor-ids",
+        });
+        await distribution.getGroupPatchProgress({
+            collectionPath: "/users/user1/feeds",
+            patchType: "patch-logics",
+        });
+        const calledPaths = docSpy.mock.calls.map((call) => call[0]);
+        expect(calledPaths[0]).not.toEqual(calledPaths[1]);
+    });
+});
 //# sourceMappingURL=distribution.test.js.map