plum-e2e 2.6.8 → 2.7.1

package/backend/services/cronService.js

@@ -1,18 +1,6 @@
 /*
  * This file is part of Plum.
- *
- * Plum is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Plum is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Plum. If not, see https://www.gnu.org/licenses/.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
  */
 
 const cron = require('node-cron');
@@ -25,8 +13,13 @@ const runnerService = require('./runnerService');
 const reportService = require('./reportService');
 const settingsService = require('./settingsService');
 const notificationService = require('./notificationService');
+const activeRunsService = require('./activeRunsService');
 const { startSsPoller } = require('../lib/screenshotPoller');
-const { BUILT_IN_RUNNER_ID, TRIGGER_REMOTE } = require('../constants/triggers');
+const { BUILT_IN_RUNNER_ID, TRIGGER_REMOTE, TRIGGER_TYPE } = require('../constants/triggers');
+const { DEFAULT_BROWSER } = require('../constants/defaults');
+const { PLUM_MODE_NODE } = require('../constants/env');
+const { SOCKET_EVENTS } = require('../constants/socketEvents');
+const { JOB_STATUS } = require('../constants/jobStatus');
 const { getTestIdsForTag, chunkTests, buildTagExpression } = require('../lib/testChunker');
 const { readCucumberReportFile } = require('../lib/reportFilename');
 const { runWithRetries } = require('../lib/retryRunner');
