feat: replace psl deprecation warning by using tldts (#930)

* Replace psl with tldts to parse domain * Add test cases for getTopLevelDomainForSameSiteResolution function * Bump version and update changelog
supertokens · Sep 30, 2024 · dda41bc · dda41bc
1 parent e57cda4
commit dda41bc
Show file tree

Hide file tree

Showing 10 changed files with 90 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [20.1.3] - 2024-09-30
+
+-   Replaces `psl` with `tldts` to avoid `punycode` deprecation warning.
+
 ## [20.1.2] - 2024-09-14
 
 -   Fixes formFields to accept non string types as well.

diff --git a/examples/cloudflare-workers/with-email-password-hono-be-only/index.ts b/examples/cloudflare-workers/with-email-password-hono-be-only/index.ts
@@ -41,8 +41,8 @@ app.get("/sessioninfo", (c) => {
 
 app.get("/", (c) => {
     return c.json({
-        "message": "Hello from Supertokens"
-    })
-})
+        message: "Hello from Supertokens",
+    });
+});
 
 export default app;
diff --git a/lib/build/utils.js b/lib/build/utils.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/utils.ts b/lib/ts/utils.ts
@@ -1,4 +1,4 @@
-import * as psl from "psl";
+import { parse } from "tldts";
 
 import type { AppInfo, NormalisedAppinfo, HTTPMethod, JSONObject, UserContext } from "./types";
 import NormalisedURLDomain from "./normalisedURLDomain";
@@ -345,13 +345,13 @@ export function getTopLevelDomainForSameSiteResolution(url: string): string {
         return "localhost";
     }
 
-    let parsedURL = psl.parse(hostname) as psl.ParsedDomain;
-    if (parsedURL.domain === null) {
-        if (hostname.endsWith(".amazonaws.com") && parsedURL.tld === hostname) {
+    let parsedURL = parse(hostname);
+    if (!parsedURL.domain) {
+        if (hostname.endsWith(".amazonaws.com") && parsedURL.publicSuffix === hostname) {
             return hostname;
         }
         // support for .local domain
-        if (hostname.endsWith(".local") && parsedURL.tld === null) {
+        if (hostname.endsWith(".local") && !parsedURL.publicSuffix) {
             return hostname;
         }
         throw new Error("Please make sure that the apiDomain and websiteDomain have correct values");

diff --git a/lib/ts/version.ts b/lib/ts/version.ts
@@ -12,7 +12,7 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const version = "20.1.2";
+export const version = "20.1.3";
 
 export const cdiSupported = ["5.1"];
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "supertokens-node",
-    "version": "20.1.2",
+    "version": "20.1.3",
     "description": "NodeJS driver for SuperTokens core",
     "main": "index.js",
     "scripts": {
@@ -124,8 +124,8 @@
         "pako": "^2.1.0",
         "pkce-challenge": "^3.0.0",
         "process": "^0.11.10",
-        "psl": "1.8.0",
         "supertokens-js-override": "^0.0.4",
+        "tldts": "^6.1.48",
         "twilio": "^4.19.3"
     },
     "devDependencies": {

diff --git a/test/utils.test.js b/test/utils.test.js
@@ -1,5 +1,5 @@
 const assert = require("assert");
-const { getFromObjectCaseInsensitive } = require("../lib/build/utils");
+const { getFromObjectCaseInsensitive, getTopLevelDomainForSameSiteResolution } = require("../lib/build/utils");
 
 describe("SuperTokens utils test", () => {
     it("Test getFromObjectCaseInsensitive", () => {
@@ -18,3 +18,39 @@ describe("SuperTokens utils test", () => {
         assert.equal(getFromObjectCaseInsensitive("authoriZation", testObj), "test");
     });
 });
+
+describe("getTopLevelDomainForSameSiteResolution test", () => {
+    it('should return "localhost" for localhost URLs', () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("http://localhost:3000"), "localhost");
+        assert.equal(getTopLevelDomainForSameSiteResolution("https://localhost"), "localhost");
+    });
+
+    it('should return "localhost" for localhost.org URLs', () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("http://localhost.org"), "localhost");
+        assert.equal(getTopLevelDomainForSameSiteResolution("https://localhost.org/test-path"), "localhost");
+    });
+
+    it('should return "localhost" for IP addresses', () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("http://127.0.0.1"), "localhost");
+        assert.equal(getTopLevelDomainForSameSiteResolution("https://192.168.1.1"), "localhost");
+    });
+
+    it("should return the correct domain for normal URLs", () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("https://www.example.com"), "example.com");
+        assert.equal(getTopLevelDomainForSameSiteResolution("http://sub.domain.co.uk"), "domain.co.uk");
+    });
+
+    it("should handle .amazonaws.com domains correctly", () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("https://my-instance.amazonaws.com"), "amazonaws.com");
+    });
+
+    it("should handle .local domains correctly", () => {
+        assert.equal(getTopLevelDomainForSameSiteResolution("http://myserver.local"), "myserver.local");
+    });
+
+    it("should throw an error for invalid domains", () => {
+        assert.throws(() => {
+            getTopLevelDomainForSameSiteResolution("http://invalid..com");
+        }, Error);
+    });
+});