mysql-memory-server 1.8.1 → 1.9.0

package/dist/src/libraries/Executor.js

@@ -37,7 +37,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Executor_instances, _Executor_executeFile, _Executor_killProcess, _Executor_deleteDatabaseDirectory, _Executor_returnBinaryPathToDelete, _Executor_startMySQLProcess, _Executor_setupDataDirectories;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _Executor_instances, _Executor_executeFile, _Executor_killProcess, _Executor_returnBinaryPathToDelete, _Executor_startMySQLProcess, _Executor_setupDataDirectories;
 Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const semver_1 = require("semver");
@@ -49,6 +52,8 @@ 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");
+const LinuxOSRelease_1 = __importDefault(require("./LinuxOSRelease"));
 class Executor {
     constructor(logger) {
         _Executor_instances.add(this);
@@ -118,13 +123,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(this.databasePath, { recursive: true, maxRetries: 50, force: true });
                 }
                 catch (e) {
                     this.logger.error('An error occurred while deleting database directory path:', e);
@@ -139,21 +144,22 @@ 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`);
+        this.databasePath = (0, path_1.normalize)(`${(0, constants_1.getInternalEnvVariable)('databaseDirectoryPath')}/${(0, crypto_1.randomUUID)().replaceAll("-", '')}`);
+        const datadir = (0, path_1.normalize)(`${this.databasePath}/data`);
         do {
-            await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, installedMySQLBinary.path, datadir, true);
+            await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, installedMySQLBinary, 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, installedMySQLBinary.path);
+                const resolved = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_startMySQLProcess).call(this, options, port, mySQLXPort, datadir, this.databasePath, installedMySQLBinary.path);
                 this.logger.log('Starting process was successful');
                 return resolved;
             }
@@ -195,28 +201,6 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
         killed = process.kill();
     }
     return killed;
-}, _Executor_deleteDatabaseDirectory = async function _Executor_deleteDatabaseDirectory(path) {
-    let retries = 0;
-    //Maximum wait of 10 seconds | 500ms * 20 retries = 10,000ms = 10 seconds
-    const waitTime = 500;
-    const maxRetries = 20;
-    //Since the database processes are killed instantly (SIGKILL) sometimes the database file handles may still be open
-    //This would cause an EBUSY error. Retrying the deletions for 10 seconds should give the OS enough time to close
-    //the file handles.
-    while (retries <= maxRetries) {
-        try {
-            await fsPromises.rm(path, { recursive: true, force: true });
-            return;
-        }
-        catch (e) {
-            if (retries === maxRetries) {
-                throw e;
-            }
-            await new Promise(resolve => setTimeout(resolve, waitTime));
-            retries++;
-            this.logger.log('DB data directory deletion failed. Now on retry', retries);
-        }
-    }
 }, _Executor_returnBinaryPathToDelete = function _Executor_returnBinaryPathToDelete(binaryFilepath, options) {
     if (binaryFilepath.includes(os.tmpdir()) && !options.downloadBinaryOnce) {
         const splitPath = binaryFilepath.split(os.platform() === 'win32' ? '\\' : '/');
@@ -234,12 +218,51 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
         await fsPromises.rm(logFile, { force: true });
         const socket = os.platform() === 'win32' ? `MySQL-${(0, crypto_1.randomUUID)()}` : `${dbPath}/m.sock`;
         const xSocket = os.platform() === 'win32' ? `MySQLX-${(0, crypto_1.randomUUID)()}` : `${dbPath}/x.sock`;
-        const process = (0, child_process_1.spawn)(binaryFilepath, ['--no-defaults', `--port=${port}`, `--datadir=${datadir}`, `--mysqlx-port=${mySQLXPort}`, `--mysqlx-socket=${xSocket}`, `--socket=${socket}`, `--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: this.DBDestroySignal.signal, killSignal: 'SIGKILL' });
+        const mysqlArguments = [
+            '--no-defaults',
+            '--mysqlx=FORCE',
+            `--port=${port}`,
+            `--datadir=${datadir}`,
+            `--mysqlx-port=${mySQLXPort}`,
+            `--mysqlx-socket=${xSocket}`,
+            `--socket=${socket}`,
+            `--general-log-file=${logFile}`,
+            '--general-log=1',
+            `--init-file=${dbPath}/init.sql`,
+            '--bind-address=127.0.0.1',
+            '--innodb-doublewrite=OFF',
+            `--log-error=${errorLogFile}`,
+            `--user=${os.userInfo().username}`
+        ];
+        //<8.0.11 does not have MySQL X turned on by default so we will be installing the X Plugin in this if statement.
+        //MySQL 5.7.12 introduced the X plugin, but according to https://dev.mysql.com/doc/refman/5.7/en/document-store-setting-up.html, the database needs to be initialised with version 5.7.19.
+        //If the MySQL version is >=5.7.19 & <8.0.11 then install the X Plugin
+        if ((0, semver_1.lt)(this.version, '8.0.11') && (0, semver_1.gte)(this.version, '5.7.19')) {
+            const pluginExtension = os.platform() === 'win32' ? 'dll' : 'so';
+            let pluginPath;
+            const firstPath = (0, path_1.resolve)(`${binaryFilepath}/../../lib/plugin`);
+            const secondPath = '/usr/lib/mysql/plugin';
+            if (fs.existsSync(`${firstPath}/mysqlx.${pluginExtension}`)) {
+                pluginPath = firstPath;
+            }
+            else if (os.platform() === 'linux' && fs.existsSync(`${secondPath}/mysqlx.so`)) {
+                pluginPath = secondPath;
+            }
+            else {
+                throw 'Could not install MySQL X as the path to the plugin cannot be found.';
+            }
+            mysqlArguments.splice(1, 0, `--plugin-dir=${pluginPath}`, `--early-plugin-load=mysqlx=mysqlx.${pluginExtension};`);
+        }
+        const process = (0, child_process_1.spawn)(binaryFilepath, mysqlArguments, { signal: this.DBDestroySignal.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.
         let resolveFunction;
         process.on('close', async (code, signal) => {
+            if (signal) {
+                this.logger.log('Exiting because of aborted signal.');
+                return;
+            }
             let errorLog;
             try {
                 errorLog = await fsPromises.readFile(errorLogFile, { encoding: 'utf-8' });
@@ -247,13 +270,19 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             catch (e) {
                 errorLog = `ERROR WHILE READING LOG: ${e}`;
             }
-            const portIssue = errorLog.includes("Do you already have another mysqld server running");
-            const xPortIssue = errorLog.includes("X Plugin can't bind to it");
-            this.logger.log('Exiting because of a port issue:', portIssue, '. MySQL X Plugin failed to bind:', xPortIssue);
-            if (portIssue || xPortIssue) {
+            if (!this.killedFromPortIssue) {
+                //A check is done after the error log file says that the server is ready for connections.
+                //When MySQL X cannot bind to a port, the server still says it is ready for connections so killedFromPortIssue gets set to true
+                //This if statement will be ran if the server did not encounter a port issue or if the MySQL server could not bind to its port
+                this.killedFromPortIssue = errorLog.includes("Do you already have another mysqld server running");
+                this.logger.log('Did a port issue occur between server start and server close:', this.killedFromPortIssue);
+            }
+            if (this.killedFromPortIssue) {
                 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);
+                    this.logger.log('Deleting database path after port issue...');
+                    await fsPromises.rm(dbPath, { recursive: true, force: true, maxRetries: 50, retryDelay: 100 });
+                    this.logger.log('Successfully deleted database after port issue.');
                 }
                 catch (e) {
                     this.logger.error(e);
@@ -262,8 +291,8 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                 return reject('Port is already in use');
             }
             try {
-                if (options._DO_NOT_USE_deleteDBAfterStopped) {
-                    await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, dbPath);
+                if ((0, constants_1.getInternalEnvVariable)('deleteDBAfterStopped') === 'true') {
+                    await fsPromises.rm(dbPath, { recursive: true, force: true, maxRetries: 50, retryDelay: 100 });
                 }
             }
             catch (e) {
@@ -310,18 +339,17 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             if (curr.dev !== 0) {
                 //File exists
                 const file = await fsPromises.readFile(errorLogFile, { encoding: 'utf8' });
-                if (file.includes("X Plugin can't bind to it")) {
-                    //As stated in the MySQL X Plugin documentation at https://dev.mysql.com/doc/refman/8.4/en/x-plugin-options-system-variables.html#sysvar_mysqlx_bind_address
-                    //when the MySQL X Plugin fails to bind to an address, it does not prevent the MySQL server startup because MySQL X is not a mandatory plugin.
-                    //It doesn't seem like there is a way to prevent server startup when that happens. The workaround to that is to shutdown the MySQL server ourselves when the X plugin
-                    //cannot bind to an address. If there is a way to prevent server startup when binding fails, this workaround can be removed.
-                    const killed = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_killProcess).call(this, process);
-                    if (!killed) {
-                        reject('Failed to kill MySQL process to retry listening on a free port.');
-                    }
-                }
-                else if (file.includes('ready for connections. Version:')) {
+                if (file.includes(': ready for connections') || file.includes('Server starts handling incoming connections')) {
                     fs.unwatchFile(errorLogFile);
+                    this.killedFromPortIssue = file.includes("Do you already have another mysqld server running");
+                    this.logger.log('Did a port issue occur after watching errorLogFile:', this.killedFromPortIssue);
+                    if (this.killedFromPortIssue) {
+                        const killed = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_killProcess).call(this, process);
+                        if (!killed) {
+                            return reject('Failed to kill process after port error.');
+                        }
+                        return; //Promise rejection will be handled in the process.on('close') section because this.killedFromPortIssue is being set to true
+                    }
                     resolve({
                         port,
                         xPort: mySQLXPort,
@@ -339,7 +367,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                                 this.removeExitHandler();
                                 const killed = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_killProcess).call(this, process);
                                 if (!killed) {
-                                    reject();
+                                    reject('Failed to kill process.');
                                 }
                             });
                         }
@@ -348,59 +376,53 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             }
         });
     });
