impr: optimize database access for UserDal (@fehmer)

backend/__tests__/api/controllers/user.spec.ts

@@ -195,7 +195,7 @@ describe("user controller test", () => {
     });
   });
   describe("getTestActivity", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
     afterAll(() => {
       getUserMock.mockReset();
     });
@@ -303,7 +303,7 @@ describe("user controller test", () => {
   });
 
   describe("toggle ban", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
     const setBannedMock = vi.spyOn(UserDal, "setBanned");
     const georgeUserBannedMock = vi.spyOn(GeorgeQueue, "userBanned");
     const isAdminMock = vi.spyOn(AdminUuids, "isAdmin");
@@ -340,7 +340,10 @@ describe("user controller test", () => {
         .expect(200);
 
       //THEN
-      expect(getUserMock).toHaveBeenLastCalledWith(uid, "toggle ban");
+      expect(getUserMock).toHaveBeenLastCalledWith(uid, "toggle ban", [
+        "banned",
+        "discordId",
+      ]);
       expect(setBannedMock).toHaveBeenCalledWith(uid, true);
       expect(georgeUserBannedMock).toHaveBeenCalledWith("discordId", true);
     });
@@ -392,7 +395,10 @@ describe("user controller test", () => {
         .expect(200);
 
       //THEN
-      expect(getUserMock).toHaveBeenLastCalledWith(uid, "toggle ban");
+      expect(getUserMock).toHaveBeenLastCalledWith(uid, "toggle ban", [
+        "banned",
+        "discordId",
+      ]);
       expect(setBannedMock).toHaveBeenCalledWith(uid, false);
       expect(georgeUserBannedMock).toHaveBeenCalledWith("discordId", false);
     });
@@ -425,7 +431,7 @@ describe("user controller test", () => {
   });
 
   describe("delete user", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
     const deleteUserMock = vi.spyOn(UserDal, "deleteUser");
     const firebaseDeleteUserMock = vi.spyOn(AuthUtils, "deleteUser");
     const deleteAllApeKeysMock = vi.spyOn(ApeKeys, "deleteAllApeKeys");
@@ -537,7 +543,7 @@ describe("user controller test", () => {
     });
   });
   describe("link discord", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
     const isDiscordIdAvailableMock = vi.spyOn(UserDal, "isDiscordIdAvailable");
     const isStateValidForUserMock = vi.spyOn(
       DiscordUtils,
@@ -601,7 +607,7 @@ describe("user controller test", () => {
     });
   });
   describe("getCurrentTestActivity", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
 
     afterEach(() => {
       getUserMock.mockReset();
@@ -635,7 +641,7 @@ describe("user controller test", () => {
     });
   });
   describe("getStreak", () => {
-    const getUserMock = vi.spyOn(UserDal, "getUser");
+    const getUserMock = vi.spyOn(UserDal, "getPartialUser");
 
     afterEach(() => {
       getUserMock.mockReset();

backend/__tests__/dal/user.spec.ts

@@ -849,4 +849,46 @@ describe("UserDal", () => {
       expect(year2024[93]).toEqual(2);
     });
   });
+  describe("getPartialUser", () => {
+    it("should throw for unknown user", async () => {
+      expect(async () =>
+        UserDAL.getPartialUser("1234", "stack", [])
+      ).rejects.toThrowError("User not found\nStack: stack");
+    });
+
+    it("should get streak", async () => {
+      //GIVEN
+      let user = await UserTestData.createUser({
+        streak: {
+          hourOffset: 1,
+          length: 5,
+          lastResultTimestamp: 4711,
+          maxLength: 23,
+        },
+      });
+
+      //WHEN
+      const partial = await UserDAL.getPartialUser(user.uid, "streak", [
+        "streak",
+      ]);
+
+      //THEN
+      expect(partial).toStrictEqual({
+        _id: user._id,
+        streak: {
+          hourOffset: 1,
+          length: 5,
+          lastResultTimestamp: 4711,
+          maxLength: 23,
+        },
+      });
+    });
+  });
+  describe("updateEmail", () => {
+    it("throws for nonexisting user", async () => {
+      expect(async () =>
+        UserDAL.updateEmail(123, "test@example.com")
+      ).rejects.toThrowError("User not found\nStack: update email");
+    });
+  });
 });

backend/src/api/controllers/quote.ts

@@ -1,6 +1,6 @@
 import _ from "lodash";
 import { v4 as uuidv4 } from "uuid";
-import { getUser, updateQuoteRatings } from "../../dal/user";
+import { getPartialUser, updateQuoteRatings } from "../../dal/user";
 import * as ReportDAL from "../../dal/report";
 import * as NewQuotesDAL from "../../dal/new-quotes";
 import * as QuoteRatingsDAL from "../../dal/quote-ratings";
@@ -21,7 +21,7 @@ export async function getQuotes(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
   const quoteMod: boolean | undefined | string = (
-    await getUser(uid, "get quotes")
+    await getPartialUser(uid, "get quotes", ["quoteMod"])
   ).quoteMod;
   let quoteModString: string;
   if (quoteMod === true) {
@@ -63,7 +63,7 @@ export async function approveQuote(
   const { uid } = req.ctx.decodedToken;
   const { quoteId, editText, editSource } = req.body;
 
-  const { name } = await getUser(uid, "approve quote");
+  const { name } = await getPartialUser(uid, "approve quote", ["name"]);
 
   if (!name) {
     throw new MonkeyError(500, "Missing name field");
@@ -103,7 +103,7 @@ export async function submitRating(
   const { uid } = req.ctx.decodedToken;
   const { quoteId, rating, language } = req.body;
 
-  const user = await getUser(uid, "submit rating");
+  const user = await getPartialUser(uid, "submit rating", ["quoteRatings"]);
 
   const normalizedQuoteId = parseInt(quoteId as string, 10);
   const normalizedRating = Math.round(parseInt(rating as string, 10));

backend/src/api/controllers/result.ts

@@ -157,7 +157,7 @@ export async function updateTags(
     result.numbers = false;
   }
 
-  const user = await UserDAL.getUser(uid, "update tags");
+  const user = await UserDAL.getPartialUser(uid, "update tags", ["tags"]);
   const tagPbs = await UserDAL.checkIfTagPb(uid, user, result);
   return new MonkeyResponse("Result tags updated", {
     tagPbs,

backend/src/api/controllers/user.ts

@@ -91,7 +91,11 @@ export async function sendVerificationEmail(
     throw new MonkeyError(400, "Email already verified");
   }
 
-  const userInfo = await UserDAL.getUser(uid, "request verification email");
+  const userInfo = await UserDAL.getPartialUser(
+    uid,
+    "request verification email",
+    ["uid", "name", "email"]
+  );
 
   if (userInfo.email !== email) {
     throw new MonkeyError(
@@ -150,9 +154,10 @@ export async function sendForgotPasswordEmail(
 
   try {
     const uid = (await FirebaseAdmin().auth().getUserByEmail(email)).uid;
-    const userInfo = await UserDAL.getUser(
+    const userInfo = await UserDAL.getPartialUser(
       uid,
-      "request forgot password email"
+      "request forgot password email",
+      ["name"]
     );
 
     const link = await FirebaseAdmin()
@@ -179,7 +184,12 @@ export async function deleteUser(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  const userInfo = await UserDAL.getUser(uid, "delete user");
+  const userInfo = await UserDAL.getPartialUser(uid, "delete user", [
+    "banned",
+    "name",
+    "email",
+    "discordId",
+  ]);
 
   if (userInfo.banned === true) {
     await BlocklistDal.add(userInfo);
@@ -215,7 +225,12 @@ export async function resetUser(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  const userInfo = await UserDAL.getUser(uid, "reset user");
+  const userInfo = await UserDAL.getPartialUser(uid, "reset user", [
+    "banned",
+    "discordId",
+    "email",
+    "name",
+  ]);
   if (userInfo.banned) {
     throw new MonkeyError(403, "Banned users cannot reset their account");
   }
@@ -247,7 +262,12 @@ export async function updateName(
   const { uid } = req.ctx.decodedToken;
   const { name } = req.body;
 
-  const user = await UserDAL.getUser(uid, "update name");
+  const user = await UserDAL.getPartialUser(uid, "update name", [
+    "name",
+    "banned",
+    "needsToChangeName",
+    "lastNameChange",
+  ]);
 
   if (user.banned) {
     throw new MonkeyError(403, "Banned users cannot change their name");
@@ -486,7 +506,10 @@ export async function linkDiscord(
     throw new MonkeyError(403, "Invalid user token");
   }
 
-  const userInfo = await UserDAL.getUser(uid, "link discord");
+  const userInfo = await UserDAL.getPartialUser(uid, "link discord", [
+    "banned",
+    "discordId",
+  ]);
   if (userInfo.banned) {
     throw new MonkeyError(403, "Banned accounts cannot link with Discord");
   }
@@ -538,7 +561,10 @@ export async function unlinkDiscord(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  const userInfo = await UserDAL.getUser(uid, "unlink discord");
+  const userInfo = await UserDAL.getPartialUser(uid, "unlink discord", [
+    "banned",
+    "discordId",
+  ]);
 
   if (userInfo.banned) {
     throw new MonkeyError(403, "Banned accounts cannot unlink Discord");
@@ -822,7 +848,10 @@ export async function updateProfile(
   const { uid } = req.ctx.decodedToken;
   const { bio, keyboard, socialProfiles, selectedBadgeId } = req.body;
 
-  const user = await UserDAL.getUser(uid, "update user profile");
+  const user = await UserDAL.getPartialUser(uid, "update user profile", [
+    "banned",
+    "inventory",
+  ]);
 
   if (user.banned) {
     throw new MonkeyError(403, "Banned users cannot update their profile");
@@ -908,7 +937,9 @@ export async function setStreakHourOffset(
   const { uid } = req.ctx.decodedToken;
   const { hourOffset } = req.body;
 
-  const user = await UserDAL.getUser(uid, "update user profile");
+  const user = await UserDAL.getPartialUser(uid, "update user profile", [
+    "streak",
+  ]);
 
   if (
     user.streak?.hourOffset !== undefined &&
@@ -927,7 +958,10 @@ export async function toggleBan(
 ): Promise<MonkeyResponse> {
   const { uid } = req.body;
 
-  const user = await UserDAL.getUser(uid, "toggle ban");
+  const user = await UserDAL.getPartialUser(uid, "toggle ban", [
+    "banned",
+    "discordId",
+  ]);
   const discordId = user.discordId;
   const discordIdIsValid = discordId !== undefined && discordId !== "";
 
@@ -1036,7 +1070,10 @@ export async function getTestActivity(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
   const premiumFeaturesEnabled = req.ctx.configuration.users.premium.enabled;
-  const user = await UserDAL.getUser(uid, "testActivity");
+  const user = await UserDAL.getPartialUser(uid, "testActivity", [
+    "testActivity",
+    "premium",
+  ]);
   const userHasPremium = await UserDAL.checkIfUserIsPremium(uid, user);
 
   if (!premiumFeaturesEnabled) {
@@ -1063,7 +1100,9 @@ export async function getCurrentTestActivity(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  const user = await UserDAL.getUser(uid, "current test activity");
+  const user = await UserDAL.getPartialUser(uid, "current test activity", [
+    "testActivity",
+  ]);
   const data = generateCurrentTestActivity(user.testActivity);
   return new MonkeyResponse("Current test activity data retrieved", data);
 }
@@ -1073,7 +1112,7 @@ export async function getStreak(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  const user = await UserDAL.getUser(uid, "streak");
+  const user = await UserDAL.getPartialUser(uid, "streak", ["streak"]);
 
   return new MonkeyResponse("Streak data retrieved", user.streak);
 }