Merge pull request #1711 from TriliumNext/test_add-login-route-tests

test(routes/login): add initial tests via supertest

Author: eliandoran

integration-tests/db/config.ini

@@ -27,3 +27,8 @@ keyPath=
 # once set, expressjs will use the X-Forwarded-For header set by the rev. proxy to determinate the real IPs of clients.
 # expressjs shortcuts are supported: loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
 trustedReverseProxy=false
+
+[Session]
+# Default value is 1814400 Seconds, which is 21 Days.
+# For integration test we set the value to just 86400 seconds, which is 1 Day
+cookieMaxAge=86400

src/routes/login.spec.ts

@@ -0,0 +1,93 @@
+import { beforeAll, describe, expect, it } from "vitest";
+import supertest from "supertest";
+import { initializeTranslations } from "../services/i18n.js";
+import type { Application, Request, Response, NextFunction } from "express";
+import dayjs from "dayjs";
+
+let app: Application;
+
+describe("Login Route test", () => {
+
+    beforeAll(async () => {
+        initializeTranslations();
+        app = (await import("../app.js")).default;
+    });
+
+    it("should return the login page, when using a GET request", async () => {
+
+        // RegExp for login page specific string in HTML: e.g. "assets/v0.92.7/app/login.css"
+        const loginCssRegexp = /assets\/v[0-9.a-z]+\/app\/login\.css/;
+
+        const res = await supertest(app)
+            .get("/login")
+            .expect(200)
+
+
+        expect(loginCssRegexp.test(res.text)).toBe(true);
+
+    });
+
+    it("returns a 401 status, when login fails with wrong password", async () => {
+
+        await supertest(app)
+            .post("/login")
+            .send({ password: "fakePassword" })
+            .expect(401)
+
+    });
+
+
+    it("sets correct Expires, when 'Remember Me' is ticked", async () => {
+
+        // TriliumNextTODO: make setting cookieMaxAge via env variable work
+        // => process.env.TRILIUM_SESSION_COOKIEMAXAGE
+        // the custom cookieMaxAge is currently hardocded in the test data dir's config.ini
+
+        const CUSTOM_MAX_AGE_SECONDS = 86400;
+        const expectedExpiresDate = dayjs().utc().add(CUSTOM_MAX_AGE_SECONDS, "seconds").toDate().toUTCString();
+
+        const res = await supertest(app)
+            .post("/login")
+            .send({ password: "demo1234", rememberMe: 1 })
+            .expect(302)
+
+        const setCookieHeader = res.headers["set-cookie"][0];
+
+        // match for e.g. "Expires=Wed, 07 May 2025 07:02:59 GMT;"
+        const expiresCookieRegExp = /Expires=(?<date>[\w\s,:]+)/;
+        const expiresCookieMatch = setCookieHeader.match(expiresCookieRegExp);
+        const actualExpiresDate = new Date(expiresCookieMatch?.groups?.date || "").toUTCString()
+
+        expect(actualExpiresDate).to.not.eql("Invalid Date");
+
+        // ignore the seconds in the comparison, just to avoid flakiness in tests, 
+        // if for some reason execution is slow between calculation of expected and actual
+        expect(actualExpiresDate.slice(0,23)).toBe(expectedExpiresDate.slice(0,23))
+
+    }, 10_000);
+    // use 10 sec (10_000 ms) timeout for now, instead of default 5 sec to work around
+    // failing CI, because for some reason it currently takes approx. 6 secs to run
+    // TODO: actually identify what is causing this and fix the flakiness
+
+
+    it("does not set Expires, when 'Remember Me' is not ticked", async () => {
+
+        const res = await supertest(app)
+            .post("/login")
+            .send({ password: "demo1234" })
+            .expect(302)
+
+        const setCookieHeader = res.headers["set-cookie"][0];
+
+        // match for e.g. "Expires=Wed, 07 May 2025 07:02:59 GMT;"
+        const expiresCookieRegExp = /Expires=(?<date>[\w\s,:]+)/;
+        const expiresCookieMatch = setCookieHeader.match(expiresCookieRegExp);
+        expect(expiresCookieMatch).toBeNull();
+
+    }, 10_000);
+    // use 10 sec (10_000 ms) timeout for now, instead of default 5 sec to work around
+    // failing CI, because for some reason it currently takes approx. 6 secs to run
+    // TODO: actually identify what is causing this and fix the flakiness
+
+
+});