add initSQLFilePath option functionality

Author: Sebastian-Webster

README.md

@@ -186,7 +186,7 @@ Description: A string with SQL queries to run before the database starts to acce
 
 Default: ""
 
-Description: A path to a .sql file with SQL queries to run before the database starts to accept connections. This option can be used for things like importing an exported MySQL database. Check the [Init SQL file order of operations](#init-sql-file-order-of-operations) to learn more about what SQL queries are ran and in what order before the database starts accepting connections. If a filepath is defined and reading the file fails (like if the path does not exist), then the database creation will fail.
+Description: A path to a UTF-8 .sql file with SQL queries to run before the database starts to accept connections. This option can be used for things like importing an exported MySQL database. Check the [Init SQL file order of operations](#init-sql-file-order-of-operations) to learn more about what SQL queries are ran and in what order before the database starts accepting connections. If a filepath is defined and reading the file fails (like if the path does not exist), then the database creation will fail.
 
 - `arch: "arm64" | "x64"`
 

src/constants.ts

@@ -2,6 +2,7 @@ import { InternalServerOptions, OptionTypeChecks } from "../types";
 import {normalize as normalizePath} from 'path'
 import { tmpdir } from "os";
 import { valid as validSemver, coerce as coerceSemver } from "semver";
+import { existsSync } from "fs";
 
 export const DEFAULT_OPTIONS: InternalServerOptions = {
     version: undefined,
@@ -18,7 +19,8 @@ export const DEFAULT_OPTIONS: InternalServerOptions = {
     downloadRetries: 10,
     initSQLString: '',
     arch: process.arch,
-    xEnabled: 'FORCE'
+    xEnabled: 'FORCE',
+    initSQLFilePath: ''
 } as const;
 
 export const DEFAULT_OPTIONS_KEYS = Object.freeze(Object.keys(DEFAULT_OPTIONS))
@@ -115,7 +117,12 @@ export const OPTION_TYPE_CHECKS: OptionTypeChecks = {
         check: (opt: any) => opt === undefined || pluginActivationStates.includes(opt),
         errorMessage: `xEnabled must be either undefined or one of the following: ${pluginActivationStates.join(', ')}`,
         definedType: 'boolean'
-    }
+    },
+    initSQLFilePath: {
+        check: (opt: any) => opt === undefined || (typeof opt === 'string' && existsSync(opt)),
+        errorMessage: 'Option initSQLFilePath must be either undefined or a filepath string that points to a file that exists.',
+        definedType: 'string'
+    },
 } as const;
 
 export const MIN_SUPPORTED_MYSQL = '5.7.19';

src/libraries/Executor.ts

@@ -358,6 +358,29 @@ class Executor {
         })
     }
 
+    #streamAppendToFile(readPath: string, writePath: string): Promise<void> {
+        return new Promise((resolve, reject) => {
+            const rs = fs.createReadStream(readPath, {encoding: 'utf-8'})
+            const ws = fs.createWriteStream(writePath, {flags: 'a', encoding: 'utf-8'})
+
+            rs.on('error', (e) => {
+                ws.end();
+                this.logger.error('Received error from streamAppendToFile read stream:', e)
+                reject(e)
+            })
+
+            ws.on('error', (e) => {
+                rs.close();
+                this.logger.error('Received error from streamAppendToFile write stream:', e)
+                reject(e)
+            })
+
+            rs.pipe(ws)
+
+            ws.on('finish', () => resolve)
+        })
+    }
+
     async #setupDataDirectories(options: InternalServerOptions, binary: DownloadedMySQLVersion, datadir: string, retry: boolean): Promise<void> {
         const binaryFilepath = binary.path
         this.logger.log('Created data directory for database at:', datadir)
@@ -499,9 +522,18 @@ class Executor {
 
         this.logger.log('Writing init file')
 
-        await fsPromises.writeFile(`${this.databasePath}/init.sql`, initText, {encoding: 'utf8'})
+        const initFilePath = `${this.databasePath}/init.sql`
+        await fsPromises.writeFile(initFilePath, initText, {encoding: 'utf8'})
 
         this.logger.log('Finished writing init file')
+
+        if (options.initSQLFilePath) {
+            this.logger.log('Appending init.sql file with the contents of the file at path provided by options.initSQLFilePath.')
+
+            await this.#streamAppendToFile(options.initSQLFilePath, initFilePath)
+
+            this.logger.log('Successfully appended init.sql file with the contents of the file at path provided by options.initSQLFilePath.')
+        }
     }
 
     async startMySQL(options: InternalServerOptions, installedMySQLBinary: DownloadedMySQLVersion): Promise<MySQLDB> {

types/index.ts

@@ -19,7 +19,8 @@ export type ServerOptions = {
     downloadRetries?: number | undefined,
     initSQLString?: string | undefined,
     arch?: "arm64" | "x64" | undefined,
-    xEnabled?: PluginActivationState | undefined
+    xEnabled?: PluginActivationState | undefined,
+    initSQLFilePath?: string | undefined
 }
 
 export type InternalServerOptions = {
@@ -37,7 +38,8 @@ export type InternalServerOptions = {
     downloadRetries: number,
     initSQLString: string,
     arch: string,
-    xEnabled: PluginActivationState
+    xEnabled: PluginActivationState,
+    initSQLFilePath: string
 }
 
 export type ExecuteFileReturn = {