[NEW] Send LiveChat visitor navigation history as messages #10091

renatobecker-zz · 2018-03-09T22:18:49Z

@RocketChat/core

Closes #9853
The purpose of this PR is to send the navigation history of the Livechat visitor as a message.
Using this feature, the agent that is attending the chat will be notified each time the visitor's navigation is changed.
So, the informations about the navigation will be displayed as a message into the LiveChat room, but the visitor will not be notified.
The default value of the setting is false.

Closes #9874
New feature added to send messages related to Livechat visitor navigation history in CRM integrations.
When this feature is enabled, the stored messages containing the visitor navigation history will be
sent to the CRM along with other requests.
The default value of the setting is false.

…navigaton-history-as-a-message

…ents.

- Created a setting to manage it (enabled by default) - Created a migration to move navigation historys to messages collection

sampaiodiego · 2018-03-12T13:18:49Z

packages/rocketchat-livechat/.app/imports/client/visitor.js

 		msgStream.on(roomId, { token: this.getToken() }, (msg) => {
 			if (msg.t === 'command') {
 				Commands[msg.msg] && Commands[msg.msg]();
-			} else if (msg.t !== 'livechat_video_call') {
+            } else if (!_.contains(msgTypesNotDisplayed, msg.t)) {


no need to use underscore here, you can use includes

sampaiodiego · 2018-03-12T13:22:22Z

packages/rocketchat-livechat/server/lib/Livechat.js

@@ -311,9 +311,31 @@ RocketChat.Livechat = {
 		});
 	},

-	savePageHistory(token, pageInfo) {
+	savePageHistory(token, roomId, pageInfo) {


you don't need to receive roomId here.. we can rely on RocketChat.models.Rooms.findOneOpenByVisitorToken to get visitor's current room.

@sampaiodiego, the RocketChat.models.Rooms.findOneOpenByVisitorToken has a roomId parameter, due to this I changed the savePageHistory to get this parameter.
How can I call the RocketChat.models.Rooms.findOneOpenByVisitorToken method if I don't pass the roomId parameter?
I'm sorry if I'm making a mistake but I think this parameter is necessary.

you're correct @renatobecker .. I didn't notice RocketChat.models.Rooms.findOneOpenByVisitorToken has a roomId parameter as well. 😉
I'll give this PR a whole review to see how we could still save visitor's navigation history without a room.

sampaiodiego · 2018-03-12T13:27:13Z

packages/rocketchat-livechat/server/methods/registerGuest.js

@@ -7,9 +7,6 @@ Meteor.methods({
 			department
 		});

-		// update visited page history to not expire
-		RocketChat.models.LivechatPageVisited.keepHistoryForToken(token);


we should keep this behavior. the idea is that page history of unregistered visitors can be deleted (expired), because we track visitor's navigation from the very first interaction.. but if that visitor sends a message then we want to keep his page history "forever"

There is a problem here.. I tried to keep this behavior, but currently we are sending and storing the navigation history as a message and we have a relation between message and room.
The point is that the method RocketChat.models.Messages.createWithTypeRoomIdMessageAndUser calls another method RocketChat.models.Rooms.incMsgCountById(room._id, 1) and a valid room is required.
So, because of this we can't store messages without a room using this method.
If you could give me an orientation about this it would be nice.

~~I'll give this another look, but once we merge #9903 we will not call incMsgCountById anymore.. so we might be able to keep this behavior..~~
edit: this is not true as well 😞 I've made a confusion with incMsgCountById method. it needs to be there.. what I think we need to do is to create a new method to insert navigation histories and do not call incMsgCountById there..

sampaiodiego · 2018-03-14T13:28:04Z

packages/rocketchat-livechat/client/views/app/tabbar/visitorNavigation.js

-		if (room && room.v && room.v.token) {
-			return LivechatPageVisited.find({ token: room.v.token }, { sort: { ts: -1 } });
+		if (room) {
+			return LivechatMessage.find({rid: room._id, t: 'livechat_navigation_history', $or: [{ _shared: { $exists: false }}, { _shared: true }]}, { sort: { ts: -1 } });


why did you use this _shared filter?

OMG! It's a good question...
As you could see, I made a mistake.. Actually, I was trying to deal with the _hidden property and not the _shared property, but I just see that it is not necessary because I'm filtering the messages type(t: 'livechat_navigation_history') on the subscribe.
I made this mess because we have a setting to activate this feature and when the feature is not enabled, the messages are still sending, but with the _hidden property defined. So, I thought that if I didn't force the filter, the messages would not be received on the client side.
Anyway, I just pushed a new commit fixing this mistake.
Thanks!

sampaiodiego · 2018-03-14T13:29:59Z

packages/rocketchat-livechat/server/lib/Livechat.js

+			// It's necessary to check the room due to the incMsgCountById method inside RocketChat.models.Rooms.findOneOpenByVisitorToken
+			const room = RocketChat.models.Rooms.findOneOpenByVisitorToken(token, roomId);
+			if (!room) {
+				return false;


we have to keep saving navigation history even if there is no room yet, so we cannot abort here

sampaiodiego · 2018-03-14T13:31:01Z

packages/rocketchat-livechat/server/lib/Livechat.js

+				extraData._hidden = true;
+			}
+
+			return RocketChat.models.Messages.createWithTypeRoomIdMessageAndUser('livechat_navigation_history', room._id, `${ TAPi18n.__('New_visitor_navigation') }: ${ pageTitle } - ${ pageUrl }`, user, extraData);


since this method requires a room, we'll need to create another one that still saves the message even with no room.

sampaiodiego · 2018-03-14T13:51:32Z

packages/rocketchat-livechat/server/methods/registerGuest.js

@@ -7,9 +7,6 @@ Meteor.methods({
 			department
 		});

-		// update visited page history to not expire
-		RocketChat.models.LivechatPageVisited.keepHistoryForToken(token);


to keep this behavior, as stated before, we'll have to use a new method to store navigations histories as messages. this new method will use RocketChat.models.Rooms.incMsgCountById only if there is a room opened. please take a special look at this, we'll need an index like that on the messages collection as well.

sampaiodiego · 2018-03-14T13:52:07Z

packages/rocketchat-livechat/server/methods/setDepartmentForVisitor.js

@@ -5,9 +5,6 @@ Meteor.methods({
 			department
 		});

-		// update visited page history to not expire
-		RocketChat.models.LivechatPageVisited.keepHistoryForToken(token);


remember to add this back too =)

sampaiodiego · 2018-03-14T13:56:05Z

packages/rocketchat-livechat/server/models/LivechatMessage.js

+ */
+class LivechatMessage extends RocketChat.models._Base {
+	constructor() {
+		super('rocketchat_message');


I don't think this is working as expected, it is creating a collection called rocketchat_rocketchat_message. Also looks like RocketChat.models.LivechatMessage is not used anywhere.

sampaiodiego · 2018-03-14T14:26:44Z

server/startup/migrations/v108.js

@@ -0,0 +1,45 @@
+RocketChat.Migrations.add({


this migration can be huge, so I think we need to make it asynchronous migration 106

renatobecker added 5 commits February 26, 2018 15:22

Fix livechat routes to allow inviting other agents to the same chat.

2fb6d12

Fix indentation tabs.

41e7cbd

Merge branch 'fix-invite-agents-to-livechat-rooms' into send-visitor-…

089e15e

…navigaton-history-as-a-message

Started working on send visitor navigation history as a message to ag…

587ffda

…ents.

- Sending the navigation history of the visitor as a message;

460b76b

- Created a setting to manage it (enabled by default) - Created a migration to move navigation historys to messages collection

renatobecker-zz requested review from rodrigok and sampaiodiego March 9, 2018 22:18

engelgabriel temporarily deployed to rocket-chat-pr-10091 March 9, 2018 22:19 Inactive

Fix Ci build validations.

221c595

engelgabriel temporarily deployed to rocket-chat-pr-10091 March 12, 2018 13:26 Inactive

sampaiodiego requested changes Mar 12, 2018

View reviewed changes

RocketChat deleted a comment Mar 12, 2018

Fix PR review.

bc8c03d

engelgabriel temporarily deployed to rocket-chat-pr-10091 March 12, 2018 14:23 Inactive

sampaiodiego reviewed Mar 14, 2018

View reviewed changes

Fix filter of the navigation history subscribe.

5b4ec2a

engelgabriel temporarily deployed to rocket-chat-pr-10091 March 14, 2018 14:19 Inactive

sampaiodiego requested changes Mar 14, 2018

View reviewed changes

Fix PR review.

57d0bf3

engelgabriel temporarily deployed to rocket-chat-pr-10091 March 14, 2018 20:05 Inactive

Fix codacy-bot review issues.

632baf1

engelgabriel temporarily deployed to rocket-chat-pr-10091 May 29, 2018 21:46 Inactive

RocketChat deleted a comment May 29, 2018

Merge branch 'develop' into send-visitor-navigaton-history-as-a-message

f4c62d8

sampaiodiego temporarily deployed to rocket-chat-pr-10091 June 4, 2018 18:57 Inactive

sampaiodiego added 3 commits June 5, 2018 01:38

Fix coding styling

d314565

Do not return message on pageVisited method

2cc736b

Better styling for navigation history messages

bf90817

sampaiodiego temporarily deployed to rocket-chat-pr-10091 June 5, 2018 04:41 Inactive

Improved livechat history migration to run faster

b2535ea

sampaiodiego force-pushed the send-visitor-navigaton-history-as-a-message branch from 6fdebef to b2535ea Compare June 5, 2018 14:01

sampaiodiego temporarily deployed to rocket-chat-pr-10091 June 5, 2018 14:01 Inactive

Disable showing livechat navigation history as message by default

cb2274d

sampaiodiego temporarily deployed to rocket-chat-pr-10091 June 5, 2018 16:52 Inactive

sampaiodiego previously approved these changes Jun 5, 2018

View reviewed changes

sampaiodiego changed the title ~~[NEW] Send LiveChat visitor navigation as a message~~ [NEW] Send LiveChat visitor navigation history as messages Jun 5, 2018

Better visitor navigation translation

c086d6c

sampaiodiego dismissed their stale review via c086d6c June 5, 2018 19:00

sampaiodiego temporarily deployed to rocket-chat-pr-10091 June 5, 2018 19:00 Inactive

Remove unnecessary files

b350a0b

sampaiodiego deployed to rocket-chat-pr-10091 June 5, 2018 19:08 View deployment

sampaiodiego approved these changes Jun 5, 2018

View reviewed changes

sampaiodiego merged commit 2218753 into develop Jun 5, 2018

sampaiodiego deleted the send-visitor-navigaton-history-as-a-message branch June 5, 2018 19:57

rodrigok mentioned this pull request Jun 28, 2018

Release 0.66.0 #11278

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NEW] Send LiveChat visitor navigation history as messages #10091

[NEW] Send LiveChat visitor navigation history as messages #10091

renatobecker-zz commented Mar 9, 2018 •

edited by sampaiodiego

Loading

sampaiodiego Mar 12, 2018

sampaiodiego Mar 12, 2018

renatobecker-zz Mar 12, 2018

sampaiodiego Mar 13, 2018

sampaiodiego Mar 12, 2018

renatobecker-zz Mar 12, 2018

sampaiodiego Mar 13, 2018 •

edited

Loading

sampaiodiego Mar 14, 2018

renatobecker-zz Mar 14, 2018

sampaiodiego Mar 14, 2018

sampaiodiego Mar 14, 2018

sampaiodiego Mar 14, 2018

sampaiodiego Mar 14, 2018

sampaiodiego Mar 14, 2018

sampaiodiego Mar 14, 2018

[NEW] Send LiveChat visitor navigation history as messages #10091

[NEW] Send LiveChat visitor navigation history as messages #10091

Conversation

renatobecker-zz commented Mar 9, 2018 • edited by sampaiodiego Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sampaiodiego Mar 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renatobecker-zz commented Mar 9, 2018 •

edited by sampaiodiego

Loading

sampaiodiego Mar 13, 2018 •

edited

Loading