Merge branch 'master' of https://github.com/LuckySilver0021/caches-user-data

Author: LuckySilver0021

.github/pull_request_template.md

@@ -4,8 +4,6 @@
 
 ### Checks
 
-- [ ] Adding/modifying Typescript code?
-  - [ ] I have used `qs`, `qsa` or `qsr` instead of JQuery selectors.
 - [ ] Adding quotes?
   - [ ] Make sure to include translations for the quotes in the description (or another comment) so we can verify their content.
 - [ ] Adding a language?

backend/__tests__/__integration__/dal/user.spec.ts

@@ -1,12 +1,12 @@
-import { describe, it, expect, vi } from "vitest";
+import { describe, expect, it, vi } from "vitest";
 
+import { CustomThemeColors } from "@monkeytype/schemas/configs";
+import { PersonalBest, PersonalBests } from "@monkeytype/schemas/shared";
+import { MonkeyMail, ResultFilters } from "@monkeytype/schemas/users";
+import { ObjectId } from "mongodb";
 import * as UserDAL from "../../../src/dal/user";
-import * as UserTestData from "../../__testData__/users";
 import { createConnection as createFriend } from "../../__testData__/connections";
-import { ObjectId } from "mongodb";
-import { MonkeyMail, ResultFilters } from "@monkeytype/schemas/users";
-import { PersonalBest, PersonalBests } from "@monkeytype/schemas/shared";
-import { CustomThemeColors } from "@monkeytype/schemas/configs";
+import * as UserTestData from "../../__testData__/users";
 
 const mockPersonalBest: PersonalBest = {
   acc: 1,
@@ -1122,6 +1122,55 @@ describe("UserDal", () => {
       expect(year2024[93]).toEqual(2);
     });
   });
+
+  describe("getUser", () => {
+    it("should get with missing personalBests", async () => {
+      //GIVEN
+      let user = await UserTestData.createUser({ personalBests: undefined });
+
+      //WHEN
+      const read = await UserDAL.getUser(user.uid, "read");
+
+      expect(read.personalBests).toEqual({
+        custom: {},
+        quote: {},
+        time: {},
+        words: {},
+        zen: {},
+      });
+    });
+  });
+
+  describe("getUserByName", () => {
+    it("should get with missing personalBests", async () => {
+      //GIVEN
+      let user = await UserTestData.createUser({ personalBests: undefined });
+
+      //WHEN
+      const read = await UserDAL.getUserByName(user.name, "read");
+
+      expect(read.personalBests).toEqual({
+        custom: {},
+        quote: {},
+        time: {},
+        words: {},
+        zen: {},
+      });
+    });
+  });
+
+  describe("getPersonalBests", () => {
+    it("should get with missing personalBests", async () => {
+      //GIVEN
+      let user = await UserTestData.createUser({ personalBests: undefined });
+
+      //WHEN
+      const read = await UserDAL.getPersonalBests(user.uid, "time", "15");
+
+      expect(read).toBeUndefined();
+    });
+  });
+
   describe("getPartialUser", () => {
     it("should throw for unknown user", async () => {
       await expect(async () =>
@@ -1156,6 +1205,24 @@ describe("UserDal", () => {
         },
       });
     });
+    it("should get with missing personalBests", async () => {
+      //GIVEN
+      let user = await UserTestData.createUser({ personalBests: undefined });
+
+      //WHEN
+      const read = await UserDAL.getPartialUser(user.uid, "read", [
+        "uid",
+        "personalBests",
+      ]);
+
+      expect(read.personalBests).toEqual({
+        custom: {},
+        quote: {},
+        time: {},
+        words: {},
+        zen: {},
+      });
+    });
   });
   describe("updateEmail", () => {
     it("throws for nonexisting user", async () => {

backend/src/api/controllers/user.ts

@@ -4,6 +4,7 @@ import MonkeyError, {
   isFirebaseError,
 } from "../../utils/error";
 import { MonkeyResponse } from "../../utils/monkey-response";
+import { getCached, setCached, invalidateUserCache } from "../../utils/cache";
 import * as DiscordUtils from "../../utils/discord";
 import {
   buildAgentLog,
@@ -914,6 +915,10 @@ export async function getProfile(
 ): Promise<GetProfileResponse> {
   const { uidOrName } = req.params;
 
+  const cacheKey = `user:profile:${uidOrName}`;
+  const cached = await getCached<GetProfileResponse>(cacheKey);
+  if (cached !== null) return cached;
+
   const user = req.query.isUid
     ? await UserDAL.getUser(uidOrName, "get user profile")
     : await UserDAL.getUserByName(uidOrName, "get user profile");
@@ -987,7 +992,11 @@ export async function getProfile(
   };
 
   if (banned) {
-    return new MonkeyResponse("Profile retrived: banned user", baseProfile);
+    await setCached(
+      cacheKey,
+      new MonkeyResponse("Profile retrieved: banned user", baseProfile),
+    );
+    return new MonkeyResponse("Profile retrieved: banned user", baseProfile);
   }
 
   const allTimeLbs = await getAllTimeLbs(user.uid);
@@ -1005,6 +1014,10 @@ export async function getProfile(
   } else {
     delete profileData.testActivity;
   }
+  await setCached(
+    cacheKey,
+    new MonkeyResponse("Profile retrieved", profileData),
+  );
   return new MonkeyResponse("Profile retrieved", profileData);
 }
 
@@ -1050,6 +1063,7 @@ export async function updateProfile(
   };
 
   await UserDAL.updateProfile(uid, profileDetailsUpdates, user.inventory);
+  await invalidateUserCache(uid);
 
   return new MonkeyResponse("Profile updated", profileDetailsUpdates);
 }

backend/src/dal/user.ts

@@ -27,7 +27,12 @@ import {
   CountByYearAndDay,
   Friend,
 } from "@monkeytype/schemas/users";
-import { Mode, Mode2, PersonalBest } from "@monkeytype/schemas/shared";
+import {
+  Mode,
+  Mode2,
+  PersonalBest,
+  PersonalBests,
+} from "@monkeytype/schemas/shared";
 import { addImportantLog } from "./logs";
 import { Result as ResultType } from "@monkeytype/schemas/results";
 import { Configuration } from "@monkeytype/schemas/configuration";
@@ -246,7 +251,7 @@ export async function updateEmail(
 export async function getUser(uid: string, stack: string): Promise<DBUser> {
   const user = await getUsersCollection().findOne({ uid });
   if (!user) throw new MonkeyError(404, "User not found", stack);
-  return user;
+  return migrateUser(user);
 }
 
 /**
@@ -263,10 +268,16 @@ export async function getPartialUser<K extends keyof DBUser>(
   fields: K[],
 ): Promise<Pick<DBUser, K>> {
   const projection = new Map(fields.map((it) => [it, 1]));
-  const results = await getUsersCollection().findOne({ uid }, { projection });
-  if (results === null) throw new MonkeyError(404, "User not found", stack);
+  const partialUser = await getUsersCollection().findOne(
+    { uid },
+    { projection },
+  );
+  if (partialUser === null) throw new MonkeyError(404, "User not found", stack);
 
-  return results;
+  if (fields.includes("personalBests" as K)) {
+    return migrateUser(partialUser);
+  }
+  return partialUser;
 }
 
 export async function findByName(name: string): Promise<DBUser | undefined> {
@@ -294,7 +305,7 @@ export async function getUserByName(
 ): Promise<DBUser> {
   const user = await findByName(name);
   if (!user) throw new MonkeyError(404, "User not found", stack);
-  return user;
+  return migrateUser(user);
 }
 
 export async function isDiscordIdAvailable(
@@ -1359,3 +1370,15 @@ export async function getFriends(uid: string): Promise<DBFriend[]> {
     ],
   );
 }
+
+function migrateUser<T extends { personalBests: PersonalBests }>(user: T): T {
+  user.personalBests ??= {
+    time: {},
+    words: {},
+    quote: {},
+    zen: {},
+    custom: {},
+  };
+
+  return user;
+}

backend/src/utils/cache.ts

@@ -0,0 +1,42 @@
+import { getConnection } from "../init/redis";
+
+const CACHE_PREFIX = "cache:";
+const TTL = 300; // == 5 minutes
+
+export async function getCached<T>(key: string): Promise<T | null> {
+  const redis = getConnection();
+  if (!redis) return null;
+
+  try {
+    const data = await redis.get(`${CACHE_PREFIX}${key}`);
+    if (data === null || data === undefined || data === "") return null;
+    return JSON.parse(data) as T;
+  } catch {
+    return null;
+  }
+}
+
+export async function setCached<T>(key: string, data: T): Promise<void> {
+  const redis = getConnection();
+  if (!redis) return;
+
+  try {
+    await redis.setex(`${CACHE_PREFIX}${key}`, TTL, JSON.stringify(data));
+  } catch (err) {
+    console.error("Cache set failed:", err);
+  }
+}
+
+export async function invalidateUserCache(userId: string): Promise<void> {
+  const redis = getConnection();
+  if (!redis) return;
+
+  try {
+    const keys = await redis.keys(`${CACHE_PREFIX}user:profile:${userId}*`);
+    if (keys.length > 0) {
+      await redis.del(keys);
+    }
+  } catch (err) {
+    console.error("Cache invalidation failed:", err);
+  }
+}

docs/CONTRIBUTING_ADVANCED.md

@@ -150,8 +150,6 @@ If you are on a UNIX system and you get a spawn error, run npm with `sudo`.
 
 Code formatting is enforced by [Prettier](https://prettier.io/docs/en/install.html), which automatically runs every time you make a commit.
 
-We are currently in the process of converting from JQuery to vanilla JS. When submitting new code, please use the `qs`, `qsa` and `qsr` helper functions. These return a class with a lot of JQuery-like methods. You can read how they work and import them from `frontend/src/ts/utils/dom.ts`.
-
 For guidelines on commit messages, adding themes, languages, or quotes, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md). Following these guidelines will increase the chances of getting your change accepted.
 
 ## Questions

frontend/__tests__/__harness__/setup-jquery.ts

@@ -13,14 +13,11 @@ describe("LayoutEmulator", () => {
       updateAltGrState(event);
     });
 
-    const createEvent = (
-      code: string,
-      type: string,
-    ): JQuery.KeyboardEventBase =>
+    const createEvent = (code: string, type: string): KeyboardEvent =>
       ({
         code,
         type,
-      }) as JQuery.KeyboardEventBase;
+      }) as KeyboardEvent;
 
     it("should set isAltGrPressed to true on AltRight keydown", () => {
       const event = createEvent("AltRight", "keydown");

frontend/__tests__/test/layout-emulator.spec.ts

@@ -26,7 +26,6 @@ describe("dom", () => {
           handler({
             target: e.target,
             childTarget: e.childTarget,
-            //@ts-expect-error will be added later, check TODO on the ChildEvent
             currentTarget: e.currentTarget,
           }),
         );
@@ -130,10 +129,6 @@ describe("dom", () => {
         await userEvent.click(clickTarget);
 
         //THEN
-
-        //This is the same behavior as jQuery `.on` with selector.
-        //The handler will be called two times,
-        //It does NOT call on the <section> or the parent element itself
         expect(handler).toHaveBeenCalledTimes(2);
 
         //First call is for childTarget inner2 (grand child of parent)