mysql-memory-server 1.3.0 → 1.4.1

package/README.md

@@ -11,7 +11,7 @@ Download with your package manager of choice. The package name is `mysql-memory-
 #### Requirements
 
 - Node.js 16.6.0 and newer
-- macOS 13+, Windows, or Linux (Only Ubuntu has been tested. Other Linux distributions may or may not work at this time.)
+- macOS 13+, Windows, or Linux (This package is only tested on Ubuntu 20.04, 22.04, 24.04, and Fedora 40. Other Linux distributions may or may not work at this time.)
 
 Windows only requirements:
 - `Microsoft Visual C++ 2019 Redistributable Package` needs to be installed
@@ -143,6 +143,22 @@ Default: root
 
 Description: The username of the user that is used to login to the database.
 
+- `port: number`
+
+Required: No
+
+Default: 0
+
+Description: The port that the database will listen on. If set to 0, a randomly generated port is used.
+
+- `xPort: number`
+
+Required: No
+
+Default: 0
+
+Description: The port that the MySQL X Plugin will listen on. If set to 0, a randomly generated port is used.
+
 - `ignoreUnsupportedSystemVersion: boolean`
 
 Required: No

package/dist/src/index.js

@@ -31,16 +31,12 @@ const Logger_1 = __importDefault(require("./libraries/Logger"));
 const os = __importStar(require("node:os"));
 const Executor_1 = __importDefault(require("./libraries/Executor"));
 const semver_1 = require("semver");
-const AbortSignal_1 = __importDefault(require("./libraries/AbortSignal"));
 const Version_1 = __importDefault(require("./libraries/Version"));
 const versions_json_1 = __importDefault(require("./versions.json"));
 const Downloader_1 = require("./libraries/Downloader");
 const crypto_1 = require("crypto");
 const path_1 = require("path");
 const constants_1 = __importDefault(require("./constants"));
-process.on('exit', () => {
-    AbortSignal_1.default.abort('Process is exiting');
-});
 async function createDB(opts) {
     const defaultOptions = {
         dbName: 'dbdata',
@@ -53,7 +49,9 @@ async function createDB(opts) {
         deleteDBAfterStopped: true,
         //mysqlmsn = MySQL Memory Server Node.js
         dbPath: (0, path_1.normalize)(`${os.tmpdir()}/mysqlmsn/dbs/${(0, crypto_1.randomUUID)().replace(/-/g, '')}`),
-        ignoreUnsupportedSystemVersion: false
+        ignoreUnsupportedSystemVersion: false,
+        port: 0,
+        xPort: 0
     };
     const options = { ...defaultOptions, ...opts };
     const logger = new Logger_1.default(options.logLevel);
@@ -88,7 +86,7 @@ async function createDB(opts) {
             binaryFilepath = await (0, Downloader_1.downloadBinary)(binaryInfo, options, logger);
         }
         catch (error) {
-            logger.error('Failed to download binary');
+            logger.error('Failed to download binary:', error);
             throw `Failed to download binary. The error was: "${error}"`;
         }
         logger.log('Running downloaded binary');

package/dist/src/libraries/AbortSignal.js

@@ -1,4 +1,11 @@
 "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;

package/dist/src/libraries/Downloader.js

@@ -107,7 +107,7 @@ function downloadFromCDN(url, downloadLocation, logger) {
         });
     });
 }
-function extractBinary(url, archiveLocation, extractedLocation) {
+function extractBinary(url, archiveLocation, extractedLocation, logger) {
     return new Promise(async (resolve, reject) => {
         const lastDashIndex = url.lastIndexOf('-');
         const fileExtension = url.slice(lastDashIndex).split('.').splice(1).join('.');
@@ -140,8 +140,11 @@ function extractBinary(url, archiveLocation, extractedLocation) {
             try {
                 await fsPromises.rm(archiveLocation);
             }
+            catch (e) {
+                logger.error('A non-fatal error occurred while removing no longer needed archive file:', e);
+            }
             finally {
-                fsPromises.rename(`${extractedLocation}/${folderName}`, `${extractedLocation}/mysql`);
+                await fsPromises.rename(`${extractedLocation}/${folderName}`, `${extractedLocation}/mysql`);
                 return resolve((0, path_1.normalize)(`${extractedLocation}/mysql/bin/mysqld.exe`));
             }
         }
@@ -149,8 +152,11 @@ function extractBinary(url, archiveLocation, extractedLocation) {
             try {
                 await fsPromises.rm(archiveLocation);
             }
+            catch (e) {
+                logger.error('A non-fatal error occurred while removing no longer needed archive file:', e);
+            }
             finally {
-                fsPromises.rename(`${extractedLocation}/${folderName}`, `${extractedLocation}/mysql`);
+                await fsPromises.rename(`${extractedLocation}/${folderName}`, `${extractedLocation}/mysql`);
                 resolve(`${extractedLocation}/mysql/bin/mysqld`);
             }
         }).catch(error => {
@@ -170,15 +176,17 @@ function downloadBinary(binaryInfo, options, logger) {
             const extractedPath = `${dirpath}/${version}`;
             await fsPromises.mkdir(extractedPath, { recursive: true });
             const binaryPath = (0, path_1.normalize)(`${extractedPath}/mysql/bin/mysqld${process.platform === 'win32' ? '.exe' : ''}`);
+            const archivePath = `${dirpath}/${version}.${fileExtension}`;
             const binaryExists = fs.existsSync(binaryPath);
             if (binaryExists) {
                 return resolve(binaryPath);
             }
+            let lockedByUs = false;
             try {
                 (0, proper_lockfile_1.lockSync)(extractedPath);
-                const archivePath = `${dirpath}/${version}.${fileExtension}`;
+                lockedByUs = true;
                 await downloadFromCDN(url, archivePath, logger);
-                await extractBinary(url, archivePath, extractedPath);
+                await extractBinary(url, archivePath, extractedPath, logger);
                 try {
                     (0, proper_lockfile_1.unlockSync)(extractedPath);
                 }
@@ -188,12 +196,28 @@ function downloadBinary(binaryInfo, options, logger) {
                 return resolve(binaryPath);
             }
             catch (e) {
-                if (String(e) === 'Error: Lock file is already being held') {
+                if (String(e).includes('Lock file is already being held')) {
                     logger.log('Waiting for lock for MySQL version', version);
                     await (0, FileLock_1.waitForLock)(extractedPath, options);
                     logger.log('Lock is gone for version', version);
                     return resolve(binaryPath);
                 }
+                if (lockedByUs) {
+                    try {
+                        await Promise.all([
+                            fsPromises.rm(extractedPath, { force: true, recursive: true }),
+                            fsPromises.rm(archivePath, { force: true, recursive: true })
+                        ]);
+                    }
+                    finally {
+                        try {
+                            (0, proper_lockfile_1.unlockSync)(extractedPath, { realpath: false });
+                        }
+                        catch (e) {
+                            logger.error('An error occurred while unlocking path:', e);
+                        }
+                    }
+                }
                 return reject(e);
             }
         }
@@ -208,7 +232,7 @@ function downloadBinary(binaryInfo, options, logger) {
             reject(e);
         }
         try {
-            const binaryPath = await extractBinary(url, zipFilepath, extractedPath);
+            const binaryPath = await extractBinary(url, zipFilepath, extractedPath, logger);
             resolve(binaryPath);
         }
         catch (e) {

package/dist/src/libraries/Executor.js

@@ -135,8 +135,8 @@ class Executor {
         do {
             await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, binaryFilepath, datadir, true);
             this.logger.log('Setting up directories was successful');
-            const port = (0, Port_1.GenerateRandomPort)();
-            const mySQLXPort = (0, Port_1.GenerateRandomPort)();
+            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');
@@ -194,7 +194,7 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
     const errorLogFile = `${datadir}/errorlog.err`;
     return new Promise(async (resolve, reject) => {
         await fsPromises.rm(logFile, { force: true });
-        const process = (0, child_process_1.spawn)(binaryFilepath, ['--no-defaults', `--port=${port}`, `--datadir=${datadir}`, `--mysqlx-port=${mySQLXPort}`, `--mysqlx-socket=${dbPath}/x.sock`, `--socket=${dbPath}/m.sock`, `--general-log-file=${logFile}`, '--general-log=1', `--init-file=${dbPath}/init.sql`, '--bind-address=127.0.0.1', '--innodb-doublewrite=OFF', '--mysqlx=FORCE', `--log-error=${errorLogFile}`], { signal: AbortSignal_1.default.signal, killSignal: 'SIGKILL' });
+        const process = (0, child_process_1.spawn)(binaryFilepath, ['--no-defaults', `--port=${port}`, `--datadir=${datadir}`, `--mysqlx-port=${mySQLXPort}`, `--mysqlx-socket=${dbPath}/x.sock`, `--socket=${dbPath}/m.sock`, `--general-log-file=${logFile}`, '--general-log=1', `--init-file=${dbPath}/init.sql`, '--bind-address=127.0.0.1', '--innodb-doublewrite=OFF', '--mysqlx=FORCE', `--log-error=${errorLogFile}`, `--user=${os.userInfo().username}`], { signal: AbortSignal_1.default.signal, killSignal: 'SIGKILL' });
         //resolveFunction is the function that will be called to resolve the promise that stops the database.
         //If resolveFunction is not undefined, the database has received a kill signal and data cleanup procedures should run.
         //Once ran, resolveFunction will be called.
@@ -226,6 +226,9 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
                     await this.deleteDatabaseDirectory(dbPath);
                 }
             }
+            catch (e) {
+                this.logger.error('An erorr occurred while deleting database directory at path:', dbPath, '| The error was:', e);
+            }
             finally {
                 try {
                     if (binaryFilepath.includes(os.tmpdir()) && !options.downloadBinaryOnce) {
@@ -237,6 +240,9 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
                         await fsPromises.rm(splitPath.join('/'), { force: true, recursive: true });
                     }
                 }
+                catch (e) {
+                    this.logger.error('An error occurred while deleting no longer needed MySQL binary:', e);
+                }
                 finally {
                     if (resolveFunction) {
                         resolveFunction();

package/dist/types/index.d.ts

@@ -12,6 +12,8 @@ export type ServerOptions = {
     deleteDBAfterStopped?: boolean;
     dbPath?: string;
     ignoreUnsupportedSystemVersion?: boolean;
+    port?: number;
+    xPort?: number;
 };
 export type InternalServerOptions = {
     version?: string;
@@ -25,6 +27,8 @@ export type InternalServerOptions = {
     deleteDBAfterStopped: boolean;
     dbPath: string;
     ignoreUnsupportedSystemVersion: boolean;
+    port: number;
+    xPort: number;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -24,10 +24,10 @@
   "license": "MIT",
   "devDependencies": {
     "@babel/core": "^7.24.9",
-    "@babel/preset-env": "^7.24.8",
+    "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.5.0",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",
     "babel-jest": "^29.7.0",