fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into from
May 13, 2024
Merged

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0f85b1
fix(clerk-react): Correctly map redirect prop names
nikosdouvlis May 10, 2024
a4ef2c6
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…
nikosdouvlis May 10, 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
6 changes: 6 additions & 0 deletions .changeset/wet-peaches-grow.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
---

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.
32 changes: 16 additions & 16 deletions packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
});

it('redirects to signInUrl for development instance', async () => {
await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
expect(mockNavigate).toHaveBeenCalledWith(
'/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
'/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
undefined,
);
});

it('redirects to signInUrl for production instance', async () => {
await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
expect(mockNavigate).toHaveBeenCalledWith(
'/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
'/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
undefined,
);
});

it('redirects to signUpUrl for development instance', async () => {
await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
expect(mockNavigate).toHaveBeenCalledWith(
'/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
'/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
undefined,
);
});

it('redirects to signUpUrl for production instance', async () => {
await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
expect(mockNavigate).toHaveBeenCalledWith(
'/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
'/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
undefined,
);
});
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
const host = 'http://another-test.host';

it('redirects to signInUrl for development instance', async () => {
await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
expect(mockHref).toHaveBeenCalledTimes(1);
expect(mockHref).toHaveBeenCalledWith(
`${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
`${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
);
});

it('redirects to signInUrl for production instance', async () => {
await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
expect(mockHref).toHaveBeenCalledTimes(1);
expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
});

it('redirects to signUpUrl for development instance', async () => {
await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
expect(mockHref).toHaveBeenCalledTimes(1);
expect(mockHref).toHaveBeenCalledWith(
`${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
`${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
);
});

it('redirects to signUpUrl for production instance', async () => {
await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
expect(mockHref).toHaveBeenCalledTimes(1);
expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
});

it('redirects to userProfileUrl', async () => {
Expand Down
32 changes: 20 additions & 12 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
OrganizationProfileProps,
OrganizationResource,
OrganizationSwitcherProps,
RedirectOptions,
Resources,
SDKMetadata,
SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
}

public buildSignInUrl(options?: SignInRedirectOptions): string {
return this.#buildUrl('signInUrl', {
...options?.initialValues,
redirect_url: options?.redirectUrl || window.location.href,
});
return this.#buildUrl(
'signInUrl',
{ ...options, redirectUrl: options?.redirectUrl || window.location.href },
options?.initialValues,
);
}

public buildSignUpUrl(options?: SignUpRedirectOptions): string {
return this.#buildUrl('signUpUrl', {
...options?.initialValues,
redirect_url: options?.redirectUrl || window.location.href,
});
return this.#buildUrl(
'signUpUrl',
{ ...options, redirectUrl: options?.redirectUrl || window.location.href },
options?.initialValues,
);
}

public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
});
};

#buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
#buildUrl = (
key: 'signInUrl' | 'signUpUrl',
options: RedirectOptions,
_initValues?: Record<string, string>,

@dimkldimklMay 13, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?

): string => {
if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
return '';
}
const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
const redirectUrls = new RedirectUrls(this.#options, params);
return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
const initValues = new URLSearchParams(_initValues || {});
const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
return this.buildUrlWithAuth(url);
};

assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down
11 changes: 7 additions & 4 deletions packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
const preservedParams = redirectUrls.getPreservedSearchParams();
signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

// TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
const preservedParams = redirectUrls.getPreservedSearchParams();
signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

return {
Expand Down
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/router/RouteContext.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.
import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
refresh: () => void;
params: { [key: string]: string };
queryString: string;
queryParams: ParsedQs;
queryParams: Record<string, string>;
preservedParams?: string[];
getMatchData: (path?: string, index?: boolean) => false | object;
urlStateParam?: {
Expand Down
61 changes: 14 additions & 47 deletions packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
});

