mysql-memory-server 1.5.0 → 1.6.0

package/README.md

@@ -1,8 +1,8 @@
 # MySQL Memory Server
 
-This package allows you to create ephemeral MySQL databases inside of Node.js, great for testing. When creating a new database, if the version selected is not installed on the system, the binary is downloaded from MySQL's CDN (cdn.mysql.com)
+This package allows you to create ephemeral MySQL databases from JavaScript and/or TypeScript code, great for testing. When creating a new database, if the version selected is not installed on the system, the binary is downloaded from MySQL's CDN (cdn.mysql.com)
 
-You can run multiple MySQL databases with this package at the same time. Each database will use a random free port. The databases will automatically shutdown when the Node.js process exits. A `stop()` method is also provided to stop each database instance.
+You can run multiple MySQL databases with this package at the same time. Each database will use a random free port. The databases will automatically shutdown when the JS runtime process exits. A `stop()` method is also provided to stop each database instance.
 
 ## Installation
 
@@ -28,10 +28,12 @@ Requirements for Linux:
 #### Currently supported MySQL versions
 
 - If using the system installed MySQL server: 8.0.20 and newer
-- If not using the system installed MySQL server: 8.0.39, 8.1.0, 8.2.0, 8.3.0, 8.4.2, 9.0.1
+- If not using the system installed MySQL server: 8.0.39, 8.0.40, 8.1.0, 8.2.0, 8.3.0, 8.4.2, 8.4.3, 9.0.1, 9.1.0
 
 ## Usage
 
+This package supports both ESM and CJS so you can use import or require.
+
 ```javascript
 import { createDB } from 'mysql-memory-server';
 import sql from 'mysql2/promise'
@@ -194,6 +196,16 @@ Default: 3
 
 Description: The number of times to try to download a MySQL binary before giving up and rejecting the `createDB()` promise.
 
+- `initSQLString: string`
+
+Required: No
+
+Default: ""
+
+Description: A string with MySQL queries to run before the database starts to accept connections. This option can be used for things like initialising tables without having to first connect to the database to do that.The queries in the string get executed after ```mysql-memory-server```'s queries run. Uses the ```--init-file``` MySQL server option under the hood. Learn more at the [--init-file MySQL Documentation](https://dev.mysql.com/doc/refman/8.4/en/server-system-variables.html#sysvar_init_file)
+
+The internal queries that are ran before the queries in ```initSQLString``` are renaming the user from ```root``` to the username specified in the ```username``` option if it's set, and creating a database with the name from the ```dbName``` option.
+
 ***
 ### :warning: Internal Options :warning:
 

package/dist/src/index.js

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

package/dist/src/libraries/Executor.js

@@ -423,6 +423,9 @@ _Executor_instances = new WeakSet(), _Executor_executeFile = function _Executor_
     if (options.username !== 'root') {
         initText += `\nRENAME USER 'root'@'localhost' TO '${options.username}'@'localhost';`;
     }
+    if (options.initSQLString.length > 0) {
+        initText += `\n${options.initSQLString}`;
+    }
     this.logger.log('Writing init file');
     await fsPromises.writeFile(`${options.dbPath}/init.sql`, initText, { encoding: 'utf8' });
     this.logger.log('Finished writing init file');

package/dist/src/versions.json

@@ -1,4 +1,109 @@
 [
+    {
+        "version": "9.1.0",
+        "arch": "arm64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-9.1/mysql-9.1.0-macos14-arm64.tar.gz"
+    },
+    {
+        "version": "9.1.0",
+        "arch": "x64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-9.1/mysql-9.1.0-macos14-x86_64.tar.gz"
+    },
+    {
+        "version": "9.1.0",
+        "arch": "x64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-9.1/mysql-9.1.0-linux-glibc2.17-x86_64-minimal.tar.xz"
+    },
+    {
+        "version": "9.1.0",
+        "arch": "arm64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-9.1/mysql-9.1.0-linux-glibc2.17-aarch64-minimal.tar.xz"
+    },
+    {
+        "version": "9.1.0",
+        "arch": "x64",
+        "os": "win32",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-9.1/mysql-9.1.0-winx64.zip"
+    },
+    {
+        "version": "8.4.3",
+        "arch": "arm64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.3-macos14-arm64.tar.gz"
+    },
+    {
+        "version": "8.4.3",
+        "arch": "x64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.3-macos14-x86_64.tar.gz"
+    },
+    {
+        "version": "8.4.3",
+        "arch": "x64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.3-linux-glibc2.17-x86_64-minimal.tar.xz"
+    },
+    {
+        "version": "8.4.3",
+        "arch": "arm64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.3-linux-glibc2.17-aarch64-minimal.tar.xz"
+    },
+    {
+        "version": "8.4.3",
+        "arch": "x64",
+        "os": "win32",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.4/mysql-8.4.3-winx64.zip"
+    },
+    {
+        "version": "8.0.40",
+        "arch": "arm64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.40-macos14-arm64.tar.gz"
+    },
+    {
+        "version": "8.0.40",
+        "arch": "x64",
+        "os": "darwin",
+        "osKernelVersionsSupported": ">=22",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.40-macos14-x86_64.tar.gz"
+    },
+    {
+        "version": "8.0.40",
+        "arch": "x64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.40-linux-glibc2.17-x86_64-minimal.tar.xz"
+    },
+    {
+        "version": "8.0.40",
+        "arch": "arm64",
+        "os": "linux",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.40-linux-glibc2.17-aarch64-minimal.tar.xz"
+    },
+    {
+        "version": "8.0.40",
+        "arch": "x64",
+        "os": "win32",
+        "osKernelVersionsSupported": "*",
+        "url": "https://cdn.mysql.com//Downloads/MySQL-8.0/mysql-8.0.40-winx64.zip"
+    },
     {
         "version": "9.0.1",
         "arch": "arm64",

package/dist/types/index.d.ts

@@ -1,24 +1,25 @@
 import { ExecFileException } from "child_process";
 export type LOG_LEVEL = 'LOG' | 'WARN' | 'ERROR';
 export type ServerOptions = {
-    version?: string;
-    dbName?: string;
-    logLevel?: LOG_LEVEL;
-    portRetries?: number;
-    downloadBinaryOnce?: boolean;
-    lockRetries?: number;
-    lockRetryWait?: number;
-    username?: string;
-    deleteDBAfterStopped?: boolean;
-    dbPath?: string;
-    ignoreUnsupportedSystemVersion?: boolean;
-    port?: number;
-    xPort?: number;
-    binaryDirectoryPath?: string;
-    downloadRetries?: number;
+    version?: string | undefined;
+    dbName?: string | undefined;
+    logLevel?: LOG_LEVEL | undefined;
+    portRetries?: number | undefined;
+    downloadBinaryOnce?: boolean | undefined;
+    lockRetries?: number | undefined;
+    lockRetryWait?: number | undefined;
+    username?: string | undefined;
+    deleteDBAfterStopped?: boolean | undefined;
+    dbPath?: string | undefined;
+    ignoreUnsupportedSystemVersion?: boolean | undefined;
+    port?: number | undefined;
+    xPort?: number | undefined;
+    binaryDirectoryPath?: string | undefined;
+    downloadRetries?: number | undefined;
+    initSQLString?: string | undefined;
 };
 export type InternalServerOptions = {
-    version?: string;
+    version?: string | undefined;
     dbName: string;
     logLevel: LOG_LEVEL;
     portRetries: number;
@@ -33,6 +34,7 @@ export type InternalServerOptions = {
     xPort: number;
     binaryDirectoryPath: string;
     downloadRetries: number;
+    initSQLString: string;
 };
 export type ExecutorOptions = {
     logLevel: LOG_LEVEL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-memory-server",
-  "version": "1.5.0",
+  "version": "1.6.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",
-    "test:ci": "jest --testPathIgnorePatterns=/stress-tests/ --setupFilesAfterEnv ./ciSetup.js --verbose",
-    "stress": "jest --runTestsByPath stress-tests/stress.test.ts --setupFilesAfterEnv ./ciSetup.js --verbose"
+    "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"
   },
   "engines": {
     "node": ">=16.6.0",
@@ -27,11 +27,11 @@
   "author": "Sebastian-Webster",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "^7.25.8",
-    "@babel/preset-env": "^7.25.8",
-    "@babel/preset-typescript": "^7.25.7",
+    "@babel/core": "^7.25.9",
+    "@babel/preset-env": "^7.25.9",
+    "@babel/preset-typescript": "^7.25.9",
     "@types/adm-zip": "^0.5.5",
-    "@types/node": "^22.7.5",
+    "@types/node": "^22.7.9",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",
     "babel-jest": "^29.7.0",