mysql-memory-server 1.7.1 → 1.8.0

package/README.md

@@ -98,10 +98,13 @@ The name of the user to use to login to the database
 If on Windows, this is the name of the named pipe that MySQL is listening on. If not on Windows, this is the path to the socket that MySQL is listening on.
 - `xSocket: string`
 If on Windows, this is the name of the named pipe that the MySQL X Plugin is listening on. If not on Windows, this is the path that the MySQL X Plugin is listening on.
+- `mysql: {version: string, versionIsInstalledOnSystem: boolean}`
+An object with two properties. ```version``` is the version of MySQL used to create the database. ```versionIsInstalledOnSystem``` will be true if the MySQL version used is already installed on the system and false if the version had to be downloaded from MySQL's CDN.
 - `stop: () => Promise<void>`
 The method to stop the database. The returned promise resolves when the database has successfully stopped.
 
 #### Options:
+##### For options that are not required, using ```undefined``` as a value will use the option's default value.
 - `version: string`
 
 Required: No
@@ -132,7 +135,7 @@ Required: No
 
 Default: "ERROR"
 
-Description: Log level for the database. If "ERROR" is used, only errors will show up in the console. If "WARN" is used, warnings and errors will show up in the console. If "LOG" is used, everything will show up in the console.
+Description: Log level for this package. If "ERROR" is used, only errors from this package will show up in the console. If "WARN" is used, warnings and errors from this package will show up in the console. If "LOG" is used, every log from this package will show up in the console.
 
 - `portRetries: number`
 
@@ -140,7 +143,7 @@ Required: No
 
 Default: 10
 
