feat(clerk-js): Track usage of UI modals#5185

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

Merged
panteliselef merged 4 commits into from
Feb 24, 2025
Merged

feat(clerk-js): Track usage of UI modals #5185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad51477
feat(clerk-js): Track usage of UI modals
panteliselef Feb 17, 2025
7b5d541
clean up
panteliselef Feb 17, 2025
fed0b55
introduce a new event
panteliselef Feb 17, 2025
23a1208
Update packages/shared/src/telemetry/events/component-mounted.ts
panteliselef Feb 19, 2025
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
5 changes: 5 additions & 0 deletions .changeset/poor-cobras-sin.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.
76 changes: 36 additions & 40 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
};

public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
// TODO: add telemetry
this.assertComponentsReady(this.#componentControls);
void this.#componentControls
.ensureMounted({ preloadHint: 'GoogleOneTap' })
.then(controls => controls.openModal('googleOneTap', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
};

public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'SignIn' })
.then(controls => controls.openModal('signIn', props || {}));

const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
};

public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'UserVerification' })
.then(controls => controls.openModal('userVerification', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
};

public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'SignUp' })
.then(controls => controls.openModal('signUp', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
};

public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'UserProfile' })
.then(controls => controls.openModal('userProfile', props || {}));

const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
};

public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'OrganizationProfile' })
.then(controls => controls.openModal('organizationProfile', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
};

public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'CreateOrganization' })
.then(controls => controls.openModal('createOrganization', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
};

public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
void this.#componentControls
.ensureMounted({ preloadHint: 'Waitlist' })
.then(controls => controls.openModal('waitlist', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
};

public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
props,
}),
);
this.telemetry?.record(
eventPrebuiltComponentMounted(
'SignIn',
{
...props,
},
{
withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
},
),
);

const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
};

public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
props,
}),
);
this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
};

public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
}),
);

this.telemetry?.record(
eventPrebuiltComponentMounted(
'UserProfile',
props,
props?.customPages?.length || 0 > 0
? {
customPages: true,
}
: undefined,
),
);
const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
};

public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
}),
);

this.telemetry?.record(
eventPrebuiltComponentMounted('UserButton', props, {
...(props?.customMenuItems?.length || 0 > 0
? {
customItems: true,
}
: undefined),

...(props?.__experimental_asStandalone
? {
standalone: true,
}
: undefined),
}),
);
const additionalData = {
...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
};

this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
};

public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down
57 changes: 43 additions & 14 deletions packages/shared/src/telemetry/events/component-mounted.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
appearanceProp: boolean;
elements: boolean;
variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
return function (
component: string,
props?: Record<string, any>,
additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
return {
event,
eventSamplingRate: EVENT_SAMPLING_RATE,
payload: {
component,
appearanceProp: Boolean(props?.appearance),
baseTheme: Boolean(props?.appearance?.baseTheme),
elements: Boolean(props?.appearance?.elements),
variables: Boolean(props?.appearance?.variables),
...additionalPayload,
},
};
};
}

