@arrai-innovations/reactive-helpers 14.0.2 → 15.0.0

package/tests/unit/use/listInstance.spec.js

@@ -3,7 +3,8 @@ import { expectErrorToBeNull } from "../expectHelpers.js";
 import flushPromises from "flush-promises";
 import keyBy from "lodash-es/keyBy.js";
 import { inspect } from "util";
-import { isReactive, nextTick, reactive, isRef, isReadonly } from "vue";
+import { isReactive, nextTick, reactive, isRef, isReadonly, ref } from "vue";
+import { ListInstanceError } from "../../../use/listInstance.js";
 
 afterAll(() => {
     vi.restoreAllMocks();
@@ -11,17 +12,19 @@ afterAll(() => {
 
 const fields = ["id", "__str__", "name"];
 describe("use/listInstance.spec.js", function () {
-    let useListInstance, ListInstanceError, useListInstances, globalList, globalbulkDelete;
+    let useListInstance, ListInstanceError, useListInstances, globalList, globalbulkDelete, globalexecuteAction;
     beforeEach(async () => {
         const listCrud = await import("../../../config/listCrud.js");
         const imported = await import("../../../use/listInstance.js");
         globalList = vi.fn();
         globalbulkDelete = vi.fn(() => Promise.resolve(true));
+        globalexecuteAction = vi.fn(() => Promise.resolve(true));
         // @ts-ignore
         globalList.cancel = vi.fn();
         listCrud.setListCrud({
             list: globalList,
             bulkDelete: globalbulkDelete,
+            executeAction: globalexecuteAction,
             args: { stream: "test_stream" },
         });
         useListInstance = imported.useListInstance;
@@ -98,7 +101,10 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -165,7 +171,10 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "unique", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "unique", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -207,14 +216,17 @@ describe("use/listInstance.spec.js", function () {
             });
             expect(globalList).toHaveBeenCalledTimes(1);
         });
-        it("already loading", async function () {
+        it("already retrieving", async function () {
             const listArgs = reactive({
                 user: 1,
             });
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs, keepOldPages: false },
+                keepOldPages: false,
+            });
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBeUndefined();
@@ -238,6 +250,32 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.loading).toBe(true);
             expect({ ...listInstance.state.objects }).toEqual({});
         });
+        it("already loading", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+            globalList.mockImplementation(() => new Promise(() => {}));
+            listInstance.bulkDelete();
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            await expect(() => listInstance.list()).rejects.toThrow(ListInstanceError);
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+        });
         it("errored", async function () {
             const listArgs = reactive({
                 user: 1,
@@ -245,7 +283,10 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
             let crudListReject;
             const crudListPromise = new Promise((resolve, reject) => {
                 crudListReject = reject;
@@ -300,6 +341,7 @@ describe("use/listInstance.spec.js", function () {
             });
             const listInstance = useListInstance({
                 props: { pkKey: "id", listArgs, retrieveArgs, crudArgs: { stream: "custom_stream" } },
+                keepOldPages: false,
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -374,6 +416,7 @@ describe("use/listInstance.spec.js", function () {
                     retrieveArgs,
                     pkKey: "id",
                 },
+                keepOldPages: false,
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -433,6 +476,7 @@ describe("use/listInstance.spec.js", function () {
                     fields,
                 },
             },
+            keepOldPages: false,
         });
         const listInstanceB = useListInstance({
             props: {
@@ -443,6 +487,7 @@ describe("use/listInstance.spec.js", function () {
                     fields,
                 },
             },
+            keepOldPages: false,
         });
         const listInstances = useListInstances({
             A: {
@@ -454,6 +499,7 @@ describe("use/listInstance.spec.js", function () {
                         fields,
                     },
                 },
+                keepOldPages: false,
             },
             B: {
                 props: {
@@ -464,6 +510,7 @@ describe("use/listInstance.spec.js", function () {
                         fields,
                     },
                 },
+                keepOldPages: false,
             },
         });
         expect(inspect(listInstances.A)).toEqual(inspect(listInstanceA));
@@ -471,14 +518,14 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("addListObject", function () {
         it("errored", function () {
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             expect(() => listInstance.addListObject({ listObject })).toThrowError(ListInstanceError);
             listObject.id = listInstance.getFakePk();
             listInstance.addListObject(listObject);
             expect(() => listInstance.addListObject({ listObject })).toThrowError(ListInstanceError);
         });
         it("succeeded", async function () {
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const newId = listInstance.getFakePk();
             listObject.id = newId;
             listInstance.addListObject(listObject);
@@ -501,7 +548,7 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("updateListObject", function () {
         it("errors", function () {
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             expect(() => listInstance.updateListObject({ listObject })).toThrowError(ListInstanceError);
             listObject.id = -50002000;
             listInstance.addListObject(listObject);
@@ -510,6 +557,7 @@ describe("use/listInstance.spec.js", function () {
         it("succeeds", async function () {
             const listInstance = useListInstance({
                 props: { pkKey: "id" },
+                keepOldPages: false,
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -546,12 +594,13 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("deleteListObject", function () {
         it("errors", function () {
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             expect(() => listInstance.deleteListObject(-50002000)).toThrowError(ListInstanceError);
         });
         it("succeeds", async function () {
             const listInstance = useListInstance({
                 props: { pkKey: "id" },
+                keepOldPages: false,
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -591,6 +640,182 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.order).toEqual(["2", "3"]);
         });
     });
+    describe("executeAction", function () {
+        it("succeeds", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            let crudListResolve;
+            const crudListPromise = new Promise((resolve) => {
+                crudListResolve = resolve;
+            });
+            let passedPageCallback;
+            globalList.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+            const liListResolve = listInstance.list();
+            await nextTick();
+            // @ts-ignore - pageCallback is set in the mock, if not it will throw which is what we want
+            passedPageCallback(crudListResolvedPage2);
+            // @ts-ignore - crudListResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(liListResolve).resolves.toBe(true);
+
+            expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjects2);
+            const executeActionResolve = listInstance.executeAction();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect(globalexecuteAction).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "id",
+                pks: Object.keys(crudListResolvedObjects2).map(Number),
+            });
+
+            expect(globalexecuteAction).toHaveBeenCalledTimes(1);
+
+            // @ts-ignore - executeAction is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(executeActionResolve).resolves.toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+        });
+        it("succeeds with non-standard primary key", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "unique", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            let crudListResolve;
+            const crudListPromise = new Promise((resolve) => {
+                crudListResolve = resolve;
+            });
+            let passedPageCallback;
+            globalList.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+            const liListResolve = listInstance.list();
+            await nextTick();
+            // @ts-ignore - pageCallback is set in the mock, if not it will throw which is what we want
+            passedPageCallback(crudListResolvedPageNonStandardPK);
+            // @ts-ignore - crudListResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(liListResolve).resolves.toBe(true);
+
+            expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjectsNonStandardPK);
+            const executeActionResolve = listInstance.executeAction();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect(globalexecuteAction).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "unique",
+                pks: Object.keys(crudListResolvedObjectsNonStandardPK).map(Number),
+            });
+
+            expect(globalexecuteAction).toHaveBeenCalledTimes(1);
+
+            // @ts-ignore - globalexecuteAction is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(executeActionResolve).resolves.toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+        });
+        it("already loading", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+            globalexecuteAction.mockImplementation(() => new Promise(() => {}));
+            listInstance.executeAction();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            await expect(() => listInstance.executeAction()).rejects.toThrow(ListInstanceError);
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+        });
+        it("errored", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            let crudListReject;
+            const crudListPromise = new Promise((resolve, reject) => {
+                crudListReject = reject;
+            });
+            let passedPageCallback;
+            globalexecuteAction.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            const liListResolve = listInstance.executeAction();
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            await nextTick();
+
+            const rejected = new Error("Test Error");
+            // @ts-ignore - crudListReject is set in a promise, since we await this will be set
+            crudListReject(rejected);
+            await flushPromises();
+
+            await expect(liListResolve).resolves.toBe(false);
+
+            expect(listInstance.state.error).toBe(rejected);
+            expect(listInstance.state.errored).toBe(true);
+            expect(listInstance.state.loading).toBe(false);
+            expect({ ...listInstance.state.objects }).toEqual({});
+            expect(globalexecuteAction).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "id",
+                pks: [],
+            });
+            expect(globalexecuteAction).toHaveBeenCalledTimes(1);
+        });
+    });
     describe("bulkDelete", function () {
         it("succeeds", async function () {
             const listArgs = reactive({
@@ -599,7 +824,10 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -644,7 +872,10 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { pkKey: "unique", listArgs, retrieveArgs } });
+            const listInstance = useListInstance({
+                props: { pkKey: "unique", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -682,10 +913,91 @@ describe("use/listInstance.spec.js", function () {
             await expect(bulkDeleteResolve).resolves.toBe(true);
             expect({ ...listInstance.state.objects }).toEqual({});
         });
+        it("already loading", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+            globalbulkDelete.mockImplementation(() => new Promise(() => {}));
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            listInstance.bulkDelete();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            await expect(() => listInstance.bulkDelete()).rejects.toThrow(ListInstanceError);
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+        });
+        it("errored", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({
+                props: { pkKey: "id", listArgs, retrieveArgs },
+                keepOldPages: false,
+            });
+            let crudListReject;
+            const crudListPromise = new Promise((resolve, reject) => {
+                crudListReject = reject;
+            });
+            let passedPageCallback;
+            globalbulkDelete.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            const liListResolve = listInstance.bulkDelete();
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            await nextTick();
+
+            const rejected = new Error("Test Error");
+            // @ts-ignore - crudListReject is set in a promise, since we await this will be set
+            crudListReject(rejected);
+            await flushPromises();
+
+            await expect(liListResolve).resolves.toBe(false);
+
+            expect(listInstance.state.error).toBe(rejected);
+            expect(listInstance.state.errored).toBe(true);
+            expect(listInstance.state.loading).toBe(false);
+            expect({ ...listInstance.state.objects }).toEqual({});
+            expect(globalbulkDelete).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "id",
+                pks: [],
+            });
+            expect(globalbulkDelete).toHaveBeenCalledTimes(1);
+        });
     });
     describe("getFakePk", function () {
         it("returns fakeId", function () {
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const fakeId = listInstance.getFakePk();
             expect(fakeId).toBeTruthy();
         });
@@ -716,6 +1028,7 @@ describe("use/listInstance.spec.js", function () {
         };
         const listInstance = useListInstance({
             props: { pkKey: "id", listArgs: { user: 1 }, retrieveArgs: { fields: fields } },
+            keepOldPages: false,
         });
         let crudListResolve;
         const crudListPromise = new Promise((resolve) => {
@@ -771,6 +1084,7 @@ describe("use/listInstance.spec.js", function () {
                 functions: {
                     list: myListFn,
                 },
+                keepOldPages: false,
             });
 
             const cancelablePromise = listInstance.list();
@@ -793,4 +1107,29 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.loading).toBe(false);
         });
     });
+    describe("useListInstance", function () {
+        it("throw error when missing keepOldPages", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields: fields,
+            });
+            expect(() =>
+                useListInstance({
+                    props: { pkKey: "id", listArgs, retrieveArgs },
+                    keepOldPages: false,
+                }).toThrow("useListInstance requires keepOldPages.")
+            );
+        });
+        it("throw error when missing props", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields: fields,
+            });
+            expect(() => useListInstance({}).toThrow("useListInstance requires props."));
+        });
+    });
 });

package/tests/unit/use/listRelated.spec.js

@@ -13,8 +13,8 @@ describe("use/listRelated", () => {
         AwaitNot = watchesModule.AwaitNot;
     });
     it("should return a list of related items", async () => {
-        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
-        const relatedListInstance = useListInstance({ props: { pkKey: "id" } });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+        const relatedListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         mainListInstance.addListObject({
             id: "1",
             name: "main",
@@ -82,9 +82,9 @@ describe("use/listRelated", () => {
     });
     it('should allow related objects pkKey to be prefixed with "relatedItem." to reference previously related objects', async () => {
         //
-        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
-        const intermediateListInstance = useListInstance({ props: { pkKey: "id" } });
-        const relatedListInstance = useListInstance({ props: { pkKey: "id" } });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+        const intermediateListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+        const relatedListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         mainListInstance.addListObject({
             id: "1",
             name: "main",