plum-e2e 2.8.6 → 2.9.1

package/backend/services/triggerService.js

@@ -8,8 +8,8 @@ const fs = require('fs');
 const os = require('os');
 const { spawn } = require('child_process');
 const { randomUUID } = require('crypto');
-const { startSsPoller } = require('../lib/screenshotPoller');
-const { TRIGGER_TYPE } = require('../constants/triggers');
+const { startRRwebPoller } = require('../lib/rrwebPoller');
+const { TRIGGER_TYPE, BUILT_IN_RUNNER_ID } = require('../constants/triggers');
 const { DEFAULT_BROWSER } = require('../constants/defaults');
 const { PLUM_MODE_NODE } = require('../constants/env');
 const { SOCKET_EVENTS } = require('../constants/socketEvents');
@@ -52,7 +52,7 @@ function runAttempt({
 	baseUrl,
 	suppressSave,
 	onLog,
-	onScreenshot
+	onRRwebBatch
 }) {
 	return new Promise((resolve) => {
 		const ssDir = path.join(os.tmpdir(), `plum-trigger-ss-${jobId}-${Date.now()}`);
@@ -73,7 +73,7 @@ function runAttempt({
 
 		const proc = spawn('npm', ['run', 'test'], { env, shell: true, cwd: BACKEND_DIR });
 
-		const ssPoller = startSsPoller(ssDir, onScreenshot);
+		const ssPoller = startRRwebPoller(ssDir, onRRwebBatch);
 
 		proc.stdout.on('data', (d) => onLog(d.toString()));
 		proc.stderr.on('data', (d) => onLog(`[ERROR] ${d.toString()}`));
@@ -96,7 +96,7 @@ function runNoRetry({
 	baseUrl,
 	startedAt,
 	onLog,
-	onScreenshot
+	onRRwebBatch
 }) {
 	runAttempt({
 		jobId,
@@ -108,7 +108,7 @@ function runNoRetry({
 		baseUrl,
 		suppressSave: false,
 		onLog,
-		onScreenshot
+		onRRwebBatch
 	}).then(async ({ code }) => {
 		let reportId = null;
 		try {
@@ -142,7 +142,7 @@ function runWithRetriesAndSave({
 	maxRetries,
 	startedAt,
 	onLog,
-	onScreenshot
+	onRRwebBatch
 }) {
 	runWithRetries({
 		maxRetries,
@@ -157,7 +157,7 @@ function runWithRetriesAndSave({
 				baseUrl,
 				suppressSave: true,
 				onLog,
-				onScreenshot
+				onRRwebBatch
 			});
 			return { code, rawJson: raw ? JSON.parse(raw) : [] };
 		},
@@ -169,6 +169,7 @@ function runWithRetriesAndSave({
 				rawCucumberJson: rawJson,
 				tags: tag,
 				triggerType: trigger,
+				workerCount: workers,
 				browser,
 				testRunId: testRunId ?? null,
 				duration: Date.now() - startedAt,
@@ -191,8 +192,8 @@ function runWithRetriesAndSave({
 
 // Starts a background test run for the HTTP trigger API and returns the jobId
 // immediately — the run continues asynchronously, reporting progress via
-// socket.io events (bg-run-start/log/screenshot/done) and the job store
-// (polled through getJob).
+// socket.io events (bg-run-start/log/done) and the job store (polled through
+// getJob).
 async function startRun({
 	tag = '',
 	browser = DEFAULT_BROWSER,
@@ -218,8 +219,14 @@ async function startRun({
 	const onLog = (text) => {
 		if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_LOG, { runId: jobId, log: text });
 	};
-	const onScreenshot = ({ stepName, data }) => {
-		if (_io) _io.emit(SOCKET_EVENTS.BG_RUN_SCREENSHOT, { runId: jobId, stepName, data });
+	const onRRwebBatch = (batch) => {
+		if (_io) {
+			_io.emit(SOCKET_EVENTS.BG_RUN_LANE_RRWEB_BATCH, {
+				runId: jobId,
+				id: BUILT_IN_RUNNER_ID,
+				...batch
+			});
+		}
 	};
 
 	const runParams = {
@@ -232,7 +239,7 @@ async function startRun({
 		baseUrl,
 		startedAt,
 		onLog,
-		onScreenshot
+		onRRwebBatch
 	};
 	if (maxRetries === 0) {
 		runNoRetry(runParams);

package/backend/websockets/nodeSocketHandler.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.
+ */
+
+const runnerService = require('../services/runnerService');
+const nodeStreamRegistry = require('../services/nodeStreamRegistry');
+
+// A separate namespace from the browser-facing default one — a node connects
+// with its own runner token (the same credential it already uses to call back
+// into the primary's HTTP control routes, see runnerService.isValidToken) and
+// announces the jobId it's streaming for, which nodeStreamRegistry maps back
+// to whichever dispatch call is waiting on it.
+function nodeSocketHandler(io) {
+	const nodeIo = io.of('/node-stream');
+
+	nodeIo.use(async (socket, next) => {
+		const token = socket.handshake.auth?.token;
+		if (await runnerService.isValidToken(token)) return next();
+		next(new Error('unauthorized'));
+	});
+
+	nodeIo.on('connection', (socket) => {
+		let jobId = null;
+
+		socket.on('join', (id) => {
+			jobId = id;
+		});
+
+		socket.on('rrweb-batch', (batch) => {
+			if (jobId) nodeStreamRegistry.getRelay(jobId)?.onRRwebBatch?.(batch);
+		});
+
+		socket.on('log', (text) => {
+			if (jobId) nodeStreamRegistry.getRelay(jobId)?.onLog?.(text);
+		});
+	});
+}
+
+module.exports = nodeSocketHandler;

package/backend/websockets/socketHandler.js

@@ -13,7 +13,7 @@ const reportService = require('../services/reportService');
 const settingsService = require('../services/settingsService');
 const notificationService = require('../services/notificationService');
 const activeRunsService = require('../services/activeRunsService');
-const { startSsPoller } = require('../lib/screenshotPoller');
+const { startRRwebPoller } = require('../lib/rrwebPoller');
 const { runWithRetries } = require('../lib/retryRunner');
 const { TRIGGER_TYPE, BUILT_IN_RUNNER_ID, TRIGGER_REMOTE } = require('../constants/triggers');
 const { DEFAULT_BROWSER } = require('../constants/defaults');
@@ -243,8 +243,8 @@ function runBuiltInAttempt({
 		const proc = spawn('npm', ['run', 'test'], { env, shell: true });
 		activeProcs.add(proc);
 
-		const ssPoller = startSsPoller(ssDir, ({ stepName, data }) => {
-			socket.emit(SOCKET_EVENTS.STEP_SCREENSHOT, { stepName, data });
+		const ssPoller = startRRwebPoller(ssDir, (batch) => {
+			socket.emit(SOCKET_EVENTS.RUNNER_LANE_RRWEB_BATCH, { id: BUILT_IN_RUNNER_ID, ...batch });
 		});
 
 		proc.stdout.on('data', (d) => onLog(d.toString()));
@@ -362,6 +362,7 @@ async function runBuiltIn(
 		rawCucumberJson: rawJson,
 		tags: tag,
 		triggerType: TRIGGER_TYPE.MANUAL,
+		workerCount: workers,
 		browser,
 		testRunId: testRunId ?? null,
 		logs: logBuffer || null,
@@ -468,6 +469,7 @@ async function runDistributed(
 				.saveCombinedReport({
 					reports: collectedReports,
 					runners: laneInfos,
+					workers,
 					overallCode,
 					tag,
 					triggerType: TRIGGER_TYPE.MANUAL,
@@ -543,8 +545,8 @@ async function runDistributed(
 					const proc = spawn('npm', ['run', 'test'], { env, shell: true });
 					activeProcs.add(proc);
 
-					const ssPoller = startSsPoller(ssDir, ({ stepName, data }) => {
-						socket.emit(SOCKET_EVENTS.RUNNER_LANE_SCREENSHOT, { id: laneId, stepName, data });
+					const ssPoller = startRRwebPoller(ssDir, (batch) => {
+						socket.emit(SOCKET_EVENTS.RUNNER_LANE_RRWEB_BATCH, { id: laneId, ...batch });
 					});
 
 					proc.stdout.on('data', (d) => onLog(d.toString()));
@@ -588,8 +590,8 @@ async function runDistributed(
 								makeSyntheticFailReport(lane.name, chunkIds, 'could not fetch report from runner');
 							resolve({ code, rawJson: JSON.parse(raw) });
 						},
-						({ stepName, data }) => {
-							socket.emit(SOCKET_EVENTS.RUNNER_LANE_SCREENSHOT, { id: laneId, stepName, data });
+						(batch) => {
+							socket.emit(SOCKET_EVENTS.RUNNER_LANE_RRWEB_BATCH, { id: laneId, ...batch });
 						}
 					);
 				});

package/bin/plum.js

@@ -62,6 +62,48 @@ function scaffoldPluginsFile() {
 	clack.log.success('plum.plugins.json created.');
 }
 
+// Files under tests/ that are Plum's own wiring rather than customer content —
+// `plum init` only writes these once, so a project scaffolded before a Plum
+// upgrade keeps running whatever version shipped at init time (e.g. an old
+// screenshot-based browser.ts after Plum has moved to rrweb recording) unless
+// something explicitly re-syncs them. Never touches customer-owned files
+// (features/, pages/, step_definitions/, utils/constants.ts, utils/utils.ts).
+const INFRA_SCAFFOLD_FILES = ['utils/browser.ts', 'utils/hooks.ts'];
+
+// Re-syncs INFRA_SCAFFOLD_FILES from the installed Plum version's scaffold
+// into an existing tests/ directory, backing up anything it overwrites so a
+// customer's own edits to these files (unsupported, but possible) aren't
+// silently lost.
+function syncScaffoldInfraFiles(testsDir) {
+	if (!fs.existsSync(testsDir)) {
+		clack.log.warn(`No \`tests/\` folder found at ${testsDir} — skipping scaffold sync.`);
+		return;
+	}
+
+	let updated = 0;
+	for (const relPath of INFRA_SCAFFOLD_FILES) {
+		const src = path.join(scaffoldTestsPath, relPath);
+		const dest = path.join(testsDir, relPath);
+		if (!fs.existsSync(src) || !fs.existsSync(dest)) continue;
+
+		const current = fs.readFileSync(dest, 'utf8');
+		const latest = fs.readFileSync(src, 'utf8');
+		if (current === latest) continue;
+
+		const backupPath = `${dest}.bak-${Date.now()}`;
+		fs.copyFileSync(dest, backupPath);
+		fs.copyFileSync(src, dest);
+		updated++;
+		clack.log.success(
+			`Updated ${relPath} (previous version backed up to ${path.basename(backupPath)})`
+		);
+	}
+
+	if (updated === 0) {
+		clack.log.info('Test scaffold wiring is already up to date.');
+	}
+}
+
 // Install user plugins listed in plum.plugins.json into the backend
 function installPlugins() {
 	const pluginsPath = path.join(process.cwd(), 'plum.plugins.json');
@@ -511,6 +553,9 @@ async function serverUpdate() {
 	// logic no matter how new the just-installed files on disk actually are.
 	for (const dir of getInstalls('server')) {
 		if (!fs.existsSync(path.join(dir, '.plum-server.json'))) continue;
+		if (fs.existsSync(path.join(dir, 'tests'))) {
+			syncScaffoldInfraFiles(path.join(dir, 'tests'));
+		}
 		clack.log.step(`Rebuilding server at ${dir}…`);
 		try {
 			execSync('plum server restart', { stdio: 'inherit', cwd: dir });
@@ -523,6 +568,9 @@ async function serverUpdate() {
 	for (const dir of getInstalls('node')) {
 		const nodeCfg = loadNodeConfig(dir);
 		if (!nodeCfg.id) continue;
+		if (fs.existsSync(path.join(dir, 'tests'))) {
+			syncScaffoldInfraFiles(path.join(dir, 'tests'));
+		}
 		// Always attempt the restart rather than gating on the local PID
 		// registry: that registry goes stale (manager restarts, pre-existing
 		// installs from before this tracking existed, etc.), and skipping the
@@ -1093,6 +1141,12 @@ switch (command) {
 		await serverUpdate();
 		break;
 
+	case 'sync-scaffold':
+		clack.intro(pc.bgMagenta(pc.white('  🟣 Plum — Sync Test Scaffold  ')));
+		syncScaffoldInfraFiles(userTestsPath);
+		clack.outro(pc.green('Done.'));
+		break;
+
 	case 'run-test': {
 		const runHelpArgs = process.argv.slice(3);
 		if (anyFlags(runHelpArgs, ['--help', '-h'])) {
@@ -1299,7 +1353,10 @@ switch (command) {
 		console.log('  server stop          Stop the server (data preserved)');
 		console.log('  server reconfig      Re-enter server settings without starting');
 		console.log(
-			'  update               Update Plum and restart whichever is running (server/node)'
+			'  update               Update Plum, restart whichever is running (server/node), and re-sync tests/ wiring'
+		);
+		console.log(
+			'  sync-scaffold        Re-sync browser.ts/hooks.ts in tests/ from the installed Plum version'
 		);
 		console.log('  node start           Start a runner node (interactive), then open runner menu');
 		console.log('    --primary <url>    Primary Plum server to auto-register with');

package/frontend/.svelte-kit/ambient.d.ts

@@ -58,41 +58,42 @@ declare module '$env/static/private' {
 	export const VIKUNJA_API_KEY: string;
 	export const USER: string;
 	export const COMMAND_MODE: string;
-	export const npm_config_globalconfig: string;
 	export const OUTLINE_BASE_URL: string;
+	export const npm_config_globalconfig: string;
 	export const CLAUDE_CODE_SSE_PORT: string;
 	export const SSH_AUTH_SOCK: string;
 	export const VSCODE_PROFILE_INITIALIZED: string;
 	export const __CF_USER_TEXT_ENCODING: string;
 	export const npm_execpath: string;
 	export const PATH: string;
-	export const npm_package_json: string;
+	export const npm_package_bin_plum: string;
 	export const npm_config_engine_strict: string;
 	export const _: string;
-	export const npm_config_userconfig: string;
-	export const npm_config_init_module: string;
+	export const npm_package_json: string;
 	export const USER_ZDOTDIR: string;
 	export const __CFBundleIdentifier: string;
-	export const npm_command: string;
+	export const npm_config_init_module: string;
+	export const npm_config_userconfig: string;
 	export const PWD: string;
-	export const npm_lifecycle_event: string;
-	export const EDITOR: string;
+	export const npm_command: string;
 	export const OUTLINE_API_KEY: string;
-	export const npm_package_name: string;
+	export const EDITOR: string;
+	export const npm_lifecycle_event: string;
 	export const LANG: string;
-	export const npm_config_npm_version: string;
+	export const npm_package_name: string;
 	export const VSCODE_GIT_ASKPASS_EXTRA_ARGS: string;
 	export const XPC_FLAGS: string;
+	export const npm_config_npm_version: string;
 	export const npm_config_node_gyp: string;
-	export const npm_package_version: string;
 	export const XPC_SERVICE_NAME: string;
+	export const npm_package_version: string;
 	export const VSCODE_INJECTION: string;
 	export const SHLVL: string;
 	export const HOME: string;
 	export const VSCODE_GIT_ASKPASS_MAIN: string;
 	export const CLAUDE_CODE_EXECPATH: string;
-	export const npm_config_cache: string;
 	export const LOGNAME: string;
+	export const npm_config_cache: string;
 	export const npm_lifecycle_script: string;
 	export const VSCODE_GIT_IPC_HANDLE: string;
 	export const COREPACK_ENABLE_AUTO_PIN: string;
@@ -103,10 +104,9 @@ declare module '$env/static/private' {
 	export const OSLogRateLimit: string;
 	export const CLAUDECODE: string;
 	export const CLAUDE_CODE_MESSAGING_SOCKET: string;
-	export const npm_node_execpath: string;
-	export const npm_config_prefix: string;
 	export const COLORTERM: string;
-	export const NODE_ENV: string;
+	export const npm_config_prefix: string;
+	export const npm_node_execpath: string;
 }
 
 /**
@@ -165,41 +165,42 @@ declare module '$env/dynamic/private' {
 		VIKUNJA_API_KEY: string;
 		USER: string;
 		COMMAND_MODE: string;
-		npm_config_globalconfig: string;
 		OUTLINE_BASE_URL: string;
+		npm_config_globalconfig: string;
 		CLAUDE_CODE_SSE_PORT: string;
 		SSH_AUTH_SOCK: string;
 		VSCODE_PROFILE_INITIALIZED: string;
 		__CF_USER_TEXT_ENCODING: string;
 		npm_execpath: string;
 		PATH: string;
-		npm_package_json: string;
+		npm_package_bin_plum: string;
 		npm_config_engine_strict: string;
 		_: string;
-		npm_config_userconfig: string;
-		npm_config_init_module: string;
+		npm_package_json: string;
 		USER_ZDOTDIR: string;
 		__CFBundleIdentifier: string;
-		npm_command: string;
+		npm_config_init_module: string;
+		npm_config_userconfig: string;
 		PWD: string;
-		npm_lifecycle_event: string;
-		EDITOR: string;
+		npm_command: string;
 		OUTLINE_API_KEY: string;
-		npm_package_name: string;
+		EDITOR: string;
+		npm_lifecycle_event: string;
 		LANG: string;
-		npm_config_npm_version: string;
+		npm_package_name: string;
 		VSCODE_GIT_ASKPASS_EXTRA_ARGS: string;
 		XPC_FLAGS: string;
+		npm_config_npm_version: string;
 		npm_config_node_gyp: string;
-		npm_package_version: string;
 		XPC_SERVICE_NAME: string;
+		npm_package_version: string;
 		VSCODE_INJECTION: string;
 		SHLVL: string;
 		HOME: string;
 		VSCODE_GIT_ASKPASS_MAIN: string;
 		CLAUDE_CODE_EXECPATH: string;
-		npm_config_cache: string;
 		LOGNAME: string;
+		npm_config_cache: string;
 		npm_lifecycle_script: string;
 		VSCODE_GIT_IPC_HANDLE: string;
 		COREPACK_ENABLE_AUTO_PIN: string;
@@ -210,10 +211,9 @@ declare module '$env/dynamic/private' {
 		OSLogRateLimit: string;
 		CLAUDECODE: string;
 		CLAUDE_CODE_MESSAGING_SOCKET: string;
-		npm_node_execpath: string;
-		npm_config_prefix: string;
 		COLORTERM: string;
-		NODE_ENV: string;
+		npm_config_prefix: string;
+		npm_node_execpath: string;
 		[key: `PUBLIC_${string}`]: undefined;
 		[key: `${string}`]: string | undefined;
 	}

package/frontend/.svelte-kit/generated/server/internal.js

@@ -26,7 +26,7 @@ export const options = {
 		app: ({ head, body, assets, nonce, env }) => "<!--\nThis file is part of Plum.\nLicensed under the MIT License. See LICENSE file in the project root for details.\n-->\n<!doctype html>\n<html lang=\"en\" data-theme=\"light\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<link rel=\"icon\" href=\"" + assets + "/favicon.ico\" />\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n\t\t<link rel=\"preconnect\" href=\"https://fonts.googleapis.com\" />\n\t\t<link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin />\n\t\t<link\n\t\t\thref=\"https://fonts.googleapis.com/css2?family=Playfair+Display:wght@400;500&family=DM+Sans:wght@300;400;500&display=swap\"\n\t\t\trel=\"stylesheet\"\n\t\t/>\n\t\t<!-- Prevent theme flash before Svelte hydrates -->\n\t\t<script>\n\t\t\ttry {\n\t\t\t\tconst t = localStorage.getItem('plum-theme');\n\t\t\t\tif (t) document.documentElement.setAttribute('data-theme', t);\n\t\t\t} catch (e) {}\n\t\t</script>\n\t\t" + head + "\n\t</head>\n\t<body data-sveltekit-preload-data=\"hover\">\n\t\t<div style=\"display: contents\">" + body + "</div>\n\t</body>\n</html>\n",
 		error: ({ status, message }) => "<!doctype html>\n<html lang=\"en\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<title>" + message + "</title>\n\n\t\t<style>\n\t\t\tbody {\n\t\t\t\t--bg: white;\n\t\t\t\t--fg: #222;\n\t\t\t\t--divider: #ccc;\n\t\t\t\tbackground: var(--bg);\n\t\t\t\tcolor: var(--fg);\n\t\t\t\tfont-family:\n\t\t\t\t\tsystem-ui,\n\t\t\t\t\t-apple-system,\n\t\t\t\t\tBlinkMacSystemFont,\n\t\t\t\t\t'Segoe UI',\n\t\t\t\t\tRoboto,\n\t\t\t\t\tOxygen,\n\t\t\t\t\tUbuntu,\n\t\t\t\t\tCantarell,\n\t\t\t\t\t'Open Sans',\n\t\t\t\t\t'Helvetica Neue',\n\t\t\t\t\tsans-serif;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tjustify-content: center;\n\t\t\t\theight: 100vh;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t.error {\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tmax-width: 32rem;\n\t\t\t\tmargin: 0 1rem;\n\t\t\t}\n\n\t\t\t.status {\n\t\t\t\tfont-weight: 200;\n\t\t\t\tfont-size: 3rem;\n\t\t\t\tline-height: 1;\n\t\t\t\tposition: relative;\n\t\t\t\ttop: -0.05rem;\n\t\t\t}\n\n\t\t\t.message {\n\t\t\t\tborder-left: 1px solid var(--divider);\n\t\t\t\tpadding: 0 0 0 1rem;\n\t\t\t\tmargin: 0 0 0 1rem;\n\t\t\t\tmin-height: 2.5rem;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t}\n\n\t\t\t.message h1 {\n\t\t\t\tfont-weight: 400;\n\t\t\t\tfont-size: 1em;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t@media (prefers-color-scheme: dark) {\n\t\t\t\tbody {\n\t\t\t\t\t--bg: #222;\n\t\t\t\t\t--fg: #ddd;\n\t\t\t\t\t--divider: #666;\n\t\t\t\t}\n\t\t\t}\n\t\t</style>\n\t</head>\n\t<body>\n\t\t<div class=\"error\">\n\t\t\t<span class=\"status\">" + status + "</span>\n\t\t\t<div class=\"message\">\n\t\t\t\t<h1>" + message + "</h1>\n\t\t\t</div>\n\t\t</div>\n\t</body>\n</html>\n"
 	},
-	version_hash: "1cz1h1z"
+	version_hash: "19o4i41"
 };
 
 export async function get_hooks() {