Correctly type request bodies in API routers

Author: AnastasiiaBalenko

eslint-suppressions.json

@@ -2,48 +2,6 @@
   "src/server/api/bannerRouter.ts": {
     "@typescript-eslint/no-unnecessary-condition": {
       "count": 1
-    },
-    "@typescript-eslint/no-unsafe-assignment": {
-      "count": 7
-    },
-    "@typescript-eslint/no-unsafe-argument": {
-      "count": 1
-    },
-    "@typescript-eslint/no-unsafe-member-access": {
-      "count": 6
-    }
-  },
-  "src/server/api/epicRouter.ts": {
-    "@typescript-eslint/restrict-template-expressions": {
-      "count": 1
-    },
-    "@typescript-eslint/no-unsafe-assignment": {
-      "count": 3
-    },
-    "@typescript-eslint/no-unsafe-argument": {
-      "count": 2
-    },
-    "@typescript-eslint/no-unsafe-call": {
-      "count": 2
-    },
-    "@typescript-eslint/no-unsafe-member-access": {
-      "count": 3
-    }
-  },
-  "src/server/api/gutterRouter.ts": {
-    "@typescript-eslint/no-unsafe-assignment": {
-      "count": 1
-    },
-    "@typescript-eslint/no-unsafe-argument": {
-      "count": 1
-    }
-  },
-  "src/server/api/headerRouter.ts": {
-    "@typescript-eslint/no-unsafe-assignment": {
-      "count": 1
-    },
-    "@typescript-eslint/no-unsafe-argument": {
-      "count": 1
     }
   },
   "src/server/factories/test.ts": {

src/server/api/bannerRouter.ts

@@ -167,7 +167,11 @@ export const buildBannerRouter = (
 
     router.post(
         '/banner',
-        (req: express.Request, res: express.Response, next: express.NextFunction) => {
+        (
+            req: express.Request<Record<string, never>, unknown, { targeting: BannerTargeting }>,
+            res: express.Response,
+            next: express.NextFunction,
+        ) => {
             try {
                 const { targeting } = req.body;
                 const params = getQueryParams(req.query);

src/server/api/epicRouter.ts

@@ -74,7 +74,13 @@ export const buildEpicRouter = (
 
             return [...hardcodedTests, ...articleEpicTests.get()];
         } catch (err) {
-            logWarn(`Error getting article epic tests: ${err}`);
+            if (typeof err === 'string') {
+                logWarn(`Error getting article epic tests: ${err}`);
+            } else if (err instanceof Error) {
+                logWarn(`Error getting article epic tests: ${err.message}`);
+            } else {
+                logWarn(`Error getting article epic tests: ${JSON.stringify(err)}`);
+            }
 
             return [];
         }
@@ -198,7 +204,11 @@ export const buildEpicRouter = (
 
     router.post(
         '/epic',
-        (req: express.Request, res: express.Response, next: express.NextFunction): void => {
+        (
+            req: express.Request<Record<string, never>, unknown, { targeting: EpicTargeting }>,
+            res: express.Response,
+            next: express.NextFunction,
+        ): void => {
             try {
                 const epicType: EpicType = 'ARTICLE';
 
@@ -228,7 +238,11 @@ export const buildEpicRouter = (
 
     router.post(
         '/liveblog-epic',
-        (req: express.Request, res: express.Response, next: express.NextFunction) => {
+        (
+            req: express.Request<Record<string, never>, unknown, { targeting: EpicTargeting }>,
+            res: express.Response,
+            next: express.NextFunction,
+        ) => {
             try {
                 const epicType: EpicType = 'LIVEBLOG';
 

src/server/api/gutterRouter.ts

@@ -84,7 +84,11 @@ export const buildGutterRouter = (
     router.post(
         '/gutter-liveblog',
         bodyContainsAllFields(['targeting']),
-        (req: express.Request, res: express.Response, next: express.NextFunction) => {
+        (
+            req: express.Request<Record<string, never>, unknown, { targeting: GutterTargeting }>,
+            res: express.Response,
+            next: express.NextFunction,
+        ) => {
             try {
                 const { targeting } = req.body;
                 const params = getQueryParams(req.query);

src/server/api/headerRouter.ts

@@ -79,7 +79,11 @@ export const buildHeaderRouter = (
     router.post(
         '/header',
         bodyContainsAllFields(['targeting']),
-        (req: express.Request, res: express.Response, next: express.NextFunction) => {
+        (
+            req: express.Request<Record<string, never>, unknown, { targeting: HeaderTargeting }>,
+            res: express.Response,
+            next: express.NextFunction,
+        ) => {
             try {
                 const { targeting } = req.body;
                 const params = getQueryParams(req.query);