Merge branch 'develop' into rewrite/marketplace-page

.changeset/lucky-bikes-enjoy.md

@@ -0,0 +1,7 @@
+---
+"@rocket.chat/meteor": patch
+"@rocket.chat/core-typings": patch
+"@rocket.chat/rest-typings": patch
+---
+
+Added `chat.getURLPreview` endpoint to enable users to retrieve previews for URL (ready to be provided in message send/update)

apps/meteor/app/api/server/v1/chat.ts

@@ -1,7 +1,7 @@
 import { Message } from '@rocket.chat/core-services';
 import type { IMessage } from '@rocket.chat/core-typings';
 import { Messages, Users, Rooms, Subscriptions } from '@rocket.chat/models';
-import { isChatReportMessageProps } from '@rocket.chat/rest-typings';
+import { isChatReportMessageProps, isChatGetURLPreviewProps } from '@rocket.chat/rest-typings';
 import { escapeRegExp } from '@rocket.chat/string-helpers';
 import { Match, check } from 'meteor/check';
 import { Meteor } from 'meteor/meteor';
@@ -15,6 +15,7 @@ import { deleteMessageValidatingPermission } from '../../../lib/server/functions
 import { processWebhookMessage } from '../../../lib/server/functions/processWebhookMessage';
 import { executeSendMessage } from '../../../lib/server/methods/sendMessage';
 import { executeUpdateMessage } from '../../../lib/server/methods/updateMessage';
+import { OEmbed } from '../../../oembed/server/server';
 import { executeSetReaction } from '../../../reactions/server/setReaction';
 import { settings } from '../../../settings/server';
 import { normalizeMessagesForUser } from '../../../utils/server/lib/normalizeMessagesForUser';
@@ -822,3 +823,22 @@ API.v1.addRoute(
 		},
 	},
 );
+
+API.v1.addRoute(
+	'chat.getURLPreview',
+	{ authRequired: true, validateParams: isChatGetURLPreviewProps },
+	{
+		async get() {
+			const { roomId, url } = this.queryParams;
+
+			if (!(await canAccessRoomIdAsync(roomId, this.userId))) {
+				throw new Meteor.Error('error-not-allowed', 'Not allowed');
+			}
+
+			const { urlPreview } = await OEmbed.parseUrl(url);
+			urlPreview.ignoreParse = true;
+
+			return API.v1.success({ urlPreview });
+		},
+	},
+);

apps/meteor/app/livechat/imports/server/rest/departments.ts

