[NEW] Omnichannel source identification fields (RocketChat#23090)

* Add new fields to IOmnichannelRoom and adapt livechat bridge to them

* Add source information to places that create livechat rooms

* Add deprecation warning to unused livechat methods and remove source from native facebook integration

* Remove unnecesary alias for widget

* Update app/lib/server/lib/deprecationWarningLogger.ts

* Update Apps-Engine version

* frontend part

* Change way of identifying when a chat is coming through widget

* Update deprecationlogger to new logger interface

* Fix usage of source.type as key

* sms icon

* [NEW] Add Channel Source details to room info panel (RocketChat#23224)

* Add Source icon/text to room info

* Fix TS error and styling

* Change order

* Typing and style fix

* Use source.id instead of email object

* useEndpoint

* Revert "Merge branch 'develop' into new/omnichannel-source-fields"

This reverts commit 7fea2ad, reversing
changes made to dbbcaf4.

* Removing unnecesary changes from branch

* why github, why?

* Bump icons & fuselage to latest versions

Co-authored-by: Kevin Aleman <kevin.aleman@rocket.chat>
Co-authored-by: Tiago Evangelista Pinto <tiago.evangelista@rocket.chat>
Co-authored-by: Martin Schoeler <martin.schoeler@rocket.chat>

Author: 4 people

app/api/server/helpers/deprecationWarning.js

@@ -0,0 +1,15 @@
+import { API } from '../api';
+import { apiDeprecationLogger } from '../../../lib/server/lib/deprecationWarningLogger';
+
+(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 }`;
+	apiDeprecationLogger.warn(warningMessage);
+	if (process.env.NODE_ENV === 'development') {
+		return {
+			warning: warningMessage,
+			...response,
+		};
+	}
+
+	return response;
+});

app/api/server/helpers/deprecationWarning.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');
+});

app/api/server/helpers/isWidget.ts

@@ -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';

app/api/server/index.js

@@ -19,6 +19,7 @@ import {
 	LivechatRooms,
 } from '../../../models/server';
 import { AppServerOrchestrator } from '../orchestrator';
+import { OmnichannelSourceType } from '../../../../definition/IRoom';
 
 export class AppLivechatBridge extends LivechatBridge {
 	// eslint-disable-next-line no-empty-function
@@ -45,7 +46,13 @@ export class AppLivechatBridge extends LivechatBridge {
 			guest: this.orch.getConverters()?.get('visitors').convertAppVisitor(message.visitor),
 			message: this.orch.getConverters()?.get('messages').convertAppMessage(message),
 			agent: undefined,
-			roomInfo: undefined,
+			roomInfo: {
+				source: {
+					type: OmnichannelSourceType.APP,
+					id: appId,
+					alias: this.orch.getManager()?.getOneById(appId)?.getNameSlug(),
+				},
+			},
 		});
 
 		return msg._id;
@@ -81,7 +88,13 @@ export class AppLivechatBridge extends LivechatBridge {
 			guest: this.orch.getConverters()?.get('visitors').convertAppVisitor(visitor),
 			agent: agentRoom,
 			rid: Random.id(),
-			roomInfo: undefined,
+			roomInfo: {
+				source: {
+					type: OmnichannelSourceType.APP,
+					id: appId,
+					alias: this.orch.getManager()?.getOneById(appId)?.getNameSlug(),
+				},
+			},
 			extraParams: undefined,
 		});
 

app/apps/server/bridges/livechat.ts

@@ -0,0 +1,7 @@
+import { Logger } from '../../../logger/server';
+
+const deprecationLogger = new Logger('DeprecationWarning');
+
+export const apiDeprecationLogger = deprecationLogger.section('API');
+export const methodDeprecationLogger = deprecationLogger.section('METHOD');
+export const functionDeprecationLogger = deprecationLogger.section('FUNCTION');

app/lib/server/lib/deprecationWarningLogger.ts

@@ -7,6 +7,7 @@ import { LivechatRooms, LivechatVisitors, LivechatDepartment } from '../../../..
 import { API } from '../../../../api/server';
 import { SMS } from '../../../../sms';
 import { Livechat } from '../../../server/lib/Livechat';
+import { OmnichannelSourceType } from '../../../../../definition/IRoom';
 
 const getUploadFile = (details, fileUrl) => {
 	const response = HTTP.get(fileUrl, { npmRequestOptions: { encoding: null } });
@@ -83,6 +84,10 @@ API.v1.addRoute('livechat/sms-incoming/:service', {
 				sms: {
 					from: sms.to,
 				},
+				source: {
+					type: OmnichannelSourceType.SMS,
+					alias: this.urlParams.service,
+				},
 			},
 		};
 

app/livechat/imports/server/rest/sms.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));
 	},
 });

app/livechat/imports/server/rest/upload.js

@@ -10,6 +10,7 @@ import { findGuest, findRoom, normalizeHttpHeaderData } from '../lib/livechat';
 import { Livechat } from '../../lib/Livechat';
 import { normalizeMessageFileUpload } from '../../../../utils/server/functions/normalizeMessageFileUpload';
 import { settings } from '../../../../settings/server';
+import { OmnichannelSourceType } from '../../../../../definition/IRoom';
 
 API.v1.addRoute('livechat/message', {
 	post() {
@@ -56,6 +57,11 @@ API.v1.addRoute('livechat/message', {
 					token,
 				},
 				agent,
+				roomInfo: {
+					source: {
+						type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
+					},
+				},
 			};
 
 			const result = Promise.await(Livechat.sendMessage(sendMessage));
@@ -305,6 +311,11 @@ API.v1.addRoute('livechat/messages', { authRequired: true }, {
 					token: visitorToken,
 					msg: message.msg,
 				},
+				roomInfo: {
+					source: {
+						type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
+					},
+				},
 			};
 			const sentMessage = Promise.await(Livechat.sendMessage(sendMessage));
 			return {

app/livechat/server/api/v1/message.js

@@ -10,7 +10,7 @@ import { findGuest, findRoom, getRoom, settings, findAgent, onCheckRoomParams }
 import { Livechat } from '../../lib/Livechat';
 import { normalizeTransferredByData } from '../../lib/Helper';
 import { findVisitorInfo } from '../lib/visitors';
-
+import { OmnichannelSourceType } from '../../../../../definition/IRoom';
 
 API.v1.addRoute('livechat/room', {
 	get() {
@@ -46,7 +46,13 @@ API.v1.addRoute('livechat/room', {
 			}
 
 			const rid = Random.id();
-			room = Promise.await(getRoom({ guest, rid, agent, extraParams }));
+			const roomInfo = {
+				source: {
+					type: this.isWidget() ? OmnichannelSourceType.WIDGET : OmnichannelSourceType.API,
+				},
+			};
+
+			room = Promise.await(getRoom({ guest, rid, agent, roomInfo, extraParams }));
 			return API.v1.success(room);
 		}