/**
* Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
*
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
component: string,
props?: Record<string, any>,
additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
return {
event: EVENT_COMPONENT_MOUNTED,
eventSamplingRate: EVENT_SAMPLING_RATE,
payload: {
component,
appearanceProp: Boolean(props?.appearance),
baseTheme: Boolean(props?.appearance?.baseTheme),
elements: Boolean(props?.appearance?.elements),
variables: Boolean(props?.appearance?.variables),
...additionalPayload,
},
};
): TelemetryEventRaw<EventPrebuiltComponent> {
return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
* Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
*
* @param component - The name of the component.
* @param props - The props passed to the component. Will be filtered to a known list of props.
* @param additionalPayload - Additional data to send with the event.
*
* @example
* telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
*/
export function eventPrebuiltComponentOpened(
component: string,
props?: Record<string, any>,
additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(clerk-js): Track usage of UI modals#5185

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

 Merged

panteliselef
merged 4 commits into

from

Feb 24, 2025
 Merged


feat(clerk-js): Track usage of UI modals
#5185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad51477

feat(clerk-js): Track usage of UI modals


panteliselef Feb 17, 2025
7b5d541

clean up


panteliselef Feb 17, 2025
fed0b55

introduce a new event


panteliselef Feb 17, 2025
23a1208

Update packages/shared/src/telemetry/events/component-mounted.ts


panteliselef Feb 19, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/poor-cobras-sin.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Track usage of modal UI Components as part of telemetry.

76 changes: 36 additions & 40 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,11 @@ import { parsePublishableKey } from '@clerk/shared/keys';
import { LocalStorageBroadcastChannel } from '@clerk/shared/localStorageBroadcastChannel';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import { eventPrebuiltComponentMounted, TelemetryCollector } from '@clerk/shared/telemetry';
import {
 eventPrebuiltComponentMounted,
 eventPrebuiltComponentOpened,
 TelemetryCollector,
} from '@clerk/shared/telemetry';
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
Expand DownExpand Up@@ -404,11 +408,12 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 // TODO: add telemetry
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -429,6 +434,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand All@@ -449,6 +457,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserVerification' })
 .then(controls => controls.openModal('userVerification', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`UserVerification`, props));
 };

 public __internal_closeReverification = (): void => {
Expand DownExpand Up@@ -483,6 +493,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignUp' })
 .then(controls => controls.openModal('signUp', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
 };

 public closeSignUp = (): void => {
Expand All@@ -503,6 +515,9 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

 public closeUserProfile = (): void => {
Expand DownExpand Up@@ -531,6 +546,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'OrganizationProfile' })
 .then(controls => controls.openModal('organizationProfile', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
 };

 public closeOrganizationProfile = (): void => {
Expand All@@ -551,6 +568,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'CreateOrganization' })
 .then(controls => controls.openModal('createOrganization', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
 };

 public closeCreateOrganization = (): void => {
Expand All@@ -563,6 +582,8 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Waitlist' })
 .then(controls => controls.openModal('waitlist', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
 };

 public closeWaitlist = (): void => {
Expand All@@ -580,17 +601,9 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'SignIn',
 {
 ...props,
 },
 {
 withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow(),
 },
 ),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -612,7 +625,8 @@ export class Clerk implements ClerkInterface {
 props,
 }),
 );
 this.telemetry?.record(eventPrebuiltComponentMounted('SignUp', props));

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -643,17 +657,8 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted(
 'UserProfile',
 props,
 props?.customPages?.length || 0 > 0
 ? {
 customPages: true,
 }
 : undefined,
 ),
 );
 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand DownExpand Up@@ -808,21 +813,12 @@ export class Clerk implements ClerkInterface {
 }),
 );

 this.telemetry?.record(
 eventPrebuiltComponentMounted('UserButton', props, {
 ...(props?.customMenuItems?.length || 0 > 0
 ? {
 customItems: true,
 }
 : undefined),

 ...(props?.__experimental_asStandalone
 ? {
 standalone: true,
 }
 : undefined),
 }),
 );
 const additionalData = {
 ...(props?.customMenuItems?.length || 0 > 0 ? { customItems: true } : undefined),
 ...(props?.__experimental_asStandalone ? { standalone: true } : undefined),
 };

 this.telemetry?.record(eventPrebuiltComponentMounted('UserButton', props, additionalData));
 };

 public unmountUserButton = (node: HTMLDivElement): void => {
Expand Down

57 changes: 43 additions & 14 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import type { TelemetryEventRaw } from '@clerk/types';

const EVENT_COMPONENT_MOUNTED = 'COMPONENT_MOUNTED';
const EVENT_COMPONENT_OPENED = 'COMPONENT_OPENED';
const EVENT_SAMPLING_RATE = 0.1;

type ComponentMountedBase = {
 component: string;
};

type EventPrebuiltComponentMounted = ComponentMountedBase & {
type EventPrebuiltComponent = ComponentMountedBase & {
 appearanceProp: boolean;
 elements: boolean;
 variables: boolean;
Expand All@@ -16,6 +17,27 @@ type EventPrebuiltComponentMounted = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
 ): TelemetryEventRaw<EventPrebuiltComponent> {
 return {
 event,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
 };
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is mounted.
 *
Expand All@@ -30,19 +52,26 @@ export function eventPrebuiltComponentMounted(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponentMounted> {
 return {
 event: EVENT_COMPONENT_MOUNTED,
 eventSamplingRate: EVENT_SAMPLING_RATE,
 payload: {
 component,
 appearanceProp: Boolean(props?.appearance),
 baseTheme: Boolean(props?.appearance?.baseTheme),
 elements: Boolean(props?.appearance?.elements),
 variables: Boolean(props?.appearance?.variables),
 ...additionalPayload,
 },
 };
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_MOUNTED)(component, props, additionalPayload);
}

/**
 * Helper function for `telemetry.record()`. Create a consistent event object for when a prebuilt (AIO) component is opened as a modal.
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
export function eventPrebuiltComponentOpened(
 component: string,
 props?: Record<string, any>,
 additionalPayload?: TelemetryEventRaw['payload'],
): TelemetryEventRaw<EventPrebuiltComponent> {
 return createPrebuiltComponentEvent(EVENT_COMPONENT_OPENED)(component, props, additionalPayload);
}

/**
Expand Down