Skip to content

Commit

Permalink
feat(request): add timeout (#7)
Browse files Browse the repository at this point in the history
Thanks to @jcfauchet for creating this PR!
  • Loading branch information
jcfauchet authored Nov 25, 2023
1 parent aa8a27a commit ae1d171
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 7 deletions.
7 changes: 5 additions & 2 deletions src/contexts.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { createContextId, QRL } from '@builder.io/qwik'

export const QwikqlURLContext = createContextId<{ url: string }>('qwikql.url')
export const QwikqlTimeoutContext = createContextId<{ timeout: number }>(
'qwikql.timeout'
)
export const QwikqlRequestContextContext = createContextId<{
headers: Record<string, string>
}>('qwikql.requestContext')
export const QwikqlSetHeadersContext =
createContextId<QRL<(headers: Record<string, string>) => void>>(
createContextId<QRL<(headers: Record<string, string>) => void>>(
'qwikql.setHeaders'
)
)
3 changes: 3 additions & 0 deletions src/qwikql-component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ import {
import {
QwikqlRequestContextContext,
QwikqlSetHeadersContext,
QwikqlTimeoutContext,
QwikqlURLContext
} from './contexts'

interface QwikQLProps {
url: string
timeout?: number
headers?: Record<string, string>
}

Expand All @@ -25,6 +27,7 @@ export const QwikQL = component$((props: QwikQLProps) => {

useContextProvider(QwikqlURLContext, { url: props.url })
useContextProvider(QwikqlRequestContextContext, context)
useContextProvider(QwikqlTimeoutContext, { timeout: props.timeout })
useContextProvider(
QwikqlSetHeadersContext,
$((headers) => {
Expand Down
23 changes: 20 additions & 3 deletions src/useMutation.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { $, useContext, useStore } from '@builder.io/qwik'
import { request, RequestDocument } from 'graphql-request'
import { QwikqlRequestContextContext, QwikqlURLContext } from './contexts'
import {
QwikqlRequestContextContext,
QwikqlTimeoutContext,
QwikqlURLContext
} from './contexts'
import { toQwikqlError } from './util/toQwikqlError'

interface MutationStore {
Expand All @@ -12,6 +16,8 @@ interface MutationStore {
export const useMutation = (mutation: RequestDocument) => {
const url = useContext(QwikqlURLContext).url
const requestContext = useContext(QwikqlRequestContextContext)
const timeout = useContext(QwikqlTimeoutContext).timeout

const mutationAsString = mutation?.toString()
const result = useStore<MutationStore>({
data: undefined,
Expand All @@ -21,17 +27,28 @@ export const useMutation = (mutation: RequestDocument) => {

const mutate$ = $(async (variables: Record<string, any>) => {
result.loading = true
let controller: AbortController | undefined, timeoutId
if (timeout) {
controller = new AbortController()
timeoutId = setTimeout(() => {
controller!.abort()
}, timeout)
}

try {
result.data = await request({
url,
document: mutationAsString,
variables,
requestHeaders: requestContext.headers
requestHeaders: requestContext.headers,
signal: controller?.signal
})
} catch (error) {
result.error = toQwikqlError(error)
} finally {
if (timeoutId) clearTimeout(timeoutId)
result.loading = false
}
result.loading = false
})

return { mutate$, result }
Expand Down
20 changes: 18 additions & 2 deletions src/useQuery.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { useContext, $ } from '@builder.io/qwik'
import { request, RequestDocument } from 'graphql-request'
import { QwikqlRequestContextContext, QwikqlURLContext } from './contexts'
import {
QwikqlRequestContextContext,
QwikqlTimeoutContext,
QwikqlURLContext
} from './contexts'
import { toQwikqlError } from './util/toQwikqlError'

interface QueryConfig {
Expand All @@ -11,17 +15,29 @@ export const useQuery = (query: RequestDocument) => {
const queryAsString = query.toString()
const url = useContext(QwikqlURLContext).url
const requestContext = useContext(QwikqlRequestContextContext)
const timeout = useContext(QwikqlTimeoutContext).timeout

const executeQuery$ = $(async (queryConfig: Partial<QueryConfig> = {}) => {
let controller: AbortController | undefined, timeoutId
if (timeout) {
controller = new AbortController()
timeoutId = setTimeout(() => {
controller!.abort()
}, timeout)
}

try {
return await request({
url,
document: queryAsString,
variables: queryConfig.variables || undefined,
requestHeaders: requestContext.headers
requestHeaders: requestContext.headers,
signal: controller?.signal
})
} catch (error) {
return Promise.reject(toQwikqlError(error))
} finally {
if (timeoutId) clearTimeout(timeoutId)
}
})

Expand Down

0 comments on commit ae1d171

Please sign in to comment.