Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Reuse note input stories in tests

Anibal Svarcas92c5d56c4d39
diff --git a/src/components/atomic-crm/notes/NoteInputs.stories.tsx b/src/components/atomic-crm/notes/NoteInputs.stories.tsx
new file mode 100644
index 00000000..3dfcf090
--- /dev/null
+++ b/src/components/atomic-crm/notes/NoteInputs.stories.tsx
@@ -0,0 +1,78 @@
+import type { Meta, StoryObj } from "@storybook/react-vite";
+import { CoreAdminContext, Form } from "ra-core";
+import fakeDataProvider from "ra-data-fakerest";
+
+import { NoteInputs } from "./NoteInputs";
+import { SaveButton } from "@/components/admin/form";
+
+const testI18nProvider = {
+ translate: (key: string) =>
+ (
+ ({
+ "resources.notes.inputs.add_note": "Add a note",
+ "resources.notes.inputs.show_options": "Show options",
+ "resources.notes.fields.date": "Date",
+ "resources.notes.fields.attachments": "Attachments",
+ "resources.notes.fields.status": "Status",
+ "resources.notes.fields.contact_id": "Contact",
+ "resources.notes.fields.deal_id": "Deal",
+ "resources.notes.validation.note_or_attachment_required":
+ "A note or an attachment is required",
+ "ra.action.save": "Save",
+ }) as Record<string, string>
+ )[key] ?? key,
+ changeLocale: () => Promise.resolve(),
+ getLocale: () => "en",
+};
+
+const dataProvider = fakeDataProvider({
+ notes: [],
+ contacts: [],
+ deals: [],
+ sales: [],
+});
+
+type NoteInputsStoryProps = React.ComponentProps<typeof NoteInputs> & {
+ defaultValues?: Record<string, unknown>;
+ withSaveButton?: boolean;
+};
+
+export const NoteInputsStory = ({
+ defaultValues,
+ withSaveButton = false,
+ ...props
+}: NoteInputsStoryProps) => (
+ <CoreAdminContext dataProvider={dataProvider} i18nProvider={testI18nProvider}>
+ <Form defaultValues={defaultValues}>
+ <NoteInputs {...props} />
+ {withSaveButton ? <SaveButton type="button" /> : null}
+ </Form>
+ </CoreAdminContext>
+);
+
+const meta = {
+ title: "Atomic CRM/Notes/Note Inputs",
+ includeStories: ["Default", "WithSaveButton", "WithAttachmentDefault"],
+ render: (args) => <NoteInputsStory {...args} />,
+} satisfies Meta<typeof NoteInputsStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};
+
+export const WithSaveButton: Story = {
+ args: {
+ withSaveButton: true,
+ },
+};
+
+export const WithAttachmentDefault: Story = {
+ args: {
+ defaultValues: {
+ attachments: [{ src: "blob:test", title: "evidence.pdf" }],
+ },
+ withSaveButton: true,
+ },
+};
diff --git a/src/components/atomic-crm/notes/NoteInputs.test.tsx b/src/components/atomic-crm/notes/NoteInputs.test.tsx
index 8030854d..3c84a6fb 100644
--- a/src/components/atomic-crm/notes/NoteInputs.test.tsx
+++ b/src/components/atomic-crm/notes/NoteInputs.test.tsx
@@ -1,58 +1,15 @@
+import { composeStories } from "@storybook/react-vite";
import { render } from "vitest-browser-react";
-import { CoreAdminContext, Form } from "ra-core";
-import fakeDataProvider from "ra-data-fakerest";
-
-import { NoteInputs } from "./NoteInputs";
-import { SaveButton } from "@/components/admin/form";
-import { defaultConfiguration } from "../root/defaultConfiguration";
-
-vi.mock("../root/ConfigurationContext", () => ({
- useConfigurationContext: () => defaultConfiguration,
-}));
+import * as stories from "./NoteInputs.stories";
+import { NoteInputsStory } from "./NoteInputs.stories";
const mockIsMobile = vi.hoisted(() => vi.fn(() => false));
vi.mock("@/hooks/use-mobile", () => ({
useIsMobile: mockIsMobile,
}));
-const testI18nProvider = {
- translate: (key: string) =>
- (
- ({
- "resources.notes.inputs.add_note": "Add a note",
- "resources.notes.inputs.show_options": "Show options",
- "resources.notes.fields.date": "Date",
- "resources.notes.fields.attachments": "Attachments",
- "resources.notes.fields.status": "Status",
- "resources.notes.fields.contact_id": "Contact",
- "resources.notes.fields.deal_id": "Deal",
- "resources.notes.validation.note_or_attachment_required":
- "A note or an attachment is required",
- "ra.action.save": "Save",
- }) as Record<string, string>
- )[key] ?? key,
- changeLocale: () => Promise.resolve(),
- getLocale: () => "en",
-};
-
-const dataProvider = fakeDataProvider({
- notes: [],
- contacts: [],
- deals: [],
- sales: [],
-});
-
-const Wrapper = ({
- children,
- defaultValues,
-}: {
- children: React.ReactNode;
- defaultValues?: Record<string, unknown>;
-}) => (
- <CoreAdminContext dataProvider={dataProvider} i18nProvider={testI18nProvider}>
- <Form defaultValues={defaultValues}>{children}</Form>
- </CoreAdminContext>
-);
+const { Default, WithAttachmentDefault, WithSaveButton } =
+ composeStories(stories);
describe("NoteInputs", () => {
beforeEach(() => {
@@ -65,17 +22,13 @@ describe("NoteInputs", () => {
});
it("renders the note textarea", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await expect.element(screen.getByPlaceholder("Add a note")).toBeVisible();
});
it("shows the 'Show options' button on desktop when displayMore is false", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await expect
.element(screen.getByRole("button", { name: "Show options" }))
@@ -85,9 +38,7 @@ describe("NoteInputs", () => {
it("does not show the 'Show options' button on mobile", async () => {
mockIsMobile.mockReturnValue(true);
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await expect
.element(screen.getByRole("button", { name: "Show options" }))
@@ -95,9 +46,7 @@ describe("NoteInputs", () => {
});
it("reveals the extra options section after clicking 'Show options'", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
const showOptionsButton = screen.getByRole("button", {
name: "Show options",
@@ -113,9 +62,7 @@ describe("NoteInputs", () => {
});
it("renders the status selector when showStatus is true", async () => {
- const screen = await render(<NoteInputs showStatus />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<NoteInputsStory showStatus />);
// Click 'Show options' to reveal the hidden section
await screen.getByRole("button", { name: "Show options" }).click();
@@ -124,19 +71,14 @@ describe("NoteInputs", () => {
});
it("does not render the status selector when showStatus is false", async () => {
- const screen = await render(<NoteInputs showStatus={false} />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await expect.element(screen.getByText("Status")).not.toBeInTheDocument();
});
it("renders the contact reference selector when selectReference is contacts", async () => {
const screen = await render(
- <NoteInputs selectReference reference="contacts" />,
- {
- wrapper: Wrapper,
- },
+ <NoteInputsStory reference="contacts" selectReference />,
);
await expect.element(screen.getByText("Contact")).toBeVisible();
@@ -144,28 +86,21 @@ describe("NoteInputs", () => {
it("renders the deal reference selector when selectReference is deals", async () => {
const screen = await render(
- <NoteInputs selectReference reference="deals" />,
- {
- wrapper: Wrapper,
- },
+ <NoteInputsStory reference="deals" selectReference />,
);
await expect.element(screen.getByText("Deal")).toBeVisible();
});
it("does not render a reference selector when selectReference is not set", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await expect.element(screen.getByText("Contact")).not.toBeInTheDocument();
await expect.element(screen.getByText("Deal")).not.toBeInTheDocument();
});
it("should have the current date as default value for the date input", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: Wrapper,
- });
+ const screen = await render(<Default />);
await screen.getByRole("button", { name: "Show options" }).click();
@@ -179,13 +114,9 @@ describe("NoteInputs", () => {
});
it("should use the note date instead of the current date when it is set", async () => {
- const screen = await render(<NoteInputs />, {
- wrapper: ({ children }) => (
- <Wrapper defaultValues={{ date: "2024-01-01T12:00" }}>
- {children}
- </Wrapper>
- ),
- });
+ const screen = await render(
+ <NoteInputsStory defaultValues={{ date: "2024-01-01T12:00" }} />,
+ );
await screen.getByRole("button", { name: "Show options" }).click();
@@ -195,15 +126,7 @@ describe("NoteInputs", () => {
});
it("shows a validation error when submitting an empty note without attachments", async () => {
- const screen = await render(
- <>
- <NoteInputs />
- <SaveButton type="button" />
- </>,
- {
- wrapper: Wrapper,
- },
- );
+ const screen = await render(<WithSaveButton />);
await screen.getByRole("button", { name: "Save" }).click();
@@ -213,15 +136,7 @@ describe("NoteInputs", () => {
});
it("treats whitespace-only note text as empty", async () => {
- const screen = await render(
- <>
- <NoteInputs />
- <SaveButton type="button" />
- </>,
- {
- wrapper: Wrapper,
- },
- );
+ const screen = await render(<WithSaveButton />);
await screen.getByPlaceholder("Add a note").fill(" ");
await screen.getByRole("button", { name: "Save" }).click();
@@ -232,15 +147,7 @@ describe("NoteInputs", () => {
});
it("allows submitting a note with text only", async () => {
- const screen = await render(
- <>
- <NoteInputs />
- <SaveButton type="button" />
- </>,
- {
- wrapper: Wrapper,
- },
- );
+ const screen = await render(<WithSaveButton />);
await screen.getByPlaceholder("Add a note").fill("Call summary");
await screen.getByRole("button", { name: "Save" }).click();
@@ -251,23 +158,7 @@ describe("NoteInputs", () => {
});
it("allows submitting a note with an attachment and no text", async () => {
- const screen = await render(
- <>
- <NoteInputs />
- <SaveButton type="button" />
- </>,
- {
- wrapper: ({ children }) => (
- <Wrapper
- defaultValues={{
- attachments: [{ src: "blob:test", title: "evidence.pdf" }],
- }}
- >
- {children}
- </Wrapper>
- ),
- },
- );
+ const screen = await render(<WithAttachmentDefault />);
await screen.getByRole("button", { name: "Save" }).click();