Skip to content
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

Jump to bottom

fix: apply includeTypes to the listen query #91

Merged
merged 2 commits into from
Jun 28, 2023
Merged

fix: apply includeTypes to the listen query #91

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1294355
fix: apply `includeTypes` to the `listen` query
stipsan Jun 9, 2023
3ad9249
Merge branch 'main' into fix-include-types-and-listen-endpoint
stipsan Jun 28, 2023
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
36 changes: 34 additions & 2 deletions src/listen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,31 @@ const addEventSourceListener = (
}
}

const encodeQueryString = ({
query,
params = {},
options = {effectFormat: 'mendoza'},
}: {
query: string
params?: Record<string, unknown>
options?: Record<string, unknown>
}) => {
const searchParams = new URLSearchParams()
searchParams.set('query', query)

// Iterate params, the keys are prefixed with `$` and their values JSON stringified
for (const [key, value] of Object.entries(params)) {
searchParams.set(`$${key}`, JSON.stringify(value))
}
// Options are passed as-is
for (const [key, value] of Object.entries(options)) {
// Skip falsy values
if (value) searchParams.set(key, `${value}`)
}

return `?${searchParams}`
}

export function listen(
EventSourceImpl: EnvImplementations['EventSource'],
config: Config,
Expand All @@ -49,9 +74,16 @@ export function listen(
next: (event: MutationEvent) => void
}
): Subscription {
const {projectId, dataset, token} = config
const {projectId, dataset, token, includeTypes} = config
const headers = token ? {Authorization: `Bearer ${token}`} : undefined
const url = `https://${projectId}.api.sanity.io/v1/data/listen/${dataset}?query=*&effectFormat=mendoza`

// Make sure we only listen to mutations on documents part of the `includeTypes` allowlist, if provided
const searchParams = encodeQueryString(
Array.isArray(includeTypes) && includeTypes.length > 0
? {query: `*[_type in $includeTypes]`, params: {includeTypes}}
: {query: '*'}
)
const url = `https://${projectId}.api.sanity.io/v1/data/listen/${dataset}${searchParams}`
const es = new EventSourceImpl(url, {withCredentials: true, headers})

addEventSourceListener(es, 'welcome', handlers.open)
Expand Down