feat(nextjs): point missing-key errors at the Clerk CLI#9481

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

Closed
djgould wants to merge 1 commit into from
Closed

feat(nextjs): point missing-key errors at the Clerk CLI #9481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions .changeset/missing-key-cli-init.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.
4 changes: 2 additions & 2 deletions packages/backend/src/__tests__/createRedirect.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
} as any);

expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
'@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
);
});
});
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
});

expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
'@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
);
});

Expand Down
15 changes: 10 additions & 5 deletions packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
});

it('falls back to the standard missing-key error when keyless is unavailable', async () => {
it('throws the deploy error pointing at the CLI in production', async () => {
vi.stubEnv('NODE_ENV', 'production');
await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
});

it('names both env vars and the CLI command in the message', async () => {
const { keylessMissingEnvVars } = await import('../errors.js');
expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
expect(message).toContain('CLERK_SECRET_KEY');
}
expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
});
});
21 changes: 14 additions & 7 deletions packages/nextjs/src/server/clerkMiddleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
// Handles the case where `options` is a callback function to dynamically access `NextRequest`
const resolvedParams = typeof params === 'function' ? await params(request) : params;

const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
errorThrower.throwMissingPublishableKeyError(),
);
const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
if (isDevelopmentEnvironment()) {
return errorThrower.throwMissingPublishableKeyError();
}
throw new Error(productionMissingEnvVars);
});

const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
errorThrower.throwMissingSecretKeyError(),
);
const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
if (isDevelopmentEnvironment()) {
return errorThrower.throwMissingSecretKeyError();
}
throw new Error(productionMissingEnvVars);
});

// Handle Frontend API proxy requests early, before authentication
const requestUrl = new URL(request.nextUrl.href);
Expand Down
8 changes: 8 additions & 0 deletions packages/nextjs/src/server/errors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/__tests__/error.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
'@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
);
});

Expand Down
4 changes: 2 additions & 2 deletions packages/shared/src/__tests__/loadClerkJsScript.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

test('throws error when publishableKey is missing', async () => {
await expect(loadClerkJsScript({} as any)).rejects.toThrow(
'@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
);
});

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

