[Query Copilot] Adding tests for the welcome modal (#1538)

src/Explorer/QueryCopilot/Modal/QueryCopilotFeedbackModal.test.tsx

@@ -0,0 +1,122 @@
+import { Checkbox, ChoiceGroup, DefaultButton, IconButton, PrimaryButton, TextField } from "@fluentui/react";
+import { QueryCopilotFeedbackModal } from "Explorer/QueryCopilot/Modal/QueryCopilotFeedbackModal";
+import { submitFeedback } from "Explorer/QueryCopilot/QueryCopilotUtilities";
+import { getUserEmail } from "Utils/UserUtils";
+import { shallow } from "enzyme";
+import { useQueryCopilot } from "hooks/useQueryCopilot";
+import React from "react";
+
+jest.mock("Utils/UserUtils");
+(getUserEmail as jest.Mock).mockResolvedValue("test@email.com");
+
+jest.mock("Explorer/QueryCopilot/QueryCopilotUtilities");
+submitFeedback as jest.Mock;
+
+describe("Query Copilot Feedback Modal snapshot test", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  it("shoud render and match snapshot", () => {
+    useQueryCopilot.getState().openFeedbackModal("test query", false, "test prompt");
+
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    expect(wrapper.props().isOpen).toBeTruthy();
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should close on cancel click", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    const cancelButton = wrapper.find(IconButton);
+    cancelButton.simulate("click");
+    wrapper.setProps({});
+
+    expect(wrapper.props().isOpen).toBeFalsy();
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should get user unput", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+    const testUserInput = "test user input";
+
+    const userInput = wrapper.find(TextField).first();
+    userInput.simulate("change", {}, testUserInput);
+
+    expect(wrapper.find(TextField).first().props().value).toEqual(testUserInput);
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should record user contact choice no", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+    const contactAllowed = wrapper.find(ChoiceGroup);
+
+    contactAllowed.simulate("change", {}, { key: "no" });
+
+    expect(getUserEmail).toHaveBeenCalledTimes(3);
+    expect(wrapper.find(ChoiceGroup).props().selectedKey).toEqual("no");
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should record user contact choice yes", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+    const contactAllowed = wrapper.find(ChoiceGroup);
+
+    contactAllowed.simulate("change", {}, { key: "yes" });
+
+    expect(getUserEmail).toHaveBeenCalledTimes(4);
+    expect(wrapper.find(ChoiceGroup).props().selectedKey).toEqual("yes");
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should not render dont show again button", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    const dontShowAgain = wrapper.find(Checkbox);
+
+    expect(dontShowAgain).toHaveLength(0);
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should render dont show again button and check it ", () => {
+    useQueryCopilot.getState().openFeedbackModal("test query", true, "test prompt");
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    const dontShowAgain = wrapper.find(Checkbox);
+    dontShowAgain.simulate("change", {}, true);
+
+    expect(wrapper.find(Checkbox)).toHaveLength(1);
+    expect(wrapper.find(Checkbox).first().props().checked).toBeTruthy();
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should cancel submission", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    const cancelButton = wrapper.find(DefaultButton);
+    cancelButton.simulate("click");
+    wrapper.setProps({});
+
+    expect(wrapper.props().isOpen).toBeFalsy();
+    expect(wrapper).toMatchSnapshot();
+  });
+
+  it("should submit submission", () => {
+    const wrapper = shallow(<QueryCopilotFeedbackModal />);
+
+    const submitButton = wrapper.find(PrimaryButton);
+    submitButton.simulate("click");
+    wrapper.setProps({});
+
+    expect(submitFeedback).toHaveBeenCalledTimes(1);
+    expect(submitFeedback).toHaveBeenCalledWith({
+      likeQuery: false,
+      generatedQuery: "",
+      userPrompt: "",
+      description: "",
+      contact: getUserEmail(),
+    });
+    expect(wrapper.props().isOpen).toBeFalsy();
+    expect(wrapper).toMatchSnapshot();
+  });
+});

src/Explorer/QueryCopilot/Modal/QueryCopilotFeedbackModal.tsx

