refactor: implement authentication flow using authHash in unlock hook and update PasskeyModal UI

Co-authored-by: me <ramvignesh-b@github.com>
Co-authored-by: ramvignesh-b <ramvignesh-b@github.com>
Reviewed-on: #1

.github/workflows/ci.yml

@@ -26,59 +26,6 @@ jobs:
           path: certs/
           retention-days: 1
 
-  backend:
-    name: Backend CI
-    runs-on: ubuntu-latest
-    needs: setup-environment
-    services:
-      test-db:
-        image: postgres:16-alpine
-        env:
-          POSTGRES_DB: piku_test
-          POSTGRES_USER: test
-          POSTGRES_PASSWORD: password123
-        ports:
-          - 5442:5432
-        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
-    defaults:
-      run:
-        working-directory: ./backend
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          enable-cache: true
-          cache-dependency-glob: "backend/uv.lock"
-
-      - name: Restore certificates
-        uses: christopherHX/gitea-download-artifact@v4
-        with:
-          name: ssl-certs
-          path: certs/
-
-      - name: Setup Environment
-        run: |
-          cp ../.env.example ../.env
-          uv sync
-          if [ "$GITEA_ACTIONS" = "true" ]; then
-            export DB_HOST="test-db"
-            export DB_PORT="5432"
-          else
-            export DB_HOST="127.0.0.1"
-            export DB_PORT="5442"
-          fi
-          export DB_PASSWORD='password123'
-          export DB_NAME="piku_test"
-          export DB_USER="test"
-
-      - name: Lint & Test
-        run: |
-
-
-          uv run ruff check
-          uv run python manage.py test
-
   frontend:
     name: Frontend CI
     runs-on: ubuntu-latest
@@ -110,6 +57,57 @@ jobs:
       - name: Unit Tests
         run: bun run test
 
+  backend:
+    name: Backend CI
+    runs-on: ubuntu-latest
+    needs: setup-environment
+    services:
+      db:
+        image: postgres:16-alpine
+        env:
+          POSTGRES_DB: piku__test
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: password123
+        ports:
+          - 5442:5432
+        options: --tmpfs /var/lib/postgresql/data --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    defaults:
+      run:
+        working-directory: ./backend
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "backend/uv.lock"
+
+      - name: Restore certificates
+        uses: christopherHX/gitea-download-artifact@v4
+        with:
+          name: ssl-certs
+          path: certs/
+
+      - name: Setup & Test
+        run: |
+          cp ../.env.example ../.env
+          uv sync
+
+          export DB_NAME="piku__test"
+          export DB_USER="test"
+          export DB_PASSWORD="password123"
+
+          if [ "$GITEA_ACTIONS" = "true" ]; then
+            export DB_HOST="db"
+            export DB_PORT="5432"
+          else
+            export DB_HOST="127.0.0.1"
+            export DB_PORT="5442"
+          fi
+
+          uv run ruff check
+          uv run python manage.py test
+
   e2e:
     name: E2E Tests
     runs-on: ubuntu-latest
@@ -135,7 +133,7 @@ jobs:
         # Disable cache when not using GitHub Actions because the runner spends ~3mins trying to upload the cache and failing
         # TODO: setup cache server in Gitea
         if: github.server_url == 'https://github.com'
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/ms-playwright
           key: ${{ runner.os }}-playwright-${{ hashFiles('frontend/bun.lock') }}

frontend/src/App.tsx

@@ -1,11 +1,5 @@
 import { lazy, Suspense, useEffect, useRef } from "react";
-import {
+import { BrowserRouter, Navigate, Route, Routes } from "react-router-dom";
-  BrowserRouter,
-  Navigate,
-  Route,
-  Routes,
-  ScrollRestoration,
-} from "react-router-dom";
 import { ProtectedRoute, PublicRoute } from "./components/RouteGuards";
 import SplashScreen from "./components/SplashScreen";
 import { ROUTES } from "./config/routes";

frontend/src/components/drawer/PasskeyModal.tsx

@@ -1,26 +1,26 @@
-import { LockKeyIcon } from "@phosphor-icons/react";
+import { HourglassSimpleMediumIcon } from "@phosphor-icons/react";
+import { useAuth } from "../../hooks/useAuth";
 import { Modal } from "../ui/Modal";
 
