start-command 0.37.7 → 0.37.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # start-command
 
+## 0.37.8
+
+### Patch Changes
+
+- 9ffcae7: A closed stdout/stderr pipe (`$ -- cmd | head -1`) no longer crashes start with an unhandled `EPIPE` and exit code 1: the command keeps running, its log and record are written, and start exits with the command's own exit code (#222).
+
 ## 0.37.7
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "start-command",
-  "version": "0.37.7",
+  "version": "0.37.8",
   "description": "Gamification of coding, execute any command with ability to auto-report issues on GitHub",
   "main": "src/bin/cli.js",
   "exports": {

package/src/bin/cli.js

@@ -42,6 +42,17 @@ const { resolveChildExitCode } = require('../lib/exit-reason');
 const { printUsage } = require('../lib/usage');
 const { buildDisplayCommand, getCommandName } = require('../lib/shell-utils');
 
+// A closed stdout/stderr pipe (`$ --version | head -1`) must neither crash
+// start nor replace the command's exit code: drop the failed output and keep
+// running, logging and recording as usual (issue #222).
+for (const stream of [process.stdout, process.stderr]) {
+  stream.on('error', (err) => {
+    if (err.code !== 'EPIPE' && err.code !== 'ERR_STREAM_DESTROYED') {
+      throw err;
+    }
+  });
+}
+
 // Configuration from environment variables
 const config = {
   // Disable automatic issue creation (useful for testing)

package/test/regression-222.js

@@ -0,0 +1,61 @@
+const { describe, it, expect } = require('bun:test');
+const { spawn } = require('child_process');
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const CLI = path.join(__dirname, '../src/bin/cli.js');
+
+// Run the CLI with the read ends of the given output pipes closed before it
+// starts writing, like `$ --version | head -1` once `head` has exited.
+function runWithClosedPipes(args, closed) {
+  return new Promise((resolve) => {
+    const child = spawn(process.execPath, [CLI, ...args], {
+      stdio: ['ignore', 'pipe', 'pipe'],
+      env: {
+        ...process.env,
+        START_APP_FOLDER: fs.mkdtempSync(path.join(os.tmpdir(), 'start-222-')),
+        START_DISABLE_AUTO_ISSUE: '1',
+        START_DISABLE_LOG_UPLOAD: '1',
+      },
+    });
+    let stderr = '';
+    for (const name of ['stdout', 'stderr']) {
+      if (closed.includes(name)) {
+        child[name].destroy();
+      } else {
+        child[name].on('data', (chunk) => (stderr += chunk));
+      }
+    }
+    child.on('close', (code) => resolve({ code, stderr }));
+  });
+}
+
+describe('closed output pipes (#222)', () => {
+  if (process.platform === 'win32') {
+    return;
+  }
+  const big = 'seq 1 200000';
+  for (const args of [['--version'], ['-v'], ['--help']]) {
+    it(`${args[0]} exits 0 when stdout is closed`, async () => {
+      const result = await runWithClosedPipes(args, ['stdout']);
+      expect(result.stderr).not.toContain('EPIPE');
+      expect(result.code).toBe(0);
+    }, 15000);
+  }
+  it('a command keeps its exit code when stdout is closed', async () => {
+    const result = await runWithClosedPipes(
+      ['--', 'sh', '-c', `${big}; exit 3`],
+      ['stdout']
+    );
+    expect(result.stderr).not.toContain('EPIPE');
+    expect(result.code).toBe(3);
+  }, 15000);
+  it('a command keeps its exit code when stdout and stderr are closed', async () => {
+    const result = await runWithClosedPipes(
+      ['--', 'sh', '-c', `${big}; ${big} >&2; exit 3`],
+      ['stdout', 'stderr']
+    );
+    expect(result.code).toBe(3);
+  }, 15000);
+});