@sanity/sdk 2.8.0 → 2.9.0

package/src/preview/subscribeToStateAndFetchBatches.test.ts

@@ -1,221 +0,0 @@
-import {NEVER, Observable, type Observer} from 'rxjs'
-import {describe, expect, it, vi} from 'vitest'
-
-import {getQueryState, resolveQuery} from '../query/queryStore'
-import {type BoundDatasetKey} from '../store/createActionBinder'
-import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
-import {type StateSource} from '../store/createStateSourceAction'
-import {createStoreState, type StoreState} from '../store/createStoreState'
-import {type PreviewQueryResult, type PreviewStoreState} from './previewStore'
-import {subscribeToStateAndFetchBatches} from './subscribeToStateAndFetchBatches'
-import {PREVIEW_PERSPECTIVE, PREVIEW_TAG} from './util'
-
-vi.mock('../query/queryStore')
-
-describe('subscribeToStateAndFetchBatches', () => {
-  let instance: SanityInstance
-  let state: StoreState<PreviewStoreState>
-  let key: BoundDatasetKey
-
-  beforeEach(() => {
-    vi.clearAllMocks()
-    instance = createSanityInstance({projectId: 'test', dataset: 'test'})
-    state = createStoreState<PreviewStoreState>({
-      subscriptions: {},
-      values: {},
-    })
-    key = {name: 'test.test', projectId: 'test', dataset: 'test'}
-
-    vi.mocked(getQueryState).mockReturnValue({
-      getCurrent: () => undefined,
-      observable: NEVER as Observable<PreviewQueryResult[] | undefined>,
-    } as StateSource<PreviewQueryResult[] | undefined>)
-
-    vi.mocked(resolveQuery).mockResolvedValue(undefined)
-  })
-
-  afterEach(() => {
-    instance.dispose()
-  })
-
-  it('batches rapid subscription changes into single requests', async () => {
-    const subscription = subscribeToStateAndFetchBatches({instance, state, key})
-
-    // Add multiple subscriptions rapidly
-    state.set('addSubscription1', {
-      subscriptions: {doc1: {sub1: true}},
-    })
-
-    state.set('addSubscription2', (prev) => ({
-      subscriptions: {...prev.subscriptions, doc2: {sub2: true}},
-    }))
-
-    // Wait for debounce
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(getQueryState).toHaveBeenCalledTimes(1)
-    expect(getQueryState).toHaveBeenCalledWith(
-      instance,
-      expect.objectContaining({
-        params: expect.objectContaining({
-          __ids_71322c7a: ['doc1', 'drafts.doc1', 'doc2', 'drafts.doc2'],
-        }),
-        perspective: PREVIEW_PERSPECTIVE,
-        tag: PREVIEW_TAG,
-        query: expect.any(String),
-      }),
-    )
-
-    subscription.unsubscribe()
-  })
-
-  it('processes query results and updates state with resolved values', async () => {
-    const teardown = vi.fn()
-    const subscriber = vi
-      .fn<(observer: Observer<PreviewQueryResult[] | undefined>) => () => void>()
-      .mockReturnValue(teardown)
-
-    vi.mocked(getQueryState).mockReturnValue({
-      getCurrent: () => undefined,
-      observable: new Observable(subscriber),
-    } as StateSource<PreviewQueryResult[] | undefined>)
-
-    const subscription = subscribeToStateAndFetchBatches({instance, state, key})
-
-    expect(subscriber).not.toHaveBeenCalled()
-
-    // Add a subscription
-    state.set('addSubscription', {
-      subscriptions: {doc1: {sub1: true}},
-    })
-
-    expect(subscriber).not.toHaveBeenCalled()
-
-    // Wait for debounce
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(subscriber).toHaveBeenCalled()
-    expect(teardown).not.toHaveBeenCalled()
-
-    const [observer] = subscriber.mock.lastCall!
-
-    const timestamp = new Date().toISOString()
-
-    observer.next([
-      {
-        _id: 'doc1',
-        _type: 'test',
-        _updatedAt: timestamp,
-        titleCandidates: {title: 'Test Document'},
-        subtitleCandidates: {description: 'Test Description'},
-      },
-    ])
-
-    const {values} = state.get()
-    expect(values['doc1']).toEqual({
-      isPending: false,
-      data: expect.objectContaining({
-        title: 'Test Document',
-      }),
-    })
-
-    subscription.unsubscribe()
-    expect(teardown).toHaveBeenCalled()
-  })
-
-  it('handles new subscriptions optimistically with pending states', async () => {
-    state.set('initializeValues', {
-      values: {doc1: {data: {title: 'Doc 1'}, isPending: false}},
-      subscriptions: {doc1: {sub1: true}},
-    })
-
-    const subscription = subscribeToStateAndFetchBatches({instance, state, key})
-
-    // Add a subscription for a document already in the batch
-    state.set('addSubscriptionAlreadyInBatch', (prev) => ({
-      subscriptions: {doc1: {sub1: true, ...prev.subscriptions['doc1'], sub2: true}},
-    }))
-
-    // this isn't a new subscription so it isn't pending by design.
-    // the pending state is intended to only appear for new documents
-    expect(state.get().values['doc1']).toEqual({data: {title: 'Doc 1'}, isPending: false})
-
-    expect(state.get().values['doc2']).toBeUndefined()
-
-    state.set('addSubscriptionNotInBatch', {
-      subscriptions: {doc2: {sub1: true}},
-    })
-
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(state.get().values['doc2']).toEqual({data: null, isPending: true})
-
-    subscription.unsubscribe()
-  })
-
-  it('cancels and restarts fetches when subscription set changes', async () => {
-    const abortSpy = vi.spyOn(AbortController.prototype, 'abort')
-    const subscription = subscribeToStateAndFetchBatches({instance, state, key})
-
-    // Add initial subscription
-    state.set('addSubscription1', {
-      subscriptions: {doc1: {sub1: true}},
-    })
-
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    // Add another subscription before first fetch completes
-    state.set('addSubscription2', (prev) => ({
-      subscriptions: {...prev.subscriptions, doc2: {sub2: true}},
-    }))
-
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(getQueryState).toHaveBeenCalledTimes(2)
-    expect(abortSpy).toHaveBeenCalled()
-
-    subscription.unsubscribe()
-  })
-
-  it('processes and applies fetch results correctly', async () => {
-    const subscriber = vi.fn<(observer: Observer<PreviewQueryResult[] | undefined>) => () => void>()
-
-    vi.mocked(getQueryState).mockReturnValue({
-      getCurrent: () => undefined,
-      observable: new Observable(subscriber),
-    } as StateSource<PreviewQueryResult[] | undefined>)
-
-    const subscription = subscribeToStateAndFetchBatches({instance, state, key})
-
-    // Add a subscription
-    state.set('addSubscription', {
-      subscriptions: {doc1: {sub1: true}},
-    })
-
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(subscriber).toHaveBeenCalled()
-    const [observer] = subscriber.mock.lastCall!
-
-    // Emit fetch results
-    observer.next([
-      {
-        _id: 'doc1',
-        _type: 'test',
-        _updatedAt: '2024-01-01T00:00:00Z',
-        titleCandidates: {title: 'Test Document'},
-        subtitleCandidates: {description: 'Test Description'},
-      },
-    ])
-
-    // Check that the state was updated
-    expect(state.get().values['doc1']).toEqual({
-      data: expect.objectContaining({
-        title: 'Test Document',
-      }),
-      isPending: false,
-    })
-
-    subscription.unsubscribe()
-  })
-})

