snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/reporters/jira.ts

@@ -0,0 +1,268 @@
+import type { Reporter, TestCase, TestResult } from '@playwright/test/reporter';
+import fetch from 'node-fetch';
+
+const LOG = '[JIRA reporter]';
+
+const escapeJqlTextSearch = (value: string): string => value.replace(/\\/g, '\\\\').replace(/'/g, "\\'").replace(/"/g, '\\"');
+
+export const createJiraSearchParams = (summary: string) =>
+	new URLSearchParams({
+		jql: `project = FLAKY AND summary ~ '"${escapeJqlTextSearch(summary)}"'`,
+		fields: 'summary',
+	});
+
+/** Jira REST API v3 expects `description` as Atlassian Document Format, not a plain string. */
+const EMPTY_ADF_DESCRIPTION = {
+	type: 'doc',
+	version: 1,
+	content: [] as const,
+};
+
+type JiraCommentDetails = {
+	run: number;
+	author: string;
+	pr: number;
+	testUrl: string;
+	runUrl: string;
+};
+
+export const createJiraCommentBody = ({ run, author, pr, testUrl, runUrl }: JiraCommentDetails) => ({
+	type: 'doc',
+	version: 1,
+	content: [
+		{
+			type: 'paragraph',
+			content: [{ type: 'text', text: `Test run ${run} failed` }],
+		},
+		{
+			type: 'paragraph',
+			content: [{ type: 'text', text: `author: ${author}` }],
+		},
+		{
+			type: 'paragraph',
+			content: [{ type: 'text', text: `PR: ${pr}` }],
+		},
+		{
+			type: 'paragraph',
+			content: [{ type: 'text', text: testUrl, marks: [{ type: 'link', attrs: { href: testUrl } }] }],
+		},
+		{
+			type: 'paragraph',
+			content: [{ type: 'text', text: runUrl, marks: [{ type: 'link', attrs: { href: runUrl } }] }],
+		},
+	],
+});
+
+class JIRAReporter implements Reporter {
+	private url: string;
+
+	private apiKey: string;
+
+	private branch: string;
+
+	private draft: boolean;
+
+	private run: number;
+
+	private headSha: string;
+
+	private author: string;
+
+	private run_url: string;
+
+	private pr: number;
+
+	constructor(options: {
+		url: string;
+		apiKey: string;
+		branch: string;
+		draft: boolean;
+		run: number;
+		headSha: string;
+		author: string;
+		run_url: string;
+		pr: number;
+	}) {
+		this.url = options.url;
+		this.apiKey = options.apiKey;
+		this.branch = options.branch;
+		this.draft = options.draft;
+		this.run = options.run;
+		this.headSha = options.headSha;
+		this.author = options.author;
+		this.run_url = options.run_url;
+		this.pr = options.pr;
+	}
+
+	private static async ensureJiraOk(response: Awaited<ReturnType<typeof fetch>>, context: string): Promise<void> {
+		if (response.ok) {
+			return;
+		}
+		const text = await response.text();
+		const preview = text.length > 800 ? `${text.slice(0, 800)}...` : text;
+		throw new Error(`${LOG} ${context}: HTTP ${response.status} ${response.statusText}. Body: ${preview}`);
+	}
+
+	private async postComment(issue: string, test: TestCase, payload: { run: number; headSha: string }): Promise<void> {
+		const { location } = test;
+		const testUrl = `https://github.com/RocketChat/Rocket.Chat/blob/${payload.headSha}${location.file.replace(
+			'/home/runner/work/Rocket.Chat/Rocket.Chat',
+			'',
+		)}#L${location.line}`;
+
+		const commentRes = await fetch(`${this.url}/rest/api/3/issue/${issue}/comment`, {
+			method: 'POST',
+			body: JSON.stringify({
+				body: createJiraCommentBody({
+					run: payload.run,
+					author: this.author,
+					pr: this.pr,
+					testUrl,
+					runUrl: this.run_url,
+				}),
+			}),
+			headers: {
+				'Content-Type': 'application/json',
+				'Authorization': `Basic ${this.apiKey}`,
+			},
+		});
+		await JIRAReporter.ensureJiraOk(commentRes, `comment on ${issue}`);
+	}
+
+	async onTestEnd(test: TestCase, result: TestResult) {
+		try {
+			await this._onTestEnd(test, result);
+		} catch (error) {
+			console.error(`${LOG} Error sending test result to JIRA`, error);
+		}
+	}
+
+	private async _onTestEnd(test: TestCase, result: TestResult) {
+		if (process.env.REPORTER_ROCKETCHAT_REPORT !== 'true') {
+			return;
+		}
+
+		if (this.draft === true) {
+			return;
+		}
+
+		if (result.status === 'passed' || result.status === 'skipped') {
+			return;
+		}
+
+		if (test.expectedStatus === 'failed') {
+			return;
+		}
+
+		const payload = {
+			name: test.title,
+			status: result.status,
+			duration: result.duration,
+			branch: this.branch,
+			draft: this.draft,
+			run: this.run,
+			headSha: this.headSha,
+		};
+
+		console.log(`${LOG} preparing notification for flaky/unexpected failure: ${JSON.stringify(payload)}`);
+
+		// first search and check if there is an existing issue
+		const search = await fetch(`${this.url}/rest/api/3/search/jql?${createJiraSearchParams(payload.name)}`, {
+			method: 'GET',
+			headers: {
+				'Content-Type': 'application/json',
+				'Authorization': `Basic ${this.apiKey}`,
+			},
+		});
+
+		await JIRAReporter.ensureJiraOk(search, 'search for existing issue');
+
+		const { issues } = JSON.parse(await search.text()) as {
+			issues: { key: string; fields: { summary: string } }[];
+		};
+
+		console.log(`${LOG} JQL search returned ${issues.length} candidate issue(s) (exact summary match is applied next).`);
+
+		const existing = issues.find((issue) => issue.fields.summary === payload.name);
+
+		if (existing) {
+			console.log(`${LOG} exact summary match on ${existing.key}; no new issue will be created (comment / label only).`);
+
+			if (this.pr === 0) {
+				const labelRes = await fetch(`${this.url}/rest/api/3/issue/${existing.key}`, {
+					method: 'PUT',
+					body: JSON.stringify({
+						update: {
+							labels: [
+								{
+									add: 'flaky_Develop',
+								},
+							],
+						},
+					}),
+					headers: {
+						'Content-Type': 'application/json',
+						'Authorization': `Basic ${this.apiKey}`,
+					},
+				});
+				await JIRAReporter.ensureJiraOk(labelRes, `add label flaky_Develop on ${existing.key}`);
+				console.log(`${LOG} label update OK for ${existing.key}`);
+			}
+
+			await this.postComment(existing.key, test, payload);
+			console.log(`${LOG} comment posted on ${existing.key} for run ${payload.run}.`);
+			return;
+		}
+
+		console.log(`${LOG} no issue with identical summary; creating new FLAKY issue.`);
+
+		const data: {
+			fields: {
+				summary: string;
+				description: typeof EMPTY_ADF_DESCRIPTION;
+				issuetype: {
+					name: string;
+				};
+				project: {
+					key: string;
+				};
+			};
+		} = {
+			fields: {
+				summary: payload.name,
+				description: EMPTY_ADF_DESCRIPTION,
+				issuetype: {
+					name: 'Tech Debt',
+				},
+				project: {
+					key: 'FLAKY',
+				},
+				...(this.pr === 0 && { labels: ['flaky_Develop'] }),
+			},
+		};
+
+		const responseIssue = await fetch(`${this.url}/rest/api/3/issue`, {
+			method: 'POST',
+			body: JSON.stringify(data),
+			headers: {
+				'Content-Type': 'application/json',
+				'Authorization': `Basic ${this.apiKey}`,
+			},
+		});
+
+		await JIRAReporter.ensureJiraOk(responseIssue, 'create issue');
+
+		const created = JSON.parse(await responseIssue.text()) as { key?: string };
+		const issue = created.key;
+		if (!issue) {
+			throw new Error(`${LOG} create issue response had no key: ${JSON.stringify(created)}`);
+		}
+
+		console.log(`${LOG} created issue ${issue}.`);
+
+		await this.postComment(issue, test, payload);
+		console.log(`${LOG} comment posted on ${issue}; done for run ${payload.run}.`);
+	}
+}
+
+export default JIRAReporter;

