Cancel ringing call notification on call cancellation

[jmartinesp]

Content

Listen to active call state for DMs with ringing calls so if the other user hangs up before you've replied the ringing stops and the call is cancelled.

Motivation and context

Improve the call ringing implementation. Fixes #3014.

Tests

• With a client using a session A, call a user in another client using session B from a DM.
• The user in session B should see a ringing call notification.
• From session A, hang up.
• The ringing should stop soon after in session B.

Tested devices

• Physical
• Emulator
• OS version(s): 14, 13.

Checklist

• Changes have been tested on an Android device or Android emulator with API 23
• UI change has been tested on both light and dark themes
• Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
• Pull request is based on the develop branch
• Pull request includes a new file under ./changelog.d. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#changelog
• Pull request includes screenshots or videos if containing UI changes
• Pull request includes a sign off
• You've made a self review of your PR

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[github-actions]

📱 Scan the QR code below to install the build (arm64 only) for this PR.

If you can't scan the QR code you can install the build via this link: https://i.diawi.com/S5dQsa

[codecov]

Codecov Report

Attention: Patch coverage is 85.71429% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.15%. Comparing base (bf3bdbf) to head (d68e5e4).
Report is 8 commits behind head on develop.

Files	Patch %	Lines
...roid/features/call/impl/utils/ActiveCallManager.kt	85.00%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3047   +/-   ##
========================================
  Coverage    76.14%   76.15%           
========================================
  Files         1645     1645           
  Lines        38809    38829   +20     
  Branches      7516     7523    +7     
========================================
+ Hits         29552    29570   +18     
- Misses        5356     5357    +1     
- Partials      3901     3902    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bmarty]

Hello @jmartinesp what is the status of the PR? I mean can it become "Ready for review" or does it need any update?

[jmartinesp]

So I created this PR as a draft so everyone could test it (especially Timo, who suggested the implementation), it's functional and it could be merged (maybe after some cleanup, I can't remember) but we don't have a counterpart on iOS and I don't think we have a plan to do this work there any time soon.

It depends on whether we want this even if iOS doesn't have it or not. @manuroe ?

[manuroe]

We (well @stefanceriu ) worked through this on iOS in this commit with the same approach as @jmartinesp here. We can merge this PR.

[bmarty]

Just one remark, else LGTM!

[bmarty]

You may want to add timedOutCallJob?.cancel() too, even if it should not change anything.

[bmarty]

I am a bit scared about this drop. If it is not mandatory, can we just remove it?
Or maybe replace by

            // We only want to check if the room active call status changes
            .distinctUntilChanged()
            .filter { roomHasActiveCall -> !roomHasActiveCall }
            .onEach {
                // The call was cancelled
                incomingCallTimedOut()
            }
            .launchIn(coroutineScope)

(Unit tests are still passing with this)

[jmartinesp]

IIRC we can't, because in a real life situation this flow will start before we get the room info, and by default the roomHasActiveCall will be false, instantly cancelling any incoming call as a result.

We could replace it by some operator that takes pairs of events instead so we can compare hadCall == true && newValue == false, but that's technically doing exactly the same as the drop as it wouldn't trigger until there are 2 elements in the flow.

[bmarty]

ok

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud