feat: improve voip error handling #35776

pierre-lehnen-rc · 2025-04-10T20:51:46Z

Proposed changes (including videos or screenshots)

Determine the reason for a call having ended and if the reason is not natural, show an error message to the user.

Replaced the "Unable to complete call" error message with "Unable to negotiate call params." when the call fails with an "Not Acceptable Here" error.
For all other errors, replaced the "Unable to complete call" error message with "Unable to complete call. Error code [{{statusCode}}]", which will show the code for the SIP error that caused the call to fail
When a call started by us fails for a non-natural reason, we'll now display one of the following two messages in an error toast:
- "An Incoming Voice Call was canceled due to an unexpected error."
- "An Incoming Voice Call was canceled suddenly."
Changed the voip client internal code to log some information to the console when a call fails or throws an error.

Issue(s)

Steps to test or reproduce

Further comments

This pull request aims to enhance the error handling capabilities for voice calls in the Rocket.Chat application. The changes include:

Improved error handling across multiple packages, specifically for voice over IP (VoIP) scenarios.
Addition of four new English translation strings related to error messages and notifications for voice calls and call negotiation in the i18n JSON file.
Updates to the VoipErrorView component, including new error status code handling and improved default error messages that incorporate status codes.
Enhancements to the VoipClient to parse SIP invitation cancellation reasons and emit a new incomingcallerror event for specific failure scenarios, such as 'USER_NOT_REGISTERED' or unexpected cancellations. This also includes error logging improvements and proper wiring of the new cancellation handler to the invitation delegate.
Updates to the VoipProvider to handle incoming call errors more effectively.
A test case update to ensure the correct error message is displayed for unknown error calls in the VoIP error view component.

These improvements are intended to provide more robust error handling and clearer communication of issues during VoIP calls.

dionisio-bot · 2025-04-10T20:51:50Z

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

changeset-bot · 2025-04-10T20:51:51Z

🦋 Changeset detected

Latest commit: 7f363a2

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

This PR includes changesets to release 37 packages

Name	Type
@rocket.chat/ui-voip	Major
@rocket.chat/i18n	Minor
@rocket.chat/meteor	Minor
@rocket.chat/mock-providers	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/web-ui-registration	Major
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/ui-client	Major
@rocket.chat/uikit-playground	Patch
@rocket.chat/gazzodown	Major
@rocket.chat/livechat	Patch
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/core-typings	Minor
@rocket.chat/rest-typings	Minor
@rocket.chat/api-client	Patch
@rocket.chat/apps	Patch
@rocket.chat/core-services	Patch
@rocket.chat/cron	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/freeswitch	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/license	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/models	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/instance-status	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

github-actions · 2025-04-10T21:01:28Z

PR Preview Action v1.6.1
🚀 View preview at https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-35776/
Built to branch `gh-pages` at 2025-04-20 23:57 UTC. Preview will be ready when the GitHub Pages deployment is complete.

codecov · 2025-04-15T16:35:46Z

Codecov Report

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

Project coverage is 61.17%. Comparing base (d8eb824) to head (7f363a2).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #35776      +/-   ##
===========================================
+ Coverage    61.16%   61.17%   +0.01%     
===========================================
  Files         3003     3005       +2     
  Lines        71350    71387      +37     
  Branches     16333    16342       +9     
===========================================
+ Hits         43638    43669      +31     
- Misses       24745    24751       +6     
  Partials      2967     2967