test('throws error when publishableKey is missing', async () => {
await expect(loadClerkUIScript({} as any)).rejects.toThrow(
'@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/shared/src/errors/errorThrower.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading
, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading

, '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(nextjs): point missing-key errors at the Clerk CLI#9481

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

 Closed

djgould
wants to merge
1
commit into

from

 Closed


feat(nextjs): point missing-key errors at the Clerk CLI
#9481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 6 additions & 0 deletions
.changeset/missing-key-cli-init.md

View file


Open in desktop

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

Update missing key error messages to recommend the Clerk CLI: `npx clerk@latest init` for setup, and `npx clerk@latest deploy` / `npx clerk@latest env pull --instance prod` when keys are missing in production Next.js environments.

4 changes: 2 additions & 2 deletions
packages/backend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ describe('redirect(redirectAdapter)', () => {
 } as any);

 expect(() => redirectToSignIn({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });
 });
Expand DownExpand Up@@ -258,7 +258,7 @@ describe('redirect(redirectAdapter)', () => {
 });

 expect(() => redirectToSignUp({ returnBackUrl })).toThrowError(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/backend: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

15 changes: 10 additions & 5 deletions
packages/nextjs/src/server/__tests__/clerkMiddlewareKeyless.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,15 +46,20 @@ describe('clerkMiddleware when Clerk env vars are missing', () => {
 await expect(runMiddleware({ authorization: 'Bearer mt_xxxxxxxx' })).rejects.toThrow(/npx clerk@latest init/);
 });

 it('falls back to the standard missing-key error when keyless is unavailable', async () => {
 it('throws the deploy error pointing at the CLI in production', async () => {
 vi.stubEnv('NODE_ENV', 'production');
 await expect(runMiddleware()).rejects.toThrow(/publishableKey/i);
 await expect(runMiddleware()).rejects.toThrow(/npx clerk@latest deploy/);
 await expect(runMiddleware()).rejects.toThrow(/\(code=missing_env_keys_production\)/);
 });

 it('names both env vars and the CLI command in the message', async () => {
 const { keylessMissingEnvVars } = await import('../errors.js');
 expect(keylessMissingEnvVars).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(keylessMissingEnvVars).toContain('CLERK_SECRET_KEY');
 const { keylessMissingEnvVars, productionMissingEnvVars } = await import('../errors.js');
 for (const message of [keylessMissingEnvVars, productionMissingEnvVars]) {
 expect(message).toContain('NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY');
 expect(message).toContain('CLERK_SECRET_KEY');
 }
 expect(keylessMissingEnvVars).toContain('npx clerk@latest init');
 expect(productionMissingEnvVars).toContain('npx clerk@latest deploy');
 expect(productionMissingEnvVars).toContain('npx clerk@latest env pull --instance prod');
 });
});

21 changes: 14 additions & 7 deletions
packages/nextjs/src/server/clerkMiddleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shar
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -37,7 +38,7 @@ import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { keylessMissingEnvVars } from './errors';
import { keylessMissingEnvVars, productionMissingEnvVars } from './errors';
import { errorThrower } from './errorThrower';
import { clerkMiddlewareRequestDataStorage, clerkMiddlewareRequestDataStore } from './middleware-storage';
import {
Expand DownExpand Up@@ -148,13 +149,19 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
 // Handles the case where `options` is a callback function to dynamically access `NextRequest`
 const resolvedParams = typeof params === 'function' ? await params(request) : params;

 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () =>
 errorThrower.throwMissingPublishableKeyError(),
 );
 const publishableKey = assertKey(resolvedParams.publishableKey || PUBLISHABLE_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingPublishableKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () =>
 errorThrower.throwMissingSecretKeyError(),
 );
 const secretKey = assertKey(resolvedParams.secretKey || SECRET_KEY, () => {
 if (isDevelopmentEnvironment()) {
 return errorThrower.throwMissingSecretKeyError();
 }
 throw new Error(productionMissingEnvVars);
 });

 // Handle Frontend API proxy requests early, before authentication
 const requestUrl = new URL(request.nextUrl.href);
Expand Down

8 changes: 8 additions & 0 deletions
packages/nextjs/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,14 @@ To set up Clerk for this project, run:

The command is non-interactive and requires no Clerk account or login: it provisions temporary development keys automatically and writes them to your .env.local file. Then restart your dev server. Do not invent placeholder keys - they will fail. If you already have a Clerk application, copy its keys from https://dashboard.clerk.com into .env.local instead. (code=missing_env_keys)`;

export const productionMissingEnvVars = `Clerk: Missing environment variables (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).

To deploy this application to production, run:

 npx clerk@latest deploy

This provisions a production Clerk instance and walks you through DNS and OAuth setup. If you already have a production instance, run \`npx clerk@latest env pull --instance prod\` to write its keys to your env file, and set the same keys in your deployment environment. (code=missing_env_keys_production)`;

export const authSignatureInvalid = `Clerk: Unable to verify request, this usually means the Clerk middleware did not run. Ensure Clerk's middleware is properly integrated and matches the current route. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware. (code=auth_signature_invalid)`;

export const encryptionKeyInvalid = `Clerk: Unable to decrypt request data, this usually means the encryption key is invalid. Ensure the encryption key is properly set. For more information, see: https://clerk.com/docs/reference/nextjs/clerk-middleware#dynamic-keys. (code=encryption_key_invalid)`;
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/__tests__/error.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ describe('ErrorThrower', () => {

 it('throws the correct error message and interpolates pkg if no parameters are provided', () => {
 expect(() => errorThrower.throwMissingPublishableKeyError()).toThrow(
 '@clerk/test-package: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/test-package: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

4 changes: 2 additions & 2 deletions
packages/shared/src/__tests__/loadClerkJsScript.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ describe('loadClerkJsScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkJsScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand DownExpand Up@@ -310,7 +310,7 @@ describe('loadClerkUIScript(options)', () => {

 test('throws error when publishableKey is missing', async () => {
 await expect(loadClerkUIScript({} as any)).rejects.toThrow(
 '@clerk/react: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 '@clerk/react: Missing publishableKey. To set up Clerk for this project, run:',
 );
 });

Expand Down

12 changes: 10 additions & 2 deletions
packages/shared/src/errors/errorThrower.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
const DefaultMessages = Object.freeze({
 InvalidProxyUrlErrorMessage: `The proxyUrl passed to Clerk is invalid. The expected value for proxyUrl is an absolute URL or a relative path with a leading '/'. (key={{url}})`,
 InvalidPublishableKeyErrorMessage: `The publishableKey passed to Clerk is invalid. You can get your Publishable key at https://dashboard.clerk.com/last-active?path=api-keys. (key={{key}})`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`,
 MissingPublishableKeyErrorMessage: `Missing publishableKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingSecretKeyErrorMessage: `Missing secretKey. To set up Clerk for this project, run:

 npx clerk@latest init

This creates a Clerk application and writes the required keys to your env file. If you already have a Clerk application, copy the keys from https://dashboard.clerk.com/last-active?path=api-keys instead.`,
 MissingClerkProvider: `{{source}} can only be used within the <ClerkProvider /> component. Learn more: https://clerk.com/docs/components/clerk-provider`,
});

Expand Down
Loading