emberflow 1.3.81 → 1.3.83

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

@@ -35,7 +35,6 @@ 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 indexutils = __importStar(require("../index-utils"));
 const misc = __importStar(require("../utils/misc"));
 const index_utils_1 = require("../index-utils");
 const viewLogics = __importStar(require("../logics/view-logics"));
@@ -86,36 +85,21 @@ describe("distributeDoc", () => {
         queueInstructionsSpy.mockRestore();
         queueRunViewLogicsSpy.mockRestore();
     });
-    it("should delete a document from dstPath", async () => {
+    it("should create a document to dstPath", async () => {
         const logicResultDoc = {
-            action: "delete",
+            action: "create",
             priority: "normal",
             dstPath: "/users/test-user-id/documents/test-doc-id",
+            doc: { name: "test-doc-name-updated" },
         };
+        const expectedData = Object.assign(Object.assign({}, logicResultDoc.doc), { "@id": "test-doc-id", "@dateCreated": expect.any(Timestamp) });
         await indexUtils.distributeDoc(logicResultDoc);
         expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
         expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
-        expect(dbDoc.get).toHaveBeenCalledTimes(1);
-        expect(dbDoc.delete).toHaveBeenCalledTimes(1);
-        expect(dbDoc.delete).toHaveBeenCalled();
-        expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
-        expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
-    });
-    it("should delete documents in batch", async () => {
-        const batchDeleteSpy = jest.spyOn(batch, "deleteDoc").mockResolvedValue(undefined);
-        const logicResultDoc = {
-            action: "delete",
-            priority: "normal",
-            dstPath: "/users/test-user-id/documents/test-doc-id",
-        };
-        await indexUtils.distributeDoc(logicResultDoc, batch);
-        expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
-        expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
-        expect(dbDoc.get).toHaveBeenCalledTimes(1);
-        expect(batchDeleteSpy).toHaveBeenCalledTimes(1);
+        expect(dbDoc.set).toHaveBeenCalledTimes(1);
+        expect(dbDoc.set).toHaveBeenCalledWith(expectedData);
         expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
         expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
-        batchDeleteSpy.mockRestore();
     });
     it("should merge a document to dstPath", async () => {
         const logicResultDoc = {
@@ -157,20 +141,33 @@ describe("distributeDoc", () => {
         expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
         expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
     });
-    it("should merge documents in batch", async () => {
-        const batchSetSpy = jest.spyOn(batch, "update").mockResolvedValue(undefined);
+    it("should not merge when document is undefined", async () => {
         const logicResultDoc = {
             action: "merge",
             priority: "normal",
             dstPath: "/users/test-user-id/documents/test-doc-id",
         };
-        await indexUtils.distributeDoc(logicResultDoc, batch);
+        await indexUtils.distributeDoc(logicResultDoc);
         expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
         expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
-        expect(batchSetSpy).toHaveBeenCalledTimes(1);
+        expect(dbDoc.update).not.toHaveBeenCalled();
+        expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+        expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+    });
+    it("should delete a document from dstPath", async () => {
+        const logicResultDoc = {
+            action: "delete",
+            priority: "normal",
+            dstPath: "/users/test-user-id/documents/test-doc-id",
+        };
+        await indexUtils.distributeDoc(logicResultDoc);
+        expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+        expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+        expect(dbDoc.get).toHaveBeenCalledTimes(1);
+        expect(dbDoc.delete).toHaveBeenCalledTimes(1);
+        expect(dbDoc.delete).toHaveBeenCalled();
         expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
         expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
-        batchSetSpy.mockRestore();
     });
     it("should queue a document to submit form", async () => {
         const queueSubmitFormSpy = jest.spyOn(forms, "queueSubmitForm").mockResolvedValue("test-message-id");
@@ -189,6 +186,188 @@ describe("distributeDoc", () => {
         expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(0);
         queueSubmitFormSpy.mockRestore();
     });
+    describe("batched", () => {
+        it("should create a document to dstPath", async () => {
+            const batchSetSpy = jest.spyOn(batch, "set").mockResolvedValue(undefined);
+            const logicResultDoc = {
+                action: "create",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = Object.assign(Object.assign({}, logicResultDoc.doc), { "@id": "test-doc-id", "@dateCreated": expect.any(Timestamp) });
+            await indexUtils.distributeDoc(logicResultDoc, batch);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(batchSetSpy).toHaveBeenCalledTimes(1);
+            expect(batchSetSpy.mock.calls[0][1]).toEqual(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+            batchSetSpy.mockRestore();
+        });
+        it("should merge a document to dstPath", async () => {
+            const batchUpdateSpy = jest.spyOn(batch, "update").mockResolvedValue(undefined);
+            const logicResultDoc = {
+                action: "merge",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = Object.assign(Object.assign({}, logicResultDoc.doc), { "@id": "test-doc-id" });
+            await indexUtils.distributeDoc(logicResultDoc, batch);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(batchUpdateSpy).toHaveBeenCalledTimes(1);
+            expect(batchUpdateSpy.mock.calls[0][1]).toEqual(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+            batchUpdateSpy.mockRestore();
+        });
+        it("should a delete document from dstPath", async () => {
+            const batchDeleteSpy = jest.spyOn(batch, "deleteDoc").mockResolvedValue(undefined);
+            const logicResultDoc = {
+                action: "delete",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id",
+            };
+            await indexUtils.distributeDoc(logicResultDoc, batch);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.get).toHaveBeenCalledTimes(1);
+            expect(batchDeleteSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+            batchDeleteSpy.mockRestore();
+        });
+    });
+    describe("map destProp", () => {
+        it("should create destProp", async () => {
+            const logicResultDoc = {
+                action: "create",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#createdBy",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = {
+                "createdBy": logicResultDoc.doc,
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+        it("should update destProp", async () => {
+            const logicResultDoc = {
+                action: "merge",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#createdBy",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = {
+                "createdBy.name": "test-doc-name-updated",
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+        it("should delete destProp", async () => {
+            const logicResultDoc = {
+                action: "delete",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#createdBy",
+            };
+            const expectedData = {
+                "createdBy": admin.firestore.FieldValue.delete(),
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.get).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(dbDoc.delete).not.toHaveBeenCalled();
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+    });
+    describe("array map destProp", () => {
+        it("should return when destProp id is empty", async () => {
+            const consoleErrorSpy = jest.spyOn(console, "error").mockImplementation();
+            const logicResultDoc = {
+                action: "merge",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#followers[]",
+                doc: { name: "test-doc-name-updated" },
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(consoleErrorSpy).toHaveBeenCalledWith("destPropId should not be blank for array map");
+            expect(admin.firestore().doc).not.toHaveBeenCalled();
+            expect(dbDoc.update).not.toHaveBeenCalled();
+            expect(queueRunViewLogicsSpy).not.toHaveBeenCalled();
+        });
+        it("should create destProp", async () => {
+            const logicResultDoc = {
+                action: "create",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#followers[test-another-user]",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = {
+                "followers.test-another-user": logicResultDoc.doc,
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+        it("should update destProp", async () => {
+            const logicResultDoc = {
+                action: "merge",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#followers[test-another-user]",
+                doc: { name: "test-doc-name-updated" },
+            };
+            const expectedData = {
+                "followers.test-another-user.name": "test-doc-name-updated",
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+        it("should delete destProp", async () => {
+            const logicResultDoc = {
+                action: "delete",
+                priority: "normal",
+                dstPath: "/users/test-user-id/documents/test-doc-id#followers[test-another-user]",
+            };
+            const expectedData = {
+                "followers.test-another-user": admin.firestore.FieldValue.delete(),
+            };
+            await indexUtils.distributeDoc(logicResultDoc);
+            expect(admin.firestore().doc).toHaveBeenCalledTimes(1);
+            expect(admin.firestore().doc).toHaveBeenCalledWith("/users/test-user-id/documents/test-doc-id");
+            expect(dbDoc.get).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledTimes(1);
+            expect(dbDoc.update).toHaveBeenCalledWith(expectedData);
+            expect(dbDoc.delete).not.toHaveBeenCalled();
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledTimes(1);
+            expect(queueRunViewLogicsSpy).toHaveBeenCalledWith(logicResultDoc);
+        });
+    });
 });
 describe("distribute", () => {
     let dbSpy;
@@ -410,6 +589,9 @@ describe("runBusinessLogics", () => {
     let logicFn1;
     let logicFn2;
     let logicFn3;
+    let logicFn4;
+    let logicFn5;
+    let logicFn6;
     let dbSpy;
     let simulateSubmitFormSpy;
     let createMetricExecutionSpy;
@@ -419,6 +601,9 @@ describe("runBusinessLogics", () => {
         logicFn1 = jest.fn().mockResolvedValue({ status: "finished" });
         logicFn2 = jest.fn().mockResolvedValue({ status: "finished" });
         logicFn3 = jest.fn().mockResolvedValue({ status: "error", message: "Error message" });
+        logicFn4 = jest.fn().mockResolvedValue({ status: "finished" });
+        logicFn5 = jest.fn().mockResolvedValue({ status: "finished" });
+        logicFn6 = jest.fn().mockResolvedValue({ status: "finished" });
         simulateSubmitFormSpy = jest.spyOn(indexUtils._mockable, "simulateSubmitForm").mockResolvedValue();
         createMetricExecutionSpy = jest.spyOn(indexUtils._mockable, "createMetricExecution").mockResolvedValue();
         const dbDoc = {
@@ -474,12 +659,45 @@ describe("runBusinessLogics", () => {
                 entities: ["user"],
                 logicFn: logicFn3,
             },
+            {
+                name: "Logic 4",
+                actionTypes: ["create"],
+                modifiedFields: ["field1"],
+                entities: ["user"],
+                logicFn: logicFn4,
+                addtlFilterFn(actionType) {
+                    return actionType !== "create";
+                },
+            },
+            {
+                name: "Logic 5",
+                actionTypes: ["create"],
+                modifiedFields: ["field2"],
+                entities: ["user"],
+                logicFn: logicFn5,
+                addtlFilterFn(actionType, modifiedFields) {
+                    return !Object.prototype.hasOwnProperty.call(modifiedFields, "field1");
+                },
+            },
+            {
+                name: "Logic 6",
+                actionTypes: ["create"],
+                modifiedFields: ["field2"],
+                entities: ["user"],
+                logicFn: logicFn6,
+                addtlFilterFn(actionType, modifiedFields, document) {
+                    return !Object.prototype.hasOwnProperty.call(document, "field3");
+                },
+            },
         ];
         (0, index_1.initializeEmberFlow)(projectConfig, admin, db_structure_1.dbStructure, db_structure_1.Entity, security_1.securityConfig, validators_1.validatorConfig, logics);
         const runStatus = await indexUtils.runBusinessLogics(actionRef, action, distributeFn);
         expect(logicFn1).toHaveBeenCalledWith(action, new Map(), undefined);
         expect(logicFn2).toHaveBeenCalledWith(action, new Map(), undefined);
         expect(logicFn3).not.toHaveBeenCalled();
+        expect(logicFn4).not.toHaveBeenCalled();
+        expect(logicFn5).not.toHaveBeenCalled();
+        expect(logicFn6).not.toHaveBeenCalled();
         expect(distributeFn).toHaveBeenCalledTimes(1);
         expect(distributeFn).toHaveBeenCalledWith(actionRef, [expect.objectContaining({
                 status: "finished",
@@ -735,7 +953,7 @@ describe("simulateSubmitForm", () => {
         now = Timestamp.now();
         jest.spyOn(indexUtils._mockable, "createNowTimestamp").mockReturnValue(now);
         runBusinessLogicsSpy =
-            jest.spyOn(indexutils, "runBusinessLogics").mockResolvedValue("done");
+            jest.spyOn(indexUtils, "runBusinessLogics").mockResolvedValue("done");
     });
     afterEach(() => {
         jest.restoreAllMocks();