Change way of identifying when a chat is coming through widget

RocketChat · Sep 10, 2021 · e6a0e40 · e6a0e40
1 parent abed911
commit e6a0e40
Show file tree

Hide file tree

Showing 13 changed files with 24,111 additions and 1,092 deletions.
diff --git a/app/api/server/helpers/deprecationWarning.js → app/api/server/helpers/deprecationWarning.ts b/app/api/server/helpers/deprecationWarning.js → app/api/server/helpers/deprecationWarning.ts
@@ -1,9 +1,9 @@
 import { API } from '../api';
 import { deprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
 
-API.helperMethods.set('deprecationWarning', function _deprecationWarning({ endpoint, versionWillBeRemoved, response }) {
+(API as any).helperMethods.set('deprecationWarning', function _deprecationWarning({ endpoint, versionWillBeRemoved, response }: { endpoint: string; versionWillBeRemoved: string; response: any }) {
 	const warningMessage = `The endpoint "${ endpoint }" is deprecated and will be removed after version ${ versionWillBeRemoved }`;
-	deprecationLogger.api.warn(warningMessage);
+	(deprecationLogger as any).api.warn(warningMessage);
 	if (process.env.NODE_ENV === 'development') {
 		return {
 			warning: warningMessage,

diff --git a/app/api/server/helpers/isWidget.ts b/app/api/server/helpers/isWidget.ts
@@ -0,0 +1,13 @@
+import { parse } from 'cookie';
+
+import { API } from '../api';
+
+(API as any).helperMethods.set('isWidget', function _isWidget() {
+	// @ts-expect-error
+	const { headers } = this.request;
+
+	const { rc_room_type: roomType, rc_is_widget: isWidget } = parse(headers.cookie);
+
+	const isLivechatRoom = roomType && roomType === 'l';
+	return !!(isLivechatRoom && isWidget === 't');
+});
diff --git a/app/api/server/index.js b/app/api/server/index.js
@@ -9,6 +9,7 @@ import './helpers/insertUserObject';
 import './helpers/isUserFromParams';
 import './helpers/parseJsonQuery';
 import './helpers/requestParams';
+import './helpers/isWidget';
 import './default/info';
 import './v1/assets';
 import './v1/channels';

diff --git a/app/livechat/imports/server/rest/upload.js b/app/livechat/imports/server/rest/upload.js
@@ -72,6 +72,6 @@ API.v1.addRoute('livechat/upload/:rid', {
 		uploadedFile.description = fields.description;
 
 		delete fields.description;
-		API.v1.success(Meteor.call('sendFileLivechatMessage', this.urlParams.rid, visitorToken, uploadedFile, fields));
+		return API.v1.success(Meteor.call('sendFileLivechatMessage', this.urlParams.rid, visitorToken, uploadedFile, fields));
 	},
 });
diff --git a/app/livechat/server/api/v1/message.js b/app/livechat/server/api/v1/message.js
@@ -59,8 +59,7 @@ API.v1.addRoute('livechat/message', {
 				agent,
 				roomInfo: {
 					source: {
-						type: OmnichannelSourceType.OTHER,
-						alias: 'livechat-api',
+						type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
 					},
 				},
 			};
@@ -314,8 +313,7 @@ API.v1.addRoute('livechat/messages', { authRequired: true }, {
 				},
 				roomInfo: {
 					source: {
-						type: OmnichannelSourceType.OTHER,
-						alias: 'livechat-api',
+						type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
 					},
 				},
 			};

diff --git a/app/livechat/server/api/v1/room.js b/app/livechat/server/api/v1/room.js
@@ -48,7 +48,7 @@ API.v1.addRoute('livechat/room', {
 			const rid = Random.id();
 			const roomInfo = {
 				source: {
-					type: OmnichannelSourceType.WIDGET,
+					type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
 				},
 			};
 

diff --git a/app/livechat/server/api/v1/videoCall.js b/app/livechat/server/api/v1/videoCall.js
@@ -30,7 +30,7 @@ API.v1.addRoute('livechat/video.call/:token', {
 			const roomInfo = {
 				jitsiTimeout: new Date(Date.now() + 3600 * 1000),
 				source: {
-					type: OmnichannelSourceType.OTHER,
+					type: OmnichannelSourceType.API,
 					alias: 'video-call',
 				},
 			};

diff --git a/app/livechat/server/methods/sendMessageLivechat.js b/app/livechat/server/methods/sendMessageLivechat.js
@@ -43,8 +43,7 @@ Meteor.methods({
 			agent,
 			roomInfo: {
 				source: {
-					type: OmnichannelSourceType.OTHER,
-					alias: 'livechat-api',
+					type: OmnichannelSourceType.API,
 				},
 			},
 		});

diff --git a/app/livechat/server/methods/startFileUploadRoom.js b/app/livechat/server/methods/startFileUploadRoom.js
@@ -20,7 +20,7 @@ Meteor.methods({
 		};
 
 		const roomInfo = {
-			source: OmnichannelSourceType.OTHER,
+			source: OmnichannelSourceType.API,
 			alias: 'file-upload',
 		};
 

diff --git a/app/livechat/server/methods/startVideoCall.js b/app/livechat/server/methods/startVideoCall.js
@@ -26,7 +26,7 @@ Meteor.methods({
 		const roomInfo = {
 			jitsiTimeout: new Date(Date.now() + 3600 * 1000),
 			source: {
-				type: OmnichannelSourceType.OTHER,
+				type: OmnichannelSourceType.API,
 				alias: 'video-call',
 			},
 		};

diff --git a/definition/IRoom.ts b/definition/IRoom.ts
@@ -74,7 +74,8 @@ export enum OmnichannelSourceType {
 	EMAIL = 'email',
 	SMS = 'sms',
 	APP = 'app',
-	OTHER = 'other', // temporal, catch-all source type
+	API = 'api',
+	OTHER = 'other', // catch-all source type
 }
 
 export interface IOmnichannelRoom extends Omit<IRoom, 'default' | 'featured' | 'broadcast' | 'featured' | ''> {