mysql-memory-server 1.8.1 → 1.8.2

package/README.md

@@ -200,32 +200,3 @@ The internal queries that are ran before the queries in ```initSQLString``` are
 Default: process.arch
 
 Description: The MySQL binary architecture to execute. MySQL does not offer server builds for Windows on ARM, so to get this package working on Windows on ARM, set the arch option to "x64" and Windows will emulate MySQL.
-
-***
-### :warning: Internal Options :warning:
-
-The following options are only meant for internal use (such as for testing this package 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`
-
-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`
-
-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`
-
-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_cli: boolean`
-
-Default: ```false``` if the package is not being executed via the CLI and ```true``` if it is.
-
-Description: If set to ```true```, this enables certain CLI-only functionality. For example, when ran by the CLI, logging a message to the console when a shutdown signal (like CTRL + C) has been received and the MySQL database is shutting down and getting deleted.

package/dist/src/cli.js

@@ -3,16 +3,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
 const constants_1 = require("./constants");
-async function main() {
+function main() {
     const definedOptions = process.argv.filter((option) => option.startsWith('--'));
-    const options = {
-        _DO_NOT_USE_cli: true
-    };
+    const options = {};
+    process.env.mysqlmsn_internal_DO_NOT_USE_cli = 'true';
     for (const opt of definedOptions) {
+        if (!constants_1.DEFAULT_OPTIONS_KEYS.includes(opt.replace('--', ''))) {
+            console.error(`Option ${opt} is not a valid option.`);
+            return;
+        }
         const index = process.argv.indexOf(opt);
         const optionValue = process.argv[index + 1];
         if (optionValue === undefined) {
-            throw `Option ${opt} must have a value.`;
+            console.error(`Option ${opt} must have a value.`);
+            return;
         }
         const optionName = opt.slice(2);
         const optionType = constants_1.OPTION_TYPE_CHECKS[optionName].definedType;
@@ -39,17 +43,18 @@ async function main() {
         }
     }
     console.log('Creating ephemeral MySQL database...');
-    const db = await (0, index_1.createDB)(options);
-    console.log(`A MySQL database has been successfully created with the following parameters:\n\nMySQL Version: ${db.mysql.version} (${db.mysql.versionIsInstalledOnSystem ? 'installed on this system' : 'not installed on this system - downloaded from the MySQL CDN'}) \nUsername: ${db.username} \nDatabase Name: ${db.dbName} \nPort: ${db.port} \nX Plugin Port: ${db.xPort} \nSocket: ${db.socket} \nX Plugin Socket: ${db.xSocket}\n`);
-    if (process.platform === 'win32') {
-        //The connection information logs will be different for Windows compared to other platforms.
-        //Windows uses mysqlsh instead of mysql to invoke the client shell, needs a --sql flag to be put into SQL mode, and also does not have a protocol flag.
-        //Also according to https://bugs.mysql.com/bug.php?id=106852, you cannot log into a MySQL database with a named pipe for the first connection so a socket connection suggestion
-        //should only be displayed for non-Windows platforms.
-        console.log(`If you want to use the MySQL CLI client to connect to the database, you can use the following command: \nmysqlsh --sql -u ${db.username} -P ${db.port}\nIf prompted for a password, leave the password field blank. The database does not have a password set.`);
-    }
-    else {
-        console.log(`If you want to use the MySQL CLI client to connect to the database, you can use either commands: \nmysql -u ${db.username} -P ${db.port} --protocol tcp \nOR\nmysql -u ${db.username} --socket ${db.socket}\nIf prompted for a password, leave the password field blank. The database does not have a password set.`);
-    }
+    (0, index_1.createDB)(options).then(db => {
+        console.log(`A MySQL database has been successfully created with the following parameters:\n\nMySQL Version: ${db.mysql.version} (${db.mysql.versionIsInstalledOnSystem ? 'installed on this system' : 'not installed on this system - downloaded from the MySQL CDN'}) \nUsername: ${db.username} \nDatabase Name: ${db.dbName} \nPort: ${db.port} \nX Plugin Port: ${db.xPort} \nSocket: ${db.socket} \nX Plugin Socket: ${db.xSocket}\n`);
+        if (process.platform === 'win32') {
+            //The connection information logs will be different for Windows compared to other platforms.
+            //Windows uses mysqlsh instead of mysql to invoke the client shell, needs a --sql flag to be put into SQL mode, and also does not have a protocol flag.
+            //Also according to https://bugs.mysql.com/bug.php?id=106852, you cannot log into a MySQL database with a named pipe for the first connection so a socket connection suggestion
+            //should only be displayed for non-Windows platforms.
+            console.log(`If you want to use the MySQL CLI client to connect to the database, you can use the following command: \nmysqlsh --sql -u ${db.username} -P ${db.port}\nIf prompted for a password, leave the password field blank. The database does not have a password set.`);
+        }
+        else {
+            console.log(`If you want to use the MySQL CLI client to connect to the database, you can use either commands: \nmysql -u ${db.username} -P ${db.port} --protocol tcp \nOR\nmysql -u ${db.username} --socket ${db.socket}\nIf prompted for a password, leave the password field blank. The database does not have a password set.`);
+        }
+    });
 }
 main();

package/dist/src/constants.d.ts

@@ -7,5 +7,12 @@ export declare const LOG_LEVELS: {
     readonly WARN: 1;
     readonly ERROR: 2;
 };
-export declare const INTERNAL_OPTIONS: readonly ["_DO_NOT_USE_deleteDBAfterStopped", "_DO_NOT_USE_dbPath", "_DO_NOT_USE_binaryDirectoryPath", "_DO_NOT_USE_beforeSignalCleanup", "_DO_NOT_USE_afterSignalCleanup"];
+declare const internalOptions: {
+    deleteDBAfterStopped: string;
+    dbPath: string;
+    binaryDirectoryPath: string;
+    cli: string;
+};
+export declare function getInternalEnvVariable(envVar: keyof typeof internalOptions): string;
 export declare const OPTION_TYPE_CHECKS: OptionTypeChecks;
+export {};

package/dist/src/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPTION_TYPE_CHECKS = exports.INTERNAL_OPTIONS = exports.LOG_LEVELS = exports.DEFAULT_OPTIONS_KEYS = exports.DEFAULT_OPTIONS_GENERATOR = exports.MIN_SUPPORTED_MYSQL = void 0;
+exports.OPTION_TYPE_CHECKS = exports.LOG_LEVELS = exports.DEFAULT_OPTIONS_KEYS = exports.DEFAULT_OPTIONS_GENERATOR = exports.MIN_SUPPORTED_MYSQL = void 0;
+exports.getInternalEnvVariable = getInternalEnvVariable;
 const crypto_1 = require("crypto");
 const path_1 = require("path");
 const os_1 = require("os");
@@ -20,12 +21,7 @@ const DEFAULT_OPTIONS_GENERATOR = () => ({
     xPort: 0,
     downloadRetries: 10,
     initSQLString: '',
-    arch: process.arch,
-    _DO_NOT_USE_deleteDBAfterStopped: true,
-    //mysqlmsn = MySQL Memory Server Node.js
-    _DO_NOT_USE_dbPath: (0, path_1.normalize)(`${(0, os_1.tmpdir)()}/mysqlmsn/dbs/${(0, crypto_1.randomUUID)().replace(/-/g, '')}`),
-    _DO_NOT_USE_binaryDirectoryPath: `${(0, os_1.tmpdir)()}/mysqlmsn/binaries`,
-    _DO_NOT_USE_cli: false
+    arch: process.arch
 });
 exports.DEFAULT_OPTIONS_GENERATOR = DEFAULT_OPTIONS_GENERATOR;
 exports.DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys((0, exports.DEFAULT_OPTIONS_GENERATOR)()));
@@ -34,7 +30,16 @@ exports.LOG_LEVELS = {
     'WARN': 1,
     'ERROR': 2
 };
-exports.INTERNAL_OPTIONS = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath', '_DO_NOT_USE_beforeSignalCleanup', '_DO_NOT_USE_afterSignalCleanup'];
+const internalOptions = {
+    deleteDBAfterStopped: 'true',
+    //mysqlmsn = MySQL Memory Server Node.js
+    dbPath: (0, path_1.normalize)(`${(0, os_1.tmpdir)()}/mysqlmsn/dbs/${(0, crypto_1.randomUUID)().replace(/-/g, '')}`),
+    binaryDirectoryPath: `${(0, os_1.tmpdir)()}/mysqlmsn/binaries`,
+    cli: 'false'
+};
+function getInternalEnvVariable(envVar) {
+    return process.env['mysqlmsn_internal_DO_NOT_USE_' + envVar] || internalOptions[envVar];
+}
 const allowedArches = ['x64', 'arm64', undefined];
 exports.OPTION_TYPE_CHECKS = {
     version: {
@@ -106,25 +111,5 @@ exports.OPTION_TYPE_CHECKS = {
         check: (opt) => allowedArches.includes(opt),
         errorMessage: `Option arch must be either of the following: ${allowedArches.join(', ')}`,
         definedType: 'string'
-    },
-    _DO_NOT_USE_deleteDBAfterStopped: {
-        check: (opt) => opt === undefined || typeof opt === 'boolean',
-        errorMessage: 'Option _DO_NOT_USE_deleteDBAfterStopped must be either undefined or a boolean.',
-        definedType: 'boolean'
-    },
-    _DO_NOT_USE_dbPath: {
-        check: (opt) => opt === undefined || typeof opt === 'string',
-        errorMessage: 'Option _DO_NOT_USE_dbPath must be either undefined or a string.',
-        definedType: 'string'
-    },
-    _DO_NOT_USE_binaryDirectoryPath: {
-        check: (opt) => opt === undefined || typeof opt === 'string',
-        errorMessage: 'Option _DO_NOT_USE_binaryDirectoryPath must be either undefined or a string.',
-        definedType: 'string'
-    },
-    _DO_NOT_USE_cli: {
-        check: (opt) => opt === undefined || typeof opt === 'boolean',
-        errorMessage: 'Option _DO_NOT_USE_cli must be either undefined or a boolean.',
-        definedType: 'boolean'
     }
 };

package/dist/src/index.js

@@ -48,11 +48,6 @@ const constants_1 = require("./constants");
 async function createDB(opts) {
     const suppliedOpts = opts || {};
     const suppliedOptsKeys = Object.keys(suppliedOpts);
-    for (const opt of constants_1.INTERNAL_OPTIONS) {
-        if (suppliedOptsKeys.includes(opt)) {
-            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.`);
-        }
-    }
     const options = (0, constants_1.DEFAULT_OPTIONS_GENERATOR)();
     for (const opt of suppliedOptsKeys) {
         if (!constants_1.DEFAULT_OPTIONS_KEYS.includes(opt)) {

package/dist/src/libraries/Downloader.js

@@ -46,6 +46,7 @@ const path_1 = require("path");
 const crypto_1 = require("crypto");
 const child_process_1 = require("child_process");
 const FileLock_1 = require("./FileLock");
+const constants_1 = require("../constants");
 function getZipData(entry) {
     return new Promise((resolve, reject) => {
         entry.getDataAsync((data, err) => {
@@ -208,7 +209,7 @@ function extractBinary(url, archiveLocation, extractedLocation, logger) {
 function downloadBinary(binaryInfo, options, logger) {
     return new Promise(async (resolve, reject) => {
         const { url, version } = binaryInfo;
-        const dirpath = options._DO_NOT_USE_binaryDirectoryPath;
+        const dirpath = (0, constants_1.getInternalEnvVariable)('binaryDirectoryPath');
         logger.log('Binary path:', dirpath);
         await fsPromises.mkdir(dirpath, { recursive: true });
         const lastDashIndex = url.lastIndexOf('-');

package/dist/src/libraries/Executor.js

@@ -49,6 +49,7 @@ const path_1 = require("path");
 const FileLock_1 = require("./FileLock");
 const signal_exit_1 = require("signal-exit");
 const crypto_1 = require("crypto");
+const constants_1 = require("../constants");
 class Executor {
     constructor(logger) {
         _Executor_instances.add(this);
@@ -118,13 +119,13 @@ class Executor {
         this.version = installedMySQLBinary.version;
         this.versionInstalledOnSystem = installedMySQLBinary.installedOnSystem;
         this.removeExitHandler = (0, signal_exit_1.onExit)(() => {
-            if (options._DO_NOT_USE_cli) {
+            if ((0, constants_1.getInternalEnvVariable)('cli') === 'true') {
                 console.log('\nShutting down the ephemeral MySQL database and cleaning all related files...');
             }
             this.DBDestroySignal.abort();
-            if (options._DO_NOT_USE_deleteDBAfterStopped) {
+            if ((0, constants_1.getInternalEnvVariable)('deleteDBAfterStopped') === 'true') {
                 try {
-                    fs.rmSync(options._DO_NOT_USE_dbPath, { recursive: true, maxRetries: 50, force: true });
+                    fs.rmSync((0, constants_1.getInternalEnvVariable)('dbPath'), { recursive: true, maxRetries: 50, force: true });
                 }
                 catch (e) {
                     this.logger.error('An error occurred while deleting database directory path:', e);
@@ -139,12 +140,12 @@ class Executor {
                     this.logger.error('An error occurred while deleting database binary:', e);
                 }
             }
-            if (options._DO_NOT_USE_cli) {
+            if ((0, constants_1.getInternalEnvVariable)('cli') === 'true') {
                 console.log('Shutdown and cleanup is complete.');
             }
         });
         let retries = 0;
-        const datadir = (0, path_1.normalize)(`${options._DO_NOT_USE_dbPath}/data`);
+        const datadir = (0, path_1.normalize)(`${(0, constants_1.getInternalEnvVariable)('dbPath')}/data`);
         do {
             await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, installedMySQLBinary.path, datadir, true);
             this.logger.log('Setting up directories was successful');
@@ -153,7 +154,7 @@ class Executor {
             this.logger.log('Using port:', port, 'and MySQLX port:', mySQLXPort, 'on retry:', retries);
             try {
                 this.logger.log('Starting MySQL process');
-                const resolved = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_startMySQLProcess).call(this, options, port, mySQLXPort, datadir, options._DO_NOT_USE_dbPath, installedMySQLBinary.path);
+                const resolved = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_startMySQLProcess).call(this, options, port, mySQLXPort, datadir, (0, constants_1.getInternalEnvVariable)('dbPath'), installedMySQLBinary.path);
                 this.logger.log('Starting process was successful');
                 return resolved;
             }
@@ -253,7 +254,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             if (portIssue || xPortIssue) {
                 this.logger.log('Error log when exiting for port in use error:', errorLog);
                 try {
-                    await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, options._DO_NOT_USE_dbPath);
+                    await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, (0, constants_1.getInternalEnvVariable)('dbPath'));
                 }
                 catch (e) {
                     this.logger.error(e);
@@ -262,7 +263,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                 return reject('Port is already in use');
             }
             try {
-                if (options._DO_NOT_USE_deleteDBAfterStopped) {
+                if ((0, constants_1.getInternalEnvVariable)('deleteDBAfterStopped') === 'true') {
                     await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, dbPath);
                 }
             }
@@ -477,7 +478,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
         initText += `\n${options.initSQLString}`;
     }
     this.logger.log('Writing init file');
-    await fsPromises.writeFile(`${options._DO_NOT_USE_dbPath}/init.sql`, initText, { encoding: 'utf8' });
+    await fsPromises.writeFile(`${(0, constants_1.getInternalEnvVariable)('dbPath')}/init.sql`, initText, { encoding: 'utf8' });
     this.logger.log('Finished writing init file');
 };
 exports.default = Executor;

package/dist/types/index.d.ts

@@ -15,10 +15,6 @@ export type ServerOptions = {
     downloadRetries?: number | undefined;
     initSQLString?: string | undefined;
     arch?: "arm64" | "x64" | undefined;
-    _DO_NOT_USE_deleteDBAfterStopped?: boolean | undefined;
-    _DO_NOT_USE_dbPath?: string | undefined;
-    _DO_NOT_USE_binaryDirectoryPath?: string | undefined;
-    _DO_NOT_USE_cli?: boolean | undefined;
 };
 export type InternalServerOptions = {
     version?: string | undefined;
@@ -35,10 +31,6 @@ export type InternalServerOptions = {
     downloadRetries: number;
     initSQLString: string;
     arch: string;
-    _DO_NOT_USE_deleteDBAfterStopped: boolean;
-    _DO_NOT_USE_dbPath: string;
-    _DO_NOT_USE_binaryDirectoryPath: string;
-    _DO_NOT_USE_cli: boolean;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -31,12 +31,12 @@
     "@babel/preset-env": "^7.25.9",
     "@babel/preset-typescript": "^7.25.9",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^22.9.3",
+    "@types/node": "^22.10.6",
     "@types/semver": "^7.5.8",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
-    "mysql2": "^3.11.3",
-    "typescript": "^5.7.2"
+    "mysql2": "^3.12.0",
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "adm-zip": "^0.5.16",