Ml/nobranch add dependency control pattern

features/GroupInvites/joinGroup/joinGroup.machine.test.ts

@@ -0,0 +1,228 @@
+import { createActor, waitFor } from "xstate";
+
+import { JoinGroupClient } from "./JoinGroup.client";
+import { joinGroupMachineLogic } from "./joinGroup.machine";
+import { Controlled } from "../../../dependencies/Environment/Environment";
+import { GroupInvite } from "@utils/api.types";
+
+jest.setTimeout(1);
+
+describe("Joining a Group from an Invite", () => {
+  let OriginalCurrent: typeof Controlled;
+  beforeEach(() => {
+    OriginalCurrent = { ...Controlled };
+  });
+
+  afterEach(() => {
+    Object.entries(OriginalCurrent).forEach(([key, value]) => {
+      // todo fix this any crap
+      Controlled[key as keyof typeof Controlled] = value as any;
+    });
+  });
+
+  it("Should Successfully allow an Invited user to join with a valid group invite", async () => {
+    const newlyInvitedGroupId = "groupIdAbc";
+    let navigateToGroupPayload: any = null;
+    const navigateToGroupScreenSpy = jest.fn((payload) => {
+      navigateToGroupPayload = payload;
+    });
+    Controlled.joinGroupClient =
+      JoinGroupClient.userNotAMemberOfGroupWithId(newlyInvitedGroupId);
+
+    const input = { groupInviteId: "irrelevant", account: "irrelevant" };
+    const joinGroupActor = createActor(
+      joinGroupMachineLogic.provide({
+        actions: {
+          navigateToGroupScreen: navigateToGroupScreenSpy,
+        },
+      }),
+      {
+        input,
+      }
+    ).start();
+
+    expect(joinGroupActor.getSnapshot().value).toBe(
+      "Loading Group Invite Metadata"
+    );
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Loading Initially Joined Groups")
+    );
+
+    expect(
+      joinGroupActor.getSnapshot().context.groupInviteMetadata
+    ).toBeDefined();
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Waiting For User Action")
+    );
+
+    joinGroupActor.send({ type: "user.didTapJoinGroup" });
+    expect(joinGroupActor.getSnapshot().value).toBe("Attempting to Join Group");
+
+    Controlled.joinGroupClient =
+      JoinGroupClient.userAMemberOfGroupWithId(newlyInvitedGroupId);
+
+    // Wait for join attempt to complete
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Determining Newly Joined Group")
+    );
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Providing User Consent to Join Group")
+    );
+
+    await waitFor(joinGroupActor, (state) => state.matches("Refreshing Group"));
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("User Joined Group")
+    );
+
+    expect(navigateToGroupScreenSpy).toHaveBeenCalledTimes(1);
+    expect(navigateToGroupPayload.context.groupInviteMetadata.groupId).toBe(
+      newlyInvitedGroupId
+    );
+  });
+
+  it("Should transition to 'User Was Already a Member of Group Prior to Clicking Join Link' if the user has already joined the group before user action", async () => {
+    const GroupIdUserWasAlreadyAMemberOf = "AwesomeSupercoolGroupId";
+    let navigateToGroupPayload: any = null;
+    const navigateToGroupScreenSpy = jest.fn((payload) => {
+      navigateToGroupPayload = payload;
+    });
+    Controlled.joinGroupClient = JoinGroupClient.userAMemberOfGroupWithId(
+      GroupIdUserWasAlreadyAMemberOf
+    );
+
+    const input = { groupInviteId: "valid-invite-id", account: "0x123" };
+    const joinGroupActor = createActor(
+      joinGroupMachineLogic.provide({
+        actions: {
+          navigateToGroupScreen: navigateToGroupScreenSpy,
+        },
+      }),
+      {
+        input,
+      }
+    ).start();
+
+    // Initial state
+    expect(joinGroupActor.getSnapshot().value).toBe(
+      "Loading Group Invite Metadata"
+    );
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Loading Initially Joined Groups")
+    );
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches(
+        "User Was Already a Member of Group Prior to Clicking Join Link"
+      )
+    );
+
+    joinGroupActor.send({ type: "user.didTapOpenConversation" });
+
+    expect(navigateToGroupScreenSpy).toHaveBeenCalledTimes(1);
+    expect(navigateToGroupPayload.context.groupInviteMetadata.groupId).toBe(
+      GroupIdUserWasAlreadyAMemberOf
+    );
+  });
+
+  it("It should transition to 'User Has Been Blocked From Group' if User was blocked from group", async () => {
+    const blockedGroupId = "groupIdAbc";
+    let navigateToGroupPayload: any = null;
+    const navigateToGroupScreenSpy = jest.fn((payload) => {
+      navigateToGroupPayload = payload;
+    });
+    Controlled.joinGroupClient =
+      JoinGroupClient.userBlockedFromGroupWithId(blockedGroupId);
+
+    const input = { groupInviteId: "irrelevant", account: "irrelevant" };
+    const joinGroupActor = createActor(
+      joinGroupMachineLogic.provide({
+        actions: {
+          navigateToGroupScreen: navigateToGroupScreenSpy,
+        },
+      }),
+      {
+        input,
+      }
+    ).start();
+
+    // Initial state
+    expect(joinGroupActor.getSnapshot().value).toBe(
+      "Loading Group Invite Metadata"
+    );
+
+    // Wait for metadata to load
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Loading Initially Joined Groups")
+    );
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("User Has Been Blocked From Group")
+    );
+  });
+
+  it("Should transition to Attempting to Join Group Timed Out if the attempt times out", async () => {
+    jest.useFakeTimers();
+    const newlyInvitedGroupId = "groupIdAbc";
+    let navigateToGroupPayload: any = null;
+    const navigateToGroupScreenSpy = jest.fn((payload) => {
+      navigateToGroupPayload = payload;
+    });
+    Controlled.joinGroupClient =
+      JoinGroupClient.userJoinGroupTimeout(newlyInvitedGroupId);
+
+    const input = { groupInviteId: "irrelevant", account: "irrelevant" };
+    const joinGroupActor = createActor(
+      joinGroupMachineLogic.provide({
+        actions: {
+          navigateToGroupScreen: navigateToGroupScreenSpy,
+        },
+      }),
+      {
+        input,
+      }
+    ).start();
+
+    // Initial state
+    expect(joinGroupActor.getSnapshot().value).toBe(
+      "Loading Group Invite Metadata"
+    );
+
+    // Wait for metadata to load
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Loading Initially Joined Groups")
+    );
+
+    await waitFor(
+      joinGroupActor,
+      (state) => !state.matches("Loading Initially Joined Groups")
+    );
+
+    expect(
+      joinGroupActor.getSnapshot().context.groupInviteMetadata
+    ).toBeDefined();
+
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Waiting For User Action")
+    );
+
+    // User taps join group
+    joinGroupActor.send({ type: "user.didTapJoinGroup" });
+    expect(joinGroupActor.getSnapshot().value).toBe("Attempting to Join Group");
+
+    jest.advanceTimersByTime(2500);
+    jest.advanceTimersByTime(2500);
+
+    // Wait for join attempt to complete
+    await waitFor(joinGroupActor, (state) =>
+      state.matches("Attempting to Join Group Timed Out")
+    );
+    expect(navigateToGroupPayload).toBeNull();
+    expect(navigateToGroupScreenSpy).not.toHaveBeenCalled();
+    jest.useRealTimers();
+  });
+});