Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(nextjs): Support rendering ClerkProvider in client components by brkalow · Pull Request #1840 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gorgeous-countries-appear.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Update `<ClerkProvider />` to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error.
12 changes: 11 additions & 1 deletion integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
const now = Date.now();
const stdoutFilePath = path.resolve(appDirPath, `e2e.${now}.log`);
const stderrFilePath = path.resolve(appDirPath, `e2e.${now}.err.log`);
let buildOutput = '';

const self = {
name,
Expand DownExpand Up@@ -70,7 +71,16 @@ export const application = (config: ApplicationConfig, appDirPath: string, appDi
},
build: async () => {
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, { cwd: appDirPath, log });
await run(scripts.build, {
cwd: appDirPath,
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
},
Comment on lines +76 to +79

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Captures and makes the build output available by way of app.buildOutput. This allows us to assert on the output.

});
},
get buildOutput() {
return buildOutput;
},
serve: async (opts: { port?: number; manualStart?: boolean } = {}) => {
const port = opts.port || (await getPort());
Expand Down
12 changes: 7 additions & 5 deletions integration/tests/global.teardown.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ setup('teardown long running apps', async () => {
console.log('Skipping cleanup');
return;
}
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps());
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
const runningAppsFoundInStateFile = Object.values(stateFile.getLongRunningApps() ?? {});
if (runningAppsFoundInStateFile.length > 0) {
const matchingLongRunningApps = appConfigs.longRunningApps.getByPattern(
runningAppsFoundInStateFile.map(app => app.id),
);
await Promise.all(matchingLongRunningApps.map(app => app.destroy()));
}
stateFile.remove();
console.log('Long running apps destroyed');
});
72 changes: 72 additions & 0 deletions integration/tests/next-build.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../models/application';
import { appConfigs } from '../presets';

test.describe('next build @nextjs', () => {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis Any feedback on the test? 🙏

test.describe.configure({ mode: 'parallel' });
let app: Application;
const output = [];

test.beforeAll(async () => {
app = await appConfigs.next.appRouter
.clone()
.addFile(
'src/app/provider.tsx',
() => `'use client'
import { ClerkProvider } from "@clerk/nextjs"

export function Provider({ children }: { children: any }) {
return (
<ClerkProvider>
{children}
</ClerkProvider>
)
}`,
)
.addFile(
'src/app/layout.tsx',
() => `import './globals.css';
import { Inter } from 'next/font/google';
import { Provider } from './provider';

const inter = Inter({ subsets: ['latin'] });

export const metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
};

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<Provider>
<html lang='en'>
<body className={inter.className}>{children}</body>
</html>
</Provider>
);
}
`,
)
.commit();
await app.setup();
await app.withEnv(appConfigs.envs.withEmailCodes);
await app.build();
});

test.afterAll(async () => {
await app.teardown();
});

test('When <ClerkProvider /> is used as a client component, builds successfully and does not force dynamic rendering', () => {
const dynamicIndicator = 'λ';

/**
* Using /_not-found as it is an internal page that should statically render by default.
* This is a good indicator of whether or not the entire app has been opted-in to dynamic rendering.
*/
const notFoundPageLine = app.buildOutput.split('\n').find(msg => msg.includes('/_not-found'));

expect(notFoundPageLine).not.toContain(dynamicIndicator);
});
});
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@
"test:ci": "FORCE_COLOR=1 turbo test --concurrency=${TURBO_CONCURRENCY:-80%}",
"test:integration:base": "DEBUG=1 npx playwright test --config integration/playwright.config.ts",
"test:integration:generic": "E2E_APP_ID=react.vite.* npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep @generic",
"test:integration:nextjs": "E2E_APP_ID=next.appRouter.withEmailCodes npm run test:integration:base -- --grep \"@generic|@nextjs\"",

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the initial RFC, I added a @nextjs tag as well.

"test:integration:remix": "echo 'placeholder'",
"test:integration:deployment:nextjs": "DEBUG=1 npx playwright test --config integration/playwright.deployments.config.ts",
"clean": "turbo clean",
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import React from 'react';
import { ClerkNextOptionsProvider } from '../../client-boundary/NextOptionsContext';
import { useSafeLayoutEffect } from '../../client-boundary/useSafeLayoutEffect';
import type { NextClerkProviderProps } from '../../types';
import { mergeNextClerkPropsWithEnv } from '../../utils/mergeNextClerkPropsWithEnv';
import { useAwaitableNavigate } from './useAwaitableNavigate';

declare global {
Expand DownExpand Up@@ -33,7 +34,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
};
}, []);

const mergedProps = { ...props, navigate };
const mergedProps = mergeNextClerkPropsWithEnv({ ...props, navigate });
return (
<ClerkNextOptionsProvider options={mergedProps}>
{/*// @ts-ignore*/}
Expand Down
19 changes: 19 additions & 0 deletions packages/nextjs/src/client-boundary/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use client';

import { useRouter } from 'next/compat/router';

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a stable export we can rely on being available?

Or are we reaching into private APIs here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is stable and reliable, based on PR: vercel/next.js#42502.

import React from 'react';

import { ClientClerkProvider } from '../app-router/client/ClerkProvider';
import { ClerkProvider as PageClerkProvider } from '../pages/ClerkProvider';
import { type NextClerkProviderProps } from '../types';

/**
* This is a compatibility layer to support a single ClerkProvider component in both the app and pages routers.
*/
export function ClerkProvider(props: NextClerkProviderProps) {
const router = useRouter();

const Provider = router ? PageClerkProvider : ClientClerkProvider;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solution here makes perfect sense to me :)
Do you think we could merge the two client providers into one? I took a quick look and they look pretty similar.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikosdouvlis possibly, the difficulty is they rely on the two different router hooks, which is why we need this layer. We could abstract the dependency on the router into a prop and use this layer to compute the prop to pass down to single provider.


return <Provider {...props} />;
}
2 changes: 1 addition & 1 deletion packages/nextjs/src/components.client.ts
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export { ClerkProvider } from './pages/ClerkProvider';
export { ClerkProvider } from './client-boundary/ClerkProvider';
export { SignedIn, SignedOut } from './client-boundary/controlComponents';