Fix #7921 and added test cases

[ayeminag]

NOTES

In order to run internal/e2e-realtime-api/voiceSpeechCollect.test.ts before merging the backend changed

Backend Todos

• setup devbox with FS changes
• setup steering to devbox
• create a sip domain app on staging and handle the call on domain app with a relay context relaye2e
• add routing to devbox in kamailio for the domain app you set up in previous step

SDK Todos

• in internal/e2e-realtime-api/src/voiceSpeechCollect.test.ts, replace dev-min.dapp.swire.io sip domain with the sip domain you created in above step.
• copy env file into internal/e2e-realtime-api/.env.test and setup
• run npm dev:rt-only

References

• #7921

Description

• Added state param to CallingCallCollectEventParams
• Made sure voiceCallCollectWorker doesn't clean up CallCollect instance and emit ended/failed event if the state is "collecting"
• Resolve CallCollect.ended() promise only when state is NOT "collecting" AND final is either undefined/true AND result.type is one of ENDED_STATES.
• Added more test cases for Call.collect() in @sw-internal/e2e-realtime-api

[changeset-bot]

🦋 Changeset detected

Latest commit: f2c8332

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@sw-internal/e2e-realtime-api	Patch
@signalwire/realtime-api	Patch
@signalwire/core	Patch
@signalwire/js	Patch
@signalwire/web-api	Patch
@signalwire/webrtc	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[ayeminag]

@giavac I added the steps we need to take to run test before backend changes are on staging.

[giavac]

Bookmark to ensure the generic SIP Domains are restored before merging.

[ayeminag]

Update: No special steps needed to run the new test cases anymore to test on staging.

[giavac]

(I'll approve once the other open conversations will be resolved)

[ayeminag]

I updated the tests to make sure to fail on prod, but it seems like we deployed the collect changes to production already.
But if the state is missing in continuous: true case, SDK will just resolve the collect.ended() and cleanup CallCollect instance on first collect event with final: true (in case of partialResults: true) OR on first speech type collect event (in case partialResults: false | undefined). And when new events come in after that sdk will throws Error('Missing the Instance'), sdk is already catching that error and logging it to stderr. So, I added tests to make sure Missing the Instance error wasn't logged to stderr, if the event is missing state in continuous: true case tests will fail.

I updated the audio file I am playing in the test to include long enough pause, so FS will deliver more than one collect events (at least one event with final: true in partialResults: true, continuous: true case), and adjusted silenceTimeout and speechTimeout to accommodate it.

Since, changes are on prod, to test the failure. I disabled the state !== 'collecting' checks in sdk first (because not checking for state on sdk side is behaviorally same as state missing from FS side events), and ran the test, tests failed because it's getting Missing the Instance error just like it should. See the logs here.

I also notice speech detect can return inconsistant data for example 1 2 3 4 5 instead of one two three four five I updated assert for all possible cases, so they will pass as long as it's one of the possible expected texts.

/cc @iAmmar7

[iAmmar7]

LGTM. Thanks @ayeminag 🚀

Updated