Skip to content

fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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
heatlikeheatwave merged 4 commits into from
Aug 15, 2025
Merged

fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode #6539

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
c4e7b99
Refactor drift detection to server action
heatlikeheatwave Aug 13, 2025
3b62651
Add canUseKeyless check to detectKeylessEnvDrift function in keyless …
heatlikeheatwave Aug 13, 2025
0f0f72d
Update .changeset/fine-weeks-give.md
panteliselef Aug 14, 2025
e1d6823
Enable samplingRate argument for server side telemetry events
heatlikeheatwave Aug 14, 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/fine-weeks-give.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.
4 changes: 2 additions & 2 deletions packages/backend/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
CreateAuthenticateRequestOptions['options'],
'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
>
> & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
> & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
const apiClient = createBackendApiClient(opts);
const requestState = createAuthenticateRequest({ options: opts, apiClient });
const telemetry = new TelemetryCollector({
...options.telemetry,
publishableKey: opts.publishableKey,
secretKey: opts.secretKey,
samplingRate: 0.1,
...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
...(opts.telemetry || {}),
});

return {
Expand Down
8 changes: 8 additions & 0 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();

// Call drift detection on mount (client-side)
useSafeLayoutEffect(() => {
if (canUseKeyless) {
void detectKeylessEnvDriftAction();
}
}, []);

// Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
const isNested = Boolean(useClerkNextOptions());
if (isNested) {
Expand Down
13 changes: 13 additions & 0 deletions packages/nextjs/src/app-router/keyless-actions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
return;
}

export async function detectKeylessEnvDriftAction() {
if (!canUseKeyless) {
return;
}

try {
const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
await detectKeylessEnvDrift();
} catch {
// ignore
}
}
7 changes: 7 additions & 0 deletions packages/nextjs/src/server/keyless-telemetry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
* @returns Promise<void> - Function completes silently, errors are logged but don't throw
*/
export async function detectKeylessEnvDrift(): Promise<void> {
if (!canUseKeyless) {
return;
}
// Only run on server side
if (typeof window !== 'undefined') {
return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
const clerkClient = createClerkClientWithOptions({
publishableKey: keylessFile.publishableKey,
secretKey: keylessFile.secretKey,
telemetry: {
samplingRate: 1,
},
});

const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode by heatlikeheatwave · Pull Request #6539 · clerk/javascript · GitHub
Skip to content
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode by heatlikeheatwave · Pull Request #6539 · clerk/javascript · GitHub
Skip to content
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

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

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode by heatlikeheatwave · Pull Request #6539 · clerk/javascript · GitHub
Skip to content
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode by heatlikeheatwave · Pull Request #6539 · clerk/javascript · GitHub
Skip to content
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode by heatlikeheatwave · Pull Request #6539 · clerk/javascript · GitHub
Skip to content
fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode#6539

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading

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

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

heatlikeheatwave
merged 4 commits into

from

Aug 15, 2025
 Merged


fix(nextjs): Keyless environment drift telemetry event works client-side and only in dev mode
#6539
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
c4e7b99

Refactor drift detection to server action


heatlikeheatwave Aug 13, 2025
3b62651

Add canUseKeyless check to detectKeylessEnvDrift function in keyless …


heatlikeheatwave Aug 13, 2025
0f0f72d

Update .changeset/fine-weeks-give.md


panteliselef Aug 14, 2025
e1d6823

Enable samplingRate argument for server side telemetry events


heatlikeheatwave Aug 14, 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/fine-weeks-give.md

View file


Open in desktop

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

Fix keyless drift logic to support client components and ensure only apps on development are included. Change createClerkClient to accept an argument for samplingRate in telemetry options and update the ClerkOptions type.

4 changes: 2 additions & 2 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ export type ClerkOptions = Omit<CreateBackendApiOptions, 'skipApiVersionInUrl' |
 CreateAuthenticateRequestOptions['options'],
 'audience' | 'jwtKey' | 'proxyUrl' | 'secretKey' | 'publishableKey' | 'domain' | 'isSatellite'
 >
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug' | 'samplingRate'> };

// The current exported type resolves the following issue in packages importing createClerkClient
// TS4023: Exported variable 'clerkClient' has or is using name 'AuthErrorReason' from external module "/packages/backend/dist/index" but cannot be named.
Expand All@@ -31,11 +31,11 @@ export function createClerkClient(options: ClerkOptions): ClerkClient {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });
 const telemetry = new TelemetryCollector({
 ...options.telemetry,
 publishableKey: opts.publishableKey,
 secretKey: opts.secretKey,
 samplingRate: 0.1,
 ...(opts.sdkMetadata ? { sdk: opts.sdkMetadata.name, sdkVersion: opts.sdkMetadata.version } : {}),
 ...(opts.telemetry || {}),
 });

 return {
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/app-router/client/ClerkProvider.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { canUseKeyless } from '../../utils/feature-flags';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { RouterTelemetry } from '../../utils/router-telemetry';
import { isNextWithUnstableServerActions } from '../../utils/sdk-versions';
import { detectKeylessEnvDriftAction } from '../keyless-actions';
import { invalidateCacheAction } from '../server-actions';
import { useAwaitablePush } from './useAwaitablePush';
import { useAwaitableReplace } from './useAwaitableReplace';
Expand DownExpand Up@@ -43,6 +44,13 @@ const NextClientClerkProvider = (props: NextClerkProviderProps) => {
 const replace = useAwaitableReplace();
 const [isPending, startTransition] = useTransition();

 // Call drift detection on mount (client-side)
 useSafeLayoutEffect(() => {
 if (canUseKeyless) {
 void detectKeylessEnvDriftAction();
 }
 }, []);

 // Avoid rendering nested ClerkProviders by checking for the existence of the ClerkNextOptions context provider
 const isNested = Boolean(useClerkNextOptions());
 if (isNested) {
Expand Down

13 changes: 13 additions & 0 deletions
packages/nextjs/src/app-router/keyless-actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,3 +93,16 @@ export async function deleteKeylessAction() {
 await import('../server/keyless-node.js').then(m => m.removeKeyless()).catch(() => {});
 return;
}

export async function detectKeylessEnvDriftAction() {
 if (!canUseKeyless) {
 return;
 }

 try {
 const { detectKeylessEnvDrift } = await import('../server/keyless-telemetry.js');
 await detectKeylessEnvDrift();
 } catch {
 // ignore
 }
}

7 changes: 7 additions & 0 deletions
packages/nextjs/src/server/keyless-telemetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { TelemetryEventRaw } from '@clerk/types';
import { promises as fs } from 'fs';
import { dirname, join } from 'path';

import { canUseKeyless } from '../utils/feature-flags';
import { createClerkClientWithOptions } from './createClerkClient';

const EVENT_KEYLESS_ENV_DRIFT_DETECTED = 'KEYLESS_ENV_DRIFT_DETECTED';
Expand DownExpand Up@@ -86,6 +87,9 @@ async function tryMarkTelemetryEventAsFired(): Promise<boolean> {
 * @returns Promise<void> - Function completes silently, errors are logged but don't throw
 */
export async function detectKeylessEnvDrift(): Promise<void> {
 if (!canUseKeyless) {
 return;
 }
 // Only run on server side
 if (typeof window !== 'undefined') {
 return;
Expand DownExpand Up@@ -163,6 +167,9 @@ export async function detectKeylessEnvDrift(): Promise<void> {
 const clerkClient = createClerkClientWithOptions({
 publishableKey: keylessFile.publishableKey,
 secretKey: keylessFile.secretKey,
 telemetry: {
 samplingRate: 1,
 },
 });

 const shouldFireEvent = await tryMarkTelemetryEventAsFired();
Expand Down
Loading