Merge pull request #2513 from IDEMSInternational/feat/set-data-action…

…-standalone

Feat: set data action standalone

packages/data-models/flowTypes.ts

@@ -432,6 +432,7 @@ export namespace FlowTypes {
     "pop_up",
     "process_template",
     "reset_app",
+    "reset_data",
     "save_to_device",
     "screen_orientation",
     "set_field",

packages/shared/src/utils/object-utils.ts

@@ -100,8 +100,7 @@ export function isEqual(a: any, b: any) {
     if (!isEqual(Object.keys(aSorted), Object.keys(bSorted))) return false;
     return isEqual(Object.values(aSorted), Object.values(bSorted));
   }
-  // could not compare (e.g. symbols, date objects, functions, buffers etc)
-  console.warn(`[isEqual] could not compare`, a, b);
+  // NOTE - does not compare symbols, date objects, functions, buffers etc.
   return false;
 }
 

src/app/shared/components/template/services/instance/template-action.registry.ts

@@ -3,10 +3,8 @@ import clone from "clone";
 import { FlowTypes } from "data-models";
 
 export type IActionId = FlowTypes.TemplateRowAction["action_id"];
-export type IActionHandlers = Record<
-  IActionId,
-  (action: FlowTypes.TemplateRowAction) => Promise<any>
->;
+export type IActionHandler = (action: FlowTypes.TemplateRowAction) => Promise<any>;
+export type IActionHandlers = Record<IActionId, IActionHandler>;
 
 @Injectable({ providedIn: "root" })
 /**

src/app/shared/components/template/services/template-field.service.spec.ts

@@ -4,7 +4,7 @@ import { TemplateFieldService } from "./template-field.service";
 import type { PromiseExtended } from "dexie";
 import { booleanStringToBoolean } from "src/app/shared/utils";
 import { ErrorHandlerService } from "src/app/shared/services/error-handler/error-handler.service";
-import { MockErrorHandlerService } from "src/app/shared/services/error-handler/error-handler.service.spec";
+import { MockErrorHandlerService } from "src/app/shared/services/error-handler/error-handler.service.mock.spec";
 
 /** Mock calls for field values from the template field service to return test data */
 export class MockTemplateFieldService implements Partial<TemplateFieldService> {

src/app/shared/services/data/app-data.service.spec.ts

@@ -7,7 +7,7 @@ import { AppDataService, IAppDataCache } from "./app-data.service";
 import { FlowTypes } from "../../model";
 import { MockAppDataVariableService } from "./app-data-variable.service.spec";
 import { ErrorHandlerService } from "../error-handler/error-handler.service";
-import { MockErrorHandlerService } from "../error-handler/error-handler.service.spec";
+import { MockErrorHandlerService } from "../error-handler/error-handler.service.mock.spec";
 import { DbService } from "../db/db.service";
 import { MockDbService } from "../db/db.service.spec";
 import { Injectable } from "@angular/core";

src/app/shared/services/dynamic-data/adapters/persistedMemory.ts

@@ -135,7 +135,7 @@ export class PersistedMemoryAdapter {
     this.persistStateToDB();
   }
 
-  public async delete(flow_type: FlowTypes.FlowType, flow_name: string) {
+  public delete(flow_type: FlowTypes.FlowType, flow_name: string) {
     if (this.get(flow_type, flow_name)) {
       delete this.state[flow_type][flow_name];
       this.persistStateToDB();

src/app/shared/services/dynamic-data/dynamic-data.actions.spec.ts

@@ -0,0 +1,200 @@
+import { TestBed } from "@angular/core/testing";
+
+import { HttpClientTestingModule } from "@angular/common/http/testing";
+import { MockAppDataService } from "../data/app-data.service.spec";
+import { AppDataService } from "../data/app-data.service";
+
+import { IActionSetDataParams } from "./dynamic-data.actions";
+import { DynamicDataService } from "./dynamic-data.service";
+import ActionFactory from "./dynamic-data.actions";
+import { firstValueFrom } from "rxjs";
+import { FlowTypes } from "packages/data-models";
+import { DeploymentService } from "../deployment/deployment.service";
+import { MockDeploymentService } from "../deployment/deployment.service.spec";
+import { TemplateActionRegistry } from "../../components/template/services/instance/template-action.registry";
+
+const TEST_DATA_ROWS = [
+  { id: "id_0", number: 0, string: "hello", _meta: "original" },
+  { id: "id_1", number: 1, string: "hello", boolean: true, _meta: "original" },
+];
+
+/********************************************************************************
+ * Test Utilities
+ *******************************************************************************/
+
+/** Generate a rows to trigger set_data action with included params */
+function getTestActionRow(params: IActionSetDataParams) {
+  params._list_id = "test_flow";
+  const actionRow: FlowTypes.TemplateRowAction = {
+    action_id: "set_data",
+    trigger: "click",
+    args: [],
+    params,
+  };
+  return actionRow;
+}
+
+/**
+ * Trigger the set_data action with included params and return first update
+ * to corresponding data_list
+ * * */
+async function triggerTestSetDataAction(service: DynamicDataService, params: IActionSetDataParams) {
+  const actionRow = getTestActionRow(params);
+  const actions = new ActionFactory(service);
+  await actions.set_data(actionRow);
+  const obs = await service.query$<any>("data_list", "test_flow");
+  const data = await firstValueFrom(obs);
+  return data;
+}
+
+/********************************************************************************
+ * Tests
+ * yarn ng test --include src/app/shared/services/dynamic-data/dynamic-data.actions.spec.ts
+ *******************************************************************************/
+describe("DynamicDataService Actions", () => {
+  let service: DynamicDataService;
+  let actions: ActionFactory;
+
+  beforeEach(async () => {
+    TestBed.configureTestingModule({
+      imports: [HttpClientTestingModule],
+      providers: [
+        DynamicDataService,
+        {
+          provide: AppDataService,
+          useValue: new MockAppDataService({
+            data_list: {
+              test_flow: {
+                flow_name: "test_flow",
+                flow_type: "data_list",
+                // Make deep clone of data to avoid data overwrite issues
+                rows: JSON.parse(JSON.stringify(TEST_DATA_ROWS)),
+              },
+            },
+          }),
+        },
+        {
+          provide: DeploymentService,
+          useValue: new MockDeploymentService({ name: "test" }),
+        },
+        {
+          provide: TemplateActionRegistry,
+          useValue: { register: () => null },
+        },
+      ],
+    });
+
+    // HACK - polyfill not loaded for rxdb dev plugin so manually fill global before running tests
+    window.global = window;
+
+    service = TestBed.inject(DynamicDataService);
+    await service.ready();
+    // Ensure any data previously persisted is cleared
+    await service.resetFlow("data_list", "test_flow");
+    actions = new ActionFactory(service);
+  });
+
+  /*************************************************************
+   *  Main Tests
+   ************************************************************/
+  it("set_data by _id", async () => {
+    const params: IActionSetDataParams = { _id: "id_1", string: "updated string" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].string).toEqual("hello");
+    expect(data[1].string).toEqual("updated string");
+  });
+
+  it("set_data by _index", async () => {
+    const params: IActionSetDataParams = { _index: 1, string: "updated string" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].string).toEqual("hello");
+    expect(data[1].string).toEqual("updated string");
+  });
+
+  it("set_data bulk", async () => {
+    const params: IActionSetDataParams = { string: "updated string" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].string).toEqual("updated string");
+    expect(data[1].string).toEqual("updated string");
+  });
+
+  it("set_data with item ref (single)", async () => {
+    const params: IActionSetDataParams = { _id: "id_1", number: "@item.number + 100" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].number).toEqual(0);
+    expect(data[1].number).toEqual(101);
+  });
+
+  it("set_data with item ref (bulk)", async () => {
+    const params: IActionSetDataParams = { number: "@item.number + 100" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].number).toEqual(100);
+    expect(data[1].number).toEqual(101);
+  });
+
+  it("set_data ignores updates for unchanged data", async () => {
+    const params: IActionSetDataParams = { _list_id: "test_flow", number: 1 };
+    const updates = await actions["generateUpdateList"](params);
+    expect(updates).toEqual([{ id: "id_0", number: 1 }]);
+  });
+
+  it("set_data prevents update to metadata fields", async () => {
+    const params: IActionSetDataParams = { _meta: "updated", string: "updated" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].string).toEqual("updated");
+    expect(data[0]._meta).toEqual("original");
+  });
+
+  it("set_data ignores evaluation when _updates provided", async () => {
+    const params: IActionSetDataParams = { _updates: [{ id: "id_0", number: "@item.number" }] };
+    const data = await triggerTestSetDataAction(service, params);
+    // test case illustrative only of not parsing data (would have been parsed independently)
+    expect(data[0].number).toEqual("@item.number");
+    expect(data[1].number).toEqual(1);
+  });
+
+  it("reset_data action restores data to initial", async () => {
+    const updatedData = await triggerTestSetDataAction(service, { string: "updated string" });
+    expect(updatedData[0].string).toEqual("updated string");
+    const resetActionBase = getTestActionRow({});
+    await actions.reset_data({ ...resetActionBase, action_id: "reset_data" });
+    const obs = await service.query$<any>("data_list", "test_flow");
+    const resetData = await firstValueFrom(obs);
+    expect(resetData[0].string).toEqual("hello");
+  });
+
+  /*************************************************************
+   *  Misc
+   ************************************************************/
+
+  it("Coerces string params to correct data type", async () => {
+    // NOTE - there is no specific code that casts variables, but RXDB will infer from schema
+    const params: IActionSetDataParams = { number: "300" };
+    const data = await triggerTestSetDataAction(service, params);
+    expect(data[0].number).toEqual(300);
+  });
+
+  /*************************************************************
+   *  Quality Control
+   ************************************************************/
+
+  it("throws error if provided _id does not exist", async () => {
+    const params = getTestActionRow({
+      _id: "missing_id",
+      string: "sets an item correctly a given id",
+    });
+    await expectAsync(actions.set_data(params)).toBeRejectedWithError(
+      `[Update Fail] no doc exists\ndata_list: test_flow\n_id: missing_id`
+    );
+  });
+
+  it("throws error if provided _index does not exist", async () => {
+    const params = getTestActionRow({
+      _index: 10,
+      string: "sets an item correctly a given id",
+    });
+    await expectAsync(actions.set_data(params)).toBeRejectedWithError(
+      `[Update Fail] no doc exists\ndata_list: test_flow\n_index: 10`
+    );
+  });
+});