refactor: add trycatch util (@Miodec) (monkeytypegame#6492)

Adds trycatch util to cleanup try catch code.

Author: Miodec

backend/src/api/controllers/result.ts

@@ -63,6 +63,7 @@ import {
   checkCompatibility,
   stringToFunboxNames,
 } from "@monkeytype/funbox";
+import { tryCatch } from "@monkeytype/util/trycatch";
 
 try {
   if (!anticheatImplemented()) throw new Error("undefined");
@@ -318,13 +319,7 @@ export async function addResult(
   //   );
   //   return res.status(400).json({ message: "Time traveler detected" });
 
-  //get latest result ordered by timestamp
-  let lastResultTimestamp: null | number = null;
-  try {
-    lastResultTimestamp = (await ResultDAL.getLastResult(uid)).timestamp;
-  } catch (e) {
-    //
-  }
+  const { data: lastResult } = await tryCatch(ResultDAL.getLastResult(uid));
 
   //convert result test duration to miliseconds
   completedEvent.timestamp = Math.floor(Date.now() / 1000) * 1000;
@@ -333,13 +328,13 @@ export async function addResult(
   const testDurationMilis = completedEvent.testDuration * 1000;
   const incompleteTestsMilis = completedEvent.incompleteTestSeconds * 1000;
   const earliestPossible =
-    (lastResultTimestamp ?? 0) + testDurationMilis + incompleteTestsMilis;
+    (lastResult?.timestamp ?? 0) + testDurationMilis + incompleteTestsMilis;
   const nowNoMilis = Math.floor(Date.now() / 1000) * 1000;
-  if (lastResultTimestamp && nowNoMilis < earliestPossible - 1000) {
+  if (lastResult?.timestamp && nowNoMilis < earliestPossible - 1000) {
     void addLog(
       "invalid_result_spacing",
       {
-        lastTimestamp: lastResultTimestamp,
+        lastTimestamp: lastResult.timestamp,
         earliestPossible,
         now: nowNoMilis,
         testDuration: testDurationMilis,
@@ -786,17 +781,16 @@ async function calculateXp(
   const accuracyModifier = (acc - 50) / 50;
 
   let dailyBonus = 0;
-  let lastResultTimestamp: number | undefined;
+  const { data: lastResult, error: getLastResultError } = await tryCatch(
+    ResultDAL.getLastResult(uid)
+  );
 
-  try {
-    const { timestamp } = await ResultDAL.getLastResult(uid);
-    lastResultTimestamp = timestamp;
-  } catch (err) {
-    Logger.error(`Could not fetch last result: ${err}`);
+  if (getLastResultError) {
+    Logger.error(`Could not fetch last result: ${getLastResultError}`);
   }
 
-  if (lastResultTimestamp) {
-    const lastResultDay = getStartOfDayTimestamp(lastResultTimestamp);
+  if (lastResult?.timestamp) {
+    const lastResultDay = getStartOfDayTimestamp(lastResult.timestamp);
     const today = getCurrentDayTimestamp();
     if (lastResultDay !== today) {
       const proportionalXp = Math.round(currentTotalXp * 0.05);

backend/src/api/controllers/user.ts

@@ -88,13 +88,11 @@ import {
 } from "@monkeytype/contracts/users";
 import { MILLISECONDS_IN_DAY } from "@monkeytype/util/date-and-time";
 import { MonkeyRequest } from "../types";
+import { tryCatch } from "@monkeytype/util/trycatch";
 
 async function verifyCaptcha(captcha: string): Promise<void> {
-  let verified = false;
-  try {
-    verified = await verify(captcha);
-  } catch (e) {
-    //fetch to recaptcha api can sometimes fail
+  const { data: verified, error } = await tryCatch(verify(captcha));
+  if (error) {
     throw new MonkeyError(
       422,
       "Request to the Captcha API failed, please try again later"
@@ -177,18 +175,19 @@ export async function sendVerificationEmail(
     );
   }
 
-  let link = "";
-  try {
-    link = await FirebaseAdmin()
+  const { data: link, error } = await tryCatch(
+    FirebaseAdmin()
       .auth()
       .generateEmailVerificationLink(email, {
         url: isDevEnvironment()
           ? "http://localhost:3000"
           : "https://monkeytype.com",
-      });
-  } catch (e) {
-    if (isFirebaseError(e)) {
-      if (e.errorInfo.code === "auth/user-not-found") {
+      })
+  );
+
+  if (error) {
+    if (isFirebaseError(error)) {
+      if (error.errorInfo.code === "auth/user-not-found") {
         throw new MonkeyError(
           500,
           "Auth user not found when the user was found in the database. Contact support with this error message and your email",
@@ -198,11 +197,11 @@ export async function sendVerificationEmail(
           }),
           userInfo.uid
         );
-      } else if (e.errorInfo.code === "auth/too-many-requests") {
+      } else if (error.errorInfo.code === "auth/too-many-requests") {
         throw new MonkeyError(429, "Too many requests. Please try again later");
       } else if (
-        e.errorInfo.code === "auth/internal-error" &&
-        e.errorInfo.message.toLowerCase().includes("too_many_attempts")
+        error.errorInfo.code === "auth/internal-error" &&
+        error.errorInfo.message.toLowerCase().includes("too_many_attempts")
       ) {
         throw new MonkeyError(
           429,
@@ -212,12 +211,12 @@ export async function sendVerificationEmail(
         throw new MonkeyError(
           500,
           "Firebase failed to generate an email verification link: " +
-            e.errorInfo.message,
-          JSON.stringify(e)
+            error.errorInfo.message,
+          JSON.stringify(error)
         );
       }
     } else {
-      const message = getErrorMessage(e);
+      const message = getErrorMessage(error);
       if (message === undefined) {
         throw new MonkeyError(
           500,
@@ -233,12 +232,13 @@ export async function sendVerificationEmail(
           throw new MonkeyError(
             500,
             "Failed to generate an email verification link: " + message,
-            (e as Error).stack
+            error.stack
           );
         }
       }
     }
   }
+
   await emailQueue.sendVerificationEmail(email, userInfo.name, link);
 
   return new MonkeyResponse("Email sent", null);
@@ -259,22 +259,20 @@ export async function sendForgotPasswordEmail(
 export async function deleteUser(req: MonkeyRequest): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  let userInfo:
-    | Pick<UserDAL.DBUser, "banned" | "name" | "email" | "discordId">
-    | undefined;
-
-  try {
-    userInfo = await UserDAL.getPartialUser(uid, "delete user", [
+  const { data: userInfo, error } = await tryCatch(
+    UserDAL.getPartialUser(uid, "delete user", [
       "banned",
       "name",
       "email",
       "discordId",
-    ]);
-  } catch (e) {
-    if (e instanceof MonkeyError && e.status === 404) {
+    ])
+  );
+
+  if (error) {
+    if (error instanceof MonkeyError && error.status === 404) {
       //userinfo was already deleted. We ignore this and still try to remove the  other data
     } else {
-      throw e;
+      throw error;
     }
   }
 
@@ -533,12 +531,12 @@ function getRelevantUserInfo(user: UserDAL.DBUser): RelevantUserInfo {
 export async function getUser(req: MonkeyRequest): Promise<GetUserResponse> {
   const { uid } = req.ctx.decodedToken;
 
-  let userInfo: UserDAL.DBUser;
-  try {
-    userInfo = await UserDAL.getUser(uid, "get user");
-  } catch (e) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    if (e.status === 404) {
+  const { data: userInfo, error } = await tryCatch(
+    UserDAL.getUser(uid, "get user")
+  );
+
+  if (error) {
+    if (error instanceof MonkeyError && error.status === 404) {
       //if the user is in the auth system but not in the db, its possible that the user was created by bypassing captcha
       //since there is no data in the database anyway, we can just delete the user from the auth system
       //and ask them to sign up again
@@ -564,7 +562,7 @@ export async function getUser(req: MonkeyRequest): Promise<GetUserResponse> {
         }
       }
     } else {
-      throw e;
+      throw error;
     }
   }
 

backend/src/api/routes/swagger.ts

@@ -3,13 +3,17 @@ import { getMiddleware as getSwaggerMiddleware } from "swagger-stats";
 import { isDevEnvironment } from "../../utils/misc";
 import { readFileSync } from "fs";
 import Logger from "../../utils/logger";
+import { tryCatchSync } from "@monkeytype/util/trycatch";
 
 function addSwaggerMiddlewares(app: Application): void {
   const openApiSpec = __dirname + "/../../../dist/static/api/openapi.json";
-  let spec = {};
-  try {
-    spec = JSON.parse(readFileSync(openApiSpec, "utf8")) as string;
-  } catch (err) {
+
+  const { data: spec, error } = tryCatchSync(
+    () =>
+      JSON.parse(readFileSync(openApiSpec, "utf8")) as Record<string, unknown>
+  );
+
+  if (error) {
     Logger.warning(
       `Cannot read openApi specification from ${openApiSpec}. Swagger stats will not fully work.`
     );
@@ -21,7 +25,7 @@ function addSwaggerMiddlewares(app: Application): void {
       uriPath: "/stats",
       authentication: !isDevEnvironment(),
       apdexThreshold: 100,
-      swaggerSpec: spec,
+      swaggerSpec: spec ?? {},
       onAuthenticate: (_req, username, password) => {
         return (
           username === process.env["STATS_USERNAME"] &&

backend/src/dal/new-quotes.ts

@@ -1,4 +1,4 @@
-import { SimpleGit, simpleGit } from "simple-git";
+import { simpleGit } from "simple-git";
 import { Collection, ObjectId } from "mongodb";
 import path from "path";
 import { existsSync, writeFileSync } from "fs";
@@ -10,6 +10,7 @@ import { ApproveQuote, Quote } from "@monkeytype/contracts/schemas/quotes";
 import { WithObjectId } from "../utils/misc";
 import { parseWithSchema as parseJsonWithSchema } from "@monkeytype/util/json";
 import { z } from "zod";
+import { tryCatchSync } from "@monkeytype/util/trycatch";
 
 const JsonQuoteSchema = z.object({
   text: z.string(),
@@ -28,12 +29,12 @@ const QuoteDataSchema = z.object({
 
 const PATH_TO_REPO = "../../../../monkeytype-new-quotes";
 
-let git: SimpleGit | undefined;
-try {
-  git = simpleGit(path.join(__dirname, PATH_TO_REPO));
-} catch (e) {
-  console.error(`Failed to initialize git: ${e}`);
-  git = undefined;
+const { data: git, error } = tryCatchSync(() =>
+  simpleGit(path.join(__dirname, PATH_TO_REPO))
+);
+
+if (error) {
+  console.error(`Failed to initialize git: ${error}`);
 }
 
 type AddQuoteReturn = {
@@ -145,7 +146,7 @@ export async function approve(
   editSource: string | undefined,
   name: string
 ): Promise<ApproveReturn> {
-  if (git === undefined) throw new MonkeyError(500, "Git not available.");
+  if (git === null) throw new MonkeyError(500, "Git not available.");
   //check mod status
   const targetQuote = await getNewQuoteCollection().findOne({
     _id: new ObjectId(quoteId),

backend/src/dal/result.ts

@@ -8,8 +8,9 @@ import {
 import MonkeyError from "../utils/error";
 import * as db from "../init/db";
 
-import { getUser, getTags, DBUser } from "./user";
+import { getUser, getTags } from "./user";
 import { DBResult } from "../utils/result";
+import { tryCatch } from "@monkeytype/util/trycatch";
 
 export const getResultCollection = (): Collection<DBResult> =>
   db.collection<DBResult>("results");
@@ -18,12 +19,8 @@ export async function addResult(
   uid: string,
   result: DBResult
 ): Promise<{ insertedId: ObjectId }> {
-  let user: DBUser | null = null;
-  try {
-    user = await getUser(uid, "add result");
-  } catch (e) {
-    user = null;
-  }
+  const { data: user } = await tryCatch(getUser(uid, "add result"));
+
   if (!user) throw new MonkeyError(404, "User not found", "add result");
   if (result.uid === undefined) result.uid = uid;
   // result.ir = true;

backend/src/init/email-client.ts

@@ -8,6 +8,7 @@ import { recordEmail } from "../utils/prometheus";
 import type { EmailTaskContexts, EmailType } from "../queues/email-queue";
 import { isDevEnvironment } from "../utils/misc";
 import { getErrorMessage } from "../utils/error";
+import { tryCatch } from "@monkeytype/util/trycatch";
 
 type EmailMetadata = {
   subject: string;
@@ -109,14 +110,15 @@ export async function sendEmail(
 
   type Result = { response: string; accepted: string[] };
 
-  let result: Result;
-  try {
-    result = (await transporter.sendMail(mailOptions)) as Result;
-  } catch (e) {
+  const { data: result, error } = await tryCatch(
+    transporter.sendMail(mailOptions) as Promise<Result>
+  );
+
+  if (error) {
     recordEmail(templateName, "fail");
     return {
       success: false,
-      message: getErrorMessage(e) ?? "Unknown error",
+      message: getErrorMessage(error) ?? "Unknown error",
     };
   }
 

backend/src/services/weekly-xp-leaderboard.ts

@@ -11,6 +11,7 @@ import { getCurrentWeekTimestamp } from "@monkeytype/util/date-and-time";
 import MonkeyError from "../utils/error";
 import { omit } from "lodash";
 import { parseWithSchema as parseJsonWithSchema } from "@monkeytype/util/json";
+import { tryCatchSync } from "@monkeytype/util/trycatch";
 
 type AddResultOpts = {
   entry: RedisXpLeaderboardEntry;
@@ -225,11 +226,11 @@ export class WeeklyXpLeaderboard {
       return null;
     }
 
-    // safely parse the result with error handling
-    let parsed: RedisXpLeaderboardEntry;
-    try {
-      parsed = parseJsonWithSchema(result, RedisXpLeaderboardEntrySchema);
-    } catch (error) {
+    const { data: parsed, error } = tryCatchSync(() =>
+      parseJsonWithSchema(result, RedisXpLeaderboardEntrySchema)
+    );
+
+    if (error) {
       throw new MonkeyError(
         500,
         `Failed to parse leaderboard entry: ${

frontend/src/ts/controllers/challenge-controller.ts

@@ -19,6 +19,7 @@ import {
 } from "@monkeytype/contracts/schemas/configs";
 import { Mode } from "@monkeytype/contracts/schemas/shared";
 import { CompletedEvent } from "@monkeytype/contracts/schemas/results";
+import { tryCatch } from "@monkeytype/util/trycatch";
 
 let challengeLoading = false;
 
@@ -219,11 +220,9 @@ export async function setup(challengeName: string): Promise<boolean> {
 
   UpdateConfig.setFunbox("none");
 
-  let list;
-  try {
-    list = await JSONData.getChallengeList();
-  } catch (e) {
-    const message = Misc.createErrorMessage(e, "Failed to setup challenge");
+  const { data: list, error } = await tryCatch(JSONData.getChallengeList());
+  if (error) {
+    const message = Misc.createErrorMessage(error, "Failed to setup challenge");
     Notifications.add(message, -1);
     ManualRestart.set();
     setTimeout(() => {