@@ -117,23 +117,17 @@ API.v1.addRoute(
 			const { _id } = this.urlParams;
 			const { department, agents } = this.bodyParams;
 
-			let success;
-			if (permissionToSave) {
-				success = await LivechatEnterprise.saveDepartment(_id, department);
+			if (!permissionToSave) {
+				throw new Error('error-not-allowed');
 			}
 
-			if (success && agents && permissionToAddAgents) {
-				success = await LivechatTs.saveDepartmentAgents(_id, { upsert: agents });
-			}
+			const agentParam = permissionToAddAgents && agents ? { upsert: agents } : {};
+			await LivechatEnterprise.saveDepartment(_id, department, agentParam);
 
-			if (success) {
-				return API.v1.success({
-					department: await LivechatDepartment.findOneById(_id),
-					agents: await LivechatDepartmentAgents.findByDepartmentId(_id).toArray(),
-				});
-			}
-
-			return API.v1.failure();
+			return API.v1.success({
+				department: await LivechatDepartment.findOneById(_id),
+				agents: await LivechatDepartmentAgents.findByDepartmentId(_id).toArray(),
+			});
 		},
 		async delete() {
 			check(this.urlParams, {

apps/meteor/app/livechat/imports/server/rest/inquiries.ts

@@ -23,7 +23,7 @@ API.v1.addRoute(
 			const { department } = this.queryParams;
 			const ourQuery: { status: string; department?: string } = { status: 'queued' };
 			if (department) {
-				const departmentFromDB = await LivechatDepartment.findOneByIdOrName(department);
+				const departmentFromDB = await LivechatDepartment.findOneByIdOrName(department, { projection: { _id: 1 } });
 				if (departmentFromDB) {
 					ourQuery.department = departmentFromDB._id;
 				}

apps/meteor/app/livechat/server/business-hour/AbstractBusinessHour.ts

@@ -1,4 +1,4 @@
-import type { ILivechatAgentStatus, ILivechatBusinessHour, ILivechatDepartment } from '@rocket.chat/core-typings';
+import type { AtLeast, ILivechatAgentStatus, ILivechatBusinessHour, ILivechatDepartment } from '@rocket.chat/core-typings';
 import type { ILivechatBusinessHoursModel, IUsersModel } from '@rocket.chat/model-typings';
 import { LivechatBusinessHours, Users } from '@rocket.chat/models';
 import moment from 'moment-timezone';
@@ -14,8 +14,8 @@ export interface IBusinessHourBehavior {
 	onAddAgentToDepartment(options?: { departmentId: string; agentsId: string[] }): Promise<any>;
 	onRemoveAgentFromDepartment(options?: Record<string, any>): Promise<any>;
 	onRemoveDepartment(options: { department: ILivechatDepartment; agentsIds: string[] }): Promise<any>;
-	onDepartmentDisabled(department?: ILivechatDepartment): Promise<any>;
-	onDepartmentArchived(department: Pick<ILivechatDepartment, '_id'>): Promise<void>;
+	onDepartmentDisabled(department?: AtLeast<ILivechatDepartment, '_id' | 'businessHourId'>): Promise<void>;
+	onDepartmentArchived(department: Pick<ILivechatDepartment, '_id' | 'businessHourId'>): Promise<void>;
 	onStartBusinessHours(): Promise<void>;
 	afterSaveBusinessHours(businessHourData: ILivechatBusinessHour): Promise<void>;
 	allowAgentChangeServiceStatus(agentId: string): Promise<boolean>;

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

@@ -1,4 +1,4 @@
-import type { ILivechatDepartmentAgents } from '@rocket.chat/core-typings';
+import type { ILivechatDepartment, ILivechatDepartmentAgents } from '@rocket.chat/core-typings';
 import { Logger } from '@rocket.chat/logger';
 import { LivechatDepartment, LivechatDepartmentAgents, LivechatRooms } from '@rocket.chat/models';
 
@@ -10,7 +10,9 @@ class DepartmentHelperClass {
 	async removeDepartment(departmentId: string) {
 		this.logger.debug(`Removing department: ${departmentId}`);
 
-		const department = await LivechatDepartment.findOneById(departmentId);
+		const department = await LivechatDepartment.findOneById<Pick<ILivechatDepartment, '_id' | 'businessHourId'>>(departmentId, {
+			projection: { _id: 1, businessHourId: 1 },
+		});
 		if (!department) {
 			throw new Error('error-department-not-found');
 		}

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

@@ -648,13 +648,24 @@ export const updateDepartmentAgents = async (
 	departmentEnabled: boolean,
 ) => {
 	check(departmentId, String);
-	check(
-		agents,
-		Match.ObjectIncluding({
-			upsert: Match.Maybe(Array),
-			remove: Match.Maybe(Array),
-		}),
-	);
+	check(agents, {
+		upsert: Match.Maybe([
+			Match.ObjectIncluding({
+				agentId: String,
+				username: Match.Maybe(String),
+				count: Match.Maybe(Match.Integer),
+				order: Match.Maybe(Match.Integer),
+			}),
+		]),
+		remove: Match.Maybe([
+			Match.ObjectIncluding({
+				agentId: String,
+				username: Match.Maybe(String),
+				count: Match.Maybe(Match.Integer),
+				order: Match.Maybe(Match.Integer),
+			}),
+		]),
+	});
 
 	const { upsert = [], remove = [] } = agents;
 	const agentsRemoved = [];

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

@@ -475,7 +475,7 @@ class LivechatClass {
 			},
 		};
 
-		const dep = await LivechatDepartment.findOneById(department);
+		const dep = await LivechatDepartment.findOneById<Pick<ILivechatDepartment, '_id'>>(department, { projection: { _id: 1 } });
 		if (!dep) {
 			throw new Meteor.Error('invalid-department', 'Provided department does not exists');
 		}
@@ -987,7 +987,9 @@ class LivechatClass {
 	}
 
 	async archiveDepartment(_id: string) {
-		const department = await LivechatDepartment.findOneById(_id, { projection: { _id: 1 } });
+		const department = await LivechatDepartment.findOneById<Pick<ILivechatDepartment, '_id' | 'businessHourId'>>(_id, {
+			projection: { _id: 1, businessHourId: 1 },
+		});
 
 		if (!department) {
 			throw new Error('department-not-found');
@@ -1053,7 +1055,7 @@ class LivechatClass {
 		}
 
 		if (transferData.departmentId) {
-			const department = await LivechatDepartment.findOneById(transferData.departmentId, {
+			const department = await LivechatDepartment.findOneById<Pick<ILivechatDepartment, 'name' | '_id'>>(transferData.departmentId, {
 				projection: { name: 1 },
 			});
 			if (!department) {

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

@@ -65,7 +65,7 @@ Meteor.startup(async () => {
 	await createDefaultBusinessHourIfNotExists();
 
 	settings.watch<boolean>('Livechat_enable_business_hours', async (value) => {
-		logger.info(`Changing business hour type to ${value}`);
+		logger.debug(`Starting business hour manager ${value}`);
 		if (value) {
 			await businessHourManager.startManager();
 			return;

apps/meteor/app/oembed/server/server.ts

@@ -1,5 +1,12 @@
-import type { OEmbedUrlContentResult, OEmbedUrlWithMetadata, IMessage, MessageAttachment, OEmbedMeta } from '@rocket.chat/core-typings';
-import { isOEmbedUrlContentResult, isOEmbedUrlWithMetadata } from '@rocket.chat/core-typings';
+import type {
+	OEmbedUrlContentResult,
+	OEmbedUrlWithMetadata,
+	IMessage,
+	MessageAttachment,
+	OEmbedMeta,
+	MessageUrl,
+} from '@rocket.chat/core-typings';
+import { isOEmbedUrlWithMetadata } from '@rocket.chat/core-typings';
 import { Logger } from '@rocket.chat/logger';
 import { Messages, OEmbedCache } from '@rocket.chat/models';
 import { serverFetch as fetch } from '@rocket.chat/server-fetch';
@@ -128,6 +135,41 @@ const getUrlContent = async (urlObj: URL, redirectCount = 5): Promise<OEmbedUrlC
 	};
 };
 
+const parseUrl = async function (url: string): Promise<{ urlPreview: MessageUrl; foundMeta: boolean }> {
+	const parsedUrlObject: MessageUrl = { url, meta: {} };
+	let foundMeta = false;
+	if (!isURL(url)) {
+		return { urlPreview: parsedUrlObject, foundMeta };
+	}
+
+	const data = await getUrlMetaWithCache(url);
+	if (!data) {
+		return { urlPreview: parsedUrlObject, foundMeta };
+	}
+
+	if (isOEmbedUrlWithMetadata(data) && data.meta) {
+		parsedUrlObject.meta = getRelevantMetaTags(data.meta) || {};
+		if (parsedUrlObject.meta?.oembedHtml) {
+			parsedUrlObject.meta.oembedHtml = insertMaxWidthInOembedHtml(parsedUrlObject.meta.oembedHtml) || '';
+		}
+	}
+
+	foundMeta = true;
+	return {
+		urlPreview: {
+			...parsedUrlObject,
+			...((parsedUrlObject.headers || data.headers) && {
+				headers: {
+					...parsedUrlObject.headers,
+					...(data.headers?.contentLength && { contentLength: data.headers.contentLength }),
+					...(data.headers?.contentType && { contentType: data.headers.contentType }),
+				},
+			}),
+		},
+		foundMeta,
+	};
+};
+
 const getUrlMeta = async function (
 	url: string,
 	withFragment?: boolean,
@@ -151,10 +193,6 @@ const getUrlMeta = async function (
 		return;
 	}
 
-	if (content.attachments) {
-		return content;
-	}
-
 	log.debug('Parsing metadata for URL', url);
 	const metas: { [k: string]: string } = {};
 
@@ -273,37 +311,10 @@ const rocketUrlParser = async function (message: IMessage): Promise<IMessage> {
 			continue;
 		}
 
-		if (!isURL(item.url)) {
-			continue;
-		}
-
-		const data = await getUrlMetaWithCache(item.url);
-
-		if (!data) {
-			continue;
-		}
-
-		if (isOEmbedUrlContentResult(data) && data.attachments) {
-			attachments.push(...data.attachments);
-			break;
-		}
-
-		if (isOEmbedUrlWithMetadata(data) && data.meta) {
-			item.meta = getRelevantMetaTags(data.meta) || {};
-			if (item.meta?.oembedHtml) {
-				item.meta.oembedHtml = insertMaxWidthInOembedHtml(item.meta.oembedHtml) || '';
-			}
-		}
-
-		if (data.headers?.contentLength) {
-			item.headers = { ...item.headers, contentLength: data.headers.contentLength };
-		}
-
-		if (data.headers?.contentType) {
-			item.headers = { ...item.headers, contentType: data.headers.contentType };
-		}
+		const { urlPreview, foundMeta } = await parseUrl(item.url);
 
-		changed = true;
+		Object.assign(item, foundMeta ? urlPreview : {});
+		changed = changed || foundMeta;
 	}
 
 	if (attachments.length) {
@@ -321,10 +332,12 @@ const OEmbed: {
 	getUrlMeta: (url: string, withFragment?: boolean) => Promise<OEmbedUrlWithMetadata | undefined | OEmbedUrlContentResult>;
 	getUrlMetaWithCache: (url: string, withFragment?: boolean) => Promise<OEmbedUrlWithMetadata | OEmbedUrlContentResult | undefined>;
 	rocketUrlParser: (message: IMessage) => Promise<IMessage>;
+	parseUrl: (url: string) => Promise<{ urlPreview: MessageUrl; foundMeta: boolean }>;
 } = {
 	rocketUrlParser,
 	getUrlMetaWithCache,
 	getUrlMeta,
+	parseUrl,
 };
 
 settings.watch('API_Embed', (value) => {

apps/meteor/ee/app/livechat-enterprise/server/business-hour/Helper.ts

@@ -74,9 +74,9 @@ export const openBusinessHour = async (
 		totalAgents: agentIds.length,
 		top10AgentIds: agentIds.slice(0, 10),
 	});
-
 	await Users.addBusinessHourByAgentIds(agentIds, businessHour._id);
 	await Users.makeAgentsWithinBusinessHourAvailable(agentIds);
+
 	if (updateLivechatStatus) {
 		await Users.updateLivechatStatusBasedOnBusinessHours();
 	}