fix(structure): update archived and published docs in release links (#8925)

Author: pedrobonamin

packages/sanity/src/core/i18n/bundles/studio.ts

@@ -1200,6 +1200,8 @@ export const studioLocaleStrings = defineLocalesResources('studio', {
   'release.chip.global.drafts': 'Drafts',
   /** Label for Published chip in document header */
   'release.chip.published': 'Published',
+  /** Label for tooltip in chip when document is in an archived release */
+  'release.chip.tooltip.archived': 'This release is archived and cannot be edited.',
   /** Label for tooltip in chip with the created date */
   'release.chip.tooltip.created-date': 'Created {{date}}',
   /** Label for tooltip in draft chip when it's a live edit document */

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

@@ -23,6 +23,9 @@ interface ReleaseDocumentPreviewProps {
   layout?: PreviewLayoutKey
 }
 
+const isArchivedRelease = (releaseState: ReleaseState | undefined) =>
+  releaseState === 'archived' || releaseState === 'archiving' || releaseState === 'unarchiving'
+
 export function ReleaseDocumentPreview({
   documentId,
   documentTypeName,
@@ -36,17 +39,27 @@ export function ReleaseDocumentPreview({
   const documentPresence = useDocumentPresence(documentId)
 
   const intentParams = useMemo(() => {
-    if (releaseState !== 'published' && releaseState !== 'archived') return {}
-
-    const rev = releaseState === 'archived' ? '@lastEdited' : '@lastPublished'
+    if (releaseState === 'published') {
+      // We are inspecting this document through the published view of the doc.
+      return {
+        rev: `@release:${getReleaseIdFromReleaseDocumentId(releaseId)}`,
+        inspect: 'sanity/structure/history',
+      }
+    }
 
-    return {
-      rev,
-      inspect: 'sanity/structure/history',
-      historyEvent: documentRevision,
-      historyVersion: getReleaseIdFromReleaseDocumentId(releaseId),
+    if (releaseState === 'archived') {
+      // We are "faking" the release as if it is still valid only to render the document
+      return {
+        rev: '@lastEdited',
+        inspect: 'sanity/structure/history',
+        historyEvent: documentRevision,
+        historyVersion: getReleaseIdFromReleaseDocumentId(releaseId),
+        archivedRelease: 'true',
+      }
     }
-  }, [documentRevision, releaseId, releaseState])
+
+    return {}
+  }, [releaseState, releaseId, documentRevision])
 
   const LinkComponent = useMemo(
     () =>
@@ -61,19 +74,23 @@ export function ReleaseDocumentPreview({
               type: documentTypeName,
               ...intentParams,
             }}
-            searchParams={[
-              [
-                'perspective',
-                releaseState === 'published'
-                  ? 'published'
-                  : getReleaseIdFromReleaseDocumentId(releaseId),
-              ],
-            ]}
+            searchParams={
+              isArchivedRelease(releaseState)
+                ? undefined
+                : [
+                    [
+                      'perspective',
+                      releaseState === 'published'
+                        ? 'published'
+                        : getReleaseIdFromReleaseDocumentId(releaseId),
+                    ],
+                  ]
+            }
             ref={ref}
           />
         )
       }),
-    [documentId, documentTypeName, intentParams, releaseId, releaseState],
+    [documentId, documentTypeName, intentParams, releaseState, releaseId],
   )
 
   const previewPresence = useMemo(

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

@@ -123,4 +123,19 @@ describe('ReleaseDocumentPreview', () => {
     const searchParams = JSON.parse(link.getAttribute('data-search-params'))
     expect(searchParams).toContainEqual(['perspective', 'rActive'])
   })
+
+  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: 'archived',
+    })
+
+    const link = container.querySelector('a')
+    const searchParams = JSON.parse(link.getAttribute('data-search-params'))
+    expect(searchParams).toBeNull()
+  })
 })

packages/sanity/src/core/store/events/useEventsStore.ts

