Merge pull request #260 from supertokens/fix/add_cookie_blocked_warning

feat: add a console warning if writing to cookies doesn't work
supertokens · Jun 14, 2024 · 56fa018 · 56fa018
2 parents ca75b25 + 1f8cee8
commit 56fa018
Show file tree

Hide file tree

Showing 11 changed files with 106 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [20.1.1] - 2024-07-13
+
+### Changes
+
+- Added a warning if the SDK can't save to cookies to help people notice/debug these issues faster.
+
 ## [20.1.0] - 2024-05-31
 
 ### Changes

diff --git a/bundle/bundle.js b/bundle/bundle.js
diff --git a/lib/build/fetch.js b/lib/build/fetch.js
diff --git a/lib/build/version.d.ts b/lib/build/version.d.ts
diff --git a/lib/build/version.js b/lib/build/version.js
diff --git a/lib/ts/fetch.ts b/lib/ts/fetch.ts
@@ -805,6 +805,8 @@ async function saveTokensFromHeaders(response: Response) {
     }
 }
 
+let successfullySavedToCookies: boolean | undefined = undefined;
+
 export async function saveLastAccessTokenUpdate() {
     logDebugMessage("saveLastAccessTokenUpdate: called");
 
@@ -813,6 +815,16 @@ export async function saveLastAccessTokenUpdate() {
     logDebugMessage("saveLastAccessTokenUpdate: setting " + now);
     await storeInCookies(LAST_ACCESS_TOKEN_UPDATE, now, Number.MAX_SAFE_INTEGER);
 
+    if (successfullySavedToCookies === undefined) {
+        successfullySavedToCookies = (await getFromCookies(LAST_ACCESS_TOKEN_UPDATE)) === now;
+    }
+
+    if (successfullySavedToCookies === false) {
+        console.warn(
+            "Saving to cookies was not successful, this indicates a configuration error or the browser preventing us from writing the cookies (e.g.: incognito mode)."
+        );
+    }
+
     // We clear the sIRTFrontend cookie
     // We are handling this as a special case here because we want to limit the scope of legacy code
     await storeInCookies("sIRTFrontend", "", 0);

diff --git a/lib/ts/version.ts b/lib/ts/version.ts
@@ -12,6 +12,6 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const package_version = "20.1.0";
+export const package_version = "20.1.1";
 
 export const supported_fdi = ["1.16", "1.17", "1.18", "1.19", "2.0", "3.0"];
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "supertokens-website",
-  "version": "20.1.0",
+  "version": "20.1.1",
   "description": "frontend sdk for website to be used for auth solution.",
   "main": "index.js",
   "dependencies": {

diff --git a/test/interception.basic1.test.js b/test/interception.basic1.test.js
@@ -231,6 +231,43 @@ addTestCases((name, transferMethod, setupFunc, setupArgs = []) => {
             assert.strictEqual(cookies.length, 0);
         });
 
+        it("test warnings when cookie writes are not successful", async function () {
+            await startST(3);
+            await setup({
+                // enableDebugLogs: true,
+                disableCookies: true
+            });
+            const logs = [];
+            page.on("console", c => logs.push(c.text()));
+            await page.evaluate(async () => {
+                await new Promise(res => setTimeout(res, 5000));
+                const userId = "testing-supertokens-website";
+
+                const loginResponse = await toTest({
+                    url: `${BASE_URL}/login`,
+                    method: "post",
+                    headers: {
+                        Accept: "application/json",
+                        "Content-Type": "application/json"
+                    },
+                    body: JSON.stringify({ userId })
+                });
+
+                assert.strictEqual(loginResponse.responseText, userId);
+            });
+            assert(logs.filter(str => str.includes("the server responded with a status of 401")).length, 1);
+            assert(
+                logs.some(str =>
+                    str.includes(
+                        "Saving to cookies was not successful, this indicates a configuration error or the browser preventing us from writing the cookies (e.g.: incognito mode)."
+                    )
+                )
+            );
+
+            const cookies = await page.cookies();
+            assert.strictEqual(cookies.length, 0);
+        });
+
         it("test rid is there", async function () {
             await startST(3);
             await setup();

diff --git a/test/interception.testgen.js b/test/interception.testgen.js
@@ -4,6 +4,12 @@ module.exports.addGenericTestCases = function (getTestCases) {
             "fetch using " + tokenTransferMethod,
             tokenTransferMethod,
             (config, tokenTransferMethod) => {
+                if (config.disableCookies) {
+                    config.cookieHandler = () => ({
+                        setCookie: () => Promise.resolve(),
+                        getCookie: () => Promise.resolve("")
+                    });
+                }
                 let overrideFunctions = [];
                 if (config.override) {
                     for (const reqOverride of config.override) {
@@ -62,6 +68,12 @@ module.exports.addGenericTestCases = function (getTestCases) {
             "XHR using " + tokenTransferMethod,
             tokenTransferMethod,
             (config, tokenTransferMethod) => {
+                if (config.disableCookies) {
+                    config.cookieHandler = () => ({
+                        setCookie: () => Promise.resolve(),
+                        getCookie: () => Promise.resolve("")
+                    });
+                }
                 let overrideFunctions = [];
                 if (config.override) {
                     for (const reqOverride of config.override) {
@@ -149,6 +161,12 @@ module.exports.addGenericTestCases = function (getTestCases) {
             "axios with axios interceptor using " + tokenTransferMethod,
             tokenTransferMethod,
             (config, tokenTransferMethod) => {
+                if (config.disableCookies) {
+                    config.cookieHandler = () => ({
+                        setCookie: () => Promise.resolve(),
+                        getCookie: () => Promise.resolve("")
+                    });
+                }
                 let overrideFunctions = [];
                 if (config.override) {
                     for (const reqOverride of config.override) {
@@ -226,6 +244,12 @@ module.exports.addGenericTestCases = function (getTestCases) {
             "axios using " + tokenTransferMethod,
             tokenTransferMethod,
             (config, tokenTransferMethod) => {
+                if (config.disableCookies) {
+                    config.cookieHandler = () => ({
+                        setCookie: () => Promise.resolve(),
+                        getCookie: () => Promise.resolve("")
+                    });
+                }
                 let overrideFunctions = [];
                 if (config.override) {
                     for (const reqOverride of config.override) {
@@ -300,6 +324,13 @@ module.exports.addGenericTestCases = function (getTestCases) {
             async (config, tokenTransferMethod) => {
                 await loadAngular();
 
+                if (config.disableCookies) {
+                    config.cookieHandler = () => ({
+                        setCookie: () => Promise.resolve(),
+                        getCookie: () => Promise.resolve("")
+                    });
+                }
+
                 let overrideFunctions = [];
                 if (config.override) {
                     for (const reqOverride of config.override) {