mysql-memory-server 1.0.0 → 1.1.0

package/README.md

@@ -32,7 +32,7 @@ const db = await createDB()
 // Connect to the new database with the port provided
 const connection = await sql.createConnection({
         host: '127.0.0.1',
-        user: 'root',
+        user: db.username,
         port: db.port,
         database: db.dbName
 })
@@ -58,6 +58,8 @@ The port that the MySQL database is listening on
 The port that MySQLX is listening on
 - `dbName: string`
 The database that was created on database initialization
+- `username: string`
+The name of the user to use to login to the database
 - `stop: () => Promise<void>`
 The method to stop the database. The returned promise resolves when the database has successfully stopped.
 
@@ -122,6 +124,14 @@ Default: 1,000
 
 Description: If `downloadBinaryOnce` is set to `true`, `lockRetryWait` is the number of milliseconds to wait before checking if the lock has been released.
 
+- `username: string`
+
+Required: No
+
+Default: root
+
+Description: The username of the user that is used to login to the database.
+
 ## If using Ubuntu 24.04 and newer
 
 Selecting what MySQL version to use is not currently supported on Ubuntu 24.04 and newer. To use this package on Ubuntu 24.04 and newer you must have the `mysql-server` package installed on your system and `ServerOptions.version` must either be the version that is installed on the system or undefined.

package/dist/src/index.js

