fix: Update Contact's custom fields when updating visitor custom fields #35580

lucas-a-pelegrino · 2025-03-21T13:28:54Z

Proposed changes (including videos or screenshots)

This PR aims to increment the logic of .setCustomFields(), updating the customFields from the visitor's Contact entity when applicable.

When Contact.customFields is nullish and/or overwrite is true, it inserts the customFields accordingly. If Contact.customFields is not nullish and overwrite is false, it will save it as a conflict.

Issue(s)

CTZ-17

Steps to test or reproduce

Open Livechat widget
Call setCustomField API method
Start a new chat
call setCustomField again with a different value

Further comments

This pull request introduces enhancements and bug fixes related to the handling of custom fields in the Rocket.Chat Livechat module. The key changes include:

Functionality Update: The setCustomFields function is updated to correctly update the Context's customFields property, ensuring that custom fields are managed accurately.
Livechat Bridge Enhancement: Implementation for setting custom fields is added to the AppLivechatBridge class, with a note for future refactoring.
Visitor Registration Enhancement: The visitor registration endpoint (POST livechat/visitor) is enhanced to update custom fields for associated Livechat contacts when a visitor's custom fields are updated. This is achieved by introducing the LivechatContacts model and using the updateContactsCustomFields function to perform updates in parallel.
Custom Fields Refactoring: The setCustomFields function is refactored to handle updates for associated livechat contacts when the scope is not 'room'. A new helper function, updateContactsCustomFields, is introduced to manage update logic, including handling overwrites and conflicts. This involves fetching the visitor, identifying associated contacts, and updating them concurrently.
Error Handling Removal: Error handling for custom field operations is removed, which may potentially hide failures during these operations.

These changes aim to improve the robustness and functionality of custom field management within the Livechat module.

dionisio-bot · 2025-03-21T13:28:57Z

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

changeset-bot · 2025-03-21T13:28:58Z

🦋 Changeset detected

Latest commit: 9e70f13

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

This PR includes changesets to release 36 packages

Name	Type
@rocket.chat/meteor	Patch
@rocket.chat/core-typings	Patch
@rocket.chat/rest-typings	Patch
@rocket.chat/uikit-playground	Patch
@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/fuselage-ui-kit	Patch
@rocket.chat/gazzodown	Patch
@rocket.chat/livechat	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/ui-contexts	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/mock-providers	Patch
@rocket.chat/ui-avatar	Patch
@rocket.chat/ui-client	Patch
@rocket.chat/ui-video-conf	Patch
@rocket.chat/ui-voip	Patch
@rocket.chat/web-ui-registration	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-03-21T13:34:30Z

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

codecov · 2025-03-21T13:35:28Z

Codecov Report

Attention: Patch coverage is 6.66667% with 14 lines in your changes missing coverage. Please review.

Project coverage is 61.19%. Comparing base (1c839a3) to head (9e70f13).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #35580      +/-   ##
===========================================
+ Coverage    61.16%   61.19%   +0.02%     
===========================================
  Files         2971     3119     +148     
  Lines        70838    73822    +2984     
  Branches     16184    16481     +297     
===========================================
+ Hits         43325    45172    +1847     
- Misses       24564    25620    +1056     
- Partials      2949     3030      +81

Flag	Coverage Δ
e2e	`57.69% <ø> (+0.02%)`	⬆️
unit	`75.57% <6.66%> (-0.04%)`	⬇️

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.

…at API

…ix/CTZ-17

…o bugfix/CTZ-17

…ct and updates the customFields

KevLehman

Can u add a changeset?

apps/meteor/app/apps/server/bridges/livechat.ts

apps/meteor/app/livechat/server/api/v1/customField.ts

apps/meteor/app/livechat/server/lib/LivechatTyped.ts

kody-ai · 2025-04-16T18:48:28Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

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-16T18:50:16Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

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-16T19:21:26Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

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-17T15:32:07Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

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.

Dismissed as Kevin is OOO.

.changeset/young-kiwis-fly.md

apps/meteor/app/livechat/server/api/v1/visitor.ts

scuciatto · 2025-06-05T21:37:42Z

/backport 7.5.2

dionisio-bot · 2025-06-05T21:38:13Z

Sorry, I couldn't do that backport because of conflicts. Could you please solve them?

you can do so by running the following commands:

git fetch
git checkout backport-7.5.2-35580
git cherry-pick 3309dac86aaa331af0eeaba4a9a2620d8bd74423
// solve the conflict
git push

after that just run /backport 7.5.2 again

lucas-a-pelegrino · 2025-06-05T22:32:36Z

/backport 7.5.2

dionisio-bot · 2025-06-05T22:32:54Z

Pull request #36170 added to Project: "Patch 7.5.2"

