plum-e2e 2.6.9 → 2.8.0

package/README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/plum-e2e"><img src="https://img.shields.io/npm/v/plum-e2e?color=7c3aed&label=plum-e2e" alt="npm version" /></a>
-  <a href="https://github.com/silverlunah/plum/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-GPL--3.0-blue" alt="license" /></a>
+  <a href="https://github.com/silverlunah/plum/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="license" /></a>
   <a href="https://outline.silverlunah.com/collection/plum-XRoE2MURWj"><img src="https://img.shields.io/badge/docs-outline-7c3aed" alt="docs" /></a>
 </p>
 

package/backend/Dockerfile

@@ -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.
 #
 
 FROM mcr.microsoft.com/playwright:v1.50.0

package/backend/app.js

@@ -1,24 +1,13 @@
 /*
  * 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 path = require('path');
 const express = require('express');
 const cors = require('cors');
 const { SCREENSHOTS_DIR } = require('./lib/reportFilename');
+const { isNodeMode } = require('./constants/env');
 const app = express();
 
 app.use(cors({ origin: '*' }));
@@ -35,7 +24,7 @@ const nodeRoutes = require('./routes/node.routes');
 app.use('/api', nodeRoutes);
 
 // Primary-mode routes — skipped when running as a runner node (no DB available)
-if (process.env.PLUM_MODE !== 'node') {
+if (!isNodeMode()) {
 	app.use('/tests', require('./routes/tests.routes'));
 	app.use('/reports', require('./routes/reports.routes'));
 	app.use('/cron-jobs', require('./routes/cron.routes'));
@@ -48,6 +37,7 @@ if (process.env.PLUM_MODE !== 'node') {
 	app.use('/test-cases', require('./routes/test-cases.routes'));
 	app.use('/test-runs', require('./routes/test-runs.routes'));
 	app.use('/trigger', require('./routes/trigger.routes'));
+	app.use('/active-runs', require('./routes/active-runs.routes'));
 }
 
 // Global JSON error handler — Express's default sends HTML, which breaks JSON clients

package/backend/config/scripts/create-step.mjs

@@ -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.
  */
 
 import * as clack from '@clack/prompts';

package/backend/config/scripts/create-test.mjs

@@ -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.
  */
 
 import * as clack from '@clack/prompts';

package/backend/config/scripts/generate-report.js

@@ -1,23 +1,13 @@
 /*
  * 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');
 const path = require('path');
 const { normaliseTrigger } = require('../../constants/triggers');
+const { DEFAULT_BROWSER } = require('../../constants/defaults');
+const { isNodeMode } = require('../../constants/env');
 const { REPORTS_DIR } = require('../../lib/reportFilename');
 
 const jsonReportFile = path.join(REPORTS_DIR, 'cucumber_report.json');
@@ -30,7 +20,7 @@ if (!fs.existsSync(jsonReportFile)) {
 // Remote runner nodes (PLUM_MODE=node) have no DB access.
 // The primary server reads cucumber_report.json via readCucumberReportFile()
 // and saves the combined report after all lanes finish.
-if (process.env.PLUM_MODE === 'node') process.exit(0);
+if (isNodeMode()) process.exit(0);
 
 // `run-test` runs on the host without Docker/Postgres, so DATABASE_URL is
 // never set there — skip the DB save instead of letting Prisma's connection
@@ -56,7 +46,7 @@ if (!process.env.DATABASE_URL) {
 			tags: rawTag,
 			triggerType,
 			nodeCount,
-			browser: process.env.BROWSER || 'chromium',
+			browser: process.env.BROWSER || DEFAULT_BROWSER,
 			runnerName: process.env.RUNNER_NAME || null,
 			runnerId: process.env.RUNNER_ID || null,
 			testRunId: process.env.TEST_RUN_ID || null

package/backend/config/scripts/run-tests.js

@@ -1,31 +1,20 @@
 /*
  * 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 { execSync } = require('child_process');
+const { execSync, execFileSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 const pc = require('picocolors');
+const { DEFAULT_BROWSER } = require('../../constants/defaults');
 
 const parallelIdx = process.argv.indexOf('--parallel');
 const parallel =
 	process.env.PARALLEL || (parallelIdx !== -1 ? process.argv[parallelIdx + 1] : null);
 const runners = parallel || process.env.REPORT_RUNNERS || '1';
 const tag = process.env.TAG || process.argv.slice(2).find((a) => a.startsWith('@'));
-const browser = process.env.BROWSER || 'chromium';
+const browser = process.env.BROWSER || DEFAULT_BROWSER;
 
 const reportFile =
 	process.env.CUCUMBER_REPORT_FILE ||
@@ -132,7 +121,7 @@ try {
 	console.error(pc.red('✗') + ' Tests failed: ' + error.message);
 } finally {
 	try {
-		execSync('node config/scripts/generate-report.js', {
+		execFileSync(process.execPath, [path.resolve(__dirname, 'generate-report.js')], {
 			stdio: 'inherit',
 			env: { ...process.env, REPORT_RUNNERS: runners }
 		});

package/backend/constants/defaults.js

@@ -0,0 +1,8 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+const DEFAULT_BROWSER = 'chromium';
+
+module.exports = { DEFAULT_BROWSER };

package/backend/constants/env.js

@@ -0,0 +1,16 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+/** Value of PLUM_MODE when this process is a runner node, not the primary server. */
+const PLUM_MODE_NODE = 'node';
+
+/** Fallback port for the Express server when PORT is unset. */
+const DEFAULT_PORT = '3001';
+
+function isNodeMode() {
+	return process.env.PLUM_MODE === PLUM_MODE_NODE;
+}
+
+module.exports = { PLUM_MODE_NODE, DEFAULT_PORT, isNodeMode };