@@ -41,7 +41,8 @@ const defaultOptions = {
     portRetries: 10,
     downloadBinaryOnce: true,
     lockRetries: 1000,
-    lockRetryWait: 1000
+    lockRetryWait: 1000,
+    username: 'root'
 };
 process.on('exit', () => {
     AbortSignal_1.default.abort('Process is exiting');

package/dist/src/libraries/Downloader.js

@@ -112,18 +112,20 @@ function extractBinary(url, archiveLocation, extractedLocation) {
             const zip = new adm_zip_1.default(archiveLocation);
             const entries = zip.getEntries();
             for (const entry of entries) {
-                if (entry.isDirectory) {
-                    if (entry.name === folderName) {
-                        await fsPromises.mkdir(`${extractedLocation}/mysql`, { recursive: true });
+                if (entry.entryName.indexOf('..') === -1) {
+                    if (entry.isDirectory) {
+                        if (entry.name === folderName) {
+                            await fsPromises.mkdir(`${extractedLocation}/mysql`, { recursive: true });
+                        }
+                        else {
+                            await fsPromises.mkdir(`${extractedLocation}/${entry.entryName}`, { recursive: true });
+                        }
                     }
                     else {
-                        await fsPromises.mkdir(`${extractedLocation}/${entry.entryName}`, { recursive: true });
+                        const data = await getZipData(entry);
+                        await fsPromises.writeFile(`${extractedLocation}/${entry.entryName}`, data);
                     }
                 }
-                else {
-                    const data = await getZipData(entry);
-                    await fsPromises.writeFile(`${extractedLocation}/${entry.entryName}`, data);
-                }
             }
             try {
                 await fsPromises.rm(archiveLocation);

package/dist/src/libraries/Executor.js

@@ -123,7 +123,11 @@ class Executor {
                 }
                 return reject(err || stderr);
             }
-            await fsPromises.writeFile(`${dbPath}/init.sql`, `CREATE DATABASE ${options.dbName};`, { encoding: 'utf8' });
+            let initText = `CREATE DATABASE ${options.dbName};`;
+            if (options.username !== 'root') {
+                initText += `RENAME USER 'root'@'localhost' TO '${options.username}'@'localhost';`;
+            }
+            await fsPromises.writeFile(`${dbPath}/init.sql`, initText, { encoding: 'utf8' });
             let retries = 0;
             do {
                 const port = (0, Port_1.GenerateRandomPort)();
@@ -164,6 +168,10 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
         //Once ran, resolveFunction will be called.
         let resolveFunction;
         process.on('close', async (code, signal) => {
+            const errorString = errors.join('\n');
+            if (errorString.includes('Address already in use')) {
+                return reject('Port is already in use');
+            }
             try {
                 await fsPromises.rm(dbPath, { recursive: true, force: true });
                 if (binaryFilepath.includes(os.tmpdir()) && !options.downloadBinaryOnce) {
@@ -183,12 +191,8 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
                 if (code === 0) {
                     return reject('Database exited early');
                 }
-                const errorString = errors.join('\n');
-                this.logger.error(errorString);
-                if (errorString.includes('Address already in use')) {
-                    return reject('Port is already in use');
-                }
                 if (code) {
+                    this.logger.error(errorString);
                     return reject(errorString);
                 }
             }
@@ -213,6 +217,7 @@ _Executor_instances = new WeakSet(), _Executor_execute = function _Executor_exec
                         port,
                         xPort: mySQLXPort,
                         dbName: options.dbName,
+                        username: options.username,
                         stop: () => {
                             return new Promise(async (resolve, reject) => {
                                 resolveFunction = resolve;

package/dist/src/versions.json

@@ -3,14 +3,14 @@
         "version": "9.0.1",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-9.0/mysql-9.0.1-macos14-arm64.tar.gz"
     },
     {
         "version": "9.0.1",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-9.0/mysql-9.0.1-macos14-x86_64.tar.gz"
     },
     {
@@ -38,14 +38,14 @@
         "version": "8.4.2",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.2-macos14-arm64.tar.gz"
     },
     {
         "version": "8.4.2",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.2-macos14-x86_64.tar.gz"
     },
     {
@@ -73,14 +73,14 @@
         "version": "8.0.39",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.39-macos14-arm64.tar.gz"
     },
     {
         "version": "8.0.39",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.39-macos14-x86_64.tar.gz"
     },
     {
@@ -108,14 +108,14 @@
         "version": "8.1.0",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.1/mysql-8.1.0-macos13-arm64.tar.gz"
     },
     {
         "version": "8.1.0",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.1/mysql-8.1.0-macos13-x86_64.tar.gz"
     },
     {
@@ -143,14 +143,14 @@
         "version": "8.2.0",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.2/mysql-8.2.0-macos13-arm64.tar.gz"
     },
     {
         "version": "8.2.0",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.2/mysql-8.2.0-macos13-x86_64.tar.gz"
     },
     {
@@ -178,14 +178,14 @@
         "version": "8.3.0",
         "arch": "arm64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.3/mysql-8.3.0-macos14-arm64.tar.gz"
     },
     {
         "version": "8.3.0",
         "arch": "x64",
         "os": "darwin",
-        "osKernelVersionsSupported": ">22",
+        "osKernelVersionsSupported": ">=22",
         "url": "https://cdn.mysql.com//Downloads/MySQL-8.3/mysql-8.3.0-macos14-x86_64.tar.gz"
     },
     {

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export type ServerOptions = {
     downloadBinaryOnce?: boolean;
     lockRetries?: number;
     lockRetryWait?: number;
+    username?: string;
 };
 export type InternalServerOptions = {
     version?: string;
@@ -17,6 +18,7 @@ export type InternalServerOptions = {
     downloadBinaryOnce: boolean;
     lockRetries: number;
     lockRetryWait: number;
+    username: string;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;
@@ -30,6 +32,7 @@ export type MySQLDB = {
     port: number;
     xPort: number;
     dbName: string;
+    username: string;
     stop: () => Promise<void>;
 };
 export type MySQLVersion = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Spin up an ephemeral MySQL database from your JavaScript code",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -30,5 +30,13 @@
     "adm-zip": "^0.5.14",
     "proper-lockfile": "^4.1.2",
     "semver": "^7.6.3"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Sebastian-Webster/mysql-memory-server-nodejs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Sebastian-Webster/mysql-memory-server-nodejs/issues"
+  },
+  "homepage": "https://github.com/Sebastian-Webster/mysql-memory-server-nodejs"
 }