feat: remove all "beforeExit" listeners

fixes #563

BREAKING CHANGE:
There is now no more "beforeExit" listener added

Author: hasezoey

docs/api/classes/mongo-memory-replset.md

@@ -89,10 +89,6 @@ Typings: `async cleanup(force: boolean = false): Promise<void>`
 
 Cleanup all files used by this ReplSet & instances
 
-:::tip
-Runs automatically on `process.on('beforeExit')`
-:::
-
 ### waitUntilRunning
 
 Typings: `async waitUntilRunning(): Promise<void>`

docs/api/classes/mongo-memory-server.md

@@ -81,10 +81,6 @@ Typings: `async cleanup(force: boolean): Promise<void>`
 
 Cleanup all files used by this instance
 
-:::tip
-Runs automatically on `process.on('beforeExit')` [This can add many listeners if many instances are used without an replset]
-:::
-
 ### ensureInstance
 
 Typings: `async ensureInstance(): Promise<MongoInstanceData>`

docs/guides/faq.md

@@ -13,5 +13,5 @@ It is currently recommended to directly look at the TSDoc for these properties t
 
 ### Do testing database paths get cleaned up?
 
-If the Database path is generated by this package, then it will automatically get cleaned up (ensured to run by process event `beforeExit`).  
-If the Database path is provided, then it will not be automatically cleaned up, cleanup needs to be called explicitly like `.cleanup(true)` (parameter is to force-delete the directory).
+If the Database if a temporary directory (generated with `tmp`), then it will automatically get cleaned-up when calling `.stop()`, this can be disabled with `.stop(false)`.  
+If the Database if manually set (set with `dbPath`), then it needs to be manually cleaned-up with `.cleanup(true)`.

packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts

@@ -348,15 +348,6 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
     }
     this.stateChange(MongoMemoryReplSetStates.init); // this needs to be executed before "setImmediate"
 
-    // check if an "beforeExit" listener for "this.cleanup" is already defined for this class, if not add one
-    if (
-      process
-        .listeners('beforeExit')
-        .findIndex((f: (...args: any[]) => any) => f === this.cleanup) <= -1
-    ) {
-      process.on('beforeExit', this.cleanup);
-    }
-
     await ensureAsync()
       .then(() => this.initAllServers())
       .then(() => this._initReplSet())
@@ -507,7 +498,6 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
 
   /**
    * Remove the defined dbPath's
-   * This function gets automatically called on process event "beforeExit" (with force being "false")
    * @param force Remove the dbPath even if it is no "tmpDir" (and re-check if tmpDir actually removed it)
    * @throws If "state" is not "stopped"
    * @throws If "instanceInfo" is not defined
@@ -516,7 +506,6 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
   async cleanup(force: boolean = false): Promise<void> {
     assertionIsMMSRSState(MongoMemoryReplSetStates.stopped, this._state);
     log(`cleanup for "${this.servers.length}" servers`);
-    process.removeListener('beforeExit', this.cleanup);
 
     await Promise.all(this.servers.map((s) => s.cleanup(force)));
 

packages/mongodb-memory-server-core/src/MongoMemoryServer.ts

@@ -276,17 +276,6 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
 
     this.stateChange(MongoMemoryServerStates.starting);
 
-    // check if not replset (because MongoMemoryReplSet has an own beforeExit listener) and
-    // check if an "beforeExit" listener for "this.cleanup" is already defined for this class, if not add one
-    if (
-      isNullOrUndefined(this.opts.instance?.replSet) &&
-      process
-        .listeners('beforeExit')
-        .findIndex((f: (...args: any[]) => any) => f === this.cleanup) <= -1
-    ) {
-      process.on('beforeExit', this.cleanup);
-    }
-
     await this._startUpInstance(forceSamePort).catch((err) => {
       if (!debug.enabled('MongoMS:MongoMemoryServer')) {
         console.warn('Starting the instance failed, enable debug for more information');
@@ -505,25 +494,13 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
 
   /**
    * Remove the defined dbPath
-   * This function gets automatically called on process event "beforeExit" (with force being "false")
    * @param force Remove the dbPath even if it is no "tmpDir" (and re-check if tmpDir actually removed it)
    * @throws If "state" is not "stopped"
    * @throws If "instanceInfo" is not defined
    * @throws If an fs error occured
    */
-  async cleanup(force: boolean): Promise<void>;
-  /**
-   * This Overload is used for the "beforeExit" listener (ignore this)
-   * @internal
-   */
-  async cleanup(code?: number): Promise<void>;
-  async cleanup(force: boolean | number = false): Promise<void> {
-    if (typeof force !== 'boolean') {
-      force = false;
-    }
-
+  async cleanup(force: boolean = false): Promise<void> {
     assertionIsMMSState(MongoMemoryServerStates.stopped, this.state);
-    process.removeListener('beforeExit', this.cleanup);
 
     if (isNullOrUndefined(this._instanceInfo)) {
       this.debug('cleanup: "instanceInfo" is undefined');