describe('search params', () => {
it('appends only the preserved props', () => {
it('flattens and returns all params', () => {
const redirectUrls = new RedirectUrls(
{
signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
);

const params = redirectUrls.toSearchParams();
expect([...params.keys()].length).toBe(1);
expect([...params.keys()].length).toBe(3);
expect(params.get('sign_in_force_redirect_url')).toBe(
`${mockWindowLocation.href}props-sign-in-force-redirect-url`,
);
expect(params.get('sign_up_fallback_redirect_url')).toBe(
`${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
);
expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
});
});

describe('append to url', () => {
it('does not append redirect urls from options to the url if the url is same origin', () => {
describe('preserved search params', () => {
it('does not return redirect urls if they are not in the preserved props array', () => {
const redirectUrls = new RedirectUrls({
signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
});

const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
expect(url).toBe('https://www.clerk.com/');
});

it('appends redirect urls from options to the url if the url is cross origin', () => {
const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
expect(url).toContain('search-param-redirect-url');
});

it('overrides the existing search params', () => {
const redirectUrls = new RedirectUrls(
{
signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
},
{},
{ redirect_url: '/search-param-redirect-url' },
);

const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
expect(url).toBe(
'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
);
const params = redirectUrls.getPreservedSearchParams();
expect([...params.keys()].length).toBe(0);
});

it('appends redirect urls from props to the url even if the url is same origin', () => {
const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
expect(url).toContain('search-param-redirect-url');
});

it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
const redirectUrls = new RedirectUrls(
{
signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
},
{
signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
},
);

const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
expect(url).toBe('https://www.clerk.com/');
const params = redirectUrls.getPreservedSearchParams();
expect(params.get('redirect_url')).toContain('search-param-redirect-url');
});
});
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
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
fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361

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 2 commits into

from

May 13, 2024
 Merged


fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUpUrl#3361
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d0f85b1

fix(clerk-react): Correctly map redirect prop names


nikosdouvlis May 10, 2024
a4ef2c6

fix(clerk-js): Respect props passed to buildSignInUrl and buildSignUp…


nikosdouvlis May 10, 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


6 changes: 6 additions & 0 deletions
.changeset/wet-peaches-grow.md

View file


Open in desktop

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

Respect the `signInForceRedirectUrl`, `signInFallbackRedirectUrl`, `signUpForceRedirectUrl` and `signUpFallbackRedirectUrl` props passed to `SignInButton`, `SignUpButton` and the low-level `window.Clerk.buildSignInUrl` & `window.Clerk.buildSignUpUrl` methods. These props allow you to control the redirect behavior of the `SignIn` and `SignUp` components. For more information, refer to the [Custom Redirects](https://clerk.com/docs/guides/custom-redirects) guide.

32 changes: 16 additions & 16 deletions
packages/clerk-js/src/core/__tests__/clerk.redirects.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,33 +123,33 @@ describe('Clerk singleton - Redirects', () => {
 });

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockNavigate).toHaveBeenCalledWith(
 '/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F',
 '/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample',
 undefined,
 );
 });
Expand DownExpand Up@@ -220,31 +220,31 @@ describe('Clerk singleton - Redirects', () => {
 const host = 'http://another-test.host';

 it('redirects to signInUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-in?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signInUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignIn({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-in#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to signUpUrl for development instance', async () => {
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForDevelopmentInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`,
 `${host}/sign-up?__clerk_db_jwt=deadbeef#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`,
 );
 });

 it('redirects to signUpUrl for production instance', async () => {
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: 'https://www.example.com/' });
 await clerkForProductionInstance.redirectToSignUp({ redirectUrl: '/example' });
 expect(mockHref).toHaveBeenCalledTimes(1);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=https%3A%2F%2Fwww.example.com%2F`);
 expect(mockHref).toHaveBeenCalledWith(`${host}/sign-up#/?redirect_url=http%3A%2F%2Ftest.host%2Fexample`);
 });

 it('redirects to userProfileUrl', async () => {
Expand Down

32 changes: 20 additions & 12 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 RedirectOptions,
 Resources,
 SDKMetadata,
 SetActiveParams,
Expand DownExpand Up@@ -826,19 +827,20 @@ export class Clerk implements ClerkInterface {

 return setDevBrowserJWTInURL(toURL, devBrowserJwt).href;
 }

 public buildSignInUrl(options?: SignInRedirectOptions): string {
 return this.#buildUrl('signInUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signInUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildSignUpUrl(options?: SignUpRedirectOptions): string {
 return this.#buildUrl('signUpUrl', {
 ...options?.initialValues,
 redirect_url: options?.redirectUrl || window.location.href,
 });
 return this.#buildUrl(
 'signUpUrl',
 { ...options, redirectUrl: options?.redirectUrl || window.location.href },
 options?.initialValues,
 );
 }

 public buildUserProfileUrl(): string {
Expand DownExpand Up@@ -1642,13 +1644,19 @@ export class Clerk implements ClerkInterface {
 });
 };

 #buildUrl = (key: 'signInUrl' | 'signUpUrl', params?: Record<string, string>): string => {
 #buildUrl = (
 key: 'signInUrl' | 'signUpUrl',
 options: RedirectOptions,
 _initValues?: Record<string, string>,
@dimkldimklMay 13, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🙃 The _ prefix in parameters is used to mark unused parameters of a function. Are we sure about this naming?
 ): string => {
 if (!key || !this.loaded || !this.#environment || !this.#environment.displayConfig) {
 return '';
 }
 const signInOrUpUrl = this.#options[key] || this.#environment.displayConfig[key];
 const redirectUrls = new RedirectUrls(this.#options, params);
 return this.buildUrlWithAuth(redirectUrls.appendPreservedPropsToUrl(signInOrUpUrl, params));
 const redirectUrls = new RedirectUrls(this.#options, options).toSearchParams();
 const initValues = new URLSearchParams(_initValues || {});
 const url = buildURL({ base: signInOrUpUrl, hashSearchParams: [initValues, redirectUrls] }, { stringify: true });
 return this.buildUrlWithAuth(url);
 };

 assertComponentsReady(controls: unknown): asserts controls is ReturnType<MountComponentRenderer> {
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -91,8 +91,9 @@ export const useSignUpContext = (): SignUpContextType => {
 let signUpUrl = (ctx.routing === 'path' && ctx.path) || options.signUpUrl || displayConfig.signUpUrl;
 let signInUrl = ctx.signInUrl || options.signInUrl || displayConfig.signInUrl;

 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 // TODO: Avoid building this url again to remove duplicate code. Get it from window.Clerk instead.
 const secondFactorUrl = buildURL({ base: signInUrl, hashPath: '/factor-two' }, { stringify: true });
Expand DownExpand Up@@ -161,8 +162,10 @@ export const useSignInContext = (): SignInContextType => {
 let signInUrl = (ctx.routing === 'path' && ctx.path) || options.signInUrl || displayConfig.signInUrl;
 let signUpUrl = ctx.signUpUrl || options.signUpUrl || displayConfig.signUpUrl;

 signInUrl = redirectUrls.appendPreservedPropsToUrl(signInUrl, queryParams);
 signUpUrl = redirectUrls.appendPreservedPropsToUrl(signUpUrl, queryParams);
 const preservedParams = redirectUrls.getPreservedSearchParams();
 signInUrl = buildURL({ base: signInUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });
 signUpUrl = buildURL({ base: signUpUrl, hashSearchParams: [queryParams, preservedParams] }, { stringify: true });

 const signUpContinueUrl = buildURL({ base: signUpUrl, hashPath: '/continue' }, { stringify: true });

 return {
Expand Down

3 changes: 1 addition & 2 deletions
packages/clerk-js/src/ui/router/RouteContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import type { ParsedQs } from 'qs';
Comment thread
nikosdouvlis marked this conversation as resolved.

import React from 'react';

export interface RouteContextValue {
Expand All@@ -15,7 +14,7 @@ export interface RouteContextValue {
 refresh: () => void;
 params: { [key: string]: string };
 queryString: string;
 queryParams: ParsedQs;
 queryParams: Record<string, string>;
 preservedParams?: string[];
 getMatchData: (path?: string, index?: boolean) => false | object;
 urlStateParam?: {
Expand Down

61 changes: 14 additions & 47 deletions
packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,7 +247,7 @@ describe('redirectUrls', () => {
 });

 describe('search params', () => {
 it('appends only the preserved props', () => {
 it('flattens and returns all params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
Expand All@@ -263,66 +263,33 @@ describe('redirectUrls', () => {
 );

 const params = redirectUrls.toSearchParams();
 expect([...params.keys()].length).toBe(1);
 expect([...params.keys()].length).toBe(3);
 expect(params.get('sign_in_force_redirect_url')).toBe(
 `${mockWindowLocation.href}props-sign-in-force-redirect-url`,
 );
 expect(params.get('sign_up_fallback_redirect_url')).toBe(
 `${mockWindowLocation.href}search-param-sign-up-fallback-redirect-url`,
 );
 expect(params.get('redirect_url')).toBe(`${mockWindowLocation.href}search-param-redirect-url`);
 });
 });

 describe('append to url', () => {
 it('does not append redirect urls from options to the url if the url is same origin', () => {
 describe('preserved search params', () => {
 it('does not return redirect urls if they are not in the preserved props array', () => {
 const redirectUrls = new RedirectUrls({
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 });

 it('appends redirect urls from options to the url if the url is cross origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('overrides the existing search params', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {},
 { redirect_url: '/search-param-redirect-url' },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.example.com?redirect_url=existing');
 expect(url).toBe(
 'https://www.example.com/?redirect_url=existing#/?redirect_url=https%3A%2F%2Fwww.clerk.com%2Fsearch-param-redirect-url',
 );
 const params = redirectUrls.getPreservedSearchParams();
 expect([...params.keys()].length).toBe(0);
 });

 it('appends redirect urls from props to the url even if the url is same origin', () => {
 const redirectUrls = new RedirectUrls({}, {}, { redirect_url: '/search-param-redirect-url' });

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toContain('search-param-redirect-url');
 });

 it('does not append redirect urls from props to the url if the url is same origin if they match the options urls', () => {
 const redirectUrls = new RedirectUrls(
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 {
 signInFallbackRedirectUrl: 'sign-in-fallback-redirect-url',
 signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
 },
 );

 const url = redirectUrls.appendPreservedPropsToUrl('https://www.clerk.com');
 expect(url).toBe('https://www.clerk.com/');
 const params = redirectUrls.getPreservedSearchParams();
 expect(params.get('redirect_url')).toContain('search-param-redirect-url');
 });
 });
});
Loading