feat: adds contact custom field update when visitor's contact exists

496c5f5

lucas-a-pelegrino added 3 commits March 27, 2025 15:23

test: implements test case for contact custom field update via livech…

51698f5

…at API

chore: fixes lint errors

dd3d614

chore: improves the quality of contact's custom fields tests

2d6eea4

scuciatto added this to the 7.6.0 milestone Mar 31, 2025

lucas-a-pelegrino and others added 13 commits March 31, 2025 15:11

fix: fixes test case before setup

1f6d923

chore: change contact find method in setCustomFields

bbe62c2

fix: simplifies before setup

c5c8a9d

tests: refactors tests to be more independently

ddadd9d

test: fix contact creation

440039a

test: fix visitor fetch and custom fields validation

0553d69

refactor: adds minor improvements to setCustomFields logic and tests

c2e72b8

fix: removes .only method call

6aca79b

Merge branch 'develop' into bugfix/CTZ-17

d4ece99

refactor: adds changes in the .setCustomFields() return values

3b5e363

Merge branch 'develop' of github.com:RocketChat/Rocket.Chat into bugf…

4a4c11d

…ix/CTZ-17

Merge branch 'bugfix/CTZ-17' of github.com:RocketChat/Rocket.Chat int…

4e2ff22

…o bugfix/CTZ-17

fix: adds a placeholder return number.

0be6691

lucas-a-pelegrino marked this pull request as ready for review April 2, 2025 20:20

lucas-a-pelegrino requested review from a team as code owners April 2, 2025 20:20

chore: adds minor improvements to the logic that checks for the conta…

0c8c699

…ct and updates the customFields

KevLehman requested changes Apr 4, 2025

View reviewed changes

lucas-a-pelegrino and others added 2 commits April 7, 2025 12:32

chore: adds improvements requested in code review

6b485f0

chore: adds changeset

079c71e

lucas-a-pelegrino requested a review from a team as a code owner April 16, 2025 18:48

chore: removes commented code

f6108f4

chore: removes .only leftover

76343dd

lucas-a-pelegrino requested a review from KevLehman April 16, 2025 19:19

chore: removes commented code

fdd12d8

refactor: adds improvements that covers an edge case

1177d65

renatobecker 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

Merge remote-tracking branch 'origin/develop' into bugfix/CTZ-17

42b7e03

sampaiodiego requested changes Apr 17, 2025

View reviewed changes

.changeset/young-kiwis-fly.md Outdated Show resolved Hide resolved

apps/meteor/app/livechat/server/api/v1/visitor.ts Show resolved Hide resolved

sampaiodiego added 4 commits April 17, 2025 19:01

doc: improve changeset

03ce299

add TODO

bdc9272

remove file again

63fc15a

revert old behavior

7df9768

sampaiodiego changed the title ~~feat: Contact's custom fields on setCustomFields~~ fix: Update Contact's custom fields when updating visitor custom fields Apr 17, 2025

sampaiodiego approved these changes Apr 17, 2025

View reviewed changes

Merge branch 'develop' into bugfix/CTZ-17

9e70f13

kodiakhq bot merged commit 3309dac into develop Apr 18, 2025
48 checks passed

kodiakhq bot deleted the bugfix/CTZ-17 branch April 18, 2025 05:05

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

Release 7.6.0 #35843

Merged

dionisio-bot bot mentioned this pull request Jun 5, 2025

fix: Update Contact's custom fields when updating visitor custom fields #36170

Merged

fix: Update Contact's custom fields when updating visitor custom fields #35580

fix: Update Contact's custom fields when updating visitor custom fields #35580

Uh oh!

Conversation

lucas-a-pelegrino commented Mar 21, 2025 • edited by kody-ai bot 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 Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 21, 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 Mar 21, 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-18 03:48 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

KevLehman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Kody Review Complete

Uh oh!

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

Uh oh!

Kody Review Complete

Uh oh!

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

Uh oh!

Kody Review Complete

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!

Kody Review Complete

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scuciatto commented Jun 5, 2025

Uh oh!

dionisio-bot bot commented Jun 5, 2025

Uh oh!

lucas-a-pelegrino commented Jun 5, 2025

Uh oh!

dionisio-bot bot commented Jun 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lucas-a-pelegrino commented Mar 21, 2025 •

edited by kody-ai bot

Loading

dionisio-bot bot commented Mar 21, 2025 •

edited

Loading

changeset-bot bot commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025 •

edited

Loading

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

codecov bot commented Mar 21, 2025 •

edited

Loading

kody-ai bot commented Apr 16, 2025 •

edited

Loading

kody-ai bot commented Apr 16, 2025 •

edited

Loading

kody-ai bot commented Apr 16, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading