Merge branch 'master' into feature/track-user-email-verification

Author: fehmer

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

@@ -139,28 +139,29 @@ describe("Loaderboard Controller", () => {
       );
     });
 
-    it("should get for mode", async () => {
-      getLeaderboardMock.mockResolvedValue([]);
-      for (const mode of ["time", "words", "quote", "zen", "custom"]) {
-        const response = await mockApp
-          .get("/leaderboards")
-          .query({ language: "english", mode, mode2: "custom" });
-        expect(response.status, "for mode " + mode).toEqual(200);
-      }
-    });
-
-    it("should get for mode2", async () => {
-      getLeaderboardMock.mockResolvedValue([]);
-      for (const mode2 of allModes) {
-        const response = await mockApp.get("/leaderboards").query({
-          language: "english",
-          mode: "words",
-          mode2,
-        });
+    describe("should get for modes", async () => {
+      beforeEach(() => {
+        getLeaderboardMock.mockResolvedValue([]);
+      });
 
-        expect(response.status, "for mode2 " + mode2).toEqual(200);
-      }
+      const testCases = [
+        { mode: "time", mode2: "15", language: "english", expectStatus: 200 },
+        { mode: "time", mode2: "60", language: "english", expectStatus: 200 },
+        { mode: "time", mode2: "30", language: "english", expectStatus: 404 },
+        { mode: "words", mode2: "15", language: "english", expectStatus: 404 },
+        { mode: "time", mode2: "15", language: "spanish", expectStatus: 404 },
+      ];
+      it.for(testCases)(
+        `expect $expectStatus for mode $mode, mode2 $mode2, lang $language`,
+        async ({ mode, mode2, language, expectStatus }) => {
+          await mockApp
+            .get("/leaderboards")
+            .query({ language, mode, mode2 })
+            .expect(expectStatus);
+        }
+      );
     });
+
     it("fails for missing query", async () => {
       const { body } = await mockApp.get("/leaderboards").expect(422);
 

backend/src/api/controllers/leaderboard.ts

@@ -32,6 +32,14 @@ export async function getLeaderboard(
 ): Promise<GetLeaderboardResponse> {
   const { language, mode, mode2, page, pageSize } = req.query;
 
+  if (
+    mode !== "time" ||
+    (mode2 !== "15" && mode2 !== "60") ||
+    language !== "english"
+  ) {
+    throw new MonkeyError(404, "There is no leaderboard for this mode");
+  }
+
   const leaderboard = await LeaderboardsDAL.get(
     mode,
     mode2,

backend/src/api/controllers/user.ts

@@ -8,7 +8,7 @@ import { MonkeyResponse } from "../../utils/monkey-response";
 import * as DiscordUtils from "../../utils/discord";
 import {
   buildAgentLog,
-  isDevEnvironment,
+  getFrontendUrl,
   replaceObjectId,
   replaceObjectIds,
   sanitizeString,
@@ -180,11 +180,7 @@ export async function sendVerificationEmail(
   const { data: link, error } = await tryCatch(
     FirebaseAdmin()
       .auth()
-      .generateEmailVerificationLink(email, {
-        url: isDevEnvironment()
-          ? "http://localhost:3000"
-          : "https://monkeytype.com",
-      })
+      .generateEmailVerificationLink(email, { url: getFrontendUrl() })
   );
 
   if (error) {

backend/src/init/email-client.ts

@@ -28,6 +28,7 @@ const templates: Record<EmailType, EmailMetadata> = {
 
 let transportInitialized = false;
 let transporter: nodemailer.Transporter;
+let emailFrom = "Monkeytype <[email protected]>";
 
 export function isInitialized(): boolean {
   return transportInitialized;
@@ -38,7 +39,12 @@ export async function init(): Promise<void> {
     return;
   }
 
-  const { EMAIL_HOST, EMAIL_USER, EMAIL_PASS, EMAIL_PORT } = process.env;
+  const { EMAIL_HOST, EMAIL_USER, EMAIL_PASS, EMAIL_PORT, EMAIL_FROM } =
+    process.env;
+
+  if (EMAIL_FROM !== undefined) {
+    emailFrom = EMAIL_FROM;
+  }
 
   if (!(EMAIL_HOST ?? "") || !(EMAIL_USER ?? "") || !(EMAIL_PASS ?? "")) {
     if (isDevEnvironment()) {
@@ -102,7 +108,7 @@ export async function sendEmail(
   const template = await fillTemplate<typeof templateName>(templateName, data);
 
   const mailOptions = {
-    from: "Monkeytype <[email protected]>",
+    from: emailFrom,
     to,
     subject: templates[templateName].subject,
     html: template,

backend/src/utils/auth.ts

@@ -6,7 +6,7 @@ import {
   setTokenCacheSize,
 } from "./prometheus";
 import { type DecodedIdToken, UserRecord } from "firebase-admin/auth";
-import { isDevEnvironment } from "./misc";
+import { getFrontendUrl } from "./misc";
 import emailQueue from "../queues/email-queue";
 import * as UserDAL from "../dal/user";
 import { isFirebaseError } from "./error";
@@ -98,11 +98,7 @@ export async function sendForgotPasswordEmail(email: string): Promise<void> {
 
     const link = await FirebaseAdmin()
       .auth()
-      .generatePasswordResetLink(email, {
-        url: isDevEnvironment()
-          ? "http://localhost:3000"
-          : "https://monkeytype.com",
-      });
+      .generatePasswordResetLink(email, { url: getFrontendUrl() });
 
     await emailQueue.sendForgotPasswordEmail(email, name, link);
   } catch (err) {

backend/src/utils/misc.ts

@@ -193,6 +193,14 @@ export function isDevEnvironment(): boolean {
   return process.env["MODE"] === "dev";
 }
 
+export function getFrontendUrl(): string {
+  return isDevEnvironment()
+    ? "http://localhost:3000"
+    : process.env["FRONTEND_URL"] !== undefined
+    ? process.env["FRONTEND_URL"]
+    : "https://monkeytype.com";
+}
+
 /**
  * convert database object into api object
  * @param data  database object with `_id: ObjectId`

docker/docker-compose.yml

@@ -35,6 +35,11 @@ services:
       - REDIS_URI=redis://monkeytype-redis:6379
       - FRONTEND_URL=${MONKEYTYPE_FRONTENDURL}
       - RECAPTCHA_SECRET=${RECAPTCHA_SECRET:-}
+      - EMAIL_HOST=${EMAIL_HOST:-}
+      - EMAIL_PORT=${EMAIL_PORT:-}
+      - EMAIL_USER=${EMAIL_USER:-}
+      - EMAIL_PASS=${EMAIL_PASS:-}
+      - EMAIL_FROM=${EMAIL_FROM:-}
     volumes:
       #uncomment to enable the account system, check the SELF_HOSTING.md file
       #- type: bind

docker/example.env

@@ -4,15 +4,24 @@ MONKEYTYPE_FRONTENDURL=http://myserver:8080
 #url of the backend server, this must be accessible by your clients browser
 MONKEYTYPE_BACKENDURL=http://myserver:5005
 
-# uncomment below config if you need user accounts
 # firebase config
+# uncomment below config if you need user accounts
 #FIREBASE_APIKEY=
 #FIREBASE_AUTHDOMAIN=
 #FIREBASE_PROJECTID=
 #FIREBASE_STORAGEBUCKET=
 #FIREBASE_MESSAGINGSENDERID=
 #FIREBASE_APPID=
 
+
+# email server config
+# uncomment below if you want to send emails for e.g. password reset
+#EMAIL_HOST=mail.myserver
+#EMAIL_USER=mailuser
+#EMAIL_PASS=mailpass
+#EMAIL_PORT=465
+#EMAIL_FROM="Support <noreply@myserver>"
+
 # google recaptcha
 # uncomment below config if you need user accounts
 # you can use these defaults if you host this privately

docs/SELF_HOSTING.md

@@ -14,6 +14,7 @@
         - [Setup Firebase](#setup-firebase)
         - [Update backend configuration](#update-backend-configuration)
         - [Setup Recaptcha](#setup-recaptcha)
+        - [Setup email optional](#setup-email-optional)
     - [Enable daily leaderboards](#enable-daily-leaderboards)
     - [Configuration files](#configuration-files)
         - [env file](#env-file)
@@ -126,6 +127,20 @@ RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
 RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
 ```
 
+### Setup email (optional)
+
+To enable emails for password reset and email verification update the following config in `.env` file:
+
+```
+# email server config
+# uncomment below if you want to send emails for e.g. password reset
+EMAIL_HOST=mail.myserver   # your mailserver domain
+EMAIL_USER=mailuser        # username to authenticate with your mailserver
+EMAIL_PASS=mailpass        # password for the user
+EMAIL_PORT=465             # port, likely 465 or 578
+EMAIL_FROM="Support <noreply@myserver>"
+``` 
+
 ## Enable daily leaderboards
 
 To enable daily leaderboards update the `backend-configuration.json` file and add/modify

frontend/src/html/pages/leaderboards.html

@@ -23,7 +23,7 @@
         <div class="title timer">Updates in: -</div>
 
         <div class="jumpButtons">
-          <div class="updating hidden">
+          <div class="updating">
             <i class="fas fa-circle-notch fa-spin"></i>
           </div>
           <button data-action="firstPage"><i class="fas fa-crown"></i></button>
@@ -55,7 +55,7 @@
               wpm
               <div class="sub">accuracy</div>
             </td>
-            <td class="stat narrow">
+            <td class="stat narrow rawAndConsistency">
               raw
               <div class="sub">consistency</div>
             </td>
@@ -156,7 +156,7 @@
         </div>
       </div>
     </div>
-    <div class="buttons">
+    <div class="sideButtons">
       <div class="buttonGroup typeButtons">
         <button data-type="allTime">
           <i class="fas fa-globe-americas"></i>
@@ -172,7 +172,7 @@
         </button>
       </div>
       <div class="divider hidden"></div>
-      <div class="buttonGroup hidden secondary modeButtons">
+      <div class="buttonGroup hidden modeButtons">
         <button data-mode="15">
           <i class="fas fa-clock"></i>
           time 15
@@ -182,8 +182,8 @@
           time 60
         </button>
       </div>
-      <div class="divider divider2 hidden"></div>
-      <div class="buttonGroup hidden secondary languageButtons">
+      <div class="divider2 hidden"></div>
+      <div class="buttonGroup hidden languageButtons">
         <button data-language="english">
           <i class="fas fa-globe"></i>
           english