SED-4789 Implement live reporting in the Node.js agent

step-node/step-node-agent/.gitignore

@@ -4,3 +4,4 @@ node_modules/
 filemanager/work/
 /coverage/
 /npm-project-workspaces/
+/agent-fork-libs/

step-node/step-node-agent/api/controllers/agent-fork.js

@@ -18,6 +18,7 @@
  */
 
 const { OutputBuilder } = require("./output");
+const { createLiveReporting } = require("./live-reporting");
 const Session = require("./session");
 const fs = require("fs");
 const path = require('path')
@@ -34,7 +35,11 @@ process.on('message', async ({ type, projectPath, functionName, input, propertie
     pendingUncaughtException = null;
     console.log("[Agent fork] Calling keyword " + functionName)
     const outputBuilder = new OutputBuilder();
+    let liveReporting;
     try {
+      // Initialize inside the try so any initialization error is reported via outputBuilder.fail
+      // (in the catch below) rather than escaping the message handler.
+      liveReporting = createLiveReporting(properties);
       if (!keywordDirectoryExists(projectPath, keywordDirectory)) {
         outputBuilder.fail("The keyword directory '" + keywordDirectory + "' doesn't exist in " + path.basename(projectPath) + ". Possible cause: If using TypeScript, the keywords may not have been compiled. Fix: Ensure your project is built before deploying to Step or during 'npm install'.")
       } else {
@@ -52,7 +57,7 @@ process.on('message', async ({ type, projectPath, functionName, input, propertie
             if(beforeKeyword) {
               await beforeKeyword(functionName);
             }
-            await keyword(input, outputBuilder, session, properties);
+            await keyword(input, outputBuilder, session, properties, liveReporting);
           } catch (e) {
             console.log("[Agent fork] Keyword execution failed with following error", e)
             const onError = module['onError'];
@@ -82,6 +87,15 @@ process.on('message', async ({ type, projectPath, functionName, input, propertie
       // Flush the event loop so unhandledRejection / uncaughtException from the keyword
       // (e.g. fire-and-forget promises, nextTick throws) land before we send the result.
       await new Promise(resolve => setImmediate(resolve));
+      // Close live reporting: flushes any buffered measures and waits for in-flight uploads.
+      // Guarded because initialization above may have failed before liveReporting was assigned.
+      try {
+        if (liveReporting) {
+          await liveReporting.close();
+        }
+      } catch (e) {
+        console.log("[Agent fork] Error while closing live reporting", e);
+      }
       // Surface inter-keyword errors first, labelled clearly as coming from a previous keyword.
       if (prevUnhandledRejection) {
         const sep = outputBuilder.hasError() ? '\n' : '';

step-node/step-node-agent/api/controllers/agent.js

@@ -7,6 +7,16 @@ const logger = require('../logger').child({ component: 'Agent' });
 
 const npmCommand = process.platform === 'win32' ? 'npm.cmd' : 'npm';
 
+// Resolve the bundled `ws` module path once, so it can be injected into forked keyword processes
+// (whose own require() resolves against the keyword project, not the agent). Used by live reporting
+// for streaming file uploads. If ws is missing, file uploads degrade to discarding.
+let wsModulePath = null;
+try {
+  wsModulePath = require.resolve('ws');
+} catch {
+  logger.warn('The ws module could not be resolved; live reporting file uploads will be disabled');
+}
+
 process.on('unhandledRejection', error => {
   logger.error('Critical: an unhandled error (unhandled promise rejection) occurred and might not have been reported:', error)
 })
@@ -349,9 +359,16 @@ class ForkedAgent {
     fs.copyFileSync(path.resolve(__dirname, 'agent-fork.js'), path.join(agentForkerLibPath, 'agent-fork.js'));
     fs.copyFileSync(path.join(__dirname, 'output.js'), path.join(agentForkerLibPath, 'output.js'));
     fs.copyFileSync(path.join(__dirname, 'session.js'), path.join(agentForkerLibPath, 'session.js'));
+    // The live-reporting code is split across a folder of modules; copy the whole directory so adding
+    // new modules never requires updating this list.
+    fs.cpSync(path.join(__dirname, 'live-reporting'), path.join(agentForkerLibPath, 'live-reporting'), { recursive: true });
     this.agentForkerLibPath = agentForkerLibPath;
     this.startupChunks = [];
-    this.forkProcess = fork(path.join(agentForkerLibPath, 'agent-fork.js'), [], {cwd: keywordProjectPath, silent: true});
+    const forkEnv = { ...process.env };
+    if (wsModulePath) {
+      forkEnv.STEP_AGENT_WS_MODULE = wsModulePath;
+    }
+    this.forkProcess = fork(path.join(agentForkerLibPath, 'agent-fork.js'), [], {cwd: keywordProjectPath, silent: true, env: forkEnv});
     // Capture stdout/stderr immediately so startup crashes are not silently lost
     if (this.forkProcess.stdout) {
       this.forkProcess.stdout.on('data', (data) => this.startupChunks.push(data));