-
Notifications
You must be signed in to change notification settings - Fork 459
Expand file tree
/
Copy pathuseEnterpriseConnectionTestRuns.tsx
More file actions
140 lines (122 loc) · 4.08 KB
/
Copy pathuseEnterpriseConnectionTestRuns.tsx
File metadata and controls
140 lines (122 loc) · 4.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
import { useCallback, useEffect, useState } from 'react';
import type {
EnterpriseConnectionTestRunResource,
GetEnterpriseConnectionTestRunsParams,
} from '../../types/enterpriseConnectionTestRun';
import { useClerkInstanceContext } from '../contexts';
import { useClerkQueryClient } from '../query/use-clerk-query-client';
import { useClerkQuery } from '../query/useQuery';
import { useUserBase } from './base/useUserBase';
import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut';
import { useEnterpriseConnectionTestRunsCacheKeys } from './useEnterpriseConnectionTestRuns.shared';
const DEFAULT_POLL_INTERVAL_MS = 2_000;
export type UseEnterpriseConnectionTestRunsParams = {
enterpriseConnectionId: string | null;
/**
* Pass-through fetch parameters (pagination, status filter).
* Defaults to `{ initialPage: 1, pageSize: 10 }`.
*/
params?: GetEnterpriseConnectionTestRunsParams;
/**
* Polling interval (ms) applied between `revalidate()` and the moment the
* first record arrives in the response.
*
* @default 2000
*/
pollIntervalMs?: number;
/**
* If `false`, the hook is dormant — no fetch, no polling.
*
* @default true
*/
enabled?: boolean;
};
export type UseEnterpriseConnectionTestRunsReturn = {
data: EnterpriseConnectionTestRunResource[] | undefined;
totalCount: number | undefined;
error: Error | null;
isLoading: boolean;
isFetching: boolean;
/**
* `true` while the hook is actively polling for the first record to appear
*/
isPolling: boolean;
/**
* Force a refetch and (if the list is currently empty) arm polling
*/
revalidate: () => Promise<void>;
};
/**
* Subscribes to the list of enterprise-connection test runs for the signed-in user
*
* @internal
*/
function useEnterpriseConnectionTestRuns(
params: UseEnterpriseConnectionTestRunsParams,
): UseEnterpriseConnectionTestRunsReturn {
const {
enterpriseConnectionId,
params: fetchParams = { initialPage: 1, pageSize: 10 },
pollIntervalMs = DEFAULT_POLL_INTERVAL_MS,
enabled = true,
} = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();
const [queryClient] = useClerkQueryClient();
const { queryKey, invalidationKey, stableKey, authenticated } = useEnterpriseConnectionTestRunsCacheKeys({
userId: user?.id ?? null,
enterpriseConnectionId,
args: fetchParams,
});
useClearQueriesOnSignOut({
isSignedOut: user === null,
authenticated,
stableKeys: stableKey,
});
const queryEnabled = enabled && clerk.loaded && Boolean(user) && Boolean(enterpriseConnectionId);
const [shouldPoll, setShouldPoll] = useState(false);
const query = useClerkQuery({
queryKey,
queryFn: () => {
if (!enterpriseConnectionId) {
throw new Error('enterpriseConnectionId is required to fetch test runs');
}
return user?.getEnterpriseConnectionTestRuns(enterpriseConnectionId, fetchParams);
},
refetchInterval: q => {
if (!shouldPoll) {
return false;
}
const hasRows = (q.state.data?.data?.length ?? 0) > 0;
return hasRows ? false : pollIntervalMs;
},
enabled: queryEnabled,
refetchIntervalInBackground: false,
refetchOnWindowFocus: false,
});
const hasRows = (query.data?.data?.length ?? 0) > 0;
useEffect(() => {
if (shouldPoll && hasRows) {
setShouldPoll(false);
}
}, [shouldPoll, hasRows]);
const revalidate = useCallback(async () => {
// Only arm polling when there is nothing in the list yet — once any record
// has been seen, this is a one-shot refetch.
if (!hasRows) {
setShouldPoll(true);
}
await queryClient.invalidateQueries({ queryKey: invalidationKey });
}, [queryClient, invalidationKey, hasRows]);
const isPolling = queryEnabled && shouldPoll && !hasRows;
return {
data: query.data?.data,
totalCount: query.data?.total_count,
error: query.error ?? null,
isLoading: query.isLoading,
isFetching: query.isFetching,
isPolling,
revalidate,
};
}
export { useEnterpriseConnectionTestRuns as __internal_useEnterpriseConnectionTestRuns };