fix: remove event listeners in finally

Author: shetzel

src/shared/sandboxCommandBase.ts

@@ -225,6 +225,20 @@ export abstract class SandboxCommandBase<T> extends SfCommand<T> {
     }
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  protected async finally(_: Error | undefined): Promise<any> {
+    const lifecycle = Lifecycle.getInstance();
+    lifecycle.removeAllListeners('POLLING_TIME_OUT');
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_RESUME);
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_ASYNC_RESULT);
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_STATUS);
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_AUTH);
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_RESULT);
+    lifecycle.removeAllListeners(SandboxEvents.EVENT_MULTIPLE_SBX_PROCESSES);
+
+    return super.finally(_);
+  }
+
   private removeSandboxProgressConfig(): void {
     if (this.latestSandboxProgressObj?.SandboxName) {
       this.sandboxRequestConfig.unset(this.latestSandboxProgressObj.SandboxName);

test/unit/org/createSandbox.test.ts

@@ -37,8 +37,6 @@ const fakeOrg: AuthFields = {
 
 describe('org:create:sandbox', () => {
   beforeEach(() => {
-    // stubMethod(sandbox, OrgAccessor.prototype, 'read').callsFake(async (): Promise<AuthFields> => fakeOrg);
-    // stubMethod(sandbox, OrgAccessor.prototype, 'write').callsFake(async (): Promise<AuthFields> => fakeOrg);
     stubMethod(sandbox, OrgAccessor.prototype, 'read').resolves(fakeOrg);
     stubMethod(sandbox, OrgAccessor.prototype, 'write').resolves(fakeOrg);
     sfCommandUxStubs = stubSfCommandUx(sandbox);
@@ -53,23 +51,18 @@ describe('org:create:sandbox', () => {
     it('will print the correct message for asyncResult lifecycle event', async () => {
       stubMethod(sandbox, Org, 'create').resolves(Org.prototype);
       stubMethod(sandbox, Org.prototype, 'getUsername').returns('testProdOrg');
-      const createStub = stubMethod(sandbox, Org.prototype, 'createSandbox').callsFake(async () =>
-        (async () => {})().catch()
-      );
+      const createStub = stubMethod(sandbox, Org.prototype, 'createSandbox').callsFake(async () => {
+        await Lifecycle.getInstance().emit(SandboxEvents.EVENT_ASYNC_RESULT, sandboxProcessObj);
+      });
 
       await CreateSandbox.run(['-o', 'testProdOrg', '--name', 'mysandboxx', '--no-prompt']);
 
-      expect(createStub.firstCall.args[0].SandboxName).includes('mysandboxx');
-      expect(createStub.firstCall.args[0].SandboxName.length).equals(10);
-
-      Lifecycle.getInstance().on(SandboxEvents.EVENT_ASYNC_RESULT, async (result) => {
-        expect(result).to.deep.equal(sandboxProcessObj);
-        expect(sfCommandUxStubs.info.firstCall.firstArg).to.include(sandboxProcessObj.Id);
-        return Promise.resolve();
+      expect(createStub.firstCall.firstArg).to.deep.equal({
+        SandboxName: 'mysandboxx',
+        LicenseType: 'Developer',
       });
-
-      await Lifecycle.getInstance().emit(SandboxEvents.EVENT_ASYNC_RESULT, sandboxProcessObj);
-      Lifecycle.getInstance().removeAllListeners(SandboxEvents.EVENT_ASYNC_RESULT);
+      const expectedInfoMsg = `org resume sandbox --job-id ${sandboxProcessObj.Id} -o testProdOrg`;
+      expect(sfCommandUxStubs.info.firstCall.firstArg).to.include(expectedInfoMsg);
     });
   });