package/backend/constants/jobStatus.js

@@ -0,0 +1,21 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+/** In-flight state of a spawned test job (trigger/node-execution/cron job stores). */
+const JOB_STATUS = Object.freeze({
+	RUNNING: 'running',
+	DONE: 'done',
+	ERROR: 'error',
+	PENDING: 'pending',
+	CANCELLED: 'cancelled'
+});
+
+/** Final verdict stored on a Report row. */
+const REPORT_STATUS = Object.freeze({
+	PASS: 'PASS',
+	FAIL: 'FAIL'
+});
+
+module.exports = { JOB_STATUS, REPORT_STATUS };

package/backend/constants/socketEvents.js

@@ -0,0 +1,40 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+/**
+ * Socket.io event names shared between the backend and the frontend. There is
+ * no shared package between the two (CommonJS backend, ESM/Svelte frontend),
+ * so `frontend/src/lib/socketEvents.js` mirrors this file by hand — keep both
+ * in sync when adding or renaming an event.
+ */
+const SOCKET_EVENTS = Object.freeze({
+	// Interactive single-run (built-in runner, one browser tab watching)
+	RUN_TEST: 'run-test',
+	CANCEL_TEST: 'cancel-test',
+	LOG: 'log',
+	DONE: 'done',
+	STEP_SCREENSHOT: 'step-screenshot',
+
+	// Multi-lane distributed run (single interactive run, several runners)
+	RUNNER_LANES_INIT: 'runner-lanes-init',
+	RUNNER_LANE_LOG: 'runner-lane-log',
+	RUNNER_LANE_STATUS: 'runner-lane-status',
+	RUNNER_LANE_SCREENSHOT: 'runner-lane-screenshot',
+
+	// Background runs (cron / REST / MCP triggered, no single owning socket)
+	BG_RUN_START: 'bg-run-start',
+	BG_RUN_LOG: 'bg-run-log',
+	BG_RUN_DONE: 'bg-run-done',
+	BG_RUN_SCREENSHOT: 'bg-run-screenshot',
+	BG_RUN_LANES_INIT: 'bg-run-lanes-init',
+	BG_RUN_LANE_LOG: 'bg-run-lane-log',
+	BG_RUN_LANE_STATUS: 'bg-run-lane-status',
+	BG_RUN_LANE_SCREENSHOT: 'bg-run-lane-screenshot',
+
+	// Global notifications (any client, not tied to a specific run)
+	REPORT_READY: 'report-ready'
+});
+
+module.exports = { SOCKET_EVENTS };

