Merge pull request #153 from Sebastian-Webster/151-add-option-for-mysql-binary-architecture

Add arch option (add support for Windows on ARM)

Author: Sebastian-Webster

README.md

@@ -218,6 +218,14 @@ Description: A string with MySQL queries to run before the database starts to ac
 
 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.
 
+- `arch: "arm64" | "x64"`
+
+Required: No
+
+Default: process.arch
+
+Description: The MySQL binary architecture to execute. MySQL does not offer server builds for Windows on ARM, so to get this package working on Windows on ARM, set the arch option to "x64" and Windows will emulate MySQL.
+
 ***
 ### :warning: Internal Options :warning:
 

src/constants.ts

@@ -20,6 +20,7 @@ export const DEFAULT_OPTIONS_GENERATOR: () => InternalServerOptions = () => ({
     xPort: 0,
     downloadRetries: 10,
     initSQLString: '',
+    arch: process.arch,
     _DO_NOT_USE_deleteDBAfterStopped: true,
     //mysqlmsn = MySQL Memory Server Node.js
     _DO_NOT_USE_dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
@@ -38,6 +39,7 @@ export const LOG_LEVELS = {
 
 export const INTERNAL_OPTIONS = ['_DO_NOT_USE_deleteDBAfterStopped', '_DO_NOT_USE_dbPath', '_DO_NOT_USE_binaryDirectoryPath', '_DO_NOT_USE_beforeSignalCleanup', '_DO_NOT_USE_afterSignalCleanup'] as const;
 
+const allowedArches = ['x64', 'arm64', undefined]
 export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
     version: {
         check: (opt: any) => opt === undefined || typeof opt === 'string' && validSemver(opt) !== null,
@@ -104,6 +106,11 @@ export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
         errorMessage: 'Option initSQLString must be either undefined or a string.',
         definedType: 'string'
     },
+    arch: {
+        check: (opt: any) => allowedArches.includes(opt),
+        errorMessage: `Option arch must be either of the following: ${allowedArches.join(', ')}`,
+        definedType: 'string'
+    },
     _DO_NOT_USE_deleteDBAfterStopped: {
         check: (opt: any) => opt === undefined || typeof opt === 'boolean',
         errorMessage: 'Option _DO_NOT_USE_deleteDBAfterStopped must be either undefined or a boolean.',

src/index.ts

@@ -60,7 +60,7 @@ export async function createDB(opts?: ServerOptions) {
         let binaryInfo: BinaryInfo;
         let binaryFilepath: string;
         try {
-            binaryInfo = getBinaryURL(MySQLVersions, options.version)
+            binaryInfo = getBinaryURL(MySQLVersions, options.version, options)
             logger.log('Using MySQL binary version:', binaryInfo.version, 'from URL:', binaryInfo.url)
         } catch (e) {
             logger.error(e)

src/libraries/Version.ts

@@ -1,13 +1,13 @@
-import { MySQLVersion } from "../../types";
+import { InternalServerOptions, MySQLVersion } from "../../types";
 import * as os from 'os'
 import { satisfies, coerce } from "semver";
 
-export default function getBinaryURL(versions: MySQLVersion[], versionToGet: string = "x") {
+export default function getBinaryURL(versions: MySQLVersion[], versionToGet: string = "x", options: InternalServerOptions) {
     let availableVersions = versions;
 
-    availableVersions = availableVersions.filter(v => v.arch === process.arch)
+    availableVersions = availableVersions.filter(v => v.arch === options.arch)
 
-    if (availableVersions.length === 0) throw `No MySQL binary could be found for your CPU architecture: ${process.arch}`
+    if (availableVersions.length === 0) throw `No MySQL binary could be found for your CPU architecture: ${options.arch}. ${process.platform === 'win32' && process.arch === 'arm64' ? 'This package has detected you are running Windows on ARM. MySQL does not support Windows on ARM. To get this package working, please try setting the "arch" option to "x64".' : ''}`
 
     availableVersions = availableVersions.filter(v => v.os === process.platform)
 

types/index.ts

@@ -15,7 +15,8 @@ export type ServerOptions = {
     port?: number | undefined,
     xPort?: number | undefined,
     downloadRetries?: number | undefined,
-    initSQLString?: string | undefined
+    initSQLString?: string | undefined,
+    arch?: "arm64" | "x64" | undefined,
     _DO_NOT_USE_deleteDBAfterStopped?: boolean | undefined,
     _DO_NOT_USE_dbPath?: string | undefined,
     _DO_NOT_USE_binaryDirectoryPath?: string | undefined,
@@ -36,7 +37,8 @@ export type InternalServerOptions = {
     port: number,
     xPort: number,
     downloadRetries: number,
-    initSQLString: string
+    initSQLString: string,
+    arch: string,
     _DO_NOT_USE_deleteDBAfterStopped: boolean,
     _DO_NOT_USE_dbPath: string,
     _DO_NOT_USE_binaryDirectoryPath: string,