fix(clerk-js): Support legacy redirectUrl prop

clerk · Apr 18, 2024 · f00fd2d · f00fd2d
1 parent da9c31f
commit f00fd2d
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 1 deletion.
diff --git a/.changeset/silent-rocks-do.md b/.changeset/silent-rocks-do.md
@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Support legacy redirectUrl prop on SignIn and SignUp
diff --git a/packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts b/packages/clerk-js/src/utils/__tests__/redirectUrls.test.ts
@@ -101,6 +101,39 @@ describe('redirectUrls', () => {
       expect(redirectUrls.getAfterSignUpUrl()).toBe(`${mockWindowLocation.href}sign-up-fallback-redirect-url`);
     });
 
+    // TODO: v6 - remove this test
+    it('falls back to legacy redirect prop if no new props are found', () => {
+      const redirectUrls = new RedirectUrls(
+        {
+          signUpFallbackRedirectUrl: 'sign-up-fallback-redirect-url',
+        },
+        {
+          redirectUrl: 'redirect-url',
+        },
+      );
+
+      expect(redirectUrls.getAfterSignInUrl()).toBe(`${mockWindowLocation.href}redirect-url`);
+      expect(redirectUrls.getAfterSignUpUrl()).toBe(`${mockWindowLocation.href}sign-up-fallback-redirect-url`);
+    });
+
+    // TODO: v6 - remove this test
+    it('falls back to legacy redirect prop if no new props are found', () => {
+      const redirectUrls = new RedirectUrls(
+        {
+          signUpForceRedirectUrl: 'sign-up-fallback-redirect-url',
+        },
+        {
+          redirectUrl: 'redirect-url',
+        },
+        {
+          redirect_url: 'redirect-url-params',
+        },
+      );
+
+      expect(redirectUrls.getAfterSignInUrl()).toBe(`${mockWindowLocation.href}redirect-url-params`);
+      expect(redirectUrls.getAfterSignUpUrl()).toBe(`${mockWindowLocation.href}sign-up-fallback-redirect-url`);
+    });
+
     it('prioritizes force urls among other urls in the same group', () => {
       const redirectUrls = new RedirectUrls({
         signInForceRedirectUrl: 'sign-in-force-redirect-url',

diff --git a/packages/clerk-js/src/utils/redirectUrls.ts b/packages/clerk-js/src/utils/redirectUrls.ts
@@ -14,6 +14,7 @@ export class RedirectUrls {
     'signUpFallbackRedirectUrl',
     'afterSignInUrl',
     'afterSignUpUrl',
+    'redirectUrl',
   ];
 
   private static preserved = ['redirectUrl'];
@@ -84,7 +85,12 @@ export class RedirectUrls {
 
     // TODO: v6
     // Remove the compatibility layer for afterSignInUrl and afterSignUpUrl
-    result ||= this.fromSearchParams[legacyPropKey] || this.fromProps[legacyPropKey] || this.fromOptions[legacyPropKey];
+    result ||=
+      this.fromSearchParams[legacyPropKey] ||
+      this.fromSearchParams.redirectUrl ||
+      this.fromProps[legacyPropKey] ||
+      this.fromProps.redirectUrl ||
+      this.fromOptions[legacyPropKey];
 
     return result || '/';
   }

diff --git a/packages/types/src/redirects.ts b/packages/types/src/redirects.ts
@@ -21,6 +21,11 @@ export type LegacyRedirectProps = {
    * Use `fallbackRedirectUrl` or `forceRedirectUrl` instead.
    */
   afterSignUpUrl?: string | null;
+  /**
+   * @deprecated This is deprecated and will be removed in a future release.
+   * Use `fallbackRedirectUrl` or `forceRedirectUrl` instead.
+   */
+  redirectUrl?: string | null;
 };
 
 /**