-}, _Executor_setupDataDirectories = async function _Executor_setupDataDirectories(options, binaryFilepath, datadir, retry) {
+}, _Executor_setupDataDirectories = async function _Executor_setupDataDirectories(options, binary, datadir, retry) {
+    const binaryFilepath = binary.path;
     this.logger.log('Created data directory for database at:', datadir);
     await fsPromises.mkdir(datadir, { recursive: true });
-    let stderr;
-    if (binaryFilepath === 'mysqld') {
-        const { error, stderr: output } = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_executeFile).call(this, 'mysqld', ['--no-defaults', `--datadir=${datadir}`, '--initialize-insecure']);
-        stderr = output;
-        if (error) {
-            this.logger.error('An error occurred while initializing database with system-installed MySQL:', error);
-            throw 'An error occurred while initializing database with system-installed MySQL. Please check the console for more information.';
-        }
-    }
-    else {
-        let result;
-        try {
-            result = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_executeFile).call(this, `${binaryFilepath}`, [`--no-defaults`, `--datadir=${datadir}`, `--initialize-insecure`]);
-        }
-        catch (e) {
-            this.logger.error('Error occurred from executeFile:', e);
-            throw e;
-        }
-        stderr = result === null || result === void 0 ? void 0 : result.stderr;
+    const { error, stderr } = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_executeFile).call(this, binaryFilepath, ['--no-defaults', `--datadir=${datadir}`, '--initialize-insecure']);
+    if (binary.installedOnSystem && error) {
+        this.logger.error('An error occurred while initializing database with the system-installed MySQL binary:', error);
+        throw `An error occurred while initializing the MySQL database: ${error}`;
     }
