test(sanity): update and re-write unit tests (CreateReleaseDialog/useVersionOperations) (#7853)

Author: RitaDias

packages/sanity/src/core/releases/components/dialog/CreateReleaseDialog.tsx

@@ -30,6 +30,8 @@ export function CreateReleaseDialog(props: CreateReleaseDialogProps): JSX.Elemen
     return {
       _id: createReleaseId(),
       metadata: {
+        title: '',
+        description: '',
         releaseType: DEFAULT_RELEASE_TYPE,
       },
     } as const

packages/sanity/src/core/releases/components/dialog/__tests__/CreateReleaseDialog.test.tsx

@@ -1,40 +1,17 @@
-import {fireEvent, render, screen} from '@testing-library/react'
-import {afterEach, beforeEach, describe, expect, it, type Mock, vi, vitest} from 'vitest'
+import {act, fireEvent, render, screen, waitFor} from '@testing-library/react'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
 
 import {createTestProvider} from '../../../../../../test/testUtils/TestProvider'
+import {activeASAPRelease} from '../../../__fixtures__/release.fixture'
 import {type ReleaseDocument} from '../../../index'
-import {useReleaseOperations} from '../../../store/useReleaseOperations'
-import {useReleases} from '../../../store/useReleases'
+import {useReleaseOperationsMockReturn} from '../../../store/__tests__/__mocks/useReleaseOperations.mock'
 import {CreateReleaseDialog} from '../CreateReleaseDialog'
 
-vi.mock('../../../store/useReleases', () => ({
-  useReleases: vi.fn(),
+vi.mock('../../../store/useReleaseOperations', () => ({
+  useReleaseOperations: vi.fn(() => useReleaseOperationsMockReturn),
 }))
 
-vi.mock('../../../../store/release/useReleaseOperations', () => ({
-  useReleaseOperations: vi.fn().mockReturnValue({
-    createRelease: vi.fn(),
-    updateRelease: vi.fn(),
-  }),
-}))
-
-vi.mock('../../../i18n/hooks/useTranslation', () => ({
-  useTranslate: vi.fn().mockReturnValue({
-    t: vi.fn(),
-  }),
-}))
-
-const mockUseBundleStore = useReleases as Mock<typeof useReleases>
-//const mockUseDateTimeFormat = useDateTimeFormat as Mock
-
 describe('CreateReleaseDialog', () => {
-  beforeEach(() => {
-    vi.clearAllMocks()
-  })
-  afterEach(() => {
-    vi.clearAllMocks()
-  })
-
   describe('when creating a new release', () => {
     const onCancelMock = vi.fn()
     const onSubmitMock = vi.fn()
@@ -43,23 +20,9 @@ describe('CreateReleaseDialog', () => {
       onCancelMock.mockClear()
       onSubmitMock.mockClear()
 
-      mockUseBundleStore.mockReturnValue({
-        data: [],
-        loading: true,
-        dispatch: vi.fn(),
-        error: undefined,
-        releasesIds: [],
-        archivedReleases: [],
-      })
-
-      //mockUseDateTimeFormat.mockReturnValue({format: vi.fn().mockReturnValue('Mocked date')})
-
       const wrapper = await createTestProvider()
       render(<CreateReleaseDialog onCancel={onCancelMock} onSubmit={onSubmitMock} />, {wrapper})
     })
-    afterEach(() => {
-      vitest.resetAllMocks()
-    })
 
     it('should render the dialog', () => {
       expect(screen.getByRole('dialog')).toBeInTheDocument()
@@ -71,35 +34,27 @@ describe('CreateReleaseDialog', () => {
       expect(onCancelMock).toHaveBeenCalled()
     })
 
-    // TODO: Fix this test
-    it.skip('should call createRelease and onCreate when form is submitted', async () => {
-      // const wrapper = await createTestProvider()
-      // render(<CreateReleaseDialog onCancel={onCancelMock} onSubmit={onSubmitMock} />, {wrapper})
-
-      const value: Partial<ReleaseDocument> = {
-        metadata: {
-          title: 'Bundle 1',
-          description: undefined,
-          intendedPublishAt: undefined,
-          releaseType: 'asap',
-        },
-      }
+    it('should call createRelease and onCreate when form is submitted', async () => {
+      const value: Partial<ReleaseDocument> = activeASAPRelease
 
-      const titleInput = screen.getByTestId('release-form-title')
-      fireEvent.change(titleInput, {target: {value: value.metadata?.title}})
+      act(async () => {
+        const titleInput = screen.getByTestId('release-form-title')
+        fireEvent.change(titleInput, {target: {value: value.metadata?.title}})
 
-      const submitButton = screen.getByTestId('submit-release-button')
-      fireEvent.click(submitButton)
+        const submitButton = screen.getByTestId('submit-release-button')
+        fireEvent.click(submitButton)
 
-      expect(useReleaseOperations().createRelease).toHaveBeenCalledWith(
-        expect.objectContaining({
-          _id: expect.stringContaining('releases'),
-          ...value,
-        }),
-      )
-      await Promise.resolve()
+        waitFor(async () => {
+          await Promise.resolve()
 
-      expect(onSubmitMock).toHaveBeenCalled()
+          expect(onSubmitMock).toHaveBeenCalledOnce()
+          expect(useReleaseOperationsMockReturn.createRelease).toHaveBeenCalledWith(
+            expect.objectContaining({
+              _id: expect.stringContaining('releases'),
+            }),
+          )
+        })
+      })
     })
   })
 })

packages/sanity/src/core/releases/hooks/__tests__/__mocks__/useVersionOperations.mock.ts

@@ -0,0 +1,10 @@
+import {type Mock, type Mocked, vi} from 'vitest'
+
+import {useVersionOperations, type VersionOperationsValue} from '../../useVersionOperations'
+
+export const useVersionOperationsReturn: Mocked<VersionOperationsValue> = {
+  createVersion: vi.fn(),
+  discardVersion: vi.fn(),
+}
+
+export const mockUseVersionOperations = useVersionOperations as Mock<typeof useVersionOperations>

packages/sanity/src/core/releases/hooks/__tests__/useVersionOperations.test.tsx

@@ -1,13 +1,50 @@
-import {beforeEach, describe, it, vi} from 'vitest'
+import {act, renderHook} from '@testing-library/react'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {createTestProvider} from '../../../../../test/testUtils/TestProvider'
+import {useReleaseOperationsMockReturn} from '../../store/__tests__/__mocks/useReleaseOperations.mock'
+import {useVersionOperations} from '../useVersionOperations'
+import {usePerspectiveMockReturn} from './__mocks__/usePerspective.mock'
+
+vi.mock('../../store/useReleaseOperations', () => ({
+  useReleaseOperations: vi.fn(() => useReleaseOperationsMockReturn),
+}))
+
+vi.mock('../usePerspective', () => ({
+  usePerspective: vi.fn(() => usePerspectiveMockReturn),
+}))
 
 describe('useVersionOperations', () => {
   beforeEach(() => {
     vi.clearAllMocks()
   })
 
-  it.todo('should create a version successfully', async () => {})
+  it('should create a version successfully', async () => {
+    const wrapper = await createTestProvider()
+    const {result} = renderHook(() => useVersionOperations(), {wrapper})
+
+    await act(async () => {
+      await result.current.createVersion('releaseId', 'documentId')
+    })
+
+    expect(useReleaseOperationsMockReturn.createVersion).toHaveBeenCalledWith(
+      'releaseId',
+      'documentId',
+    )
+    expect(usePerspectiveMockReturn.setPerspectiveFromReleaseId).toHaveBeenCalledWith('releaseId')
+  })
+
+  it('should discard a version successfully', async () => {
+    const wrapper = await createTestProvider()
+    const {result} = renderHook(() => useVersionOperations(), {wrapper})
 
-  it.todo('should discard a version successfully')
+    await act(async () => {
+      await result.current.discardVersion('releaseId', 'documentId')
+    })
 
-  it.todo('should handle discard version failure')
+    expect(useReleaseOperationsMockReturn.discardVersion).toHaveBeenCalledWith(
+      'releaseId',
+      'documentId',
+    )
+  })
 })

packages/sanity/src/core/releases/hooks/useVersionOperations.tsx

@@ -7,11 +7,13 @@ import {useReleaseOperations} from '../store/useReleaseOperations'
 import {getCreateVersionOrigin} from '../util/util'
 import {usePerspective} from './usePerspective'
 
-/** @internal */
-export function useVersionOperations(): {
+export interface VersionOperationsValue {
   createVersion: (releaseId: string, documentId: string) => Promise<void>
   discardVersion: (releaseId: string, documentId: string) => Promise<void>
-} {
+}
+
+/** @internal */
+export function useVersionOperations(): VersionOperationsValue {
   const telemetry = useTelemetry()
   const {createVersion, discardVersion} = useReleaseOperations()
 

packages/sanity/src/core/releases/store/__tests__/__mocks/createReleaseOperationsStore.mock.ts

@@ -0,0 +1,22 @@
+import {type Mock, type Mocked, vi} from 'vitest'
+
+import {
+  createReleaseOperationsStore,
+  type ReleaseOperationsStore,
+} from '../../createReleaseOperationStore'
+
+export const createReleaseOperationsStoreReturn: Mocked<ReleaseOperationsStore> = {
+  archive: vi.fn(),
+  unarchive: vi.fn(),
+  createRelease: vi.fn(),
+  createVersion: vi.fn(),
+  discardVersion: vi.fn(),
+  publishRelease: vi.fn(),
+  schedule: vi.fn(),
+  unschedule: vi.fn(),
+  updateRelease: vi.fn(),
+}
+
+export const mockCreateReleaseOperationsStore = createReleaseOperationsStore as Mock<
+  typeof createReleaseOperationsStore
+>

packages/sanity/src/core/releases/tool/components/ReleaseMenuButton/__tests__/ReleaseMenuButton.test.tsx

@@ -132,6 +132,7 @@ describe('ReleaseMenuButton', () => {
   })
 
   test.todo('will unarchive an archived release', async () => {
+    /** @todo update once unarchive has been implemented */
     const archivedRelease: ReleaseDocument = {...activeScheduledRelease, state: 'archived'}
 
     await renderTest({release: archivedRelease})