Setup eslint and enforce rules

2021-06-02 22:36:25 -05:00
parent 82e7a1f299
commit 1d5056b753
149 changed files with 6104 additions and 3114 deletions
--- a/src/http/kernel/module/AbstractResolvedRouteHandlerHTTPModule.ts
+++ b/src/http/kernel/module/AbstractResolvedRouteHandlerHTTPModule.ts
@@ -1,9 +1,9 @@
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {ResponseObject} from "../../routing/Route";
-import {Request} from "../../lifecycle/Request";
-import {plaintext} from "../../response/StringResponseFactory";
-import {ResponseFactory} from "../../response/ResponseFactory";
-import {json} from "../../response/JSONResponseFactory";
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {ResponseObject} from '../../routing/Route'
+import {Request} from '../../lifecycle/Request'
+import {plaintext} from '../../response/StringResponseFactory'
+import {ResponseFactory} from '../../response/ResponseFactory'
+import {json} from '../../response/JSONResponseFactory'

 /**
 * Base class for HTTP kernel modules that apply some response from a route handler to the request.
@@ -15,7 +15,7 @@ export abstract class AbstractResolvedRouteHandlerHTTPModule extends HTTPKernelM
     * @param request
     * @protected
     */
-    protected async applyResponseObject(object: ResponseObject, request: Request) {
+    protected async applyResponseObject(object: ResponseObject, request: Request): Promise<void> {
        if ( (typeof object === 'string') || (typeof object === 'number') ) {
            object = plaintext(String(object))
        }
--- a/src/http/kernel/module/ExecuteResolvedRouteHandlerHTTPModule.ts
+++ b/src/http/kernel/module/ExecuteResolvedRouteHandlerHTTPModule.ts
@@ -1,10 +1,10 @@
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {ActivatedRoute} from "../../routing/ActivatedRoute";
-import {ResponseObject} from "../../routing/Route";
-import {http} from "../../response/HTTPErrorResponseFactory";
-import {HTTPStatus} from "../../../util";
-import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {ActivatedRoute} from '../../routing/ActivatedRoute'
+import {ResponseObject} from '../../routing/Route'
+import {http} from '../../response/HTTPErrorResponseFactory'
+import {HTTPStatus} from '../../../util'
+import {AbstractResolvedRouteHandlerHTTPModule} from './AbstractResolvedRouteHandlerHTTPModule'

 /**
 * HTTP kernel module that runs the handler for the request's route.
@@ -12,14 +12,14 @@ import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHan
 * In most cases, this is the controller method defined by the route.
 */
 export class ExecuteResolvedRouteHandlerHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).core()
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        if ( request.hasInstance(ActivatedRoute) ) {
            const route = <ActivatedRoute> request.make(ActivatedRoute)
-            let object: ResponseObject = await route.handler(request)
+            const object: ResponseObject = await route.handler(request)

            await this.applyResponseObject(object, request)
        } else {
--- a/src/http/kernel/module/ExecuteResolvedRoutePostflightHTTPModule.ts
+++ b/src/http/kernel/module/ExecuteResolvedRoutePostflightHTTPModule.ts
@@ -1,9 +1,9 @@
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {ActivatedRoute} from "../../routing/ActivatedRoute";
-import {ResponseObject} from "../../routing/Route";
-import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
-import {PersistSessionHTTPModule} from "./PersistSessionHTTPModule";
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {ActivatedRoute} from '../../routing/ActivatedRoute'
+import {ResponseObject} from '../../routing/Route'
+import {AbstractResolvedRouteHandlerHTTPModule} from './AbstractResolvedRouteHandlerHTTPModule'
+import {PersistSessionHTTPModule} from './PersistSessionHTTPModule'

 /**
 * HTTP kernel module that executes the postflight handlers for the route.
@@ -11,18 +11,18 @@ import {PersistSessionHTTPModule} from "./PersistSessionHTTPModule";
 * Usually, this is post middleware.
 */
 export class ExecuteResolvedRoutePostflightHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).before(PersistSessionHTTPModule)
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        if ( request.hasInstance(ActivatedRoute) ) {
            const route = <ActivatedRoute> request.make(ActivatedRoute)
            const postflight = route.postflight

            for ( const handler of postflight ) {
                const result: ResponseObject = await handler(request)
-                if ( typeof result !== "undefined" ) {
+                if ( typeof result !== 'undefined' ) {
                    await this.applyResponseObject(result, request)
                    request.response.blockingWriteback(true)
                }
--- a/src/http/kernel/module/ExecuteResolvedRoutePreflightHTTPModule.ts
+++ b/src/http/kernel/module/ExecuteResolvedRoutePreflightHTTPModule.ts
@@ -1,9 +1,9 @@
-import {HTTPKernel} from "../HTTPKernel";
-import {MountActivatedRouteHTTPModule} from "./MountActivatedRouteHTTPModule";
-import {Request} from "../../lifecycle/Request";
-import {ActivatedRoute} from "../../routing/ActivatedRoute";
-import {ResponseObject} from "../../routing/Route";
-import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
+import {HTTPKernel} from '../HTTPKernel'
+import {MountActivatedRouteHTTPModule} from './MountActivatedRouteHTTPModule'
+import {Request} from '../../lifecycle/Request'
+import {ActivatedRoute} from '../../routing/ActivatedRoute'
+import {ResponseObject} from '../../routing/Route'
+import {AbstractResolvedRouteHandlerHTTPModule} from './AbstractResolvedRouteHandlerHTTPModule'

 /**
 * HTTP Kernel module that executes the preflight handlers for the route.
@@ -11,18 +11,18 @@ import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHan
 * Usually, this is the pre middleware.
 */
 export class ExecuteResolvedRoutePreflightHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).after(MountActivatedRouteHTTPModule)
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        if ( request.hasInstance(ActivatedRoute) ) {
            const route = <ActivatedRoute> request.make(ActivatedRoute)
            const preflight = route.preflight

            for ( const handler of preflight ) {
                const result: ResponseObject = await handler(request)
-                if ( typeof result !== "undefined" ) {
+                if ( typeof result !== 'undefined' ) {
                    await this.applyResponseObject(result, request)
                    request.response.blockingWriteback(true)
                }
--- a/src/http/kernel/module/InjectSessionHTTPModule.ts
+++ b/src/http/kernel/module/InjectSessionHTTPModule.ts
@@ -1,11 +1,11 @@
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {Injectable} from "../../../di"
-import {ErrorWithContext} from "../../../util"
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {SetSessionCookieHTTPModule} from "./SetSessionCookieHTTPModule";
-import {SessionFactory} from "../../session/SessionFactory";
-import {Session} from "../../session/Session";
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {Injectable} from '../../../di'
+import {ErrorWithContext} from '../../../util'
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {SetSessionCookieHTTPModule} from './SetSessionCookieHTTPModule'
+import {SessionFactory} from '../../session/SessionFactory'
+import {Session} from '../../session/Session'

 /**
 * HTTP kernel middleware that creates the session using the configured driver
@@ -15,11 +15,11 @@ import {Session} from "../../session/Session";
 export class InjectSessionHTTPModule extends HTTPKernelModule {
    public readonly executeWithBlockingWriteback = true

-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).after(SetSessionCookieHTTPModule)
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        request.registerFactory(new SessionFactory())

        const session = <Session> request.make(Session)
--- a/src/http/kernel/module/MountActivatedRouteHTTPModule.ts
+++ b/src/http/kernel/module/MountActivatedRouteHTTPModule.ts
@@ -1,10 +1,10 @@
-import {Injectable, Inject} from "../../../di"
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {Routing} from "../../../service/Routing";
-import {ActivatedRoute} from "../../routing/ActivatedRoute";
-import {Logging} from "../../../service/Logging";
+import {Injectable, Inject} from '../../../di'
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {Routing} from '../../../service/Routing'
+import {ActivatedRoute} from '../../routing/ActivatedRoute'
+import {Logging} from '../../../service/Logging'

 /**
 * HTTP kernel middleware that tries to find a registered route matching the request's
@@ -20,7 +20,7 @@ export class MountActivatedRouteHTTPModule extends HTTPKernelModule {
    @Inject()
    protected readonly logging!: Logging

-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).before()
    }

--- a/src/http/kernel/module/ParseIncomingBodyHTTPModule.ts
+++ b/src/http/kernel/module/ParseIncomingBodyHTTPModule.ts
@@ -1,16 +1,16 @@
-import {HTTPKernelModule} from "../HTTPKernelModule"
-import {HTTPKernel} from "../HTTPKernel"
-import * as Busboy from "busboy"
-import {Request} from "../../lifecycle/Request"
-import {infer, uuid_v4} from "../../../util"
-import {Files} from "../../../service/Files"
-import {Config} from "../../../service/Config"
-import {Logging} from "../../../service/Logging"
-import {Injectable, Inject, Container} from "../../../di"
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {HTTPKernel} from '../HTTPKernel'
+import * as Busboy from 'busboy'
+import {Request} from '../../lifecycle/Request'
+import {infer, uuid4} from '../../../util'
+import {Files} from '../../../service/Files'
+import {Config} from '../../../service/Config'
+import {Logging} from '../../../service/Logging'
+import {Injectable, Inject, Container} from '../../../di'

@Injectable()
 export class ParseIncomingBodyHTTPModule extends HTTPKernelModule {
-    static register(kernel: HTTPKernel) {
+    static register(kernel: HTTPKernel): void {
        const files = <Files> Container.getContainer().make(Files)
        const logging = <Logging> Container.getContainer().make(Logging)
        if ( !files.hasFilesystem() ) {
@@ -32,8 +32,11 @@ export class ParseIncomingBodyHTTPModule extends HTTPKernelModule {
    public async apply(request: Request): Promise<Request> {
        const contentType = request.getHeader('content-type')
        const contentTypes = (Array.isArray(contentType) ? contentType : [contentType])
-            .filter(Boolean).map(x => x!.toLowerCase().split(';')[0])
-        if ( !contentType ) return request
+            .filter(Boolean).map(x => String(x).toLowerCase()
+                .split(';')[0])
+        if ( !contentType ) {
+            return request
+        }

        if (
            contentTypes.includes('multipart/form-data')
@@ -65,7 +68,10 @@ export class ParseIncomingBodyHTTPModule extends HTTPKernelModule {
                try {
                    const body = JSON.parse(data)
                    for ( const key in body ) {
-                        if ( !body.hasOwnProperty(key) ) continue
+                        if ( !Object.prototype.hasOwnProperty.call(body, key) ) {
+                            continue
+                        }
+
                        request.parsedInput[key] = body[key]
                    }
                    res()
@@ -94,8 +100,10 @@ export class ParseIncomingBodyHTTPModule extends HTTPKernelModule {
                request.parsedInput[field] = infer(val)
            })

-            busboy.on('file', async (field, file, filename, encoding, mimetype) => {
-                if ( !this.files.hasFilesystem() ) return
+            busboy.on('file', async (field, file, filename, encoding, mimetype) => {  // eslint-disable-line max-params
+                if ( !this.files.hasFilesystem() ) {
+                    return
+                }

                if ( !config?.enable ) {
                    this.logging.warn(`Skipping uploaded file '${filename}' because uploading is disabled. Set the server.uploads.enable config to allow uploads.`)
@@ -122,7 +130,7 @@ export class ParseIncomingBodyHTTPModule extends HTTPKernelModule {
                }

                const fs = this.files.getFilesystem()
-                const storePath = `${config.filesystemPrefix ? config.filesystemPrefix : ''}${(config.filesystemPrefix && !config.filesystemPrefix.endsWith('/')) ? '/' : ''}${field}-${uuid_v4()}`
+                const storePath = `${config.filesystemPrefix ? config.filesystemPrefix : ''}${(config.filesystemPrefix && !config.filesystemPrefix.endsWith('/')) ? '/' : ''}${field}-${uuid4()}`
                this.logging.verbose(`Uploading file in field ${field} to ${fs.getPrefix()}${storePath}`)
                file.pipe(await fs.putStoreFileAsStream({ storePath }))  // FIXME might need to revisit this to ensure we don't res() before pipe finishes

--- a/src/http/kernel/module/PersistSessionHTTPModule.ts
+++ b/src/http/kernel/module/PersistSessionHTTPModule.ts
@@ -1,8 +1,8 @@
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {Injectable} from "../../../di"
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {Session} from "../../session/Session";
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {Injectable} from '../../../di'
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {Session} from '../../session/Session'

 /**
 * HTTP kernel module that runs after the main logic in the request to persist
@@ -12,7 +12,7 @@ import {Session} from "../../session/Session";
 export class PersistSessionHTTPModule extends HTTPKernelModule {
    public readonly executeWithBlockingWriteback = true

-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).last()
    }

--- a/src/http/kernel/module/PoweredByHeaderInjectionHTTPModule.ts
+++ b/src/http/kernel/module/PoweredByHeaderInjectionHTTPModule.ts
@@ -1,8 +1,8 @@
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {Request} from "../../lifecycle/Request";
-import {Injectable, Inject} from "../../../di"
-import {HTTPKernel} from "../HTTPKernel";
-import {Config} from "../../../service/Config";
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {Request} from '../../lifecycle/Request'
+import {Injectable, Inject} from '../../../di'
+import {HTTPKernel} from '../HTTPKernel'
+import {Config} from '../../../service/Config'

 /**
 * HTTP kernel middleware that sets the `X-Powered-By` header.
@@ -14,11 +14,11 @@ export class PoweredByHeaderInjectionHTTPModule extends HTTPKernelModule {
    @Inject()
    protected readonly config!: Config;

-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).after()
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        if ( !this.config.get('server.poweredBy.hide', false) ) {
            request.response.setHeader('X-Powered-By', this.config.get('server.poweredBy.header', 'Extollo'))
        }
--- a/src/http/kernel/module/SetSessionCookieHTTPModule.ts
+++ b/src/http/kernel/module/SetSessionCookieHTTPModule.ts
@@ -1,9 +1,9 @@
-import {HTTPKernelModule} from "../HTTPKernelModule";
-import {Injectable, Inject} from "../../../di";
-import {uuid_v4} from "../../../util";
-import {HTTPKernel} from "../HTTPKernel";
-import {Request} from "../../lifecycle/Request";
-import {Logging} from "../../../service/Logging";
+import {HTTPKernelModule} from '../HTTPKernelModule'
+import {Injectable, Inject} from '../../../di'
+import {uuid4} from '../../../util'
+import {HTTPKernel} from '../HTTPKernel'
+import {Request} from '../../lifecycle/Request'
+import {Logging} from '../../../service/Logging'

 /**
 * HTTP kernel middleware that tries to look up the session ID from the request.
@@ -16,13 +16,13 @@ export class SetSessionCookieHTTPModule extends HTTPKernelModule {
    @Inject()
    protected readonly logging!: Logging

-    public static register(kernel: HTTPKernel) {
+    public static register(kernel: HTTPKernel): void {
        kernel.register(this).first()
    }

-    public async apply(request: Request) {
+    public async apply(request: Request): Promise<Request> {
        if ( !request.cookies.has('extollo.session') ) {
-            const session = `${uuid_v4()}-${uuid_v4()}`
+            const session = `${uuid4()}-${uuid4()}`

            this.logging.verbose(`Starting session: ${session}`)
            request.cookies.set('extollo.session', session)