-    if (stderr && !stderr.includes('InnoDB initialization has ended')) {
+    if (stderr && !stderr.includes('is created with an empty password')) {
         if (process.platform === 'win32' && stderr.includes('Command failed')) {
             this.logger.error(stderr);
             throw 'The mysqld command failed to run. A possible cause is that the Microsoft Visual C++ Redistributable Package is not installed. MySQL 5.7.40 and newer requires Microsoft Visual C++ Redistributable Package 2019 to be installed. Check the MySQL docs for Microsoft Visual C++ requirements for other MySQL versions. If you are sure you have this installed, check the error message in the console for more details.';
         }
         if (process.platform === 'linux' && stderr.includes('libaio.so')) {
-            if (binaryFilepath === 'mysqld') {
-                throw 'libaio could not be found while running system-installed MySQL. libaio must be installed on this system for MySQL to run. To learn more, please check out https://dev.mysql.com/doc/refman/en/binary-installation.html';
-            }
             if (retry === false) {
                 this.logger.error('An error occurred while initializing database:', stderr);
                 throw 'Tried to copy libaio into lib folder and MySQL is still failing to initialize. Please check the console for more information.';
             }
-            if (binaryFilepath.slice(-16) === 'mysql/bin/mysqld') {
+            if (binary.installedOnSystem) {
+                throw 'libaio could not be found while running system-installed MySQL. libaio must be installed on this system for MySQL to run. To learn more, please check out https://dev.mysql.com/doc/refman/en/binary-installation.html';
+            }
+            // If the below code is running, the version of MySQL that is trying to be executed was downloaded from the CDN by this package and libaio has not yet been attempted to be copied
+            if (LinuxOSRelease_1.default.NAME === 'Ubuntu' && LinuxOSRelease_1.default.VERSION_ID >= '24.04') {
                 const { error: lderror, stdout, stderr: ldstderr } = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_executeFile).call(this, 'ldconfig', ['-p']);
                 if (lderror || ldstderr) {
                     this.logger.error('The following libaio error occurred:', stderr);
                     this.logger.error('After the libaio error, an ldconfig error occurred:', lderror || ldstderr);
-                    throw 'The ldconfig command failed to run. This command was ran to find libaio because libaio could not be found on the system. libaio is needed for MySQL to run. Do you have ldconfig and libaio installed? Learn more about libaio at Learn more at https://dev.mysql.com/doc/refman/en/binary-installation.html';
+                    throw 'The ldconfig command failed to run. This command was ran to find libaio1t64 because libaio1t64 could not be found on the system. libaio1t64 is needed for MySQL to run. Do you have ldconfig and libaio1t64 installed? Learn more at https://dev.mysql.com/doc/refman/en/binary-installation.html';
                 }
                 const libaioFound = stdout.split('\n').filter(lib => lib.includes('libaio.so.1t64'));
                 if (!libaioFound.length) {
                     this.logger.error('Error from launching MySQL:', stderr);
-                    throw 'An error occurred while launching MySQL. The most likely cause is that libaio1 and libaio1t64 could not be found. Either libaio1 or libaio1t64 must be installed on this system for MySQL to run. To learn more, please check out https://dev.mysql.com/doc/refman/en/binary-installation.html. Check error in console for more information.';
+                    this.logger.error('Could not find libaio1t64 in this list:', libaioFound);
+                    throw 'An error occurred while launching MySQL because libaio1t64 is not installed on your system. Please install libaio1t64 and then use mysql-memory-server again. To learn more, please check out https://dev.mysql.com/doc/refman/en/binary-installation.html. Check error in console for more information.';
                 }
                 const libaioEntry = libaioFound[0];
                 const libaioPathIndex = libaioEntry.indexOf('=>');
                 const libaioSymlinkPath = libaioEntry.slice(libaioPathIndex + 3);
                 const libaioPath = await fsPromises.realpath(libaioSymlinkPath);
-                const copyPath = (0, path_1.resolve)(`${binaryFilepath}/../../lib/private/libaio.so.1`);
+                let copyPath;
+                if ((0, semver_1.lt)(this.version, '8.0.18')) {
+                    copyPath = (0, path_1.resolve)(`${binaryFilepath}/../../bin/libaio.so.1`);
+                }
+                else {
+                    copyPath = (0, path_1.resolve)(`${binaryFilepath}/../../lib/private/libaio.so.1`);
+                }
                 let lockRelease;
                 while (true) {
                     try {
@@ -454,30 +476,28 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                         if (copyError) {
                             throw 'An error occurred while copying libaio1t64 to the MySQL lib folder. Please check the console for more details.';
                         }
-                        //Retry setting up directory now that libaio has been copied
-                        this.logger.log('Retrying directory setup');
-                        await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, datadir);
-                        await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, binaryFilepath, datadir, false);
-                        return;
                     }
                 }
+                //Retry setting up directory now that libaio has been copied
+                this.logger.log('Retrying directory setup');
+                await fsPromises.rm(datadir, { recursive: true, force: true, maxRetries: 50, retryDelay: 100 });
+                await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_setupDataDirectories).call(this, options, binary, datadir, false);
+                return;
             }
