refactor(server): cleanup remaining lint rule violations

Author: ethanwu10

server/.eslintrc.js

@@ -23,7 +23,8 @@ module.exports = {
       '@typescript-eslint'
     ],
     rules: {
-      '@typescript-eslint/no-unnecessary-condition': 'error'
+      '@typescript-eslint/no-unnecessary-condition': 'error',
+      '@typescript-eslint/require-await': 'off'
     }
   }, {
     files: ['.eslintrc.js'],

server/challenges/Provider.ts

@@ -9,8 +9,8 @@ export interface Provider extends EventEmitter {
 
     Challenge equality is determined by chall.id.
   */
-  updateChallenge(chall: Challenge): void;
-  deleteChallenge(id: string): void;
+  updateChallenge(chall: Challenge): Promise<void>;
+  deleteChallenge(id: string): Promise<void>;
   cleanup (): void;
 }
 

server/challenges/index.ts

@@ -3,6 +3,7 @@ import path from 'path'
 import { Challenge, CleanedChallenge } from './types'
 import { Provider, ProviderConstructor } from './Provider'
 import { challUpdateEmitter, publishChallUpdate } from '../cache/challs'
+import { EventEmitter } from 'events'
 
 let provider: Provider
 
@@ -41,7 +42,8 @@ void import(path.join('../providers', config.challengeProvider.name))
     provider.on('update', onUpdate)
   })
 
-challUpdateEmitter.on('update', () => {
+// FIXME: remove cast once cache is typed
+;(challUpdateEmitter as EventEmitter).on('update', () => {
   provider.forceUpdate()
 })
 

server/config/server.ts

@@ -80,24 +80,27 @@ export type ServerConfig = {
   loginTimeout: number;
 }
 
-const fileConfigLoaders: Map<string, (file: string) => unknown> = new Map([
-  ['json', file => JSON.parse(file)],
-  ['yaml', file => yaml.parse(file)],
-  ['yml', file => yaml.parse(file)]
+const jsonLoader = (file: string) => JSON.parse(file) as PartialDeep<ServerConfig>
+const yamlLoader = (file: string) => yaml.parse(file) as PartialDeep<ServerConfig>
+
+const fileConfigLoaders: Map<string, (file: string) => PartialDeep<ServerConfig>> = new Map([
+  ['json', jsonLoader],
+  ['yaml', yamlLoader],
+  ['yml', yamlLoader]
 ])
 
 const configPath = process.env.RCTF_CONF_PATH ?? path.join(__dirname, '../../../conf.d')
 const fileConfigs: PartialDeep<ServerConfig>[] = []
 fs.readdirSync(configPath).sort().forEach((name) => {
-  const matched = name.match(/\.(.+)$/)
+  const matched = /\.(.+)$/.exec(name)
   if (matched === null) {
     return
   }
   const loader = fileConfigLoaders.get(matched[1])
   if (loader === undefined) {
     return
   }
-  const config = loader(fs.readFileSync(path.join(configPath, name)).toString()) as PartialDeep<ServerConfig>
+  const config = loader(fs.readFileSync(path.join(configPath, name)).toString())
   fileConfigs.push(config)
 })
 

server/providers/emails/smtp/index.ts

@@ -17,7 +17,7 @@ export default class SmtpProvider implements Provider {
     this.mailer = nodemailer.createTransport(options.smtpUrl)
   }
 
-  send (mail: Mail): Promise<void> {
-    return this.mailer.sendMail(mail)
+  async send (mail: Mail): Promise<void> {
+    await this.mailer.sendMail(mail)
   }
 }

server/providers/uploads/gcs/index.ts

@@ -13,7 +13,7 @@ export default class GcsProvider implements Provider {
 
   constructor (_options: Partial<GcsProviderOptions>) {
     const options: Required<GcsProviderOptions> = {
-      credentials: _options.credentials || JSON.parse(process.env.RCTF_GCS_CREDENTIALS as string),
+      credentials: _options.credentials || JSON.parse(process.env.RCTF_GCS_CREDENTIALS as string) as GcsProviderOptions['credentials'],
       bucketName: _options.bucketName || process.env.RCTF_GCS_BUCKET as string
     }
     // TODO: validate that all options are indeed provided

server/providers/uploads/local/index.ts

@@ -38,16 +38,18 @@ export default class LocalProvider implements Provider {
     this.uploadDirectory = path.resolve(options.uploadDirectory)
     this.endpoint = options.endpoint || '/uploads'
 
-    this.uploadMap = new Map()
+    this.uploadMap = new Map<string, Upload>()
 
-    app.register(async (fastify) => {
-      fastify.register(fastifyStatic, {
+    void app.register(async (fastify) => {
+      void fastify.register(fastifyStatic, {
         root: this.uploadDirectory,
         serve: false
       })
 
+      // Fastify bug #2466
+      // eslint-disable-next-line @typescript-eslint/no-misused-promises
       fastify.setNotFoundHandler(async (req, res) => {
-        res.status(404)
+        void res.status(404)
         return 'Not found'
       })
 
@@ -70,9 +72,9 @@ export default class LocalProvider implements Provider {
 
         const upload = this.uploadMap.get(key)
         if (upload != null) {
-          reply.header('Cache-Control', 'public, max-age=31557600, immutable')
-          reply.header('Content-Disposition', contentDisposition(upload.name))
-          reply.sendFile(path.relative(this.uploadDirectory, upload.filePath))
+          void reply.header('Cache-Control', 'public, max-age=31557600, immutable')
+          void reply.header('Content-Disposition', contentDisposition(upload.name))
+          void reply.sendFile(path.relative(this.uploadDirectory, upload.filePath))
         } else {
           reply.callNotFound()
         }

server/uploads/index.ts

@@ -1,6 +1,6 @@
 import config from '../config/server'
 import path from 'path'
-import { Provider } from './types'
+import { Provider, ProviderConstructor } from './types'
 import { FastifyInstance } from 'fastify'
 
 let provider: Provider | null = null
@@ -10,7 +10,7 @@ export const init = (app: FastifyInstance | null): void => {
 
   // FIXME: use async loading
   // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const ProviderClass = require(path.join('../providers', name)).default
+  const { default: ProviderClass } = require(path.join('../providers', name)) as { default: ProviderConstructor }
 
   provider = new ProviderClass(config.uploadProvider.options ?? {}, app)
 }

server/uploads/types.ts

@@ -1,7 +1,13 @@
+import { FastifyInstance } from 'fastify'
+
 export interface Provider {
   // Returns a string, the url of the uploaded file
   upload (data: Buffer, name: string): Promise<string>;
 
   // Returns a string, the url of the previously uploaded file. Returns null if the file was not previously uploaded.
   getUrl (sha256: string, name: string): Promise<string|null>;
 }
+
+export interface ProviderConstructor {
+  new (options: unknown, app: FastifyInstance | null): Provider
+}

server/util/index.ts

@@ -12,7 +12,7 @@ export * as restrict from './restrict'
  * Perform a deep-copy of a JSON-stringifiable object
  */
 export const deepCopy = <T>(data: T): T => {
-  return JSON.parse(JSON.stringify(data))
+  return JSON.parse(JSON.stringify(data)) as T
 }
 
 export const serveIndex: FastifyPluginAsync<{ indexPath: string; }> = async (fastify, opts) => {
@@ -27,19 +27,21 @@ export const serveIndex: FastifyPluginAsync<{ indexPath: string; }> = async (fas
   })
 
   const routeHandler: RouteHandlerMethod = async (req, reply) => {
-    reply.type('text/html; charset=UTF-8')
-    reply.send(rendered)
+    void reply.type('text/html; charset=UTF-8')
+    void reply.send(rendered)
   }
 
   fastify.get('/', routeHandler)
   fastify.get('/index.html', async (req, reply) => reply.redirect(301, '/'))
   fastify.get('//*', async (req, reply) => reply.redirect(302, '/'))
+  // Fastify bug #2466
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
   fastify.setNotFoundHandler(routeHandler)
 }
 
 // Parse Cloudflare CF-Connecting-IP header
 export const getRealIp = (req: FastifyRequest): string => {
   // Use `get` on req.__proto__ since getRealIp is used in req's getter
-  return req.headers['cf-connecting-ip'] ||
-    Reflect.get(Object.getPrototypeOf(req), 'ip', req)
+  return req.headers['cf-connecting-ip'] as string ||
+    Reflect.get(Object.getPrototypeOf(req), 'ip', req) as string
 }