Create expectRedirect test utility

storybookjs · May 15, 2024 · a3353a6 · a3353a6
1 parent c777b40
commit a3353a6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 12 deletions.
diff --git a/app/note/edit/[id]/page.stories.tsx b/app/note/edit/[id]/page.stories.tsx
@@ -5,7 +5,7 @@ import Page from './page'
 import { db } from '#lib/db'
 import { createUserCookie, userCookieKey } from '#lib/session'
 import { PageDecorator } from '#.storybook/decorators'
-import { getRouter } from '@storybook/nextjs/navigation.mock'
+import { expectRedirect } from '#lib/test-utils'
 
 const meta = {
   component: Page,
@@ -49,9 +49,6 @@ export const UnknownId: Story = {
   args: { params: { id: '999' } },
 }
 
-const waitForRedirect = () =>
-  waitFor(() => expect(getRouter().push).toHaveBeenCalled())
-
 export const SavingExistingNoteShouldUpdateDBAndRedirect: Story = {
   play: async ({ canvasElement, step }) => {
     const canvas = within(canvasElement)
@@ -70,7 +67,7 @@ export const SavingExistingNoteShouldUpdateDBAndRedirect: Story = {
     await userEvent.click(
       await canvas.findByRole('menuitem', { name: /done/i }),
     )
-    await waitForRedirect()
+    await expectRedirect()
 
     await expect(await db.note.findUnique({ where: { id: 2 } })).toEqual(
       expect.objectContaining({
@@ -93,7 +90,7 @@ export const DeleteNoteRemovesFromDBAndSidebar: Story = {
     await userEvent.click(
       await canvas.findByRole('menuitem', { name: /delete/i }),
     )
-    await waitForRedirect()
+    await expectRedirect()
 
     await expect(
       await db.note.findMany({ where: { id: 2 } }),

diff --git a/app/note/edit/page.stories.tsx b/app/note/edit/page.stories.tsx
@@ -1,11 +1,11 @@
-import { expect, userEvent, waitFor, within } from '@storybook/test'
+import { expect, userEvent, within } from '@storybook/test'
 import { Meta, StoryObj } from '@storybook/react'
 import { cookies } from '@storybook/nextjs/headers.mock'
 import Page from './page'
 import { db } from '#lib/db'
 import { createUserCookie, userCookieKey } from '#lib/session'
 import { PageDecorator } from '#.storybook/decorators'
-import { getRouter } from '@storybook/nextjs/navigation.mock'
+import { expectRedirect } from '#lib/test-utils'
 
 const meta = {
   component: Page,
@@ -43,9 +43,6 @@ type Story = StoryObj<typeof meta>
 
 export const EditNewNote: Story = {}
 
-const waitForRedirect = () =>
-  waitFor(() => expect(getRouter().push).toHaveBeenCalled())
-
 export const SaveNewNote: Story = {
   play: async ({ canvasElement, step }) => {
     const canvas = within(canvasElement)
@@ -63,7 +60,7 @@ export const SaveNewNote: Story = {
       await canvas.findByRole('menuitem', { name: /done/i }),
     )
 
-    await waitForRedirect()
+    await expectRedirect()
 
     await expect(await db.note.findUnique({ where: { id: 3 } })).toEqual(
       expect.objectContaining({

diff --git a/lib/test-utils.ts b/lib/test-utils.ts
@@ -0,0 +1,5 @@
+import { expect, waitFor } from '@storybook/test'
+import { getRouter } from '@storybook/nextjs/navigation.mock'
+
+export const expectRedirect = () =>
+  waitFor(() => expect(getRouter().push).toHaveBeenCalled())