test(core): enhance tests for useActiveReleases and add ReleaseDocumentPreview tests (#8944)

Author: jordanl17

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

@@ -1,12 +1,13 @@
-import {type Mock, type Mocked, vi} from 'vitest'
+import {type Mock, vi} from 'vitest'
 
+import {type ReleaseDocument} from '../../types'
 import {useActiveReleases} from '../../useActiveReleases'
 
-export const useActiveReleasesMockReturn: Mocked<ReturnType<typeof useActiveReleases>> = {
-  data: [],
-  dispatch: vi.fn(),
-  error: undefined,
+export const useActiveReleasesMockReturn = {
+  data: [] as ReleaseDocument[],
+  error: undefined as Error | undefined,
   loading: false,
+  dispatch: vi.fn(),
 }
 
 export const mockUseActiveReleases = useActiveReleases as Mock<typeof useActiveReleases>

packages/sanity/src/core/releases/tool/components/ReleaseDocumentPreview.tsx

@@ -32,7 +32,6 @@ export function ReleaseDocumentPreview({
   releaseState,
   documentRevision,
   layout,
-  hasValidationError,
 }: ReleaseDocumentPreviewProps) {
   const documentPresence = useDocumentPresence(documentId)
 

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

@@ -0,0 +1,126 @@
+import {render, screen, waitFor} from '@testing-library/react'
+import {type ComponentProps} from 'react'
+import {describe, expect, it, vi} from 'vitest'
+
+import {createTestProvider} from '../../../../../../test/testUtils/TestProvider'
+import {activeASAPRelease, activeScheduledRelease} from '../../../__fixtures__/release.fixture'
+import {releasesUsEnglishLocaleBundle} from '../../../i18n'
+import {ReleaseDocumentPreview} from '../ReleaseDocumentPreview'
+
+interface DocumentPresenceData {
+  user: string
+  sessionId: string
+  lastActiveAt: string
+}
+
+const mockDocumentPresence: DocumentPresenceData[] = []
+
+vi.mock('../../../../preview/components/SanityDefaultPreview', () => ({
+  SanityDefaultPreview: vi.fn(({isPlaceholder, title, subtitle, status}) => (
+    <div data-ui={isPlaceholder ? 'Placeholder' : 'Preview'}>
+      {!isPlaceholder && title && <div>{title}</div>}
+      {!isPlaceholder && subtitle && <div>{subtitle}</div>}
+      {status}
+    </div>
+  )),
+}))
+
+vi.mock('sanity/router', () => ({
+  useRouter: vi.fn(() => ({
+    navigate: vi.fn(),
+    state: {},
+    resolveIntentLink: vi.fn(() => '#'),
+    resolvePathFromState: vi.fn(),
+  })),
+  IntentLink: vi
+    .fn()
+    .mockImplementation(({children, searchParams}) => (
+      <a data-search-params={JSON.stringify(searchParams)}>{children}</a>
+    )),
+  route: {
+    create: vi.fn(() => ({
+      path: vi.fn(),
+    })),
+  },
+}))
+
+vi.mock('../../../../store/_legacy/presence/useDocumentPresence', () => ({
+  useDocumentPresence: vi.fn(() => mockDocumentPresence),
+}))
+
+const mockPreviewValues = {
+  title: 'Test Document',
+  subtitle: 'Test Subtitle',
+  media: null,
+}
+
+const renderTest = async (props: ComponentProps<typeof ReleaseDocumentPreview>) => {
+  const wrapper = await createTestProvider({
+    resources: [releasesUsEnglishLocaleBundle],
+  })
+
+  const rendered = render(<ReleaseDocumentPreview {...props} />, {wrapper})
+
+  await waitFor(() => {
+    expect(screen.queryByTestId('loading-block')).not.toBeInTheDocument()
+  })
+
+  return rendered
+}
+
+describe('ReleaseDocumentPreview', () => {
+  it('renders with default props', async () => {
+    await renderTest({
+      documentId: 'doc123',
+      documentTypeName: 'post',
+      releaseId: activeASAPRelease._id,
+      previewValues: mockPreviewValues,
+      isLoading: false,
+    })
+
+    expect(screen.getByText('Test Document')).toBeInTheDocument()
+    expect(screen.getByText('Test Subtitle')).toBeInTheDocument()
+  })
+
+  it('renders in loading state', async () => {
+    const {container} = await renderTest({
+      documentId: 'doc123',
+      documentTypeName: 'post',
+      releaseId: activeASAPRelease._id,
+      previewValues: mockPreviewValues,
+      isLoading: true,
+    })
+
+    expect(container.querySelector('[data-ui="Placeholder"]')).toBeInTheDocument()
+  })
+
+  it('creates link with published perspective when release state is published', async () => {
+    const {container} = await renderTest({
+      documentId: 'doc123',
+      documentTypeName: 'post',
+      releaseId: activeASAPRelease._id,
+      previewValues: mockPreviewValues,
+      isLoading: false,
+      releaseState: 'published',
+    })
+
+    const link = container.querySelector('a')
+    const searchParams = JSON.parse(link.getAttribute('data-search-params'))
+    expect(searchParams).toContainEqual(['perspective', 'published'])
+  })
+
+  it('creates link with release ID perspective when release state is not published', async () => {
+    const {container} = await renderTest({
+      documentId: 'doc123',
+      documentTypeName: 'post',
+      releaseId: activeScheduledRelease._id,
+      previewValues: mockPreviewValues,
+      isLoading: false,
+      releaseState: 'active',
+    })
+
+    const link = container.querySelector('a')
+    const searchParams = JSON.parse(link.getAttribute('data-search-params'))
+    expect(searchParams).toContainEqual(['perspective', 'rActive'])
+  })
+})

packages/sanity/src/core/releases/tool/detail/__tests__/ReleaseDetail.test.tsx

@@ -200,6 +200,7 @@ describe('after releases have loaded', () => {
               validation: {...documentsInRelease.validation, isValidating: true},
             },
           ],
+          error: null,
         })
         mockUseReleasePermissions.mockReturnValue(useReleasesPermissionsMockReturnTrue)
 
@@ -221,6 +222,7 @@ describe('after releases have loaded', () => {
         mockUseBundleDocuments.mockReturnValue({
           loading: false,
           results: [documentsInRelease],
+          error: null,
         })
         mockUseReleasePermissions.mockReturnValue(useReleasesPermissionsMockReturnTrue)
 
@@ -284,6 +286,7 @@ describe('after releases have loaded', () => {
               },
             },
           ],
+          error: null,
         })
         mockUseReleasePermissions.mockReturnValue(useReleasesPermissionsMockReturnTrue)