Merge pull request #110 from supertokens/fix/emailverification_valida…

…tor_refetch_times fix: emailverification validator refetch times
supertokens · Apr 8, 2024 · 4212e08 · 4212e08
2 parents 18f0d15 + 29ae6c3
commit 4212e08
Show file tree

Hide file tree

Showing 19 changed files with 84 additions and 20 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]
 
+## [0.10.1] - 2024-04-08
+
+#### Fixes
+
+-   Reduced the number of unnecessary email verification checks by fixing the default values for `refetchTimeOnFalseInSeconds` and `maxAgeInSeconds`
+
 ## [0.10.0] - 2024-03-03
 
 ### Overview

diff --git a/bundle/emailpassword.js b/bundle/emailpassword.js
diff --git a/bundle/emailverification.js b/bundle/emailverification.js
diff --git a/bundle/multifactorauth.js b/bundle/multifactorauth.js
diff --git a/bundle/multitenancy.js b/bundle/multitenancy.js
diff --git a/bundle/passwordless.js b/bundle/passwordless.js
diff --git a/bundle/supertokens.js b/bundle/supertokens.js
diff --git a/bundle/thirdparty.js b/bundle/thirdparty.js
diff --git a/bundle/thirdpartyemailpassword.js b/bundle/thirdpartyemailpassword.js
diff --git a/bundle/thirdpartypasswordless.js b/bundle/thirdpartypasswordless.js
diff --git a/bundle/totp.js b/bundle/totp.js
diff --git a/lib/build/recipe/emailverification/emailVerificationClaim.js b/lib/build/recipe/emailverification/emailVerificationClaim.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/recipe/emailverification/emailVerificationClaim.ts b/lib/ts/recipe/emailverification/emailVerificationClaim.ts
@@ -29,8 +29,8 @@ export class EmailVerificationClaimClass extends BooleanClaim {
                 shouldRefresh: (payload, userContext) => {
                     const DateProvider = DateProviderReference.getReferenceOrThrow().dateProvider;
 
-                    maxAgeInSeconds = maxAgeInSeconds ?? getThresholdAwareDefaultValue(10);
-                    refetchTimeOnFalseInSeconds = refetchTimeOnFalseInSeconds ?? getThresholdAwareDefaultValue(300);
+                    maxAgeInSeconds = maxAgeInSeconds ?? getThresholdAwareDefaultValue(300);
+                    refetchTimeOnFalseInSeconds = refetchTimeOnFalseInSeconds ?? getThresholdAwareDefaultValue(10);
 
                     if (maxAgeInSeconds < DateProvider.getThresholdInSeconds()) {
                         throw new Error(

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 = "0.10.0";
+export const package_version = "0.10.1";
 
 export const supported_fdi = ["1.17", "1.18", "1.19"];
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "supertokens-web-js",
-    "version": "0.10.0",
+    "version": "0.10.1",
     "description": "SuperTokens SDK for vanilla JS for all recipes",
     "main": "./index.js",
     "scripts": {

diff --git a/test/unit/emailverificationclaim.test.js b/test/unit/emailverificationclaim.test.js
@@ -0,0 +1,58 @@
+/* Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved.
+ *
+ * This software is licensed under the Apache License, Version 2.0 (the
+ * "License") as published by the Apache Software Foundation.
+ *
+ * You may not use this file except in compliance with the License. You may
+ * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+import jsdom from "mocha-jsdom";
+import EmailVerification from "../../recipe/emailverification";
+import SuperTokens from "../../lib/build/supertokens";
+import assert from "assert";
+
+describe("EmailVerificationClaim test", function () {
+    jsdom({ url: "http://localhost.org" });
+
+    let storageLogs = [];
+
+    beforeEach(function () {
+        SuperTokens.reset();
+        storageLogs = [];
+    });
+
+    it("should require refresh less often for true values", async function () {
+        SuperTokens.init({
+            appInfo: {
+                appName: "SuperTokens",
+                apiDomain: "api.supertokens.io",
+            },
+            dateProvider: function () {
+                return {
+                    getThresholdInSeconds: function () {
+                        return 2;
+                    },
+                    now: function () {
+                        return Date.now();
+                    },
+                };
+            },
+            recipeList: [EmailVerification.init()],
+        });
+
+        const validator = EmailVerification.EmailVerificationClaim.validators.isVerified();
+        const shouldRefreshVerified = await validator.shouldRefresh({ "st-ev": { v: true, t: Date.now() - 15000 } });
+        const shouldRefreshUnverified = await validator.shouldRefresh({ "st-ev": { v: false, t: Date.now() - 15000 } });
+        const shouldRefreshUndefined = await validator.shouldRefresh({});
+
+        assert.strictEqual(shouldRefreshVerified, false);
+        assert.strictEqual(shouldRefreshUnverified, true);
+        assert.strictEqual(shouldRefreshUndefined, true);
+    });
+});