@@ -0,0 +1,111 @@
+import {
+  Checkbox,
+  ChoiceGroup,
+  DefaultButton,
+  IconButton,
+  Link,
+  Modal,
+  PrimaryButton,
+  Stack,
+  Text,
+  TextField,
+} from "@fluentui/react";
+import { submitFeedback } from "Explorer/QueryCopilot/QueryCopilotUtilities";
+import { useQueryCopilot } from "hooks/useQueryCopilot";
+import React from "react";
+import { getUserEmail } from "../../../Utils/UserUtils";
+
+export const QueryCopilotFeedbackModal: React.FC = (): JSX.Element => {
+  const {
+    generatedQuery,
+    userPrompt,
+    likeQuery,
+    showFeedbackModal,
+    closeFeedbackModal,
+    setHideFeedbackModalForLikedQueries,
+  } = useQueryCopilot();
+  const [isContactAllowed, setIsContactAllowed] = React.useState<boolean>(true);
+  const [description, setDescription] = React.useState<string>("");
+  const [doNotShowAgainChecked, setDoNotShowAgainChecked] = React.useState<boolean>(false);
+  const [contact, setContact] = React.useState<string>(getUserEmail());
+
+  return (
+    <Modal isOpen={showFeedbackModal}>
+      <Stack style={{ padding: 24 }}>
+        <Stack horizontal horizontalAlign="space-between">
+          <Text style={{ fontSize: 20, fontWeight: 600, marginBottom: 20 }}>Send feedback to Microsoft</Text>
+          <IconButton iconProps={{ iconName: "Cancel" }} onClick={() => closeFeedbackModal()} />
+        </Stack>
+        <Text style={{ fontSize: 14, marginBottom: 14 }}>Your feedback will help improve the experience.</Text>
+        <TextField
+          styles={{ root: { marginBottom: 14 } }}
+          label="Description"
+          required
+          placeholder="Provide more details"
+          value={description}
+          onChange={(_, newValue) => setDescription(newValue)}
+          multiline
+          rows={3}
+        />
+        <TextField
+          styles={{ root: { marginBottom: 14 } }}
+          label="Query generated"
+          defaultValue={generatedQuery}
+          readOnly
+        />
+        <ChoiceGroup
+          styles={{
+            root: {
+              marginBottom: 14,
+            },
+            flexContainer: {
+              selectors: {
+                ".ms-ChoiceField-field::before": { marginTop: 4 },
+                ".ms-ChoiceField-field::after": { marginTop: 4 },
+                ".ms-ChoiceFieldLabel": { paddingLeft: 6 },
+              },
+            },
+          }}
+          label="May we contact you about your feedback?"
+          options={[
+            { key: "yes", text: "Yes, you may contact me." },
+            { key: "no", text: "No, do not contact me." },
+          ]}
+          selectedKey={isContactAllowed ? "yes" : "no"}
+          onChange={(_, option) => {
+            setIsContactAllowed(option.key === "yes");
+            setContact(option.key === "yes" ? getUserEmail() : "");
+          }}
+        ></ChoiceGroup>
+        <Text style={{ fontSize: 12, marginBottom: 14 }}>
+          By pressing submit, your feedback will be used to improve Microsoft products and services. IT admins for your
+          organization will be able to view and manage your feedback data.{" "}
+          <Link href="" target="_blank">
+            Privacy statement
+          </Link>
+        </Text>
+        {likeQuery && (
+          <Checkbox
+            styles={{ label: { paddingLeft: 0 }, root: { marginBottom: 14 } }}
+            label="Don't show me this next time"
+            checked={doNotShowAgainChecked}
+            onChange={(_, checked) => setDoNotShowAgainChecked(checked)}
+          />
+        )}
+        <Stack horizontal horizontalAlign="end">
+          <PrimaryButton
+            styles={{ root: { marginRight: 8 } }}
+            onClick={() => {
+              closeFeedbackModal();
+              setHideFeedbackModalForLikedQueries(doNotShowAgainChecked);
+              submitFeedback({ generatedQuery, likeQuery, description, userPrompt, contact });
+            }}
+          >
+            Submit
+          </PrimaryButton>
+          <DefaultButton onClick={() => closeFeedbackModal()}>Cancel</DefaultButton>
+        </Stack>
+      </Stack>
+    </Modal>
+  );
+};

src/Explorer/QueryCopilot/Modal/WelcomeModal.test.tsx

@@ -3,7 +3,7 @@ import { withHooks } from "jest-react-hooks-shallow";
 import React from "react";
 import { WelcomeModal } from "./WelcomeModal";
 
-describe("Query Copilot Carousel snapshot test", () => {
+describe("Query Copilot Welcome Modal snapshot test", () => {
   it("should render when isOpen is true", () => {
     withHooks(() => {
       const spy = jest.spyOn(localStorage, "setItem");

src/Explorer/QueryCopilot/Modal/__snapshots__/WelcomeModal.test.tsx.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Query Copilot Carousel snapshot test should render when isOpen is true 1`] = `
+exports[`Query Copilot Welcome Modal snapshot test should render when isOpen is true 1`] = `
 <Fragment>
   <Modal
     isBlocking={false}