mysql-memory-server 1.4.3 → 1.5.0

package/README.md

@@ -10,7 +10,7 @@ Download with your package manager of choice. The package name is `mysql-memory-
 
 #### Requirements
 
-- Node.js 16.6.0 and newer
+- Node.js >=16.6.0 or Bun >= 1.0.0
 - 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.)
 
 #### Requirements for downloaded MySQL versions
@@ -186,6 +186,14 @@ Default: false
 
 Description: This option only applies if the system-installed MySQL version is lower than the oldest supported MySQL version for this package (8.0.20) and the `version` option is not defined. If set to `true`, this package will use the latest version of MySQL instead of the system-installed version. If `false`, the package will throw an error.
 
+- `downloadRetries: number`
+
+Required: No
+
+Default: 3
+
+Description: The number of times to try to download a MySQL binary before giving up and rejecting the `createDB()` promise.
+
 ***
 ### :warning: Internal Options :warning:
 

package/dist/src/index.js

@@ -52,7 +52,8 @@ async function createDB(opts) {
         ignoreUnsupportedSystemVersion: false,
         port: 0,
         xPort: 0,
-        binaryDirectoryPath: `${os.tmpdir()}/mysqlmsn/binaries`
+        binaryDirectoryPath: `${os.tmpdir()}/mysqlmsn/binaries`,
+        downloadRetries: 10
     };
     const options = { ...defaultOptions, ...opts };
     const logger = new Logger_1.default(options.logLevel);

package/dist/src/libraries/Downloader.js

@@ -75,12 +75,37 @@ function downloadVersions() {
     });
 }
 function downloadFromCDN(url, downloadLocation, logger) {
-    return new Promise((resolve, reject) => {
+    return new Promise(async (resolve, reject) => {
+        if (fs.existsSync(downloadLocation)) {
+            logger.warn('Removing item at downloadLocation:', downloadLocation, 'so the MySQL binary archive can be stored there. This is probably because a previous download/extraction failed.');
+            await fsPromises.rm(downloadLocation, { recursive: true, force: true });
+        }
         const fileStream = fs.createWriteStream(downloadLocation);
         let error;
         fileStream.on('open', () => {
             const request = https.get(url, (response) => {
-                response.pipe(fileStream);
+                if (response.statusCode !== 200) {
+                    fileStream.close((err) => {
+                        if (err) {
+                            logger.error('An error occurred while closing the fileStream for non-200 status code. The error was:', err);
+                        }
+                        fs.unlink(downloadLocation, (unlinkErr) => {
+                            if (unlinkErr) {
+                                logger.error('An error occurred while deleting downloadLocation after non-200 status code download attempt. The error was:', err);
+                            }
+                            logger.error('Received status code:', response.statusCode, 'while downloading MySQL binary.');
+                            reject(`Received status code ${response.statusCode} while downloading MySQL binary.`);
+                        });
+                    });
+                }
+                else {
+                    response.pipe(fileStream);
+                    fileStream.on('finish', () => {
+                        if (!error) {
+                            resolve();
+                        }
+                    });
+                }
             });
             request.on('error', (err) => {
                 error = err;
@@ -95,11 +120,6 @@ function downloadFromCDN(url, downloadLocation, logger) {
                 });
             });
         });
-        fileStream.on('finish', () => {
-            if (!error) {
-                resolve();
-            }
-        });
         fileStream.on('error', (err) => {
             error = err;
             logger.error(err);
@@ -116,6 +136,10 @@ function downloadFromCDN(url, downloadLocation, logger) {
 }
 function extractBinary(url, archiveLocation, extractedLocation, 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.');
+            await fsPromises.rm(extractedLocation, { recursive: true, force: true });
+        }
         const lastDashIndex = url.lastIndexOf('-');
         const fileExtension = url.slice(lastDashIndex).split('.').splice(1).join('.');
         await fsPromises.mkdir(extractedLocation, { recursive: true });
@@ -167,7 +191,8 @@ function extractBinary(url, archiveLocation, extractedLocation, logger) {
                 resolve(`${extractedLocation}/mysql/bin/mysqld`);
             }
         }).catch(error => {
-            reject(`An error occurred while extracting the tar file. Please make sure tar is installed and there is enough storage space for the extraction. The error was: ${error}`);
+            logger.error(`An error occurred while extracting the tar file. Please make sure tar is installed and there is enough storage space for the extraction. The error was: ${error}`);
+            reject(error);
         });
     });
 }
@@ -190,8 +215,7 @@ function downloadBinary(binaryInfo, options, logger) {
             let releaseFunction;
             while (true) {
                 try {
-                    await fsPromises.mkdir(extractedPath, { recursive: true });
-                    releaseFunction = (0, proper_lockfile_1.lockSync)(extractedPath);
+                    releaseFunction = (0, proper_lockfile_1.lockSync)(extractedPath, { realpath: false });
                     break;
                 }
                 catch (e) {
@@ -210,54 +234,82 @@ function downloadBinary(binaryInfo, options, logger) {
                 }
             }
             //The code below only runs if the lock has been acquired by us
-            try {
-                await downloadFromCDN(url, archivePath, logger);
-                await extractBinary(url, archivePath, extractedPath, logger);
-            }
-            catch (e) {
+            let downloadTries = 0;
+            do {
                 try {
-                    await Promise.all([
-                        fsPromises.rm(extractedPath, { force: true, recursive: true }),
-                        fsPromises.rm(archivePath, { force: true, recursive: true })
-                    ]);
+                    downloadTries++;
+                    await downloadFromCDN(url, archivePath, logger);
+                    await extractBinary(url, archivePath, extractedPath, logger);
+                    break;
                 }
                 catch (e) {
-                    logger.error('An error occurred while deleting extractedPath and/or archivePath:', e);
-                }
-                finally {
+                    //Delete generated files since either download or extraction failed
                     try {
-                        releaseFunction();
+                        await Promise.all([
+                            fsPromises.rm(extractedPath, { force: true, recursive: true }),
+                            fsPromises.rm(archivePath, { force: true, recursive: true })
+                        ]);
                     }
                     catch (e) {
-                        logger.error('An error occurred while unlocking path:', e);
+                        logger.error('An error occurred while deleting extractedPath and/or archivePath:', e);
+                    }
+                    if (downloadTries >= options.downloadRetries) {
+                        //Only reject if we have met the downloadRetries limit
+                        try {
+                            releaseFunction();
+                        }
+                        catch (e) {
+                            logger.error('An error occurred while releasing lock after downloadRetries exhaustion. The error was:', e);
+                        }
+                        logger.error('downloadRetries have been exceeded. Aborting download.');
+                        return reject(e);
+                    }
+                    else {
+                        console.warn(`An error was encountered during the binary download process. Retrying for retry ${downloadTries}/${options.downloadRetries}. The error was:`, e);
                     }
-                    return reject(e);
                 }
-            }
+            } while (downloadTries < options.downloadRetries);
             try {
                 releaseFunction();
             }
             catch (e) {
-                return reject(e);
+                logger.error('An error occurred while releasing lock after successful binary download. The error was:', e);
             }
             return resolve(binaryPath);
         }
-        const uuid = (0, crypto_1.randomUUID)();
-        const zipFilepath = `${dirpath}/${uuid}.${fileExtension}`;
-        logger.log('Binary filepath:', zipFilepath);
-        const extractedPath = `${dirpath}/${uuid}`;
-        try {
-            await downloadFromCDN(url, zipFilepath, logger);
-        }
-        catch (e) {
-            reject(e);
-        }
-        try {
-            const binaryPath = await extractBinary(url, zipFilepath, extractedPath, logger);
-            resolve(binaryPath);
-        }
-        catch (e) {
-            reject(e);
+        else {
+            let downloadTries = 0;
+            do {
+                const uuid = (0, crypto_1.randomUUID)();
+                const zipFilepath = `${dirpath}/${uuid}.${fileExtension}`;
+                logger.log('Binary filepath:', zipFilepath);
+                const extractedPath = `${dirpath}/${uuid}`;
+                try {
+                    downloadTries++;
+                    await downloadFromCDN(url, zipFilepath, logger);
+                    const binaryPath = await extractBinary(url, zipFilepath, extractedPath, logger);
+                    return resolve(binaryPath);
+                }
+                catch (e) {
+                    //Delete generated files since either download or extraction failed
+                    try {
+                        await Promise.all([
+                            fsPromises.rm(extractedPath, { force: true, recursive: true }),
+                            fsPromises.rm(zipFilepath, { force: true, recursive: true })
+                        ]);
+                    }
+                    catch (e) {
+                        logger.error('An error occurred while deleting extractedPath and/or archivePath:', e);
+                    }
+                    if (downloadTries >= options.downloadRetries) {
+                        //Only reject if we have met the downloadRetries limit
+                        return reject(e);
+                    }
+                    else {
+                        console.warn(`An error was encountered during the binary download process. Retrying for retry ${downloadTries}/${options.downloadRetries}. The error was:`, e);
+                    }
+                }
+            } while (downloadTries < options.downloadRetries);
         }
     });
 }

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

@@ -4,7 +4,6 @@ declare class Executor {
     #private;
     logger: Logger;
     constructor(logger: Logger);
-    deleteDatabaseDirectory(path: string): Promise<void>;
     getMySQLVersion(preferredVersion?: string): Promise<InstalledMySQLVersion | null>;
     startMySQL(options: InternalServerOptions, binaryFilepath: string): Promise<MySQLDB>;
 }

package/dist/src/libraries/Executor.js

@@ -30,7 +30,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _Executor_instances, _Executor_executeFile, _Executor_killProcess, _Executor_startMySQLProcess, _Executor_setupDataDirectories;
+var _Executor_instances, _Executor_executeFile, _Executor_killProcess, _Executor_deleteDatabaseDirectory, _Executor_startMySQLProcess, _Executor_setupDataDirectories;
 Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const semver_1 = require("semver");
@@ -47,29 +47,6 @@ class Executor {
         _Executor_instances.add(this);
         this.logger = logger;
     }
-    async 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);
-            }
-        }
-    }
     getMySQLVersion(preferredVersion) {
         return new Promise(async (resolve, reject) => {
             if (process.platform === 'win32') {
@@ -182,6 +159,28 @@ _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_startMySQLProcess = function _Executor_startMySQLProcess(options, port, mySQLXPort, datadir, dbPath, binaryFilepath) {
     const errors = [];
     const logFile = `${dbPath}/log.log`;
@@ -207,7 +206,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             if (portIssue || xPortIssue) {
                 this.logger.log('Error log when exiting for port in use error:', errorLog);
                 try {
-                    await this.deleteDatabaseDirectory(options.dbPath);
+                    await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, options.dbPath);
                 }
                 catch (e) {
                     this.logger.error(e);
@@ -217,7 +216,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
             }
             try {
                 if (options.deleteDBAfterStopped) {
-                    await this.deleteDatabaseDirectory(dbPath);
+                    await __classPrivateFieldGet(this, _Executor_instances, "m", _Executor_deleteDatabaseDirectory).call(this, dbPath);
                 }
             }
             catch (e) {
@@ -407,7 +406,7 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
                         }
                         //Retry setting up directory now that libaio has been copied
                         this.logger.log('Retrying directory setup');
-                        await this.deleteDatabaseDirectory(datadir);
+                        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;
                     }

package/dist/types/index.d.ts

@@ -15,6 +15,7 @@ export type ServerOptions = {
     port?: number;
     xPort?: number;
     binaryDirectoryPath?: string;
+    downloadRetries?: number;
 };
 export type InternalServerOptions = {
     version?: string;
@@ -31,6 +32,7 @@ export type InternalServerOptions = {
     port: number;
     xPort: number;
     binaryDirectoryPath: string;
+    downloadRetries: number;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -21,22 +21,23 @@
     "stress": "jest --runTestsByPath stress-tests/stress.test.ts --setupFilesAfterEnv ./ciSetup.js --verbose"
   },
   "engines": {
-    "node": ">=16.6.0"
+    "node": ">=16.6.0",
+    "bun": ">=1.0.0"
   },
   "author": "Sebastian-Webster",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "^7.24.9",
-    "@babel/preset-env": "^7.25.4",
-    "@babel/preset-typescript": "^7.24.7",
+    "@babel/core": "^7.25.8",
+    "@babel/preset-env": "^7.25.8",
+    "@babel/preset-typescript": "^7.25.7",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^22.5.4",
+    "@types/node": "^22.7.5",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
-    "mysql2": "^3.11.2",
-    "typescript": "^5.6.2"
+    "mysql2": "^3.11.3",
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "adm-zip": "^0.5.16",