Flag	Coverage Δ
e2e	`57.87% <ø> (-0.01%)`	⬇️
unit	`75.01% <92.10%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kody-ai · 2025-04-15T18:32:56Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

packages/ui-voip/src/lib/VoipClient.ts

packages/ui-voip/src/components/VoipPopup/views/VoipErrorView.tsx

packages/ui-voip/src/lib/VoipClient.ts

packages/ui-voip/src/providers/VoipProvider.tsx

packages/ui-voip/src/lib/VoipClient.ts

vmarinogg · 2025-04-17T14:22:25Z

This PR is important for us to test the VoIP solution on Open continuously, and also represents important improvements in how we currently handle call errors. If approved technically, we can move forward with it.

kody-ai · 2025-04-17T19:16:48Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-17T19:18:19Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

packages/ui-voip/src/lib/getMainInviteRejectionReason.ts

packages/ui-voip/src/lib/parseInviteRejectionReasons.ts

kody-ai · 2025-04-18T02:41:34Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-18T06:01:38Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-18T06:49:20Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-19T15:48:04Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-20T23:45:26Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

pierre-lehnen-rc added 4 commits April 10, 2025 13:57

fix: voip calls not ringing after temporary disconnection

ed6992d

only auto register if a registration was lost before

0719cd9

show reconnecting status on usermenu

27d1307

feat: improve voip error handling

3080596

pierre-lehnen-rc added this to the 7.6.0 milestone Apr 11, 2025

fixed i18n key

b73d7a2

Base automatically changed from fix/voip-reconnection to develop April 15, 2025 17:46

pierre-lehnen-rc marked this pull request as ready for review April 15, 2025 18:04

pierre-lehnen-rc requested a review from a team as a code owner April 15, 2025 18:04

Merge branch 'develop' into fix/voip-hangup-cause

652bfec

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/lib/VoipClient.ts Outdated Show resolved Hide resolved

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/components/VoipPopup/views/VoipErrorView.tsx Show resolved Hide resolved

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/components/VoipPopup/views/VoipErrorView.tsx Show resolved Hide resolved

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/lib/VoipClient.ts Outdated Show resolved Hide resolved

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/lib/VoipClient.ts Show resolved Hide resolved

kody-ai bot reviewed Apr 15, 2025

View reviewed changes

packages/ui-voip/src/providers/VoipProvider.tsx Show resolved Hide resolved

pierre-lehnen-rc added the stat: QA assured Means it has been tested and approved by a company insider label Apr 17, 2025

dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Apr 17, 2025

MarcosSpessatto suggested changes Apr 17, 2025

View reviewed changes

packages/ui-voip/src/lib/VoipClient.ts Show resolved Hide resolved

ggazzo previously approved these changes Apr 17, 2025

View reviewed changes

moved error parsing to separate files and added unit tests for it

f2b0b8f

pierre-lehnen-rc dismissed ggazzo’s stale review via f2b0b8f April 17, 2025 19:16

pierre-lehnen-rc requested a review from MarcosSpessatto April 17, 2025 19:17

pierre-lehnen-rc requested a review from ggazzo April 17, 2025 19:17

Merge branch 'develop' into fix/voip-hangup-cause

a4eb161

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

packages/ui-voip/src/lib/getMainInviteRejectionReason.ts Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

packages/ui-voip/src/lib/parseInviteRejectionReasons.ts Show resolved Hide resolved

MarcosSpessatto approved these changes Apr 17, 2025

View reviewed changes

Merge branch 'develop' into fix/voip-hangup-cause

2c89fcd

Merge branch 'develop' into fix/voip-hangup-cause

7e08948

Merge branch 'develop' into fix/voip-hangup-cause

0e9ac3a

Merge branch 'develop' into fix/voip-hangup-cause

eff3045

Merge branch 'develop' into fix/voip-hangup-cause

7f363a2

kodiakhq bot merged commit 996f5b9 into develop Apr 21, 2025
48 checks passed

kodiakhq bot deleted the fix/voip-hangup-cause branch April 21, 2025 12:40

lucas-a-pelegrino pushed a commit that referenced this pull request Apr 29, 2025

feat: improve voip error handling (#35776)

21ce823

rocketchat-github-ci mentioned this pull request May 20, 2025

Release 7.7.0 #36031

Merged

feat: improve voip error handling #35776

feat: improve voip error handling #35776

Uh oh!

Conversation

pierre-lehnen-rc commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes (including videos or screenshots)

Issue(s)

Steps to test or reproduce

Further comments

Uh oh!

dionisio-bot bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2025-04-20 23:57 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

codecov bot commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kody-ai bot commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vmarinogg commented Apr 17, 2025

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

Uh oh!

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pierre-lehnen-rc commented Apr 10, 2025 •

edited

Loading

dionisio-bot bot commented Apr 10, 2025 •

edited

Loading

changeset-bot bot commented Apr 10, 2025 •

edited

Loading

github-actions bot commented Apr 10, 2025 •

edited

Loading

Built to branch `gh-pages` at 2025-04-20 23:57 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

codecov bot commented Apr 15, 2025 •

edited

Loading

kody-ai bot commented Apr 15, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 19, 2025 •

edited

Loading

kody-ai bot commented Apr 20, 2025 •

edited

Loading