package/src/preview/subscribeToStateAndFetchBatches.ts

@@ -1,112 +0,0 @@
-import {
-  debounceTime,
-  defer,
-  distinctUntilChanged,
-  EMPTY,
-  filter,
-  from,
-  map,
-  Observable,
-  pairwise,
-  startWith,
-  Subscription,
-  switchMap,
-  tap,
-} from 'rxjs'
-
-import {getQueryState, resolveQuery} from '../query/queryStore'
-import {type BoundDatasetKey} from '../store/createActionBinder'
-import {type StoreContext} from '../store/defineStore'
-import {createPreviewQuery, processPreviewQuery} from './previewQuery'
-import {type PreviewQueryResult, type PreviewStoreState} from './previewStore'
-import {PREVIEW_PERSPECTIVE, PREVIEW_TAG} from './util'
-
-const BATCH_DEBOUNCE_TIME = 50
-
-const isSetEqual = <T>(a: Set<T>, b: Set<T>) =>
-  a.size === b.size && Array.from(a).every((i) => b.has(i))
-
-export const subscribeToStateAndFetchBatches = ({
-  state,
-  instance,
-  key: {projectId, dataset},
-}: StoreContext<PreviewStoreState, BoundDatasetKey>): Subscription => {
-  const newSubscriberIds$ = state.observable.pipe(
-    map(({subscriptions}) => new Set(Object.keys(subscriptions))),
-    distinctUntilChanged(isSetEqual),
-    debounceTime(BATCH_DEBOUNCE_TIME),
-    startWith(new Set<string>()),
-    pairwise(),
-    tap(([prevIds, currIds]) => {
-      // for all new subscriptions, set their values to pending
-      const newIds = [...currIds].filter((element) => !prevIds.has(element))
-      state.set('updatingPending', (prev) => {
-        const pendingValues = newIds.reduce<PreviewStoreState['values']>((acc, id) => {
-          const prevValue = prev.values[id]
-          const value = prevValue?.data ? prevValue.data : null
-          acc[id] = {data: value, isPending: true}
-          return acc
-        }, {})
-        return {values: {...prev.values, ...pendingValues}}
-      })
-    }),
-    map(([, ids]) => ids),
-    distinctUntilChanged(isSetEqual),
-  )
-
-  return newSubscriberIds$
-    .pipe(
-      switchMap((ids) => {
-        if (!ids.size) return EMPTY
-        const {query, params} = createPreviewQuery(ids)
-        const controller = new AbortController()
-        return new Observable<PreviewQueryResult[]>((observer) => {
-          const {getCurrent, observable} = getQueryState<PreviewQueryResult[]>(instance, {
-            query,
-            params,
-            tag: PREVIEW_TAG,
-            perspective: PREVIEW_PERSPECTIVE,
-            projectId,
-            dataset,
-          })
-          const source$ = defer(() => {
-            if (getCurrent() === undefined) {
-              return from(
-                resolveQuery<PreviewQueryResult[]>(instance, {
-                  query,
-                  params,
-                  tag: PREVIEW_TAG,
-                  perspective: PREVIEW_PERSPECTIVE,
-                  signal: controller.signal,
-                  projectId,
-                  dataset,
-                }),
-              ).pipe(switchMap(() => observable))
-            }
-            return observable
-          }).pipe(filter((result) => result !== undefined))
-          const subscription = source$.subscribe(observer)
-          return () => {
-            if (!controller.signal.aborted) {
-              controller.abort()
-            }
-
-            subscription.unsubscribe()
-          }
-        }).pipe(map((data) => ({data, ids})))
-      }),
-      map(({ids, data}) => ({
-        values: processPreviewQuery({
-          projectId,
-          dataset,
-          ids,
-          results: data,
-        }),
-      })),
-    )
-    .subscribe({
-      next: ({values}) => {
-        state.set('updateResult', (prev) => ({values: {...prev.values, ...values}}))
-      },
-    })
-}

package/src/preview/util.ts

@@ -1,13 +0,0 @@
-import {getEnv} from '../utils/getEnv'
-import {type PreviewValue, type ValuePending} from './previewStore'
-
-export const PREVIEW_TAG = 'preview'
-export const PREVIEW_PERSPECTIVE = 'raw'
-export const STABLE_EMPTY_PREVIEW: ValuePending<PreviewValue> = {data: null, isPending: false}
-export const STABLE_ERROR_PREVIEW: ValuePending<PreviewValue> = {
-  data: {
-    title: 'Preview Error',
-    ...(!!getEnv('DEV') && {subtitle: 'Check the console for more details'}),
-  },
-  isPending: false,
-}