refactor: move challenges to typescript and improve types (@fehmer) (#8159)

Co-authored-by: Shizuko <83967781+ShizukoV@users.noreply.github.com>
Co-authored-by: Miodec <jack@monkeytype.com>

Author: 3 people

backend/__tests__/setup-tests.ts

@@ -9,7 +9,7 @@ beforeAll(async () => {
   //don't add any configuration here, add to global-setup.ts instead.
 
   vi.mock("../src/init/configuration", async (importOriginal) => {
-    const orig = (await importOriginal()) as { __testing: typeof __testing };
+    const orig = (await importOriginal()) as any;
 
     return {
       __testing: orig.__testing,

backend/package.json

@@ -21,6 +21,7 @@
   },
   "dependencies": {
     "@date-fns/utc": "1.2.0",
+    "@monkeytype/challenges": "workspace:*",
     "@monkeytype/contracts": "workspace:*",
     "@monkeytype/funbox": "workspace:*",
     "@monkeytype/schemas": "workspace:*",

backend/src/api/controllers/result.ts

@@ -24,7 +24,6 @@ import {
 } from "../../utils/prometheus";
 import GeorgeQueue from "../../queues/george-queue";
 import { getDailyLeaderboard } from "../../utils/daily-leaderboards";
-import AutoRoleList from "../../constants/auto-roles";
 import * as UserDAL from "../../dal/user";
 import { buildMonkeyMail } from "../../utils/monkey-mail";
 import * as WeeklyXpLeaderboard from "../../services/weekly-xp-leaderboard";
@@ -64,6 +63,7 @@ import { MonkeyRequest } from "../types";
 import { getFunbox, checkCompatibility } from "@monkeytype/funbox";
 import { tryCatch } from "@monkeytype/util/trycatch";
 import { getCachedConfiguration } from "../../init/configuration";
+import { getChallenges } from "@monkeytype/challenges";
 
 try {
   if (!anticheatImplemented()) throw new Error("undefined");
@@ -81,6 +81,12 @@ try {
   }
 }
 
+const autoRoleChallengeNames = new Set(
+  getChallenges()
+    .filter((it) => it.settings?.autoRole)
+    .map((it) => it.name),
+);
+
 export async function getResults(
   req: MonkeyRequest<GetResultsQuery>,
 ): Promise<GetResultsResponse> {
@@ -459,7 +465,7 @@ export async function addResult(
   if (
     completedEvent.challenge !== null &&
     completedEvent.challenge !== undefined &&
-    AutoRoleList.includes(completedEvent.challenge) &&
+    autoRoleChallengeNames.has(completedEvent.challenge) &&
     user.discordId !== undefined &&
     user.discordId !== ""
   ) {

backend/src/constants/auto-roles.ts

@@ -28,6 +28,7 @@
   "dependencies": {
     "@date-fns/utc": "1.2.0",
     "@leonabcd123/modern-caps-lock": "3.1.3",
+    "@monkeytype/challenges": "workspace:*",
     "@monkeytype/contracts": "workspace:*",
     "@monkeytype/funbox": "workspace:*",
     "@monkeytype/schemas": "workspace:*",

frontend/package.json

@@ -2,7 +2,6 @@
  * Example usage in root or frontend:
  * pnpm check-assets (npm run check-assets)
  * pnpm check-assets -- -- quotes others (npm run check-assets -- -- quotes others)
- * pnpm check-assets -- -- challenges sound -p (npm run check-assets -- -- challenges sound -p)
  */
 
 import * as fs from "fs";
@@ -18,7 +17,6 @@ import { KnownFontName } from "@monkeytype/schemas/fonts";
 import { Fonts } from "../src/ts/constants/fonts";
 import { themes, ThemeSchema, ThemesList } from "../src/ts/constants/themes";
 import { z } from "zod";
-import { ChallengeSchema, Challenge } from "@monkeytype/schemas/challenges";
 import { LayoutObject, LayoutObjectSchema } from "@monkeytype/schemas/layouts";
 import { QuoteDataSchema, QuoteData } from "@monkeytype/schemas/quotes";
 import { clickSoundConfig } from "../src/ts/constants/sounds";
@@ -99,24 +97,6 @@ function findDuplicates<T>(items: T[]): T[] {
   return Array.from(duplicates);
 }
 
-async function validateChallenges(): Promise<void> {
-  const problems = new Problems<"_list.json", never>("Challenges", {});
-
-  const challengesData = JSON.parse(
-    fs.readFileSync("./static/challenges/_list.json", {
-      encoding: "utf8",
-      flag: "r",
-    }),
-  ) as Challenge;
-  const validationResult = z.array(ChallengeSchema).safeParse(challengesData);
-  problems.addValidation("_list.json", validationResult);
-
-  console.log(problems.toString());
-  if (problems.hasError()) {
-    throw new Error("challenges with errors");
-  }
-}
-
 async function validateLayouts(): Promise<void> {
   const problems = new Problems<Layout, "_additional">("Layouts", {
     _additional:
@@ -496,17 +476,10 @@ async function main(): Promise<void> {
     quotes: [validateQuotes],
     languages: [validateLanguages],
     layouts: [validateLayouts],
-    challenges: [validateChallenges],
     fonts: [validateFonts],
     themes: [validateThemes],
     sounds: [validateSounds],
-    others: [
-      validateChallenges,
-      validateLayouts,
-      validateFonts,
-      validateThemes,
-      validateSounds,
-    ],
+    others: [validateLayouts, validateFonts, validateThemes, validateSounds],
   };
 
   // flags

frontend/scripts/check-assets.ts

@@ -1,4 +1,5 @@
 import { NewPasswordSchema, PasswordSchema } from "@monkeytype/schemas/users";
+import { typedKeys } from "@monkeytype/util/objects";
 import { tryCatch } from "@monkeytype/util/trycatch";
 import { FirebaseError } from "firebase/app";
 import {
@@ -47,7 +48,6 @@ import {
 import { FaObject } from "./types/font-awesome";
 import { isDevEnvironment } from "./utils/env";
 import { createErrorMessage } from "./utils/error";
-import { typedKeys } from "./utils/misc";
 import { SnapshotInitError } from "./utils/snapshot-init-error";
 import { OneOf } from "./utils/types";
 

frontend/src/ts/auth.tsx

@@ -13,13 +13,13 @@ import {
   setLastGeneratedApeKey,
 } from "../states/account-settings";
 import { applyIdWorkaround, tempId } from "./utils/misc";
-import { typedEntries } from "../utils/misc";
 import { ApeKey } from "@monkeytype/schemas/ape-keys";
 import { showSuccessNotification } from "../states/notifications";
 import {
   replaceSpacesWithUnderscores,
   replaceUnderscoresWithSpaces,
 } from "../utils/strings";
+import { typedEntries } from "@monkeytype/util/objects";
 
 export type ApeKeyEntry = ApeKey & { _id: string };
 const queryKeys = {

frontend/src/ts/collections/ape-keys.ts

@@ -13,8 +13,8 @@ import { getActivePage, isAuthenticated } from "../states/core";
 import { Fonts } from "../constants/fonts";
 import { KnownFontName } from "@monkeytype/schemas/fonts";
 import * as UI from "../ui";
-import { typedKeys } from "../utils/misc";
 import { Validation } from "../types/validation";
+import { typedKeys } from "@monkeytype/util/objects";
 
 //TODO: remove display property and instead use optionsMetadata from configMetadata
 // eventually this file should be fully merged into config metadata, probably under the 'commandline' property

frontend/src/ts/commandline/commandline-metadata.ts

@@ -12,14 +12,10 @@ import CustomThemesListCommands from "./lists/custom-themes-list";
 import PresetsCommands from "./lists/presets";
 import FunboxCommands from "./lists/funbox";
 import ThemesCommands from "./lists/themes";
-import LoadChallengeCommands, {
-  update as updateLoadChallengeCommands,
-} from "./lists/load-challenge";
+import LoadChallengeCommands from "./lists/load-challenge";
 
 import { Config } from "../config/store";
 import { setConfig } from "../config/setters";
-import * as getErrorMessage from "../utils/error";
-import * as JSONData from "../utils/json-data";
 import { randomizeTheme } from "../controllers/theme-controller";
 import { showModal } from "../states/modals";
 import {
@@ -41,20 +37,6 @@ import {
 import { applyConfigFromJson } from "../config/lifecycle";
 import { lastEventLog } from "../test/test-state";
 
-const challengesPromise = JSONData.getChallengeList();
-challengesPromise
-  .then((challenges) => {
-    updateLoadChallengeCommands(challenges);
-  })
-  .catch((e: unknown) => {
-    console.error(
-      getErrorMessage.createErrorMessage(
-        e,
-        "Failed to update challenges commands",
-      ),
-    );
-  });
-
 const adsCommands = buildCommands("ads");
 
 export const commands: CommandsSubgroup = {
@@ -406,8 +388,6 @@ export function doesListExist(listName: string): boolean {
 export async function getList(
   listName: CommandlineListKey | ConfigKey,
 ): Promise<CommandsSubgroup> {
-  await Promise.allSettled([challengesPromise]);
-
   const subGroup = subgroupByConfigKey[listName];
   if (subGroup !== undefined) {
     return subGroup;
@@ -451,7 +431,6 @@ export function getTopOfStack(): CommandsSubgroup {
 
 let singleList: CommandsSubgroup | undefined;
 export async function getSingleSubgroup(): Promise<CommandsSubgroup> {
-  await Promise.allSettled([challengesPromise]);
   const singleCommands: Command[] = [];
   for (const command of commands.list) {
     const ret = buildSingleListCommands(command);