fix(import): guard interactive TUI with requireTTY() so non-TTY exits 1 cleanly (#982) by aidandaly24 · Pull Request #1170 · aws/agentcore-cli

aidandaly24 · 2026-05-07T19:35:17Z

Description

Fix issue #982: non-TTY invocations of TUI-based commands could crash with the Ink "Raw mode is not supported on the current process.stdin" error and silently exit with code 0, hiding the failure from CI/CD pipelines and scripted usage.

Root cause

The requireTTY() guard in src/cli/tui/guards/tty.ts already exists and is applied in deploy, create, dev, add, remove, and invoke. However, the import command's interactive TUI branch (agentcore import with no --source and no subcommand) called render(<ImportFlow>) without first calling requireTTY(). Verified reproducer:

echo "" | agentcore import      # before: Ink raw-mode error, exit 0
echo "" | agentcore import      # after:  exit 1, "requires an interactive terminal"

Changes

src/cli/commands/import/command.ts — Add requireTTY() (called before requireProject(), so the non-TTY exit path never goes through any Ink render) in the no-source branch. Hoisted to a static barrel import (import { requireProject, requireTTY } from '../../tui/guards') for consistency with the other TUI commands.
src/cli/tui/guards/__tests__/tty.test.ts (new) — Unit tests locking in the exit-1 + clear-message contract for requireTTY() across the four TTY combinations.
src/cli/commands/import/__tests__/command.test.ts (new) — Integration test running agentcore import via runCLI (non-TTY stdin/stdout) asserting exit 1 with the interactive-terminal message and no Ink raw-mode text. Also pins guard placement: import --source <bogus> must take the source-file-validation path, not the TTY guard.
src/cli/commands/deploy/__tests__/deploy-non-tty.test.ts (new) — Regression test for the command named in the bug title: agentcore deploy (no flags) and agentcore deploy --diff in non-TTY exit 1 cleanly without surfacing the Ink raw-mode error.

Out of scope

deploy, create, dev, add, remove, invoke already have requireTTY() (since PR fix: add TTY detection before TUI fallbacks to prevent agent/CI hangs #949) — verified working under the reproducer; no behavior change beyond adding the missing test coverage above.
Non-interactive render(<Text>) usages in status, fetch, package, traces, config-bundle don't use Ink raw mode and don't trigger the bug.
The global uncaughtException handler in src/cli/index.ts already exits 1; no change needed.

Related Issue

Closes #982

Documentation PR

N/A — bug fix, no user-facing surface area changes.

Type of Change

Testing

How have you tested the change?

I ran npm run test:unit and npm run test:integ (targeted: 8/8 tests across tty.test.ts, import/__tests__/command.test.ts, deploy/__tests__/deploy-non-tty.test.ts pass; full unit suite green in CI)
I ran npm run typecheck
I ran npm run lint
If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots (N/A — no asset changes)

Manual verification of the reproducer:

$ echo "" | agentcore import        # exit 1, "requires an interactive terminal"
$ echo "" | agentcore deploy        # exit 1, "requires an interactive terminal"
$ agentcore deploy < /dev/null      # exit 1, "requires an interactive terminal"
$ agentcore import --source bogus.yaml   # exit 1, "Source file not found" (guard correctly NOT applied)

Checklist

I have read the CONTRIBUTING document
I have added any necessary tests that prove my fix is effective or my feature works
I have updated the documentation accordingly (no docs changes needed for this guard fix)
I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
My changes generate no new warnings
Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

agentcore-cli-automation

Reviewed the diff end-to-end against the codebase. This is a small, focused fix that addresses the stated bug:

The requireTTY() call is added in exactly the right place — the no---source / no-subcommand branch of agentcore import, which is the only branch that calls render(<ImportFlow>). ImportFlow includes ArnInputScreen which uses TextInput, so Ink's raw mode is needed and the guard is warranted.
Ordering (requireProject() then requireTTY()) matches the established pattern in add, remove, deploy, and invoke. requireProject()'s render(<FatalError>) path is a static component with no useInput, so running it before the TTY check is safe in non-TTY environments.
The YAML-path / subcommand branches (--source ..., import runtime, import memory, etc.) are correctly untouched — they don't launch the TUI.

Tests look good:

tty.test.ts covers all four TTY permutations (stdin-only, stdout-only, both, neither) and asserts exit code 1 + the user-facing message. Using Object.defineProperty with configurable: true to restore isTTY is correct given Node's TTY descriptors.
The regression test in command.test.ts exercises the real bug scenario via runCLI (which spawns with stdio: ['ignore', 'pipe', 'pipe'] — non-TTY stdin and stdout, matching the original repro) and asserts both the positive signal (interactive-terminal message, exit 1) and the negative signal (no "Raw mode is not supported" text). The minimal agentcore/agentcore.json is sufficient to satisfy findConfigRoot / requireProject.

No serious issues. LGTM.

github-actions · 2026-05-07T19:39:04Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	43.2%	9037 / 20915
🔵	Statements	42.48%	9595 / 22585
🔵	Functions	40.04%	1559 / 3893
🔵	Branches	40.02%	5815 / 14527

Generated in workflow #2651 for commit 36d6c75 by the Vitest Coverage Report Action

- Swap requireTTY() before requireProject() in import command so non-TTY contexts exit cleanly without going through any Ink render path (FatalError) that could emit malformed output to a piped stream. - Hoist requireTTY/requireProject to a static barrel import for consistency with deploy/dev/add/remove/invoke/create. - Replace expect(boolean, msg).toBeTruthy() with toContain assertions in import command test for clearer Vitest failure diagnostics. Notes on findings not addressed: - secretlint version finding is a false positive: this PR does not modify package.json (verified with git diff origin/main...HEAD). - The deploy command already has requireTTY() (since PR #949) and was verified working via reproducer; no change needed there. - The runCLI/dist bundle dependency is the existing convention across the repo; tty.test.ts provides the primary regression guard.

- Add deploy non-TTY regression test (deploy-non-tty.test.ts) that pins exit 1 + clear message + no Ink raw-mode error for the no-flags and --diff TUI paths. Flag-bearing modes (--yes, --json, --dry-run, --target, --verbose) route to the non-interactive CLI path which does not require a TTY. - Add import --source <bogus> negative test that pins the guard placement: a future regression that hoists requireTTY() to the top of the action will break this test (it would yield the interactive-terminal message instead of 'Source file not found'). - Move originalStdinIsTTY/originalStdoutIsTTY snapshots into beforeEach in tty.test.ts and re-define with configurable: true so prior test contamination cannot poison restoration.

Hweinstock · 2026-05-07T23:47:41Z

+import { requireTTY } from '../tty.js';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+describe('requireTTY', () => {


what does this verify that the integ tests don't cover?

Hweinstock · 2026-05-07T23:49:07Z

+        // exit with the plain-text message rather than going through any Ink
+        // rendering path (FatalError uses Ink, which can produce malformed
+        // output to a piped stream).
+        requireTTY();


if I understand correctly, we need this logic before all commands. Is there a way we can bake this into a shared middleware to avoid regressions or missing it in other places?

Hweinstock · 2026-05-07T23:49:58Z

+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+/**
+ * Regression test for issue #982 (the command named in the bug title):


nit: the comments feel verbose and unnecessary.

aidandaly24 requested a review from a team May 7, 2026 19:35

github-actions Bot added size/m PR size: M agentcore-harness-reviewing AgentCore Harness review in progress labels May 7, 2026

agentcore-cli-automation approved these changes May 7, 2026

View reviewed changes

github-actions Bot removed the agentcore-harness-reviewing AgentCore Harness review in progress label May 7, 2026

github-actions Bot added size/m PR size: M and removed size/m PR size: M labels May 7, 2026

AgentCore Bot added 3 commits May 7, 2026 19:54

fix: fix issue #982

a9bd408

aidandaly24 force-pushed the fix/982-d968425d branch from e145b9d to 36d6c75 Compare May 7, 2026 19:54

github-actions Bot added size/m PR size: M and removed size/m PR size: M labels May 7, 2026

aidandaly24 changed the title ~~fix: non-TTY import command exits 0 with Ink raw-mode crash (#982)~~ fix(import): guard interactive TUI with requireTTY() so non-TTY exits 1 cleanly (#982) May 7, 2026

Hweinstock reviewed May 7, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(import): guard interactive TUI with requireTTY() so non-TTY exits 1 cleanly (#982)#1170

fix(import): guard interactive TUI with requireTTY() so non-TTY exits 1 cleanly (#982)#1170
aidandaly24 wants to merge 3 commits intomainfrom
fix/982-d968425d

aidandaly24 commented May 7, 2026 •

edited

Loading

Uh oh!

agentcore-cli-automation left a comment

Uh oh!

github-actions Bot commented May 7, 2026 •

edited

Loading

Uh oh!

Hweinstock May 7, 2026

Uh oh!

Hweinstock May 7, 2026

Uh oh!

Hweinstock May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

aidandaly24 commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Root cause

Changes

Out of scope

Related Issue

Documentation PR

Type of Change

Testing

Checklist

Uh oh!

agentcore-cli-automation left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Hweinstock May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Hweinstock May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Hweinstock May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aidandaly24 commented May 7, 2026 •

edited

Loading

github-actions Bot commented May 7, 2026 •

edited

Loading