fix(core): clean up edit state listeners (#5911)

Author: ricokahler

packages/sanity/src/core/hooks/useEditState.ts

@@ -1,6 +1,5 @@
 import {useMemoObservable} from 'react-rx'
-import {merge, timer} from 'rxjs'
-import {debounce, share, skip, take} from 'rxjs/operators'
+import {debounce, merge, share, skip, take, timer} from 'rxjs'
 
 import {type EditStateFor, useDocumentStore} from '../store'
 
@@ -13,8 +12,9 @@ export function useEditState(
   const documentStore = useDocumentStore()
 
   return useMemoObservable(() => {
-    const base = documentStore.pair.editState(publishedDocId, docTypeName).pipe(share())
     if (priority === 'low') {
+      const base = documentStore.pair.editState(publishedDocId, docTypeName).pipe(share())
+
       return merge(
         base.pipe(take(1)),
         base.pipe(
@@ -23,6 +23,7 @@ export function useEditState(
         ),
       )
     }
+
     return documentStore.pair.editState(publishedDocId, docTypeName)
   }, [documentStore.pair, publishedDocId, docTypeName, priority]) as EditStateFor
 }

packages/sanity/src/core/store/_legacy/document/document-pair/checkoutPair.ts

@@ -1,7 +1,7 @@
 import {type SanityClient} from '@sanity/client'
 import {type Mutation} from '@sanity/mutator'
 import {type SanityDocument} from '@sanity/types'
-import {EMPTY, from, merge, type Observable} from 'rxjs'
+import {EMPTY, from, merge, type Observable, Subject} from 'rxjs'
 import {filter, map, mergeMap, mergeMapTo, share, tap} from 'rxjs/operators'
 
 import {
@@ -63,6 +63,7 @@ export interface Pair {
   transactionsPendingEvents$: Observable<PendingMutationsEvent>
   published: DocumentVersion
   draft: DocumentVersion
+  complete: () => void
 }
 
 function setVersion<T>(version: 'draft' | 'published') {
@@ -105,7 +106,10 @@ function submitCommitRequest(client: SanityClient, request: CommitRequest) {
 export function checkoutPair(client: SanityClient, idPair: IdPair): Pair {
   const {publishedId, draftId} = idPair
 
-  const listenerEvents$ = getPairListener(client, idPair).pipe(share())
+  const listenerEventsConnector = new Subject<ListenerEvent>()
+  const listenerEvents$ = getPairListener(client, idPair).pipe(
+    share({connector: () => listenerEventsConnector}),
+  )
 
   const reconnect$ = listenerEvents$.pipe(
     filter((ev) => ev.type === 'reconnect'),
@@ -146,5 +150,6 @@ export function checkoutPair(client: SanityClient, idPair: IdPair): Pair {
       consistency$: published.consistency$,
       remoteSnapshot$: published.remoteSnapshot$.pipe(map(setVersion('published'))),
     },
+    complete: () => listenerEventsConnector.complete(),
   }
 }

packages/sanity/src/core/store/_legacy/document/document-pair/memoizedPair.ts

@@ -14,7 +14,10 @@ export const memoizedPair: (
 ) => Observable<Pair> = memoize(
   (client: SanityClient, idPair: IdPair, _typeName: string): Observable<Pair> => {
     return new Observable<Pair>((subscriber) => {
-      subscriber.next(checkoutPair(client, idPair))
+      const pair = checkoutPair(client, idPair)
+      subscriber.next(pair)
+
+      return pair.complete
     }).pipe(publishReplay(1), refCount())
   },
   memoizeKeyGen,