feat: add option type validation

Author: Sebastian-Webster

src/constants.ts

@@ -1,5 +1,94 @@
-const CONSTANTS = {
-    MIN_SUPPORTED_MYSQL: '8.0.20'
-}
+import { InternalServerOptions, OptionTypeChecks } from "../types";
+import { randomUUID } from "crypto";
+import {normalize as normalizePath} from 'path'
+import { tmpdir } from "os";
 
-export default CONSTANTS
+export const MIN_SUPPORTED_MYSQL = '8.0.20';
+
+export const DEFAULT_OPTIONS: InternalServerOptions = {
+    dbName: 'dbdata',
+    logLevel: 'ERROR',
+    portRetries: 10,
+    downloadBinaryOnce: true,
+    lockRetries: 1_000,
+    lockRetryWait: 1_000,
+    username: 'root',
+    deleteDBAfterStopped: true,
+    //mysqlmsn = MySQL Memory Server Node.js
+    dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
+    ignoreUnsupportedSystemVersion: false,
+    port: 0,
+    xPort: 0,
+    binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`,
+    downloadRetries: 10,
+    initSQLString: ''
+} as const;
+
+export const LOG_LEVELS = {
+    'LOG': 0,
+    'WARN': 1,
+    'ERROR': 2
+} as const;
+
+export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
+    dbName: {
+        check: (opt: any) => typeof opt === 'string' && opt.length <= 64,
+        errorMessage: 'Option dbName must be a string and must not be longer than 64 characters.'
+    },
+    logLevel: {
+        check: (opt: any) => Object.keys(LOG_LEVELS).includes(opt),
+        errorMessage: 'Option logLevel must be either "LOG", "WARN", or "ERROR".'
+    },
+    portRetries: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0,
+        errorMessage: 'Option portRetries must be a positive number or 0.'
+    },
+    downloadBinaryOnce: {
+        check: (opt: any) => typeof opt === 'boolean',
+        errorMessage: 'Option downloadBinaryOnce must be a boolean.'
+    },
+    lockRetries: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0,
+        errorMessage: 'Option lockRetries must be a positive number or 0.'
+    },
+    lockRetryWait: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0,
+        errorMessage: 'Option lockRetryWait must be a positive number or 0.'
+    },
+    username: {
+        check: (opt: any) => typeof opt === 'string' && opt.length <= 32,
+        errorMessage: 'Option username must be a string and must not be longer than 32 characters.'
+    },
+    _DO_NOT_USE_deleteDBAfterStopped: {
+        check: (opt: any) => typeof opt === 'boolean',
+        errorMessage: 'Option _DO_NOT_USE_deleteDBAfterStopped must be a boolean.'
+    },
+    _DO_NOT_USE_dbPath: {
+        check: (opt: any) => typeof opt === 'string',
+        errorMessage: 'Option _DO_NOT_USE_dbPath must be a string.'
+    },
+    ignoreUnsupportedSystemVersion: {
+        check: (opt: any) => typeof opt === 'boolean',
+        errorMessage: 'Option ignoreUnsupportedSystemVersion must be a boolean.'
+    },
+    port: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0 && opt <= 65535,
+        errorMessage: 'Option port must be a number and between 0 and 65535 inclusive.'
+    },
+    xPort: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0 && opt <= 65535,
+        errorMessage: 'Option xPort must be a number and between 0 and 65535 inclusive.'
+    },
+    _DO_NOT_USE_binaryDirectoryPath: {
+        check: (opt: any) => typeof opt === 'string',
+        errorMessage: 'Option _DO_NOT_USE_binaryDirectoryPath must be a string.'
+    },
+    downloadRetries: {
+        check: (opt: any) => typeof opt === 'number' && opt >= 0,
+        errorMessage: 'Option downloadRetries must be a positive number or 0.'
+    },
+    initSQLString: {
+        check: (opt: any) => typeof opt === 'string',
+        errorMessage: 'Option initSQLString must be a string.'
+    }
+} as const;

src/index.ts

@@ -2,35 +2,13 @@ import Logger from './libraries/Logger'
 import * as os from 'node:os'
 import Executor from "./libraries/Executor"
 import { satisfies, lt } from "semver"
-import DBDestroySignal from "./libraries/AbortSignal"
 import { BinaryInfo, InternalServerOptions, ServerOptions } from '../types'
 import getBinaryURL from './libraries/Version'
 import MySQLVersions from './versions.json'
 import { downloadBinary } from './libraries/Downloader'
-import { randomUUID } from "crypto";
-import {normalize as normalizePath} from 'path'
-import CONSTANTS from './constants'
+import { MIN_SUPPORTED_MYSQL, DEFAULT_OPTIONS, OPTION_TYPE_CHECKS } from './constants'
 
 export async function createDB(opts?: ServerOptions) {
-    const defaultOptions: InternalServerOptions = {
-        dbName: 'dbdata',
-        logLevel: 'ERROR',
-        portRetries: 10,
-        downloadBinaryOnce: true,
-        lockRetries: 1_000,
-        lockRetryWait: 1_000,
-        username: 'root',
-        deleteDBAfterStopped: true,
-        //mysqlmsn = MySQL Memory Server Node.js
-        dbPath: normalizePath(`${os.tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
-        ignoreUnsupportedSystemVersion: false,
-        port: 0,
-        xPort: 0,
-        binaryDirectoryPath: `${os.tmpdir()}/mysqlmsn/binaries`,
-        downloadRetries: 10,
-        initSQLString: ''
-    }
-
     const suppliedOpts = opts || {};
     const suppliedOptsKeys = Object.keys(suppliedOpts);
     const internalOpts = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath'];
@@ -40,24 +18,31 @@ export async function createDB(opts?: ServerOptions) {
             console.warn(`[ mysql-memory-server - Options WARN ]: Creating MySQL database with option ${opt}. This is considered unstable and should not be used externally. Please consider removing this option.`)
         }
     }
+
+    for (const opt of suppliedOptsKeys) {
+        if (suppliedOpts[opt] !== undefined && !OPTION_TYPE_CHECKS[opt].check(suppliedOpts[opt])) {
+            //Supplied option failed the check
+            throw OPTION_TYPE_CHECKS[opt].errorMessage
+        }
+    }
 
-    const options: InternalServerOptions = {...defaultOptions, ...opts}
+    const options: InternalServerOptions = {...DEFAULT_OPTIONS, ...opts}
 
     const logger = new Logger(options.logLevel)
 
     const executor = new Executor(logger)
 
     const version = await executor.getMySQLVersion(options.version)
 
-    const unsupportedMySQLIsInstalled = version && lt(version.version, CONSTANTS.MIN_SUPPORTED_MYSQL)
+    const unsupportedMySQLIsInstalled = version && lt(version.version, MIN_SUPPORTED_MYSQL)
 
     const throwUnsupportedError = unsupportedMySQLIsInstalled && !options.ignoreUnsupportedSystemVersion && !options.version
 
     if (throwUnsupportedError) {
         throw `A version of MySQL is installed on your system that is not supported by this package. If you want to download a MySQL binary instead of getting this error, please set the option "ignoreUnsupportedSystemVersion" to true.`
     }
 
-    if (options.version && lt(options.version, CONSTANTS.MIN_SUPPORTED_MYSQL)) {
+    if (options.version && lt(options.version, MIN_SUPPORTED_MYSQL)) {
         //The difference between the throw here and the throw above is this throw is because the selected "version" is not supported.
         //The throw above is because the system-installed MySQL is out of date and "ignoreUnsupportedSystemVersion" is not set to true.
         throw `The selected version of MySQL (${options.version}) is not currently supported by this package. Please choose a different version to use.`

src/libraries/Logger.ts

@@ -1,10 +1,5 @@
 import { LOG_LEVEL } from "../../types";
-
-const LOG_LEVELS = {
-    'LOG': 0,
-    'WARN': 1,
-    'ERROR': 2
-}
+import { LOG_LEVELS } from "../constants";
 
 class Logger {
     LOG_LEVEL: number;

types/index.ts

@@ -76,4 +76,11 @@ export type InstalledMySQLVersion = {
 export type BinaryInfo = {
     url: string,
     version: string
+}
+
+export type OptionTypeChecks = {
+    [key in keyof ServerOptions]: {
+        check: (opt: any) => boolean,
+        errorMessage: string
+    }
 }