@@ -89,11 +89,19 @@ export function useEventsStore({
       return publishEvent?.id || null
     }
     if (rev === '@lastEdited') {
-      const editEvent = events.find((event) => isEditDocumentVersionEvent(event))
+      const editEvent = events.find(isEditDocumentVersionEvent)
       if (editEvent) return editEvent.revisionId
     }
+    if (rev?.startsWith('@release:')) {
+      const releaseId = rev.split(':')[1]
+      const releaseEvent = events.find(
+        (event) => isPublishDocumentVersionEvent(event) && event.releaseId === releaseId,
+      )
+      if (releaseEvent) return releaseEvent.id
+      if (events.length > 0 && !loading) eventsStore.loadMoreEvents()
+    }
     return rev
-  }, [events, rev])
+  }, [events, rev, eventsStore, loading])
 
   const revision$ = useMemo(
     () =>

packages/sanity/src/structure/i18n/resources.ts

@@ -92,7 +92,7 @@ const structureLocaleStrings = defineLocalesResources('structure', {
     'This document has live edit enabled and cannot be unpublished',
   /** Description for the archived release banner, rendered when viewing the history of a version document from the publihed view */
   'banners.archived-release.description':
-    "You are viewing a read-only document that was archived as part of <VersionBadge>{{title}}</VersionBadge>. It can't be edited",
+    'This document version belongs to the archived <VersionBadge>{{title}}</VersionBadge> release',
   /** The text for the restore button on the deleted document banner */
   'banners.deleted-document-banner.restore-button.text': 'Restore most recent revision',
   /** The text content for the deleted document banner */

packages/sanity/src/structure/panes/document/documentPanel/banners/ArchivedReleaseDocumentBanner.tsx

@@ -59,10 +59,14 @@ export function ArchivedReleaseDocumentBanner(): React.JSX.Element {
           </Text>
         </Flex>
       }
-      action={{
-        text: 'Go back to published version',
-        onClick: handleGoBack,
-      }}
+      action={
+        params?.archivedRelease
+          ? undefined
+          : {
+              text: 'Go back to published version',
+              onClick: handleGoBack,
+            }
+      }
     />
   )
 }

packages/sanity/src/structure/panes/document/documentPanel/header/perspective/DocumentPerspectiveList.tsx

@@ -31,6 +31,9 @@ import {useDocumentPane} from '../../../useDocumentPane'
 const TooltipContent = ({release}: {release: ReleaseDocument}) => {
   const {t} = useTranslation()
 
+  if (release.state === 'archived') {
+    return <Text size={1}>{t('release.chip.tooltip.archived')}</Text>
+  }
   if (release.metadata.releaseType === 'asap') {
     return <Text size={1}>{t('release.type.asap')}</Text>
   }

packages/sanity/src/structure/panes/document/timeline/events/PublishedEventMenu.tsx

@@ -9,6 +9,7 @@ import {
 import {useCallback} from 'react'
 import {
   ContextMenuButton,
+  getReleaseIdFromReleaseDocumentId,
   getReleaseTone,
   getVersionFromId,
   type PublishDocumentVersionEvent,
@@ -77,15 +78,15 @@ export function PublishedEventMenu({event}: {event: PublishDocumentVersionEvent}
             <>
               <IntentLink
                 intent={RELEASES_INTENT}
-                params={{id: event.release?.name}}
+                params={{id: getReleaseIdFromReleaseDocumentId(event.release._id)}}
                 style={{textDecoration: 'none'}}
               >
                 <MenuItem padding={3}>
-                  <Flex align={'center'}>
+                  <Flex align={'center'} justify="flex-start">
                     <Text size={1} style={{textDecoration: 'none'}}>
                       <Translate
                         components={{
-                          VersionBadge: ({children}) => <VersionBadge>{children} </VersionBadge>,
+                          VersionBadge: ({children}) => <VersionBadge>{children}</VersionBadge>,
                         }}
                         i18nKey="events.open.release"
                         values={{
@@ -100,11 +101,11 @@ export function PublishedEventMenu({event}: {event: PublishDocumentVersionEvent}
                 </MenuItem>
               </IntentLink>
               <MenuItem onClick={handleOpenReleaseDocument}>
-                <Flex align={'center'}>
+                <Flex align={'center'} justify="flex-start">
                   <Text size={1}>
                     <Translate
                       components={{
-                        VersionBadge: ({children}) => <VersionBadge>{children} </VersionBadge>,
+                        VersionBadge: ({children}) => <VersionBadge>{children}</VersionBadge>,
                       }}
                       i18nKey="events.inspect.release"
                       values={{