fix: preserve query params when redirectBack is used (#779)

* Preserve query params when redirectBack is used

* PR changes

* Update tests

Author: anku255

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
+## [0.36.1] - 2023-12-20
+
+### Fixes
+
+-   Previously, when calling `redirectToAuth` with the `redirectBack` option, query parameters were stripped when redirecting back to the previous page after authentication. This issue has been fixed, and now query parameters are preserved as intended.
+
 ## [0.36.0] - 2023-12-07
 
 ### Changes

lib/build/genericComponentOverrideContext.js

@@ -28,7 +28,7 @@ import { saveCurrentLanguage, TranslationController } from "./translation/transl
 import {
     appendQueryParamsToURL,
     appendTrailingSlashToURL,
-    getCurrentNormalisedUrlPath,
+    getCurrentNormalisedUrlPathWithQueryParams,
     getDefaultCookieScope,
     getOriginOfPage,
     isTest,
@@ -193,7 +193,7 @@ export default class SuperTokens {
             queryParams.show = options.show;
         }
         if (options.redirectBack === true) {
-            queryParams.redirectToPath = getCurrentNormalisedUrlPath().getAsStringDangerous();
+            queryParams.redirectToPath = getCurrentNormalisedUrlPathWithQueryParams();
         }
 
         let redirectUrl = await this.getRedirectUrl(

lib/build/utils.d.ts

@@ -80,7 +80,18 @@ export function getRedirectToPathFromURL(): string | undefined {
         try {
             const normalisedURLPath = new NormalisedURLPath(param).getAsStringDangerous();
             const pathQueryParams = param.split("?")[1] !== undefined ? `?${param.split("?")[1]}` : "";
-            return normalisedURLPath + pathQueryParams;
+            const pathWithQueryParams = normalisedURLPath + pathQueryParams;
+
+            // Ensure a leading "/" if `normalisedUrlPath` is empty but `pathWithQueryParams` is not to ensure proper redirection.
+            // Example: "?test=1" will not redirect the user to `/?test=1` if we don't add a leading "/".
+            if (
+                normalisedURLPath.length === 0 &&
+                pathWithQueryParams.length > 0 &&
+                !pathWithQueryParams.startsWith("/")
+            ) {
+                return "/" + pathWithQueryParams;
+            }
+            return pathWithQueryParams;
         } catch {
             return undefined;
         }
@@ -189,6 +200,11 @@ export function getCurrentNormalisedUrlPath(): NormalisedURLPath {
     return new NormalisedURLPath(WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getPathName());
 }
 
+export function getCurrentNormalisedUrlPathWithQueryParams(): string {
+    const normalisedUrlPath = getCurrentNormalisedUrlPath().getAsStringDangerous();
+    return normalisedUrlPath + WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getSearch();
+}
+
 export function appendQueryParamsToURL(stringUrl: string, queryParams?: Record<string, string>): string {
     if (queryParams === undefined) {
         return stringUrl;

lib/build/version.d.ts

@@ -12,4 +12,4 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const package_version = "0.36.0";
+export const package_version = "0.36.1";

lib/ts/superTokens.tsx

@@ -1,6 +1,6 @@
 {
     "name": "supertokens-auth-react",
-    "version": "0.36.0",
+    "version": "0.36.1",
     "description": "ReactJS SDK that provides login functionality with SuperTokens.",
     "main": "./index.js",
     "engines": {

lib/ts/utils.ts

@@ -52,6 +52,8 @@ import {
     setGeneralErrorToLocalStorage,
     isAccountLinkingSupported,
     backendBeforeEach,
+    getDefaultSignUpFieldValues,
+    getTestEmail,
 } from "../helpers";
 
 describe("SuperTokens Email Verification", function () {
@@ -114,14 +116,11 @@ describe("SuperTokens Email Verification", function () {
                 page.waitForNavigation({ waitUntil: "networkidle0" }),
             ]);
             await toggleSignInSignUp(page);
-            const email = `john.doe${Date.now()}@supertokens.io`;
-            await signUp(page, [
-                { name: "email", value: email },
-                { name: "password", value: "Str0ngP@ssw0rd" },
-                { name: "name", value: "John Doe" },
-                { name: "age", value: "20" },
-                { name: "country", value: "" },
-            ]);
+
+            const email = getTestEmail();
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email });
+            await signUp(page, fieldValues, postValues, "emailpassword");
+
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             await fetch(`${TEST_APPLICATION_SERVER_BASE_URL}/deleteUser`, {
@@ -169,14 +168,10 @@ describe("SuperTokens Email Verification", function () {
                 page.waitForNavigation({ waitUntil: "networkidle0" }),
             ]);
             await toggleSignInSignUp(page);
-            const email = `john.doe${Date.now()}@supertokens.io`;
-            await signUp(page, [
-                { name: "email", value: email },
-                { name: "password", value: "Str0ngP@ssw0rd" },
-                { name: "name", value: "John Doe" },
-                { name: "age", value: "20" },
-                { name: "country", value: "" },
-            ]);
+            const email = getTestEmail();
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email });
+            await signUp(page, fieldValues, postValues, "emailpassword");
+
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
             let pathname = await page.evaluate(() => window.location.pathname);
             assert.deepStrictEqual(pathname, "/auth/verify-email");
@@ -264,24 +259,15 @@ describe("SuperTokens Email Verification", function () {
             ]);
         });
 
-        it("Should redirect to verify email screen on successful sign up when mode is REQUIRED and email is not verified and then post verification should redirect with original redirectPath and newUser", async function () {
+        it("Should redirect to verify email screen on successful sign up when mode is REQUIRED and email is not verified and then post verification should redirect with original redirectPath (w/ leading slash) and newUser", async function () {
             await Promise.all([
-                page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=%2Fredirect-here`),
+                page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=%2Fredirect-here%3Ffoo%3Dbar`),
                 page.waitForNavigation({ waitUntil: "networkidle0" }),
             ]);
             await toggleSignInSignUp(page);
-            const rid = "emailpassword";
-            await signUp(
-                page,
-                [
-                    { name: "email", value: "[email protected]" },
-                    { name: "password", value: "Str0ngP@ssw0rd" },
-                    { name: "name", value: "John Doe" },
-                    { name: "age", value: "20" },
-                ],
-                '{"formFields":[{"id":"email","value":"[email protected]"},{"id":"password","value":"Str0ngP@ssw0rd"},{"id":"name","value":"John Doe"},{"id":"age","value":"20"},{"id":"country","value":""}]}',
-                rid
-            );
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: "[email protected]" });
+            await signUp(page, fieldValues, postValues, "emailpassword");
+
             let pathname = await page.evaluate(() => window.location.pathname);
             assert.deepStrictEqual(pathname, "/auth/verify-email");
 
@@ -295,9 +281,36 @@ describe("SuperTokens Email Verification", function () {
             // click on the continue button
             await Promise.all([submitForm(page), page.waitForNavigation({ waitUntil: "networkidle0" })]);
 
-            // check that we are in /redirect-here
-            pathname = await page.evaluate(() => window.location.pathname);
-            assert.deepStrictEqual(pathname, "/redirect-here");
+            // check that we are in /redirect-here?foo=bar
+            const urlWithQP = await page.evaluate(() => window.location.pathname + window.location.search);
+            assert.deepStrictEqual(urlWithQP, "/redirect-here?foo=bar");
+        });
+
+        it("Should redirect to verify email screen on successful sign up when mode is REQUIRED and email is not verified and then post verification should redirect with original redirectPath (w/o leading slash) and newUser", async function () {
+            await Promise.all([
+                page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=%3Ffoo%3Dbar`),
+                page.waitForNavigation({ waitUntil: "networkidle0" }),
+            ]);
+            await toggleSignInSignUp(page);
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: getTestEmail() });
+            await signUp(page, fieldValues, postValues, "emailpassword");
+
+            let pathname = await page.evaluate(() => window.location.pathname);
+            assert.deepStrictEqual(pathname, "/auth/verify-email");
+
+            // we wait for email to be created
+            await new Promise((r) => setTimeout(r, 1000));
+
+            // we fetch the email verification link and go to that
+            const latestURLWithToken = await getLatestURLWithToken();
+            await Promise.all([page.waitForNavigation({ waitUntil: "networkidle0" }), page.goto(latestURLWithToken)]);
+
+            // click on the continue button
+            await Promise.all([submitForm(page), page.waitForNavigation({ waitUntil: "networkidle0" })]);
+
+            // check that we are in /?foo=bar
+            const urlWithQP = await page.evaluate(() => window.location.pathname + window.location.search);
+            assert.deepStrictEqual(urlWithQP, "/?foo=bar");
         });
 
         it("Should redirect to verify email screen on successful sign in when mode is REQUIRED and email is not verified", async function () {
@@ -451,17 +464,8 @@ describe("SuperTokens Email Verification", function () {
 
         it('Should show "Email Verification successful" screen when token is valid with an active session', async function () {
             await toggleSignInSignUp(page);
-            await signUp(
-                page,
-                [
-                    { name: "email", value: "[email protected]" },
-                    { name: "password", value: "Str0ngP@ssw0rd" },
-                    { name: "name", value: "John Doe" },
-                    { name: "age", value: "20" },
-                ],
-                '{"formFields":[{"id":"email","value":"[email protected]"},{"id":"password","value":"Str0ngP@ssw0rd"},{"id":"name","value":"John Doe"},{"id":"age","value":"20"},{"id":"country","value":""}]}',
-                "emailpassword"
-            );
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: "[email protected]" });
+            await signUp(page, fieldValues, postValues, "emailpassword");
 
             const latestURLWithToken = await getLatestURLWithToken();
             await Promise.all([page.waitForNavigation({ waitUntil: "networkidle0" }), page.goto(latestURLWithToken)]);
@@ -518,17 +522,8 @@ describe("SuperTokens Email Verification", function () {
             ]);
             await toggleSignInSignUp(page);
 
-            await signUp(
-                page,
-                [
-                    { name: "email", value: "[email protected]" },
-                    { name: "password", value: "Str0ngP@ssw0rd" },
-                    { name: "name", value: "John Doe" },
-                    { name: "age", value: "20" },
-                ],
-                '{"formFields":[{"id":"email","value":"[email protected]"},{"id":"password","value":"Str0ngP@ssw0rd"},{"id":"name","value":"John Doe"},{"id":"age","value":"20"},{"id":"country","value":""}]}',
-                "emailpassword"
-            );
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: "[email protected]" });
+            await signUp(page, fieldValues, postValues, "emailpassword");
 
             const latestURLWithToken = await getLatestURLWithToken();
             await Promise.all([
@@ -708,17 +703,8 @@ describe("SuperTokens Email Verification general errors", function () {
 
         it('Should show "General Error" when API returns "GENERAL_ERROR"', async function () {
             await toggleSignInSignUp(page);
-            await signUp(
-                page,
-                [
-                    { name: "email", value: "[email protected]" },
-                    { name: "password", value: "Str0ngP@ssw0rd" },
-                    { name: "name", value: "John Doe" },
-                    { name: "age", value: "20" },
-                ],
-                '{"formFields":[{"id":"email","value":"[email protected]"},{"id":"password","value":"Str0ngP@ssw0rd"},{"id":"name","value":"John Doe"},{"id":"age","value":"20"},{"id":"country","value":""}]}',
-                "emailpassword"
-            );
+            const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: "[email protected]" });
+            await signUp(page, fieldValues, postValues, "emailpassword");
 
             const latestURLWithToken = await getLatestURLWithToken();
             await page.goto(latestURLWithToken);
@@ -903,18 +889,8 @@ describe("Email verification signOut errors", function () {
         await toggleSignInSignUp(page);
         await page.evaluate(() => localStorage.setItem("SHOW_GENERAL_ERROR", "SESSION SIGN_OUT"));
 
-        const rid = "emailpassword";
-        await signUp(
-            page,
-            [
-                { name: "email", value: "[email protected]" },
-                { name: "password", value: "Str0ngP@ssw0rd" },
-                { name: "name", value: "John Doe" },
-                { name: "age", value: "20" },
-            ],
-            '{"formFields":[{"id":"email","value":"[email protected]"},{"id":"password","value":"Str0ngP@ssw0rd"},{"id":"name","value":"John Doe"},{"id":"age","value":"20"},{"id":"country","value":""}]}',
-            rid
-        );
+        const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: "[email protected]" });
+        await signUp(page, fieldValues, postValues, "emailpassword");
 
         let pathname = await page.evaluate(() => window.location.pathname);
         assert.deepStrictEqual(pathname, "/auth/verify-email");