Skip to content

feat: support source in document stores #641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: holm/actions-source
Choose a base branch
from
Draft

feat: support source in document stores #641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 47 additions & 37 deletions packages/core/src/document/documentStore.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ afterEach(() => {
})

it('creates, edits, and publishes a document', async () => {
const doc = createDocumentHandle({documentId: 'doc-single', documentType: 'article'})
const doc = {documentId: 'doc-single', documentType: 'article', source}
const documentState = getDocumentState(instance, doc)

// Initially the document is undefined
Expand Down Expand Up @@ -122,7 +122,7 @@ it('creates, edits, and publishes a document', async () => {
})

it('edits existing documents', async () => {
const doc = createDocumentHandle({documentId: 'existing-doc', documentType: 'article'})
const doc = {documentId: 'existing-doc', documentType: 'article', source}
const state = getDocumentState(instance, doc)

// not subscribed yet so the value is undefined
Expand Down Expand Up @@ -151,16 +151,16 @@ it('edits existing documents', async () => {
})

it('sets optimistic changes synchronously', async () => {
const doc = createDocumentHandle({documentId: 'optimistic', documentType: 'article'})
const doc = {documentId: 'optimistic', documentType: 'article'}

const state1 = getDocumentState(instance1, doc)
const state2 = getDocumentState(instance2, doc)
const state1 = getDocumentState(instance1, {...doc, source: source1})
const state2 = getDocumentState(instance2, {...doc, source: source2})

const unsubscribe1 = state1.subscribe()
const unsubscribe2 = state2.subscribe()

// wait until the value is primed in the store
await resolveDocument(instance1, doc)
await resolveDocument(instance1, {...doc, source: source1})

// then the actions are synchronous
expect(state1.getCurrent()).toBeNull()
Expand Down Expand Up @@ -204,9 +204,9 @@ it('sets optimistic changes synchronously', async () => {
})

it('propagates changes between two instances', async () => {
const doc = createDocumentHandle({documentId: 'doc-collab', documentType: 'article'})
const state1 = getDocumentState(instance1, doc)
const state2 = getDocumentState(instance2, doc)
const doc = {documentId: 'doc-collab', documentType: 'article'}
const state1 = getDocumentState(instance1, {...doc, source: source1})
const state2 = getDocumentState(instance2, {...doc, source: source2})

const state1Unsubscribe = state1.subscribe()
const state2Unsubscribe = state2.subscribe()
Expand Down Expand Up @@ -237,9 +237,9 @@ it('propagates changes between two instances', async () => {
})

it('handles concurrent edits and resolves conflicts', async () => {
const doc = createDocumentHandle({documentId: 'doc-concurrent', documentType: 'article'})
const state1 = getDocumentState(instance1, doc)
const state2 = getDocumentState(instance2, doc)
const doc = {documentId: 'doc-concurrent', documentType: 'article'}
const state1 = getDocumentState(instance1, {...doc, source: source1})
const state2 = getDocumentState(instance2, {...doc, source: source2})

const state1Unsubscribe = state1.subscribe()
const state2Unsubscribe = state2.subscribe()
Expand Down Expand Up @@ -281,7 +281,7 @@ it('handles concurrent edits and resolves conflicts', async () => {
})

it('unpublishes and discards a document', async () => {
const doc = createDocumentHandle({documentId: 'doc-pub-unpub', documentType: 'article'})
const doc = {documentId: 'doc-pub-unpub', documentType: 'article', source}
const documentState = getDocumentState(instance, doc)
const unsubscribe = documentState.subscribe()

Expand Down Expand Up @@ -312,7 +312,7 @@ it('unpublishes and discards a document', async () => {
})

it('deletes a document', async () => {
const doc = createDocumentHandle({documentId: 'doc-delete', documentType: 'article'})
const doc = {documentId: 'doc-delete', documentType: 'article', source}

const documentState = getDocumentState(instance, doc)
const unsubscribe = documentState.subscribe()
Expand All @@ -333,7 +333,7 @@ it('deletes a document', async () => {
})

it('cleans up document state when there are no subscribers', async () => {
const doc = createDocumentHandle({documentId: 'doc-cleanup', documentType: 'article'})
const doc = {documentId: 'doc-cleanup', documentType: 'article', source}
const documentState = getDocumentState(instance, doc)

// Subscribe to the document state.
Expand All @@ -356,7 +356,7 @@ it('cleans up document state when there are no subscribers', async () => {
})

it('fetches documents if there are no active subscriptions for the actions applied', async () => {
const doc = createDocumentHandle({documentId: 'existing-doc', documentType: 'article'})
const doc = {documentId: 'existing-doc', documentType: 'article', source}

const {getCurrent} = getDocumentState(instance, doc)
expect(getCurrent()).toBeUndefined()
Expand Down Expand Up @@ -411,7 +411,7 @@ it('fetches documents if there are no active subscriptions for the actions appli
})

it('batches edit transaction into one outgoing transaction', async () => {
const doc = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'article'})
const doc = {documentId: crypto.randomUUID(), documentType: 'article', source}

const unsubscribe = getDocumentState(instance, doc).subscribe()

Expand All @@ -438,7 +438,7 @@ it('batches edit transaction into one outgoing transaction', async () => {
})

it('provides the consistency status via `getDocumentSyncStatus`', async () => {
const doc = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'article'})
const doc = {documentId: crypto.randomUUID(), documentType: 'article', source}

const syncStatus = getDocumentSyncStatus(instance, doc)
expect(syncStatus.getCurrent()).toBeUndefined()
Expand Down Expand Up @@ -482,15 +482,18 @@ it('reverts failed outgoing transaction locally', async () => {
})

const revertedEventPromise = new Promise<TransactionRevertedEvent>((resolve) => {
const unsubscribe = subscribeDocumentEvents(instance, (e) => {
if (e.type === 'reverted') {
resolve(e)
unsubscribe()
}
const unsubscribe = subscribeDocumentEvents(instance, {
onEvent: (e) => {
if (e.type === 'reverted') {
resolve(e)
unsubscribe()
}
},
source,
})
})

const doc = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'article'})
const doc = {documentId: crypto.randomUUID(), documentType: 'article', source}

const {getCurrent, subscribe} = getDocumentState(instance, doc)
const unsubscribe = subscribe()
Expand Down Expand Up @@ -546,15 +549,18 @@ it('reverts failed outgoing transaction locally', async () => {

it('removes a queued transaction if it fails to apply', async () => {
const actionErrorEventPromise = new Promise<ActionErrorEvent>((resolve) => {
const unsubscribe = subscribeDocumentEvents(instance, (e) => {
if (e.type === 'error') {
resolve(e)
unsubscribe()
}
const unsubscribe = subscribeDocumentEvents(instance, {
onEvent: (e) => {
if (e.type === 'error') {
resolve(e)
unsubscribe()
}
},
source,
})
})

const doc = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'article'})
const doc = {documentId: crypto.randomUUID(), documentType: 'article', source}
const state = getDocumentState(instance, doc)
const unsubscribe = state.subscribe()

Expand Down Expand Up @@ -587,10 +593,11 @@ it('returns allowed true when no permission errors occur', async () => {
client.observable.request = vi.fn().mockReturnValue(of(datasetAcl))

// Create a document and subscribe to it.
const doc = createDocumentHandle({
const doc = {
documentId: 'doc-perm-allowed',
documentType: 'article',
})
source,
}
const state = getDocumentState(instance, doc)
const unsubscribe = state.subscribe()
await applyDocumentActions(instance, {actions: [createDocument(doc)], source}).then((r) =>
Expand All @@ -606,6 +613,7 @@ it('returns allowed true when no permission errors occur', async () => {
patches: [{set: {title: 'New Title'}}],
},
],
source,
})
// Wait briefly to allow permissions calculation.
await new Promise((resolve) => setTimeout(resolve, 10))
Expand Down Expand Up @@ -638,7 +646,7 @@ it('returns allowed false with reasons when permission errors occur', async () =
vi.mocked(client.request).mockResolvedValue(datasetAcl)

const doc = createDocumentHandle({documentId: 'doc-perm-denied', documentType: 'article'})
const result = await resolvePermissions(instance, {actions: [createDocument(doc)]})
const result = await resolvePermissions(instance, {actions: [createDocument(doc)], source})

const message = 'You do not have permission to create a draft for document "doc-perm-denied".'
expect(result).toMatchObject({
Expand All @@ -659,17 +667,19 @@ it('fetches dataset ACL and updates grants in the document store state', async (
const book = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'book'})
const author = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'author'})

expect(await resolvePermissions(instance, {actions: [createDocument(book)]})).toEqual({
expect(await resolvePermissions(instance, {actions: [createDocument(book)], source})).toEqual({
allowed: true,
})
expect(await resolvePermissions(instance, {actions: [createDocument(author)]})).toMatchObject({
expect(
await resolvePermissions(instance, {actions: [createDocument(author)], source}),
).toMatchObject({
allowed: false,
message: expect.stringContaining('You do not have permission to create a draft for document'),
})
})

it('returns a promise that resolves when a document has been loaded in the store (useful for suspense)', async () => {
const doc = createDocumentHandle({documentId: crypto.randomUUID(), documentType: 'article'})
const doc = {documentId: crypto.randomUUID(), documentType: 'article', source}

expect(await resolveDocument(instance, doc)).toBe(null)

Expand All @@ -691,7 +701,7 @@ it('returns a promise that resolves when a document has been loaded in the store

it('emits an event for each action after an outgoing transaction has been accepted', async () => {
const handler = vi.fn()
const unsubscribe = subscribeDocumentEvents(instance, handler)
const unsubscribe = subscribeDocumentEvents(instance, {onEvent: handler, source})

const documentId = crypto.randomUUID()
const doc = createDocumentHandle({documentId, documentType: 'article'})
Expand Down
33 changes: 16 additions & 17 deletions packages/core/src/document/documentStore.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
} from 'rxjs'

import {getClientState} from '../client/clientStore'
import {type DocumentHandle} from '../config/sanityConfig'
import {type DocumentHandle, type DocumentSource} from '../config/sanityConfig'
import {
bindActionByDataset,
type BoundDatasetKey,
Expand Down Expand Up @@ -141,10 +141,11 @@ export const documentStore = defineStore<DocumentStoreState, BoundDatasetKey>({
export interface DocumentOptions<
TPath extends string | undefined = undefined,
TDocumentType extends string = string,
TDataset extends string = string,
TProjectId extends string = string,
> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
> {
path?: TPath
documentId: string
documentType: TDocumentType
source: DocumentSource
}

/** @beta */
Expand All @@ -154,7 +155,7 @@ export function getDocumentState<
TProjectId extends string = string,
>(
instance: SanityInstance,
options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
options: DocumentOptions<undefined>,
): StateSource<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>

/** @beta */
Expand All @@ -165,7 +166,7 @@ export function getDocumentState<
TProjectId extends string = string,
>(
instance: SanityInstance,
options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
options: DocumentOptions<TPath>,
): StateSource<
JsonMatch<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
>
Expand Down Expand Up @@ -215,12 +216,12 @@ export function resolveDocument<
TProjectId extends string = string,
>(
instance: SanityInstance,
docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
docHandle: Omit<DocumentOptions, 'path'>,
): Promise<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`> | null>
/** @beta */
export function resolveDocument<TData extends SanityDocument>(
instance: SanityInstance,
docHandle: DocumentHandle<string, string, string>,
docHandle: Omit<DocumentOptions, 'path'>,
): Promise<TData | null>
/** @beta */
export function resolveDocument(
Expand All @@ -230,12 +231,9 @@ export function resolveDocument(
}
const _resolveDocument = bindActionByDataset(
documentStore,
({instance}, docHandle: DocumentHandle<string, string, string>) => {
({instance}, docHandle: Omit<DocumentOptions, 'path'>) => {
return firstValueFrom(
getDocumentState(instance, {
...docHandle,
path: undefined,
}).observable.pipe(filter((i) => i !== undefined)),
getDocumentState(instance, docHandle).observable.pipe(filter((i) => i !== undefined)),
) as Promise<SanityDocument | null>
},
)
Expand All @@ -246,9 +244,9 @@ export const getDocumentSyncStatus = bindActionByDataset(
createStateSourceAction({
selector: (
{state: {error, documentStates: documents, outgoing, applied, queued}},
doc: DocumentHandle,
doc: Omit<DocumentOptions, 'path'>,
) => {
const documentId = typeof doc === 'string' ? doc : doc.documentId
const documentId = doc.documentId
if (error) throw error
const draftId = getDraftId(documentId)
const publishedId = getPublishedId(documentId)
Expand All @@ -265,6 +263,7 @@ export const getDocumentSyncStatus = bindActionByDataset(

type PermissionsStateOptions = {
actions: DocumentAction[]
source: DocumentSource
}

/** @beta */
Expand Down Expand Up @@ -294,9 +293,9 @@ export const resolvePermissions = bindActionByDataset(
/** @beta */
export const subscribeDocumentEvents = bindActionByDataset(
documentStore,
({state}, eventHandler: (e: DocumentEvent) => void) => {
({state}, {onEvent}: {onEvent: (e: DocumentEvent) => void; source: DocumentSource}) => {
const {events} = state.get()
const subscription = events.subscribe(eventHandler)
const subscription = events.subscribe(onEvent)
return () => subscription.unsubscribe()
},
)
Expand Down
Loading
Loading