feat: add execCmd testing function

mark runSingleOfPromiseCmd as deprecated

Author: atheck

src/Testing/index.ts

@@ -3,6 +3,7 @@ import { Cmd } from "../Cmd";
 /**
  * Executes a single command created by one of the ofPromise functions.
  * @param cmd The command to process.
+ * @deprecated Use execCmd instead.
  */
 export const runSingleOfPromiseCmd = async <TMsg>(cmd: Cmd<TMsg>): Promise<void> => {
     return new Promise<void>((resolve) => {
@@ -25,4 +26,19 @@ export const getOfMsgParams = <TMsg>(cmd?: Cmd<TMsg>): TMsg [] => {
     cmd?.map(c => c(dispatch));
 
     return msgNames;
+};
+
+/**
+ * Executes all commands and resolves the messages.
+ * @param cmd The command to process.
+ * @returns The array of processed messages.
+ */
+export const execCmd = <TMsg>(cmd: Cmd<TMsg>): Promise<TMsg []> => {
+    const callers = cmd.map(c => new Promise<TMsg>((resolve) => {
+        const dispatch = (msg: TMsg) => resolve(msg);
+
+        c(dispatch);
+    }));
+
+    return Promise.all(callers);
 };

tests/Testing.spec.ts

@@ -0,0 +1,85 @@
+import { execCmd, runSingleOfPromiseCmd } from "../src/Testing";
+import { createCmd } from "../src/Cmd";
+
+type Message =
+    | { name: "Msg1" }
+    | { name: "Msg2" }
+    | { name: "Error" }
+    ;
+
+const cmd = createCmd<Message>();
+
+describe("Testing", () => {
+    describe("execCmd", () => {
+        it("executes all message commands", async () => {
+            // arrange
+            const cmds = cmd.batch(cmd.ofMsg({ name: "Msg1" }), cmd.ofMsg({ name: "Msg2" }));
+
+            // act
+            const messages = await execCmd(cmds);
+
+            // assert
+            expect(messages).toEqual([{ name: "Msg1" }, { name: "Msg2" }]);
+        });
+
+        it("executes all ofFunc commands", async () => {
+            // arrange
+            const func = (): void => {
+                return;
+            };
+
+            const cmds = cmd.batch(cmd.ofFunc.either(func, () => ({ name: "Msg1" }), () => ({ name: "Error"})), cmd.ofMsg({ name: "Msg2" }));
+
+            // act
+            const messages = await execCmd(cmds);
+
+            // assert
+            expect(messages).toEqual([{ name: "Msg1" }, { name: "Msg2" }]);
+        });
+
+        it("executes all ofFunc commands, fail", async () => {
+            // arrange
+            const func = (): void => {
+                throw Error();
+            };
+
+            const cmds = cmd.batch(cmd.ofFunc.either(func, () => ({ name: "Msg1" }), () => ({ name: "Error"})), cmd.ofMsg({ name: "Msg2" }));
+
+            // act
+            const messages = await execCmd(cmds);
+
+            // assert
+            expect(messages).toEqual([{ name: "Error" }, { name: "Msg2" }]);
+        });
+
+        it("executes all ofPromise commands", async () => {
+            // arrange
+            const asyncFunc = (): Promise<void> => {
+                return Promise.resolve();
+            };
+
+            const cmds = cmd.batch(cmd.ofPromise.either(asyncFunc, () => ({ name: "Msg1" }), () => ({ name: "Error"})), cmd.ofMsg({ name: "Msg2" }));
+
+            // act
+            const messages = await execCmd(cmds);
+
+            // assert
+            expect(messages).toEqual([{ name: "Msg1" }, { name: "Msg2" }]);
+        });
+
+        it("executes all ofPromise commands, fail", async () => {
+            // arrange
+            const asyncFunc = (): Promise<void> => {
+                return Promise.reject();
+            };
+
+            const cmds = cmd.batch(cmd.ofPromise.either(asyncFunc, () => ({ name: "Msg1" }), () => ({ name: "Error"})), cmd.ofMsg({ name: "Msg2" }));
+
+            // act
+            const messages = await execCmd(cmds);
+
+            // assert
+            expect(messages).toEqual([{ name: "Error" }, { name: "Msg2" }]);
+        });
+    });
+});