refactor(types): shared config and preset types (#5024)

* build: include all shared types files instead of just one

* move config property value types to a shared file

* backend build issues

* shared preset and config types
preset and config ape types

* typo

* ignoring unused warnings

* fixed merge

Author: Miodec

backend/__tests__/dal/result.spec.ts

@@ -2,7 +2,7 @@ import * as ResultDal from "../../src/dal/result";
 import { ObjectId } from "mongodb";
 import * as UserDal from "../../src/dal/user";
 
-type MonkeyTypesResult = SharedTypes.DBResult<SharedTypes.Mode>;
+type MonkeyTypesResult = SharedTypes.DBResult<SharedTypes.Config.Mode>;
 
 let uid: string = "";
 const timestamp = Date.now() - 60000;

backend/src/api/controllers/user.ts

@@ -580,7 +580,8 @@ export async function updateLbMemory(
 ): Promise<MonkeyResponse> {
   const { uid } = req.ctx.decodedToken;
   const { mode, language, rank } = req.body;
-  const mode2 = req.body.mode2 as SharedTypes.Mode2<SharedTypes.Mode>;
+  const mode2 = req.body
+    .mode2 as SharedTypes.Config.Mode2<SharedTypes.Config.Mode>;
 
   await UserDAL.updateLbMemory(uid, mode, mode2, language, rank);
   return new MonkeyResponse("Leaderboard memory updated");

backend/src/dal/preset.ts

@@ -1,11 +1,15 @@
 import MonkeyError from "../utils/error";
 import * as db from "../init/db";
-import { ObjectId, Filter } from "mongodb";
+import { ObjectId, Filter, Collection, WithId } from "mongodb";
 
 const MAX_PRESETS = 10;
-const COLLECTION_NAME = "presets";
 
-function getPresetKeyFilter(uid: string, keyId: string): Filter<any> {
+type DBConfigPreset = SharedTypes.WithObjectId<SharedTypes.DBConfigPreset>;
+
+function getPresetKeyFilter(
+  uid: string,
+  keyId: string
+): Filter<DBConfigPreset> {
   return {
     _id: new ObjectId(keyId),
     uid,
@@ -16,10 +20,11 @@ interface PresetCreationResult {
   presetId: string;
 }
 
-// TODO: Add typings for presets/configs, must look into shared type declarations.
-export async function getPresets(uid: string): Promise<any[]> {
-  const presets = await db
-    .collection(COLLECTION_NAME)
+export const getPresetsCollection = (): Collection<WithId<DBConfigPreset>> =>
+  db.collection<DBConfigPreset>("presets");
+
+export async function getPresets(uid: string): Promise<DBConfigPreset[]> {
+  const presets = await getPresetsCollection()
     .find({ uid })
     .sort({ timestamp: -1 })
     .toArray(); // this needs to be changed to later take patreon into consideration
@@ -36,9 +41,12 @@ export async function addPreset(
     throw new MonkeyError(409, "Too many presets");
   }
 
-  const preset = await db
-    .collection(COLLECTION_NAME)
-    .insertOne({ uid, name, config } as any);
+  const preset = await getPresetsCollection().insertOne({
+    _id: new ObjectId(),
+    uid,
+    name,
+    config,
+  });
   return {
     presetId: preset.insertedId.toHexString(),
   };
@@ -54,24 +62,24 @@ export async function editPreset(
     config !== undefined && config !== null && Object.keys(config).length > 0
       ? { name, config }
       : { name };
-  await db
-    .collection(COLLECTION_NAME)
-    .updateOne(getPresetKeyFilter(uid, presetId), { $set: presetUpdates });
+  await getPresetsCollection().updateOne(getPresetKeyFilter(uid, presetId), {
+    $set: presetUpdates,
+  });
 }
 
 export async function removePreset(
   uid: string,
   presetId: string
 ): Promise<void> {
-  const deleteResult = await db
-    .collection(COLLECTION_NAME)
-    .deleteOne(getPresetKeyFilter(uid, presetId));
+  const deleteResult = await getPresetsCollection().deleteOne(
+    getPresetKeyFilter(uid, presetId)
+  );
 
   if (deleteResult.deletedCount === 0) {
     throw new MonkeyError(404, "Preset not found");
   }
 }
 
 export async function deleteAllPresets(uid: string): Promise<void> {
-  await db.collection(COLLECTION_NAME).deleteMany({ uid });
+  await getPresetsCollection().deleteMany({ uid });
 }

backend/src/dal/result.ts

@@ -5,7 +5,7 @@ import * as db from "../init/db";
 
 import { getUser, getTags } from "./user";
 
-type DBResult = SharedTypes.DBResult<SharedTypes.Mode>;
+type DBResult = SharedTypes.DBResult<SharedTypes.Config.Mode>;
 
 export async function addResult(
   uid: string,

backend/src/dal/user.ts

@@ -10,7 +10,10 @@ import { flattenObjectDeep, isToday, isYesterday } from "../utils/misc";
 
 const SECONDS_PER_HOUR = 3600;
 
-type Result = Omit<SharedTypes.DBResult<SharedTypes.Mode>, "_id" | "name">;
+type Result = Omit<
+  SharedTypes.DBResult<SharedTypes.Config.Mode>,
+  "_id" | "name"
+>;
 
 // Export for use in tests
 export const getUsersCollection = (): Collection<WithId<MonkeyTypes.User>> =>
@@ -385,8 +388,8 @@ export async function removeTagPb(uid: string, _id: string): Promise<void> {
 
 export async function updateLbMemory(
   uid: string,
-  mode: SharedTypes.Mode,
-  mode2: SharedTypes.Mode2<SharedTypes.Mode>,
+  mode: SharedTypes.Config.Mode,
+  mode2: SharedTypes.Config.Mode2<SharedTypes.Config.Mode>,
   language: string,
   rank: number
 ): Promise<void> {

backend/src/types/types.d.ts

@@ -143,7 +143,7 @@ declare namespace MonkeyTypes {
     _id: ObjectId;
     acc: number;
     consistency: number;
-    difficulty: SharedTypes.Difficulty;
+    difficulty: SharedTypes.Config.Difficulty;
     lazyMode: boolean;
     language: string;
     punctuation: boolean;

backend/src/utils/pb.ts

@@ -7,7 +7,10 @@ interface CheckAndUpdatePbResult {
   lbPersonalBests?: MonkeyTypes.LbPersonalBests;
 }
 
-type Result = Omit<SharedTypes.DBResult<SharedTypes.Mode>, "_id" | "name">;
+type Result = Omit<
+  SharedTypes.DBResult<SharedTypes.Config.Mode>,
+  "_id" | "name"
+>;
 
 export function canFunboxGetPb(result: Result): boolean {
   const funbox = result.funbox;
@@ -32,7 +35,7 @@ export function checkAndUpdatePb(
   result: Result
 ): CheckAndUpdatePbResult {
   const mode = result.mode;
-  const mode2 = result.mode2 as SharedTypes.Mode2<"time">;
+  const mode2 = result.mode2 as SharedTypes.Config.Mode2<"time">;
 
   const userPb = userPersonalBests ?? {};
   userPb[mode] ??= {};
@@ -155,7 +158,7 @@ function updateLeaderboardPersonalBests(
   }
 
   const mode = result.mode;
-  const mode2 = result.mode2 as SharedTypes.Mode2<"time">;
+  const mode2 = result.mode2 as SharedTypes.Config.Mode2<"time">;
 
   lbPersonalBests[mode] = lbPersonalBests[mode] ?? {};
   const lbMode2 = lbPersonalBests[mode][mode2] as MonkeyTypes.LbPersonalBests;

backend/src/utils/prometheus.ts

@@ -89,7 +89,7 @@ export function setLeaderboard(
 }
 
 export function incrementResult(
-  res: SharedTypes.Result<SharedTypes.Mode>
+  res: SharedTypes.Result<SharedTypes.Config.Mode>
 ): void {
   const {
     mode,

backend/src/utils/result.ts

@@ -1,6 +1,6 @@
 import { ObjectId } from "mongodb";
 
-type Result = SharedTypes.DBResult<SharedTypes.Mode>;
+type Result = SharedTypes.DBResult<SharedTypes.Config.Mode>;
 
 export function buildDbResult(
   completedEvent: SharedTypes.CompletedEvent,

backend/tsconfig.json

@@ -22,8 +22,12 @@
   "ts-node": {
     "files": true
   },
-  "files": ["./src/types/types.d.ts", "../shared-types/types.d.ts"],
-  "include": ["./src/**/*"],
+  "files": [
+    "./src/types/types.d.ts",
+    "../shared-types/types.d.ts",
+    "../shared-types/config.d.ts"
+  ],
+  "include": ["./src/**/*", "../shared-types/**/*.d.ts"],
   "exclude": [
     "node_modules",
     "build",