Skip to content
Open
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/upgrade-codemod-sdk-filtering.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/upgrade': minor
---

Add `transform-clerk-provider-inside-body` codemod for Next.js 16 cache components support
125 changes: 124 additions & 1 deletion packages/upgrade/src/__tests__/integration/runner.test.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { loadConfig } from '../../config.js';
import { runScans } from '../../runner.js';
import { runCodemods, runScans } from '../../runner.js';
import { createTempFixture } from '../helpers/create-fixture.js';

const mockRunCodemod = vi.fn(() => Promise.resolve({ stats: {} }));

vi.mock('../../codemods/index.js', () => ({
runCodemod: (...args) => mockRunCodemod(...args),
getCodemodConfig: vi.fn(() => null),
}));

vi.mock('../../render.js', () => ({
colors: { reset: '', bold: '', yellow: '', gray: '' },
createSpinner: vi.fn(() => ({
Expand All @@ -17,6 +24,122 @@ vi.mock('../../render.js', () => ({
renderText: vi.fn(),
}));

describe('runCodemods', () => {
beforeEach(() => {
mockRunCodemod.mockClear();
});

it('runs all codemods when no packages filter is specified', async () => {
const config = {
codemods: ['transform-a', 'transform-b'],
};

await runCodemods(config, 'nextjs', { glob: '**/*.tsx' });

expect(mockRunCodemod).toHaveBeenCalledTimes(2);
expect(mockRunCodemod).toHaveBeenCalledWith('transform-a', ['**/*.tsx'], { glob: '**/*.tsx' });
expect(mockRunCodemod).toHaveBeenCalledWith('transform-b', ['**/*.tsx'], { glob: '**/*.tsx' });
});

it('skips codemods that do not match the current SDK', async () => {
const config = {
codemods: [
'transform-all', // runs for all
{ name: 'transform-nextjs-only', packages: ['nextjs'] },
{ name: 'transform-react-only', packages: ['react'] },
],
};

await runCodemods(config, 'nextjs', { glob: '**/*.tsx' });

expect(mockRunCodemod).toHaveBeenCalledTimes(2);
expect(mockRunCodemod).toHaveBeenCalledWith('transform-all', ['**/*.tsx'], { glob: '**/*.tsx' });
expect(mockRunCodemod).toHaveBeenCalledWith('transform-nextjs-only', ['**/*.tsx'], { glob: '**/*.tsx' });
});

it('runs codemods with wildcard packages for any SDK', async () => {
const config = {
codemods: [{ name: 'transform-universal', packages: ['*'] }],
};

await runCodemods(config, 'expo', { glob: '**/*.tsx' });

expect(mockRunCodemod).toHaveBeenCalledTimes(1);
expect(mockRunCodemod).toHaveBeenCalledWith('transform-universal', ['**/*.tsx'], { glob: '**/*.tsx' });
});

it('runs codemods when SDK is in the packages array', async () => {
const config = {
codemods: [{ name: 'transform-multi', packages: ['nextjs', 'react', 'expo'] }],
};

await runCodemods(config, 'react', { glob: '**/*.tsx' });

expect(mockRunCodemod).toHaveBeenCalledTimes(1);
});

it('skips all codemods when SDK does not match any', async () => {
const config = {
codemods: [
{ name: 'transform-nextjs-only', packages: ['nextjs'] },
{ name: 'transform-react-only', packages: ['react'] },
],
};

await runCodemods(config, 'expo', { glob: '**/*.tsx' });

expect(mockRunCodemod).not.toHaveBeenCalled();
});

it('handles empty codemods array', async () => {
const config = {
codemods: [],
};

await runCodemods(config, 'nextjs', { glob: '**/*.tsx' });

expect(mockRunCodemod).not.toHaveBeenCalled();
});

it('handles undefined codemods', async () => {
const config = {};

await runCodemods(config, 'nextjs', { glob: '**/*.tsx' });

expect(mockRunCodemod).not.toHaveBeenCalled();
});

it('treats empty packages array as matching no SDKs', async () => {
const config = {
codemods: [{ name: 'transform-none', packages: [] }],
};

await runCodemods(config, 'nextjs', { glob: '**/*.tsx' });

expect(mockRunCodemod).not.toHaveBeenCalled();
});

it('treats undefined packages as matching all SDKs', async () => {
const config = {
codemods: [{ name: 'transform-all', packages: undefined }],
};

await runCodemods(config, 'expo', { glob: '**/*.tsx' });

expect(mockRunCodemod).toHaveBeenCalledTimes(1);
});

it('propagates errors from codemod execution', async () => {
mockRunCodemod.mockRejectedValueOnce(new Error('Codemod failed'));

const config = {
codemods: ['transform-broken'],
};

await expect(runCodemods(config, 'nextjs', { glob: '**/*.tsx' })).rejects.toThrow('Codemod failed');
});
});

describe('runScans', () => {
let fixture;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
export const fixtures = [
{
name: 'Moves ClerkProvider from wrapping html to inside body',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<ClerkProvider>
<html>
<body>{children}</body>
</html>
</ClerkProvider>
);
}
`,
output: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<html>
<body><ClerkProvider>{children}</ClerkProvider></body>
</html>
);
}
`,
},
{
name: 'Preserves ClerkProvider props when moving',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<ClerkProvider dynamic afterSignInUrl="/dashboard">
<html lang="en">
<body className="antialiased">{children}</body>
</html>
</ClerkProvider>
);
}
`,
output: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<html lang="en">
<body className="antialiased"><ClerkProvider dynamic afterSignInUrl="/dashboard">{children}</ClerkProvider></body>
</html>
);
}
`,
},
{
name: 'Does not transform if ClerkProvider is already inside body',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<html>
<body>
<ClerkProvider>{children}</ClerkProvider>
</body>
</html>
);
}
`,
output: '',
},
{
name: 'Does not transform if ClerkProvider does not wrap html',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function Page() {
return (
<ClerkProvider>
<div>{children}</div>
</ClerkProvider>
);
}
`,
output: '',
},
{
name: 'Does not transform if not from @clerk/nextjs',
source: `
import { ClerkProvider } from 'some-other-package'

export default function RootLayout({ children }) {
return (
<ClerkProvider>
<html>
<body>{children}</body>
</html>
</ClerkProvider>
);
}
`,
output: '',
},
{
name: 'Handles body with multiple children',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<ClerkProvider>
<html>
<body>
<Header />
<main>{children}</main>
<Footer />
</body>
</html>
</ClerkProvider>
);
}
`,
output: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<html>
<body>
<ClerkProvider>
<Header />
<main>{children}</main>
<Footer />
</ClerkProvider>
</body>
</html>
);
}
`,
},
{
name: 'Handles html with head element',
source: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<ClerkProvider>
<html>
<head>
<title>My App</title>
</head>
<body>{children}</body>
</html>
</ClerkProvider>
);
}
`,
output: `
import { ClerkProvider } from '@clerk/nextjs'

export default function RootLayout({ children }) {
return (
<html>
<head>
<title>My App</title>
</head>
<body><ClerkProvider>{children}</ClerkProvider></body>
</html>
);
}
`,
},
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { applyTransform } from 'jscodeshift/dist/testUtils';
import { describe, expect, it } from 'vitest';

import transformer from '../transform-clerk-provider-inside-body.cjs';
import { fixtures } from './__fixtures__/transform-clerk-provider-inside-body.fixtures';

describe('transform-clerk-provider-inside-body', () => {
it.each(fixtures)(`$name`, ({ source, output }) => {
const result = applyTransform(transformer, {}, { source });

expect(result).toEqual(output.trim());
});
});
Loading
Loading