Allow downloading all supported MySQL versions

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   ci:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     steps:
       - name: Checkout

.github/workflows/os-compatibility.yml

@@ -14,6 +14,8 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-13, macos-14, macos-15, ubuntu-20.04, ubuntu-22.04, ubuntu-24.04, windows-2019, windows-2022]
+        #There is no 10.0.0 at the time of writing, but since greater than characters are not allowed in GitHub Actions artifacts names, 9.0.1 - 10.0.0 will be used instead of >9.0.0
+        version-requirement: ['5.7.19 - 5.7.24', '5.7.25 - 5.7.29', '5.7.30 - 5.7.34', '5.7.35 - 5.7.39', '5.7.40 - 5.7.44', '8.0.0 - 8.0.4', '8.0.4 - 8.0.13', '8.0.14 - 8.0.19', '8.0.20 - 8.0.24', '8.0.25 - 8.0.29', '8.0.30 - 8.0.34', '8.0.35 - 8.0.39', '8.0.40 - 8.3.0', '8.4.0 - 9.0.0', '9.0.1 - 10.0.0']
 
     steps:
       - name: Checkout
@@ -29,23 +31,25 @@ jobs:
         run: npm ci
 
       - name: Run tests
-        run: npm run test:ci
+        env:
+          VERSION_REQUIREMENT: ${{ matrix.version-requirement }}
+        run: npm run os-compat:ci
 
       - name: Upload mysqlmsn directory (Windows)
         if: ${{ failure() && runner.os == 'Windows' }}
         uses: actions/upload-artifact@v4.3.5
         with:
-          name: ${{ matrix.os }}
+          name: ${{ matrix.os }}-${{ matrix.version-requirement }}
           path: "C:\\Users\\RUNNER~1\\mysqlmsn"
-          compression-level: 9
+          compression-level: 0
 
       - name: Upload mysqlmsn directory (Not Windows)
         if: ${{ failure() && runner.os != 'Windows' }}
         uses: actions/upload-artifact@v4.3.5
         with:
-          name: ${{ matrix.os }}
+          name: ${{ matrix.os }}-${{ matrix.version-requirement }}
           path: /tmp/mysqlmsn
-          compression-level: 9
+          compression-level: 0
 
   fedora-docker:
     runs-on: ubuntu-latest
@@ -54,6 +58,8 @@ jobs:
       fail-fast: false
       matrix:
         version: [40]
+        #There is no 10.0.0 at the time of writing, but since greater than characters are not allowed in GitHub Actions artifacts names, 9.0.1 - 10.0.0 will be used instead of >9.0.0
+        version-requirement: ['5.7.19 - 5.7.24', '5.7.25 - 5.7.29', '5.7.30 - 5.7.34', '5.7.35 - 5.7.39', '5.7.40 - 5.7.44', '8.0.0 - 8.0.4', '8.0.4 - 8.0.13', '8.0.14 - 8.0.19', '8.0.20 - 8.0.24', '8.0.25 - 8.0.29', '8.0.30 - 8.0.34', '8.0.35 - 8.0.39', '8.0.40 - 8.3.0', '8.4.0 - 9.0.0', '9.0.1 - 10.0.0']
 
     container: fedora:${{ matrix.version }}
 
@@ -68,18 +74,23 @@ jobs:
           check-latest: true
 
       - name: Install required libraries
-        run: sudo dnf install libaio numactl -y
+        run: sudo dnf install libaio numactl libxcrypt-compat -y
 
       - name: Install packages
         run: npm ci
 
+      - name: Print available storage space
+        run: df -h
+
       - name: Run tests
-        run: npm run test:ci
+        env:
+          VERSION_REQUIREMENT: ${{ matrix.version-requirement }}
+        run: npm run os-compat:ci
 
       - name: Upload mysqlmsn directory
         if: ${{ failure() }}
         uses: actions/upload-artifact@v4.3.5
         with:
-          name: docker-fedora-${{ matrix.version }}
+          name: docker-fedora-${{ matrix.version }}-${{ matrix.version-requirement }}
           path: /tmp/mysqlmsn
-          compression-level: 9
+          compression-level: 0

CONTRIBUTING.md

@@ -48,7 +48,7 @@ There are also automated tests which you can run by running the command:
 npm test
 ```
 
-Please do not run the `npm run test:ci` command to test your code locally. That command is meant to only be used in GitHub Actions.
+Please do not run the `npm run test:ci` or `npm run stress:ci` command to test your code locally. That command is meant to only be used in GitHub Actions.
 
 # Submitting the pull request
 

README.md

@@ -27,8 +27,8 @@ Requirements for Linux:
 
 #### Currently supported MySQL versions
 
-- Running MySQL versions already installed on the system: 5.7.19 and newer
-- MySQL versions available to download through ```mysql-memory-server``` and run: 8.0.39 - 8.0.41, 8.1.0 - 8.3.0, 8.4.2 - 8.4.4, and 9.0.1 - 9.2.0
+- ```mysql-memory-server``` can run MySQL versions 5.7.19 and newer
+- ```mysql-memory-server``` can download MySQL versions 5.7.20 - 9.2.0
 
 ## Example Usage - Application Code
 

ciSetup.js

@@ -1 +1,10 @@
-process.env.useCIDBPath = true;
+const { normalize } = require("path");
+
+process.env.useCIDBPath = true;
+
+const GitHubActionsTempFolder = process.platform === 'win32' ? 'C:\\Users\\RUNNER~1\\mysqlmsn' : '/tmp/mysqlmsn'
+
+process.env.mysqlmsn_internal_DO_NOT_USE_databaseDirectoryPath = normalize(GitHubActionsTempFolder + '/dbs')
+process.env.mysqlmsn_internal_DO_NOT_USE_binaryDirectoryPath = normalize(GitHubActionsTempFolder + '/binaries')
+
+process.env.mysqlmsn_internal_DO_NOT_USE_deleteDBAfterStopped = false;

package.json

@@ -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",

src/constants.ts

@@ -4,9 +4,7 @@ import {normalize as normalizePath} from 'path'
 import { tmpdir } from "os";
 import { valid as validSemver, coerce as coerceSemver } from "semver";
 
-export const MIN_SUPPORTED_MYSQL = '5.7.19';
-
-export const DEFAULT_OPTIONS_GENERATOR: () => InternalServerOptions = () => ({
+export const DEFAULT_OPTIONS: InternalServerOptions = {
     version: undefined,
     dbName: 'dbdata',
     logLevel: 'ERROR',
@@ -21,9 +19,9 @@ export const DEFAULT_OPTIONS_GENERATOR: () => InternalServerOptions = () => ({
     downloadRetries: 10,
     initSQLString: '',
     arch: process.arch
-});
+} as const;
 
-export const DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(DEFAULT_OPTIONS_GENERATOR()))
+export const DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(DEFAULT_OPTIONS))
 
 export const LOG_LEVELS = {
     'LOG': 0,
@@ -34,7 +32,7 @@ export const LOG_LEVELS = {
 const internalOptions = {
     deleteDBAfterStopped: 'true',
     //mysqlmsn = MySQL Memory Server Node.js
-    dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
+    databaseDirectoryPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs`),
     binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`,
     cli: 'false'
 }
@@ -115,4 +113,83 @@ export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
         errorMessage: `Option arch must be either of the following: ${allowedArches.join(', ')}`,
         definedType: 'string'
     }
-} as const;
+} as const;
+
+export const MIN_SUPPORTED_MYSQL = '5.7.19';
+export const downloadsBaseURL = 'https://cdn.mysql.com//Downloads/MySQL-'
+export const archiveBaseURL = '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.
+export const 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',
+
+    '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.1.0', '8.2.0', '8.3.0',
+
+    '8.4.0', '8.4.2', '8.4.3', '8.4.4',
+
+    '9.0.1', '9.1.0', '9.2.0'
+] as const;
+export const MYSQL_ARCH_SUPPORT = {
+    darwin: {
+        arm64: '8.0.26 - 9.2.0',
+        x64: '5.7.19 - 9.2.0'
+    },
+    linux: {
+        arm64: '8.0.31 - 9.2.0',
+        x64: '5.7.19 - 9.2.0'
+    },
+    win32: {
+        x64: '5.7.19 - 9.2.0'
+    }
+} as const;
+export const MYSQL_MIN_OS_SUPPORT = {
+    win32: {
+        x: '0.0.0' // No minimum version is documented as far as I can tell, so allow any minimum version
+    },
+    linux: {
+        x: '0.0.0'// No minimum version is documented as far as I can tell, so allow any minimum version
+    },
+    darwin: {
+        '5.7.19 - 5.7.23 || 8.0.1 - 8.0.3 || 8.0.11 - 8.0.12': '16.0.0',
+        '5.7.24 - 5.7.29 || 8.0.4 || 8.0.13 - 8.0.18': '17.0.0',
+        '5.7.30 - 5.7.31 || 8.0.19 - 8.0.22': '18.0.0',
+        //5.7.32 - 5.7.44 is not supported for macOS by MySQL. Those versions are not appearing in this list
+        '8.0.0': '13.0.0',
+        '8.0.23 - 8.0.27': '19.0.0',
+        '8.0.28 - 8.0.31': '20.0.0',
+        '8.0.32 - 8.0.34': '21.0.0',
+        '8.0.35 - 8.0.39 || 8.1.0 - 8.4.2': '22.0.0',
+        '8.0.40 - 8.0.41 || 8.4.3 - 9.2.0': '23.0.0'
+    }
+} as const;
+export const DMR_MYSQL_VERSIONS = '8.0.0 - 8.0.2';
+export const RC_MYSQL_VERSIONS = '8.0.3 - 8.0.4';
+export const MYSQL_MACOS_VERSIONS_IN_FILENAME = {
+    '5.7.19 - 5.7.20 || 8.0.1 - 8.0.3': 'macos10.12',
+    '5.7.21 - 5.7.23 || 8.0.4 - 8.0.12': 'macos10.13',
+    '5.7.24 - 5.7.31 || 8.0.13 - 8.0.18': 'macos10.14',
+    '8.0.0': 'osx10.11',
+    '8.0.19 - 8.0.23': 'macos10.15',
+    '8.0.24 - 8.0.28': 'macos11',
+    '8.0.30 - 8.0.31': 'macos12',
+    '8.0.32 - 8.0.35 || 8.1.0 - 8.2.0': 'macos13',
+    '8.0.36 - 8.0.40 || 8.3.0 - 8.4.3 || 9.0.1 - 9.1.0': 'macos14',
+    '8.0.41 || 8.4.4 || 9.2.0': 'macos15'
+} as const;
+export const MYSQL_LINUX_GLIBC_VERSIONS = {
+    '5.7.19 - 8.0.20': '2.12',
+    '8.0.21 - 9.2.0': '2.17'
+} as const;
+export const MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE = {
+    '5.7.19 - 8.0.15': 'no',
+    '8.0.16 - 8.0.20': 'no-glibc-tag',
+    '8.0.21 - 9.2.0': 'glibc-tag'
+} as const;
+export const MYSQL_LINUX_FILE_EXTENSIONS = {
+    '5.7.19 - 8.0.11': 'gz',
+    '8.0.12 - 9.2.0': 'xz'
+} as const;
+export const MYSQL_LINUX_MINIMAL_REBUILD_VERSIONS = '8.0.26';

src/index.ts

@@ -1,18 +1,16 @@
 import Logger from './libraries/Logger'
-import * as os from 'node:os'
 import Executor from "./libraries/Executor"
-import { satisfies, lt, coerce } from "semver"
-import { BinaryInfo, ServerOptions } from '../types'
+import { satisfies, lt } from "semver"
+import { BinaryInfo, InternalServerOptions, ServerOptions } from '../types'
 import getBinaryURL from './libraries/Version'
-import MySQLVersions from './versions.json'
 import { downloadBinary } from './libraries/Downloader'
-import { MIN_SUPPORTED_MYSQL, DEFAULT_OPTIONS_KEYS, OPTION_TYPE_CHECKS, DEFAULT_OPTIONS_GENERATOR } from './constants'
+import { MIN_SUPPORTED_MYSQL, DEFAULT_OPTIONS_KEYS, OPTION_TYPE_CHECKS, DEFAULT_OPTIONS } from './constants'
 
 export async function createDB(opts?: ServerOptions) {
     const suppliedOpts = opts || {};
     const suppliedOptsKeys = Object.keys(suppliedOpts);
 
-    const options = DEFAULT_OPTIONS_GENERATOR();
+    const options: InternalServerOptions = {...DEFAULT_OPTIONS}
 
     for (const opt of suppliedOptsKeys) {
         if (!DEFAULT_OPTIONS_KEYS.includes(opt)) {
@@ -47,28 +45,13 @@ export async function createDB(opts?: ServerOptions) {
     if (version === null || (options.version && !satisfies(version.version, options.version)) || unsupportedMySQLIsInstalled) {
         let binaryInfo: BinaryInfo;
         let binaryFilepath: string;
-        try {
-            binaryInfo = getBinaryURL(MySQLVersions, options.version, options)
-            logger.log('Using MySQL binary version:', binaryInfo.version, 'from URL:', binaryInfo.url)
-        } catch (e) {
-            if (options.version && lt(coerce(options.version), MIN_SUPPORTED_MYSQL)) {
-                //The difference between the throw here and the throw above is this throw is because the selected "version" is not supported.
-                //The throw above is because the system-installed MySQL is out of date and "ignoreUnsupportedSystemVersion" is not set to true.
-                throw `The selected version of MySQL (${options.version}) is not currently supported by this package. Please choose a different version to use.`
-            }
-
-            logger.error(e)
-            if (options.version) {
-                throw `A MySQL version ${options.version} binary could not be found that supports your OS (${os.platform()} | ${os.version()} | ${os.release()}) and CPU architecture (${os.arch()}). Please check you have the latest version of mysql-memory-server. If the latest version still doesn't support the version you want to use, feel free to make a pull request to add support!`
-            }
-            throw `A MySQL binary could not be found that supports your OS (${os.platform()} | ${os.version()} | ${os.release()}) and CPU architecture (${os.arch()}). Please check you have the latest version of mysql-memory-server. If the latest version still doesn't support your OS and CPU architecture, feel free to make a pull request to add support!`
-        }
+        binaryInfo = getBinaryURL(options.version, options.arch)
 
         try {
             binaryFilepath = await downloadBinary(binaryInfo, options, logger);
         } catch (error) {
             logger.error('Failed to download binary:', error)
-            throw `Failed to download binary. The error was: "${error}"`  
+            throw `Failed to download binary. The error was: "${error}"`
         }
 
         logger.log('Running downloaded binary')