apps/meteor/reporters/rocketchat.ts

@@ -0,0 +1,59 @@
+import type { Reporter, TestCase, TestResult } from '@playwright/test/reporter';
+import fetch from 'node-fetch';
+
+class RocketChatReporter implements Reporter {
+	private url: string;
+
+	private apiKey: string;
+
+	private branch: string;
+
+	private draft: boolean;
+
+	private run: number;
+
+	constructor(options: { url: string; apiKey: string; branch: string; draft: boolean; run: number }) {
+		this.url = options.url;
+		this.apiKey = options.apiKey;
+		this.branch = options.branch;
+		this.draft = options.draft;
+		this.run = options.run;
+	}
+
+	async onTestEnd(test: TestCase, result: TestResult) {
+		if (process.env.REPORTER_ROCKETCHAT_REPORT !== 'true') {
+			console.log('REPORTER_ROCKETCHAT_REPORT is not true, skipping', {
+				draft: this.draft,
+				branch: this.branch,
+			});
+			return;
+		}
+		const payload = {
+			name: test.title,
+			status: result.status,
+			duration: result.duration,
+			branch: this.branch,
+			draft: this.draft,
+			run: this.run,
+		};
+
+		try {
+			const res = await fetch(this.url, {
+				method: 'POST',
+				body: JSON.stringify(payload),
+				headers: {
+					'Content-Type': 'application/json',
+					'X-Api-Key': this.apiKey,
+				},
+			});
+
+			if (!res.ok) {
+				console.error('Error sending test result to Rocket.Chat', JSON.stringify(payload), res);
+			}
+		} catch (error) {
+			console.error('Unknown error while sending test result to Rocket.Chat', JSON.stringify(payload), error);
+		}
+	}
+}
+
+export default RocketChatReporter;