Merge pull request #55 from Sebastian-Webster/add-informative-mysql-out-of-date-error

Add informative MySQL out of date error

Author: Sebastian-Webster

README.md

@@ -76,7 +76,13 @@ Default: undefined
 
 Description: Version of MySQL to use for the database. Uses semver for getting the version, so valid semver versions are allowed. For example, `8.x` is a valid version and will use the latest 8.x MySQL version. 
 
-If left undefined and the system has MySQL already installed, the system installed version of MySQL will be used. If left undefined and the system does not have MySQL installed, the latest version of MySQL in the `versions.json` file in this package will be downloaded. If defined and the system has that version of MySQL installed, the system installed version will be used. If defined and the system does not have that version of MySQL installed, that version will be downloaded as long as it is found in the `versions.json` file in this package.
+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 <8.0.20), an error will be thrown unless `ignoreUnsupportedSystemVersion` is set to `true`.
+- If the system does not have MySQL installed, the latest version of MySQL in the `versions.json` file in this package will be downloaded.
+
+If defined:
+- If the version is 8.0.19 or older, an error will be thrown as this package does not currently support those versions of MySQL.
+- If MySQL is installed on the system, the installed version will be used. Otherwise the selected version will be downloaded from the MySQL CDN as long as it can be found in the `versions.json` file. If it cannot be found in that file, an error will be thrown.
 
 - `dbName: string`
 
@@ -136,6 +142,14 @@ Default: root
 
 Description: The username of the user that is used to login to the database.
 
+- `ignoreUnsupportedSystemVersion: boolean`
+
+Required: No
+
+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). 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.
+
 - `deleteDBAfterStopped: boolean`
 
 Required: No

src/constants.ts

@@ -0,0 +1,5 @@
+const CONSTANTS = {
+    MIN_SUPPORTED_MYSQL: '8.0.20'
+}
+
+export default CONSTANTS

src/index.ts

@@ -1,14 +1,15 @@
 import Logger from './libraries/Logger'
 import * as os from 'node:os'
 import Executor from "./libraries/Executor"
-import { satisfies } from "semver"
+import { satisfies, lt } from "semver"
 import DBDestroySignal from "./libraries/AbortSignal"
 import { BinaryInfo, InternalServerOptions, ServerOptions } from '../types'
 import getBinaryURL from './libraries/Version'
 import MySQLVersions from './versions.json'
 import { downloadBinary } from './libraries/Downloader'
 import { randomUUID } from "crypto";
 import {normalize as normalizePath} from 'path'
+import CONSTANTS from './constants'
 
 process.on('exit', () => {
     DBDestroySignal.abort('Process is exiting')
@@ -25,7 +26,8 @@ export async function createDB(opts?: ServerOptions) {
         username: 'root',
         deleteDBAfterStopped: true,
         //mysqlmsn = MySQL Memory Server Node.js
-        dbPath: normalizePath(`${os.tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`)
+        dbPath: normalizePath(`${os.tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
+        ignoreUnsupportedSystemVersion: false
     }
 
     const options: InternalServerOptions = {...defaultOptions, ...opts}
@@ -35,8 +37,23 @@ export async function createDB(opts?: ServerOptions) {
     const executor = new Executor(logger)
 
     const version = await executor.getMySQLVersion(options.version)
+
+    const unsupportedMySQLIsInstalled = version && lt(version.version, CONSTANTS.MIN_SUPPORTED_MYSQL)
+
+    const throwUnsupportedError = unsupportedMySQLIsInstalled && !options.ignoreUnsupportedSystemVersion && !options.version
+
+    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.`
+    }
+
+    if (options.version && lt(options.version, CONSTANTS.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.log('Version currently installed:', version)
-    if (version === null || (options.version && !satisfies(version.version, options.version))) {
+    if (version === null || (options.version && !satisfies(version.version, options.version)) || unsupportedMySQLIsInstalled) {
         let binaryInfo: BinaryInfo;
         let binaryFilepath: string;
         try {

stress-tests/stress.test.ts

@@ -15,7 +15,8 @@ for (let i = 0; i < 100; i++) {
         const options: ServerOptions = {
             username: 'dbuser',
             logLevel: 'LOG',
-            deleteDBAfterStopped: !process.env.useCIDBPath
+            deleteDBAfterStopped: !process.env.useCIDBPath,
+            ignoreUnsupportedSystemVersion: true
         }
 
         if (process.env.useCIDBPath) {

tests/sql.test.ts

@@ -15,7 +15,8 @@ beforeEach(async () => {
     const options: ServerOptions = {
         username: 'root',
         logLevel: 'LOG',
-        deleteDBAfterStopped: !process.env.useCIDBPath
+        deleteDBAfterStopped: !process.env.useCIDBPath,
+        ignoreUnsupportedSystemVersion: true
     }
 
     if (process.env.useCIDBPath) {

tests/versions.test.ts

@@ -14,7 +14,7 @@ jest.setTimeout(500_000);
 for (const version of versions) {
     test(`running on version ${version}`, async () => {
         Error.stackTraceLimit = Infinity
-        const options: ServerOptions = {version, dbName: 'testingdata', username: 'root', logLevel: 'LOG', deleteDBAfterStopped: !process.env.useCIDBPath}
+        const options: ServerOptions = {version, dbName: 'testingdata', username: 'root', logLevel: 'LOG', deleteDBAfterStopped: !process.env.useCIDBPath, ignoreUnsupportedSystemVersion: true}
 
         if (process.env.useCIDBPath) {
             options.dbPath = `${dbPathPrefix}/${randomUUID()}`

types/index.ts

@@ -12,7 +12,8 @@ export type ServerOptions = {
     lockRetryWait?: number,
     username?: string,
     deleteDBAfterStopped?: boolean,
-    dbPath?: string
+    dbPath?: string,
+    ignoreUnsupportedSystemVersion?: boolean
 }
 
 export type InternalServerOptions = {
@@ -25,7 +26,8 @@ export type InternalServerOptions = {
     lockRetryWait: number,
     username: string,
     deleteDBAfterStopped: boolean,
-    dbPath: string
+    dbPath: string,
+    ignoreUnsupportedSystemVersion: boolean
 }
 
 export type ExecutorOptions = {