added support for custom headers for oembed providers

Signed-off-by: Abhinav Kumar <[email protected]>
RocketChat · Dec 11, 2024 · c057863 · c057863
1 parent e16f595
commit c057863
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 3 deletions.
diff --git a/apps/meteor/app/oembed/server/providers.ts b/apps/meteor/app/oembed/server/providers.ts
@@ -3,6 +3,8 @@ import { camelCase } from 'change-case';
 
 import { callbacks } from '../../../lib/callbacks';
 import { SystemLogger } from '../../../server/lib/logger/system';
+import { settings } from '../../settings/server';
+import { Info } from '../../utils/rocketchat.info';
 
 class Providers {
 	private providers: OEmbedProvider[];
@@ -11,13 +13,20 @@ class Providers {
 		this.providers = [];
 	}
 
-	static getConsumerUrl(provider: OEmbedProvider, url: string): string {
+	static getConsumerUrl(provider: OEmbedProvider, url: string): string | undefined {
+		if (!provider.endPoint) {
+			return;
+		}
 		const urlObj = new URL(provider.endPoint);
 		urlObj.searchParams.set('url', url);
 
 		return urlObj.toString();
 	}
 
+	static getCustomHeaders(provider: OEmbedProvider): { [k: string]: string } {
+		return provider.getHeaderOverrides?.() || {};
+	}
+
 	registerProvider(provider: OEmbedProvider): number {
 		return this.providers.push(provider);
 	}
@@ -73,6 +82,15 @@ providers.registerProvider({
 	endPoint: 'https://www.dailymotion.com/services/oembed?maxheight=200',
 });
 
+providers.registerProvider({
+	urls: [new RegExp('https?://(twitter|x)\\.com/[^/]+/status/\\S+')],
+	getHeaderOverrides: () => {
+		return {
+			'User-Agent': `${settings.get('API_Embed_UserAgent')} Rocket.Chat/${Info.version} Googlebot/2.1`,
+		};
+	},
+});
+
 providers.registerProvider({
 	urls: [new RegExp('https?://(play|open)\\.spotify\\.com/(track|album|playlist|show)/\\S+')],
 	endPoint: 'https://open.spotify.com/oembed',
@@ -99,7 +117,12 @@ callbacks.add(
 
 		const consumerUrl = Providers.getConsumerUrl(provider, url);
 
-		return { ...data, urlObj: new URL(consumerUrl) };
+		const headerOverrides = Providers.getCustomHeaders(provider);
+		if (!consumerUrl) {
+			return { ...data, headerOverrides };
+		}
+
+		return { ...data, headerOverrides, urlObj: new URL(consumerUrl) };
 	},
 	callbacks.priority.MEDIUM,
 	'oembed-providers-before',

diff --git a/apps/meteor/app/oembed/server/server.ts b/apps/meteor/app/oembed/server/server.ts
@@ -107,6 +107,7 @@ const getUrlContent = async (urlObj: URL, redirectCount = 5): Promise<OEmbedUrlC
 			headers: {
 				'User-Agent': `${settings.get('API_Embed_UserAgent')} Rocket.Chat/${Info.version}`,
 				'Accept-Language': settings.get('Language') || 'en',
+				...data.headerOverrides,
 			},
 			size: sizeLimit, // max size of the response body, this was not working as expected so I'm also manually verifying that on the iterator
 		},

diff --git a/apps/meteor/lib/callbacks.ts b/apps/meteor/lib/callbacks.ts
@@ -183,6 +183,7 @@ type ChainedCallbackSignatures = {
 	'renderMessage': <T extends IMessage & { html: string }>(message: T) => T;
 	'oembed:beforeGetUrlContent': (data: { urlObj: URL }) => {
 		urlObj: URL;
+		headerOverrides?: { [k: string]: string };
 	};
 	'oembed:afterParseContent': (data: { url: string; meta: OEmbedMeta; headers: { [k: string]: string }; content: OEmbedUrlContent }) => {
 		url: string;

diff --git a/packages/core-typings/src/IOembed.ts b/packages/core-typings/src/IOembed.ts
@@ -16,7 +16,8 @@ export type OEmbedUrlContent = {
 
 export type OEmbedProvider = {
 	urls: RegExp[];
-	endPoint: string;
+	endPoint?: string;
+	getHeaderOverrides?: () => { [k: string]: string };
 };
 
 export type OEmbedUrlContentResult = {