-interface PasskeyModalProps {
+export function PasskeyModal() {
-  onUnlock: (password: string) => Promise<void>;
+  const { unlock } = useAuth();
-}
 
-export function PasskeyModal({ onUnlock }: PasskeyModalProps) {
   return (
     <Modal isOpen={true}>
-      <LockKeyIcon
+      <HourglassSimpleMediumIcon
         size={48}
         className="text-primary mx-auto mb-8 animate-pulse"
+        weight="duotone"
       />
       <h3 className="font-bold text-lg font-display text-primary">
-        Authentication Required
+        You've been away a while.
       </h3>
       <p className="py-4 font-sans">
-        We need your passkey to open your letters
+        Your letters are still there. Just need the key once more.
       </p>
       <div className="divider w-1/2 mx-auto text-xs text-neutral-content/30 mt-0"></div>
       <p className="text-xs text-neutral-content/30 font-mono italic">
-        Your passkey is used to decrypt your data locally.
+        Nothing was lost.
       </p>
       <div className="modal-action items-center gap-4">
         <form
@@ -30,7 +30,7 @@ export function PasskeyModal({ onUnlock }: PasskeyModalProps) {
             const formData = new FormData(e.currentTarget);
             const password = formData.get("password") as string;
             if (!password) return;
-            await onUnlock(password);
+            await unlock(password);
           }}
         >
           <input

frontend/src/hooks/useAuth.test.ts

@@ -6,6 +6,7 @@ import { mockUser } from "../../test/fixtures/user.fixture";
 import { server } from "../../test/mocks/server";
 import { useAuthStore } from "../store/useAuthStore";
 import { useKeyStore } from "../store/useKeyStore";
+import { CryptoUtils } from "../utils/crypto";
 import {
   clearMasterKey,
   loadMasterKey,
@@ -14,6 +15,7 @@ import {
 import { useAuth } from "./useAuth";
 
 vi.mock("../utils/keystore");
+vi.mock("../utils/crypto");
 
 const VITE_API_URL = "http://piku-server";
 
@@ -30,6 +32,11 @@ beforeEach(() => {
     isInitializing: true,
   });
   useKeyStore.setState({ masterKey: null });
+
+  vi.mocked(CryptoUtils.deriveKeyBundle).mockResolvedValue({
+    masterKey: mockMasterKey,
+    authHash: "mock-hash",
+  });
 });
 
 describe("isAuthenticated", () => {
@@ -201,3 +208,68 @@ describe("initialize", () => {
     expect(useKeyStore.getState().masterKey).not.toBeNull();
   });
 });
+
+describe("unlock", () => {
+  beforeEach(() => {
+    useAuthStore.setState({
+      accessToken: "valid-token",
+      user: mockUser,
+      isInitializing: false,
+    });
+  });
+
+  it("should derive the master key from the user password, validate it via API, and persist it", async () => {
+    let loginCalled = false;
+    server.use(
+      http.post(`${VITE_API_URL}/api/auth/login/`, async () => {
+        loginCalled = true;
+        return HttpResponse.json({ access: "token", user: mockUser });
+      }),
+    );
+    const { result } = renderHook(() => useAuth());
+
+    await act(async () => {
+      await result.current.unlock("password");
+    });
+
+    expect(CryptoUtils.deriveKeyBundle).toHaveBeenCalledWith(
+      "password",
+      mockUser.email,
+    );
+    expect(loginCalled).toBe(true);
+    expect(saveMasterKey).toHaveBeenCalledWith(mockMasterKey);
+    expect(useKeyStore.getState().masterKey).toEqual(mockMasterKey);
+  });
+
+  it("should logout if user is not present", async () => {
+    useAuthStore.setState({ user: null });
+    const { result } = renderHook(() => useAuth());
+
+    await act(async () => {
+      await result.current.unlock("password");
+    });
+
+    expect(CryptoUtils.deriveKeyBundle).not.toHaveBeenCalled();
+    expect(saveMasterKey).not.toHaveBeenCalled();
+    expect(useAuthStore.getState().accessToken).toBeNull();
+    expect(clearMasterKey).toHaveBeenCalled();
+  });
+
+  it("should throw an error and not persist the key if validation fails", async () => {
+    server.use(
+      http.post(
+        `${VITE_API_URL}/api/auth/login/`,
+        () => new HttpResponse(null, { status: 400 }),
+      ),
+    );
+
+    const { result } = renderHook(() => useAuth());
+
+    await act(async () => {
+      await expect(result.current.unlock("wrong-password")).rejects.toThrow();
+    });
+
+    expect(saveMasterKey).not.toHaveBeenCalled();
+    expect(useKeyStore.getState().masterKey).toBeNull();
+  });
+});

frontend/src/hooks/useAuth.ts

@@ -57,7 +57,6 @@ export const useAuth = () => {
     }
 
     try {
-      // try session refresh
       const { data: refreshData } = await publicApi.post(endpoints.REFRESH);
       const { data: userData } = await api.get(endpoints.ME, {
         headers: { Authorization: `Bearer ${refreshData.access}` },
@@ -71,16 +70,24 @@ export const useAuth = () => {
   }, [setMasterKey]);
 
   const unlock = async (password: string) => {
-    if (!user) return;
+    if (!user) {
+      await logout();
+      return;
+    }
 
-    try {
+    const { masterKey, authHash } = await CryptoUtils.deriveKeyBundle(
-      const { masterKey } = await CryptoUtils.deriveKeyBundle(
       password,
       user.email,
     );
+
+    // Validate password by calling login endpoint
+    await api.post(endpoints.LOGIN, {
+      email: user.email,
+      password: authHash,
+    });
+
     await saveMasterKey(masterKey);
     setMasterKey(masterKey);
-    } catch {}
   };
 
   return {

frontend/src/pages/Drawer.test.tsx

@@ -75,7 +75,9 @@ describe("Drawer Page", () => {
             </MemoryRouter>,
         );
 
-    expect(screen.getByText(/Authentication Required/i)).toBeInTheDocument();
+        expect(
+            screen.getByText(/You've been away a while./i),
+        ).toBeInTheDocument();
         expect(screen.getByPlaceholderText(/password/i)).toBeInTheDocument();
     });
 });

frontend/src/pages/Drawer.tsx

@@ -15,7 +15,7 @@ import {
 } from "../utils/dateFormat.ts";
 
 export default function Drawer() {
-  const { user, logout, unlock } = useAuth();
+  const { user, logout } = useAuth();
 
   const [openSection, setOpenSection] = useState<string | null>(null);
   const navigate = useNavigate();
@@ -30,7 +30,7 @@ export default function Drawer() {
     <div className="min-h-screen w-full bg-base-100 text-base-content flex flex-col items-center py-12 px-5 pb-32 font-serif transition-colors">
       <div className="fixed inset-0 bg-vig pointer-events-none z-0" />
 
-      {isAuthRequired && <PasskeyModal onUnlock={unlock} />}
+      {isAuthRequired && <PasskeyModal />}
       <header className="text-center mb-12 z-10 animate-in fade-in slide-in-from-top-4 duration-500">
         <Logo />
         <div className="font-sans text-xs tracking-widester uppercase text-base-content/40 mt-2">

frontend/src/pages/Home.tsx

@@ -1,9 +1,9 @@
 import { InfoIcon } from "@phosphor-icons/react";
+import { ReactLenis } from "lenis/react";
 import {
   motion,
   useMotionValueEvent,
   useScroll,
-  useSpring,
   useTransform,
 } from "motion/react";
 import { useRef, useState } from "react";
@@ -16,14 +16,9 @@ import { formatDate } from "../utils/dateFormat.ts";
 
 export default function Home() {
   const sectionContainer1 = useRef<HTMLDivElement>(null);
-  const { scrollYProgress: section1ScrollProgress } = useScroll({
+  const { scrollYProgress } = useScroll({
     target: sectionContainer1,
   });
-  const smoothProgress1 = useSpring(section1ScrollProgress, {
-    stiffness: 100,
-    damping: 30,
-    restDelta: 0.001,
-  });
   const [isEnvelopeFlipped, setIsEnvelopeFlipped] = useState(true);
   const [flapOpen, setFlapOpen] = useState(false);
   const [recipient, setRecipient] = useState("someone dear");
@@ -31,7 +26,7 @@ export default function Home() {
 
   const navigate = useNavigate();
 
-  useMotionValueEvent(section1ScrollProgress, "change", (latestScrollValue) => {
+  useMotionValueEvent(scrollYProgress, "change", (latestScrollValue) => {
     if (latestScrollValue > 0.54) {
       setFlapOpen(false);
     } else {
@@ -55,6 +50,7 @@ export default function Home() {
   });
 
   return (
+    <ReactLenis root options={{ lerp: 0.1, duration: 1.5, smoothWheel: true }}>
       <section
         ref={sectionContainer1}
         className="relative w-full h-[850vh] bg-base-100 font-serif"
@@ -64,8 +60,8 @@ export default function Home() {
           <motion.div
             className="absolute flex flex-col items-center justify-center pointer-events-none"
             style={{
-            opacity: useTransform(smoothProgress1, [0, 0.12, 1], [1, 0, 0]),
+              opacity: useTransform(scrollYProgress, [0, 0.12, 1], [1, 0, 0]),
-            scale: useTransform(smoothProgress1, [0, 0.12], [1, 10]),
+              scale: useTransform(scrollYProgress, [0, 0.12], [1, 10]),
             }}
           >
             <h1 className="text-neutral-content/40 text-4xl md:text-6xl text-center px-6">
@@ -79,9 +75,9 @@ export default function Home() {
           <motion.div
             className="absolute text-center"
             style={{
-            opacity: useTransform(smoothProgress1, [0, 0.15, 0.2], [0, 1, 0]),
+              opacity: useTransform(scrollYProgress, [0, 0.15, 0.2], [0, 1, 0]),
-            y: useTransform(smoothProgress1, [0, 0.15, 0.2], [40, 0, -40]),
+              y: useTransform(scrollYProgress, [0, 0.15, 0.2], [40, 0, -40]),
-            scale: useTransform(smoothProgress1, [0, 0.15, 0.2], [0.8, 1, 3]),
+              scale: useTransform(scrollYProgress, [0, 0.15, 0.2], [0.8, 1, 3]),
             }}
           >
             <div className="mt-6 text-4xl md:text-6xl text-base-content/60 italic">
@@ -93,11 +89,11 @@ export default function Home() {
             className="absolute text-center px-6"
             style={{
               opacity: useTransform(
-              smoothProgress1,
+                scrollYProgress,
                 [0.18, 0.25, 0.3],
                 [0, 1, 0],
               ),
-            y: useTransform(smoothProgress1, [0.18, 0.25, 0.3], [20, 0, -20]),
+              y: useTransform(scrollYProgress, [0.18, 0.25, 0.3], [20, 0, -20]),
             }}
             transition={{ delay: 4 }}
           >
@@ -106,12 +102,12 @@ export default function Home() {
               className="mt-6 text-4xl md:text-6xl text-base-content/60 "
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.22, 0.25, 0.35, 0.4],
                   [0, 1, 1, 0],
                 ),
                 y: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.25, 0.3, 0.35, 0.4],
                   [20, 0, 0, -20],
                 ),
@@ -137,12 +133,12 @@ export default function Home() {
             <motion.h2
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.3, 0.35, 0.4, 0.45],
                   [0, 1, 1, 0],
                 ),
                 y: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.3, 0.35, 0.4, 0.45],
                   [40, 0, 0, -40],
                 ),
@@ -159,12 +155,12 @@ export default function Home() {
             <motion.h2
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.45, 0.5, 0.55, 0.6],
                   [0, 1, 1, 0],
                 ),
                 y: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.45, 0.5, 0.55, 0.6],
                   [40, 0, 0, -40],
                 ),
@@ -185,12 +181,12 @@ export default function Home() {
             <motion.h2
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.6, 0.63, 0.72, 0.75],
                   [0, 1, 1, 0],
                 ),
                 y: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.6, 0.63, 0.72, 0.75],
                   [40, 0, 0, -40],
                 ),
@@ -202,7 +198,7 @@ export default function Home() {
                 className="font-display text-accent"
                 style={{
                   color: useTransform(
-                  smoothProgress1,
+                    scrollYProgress,
                     [0.67, 1],
                     ["var(--color-accent)", "var(--color-neutral)"],
                   ),
@@ -212,14 +208,14 @@ export default function Home() {
               </motion.span>
               <motion.span
                 style={{
-                opacity: useTransform(smoothProgress1, [0.66, 0.7], [0, 1]),
+                  opacity: useTransform(scrollYProgress, [0.66, 0.7], [0, 1]),
                 }}
               >
                 <motion.span
                   className="font-display text-accent"
                   style={{
                     color: useTransform(
-                    smoothProgress1,
+                      scrollYProgress,
                       [0.67, 1],
                       ["var(--color-accent)", "var(--color-neutral)"],
                     ),
@@ -238,20 +234,20 @@ export default function Home() {
             <motion.h2
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.75, 0.8, 0.85, 0.9],
                   [0, 1, 1, 0],
                 ),
                 y: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.75, 0.8, 0.85, 0.9],
                   [40, 0, 0, -40],
                 ),
               }}
               className="absolute text-4xl md:text-6xl text-center px-10 leading-tight"
             >
-            and even <span className="font-display text-error">burn it</span> to
+              and even <span className="font-display text-error">burn it</span>{" "}
-            release the burden.
+              to release the burden.
             </motion.h2>
             {/*  Outro  */}
             <motion.h2
@@ -259,8 +255,8 @@ export default function Home() {
                 "italic absolute text-4xl md:text-6xl text-center px-10 leading-tight"
               }
               style={{
-              opacity: useTransform(smoothProgress1, [0.9, 1], [0, 1]),
+                opacity: useTransform(scrollYProgress, [0.9, 1], [0, 1]),
-              y: useTransform(smoothProgress1, [0.9, 1], [80, 0]),
+                y: useTransform(scrollYProgress, [0.9, 1], [80, 0]),
               }}
             >
               You've been carrying it long enough.
@@ -271,10 +267,10 @@ export default function Home() {
                 "z-100 absolute -bottom-12 md:bottom-0 font-display flex flex-wrap md:flex-nowrap gap-4 md:gap-12 justify-center"
               }
               style={{
-              opacity: useTransform(smoothProgress1, [0.98, 1], [0, 1]),
+                opacity: useTransform(scrollYProgress, [0.98, 1], [0, 1]),
-              y: useTransform(smoothProgress1, [0.98, 1], [80, 0]),
+                y: useTransform(scrollYProgress, [0.98, 1], [80, 0]),
                 display: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.96, 1],
                   ["none", "flex"],
                 ),
@@ -307,13 +303,17 @@ export default function Home() {
               className={"z-21 absolute"}
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.3, 0.4, 0.5, 0.52],
                   [0, 1, 0.1, 0],
                 ),
-              y: useTransform(smoothProgress1, [0.3, 0.45, 0.5], [300, 0, 200]),
+                y: useTransform(
+                  scrollYProgress,
+                  [0.3, 0.45, 0.5],
+                  [300, 0, 200],
+                ),
                 scale: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.3, 0.4, 0.5],
                   [1, 1, 0.6],
                 ),
@@ -331,11 +331,11 @@ export default function Home() {
               className="absolute scale-50 md:scale-80 z-10"
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.4, 0.45, 0.5, 0.7, 0.9, 1],
                   [0, 0.6, 1, 1, 0.3, 0],
                 ),
-              y: useTransform(smoothProgress1, [0.45, 0.5, 1], [600, 200, 0]),
+                y: useTransform(scrollYProgress, [0.45, 0.5, 1], [600, 200, 0]),
               }}
             >
               <EnvelopeReveal
@@ -353,11 +353,11 @@ export default function Home() {
               className="fixed bottom-0 z-10 font-sans -mb-6 scale-85 md:scale-100 md:mb-0"
               style={{
                 opacity: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.98, 0.995, 1],
                   [0, 0.5, 1],
                 ),
-              y: useTransform(smoothProgress1, [0.98, 1], [50, -10]),
+                y: useTransform(scrollYProgress, [0.98, 1], [50, -10]),
               }}
             >
               <Saajan
