start-command 0.39.0 → 0.39.2

package/src/lib/screen-isolation.js

@@ -100,6 +100,28 @@ function supportsLogfileOption() {
   return version.patch >= 1;
 }
 
+/**
+ * Polls without the session in `screen -ls` and without an exit code before
+ * the session counts as gone. `screen -dmS` can return before the session is
+ * listed, so a missing session alone is no proof that the command finished;
+ * its exit code is written just before the session ends.
+ */
+const SCREEN_UNLISTED_GRACE_POLLS = 20;
+
+/**
+ * Whether an attached screen run is over.
+ * @param {boolean} listed - The session is in `screen -ls`
+ * @param {boolean} exitCodeReady - The exit-code sidecar has content (or no
+ *   sidecar is expected, as for a bare shell)
+ * @param {number} unlistedPolls - Consecutive polls without the session
+ * @returns {boolean}
+ */
+function isScreenRunFinished(listed, exitCodeReady, unlistedPolls) {
+  return (
+    !listed && (exitCodeReady || unlistedPolls >= SCREEN_UNLISTED_GRACE_POLLS)
+  );
+}
+
 /**
  * Run command in GNU Screen using detached mode with log capture.
  *
@@ -346,58 +368,64 @@ function runScreenWithLogCapture(
       const checkInterval = 100; // ms
       const maxWait = 300000; // 5 minutes max
       let waited = 0;
+      let unlistedPolls = 0;
+
+      const exitCodeReady = () => {
+        if (isBareShell) {
+          return true;
+        }
+        try {
+          return fs.readFileSync(exitCodeFile, 'utf8').trim() !== '';
+        } catch {
+          return false;
+        }
+      };
+
+      const finish = () => {
+        readAndDisplayOutput().then((output) => {
+          const exitCode = readExitCode();
+          cleanupTempFiles();
+          resolve({
+            success: exitCode === 0,
+            sessionName,
+            message: `Screen session "${sessionName}" exited with code ${exitCode}`,
+            exitCode,
+            output,
+          });
+        });
+      };
 
       const checkCompletion = () => {
+        let listed;
         try {
           // Check if session still exists
-          const sessions = execSync('screen -ls', {
+          listed = execSync('screen -ls', {
             encoding: 'utf8',
             stdio: ['pipe', 'pipe', 'pipe'],
-          });
-
-          if (!sessions.includes(sessionName)) {
-            // Session ended, read output and exit code
-            readAndDisplayOutput().then((output) => {
-              const exitCode = readExitCode();
-              cleanupTempFiles();
-              resolve({
-                success: exitCode === 0,
-                sessionName,
-                message: `Screen session "${sessionName}" exited with code ${exitCode}`,
-                exitCode,
-                output,
-              });
-            });
-            return;
-          }
-
-          waited += checkInterval;
-          if (waited >= maxWait) {
-            cleanupTempFiles();
-            resolve({
-              success: false,
-              sessionName,
-              message: `Screen session "${sessionName}" timed out after ${maxWait / 1000} seconds`,
-              exitCode: 1,
-            });
-            return;
-          }
-
-          setTimeout(checkCompletion, checkInterval);
+          }).includes(sessionName);
         } catch {
           // screen -ls failed, session probably ended
-          readAndDisplayOutput().then((output) => {
-            const exitCode = readExitCode();
-            cleanupTempFiles();
-            resolve({
-              success: exitCode === 0,
-              sessionName,
-              message: `Screen session "${sessionName}" exited with code ${exitCode}`,
-              exitCode,
-              output,
-            });
+          listed = false;
+        }
+        unlistedPolls = listed ? 0 : unlistedPolls + 1;
+        if (isScreenRunFinished(listed, exitCodeReady(), unlistedPolls)) {
+          finish();
+          return;
+        }
+
+        waited += checkInterval;
+        if (waited >= maxWait) {
+          cleanupTempFiles();
+          resolve({
+            success: false,
+            sessionName,
+            message: `Screen session "${sessionName}" timed out after ${maxWait / 1000} seconds`,
+            exitCode: 1,
           });
+          return;
         }
+
+        setTimeout(checkCompletion, checkInterval);
       };
 
       // Start checking after a brief delay
@@ -522,7 +550,9 @@ function resetScreenVersionCache() {
 }
 
 module.exports = {
+  SCREEN_UNLISTED_GRACE_POLLS,
   getScreenVersion,
+  isScreenRunFinished,
   supportsLogfileOption,
   runScreenWithLogCapture,
   startDetachedScreenWithLogCapture,

package/test/isolation.js

@@ -812,3 +812,35 @@ describe('isInteractiveShellCommand (issue #84)', () => {
     assert.strictEqual(isInteractiveShellCommand('  '), false);
   });
 });
+
+describe('isScreenRunFinished', () => {
+  // `screen -dmS` can return before `screen -ls` lists the session; a failed
+  // command then read as exit 0 (Rust CI run 39873000384).
+  const {
+    SCREEN_UNLISTED_GRACE_POLLS,
+    isScreenRunFinished,
+  } = require('../src/lib/screen-isolation');
+
+  it('waits while the session is listed', () => {
+    assert.strictEqual(isScreenRunFinished(true, true, 0), false);
+  });
+
+  it('finishes once the session is gone and its exit code is written', () => {
+    assert.strictEqual(isScreenRunFinished(false, true, 1), true);
+  });
+
+  it('keeps polling an unlisted session without an exit code', () => {
+    assert.strictEqual(isScreenRunFinished(false, false, 1), false);
+    assert.strictEqual(
+      isScreenRunFinished(false, false, SCREEN_UNLISTED_GRACE_POLLS - 1),
+      false
+    );
+  });
+
+  it('gives up after the grace polls', () => {
+    assert.strictEqual(
+      isScreenRunFinished(false, false, SCREEN_UNLISTED_GRACE_POLLS),
+      true
+    );
+  });
+});