@@ -85,12 +78,12 @@ function runSingleBuiltInAttempt({ taskName, currentTag, workers, browser, suppr
 			PLUM_SS_DIR: ssDir
 		};
 		if (workers > 1) env.PARALLEL = String(workers);
-		if (suppressSave) env.PLUM_MODE = 'node';
+		if (suppressSave) env.PLUM_MODE = PLUM_MODE_NODE;
 
 		const task = spawn('npm', ['run', 'test'], { env, shell: true });
 
 		const ssPoller = startSsPoller(ssDir, ({ stepName, data }) => {
-			if (_io) _io.emit('bg-run-screenshot', { runId: taskName, stepName, data });
+			if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_SCREENSHOT, { runId: taskName, stepName, data });
 		});
 
 		task.stdout.on('data', (d) => {
@@ -118,7 +111,7 @@ async function runSingleBuiltIn({ taskName, tags, workers, browser, notifyDiscor
 	const { maxRetries } = await settingsService.getProject();
 
 	const onLog = (text) => {
-		if (_io) _io.emit('bg-run-log', { runId: taskName, log: text });
+		if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_LOG, { runId: taskName, log: text });
 	};
 
 	if (maxRetries === 0) {
@@ -139,7 +132,13 @@ async function runSingleBuiltIn({ taskName, tags, workers, browser, notifyDiscor
 				select: { id: true, status: true, content: true }
 			})
 			.then((report) => {
-				if (_io) _io.emit('bg-run-done', { runId: taskName, code, reportId: report?.id ?? null });
+				activeRunsService.unregisterRun(taskName);
+				if (_io)
+					_io.emit(SOCKET_EVENTS.BG_RUN_DONE, {
+						runId: taskName,
+						code,
+						reportId: report?.id ?? null
+					});
 
 				if (report) {
 					prisma.report
@@ -162,7 +161,8 @@ async function runSingleBuiltIn({ taskName, tags, workers, browser, notifyDiscor
 			})
 			.catch((e) => {
 				console.error(`[cron] Notification failed: ${e.message}`);
-				if (_io) _io.emit('bg-run-done', { runId: taskName, code, reportId: null });
+				activeRunsService.unregisterRun(taskName);
+				if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_DONE, { runId: taskName, code, reportId: null });
 			});
 		return;
 	}
@@ -199,7 +199,9 @@ async function runSingleBuiltIn({ taskName, tags, workers, browser, notifyDiscor
 		console.error(`[cron] Failed to save report: ${e.message}`);
 	}
 
-	if (_io) _io.emit('bg-run-done', { runId: taskName, code, reportId: report?.id ?? null });
+	activeRunsService.unregisterRun(taskName);
+	if (_io)
+		_io.emit(SOCKET_EVENTS.BG_RUN_DONE, { runId: taskName, code, reportId: report?.id ?? null });
 
 	if (report && (notifyDiscord || notifySlack)) {
 		notificationService
@@ -241,14 +243,15 @@ async function runDistributed({
 
 	if (activeRunnerIds.length === 0) {
 		console.log(`Task "${taskName}" — no tests found, skipping.`);
-		if (_io) _io.emit('bg-run-done', { runId: taskName, code: 0, reportId: null });
+		activeRunsService.unregisterRun(taskName);
+		if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_DONE, { runId: taskName, code: 0, reportId: null });
 		return;
 	}
 
 	const laneInfos = await resolveLaneInfos(activeRunnerIds);
 
 	if (_io) {
-		_io.emit('bg-run-lanes-init', {
+		_io.emit(SOCKET_EVENTS.BG_RUN_LANES_INIT, {
 			runId: taskName,
 			lanes: laneInfos.map((l, i) => ({ id: l.id, name: l.name, testCount: chunks[i].length }))
 		});
@@ -265,10 +268,10 @@ async function runDistributed({
 		laneAttempts[idx] = attempts;
 		doneCount++;
 		if (_io) {
-			_io.emit('bg-run-lane-status', {
+			_io.emit(SOCKET_EVENTS.BG_RUN_LANE_STATUS, {
 				runId: taskName,
 				laneId,
-				status: code === 0 ? 'done' : 'error'
+				status: code === 0 ? JOB_STATUS.DONE : JOB_STATUS.ERROR
 			});
 		}
 
@@ -287,8 +290,9 @@ async function runDistributed({
 					attemptsByLane: laneAttempts
 				})
 				.then((saved) => {
+					activeRunsService.unregisterRun(taskName);
 					if (_io) {
-						_io.emit('bg-run-done', {
+						_io.emit(SOCKET_EVENTS.BG_RUN_DONE, {
 							runId: taskName,
 							code: overallCode,
 							reportId: saved?.id ?? null
@@ -309,7 +313,13 @@ async function runDistributed({
 				})
 				.catch((e) => {
 					console.error(`[cron] Failed to save combined report: ${e.message}`);
-					if (_io) _io.emit('bg-run-done', { runId: taskName, code: overallCode, reportId: null });
+					activeRunsService.unregisterRun(taskName);
+					if (_io)
+						_io.emit(SOCKET_EVENTS.BG_RUN_DONE, {
+							runId: taskName,
+							code: overallCode,
+							reportId: null
+						});
 				});
 		}
 	}
@@ -322,7 +332,7 @@ async function runDistributed({
 		if (lane.id === BUILT_IN_RUNNER_ID) {
 			const idx = i;
 			const onLog = (text) => {
-				if (_io) _io.emit('bg-run-lane-log', { runId: taskName, laneId, log: text });
+				if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_LANE_LOG, { runId: taskName, laneId, log: text });
 			};
 
 			const spawnBuiltInLaneAttempt = (currentTag) =>
@@ -335,7 +345,7 @@ async function runDistributed({
 						TAG: currentTag,
 						TRIGGER: TRIGGER_REMOTE, // node-mode: file naming only, not persisted to DB
 						BROWSER: browser,
-						PLUM_MODE: 'node',
+						PLUM_MODE: PLUM_MODE_NODE,
 						PLUM_SS_DIR: ssDir
 					};
 					if (workers > 1) env.PARALLEL = String(workers);
@@ -344,7 +354,12 @@ async function runDistributed({
 
 					const ssPoller = startSsPoller(ssDir, ({ stepName, data }) => {
 						if (_io)
-							_io.emit('bg-run-lane-screenshot', { runId: taskName, laneId, stepName, data });
+							_io.emit(SOCKET_EVENTS.BG_RUN_LANE_SCREENSHOT, {
+								runId: taskName,
+								laneId,
+								stepName,
+								data
+							});
 					});
 
 					task.stdout.on('data', (d) => {
@@ -374,7 +389,7 @@ async function runDistributed({
 			const idx = i;
 			const onLog = (log) => {
 				process.stdout.write(log);
-				if (_io) _io.emit('bg-run-lane-log', { runId: taskName, laneId, log });
+				if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_LANE_LOG, { runId: taskName, laneId, log });
 			};
 
 			const spawnRemoteLaneAttempt = (currentTag) =>
@@ -386,7 +401,12 @@ async function runDistributed({
 						(code, content) => resolve({ code, rawJson: content ? JSON.parse(content) : [] }),
 						({ stepName, data }) => {
 							if (_io)
-								_io.emit('bg-run-lane-screenshot', { runId: taskName, laneId, stepName, data });
+								_io.emit(SOCKET_EVENTS.BG_RUN_LANE_SCREENSHOT, {
+									runId: taskName,
+									laneId,
+									stepName,
+									data
+								});
 						}
 					);
 				});
@@ -418,13 +438,11 @@ async function runCronJob(job) {
 	} = job;
 	const runnerIds = parseRunnerIds(runnerIdsStr);
 
+	const label = taskName;
+	const meta = { tag: tags, browser, workers };
+	activeRunsService.registerRun(taskName, { kind: TRIGGER_TYPE.CRON, label, meta });
 	if (_io) {
-		_io.emit('bg-run-start', {
-			runId: taskName,
-			kind: 'cron',
-			label: taskName,
-			meta: { tag: tags, browser, workers }
-		});
+		_io.emit(SOCKET_EVENTS.BG_RUN_START, { runId: taskName, kind: TRIGGER_TYPE.CRON, label, meta });
 	}
 	console.log(`Running scheduled task: "${taskName}" → runners: ${runnerIds.join(', ')}`);
 
@@ -504,7 +522,7 @@ const addCronJob = async ({
 			cronExpression,
 			tags: tags ?? '',
 			workers: workers ?? 1,
-			browser: browser ?? 'chromium',
+			browser: browser ?? DEFAULT_BROWSER,
 			runnerIds: runnerIdsStr,
 			notifyDiscord: notifyDiscord ?? false,
 			notifySlack: notifySlack ?? false,
@@ -559,7 +577,7 @@ const updateCronJob = async (
 			cronExpression,
 			tags,
 			workers: workers ?? 1,
-			browser: browser ?? 'chromium',
+			browser: browser ?? DEFAULT_BROWSER,
 			runnerIds: runnerIdsStr,
 			notifyDiscord: notifyDiscord ?? false,
 			notifySlack: notifySlack ?? false,

package/backend/services/envService.js

@@ -1,18 +1,6 @@
 /*
  * This file is part of Plum.
- *
- * Plum is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Plum is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Plum. If not, see https://www.gnu.org/licenses/.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
  */
 
 const fs = require('fs');

package/backend/services/nodeExecutionService.js

@@ -0,0 +1,140 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const crypto = require('crypto');
+const { spawn } = require('child_process');
+const { startSsPoller } = require('../lib/screenshotPoller');
+const { TRIGGER_REMOTE } = require('../constants/triggers');
+const { DEFAULT_BROWSER } = require('../constants/defaults');
+const { JOB_STATUS } = require('../constants/jobStatus');
+
+const BACKEND_DIR = path.resolve(__dirname, '..');
+
+// In-memory job store for active remote executions.
+// Jobs are purged after 10 minutes post-completion.
+const jobs = {};
+
+function getJob(jobId) {
+	return jobs[jobId];
+}
+
+// Starts a remote test job dispatched from the primary server: materializes
+// any uploaded test files, spawns `npm run test`, and tracks logs/screenshots
+// for later HTTP polling (see pollJob).
+function startJob({
+	tags,
+	browser = DEFAULT_BROWSER,
+	workers = 1,
+	tests = null,
+	env: userEnv = {}
+}) {
+	const jobId = crypto.randomUUID();
+
+	// path.resolve ensures absolute even if TMPDIR env var is set to a relative path
+	const tmpdir = path.resolve(os.tmpdir());
+
+	// Write test files sent by the primary into a per-job temp dir
+	let tempTestsDir = null;
+	if (tests && Object.keys(tests).length > 0) {
+		tempTestsDir = path.join(tmpdir, `plum-job-${jobId}`);
+		for (const [rel, content] of Object.entries(tests)) {
+			const dest = path.join(tempTestsDir, rel);
+			fs.mkdirSync(path.dirname(dest), { recursive: true });
+			fs.writeFileSync(dest, Buffer.from(content, 'base64'));
+		}
+	}
+
+	// Each job writes to its own temp file so concurrent jobs on the same node
+	// cannot clobber each other's reports (shared cucumber_report.json race condition).
+	const reportFile = path.join(tmpdir, `plum-report-${jobId}.json`);
+	const ssDir = path.join(tmpdir, `plum-ss-${jobId}`);
+	fs.mkdirSync(ssDir, { recursive: true });
+
+	jobs[jobId] = {
+		status: JOB_STATUS.RUNNING,
+		logs: '',
+		exitCode: null,
+		startedAt: Date.now(),
+		meta: { tags: tags || '', browser, workers },
+		tempTestsDir,
+		reportFile,
+		ssDir,
+		pendingScreenshots: []
+	};
+
+	const env = {
+		...process.env,
+		// User/test vars (BASE_URL, IS_HEADLESS, custom secrets) forwarded from the
+		// primary's own .env — nodes are stateless runners and shouldn't need their
+		// own copy. Spread before the job-control vars below so a stray same-named
+		// var in the user's .env can never override how this job actually runs.
+		...userEnv,
+		TAG: tags || '',
+		TRIGGER: TRIGGER_REMOTE,
+		BROWSER: browser,
+		REPORT_RUNNERS: String(workers),
+		CUCUMBER_REPORT_FILE: reportFile,
+		PLUM_SS_DIR: ssDir,
+		...(tempTestsDir ? { TESTS_ROOT: tempTestsDir } : {})
+	};
+	if (workers > 1) env.PARALLEL = String(workers);
+
+	const ssPoller = startSsPoller(ssDir, (data) => {
+		jobs[jobId]?.pendingScreenshots.push(data);
+	});
+
+	const proc = spawn('npm', ['run', 'test'], { env, shell: true, cwd: BACKEND_DIR });
+	proc.stdout.on('data', (d) => {
+		jobs[jobId].logs += d.toString();
+	});
+	proc.stderr.on('data', (d) => {
+		jobs[jobId].logs += d.toString();
+	});
+	proc.on('close', (code) => {
+		clearInterval(ssPoller);
+		jobs[jobId].status = code === 0 ? JOB_STATUS.DONE : JOB_STATUS.ERROR;
+		jobs[jobId].exitCode = code;
+
+		try {
+			if (fs.existsSync(reportFile)) {
+				jobs[jobId].reportContent = fs.readFileSync(reportFile, 'utf8');
+			}
+		} catch {}
+
+		fs.rm(ssDir, { recursive: true, force: true }, () => {});
+
+		if (jobs[jobId].tempTestsDir) {
+			fs.rm(jobs[jobId].tempTestsDir, { recursive: true, force: true }, () => {});
+		}
+
+		setTimeout(() => {
+			try {
+				fs.unlinkSync(reportFile);
+			} catch {}
+			delete jobs[jobId];
+		}, 600_000);
+	});
+
+	return jobId;
+}
+
+// Drains and returns pending screenshots plus logs since `offset` — used by
+// the primary's HTTP polling loop (this node has no socket.io connection back).
+function pollJob(jobId, offset) {
+	const job = jobs[jobId];
+	if (!job) return null;
+	const screenshots = job.pendingScreenshots.splice(0);
+	return {
+		status: job.status,
+		logs: job.logs.slice(offset),
+		exitCode: job.exitCode,
+		screenshots
+	};
+}
+
+module.exports = { startJob, getJob, pollJob };

package/backend/services/notificationService.js

@@ -1,21 +1,11 @@
 /*
  * This file is part of Plum.
- *
- * Plum is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Plum is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Plum. If not, see https://www.gnu.org/licenses/.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
  */
 
 const settingsService = require('./settingsService');
+const { DEFAULT_BROWSER } = require('../constants/defaults');
+const { REPORT_STATUS } = require('../constants/jobStatus');
 
 function countScenarios(content) {
 	try {
@@ -38,7 +28,7 @@ function countScenarios(content) {
 }
 
 function buildDiscordPayload({ jobName, status, counts, browser, tags, reportUrl }) {
-	const isPass = status === 'PASS';
+	const isPass = status === REPORT_STATUS.PASS;
 	// Discord colour integers: green 3066993, red 15158332
 	const color = isPass ? 3066993 : 15158332;
 	const fields = [
@@ -48,7 +38,7 @@ function buildDiscordPayload({ jobName, status, counts, browser, tags, reportUrl
 			value: `${counts.passed} / ${counts.total} passed`,
 			inline: true
 		},
-		{ name: 'Browser', value: browser ?? 'chromium', inline: true },
+		{ name: 'Browser', value: browser ?? DEFAULT_BROWSER, inline: true },
 		{ name: 'Tags', value: tags || '(all tests)', inline: false }
 	];
 	if (reportUrl) {
@@ -61,7 +51,7 @@ function buildDiscordPayload({ jobName, status, counts, browser, tags, reportUrl
 }
 
 function buildSlackPayload({ jobName, status, counts, browser, tags, reportUrl }) {
-	const isPass = status === 'PASS';
+	const isPass = status === REPORT_STATUS.PASS;
 	const icon = isPass ? '✅' : '❌';
 	const blocks = [
 		{
@@ -74,7 +64,7 @@ function buildSlackPayload({ jobName, status, counts, browser, tags, reportUrl }
 		{
 			type: 'section',
 			fields: [
-				{ type: 'mrkdwn', text: `*Browser:*\n${browser ?? 'chromium'}` },
+				{ type: 'mrkdwn', text: `*Browser:*\n${browser ?? DEFAULT_BROWSER}` },
 				{ type: 'mrkdwn', text: `*Tags:*\n${tags || '(all tests)'}` }
 			]
 		}

package/backend/services/prisma.js

@@ -1,18 +1,6 @@
 /*
  * This file is part of Plum.
- *
- * Plum is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Plum is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Plum. If not, see https://www.gnu.org/licenses/.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
  */
 
 const { PrismaClient } = require('@prisma/client');

package/backend/services/reportService.js

@@ -1,18 +1,6 @@
 /*
  * This file is part of Plum.
- *
- * Plum is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Plum is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Plum. If not, see https://www.gnu.org/licenses/.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
  */
 
 const fs = require('fs');
@@ -20,6 +8,8 @@ const path = require('path');
 const crypto = require('crypto');
 const prisma = require('./prisma');
 const { isScheduledTrigger, normaliseTrigger } = require('../constants/triggers');
+const { DEFAULT_BROWSER } = require('../constants/defaults');
+const { REPORT_STATUS } = require('../constants/jobStatus');
 const { SCREENSHOTS_DIR } = require('../lib/reportFilename');
 
 // ---------------------------------------------------------------------------
@@ -287,7 +277,7 @@ function processCucumberJson(raw, attempts = {}) {
 	});
 
 	const hasFailures = features.some((f) => f.status === 'failed');
-	return { features, status: hasFailures ? 'FAIL' : 'PASS' };
+	return { features, status: hasFailures ? REPORT_STATUS.FAIL : REPORT_STATUS.PASS };
 }
 
 // ---------------------------------------------------------------------------
@@ -318,7 +308,7 @@ const getReports = async ({ page = 1, limit = 15 } = {}) => {
 			select: reportListSelect
 		}),
 		prisma.report.count(),
-		prisma.report.count({ where: { status: 'PASS' } }),
+		prisma.report.count({ where: { status: REPORT_STATUS.PASS } }),
 		prisma.report.findMany({
 			orderBy: { createdAt: 'desc' },
 			take: TREND_SIZE,
@@ -393,7 +383,7 @@ const saveReport = async ({
 }) => {
 	const normTrigger = normaliseTrigger(triggerType);
 	const { features, status: derivedStatus } = processCucumberJson(rawCucumberJson, attempts);
-	const status = forceFail ? 'FAIL' : derivedStatus;
+	const status = forceFail ? REPORT_STATUS.FAIL : derivedStatus;
 	const cronJobId = await resolveCronJobId(normTrigger);
 
 	const report = await prisma.report.create({
@@ -402,7 +392,7 @@ const saveReport = async ({
 			tags: (tags ?? '').replace(/^\(|\)$/g, '') || '@all-tests',
 			triggerType: normTrigger,
 			runners: nodeCount ?? 1,
-			browser: browser ?? 'chromium',
+			browser: browser ?? DEFAULT_BROWSER,
 			runnerName: runnerName ?? null,
 			runnerId: runnerId ?? null,
 			cronJobId,
@@ -494,6 +484,19 @@ const saveCombinedReport = async ({
 	});
 };
 
+// Finds the report a no-retry run just produced (the most recent one created
+// after the run started) and patches in its wall-clock duration.
+const attachDurationToLatestReport = async ({ afterTimestamp, duration }) => {
+	const report = await prisma.report.findFirst({
+		where: { createdAt: { gte: new Date(afterTimestamp) } },
+		orderBy: { createdAt: 'desc' },
+		select: { id: true, status: true }
+	});
+	if (!report) return null;
+	await prisma.report.update({ where: { id: report.id }, data: { duration } });
+	return report;
+};
+
 // ---------------------------------------------------------------------------
 // Delete operations
 // ---------------------------------------------------------------------------
@@ -539,6 +542,7 @@ module.exports = {
 	getReportDetail,
 	saveReport,
 	saveCombinedReport,
+	attachDurationToLatestReport,
 	syncAutomatedFromFeatures,
 	deleteReport,
 	deleteReports,