Skip to content

fix(test): strip ANSI codes from Ink TUI test assertions#1301

Merged
notgitika merged 1 commit into
aws:mainfrom
arepageek:fix/tui-tests-ansi-codes
May 19, 2026
Merged

fix(test): strip ANSI codes from Ink TUI test assertions#1301
notgitika merged 1 commit into
aws:mainfrom
arepageek:fix/tui-tests-ansi-codes

Conversation

@arepageek
Copy link
Copy Markdown

Description

Three TUI component test files have failing assertions on main because Ink 6.8.0 emits ANSI escape codes from styled <Text> and gradient components even when the renderer is not attached to a TTY. The assertions compare lastFrame() against plain strings, so the ANSI bytes inside the frame cause them to fail.

What's failing on main

src/cli/tui/components/__tests__/DeployStatus.test.tsx
  ✗ shows "Deploying to AWS" when not complete
  ✗ ignores non-resource-event messages (non-I5502 codes)
    → frame contains `\u001b[90m╭...` from <GradientText> + bordered <Box>

src/cli/tui/components/__tests__/LogPanel.test.tsx
  ✗ renders "No output yet" with no other content
    → frame is `\u001b[2mNo output yet\u001b[22m` (from <Text dimColor>)

src/cli/tui/components/__tests__/SecretInput.test.tsx
  ✗ renders placeholder when value is empty
    → placeholder is split into <Cursor> + <Text dimColor>, so the literal
      substring 'sk-...' has ANSI codes between 's' and 'k-...'

Fix

Import strip-ansi (already a transitive dep, now declared as a top-level devDependency) and apply it to lastFrame() in the four affected assertions only. Other assertions in the same files were left untouched because they pass through plain log lines / system messages that are already ANSI-free in their substrings.

Why strip-ansi rather than rewriting the components

The components (<Text dimColor>, <GradientText>, <Cursor>) are intentionally styled — that styling is part of the actual UX. The bug is in the test assertions assuming lastFrame() is plain text, which is fragile any time Ink's rendering behavior changes. Stripping ANSI in the assertion is the minimal, low-risk change and matches the standard pattern used by other Ink-based projects.

Files changed

  • package.jsonstrip-ansi ^7.2.0 added under devDependencies (was already pulled in transitively via Vitest / ESLint)
  • package-lock.json — regenerated
  • src/cli/tui/components/__tests__/DeployStatus.test.tsx — 2 assertions
  • src/cli/tui/components/__tests__/LogPanel.test.tsx — 1 assertion
  • src/cli/tui/components/__tests__/SecretInput.test.tsx — 1 assertion

5 files, +9 / -4 lines total.

Before / After

Before: Test Files 3 failed | 270 passed (273) | Tests 4 failed | 3912 passed (3916)
After:  Test Files 273 passed (273)            | Tests 3916 passed (3916)

Related Issue

Closes #

Documentation PR

N/A — test-only change.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

How have you tested the change?

  • I ran npm run test:unit and npm run test:integ (unit: 3916/3916 — was 3912/3916 before this PR)
  • I ran npm run typecheck
  • I ran npm run lint (0 errors; 29 preexisting warnings, none in files touched by this PR)
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots (N/A — no asset changes)

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works (no new tests; this fixes broken existing tests)
  • I have updated the documentation accordingly (no doc changes needed)
  • 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.

Three TUI component tests were broken on main because Ink 6.8.0
emits ANSI escape codes from `<Text dimColor>`, `<Text color=...>`,
and `<GradientText>` even when the renderer is not attached to a TTY.
The affected assertions compare `lastFrame()` against plain strings,
so the ANSI bytes inside the frame caused these to fail:

  src/cli/tui/components/__tests__/DeployStatus.test.tsx:
    - 'shows "Deploying to AWS" when not complete'
    - 'ignores non-resource-event messages (non-I5502 codes)'
      (frame contains `\u001b[90m╭…` from <GradientText> + bordered <Box>)

  src/cli/tui/components/__tests__/LogPanel.test.tsx:
    - 'renders "No output yet" with no other content'
      (frame is `\u001b[2mNo output yet\u001b[22m` from <Text dimColor>)

  src/cli/tui/components/__tests__/SecretInput.test.tsx:
    - 'renders placeholder when value is empty'
      (placeholder is split into <Cursor> + <Text dimColor>, so the
       literal substring 'sk-...' has ANSI codes between 's' and 'k-...')

Fix: import `strip-ansi` (already a transitive dep, now declared as a
devDependency) and apply it to `lastFrame()` in the four affected
assertions. Other assertions in the same files were left untouched
because they pass through plain log lines / system messages that are
already ANSI-free.

Verified locally:
  Before: Test Files 3 failed | 270 passed (273) | Tests 4 failed | 3912 passed (3916)
  After:  Test Files 273 passed (273)            | Tests 3916 passed (3916)
@arepageek arepageek requested a review from a team May 19, 2026 00:46
@github-actions github-actions Bot added the size/xs PR size: XS label May 19, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label May 19, 2026
@agentcore-devx-automation
Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label May 19, 2026
Copy link
Copy Markdown
Contributor

@notgitika notgitika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@notgitika notgitika merged commit ab4c19e into aws:main May 19, 2026
29 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants