add console messages for shutting down the database

Author: Sebastian-Webster

README.md

@@ -213,28 +213,38 @@ The internal queries that are ran before the queries in ```initSQLString``` are
 ***
 ### :warning: Internal Options :warning:
 
-The following options are only meant for internal debugging use. Their behaviour may change or they may get removed between major/minor/patch versions and they are not to be considered stable. The options below will not follow Semantic Versioning so it is advised to not use them.
+The following options are only meant for internal use (such as CI or the internals for running this package via the CLI). Their behaviour may change or they may get removed between major/minor/patch versions and they are not to be considered stable. The options below will not follow Semantic Versioning so it is advised to not use them.
 
 - `_DO_NOT_USE_deleteDBAfterStopped: boolean`
 
-Required: No
-
 Default: true
 
 Description: Changes whether or not the database will be deleted after it has been stopped. If set to `true`, the database WILL be deleted after it has been stopped.
 
 - `_DO_NOT_USE_dbPath: string`
 
-Required: No
-
 Default: `TMPDIR/mysqlmsn/dbs/UUID` (replacing TMPDIR with the OS temp directory and UUID with a UUIDv4 without seperating dashes).
 
 Description: The folder to store database-related data in
 
 - `_DO_NOT_USE_binaryDirectoryPath: string`
 
-Required: No
-
 Default: `TMPDIR/mysqlmsn/binaries` (replacing TMPDIR with the OS temp directory)
 
 Description: The folder to store the MySQL binaries when they are downloaded from the CDN.
+
+- `_DO_NOT_USE_beforeSignalCleanupMessage: string`
+
+Required: No
+
+Default: undefined
+
+Description: The message to get displayed in the console before the cleanup that happens when the Node.js process is stopped without the ```stop()``` method being called first.
+
+- `_DO_NOT_USE_afterSignalCleanupMessage: string`
+
+Required: No
+
+Default: undefined
+
+Description: The message to get displayed in the console after the cleanup that happens when the Node.js process is stopped without the ```stop()``` method being called first.

src/cli.ts

@@ -4,7 +4,10 @@ import { OPTION_TYPE_CHECKS } from "./constants";
 
 async function main() {
     const definedOptions = process.argv.filter((option) => option.startsWith('--'))
-    const options = {}
+    const options = {
+        _DO_NOT_USE_beforeSignalCleanupMessage: 'Shutting down the epehemeral MySQL database and cleaning all related files...',
+        _DO_NOT_USE_afterSignalCleanupMessage: 'Shutdown and cleanup is complete.'
+    }
     for (const opt of definedOptions) {
         const index = process.argv.indexOf(opt)
         const optionValue = process.argv[index + 1]

src/constants.ts

@@ -23,7 +23,9 @@ export const DEFAULT_OPTIONS_GENERATOR: () => InternalServerOptions = () => ({
     _DO_NOT_USE_deleteDBAfterStopped: true,
     //mysqlmsn = MySQL Memory Server Node.js
     _DO_NOT_USE_dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
-    _DO_NOT_USE_binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`
+    _DO_NOT_USE_binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`,
+    _DO_NOT_USE_beforeSignalCleanupMessage: '',
+    _DO_NOT_USE_afterSignalCleanupMessage: ''
 });
 
 export const DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(DEFAULT_OPTIONS_GENERATOR()))
@@ -34,7 +36,7 @@ export const LOG_LEVELS = {
     'ERROR': 2
 } as const;
 
-export const INTERNAL_OPTIONS = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath'] as const;
+export const INTERNAL_OPTIONS = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath', '_DO_NOT_USE_beforeSignalCleanup', '_DO_NOT_USE_afterSignalCleanup'] as const;
 
 export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
     version: {
@@ -116,5 +118,15 @@ export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
         check: (opt: any) => opt === undefined || typeof opt === 'string',
         errorMessage: 'Option _DO_NOT_USE_binaryDirectoryPath must be either undefined or a string.',
         definedType: 'string'
+    },
+    _DO_NOT_USE_beforeSignalCleanupMessage: {
+        check: (opt: any) => opt === undefined || typeof opt === 'string',
+        errorMessage: 'Option _DO_NOT_USE_beforeSignalCleanup must be either undefined or a string.',
+        definedType: 'string'
+    },
+    _DO_NOT_USE_afterSignalCleanupMessage: {
+        check: (opt: any) => opt === undefined || typeof opt === 'string',
+        errorMessage: 'Option _DO_NOT_USE_afterSignalCleanup must be either undefined or a string.',
+        definedType: 'string'
     }
 } as const;

src/libraries/Executor.ts

@@ -421,6 +421,10 @@ class Executor {
 
     async startMySQL(options: InternalServerOptions, binaryFilepath: string): Promise<MySQLDB> {
         this.removeExitHandler = onExit(() => {
+            if (options._DO_NOT_USE_beforeSignalCleanupMessage) {
+                console.log(options._DO_NOT_USE_beforeSignalCleanupMessage)
+            }
+
             this.DBDestroySignal.abort()
 
             if (options._DO_NOT_USE_deleteDBAfterStopped) {
@@ -439,6 +443,10 @@ class Executor {
                     this.logger.error('An error occurred while deleting database binary:', e)
                 }
             }
+
+            if (options._DO_NOT_USE_afterSignalCleanupMessage) {
+                console.log(options._DO_NOT_USE_afterSignalCleanupMessage)
+            }
         })
 
         let retries = 0;

types/index.ts

@@ -18,7 +18,9 @@ export type ServerOptions = {
     initSQLString?: string | undefined
     _DO_NOT_USE_deleteDBAfterStopped?: boolean | undefined,
     _DO_NOT_USE_dbPath?: string | undefined,
-    _DO_NOT_USE_binaryDirectoryPath?: string | undefined
+    _DO_NOT_USE_binaryDirectoryPath?: string | undefined,
+    _DO_NOT_USE_beforeSignalCleanupMessage?: string | undefined,
+    _DO_NOT_USE_afterSignalCleanupMessage?: string | undefined
 }
 
 export type InternalServerOptions = {
@@ -38,6 +40,8 @@ export type InternalServerOptions = {
     _DO_NOT_USE_deleteDBAfterStopped: boolean,
     _DO_NOT_USE_dbPath: string,
     _DO_NOT_USE_binaryDirectoryPath: string,
+    _DO_NOT_USE_beforeSignalCleanupMessage: string,
+    _DO_NOT_USE_afterSignalCleanupMessage: string
 }
 
 export type ExecutorOptions = {