Skip to content

Commit 1662aaa

Browse files
authoredMay 7, 2024
feat(clerk-react,shared): Add telemetry events for React hooks (#3341)
* feat(clerk-react,shared): Add telemetry events for React hooks * perf(clerk-react,shared): Remove `useEffect` from telemetry calls
1 parent bfcc5de commit 1662aaa

File tree

5 files changed

+20
-0
lines changed

5 files changed

+20
-0
lines changed
 

‎.changeset/chatty-jeans-fry.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
'@clerk/shared': patch
3+
'@clerk/clerk-react': patch
4+
---
5+
6+
The following are all internal changes and not relevant to any end-user:
7+
8+
Add telemetry events for `useSignIn`, `useSignUp`, `useOrganizations` and `useOrganizationList`

‎packages/react/src/hooks/useSignIn.ts

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { useClientContext } from '@clerk/shared/react';
2+
import { eventMethodCalled } from '@clerk/shared/telemetry';
23
import type { SetActive, SignInResource } from '@clerk/types';
34

45
import { useIsomorphicClerkContext } from '../contexts/IsomorphicClerkContext';
@@ -24,6 +25,8 @@ export const useSignIn: UseSignIn = () => {
2425
const isomorphicClerk = useIsomorphicClerkContext();
2526
const client = useClientContext();
2627

28+
isomorphicClerk.telemetry?.record(eventMethodCalled('useSignIn'));
29+
2730
if (!client) {
2831
return { isLoaded: false, signIn: undefined, setActive: undefined };
2932
}

‎packages/react/src/hooks/useSignUp.ts

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { useClientContext } from '@clerk/shared/react';
2+
import { eventMethodCalled } from '@clerk/shared/telemetry';
23
import type { SetActive, SignUpResource } from '@clerk/types';
34

45
import { useIsomorphicClerkContext } from '../contexts/IsomorphicClerkContext';
@@ -24,6 +25,8 @@ export const useSignUp: UseSignUp = () => {
2425
const isomorphicClerk = useIsomorphicClerkContext();
2526
const client = useClientContext();
2627

28+
isomorphicClerk.telemetry?.record(eventMethodCalled('useSignUp'));
29+
2730
if (!client) {
2831
return { isLoaded: false, signUp: undefined, setActive: undefined };
2932
}

‎packages/shared/src/react/hooks/useOrganization.tsx

+3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import type {
1111
OrganizationResource,
1212
} from '@clerk/types';
1313

14+
import { eventMethodCalled } from '../../telemetry/events/method-called';
1415
import {
1516
useAssertWrappedByClerkProvider,
1617
useClerkInstanceContext,
@@ -135,6 +136,8 @@ export const useOrganization: UseOrganization = params => {
135136

136137
const clerk = useClerkInstanceContext();
137138

139+
clerk.telemetry?.record(eventMethodCalled('useOrganization'));
140+
138141
const domainParams =
139142
typeof domainListParams === 'undefined'
140143
? undefined

‎packages/shared/src/react/hooks/useOrganizationList.tsx

+3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import type {
1111
UserOrganizationInvitationResource,
1212
} from '@clerk/types';
1313

14+
import { eventMethodCalled } from '../../telemetry/events/method-called';
1415
import { useAssertWrappedByClerkProvider, useClerkInstanceContext, useUserContext } from '../contexts';
1516
import type { PaginatedHookConfig, PaginatedResources, PaginatedResourcesWithDefault } from '../types';
1617
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';
@@ -99,6 +100,8 @@ export const useOrganizationList: UseOrganizationList = params => {
99100
const clerk = useClerkInstanceContext();
100101
const user = useUserContext();
101102

103+
clerk.telemetry?.record(eventMethodCalled('useOrganizationList'));
104+
102105
const userMembershipsParams =
103106
typeof userMemberships === 'undefined'
104107
? undefined

0 commit comments

Comments
 (0)