-Description: Number of times to try connecting MySQL to a randomly generated port before giving up. According to the [MySQL Documentation](https://dev.mysql.com/doc/refman/en/server-options.html#option_mysqld_port "MySQL Documentation") if port 0 is used as the MySQL server port, the default value (3306) will be used. To get around this, a random number between 1025 - 65535 (inclusive) is generated and used for the database's port. If MySQL cannot successfully listen on a randomly generated port after `portRetries` then the `createDB()` promise is rejected. A warning is created when MySQL tries connecting to a port that is already in use.
+Description: Number of times to try connecting MySQL to a randomly generated port before giving up. According to the [MySQL Documentation](https://dev.mysql.com/doc/refman/en/server-options.html#option_mysqld_port "MySQL Documentation") if port 0 is used as the MySQL server port, the default value (3306) will be used. To get around this, a random number between 1025 - 65535 (inclusive) is generated and used for the database's port. If MySQL cannot successfully listen on a randomly generated port after `portRetries` then the `createDB()` promise is rejected. A warning is created when MySQL tries connecting to a port that is already in use. This option only applies for the MySQL port if the MySQL port is not explicitly set or if it's set to 0. This option also only applies for the MySQL X port if the MySQL X port is not explicitly set or if it's set to 0.
 
 - `downloadBinaryOnce: boolean`
 
@@ -158,7 +161,7 @@ Required: No
 
 Default: 1,000
 
-Description: If `downloadBinaryOnce` is set to `true`, `lockRetries` is the number of times to check to see if the lock for the binary has been released (meaning it has been successfully downloaded and extracted). If the number of retries exceeds `lockRetries`, the `createDB()` promise gets rejected.
+Description: If `downloadBinaryOnce` is set to `true`, `lockRetries` is the number of times to check to see if the lock for the binary has been released (meaning it has been successfully downloaded and extracted). If the number of retries exceeds `lockRetries`, the `createDB()` promise gets rejected. This option is also used for the number of times to check to see if the lock for libaio has been released (only on Linux distros that use libaio1t64 instead of libaio1)
 
 - `lockRetryWait: number`
 
@@ -166,7 +169,7 @@ Required: No
 
 Default: 1,000
 
-Description: If `downloadBinaryOnce` is set to `true`, `lockRetryWait` is the number of milliseconds to wait before checking if the lock has been released.
+Description: If `downloadBinaryOnce` is set to `true` and/or on Linux distros that use libaio1t64 instead of libaio1, `lockRetryWait` is the number of milliseconds to wait before checking if the lock has been released.
 
 - `username: string`
 
@@ -218,10 +221,18 @@ Description: A string with MySQL queries to run before the database starts to ac
 
 The internal queries that are ran before the queries in ```initSQLString``` are renaming the user from ```root``` to the username specified in the ```username``` option if it's set, and creating a database with the name from the ```dbName``` option.
 
+- `arch: "arm64" | "x64"`
+
+Required: No
+
+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 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.
+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`
 
@@ -241,18 +252,8 @@ 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`
+- `_DO_NOT_USE_cli: boolean`
 
-Required: No
-
-Default: undefined
+Default: ```false``` if the package is not being executed via the CLI and ```true``` if it is.
 
-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.
+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

@@ -6,8 +6,7 @@ const constants_1 = require("./constants");
 async function main() {
     const definedOptions = process.argv.filter((option) => option.startsWith('--'));
     const options = {
-        _DO_NOT_USE_beforeSignalCleanupMessage: '\nShutting down the ephemeral MySQL database and cleaning all related files...',
-        _DO_NOT_USE_afterSignalCleanupMessage: 'Shutdown and cleanup is complete.'
+        _DO_NOT_USE_cli: true
     };
     for (const opt of definedOptions) {
         const index = process.argv.indexOf(opt);
@@ -41,7 +40,7 @@ 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\nUsername: ${db.username} \nDatabase Name: ${db.dbName} \nPort: ${db.port} \nX Plugin Port: ${db.xPort} \nSocket: ${db.socket} \nX Plugin Socket: ${db.xSocket}\n`);
+    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.

package/dist/src/constants.js

@@ -20,12 +20,12 @@ 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_beforeSignalCleanupMessage: '',
-    _DO_NOT_USE_afterSignalCleanupMessage: ''
+    _DO_NOT_USE_cli: false
 });
 exports.DEFAULT_OPTIONS_GENERATOR = DEFAULT_OPTIONS_GENERATOR;
 exports.DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys((0, exports.DEFAULT_OPTIONS_GENERATOR)()));
@@ -35,9 +35,10 @@ exports.LOG_LEVELS = {
     '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 allowedArches = ['x64', 'arm64', undefined];
 exports.OPTION_TYPE_CHECKS = {
     version: {
-        check: (opt) => opt === undefined || typeof opt === 'string' && (0, semver_1.valid)(opt) !== null,
+        check: (opt) => opt === undefined || typeof opt === 'string' && (0, semver_1.valid)((0, semver_1.coerce)(opt)) !== null,
         errorMessage: 'Option version must be either undefined or a valid semver string.',
         definedType: 'string'
     },
@@ -101,6 +102,11 @@ exports.OPTION_TYPE_CHECKS = {
         errorMessage: 'Option initSQLString must be either undefined or a string.',
         definedType: 'string'
     },
+    arch: {
+        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.',
@@ -116,14 +122,9 @@ exports.OPTION_TYPE_CHECKS = {
         errorMessage: 'Option _DO_NOT_USE_binaryDirectoryPath must be either undefined or a string.',
         definedType: 'string'
     },
-    _DO_NOT_USE_beforeSignalCleanupMessage: {
-        check: (opt) => 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) => opt === undefined || typeof opt === 'string',
-        errorMessage: 'Option _DO_NOT_USE_afterSignalCleanup 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

@@ -60,7 +60,7 @@ async function createDB(opts) {
         }
         if (!constants_1.OPTION_TYPE_CHECKS[opt].check(suppliedOpts[opt])) {
             //Supplied option failed the check
-            throw constants_1.OPTION_TYPE_CHECKS[opt].errorMessage;
+            throw `${constants_1.OPTION_TYPE_CHECKS[opt].errorMessage} | Received value: ${suppliedOpts[opt]} (type: ${typeof suppliedOpts[opt]})`;
         }
         if (suppliedOpts[opt] !== undefined) {
             options[opt] = suppliedOpts[opt];
@@ -84,7 +84,7 @@ async function createDB(opts) {
         let binaryInfo;
         let binaryFilepath;
         try {
-            binaryInfo = (0, Version_1.default)(versions_json_1.default, options.version);
+            binaryInfo = (0, Version_1.default)(versions_json_1.default, options.version, options);
             logger.log('Using MySQL binary version:', binaryInfo.version, 'from URL:', binaryInfo.url);
         }
         catch (e) {
@@ -102,10 +102,10 @@ async function createDB(opts) {
             throw `Failed to download binary. The error was: "${error}"`;
         }
         logger.log('Running downloaded binary');
-        return await executor.startMySQL(options, binaryFilepath);
+        return await executor.startMySQL(options, { path: binaryFilepath, version: binaryInfo.version, installedOnSystem: false });
     }
     else {
         logger.log(version);
-        return await executor.startMySQL(options, version.path);
+        return await executor.startMySQL(options, version);
     }
 }

package/dist/src/libraries/Executor.d.ts

@@ -1,12 +1,14 @@
 import Logger from "./Logger";
-import { InstalledMySQLVersion, InternalServerOptions, MySQLDB } from "../../types";
+import { DownloadedMySQLVersion, InternalServerOptions, MySQLDB } from "../../types";
 declare class Executor {
     #private;
     logger: Logger;
     DBDestroySignal: AbortController;
     removeExitHandler: () => void;
+    version: string;
+    versionInstalledOnSystem: boolean;
     constructor(logger: Logger);
-    getMySQLVersion(preferredVersion?: string): Promise<InstalledMySQLVersion | null>;
-    startMySQL(options: InternalServerOptions, binaryFilepath: string): Promise<MySQLDB>;
+    getMySQLVersion(preferredVersion?: string): Promise<DownloadedMySQLVersion | null>;
+    startMySQL(options: InternalServerOptions, installedMySQLBinary: DownloadedMySQLVersion): Promise<MySQLDB>;
 }
 export default Executor;

package/dist/src/libraries/Executor.js

@@ -78,7 +78,7 @@ class Executor {
                             return reject('Could not get MySQL version');
                         }
                         else {
-                            versions.push({ version: version.version, path });
+                            versions.push({ version: version.version, path, installedOnSystem: true });
                         }
                     }
                     if (preferredVersion) {
@@ -108,16 +108,18 @@ class Executor {
                         reject('Could not get installed MySQL version');
                     }
                     else {
-                        resolve({ version: version.version, path: 'mysqld' });
+                        resolve({ version: version.version, path: 'mysqld', installedOnSystem: true });
                     }
                 }
             }
         });
     }
-    async startMySQL(options, binaryFilepath) {
+    async startMySQL(options, installedMySQLBinary) {
+        this.version = installedMySQLBinary.version;
+        this.versionInstalledOnSystem = installedMySQLBinary.installedOnSystem;
         this.removeExitHandler = (0, signal_exit_1.onExit)(() => {
-            if (options._DO_NOT_USE_beforeSignalCleanupMessage) {
-                console.log(options._DO_NOT_USE_beforeSignalCleanupMessage);
+            if (options._DO_NOT_USE_cli) {
+                console.log('\nShutting down the ephemeral MySQL database and cleaning all related files...');
             }
             this.DBDestroySignal.abort();
             if (options._DO_NOT_USE_deleteDBAfterStopped) {
@@ -128,7 +130,7 @@ class Executor {
                     this.logger.error('An error occurred while deleting database directory path:', e);
                 }
             }
-            const binaryPathToDelete = __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_returnBinaryPathToDelete).call(this, binaryFilepath, options);
+            const binaryPathToDelete = __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_returnBinaryPathToDelete).call(this, installedMySQLBinary.path, options);
             if (binaryPathToDelete) {
                 try {
                     fs.rmSync(binaryPathToDelete, { force: true, recursive: true, maxRetries: 50 });
@@ -137,21 +139,21 @@ 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);
+            if (options._DO_NOT_USE_cli) {
+                console.log('Shutdown and cleanup is complete.');
             }
         });
         let retries = 0;
         const datadir = (0, path_1.normalize)(`${options._DO_NOT_USE_dbPath}/data`);
         do {
-            await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, binaryFilepath, datadir, true);
+            await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, installedMySQLBinary.path, datadir, true);
             this.logger.log('Setting up directories was successful');
             const port = options.port || (0, Port_1.GenerateRandomPort)();
             const mySQLXPort = options.xPort || (0, Port_1.GenerateRandomPort)();
             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, binaryFilepath);
+                const resolved = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_startMySQLProcess).call(this, options, port, mySQLXPort, datadir, options._DO_NOT_USE_dbPath, installedMySQLBinary.path);
                 this.logger.log('Starting process was successful');
                 return resolved;
             }
@@ -327,6 +329,10 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                         xSocket,
                         dbName: options.dbName,
                         username: options.username,
+                        mysql: {
+                            version: this.version,
+                            versionIsInstalledOnSystem: this.versionInstalledOnSystem
+                        },
                         stop: () => {
                             return new Promise(async (resolve, reject) => {
                                 resolveFunction = resolve;

package/dist/src/libraries/Version.d.ts

@@ -1,5 +1,5 @@
-import { MySQLVersion } from "../../types";
-export default function getBinaryURL(versions: MySQLVersion[], versionToGet?: string): {
+import { InternalServerOptions, MySQLVersion } from "../../types";
+export default function getBinaryURL(versions: MySQLVersion[], versionToGet: string, options: InternalServerOptions): {
     url: string;
     version: string;
 };

package/dist/src/libraries/Version.js

@@ -36,11 +36,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getBinaryURL;
 const os = __importStar(require("os"));
 const semver_1 = require("semver");
-function getBinaryURL(versions, versionToGet = "9.x") {
+function getBinaryURL(versions, versionToGet = "x", options) {
     let availableVersions = versions;
-    availableVersions = availableVersions.filter(v => v.arch === process.arch);
+    availableVersions = availableVersions.filter(v => v.arch === options.arch);
     if (availableVersions.length === 0)
-        throw `No MySQL binary could be found for your CPU architecture: ${process.arch}`;
+        throw `No MySQL binary could be found for your CPU architecture: ${options.arch}. ${process.platform === 'win32' && process.arch === 'arm64' ? 'This package has detected you are running Windows on ARM. MySQL does not support Windows on ARM. To get this package working, please try setting the "arch" option to "x64".' : ''}`;
     availableVersions = availableVersions.filter(v => v.os === process.platform);
     if (availableVersions.length === 0)
         throw `No MySQL binary could be found for your OS: ${process.platform}`;

package/dist/types/index.d.ts

@@ -14,11 +14,11 @@ export type ServerOptions = {
     xPort?: number | undefined;
     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_beforeSignalCleanupMessage?: string | undefined;
-    _DO_NOT_USE_afterSignalCleanupMessage?: string | undefined;
+    _DO_NOT_USE_cli?: boolean | undefined;
 };
 export type InternalServerOptions = {
     version?: string | undefined;
@@ -34,11 +34,11 @@ export type InternalServerOptions = {
     xPort: number;
     downloadRetries: number;
     initSQLString: string;
+    arch: string;
     _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;
+    _DO_NOT_USE_cli: boolean;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;
@@ -55,6 +55,10 @@ export type MySQLDB = {
     xSocket: string;
     dbName: string;
     username: string;
+    mysql: {
+        version: string;
+        versionIsInstalledOnSystem: boolean;
+    };
     stop: () => Promise<void>;
 };
 export type MySQLVersion = {
@@ -64,9 +68,10 @@ export type MySQLVersion = {
     osKernelVersionsSupported: string;
     url: string;
 };
-export type InstalledMySQLVersion = {
+export type DownloadedMySQLVersion = {
     version: string;
     path: string;
+    installedOnSystem: boolean;
 };
 export type BinaryInfo = {
     url: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

package/dist/src/libraries/AbortSignal.d.ts

@@ -1,2 +0,0 @@
-declare const DBDestroySignal: AbortController;
-export default DBDestroySignal;

package/dist/src/libraries/AbortSignal.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const DBDestroySignal = new AbortController();
-function abortSignal() {
-    if (!DBDestroySignal.signal.aborted) {
-        DBDestroySignal.abort('Process is exiting');
-    }
-}
-process.on('beforeExit', abortSignal);
-process.on('exit', abortSignal);
-exports.default = DBDestroySignal;