Skip to content

feat(gateway): add interactive invoke console - #1978

Merged
aidandaly24 merged 9 commits into
refactorfrom
feat/gateway-invoke-tui
Aug 14, 2026
Merged

feat(gateway): add interactive invoke console#1978
aidandaly24 merged 9 commits into
refactorfrom
feat/gateway-invoke-tui

Conversation

@aidandaly24

Copy link
Copy Markdown
Contributor

Summary

  • add a persistent POST JSON console for agentcore gateway invoke
  • add Gateway switching, raw path editing, generated/continued sessions, and live response streaming
  • preserve the headless Gateway invoke contract while allowing CLI flags to seed interactive context
  • share the multiline editor with Runtime and keep long payloads within stable terminal rows

UX

  • Ctrl+T switches Gateway and clears Gateway-specific state
  • Ctrl+P edits the Gateway-relative path; blank uses the exact Gateway URL
  • Ctrl+V toggles completed JSON between raw and pretty forms
  • CUSTOM_JWT Gateways proactively require a CLI-provided bearer token
  • Runtime and MCP session metadata continues across requests

Verification

  • 206 pass, 0 fail focused Gateway/Runtime invoke tests
  • 1197 pass, 0 fail full bun test src
  • bun run typecheck
  • bun run lint:check
  • bun run format:check
  • bun run build
  • live TUI validation: NONE, AWS_IAM, CUSTOM_JWT, AUTHENTICATE_ONLY, JWT passthrough, OAuth 3LO, OAuth OBO, inference, Runtime HTTP, MCP aggregation, Lambda, and real SSE streaming

Stack

Depends on #1967. Review this PR against feat/gateway-invoke.

@github-actions github-actions Bot added the size/xl PR size: XL label Aug 11, 2026
@github-actions github-actions Bot added agentcore-harness-reviewing AgentCore Harness review in progress size/xl PR size: XL and removed agentcore-harness-reviewing AgentCore Harness review in progress size/xl PR size: XL labels Aug 11, 2026
@github-actions github-actions Bot removed the size/xl PR size: XL label Aug 12, 2026
@github-actions github-actions Bot added the size/xl PR size: XL label Aug 12, 2026
@aidandaly24
aidandaly24 force-pushed the feat/gateway-invoke-tui branch from 196b394 to 9c11253 Compare August 13, 2026 18:44
@github-actions github-actions Bot added size/xl PR size: XL and removed size/xl PR size: XL labels Aug 13, 2026
@github-actions github-actions Bot added size/xl PR size: XL and removed size/xl PR size: XL labels Aug 13, 2026
@aidandaly24
aidandaly24 force-pushed the feat/gateway-invoke-tui branch from d312820 to ad207ae Compare August 13, 2026 19:41
Base automatically changed from feat/gateway-invoke to refactor August 13, 2026 19:43
@aidandaly24
aidandaly24 force-pushed the feat/gateway-invoke-tui branch from ad207ae to 858db4d Compare August 13, 2026 19:43
@aidandaly24
aidandaly24 marked this pull request as ready for review August 13, 2026 19:45
@codecov-commenter

codecov-commenter commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 98.43505% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.00%. Comparing base (ea3fa84) to head (6489a5d).

Files with missing lines Patch % Lines
src/handlers/gateway/invoke/screen.tsx 97.80% 10 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##           refactor    #1978      +/-   ##
============================================
+ Coverage     96.97%   97.00%   +0.02%     
============================================
  Files           364      366       +2     
  Lines         20844    21373     +529     
============================================
+ Hits          20213    20732     +519     
- Misses          631      641      +10     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

metadata: metadata(response),
state: "streaming",
});
const kind = classifyStreamingResponse(response.contentType);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we need the same statusCode !== 204 && statusCode !== 205 clause here that we did in the headless invoke PR

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Fixed in e14e8848 by exempting HTTP 204 and 205 from the TUI binary/unknown-content guard, matching the headless invoke behavior. I also added screen coverage for both statuses with an empty content type and body; the focused Gateway invoke screen suite passes 31/31.