package/backend/constants/triggers.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.
  */
 
 /**
@@ -25,7 +13,11 @@ const TRIGGER_TYPE = Object.freeze({
 	MANUAL: 'manual-trigger',
 	CLI: 'command-line-trigger',
 	MCP: 'mcp-trigger',
-	EXTERNAL: 'external-trigger'
+	EXTERNAL: 'external-trigger',
+	// Not a Report.triggerType value (cron jobs store their taskName there instead) —
+	// only used as the `kind` tag on bg-run-* live-broadcast events, alongside the
+	// other TRIGGER_TYPE values reused for that same field.
+	CRON: 'cron'
 });
 
 /**

package/backend/entrypoint.sh

@@ -1,18 +1,6 @@
 #!/bin/sh
 # 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.
 set -e
 
 echo "Running database migrations..."

package/backend/lib/authHeader.js

@@ -0,0 +1,16 @@
+/*
+ * This file is part of Plum.
+ * Licensed under the MIT License. See LICENSE file in the project root for details.
+ */
+
+const AUTH_SCHEME = Object.freeze({
+	BEARER: 'Bearer',
+	API_KEY: 'ApiKey'
+});
+
+/** Builds the Authorization header for an outbound request to a runner node. */
+function bearerHeader(token) {
+	return { Authorization: `${AUTH_SCHEME.BEARER} ${token}` };
+}
+
+module.exports = { AUTH_SCHEME, bearerHeader };

package/backend/lib/globalRegistry.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.
  */
 
 /**

package/backend/lib/nodeRegister.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.
  */
 
 /**
@@ -70,9 +58,17 @@ function saveNodeConfig(dir, cfg) {
  */
 async function registerWithPrimary({ primary, name, url, token, browser }) {
 	const base = primary.replace(/\/$/, '');
+	// The /runners routes require an authenticated admin session, which this
+	// headless flow has no browser/JWT to provide — PLUM_NODE_KEY is the shared
+	// secret that stands in for one (see backend/middleware/jwtAuth.js).
+	const nodeKey = process.env.PLUM_NODE_KEY;
+	const authHeaders = nodeKey ? { Authorization: `ApiKey ${nodeKey}` } : {};
 
 	let existing = null;
-	const listRes = await fetch(`${base}/runners`, { signal: AbortSignal.timeout(10000) });
+	const listRes = await fetch(`${base}/runners`, {
+		headers: authHeaders,
+		signal: AbortSignal.timeout(10000)
+	});
 	if (!listRes.ok) throw new Error(`primary returned HTTP ${listRes.status} listing runners`);
 	const { runners = [] } = await listRes.json();
 	existing = runners.find((r) => r.name === name && r.url === url) ?? null;
@@ -80,7 +76,7 @@ async function registerWithPrimary({ primary, name, url, token, browser }) {
 
 	const res = await fetch(`${base}/runners`, {
 		method: 'POST',
-		headers: { 'Content-Type': 'application/json' },
+		headers: { 'Content-Type': 'application/json', ...authHeaders },
 		body: JSON.stringify({ name, url, token, browser }),
 		signal: AbortSignal.timeout(10000)
 	});

package/backend/lib/reportFilename.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 path = require('path');

package/backend/lib/retryRunner.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 reportService = require('../services/reportService');

package/backend/lib/runnerProcess.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.
  */
 
 /**
@@ -30,6 +18,7 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 const { spawn, execSync } = require('child_process');
+const { PLUM_MODE_NODE, DEFAULT_PORT } = require('../constants/env');
 
 const BACKEND_DIR = path.resolve(__dirname, '..');
 const SERVER_PATH = path.join(BACKEND_DIR, 'server.js');
@@ -121,9 +110,9 @@ function isLocalUrl(url) {
 
 function parsePort(url) {
 	try {
-		return new URL(url).port || '3001';
+		return new URL(url).port || DEFAULT_PORT;
 	} catch {
-		return '3001';
+		return DEFAULT_PORT;
 	}
 }
 
@@ -226,7 +215,7 @@ function startNode({ id, port, token }) {
 		env: {
 			...process.env,
 			NODE_TOKEN: token,
-			PLUM_MODE: 'node',
+			PLUM_MODE: PLUM_MODE_NODE,
 			PORT: String(port),
 			RUNNER_ID: String(id)
 		},

package/backend/lib/screenshotPoller.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');