Updates for auth and index tests.

Author: Jason-Benson

api/src/app.ts

@@ -1,7 +1,7 @@
-import * as express from "express";
-import * as cookieParser from "cookie-parser";
+import express from "express";
+import cookieParser from "cookie-parser";
 import * as path from "path";
-import * as logger from "morgan";
+import logger from "morgan";
 import Config from "./models/Config";
 
 const app = express();

api/src/models/Config.ts

@@ -10,9 +10,9 @@ interface ConfigRecord {
 class Config {
     private static instance: Config;
 
-    protected ini: Record<string, any>;
+    protected ini: ConfigRecord;
 
-    constructor(ini: Record<string, any>) {
+    constructor(ini: ConfigRecord) {
         this.ini = ini;
     }
 
@@ -37,117 +37,117 @@ class Config {
     }
 
     get backendUrl(): string {
-        return this.ini["backend_url"] ?? "http://localhost:9000";
+        return (this.ini["backend_url"] as string) ?? "http://localhost:9000";
     }
 
     get clientUrl(): string {
-        return this.ini["client_url"];
+        return this.ini["client_url"] as string;
     }
 
     get fedoraUsername(): string {
-        return this.ini["fedora_username"];
+        return this.ini["fedora_username"] as string;
     }
 
     get fedoraPassword(): string {
-        return this.ini["fedora_password"];
+        return this.ini["fedora_password"] as string;
     }
 
     get fedoraPidNameSpace(): string {
-        return this.ini["fedora_pid_namespace"];
+        return this.ini["fedora_pid_namespace"] as string;
     }
 
     get ffmpegPath(): string {
-        return this.ini["ffmpeg_path"];
+        return this.ini["ffmpeg_path"] as string;
     }
 
     get fitsCommand(): string {
-        return this.ini["fits_command"];
+        return this.ini["fits_command"] as string;
     }
 
     get sessionKey(): string {
-        return this.ini["session_key"] ?? "vanilla hot cocoa";
+        return (this.ini["session_key"] as string) ?? "vanilla hot cocoa";
     }
 
     get tesseractPath(): string {
-        return this.ini["tesseract_path"];
+        return this.ini["tesseract_path"] as string;
     }
 
     get tesseractAllowedChars(): string {
-        return this.ini["tesseract_allowed_characters"];
+        return this.ini["tesseract_allowed_characters"] as string;
     }
 
     get vufindUrl(): string {
-        return this.ini["vufind_url"] ?? "";
+        return (this.ini["vufind_url"] as string) ?? "";
     }
 
     get pdfDirectory(): string {
-        return this.ini["pdf_directory"];
+        return this.ini["pdf_directory"] as string;
     }
 
     get textcleanerPath(): string {
-        return this.ini["textcleaner_path"];
+        return this.ini["textcleaner_path"] as string;
     }
 
     get textcleanerSwitches(): string {
-        return this.ini["textcleaner_switches"];
+        return this.ini["textcleaner_switches"] as string;
     }
 
     get holdingArea(): string {
-        const holdingArea = this.ini["holding_area_path"];
+        const holdingArea = this.ini["holding_area_path"] as string;
         return holdingArea.endsWith("/") ? holdingArea : holdingArea + "/";
     }
 
     get ocrmypdfPath(): string {
-        return this.ini["ocrmypdf_path"];
+        return this.ini["ocrmypdf_path"] as string;
     }
 
     get processedAreaPath(): string {
-        return this.ini["processed_area_path"];
+        return this.ini["processed_area_path"] as string;
     }
 
     get restBaseUrl(): string {
-        return this.ini["base_url"];
+        return this.ini["base_url"] as string;
     }
 
     get javaPath(): string {
-        return this.ini["java_path"] ?? "java";
+        return (this.ini["java_path"] as string) ?? "java";
     }
 
-    get tikaConfigFile(): string {
-        return this.ini["tika_config_file"] ?? null;
+    get tikaConfigFile(): string | null {
+        return (this.ini["tika_config_file"] as string) ?? null;
     }
 
     get tikaPath(): string {
-        return this.ini["tika_path"];
+        return this.ini["tika_path"] as string;
     }
 
     get solrCore(): string {
-        return this.ini["solr_core"] ?? "biblio";
+        return (this.ini["solr_core"] as string) ?? "biblio";
     }
 
     get solrUrl(): string {
-        return this.ini["solr_url"] ?? "http://localhost:8983/solr";
+        return (this.ini["solr_url"] as string) ?? "http://localhost:8983/solr";
     }
 
     get solrDocumentCacheDir(): boolean | string {
-        return this.ini["solr_document_cache_dir"] ?? false;
+        return (this.ini["solr_document_cache_dir"] as string) ?? false;
     }
 
     get allowedOrigins(): string[] {
-        return this.ini["allowed_origins"] ?? [];
+        return (this.ini["allowed_origins"] as string[]) ?? [];
     }
 
     get pidNamespace(): string {
-        return this.ini["fedora_pid_namespace"] ?? "vudl";
+        return (this.ini["fedora_pid_namespace"] as string) ?? "vudl";
     }
 
     get initialPidValue(): number {
-        return parseInt(this.ini["fedora_initial_pid"] ?? "0");
+        return parseInt((this.ini["fedora_initial_pid"] as string) ?? "0");
     }
 
     get dataModels(): Record<string, string> {
         return (
-            this.ini["data_models"] ?? {
+            (this.ini["data_models"] as Record<string, string>) ?? {
                 Image: "vudl-system:ImageData",
                 PDF: "vudl-system:PDFData",
                 DOC: "vudl-system:DOCData",
@@ -161,7 +161,7 @@ class Config {
 
     get collectionModels(): Record<string, string> {
         return (
-            this.ini["collection_models"] ?? {
+            (this.ini["collection_models"] as Record<string, string>) ?? {
                 List: "vudl-system:ListCollection",
                 Resource: "vudl-system:ResourceCollection",
                 Folder: "vudl-system:FolderCollection",
@@ -170,27 +170,27 @@ class Config {
     }
 
     get institution(): string {
-        return this.ini["institution"] ?? "My University";
+        return (this.ini["institution"] as string) ?? "My University";
     }
 
     get collection(): string {
-        return this.ini["collection"] ?? "Digital Library";
+        return (this.ini["collection"] as string) ?? "Digital Library";
     }
 
     get topLevelPids(): Array<string> {
-        return this.ini["top_level_pids"] ?? [];
+        return (this.ini["top_level_pids"] as string[]) ?? [];
     }
 
     get articlesToStrip(): Array<string> {
-        return this.ini["articles_to_strip"] ?? [];
+        return (this.ini["articles_to_strip"] as string[]) ?? [];
     }
 
     get trashPid(): string | null {
-        return this.ini["trash_pid"] ?? null;
+        return (this.ini["trash_pid"] as string) ?? null;
     }
 
     get favoritePids(): Array<string> {
-        const favorites = this.ini["favorite_pids"] ?? [];
+        const favorites = (this.ini["favorite_pids"] as string[]) ?? [];
         const trash = this.trashPid;
         if (trash && !favorites.includes(trash)) {
             favorites.push(trash);
@@ -199,19 +199,19 @@ class Config {
     }
 
     get languageMap(): Record<string, string> {
-        return this.ini["LanguageMap"] ?? {};
+        return (this.ini["LanguageMap"] as Record<string, string>) ?? {};
     }
 
     get minimumValidYear(): number {
-        return parseInt(this.ini["minimum_valid_year"] ?? 1000);
+        return parseInt((this.ini["minimum_valid_year"] as string) ?? "1000");
     }
 
     get models(): Record<string, FedoraModel> {
-        return this.ini["models"] || {};
+        return (this.ini["models"] as unknown as Record<string, FedoraModel>) || {};
     }
 
     get databaseSettings(): ConfigRecord {
-        return this.ini["Database"] ?? {};
+        return (this.ini["Database"] as ConfigRecord) ?? {};
     }
 
     get databaseClient(): string {
@@ -223,7 +223,7 @@ class Config {
     }
 
     get authenticationSettings(): ConfigRecord {
-        return this.ini["Authentication"] ?? [];
+        return (this.ini["Authentication"] as ConfigRecord) ?? {};
     }
 
     get authenticationStrategy(): string {
@@ -263,88 +263,88 @@ class Config {
     }
 
     get licenses(): Record<string, License> {
-        return this.ini["licenses"] ?? {};
+        return (this.ini["licenses"] as unknown as Record<string, License>) ?? {};
     }
 
     get agentDefaults(): Record<string, string> {
-        return this.ini?.["agent"]?.["defaults"] ?? {};
+        return ((this.ini["agent"] as ConfigRecord)?.["defaults"] as Record<string, string>) ?? {};
     }
 
     get agentRoles(): Array<string> {
-        return this.ini?.["agent"]?.["roles"] ?? [];
+        return ((this.ini["agent"] as ConfigRecord)?.["roles"] as string[]) ?? [];
     }
 
     get agentTypes(): Array<string> {
-        return this.ini?.["agent"]?.["types"] ?? [];
+        return ((this.ini["agent"] as ConfigRecord)?.["types"] as string[]) ?? [];
     }
 
     get dublinCoreFields(): Record<string, Record<string, string | Array<string>>> {
-        return this.ini?.["dublin_core"] ?? {};
+        return (this.ini["dublin_core"] as Record<string, Record<string, string | Array<string>>>) ?? {};
     }
 
     get redisConnectionSettings(): Record<string, string> {
-        return this.ini?.["queue"]?.["connection"] ?? {};
+        return ((this.ini["queue"] as ConfigRecord)?.["connection"] as Record<string, string>) ?? {};
     }
 
     get redisDefaultQueueName(): string {
-        return this.ini?.["queue"]?.["defaultQueueName"] ?? "vudl";
+        return ((this.ini["queue"] as ConfigRecord)?.["defaultQueueName"] as string) ?? "vudl";
     }
 
     get redisQueueJobMap(): Record<string, string> {
-        return this.ini?.["queue"]?.["jobMap"] ?? {};
+        return ((this.ini["queue"] as ConfigRecord)?.["jobMap"] as Record<string, string>) ?? {};
     }
 
     get redisLockDuration(): number {
-        return parseInt(this.ini?.["queue"]?.["lockDuration"] ?? "30000");
+        return parseInt(((this.ini["queue"] as ConfigRecord)?.["lockDuration"] as string) ?? "30000");
     }
 
     get processMetadataDefaults(): Record<string, string> {
-        return this.ini?.["process_metadata_defaults"] ?? {};
+        return (this.ini["process_metadata_defaults"] as Record<string, string>) ?? {};
     }
 
     get toolPresets(): Array<Record<string, string>> {
-        return this.ini?.["tool_presets"] ?? [];
+        return (this.ini["tool_presets"] as unknown as Array<Record<string, string>>) ?? [];
     }
 
     get sharpOptions(): Record<string, unknown> {
-        const pixelLimit = this.ini?.["sharp"]?.["limitInputPixels"] ?? "268402689";
+        const pixelLimit = ((this.ini["sharp"] as ConfigRecord)?.["limitInputPixels"] as string) ?? "268402689";
         return {
             limitInputPixels: parseInt(pixelLimit),
         };
     }
 
     get max409Retries(): number {
-        return this.ini["max_409_retries"] ?? 3;
+        return (this.ini["max_409_retries"] as unknown as number) ?? 3;
     }
 
     get maxUploadSize(): number {
-        return this.ini?.["upload"]?.["sizeLimit"] ?? 200 * 1024 * 1024;
+        return ((this.ini["upload"] as ConfigRecord)?.["sizeLimit"] as unknown as number) ?? 200 * 1024 * 1024;
     }
 
     get notifyMethod(): string {
-        return this.ini?.["notify"]?.["method"] ?? "ntfy";
+        return ((this.ini["notify"] as ConfigRecord)?.["method"] as string) ?? "ntfy";
     }
 
     get ntfyConfig(): Record<string, string> {
         return {
-            defaultChannel: this.ini?.["notify"]?.["ntfy_defaultChannel"] ?? "vudl-ntfy",
+            defaultChannel: ((this.ini["notify"] as ConfigRecord)?.["ntfy_defaultChannel"] as string) ?? "vudl-ntfy",
         };
     }
 
     get indexerLockRetries(): number {
-        return parseInt(this.ini?.["indexer"]?.["lockRetries"] ?? 60);
+        return parseInt(((this.ini["indexer"] as ConfigRecord)?.["lockRetries"] as string) ?? "60");
     }
 
     get indexerLockWaitMs(): number {
-        return parseInt(this.ini?.["indexer"]?.["lockWaitMs"] ?? 1000);
+        return parseInt(((this.ini["indexer"] as ConfigRecord)?.["lockWaitMs"] as string) ?? "1000");
     }
 
     get indexerExceptionRetries(): number {
-        return parseInt(this.ini?.["indexer"]?.["exceptionRetries"] ?? 10);
+        return parseInt(((this.ini["indexer"] as ConfigRecord)?.["exceptionRetries"] as string) ?? "10");
     }
 
     get indexerExceptionWaitMs(): number {
-        return parseInt(this.ini?.["indexer"]?.["exceptionWaitMs"] ?? 500);
+        return parseInt(((this.ini["indexer"] as ConfigRecord)?.["exceptionWaitMs"] as string) ?? "500");
     }
 }
 

api/src/models/Job.ts

@@ -2,6 +2,7 @@ import { createWriteStream, openSync, closeSync, existsSync as fileExists, statS
 import PDFDocument = require("pdfkit");
 
 declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace -- augmenting @types/pdfkit's ambient PDFKit namespace, not organizing our own code
     namespace PDFKit {
         interface PDFKitImage {
             width: number;

api/src/routes/auth.test.ts

@@ -1,5 +1,5 @@
 import * as request from "supertest";
-import * as session from "express-session";
+import session from "express-session";
 import { StatusCodes } from "http-status-codes";
 import app from "../app";
 import { getAuthRouter } from "./auth";

api/src/routes/index.test.ts

@@ -1,4 +1,4 @@
-import * as request from "supertest";
+import request from "supertest";
 import { StatusCodes } from "http-status-codes";
 import app from "../app";
 import index from "./index";

api/src/server.ts

@@ -4,7 +4,7 @@
 
 import * as http from "http";
 import * as passport from "passport";
-import * as session from "express-session";
+import session from "express-session";
 import debug from "debug";
 
 import app from "./app";