throw if xEnabled is 'FORCE' when X Plugin is not supported

Author: Sebastian-Webster

src/index.ts

@@ -56,7 +56,7 @@ export async function createDB(opts?: ServerOptions) {
         }
 
         logger.log('Running downloaded binary')
-        return await executor.startMySQL(options, {path: binaryFilepath, version: binaryInfo.version, installedOnSystem: false})
+        return await executor.startMySQL(options, {path: binaryFilepath, version: binaryInfo.version, installedOnSystem: false, xPluginSupported: binaryInfo.xPluginSupported})
     } else {
         logger.log(version)
         return await executor.startMySQL(options, version)

src/libraries/Downloader.ts

@@ -246,7 +246,7 @@ function extractBinary(url: string, archiveLocation: string, extractedLocation:
 
 export function downloadBinary(binaryInfo: BinaryInfo, options: InternalServerOptions, logger: Logger): Promise<string> {
     return new Promise(async (resolve, reject) => {
-        const {url, version, hostedByOracle} = binaryInfo;
+        const {url, version} = binaryInfo;
         const dirpath = getInternalEnvVariable('binaryDirectoryPath')
         logger.log('Binary path:', dirpath)
         await fsPromises.mkdir(dirpath, {recursive: true})

src/libraries/Executor.ts

@@ -11,7 +11,7 @@ import { lockFile, waitForLock } from "./FileLock";
 import { onExit } from "signal-exit";
 import { randomUUID } from "crypto";
 import { getInternalEnvVariable } from "../constants";
-import etcOSRelease from "./LinuxOSRelease";
+import etcOSRelease, { isOnAlpineLinux } from "./LinuxOSRelease";
 
 class Executor {
     logger: Logger;
@@ -309,7 +309,7 @@ class Executor {
                         if (version === null) {
                             return reject('Could not get MySQL version')
                         } else {
-                            versions.push({version: version.version, path, installedOnSystem: true})
+                            versions.push({version: version.version, path, installedOnSystem: true, xPluginSupported: gte(this.version, '5.7.19')})
                         }
                     }
 
@@ -334,7 +334,7 @@ class Executor {
                     if (version === null) {
                         reject('Could not get installed MySQL version')
                     } else {
-                        resolve({version: version.version, path: 'mysqld', installedOnSystem: true})
+                        resolve({version: version.version, path: 'mysqld', installedOnSystem: true, xPluginSupported: gte(this.version, '5.7.19')})
                     }
                 }
             }
@@ -488,6 +488,13 @@ class Executor {
     }
 
     async startMySQL(options: InternalServerOptions, installedMySQLBinary: DownloadedMySQLVersion): Promise<MySQLDB> {
+        if (installedMySQLBinary.xPluginSupported === false && options.xEnabled === 'FORCE') {
+            if (isOnAlpineLinux) {
+                throw "options.xEnabled is set to 'FORCE'. You are running this package on Alpine Linux. The MySQL binaries for Alpine Linux do not support the MySQL X Plugin. If you don't want to use the MySQL X Plugin, please set options.xEnabled to 'OFF' and that will remove this error message. Otherwise, if you want MySQL X to be enabled only if it is supported (like if you run this package on a different OS), then please set options.xEnabled to 'ON'. If you must have MySQL X enabled for each database creation, please use a different OS to run this package."
+            }
+            throw "options.xEnabled is set to 'FORCE'. The version of MySQL you are using does not support MySQL X. If you don't want to use the MySQL X Plugin, please set options.xEnabled to 'OFF'. If you only want MySQL X to be used when supported, set options.xEnabled to 'ON'. Otherwise, if MySQL X is required, please use a different version of MySQL that supports the X plugin."
+        }
+
         this.version = installedMySQLBinary.version
         this.versionInstalledOnSystem = installedMySQLBinary.installedOnSystem
         this.removeExitHandler = onExit(() => {

src/libraries/LinuxOSRelease.ts

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import { LinuxEtcOSRelease } from '../../types'
 
-const releaseDetails = {}
+const releaseDetails: LinuxEtcOSRelease = {}
 
 if (process.platform === 'linux') {
     const file = fs.readFileSync('/etc/os-release', 'utf8')
@@ -14,4 +14,6 @@ if (process.platform === 'linux') {
     }
 }
 
-export default releaseDetails as LinuxEtcOSRelease;
+export const isOnAlpineLinux = process.platform === 'linux' && releaseDetails?.ID === 'alpine'
+
+export default releaseDetails;

src/libraries/Version.ts

@@ -2,7 +2,7 @@ import { BinaryInfo, JSRuntimeVersion } from "../../types";
 import * as os from 'os'
 import { satisfies, coerce, lt, major, minor } from "semver";
 import { MySQLCDNDownloadsBaseURL, DMR_MYSQL_VERSIONS, DOWNLOADABLE_MYSQL_VERSIONS, MYSQL_ARCH_SUPPORT, MYSQL_LINUX_FILE_EXTENSIONS, MYSQL_LINUX_GLIBC_VERSIONS, MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE, MYSQL_MACOS_VERSIONS_IN_FILENAME, MYSQL_MIN_OS_SUPPORT, RC_MYSQL_VERSIONS, MYSQL_LINUX_MINIMAL_REBUILD_VERSIONS, MYSQL_LINUX_MINIMAL_INSTALL_AVAILABLE_ARM64 } from "../constants";
-import etcOSRelease from "./LinuxOSRelease";
+import etcOSRelease, { isOnAlpineLinux } from "./LinuxOSRelease";
 
 export default function getBinaryURL(versionToGet: string = "x", currentArch: string): BinaryInfo {
     let selectedVersions = DOWNLOADABLE_MYSQL_VERSIONS.filter(version => satisfies(version, versionToGet));
@@ -59,8 +59,6 @@ export default function getBinaryURL(versionToGet: string = "x", currentArch: st
         throw `Your operating system is too out of date to run a version of MySQL that fits the following requirement: ${versionToGet}. The oldest version for your operating system that you would need to get a version that satisfies the version requirement is ${minVersion} but your current operating system is ${coercedOSRelease.version}. Please try changing your MySQL version requirement, updating your OS to a newer version, or if you believe this is a bug, please report this on GitHub.`
     }
 
-    const isOnAlpineLinux = process.platform === 'linux' && etcOSRelease.ID === 'alpine'
-
     if (process.platform === 'linux') {
         if (etcOSRelease.NAME === 'Ubuntu' && etcOSRelease.VERSION_ID >= '24.04') {
             //Since Ubuntu >= 24.04 uses libaio1t64 instead of libaio, this package has to copy libaio1t64 into a folder that MySQL looks in for dynamically linked libraries with the filename "libaio.so.1".
@@ -92,6 +90,7 @@ export default function getBinaryURL(versionToGet: string = "x", currentArch: st
     const isDMR = satisfies(selectedVersion, DMR_MYSQL_VERSIONS)
 
     let fileLocation: string = ''
+    let xPluginSupported = true;
 
     if (currentOS === 'win32') {
         fileLocation = `${major(selectedVersion)}.${minor(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-winx64.zip`
@@ -101,6 +100,7 @@ export default function getBinaryURL(versionToGet: string = "x", currentArch: st
         fileLocation = `${major(selectedVersion)}.${minor(selectedVersion)}/mysql-${selectedVersion}${isRC ? '-rc' : isDMR ? '-dmr' : ''}-${MYSQL_MACOS_VERSIONS_IN_FILENAME[macOSVersionNameKey]}-${currentArch === 'x64' ? 'x86_64' : 'arm64'}.tar.gz`
     } else if (isOnAlpineLinux) {
         fileLocation = `https://github.com/Sebastian-Webster/mysql-server-musl-binaries/releases/download/current/mysql-musl-${selectedVersion}-${currentArch === 'x64' ? 'x86_64' : 'arm64'}.tar.gz`
+        xPluginSupported = false
     } else if (currentOS === 'linux') {
         const glibcObject = MYSQL_LINUX_GLIBC_VERSIONS[currentArch];
         const glibcVersionKeys = Object.keys(glibcObject);
@@ -124,6 +124,7 @@ export default function getBinaryURL(versionToGet: string = "x", currentArch: st
     return {
         version: selectedVersion,
         url: isOnAlpineLinux ? fileLocation : (MySQLCDNDownloadsBaseURL + fileLocation),
-        hostedByOracle: !isOnAlpineLinux // Only the Alpine Linux binaries are not hosted on the MySQL CDN.
+        hostedByOracle: !isOnAlpineLinux, // Only the Alpine Linux binaries are not hosted on the MySQL CDN.
+        xPluginSupported
     }
 }

types/index.ts

@@ -64,13 +64,15 @@ export type MySQLDB = {
 export type DownloadedMySQLVersion = {
     version: string,
     path: string,
-    installedOnSystem: boolean
+    installedOnSystem: boolean,
+    xPluginSupported: boolean
 }
 
 export type BinaryInfo = {
     url: string,
     version: string,
-    hostedByOracle: boolean
+    hostedByOracle: boolean,
+    xPluginSupported: boolean
 }
 
 export type OptionTypeChecks = {