mysql-memory-server 1.11.0 → 1.12.0

package/README.md

@@ -15,9 +15,9 @@ Download with your package manager of choice. The package name is `mysql-memory-
 #### Currently supported MySQL versions
 
 - ```mysql-memory-server``` can run MySQL versions 5.7.19 and newer (if the version is already installed on your system)
-- ```mysql-memory-server``` can download and run MySQL versions 5.7.19 - 5.7.44, 8.0.0 - 8.0.43, 8.1.0 - 8.4.6, and 9.0.1 - 9.4.0 (if the version is not already installed on your system - all version numbers are inclusive)
+- ```mysql-memory-server``` can download and run MySQL versions (inclusive) 5.7.19 - 5.7.44, 8.0.0 - 8.0.43, 8.1.0 - 8.4.6, and 9.0.1 - 9.4.0 (if the version is not already installed on your system)
 
-Extra system requirements apply when ```mysql-memory-server``` is downloading MySQL instead of running a version of MySQL that is already installed on the system. To see the requirements and learn more about the supported versions for download, [read the doc](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.11.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md)
+Extra system requirements apply when ```mysql-memory-server``` is downloading MySQL instead of running a version of MySQL that is already installed on the system. To see the requirements and learn more about the supported versions for download, [read the doc](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.12.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md)
 
 ## Example Usage - Application Code
 
@@ -78,7 +78,7 @@ npx mysql-memory-server@latest --version 8.4.x
 - `port: number`
 The port that the MySQL database is listening on
 - `xPort: number`
-The port that MySQLX is listening on
+The port that MySQLX is listening on. If ```options.xEnabled``` is set to "OFF", this value will be -1.
 - `dbName: string`
 The database that was created on database initialization
 - `username: string`
@@ -86,9 +86,9 @@ The name of the user to use to login to the database
 - `socket: string`
 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.
+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. If ```options.xEnabled``` is set to "OFF", this value will be an empty string.
 - `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.
+An object with three 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.
 
@@ -102,11 +102,11 @@ Description: Version of MySQL to use for the database. Uses semver for getting t
 
 If left undefined:
 - If the system has MySQL installed, the system-installed version will be used. If the installed version is not supported by this package (currently <5.7.19), an error will be thrown unless `ignoreUnsupportedSystemVersion` is set to `true`.
-- If the system does not have MySQL installed, the latest version of MySQL that [this package supports downloading](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.11.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md) will be downloaded.
+- If the system does not have MySQL installed, the latest version of MySQL that [this package supports downloading](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.12.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md) will be downloaded.
 
 If defined:
 - If the version is older than 5.7.19, an error will be thrown as this package does not currently support those versions of MySQL.
-- If the desired version of MySQL is already installed on the system, the installed version will be used. Otherwise the selected version will be downloaded as long as this package [supports downloading it](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.11.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md). If this package does not support downloading the selected version, or your system does not [meet the requirements](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.11.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md) for that version to be ran, an error will be thrown.
+- If the desired version of MySQL is already installed on the system, the installed version will be used. Otherwise the selected version will be downloaded as long as this package [supports downloading it](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.12.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md). If this package does not support downloading the selected version, or your system does not [meet the requirements](https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/blob/v1.12.0/docs/SUPPORTED_MYSQL_DOWNLOADS.md) for that version to be ran, an error will be thrown.
 
 - `dbName: string`
 
@@ -189,3 +189,9 @@ 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.
+
+- `xEnabled: "OFF" | "FORCE"`
+
+Default: "FORCE"
+
+Description: This option follows the convention set out by the [MySQL Documentation](https://dev.mysql.com/doc/refman/en/plugin-loading.html). If set to "OFF", the MySQL X Plugin will not initialise. If set to "FORCE", the MySQL Server will either start up with the MySQL X Plugin guaranteed to have successfully initialised, or if initialisation fails, the server will fail to start up.

package/dist/src/constants.d.ts

@@ -15,8 +15,8 @@ declare const internalOptions: {
 export declare function getInternalEnvVariable(envVar: keyof typeof internalOptions): string;
 export declare const OPTION_TYPE_CHECKS: OptionTypeChecks;
 export declare const MIN_SUPPORTED_MYSQL = "5.7.19";
-export declare const downloadsBaseURL = "https://cdn.mysql.com//Downloads/MySQL-";
-export declare const archiveBaseURL = "https://cdn.mysql.com/archives/mysql-";
+export declare const MySQLCDNDownloadsBaseURL = "https://cdn.mysql.com//Downloads/MySQL-";
+export declare const MySQLCDNArchivesBaseURL = "https://cdn.mysql.com/archives/mysql-";
 export declare const DOWNLOADABLE_MYSQL_VERSIONS: readonly ["5.7.19", "5.7.20", "5.7.21", "5.7.22", "5.7.23", "5.7.24", "5.7.25", "5.7.26", "5.7.27", "5.7.28", "5.7.29", "5.7.30", "5.7.31", "5.7.32", "5.7.33", "5.7.34", "5.7.35", "5.7.36", "5.7.37", "5.7.38", "5.7.39", "5.7.40", "5.7.41", "5.7.42", "5.7.43", "5.7.44", "8.0.0", "8.0.1", "8.0.2", "8.0.3", "8.0.4", "8.0.11", "8.0.12", "8.0.13", "8.0.14", "8.0.15", "8.0.16", "8.0.17", "8.0.18", "8.0.19", "8.0.20", "8.0.21", "8.0.22", "8.0.23", "8.0.24", "8.0.25", "8.0.26", "8.0.27", "8.0.28", "8.0.30", "8.0.31", "8.0.32", "8.0.33", "8.0.34", "8.0.35", "8.0.36", "8.0.37", "8.0.39", "8.0.40", "8.0.41", "8.0.42", "8.0.43", "8.1.0", "8.2.0", "8.3.0", "8.4.0", "8.4.2", "8.4.3", "8.4.4", "8.4.5", "8.4.6", "9.0.1", "9.1.0", "9.2.0", "9.3.0", "9.4.0"];
 export declare const MYSQL_ARCH_SUPPORT: {
     readonly darwin: {

package/dist/src/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MYSQL_LINUX_MINIMAL_REBUILD_VERSIONS = exports.MYSQL_LINUX_FILE_EXTENSIONS = exports.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE_ARM64 = exports.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE = exports.MYSQL_LINUX_GLIBC_VERSIONS = exports.MYSQL_MACOS_VERSIONS_IN_FILENAME = exports.RC_MYSQL_VERSIONS = exports.DMR_MYSQL_VERSIONS = exports.MYSQL_MIN_OS_SUPPORT = exports.MYSQL_ARCH_SUPPORT = exports.DOWNLOADABLE_MYSQL_VERSIONS = exports.archiveBaseURL = exports.downloadsBaseURL = exports.MIN_SUPPORTED_MYSQL = exports.OPTION_TYPE_CHECKS = exports.LOG_LEVELS = exports.DEFAULT_OPTIONS_KEYS = exports.DEFAULT_OPTIONS = void 0;
+exports.MYSQL_LINUX_MINIMAL_REBUILD_VERSIONS = exports.MYSQL_LINUX_FILE_EXTENSIONS = exports.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE_ARM64 = exports.MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE = exports.MYSQL_LINUX_GLIBC_VERSIONS = exports.MYSQL_MACOS_VERSIONS_IN_FILENAME = exports.RC_MYSQL_VERSIONS = exports.DMR_MYSQL_VERSIONS = exports.MYSQL_MIN_OS_SUPPORT = exports.MYSQL_ARCH_SUPPORT = exports.DOWNLOADABLE_MYSQL_VERSIONS = exports.MySQLCDNArchivesBaseURL = exports.MySQLCDNDownloadsBaseURL = exports.MIN_SUPPORTED_MYSQL = exports.OPTION_TYPE_CHECKS = exports.LOG_LEVELS = exports.DEFAULT_OPTIONS_KEYS = exports.DEFAULT_OPTIONS = void 0;
 exports.getInternalEnvVariable = getInternalEnvVariable;
 const path_1 = require("path");
 const os_1 = require("os");
@@ -19,7 +19,8 @@ exports.DEFAULT_OPTIONS = {
     xPort: 0,
     downloadRetries: 10,
     initSQLString: '',
-    arch: process.arch
+    arch: process.arch,
+    xEnabled: 'FORCE'
 };
 exports.DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(exports.DEFAULT_OPTIONS));
 exports.LOG_LEVELS = {
@@ -38,6 +39,7 @@ function getInternalEnvVariable(envVar) {
     return process.env['mysqlmsn_internal_DO_NOT_USE_' + envVar] || internalOptions[envVar];
 }
 const allowedArches = ['x64', 'arm64'];
+const pluginActivationStates = ['OFF', 'FORCE'];
 exports.OPTION_TYPE_CHECKS = {
     version: {
         check: (opt) => opt === undefined || typeof opt === 'string' && (0, semver_1.valid)((0, semver_1.coerce)(opt)) !== null,
@@ -108,11 +110,16 @@ exports.OPTION_TYPE_CHECKS = {
         check: (opt) => opt === undefined || allowedArches.includes(opt),
         errorMessage: `Option arch must be either of the following: ${allowedArches.join(', ')}`,
         definedType: 'string'
+    },
+    xEnabled: {
+        check: (opt) => opt === undefined || pluginActivationStates.includes(opt),
+        errorMessage: `xEnabled must be either undefined or one of the following: ${pluginActivationStates.join(', ')}`,
+        definedType: 'boolean'
     }
 };
 exports.MIN_SUPPORTED_MYSQL = '5.7.19';
-exports.downloadsBaseURL = 'https://cdn.mysql.com//Downloads/MySQL-';
-exports.archiveBaseURL = 'https://cdn.mysql.com/archives/mysql-';
+exports.MySQLCDNDownloadsBaseURL = 'https://cdn.mysql.com//Downloads/MySQL-';
+exports.MySQLCDNArchivesBaseURL = 'https://cdn.mysql.com/archives/mysql-';
 // Versions 8.0.29, 8.0.38, 8.4.1, and 9.0.0 have been purposefully left out of this list as MySQL has removed them from the CDN due to critical issues.
 exports.DOWNLOADABLE_MYSQL_VERSIONS = [
     '5.7.19', '5.7.20', '5.7.21', '5.7.22', '5.7.23', '5.7.24', '5.7.25', '5.7.26', '5.7.27', '5.7.28', '5.7.29', '5.7.30', '5.7.31', '5.7.32', '5.7.33', '5.7.34', '5.7.35', '5.7.36', '5.7.37', '5.7.38', '5.7.39', '5.7.40', '5.7.41', '5.7.42', '5.7.43', '5.7.44',

package/dist/src/index.js

@@ -10,6 +10,7 @@ const semver_1 = require("semver");
 const Version_1 = __importDefault(require("./libraries/Version"));
 const Downloader_1 = require("./libraries/Downloader");
 const constants_1 = require("./constants");
+const LinuxOSRelease_1 = __importDefault(require("./libraries/LinuxOSRelease"));
 async function createDB(opts) {
     const suppliedOpts = opts || {};
     const suppliedOptsKeys = Object.keys(suppliedOpts);
@@ -34,7 +35,7 @@ async function createDB(opts) {
     if (throwUnsupportedError) {
         throw `A version of MySQL is installed on your system that is not supported by this package. If you want to download a MySQL binary instead of getting this error, please set the option "ignoreUnsupportedSystemVersion" to true.`;
     }
-    logger.log('Version currently installed:', version);
+    logger.log('Version currently installed:', version, 'Platform:', process.platform, 'etcOSRelease:', LinuxOSRelease_1.default);
     if (version === null || (options.version && !(0, semver_1.satisfies)(version.version, options.version)) || unsupportedMySQLIsInstalled) {
         let binaryInfo;
         let binaryFilepath;
@@ -47,7 +48,7 @@ async function createDB(opts) {
             throw `Failed to download binary. The error was: "${error}"`;
         }
         logger.log('Running downloaded binary');
-        return await executor.startMySQL(options, { path: binaryFilepath, version: binaryInfo.version, installedOnSystem: false });
+        return await executor.startMySQL(options, { path: binaryFilepath, version: binaryInfo.version, installedOnSystem: false, xPluginSupported: binaryInfo.xPluginSupported });
     }
     else {
         logger.log(version);

package/dist/src/libraries/Downloader.js

@@ -56,6 +56,36 @@ function handleTarExtraction(filepath, extractedPath) {
         });
     });
 }
+function getFileDownloadURLRedirect(url) {
+    const options = {
+        headers: {
+            'accept': '*/*',
+            'connection': 'keep-alive'
+        }
+    };
+    return new Promise((resolve, reject) => {
+        const request = https.get(url, options, response => {
+            const statusCode = response.statusCode;
+            const location = response.headers.location;
+            if (statusCode !== 302) {
+                request.destroy();
+                reject(`Received status code ${statusCode} while getting redirect URL for binary download. Used URL: ${url}`);
+                return;
+            }
+            if (typeof location === 'string' && location.length > 0) {
+                request.destroy();
+                resolve(location);
+                return;
+            }
+            request.destroy();
+            reject(`Received incorrect URL information. Expected a non-empty string. Received: ${JSON.stringify(location)}`);
+        });
+        request.on('error', (err) => {
+            request.destroy();
+            reject(err.message);
+        });
+    });
+}
 function downloadFromCDN(url, downloadLocation, logger) {
     return new Promise(async (resolve, reject) => {
         if (fs.existsSync(downloadLocation)) {
@@ -139,7 +169,7 @@ function promisifiedZipExtraction(archiveLocation, extractedLocation) {
         });
     });
 }
-function extractBinary(url, archiveLocation, extractedLocation, logger) {
+function extractBinary(url, archiveLocation, extractedLocation, binaryInfo, logger) {
     return new Promise(async (resolve, reject) => {
         if (fs.existsSync(extractedLocation)) {
             logger.warn('Removing item at extractedLocation:', extractedLocation, 'so the MySQL binary can be stored there. This is probably because a previous download/extraction failed.');
@@ -148,12 +178,18 @@ function extractBinary(url, archiveLocation, extractedLocation, logger) {
         const lastDashIndex = url.lastIndexOf('-');
         const fileExtension = url.slice(lastDashIndex).split('.').splice(1).join('.');
         await fsPromises.mkdir(extractedLocation, { recursive: true });
-        const splitURL = url.split('/');
-        const mySQLFolderName = splitURL[splitURL.length - 1];
-        if (!mySQLFolderName) {
-            return reject(`Folder name is undefined for url: ${url}`);
+        let folderName = '';
+        if (binaryInfo.hostedByOracle) {
+            const splitURL = url.split('/');
+            const mySQLFolderName = splitURL[splitURL.length - 1];
+            if (!mySQLFolderName) {
+                return reject(`Folder name is undefined for url: ${url}`);
+            }
+            folderName = mySQLFolderName.replace(`.${fileExtension}`, '');
+        }
+        else {
+            folderName = `mysql-${binaryInfo.version}`;
         }
-        const folderName = mySQLFolderName.replace(`.${fileExtension}`, '');
         let extractionError = undefined;
         if (fileExtension === 'zip') {
             //Only Windows MySQL files use the .zip extension
@@ -255,13 +291,13 @@ function downloadBinary(binaryInfo, options, logger) {
             let downloadTries = 0;
             let useDownloadsURL = false;
             do {
+                const downloadURL = binaryInfo.hostedByOracle ? `${useDownloadsURL ? constants_1.MySQLCDNDownloadsBaseURL : constants_1.MySQLCDNArchivesBaseURL}${url}` : await getFileDownloadURLRedirect(url);
                 try {
                     downloadTries++;
-                    const downloadURL = useDownloadsURL ? url.replace(constants_1.archiveBaseURL, constants_1.downloadsBaseURL) : url;
                     logger.log(`Starting download for MySQL version ${version} from ${downloadURL}.`);
                     await downloadFromCDN(downloadURL, archivePath, logger);
                     logger.log(`Finished downloading MySQL version ${version} from ${downloadURL}. Now starting binary extraction.`);
-                    await extractBinary(downloadURL, archivePath, extractedPath, logger);
+                    await extractBinary(downloadURL, archivePath, extractedPath, binaryInfo, logger);
                     logger.log(`Finished extraction for version ${version}`);
                     break;
                 }
@@ -276,12 +312,12 @@ function downloadBinary(binaryInfo, options, logger) {
                     catch (e) {
                         logger.error('An error occurred while deleting extractedPath and/or archivePath:', e);
                     }
-                    if (e?.includes?.('status code 404')) {
-                        if (!useDownloadsURL) {
-                            //Retry with downloads URL
-                            downloadTries--;
+                    // If we got a 404 error while downloading a binary from Oracle and have not retried with the Downloads URL yet
+                    // then retry with the Downloads URL. Otherwise, reject.
+                    if (e?.includes('status code 404')) {
+                        if (binaryInfo.hostedByOracle && useDownloadsURL === false) {
                             useDownloadsURL = true;
-                            logger.log(`Encountered error 404 when using archives URL for version ${version}. Now retrying with the downloads URL.`);
+                            downloadTries--;
                             continue;
                         }
                         else {
@@ -289,9 +325,11 @@ function downloadBinary(binaryInfo, options, logger) {
                                 await releaseFunction();
                             }
                             catch (e) {
-                                logger.error('An error occurred while releasing lock after receiving a 404 error on both downloads and archives URLs. The error was:', e);
+                                logger.error('An error occurred while releasing lock after receiving a 404 error on download. The error was:', e);
+                            }
+                            finally {
+                                return reject(`Binary download for MySQL version ${binaryInfo.version} returned status code 404 at URL ${downloadURL}. Aborting download.`);
                             }
-                            return reject(`Both URLs for MySQL version ${binaryInfo.version} returned status code 404. Aborting download.`);
                         }
                     }
                     if (downloadTries > options.downloadRetries) {
@@ -322,17 +360,17 @@ function downloadBinary(binaryInfo, options, logger) {
             let downloadTries = 0;
             let useDownloadsURL = false;
             do {
+                const downloadURL = binaryInfo.hostedByOracle ? `${useDownloadsURL ? constants_1.MySQLCDNDownloadsBaseURL : constants_1.MySQLCDNArchivesBaseURL}${url}` : await getFileDownloadURLRedirect(url);
                 const uuid = (0, crypto_1.randomUUID)();
                 const zipFilepath = `${dirpath}/${uuid}.${fileExtension}`;
                 logger.log('Binary filepath:', zipFilepath);
                 const extractedPath = `${dirpath}/${uuid}`;
                 try {
                     downloadTries++;
-                    const downloadURL = useDownloadsURL ? url.replace(constants_1.archiveBaseURL, constants_1.downloadsBaseURL) : url;
                     logger.log(`Starting download for MySQL version ${version} from ${downloadURL}.`);
                     await downloadFromCDN(downloadURL, zipFilepath, logger);
                     logger.log(`Finished downloading MySQL version ${version} from ${downloadURL}. Now starting binary extraction.`);
-                    const binaryPath = await extractBinary(downloadURL, zipFilepath, extractedPath, logger);
+                    const binaryPath = await extractBinary(downloadURL, zipFilepath, extractedPath, binaryInfo, logger);
                     logger.log(`Finished extraction for version ${version}`);
                     return resolve(binaryPath);
                 }
@@ -347,16 +385,16 @@ function downloadBinary(binaryInfo, options, logger) {
                     catch (e) {
                         logger.error('An error occurred while deleting extractedPath and/or archivePath:', e);
                     }
-                    if (e?.includes?.('status code 404')) {
-                        if (!useDownloadsURL) {
-                            //Retry with downloads URL
-                            downloadTries--;
+                    // If we got a 404 error while downloading a binary from Oracle and have not retried with the Downloads URL yet
+                    // then retry with the Downloads URL. Otherwise, reject.
+                    if (e?.includes('status code 404')) {
+                        if (binaryInfo.hostedByOracle && useDownloadsURL === false) {
                             useDownloadsURL = true;
-                            logger.log(`Encountered error 404 when using archives URL for version ${version}. Now retrying with the downloads URL.`);
+                            downloadTries--;
                             continue;
                         }
                         else {
-                            return reject(`Both URLs for MySQL version ${binaryInfo.version} returned status code 404. Aborting download.`);
+                            return reject(`Binary download for MySQL version ${binaryInfo.version} returned status code 404 at URL ${downloadURL}. Aborting download.`);
                         }
                     }
                     if (downloadTries > options.downloadRetries) {

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

@@ -7,6 +7,7 @@ declare class Executor {
     removeExitHandler: () => void;
     version: string;
     versionInstalledOnSystem: boolean;
+    versionSupportsMySQLX: boolean;
     databasePath: string;
     killedFromPortIssue: boolean;
     constructor(logger: Logger);

package/dist/src/libraries/Executor.js

@@ -37,9 +37,6 @@ 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 __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");
@@ -53,7 +50,7 @@ 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"));
+const LinuxOSRelease_1 = __importStar(require("./LinuxOSRelease"));
 class Executor {
     constructor(logger) {
         _Executor_instances.add(this);
@@ -94,7 +91,7 @@ class Executor {
                             return reject('Could not get MySQL version');
                         }
                         else {
-                            versions.push({ version: version.version, path, installedOnSystem: true });
+                            versions.push({ version: version.version, path, installedOnSystem: true, xPluginSupported: (0, semver_1.gte)(version, '5.7.19') });
                         }
                     }
                     if (preferredVersion) {
@@ -124,15 +121,22 @@ class Executor {
                         reject('Could not get installed MySQL version');
                     }
                     else {
-                        resolve({ version: version.version, path: 'mysqld', installedOnSystem: true });
+                        resolve({ version: version.version, path: 'mysqld', installedOnSystem: true, xPluginSupported: (0, semver_1.gte)(version, '5.7.19') });
                     }
                 }
             }
         });
     }
     async startMySQL(options, installedMySQLBinary) {
+        if (installedMySQLBinary.xPluginSupported === false && options.xEnabled === 'FORCE') {
+            if (LinuxOSRelease_1.isOnAlpineLinux) {
+                throw "options.xEnabled is set to 'FORCE'. You are running this package on Alpine Linux. The MySQL binaries for Alpine Linux do not support the MySQL X Plugin. If you don't want to use the MySQL X Plugin, please set options.xEnabled to 'OFF' and that will remove this error message. If you must have MySQL X enabled for each database creation, please use a different OS to run this package.";
+            }
+            throw "options.xEnabled is set to 'FORCE'. The version of MySQL you are using does not support MySQL X. If you don't want to use the MySQL X Plugin, please set options.xEnabled to 'OFF'. Otherwise, if MySQL X is required, please use a different version of MySQL that supports the X plugin.";
+        }
         this.version = installedMySQLBinary.version;
         this.versionInstalledOnSystem = installedMySQLBinary.installedOnSystem;
+        this.versionSupportsMySQLX = installedMySQLBinary.xPluginSupported;
         this.removeExitHandler = (0, signal_exit_1.onExit)(() => {
             if ((0, constants_1.getInternalEnvVariable)('cli') === 'true') {
                 console.log('\nShutting down the ephemeral MySQL database and cleaning all related files...');
@@ -165,12 +169,9 @@ class Executor {
         do {
             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, this.databasePath, installedMySQLBinary.path);
+                const resolved = await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_startMySQLProcess).call(this, options, datadir, this.databasePath, installedMySQLBinary.path);
                 this.logger.log('Starting process was successful');
                 return resolved;
             }
@@ -182,7 +183,7 @@ class Executor {
                 }
                 retries++;
                 if (retries <= options.portRetries) {
-                    this.logger.warn(`One or both of these ports are already in use: ${port} or ${mySQLXPort}. Now retrying... ${retries}/${options.portRetries} possible retries.`);
+                    this.logger.warn(`Tried a port that is already in use. Now retrying... ${retries}/${options.portRetries} possible retries.`);
                 }
                 else {
                     throw `The port has been retried ${options.portRetries} times and a free port could not be found.\nEither try again, or if this is a common issue, increase options.portRetries.`;
@@ -221,21 +222,20 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
         return splitPath.join('/');
     }
     return null;
-}, _Executor_startMySQLProcess = function _Executor_startMySQLProcess(options, port, mySQLXPort, datadir, dbPath, binaryFilepath) {
+}, _Executor_startMySQLProcess = function _Executor_startMySQLProcess(options, datadir, dbPath, binaryFilepath) {
     const errors = [];
     const logFile = `${dbPath}/log.log`;
     const errorLogFile = `${datadir}/errorlog.err`;
+    const port = options.port || (0, Port_1.GenerateRandomPort)();
+    const mySQLXPort = options.xPort || (0, Port_1.GenerateRandomPort)();
     return new Promise(async (resolve, reject) => {
         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 mysqlArguments = [
             '--no-defaults',
-            '--mysqlx=FORCE',
             `--port=${port}`,
             `--datadir=${datadir}`,
-            `--mysqlx-port=${mySQLXPort}`,
-            `--mysqlx-socket=${xSocket}`,
             `--socket=${socket}`,
             `--general-log-file=${logFile}`,
             '--general-log=1',
@@ -245,24 +245,31 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             `--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.';
+        if (this.versionSupportsMySQLX) {
+            mysqlArguments.push(`--mysqlx=${options.xEnabled}`);
+        }
+        if (options.xEnabled !== 'OFF') {
+            mysqlArguments.push(`--mysqlx-port=${mySQLXPort}`);
+            mysqlArguments.push(`--mysqlx-socket=${xSocket}`);
+            //<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};`);
             }
-            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.
@@ -270,6 +277,10 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
         //Once ran, resolveFunction will be called.
         let resolveFunction;
         process.on('close', async (code, signal) => {
+            // Prevent open file watches when MySQL has been exited
+            // The file watch is only stopped if MySQL starts successfully
+            // This unwatch will prevent the watch from watching when the process has stopped.
+            fs.unwatchFile(errorLogFile);
             if (signal) {
                 this.logger.log('Exiting because of aborted signal.');
                 return;
@@ -361,11 +372,11 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                         }
                         return; //Promise rejection will be handled in the process.on('close') section because this.killedFromPortIssue is being set to true
                     }
-                    resolve({
+                    const result = {
                         port,
-                        xPort: mySQLXPort,
+                        xPort: options.xEnabled === 'FORCE' ? mySQLXPort : -1,
                         socket,
-                        xSocket,
+                        xSocket: options.xEnabled === 'FORCE' ? xSocket : '',
                         dbName: options.dbName,
                         username: options.username,
                         mysql: {
@@ -382,7 +393,8 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                                 }
                             });
                         }
-                    });
+                    };
+                    resolve(result);
                 }
             }
         });

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

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

package/dist/src/libraries/LinuxOSRelease.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOnAlpineLinux = void 0;
 const fs_1 = __importDefault(require("fs"));
 const releaseDetails = {};
 if (process.platform === 'linux') {
@@ -15,4 +16,5 @@ if (process.platform === 'linux') {
         }
     }
 }
+exports.isOnAlpineLinux = process.platform === 'linux' && releaseDetails?.ID === 'alpine';
 exports.default = releaseDetails;

package/dist/src/libraries/Port.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateRandomPort = GenerateRandomPort;
+const crypto_1 = require("crypto");
 function GenerateRandomPort() {
-    return Math.floor(Math.random() * (65535 - 1024) + 1025);
+    //Min is inclusive and max is exclusive. Inclusive range would be 1025 - 65535
+    return (0, crypto_1.randomInt)(1025, 65536);
 }

package/dist/src/libraries/Version.js

@@ -32,15 +32,12 @@ 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");
 const constants_1 = require("../constants");
-const LinuxOSRelease_1 = __importDefault(require("./LinuxOSRelease"));
+const LinuxOSRelease_1 = __importStar(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) {
@@ -85,16 +82,25 @@ function getBinaryURL(versionToGet = "x", currentArch) {
         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.`;
+    if (process.platform === 'linux') {
+        if (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.`;
+            }
+        }
+        else if (LinuxOSRelease_1.isOnAlpineLinux) {
+            //https://github.com/Sebastian-Webster/mysql-server-musl-binaries only has support for v8.4.x and 9.x binaries
+            selectedVersions = selectedVersions.filter(v => (0, semver_1.satisfies)(v, '8.4.x') || (0, semver_1.satisfies)(v, '9.x'));
+            if (selectedVersions.length === 0) {
+                throw 'mysql-memory-server has detected you are running this package on Alpine Linux. The source for MySQL with musl libc only provides binaries for MySQL 8.4.x and 9.x and as such only those versions can be used with this package. Please use 8.4.x or 9.x.';
+            }
+        }
     }
     //Sorts versions in descending order
     selectedVersions.sort((a, b) => a < b ? 1 : -1);
@@ -102,6 +108,7 @@ function getBinaryURL(versionToGet = "x", currentArch) {
     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 = '';
+    let xPluginSupported = true;
     if (currentOS === 'win32') {
         fileLocation = `${(0, semver_1.major)(selectedVersion)}.${(0, semver_1.minor)(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-winx64.zip`;
     }
@@ -110,6 +117,10 @@ function getBinaryURL(versionToGet = "x", currentArch) {
         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 (LinuxOSRelease_1.isOnAlpineLinux) {
+        fileLocation = `https://github.com/Sebastian-Webster/mysql-server-musl-binaries/releases/download/current/mysql-musl-${selectedVersion}-${currentArch === 'x64' ? 'x86_64' : 'arm64'}.tar.gz`;
+        xPluginSupported = false;
+    }
     else if (currentOS === 'linux') {
         const glibcObject = constants_1.MYSQL_LINUX_GLIBC_VERSIONS[currentArch];
         const glibcVersionKeys = Object.keys(glibcObject);
@@ -124,8 +135,13 @@ function getBinaryURL(versionToGet = "x", currentArch) {
         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}`;
     }
+    else {
+        throw 'You are running this package on an unsupported OS. Please use either Windows, macOS, or a Linux-based OS.';
+    }
     return {
         version: selectedVersion,
-        url: constants_1.archiveBaseURL + fileLocation
+        url: fileLocation,
+        hostedByOracle: !LinuxOSRelease_1.isOnAlpineLinux, // Only the Alpine Linux binaries are not hosted on the MySQL CDN.
+        xPluginSupported
     };
 }

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import { ExecFileException } from "child_process";
 export type LOG_LEVEL = 'LOG' | 'WARN' | 'ERROR';
+export type PluginActivationState = 'OFF' | 'FORCE';
 export type ServerOptions = {
     version?: string | undefined;
     dbName?: string | undefined;
@@ -15,6 +16,7 @@ export type ServerOptions = {
     downloadRetries?: number | undefined;
     initSQLString?: string | undefined;
     arch?: "arm64" | "x64" | undefined;
+    xEnabled?: PluginActivationState | undefined;
 };
 export type InternalServerOptions = {
     version?: string | undefined;
@@ -31,6 +33,7 @@ export type InternalServerOptions = {
     downloadRetries: number;
     initSQLString: string;
     arch: string;
+    xEnabled: PluginActivationState;
 };
 export type ExecuteFileReturn = {
     error: ExecFileException | null;
@@ -54,10 +57,13 @@ export type DownloadedMySQLVersion = {
     version: string;
     path: string;
     installedOnSystem: boolean;
+    xPluginSupported: boolean;
 };
 export type BinaryInfo = {
     url: string;
     version: string;
+    hostedByOracle: boolean;
+    xPluginSupported: boolean;
 };
 export type OptionTypeChecks = {
     [key in keyof Required<ServerOptions>]: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -17,8 +17,8 @@
   ],
   "scripts": {
     "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"
+    "test:ci": "jest tests/ci --setupFilesAfterEnv ./ciSetup.js --verbose --colors",
+    "os-compat:ci": "jest tests/versions.test.ts --setupFilesAfterEnv ./ciSetup.js --verbose --colors"
   },
   "engines": {
     "node": ">=16.6.0",
@@ -31,12 +31,12 @@
     "@babel/preset-env": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^24.0.10",
+    "@types/node": "^24.1.0",
     "@types/semver": "^7.7.0",
-    "babel-jest": "^30.0.4",
-    "jest": "^30.0.4",
-    "mysql2": "^3.14.1",
-    "typescript": "^5.8.3"
+    "babel-jest": "^30.0.5",
+    "jest": "^30.0.5",
+    "mysql2": "^3.14.3",
+    "typescript": "^5.9.2"
   },
   "dependencies": {
     "adm-zip": "^0.5.16",