Skip to content

fix: Calling registerGuest multiple times causes loss of communication #35555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 3 commits into from
Mar 19, 2025
Merged

fix: Calling registerGuest multiple times causes loss of communication #35555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ece1956
test: improved test case for multiple registerGuest calls
aleksandernsilva Mar 19, 2025
bb32f3f
fix: Calling registerGuest multiple times causes loss of communication
aleksandernsilva Mar 19, 2025
4ac69ad
chore: changeset
aleksandernsilva Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/selfish-toes-lay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@rocket.chat/meteor": patch
"@rocket.chat/livechat": patch
---

Fixes an issue causing Livechat to disconnect from the websocket when registerGuest is called multiple times with the same token
22 changes: 9 additions & 13 deletions apps/meteor/tests/e2e/omnichannel/omnichannel-livechat-api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,28 +565,24 @@ test.describe('OC - Livechat API', () => {

await expect(page.frameLocator('#rocketchat-iframe').getByText('Start Chat')).not.toBeVisible();

await poLiveChat.onlineAgentMessage.type('this_a_test_message_from_visitor');
await poLiveChat.onlineAgentMessage.fill('this_a_test_message_from_visitor');
await poLiveChat.btnSendMessageToOnlineAgent.click();

await expect(poLiveChat.txtChatMessage('this_a_test_message_from_visitor')).toBeVisible();

await poLiveChat.page.evaluate(
(registerGuestVisitor) => window.RocketChat.livechat.registerGuest(registerGuestVisitor),
registerGuestVisitor,
);
await poLiveChat.page.evaluate((registerGuestVisitor) => {
window.RocketChat.livechat.registerGuest(registerGuestVisitor);
window.RocketChat.livechat.registerGuest(registerGuestVisitor);
}, registerGuestVisitor);

await page.waitForResponse('**/api/v1/livechat/visitor');
await page.waitForTimeout(500); // NOTE: timeout is necessary to allow websocket unsubscribes to happen

await expect(poLiveChat.txtChatMessage('this_a_test_message_from_visitor')).toBeVisible();

await poLiveChat.page.evaluate(
(registerGuestVisitor) => window.RocketChat.livechat.registerGuest(registerGuestVisitor),
registerGuestVisitor,
);

await page.waitForResponse('**/api/v1/livechat/visitor');
await poLiveChat.onlineAgentMessage.fill('this_a_new_test_message_from_visitor');
await poLiveChat.btnSendMessageToOnlineAgent.click();

await expect(poLiveChat.txtChatMessage('this_a_test_message_from_visitor')).toBeVisible();
await expect(poLiveChat.txtChatMessage('this_a_new_test_message_from_visitor')).toBeVisible();
});
});

Expand Down
32 changes: 19 additions & 13 deletions packages/livechat/src/lib/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,30 @@ export const createOrUpdateGuest = async (guest: StoreState['guest']) => {
return;
}

const { token } = guest;
token && store.setState({ token });

const {
user,
iframe: { defaultDepartment },
} = store.state;

if (guest.token) {
store.setState({ token: guest.token });
}

if (defaultDepartment && !guest.department) {
guest.department = defaultDepartment;
}

const { visitor: user } = await Livechat.grantVisitor({ visitor: { ...guest } });
if (user && guest.token !== user.token) {
await Livechat.unsubscribeAll();
}

if (!user) {
const { visitor: newUser } = await Livechat.grantVisitor({ visitor: { ...guest } });

if (!newUser) {
return;
}
store.setState({ user } as Omit<StoreState['user'], 'ts'>);

store.setState({ user: newUser } as Omit<StoreState['user'], 'ts'>);
Triggers.callbacks?.emit('chat-visitor-registered');
};

Expand Down Expand Up @@ -225,19 +233,17 @@ const api = {
updateIframeGuestData({ email });
},

registerGuest: async (data: StoreState['guest']) => {
if (typeof data !== 'object') {
registerGuest: async (newGuest: StoreState['guest']) => {
if (typeof newGuest !== 'object') {
return;
}

await evaluateChangesAndLoadConfigByFields(async () => {
if (!data.token) {
data.token = createToken();
if (!newGuest.token) {
newGuest.token = createToken();
}

Livechat.unsubscribeAll();

await createOrUpdateGuest(data);
await createOrUpdateGuest(newGuest);
});
},

Expand Down
Loading