v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikosdouvlis merged 4 commits into from
Jan 17, 2024
Merged

v5 redirect improvements #2611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf1862d
fix(backend,nextjs): Propagate return type and handle relative urls i…
nikosdouvlis Dec 14, 2023
f4290a5
feat(nextjs): Introduce `auth().redirectToSignIn()`
nikosdouvlis Jan 16, 2024
e8ab978
feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…
nikosdouvlis Jan 16, 2024
2bdc2a4
fix(nextjs): Make sure importing from /server does not break page router
nikosdouvlis Jan 16, 2024
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
19 changes: 19 additions & 0 deletions .changeset/chatty-bottles-rhyme.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/nextjs': patch
---

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
const { userId } = auth();

if (!userId) {
return auth().redirectToSignIn();
}

return <>{children}</>;
};
```
114 changes: 57 additions & 57 deletions ...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

test('exposes redirectToSignIn / redirectToSignUp', assert => {
const helpers = redirect({ redirectAdapter: sinon.spy() });
const helpers = createRedirect({
redirectAdapter: sinon.spy(),
publishableKey: '',
baseUrl: 'http://www.clerk.com',
});
assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
});

test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

assert.raises(
() => redirectToSignIn(),
new Error('destination url or return back url should be an absolute path url!'),
);
});

test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

assert.raises(
() => redirectToSignIn({ returnBackUrl: '/example' }),
new Error('destination url or return back url should be an absolute path url!'),
);
});

test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({
const { redirectToSignIn } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
signInUrl: 'http://signin.url:3001/sign-in',
signUpUrl: 'http://signin.url:3001/sign-up',
publishableKey: '',
});

const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

test('returns path based url with signInUrl as relative path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
const { redirectToSignIn } = createRedirect({
redirectAdapter: redirectAdapterSpy,
baseUrl: 'http://current.url:3000',
signInUrl: '/sign-in',
signUpUrl: '/sign-up',
publishableKey: '',
});

const result = redirectToSignIn({ returnBackUrl });
assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

test('returns path based url with signInUrl as absolute path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({
const { redirectToSignIn } = createRedirect({
redirectAdapter: redirectAdapterSpy,
signInUrl: 'http://signin.url:3001/sign-in',
signUpUrl: 'http://signin.url:3001/sign-up',
publishableKey: '',
baseUrl: 'http://www.clerk.com',
});

const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
const { redirectToSignIn } = createRedirect({
redirectAdapter: redirectAdapterSpy,
signUpUrl: 'http://signin.url:3001/sign-up',
baseUrl: 'http://www.clerk.com',
} as any);

assert.raises(
() => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({
const { redirectToSignIn } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
});
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({
const { redirectToSignIn } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
});
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignIn } = redirect({
const { redirectToSignIn } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
});
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
);
});

test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

assert.raises(
() => redirectToSignUp(),
new Error('destination url or return back url should be an absolute path url!'),
);
});

test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

assert.raises(
() => redirectToSignUp({ returnBackUrl: '/example' }),
new Error('destination url or return back url should be an absolute path url!'),
);
});

test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
redirectAdapter: redirectAdapterSpy,
signUpUrl: 'http://signin.url:3001/sign-up',
baseUrl: 'http://www.clerk.com',
publishableKey: '',
});

const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

test('returns path based url with signUpUrl as relative path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
const { redirectToSignUp } = createRedirect({
redirectAdapter: redirectAdapterSpy,
signUpUrl: '/sign-up',
baseUrl: 'http://current.url:3000',
publishableKey: '',
});

const result = redirectToSignUp({ returnBackUrl });
assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

test('returns path based url with signUpUrl as absolute path', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
redirectAdapter: redirectAdapterSpy,
signUpUrl: 'http://signup.url:3001/sign-up',
baseUrl: 'http://www.clerk.com',
publishableKey: '',
});

const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
const { redirectToSignUp } = createRedirect({
redirectAdapter: redirectAdapterSpy,
publishableKey: '',
baseUrl: 'http://www.clerk.com',
});

assert.raises(
() => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
});
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
});
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
});
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
const { redirectToSignUp } = redirect({
const { redirectToSignUp } = createRedirect({
baseUrl: 'http://www.clerk.com',
redirectAdapter: redirectAdapterSpy,
publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
});
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/__tests__/exports.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
'constants',
'createAuthenticateRequest',
'createClerkRequest',
'createRedirect',
'debugRequestState',
'decorateObjectWithResources',
'makeAuthObjectSerializable',
'redirect',
'signedInAuthObject',
'signedOutAuthObject',
'stripPrivateDataFromObject',
Expand Down
2 changes: 2 additions & 0 deletions packages/backend/src/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
AuthToken: '__clerkAuthToken',
AuthStatus: '__clerkAuthStatus',
AuthReason: '__clerkAuthReason',
AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
AuthToken: 'x-clerk-auth-token',
AuthStatus: 'x-clerk-auth-status',
AuthReason: 'x-clerk-auth-reason',
AuthMessage: 'x-clerk-auth-message',
Expand Down
66 changes: 66 additions & 0 deletions packages/backend/src/createRedirect.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
const baseUrl = new URL(_baseUrl);
const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
const res = new URL(_targetUrl, baseUrl);
if (returnBackUrl) {
res.searchParams.set('redirect_url', returnBackUrl.toString());
}
return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
if (!frontendApi) {
return '';
}

// convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
const accountsBaseUrl = frontendApi
// staging accounts
.replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
.replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
* @internal
*/
type CreateRedirect = <ReturnType>(params: {
publishableKey: string;
redirectAdapter: RedirectAdapter<ReturnType>;
baseUrl: URL | string;
signInUrl?: URL | string;
signUpUrl?: URL | string;
}) => {
redirectToSignIn: RedirectFun<ReturnType>;
redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
}
const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
};

const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
}
const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
};

return { redirectToSignUp, redirectToSignIn };
};
3 changes: 2 additions & 1 deletion packages/backend/src/internal.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading

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

Skip to content
v5 redirect improvements #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 4 commits into

from

Jan 17, 2024
 Merged


v5 redirect improvements #2611
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bf1862d

fix(backend,nextjs): Propagate return type and handle relative urls i…


nikosdouvlis Dec 14, 2023
f4290a5

feat(nextjs): Introduce `auth().redirectToSignIn()`


nikosdouvlis Jan 16, 2024
e8ab978

feat(nextjs): Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth a…


nikosdouvlis Jan 16, 2024
2bdc2a4

fix(nextjs): Make sure importing from /server does not break page router


nikosdouvlis Jan 16, 2024

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


19 changes: 19 additions & 0 deletions
.changeset/chatty-bottles-rhyme.md

View file


Open in desktop

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

- Export ClerkMiddlewareAuthObject, ClerkMiddlewareAuth and ClerkMiddlewareOptions types
- Introduce `auth().redirectToSignIn()` that can be used in API routes and pages, eg
```ts
import { auth } from '@clerk/nextjs/server';

export const Layout = ({ children }) => {
 const { userId } = auth();

 if (!userId) {
 return auth().redirectToSignIn();
 }

 return <>{children}</>;
};
```

114 changes: 57 additions & 57 deletions
...ackend/src/__tests__/redirections.test.ts → ...kend/src/__tests__/createRedirect.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type QUnit from 'qunit';
import sinon from 'sinon';

import { redirect } from '../redirections';
import { createRedirect } from '../createRedirect';

export default (QUnit: QUnit) => {
 const { module, test } = QUnit;
Expand All@@ -11,35 +11,22 @@ export default (QUnit: QUnit) => {
 const encodedUrl = 'http%3A%2F%2Fcurrent.url%3A3000%2Fpath%3Fq%3D1%23hash';

 test('exposes redirectToSignIn / redirectToSignUp', assert => {
 const helpers = redirect({ redirectAdapter: sinon.spy() });
 const helpers = createRedirect({
 redirectAdapter: sinon.spy(),
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });
 assert.propEqual(Object.keys(helpers).sort(), ['redirectToSignIn', 'redirectToSignUp']);
 });

 test('raises error with signInUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signInUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });

 assert.raises(
 () => redirectToSignIn({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signInUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn();
Expand All@@ -49,7 +36,13 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy, signInUrl: '/sign-in' });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 baseUrl: 'http://current.url:3000',
 signInUrl: '/sign-in',
 signUpUrl: '/sign-up',
 publishableKey: '',
 });

 const result = redirectToSignIn({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -58,9 +51,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signInUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signInUrl: 'http://signin.url:3001/sign-in',
 signUpUrl: 'http://signin.url:3001/sign-up',
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 const result = redirectToSignIn({ returnBackUrl });
Expand All@@ -70,7 +66,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signInUrl and publishableKey in redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignIn } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 } as any);

 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
Expand All@@ -82,7 +82,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -98,7 +99,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -110,7 +112,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signInUrl to redirectToSignIn', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignIn } = redirect({
 const { redirectToSignIn } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -122,31 +125,13 @@ export default (QUnit: QUnit) => {
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp(),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('raises error with signUpUrl as relative path and returnBackUrl relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl: '/example' }),
 new Error('destination url or return back url should be an absolute path url!'),
 );
 });

 test('returns path based url with signUpUrl as absolute path and returnBackUrl missing', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signin.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp();
Expand All@@ -156,7 +141,12 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as relative path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy, signUpUrl: '/sign-up' });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: '/sign-up',
 baseUrl: 'http://current.url:3000',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
 assert.equal(result, 'redirectAdapterValue');
Expand All@@ -165,9 +155,11 @@ export default (QUnit: QUnit) => {

 test('returns path based url with signUpUrl as absolute path', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 signUpUrl: 'http://signup.url:3001/sign-up',
 baseUrl: 'http://www.clerk.com',
 publishableKey: '',
 });

 const result = redirectToSignUp({ returnBackUrl });
Expand All@@ -177,7 +169,11 @@ export default (QUnit: QUnit) => {

 test('raises error without signUpUrl and publishableKey in redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({ redirectAdapter: redirectAdapterSpy });
 const { redirectToSignUp } = createRedirect({
 redirectAdapter: redirectAdapterSpy,
 publishableKey: '',
 baseUrl: 'http://www.clerk.com',
 });

 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
Expand All@@ -189,7 +185,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA',
 });
Expand All@@ -205,7 +202,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with production publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_Y2xlcmsuZXhhbXBsZS5jb20k',
 });
Expand All@@ -217,7 +215,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50cy5kZXYk',
 });
Expand All@@ -231,7 +230,8 @@ export default (QUnit: QUnit) => {

 test('returns path based url with development (kima) publishableKey (with staging Clerk) but without signUpUrl to redirectToSignUp', assert => {
 const redirectAdapterSpy = sinon.spy(_url => 'redirectAdapterValue');
 const { redirectToSignUp } = redirect({
 const { redirectToSignUp } = createRedirect({
 baseUrl: 'http://www.clerk.com',
 redirectAdapter: redirectAdapterSpy,
 publishableKey: 'pk_test_aW5jbHVkZWQua2F0eWRpZC05Mi5jbGVyay5hY2NvdW50c3N0YWdlLmRldiQ',
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/__tests__/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@ export default (QUnit: QUnit) => {
 'constants',
 'createAuthenticateRequest',
 'createClerkRequest',
 'createRedirect',
 'debugRequestState',
 'decorateObjectWithResources',
 'makeAuthObjectSerializable',
 'redirect',
 'signedInAuthObject',
 'signedOutAuthObject',
 'stripPrivateDataFromObject',
Expand Down

2 changes: 2 additions & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
export const JWKS_CACHE_TTL_MS = 1000 * 60 * 60;

const Attributes = {
 AuthToken: '__clerkAuthToken',
 AuthStatus: '__clerkAuthStatus',
 AuthReason: '__clerkAuthReason',
 AuthMessage: '__clerkAuthMessage',
Expand All@@ -24,6 +25,7 @@ const QueryParameters = {
} as const;

const Headers = {
 AuthToken: 'x-clerk-auth-token',
 AuthStatus: 'x-clerk-auth-status',
 AuthReason: 'x-clerk-auth-reason',
 AuthMessage: 'x-clerk-auth-message',
Expand Down

66 changes: 66 additions & 0 deletions
packages/backend/src/createRedirect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
import { errorThrower, parsePublishableKey } from './util/shared';

const buildUrl = (_baseUrl: string | URL, _targetUrl: string | URL, _returnBackUrl?: string | URL) => {
 const baseUrl = new URL(_baseUrl);
 const returnBackUrl = _returnBackUrl ? new URL(_returnBackUrl, baseUrl) : undefined;
 const res = new URL(_targetUrl, baseUrl);
 if (returnBackUrl) {
 res.searchParams.set('redirect_url', returnBackUrl.toString());
 }
 return res.toString();
};

const buildAccountsBaseUrl = (frontendApi?: string) => {
 if (!frontendApi) {
 return '';
 }

 // convert url from FAPI to accounts for Kima and legacy (prod & dev) instances
 const accountsBaseUrl = frontendApi
 // staging accounts
 .replace(/(clerk\.accountsstage\.)/, 'accountsstage.')
 .replace(/(clerk\.accounts\.|clerk\.)/, 'accounts.');
 return `https://${accountsBaseUrl}`;
};

type RedirectAdapter<RedirectReturn> = (url: string) => RedirectReturn;
type RedirectToParams = { returnBackUrl?: string | URL };
export type RedirectFun<ReturnType> = (params?: RedirectToParams) => ReturnType;

/**
 * @internal
 */
type CreateRedirect = <ReturnType>(params: {
 publishableKey: string;
 redirectAdapter: RedirectAdapter<ReturnType>;
 baseUrl: URL | string;
 signInUrl?: URL | string;
 signUpUrl?: URL | string;
}) => {
 redirectToSignIn: RedirectFun<ReturnType>;
 redirectToSignUp: RedirectFun<ReturnType>;
};

export const createRedirect: CreateRedirect = params => {
 const { publishableKey, redirectAdapter, signInUrl, signUpUrl, baseUrl } = params;
 const frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
 return redirectAdapter(buildUrl(baseUrl, signUpUrl || accountsSignUpUrl, returnBackUrl));
 };

 const redirectToSignIn = ({ returnBackUrl }: RedirectToParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
 errorThrower.throwMissingPublishableKeyError();
 }
 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
 return redirectAdapter(buildUrl(baseUrl, signInUrl || accountsSignInUrl, returnBackUrl));
 };

 return { redirectToSignUp, redirectToSignIn };
};

3 changes: 2 additions & 1 deletion
packages/backend/src/internal.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
export { constants } from './constants';
export { redirect } from './redirections';
export { createRedirect } from './createRedirect';
export type { RedirectFun } from './createRedirect';

export type { CreateAuthenticateRequestOptions } from './tokens/factory';
export { createAuthenticateRequest } from './tokens/factory';
Expand Down
Loading