[BUG] Incoming sound keeps playing even after the call is disconnected

[kamalbennani]

• I have verified that the issue occurs with the latest twilio.js release and is not marked as a known issue in the CHANGELOG.md.
• I reviewed the Common Issues and open GitHub issues and verified that this report represents a potentially new issue.
• I verified that the Quickstart application works in my environment.
• I am not sharing any Personally Identifiable Information (PII)
  or sensitive account information (API keys, credentials, etc.) when reporting this issue.

Code to reproduce the issue:

// receive an incoming call
this.device.on('incoming', (call: Call) => {
  // save call
  this._activeCall = call;

  // listen to call events
  this._activeCall.on('disconnect', () => console.log('call got disconnected'));
  this._activeCall.on('accept', () => console.log('call got answered'));
});

// pickup the call
this._activeCall.accept();

// right the way hung up before the call got time to connect (before pstream->answer event)
this._activeCall.disconnect();

// incoming sound keeps playing forever

Expected behavior:

The incoming sound should be stopped after a call disconnection

Actual behavior:

The incoming sound keeps playing forever

Software versions:

• Browser(s): Version 108.0.5359.124 (Official Build) (x86_64)
• Operating System: 12.5.1 Mac

Solution

I've debugged the situation and I found the following issue:

In the device class, the SDK only stops the incoming sound in the following situation:

• accept
• cancel
• reject
• transportClose
• error

But none of these events is sent in the case I described above.

The only event emitted is "disconnect" because the call got disconnected just after attempting to connect.

To resolve the issue, it's as simple as calling this._maybeStopIncomingSound(); at the end of the disconnect event

I would like to hear your thoughts about this, to know if you are also able to reproduce it and if I should pull up a PR for it.

[mhuynh5757]

Hey @kamalbennani, thanks for filing this issue and providing a solution. We'll add it as soon as we can, I've filed an internal ticket to keep track of this.

[kamalbennani]

Hi @mhuynh5757 thank you for your quick response 🙇
Let me know if you want me to pull up a PR.
In all cases, I applied the patch to our current app and it's working perfectly fine.

[mhuynh5757]

Hey @kamalbennani, PRs are always welcome. Once the fix is done, our team will run through the usual regression testing before we can release. Thanks for the community contributions, we genuinely appreciate it.

[kamalbennani]

Hi @mhuynh5757 I've opened a PR for this. I'd like to have your thoughts on it.
Thanks.

[charliesantos]

should be fixed on 2.3.1

[bradleyy1012]

Is it possible that this bug has resurfaced after the latest update on chrome?

[charliesantos]

@bradleyy1012 we're not seeing this with the latest update on chrome. Do you have repro steps?