@@ -375,7 +375,7 @@ export default function Home() {
               }}
               style={{
                 backgroundColor: useTransform(
-                smoothProgress1,
+                  scrollYProgress,
                   [0.45, 0.5, 0.7, 0.75, 1],
                   [
                     "var(--color-primary)",
@@ -385,12 +385,13 @@ export default function Home() {
                     "var(--color-error)",
                   ],
                 ),
-              scale: useTransform(smoothProgress1, [0, 1], [0.6, 2.5]),
+                scale: useTransform(scrollYProgress, [0, 1], [0.6, 2.5]),
               }}
             />
             <div className="absolute border border-primary/5 w-64 h-64 rounded-full backdrop-blur-[1px]" />
           </div>
         </div>
       </section>
+    </ReactLenis>
   );
 }

scripts/run-e2e.sh

@@ -56,8 +56,7 @@ done
 
 export PIKU_ENV_FILE="$ENV_FILE"
 
-# NOTE: When running in Gitea Actions (within container), 127.0.0.1 is the actions instance.
+# NOTE: When running in Gitea Actions (within container), We must ponint DB and mail to the internal docker host instead.
-# We must route DB and mail traffic to the docker host instead.
 if [ "$GITEA_ACTIONS" = "true" ]; then
     sudo apt-get update && sudo apt-get install -y iproute2
     # Sample: "default via <internal docker host IP> dev <network interface> proto dhcp src <IP> metric 100"