-            else {
-                throw 'Cannot recognize file structure for the MySQL binary folder. This was caused by not being able to find libaio. Try installing libaio. Learn more at https://dev.mysql.com/doc/refman/en/binary-installation.html';
-            }
+            throw 'You do not have libaio1 installed. Please install the libaio1 package for the downloaded MySQL binary to run. Learn more here: https://dev.mysql.com/doc/refman/en/binary-installation.html';
         }
         throw stderr;
     }
     this.logger.log('Creating init text');
     let initText = `CREATE DATABASE ${options.dbName};`;
     if (options.username !== 'root') {
-        initText += `\nRENAME USER 'root'@'localhost' TO '${options.username}'@'localhost';`;
+        initText += `\nCREATE USER '${options.username}'@'localhost';\nGRANT ALL ON *.* TO '${options.username}'@'localhost' WITH GRANT OPTION;`;
     }
     if (options.initSQLString.length > 0) {
         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(`${this.databasePath}/init.sql`, initText, { encoding: 'utf8' });
     this.logger.log('Finished writing init file');
 };
 exports.default = Executor;

package/dist/src/libraries/FileLock.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForLock = waitForLock;
 exports.lockFile = lockFile;
 const promises_1 = __importDefault(require("fs/promises"));
-const mtimeUpdateIntervalTime = 2000;
-const mtimeLimit = 10000;
+const mtimeUpdateIntervalTime = 2_000;
+const mtimeLimit = 10_000;
 async function waitForLock(path, options) {
     const lockPath = `${path}.lock`;
     let retries = 0;

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

@@ -0,0 +1,3 @@
+import { LinuxEtcOSRelease } from '../../types';
+declare const _default: LinuxEtcOSRelease;
+export default _default;

package/dist/src/libraries/LinuxOSRelease.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const releaseDetails = {};
+if (process.platform === 'linux') {
+    const file = fs_1.default.readFileSync('/etc/os-release', 'utf8');
+    const entries = file.split('\n');
+    for (const entry of entries) {
+        const [key, value] = entry.split('=');
+        if (typeof key === 'string' && typeof value === 'string') {
+            releaseDetails[key] = value.replaceAll('"', '');
+        }
+    }
+}
+exports.default = releaseDetails;

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

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

package/dist/src/libraries/Version.js

@@ -32,34 +32,99 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getBinaryURL;
 const os = __importStar(require("os"));
 const semver_1 = require("semver");
-function getBinaryURL(versions, versionToGet = "x", options) {
-    let availableVersions = versions;
-    availableVersions = availableVersions.filter(v => v.arch === options.arch);
-    if (availableVersions.length === 0)
-        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}`;
-    availableVersions = availableVersions.filter(v => {
-        const release = (0, semver_1.coerce)(os.release());
-        if (!release)
-            return false;
-        return (0, semver_1.satisfies)(release.version, v.osKernelVersionsSupported);
+const constants_1 = require("../constants");
+const LinuxOSRelease_1 = __importDefault(require("./LinuxOSRelease"));
+function getBinaryURL(versionToGet = "x", currentArch) {
+    let selectedVersions = constants_1.DOWNLOADABLE_MYSQL_VERSIONS.filter(version => (0, semver_1.satisfies)(version, versionToGet));
+    if (selectedVersions.length === 0) {
+        throw `mysql-memory-server does not support downloading a version of MySQL that fits the following version requirement: ${versionToGet}. This package only supports downloads of MySQL for MySQL >= ${constants_1.DOWNLOADABLE_MYSQL_VERSIONS[0]} <= ${constants_1.DOWNLOADABLE_MYSQL_VERSIONS.at(-1)}. Please check for typos, choose a different version of MySQL to use, or make an issue or pull request on GitHub if you belive this is a bug.`;
+    }
+    const currentOS = os.platform();
+    const OSVersionSupport = constants_1.MYSQL_MIN_OS_SUPPORT[currentOS];
+    if (!OSVersionSupport)
+        throw `MySQL and/or mysql-memory-server does not support your operating system. Please make sure you are running the latest version of mysql-memory-server or try running on a different operating system or report an issue on GitHub if you believe this is a bug.`;
+    const OSSupportVersionRanges = Object.keys(OSVersionSupport);
+    selectedVersions = selectedVersions.filter(possibleVersion => {
+        const OSKey = OSSupportVersionRanges.find(item => (0, semver_1.satisfies)(possibleVersion, item));
+        return !!OSKey;
+    });
+    if (selectedVersions.length === 0) {
+        throw `No version of MySQL could be found that supports your operating system and fits the following version requirement: ${versionToGet}. Please check for typos, choose a different version of MySQL to run, or if you think this is a bug, please report this on GitHub.`;
+    }
+    const archSupport = constants_1.MYSQL_ARCH_SUPPORT[currentOS][currentArch];
+    if (!archSupport) {
+        if (currentOS === 'win32' && currentArch === 'arm64')
+            throw 'mysql-memory-server 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".';
+        throw `MySQL and/or mysql-memory-server does not support the CPU architecture you want to use (${currentArch}). Please make sure you are using the latest version of mysql-memory-server or try using a different architecture, or if you believe this is a bug, please report this on GitHub.`;
+    }
+    selectedVersions = selectedVersions.filter(possibleVersion => (0, semver_1.satisfies)(possibleVersion, archSupport));
+    if (selectedVersions.length === 0) {
+        throw `No version of MySQL could be found that supports the CPU architecture ${currentArch === os.arch() ? 'for your system' : 'you have chosen'} (${currentArch}). Please try choosing a different version of MySQL, or if you believe this is a bug, please report this on GitHub.`;
+    }
+    const versionsBeforeOSVersionCheck = selectedVersions.slice();
+    const coercedOSRelease = (0, semver_1.coerce)(os.release());
+    selectedVersions = selectedVersions.filter(possibleVersion => {
+        const OSVersionKey = OSSupportVersionRanges.find(item => (0, semver_1.satisfies)(possibleVersion, item));
+        return !(0, semver_1.lt)(coercedOSRelease, OSVersionSupport[OSVersionKey]);
     });
-    if (availableVersions.length === 0)
-        throw `No MySQL binary could be found that supports your OS version: ${os.release()} | ${os.version()}`;
-    const wantedVersions = availableVersions.filter(v => (0, semver_1.satisfies)(v.version, versionToGet));
-    if (wantedVersions.length === 0)
-        throw `No MySQL binary could be found that meets your version requirement: ${versionToGet} for OS ${process.platform} version ${os.release()} on arch ${process.arch}. The available versions for download are: ${availableVersions.map(v => v.version)}`;
+    if (selectedVersions.length === 0) {
+        const versionKeys = new Set();
+        for (const v of versionsBeforeOSVersionCheck) {
+            versionKeys.add(OSSupportVersionRanges.find(item => (0, semver_1.satisfies)(v, item)));
+        }
+        const minVersions = Array.from(versionKeys).map(v => OSVersionSupport[v]);
+        //Sorts versions in ascending order
+        minVersions.sort((a, b) => a < b ? -1 : 1);
+        const minVersion = minVersions[0];
+        throw `Your operating system is too out of date to run a version of MySQL that fits the following requirement: ${versionToGet}. The oldest version for your operating system that you would need to get a version that satisfies the version requirement is ${minVersion} but your current operating system is ${coercedOSRelease.version}. Please try changing your MySQL version requirement, updating your OS to a newer version, or if you believe this is a bug, please report this on GitHub.`;
+    }
+    if (process.platform === 'linux' && LinuxOSRelease_1.default.NAME === 'Ubuntu' && LinuxOSRelease_1.default.VERSION_ID >= '24.04') {
+        //Since Ubuntu >= 24.04 uses libaio1t64 instead of libaio, this package has to copy libaio1t64 into a folder that MySQL looks in for dynamically linked libraries with the filename "libaio.so.1".
+        //I have not been able to find a suitable folder for libaio1t64 to be copied into for MySQL < 8.0.4, so here we are filtering all versions lower than 8.0.4 since they fail to launch in Ubuntu 24.04.
+        //If there is a suitable filepath for libaio1t64 to be copied into for MySQL < 8.0.4 then this check can be removed and these older MySQL versions can run on Ubuntu.
+        //Pull requests are welcome for adding >= Ubuntu 24.04 support for MySQL < 8.0.4.
+        //A way to get MySQL running on Ubuntu >= 24.04 is to symlink libaio1t64 to the location libaio would be. It is not suitable for this package to be doing that automatically, so instead this package has been copying libaio1t64 into the MySQL binary folder.
+        selectedVersions = selectedVersions.filter(v => !(0, semver_1.lt)(v, '8.0.4'));
+    }
+    if (selectedVersions.length === 0) {
+        throw `You are running a version of Ubuntu that is too modern to run any MySQL versions with this package that match the following version requirement: ${versionToGet}. Please choose a newer version of MySQL to use, or if you believe this is a bug please report this on GitHub.`;
+    }
     //Sorts versions in descending order
-    wantedVersions.sort((a, b) => a.version < b.version ? 1 : a.version === b.version ? 0 : -1);
-    const v = wantedVersions[0];
+    selectedVersions.sort((a, b) => a < b ? 1 : -1);
+    const selectedVersion = selectedVersions[0];
+    const isRC = (0, semver_1.satisfies)(selectedVersion, constants_1.RC_MYSQL_VERSIONS);
+    const isDMR = (0, semver_1.satisfies)(selectedVersion, constants_1.DMR_MYSQL_VERSIONS);
+    let fileLocation = '';
+    if (currentOS === 'win32') {
+        fileLocation = `${(0, semver_1.major)(selectedVersion)}.${(0, semver_1.minor)(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-winx64.zip`;
+    }
+    else if (currentOS === 'darwin') {
+        const MySQLmacOSVersionNameKeys = Object.keys(constants_1.MYSQL_MACOS_VERSIONS_IN_FILENAME);
+        const macOSVersionNameKey = MySQLmacOSVersionNameKeys.find(range => (0, semver_1.satisfies)(selectedVersion, range));
+        fileLocation = `${(0, semver_1.major)(selectedVersion)}.${(0, semver_1.minor)(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-${constants_1.MYSQL_MACOS_VERSIONS_IN_FILENAME[macOSVersionNameKey]}-${currentArch === 'x64' ? 'x86_64' : 'arm64'}.tar.gz`;
+    }
+    else if (currentOS === 'linux') {
+        const glibcVersionKeys = Object.keys(constants_1.MYSQL_LINUX_GLIBC_VERSIONS);
+        const glibcVersionKey = glibcVersionKeys.find(range => (0, semver_1.satisfies)(selectedVersion, range));
+        const glibcVersion = constants_1.MYSQL_LINUX_GLIBC_VERSIONS[glibcVersionKey];
+        const minimalInstallAvailableKeys = Object.keys(constants_1.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE);
+        const minimalInstallAvailableKey = minimalInstallAvailableKeys.find(range => (0, semver_1.satisfies)(selectedVersion, range));
+        const minimalInstallAvailable = constants_1.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE[minimalInstallAvailableKey];
+        const fileExtensionObject = constants_1.MYSQL_LINUX_FILE_EXTENSIONS[currentArch];
+        const fileExtensionKeys = Object.keys(fileExtensionObject);
+        const fileExtensionKey = fileExtensionKeys.find(range => (0, semver_1.satisfies)(selectedVersion, range));
+        const fileExtension = constants_1.MYSQL_LINUX_FILE_EXTENSIONS[currentArch][fileExtensionKey];
+        fileLocation = `${(0, semver_1.major)(selectedVersion)}.${(0, semver_1.minor)(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-linux-${minimalInstallAvailable !== 'no-glibc-tag' ? `glibc${glibcVersion}-` : ''}${currentArch === 'x64' ? 'x86_64' : 'aarch64'}${minimalInstallAvailable !== 'no' && (process.arch !== 'arm64' ? true : (0, semver_1.satisfies)(selectedVersion, constants_1.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE_ARM64)) ? `-minimal${(0, semver_1.satisfies)(selectedVersion, constants_1.MYSQL_LINUX_MINIMAL_REBUILD_VERSIONS) ? '-rebuild' : ''}` : ''}.tar.${fileExtension}`;
+    }
     return {
-        url: v.url,
-        version: v.version
+        version: selectedVersion,
+        url: constants_1.archiveBaseURL + fileLocation
     };
 }

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,13 +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;
 };
 export type ExecuteFileReturn = {
     error: ExecFileException | null;
@@ -61,13 +50,6 @@ export type MySQLDB = {
     };
     stop: () => Promise<void>;
 };
-export type MySQLVersion = {
-    version: string;
-    arch: string;
-    os: string;
-    osKernelVersionsSupported: string;
-    url: string;
-};
 export type DownloadedMySQLVersion = {
     version: string;
     path: string;
@@ -84,3 +66,17 @@ export type OptionTypeChecks = {
         definedType: "string" | "boolean" | "number";
     };
 };
+export type LinuxEtcOSRelease = {
+    PRETTY_NAME?: string;
+    NAME?: string;
+    VERSION_ID?: string;
+    VERSION?: string;
+    VERSION_CODENAME?: string;
+    ID?: string;
+    ID_LIKE?: string;
+    UBUNTU_CODENAME?: string;
+};
+export type JSRuntimeVersion = {
+    runtimeName: string;
+    runtimeVersion: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -16,9 +16,9 @@
     "memory database"
   ],
   "scripts": {
-    "test": "jest --testPathIgnorePatterns=/stress-tests/ --verbose --colors",
-    "test:ci": "jest --testPathIgnorePatterns=/stress-tests/ --setupFilesAfterEnv ./ciSetup.js --verbose --colors",
-    "stress": "jest --runTestsByPath stress-tests/stress.test.ts --setupFilesAfterEnv ./ciSetup.js --verbose --colors"
+    "test": "jest --verbose --colors",
+    "test:ci": "jest --setupFilesAfterEnv ./ciSetup.js --verbose --colors --runTestsByPath tests/concurrency.test.ts",
+    "os-compat:ci": "jest --setupFilesAfterEnv ./ciSetup.js --verbose --colors --runTestsByPath tests/versions.test.ts"
   },
   "engines": {
     "node": ">=16.6.0",
@@ -31,16 +31,16 @@
     "@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",
-    "semver": "^7.6.3",
+    "semver": "^7.7.1",
     "signal-exit": "^4.1.0"
   },
   "repository": {