@aidandaly24
aidandaly24 force-pushed the feat/gateway-invoke-tui branch from 858db4d to 40b3457 Compare August 13, 2026 20:31
nborges-aws
nborges-aws previously approved these changes Aug 13, 2026

@nborges-aws nborges-aws left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

}

const jsonOutput = ctx.require(JsonKey);
if (flags.payload === undefined) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

does this break the pattern of tui only no flags? If so, could this be confusing for customers?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, but Runtime invoke already follows this pattern where a missing --payload launches the TUI. I think it technically could be a little bit confusing, but I personally think there's are a couple good reasons for why we should keep it this way. For one, we wanted to keep the TUI simple to start. When building runtime invoke I built an advanced options menu, which was accessible in the invoke TUI via a ctrl + key command. This added complexity to the code and we thought it would be better to start simple and layer this complexity on top in the future. So to keep these configurations accessible, I opted to not open the TUI on no --payload. Second, I think for things like --session-id it is more intuitive to pass it in via the CLI before opening the agent than after opening up the agent.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The harness invoke TUI is also not strictly no-flags only so I think it's okay to break the pattern on invoke for now.

I think it'd be worthwhile though to have a conversation about this with the team though.

Comment thread src/handlers/gateway/invoke/index.tsx Outdated
io,
);
} catch (error) {
if (error instanceof InvalidEnvironmentError) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why do we need to re-wrap this? Is there a specific InvalidEnvironmentError that should be a InputValidationError?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Tbh this only exists to change the exit code. I agree with what I think you may be getting at which is that this is unnecessary complexity. I'll remove this.

Runtime invoke also uses this, and I'll update it there as well. I think what I could do is have this here throw a new InvalidEnvironmentError(message, { exitCode: ExitCode.USAGE }) instead.

https://github.com/aws/agentcore-cli/blob/refactor/src/tui/index.tsx#L49-L51

Then remove the catch/rewrite here and in Runtime.

test("deep-links an id-only invoke and seeds interactive request context", async () => {
const core = configuredCore();
const output = captureIO();
const render = spyOn(tui, "renderTuiAt").mockResolvedValue(undefined);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is there a way to avoid spying by leveraging the existing dependency injection?


test("preserves unexpected TUI bearer-token source failures", async () => {
const failure = new TypeError("source failed");
const resolve = spyOn(SourceResolver.prototype, "resolveText").mockRejectedValue(failure);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same question as above. Is there way we can inject real implementations?

): Promise<string | undefined> {
if (source === "-") {
throw new InputValidationError(
"stdin bearer tokens are not available when launching the interactive console",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

don't we need to support stdin for sensitive fields?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is unfortunately a trade off of using the TUI. Headless invoke supports --bearer-token -. Interactive invoke deliberately does not because Ink needs the same stdin for keyboard input. Consuming it for the token would drain or block the TUI. Interactive mode supports inline and file:// tokens. So you still can pass bearer token securely through a file for interactive. Runtime has the same restriction.

Comment thread src/handlers/gateway/invoke/request.ts Outdated
try {
return await new SourceResolver({ stdin }).resolveText("bearer-token", source);
} catch (error) {
if (error instanceof SourceResolutionError) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

whats wrong with the sourceResolutionError bubbling up?

@aidandaly24
aidandaly24 force-pushed the feat/gateway-invoke-tui branch from e14e884 to fdbfe3a Compare August 14, 2026 17:23

@Hweinstock Hweinstock left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm! thanks for answering my earlier questions, those decisions make sense.

@aidandaly24
aidandaly24 merged commit 1976766 into refactor Aug 14, 2026
11 checks passed
@aidandaly24
aidandaly24 deleted the feat/gateway-invoke-tui branch August 14, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xl PR size: XL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants