rename internal options

Author: Sebastian-Webster

src/constants.ts

@@ -15,15 +15,15 @@ export const DEFAULT_OPTIONS: InternalServerOptions = {
     lockRetries: 1_000,
     lockRetryWait: 1_000,
     username: 'root',
-    deleteDBAfterStopped: true,
-    //mysqlmsn = MySQL Memory Server Node.js
-    dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
     ignoreUnsupportedSystemVersion: false,
     port: 0,
     xPort: 0,
-    binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`,
     downloadRetries: 10,
-    initSQLString: ''
+    initSQLString: '',
+    _DO_NOT_USE_deleteDBAfterStopped: true,
+    //mysqlmsn = MySQL Memory Server Node.js
+    _DO_NOT_USE_dbPath: normalizePath(`${tmpdir()}/mysqlmsn/dbs/${randomUUID().replace(/-/g, '')}`),
+    _DO_NOT_USE_binaryDirectoryPath: `${tmpdir()}/mysqlmsn/binaries`
 } as const;
 
 export const LOG_LEVELS = {

src/libraries/Downloader.ts

@@ -181,7 +181,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} = binaryInfo;
-        const dirpath = options.binaryDirectoryPath
+        const dirpath = options._DO_NOT_USE_binaryDirectoryPath
         logger.log('Binary path:', dirpath)
         await fsPromises.mkdir(dirpath, {recursive: true})
 

src/libraries/Executor.ts

@@ -98,7 +98,7 @@ class Executor {
                 if (portIssue || xPortIssue) {
                     this.logger.log('Error log when exiting for port in use error:', errorLog)
                     try {
-                        await this.#deleteDatabaseDirectory(options.dbPath)
+                        await this.#deleteDatabaseDirectory(options._DO_NOT_USE_dbPath)
                     } catch (e) {
                         this.logger.error(e)
                         return reject(`MySQL failed to listen on a certain port. To restart MySQL with a different port, the database directory needed to be deleted. An error occurred while deleting the database directory. Aborting. The error was: ${e}`)
@@ -107,7 +107,7 @@ class Executor {
                 }
 
                 try {
-                    if (options.deleteDBAfterStopped) {
+                    if (options._DO_NOT_USE_deleteDBAfterStopped) {
                         await this.#deleteDatabaseDirectory(dbPath)
                     }
                 } catch (e) {
@@ -400,15 +400,15 @@ class Executor {
 
         this.logger.log('Writing init file')
 
-        await fsPromises.writeFile(`${options.dbPath}/init.sql`, initText, {encoding: 'utf8'})
+        await fsPromises.writeFile(`${options._DO_NOT_USE_dbPath}/init.sql`, initText, {encoding: 'utf8'})
 
         this.logger.log('Finished writing init file')
     }
 
     async startMySQL(options: InternalServerOptions, binaryFilepath: string): Promise<MySQLDB> {
         let retries = 0;
 
-        const datadir = normalizePath(`${options.dbPath}/data`)
+        const datadir = normalizePath(`${options._DO_NOT_USE_dbPath}/data`)
 
         do {
             await this.#setupDataDirectories(options, binaryFilepath, datadir, true);
@@ -420,7 +420,7 @@ class Executor {
 
             try {
                 this.logger.log('Starting MySQL process')
-                const resolved = await this.#startMySQLProcess(options, port, mySQLXPort, datadir, options.dbPath, binaryFilepath)
+                const resolved = await this.#startMySQLProcess(options, port, mySQLXPort, datadir, options._DO_NOT_USE_dbPath, binaryFilepath)
                 this.logger.log('Starting process was successful')
                 return resolved
             } catch (e) {

stress-tests/stress.test.ts

@@ -18,13 +18,13 @@ for (let i = 0; i < 100; i++) {
         const options: ServerOptions = {
             username: 'dbuser',
             logLevel: 'LOG',
-            deleteDBAfterStopped: !process.env.useCIDBPath,
+            _DO_NOT_USE_deleteDBAfterStopped: !process.env.useCIDBPath,
             ignoreUnsupportedSystemVersion: true
         }
 
         if (process.env.useCIDBPath) {
-            options.dbPath = `${dbPath}/${i}`
-            options.binaryDirectoryPath = binaryPath
+            options._DO_NOT_USE_dbPath = `${dbPath}/${i}`
+            options._DO_NOT_USE_binaryDirectoryPath = binaryPath
         }
 
         const db = await createDB(options)

tests/sql.test.ts

@@ -18,13 +18,13 @@ beforeEach(async () => {
     const options: ServerOptions = {
         username: 'root',
         logLevel: 'LOG',
-        deleteDBAfterStopped: !process.env.useCIDBPath,
+        _DO_NOT_USE_deleteDBAfterStopped: !process.env.useCIDBPath,
         ignoreUnsupportedSystemVersion: true
     }
 
     if (process.env.useCIDBPath) {
-        options.dbPath = `${dbPath}/${randomUUID()}`
-        options.binaryDirectoryPath = binaryPath
+        options._DO_NOT_USE_dbPath = `${dbPath}/${randomUUID()}`
+        options._DO_NOT_USE_binaryDirectoryPath = binaryPath
     }
 
     db = await createDB(options)

types/index.ts

@@ -30,14 +30,14 @@ export type InternalServerOptions = {
     lockRetries: number,
     lockRetryWait: number,
     username: string,
-    deleteDBAfterStopped: boolean,
-    dbPath: string,
     ignoreUnsupportedSystemVersion: boolean,
     port: number,
     xPort: number,
-    binaryDirectoryPath: string,
     downloadRetries: number,
     initSQLString: string
+    _DO_NOT_USE_deleteDBAfterStopped: boolean,
+    _DO_NOT_USE_dbPath: string,
+    _DO_NOT_USE_binaryDirectoryPath: string,
 }
 
 export type ExecutorOptions = {