From 6adade7f3aec840e197c91767c0d8efe1f27ce8d Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 11:25:33 +1000 Subject: [PATCH 01/20] Add WithTerminal API: TerminalAnnotation, TerminalHostResource, and extension method Implements Phase 1 of the live terminal support feature (#16317). - TerminalAnnotation: IResourceAnnotation with TerminalOptions (Columns, Rows, Shell) and a SocketPath property for the UDS path set by the orchestrator. - TerminalHostResource: Internal hidden resource (IResourceWithParent) that will manage the Hex1b-based terminal host process for a parent resource. - WithTerminal(): Extension method that adds TerminalAnnotation to a resource, creates a hidden TerminalHostResource, and adds a WaitAnnotation so the parent waits for the terminal host to be started. - Tests: 8 unit tests covering annotation creation, custom options, hidden resource creation, wait annotation wiring, chaining, container support, manifest exclusion, and null argument handling. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../ApplicationModel/TerminalAnnotation.cs | 56 ++++++++ .../ApplicationModel/TerminalHostResource.cs | 33 +++++ .../TerminalResourceBuilderExtensions.cs | 95 +++++++++++++ .../Aspire.Hosting.Tests/WithTerminalTests.cs | 132 ++++++++++++++++++ 4 files changed, 316 insertions(+) create mode 100644 src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs create mode 100644 src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs create mode 100644 src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs create mode 100644 tests/Aspire.Hosting.Tests/WithTerminalTests.cs diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs new file mode 100644 index 00000000000..6f9e46883fa --- /dev/null +++ b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs @@ -0,0 +1,56 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Diagnostics; + +namespace Aspire.Hosting.ApplicationModel; + +/// +/// Represents terminal configuration for a resource that supports interactive terminal sessions. +/// +/// +/// When this annotation is present on a resource, the orchestrator will allocate a pseudo-terminal (PTY) +/// for the resource's process and make it available for interactive access via a Unix domain socket. +/// +[DebuggerDisplay("Type = {GetType().Name,nq}, SocketPath = {SocketPath}")] +public sealed class TerminalAnnotation : IResourceAnnotation +{ + /// + /// Gets or sets the path to the Unix domain socket used for terminal I/O. + /// + /// + /// This path is set by the orchestrator when the terminal host is started. + /// Clients connect to this socket to interact with the resource's terminal session. + /// + public string? SocketPath { get; set; } + + /// + /// Gets the terminal options for this annotation. + /// + public TerminalOptions Options { get; init; } = new(); +} + +/// +/// Options for configuring a terminal session. +/// +public sealed class TerminalOptions +{ + /// + /// Gets or sets the initial number of columns for the terminal. Defaults to 120. + /// + public int Columns { get; set; } = 120; + + /// + /// Gets or sets the initial number of rows for the terminal. Defaults to 30. + /// + public int Rows { get; set; } = 30; + + /// + /// Gets or sets the shell to use for the terminal session. + /// + /// + /// When null, the default shell for the resource is used. + /// For containers, this is typically /bin/sh. For executables, the process itself serves as the terminal program. + /// + public string? Shell { get; set; } +} diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs b/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs new file mode 100644 index 00000000000..61a9653af87 --- /dev/null +++ b/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs @@ -0,0 +1,33 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Hosting.ApplicationModel; + +/// +/// A hidden resource that manages the terminal host process for a parent resource. +/// +/// +/// The terminal host process uses Hex1b to maintain a headless terminal state and serves +/// as the bridge between DCP's PTY forwarding and clients (Dashboard, CLI) that connect +/// via Unix domain socket. One terminal host is created per resource that has +/// applied. +/// +internal sealed class TerminalHostResource : Resource, IResourceWithParent, IResourceWithWaitSupport +{ + /// + /// Initializes a new instance of the class. + /// + /// The name of the terminal host resource. + /// The resource that this terminal host serves. + public TerminalHostResource(string name, IResource parent) + : base(name) + { + ArgumentNullException.ThrowIfNull(parent); + Parent = parent; + } + + /// + /// Gets the parent resource that this terminal host serves. + /// + public IResource Parent { get; } +} diff --git a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs new file mode 100644 index 00000000000..689c27fc5d4 --- /dev/null +++ b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs @@ -0,0 +1,95 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Hosting.ApplicationModel; + +namespace Aspire.Hosting; + +/// +/// Provides extension methods for configuring interactive terminal support on resources. +/// +public static class TerminalResourceBuilderExtensions +{ + /// + /// Configures a resource to have an interactive terminal session. + /// + /// The type of the resource. + /// The resource builder. + /// An optional callback to configure the terminal options. + /// A reference to the for chaining additional configuration. + /// + /// + /// When a resource is configured with .WithTerminal(), the orchestrator allocates a pseudo-terminal (PTY) + /// for the resource's process and makes it available for interactive access. The terminal session can be accessed + /// from the Aspire Dashboard's "Terminal" tab or via the aspire terminal CLI command. + /// + /// + /// A hidden terminal host resource is created automatically to manage the terminal state using Hex1b. + /// The parent resource will wait for the terminal host to be ready before starting. + /// + /// + /// + /// Add terminal support to an executable resource: + /// + /// var agent = builder.AddExecutable("agent", "my-agent", ".") + /// .WithTerminal(); + /// + /// + /// + /// Add terminal support with custom dimensions: + /// + /// var agent = builder.AddExecutable("agent", "my-agent", ".") + /// .WithTerminal(options => + /// { + /// options.Columns = 200; + /// options.Rows = 50; + /// }); + /// + /// + [AspireExportIgnore(Reason = "Action delegate parameter is not ATS-compatible.")] + public static IResourceBuilder WithTerminal(this IResourceBuilder builder, Action? configure = null) + where T : IResource + { + ArgumentNullException.ThrowIfNull(builder); + + var options = new TerminalOptions(); + configure?.Invoke(options); + + var annotation = new TerminalAnnotation + { + Options = options + }; + + builder.WithAnnotation(annotation); + + AddTerminalHostResource(builder); + + return builder; + } + + private static void AddTerminalHostResource(IResourceBuilder builder) + where T : IResource + { + var terminalHostName = $"{builder.Resource.Name}-terminal-host"; + var terminalHost = new TerminalHostResource(terminalHostName, builder.Resource); + + var terminalHostBuilder = builder.ApplicationBuilder.AddResource(terminalHost); + + terminalHostBuilder + .WithInitialState(new CustomResourceSnapshot + { + ResourceType = "TerminalHost", + State = KnownResourceStates.NotStarted, + Properties = [], + IsHidden = true, + }) + .ExcludeFromManifest(); + + // The parent resource waits for the terminal host to be started so that + // the PTY forwarding infrastructure is in place before the process begins. + if (builder.Resource is IResourceWithWaitSupport) + { + builder.WithAnnotation(new WaitAnnotation(terminalHost, WaitType.WaitUntilStarted)); + } + } +} diff --git a/tests/Aspire.Hosting.Tests/WithTerminalTests.cs b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs new file mode 100644 index 00000000000..563e189d9ca --- /dev/null +++ b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs @@ -0,0 +1,132 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Hosting.Utils; +using Microsoft.Extensions.DependencyInjection; + +namespace Aspire.Hosting.Tests; + +public class WithTerminalTests +{ + [Fact] + public void WithTerminalAddsTerminalAnnotation() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(); + + var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(annotation); + Assert.Equal(120, annotation.Options.Columns); + Assert.Equal(30, annotation.Options.Rows); + Assert.Null(annotation.Options.Shell); + } + + [Fact] + public void WithTerminalAcceptsCustomOptions() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(options => + { + options.Columns = 200; + options.Rows = 50; + options.Shell = "/bin/bash"; + }); + + var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(annotation); + Assert.Equal(200, annotation.Options.Columns); + Assert.Equal(50, annotation.Options.Rows); + Assert.Equal("/bin/bash", annotation.Options.Shell); + } + + [Fact] + public void WithTerminalCreatesHiddenTerminalHostResource() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(); + + var app = builder.Build(); + var model = app.Services.GetRequiredService(); + + var terminalHost = model.Resources.OfType().SingleOrDefault(); + Assert.NotNull(terminalHost); + Assert.Equal("myapp-terminal-host", terminalHost.Name); + Assert.Same(resource.Resource, terminalHost.Parent); + } + + [Fact] + public void WithTerminalAddsWaitAnnotationForWaitSupportedResources() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(); + + var waitAnnotations = resource.Resource.Annotations.OfType().ToList(); + var terminalWait = waitAnnotations.FirstOrDefault(w => w.Resource is TerminalHostResource); + Assert.NotNull(terminalWait); + Assert.Equal(WaitType.WaitUntilStarted, terminalWait.WaitType); + } + + [Fact] + public void WithTerminalCanBeChained() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + var result = resource.WithTerminal(); + + Assert.Same(resource, result); + } + + [Fact] + public void WithTerminalWorksOnContainerResources() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var container = builder.AddContainer("mycontainer", "myimage"); + + container.WithTerminal(); + + var annotation = container.Resource.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(annotation); + + var app = builder.Build(); + var model = app.Services.GetRequiredService(); + + var terminalHost = model.Resources.OfType().SingleOrDefault(); + Assert.NotNull(terminalHost); + Assert.Equal("mycontainer-terminal-host", terminalHost.Name); + } + + [Fact] + public void TerminalHostResourceIsExcludedFromManifest() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(); + + var app = builder.Build(); + var model = app.Services.GetRequiredService(); + + var terminalHost = model.Resources.OfType().SingleOrDefault(); + Assert.NotNull(terminalHost); + + var manifestAnnotation = terminalHost.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(manifestAnnotation); + } + + [Fact] + public void WithTerminalThrowsForNullBuilder() + { + IResourceBuilder builder = null!; + + Assert.Throws(() => builder.WithTerminal()); + } +} From 250f16ba1e1700625b0e26daf0c9c8560c51bc82 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 11:52:27 +1000 Subject: [PATCH 02/20] Add Aspire Terminal Protocol spec, shared codec, and playground - docs/specs/terminal-protocol.md: Full protocol specification defining the binary framing format for terminal I/O over Unix domain sockets. Covers HELLO, DATA, RESIZE, EXIT, and CLOSE message types with wire examples and implementation notes for DCP (Go) and Aspire (C#). - src/Shared/Terminal/: Shared protocol types (TerminalProtocol constants, TerminalFrameReader, TerminalFrameWriter, TerminalFrame) designed to be linked into Aspire.Hosting, Dashboard, and CLI projects. - playground/Terminals/: Two-project playground demonstrating WithTerminal without DCP: - Terminals.TerminalHost: .NET console app using Hex1b with a custom IHex1bTerminalPresentationAdapter that implements the Aspire Terminal Protocol over UDS. Receives socket path via TERMINAL_SOCKET_PATH env var. - Terminals.AppHost: Aspire AppHost that launches the terminal host as a child process with a custom resource lifecycle (OnInitializeResource), demonstrating the full WithTerminal flow before DCP PTY support lands. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/specs/terminal-protocol.md | 300 ++++++++++++++++++ .../Terminals/Terminals.AppHost/AppHost.cs | 25 ++ .../Properties/launchSettings.json | 32 ++ .../Terminals.AppHost/TerminalDemoResource.cs | 174 ++++++++++ .../Terminals.AppHost.csproj | 23 ++ .../appsettings.Development.json | 9 + .../Terminals.AppHost/appsettings.json | 8 + .../Terminals.TerminalHost/Program.cs | 66 ++++ .../Terminals.TerminalHost.csproj | 20 ++ .../UnixDomainSocketPresentationAdapter.cs | 204 ++++++++++++ .../Terminal/TerminalFrameReaderWriter.cs | 221 +++++++++++++ src/Shared/Terminal/TerminalProtocol.cs | 99 ++++++ 12 files changed, 1181 insertions(+) create mode 100644 docs/specs/terminal-protocol.md create mode 100644 playground/Terminals/Terminals.AppHost/AppHost.cs create mode 100644 playground/Terminals/Terminals.AppHost/Properties/launchSettings.json create mode 100644 playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs create mode 100644 playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj create mode 100644 playground/Terminals/Terminals.AppHost/appsettings.Development.json create mode 100644 playground/Terminals/Terminals.AppHost/appsettings.json create mode 100644 playground/Terminals/Terminals.TerminalHost/Program.cs create mode 100644 playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj create mode 100644 playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs create mode 100644 src/Shared/Terminal/TerminalFrameReaderWriter.cs create mode 100644 src/Shared/Terminal/TerminalProtocol.cs diff --git a/docs/specs/terminal-protocol.md b/docs/specs/terminal-protocol.md new file mode 100644 index 00000000000..a07892eb658 --- /dev/null +++ b/docs/specs/terminal-protocol.md @@ -0,0 +1,300 @@ +# Aspire Terminal Protocol Specification + +**Version:** 1 +**Status:** Draft +**Issue:** https://github.com/microsoft/aspire/issues/16317 +**DCP Issue:** https://github.com/microsoft/dcp/issues/6 + +## Overview + +The Aspire Terminal Protocol defines a binary framing protocol for interactive terminal I/O over Unix domain sockets (UDS). It is used to stream PTY data between a terminal producer (DCP or a terminal host process) and a terminal consumer (Aspire Dashboard, Aspire CLI, or other clients). + +The protocol is intentionally simple so that it can be implemented in both C# (Aspire) and Go (DCP) without shared code generation or IDL. + +## Transport + +- **Socket type:** Unix domain socket (`AF_UNIX`, `SOCK_STREAM`) +- **Byte order:** Big-endian (network byte order) for all multi-byte integers +- **Connection model:** A server listens on a UDS path. Clients connect to that path. Each connection is an independent terminal session. + +## Frame Format + +Every message on the wire is a **frame** with the following layout: + +``` ++--------+----------------+-----------------+ +| Type | Payload Length | Payload | +| 1 byte | 4 bytes (BE) | 0..N bytes | ++--------+----------------+-----------------+ +``` + +| Field | Size | Description | +|----------------|---------|-------------------------------------------------------| +| Type | 1 byte | Message type identifier (see table below) | +| Payload Length | 4 bytes | Unsigned 32-bit big-endian integer, length of payload | +| Payload | N bytes | Type-specific payload data | + +### Maximum Frame Size + +The maximum payload length is **1,048,576 bytes** (1 MiB). Receivers **must** reject frames with a payload length exceeding this limit and close the connection. This prevents memory exhaustion from malformed or malicious input. + +### Partial Reads/Writes + +Since UDS is a stream socket, a single `write()` does not guarantee a single `read()` on the other side. Implementations **must** handle partial reads by buffering until a complete frame header (5 bytes) and its full payload have been received. + +## Message Types + +| Type | Name | Direction | Payload | +|------|-------------|--------------------|----------------------------------| +| 0x01 | HELLO | Server → Client | Version + dimensions + flags | +| 0x02 | DATA | Either direction | Raw terminal bytes | +| 0x03 | RESIZE | Either direction | New dimensions | +| 0x04 | EXIT | Server → Client | Exit code + reason | +| 0x05 | CLOSE | Either direction | *(empty — payload length is 0)* | + +### 0x01 — HELLO + +Sent by the server as the **first frame** on every new connection. Establishes the protocol version and initial terminal dimensions. + +``` ++----------+--------+--------+--------+ +| Version | Cols | Rows | Flags | +| 1 byte | 2 BE | 2 BE | 1 byte | ++----------+--------+--------+--------+ +``` + +| Field | Size | Description | +|---------|---------|-----------------------------------------------------| +| Version | 1 byte | Protocol version. Currently `0x01`. | +| Cols | 2 bytes | Terminal width in columns (unsigned 16-bit BE) | +| Rows | 2 bytes | Terminal height in rows (unsigned 16-bit BE) | +| Flags | 1 byte | Capability flags (see below) | + +**Payload length:** 6 bytes (fixed). + +**Flags:** + +| Bit | Name | Description | +|-----|----------------|----------------------------------------------------| +| 0 | PTY | `1` if the server has a real PTY allocated | +| 1 | REPLAY | `1` if the server will replay buffered terminal state after HELLO | +| 2-7 | *(reserved)* | Must be `0`. Receivers must ignore unknown flags. | + +**Rules:** +- The server **must** send HELLO before any DATA frames. +- The server **must** buffer PTY output until HELLO has been written to the socket. +- The client **must** wait for HELLO before sending any frames. +- If the client receives a HELLO with an unsupported version, it **should** close the connection. + +### 0x02 — DATA + +Carries raw terminal bytes in either direction. + +- **Server → Client:** PTY output (stdout/stderr interleaved, as a real terminal would produce). These are raw bytes including ANSI escape sequences, UTF-8 text, and control characters. +- **Client → Server:** User input (keystrokes, mouse events encoded as ANSI escape sequences). These are raw bytes as a terminal emulator would generate. + +**Payload:** Variable-length raw bytes. Minimum 1 byte. Maximum 1 MiB. + +**Rules:** +- DATA frames carry opaque byte streams. Neither side should assume anything about framing alignment with respect to UTF-8 characters, escape sequences, or line boundaries. A single escape sequence may span multiple DATA frames, and a single DATA frame may contain multiple escape sequences. +- Empty DATA frames (payload length 0) are permitted but have no effect. + +### 0x03 — RESIZE + +Notifies the other side of a terminal dimension change. + +``` ++--------+--------+ +| Cols | Rows | +| 2 BE | 2 BE | ++--------+--------+ +``` + +| Field | Size | Description | +|-------|---------|------------------------------------------------| +| Cols | 2 bytes | New terminal width in columns (unsigned 16-bit BE) | +| Rows | 2 bytes | New terminal height in rows (unsigned 16-bit BE) | + +**Payload length:** 4 bytes (fixed). + +**Direction:** +- **Client → Server:** The client's display area changed (e.g., browser window resized, CLI terminal resized via `SIGWINCH`). The server should forward this to the PTY via `TIOCSWINSZ` / `SIGWINCH`. +- **Server → Client:** The server-side terminal dimensions changed (informational). The client should update its terminal emulator dimensions. + +### 0x04 — EXIT + +Sent by the server when the underlying process terminates. + +``` ++-----------+--------+ +| Exit Code | Reason | +| 4 bytes | 1 byte | ++-----------+--------+ +``` + +| Field | Size | Description | +|-----------|---------|--------------------------------------------------| +| Exit Code | 4 bytes | Signed 32-bit big-endian integer. Process exit code. `-1` if unknown. | +| Reason | 1 byte | Termination reason (see below) | + +**Payload length:** 5 bytes (fixed). + +**Reason values:** + +| Value | Name | Description | +|-------|-------------|--------------------------------------------------| +| 0x00 | EXITED | Process exited normally | +| 0x01 | KILLED | Process was killed (e.g., `SIGKILL`, `TerminateProcess`) | +| 0x02 | DETACHED | Server is detaching from the PTY (process may continue) | +| 0x03 | ERROR | Server encountered an unrecoverable error | + +**Rules:** +- After sending EXIT, the server **may** send a CLOSE frame or simply close the socket. +- After receiving EXIT, the client **should** stop sending DATA/RESIZE frames. + +### 0x05 — CLOSE + +Graceful session shutdown. Either side may send this to indicate it is done. + +**Payload length:** 0 bytes (fixed). + +**Rules:** +- After sending CLOSE, the sender **must not** send any further frames. +- After receiving CLOSE, the receiver **should** close its end of the socket. +- A CLOSE without a preceding EXIT from the server indicates an abnormal disconnection (e.g., the server crashed). + +## Connection Lifecycle + +### Normal Session + +``` +Client Server + | | + |-------- connect() ----------->| + | | + |<------- HELLO(v1, 80x24) -----| (server sends HELLO first) + |<------- DATA(buffered state) -| (optional: replay if REPLAY flag set) + |<------- DATA(live output) ----| + | | + |-------- DATA(keystroke) ----->| + |<------- DATA(echo + output) --| + | | + |-------- RESIZE(120x40) ----->| (client window resized) + |<------- DATA(repaint) --------| + | | + |<------- EXIT(0, EXITED) ------| (process exited) + |<------- CLOSE ----------------| + |-------- CLOSE --------------->| + | | +``` + +### Client-Initiated Disconnect + +``` +Client Server + | | + |-------- CLOSE --------------->| (user detached) + | | (server may keep process running) +``` + +### Server Crash + +``` +Client Server + | | + |<------- [socket closed] ------| (no CLOSE/EXIT — abnormal) + | | +``` + +## Error Handling + +| Condition | Action | +|----------------------------------|-------------------------------------------| +| Unknown message type received | Close socket immediately (protocol error) | +| Payload length exceeds 1 MiB | Close socket immediately (protocol error) | +| HELLO not received as first frame| Close socket immediately (protocol error) | +| Unsupported protocol version | Close socket (version mismatch) | +| Socket read returns 0 bytes | Peer disconnected, clean up | +| Socket write fails with EPIPE | Peer disconnected, clean up | +| Fixed-length payload has wrong size | Close socket (protocol error) | + +## Implementation Notes + +### For DCP (Go) + +- When `terminal.enabled = true` on an Executable/Container spec, DCP allocates a PTY and starts the UDS server at `terminal.socketPath`. +- DCP writes `HELLO` to each new client connection, then streams PTY output as `DATA` frames. +- DCP reads `DATA` frames from the client and writes them to the PTY's stdin. +- DCP reads `RESIZE` frames and calls `ioctl(TIOCSWINSZ)` on the PTY master. +- When the process exits, DCP sends `EXIT` followed by `CLOSE`. + +### For Aspire Terminal Host (C#) + +- The terminal host is used for non-DCP resources. It runs Hex1b with a custom `IHex1bTerminalPresentationAdapter` that implements the server side of this protocol. +- The adapter listens on the UDS, sends `HELLO`, bridges `DATA` frames to/from Hex1b's presentation interface, and forwards `RESIZE` events. + +### For Aspire Dashboard (C#/Blazor) + +- The Dashboard connects to the UDS (directly or via backchannel proxy), receives `HELLO`, and configures xterm.js with the initial dimensions. +- `DATA` frames from the server are written to xterm.js for rendering. +- Keystrokes from xterm.js are sent as `DATA` frames to the server. +- Browser resize events trigger `RESIZE` frames. + +### For Aspire CLI (C#) + +- The CLI connects to the UDS, receives `HELLO`, puts the local terminal in raw mode, and forwards bytes bidirectionally. +- `SIGWINCH` triggers a `RESIZE` frame to the server. +- `Ctrl+]` detaches by sending `CLOSE`. + +## Wire Examples + +### HELLO frame (version 1, 120 columns, 30 rows, PTY flag set) + +``` +01 # Type: HELLO +00 00 00 06 # Payload length: 6 +01 # Version: 1 +00 78 # Cols: 120 +00 1E # Rows: 30 +01 # Flags: PTY=1 +``` + +### DATA frame (5 bytes: "Hello") + +``` +02 # Type: DATA +00 00 00 05 # Payload length: 5 +48 65 6C 6C 6F # "Hello" +``` + +### RESIZE frame (200 columns, 50 rows) + +``` +03 # Type: RESIZE +00 00 00 04 # Payload length: 4 +00 C8 # Cols: 200 +00 32 # Rows: 50 +``` + +### EXIT frame (exit code 0, reason EXITED) + +``` +04 # Type: EXIT +00 00 00 05 # Payload length: 5 +00 00 00 00 # Exit code: 0 +00 # Reason: EXITED +``` + +### CLOSE frame + +``` +05 # Type: CLOSE +00 00 00 00 # Payload length: 0 +``` + +## Future Considerations + +- **Multiple clients:** The current design is single-client per UDS. Supporting multiple concurrent viewers would require a fan-out layer (e.g., the terminal host, or a backchannel proxy). The protocol itself does not need to change. +- **Authentication:** If the UDS needs access control beyond filesystem permissions, a future version could add an AUTH message type after HELLO. +- **Compression:** For high-throughput scenarios, a future version could negotiate compression in the HELLO flags. +- **Flow control:** The current design has no backpressure mechanism. If a client cannot keep up with output, it will buffer or lose frames. A future version could add windowed flow control. diff --git a/playground/Terminals/Terminals.AppHost/AppHost.cs b/playground/Terminals/Terminals.AppHost/AppHost.cs new file mode 100644 index 00000000000..fd73db7a8aa --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/AppHost.cs @@ -0,0 +1,25 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Terminals.AppHost; + +var builder = DistributedApplication.CreateBuilder(args); + +// Add a terminal demo resource that runs a Hex1b-hosted shell session. +// The terminal host process receives the UDS path via environment variable, +// creates a Hex1b terminal with a custom presentation adapter, and bridges +// client connections over the socket to the shell's PTY. +// This demonstrates the full WithTerminal flow without requiring DCP PTY support. +builder.AddTerminalDemo("demo-shell"); + +#if !SKIP_DASHBOARD_REFERENCE +// This project is only added in playground projects to support development/debugging +// of the dashboard. It is not required in end developer code. Comment out this code +// or build with `/p:SkipDashboardReference=true`, to test end developer +// dashboard launch experience, Refer to Directory.Build.props for the path to +// the dashboard binary (defaults to the Aspire.Dashboard bin output in the +// artifacts dir). +builder.AddProject(KnownResourceNames.AspireDashboard); +#endif + +builder.Build().Run(); diff --git a/playground/Terminals/Terminals.AppHost/Properties/launchSettings.json b/playground/Terminals/Terminals.AppHost/Properties/launchSettings.json new file mode 100644 index 00000000000..7ef26265507 --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/Properties/launchSettings.json @@ -0,0 +1,32 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:16180;http://localhost:17120", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:17119", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:17119", + "ASPIRE_SHOW_DASHBOARD_RESOURCES": "true" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:16181", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:17120", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:17120", + "ASPIRE_SHOW_DASHBOARD_RESOURCES": "true", + "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true" + } + } + } +} diff --git a/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs b/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs new file mode 100644 index 00000000000..500f934f993 --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs @@ -0,0 +1,174 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Diagnostics; +using System.Globalization; +using Microsoft.Extensions.Logging; + +namespace Terminals.AppHost; + +/// +/// A custom resource that represents an interactive terminal session backed by +/// the Terminals.TerminalHost process. The terminal host runs Hex1b with a PTY +/// shell and serves the Aspire Terminal Protocol over a Unix domain socket. +/// +public sealed class TerminalDemoResource(string name) : Resource(name), IResourceWithWaitSupport; + +/// +/// Extension methods for adding terminal demo resources to the application builder. +/// +public static class TerminalDemoExtensions +{ + /// + /// Adds a terminal demo resource that launches a Hex1b-hosted shell session. + /// The terminal host process receives the UDS path via environment variable + /// and implements the Aspire Terminal Protocol for client connections. + /// + [AspireExportIgnore(Reason = "Playground-only terminal demo resource; not part of the supported ATS surface.")] + public static IResourceBuilder AddTerminalDemo( + this IDistributedApplicationBuilder builder, + string name) + { + var resource = new TerminalDemoResource(name); + + // Generate a UDS path for this terminal session + var socketDir = Path.Combine(Path.GetTempPath(), "aspire-terminals"); + Directory.CreateDirectory(socketDir); + var socketPath = Path.Combine(socketDir, $"{name}-{Environment.ProcessId}.sock"); + + // Find the terminal host project executable + var terminalHostProject = FindTerminalHostProject(); + + var resourceBuilder = builder.AddResource(resource) + .ExcludeFromManifest() + .WithInitialState(new CustomResourceSnapshot + { + ResourceType = "TerminalDemo", + CreationTimeStamp = DateTime.UtcNow, + State = KnownResourceStates.NotStarted, + Properties = + [ + new(CustomResourceKnownProperties.Source, "Terminal Demo"), + new("terminal.socketPath", socketPath) + ] + }) + .WithTerminal(); + + // Use OnInitializeResource to launch the terminal host process and manage its lifecycle. + // This replaces what DCP would normally do (PTY allocation + UDS forwarding). + resourceBuilder.OnInitializeResource(async (resource, @event, token) => + { + var log = @event.Logger; + var notification = @event.Notifications; + var eventing = @event.Eventing; + var services = @event.Services; + + await eventing.PublishAsync(new BeforeResourceStartedEvent(resource, services), token); + + log.LogInformation("Starting terminal host: {Project}", terminalHostProject); + log.LogInformation("Terminal socket: {SocketPath}", socketPath); + + // Store the socket path in the terminal annotation + if (resource.Annotations.OfType().FirstOrDefault() is { } terminalAnnotation) + { + terminalAnnotation.SocketPath = socketPath; + } + + // Launch the terminal host as a child process + var psi = new ProcessStartInfo("dotnet", ["run", "--project", terminalHostProject]) + { + UseShellExecute = false, + RedirectStandardOutput = true, + RedirectStandardError = true, + Environment = + { + ["TERMINAL_SOCKET_PATH"] = socketPath, + ["TERMINAL_COLUMNS"] = "120", + ["TERMINAL_ROWS"] = "30", + } + }; + + var process = Process.Start(psi); + if (process is null) + { + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.FailedToStart + }); + return; + } + + // Forward stderr to resource logs + _ = Task.Run(async () => + { + while (!process.HasExited && !token.IsCancellationRequested) + { + var line = await process.StandardError.ReadLineAsync(token); + if (line is not null) + { + log.LogInformation("{Line}", line); + } + } + }, token); + + await notification.PublishUpdateAsync(resource, s => s with + { + StartTimeStamp = DateTime.UtcNow, + State = KnownResourceStates.Running, + Properties = + [ + .. s.Properties, + new("terminal.pid", process.Id.ToString(CultureInfo.InvariantCulture)) + ] + }); + + try + { + await process.WaitForExitAsync(token); + } + catch (OperationCanceledException) + { + if (!process.HasExited) + { + process.Kill(entireProcessTree: true); + } + } + + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.Exited, + ExitCode = process.ExitCode + }); + }); + + return resourceBuilder; + } + + private static string FindTerminalHostProject() + { + // Walk up from the AppHost's directory to find the sibling TerminalHost project + var appHostDir = AppContext.BaseDirectory; + var current = new DirectoryInfo(appHostDir); + + while (current is not null) + { + var candidate = Path.Combine(current.FullName, "playground", "Terminals", "Terminals.TerminalHost", "Terminals.TerminalHost.csproj"); + if (File.Exists(candidate)) + { + return candidate; + } + + // Also check sibling directory (for when running from bin output) + var sibling = Path.Combine(current.FullName, "Terminals.TerminalHost", "Terminals.TerminalHost.csproj"); + if (File.Exists(sibling)) + { + return sibling; + } + + current = current.Parent; + } + + // Fallback: assume relative path from working directory + return Path.GetFullPath(Path.Combine("..", "Terminals.TerminalHost", "Terminals.TerminalHost.csproj")); + } +} diff --git a/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj new file mode 100644 index 00000000000..e04b2b4e61b --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj @@ -0,0 +1,23 @@ + + + + Exe + $(DefaultTargetFramework) + enable + enable + true + + + + + + + + + + + + + + + diff --git a/playground/Terminals/Terminals.AppHost/appsettings.Development.json b/playground/Terminals/Terminals.AppHost/appsettings.Development.json new file mode 100644 index 00000000000..31c092aa450 --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/appsettings.Development.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/playground/Terminals/Terminals.AppHost/appsettings.json b/playground/Terminals/Terminals.AppHost/appsettings.json new file mode 100644 index 00000000000..0c208ae9181 --- /dev/null +++ b/playground/Terminals/Terminals.AppHost/appsettings.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/playground/Terminals/Terminals.TerminalHost/Program.cs b/playground/Terminals/Terminals.TerminalHost/Program.cs new file mode 100644 index 00000000000..9296edd480a --- /dev/null +++ b/playground/Terminals/Terminals.TerminalHost/Program.cs @@ -0,0 +1,66 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Hex1b; +using Terminals.TerminalHost; + +// The terminal host process receives configuration via environment variables: +// TERMINAL_SOCKET_PATH — path to the Unix domain socket for client connections +// TERMINAL_COLUMNS — initial terminal width (default: 120) +// TERMINAL_ROWS — initial terminal height (default: 30) +// TERMINAL_SHELL — shell to run (default: platform-specific) + +var socketPath = Environment.GetEnvironmentVariable("TERMINAL_SOCKET_PATH"); +if (string.IsNullOrEmpty(socketPath)) +{ + Console.Error.WriteLine("Error: TERMINAL_SOCKET_PATH environment variable is required."); + return 1; +} + +var columns = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_COLUMNS"), out var c) ? c : 120; +var rows = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_ROWS"), out var r) ? r : 30; +var shell = Environment.GetEnvironmentVariable("TERMINAL_SHELL") + ?? (OperatingSystem.IsWindows() ? "pwsh" : "/bin/bash"); + +Console.Error.WriteLine($"[TerminalHost] Starting: shell={shell}, size={columns}x{rows}, socket={socketPath}"); + +// Create the UDS presentation adapter — this is the "display" side that clients connect to +var adapter = new UnixDomainSocketPresentationAdapter(socketPath, columns, rows); + +using var cts = new CancellationTokenSource(); +Console.CancelKeyPress += (_, e) => +{ + e.Cancel = true; + cts.Cancel(); +}; + +try +{ + // Wait for a client to connect before starting the terminal + await adapter.WaitForClientAsync(cts.Token); + + // Build the Hex1b terminal: + // - WithPresentation: our UDS adapter serves as the display + // - WithPtyProcess: the shell runs as a child process with a real PTY + await using var terminal = Hex1bTerminal.CreateBuilder() + .WithPresentation(adapter) + .WithPtyProcess(shell) + .WithDimensions(columns, rows) + .Build(); + + Console.Error.WriteLine($"[TerminalHost] Terminal running with PID shell"); + + // RunAsync blocks until the shell exits or cancellation + var exitCode = await terminal.RunAsync(cts.Token); + Console.Error.WriteLine($"[TerminalHost] Shell exited with code {exitCode}"); + + // Send EXIT + CLOSE per protocol spec + await adapter.SendExitAsync(exitCode, Aspire.Terminal.TerminalProtocol.ExitReason.Exited, cts.Token); + + return exitCode; +} +catch (OperationCanceledException) +{ + Console.Error.WriteLine("[TerminalHost] Shutting down"); + return 0; +} diff --git a/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj b/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj new file mode 100644 index 00000000000..3bd4fdfc6b9 --- /dev/null +++ b/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj @@ -0,0 +1,20 @@ + + + + Exe + $(DefaultTargetFramework) + enable + enable + + $(NoWarn);CS8002 + + + + + + + + + + + diff --git a/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs b/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs new file mode 100644 index 00000000000..a84fc3f2674 --- /dev/null +++ b/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs @@ -0,0 +1,204 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Terminal; +using Hex1b; + +namespace Terminals.TerminalHost; + +/// +/// A Hex1b presentation adapter that serves terminal I/O over a Unix domain socket +/// using the Aspire Terminal Protocol (see docs/specs/terminal-protocol.md). +/// +internal sealed class UnixDomainSocketPresentationAdapter : IHex1bTerminalPresentationAdapter +{ + private readonly string _socketPath; + private readonly CancellationTokenSource _disposeCts = new(); + private Socket? _serverSocket; + private Socket? _clientSocket; + private NetworkStream? _clientStream; + private TerminalFrameReader? _reader; + private TerminalFrameWriter? _writer; + private bool _disposed; + private bool _helloSent; + + public UnixDomainSocketPresentationAdapter(string socketPath, int width, int height) + { + _socketPath = socketPath; + Width = width; + Height = height; + } + + public int Width { get; private set; } + public int Height { get; private set; } + + public TerminalCapabilities Capabilities => new() + { + SupportsTrueColor = true, + Supports256Colors = true, + SupportsAlternateScreen = true, + SupportsBracketedPaste = true, + }; + + public event Action? Resized; + public event Action? Disconnected; + + /// + /// Starts listening on the UDS and waits for a client to connect. + /// Sends the HELLO frame once connected. + /// + public async Task WaitForClientAsync(CancellationToken ct) + { + // Clean up stale socket + if (File.Exists(_socketPath)) + { + File.Delete(_socketPath); + } + + var socketDir = Path.GetDirectoryName(_socketPath); + if (socketDir is not null) + { + Directory.CreateDirectory(socketDir); + } + + _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); + _serverSocket.Listen(backlog: 1); + + Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); + + _clientSocket = await _serverSocket.AcceptAsync(ct); + _clientStream = new NetworkStream(_clientSocket, ownsSocket: false); + _reader = new TerminalFrameReader(_clientStream); + _writer = new TerminalFrameWriter(_clientStream); + + Console.Error.WriteLine("[TerminalHost] Client connected, sending HELLO"); + + // Send HELLO as the first frame per protocol spec + await _writer.WriteHelloAsync( + (ushort)Width, + (ushort)Height, + TerminalProtocol.HelloFlags.Pty, + ct); + + _helloSent = true; + } + + public async ValueTask WriteOutputAsync(ReadOnlyMemory data, CancellationToken ct = default) + { + if (_disposed || _writer is null || !_helloSent) + { + return; + } + + try + { + await _writer.WriteDataAsync(data, ct); + } + catch (IOException) + { + Disconnected?.Invoke(); + } + catch (SocketException) + { + Disconnected?.Invoke(); + } + } + + public async ValueTask> ReadInputAsync(CancellationToken ct = default) + { + if (_disposed || _reader is null) + { + return ReadOnlyMemory.Empty; + } + + try + { + using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); + var frame = await _reader.ReadFrameAsync(linkedCts.Token); + + if (frame is null) + { + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + return frame.Value.Payload; + + case TerminalProtocol.MessageType.Resize: + var (cols, rows) = frame.Value.ParseResize(); + Width = cols; + Height = rows; + Resized?.Invoke(cols, rows); + return await ReadInputAsync(ct); + + case TerminalProtocol.MessageType.Close: + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + + default: + // Unknown frame type — skip and read next + return await ReadInputAsync(ct); + } + } + catch (OperationCanceledException) + { + return ReadOnlyMemory.Empty; + } + catch (IOException) + { + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + } + } + + public ValueTask FlushAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + + // Raw mode is handled by the client side, not the server + public ValueTask EnterRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + public ValueTask ExitRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + public (int Row, int Column) GetCursorPosition() => (0, 0); + + /// + /// Sends an EXIT frame to the client. + /// + public async ValueTask SendExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) + { + if (_writer is not null && !_disposed) + { + try + { + await _writer.WriteExitAsync(exitCode, reason, ct); + await _writer.WriteCloseAsync(ct); + } + catch { /* best effort */ } + } + } + + public async ValueTask DisposeAsync() + { + if (_disposed) + { + return; + } + + _disposed = true; + await _disposeCts.CancelAsync(); + + _clientStream?.Dispose(); + _clientSocket?.Dispose(); + _serverSocket?.Dispose(); + + if (File.Exists(_socketPath)) + { + try { File.Delete(_socketPath); } + catch { /* ignore cleanup errors */ } + } + + _disposeCts.Dispose(); + } +} diff --git a/src/Shared/Terminal/TerminalFrameReaderWriter.cs b/src/Shared/Terminal/TerminalFrameReaderWriter.cs new file mode 100644 index 00000000000..b5c4ca20031 --- /dev/null +++ b/src/Shared/Terminal/TerminalFrameReaderWriter.cs @@ -0,0 +1,221 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Buffers.Binary; + +namespace Aspire.Terminal; + +/// +/// Reads Aspire Terminal Protocol frames from a stream. +/// See docs/specs/terminal-protocol.md for the full specification. +/// +internal sealed class TerminalFrameReader(Stream stream) +{ + private readonly byte[] _headerBuffer = new byte[TerminalProtocol.FrameHeaderSize]; + + /// + /// Reads the next frame from the stream. Returns null if the stream is closed. + /// + public async ValueTask ReadFrameAsync(CancellationToken ct = default) + { + // Read the 5-byte header + var bytesRead = await ReadExactAsync(_headerBuffer, ct).ConfigureAwait(false); + if (bytesRead == 0) + { + return null; // Stream closed + } + + var type = _headerBuffer[0]; + var payloadLength = (int)BinaryPrimitives.ReadUInt32BigEndian(_headerBuffer.AsSpan(1)); + + if (payloadLength > TerminalProtocol.MaxPayloadSize) + { + throw new InvalidOperationException( + $"Terminal protocol error: payload length {payloadLength} exceeds maximum {TerminalProtocol.MaxPayloadSize}."); + } + + // Read the payload + byte[] payload; + if (payloadLength > 0) + { + payload = new byte[payloadLength]; + var payloadRead = await ReadExactAsync(payload, ct).ConfigureAwait(false); + if (payloadRead == 0) + { + return null; // Stream closed mid-frame + } + } + else + { + payload = []; + } + + return new TerminalFrame(type, payload); + } + + /// + /// Reads exactly .Length bytes, handling partial reads. + /// Returns 0 if the stream is closed before any bytes are read. + /// + private async ValueTask ReadExactAsync(byte[] buffer, CancellationToken ct) + { + var offset = 0; + while (offset < buffer.Length) + { + var read = await stream.ReadAsync(buffer.AsMemory(offset, buffer.Length - offset), ct).ConfigureAwait(false); + if (read == 0) + { + return offset == 0 ? 0 : throw new InvalidOperationException( + "Terminal protocol error: stream closed mid-frame."); + } + + offset += read; + } + + return offset; + } +} + +/// +/// Writes Aspire Terminal Protocol frames to a stream. +/// See docs/specs/terminal-protocol.md for the full specification. +/// +internal sealed class TerminalFrameWriter(Stream stream) +{ + private readonly byte[] _headerBuffer = new byte[TerminalProtocol.FrameHeaderSize]; + + /// + /// Writes a frame to the stream. + /// + public async ValueTask WriteFrameAsync(byte type, ReadOnlyMemory payload, CancellationToken ct = default) + { + if (payload.Length > TerminalProtocol.MaxPayloadSize) + { + throw new ArgumentException( + $"Payload length {payload.Length} exceeds maximum {TerminalProtocol.MaxPayloadSize}.", + nameof(payload)); + } + + _headerBuffer[0] = type; + BinaryPrimitives.WriteUInt32BigEndian(_headerBuffer.AsSpan(1), (uint)payload.Length); + + await stream.WriteAsync(_headerBuffer, ct).ConfigureAwait(false); + + if (payload.Length > 0) + { + await stream.WriteAsync(payload, ct).ConfigureAwait(false); + } + + await stream.FlushAsync(ct).ConfigureAwait(false); + } + + /// + /// Writes a HELLO frame with the specified dimensions and flags. + /// + public ValueTask WriteHelloAsync(ushort cols, ushort rows, TerminalProtocol.HelloFlags flags, CancellationToken ct = default) + { + Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Hello]; + payload[0] = TerminalProtocol.Version; + BinaryPrimitives.WriteUInt16BigEndian(payload[1..], cols); + BinaryPrimitives.WriteUInt16BigEndian(payload[3..], rows); + payload[5] = (byte)flags; + return WriteFrameAsync(TerminalProtocol.MessageType.Hello, payload.ToArray(), ct); + } + + /// + /// Writes a DATA frame with the specified raw terminal bytes. + /// + public ValueTask WriteDataAsync(ReadOnlyMemory data, CancellationToken ct = default) + { + return WriteFrameAsync(TerminalProtocol.MessageType.Data, data, ct); + } + + /// + /// Writes a RESIZE frame with the specified dimensions. + /// + public ValueTask WriteResizeAsync(ushort cols, ushort rows, CancellationToken ct = default) + { + Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Resize]; + BinaryPrimitives.WriteUInt16BigEndian(payload, cols); + BinaryPrimitives.WriteUInt16BigEndian(payload[2..], rows); + return WriteFrameAsync(TerminalProtocol.MessageType.Resize, payload.ToArray(), ct); + } + + /// + /// Writes an EXIT frame with the specified exit code and reason. + /// + public ValueTask WriteExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) + { + Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Exit]; + BinaryPrimitives.WriteInt32BigEndian(payload, exitCode); + payload[4] = (byte)reason; + return WriteFrameAsync(TerminalProtocol.MessageType.Exit, payload.ToArray(), ct); + } + + /// + /// Writes a CLOSE frame. + /// + public ValueTask WriteCloseAsync(CancellationToken ct = default) + { + return WriteFrameAsync(TerminalProtocol.MessageType.Close, ReadOnlyMemory.Empty, ct); + } +} + +/// +/// Represents a single frame in the Aspire Terminal Protocol. +/// +internal readonly record struct TerminalFrame(byte Type, byte[] Payload) +{ + /// + /// Parses the payload as a HELLO message. + /// + public (byte Version, ushort Cols, ushort Rows, TerminalProtocol.HelloFlags Flags) ParseHello() + { + if (Payload.Length < TerminalProtocol.PayloadSize.Hello) + { + throw new InvalidOperationException( + $"Invalid HELLO payload: expected {TerminalProtocol.PayloadSize.Hello} bytes, got {Payload.Length}."); + } + + return ( + Payload[0], + BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(1)), + BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(3)), + (TerminalProtocol.HelloFlags)Payload[5] + ); + } + + /// + /// Parses the payload as a RESIZE message. + /// + public (ushort Cols, ushort Rows) ParseResize() + { + if (Payload.Length < TerminalProtocol.PayloadSize.Resize) + { + throw new InvalidOperationException( + $"Invalid RESIZE payload: expected {TerminalProtocol.PayloadSize.Resize} bytes, got {Payload.Length}."); + } + + return ( + BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(0)), + BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(2)) + ); + } + + /// + /// Parses the payload as an EXIT message. + /// + public (int ExitCode, TerminalProtocol.ExitReason Reason) ParseExit() + { + if (Payload.Length < TerminalProtocol.PayloadSize.Exit) + { + throw new InvalidOperationException( + $"Invalid EXIT payload: expected {TerminalProtocol.PayloadSize.Exit} bytes, got {Payload.Length}."); + } + + return ( + BinaryPrimitives.ReadInt32BigEndian(Payload.AsSpan(0)), + (TerminalProtocol.ExitReason)Payload[4] + ); + } +} diff --git a/src/Shared/Terminal/TerminalProtocol.cs b/src/Shared/Terminal/TerminalProtocol.cs new file mode 100644 index 00000000000..90df23274c9 --- /dev/null +++ b/src/Shared/Terminal/TerminalProtocol.cs @@ -0,0 +1,99 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Terminal; + +/// +/// Constants and types for the Aspire Terminal Protocol. +/// See docs/specs/terminal-protocol.md for the full specification. +/// +internal static class TerminalProtocol +{ + /// + /// Current protocol version. + /// + public const byte Version = 1; + + /// + /// Maximum allowed payload size (1 MiB). + /// + public const int MaxPayloadSize = 1_048_576; + + /// + /// Size of the frame header (1 byte type + 4 bytes length). + /// + public const int FrameHeaderSize = 5; + + /// + /// Frame message types. + /// + public static class MessageType + { + /// Server → Client. First frame on connection with version, dimensions, and flags. + public const byte Hello = 0x01; + + /// Either direction. Raw terminal bytes (PTY output or user input). + public const byte Data = 0x02; + + /// Either direction. Terminal resize notification. + public const byte Resize = 0x03; + + /// Server → Client. Process exited with exit code and reason. + public const byte Exit = 0x04; + + /// Either direction. Graceful session shutdown. + public const byte Close = 0x05; + } + + /// + /// HELLO frame flags. + /// + [Flags] + public enum HelloFlags : byte + { + /// No flags set. + None = 0, + + /// The server has a real PTY allocated. + Pty = 1 << 0, + + /// The server will replay buffered terminal state after HELLO. + Replay = 1 << 1, + } + + /// + /// EXIT frame reason codes. + /// + public enum ExitReason : byte + { + /// Process exited normally. + Exited = 0x00, + + /// Process was killed. + Killed = 0x01, + + /// Server is detaching from the PTY (process may continue). + Detached = 0x02, + + /// Server encountered an unrecoverable error. + Error = 0x03, + } + + /// + /// Fixed payload sizes for structured message types. + /// + public static class PayloadSize + { + /// HELLO: version(1) + cols(2) + rows(2) + flags(1) = 6 bytes. + public const int Hello = 6; + + /// RESIZE: cols(2) + rows(2) = 4 bytes. + public const int Resize = 4; + + /// EXIT: exitCode(4) + reason(1) = 5 bytes. + public const int Exit = 5; + + /// CLOSE: no payload. + public const int Close = 0; + } +} From 0025cd144a4806da406b424289b25a1c0faef105 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 12:01:27 +1000 Subject: [PATCH 03/20] Add terminal protocol test client and verify end-to-end Terminals.Client: Standalone console app that connects to an Aspire Terminal Protocol UDS server, performs the HELLO handshake, puts the local console in raw mode, and bridges stdin/stdout bidirectionally. Supports Ctrl+] to detach. Verified end-to-end: TerminalHost starts pwsh with Hex1b PTY, listens on UDS. Client connects, receives HELLO(v1, 80x24, Pty), and gets a fully interactive PowerShell session with prompt rendering and command execution working correctly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Terminals/Terminals.Client/Program.cs | 158 ++++++++++++++++++ .../Terminals.Client/Terminals.Client.csproj | 14 ++ playground/Terminals/aspire.config.json | 5 + 3 files changed, 177 insertions(+) create mode 100644 playground/Terminals/Terminals.Client/Program.cs create mode 100644 playground/Terminals/Terminals.Client/Terminals.Client.csproj create mode 100644 playground/Terminals/aspire.config.json diff --git a/playground/Terminals/Terminals.Client/Program.cs b/playground/Terminals/Terminals.Client/Program.cs new file mode 100644 index 00000000000..ae3bac6e7aa --- /dev/null +++ b/playground/Terminals/Terminals.Client/Program.cs @@ -0,0 +1,158 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Terminal; + +if (args.Length < 1) +{ + Console.Error.WriteLine("Usage: Terminals.Client "); + Console.Error.WriteLine(); + Console.Error.WriteLine("Connects to an Aspire Terminal Protocol server on the given UDS path."); + Console.Error.WriteLine("Ctrl+] to detach."); + return 1; +} + +var socketPath = args[0]; + +if (!File.Exists(socketPath)) +{ + Console.Error.WriteLine($"Socket not found: {socketPath}"); + return 1; +} + +Console.Error.WriteLine($"Connecting to {socketPath}..."); + +using var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); +await socket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath)); + +await using var stream = new NetworkStream(socket, ownsSocket: false); +var reader = new TerminalFrameReader(stream); +var writer = new TerminalFrameWriter(stream); + +// Read HELLO +var helloFrame = await reader.ReadFrameAsync(); +if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) +{ + Console.Error.WriteLine("Error: did not receive HELLO frame"); + return 1; +} + +var (version, cols, rows, flags) = helloFrame.Value.ParseHello(); +Console.Error.WriteLine($"Connected! Protocol v{version}, {cols}x{rows}, flags={flags}"); +Console.Error.WriteLine("Press Ctrl+] to detach."); +Console.Error.WriteLine(); + +using var cts = new CancellationTokenSource(); + +// Put console in raw mode +var originalMode = Console.TreatControlCAsInput; +Console.TreatControlCAsInput = true; + +try +{ + // Start reading output from server + var outputTask = Task.Run(async () => + { + try + { + while (!cts.Token.IsCancellationRequested) + { + var frame = await reader.ReadFrameAsync(cts.Token); + if (frame is null) + { + break; + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + using (var stdout = Console.OpenStandardOutput()) + { + await stdout.WriteAsync(frame.Value.Payload, cts.Token); + await stdout.FlushAsync(cts.Token); + } + break; + + case TerminalProtocol.MessageType.Exit: + var (exitCode, reason) = frame.Value.ParseExit(); + Console.Error.WriteLine($"\r\n[Terminal exited: code={exitCode}, reason={reason}]"); + await cts.CancelAsync(); + break; + + case TerminalProtocol.MessageType.Close: + Console.Error.WriteLine("\r\n[Server closed connection]"); + await cts.CancelAsync(); + break; + + case TerminalProtocol.MessageType.Resize: + var (newCols, newRows) = frame.Value.ParseResize(); + Console.Error.WriteLine($"\r\n[Server resized to {newCols}x{newRows}]"); + break; + } + } + } + catch (OperationCanceledException) { } + catch (IOException) { } + }, cts.Token); + + // Read input from local console and send to server + var inputTask = Task.Run(async () => + { + try + { + using var stdin = Console.OpenStandardInput(); + var buffer = new byte[256]; + + while (!cts.Token.IsCancellationRequested) + { + var bytesRead = await stdin.ReadAsync(buffer, cts.Token); + if (bytesRead == 0) + { + break; + } + + // Check for Ctrl+] (0x1D) to detach + for (var i = 0; i < bytesRead; i++) + { + if (buffer[i] == 0x1D) // Ctrl+] + { + Console.Error.WriteLine("\r\n[Detached]"); + await writer.WriteCloseAsync(cts.Token); + await cts.CancelAsync(); + return; + } + } + + await writer.WriteDataAsync(buffer.AsMemory(0, bytesRead), cts.Token); + } + } + catch (OperationCanceledException) { } + catch (IOException) { } + }, cts.Token); + + // Send initial resize based on current console size + if (!Console.IsInputRedirected) + { + try + { + await writer.WriteResizeAsync( + (ushort)Console.WindowWidth, + (ushort)Console.WindowHeight, + cts.Token); + } + catch { /* console may not support this */ } + } + + await Task.WhenAny(outputTask, inputTask); + await cts.CancelAsync(); + + try { await Task.WhenAll(outputTask, inputTask); } + catch (OperationCanceledException) { } +} +finally +{ + Console.TreatControlCAsInput = originalMode; +} + +return 0; diff --git a/playground/Terminals/Terminals.Client/Terminals.Client.csproj b/playground/Terminals/Terminals.Client/Terminals.Client.csproj new file mode 100644 index 00000000000..27b4e2982f6 --- /dev/null +++ b/playground/Terminals/Terminals.Client/Terminals.Client.csproj @@ -0,0 +1,14 @@ + + + + Exe + $(DefaultTargetFramework) + enable + enable + + + + + + + diff --git a/playground/Terminals/aspire.config.json b/playground/Terminals/aspire.config.json new file mode 100644 index 00000000000..f8d56eba651 --- /dev/null +++ b/playground/Terminals/aspire.config.json @@ -0,0 +1,5 @@ +{ + "appHost": { + "path": "Terminals.AppHost/Terminals.AppHost.csproj" + } +} \ No newline at end of file From 4715311f94ad3b47441e2ca7b63b52d2ca6f8ea5 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 12:13:19 +1000 Subject: [PATCH 04/20] Add DCP model TerminalSpec, backchannel RPC, and CLI terminal command DCP Model: - TerminalSpec: New model type with enabled, socketPath, columns, rows - Added Terminal property to ExecutableSpec and ContainerSpec - ExecutableCreator populates TerminalSpec from TerminalAnnotation Backchannel: - GetTerminalInfoRequest/Response in BackchannelDataTypes - GetTerminalInfoAsync on AuxiliaryBackchannelRpcTarget (server) - GetTerminalInfoAsync on AppHostAuxiliaryBackchannel (client) - Added to IAppHostAuxiliaryBackchannel interface CLI: - New 'aspire terminal ' command (TerminalCommand.cs) - Connects to AppHost backchannel, gets terminal UDS path - Connects to UDS, performs HELLO handshake - Puts console in raw mode, bridges stdin/stdout bidirectionally - Ctrl+] to detach, handles EXIT/CLOSE frames - Registered in RootCommand and DI container Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.Cli/Aspire.Cli.csproj | 2 + .../AppHostAuxiliaryBackchannel.cs | 27 ++ .../IAppHostAuxiliaryBackchannel.cs | 10 + src/Aspire.Cli/Commands/RootCommand.cs | 2 + src/Aspire.Cli/Commands/TerminalCommand.cs | 259 ++++++++++++++++++ src/Aspire.Cli/Program.cs | 1 + .../AuxiliaryBackchannelRpcTarget.cs | 31 +++ .../Backchannel/BackchannelDataTypes.cs | 41 +++ src/Aspire.Hosting/Dcp/ExecutableCreator.cs | 16 ++ src/Aspire.Hosting/Dcp/Model/Container.cs | 8 + src/Aspire.Hosting/Dcp/Model/Executable.cs | 8 + src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs | 39 +++ 12 files changed, 444 insertions(+) create mode 100644 src/Aspire.Cli/Commands/TerminalCommand.cs create mode 100644 src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs diff --git a/src/Aspire.Cli/Aspire.Cli.csproj b/src/Aspire.Cli/Aspire.Cli.csproj index 887be4f50bb..93fd0e852de 100644 --- a/src/Aspire.Cli/Aspire.Cli.csproj +++ b/src/Aspire.Cli/Aspire.Cli.csproj @@ -131,6 +131,8 @@ + + diff --git a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs index 530e5e207b1..57ebbaf0d67 100644 --- a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs +++ b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs @@ -752,6 +752,33 @@ public async Task WaitForResourceAsync( return response; } + /// + /// Gets terminal information for a resource. + /// + public async Task GetTerminalInfoAsync(string resourceName, CancellationToken cancellationToken = default) + { + if (!SupportsV2) + { + return new GetTerminalInfoResponse { IsAvailable = false }; + } + + var rpc = EnsureConnected(); + + _logger?.LogDebug("Getting terminal info for resource '{ResourceName}'", resourceName); + + var request = new GetTerminalInfoRequest { ResourceName = resourceName }; + + var response = await rpc.InvokeWithCancellationAsync( + "GetTerminalInfoAsync", + [request], + cancellationToken).ConfigureAwait(false); + + _logger?.LogDebug("Terminal info for '{ResourceName}': available={Available}, socket={Socket}", + resourceName, response.IsAvailable, response.SocketPath); + + return response; + } + #endregion /// diff --git a/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs b/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs index 3e48ff9d251..4dff13fae47 100644 --- a/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs +++ b/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs @@ -130,4 +130,14 @@ Task WaitForResourceAsync( string status, int timeoutSeconds, CancellationToken cancellationToken = default); + + /// + /// Gets terminal information for a resource. + /// + /// The resource name. + /// Cancellation token. + /// Terminal information for the resource. + Task GetTerminalInfoAsync( + string resourceName, + CancellationToken cancellationToken = default); } diff --git a/src/Aspire.Cli/Commands/RootCommand.cs b/src/Aspire.Cli/Commands/RootCommand.cs index 5ffec201cbc..38d5d59a788 100644 --- a/src/Aspire.Cli/Commands/RootCommand.cs +++ b/src/Aspire.Cli/Commands/RootCommand.cs @@ -117,6 +117,7 @@ public RootCommand( PsCommand psCommand, DescribeCommand describeCommand, LogsCommand logsCommand, + TerminalCommand terminalCommand, AddCommand addCommand, PublishCommand publishCommand, DeployCommand deployCommand, @@ -209,6 +210,7 @@ public RootCommand( Subcommands.Add(psCommand); Subcommands.Add(describeCommand); Subcommands.Add(logsCommand); + Subcommands.Add(terminalCommand); Subcommands.Add(addCommand); Subcommands.Add(publishCommand); Subcommands.Add(configCommand); diff --git a/src/Aspire.Cli/Commands/TerminalCommand.cs b/src/Aspire.Cli/Commands/TerminalCommand.cs new file mode 100644 index 00000000000..03cf26738f5 --- /dev/null +++ b/src/Aspire.Cli/Commands/TerminalCommand.cs @@ -0,0 +1,259 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.CommandLine; +using System.Globalization; +using System.Net.Sockets; +using Aspire.Cli.Backchannel; +using Aspire.Cli.Configuration; +using Aspire.Cli.Interaction; +using Aspire.Cli.Resources; +using Aspire.Cli.Telemetry; +using Aspire.Cli.Utils; +using Aspire.Terminal; +using Microsoft.Extensions.Logging; + +namespace Aspire.Cli.Commands; + +/// +/// Attaches to an interactive terminal session for a resource. +/// Connects to the resource's terminal UDS using the Aspire Terminal Protocol, +/// puts the local console in raw mode, and bridges stdin/stdout bidirectionally. +/// Press Ctrl+] to detach. +/// +internal sealed class TerminalCommand : BaseCommand +{ + internal override HelpGroup HelpGroup => HelpGroup.Monitoring; + + private readonly IInteractionService _interactionService; + private readonly AppHostConnectionResolver _connectionResolver; + private readonly ILogger _logger; + + private static readonly Argument s_resourceArgument = new("resource") + { + Description = "The name of the resource to attach a terminal to." + }; + + private static readonly OptionWithLegacy s_appHostOption = + new("--apphost", "--project", SharedCommandStrings.AppHostOptionDescription); + + public TerminalCommand( + IInteractionService interactionService, + IAuxiliaryBackchannelMonitor backchannelMonitor, + IFeatures features, + ICliUpdateNotifier updateNotifier, + CliExecutionContext executionContext, + AspireCliTelemetry telemetry, + ILogger logger) + : base("terminal", "Attach to an interactive terminal session for a resource.", features, updateNotifier, executionContext, interactionService, telemetry) + { + _interactionService = interactionService; + _logger = logger; + _connectionResolver = new AppHostConnectionResolver(backchannelMonitor, interactionService, executionContext, logger); + + Arguments.Add(s_resourceArgument); + Options.Add(s_appHostOption); + } + + protected override async Task ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken) + { + using var activity = Telemetry.StartDiagnosticActivity(Name); + + var resourceName = parseResult.GetValue(s_resourceArgument)!; + var passedAppHostProjectFile = parseResult.GetValue(s_appHostOption); + + var result = await _connectionResolver.ResolveConnectionAsync( + passedAppHostProjectFile, + SharedCommandStrings.ScanningForRunningAppHosts, + string.Format(CultureInfo.CurrentCulture, SharedCommandStrings.SelectAppHost, "attach terminal to"), + SharedCommandStrings.AppHostNotRunning, + cancellationToken).ConfigureAwait(false); + + if (!result.Success) + { + _interactionService.DisplayMessage(KnownEmojis.Information, result.ErrorMessage); + return ExitCodeConstants.Success; + } + + var connection = result.Connection!; + + // Get terminal info from the AppHost + var terminalInfo = await connection.GetTerminalInfoAsync(resourceName, cancellationToken).ConfigureAwait(false); + + if (!terminalInfo.IsAvailable || string.IsNullOrEmpty(terminalInfo.SocketPath)) + { + _interactionService.DisplayError($"Terminal is not available for resource '{resourceName}'. Ensure the resource has .WithTerminal() configured."); + return ExitCodeConstants.FailedToDotnetRunAppHost; + } + + _logger.LogDebug("Connecting to terminal at {SocketPath}", terminalInfo.SocketPath); + + // Connect to the terminal UDS + using var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + try + { + await socket.ConnectAsync(new UnixDomainSocketEndPoint(terminalInfo.SocketPath), cancellationToken).ConfigureAwait(false); + } + catch (SocketException ex) + { + _interactionService.DisplayError($"Failed to connect to terminal socket: {ex.Message}"); + return ExitCodeConstants.FailedToDotnetRunAppHost; + } + + await using var stream = new NetworkStream(socket, ownsSocket: false); + var reader = new TerminalFrameReader(stream); + var writer = new TerminalFrameWriter(stream); + + // Read HELLO + var helloFrame = await reader.ReadFrameAsync(cancellationToken).ConfigureAwait(false); + if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) + { + _interactionService.DisplayError("Terminal protocol error: did not receive HELLO frame."); + return ExitCodeConstants.FailedToDotnetRunAppHost; + } + + var (version, cols, rows, flags) = helloFrame.Value.ParseHello(); + _logger.LogDebug("Terminal HELLO: v{Version}, {Cols}x{Rows}, flags={Flags}", version, cols, rows, flags); + + _interactionService.DisplayMessage(KnownEmojis.Gear, $"Connected to terminal for '{resourceName}' ({cols}x{rows}). Press Ctrl+] to detach."); + + // Enter raw mode and bridge I/O + var originalControlC = Console.TreatControlCAsInput; + Console.TreatControlCAsInput = true; + + try + { + using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); + + // Send initial resize + if (!Console.IsInputRedirected) + { + try + { + await writer.WriteResizeAsync( + (ushort)Console.WindowWidth, + (ushort)Console.WindowHeight, + cts.Token).ConfigureAwait(false); + } + catch + { + // Console may not support dimensions + } + } + + var outputTask = ReadOutputAsync(reader, cts); + var inputTask = ReadInputAsync(writer, cts); + + await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); + await cts.CancelAsync().ConfigureAwait(false); + + try + { + await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + // Expected + } + } + finally + { + Console.TreatControlCAsInput = originalControlC; + } + + return ExitCodeConstants.Success; + } + + private static async Task ReadOutputAsync(TerminalFrameReader reader, CancellationTokenSource cts) + { + try + { + while (!cts.Token.IsCancellationRequested) + { + var frame = await reader.ReadFrameAsync(cts.Token).ConfigureAwait(false); + if (frame is null) + { + break; + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + using (var stdout = Console.OpenStandardOutput()) + { + await stdout.WriteAsync(frame.Value.Payload, cts.Token).ConfigureAwait(false); + await stdout.FlushAsync(cts.Token).ConfigureAwait(false); + } + break; + + case TerminalProtocol.MessageType.Exit: + var (exitCode, reason) = frame.Value.ParseExit(); + Console.Error.WriteLine($"\r\n[Process exited: code={exitCode}, reason={reason}]"); + await cts.CancelAsync().ConfigureAwait(false); + return; + + case TerminalProtocol.MessageType.Close: + Console.Error.WriteLine("\r\n[Server closed connection]"); + await cts.CancelAsync().ConfigureAwait(false); + return; + } + } + } + catch (OperationCanceledException) + { + // Expected + } + catch (IOException) + { + // Disconnected + } + } + + private static async Task ReadInputAsync(TerminalFrameWriter writer, CancellationTokenSource cts) + { + try + { + using var stdin = Console.OpenStandardInput(); + var buffer = new byte[256]; + + while (!cts.Token.IsCancellationRequested) + { + var bytesRead = await stdin.ReadAsync(buffer, cts.Token).ConfigureAwait(false); + if (bytesRead == 0) + { + break; + } + + // Check for Ctrl+] (0x1D) to detach + for (var i = 0; i < bytesRead; i++) + { + if (buffer[i] == 0x1D) + { + Console.Error.WriteLine("\r\n[Detached]"); + try + { + await writer.WriteCloseAsync(cts.Token).ConfigureAwait(false); + } + catch + { + // Best effort + } + + await cts.CancelAsync().ConfigureAwait(false); + return; + } + } + + await writer.WriteDataAsync(buffer.AsMemory(0, bytesRead), cts.Token).ConfigureAwait(false); + } + } + catch (OperationCanceledException) + { + // Expected + } + catch (IOException) + { + // Disconnected + } + } +} diff --git a/src/Aspire.Cli/Program.cs b/src/Aspire.Cli/Program.cs index 6ecbb21a419..f19033e205a 100644 --- a/src/Aspire.Cli/Program.cs +++ b/src/Aspire.Cli/Program.cs @@ -463,6 +463,7 @@ internal static async Task BuildApplicationAsync(string[] args, CliStartu builder.Services.AddTransient(); builder.Services.AddTransient(); builder.Services.AddTransient(); + builder.Services.AddTransient(); builder.Services.AddTransient(); builder.Services.AddTransient(); builder.Services.AddTransient(); diff --git a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs index e0fa2747212..73cfc0e372f 100644 --- a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs +++ b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs @@ -240,6 +240,37 @@ public async Task ExecuteResourceCommandAsync(Ex }; } + /// + /// Gets terminal information for a resource. + /// + public Task GetTerminalInfoAsync(GetTerminalInfoRequest request, CancellationToken cancellationToken = default) + { + _ = cancellationToken; // Required by RPC contract + ArgumentNullException.ThrowIfNull(request); + + var appModel = serviceProvider.GetRequiredService(); + var resource = appModel.Resources.FirstOrDefault(r => string.Equals(r.Name, request.ResourceName, StringComparisons.ResourceName)); + + if (resource is null) + { + return Task.FromResult(new GetTerminalInfoResponse { IsAvailable = false }); + } + + var terminalAnnotation = resource.Annotations.OfType().FirstOrDefault(); + if (terminalAnnotation is null) + { + return Task.FromResult(new GetTerminalInfoResponse { IsAvailable = false }); + } + + return Task.FromResult(new GetTerminalInfoResponse + { + IsAvailable = !string.IsNullOrEmpty(terminalAnnotation.SocketPath), + SocketPath = terminalAnnotation.SocketPath, + Columns = terminalAnnotation.Options.Columns, + Rows = terminalAnnotation.Options.Rows + }); + } + /// /// Waits for a resource to reach a target status. /// diff --git a/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs b/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs index 43cf58efcd5..00c7c7ce0ea 100644 --- a/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs +++ b/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs @@ -1112,3 +1112,44 @@ internal sealed class ResourceLogLine /// public bool IsError { get; init; } } + +#region Terminal + +/// +/// Request for getting terminal information for a resource. +/// +internal sealed class GetTerminalInfoRequest +{ + /// + /// Gets the resource name. + /// + public required string ResourceName { get; init; } +} + +/// +/// Response containing terminal information for a resource. +/// +internal sealed class GetTerminalInfoResponse +{ + /// + /// Gets whether terminal access is available for this resource. + /// + public required bool IsAvailable { get; init; } + + /// + /// Gets the UDS socket path for terminal I/O, if available. + /// + public string? SocketPath { get; init; } + + /// + /// Gets the current terminal width in columns. + /// + public int Columns { get; init; } + + /// + /// Gets the current terminal height in rows. + /// + public int Rows { get; init; } +} + +#endregion diff --git a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs index b4748737ded..5200e2ee008 100644 --- a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs +++ b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs @@ -105,6 +105,22 @@ public async Task CreateObjectAsync(RenderedModelResource er, EmptyC spec.Env = configuration.EnvironmentVariables.Select(kvp => new EnvVar { Name = kvp.Key, Value = kvp.Value }).ToList(); + // Configure terminal spec if the resource has a TerminalAnnotation + if (er.ModelResource.TryGetAnnotationsOfType(out var terminalAnnotations)) + { + var terminalAnnotation = terminalAnnotations.FirstOrDefault(); + if (terminalAnnotation is not null) + { + spec.Terminal = new TerminalSpec + { + Enabled = true, + SocketPath = terminalAnnotation.SocketPath, + Columns = terminalAnnotation.Options.Columns, + Rows = terminalAnnotation.Options.Rows + }; + } + } + if (configuration.Exception is not null) { throw new FailedToApplyEnvironmentException(); diff --git a/src/Aspire.Hosting/Dcp/Model/Container.cs b/src/Aspire.Hosting/Dcp/Model/Container.cs index 7a9279632f7..0c0f4314f56 100644 --- a/src/Aspire.Hosting/Dcp/Model/Container.cs +++ b/src/Aspire.Hosting/Dcp/Model/Container.cs @@ -95,6 +95,14 @@ internal sealed class ContainerSpec // List of public PEM certificates to be trusted by the container [JsonPropertyName("pemCertificates")] public ContainerPemCertificates? PemCertificates { get; set; } + + /// + /// Terminal configuration for interactive PTY access. + /// When set, DCP allocates a pseudo-terminal for the container and forwards + /// I/O over a Unix domain socket using the Aspire Terminal Protocol. + /// + [JsonPropertyName("terminal")] + public TerminalSpec? Terminal { get; set; } } internal sealed class BuildContext diff --git a/src/Aspire.Hosting/Dcp/Model/Executable.cs b/src/Aspire.Hosting/Dcp/Model/Executable.cs index e56e3f38217..41af8caa7f3 100644 --- a/src/Aspire.Hosting/Dcp/Model/Executable.cs +++ b/src/Aspire.Hosting/Dcp/Model/Executable.cs @@ -75,6 +75,14 @@ internal sealed class ExecutableSpec /// [JsonPropertyName("pemCertificates")] public ExecutablePemCertificates? PemCertificates { get; set; } + + /// + /// Terminal configuration for interactive PTY access. + /// When set, DCP allocates a pseudo-terminal for the process and forwards + /// I/O over a Unix domain socket using the Aspire Terminal Protocol. + /// + [JsonPropertyName("terminal")] + public TerminalSpec? Terminal { get; set; } } internal sealed class AmbientEnvironment diff --git a/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs b/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs new file mode 100644 index 00000000000..cae29d6f733 --- /dev/null +++ b/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs @@ -0,0 +1,39 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Text.Json.Serialization; + +namespace Aspire.Hosting.Dcp.Model; + +/// +/// Terminal configuration for a DCP resource. When present, DCP allocates a pseudo-terminal +/// and forwards I/O over a Unix domain socket using the Aspire Terminal Protocol. +/// +internal sealed class TerminalSpec +{ + /// + /// Whether terminal (PTY) mode is enabled for this resource. + /// When true, DCP allocates a pseudo-terminal instead of pipes for the process I/O. + /// + [JsonPropertyName("enabled")] + public bool Enabled { get; set; } + + /// + /// Path to the Unix domain socket where DCP will serve the Aspire Terminal Protocol. + /// If not specified, DCP will generate a path and report it in the resource status. + /// + [JsonPropertyName("socketPath")] + public string? SocketPath { get; set; } + + /// + /// Initial terminal width in columns. + /// + [JsonPropertyName("columns")] + public int Columns { get; set; } = 120; + + /// + /// Initial terminal height in rows. + /// + [JsonPropertyName("rows")] + public int Rows { get; set; } = 30; +} From b93f7e86130d82e2cf8ba6fc6f401a3885824d02 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 12:15:24 +1000 Subject: [PATCH 05/20] Add WithTerminal custom socket path provider overload MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a second WithTerminal overload that accepts a Func> socketPathProvider for resources that manage their own terminal server (e.g., remote SSH, cloud resources). Unlike the standard overload, this does NOT create a hidden TerminalHostResource — the caller is responsible for running a server that speaks the Aspire Terminal Protocol on the provided socket path. Also adds SocketPathProvider property to TerminalAnnotation and two new tests (10 total, all passing). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../ApplicationModel/TerminalAnnotation.cs | 13 ++++- .../TerminalResourceBuilderExtensions.cs | 50 +++++++++++++++++++ .../Aspire.Hosting.Tests/WithTerminalTests.cs | 38 ++++++++++++++ 3 files changed, 100 insertions(+), 1 deletion(-) diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs index 6f9e46883fa..e2eab39ada1 100644 --- a/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs +++ b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs @@ -19,11 +19,22 @@ public sealed class TerminalAnnotation : IResourceAnnotation /// Gets or sets the path to the Unix domain socket used for terminal I/O. /// /// - /// This path is set by the orchestrator when the terminal host is started. + /// This path is set by the orchestrator when the terminal host is started, + /// or resolved from for custom terminal resources. /// Clients connect to this socket to interact with the resource's terminal session. /// public string? SocketPath { get; set; } + /// + /// Gets or sets an optional callback that provides the UDS socket path. + /// + /// + /// Used by custom terminal resources that manage their own terminal server. + /// When set, the orchestrator calls this during resource initialization to obtain the socket path + /// instead of creating a hidden terminal host resource. + /// + public Func>? SocketPathProvider { get; set; } + /// /// Gets the terminal options for this annotation. /// diff --git a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs index 689c27fc5d4..22574787c16 100644 --- a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs +++ b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs @@ -67,6 +67,56 @@ public static IResourceBuilder WithTerminal(this IResourceBuilder build return builder; } + /// + /// Configures a resource with a custom terminal socket path provider. + /// + /// The type of the resource. + /// The resource builder. + /// + /// A callback that returns the UDS path for the terminal session. This is called during resource + /// initialization. Use this overload for resources that manage their own terminal host process + /// (e.g., remote resources, SSH sessions, or custom terminal bridges). + /// + /// An optional callback to configure the terminal options. + /// A reference to the for chaining additional configuration. + /// + /// Unlike the parameterless overload, + /// this method does not create a hidden terminal host resource. The caller is responsible for ensuring + /// a terminal server is listening on the provided socket path and speaking the Aspire Terminal Protocol. + /// + /// + /// Add terminal support with a custom socket path: + /// + /// var agent = builder.AddResource(new MyCustomResource("agent")) + /// .WithTerminal(ct => Task.FromResult("/tmp/my-terminal.sock")); + /// + /// + [AspireExportIgnore(Reason = "Func delegate parameter is not ATS-compatible.")] + public static IResourceBuilder WithTerminal( + this IResourceBuilder builder, + Func> socketPathProvider, + Action? configure = null) + where T : IResource + { + ArgumentNullException.ThrowIfNull(builder); + ArgumentNullException.ThrowIfNull(socketPathProvider); + + var options = new TerminalOptions(); + configure?.Invoke(options); + + var annotation = new TerminalAnnotation + { + Options = options, + SocketPathProvider = socketPathProvider + }; + + builder.WithAnnotation(annotation); + + // No hidden terminal host resource — the caller manages the terminal server. + + return builder; + } + private static void AddTerminalHostResource(IResourceBuilder builder) where T : IResource { diff --git a/tests/Aspire.Hosting.Tests/WithTerminalTests.cs b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs index 563e189d9ca..41fc81338f5 100644 --- a/tests/Aspire.Hosting.Tests/WithTerminalTests.cs +++ b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs @@ -129,4 +129,42 @@ public void WithTerminalThrowsForNullBuilder() Assert.Throws(() => builder.WithTerminal()); } + + [Fact] + public void WithTerminalCustomSocketPathDoesNotCreateTerminalHostResource() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(_ => Task.FromResult("/tmp/my-socket.sock")); + + var app = builder.Build(); + var model = app.Services.GetRequiredService(); + + // Custom socket path provider should NOT create a hidden terminal host + var terminalHost = model.Resources.OfType().SingleOrDefault(); + Assert.Null(terminalHost); + + // But the annotation should be present with the provider + var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(annotation); + Assert.NotNull(annotation.SocketPathProvider); + } + + [Fact] + public async Task WithTerminalCustomSocketPathProviderReturnsPath() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + var expectedPath = "/tmp/custom-terminal.sock"; + + resource.WithTerminal(_ => Task.FromResult(expectedPath)); + + var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); + Assert.NotNull(annotation); + Assert.NotNull(annotation.SocketPathProvider); + + var actualPath = await annotation.SocketPathProvider(CancellationToken.None); + Assert.Equal(expectedPath, actualPath); + } } From cb683256ecc03c301d4164ad651b1dcc30c4bb6f Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 12:46:13 +1000 Subject: [PATCH 06/20] Add Dashboard terminal support: xterm.js, WebSocket proxy, ConsoleLogs integration Dashboard terminal view that replaces Console Logs for terminal-enabled resources: - TerminalView.razor: Blazor component wrapping xterm.js via JS interop - TerminalView.razor.js: xterm.js initialization, WebSocket connection, resize handling - TerminalWebSocketProxy.cs: ASP.NET Core middleware at /api/terminal that bridges browser WebSocket to UDS using the Aspire Terminal Protocol (HELLO/DATA/RESIZE/EXIT/CLOSE) - Vendored xterm.js 5.5.0 + fit addon in wwwroot/js/xterm/ ConsoleLogs integration: - ConsoleLogs.razor: Conditionally renders TerminalView instead of LogViewer when the selected resource has terminal.enabled property - ConsoleLogs.razor.cs: Detects terminal resources in SubscribeAsync, skips console log subscription for terminal resources Infrastructure: - KnownProperties.Terminal.Enabled/SocketPath constants in shared model - DashboardServiceData: Injects terminal.enabled and terminal.socketPath properties into resource snapshots when TerminalAnnotation is present - ResourceViewModelExtensions: HasTerminal() and TryGetTerminalSocketPath() Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.Dashboard/Aspire.Dashboard.csproj | 2 + .../Components/Controls/TerminalView.razor | 3 + .../Components/Controls/TerminalView.razor.cs | 100 +++++++++ .../Components/Controls/TerminalView.razor.js | 131 +++++++++++ .../Components/Pages/ConsoleLogs.razor | 21 +- .../Components/Pages/ConsoleLogs.razor.cs | 23 ++ .../DashboardWebApplication.cs | 5 + .../Model/ResourceViewModelExtensions.cs | 16 ++ .../Terminal/TerminalWebSocketProxy.cs | 204 ++++++++++++++++++ .../wwwroot/js/xterm/addon-fit.min.js | 8 + .../wwwroot/js/xterm/xterm.min.css | 8 + .../wwwroot/js/xterm/xterm.min.js | 8 + .../Dashboard/DashboardServiceData.cs | 22 ++ src/Shared/Model/KnownProperties.cs | 6 + 14 files changed, 550 insertions(+), 7 deletions(-) create mode 100644 src/Aspire.Dashboard/Components/Controls/TerminalView.razor create mode 100644 src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs create mode 100644 src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js create mode 100644 src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs create mode 100644 src/Aspire.Dashboard/wwwroot/js/xterm/addon-fit.min.js create mode 100644 src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.css create mode 100644 src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.js diff --git a/src/Aspire.Dashboard/Aspire.Dashboard.csproj b/src/Aspire.Dashboard/Aspire.Dashboard.csproj index a7f23195565..df741ce8856 100644 --- a/src/Aspire.Dashboard/Aspire.Dashboard.csproj +++ b/src/Aspire.Dashboard/Aspire.Dashboard.csproj @@ -294,6 +294,8 @@ + + diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor new file mode 100644 index 00000000000..192288e2039 --- /dev/null +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor @@ -0,0 +1,3 @@ +@namespace Aspire.Dashboard.Components.Controls + +
diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs new file mode 100644 index 00000000000..b0abbd38a06 --- /dev/null +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs @@ -0,0 +1,100 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Dashboard.Utils; +using Microsoft.AspNetCore.Components; +using Microsoft.JSInterop; + +namespace Aspire.Dashboard.Components.Controls; + +/// +/// Renders an interactive terminal using xterm.js, connected to the resource's +/// terminal session via WebSocket → Aspire Terminal Protocol over UDS. +/// +public sealed partial class TerminalView : ComponentBase, IAsyncDisposable +{ + private ElementReference _terminalElement; + private IJSObjectReference? _jsModule; + private IJSObjectReference? _terminalInstance; + + [Parameter] + public string? SocketPath { get; set; } + + [Inject] + public required IJSRuntime JS { get; init; } + + [Inject] + public required NavigationManager NavigationManager { get; init; } + + protected override async Task OnAfterRenderAsync(bool firstRender) + { + if (firstRender && SocketPath is not null) + { + await InitializeTerminalAsync(); + } + } + + private async Task InitializeTerminalAsync() + { + try + { + _jsModule = await JS.InvokeAsync( + "import", "/Components/Controls/TerminalView.razor.js"); + + // Build the WebSocket URL for the terminal proxy. + // The Dashboard exposes a WebSocket endpoint at /api/terminal?socketPath=... + var baseUri = new Uri(NavigationManager.BaseUri); + var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; + var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(SocketPath!)}"; + + _terminalInstance = await _jsModule.InvokeAsync( + "initTerminal", _terminalElement, wsUrl); + } + catch (JSDisconnectedException) + { + // Component disposed during initialization + } + } + + /// + /// Called when the socket path changes (e.g., resource selection changes). + /// + public async Task ReconnectAsync(string? newSocketPath) + { + if (_jsModule is null || _terminalInstance is null) + { + SocketPath = newSocketPath; + if (newSocketPath is not null) + { + await InitializeTerminalAsync(); + } + return; + } + + if (newSocketPath is null) + { + await _jsModule.InvokeVoidAsync("disposeTerminal", _terminalInstance); + _terminalInstance = null; + return; + } + + SocketPath = newSocketPath; + var baseUri = new Uri(NavigationManager.BaseUri); + var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; + var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(newSocketPath)}"; + + await _jsModule.InvokeVoidAsync("reconnectTerminal", _terminalInstance, wsUrl); + } + + public async ValueTask DisposeAsync() + { + if (_terminalInstance is not null) + { + await JSInteropHelpers.SafeDisposeAsync(_terminalInstance); + } + if (_jsModule is not null) + { + await JSInteropHelpers.SafeDisposeAsync(_jsModule); + } + } +} diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js new file mode 100644 index 00000000000..caffbb99de6 --- /dev/null +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js @@ -0,0 +1,131 @@ +// xterm.js terminal integration for the Aspire Dashboard. +// Connects to the Dashboard's WebSocket proxy which bridges to the +// resource's UDS using the Aspire Terminal Protocol. + +let Terminal, FitAddon; + +async function loadXterm() { + if (!Terminal) { + const xtermModule = await import('/js/xterm/xterm.min.js'); + Terminal = xtermModule.Terminal; + const fitModule = await import('/js/xterm/addon-fit.min.js'); + FitAddon = fitModule.FitAddon; + + // Inject xterm.css if not already present + if (!document.querySelector('link[href*="xterm.min.css"]')) { + const link = document.createElement('link'); + link.rel = 'stylesheet'; + link.href = '/js/xterm/xterm.min.css'; + document.head.appendChild(link); + } + } +} + +export async function initTerminal(element, wsUrl) { + await loadXterm(); + + const fitAddon = new FitAddon(); + const term = new Terminal({ + cursorBlink: true, + fontSize: 14, + fontFamily: '"Cascadia Code", "Cascadia Mono", Menlo, Monaco, "Courier New", monospace', + theme: { + background: '#1e1e1e', + foreground: '#d4d4d4', + cursor: '#d4d4d4', + }, + allowProposedApi: true, + }); + + term.loadAddon(fitAddon); + term.open(element); + fitAddon.fit(); + + // Connect WebSocket + const state = { ws: null, term, fitAddon, element }; + connectWebSocket(state, wsUrl); + + // Handle terminal resize + const resizeObserver = new ResizeObserver(() => { + fitAddon.fit(); + }); + resizeObserver.observe(element); + + term.onResize(({ cols, rows }) => { + if (state.ws && state.ws.readyState === WebSocket.OPEN) { + // Send resize as JSON message (the proxy translates to protocol RESIZE frame) + state.ws.send(JSON.stringify({ type: 'resize', cols, rows })); + } + }); + + // Handle user input + term.onData((data) => { + if (state.ws && state.ws.readyState === WebSocket.OPEN) { + state.ws.send(data); + } + }); + + // Handle binary input + term.onBinary((data) => { + if (state.ws && state.ws.readyState === WebSocket.OPEN) { + const buffer = new Uint8Array(data.length); + for (let i = 0; i < data.length; i++) { + buffer[i] = data.charCodeAt(i); + } + state.ws.send(buffer); + } + }); + + state._resizeObserver = resizeObserver; + return state; +} + +function connectWebSocket(state, wsUrl) { + const ws = new WebSocket(wsUrl); + ws.binaryType = 'arraybuffer'; + + ws.onopen = () => { + state.term.clear(); + state.fitAddon.fit(); + }; + + ws.onmessage = (event) => { + if (event.data instanceof ArrayBuffer) { + state.term.write(new Uint8Array(event.data)); + } else { + state.term.write(event.data); + } + }; + + ws.onclose = () => { + state.term.write('\r\n\x1b[1;33m[Terminal disconnected]\x1b[0m\r\n'); + }; + + ws.onerror = () => { + state.term.write('\r\n\x1b[1;31m[Terminal connection error]\x1b[0m\r\n'); + }; + + state.ws = ws; +} + +export function reconnectTerminal(state, wsUrl) { + if (state.ws) { + state.ws.onclose = null; // prevent disconnect message + state.ws.close(); + } + state.term.clear(); + connectWebSocket(state, wsUrl); +} + +export function disposeTerminal(state) { + if (state._resizeObserver) { + state._resizeObserver.disconnect(); + } + if (state.ws) { + state.ws.onclose = null; + state.ws.close(); + } + if (state.term) { + state.term.dispose(); + } +} diff --git a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor index e6f2b0dbfec..e2d72097edb 100644 --- a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor +++ b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor @@ -104,13 +104,20 @@ - + @if (_selectedResourceHasTerminal && _terminalSocketPath is not null) + { + + } + else + { + + } diff --git a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs index e7dd978d66b..7d8685f4aec 100644 --- a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs +++ b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs @@ -158,6 +158,9 @@ private record struct LogEntryToWrite(string ResourceName, LogEntry LogEntry, in private readonly object _updateLogsLock = new object(); private AIContext? _aiContext; private LogViewer? _logViewerRef; + private Controls.TerminalView? _terminalViewRef; + private bool _selectedResourceHasTerminal; + private string? _terminalSocketPath; // UI private SelectViewModel _allResource = null!; @@ -394,6 +397,26 @@ private async Task SubscribeAsync(bool isAllSelected, string? selectedResourceNa Logger.LogDebug("Subscription change needed. IsAllSelected: {IsAllSelected}, SelectedResource: {SelectedResource}", isAllSelected, selectedResourceName); _aiContext?.ContextHasChanged(); + // Detect whether the selected resource has terminal support + _selectedResourceHasTerminal = false; + _terminalSocketPath = null; + + if (!isAllSelected && selectedResourceName is not null && + _resourceByName.TryGetValue(selectedResourceName, out var selectedResource) && + selectedResource.HasTerminal() && + selectedResource.TryGetTerminalSocketPath(out var socketPath)) + { + _selectedResourceHasTerminal = true; + _terminalSocketPath = socketPath; + Logger.LogDebug("Resource '{ResourceName}' has terminal at {SocketPath}", selectedResourceName, socketPath); + + // Don't subscribe to console logs for terminal resources — + // the terminal view replaces the log viewer. + await CancelAllSubscriptionsAsync(); + _isSubscribedToAll = false; + return; + } + // Cancel all existing subscriptions await CancelAllSubscriptionsAsync(); diff --git a/src/Aspire.Dashboard/DashboardWebApplication.cs b/src/Aspire.Dashboard/DashboardWebApplication.cs index d80e031cd98..a221f340ab1 100644 --- a/src/Aspire.Dashboard/DashboardWebApplication.cs +++ b/src/Aspire.Dashboard/DashboardWebApplication.cs @@ -23,6 +23,7 @@ using Aspire.Dashboard.Otlp.Http; using Aspire.Dashboard.Otlp.Storage; using Aspire.Dashboard.Telemetry; +using Aspire.Dashboard.Terminal; using Aspire.Dashboard.Utils; using Aspire.Hosting; using Microsoft.AspNetCore.Authentication; @@ -508,9 +509,13 @@ public DashboardWebApplication( _app.UseMiddleware(); _app.UseAntiforgery(); + _app.UseWebSockets(); _app.MapRazorComponents().AddInteractiveServerRenderMode(); + // Terminal WebSocket proxy + _app.MapTerminalWebSocket(); + // OTLP HTTP services. _app.MapHttpOtlpApi(dashboardOptions.Otlp); diff --git a/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs b/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs index 3a902c36928..02c893c59da 100644 --- a/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs +++ b/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs @@ -99,6 +99,22 @@ public static bool TryGetAppArgsSensitivity(this ResourceViewModel resource, out return resource.TryGetCustomDataBoolArray(KnownProperties.Resource.AppArgsSensitivity, out argParams); } + /// + /// Returns true if the resource has an interactive terminal session available. + /// + public static bool HasTerminal(this ResourceViewModel resource) + { + return resource.Properties.ContainsKey(KnownProperties.Terminal.Enabled); + } + + /// + /// Tries to get the terminal socket path for the resource. + /// + public static bool TryGetTerminalSocketPath(this ResourceViewModel resource, [NotNullWhen(returnValue: true)] out string? socketPath) + { + return resource.TryGetCustomDataString(KnownProperties.Terminal.SocketPath, out socketPath); + } + private static bool TryGetCustomDataString(this ResourceViewModel resource, string key, [NotNullWhen(returnValue: true)] out string? s) { if (resource.Properties.TryGetValue(key, out var property) && property.Value.TryConvertToString(out var valueString)) diff --git a/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs new file mode 100644 index 00000000000..2fb8d096673 --- /dev/null +++ b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs @@ -0,0 +1,204 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#pragma warning disable CA2007 // Consider calling ConfigureAwait +using System.Net.Sockets; +using System.Net.WebSockets; +using System.Text; +using System.Text.Json; +using Aspire.Terminal; + +namespace Aspire.Dashboard.Terminal; + +/// +/// ASP.NET Core middleware that proxies WebSocket connections from the browser +/// to a Unix domain socket speaking the Aspire Terminal Protocol. +/// +internal static class TerminalWebSocketProxy +{ + /// + /// Maps the terminal WebSocket endpoint at /api/terminal. + /// + public static void MapTerminalWebSocket(this WebApplication app) + { + app.Map("/api/terminal", async (HttpContext context) => + { + if (!context.WebSockets.IsWebSocketRequest) + { + context.Response.StatusCode = 400; + await context.Response.WriteAsync("WebSocket connection required."); + return; + } + + var socketPath = context.Request.Query["socketPath"].FirstOrDefault(); + if (string.IsNullOrEmpty(socketPath)) + { + context.Response.StatusCode = 400; + await context.Response.WriteAsync("socketPath query parameter is required."); + return; + } + + if (!File.Exists(socketPath)) + { + context.Response.StatusCode = 404; + await context.Response.WriteAsync("Terminal socket not found."); + return; + } + + var webSocket = await context.WebSockets.AcceptWebSocketAsync(); + await ProxyTerminalAsync(webSocket, socketPath, context.RequestAborted); + }); + } + + private static async Task ProxyTerminalAsync(WebSocket webSocket, string socketPath, CancellationToken ct) + { + using var udsSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + try + { + await udsSocket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath), ct); + } + catch (SocketException) + { + await webSocket.CloseAsync(WebSocketCloseStatus.EndpointUnavailable, "Cannot connect to terminal socket", ct); + return; + } + + await using var udsStream = new NetworkStream(udsSocket, ownsSocket: false); + var reader = new TerminalFrameReader(udsStream); + var writer = new TerminalFrameWriter(udsStream); + + // Read HELLO from UDS + var helloFrame = await reader.ReadFrameAsync(ct); + if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) + { + await webSocket.CloseAsync(WebSocketCloseStatus.ProtocolError, "No HELLO from terminal", ct); + return; + } + + // Parse HELLO but don't send it to the browser — xterm.js doesn't need it + var (_, cols, rows, _) = helloFrame.Value.ParseHello(); + + using var cts = CancellationTokenSource.CreateLinkedTokenSource(ct); + + // UDS → WebSocket (terminal output to browser) + var outputTask = Task.Run(async () => + { + try + { + while (!cts.Token.IsCancellationRequested) + { + var frame = await reader.ReadFrameAsync(cts.Token).ConfigureAwait(false); + if (frame is null) + { + break; + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + await webSocket.SendAsync( + frame.Value.Payload, + WebSocketMessageType.Binary, + endOfMessage: true, + cts.Token).ConfigureAwait(false); + break; + + case TerminalProtocol.MessageType.Exit: + case TerminalProtocol.MessageType.Close: + await cts.CancelAsync().ConfigureAwait(false); + return; + } + } + } + catch (OperationCanceledException) { } + catch (WebSocketException) { } + catch (IOException) { } + }, cts.Token); + + // WebSocket → UDS (browser input to terminal) + var inputTask = Task.Run(async () => + { + var buffer = new byte[4096]; + try + { + while (!cts.Token.IsCancellationRequested) + { + var result = await webSocket.ReceiveAsync(buffer, cts.Token).ConfigureAwait(false); + + if (result.MessageType == WebSocketMessageType.Close) + { + await writer.WriteCloseAsync(cts.Token).ConfigureAwait(false); + await cts.CancelAsync().ConfigureAwait(false); + return; + } + + if (result.MessageType == WebSocketMessageType.Text) + { + // Check for JSON resize message from xterm.js + var text = Encoding.UTF8.GetString(buffer, 0, result.Count); + if (TryParseResize(text, out var newCols, out var newRows)) + { + await writer.WriteResizeAsync((ushort)newCols, (ushort)newRows, cts.Token).ConfigureAwait(false); + continue; + } + + // Text input — convert to bytes and send as DATA + var inputBytes = Encoding.UTF8.GetBytes(text); + await writer.WriteDataAsync(inputBytes, cts.Token).ConfigureAwait(false); + } + else + { + // Binary input + await writer.WriteDataAsync( + buffer.AsMemory(0, result.Count), + cts.Token).ConfigureAwait(false); + } + } + } + catch (OperationCanceledException) { } + catch (WebSocketException) { } + catch (IOException) { } + }, cts.Token); + + await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); + await cts.CancelAsync().ConfigureAwait(false); + + try { await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); } + catch (OperationCanceledException) { } + + if (webSocket.State == WebSocketState.Open) + { + try + { + await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Terminal closed", CancellationToken.None); + } + catch { /* best effort */ } + } + } + + private static bool TryParseResize(string text, out int cols, out int rows) + { + cols = 0; + rows = 0; + + try + { + using var doc = JsonDocument.Parse(text); + if (doc.RootElement.TryGetProperty("type", out var typeEl) && + typeEl.GetString() == "resize" && + doc.RootElement.TryGetProperty("cols", out var colsEl) && + doc.RootElement.TryGetProperty("rows", out var rowsEl)) + { + cols = colsEl.GetInt32(); + rows = rowsEl.GetInt32(); + return true; + } + } + catch (JsonException) + { + // Not JSON, treat as text input + } + + return false; + } +} diff --git a/src/Aspire.Dashboard/wwwroot/js/xterm/addon-fit.min.js b/src/Aspire.Dashboard/wwwroot/js/xterm/addon-fit.min.js new file mode 100644 index 00000000000..9f4e48c182e --- /dev/null +++ b/src/Aspire.Dashboard/wwwroot/js/xterm/addon-fit.min.js @@ -0,0 +1,8 @@ +/** + * Skipped minification because the original files appears to be already minified. + * Original file: /npm/@xterm/addon-fit@0.10.0/lib/addon-fit.js + * + * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files + */ +!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.FitAddon=t():e.FitAddon=t()}(self,(()=>(()=>{"use strict";var e={};return(()=>{var t=e;Object.defineProperty(t,"__esModule",{value:!0}),t.FitAddon=void 0,t.FitAddon=class{activate(e){this._terminal=e}dispose(){}fit(){const e=this.proposeDimensions();if(!e||!this._terminal||isNaN(e.cols)||isNaN(e.rows))return;const t=this._terminal._core;this._terminal.rows===e.rows&&this._terminal.cols===e.cols||(t._renderService.clear(),this._terminal.resize(e.cols,e.rows))}proposeDimensions(){if(!this._terminal)return;if(!this._terminal.element||!this._terminal.element.parentElement)return;const e=this._terminal._core,t=e._renderService.dimensions;if(0===t.css.cell.width||0===t.css.cell.height)return;const r=0===this._terminal.options.scrollback?0:e.viewport.scrollBarWidth,i=window.getComputedStyle(this._terminal.element.parentElement),o=parseInt(i.getPropertyValue("height")),s=Math.max(0,parseInt(i.getPropertyValue("width"))),n=window.getComputedStyle(this._terminal.element),l=o-(parseInt(n.getPropertyValue("padding-top"))+parseInt(n.getPropertyValue("padding-bottom"))),a=s-(parseInt(n.getPropertyValue("padding-right"))+parseInt(n.getPropertyValue("padding-left")))-r;return{cols:Math.max(2,Math.floor(a/t.css.cell.width)),rows:Math.max(1,Math.floor(l/t.css.cell.height))}}}})(),e})())); +//# sourceMappingURL=addon-fit.js.map \ No newline at end of file diff --git a/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.css b/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.css new file mode 100644 index 00000000000..aced1fa464a --- /dev/null +++ b/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.css @@ -0,0 +1,8 @@ +/** + * Minified by jsDelivr using clean-css v5.3.3. + * Original file: /npm/@xterm/xterm@5.5.0/css/xterm.css + * + * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files + */ +.xterm{cursor:text;position:relative;user-select:none;-ms-user-select:none;-webkit-user-select:none}.xterm.focus,.xterm:focus{outline:0}.xterm .xterm-helpers{position:absolute;top:0;z-index:5}.xterm .xterm-helper-textarea{padding:0;border:0;margin:0;position:absolute;opacity:0;left:-9999em;top:0;width:0;height:0;z-index:-5;white-space:nowrap;overflow:hidden;resize:none}.xterm .composition-view{background:#000;color:#fff;display:none;position:absolute;white-space:nowrap;z-index:1}.xterm .composition-view.active{display:block}.xterm .xterm-viewport{background-color:#000;overflow-y:scroll;cursor:default;position:absolute;right:0;left:0;top:0;bottom:0}.xterm .xterm-screen{position:relative}.xterm .xterm-screen canvas{position:absolute;left:0;top:0}.xterm .xterm-scroll-area{visibility:hidden}.xterm-char-measure-element{display:inline-block;visibility:hidden;position:absolute;top:0;left:-9999em;line-height:normal}.xterm.enable-mouse-events{cursor:default}.xterm .xterm-cursor-pointer,.xterm.xterm-cursor-pointer{cursor:pointer}.xterm.column-select.focus{cursor:crosshair}.xterm .xterm-accessibility:not(.debug),.xterm .xterm-message{position:absolute;left:0;top:0;bottom:0;right:0;z-index:10;color:transparent;pointer-events:none}.xterm .xterm-accessibility-tree:not(.debug) ::selection{color:transparent}.xterm .xterm-accessibility-tree{user-select:text;white-space:pre}.xterm .live-region{position:absolute;left:-9999px;width:1px;height:1px;overflow:hidden}.xterm-dim{opacity:1!important}.xterm-underline-1{text-decoration:underline}.xterm-underline-2{text-decoration:double underline}.xterm-underline-3{text-decoration:wavy underline}.xterm-underline-4{text-decoration:dotted underline}.xterm-underline-5{text-decoration:dashed underline}.xterm-overline{text-decoration:overline}.xterm-overline.xterm-underline-1{text-decoration:overline underline}.xterm-overline.xterm-underline-2{text-decoration:overline double underline}.xterm-overline.xterm-underline-3{text-decoration:overline wavy underline}.xterm-overline.xterm-underline-4{text-decoration:overline dotted underline}.xterm-overline.xterm-underline-5{text-decoration:overline dashed underline}.xterm-strikethrough{text-decoration:line-through}.xterm-screen .xterm-decoration-container .xterm-decoration{z-index:6;position:absolute}.xterm-screen .xterm-decoration-container .xterm-decoration.xterm-decoration-top-layer{z-index:7}.xterm-decoration-overview-ruler{z-index:8;position:absolute;top:0;right:0;pointer-events:none}.xterm-decoration-top{z-index:2;position:relative} +/*# sourceMappingURL=/sm/97377c0c258e109358121823f5790146c714989366481f90e554c42277efb500.map */ \ No newline at end of file diff --git a/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.js b/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.js new file mode 100644 index 00000000000..0a51bfb69f6 --- /dev/null +++ b/src/Aspire.Dashboard/wwwroot/js/xterm/xterm.min.js @@ -0,0 +1,8 @@ +/** + * Skipped minification because the original files appears to be already minified. + * Original file: /npm/@xterm/xterm@5.5.0/lib/xterm.js + * + * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files + */ +!function(e,t){if("object"==typeof exports&&"object"==typeof module)module.exports=t();else if("function"==typeof define&&define.amd)define([],t);else{var i=t();for(var s in i)("object"==typeof exports?exports:e)[s]=i[s]}}(globalThis,(()=>(()=>{"use strict";var e={4567:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.AccessibilityManager=void 0;const n=i(9042),o=i(9924),a=i(844),h=i(4725),c=i(2585),l=i(3656);let d=t.AccessibilityManager=class extends a.Disposable{constructor(e,t,i,s){super(),this._terminal=e,this._coreBrowserService=i,this._renderService=s,this._rowColumns=new WeakMap,this._liveRegionLineCount=0,this._charsToConsume=[],this._charsToAnnounce="",this._accessibilityContainer=this._coreBrowserService.mainDocument.createElement("div"),this._accessibilityContainer.classList.add("xterm-accessibility"),this._rowContainer=this._coreBrowserService.mainDocument.createElement("div"),this._rowContainer.setAttribute("role","list"),this._rowContainer.classList.add("xterm-accessibility-tree"),this._rowElements=[];for(let e=0;ethis._handleBoundaryFocus(e,0),this._bottomBoundaryFocusListener=e=>this._handleBoundaryFocus(e,1),this._rowElements[0].addEventListener("focus",this._topBoundaryFocusListener),this._rowElements[this._rowElements.length-1].addEventListener("focus",this._bottomBoundaryFocusListener),this._refreshRowsDimensions(),this._accessibilityContainer.appendChild(this._rowContainer),this._liveRegion=this._coreBrowserService.mainDocument.createElement("div"),this._liveRegion.classList.add("live-region"),this._liveRegion.setAttribute("aria-live","assertive"),this._accessibilityContainer.appendChild(this._liveRegion),this._liveRegionDebouncer=this.register(new o.TimeBasedDebouncer(this._renderRows.bind(this))),!this._terminal.element)throw new Error("Cannot enable accessibility before Terminal.open");this._terminal.element.insertAdjacentElement("afterbegin",this._accessibilityContainer),this.register(this._terminal.onResize((e=>this._handleResize(e.rows)))),this.register(this._terminal.onRender((e=>this._refreshRows(e.start,e.end)))),this.register(this._terminal.onScroll((()=>this._refreshRows()))),this.register(this._terminal.onA11yChar((e=>this._handleChar(e)))),this.register(this._terminal.onLineFeed((()=>this._handleChar("\n")))),this.register(this._terminal.onA11yTab((e=>this._handleTab(e)))),this.register(this._terminal.onKey((e=>this._handleKey(e.key)))),this.register(this._terminal.onBlur((()=>this._clearLiveRegion()))),this.register(this._renderService.onDimensionsChange((()=>this._refreshRowsDimensions()))),this.register((0,l.addDisposableDomListener)(document,"selectionchange",(()=>this._handleSelectionChange()))),this.register(this._coreBrowserService.onDprChange((()=>this._refreshRowsDimensions()))),this._refreshRows(),this.register((0,a.toDisposable)((()=>{this._accessibilityContainer.remove(),this._rowElements.length=0})))}_handleTab(e){for(let t=0;t0?this._charsToConsume.shift()!==e&&(this._charsToAnnounce+=e):this._charsToAnnounce+=e,"\n"===e&&(this._liveRegionLineCount++,21===this._liveRegionLineCount&&(this._liveRegion.textContent+=n.tooMuchOutput)))}_clearLiveRegion(){this._liveRegion.textContent="",this._liveRegionLineCount=0}_handleKey(e){this._clearLiveRegion(),/\p{Control}/u.test(e)||this._charsToConsume.push(e)}_refreshRows(e,t){this._liveRegionDebouncer.refresh(e,t,this._terminal.rows)}_renderRows(e,t){const i=this._terminal.buffer,s=i.lines.length.toString();for(let r=e;r<=t;r++){const e=i.lines.get(i.ydisp+r),t=[],n=e?.translateToString(!0,void 0,void 0,t)||"",o=(i.ydisp+r+1).toString(),a=this._rowElements[r];a&&(0===n.length?(a.innerText=" ",this._rowColumns.set(a,[0,1])):(a.textContent=n,this._rowColumns.set(a,t)),a.setAttribute("aria-posinset",o),a.setAttribute("aria-setsize",s))}this._announceCharacters()}_announceCharacters(){0!==this._charsToAnnounce.length&&(this._liveRegion.textContent+=this._charsToAnnounce,this._charsToAnnounce="")}_handleBoundaryFocus(e,t){const i=e.target,s=this._rowElements[0===t?1:this._rowElements.length-2];if(i.getAttribute("aria-posinset")===(0===t?"1":`${this._terminal.buffer.lines.length}`))return;if(e.relatedTarget!==s)return;let r,n;if(0===t?(r=i,n=this._rowElements.pop(),this._rowContainer.removeChild(n)):(r=this._rowElements.shift(),n=i,this._rowContainer.removeChild(r)),r.removeEventListener("focus",this._topBoundaryFocusListener),n.removeEventListener("focus",this._bottomBoundaryFocusListener),0===t){const e=this._createAccessibilityTreeNode();this._rowElements.unshift(e),this._rowContainer.insertAdjacentElement("afterbegin",e)}else{const e=this._createAccessibilityTreeNode();this._rowElements.push(e),this._rowContainer.appendChild(e)}this._rowElements[0].addEventListener("focus",this._topBoundaryFocusListener),this._rowElements[this._rowElements.length-1].addEventListener("focus",this._bottomBoundaryFocusListener),this._terminal.scrollLines(0===t?-1:1),this._rowElements[0===t?1:this._rowElements.length-2].focus(),e.preventDefault(),e.stopImmediatePropagation()}_handleSelectionChange(){if(0===this._rowElements.length)return;const e=document.getSelection();if(!e)return;if(e.isCollapsed)return void(this._rowContainer.contains(e.anchorNode)&&this._terminal.clearSelection());if(!e.anchorNode||!e.focusNode)return void console.error("anchorNode and/or focusNode are null");let t={node:e.anchorNode,offset:e.anchorOffset},i={node:e.focusNode,offset:e.focusOffset};if((t.node.compareDocumentPosition(i.node)&Node.DOCUMENT_POSITION_PRECEDING||t.node===i.node&&t.offset>i.offset)&&([t,i]=[i,t]),t.node.compareDocumentPosition(this._rowElements[0])&(Node.DOCUMENT_POSITION_CONTAINED_BY|Node.DOCUMENT_POSITION_FOLLOWING)&&(t={node:this._rowElements[0].childNodes[0],offset:0}),!this._rowContainer.contains(t.node))return;const s=this._rowElements.slice(-1)[0];if(i.node.compareDocumentPosition(s)&(Node.DOCUMENT_POSITION_CONTAINED_BY|Node.DOCUMENT_POSITION_PRECEDING)&&(i={node:s,offset:s.textContent?.length??0}),!this._rowContainer.contains(i.node))return;const r=({node:e,offset:t})=>{const i=e instanceof Text?e.parentNode:e;let s=parseInt(i?.getAttribute("aria-posinset"),10)-1;if(isNaN(s))return console.warn("row is invalid. Race condition?"),null;const r=this._rowColumns.get(i);if(!r)return console.warn("columns is null. Race condition?"),null;let n=t=this._terminal.cols&&(++s,n=0),{row:s,column:n}},n=r(t),o=r(i);if(n&&o){if(n.row>o.row||n.row===o.row&&n.column>=o.column)throw new Error("invalid range");this._terminal.select(n.column,n.row,(o.row-n.row)*this._terminal.cols-n.column+o.column)}}_handleResize(e){this._rowElements[this._rowElements.length-1].removeEventListener("focus",this._bottomBoundaryFocusListener);for(let e=this._rowContainer.children.length;ee;)this._rowContainer.removeChild(this._rowElements.pop());this._rowElements[this._rowElements.length-1].addEventListener("focus",this._bottomBoundaryFocusListener),this._refreshRowsDimensions()}_createAccessibilityTreeNode(){const e=this._coreBrowserService.mainDocument.createElement("div");return e.setAttribute("role","listitem"),e.tabIndex=-1,this._refreshRowDimensions(e),e}_refreshRowsDimensions(){if(this._renderService.dimensions.css.cell.height){this._accessibilityContainer.style.width=`${this._renderService.dimensions.css.canvas.width}px`,this._rowElements.length!==this._terminal.rows&&this._handleResize(this._terminal.rows);for(let e=0;e{function i(e){return e.replace(/\r?\n/g,"\r")}function s(e,t){return t?"[200~"+e+"[201~":e}function r(e,t,r,n){e=s(e=i(e),r.decPrivateModes.bracketedPasteMode&&!0!==n.rawOptions.ignoreBracketedPasteMode),r.triggerDataEvent(e,!0),t.value=""}function n(e,t,i){const s=i.getBoundingClientRect(),r=e.clientX-s.left-10,n=e.clientY-s.top-10;t.style.width="20px",t.style.height="20px",t.style.left=`${r}px`,t.style.top=`${n}px`,t.style.zIndex="1000",t.focus()}Object.defineProperty(t,"__esModule",{value:!0}),t.rightClickHandler=t.moveTextAreaUnderMouseCursor=t.paste=t.handlePasteEvent=t.copyHandler=t.bracketTextForPaste=t.prepareTextForTerminal=void 0,t.prepareTextForTerminal=i,t.bracketTextForPaste=s,t.copyHandler=function(e,t){e.clipboardData&&e.clipboardData.setData("text/plain",t.selectionText),e.preventDefault()},t.handlePasteEvent=function(e,t,i,s){e.stopPropagation(),e.clipboardData&&r(e.clipboardData.getData("text/plain"),t,i,s)},t.paste=r,t.moveTextAreaUnderMouseCursor=n,t.rightClickHandler=function(e,t,i,s,r){n(e,t,i),r&&s.rightClickSelect(e),t.value=s.selectionText,t.select()}},7239:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.ColorContrastCache=void 0;const s=i(1505);t.ColorContrastCache=class{constructor(){this._color=new s.TwoKeyMap,this._css=new s.TwoKeyMap}setCss(e,t,i){this._css.set(e,t,i)}getCss(e,t){return this._css.get(e,t)}setColor(e,t,i){this._color.set(e,t,i)}getColor(e,t){return this._color.get(e,t)}clear(){this._color.clear(),this._css.clear()}}},3656:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.addDisposableDomListener=void 0,t.addDisposableDomListener=function(e,t,i,s){e.addEventListener(t,i,s);let r=!1;return{dispose:()=>{r||(r=!0,e.removeEventListener(t,i,s))}}}},3551:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.Linkifier=void 0;const n=i(3656),o=i(8460),a=i(844),h=i(2585),c=i(4725);let l=t.Linkifier=class extends a.Disposable{get currentLink(){return this._currentLink}constructor(e,t,i,s,r){super(),this._element=e,this._mouseService=t,this._renderService=i,this._bufferService=s,this._linkProviderService=r,this._linkCacheDisposables=[],this._isMouseOut=!0,this._wasResized=!1,this._activeLine=-1,this._onShowLinkUnderline=this.register(new o.EventEmitter),this.onShowLinkUnderline=this._onShowLinkUnderline.event,this._onHideLinkUnderline=this.register(new o.EventEmitter),this.onHideLinkUnderline=this._onHideLinkUnderline.event,this.register((0,a.getDisposeArrayDisposable)(this._linkCacheDisposables)),this.register((0,a.toDisposable)((()=>{this._lastMouseEvent=void 0,this._activeProviderReplies?.clear()}))),this.register(this._bufferService.onResize((()=>{this._clearCurrentLink(),this._wasResized=!0}))),this.register((0,n.addDisposableDomListener)(this._element,"mouseleave",(()=>{this._isMouseOut=!0,this._clearCurrentLink()}))),this.register((0,n.addDisposableDomListener)(this._element,"mousemove",this._handleMouseMove.bind(this))),this.register((0,n.addDisposableDomListener)(this._element,"mousedown",this._handleMouseDown.bind(this))),this.register((0,n.addDisposableDomListener)(this._element,"mouseup",this._handleMouseUp.bind(this)))}_handleMouseMove(e){this._lastMouseEvent=e;const t=this._positionFromMouseEvent(e,this._element,this._mouseService);if(!t)return;this._isMouseOut=!1;const i=e.composedPath();for(let e=0;e{e?.forEach((e=>{e.link.dispose&&e.link.dispose()}))})),this._activeProviderReplies=new Map,this._activeLine=e.y);let i=!1;for(const[s,r]of this._linkProviderService.linkProviders.entries())if(t){const t=this._activeProviderReplies?.get(s);t&&(i=this._checkLinkProviderResult(s,e,i))}else r.provideLinks(e.y,(t=>{if(this._isMouseOut)return;const r=t?.map((e=>({link:e})));this._activeProviderReplies?.set(s,r),i=this._checkLinkProviderResult(s,e,i),this._activeProviderReplies?.size===this._linkProviderService.linkProviders.length&&this._removeIntersectingLinks(e.y,this._activeProviderReplies)}))}_removeIntersectingLinks(e,t){const i=new Set;for(let s=0;se?this._bufferService.cols:s.link.range.end.x;for(let e=n;e<=o;e++){if(i.has(e)){r.splice(t--,1);break}i.add(e)}}}}_checkLinkProviderResult(e,t,i){if(!this._activeProviderReplies)return i;const s=this._activeProviderReplies.get(e);let r=!1;for(let t=0;tthis._linkAtPosition(e.link,t)));e&&(i=!0,this._handleNewLink(e))}if(this._activeProviderReplies.size===this._linkProviderService.linkProviders.length&&!i)for(let e=0;ethis._linkAtPosition(e.link,t)));if(s){i=!0,this._handleNewLink(s);break}}return i}_handleMouseDown(){this._mouseDownLink=this._currentLink}_handleMouseUp(e){if(!this._currentLink)return;const t=this._positionFromMouseEvent(e,this._element,this._mouseService);t&&this._mouseDownLink===this._currentLink&&this._linkAtPosition(this._currentLink.link,t)&&this._currentLink.link.activate(e,this._currentLink.link.text)}_clearCurrentLink(e,t){this._currentLink&&this._lastMouseEvent&&(!e||!t||this._currentLink.link.range.start.y>=e&&this._currentLink.link.range.end.y<=t)&&(this._linkLeave(this._element,this._currentLink.link,this._lastMouseEvent),this._currentLink=void 0,(0,a.disposeArray)(this._linkCacheDisposables))}_handleNewLink(e){if(!this._lastMouseEvent)return;const t=this._positionFromMouseEvent(this._lastMouseEvent,this._element,this._mouseService);t&&this._linkAtPosition(e.link,t)&&(this._currentLink=e,this._currentLink.state={decorations:{underline:void 0===e.link.decorations||e.link.decorations.underline,pointerCursor:void 0===e.link.decorations||e.link.decorations.pointerCursor},isHovered:!0},this._linkHover(this._element,e.link,this._lastMouseEvent),e.link.decorations={},Object.defineProperties(e.link.decorations,{pointerCursor:{get:()=>this._currentLink?.state?.decorations.pointerCursor,set:e=>{this._currentLink?.state&&this._currentLink.state.decorations.pointerCursor!==e&&(this._currentLink.state.decorations.pointerCursor=e,this._currentLink.state.isHovered&&this._element.classList.toggle("xterm-cursor-pointer",e))}},underline:{get:()=>this._currentLink?.state?.decorations.underline,set:t=>{this._currentLink?.state&&this._currentLink?.state?.decorations.underline!==t&&(this._currentLink.state.decorations.underline=t,this._currentLink.state.isHovered&&this._fireUnderlineEvent(e.link,t))}}}),this._linkCacheDisposables.push(this._renderService.onRenderedViewportChange((e=>{if(!this._currentLink)return;const t=0===e.start?0:e.start+1+this._bufferService.buffer.ydisp,i=this._bufferService.buffer.ydisp+1+e.end;if(this._currentLink.link.range.start.y>=t&&this._currentLink.link.range.end.y<=i&&(this._clearCurrentLink(t,i),this._lastMouseEvent)){const e=this._positionFromMouseEvent(this._lastMouseEvent,this._element,this._mouseService);e&&this._askForLink(e,!1)}}))))}_linkHover(e,t,i){this._currentLink?.state&&(this._currentLink.state.isHovered=!0,this._currentLink.state.decorations.underline&&this._fireUnderlineEvent(t,!0),this._currentLink.state.decorations.pointerCursor&&e.classList.add("xterm-cursor-pointer")),t.hover&&t.hover(i,t.text)}_fireUnderlineEvent(e,t){const i=e.range,s=this._bufferService.buffer.ydisp,r=this._createLinkUnderlineEvent(i.start.x-1,i.start.y-s-1,i.end.x,i.end.y-s-1,void 0);(t?this._onShowLinkUnderline:this._onHideLinkUnderline).fire(r)}_linkLeave(e,t,i){this._currentLink?.state&&(this._currentLink.state.isHovered=!1,this._currentLink.state.decorations.underline&&this._fireUnderlineEvent(t,!1),this._currentLink.state.decorations.pointerCursor&&e.classList.remove("xterm-cursor-pointer")),t.leave&&t.leave(i,t.text)}_linkAtPosition(e,t){const i=e.range.start.y*this._bufferService.cols+e.range.start.x,s=e.range.end.y*this._bufferService.cols+e.range.end.x,r=t.y*this._bufferService.cols+t.x;return i<=r&&r<=s}_positionFromMouseEvent(e,t,i){const s=i.getCoords(e,t,this._bufferService.cols,this._bufferService.rows);if(s)return{x:s[0],y:s[1]+this._bufferService.buffer.ydisp}}_createLinkUnderlineEvent(e,t,i,s,r){return{x1:e,y1:t,x2:i,y2:s,cols:this._bufferService.cols,fg:r}}};t.Linkifier=l=s([r(1,c.IMouseService),r(2,c.IRenderService),r(3,h.IBufferService),r(4,c.ILinkProviderService)],l)},9042:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.tooMuchOutput=t.promptLabel=void 0,t.promptLabel="Terminal input",t.tooMuchOutput="Too much output to announce, navigate to rows manually to read"},3730:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.OscLinkProvider=void 0;const n=i(511),o=i(2585);let a=t.OscLinkProvider=class{constructor(e,t,i){this._bufferService=e,this._optionsService=t,this._oscLinkService=i}provideLinks(e,t){const i=this._bufferService.buffer.lines.get(e-1);if(!i)return void t(void 0);const s=[],r=this._optionsService.rawOptions.linkHandler,o=new n.CellData,a=i.getTrimmedLength();let c=-1,l=-1,d=!1;for(let t=0;tr?r.activate(e,t,n):h(0,t),hover:(e,t)=>r?.hover?.(e,t,n),leave:(e,t)=>r?.leave?.(e,t,n)})}d=!1,o.hasExtendedAttrs()&&o.extended.urlId?(l=t,c=o.extended.urlId):(l=-1,c=-1)}}t(s)}};function h(e,t){if(confirm(`Do you want to navigate to ${t}?\n\nWARNING: This link could potentially be dangerous`)){const e=window.open();if(e){try{e.opener=null}catch{}e.location.href=t}else console.warn("Opening link blocked as opener could not be cleared")}}t.OscLinkProvider=a=s([r(0,o.IBufferService),r(1,o.IOptionsService),r(2,o.IOscLinkService)],a)},6193:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.RenderDebouncer=void 0,t.RenderDebouncer=class{constructor(e,t){this._renderCallback=e,this._coreBrowserService=t,this._refreshCallbacks=[]}dispose(){this._animationFrame&&(this._coreBrowserService.window.cancelAnimationFrame(this._animationFrame),this._animationFrame=void 0)}addRefreshCallback(e){return this._refreshCallbacks.push(e),this._animationFrame||(this._animationFrame=this._coreBrowserService.window.requestAnimationFrame((()=>this._innerRefresh()))),this._animationFrame}refresh(e,t,i){this._rowCount=i,e=void 0!==e?e:0,t=void 0!==t?t:this._rowCount-1,this._rowStart=void 0!==this._rowStart?Math.min(this._rowStart,e):e,this._rowEnd=void 0!==this._rowEnd?Math.max(this._rowEnd,t):t,this._animationFrame||(this._animationFrame=this._coreBrowserService.window.requestAnimationFrame((()=>this._innerRefresh())))}_innerRefresh(){if(this._animationFrame=void 0,void 0===this._rowStart||void 0===this._rowEnd||void 0===this._rowCount)return void this._runRefreshCallbacks();const e=Math.max(this._rowStart,0),t=Math.min(this._rowEnd,this._rowCount-1);this._rowStart=void 0,this._rowEnd=void 0,this._renderCallback(e,t),this._runRefreshCallbacks()}_runRefreshCallbacks(){for(const e of this._refreshCallbacks)e(0);this._refreshCallbacks=[]}}},3236:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Terminal=void 0;const s=i(3614),r=i(3656),n=i(3551),o=i(9042),a=i(3730),h=i(1680),c=i(3107),l=i(5744),d=i(2950),_=i(1296),u=i(428),f=i(4269),v=i(5114),p=i(8934),g=i(3230),m=i(9312),S=i(4725),C=i(6731),b=i(8055),w=i(8969),y=i(8460),E=i(844),k=i(6114),L=i(8437),D=i(2584),R=i(7399),x=i(5941),A=i(9074),B=i(2585),T=i(5435),M=i(4567),O=i(779);class P extends w.CoreTerminal{get onFocus(){return this._onFocus.event}get onBlur(){return this._onBlur.event}get onA11yChar(){return this._onA11yCharEmitter.event}get onA11yTab(){return this._onA11yTabEmitter.event}get onWillOpen(){return this._onWillOpen.event}constructor(e={}){super(e),this.browser=k,this._keyDownHandled=!1,this._keyDownSeen=!1,this._keyPressHandled=!1,this._unprocessedDeadKey=!1,this._accessibilityManager=this.register(new E.MutableDisposable),this._onCursorMove=this.register(new y.EventEmitter),this.onCursorMove=this._onCursorMove.event,this._onKey=this.register(new y.EventEmitter),this.onKey=this._onKey.event,this._onRender=this.register(new y.EventEmitter),this.onRender=this._onRender.event,this._onSelectionChange=this.register(new y.EventEmitter),this.onSelectionChange=this._onSelectionChange.event,this._onTitleChange=this.register(new y.EventEmitter),this.onTitleChange=this._onTitleChange.event,this._onBell=this.register(new y.EventEmitter),this.onBell=this._onBell.event,this._onFocus=this.register(new y.EventEmitter),this._onBlur=this.register(new y.EventEmitter),this._onA11yCharEmitter=this.register(new y.EventEmitter),this._onA11yTabEmitter=this.register(new y.EventEmitter),this._onWillOpen=this.register(new y.EventEmitter),this._setup(),this._decorationService=this._instantiationService.createInstance(A.DecorationService),this._instantiationService.setService(B.IDecorationService,this._decorationService),this._linkProviderService=this._instantiationService.createInstance(O.LinkProviderService),this._instantiationService.setService(S.ILinkProviderService,this._linkProviderService),this._linkProviderService.registerLinkProvider(this._instantiationService.createInstance(a.OscLinkProvider)),this.register(this._inputHandler.onRequestBell((()=>this._onBell.fire()))),this.register(this._inputHandler.onRequestRefreshRows(((e,t)=>this.refresh(e,t)))),this.register(this._inputHandler.onRequestSendFocus((()=>this._reportFocus()))),this.register(this._inputHandler.onRequestReset((()=>this.reset()))),this.register(this._inputHandler.onRequestWindowsOptionsReport((e=>this._reportWindowsOptions(e)))),this.register(this._inputHandler.onColor((e=>this._handleColorEvent(e)))),this.register((0,y.forwardEvent)(this._inputHandler.onCursorMove,this._onCursorMove)),this.register((0,y.forwardEvent)(this._inputHandler.onTitleChange,this._onTitleChange)),this.register((0,y.forwardEvent)(this._inputHandler.onA11yChar,this._onA11yCharEmitter)),this.register((0,y.forwardEvent)(this._inputHandler.onA11yTab,this._onA11yTabEmitter)),this.register(this._bufferService.onResize((e=>this._afterResize(e.cols,e.rows)))),this.register((0,E.toDisposable)((()=>{this._customKeyEventHandler=void 0,this.element?.parentNode?.removeChild(this.element)})))}_handleColorEvent(e){if(this._themeService)for(const t of e){let e,i="";switch(t.index){case 256:e="foreground",i="10";break;case 257:e="background",i="11";break;case 258:e="cursor",i="12";break;default:e="ansi",i="4;"+t.index}switch(t.type){case 0:const s=b.color.toColorRGB("ansi"===e?this._themeService.colors.ansi[t.index]:this._themeService.colors[e]);this.coreService.triggerDataEvent(`${D.C0.ESC}]${i};${(0,x.toRgbString)(s)}${D.C1_ESCAPED.ST}`);break;case 1:if("ansi"===e)this._themeService.modifyColors((e=>e.ansi[t.index]=b.channels.toColor(...t.color)));else{const i=e;this._themeService.modifyColors((e=>e[i]=b.channels.toColor(...t.color)))}break;case 2:this._themeService.restoreColor(t.index)}}}_setup(){super._setup(),this._customKeyEventHandler=void 0}get buffer(){return this.buffers.active}focus(){this.textarea&&this.textarea.focus({preventScroll:!0})}_handleScreenReaderModeOptionChange(e){e?!this._accessibilityManager.value&&this._renderService&&(this._accessibilityManager.value=this._instantiationService.createInstance(M.AccessibilityManager,this)):this._accessibilityManager.clear()}_handleTextAreaFocus(e){this.coreService.decPrivateModes.sendFocus&&this.coreService.triggerDataEvent(D.C0.ESC+"[I"),this.element.classList.add("focus"),this._showCursor(),this._onFocus.fire()}blur(){return this.textarea?.blur()}_handleTextAreaBlur(){this.textarea.value="",this.refresh(this.buffer.y,this.buffer.y),this.coreService.decPrivateModes.sendFocus&&this.coreService.triggerDataEvent(D.C0.ESC+"[O"),this.element.classList.remove("focus"),this._onBlur.fire()}_syncTextArea(){if(!this.textarea||!this.buffer.isCursorInViewport||this._compositionHelper.isComposing||!this._renderService)return;const e=this.buffer.ybase+this.buffer.y,t=this.buffer.lines.get(e);if(!t)return;const i=Math.min(this.buffer.x,this.cols-1),s=this._renderService.dimensions.css.cell.height,r=t.getWidth(i),n=this._renderService.dimensions.css.cell.width*r,o=this.buffer.y*this._renderService.dimensions.css.cell.height,a=i*this._renderService.dimensions.css.cell.width;this.textarea.style.left=a+"px",this.textarea.style.top=o+"px",this.textarea.style.width=n+"px",this.textarea.style.height=s+"px",this.textarea.style.lineHeight=s+"px",this.textarea.style.zIndex="-5"}_initGlobal(){this._bindKeys(),this.register((0,r.addDisposableDomListener)(this.element,"copy",(e=>{this.hasSelection()&&(0,s.copyHandler)(e,this._selectionService)})));const e=e=>(0,s.handlePasteEvent)(e,this.textarea,this.coreService,this.optionsService);this.register((0,r.addDisposableDomListener)(this.textarea,"paste",e)),this.register((0,r.addDisposableDomListener)(this.element,"paste",e)),k.isFirefox?this.register((0,r.addDisposableDomListener)(this.element,"mousedown",(e=>{2===e.button&&(0,s.rightClickHandler)(e,this.textarea,this.screenElement,this._selectionService,this.options.rightClickSelectsWord)}))):this.register((0,r.addDisposableDomListener)(this.element,"contextmenu",(e=>{(0,s.rightClickHandler)(e,this.textarea,this.screenElement,this._selectionService,this.options.rightClickSelectsWord)}))),k.isLinux&&this.register((0,r.addDisposableDomListener)(this.element,"auxclick",(e=>{1===e.button&&(0,s.moveTextAreaUnderMouseCursor)(e,this.textarea,this.screenElement)})))}_bindKeys(){this.register((0,r.addDisposableDomListener)(this.textarea,"keyup",(e=>this._keyUp(e)),!0)),this.register((0,r.addDisposableDomListener)(this.textarea,"keydown",(e=>this._keyDown(e)),!0)),this.register((0,r.addDisposableDomListener)(this.textarea,"keypress",(e=>this._keyPress(e)),!0)),this.register((0,r.addDisposableDomListener)(this.textarea,"compositionstart",(()=>this._compositionHelper.compositionstart()))),this.register((0,r.addDisposableDomListener)(this.textarea,"compositionupdate",(e=>this._compositionHelper.compositionupdate(e)))),this.register((0,r.addDisposableDomListener)(this.textarea,"compositionend",(()=>this._compositionHelper.compositionend()))),this.register((0,r.addDisposableDomListener)(this.textarea,"input",(e=>this._inputEvent(e)),!0)),this.register(this.onRender((()=>this._compositionHelper.updateCompositionElements())))}open(e){if(!e)throw new Error("Terminal requires a parent element.");if(e.isConnected||this._logService.debug("Terminal.open was called on an element that was not attached to the DOM"),this.element?.ownerDocument.defaultView&&this._coreBrowserService)return void(this.element.ownerDocument.defaultView!==this._coreBrowserService.window&&(this._coreBrowserService.window=this.element.ownerDocument.defaultView));this._document=e.ownerDocument,this.options.documentOverride&&this.options.documentOverride instanceof Document&&(this._document=this.optionsService.rawOptions.documentOverride),this.element=this._document.createElement("div"),this.element.dir="ltr",this.element.classList.add("terminal"),this.element.classList.add("xterm"),e.appendChild(this.element);const t=this._document.createDocumentFragment();this._viewportElement=this._document.createElement("div"),this._viewportElement.classList.add("xterm-viewport"),t.appendChild(this._viewportElement),this._viewportScrollArea=this._document.createElement("div"),this._viewportScrollArea.classList.add("xterm-scroll-area"),this._viewportElement.appendChild(this._viewportScrollArea),this.screenElement=this._document.createElement("div"),this.screenElement.classList.add("xterm-screen"),this.register((0,r.addDisposableDomListener)(this.screenElement,"mousemove",(e=>this.updateCursorStyle(e)))),this._helperContainer=this._document.createElement("div"),this._helperContainer.classList.add("xterm-helpers"),this.screenElement.appendChild(this._helperContainer),t.appendChild(this.screenElement),this.textarea=this._document.createElement("textarea"),this.textarea.classList.add("xterm-helper-textarea"),this.textarea.setAttribute("aria-label",o.promptLabel),k.isChromeOS||this.textarea.setAttribute("aria-multiline","false"),this.textarea.setAttribute("autocorrect","off"),this.textarea.setAttribute("autocapitalize","off"),this.textarea.setAttribute("spellcheck","false"),this.textarea.tabIndex=0,this._coreBrowserService=this.register(this._instantiationService.createInstance(v.CoreBrowserService,this.textarea,e.ownerDocument.defaultView??window,this._document??"undefined"!=typeof window?window.document:null)),this._instantiationService.setService(S.ICoreBrowserService,this._coreBrowserService),this.register((0,r.addDisposableDomListener)(this.textarea,"focus",(e=>this._handleTextAreaFocus(e)))),this.register((0,r.addDisposableDomListener)(this.textarea,"blur",(()=>this._handleTextAreaBlur()))),this._helperContainer.appendChild(this.textarea),this._charSizeService=this._instantiationService.createInstance(u.CharSizeService,this._document,this._helperContainer),this._instantiationService.setService(S.ICharSizeService,this._charSizeService),this._themeService=this._instantiationService.createInstance(C.ThemeService),this._instantiationService.setService(S.IThemeService,this._themeService),this._characterJoinerService=this._instantiationService.createInstance(f.CharacterJoinerService),this._instantiationService.setService(S.ICharacterJoinerService,this._characterJoinerService),this._renderService=this.register(this._instantiationService.createInstance(g.RenderService,this.rows,this.screenElement)),this._instantiationService.setService(S.IRenderService,this._renderService),this.register(this._renderService.onRenderedViewportChange((e=>this._onRender.fire(e)))),this.onResize((e=>this._renderService.resize(e.cols,e.rows))),this._compositionView=this._document.createElement("div"),this._compositionView.classList.add("composition-view"),this._compositionHelper=this._instantiationService.createInstance(d.CompositionHelper,this.textarea,this._compositionView),this._helperContainer.appendChild(this._compositionView),this._mouseService=this._instantiationService.createInstance(p.MouseService),this._instantiationService.setService(S.IMouseService,this._mouseService),this.linkifier=this.register(this._instantiationService.createInstance(n.Linkifier,this.screenElement)),this.element.appendChild(t);try{this._onWillOpen.fire(this.element)}catch{}this._renderService.hasRenderer()||this._renderService.setRenderer(this._createRenderer()),this.viewport=this._instantiationService.createInstance(h.Viewport,this._viewportElement,this._viewportScrollArea),this.viewport.onRequestScrollLines((e=>this.scrollLines(e.amount,e.suppressScrollEvent,1))),this.register(this._inputHandler.onRequestSyncScrollBar((()=>this.viewport.syncScrollArea()))),this.register(this.viewport),this.register(this.onCursorMove((()=>{this._renderService.handleCursorMove(),this._syncTextArea()}))),this.register(this.onResize((()=>this._renderService.handleResize(this.cols,this.rows)))),this.register(this.onBlur((()=>this._renderService.handleBlur()))),this.register(this.onFocus((()=>this._renderService.handleFocus()))),this.register(this._renderService.onDimensionsChange((()=>this.viewport.syncScrollArea()))),this._selectionService=this.register(this._instantiationService.createInstance(m.SelectionService,this.element,this.screenElement,this.linkifier)),this._instantiationService.setService(S.ISelectionService,this._selectionService),this.register(this._selectionService.onRequestScrollLines((e=>this.scrollLines(e.amount,e.suppressScrollEvent)))),this.register(this._selectionService.onSelectionChange((()=>this._onSelectionChange.fire()))),this.register(this._selectionService.onRequestRedraw((e=>this._renderService.handleSelectionChanged(e.start,e.end,e.columnSelectMode)))),this.register(this._selectionService.onLinuxMouseSelection((e=>{this.textarea.value=e,this.textarea.focus(),this.textarea.select()}))),this.register(this._onScroll.event((e=>{this.viewport.syncScrollArea(),this._selectionService.refresh()}))),this.register((0,r.addDisposableDomListener)(this._viewportElement,"scroll",(()=>this._selectionService.refresh()))),this.register(this._instantiationService.createInstance(c.BufferDecorationRenderer,this.screenElement)),this.register((0,r.addDisposableDomListener)(this.element,"mousedown",(e=>this._selectionService.handleMouseDown(e)))),this.coreMouseService.areMouseEventsActive?(this._selectionService.disable(),this.element.classList.add("enable-mouse-events")):this._selectionService.enable(),this.options.screenReaderMode&&(this._accessibilityManager.value=this._instantiationService.createInstance(M.AccessibilityManager,this)),this.register(this.optionsService.onSpecificOptionChange("screenReaderMode",(e=>this._handleScreenReaderModeOptionChange(e)))),this.options.overviewRulerWidth&&(this._overviewRulerRenderer=this.register(this._instantiationService.createInstance(l.OverviewRulerRenderer,this._viewportElement,this.screenElement))),this.optionsService.onSpecificOptionChange("overviewRulerWidth",(e=>{!this._overviewRulerRenderer&&e&&this._viewportElement&&this.screenElement&&(this._overviewRulerRenderer=this.register(this._instantiationService.createInstance(l.OverviewRulerRenderer,this._viewportElement,this.screenElement)))})),this._charSizeService.measure(),this.refresh(0,this.rows-1),this._initGlobal(),this.bindMouse()}_createRenderer(){return this._instantiationService.createInstance(_.DomRenderer,this,this._document,this.element,this.screenElement,this._viewportElement,this._helperContainer,this.linkifier)}bindMouse(){const e=this,t=this.element;function i(t){const i=e._mouseService.getMouseReportCoords(t,e.screenElement);if(!i)return!1;let s,r;switch(t.overrideType||t.type){case"mousemove":r=32,void 0===t.buttons?(s=3,void 0!==t.button&&(s=t.button<3?t.button:3)):s=1&t.buttons?0:4&t.buttons?1:2&t.buttons?2:3;break;case"mouseup":r=0,s=t.button<3?t.button:3;break;case"mousedown":r=1,s=t.button<3?t.button:3;break;case"wheel":if(e._customWheelEventHandler&&!1===e._customWheelEventHandler(t))return!1;if(0===e.viewport.getLinesScrolled(t))return!1;r=t.deltaY<0?0:1,s=4;break;default:return!1}return!(void 0===r||void 0===s||s>4)&&e.coreMouseService.triggerMouseEvent({col:i.col,row:i.row,x:i.x,y:i.y,button:s,action:r,ctrl:t.ctrlKey,alt:t.altKey,shift:t.shiftKey})}const s={mouseup:null,wheel:null,mousedrag:null,mousemove:null},n={mouseup:e=>(i(e),e.buttons||(this._document.removeEventListener("mouseup",s.mouseup),s.mousedrag&&this._document.removeEventListener("mousemove",s.mousedrag)),this.cancel(e)),wheel:e=>(i(e),this.cancel(e,!0)),mousedrag:e=>{e.buttons&&i(e)},mousemove:e=>{e.buttons||i(e)}};this.register(this.coreMouseService.onProtocolChange((e=>{e?("debug"===this.optionsService.rawOptions.logLevel&&this._logService.debug("Binding to mouse events:",this.coreMouseService.explainEvents(e)),this.element.classList.add("enable-mouse-events"),this._selectionService.disable()):(this._logService.debug("Unbinding from mouse events."),this.element.classList.remove("enable-mouse-events"),this._selectionService.enable()),8&e?s.mousemove||(t.addEventListener("mousemove",n.mousemove),s.mousemove=n.mousemove):(t.removeEventListener("mousemove",s.mousemove),s.mousemove=null),16&e?s.wheel||(t.addEventListener("wheel",n.wheel,{passive:!1}),s.wheel=n.wheel):(t.removeEventListener("wheel",s.wheel),s.wheel=null),2&e?s.mouseup||(s.mouseup=n.mouseup):(this._document.removeEventListener("mouseup",s.mouseup),s.mouseup=null),4&e?s.mousedrag||(s.mousedrag=n.mousedrag):(this._document.removeEventListener("mousemove",s.mousedrag),s.mousedrag=null)}))),this.coreMouseService.activeProtocol=this.coreMouseService.activeProtocol,this.register((0,r.addDisposableDomListener)(t,"mousedown",(e=>{if(e.preventDefault(),this.focus(),this.coreMouseService.areMouseEventsActive&&!this._selectionService.shouldForceSelection(e))return i(e),s.mouseup&&this._document.addEventListener("mouseup",s.mouseup),s.mousedrag&&this._document.addEventListener("mousemove",s.mousedrag),this.cancel(e)}))),this.register((0,r.addDisposableDomListener)(t,"wheel",(e=>{if(!s.wheel){if(this._customWheelEventHandler&&!1===this._customWheelEventHandler(e))return!1;if(!this.buffer.hasScrollback){const t=this.viewport.getLinesScrolled(e);if(0===t)return;const i=D.C0.ESC+(this.coreService.decPrivateModes.applicationCursorKeys?"O":"[")+(e.deltaY<0?"A":"B");let s="";for(let e=0;e{if(!this.coreMouseService.areMouseEventsActive)return this.viewport.handleTouchStart(e),this.cancel(e)}),{passive:!0})),this.register((0,r.addDisposableDomListener)(t,"touchmove",(e=>{if(!this.coreMouseService.areMouseEventsActive)return this.viewport.handleTouchMove(e)?void 0:this.cancel(e)}),{passive:!1}))}refresh(e,t){this._renderService?.refreshRows(e,t)}updateCursorStyle(e){this._selectionService?.shouldColumnSelect(e)?this.element.classList.add("column-select"):this.element.classList.remove("column-select")}_showCursor(){this.coreService.isCursorInitialized||(this.coreService.isCursorInitialized=!0,this.refresh(this.buffer.y,this.buffer.y))}scrollLines(e,t,i=0){1===i?(super.scrollLines(e,t,i),this.refresh(0,this.rows-1)):this.viewport?.scrollLines(e)}paste(e){(0,s.paste)(e,this.textarea,this.coreService,this.optionsService)}attachCustomKeyEventHandler(e){this._customKeyEventHandler=e}attachCustomWheelEventHandler(e){this._customWheelEventHandler=e}registerLinkProvider(e){return this._linkProviderService.registerLinkProvider(e)}registerCharacterJoiner(e){if(!this._characterJoinerService)throw new Error("Terminal must be opened first");const t=this._characterJoinerService.register(e);return this.refresh(0,this.rows-1),t}deregisterCharacterJoiner(e){if(!this._characterJoinerService)throw new Error("Terminal must be opened first");this._characterJoinerService.deregister(e)&&this.refresh(0,this.rows-1)}get markers(){return this.buffer.markers}registerMarker(e){return this.buffer.addMarker(this.buffer.ybase+this.buffer.y+e)}registerDecoration(e){return this._decorationService.registerDecoration(e)}hasSelection(){return!!this._selectionService&&this._selectionService.hasSelection}select(e,t,i){this._selectionService.setSelection(e,t,i)}getSelection(){return this._selectionService?this._selectionService.selectionText:""}getSelectionPosition(){if(this._selectionService&&this._selectionService.hasSelection)return{start:{x:this._selectionService.selectionStart[0],y:this._selectionService.selectionStart[1]},end:{x:this._selectionService.selectionEnd[0],y:this._selectionService.selectionEnd[1]}}}clearSelection(){this._selectionService?.clearSelection()}selectAll(){this._selectionService?.selectAll()}selectLines(e,t){this._selectionService?.selectLines(e,t)}_keyDown(e){if(this._keyDownHandled=!1,this._keyDownSeen=!0,this._customKeyEventHandler&&!1===this._customKeyEventHandler(e))return!1;const t=this.browser.isMac&&this.options.macOptionIsMeta&&e.altKey;if(!t&&!this._compositionHelper.keydown(e))return this.options.scrollOnUserInput&&this.buffer.ybase!==this.buffer.ydisp&&this.scrollToBottom(),!1;t||"Dead"!==e.key&&"AltGraph"!==e.key||(this._unprocessedDeadKey=!0);const i=(0,R.evaluateKeyboardEvent)(e,this.coreService.decPrivateModes.applicationCursorKeys,this.browser.isMac,this.options.macOptionIsMeta);if(this.updateCursorStyle(e),3===i.type||2===i.type){const t=this.rows-1;return this.scrollLines(2===i.type?-t:t),this.cancel(e,!0)}return 1===i.type&&this.selectAll(),!!this._isThirdLevelShift(this.browser,e)||(i.cancel&&this.cancel(e,!0),!i.key||!!(e.key&&!e.ctrlKey&&!e.altKey&&!e.metaKey&&1===e.key.length&&e.key.charCodeAt(0)>=65&&e.key.charCodeAt(0)<=90)||(this._unprocessedDeadKey?(this._unprocessedDeadKey=!1,!0):(i.key!==D.C0.ETX&&i.key!==D.C0.CR||(this.textarea.value=""),this._onKey.fire({key:i.key,domEvent:e}),this._showCursor(),this.coreService.triggerDataEvent(i.key,!0),!this.optionsService.rawOptions.screenReaderMode||e.altKey||e.ctrlKey?this.cancel(e,!0):void(this._keyDownHandled=!0))))}_isThirdLevelShift(e,t){const i=e.isMac&&!this.options.macOptionIsMeta&&t.altKey&&!t.ctrlKey&&!t.metaKey||e.isWindows&&t.altKey&&t.ctrlKey&&!t.metaKey||e.isWindows&&t.getModifierState("AltGraph");return"keypress"===t.type?i:i&&(!t.keyCode||t.keyCode>47)}_keyUp(e){this._keyDownSeen=!1,this._customKeyEventHandler&&!1===this._customKeyEventHandler(e)||(function(e){return 16===e.keyCode||17===e.keyCode||18===e.keyCode}(e)||this.focus(),this.updateCursorStyle(e),this._keyPressHandled=!1)}_keyPress(e){let t;if(this._keyPressHandled=!1,this._keyDownHandled)return!1;if(this._customKeyEventHandler&&!1===this._customKeyEventHandler(e))return!1;if(this.cancel(e),e.charCode)t=e.charCode;else if(null===e.which||void 0===e.which)t=e.keyCode;else{if(0===e.which||0===e.charCode)return!1;t=e.which}return!(!t||(e.altKey||e.ctrlKey||e.metaKey)&&!this._isThirdLevelShift(this.browser,e)||(t=String.fromCharCode(t),this._onKey.fire({key:t,domEvent:e}),this._showCursor(),this.coreService.triggerDataEvent(t,!0),this._keyPressHandled=!0,this._unprocessedDeadKey=!1,0))}_inputEvent(e){if(e.data&&"insertText"===e.inputType&&(!e.composed||!this._keyDownSeen)&&!this.optionsService.rawOptions.screenReaderMode){if(this._keyPressHandled)return!1;this._unprocessedDeadKey=!1;const t=e.data;return this.coreService.triggerDataEvent(t,!0),this.cancel(e),!0}return!1}resize(e,t){e!==this.cols||t!==this.rows?super.resize(e,t):this._charSizeService&&!this._charSizeService.hasValidSize&&this._charSizeService.measure()}_afterResize(e,t){this._charSizeService?.measure(),this.viewport?.syncScrollArea(!0)}clear(){if(0!==this.buffer.ybase||0!==this.buffer.y){this.buffer.clearAllMarkers(),this.buffer.lines.set(0,this.buffer.lines.get(this.buffer.ybase+this.buffer.y)),this.buffer.lines.length=1,this.buffer.ydisp=0,this.buffer.ybase=0,this.buffer.y=0;for(let e=1;e{Object.defineProperty(t,"__esModule",{value:!0}),t.TimeBasedDebouncer=void 0,t.TimeBasedDebouncer=class{constructor(e,t=1e3){this._renderCallback=e,this._debounceThresholdMS=t,this._lastRefreshMs=0,this._additionalRefreshRequested=!1}dispose(){this._refreshTimeoutID&&clearTimeout(this._refreshTimeoutID)}refresh(e,t,i){this._rowCount=i,e=void 0!==e?e:0,t=void 0!==t?t:this._rowCount-1,this._rowStart=void 0!==this._rowStart?Math.min(this._rowStart,e):e,this._rowEnd=void 0!==this._rowEnd?Math.max(this._rowEnd,t):t;const s=Date.now();if(s-this._lastRefreshMs>=this._debounceThresholdMS)this._lastRefreshMs=s,this._innerRefresh();else if(!this._additionalRefreshRequested){const e=s-this._lastRefreshMs,t=this._debounceThresholdMS-e;this._additionalRefreshRequested=!0,this._refreshTimeoutID=window.setTimeout((()=>{this._lastRefreshMs=Date.now(),this._innerRefresh(),this._additionalRefreshRequested=!1,this._refreshTimeoutID=void 0}),t)}}_innerRefresh(){if(void 0===this._rowStart||void 0===this._rowEnd||void 0===this._rowCount)return;const e=Math.max(this._rowStart,0),t=Math.min(this._rowEnd,this._rowCount-1);this._rowStart=void 0,this._rowEnd=void 0,this._renderCallback(e,t)}}},1680:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.Viewport=void 0;const n=i(3656),o=i(4725),a=i(8460),h=i(844),c=i(2585);let l=t.Viewport=class extends h.Disposable{constructor(e,t,i,s,r,o,h,c){super(),this._viewportElement=e,this._scrollArea=t,this._bufferService=i,this._optionsService=s,this._charSizeService=r,this._renderService=o,this._coreBrowserService=h,this.scrollBarWidth=0,this._currentRowHeight=0,this._currentDeviceCellHeight=0,this._lastRecordedBufferLength=0,this._lastRecordedViewportHeight=0,this._lastRecordedBufferHeight=0,this._lastTouchY=0,this._lastScrollTop=0,this._wheelPartialScroll=0,this._refreshAnimationFrame=null,this._ignoreNextScrollEvent=!1,this._smoothScrollState={startTime:0,origin:-1,target:-1},this._onRequestScrollLines=this.register(new a.EventEmitter),this.onRequestScrollLines=this._onRequestScrollLines.event,this.scrollBarWidth=this._viewportElement.offsetWidth-this._scrollArea.offsetWidth||15,this.register((0,n.addDisposableDomListener)(this._viewportElement,"scroll",this._handleScroll.bind(this))),this._activeBuffer=this._bufferService.buffer,this.register(this._bufferService.buffers.onBufferActivate((e=>this._activeBuffer=e.activeBuffer))),this._renderDimensions=this._renderService.dimensions,this.register(this._renderService.onDimensionsChange((e=>this._renderDimensions=e))),this._handleThemeChange(c.colors),this.register(c.onChangeColors((e=>this._handleThemeChange(e)))),this.register(this._optionsService.onSpecificOptionChange("scrollback",(()=>this.syncScrollArea()))),setTimeout((()=>this.syncScrollArea()))}_handleThemeChange(e){this._viewportElement.style.backgroundColor=e.background.css}reset(){this._currentRowHeight=0,this._currentDeviceCellHeight=0,this._lastRecordedBufferLength=0,this._lastRecordedViewportHeight=0,this._lastRecordedBufferHeight=0,this._lastTouchY=0,this._lastScrollTop=0,this._coreBrowserService.window.requestAnimationFrame((()=>this.syncScrollArea()))}_refresh(e){if(e)return this._innerRefresh(),void(null!==this._refreshAnimationFrame&&this._coreBrowserService.window.cancelAnimationFrame(this._refreshAnimationFrame));null===this._refreshAnimationFrame&&(this._refreshAnimationFrame=this._coreBrowserService.window.requestAnimationFrame((()=>this._innerRefresh())))}_innerRefresh(){if(this._charSizeService.height>0){this._currentRowHeight=this._renderDimensions.device.cell.height/this._coreBrowserService.dpr,this._currentDeviceCellHeight=this._renderDimensions.device.cell.height,this._lastRecordedViewportHeight=this._viewportElement.offsetHeight;const e=Math.round(this._currentRowHeight*this._lastRecordedBufferLength)+(this._lastRecordedViewportHeight-this._renderDimensions.css.canvas.height);this._lastRecordedBufferHeight!==e&&(this._lastRecordedBufferHeight=e,this._scrollArea.style.height=this._lastRecordedBufferHeight+"px")}const e=this._bufferService.buffer.ydisp*this._currentRowHeight;this._viewportElement.scrollTop!==e&&(this._ignoreNextScrollEvent=!0,this._viewportElement.scrollTop=e),this._refreshAnimationFrame=null}syncScrollArea(e=!1){if(this._lastRecordedBufferLength!==this._bufferService.buffer.lines.length)return this._lastRecordedBufferLength=this._bufferService.buffer.lines.length,void this._refresh(e);this._lastRecordedViewportHeight===this._renderService.dimensions.css.canvas.height&&this._lastScrollTop===this._activeBuffer.ydisp*this._currentRowHeight&&this._renderDimensions.device.cell.height===this._currentDeviceCellHeight||this._refresh(e)}_handleScroll(e){if(this._lastScrollTop=this._viewportElement.scrollTop,!this._viewportElement.offsetParent)return;if(this._ignoreNextScrollEvent)return this._ignoreNextScrollEvent=!1,void this._onRequestScrollLines.fire({amount:0,suppressScrollEvent:!0});const t=Math.round(this._lastScrollTop/this._currentRowHeight)-this._bufferService.buffer.ydisp;this._onRequestScrollLines.fire({amount:t,suppressScrollEvent:!0})}_smoothScroll(){if(this._isDisposed||-1===this._smoothScrollState.origin||-1===this._smoothScrollState.target)return;const e=this._smoothScrollPercent();this._viewportElement.scrollTop=this._smoothScrollState.origin+Math.round(e*(this._smoothScrollState.target-this._smoothScrollState.origin)),e<1?this._coreBrowserService.window.requestAnimationFrame((()=>this._smoothScroll())):this._clearSmoothScrollState()}_smoothScrollPercent(){return this._optionsService.rawOptions.smoothScrollDuration&&this._smoothScrollState.startTime?Math.max(Math.min((Date.now()-this._smoothScrollState.startTime)/this._optionsService.rawOptions.smoothScrollDuration,1),0):1}_clearSmoothScrollState(){this._smoothScrollState.startTime=0,this._smoothScrollState.origin=-1,this._smoothScrollState.target=-1}_bubbleScroll(e,t){const i=this._viewportElement.scrollTop+this._lastRecordedViewportHeight;return!(t<0&&0!==this._viewportElement.scrollTop||t>0&&i0&&(i=e),s=""}}return{bufferElements:r,cursorElement:i}}getLinesScrolled(e){if(0===e.deltaY||e.shiftKey)return 0;let t=this._applyScrollModifier(e.deltaY,e);return e.deltaMode===WheelEvent.DOM_DELTA_PIXEL?(t/=this._currentRowHeight+0,this._wheelPartialScroll+=t,t=Math.floor(Math.abs(this._wheelPartialScroll))*(this._wheelPartialScroll>0?1:-1),this._wheelPartialScroll%=1):e.deltaMode===WheelEvent.DOM_DELTA_PAGE&&(t*=this._bufferService.rows),t}_applyScrollModifier(e,t){const i=this._optionsService.rawOptions.fastScrollModifier;return"alt"===i&&t.altKey||"ctrl"===i&&t.ctrlKey||"shift"===i&&t.shiftKey?e*this._optionsService.rawOptions.fastScrollSensitivity*this._optionsService.rawOptions.scrollSensitivity:e*this._optionsService.rawOptions.scrollSensitivity}handleTouchStart(e){this._lastTouchY=e.touches[0].pageY}handleTouchMove(e){const t=this._lastTouchY-e.touches[0].pageY;return this._lastTouchY=e.touches[0].pageY,0!==t&&(this._viewportElement.scrollTop+=t,this._bubbleScroll(e,t))}};t.Viewport=l=s([r(2,c.IBufferService),r(3,c.IOptionsService),r(4,o.ICharSizeService),r(5,o.IRenderService),r(6,o.ICoreBrowserService),r(7,o.IThemeService)],l)},3107:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.BufferDecorationRenderer=void 0;const n=i(4725),o=i(844),a=i(2585);let h=t.BufferDecorationRenderer=class extends o.Disposable{constructor(e,t,i,s,r){super(),this._screenElement=e,this._bufferService=t,this._coreBrowserService=i,this._decorationService=s,this._renderService=r,this._decorationElements=new Map,this._altBufferIsActive=!1,this._dimensionsChanged=!1,this._container=document.createElement("div"),this._container.classList.add("xterm-decoration-container"),this._screenElement.appendChild(this._container),this.register(this._renderService.onRenderedViewportChange((()=>this._doRefreshDecorations()))),this.register(this._renderService.onDimensionsChange((()=>{this._dimensionsChanged=!0,this._queueRefresh()}))),this.register(this._coreBrowserService.onDprChange((()=>this._queueRefresh()))),this.register(this._bufferService.buffers.onBufferActivate((()=>{this._altBufferIsActive=this._bufferService.buffer===this._bufferService.buffers.alt}))),this.register(this._decorationService.onDecorationRegistered((()=>this._queueRefresh()))),this.register(this._decorationService.onDecorationRemoved((e=>this._removeDecoration(e)))),this.register((0,o.toDisposable)((()=>{this._container.remove(),this._decorationElements.clear()})))}_queueRefresh(){void 0===this._animationFrame&&(this._animationFrame=this._renderService.addRefreshCallback((()=>{this._doRefreshDecorations(),this._animationFrame=void 0})))}_doRefreshDecorations(){for(const e of this._decorationService.decorations)this._renderDecoration(e);this._dimensionsChanged=!1}_renderDecoration(e){this._refreshStyle(e),this._dimensionsChanged&&this._refreshXPosition(e)}_createElement(e){const t=this._coreBrowserService.mainDocument.createElement("div");t.classList.add("xterm-decoration"),t.classList.toggle("xterm-decoration-top-layer","top"===e?.options?.layer),t.style.width=`${Math.round((e.options.width||1)*this._renderService.dimensions.css.cell.width)}px`,t.style.height=(e.options.height||1)*this._renderService.dimensions.css.cell.height+"px",t.style.top=(e.marker.line-this._bufferService.buffers.active.ydisp)*this._renderService.dimensions.css.cell.height+"px",t.style.lineHeight=`${this._renderService.dimensions.css.cell.height}px`;const i=e.options.x??0;return i&&i>this._bufferService.cols&&(t.style.display="none"),this._refreshXPosition(e,t),t}_refreshStyle(e){const t=e.marker.line-this._bufferService.buffers.active.ydisp;if(t<0||t>=this._bufferService.rows)e.element&&(e.element.style.display="none",e.onRenderEmitter.fire(e.element));else{let i=this._decorationElements.get(e);i||(i=this._createElement(e),e.element=i,this._decorationElements.set(e,i),this._container.appendChild(i),e.onDispose((()=>{this._decorationElements.delete(e),i.remove()}))),i.style.top=t*this._renderService.dimensions.css.cell.height+"px",i.style.display=this._altBufferIsActive?"none":"block",e.onRenderEmitter.fire(i)}}_refreshXPosition(e,t=e.element){if(!t)return;const i=e.options.x??0;"right"===(e.options.anchor||"left")?t.style.right=i?i*this._renderService.dimensions.css.cell.width+"px":"":t.style.left=i?i*this._renderService.dimensions.css.cell.width+"px":""}_removeDecoration(e){this._decorationElements.get(e)?.remove(),this._decorationElements.delete(e),e.dispose()}};t.BufferDecorationRenderer=h=s([r(1,a.IBufferService),r(2,n.ICoreBrowserService),r(3,a.IDecorationService),r(4,n.IRenderService)],h)},5871:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.ColorZoneStore=void 0,t.ColorZoneStore=class{constructor(){this._zones=[],this._zonePool=[],this._zonePoolIndex=0,this._linePadding={full:0,left:0,center:0,right:0}}get zones(){return this._zonePool.length=Math.min(this._zonePool.length,this._zones.length),this._zones}clear(){this._zones.length=0,this._zonePoolIndex=0}addDecoration(e){if(e.options.overviewRulerOptions){for(const t of this._zones)if(t.color===e.options.overviewRulerOptions.color&&t.position===e.options.overviewRulerOptions.position){if(this._lineIntersectsZone(t,e.marker.line))return;if(this._lineAdjacentToZone(t,e.marker.line,e.options.overviewRulerOptions.position))return void this._addLineToZone(t,e.marker.line)}if(this._zonePoolIndex=e.startBufferLine&&t<=e.endBufferLine}_lineAdjacentToZone(e,t,i){return t>=e.startBufferLine-this._linePadding[i||"full"]&&t<=e.endBufferLine+this._linePadding[i||"full"]}_addLineToZone(e,t){e.startBufferLine=Math.min(e.startBufferLine,t),e.endBufferLine=Math.max(e.endBufferLine,t)}}},5744:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.OverviewRulerRenderer=void 0;const n=i(5871),o=i(4725),a=i(844),h=i(2585),c={full:0,left:0,center:0,right:0},l={full:0,left:0,center:0,right:0},d={full:0,left:0,center:0,right:0};let _=t.OverviewRulerRenderer=class extends a.Disposable{get _width(){return this._optionsService.options.overviewRulerWidth||0}constructor(e,t,i,s,r,o,h){super(),this._viewportElement=e,this._screenElement=t,this._bufferService=i,this._decorationService=s,this._renderService=r,this._optionsService=o,this._coreBrowserService=h,this._colorZoneStore=new n.ColorZoneStore,this._shouldUpdateDimensions=!0,this._shouldUpdateAnchor=!0,this._lastKnownBufferLength=0,this._canvas=this._coreBrowserService.mainDocument.createElement("canvas"),this._canvas.classList.add("xterm-decoration-overview-ruler"),this._refreshCanvasDimensions(),this._viewportElement.parentElement?.insertBefore(this._canvas,this._viewportElement);const c=this._canvas.getContext("2d");if(!c)throw new Error("Ctx cannot be null");this._ctx=c,this._registerDecorationListeners(),this._registerBufferChangeListeners(),this._registerDimensionChangeListeners(),this.register((0,a.toDisposable)((()=>{this._canvas?.remove()})))}_registerDecorationListeners(){this.register(this._decorationService.onDecorationRegistered((()=>this._queueRefresh(void 0,!0)))),this.register(this._decorationService.onDecorationRemoved((()=>this._queueRefresh(void 0,!0))))}_registerBufferChangeListeners(){this.register(this._renderService.onRenderedViewportChange((()=>this._queueRefresh()))),this.register(this._bufferService.buffers.onBufferActivate((()=>{this._canvas.style.display=this._bufferService.buffer===this._bufferService.buffers.alt?"none":"block"}))),this.register(this._bufferService.onScroll((()=>{this._lastKnownBufferLength!==this._bufferService.buffers.normal.lines.length&&(this._refreshDrawHeightConstants(),this._refreshColorZonePadding())})))}_registerDimensionChangeListeners(){this.register(this._renderService.onRender((()=>{this._containerHeight&&this._containerHeight===this._screenElement.clientHeight||(this._queueRefresh(!0),this._containerHeight=this._screenElement.clientHeight)}))),this.register(this._optionsService.onSpecificOptionChange("overviewRulerWidth",(()=>this._queueRefresh(!0)))),this.register(this._coreBrowserService.onDprChange((()=>this._queueRefresh(!0)))),this._queueRefresh(!0)}_refreshDrawConstants(){const e=Math.floor(this._canvas.width/3),t=Math.ceil(this._canvas.width/3);l.full=this._canvas.width,l.left=e,l.center=t,l.right=e,this._refreshDrawHeightConstants(),d.full=0,d.left=0,d.center=l.left,d.right=l.left+l.center}_refreshDrawHeightConstants(){c.full=Math.round(2*this._coreBrowserService.dpr);const e=this._canvas.height/this._bufferService.buffer.lines.length,t=Math.round(Math.max(Math.min(e,12),6)*this._coreBrowserService.dpr);c.left=t,c.center=t,c.right=t}_refreshColorZonePadding(){this._colorZoneStore.setPadding({full:Math.floor(this._bufferService.buffers.active.lines.length/(this._canvas.height-1)*c.full),left:Math.floor(this._bufferService.buffers.active.lines.length/(this._canvas.height-1)*c.left),center:Math.floor(this._bufferService.buffers.active.lines.length/(this._canvas.height-1)*c.center),right:Math.floor(this._bufferService.buffers.active.lines.length/(this._canvas.height-1)*c.right)}),this._lastKnownBufferLength=this._bufferService.buffers.normal.lines.length}_refreshCanvasDimensions(){this._canvas.style.width=`${this._width}px`,this._canvas.width=Math.round(this._width*this._coreBrowserService.dpr),this._canvas.style.height=`${this._screenElement.clientHeight}px`,this._canvas.height=Math.round(this._screenElement.clientHeight*this._coreBrowserService.dpr),this._refreshDrawConstants(),this._refreshColorZonePadding()}_refreshDecorations(){this._shouldUpdateDimensions&&this._refreshCanvasDimensions(),this._ctx.clearRect(0,0,this._canvas.width,this._canvas.height),this._colorZoneStore.clear();for(const e of this._decorationService.decorations)this._colorZoneStore.addDecoration(e);this._ctx.lineWidth=1;const e=this._colorZoneStore.zones;for(const t of e)"full"!==t.position&&this._renderColorZone(t);for(const t of e)"full"===t.position&&this._renderColorZone(t);this._shouldUpdateDimensions=!1,this._shouldUpdateAnchor=!1}_renderColorZone(e){this._ctx.fillStyle=e.color,this._ctx.fillRect(d[e.position||"full"],Math.round((this._canvas.height-1)*(e.startBufferLine/this._bufferService.buffers.active.lines.length)-c[e.position||"full"]/2),l[e.position||"full"],Math.round((this._canvas.height-1)*((e.endBufferLine-e.startBufferLine)/this._bufferService.buffers.active.lines.length)+c[e.position||"full"]))}_queueRefresh(e,t){this._shouldUpdateDimensions=e||this._shouldUpdateDimensions,this._shouldUpdateAnchor=t||this._shouldUpdateAnchor,void 0===this._animationFrame&&(this._animationFrame=this._coreBrowserService.window.requestAnimationFrame((()=>{this._refreshDecorations(),this._animationFrame=void 0})))}};t.OverviewRulerRenderer=_=s([r(2,h.IBufferService),r(3,h.IDecorationService),r(4,o.IRenderService),r(5,h.IOptionsService),r(6,o.ICoreBrowserService)],_)},2950:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.CompositionHelper=void 0;const n=i(4725),o=i(2585),a=i(2584);let h=t.CompositionHelper=class{get isComposing(){return this._isComposing}constructor(e,t,i,s,r,n){this._textarea=e,this._compositionView=t,this._bufferService=i,this._optionsService=s,this._coreService=r,this._renderService=n,this._isComposing=!1,this._isSendingComposition=!1,this._compositionPosition={start:0,end:0},this._dataAlreadySent=""}compositionstart(){this._isComposing=!0,this._compositionPosition.start=this._textarea.value.length,this._compositionView.textContent="",this._dataAlreadySent="",this._compositionView.classList.add("active")}compositionupdate(e){this._compositionView.textContent=e.data,this.updateCompositionElements(),setTimeout((()=>{this._compositionPosition.end=this._textarea.value.length}),0)}compositionend(){this._finalizeComposition(!0)}keydown(e){if(this._isComposing||this._isSendingComposition){if(229===e.keyCode)return!1;if(16===e.keyCode||17===e.keyCode||18===e.keyCode)return!1;this._finalizeComposition(!1)}return 229!==e.keyCode||(this._handleAnyTextareaChanges(),!1)}_finalizeComposition(e){if(this._compositionView.classList.remove("active"),this._isComposing=!1,e){const e={start:this._compositionPosition.start,end:this._compositionPosition.end};this._isSendingComposition=!0,setTimeout((()=>{if(this._isSendingComposition){let t;this._isSendingComposition=!1,e.start+=this._dataAlreadySent.length,t=this._isComposing?this._textarea.value.substring(e.start,e.end):this._textarea.value.substring(e.start),t.length>0&&this._coreService.triggerDataEvent(t,!0)}}),0)}else{this._isSendingComposition=!1;const e=this._textarea.value.substring(this._compositionPosition.start,this._compositionPosition.end);this._coreService.triggerDataEvent(e,!0)}}_handleAnyTextareaChanges(){const e=this._textarea.value;setTimeout((()=>{if(!this._isComposing){const t=this._textarea.value,i=t.replace(e,"");this._dataAlreadySent=i,t.length>e.length?this._coreService.triggerDataEvent(i,!0):t.lengththis.updateCompositionElements(!0)),0)}}};t.CompositionHelper=h=s([r(2,o.IBufferService),r(3,o.IOptionsService),r(4,o.ICoreService),r(5,n.IRenderService)],h)},9806:(e,t)=>{function i(e,t,i){const s=i.getBoundingClientRect(),r=e.getComputedStyle(i),n=parseInt(r.getPropertyValue("padding-left")),o=parseInt(r.getPropertyValue("padding-top"));return[t.clientX-s.left-n,t.clientY-s.top-o]}Object.defineProperty(t,"__esModule",{value:!0}),t.getCoords=t.getCoordsRelativeToElement=void 0,t.getCoordsRelativeToElement=i,t.getCoords=function(e,t,s,r,n,o,a,h,c){if(!o)return;const l=i(e,t,s);return l?(l[0]=Math.ceil((l[0]+(c?a/2:0))/a),l[1]=Math.ceil(l[1]/h),l[0]=Math.min(Math.max(l[0],1),r+(c?1:0)),l[1]=Math.min(Math.max(l[1],1),n),l):void 0}},9504:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.moveToCellSequence=void 0;const s=i(2584);function r(e,t,i,s){const r=e-n(e,i),a=t-n(t,i),l=Math.abs(r-a)-function(e,t,i){let s=0;const r=e-n(e,i),a=t-n(t,i);for(let n=0;n=0&&et?"A":"B"}function a(e,t,i,s,r,n){let o=e,a=t,h="";for(;o!==i||a!==s;)o+=r?1:-1,r&&o>n.cols-1?(h+=n.buffer.translateBufferLineToString(a,!1,e,o),o=0,e=0,a++):!r&&o<0&&(h+=n.buffer.translateBufferLineToString(a,!1,0,e+1),o=n.cols-1,e=o,a--);return h+n.buffer.translateBufferLineToString(a,!1,e,o)}function h(e,t){const i=t?"O":"[";return s.C0.ESC+i+e}function c(e,t){e=Math.floor(e);let i="";for(let s=0;s0?s-n(s,o):t;const _=s,u=function(e,t,i,s,o,a){let h;return h=r(i,s,o,a).length>0?s-n(s,o):t,e=i&&he?"D":"C",c(Math.abs(o-e),h(d,s));d=l>t?"D":"C";const _=Math.abs(l-t);return c(function(e,t){return t.cols-e}(l>t?e:o,i)+(_-1)*i.cols+1+((l>t?o:e)-1),h(d,s))}},1296:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.DomRenderer=void 0;const n=i(3787),o=i(2550),a=i(2223),h=i(6171),c=i(6052),l=i(4725),d=i(8055),_=i(8460),u=i(844),f=i(2585),v="xterm-dom-renderer-owner-",p="xterm-rows",g="xterm-fg-",m="xterm-bg-",S="xterm-focus",C="xterm-selection";let b=1,w=t.DomRenderer=class extends u.Disposable{constructor(e,t,i,s,r,a,l,d,f,g,m,S,w){super(),this._terminal=e,this._document=t,this._element=i,this._screenElement=s,this._viewportElement=r,this._helperContainer=a,this._linkifier2=l,this._charSizeService=f,this._optionsService=g,this._bufferService=m,this._coreBrowserService=S,this._themeService=w,this._terminalClass=b++,this._rowElements=[],this._selectionRenderModel=(0,c.createSelectionRenderModel)(),this.onRequestRedraw=this.register(new _.EventEmitter).event,this._rowContainer=this._document.createElement("div"),this._rowContainer.classList.add(p),this._rowContainer.style.lineHeight="normal",this._rowContainer.setAttribute("aria-hidden","true"),this._refreshRowElements(this._bufferService.cols,this._bufferService.rows),this._selectionContainer=this._document.createElement("div"),this._selectionContainer.classList.add(C),this._selectionContainer.setAttribute("aria-hidden","true"),this.dimensions=(0,h.createRenderDimensions)(),this._updateDimensions(),this.register(this._optionsService.onOptionChange((()=>this._handleOptionsChanged()))),this.register(this._themeService.onChangeColors((e=>this._injectCss(e)))),this._injectCss(this._themeService.colors),this._rowFactory=d.createInstance(n.DomRendererRowFactory,document),this._element.classList.add(v+this._terminalClass),this._screenElement.appendChild(this._rowContainer),this._screenElement.appendChild(this._selectionContainer),this.register(this._linkifier2.onShowLinkUnderline((e=>this._handleLinkHover(e)))),this.register(this._linkifier2.onHideLinkUnderline((e=>this._handleLinkLeave(e)))),this.register((0,u.toDisposable)((()=>{this._element.classList.remove(v+this._terminalClass),this._rowContainer.remove(),this._selectionContainer.remove(),this._widthCache.dispose(),this._themeStyleElement.remove(),this._dimensionsStyleElement.remove()}))),this._widthCache=new o.WidthCache(this._document,this._helperContainer),this._widthCache.setFont(this._optionsService.rawOptions.fontFamily,this._optionsService.rawOptions.fontSize,this._optionsService.rawOptions.fontWeight,this._optionsService.rawOptions.fontWeightBold),this._setDefaultSpacing()}_updateDimensions(){const e=this._coreBrowserService.dpr;this.dimensions.device.char.width=this._charSizeService.width*e,this.dimensions.device.char.height=Math.ceil(this._charSizeService.height*e),this.dimensions.device.cell.width=this.dimensions.device.char.width+Math.round(this._optionsService.rawOptions.letterSpacing),this.dimensions.device.cell.height=Math.floor(this.dimensions.device.char.height*this._optionsService.rawOptions.lineHeight),this.dimensions.device.char.left=0,this.dimensions.device.char.top=0,this.dimensions.device.canvas.width=this.dimensions.device.cell.width*this._bufferService.cols,this.dimensions.device.canvas.height=this.dimensions.device.cell.height*this._bufferService.rows,this.dimensions.css.canvas.width=Math.round(this.dimensions.device.canvas.width/e),this.dimensions.css.canvas.height=Math.round(this.dimensions.device.canvas.height/e),this.dimensions.css.cell.width=this.dimensions.css.canvas.width/this._bufferService.cols,this.dimensions.css.cell.height=this.dimensions.css.canvas.height/this._bufferService.rows;for(const e of this._rowElements)e.style.width=`${this.dimensions.css.canvas.width}px`,e.style.height=`${this.dimensions.css.cell.height}px`,e.style.lineHeight=`${this.dimensions.css.cell.height}px`,e.style.overflow="hidden";this._dimensionsStyleElement||(this._dimensionsStyleElement=this._document.createElement("style"),this._screenElement.appendChild(this._dimensionsStyleElement));const t=`${this._terminalSelector} .${p} span { display: inline-block; height: 100%; vertical-align: top;}`;this._dimensionsStyleElement.textContent=t,this._selectionContainer.style.height=this._viewportElement.style.height,this._screenElement.style.width=`${this.dimensions.css.canvas.width}px`,this._screenElement.style.height=`${this.dimensions.css.canvas.height}px`}_injectCss(e){this._themeStyleElement||(this._themeStyleElement=this._document.createElement("style"),this._screenElement.appendChild(this._themeStyleElement));let t=`${this._terminalSelector} .${p} { color: ${e.foreground.css}; font-family: ${this._optionsService.rawOptions.fontFamily}; font-size: ${this._optionsService.rawOptions.fontSize}px; font-kerning: none; white-space: pre}`;t+=`${this._terminalSelector} .${p} .xterm-dim { color: ${d.color.multiplyOpacity(e.foreground,.5).css};}`,t+=`${this._terminalSelector} span:not(.xterm-bold) { font-weight: ${this._optionsService.rawOptions.fontWeight};}${this._terminalSelector} span.xterm-bold { font-weight: ${this._optionsService.rawOptions.fontWeightBold};}${this._terminalSelector} span.xterm-italic { font-style: italic;}`;const i=`blink_underline_${this._terminalClass}`,s=`blink_bar_${this._terminalClass}`,r=`blink_block_${this._terminalClass}`;t+=`@keyframes ${i} { 50% { border-bottom-style: hidden; }}`,t+=`@keyframes ${s} { 50% { box-shadow: none; }}`,t+=`@keyframes ${r} { 0% { background-color: ${e.cursor.css}; color: ${e.cursorAccent.css}; } 50% { background-color: inherit; color: ${e.cursor.css}; }}`,t+=`${this._terminalSelector} .${p}.${S} .xterm-cursor.xterm-cursor-blink.xterm-cursor-underline { animation: ${i} 1s step-end infinite;}${this._terminalSelector} .${p}.${S} .xterm-cursor.xterm-cursor-blink.xterm-cursor-bar { animation: ${s} 1s step-end infinite;}${this._terminalSelector} .${p}.${S} .xterm-cursor.xterm-cursor-blink.xterm-cursor-block { animation: ${r} 1s step-end infinite;}${this._terminalSelector} .${p} .xterm-cursor.xterm-cursor-block { background-color: ${e.cursor.css}; color: ${e.cursorAccent.css};}${this._terminalSelector} .${p} .xterm-cursor.xterm-cursor-block:not(.xterm-cursor-blink) { background-color: ${e.cursor.css} !important; color: ${e.cursorAccent.css} !important;}${this._terminalSelector} .${p} .xterm-cursor.xterm-cursor-outline { outline: 1px solid ${e.cursor.css}; outline-offset: -1px;}${this._terminalSelector} .${p} .xterm-cursor.xterm-cursor-bar { box-shadow: ${this._optionsService.rawOptions.cursorWidth}px 0 0 ${e.cursor.css} inset;}${this._terminalSelector} .${p} .xterm-cursor.xterm-cursor-underline { border-bottom: 1px ${e.cursor.css}; border-bottom-style: solid; height: calc(100% - 1px);}`,t+=`${this._terminalSelector} .${C} { position: absolute; top: 0; left: 0; z-index: 1; pointer-events: none;}${this._terminalSelector}.focus .${C} div { position: absolute; background-color: ${e.selectionBackgroundOpaque.css};}${this._terminalSelector} .${C} div { position: absolute; background-color: ${e.selectionInactiveBackgroundOpaque.css};}`;for(const[i,s]of e.ansi.entries())t+=`${this._terminalSelector} .${g}${i} { color: ${s.css}; }${this._terminalSelector} .${g}${i}.xterm-dim { color: ${d.color.multiplyOpacity(s,.5).css}; }${this._terminalSelector} .${m}${i} { background-color: ${s.css}; }`;t+=`${this._terminalSelector} .${g}${a.INVERTED_DEFAULT_COLOR} { color: ${d.color.opaque(e.background).css}; }${this._terminalSelector} .${g}${a.INVERTED_DEFAULT_COLOR}.xterm-dim { color: ${d.color.multiplyOpacity(d.color.opaque(e.background),.5).css}; }${this._terminalSelector} .${m}${a.INVERTED_DEFAULT_COLOR} { background-color: ${e.foreground.css}; }`,this._themeStyleElement.textContent=t}_setDefaultSpacing(){const e=this.dimensions.css.cell.width-this._widthCache.get("W",!1,!1);this._rowContainer.style.letterSpacing=`${e}px`,this._rowFactory.defaultSpacing=e}handleDevicePixelRatioChange(){this._updateDimensions(),this._widthCache.clear(),this._setDefaultSpacing()}_refreshRowElements(e,t){for(let e=this._rowElements.length;e<=t;e++){const e=this._document.createElement("div");this._rowContainer.appendChild(e),this._rowElements.push(e)}for(;this._rowElements.length>t;)this._rowContainer.removeChild(this._rowElements.pop())}handleResize(e,t){this._refreshRowElements(e,t),this._updateDimensions(),this.handleSelectionChanged(this._selectionRenderModel.selectionStart,this._selectionRenderModel.selectionEnd,this._selectionRenderModel.columnSelectMode)}handleCharSizeChanged(){this._updateDimensions(),this._widthCache.clear(),this._setDefaultSpacing()}handleBlur(){this._rowContainer.classList.remove(S),this.renderRows(0,this._bufferService.rows-1)}handleFocus(){this._rowContainer.classList.add(S),this.renderRows(this._bufferService.buffer.y,this._bufferService.buffer.y)}handleSelectionChanged(e,t,i){if(this._selectionContainer.replaceChildren(),this._rowFactory.handleSelectionChanged(e,t,i),this.renderRows(0,this._bufferService.rows-1),!e||!t)return;this._selectionRenderModel.update(this._terminal,e,t,i);const s=this._selectionRenderModel.viewportStartRow,r=this._selectionRenderModel.viewportEndRow,n=this._selectionRenderModel.viewportCappedStartRow,o=this._selectionRenderModel.viewportCappedEndRow;if(n>=this._bufferService.rows||o<0)return;const a=this._document.createDocumentFragment();if(i){const i=e[0]>t[0];a.appendChild(this._createSelectionElement(n,i?t[0]:e[0],i?e[0]:t[0],o-n+1))}else{const i=s===n?e[0]:0,h=n===r?t[0]:this._bufferService.cols;a.appendChild(this._createSelectionElement(n,i,h));const c=o-n-1;if(a.appendChild(this._createSelectionElement(n+1,0,this._bufferService.cols,c)),n!==o){const e=r===o?t[0]:this._bufferService.cols;a.appendChild(this._createSelectionElement(o,0,e))}}this._selectionContainer.appendChild(a)}_createSelectionElement(e,t,i,s=1){const r=this._document.createElement("div"),n=t*this.dimensions.css.cell.width;let o=this.dimensions.css.cell.width*(i-t);return n+o>this.dimensions.css.canvas.width&&(o=this.dimensions.css.canvas.width-n),r.style.height=s*this.dimensions.css.cell.height+"px",r.style.top=e*this.dimensions.css.cell.height+"px",r.style.left=`${n}px`,r.style.width=`${o}px`,r}handleCursorMove(){}_handleOptionsChanged(){this._updateDimensions(),this._injectCss(this._themeService.colors),this._widthCache.setFont(this._optionsService.rawOptions.fontFamily,this._optionsService.rawOptions.fontSize,this._optionsService.rawOptions.fontWeight,this._optionsService.rawOptions.fontWeightBold),this._setDefaultSpacing()}clear(){for(const e of this._rowElements)e.replaceChildren()}renderRows(e,t){const i=this._bufferService.buffer,s=i.ybase+i.y,r=Math.min(i.x,this._bufferService.cols-1),n=this._optionsService.rawOptions.cursorBlink,o=this._optionsService.rawOptions.cursorStyle,a=this._optionsService.rawOptions.cursorInactiveStyle;for(let h=e;h<=t;h++){const e=h+i.ydisp,t=this._rowElements[h],c=i.lines.get(e);if(!t||!c)break;t.replaceChildren(...this._rowFactory.createRow(c,e,e===s,o,a,r,n,this.dimensions.css.cell.width,this._widthCache,-1,-1))}}get _terminalSelector(){return`.${v}${this._terminalClass}`}_handleLinkHover(e){this._setCellUnderline(e.x1,e.x2,e.y1,e.y2,e.cols,!0)}_handleLinkLeave(e){this._setCellUnderline(e.x1,e.x2,e.y1,e.y2,e.cols,!1)}_setCellUnderline(e,t,i,s,r,n){i<0&&(e=0),s<0&&(t=0);const o=this._bufferService.rows-1;i=Math.max(Math.min(i,o),0),s=Math.max(Math.min(s,o),0),r=Math.min(r,this._bufferService.cols);const a=this._bufferService.buffer,h=a.ybase+a.y,c=Math.min(a.x,r-1),l=this._optionsService.rawOptions.cursorBlink,d=this._optionsService.rawOptions.cursorStyle,_=this._optionsService.rawOptions.cursorInactiveStyle;for(let o=i;o<=s;++o){const u=o+a.ydisp,f=this._rowElements[o],v=a.lines.get(u);if(!f||!v)break;f.replaceChildren(...this._rowFactory.createRow(v,u,u===h,d,_,c,l,this.dimensions.css.cell.width,this._widthCache,n?o===i?e:0:-1,n?(o===s?t:r)-1:-1))}}};t.DomRenderer=w=s([r(7,f.IInstantiationService),r(8,l.ICharSizeService),r(9,f.IOptionsService),r(10,f.IBufferService),r(11,l.ICoreBrowserService),r(12,l.IThemeService)],w)},3787:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.DomRendererRowFactory=void 0;const n=i(2223),o=i(643),a=i(511),h=i(2585),c=i(8055),l=i(4725),d=i(4269),_=i(6171),u=i(3734);let f=t.DomRendererRowFactory=class{constructor(e,t,i,s,r,n,o){this._document=e,this._characterJoinerService=t,this._optionsService=i,this._coreBrowserService=s,this._coreService=r,this._decorationService=n,this._themeService=o,this._workCell=new a.CellData,this._columnSelectMode=!1,this.defaultSpacing=0}handleSelectionChanged(e,t,i){this._selectionStart=e,this._selectionEnd=t,this._columnSelectMode=i}createRow(e,t,i,s,r,a,h,l,_,f,p){const g=[],m=this._characterJoinerService.getJoinedCharacters(t),S=this._themeService.colors;let C,b=e.getNoBgTrimmedLength();i&&b0&&M===m[0][0]){O=!0;const t=m.shift();I=new d.JoinedCellData(this._workCell,e.translateToString(!0,t[0],t[1]),t[1]-t[0]),P=t[1]-1,b=I.getWidth()}const H=this._isCellInSelection(M,t),F=i&&M===a,W=T&&M>=f&&M<=p;let U=!1;this._decorationService.forEachDecorationAtCell(M,t,void 0,(e=>{U=!0}));let N=I.getChars()||o.WHITESPACE_CELL_CHAR;if(" "===N&&(I.isUnderline()||I.isOverline())&&(N=" "),A=b*l-_.get(N,I.isBold(),I.isItalic()),C){if(w&&(H&&x||!H&&!x&&I.bg===E)&&(H&&x&&S.selectionForeground||I.fg===k)&&I.extended.ext===L&&W===D&&A===R&&!F&&!O&&!U){I.isInvisible()?y+=o.WHITESPACE_CELL_CHAR:y+=N,w++;continue}w&&(C.textContent=y),C=this._document.createElement("span"),w=0,y=""}else C=this._document.createElement("span");if(E=I.bg,k=I.fg,L=I.extended.ext,D=W,R=A,x=H,O&&a>=M&&a<=P&&(a=M),!this._coreService.isCursorHidden&&F&&this._coreService.isCursorInitialized)if(B.push("xterm-cursor"),this._coreBrowserService.isFocused)h&&B.push("xterm-cursor-blink"),B.push("bar"===s?"xterm-cursor-bar":"underline"===s?"xterm-cursor-underline":"xterm-cursor-block");else if(r)switch(r){case"outline":B.push("xterm-cursor-outline");break;case"block":B.push("xterm-cursor-block");break;case"bar":B.push("xterm-cursor-bar");break;case"underline":B.push("xterm-cursor-underline")}if(I.isBold()&&B.push("xterm-bold"),I.isItalic()&&B.push("xterm-italic"),I.isDim()&&B.push("xterm-dim"),y=I.isInvisible()?o.WHITESPACE_CELL_CHAR:I.getChars()||o.WHITESPACE_CELL_CHAR,I.isUnderline()&&(B.push(`xterm-underline-${I.extended.underlineStyle}`)," "===y&&(y=" "),!I.isUnderlineColorDefault()))if(I.isUnderlineColorRGB())C.style.textDecorationColor=`rgb(${u.AttributeData.toColorRGB(I.getUnderlineColor()).join(",")})`;else{let e=I.getUnderlineColor();this._optionsService.rawOptions.drawBoldTextInBrightColors&&I.isBold()&&e<8&&(e+=8),C.style.textDecorationColor=S.ansi[e].css}I.isOverline()&&(B.push("xterm-overline")," "===y&&(y=" ")),I.isStrikethrough()&&B.push("xterm-strikethrough"),W&&(C.style.textDecoration="underline");let $=I.getFgColor(),j=I.getFgColorMode(),z=I.getBgColor(),K=I.getBgColorMode();const q=!!I.isInverse();if(q){const e=$;$=z,z=e;const t=j;j=K,K=t}let V,G,X,J=!1;switch(this._decorationService.forEachDecorationAtCell(M,t,void 0,(e=>{"top"!==e.options.layer&&J||(e.backgroundColorRGB&&(K=50331648,z=e.backgroundColorRGB.rgba>>8&16777215,V=e.backgroundColorRGB),e.foregroundColorRGB&&(j=50331648,$=e.foregroundColorRGB.rgba>>8&16777215,G=e.foregroundColorRGB),J="top"===e.options.layer)})),!J&&H&&(V=this._coreBrowserService.isFocused?S.selectionBackgroundOpaque:S.selectionInactiveBackgroundOpaque,z=V.rgba>>8&16777215,K=50331648,J=!0,S.selectionForeground&&(j=50331648,$=S.selectionForeground.rgba>>8&16777215,G=S.selectionForeground)),J&&B.push("xterm-decoration-top"),K){case 16777216:case 33554432:X=S.ansi[z],B.push(`xterm-bg-${z}`);break;case 50331648:X=c.channels.toColor(z>>16,z>>8&255,255&z),this._addStyle(C,`background-color:#${v((z>>>0).toString(16),"0",6)}`);break;default:q?(X=S.foreground,B.push(`xterm-bg-${n.INVERTED_DEFAULT_COLOR}`)):X=S.background}switch(V||I.isDim()&&(V=c.color.multiplyOpacity(X,.5)),j){case 16777216:case 33554432:I.isBold()&&$<8&&this._optionsService.rawOptions.drawBoldTextInBrightColors&&($+=8),this._applyMinimumContrast(C,X,S.ansi[$],I,V,void 0)||B.push(`xterm-fg-${$}`);break;case 50331648:const e=c.channels.toColor($>>16&255,$>>8&255,255&$);this._applyMinimumContrast(C,X,e,I,V,G)||this._addStyle(C,`color:#${v($.toString(16),"0",6)}`);break;default:this._applyMinimumContrast(C,X,S.foreground,I,V,G)||q&&B.push(`xterm-fg-${n.INVERTED_DEFAULT_COLOR}`)}B.length&&(C.className=B.join(" "),B.length=0),F||O||U?C.textContent=y:w++,A!==this.defaultSpacing&&(C.style.letterSpacing=`${A}px`),g.push(C),M=P}return C&&w&&(C.textContent=y),g}_applyMinimumContrast(e,t,i,s,r,n){if(1===this._optionsService.rawOptions.minimumContrastRatio||(0,_.treatGlyphAsBackgroundColor)(s.getCode()))return!1;const o=this._getContrastCache(s);let a;if(r||n||(a=o.getColor(t.rgba,i.rgba)),void 0===a){const e=this._optionsService.rawOptions.minimumContrastRatio/(s.isDim()?2:1);a=c.color.ensureContrastRatio(r||t,n||i,e),o.setColor((r||t).rgba,(n||i).rgba,a??null)}return!!a&&(this._addStyle(e,`color:${a.css}`),!0)}_getContrastCache(e){return e.isDim()?this._themeService.colors.halfContrastCache:this._themeService.colors.contrastCache}_addStyle(e,t){e.setAttribute("style",`${e.getAttribute("style")||""}${t};`)}_isCellInSelection(e,t){const i=this._selectionStart,s=this._selectionEnd;return!(!i||!s)&&(this._columnSelectMode?i[0]<=s[0]?e>=i[0]&&t>=i[1]&&e=i[1]&&e>=s[0]&&t<=s[1]:t>i[1]&&t=i[0]&&e=i[0])}};function v(e,t,i){for(;e.length{Object.defineProperty(t,"__esModule",{value:!0}),t.WidthCache=void 0,t.WidthCache=class{constructor(e,t){this._flat=new Float32Array(256),this._font="",this._fontSize=0,this._weight="normal",this._weightBold="bold",this._measureElements=[],this._container=e.createElement("div"),this._container.classList.add("xterm-width-cache-measure-container"),this._container.setAttribute("aria-hidden","true"),this._container.style.whiteSpace="pre",this._container.style.fontKerning="none";const i=e.createElement("span");i.classList.add("xterm-char-measure-element");const s=e.createElement("span");s.classList.add("xterm-char-measure-element"),s.style.fontWeight="bold";const r=e.createElement("span");r.classList.add("xterm-char-measure-element"),r.style.fontStyle="italic";const n=e.createElement("span");n.classList.add("xterm-char-measure-element"),n.style.fontWeight="bold",n.style.fontStyle="italic",this._measureElements=[i,s,r,n],this._container.appendChild(i),this._container.appendChild(s),this._container.appendChild(r),this._container.appendChild(n),t.appendChild(this._container),this.clear()}dispose(){this._container.remove(),this._measureElements.length=0,this._holey=void 0}clear(){this._flat.fill(-9999),this._holey=new Map}setFont(e,t,i,s){e===this._font&&t===this._fontSize&&i===this._weight&&s===this._weightBold||(this._font=e,this._fontSize=t,this._weight=i,this._weightBold=s,this._container.style.fontFamily=this._font,this._container.style.fontSize=`${this._fontSize}px`,this._measureElements[0].style.fontWeight=`${i}`,this._measureElements[1].style.fontWeight=`${s}`,this._measureElements[2].style.fontWeight=`${i}`,this._measureElements[3].style.fontWeight=`${s}`,this.clear())}get(e,t,i){let s=0;if(!t&&!i&&1===e.length&&(s=e.charCodeAt(0))<256){if(-9999!==this._flat[s])return this._flat[s];const t=this._measure(e,0);return t>0&&(this._flat[s]=t),t}let r=e;t&&(r+="B"),i&&(r+="I");let n=this._holey.get(r);if(void 0===n){let s=0;t&&(s|=1),i&&(s|=2),n=this._measure(e,s),n>0&&this._holey.set(r,n)}return n}_measure(e,t){const i=this._measureElements[t];return i.textContent=e.repeat(32),i.offsetWidth/32}}},2223:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.TEXT_BASELINE=t.DIM_OPACITY=t.INVERTED_DEFAULT_COLOR=void 0;const s=i(6114);t.INVERTED_DEFAULT_COLOR=257,t.DIM_OPACITY=.5,t.TEXT_BASELINE=s.isFirefox||s.isLegacyEdge?"bottom":"ideographic"},6171:(e,t)=>{function i(e){return 57508<=e&&e<=57558}function s(e){return e>=128512&&e<=128591||e>=127744&&e<=128511||e>=128640&&e<=128767||e>=9728&&e<=9983||e>=9984&&e<=10175||e>=65024&&e<=65039||e>=129280&&e<=129535||e>=127462&&e<=127487}Object.defineProperty(t,"__esModule",{value:!0}),t.computeNextVariantOffset=t.createRenderDimensions=t.treatGlyphAsBackgroundColor=t.allowRescaling=t.isEmoji=t.isRestrictedPowerlineGlyph=t.isPowerlineGlyph=t.throwIfFalsy=void 0,t.throwIfFalsy=function(e){if(!e)throw new Error("value must not be falsy");return e},t.isPowerlineGlyph=i,t.isRestrictedPowerlineGlyph=function(e){return 57520<=e&&e<=57527},t.isEmoji=s,t.allowRescaling=function(e,t,r,n){return 1===t&&r>Math.ceil(1.5*n)&&void 0!==e&&e>255&&!s(e)&&!i(e)&&!function(e){return 57344<=e&&e<=63743}(e)},t.treatGlyphAsBackgroundColor=function(e){return i(e)||function(e){return 9472<=e&&e<=9631}(e)},t.createRenderDimensions=function(){return{css:{canvas:{width:0,height:0},cell:{width:0,height:0}},device:{canvas:{width:0,height:0},cell:{width:0,height:0},char:{width:0,height:0,left:0,top:0}}}},t.computeNextVariantOffset=function(e,t,i=0){return(e-(2*Math.round(t)-i))%(2*Math.round(t))}},6052:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.createSelectionRenderModel=void 0;class i{constructor(){this.clear()}clear(){this.hasSelection=!1,this.columnSelectMode=!1,this.viewportStartRow=0,this.viewportEndRow=0,this.viewportCappedStartRow=0,this.viewportCappedEndRow=0,this.startCol=0,this.endCol=0,this.selectionStart=void 0,this.selectionEnd=void 0}update(e,t,i,s=!1){if(this.selectionStart=t,this.selectionEnd=i,!t||!i||t[0]===i[0]&&t[1]===i[1])return void this.clear();const r=e.buffers.active.ydisp,n=t[1]-r,o=i[1]-r,a=Math.max(n,0),h=Math.min(o,e.rows-1);a>=e.rows||h<0?this.clear():(this.hasSelection=!0,this.columnSelectMode=s,this.viewportStartRow=n,this.viewportEndRow=o,this.viewportCappedStartRow=a,this.viewportCappedEndRow=h,this.startCol=t[0],this.endCol=i[0])}isCellSelected(e,t,i){return!!this.hasSelection&&(i-=e.buffer.active.viewportY,this.columnSelectMode?this.startCol<=this.endCol?t>=this.startCol&&i>=this.viewportCappedStartRow&&t=this.viewportCappedStartRow&&t>=this.endCol&&i<=this.viewportCappedEndRow:i>this.viewportStartRow&&i=this.startCol&&t=this.startCol)}}t.createSelectionRenderModel=function(){return new i}},456:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.SelectionModel=void 0,t.SelectionModel=class{constructor(e){this._bufferService=e,this.isSelectAllActive=!1,this.selectionStartLength=0}clearSelection(){this.selectionStart=void 0,this.selectionEnd=void 0,this.isSelectAllActive=!1,this.selectionStartLength=0}get finalSelectionStart(){return this.isSelectAllActive?[0,0]:this.selectionEnd&&this.selectionStart&&this.areSelectionValuesReversed()?this.selectionEnd:this.selectionStart}get finalSelectionEnd(){if(this.isSelectAllActive)return[this._bufferService.cols,this._bufferService.buffer.ybase+this._bufferService.rows-1];if(this.selectionStart){if(!this.selectionEnd||this.areSelectionValuesReversed()){const e=this.selectionStart[0]+this.selectionStartLength;return e>this._bufferService.cols?e%this._bufferService.cols==0?[this._bufferService.cols,this.selectionStart[1]+Math.floor(e/this._bufferService.cols)-1]:[e%this._bufferService.cols,this.selectionStart[1]+Math.floor(e/this._bufferService.cols)]:[e,this.selectionStart[1]]}if(this.selectionStartLength&&this.selectionEnd[1]===this.selectionStart[1]){const e=this.selectionStart[0]+this.selectionStartLength;return e>this._bufferService.cols?[e%this._bufferService.cols,this.selectionStart[1]+Math.floor(e/this._bufferService.cols)]:[Math.max(e,this.selectionEnd[0]),this.selectionEnd[1]]}return this.selectionEnd}}areSelectionValuesReversed(){const e=this.selectionStart,t=this.selectionEnd;return!(!e||!t)&&(e[1]>t[1]||e[1]===t[1]&&e[0]>t[0])}handleTrim(e){return this.selectionStart&&(this.selectionStart[1]-=e),this.selectionEnd&&(this.selectionEnd[1]-=e),this.selectionEnd&&this.selectionEnd[1]<0?(this.clearSelection(),!0):(this.selectionStart&&this.selectionStart[1]<0&&(this.selectionStart[1]=0),!1)}}},428:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.CharSizeService=void 0;const n=i(2585),o=i(8460),a=i(844);let h=t.CharSizeService=class extends a.Disposable{get hasValidSize(){return this.width>0&&this.height>0}constructor(e,t,i){super(),this._optionsService=i,this.width=0,this.height=0,this._onCharSizeChange=this.register(new o.EventEmitter),this.onCharSizeChange=this._onCharSizeChange.event;try{this._measureStrategy=this.register(new d(this._optionsService))}catch{this._measureStrategy=this.register(new l(e,t,this._optionsService))}this.register(this._optionsService.onMultipleOptionChange(["fontFamily","fontSize"],(()=>this.measure())))}measure(){const e=this._measureStrategy.measure();e.width===this.width&&e.height===this.height||(this.width=e.width,this.height=e.height,this._onCharSizeChange.fire())}};t.CharSizeService=h=s([r(2,n.IOptionsService)],h);class c extends a.Disposable{constructor(){super(...arguments),this._result={width:0,height:0}}_validateAndSet(e,t){void 0!==e&&e>0&&void 0!==t&&t>0&&(this._result.width=e,this._result.height=t)}}class l extends c{constructor(e,t,i){super(),this._document=e,this._parentElement=t,this._optionsService=i,this._measureElement=this._document.createElement("span"),this._measureElement.classList.add("xterm-char-measure-element"),this._measureElement.textContent="W".repeat(32),this._measureElement.setAttribute("aria-hidden","true"),this._measureElement.style.whiteSpace="pre",this._measureElement.style.fontKerning="none",this._parentElement.appendChild(this._measureElement)}measure(){return this._measureElement.style.fontFamily=this._optionsService.rawOptions.fontFamily,this._measureElement.style.fontSize=`${this._optionsService.rawOptions.fontSize}px`,this._validateAndSet(Number(this._measureElement.offsetWidth)/32,Number(this._measureElement.offsetHeight)),this._result}}class d extends c{constructor(e){super(),this._optionsService=e,this._canvas=new OffscreenCanvas(100,100),this._ctx=this._canvas.getContext("2d");const t=this._ctx.measureText("W");if(!("width"in t&&"fontBoundingBoxAscent"in t&&"fontBoundingBoxDescent"in t))throw new Error("Required font metrics not supported")}measure(){this._ctx.font=`${this._optionsService.rawOptions.fontSize}px ${this._optionsService.rawOptions.fontFamily}`;const e=this._ctx.measureText("W");return this._validateAndSet(e.width,e.fontBoundingBoxAscent+e.fontBoundingBoxDescent),this._result}}},4269:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.CharacterJoinerService=t.JoinedCellData=void 0;const n=i(3734),o=i(643),a=i(511),h=i(2585);class c extends n.AttributeData{constructor(e,t,i){super(),this.content=0,this.combinedData="",this.fg=e.fg,this.bg=e.bg,this.combinedData=t,this._width=i}isCombined(){return 2097152}getWidth(){return this._width}getChars(){return this.combinedData}getCode(){return 2097151}setFromCharData(e){throw new Error("not implemented")}getAsCharData(){return[this.fg,this.getChars(),this.getWidth(),this.getCode()]}}t.JoinedCellData=c;let l=t.CharacterJoinerService=class e{constructor(e){this._bufferService=e,this._characterJoiners=[],this._nextCharacterJoinerId=0,this._workCell=new a.CellData}register(e){const t={id:this._nextCharacterJoinerId++,handler:e};return this._characterJoiners.push(t),t.id}deregister(e){for(let t=0;t1){const e=this._getJoinedRanges(s,a,n,t,r);for(let t=0;t1){const e=this._getJoinedRanges(s,a,n,t,r);for(let t=0;t{Object.defineProperty(t,"__esModule",{value:!0}),t.CoreBrowserService=void 0;const s=i(844),r=i(8460),n=i(3656);class o extends s.Disposable{constructor(e,t,i){super(),this._textarea=e,this._window=t,this.mainDocument=i,this._isFocused=!1,this._cachedIsFocused=void 0,this._screenDprMonitor=new a(this._window),this._onDprChange=this.register(new r.EventEmitter),this.onDprChange=this._onDprChange.event,this._onWindowChange=this.register(new r.EventEmitter),this.onWindowChange=this._onWindowChange.event,this.register(this.onWindowChange((e=>this._screenDprMonitor.setWindow(e)))),this.register((0,r.forwardEvent)(this._screenDprMonitor.onDprChange,this._onDprChange)),this._textarea.addEventListener("focus",(()=>this._isFocused=!0)),this._textarea.addEventListener("blur",(()=>this._isFocused=!1))}get window(){return this._window}set window(e){this._window!==e&&(this._window=e,this._onWindowChange.fire(this._window))}get dpr(){return this.window.devicePixelRatio}get isFocused(){return void 0===this._cachedIsFocused&&(this._cachedIsFocused=this._isFocused&&this._textarea.ownerDocument.hasFocus(),queueMicrotask((()=>this._cachedIsFocused=void 0))),this._cachedIsFocused}}t.CoreBrowserService=o;class a extends s.Disposable{constructor(e){super(),this._parentWindow=e,this._windowResizeListener=this.register(new s.MutableDisposable),this._onDprChange=this.register(new r.EventEmitter),this.onDprChange=this._onDprChange.event,this._outerListener=()=>this._setDprAndFireIfDiffers(),this._currentDevicePixelRatio=this._parentWindow.devicePixelRatio,this._updateDpr(),this._setWindowResizeListener(),this.register((0,s.toDisposable)((()=>this.clearListener())))}setWindow(e){this._parentWindow=e,this._setWindowResizeListener(),this._setDprAndFireIfDiffers()}_setWindowResizeListener(){this._windowResizeListener.value=(0,n.addDisposableDomListener)(this._parentWindow,"resize",(()=>this._setDprAndFireIfDiffers()))}_setDprAndFireIfDiffers(){this._parentWindow.devicePixelRatio!==this._currentDevicePixelRatio&&this._onDprChange.fire(this._parentWindow.devicePixelRatio),this._updateDpr()}_updateDpr(){this._outerListener&&(this._resolutionMediaMatchList?.removeListener(this._outerListener),this._currentDevicePixelRatio=this._parentWindow.devicePixelRatio,this._resolutionMediaMatchList=this._parentWindow.matchMedia(`screen and (resolution: ${this._parentWindow.devicePixelRatio}dppx)`),this._resolutionMediaMatchList.addListener(this._outerListener))}clearListener(){this._resolutionMediaMatchList&&this._outerListener&&(this._resolutionMediaMatchList.removeListener(this._outerListener),this._resolutionMediaMatchList=void 0,this._outerListener=void 0)}}},779:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.LinkProviderService=void 0;const s=i(844);class r extends s.Disposable{constructor(){super(),this.linkProviders=[],this.register((0,s.toDisposable)((()=>this.linkProviders.length=0)))}registerLinkProvider(e){return this.linkProviders.push(e),{dispose:()=>{const t=this.linkProviders.indexOf(e);-1!==t&&this.linkProviders.splice(t,1)}}}}t.LinkProviderService=r},8934:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.MouseService=void 0;const n=i(4725),o=i(9806);let a=t.MouseService=class{constructor(e,t){this._renderService=e,this._charSizeService=t}getCoords(e,t,i,s,r){return(0,o.getCoords)(window,e,t,i,s,this._charSizeService.hasValidSize,this._renderService.dimensions.css.cell.width,this._renderService.dimensions.css.cell.height,r)}getMouseReportCoords(e,t){const i=(0,o.getCoordsRelativeToElement)(window,e,t);if(this._charSizeService.hasValidSize)return i[0]=Math.min(Math.max(i[0],0),this._renderService.dimensions.css.canvas.width-1),i[1]=Math.min(Math.max(i[1],0),this._renderService.dimensions.css.canvas.height-1),{col:Math.floor(i[0]/this._renderService.dimensions.css.cell.width),row:Math.floor(i[1]/this._renderService.dimensions.css.cell.height),x:Math.floor(i[0]),y:Math.floor(i[1])}}};t.MouseService=a=s([r(0,n.IRenderService),r(1,n.ICharSizeService)],a)},3230:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.RenderService=void 0;const n=i(6193),o=i(4725),a=i(8460),h=i(844),c=i(7226),l=i(2585);let d=t.RenderService=class extends h.Disposable{get dimensions(){return this._renderer.value.dimensions}constructor(e,t,i,s,r,o,l,d){super(),this._rowCount=e,this._charSizeService=s,this._renderer=this.register(new h.MutableDisposable),this._pausedResizeTask=new c.DebouncedIdleTask,this._observerDisposable=this.register(new h.MutableDisposable),this._isPaused=!1,this._needsFullRefresh=!1,this._isNextRenderRedrawOnly=!0,this._needsSelectionRefresh=!1,this._canvasWidth=0,this._canvasHeight=0,this._selectionState={start:void 0,end:void 0,columnSelectMode:!1},this._onDimensionsChange=this.register(new a.EventEmitter),this.onDimensionsChange=this._onDimensionsChange.event,this._onRenderedViewportChange=this.register(new a.EventEmitter),this.onRenderedViewportChange=this._onRenderedViewportChange.event,this._onRender=this.register(new a.EventEmitter),this.onRender=this._onRender.event,this._onRefreshRequest=this.register(new a.EventEmitter),this.onRefreshRequest=this._onRefreshRequest.event,this._renderDebouncer=new n.RenderDebouncer(((e,t)=>this._renderRows(e,t)),l),this.register(this._renderDebouncer),this.register(l.onDprChange((()=>this.handleDevicePixelRatioChange()))),this.register(o.onResize((()=>this._fullRefresh()))),this.register(o.buffers.onBufferActivate((()=>this._renderer.value?.clear()))),this.register(i.onOptionChange((()=>this._handleOptionsChanged()))),this.register(this._charSizeService.onCharSizeChange((()=>this.handleCharSizeChanged()))),this.register(r.onDecorationRegistered((()=>this._fullRefresh()))),this.register(r.onDecorationRemoved((()=>this._fullRefresh()))),this.register(i.onMultipleOptionChange(["customGlyphs","drawBoldTextInBrightColors","letterSpacing","lineHeight","fontFamily","fontSize","fontWeight","fontWeightBold","minimumContrastRatio","rescaleOverlappingGlyphs"],(()=>{this.clear(),this.handleResize(o.cols,o.rows),this._fullRefresh()}))),this.register(i.onMultipleOptionChange(["cursorBlink","cursorStyle"],(()=>this.refreshRows(o.buffer.y,o.buffer.y,!0)))),this.register(d.onChangeColors((()=>this._fullRefresh()))),this._registerIntersectionObserver(l.window,t),this.register(l.onWindowChange((e=>this._registerIntersectionObserver(e,t))))}_registerIntersectionObserver(e,t){if("IntersectionObserver"in e){const i=new e.IntersectionObserver((e=>this._handleIntersectionChange(e[e.length-1])),{threshold:0});i.observe(t),this._observerDisposable.value=(0,h.toDisposable)((()=>i.disconnect()))}}_handleIntersectionChange(e){this._isPaused=void 0===e.isIntersecting?0===e.intersectionRatio:!e.isIntersecting,this._isPaused||this._charSizeService.hasValidSize||this._charSizeService.measure(),!this._isPaused&&this._needsFullRefresh&&(this._pausedResizeTask.flush(),this.refreshRows(0,this._rowCount-1),this._needsFullRefresh=!1)}refreshRows(e,t,i=!1){this._isPaused?this._needsFullRefresh=!0:(i||(this._isNextRenderRedrawOnly=!1),this._renderDebouncer.refresh(e,t,this._rowCount))}_renderRows(e,t){this._renderer.value&&(e=Math.min(e,this._rowCount-1),t=Math.min(t,this._rowCount-1),this._renderer.value.renderRows(e,t),this._needsSelectionRefresh&&(this._renderer.value.handleSelectionChanged(this._selectionState.start,this._selectionState.end,this._selectionState.columnSelectMode),this._needsSelectionRefresh=!1),this._isNextRenderRedrawOnly||this._onRenderedViewportChange.fire({start:e,end:t}),this._onRender.fire({start:e,end:t}),this._isNextRenderRedrawOnly=!0)}resize(e,t){this._rowCount=t,this._fireOnCanvasResize()}_handleOptionsChanged(){this._renderer.value&&(this.refreshRows(0,this._rowCount-1),this._fireOnCanvasResize())}_fireOnCanvasResize(){this._renderer.value&&(this._renderer.value.dimensions.css.canvas.width===this._canvasWidth&&this._renderer.value.dimensions.css.canvas.height===this._canvasHeight||this._onDimensionsChange.fire(this._renderer.value.dimensions))}hasRenderer(){return!!this._renderer.value}setRenderer(e){this._renderer.value=e,this._renderer.value&&(this._renderer.value.onRequestRedraw((e=>this.refreshRows(e.start,e.end,!0))),this._needsSelectionRefresh=!0,this._fullRefresh())}addRefreshCallback(e){return this._renderDebouncer.addRefreshCallback(e)}_fullRefresh(){this._isPaused?this._needsFullRefresh=!0:this.refreshRows(0,this._rowCount-1)}clearTextureAtlas(){this._renderer.value&&(this._renderer.value.clearTextureAtlas?.(),this._fullRefresh())}handleDevicePixelRatioChange(){this._charSizeService.measure(),this._renderer.value&&(this._renderer.value.handleDevicePixelRatioChange(),this.refreshRows(0,this._rowCount-1))}handleResize(e,t){this._renderer.value&&(this._isPaused?this._pausedResizeTask.set((()=>this._renderer.value?.handleResize(e,t))):this._renderer.value.handleResize(e,t),this._fullRefresh())}handleCharSizeChanged(){this._renderer.value?.handleCharSizeChanged()}handleBlur(){this._renderer.value?.handleBlur()}handleFocus(){this._renderer.value?.handleFocus()}handleSelectionChanged(e,t,i){this._selectionState.start=e,this._selectionState.end=t,this._selectionState.columnSelectMode=i,this._renderer.value?.handleSelectionChanged(e,t,i)}handleCursorMove(){this._renderer.value?.handleCursorMove()}clear(){this._renderer.value?.clear()}};t.RenderService=d=s([r(2,l.IOptionsService),r(3,o.ICharSizeService),r(4,l.IDecorationService),r(5,l.IBufferService),r(6,o.ICoreBrowserService),r(7,o.IThemeService)],d)},9312:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.SelectionService=void 0;const n=i(9806),o=i(9504),a=i(456),h=i(4725),c=i(8460),l=i(844),d=i(6114),_=i(4841),u=i(511),f=i(2585),v=String.fromCharCode(160),p=new RegExp(v,"g");let g=t.SelectionService=class extends l.Disposable{constructor(e,t,i,s,r,n,o,h,d){super(),this._element=e,this._screenElement=t,this._linkifier=i,this._bufferService=s,this._coreService=r,this._mouseService=n,this._optionsService=o,this._renderService=h,this._coreBrowserService=d,this._dragScrollAmount=0,this._enabled=!0,this._workCell=new u.CellData,this._mouseDownTimeStamp=0,this._oldHasSelection=!1,this._oldSelectionStart=void 0,this._oldSelectionEnd=void 0,this._onLinuxMouseSelection=this.register(new c.EventEmitter),this.onLinuxMouseSelection=this._onLinuxMouseSelection.event,this._onRedrawRequest=this.register(new c.EventEmitter),this.onRequestRedraw=this._onRedrawRequest.event,this._onSelectionChange=this.register(new c.EventEmitter),this.onSelectionChange=this._onSelectionChange.event,this._onRequestScrollLines=this.register(new c.EventEmitter),this.onRequestScrollLines=this._onRequestScrollLines.event,this._mouseMoveListener=e=>this._handleMouseMove(e),this._mouseUpListener=e=>this._handleMouseUp(e),this._coreService.onUserInput((()=>{this.hasSelection&&this.clearSelection()})),this._trimListener=this._bufferService.buffer.lines.onTrim((e=>this._handleTrim(e))),this.register(this._bufferService.buffers.onBufferActivate((e=>this._handleBufferActivate(e)))),this.enable(),this._model=new a.SelectionModel(this._bufferService),this._activeSelectionMode=0,this.register((0,l.toDisposable)((()=>{this._removeMouseDownListeners()})))}reset(){this.clearSelection()}disable(){this.clearSelection(),this._enabled=!1}enable(){this._enabled=!0}get selectionStart(){return this._model.finalSelectionStart}get selectionEnd(){return this._model.finalSelectionEnd}get hasSelection(){const e=this._model.finalSelectionStart,t=this._model.finalSelectionEnd;return!(!e||!t||e[0]===t[0]&&e[1]===t[1])}get selectionText(){const e=this._model.finalSelectionStart,t=this._model.finalSelectionEnd;if(!e||!t)return"";const i=this._bufferService.buffer,s=[];if(3===this._activeSelectionMode){if(e[0]===t[0])return"";const r=e[0]e.replace(p," "))).join(d.isWindows?"\r\n":"\n")}clearSelection(){this._model.clearSelection(),this._removeMouseDownListeners(),this.refresh(),this._onSelectionChange.fire()}refresh(e){this._refreshAnimationFrame||(this._refreshAnimationFrame=this._coreBrowserService.window.requestAnimationFrame((()=>this._refresh()))),d.isLinux&&e&&this.selectionText.length&&this._onLinuxMouseSelection.fire(this.selectionText)}_refresh(){this._refreshAnimationFrame=void 0,this._onRedrawRequest.fire({start:this._model.finalSelectionStart,end:this._model.finalSelectionEnd,columnSelectMode:3===this._activeSelectionMode})}_isClickInSelection(e){const t=this._getMouseBufferCoords(e),i=this._model.finalSelectionStart,s=this._model.finalSelectionEnd;return!!(i&&s&&t)&&this._areCoordsInSelection(t,i,s)}isCellInSelection(e,t){const i=this._model.finalSelectionStart,s=this._model.finalSelectionEnd;return!(!i||!s)&&this._areCoordsInSelection([e,t],i,s)}_areCoordsInSelection(e,t,i){return e[1]>t[1]&&e[1]=t[0]&&e[0]=t[0]}_selectWordAtCursor(e,t){const i=this._linkifier.currentLink?.link?.range;if(i)return this._model.selectionStart=[i.start.x-1,i.start.y-1],this._model.selectionStartLength=(0,_.getRangeLength)(i,this._bufferService.cols),this._model.selectionEnd=void 0,!0;const s=this._getMouseBufferCoords(e);return!!s&&(this._selectWordAt(s,t),this._model.selectionEnd=void 0,!0)}selectAll(){this._model.isSelectAllActive=!0,this.refresh(),this._onSelectionChange.fire()}selectLines(e,t){this._model.clearSelection(),e=Math.max(e,0),t=Math.min(t,this._bufferService.buffer.lines.length-1),this._model.selectionStart=[0,e],this._model.selectionEnd=[this._bufferService.cols,t],this.refresh(),this._onSelectionChange.fire()}_handleTrim(e){this._model.handleTrim(e)&&this.refresh()}_getMouseBufferCoords(e){const t=this._mouseService.getCoords(e,this._screenElement,this._bufferService.cols,this._bufferService.rows,!0);if(t)return t[0]--,t[1]--,t[1]+=this._bufferService.buffer.ydisp,t}_getMouseEventScrollAmount(e){let t=(0,n.getCoordsRelativeToElement)(this._coreBrowserService.window,e,this._screenElement)[1];const i=this._renderService.dimensions.css.canvas.height;return t>=0&&t<=i?0:(t>i&&(t-=i),t=Math.min(Math.max(t,-50),50),t/=50,t/Math.abs(t)+Math.round(14*t))}shouldForceSelection(e){return d.isMac?e.altKey&&this._optionsService.rawOptions.macOptionClickForcesSelection:e.shiftKey}handleMouseDown(e){if(this._mouseDownTimeStamp=e.timeStamp,(2!==e.button||!this.hasSelection)&&0===e.button){if(!this._enabled){if(!this.shouldForceSelection(e))return;e.stopPropagation()}e.preventDefault(),this._dragScrollAmount=0,this._enabled&&e.shiftKey?this._handleIncrementalClick(e):1===e.detail?this._handleSingleClick(e):2===e.detail?this._handleDoubleClick(e):3===e.detail&&this._handleTripleClick(e),this._addMouseDownListeners(),this.refresh(!0)}}_addMouseDownListeners(){this._screenElement.ownerDocument&&(this._screenElement.ownerDocument.addEventListener("mousemove",this._mouseMoveListener),this._screenElement.ownerDocument.addEventListener("mouseup",this._mouseUpListener)),this._dragScrollIntervalTimer=this._coreBrowserService.window.setInterval((()=>this._dragScroll()),50)}_removeMouseDownListeners(){this._screenElement.ownerDocument&&(this._screenElement.ownerDocument.removeEventListener("mousemove",this._mouseMoveListener),this._screenElement.ownerDocument.removeEventListener("mouseup",this._mouseUpListener)),this._coreBrowserService.window.clearInterval(this._dragScrollIntervalTimer),this._dragScrollIntervalTimer=void 0}_handleIncrementalClick(e){this._model.selectionStart&&(this._model.selectionEnd=this._getMouseBufferCoords(e))}_handleSingleClick(e){if(this._model.selectionStartLength=0,this._model.isSelectAllActive=!1,this._activeSelectionMode=this.shouldColumnSelect(e)?3:0,this._model.selectionStart=this._getMouseBufferCoords(e),!this._model.selectionStart)return;this._model.selectionEnd=void 0;const t=this._bufferService.buffer.lines.get(this._model.selectionStart[1]);t&&t.length!==this._model.selectionStart[0]&&0===t.hasWidth(this._model.selectionStart[0])&&this._model.selectionStart[0]++}_handleDoubleClick(e){this._selectWordAtCursor(e,!0)&&(this._activeSelectionMode=1)}_handleTripleClick(e){const t=this._getMouseBufferCoords(e);t&&(this._activeSelectionMode=2,this._selectLineAt(t[1]))}shouldColumnSelect(e){return e.altKey&&!(d.isMac&&this._optionsService.rawOptions.macOptionClickForcesSelection)}_handleMouseMove(e){if(e.stopImmediatePropagation(),!this._model.selectionStart)return;const t=this._model.selectionEnd?[this._model.selectionEnd[0],this._model.selectionEnd[1]]:null;if(this._model.selectionEnd=this._getMouseBufferCoords(e),!this._model.selectionEnd)return void this.refresh(!0);2===this._activeSelectionMode?this._model.selectionEnd[1]0?this._model.selectionEnd[0]=this._bufferService.cols:this._dragScrollAmount<0&&(this._model.selectionEnd[0]=0));const i=this._bufferService.buffer;if(this._model.selectionEnd[1]0?(3!==this._activeSelectionMode&&(this._model.selectionEnd[0]=this._bufferService.cols),this._model.selectionEnd[1]=Math.min(e.ydisp+this._bufferService.rows,e.lines.length-1)):(3!==this._activeSelectionMode&&(this._model.selectionEnd[0]=0),this._model.selectionEnd[1]=e.ydisp),this.refresh()}}_handleMouseUp(e){const t=e.timeStamp-this._mouseDownTimeStamp;if(this._removeMouseDownListeners(),this.selectionText.length<=1&&t<500&&e.altKey&&this._optionsService.rawOptions.altClickMovesCursor){if(this._bufferService.buffer.ybase===this._bufferService.buffer.ydisp){const t=this._mouseService.getCoords(e,this._element,this._bufferService.cols,this._bufferService.rows,!1);if(t&&void 0!==t[0]&&void 0!==t[1]){const e=(0,o.moveToCellSequence)(t[0]-1,t[1]-1,this._bufferService,this._coreService.decPrivateModes.applicationCursorKeys);this._coreService.triggerDataEvent(e,!0)}}}else this._fireEventIfSelectionChanged()}_fireEventIfSelectionChanged(){const e=this._model.finalSelectionStart,t=this._model.finalSelectionEnd,i=!(!e||!t||e[0]===t[0]&&e[1]===t[1]);i?e&&t&&(this._oldSelectionStart&&this._oldSelectionEnd&&e[0]===this._oldSelectionStart[0]&&e[1]===this._oldSelectionStart[1]&&t[0]===this._oldSelectionEnd[0]&&t[1]===this._oldSelectionEnd[1]||this._fireOnSelectionChange(e,t,i)):this._oldHasSelection&&this._fireOnSelectionChange(e,t,i)}_fireOnSelectionChange(e,t,i){this._oldSelectionStart=e,this._oldSelectionEnd=t,this._oldHasSelection=i,this._onSelectionChange.fire()}_handleBufferActivate(e){this.clearSelection(),this._trimListener.dispose(),this._trimListener=e.activeBuffer.lines.onTrim((e=>this._handleTrim(e)))}_convertViewportColToCharacterIndex(e,t){let i=t;for(let s=0;t>=s;s++){const r=e.loadCell(s,this._workCell).getChars().length;0===this._workCell.getWidth()?i--:r>1&&t!==s&&(i+=r-1)}return i}setSelection(e,t,i){this._model.clearSelection(),this._removeMouseDownListeners(),this._model.selectionStart=[e,t],this._model.selectionStartLength=i,this.refresh(),this._fireEventIfSelectionChanged()}rightClickSelect(e){this._isClickInSelection(e)||(this._selectWordAtCursor(e,!1)&&this.refresh(!0),this._fireEventIfSelectionChanged())}_getWordAt(e,t,i=!0,s=!0){if(e[0]>=this._bufferService.cols)return;const r=this._bufferService.buffer,n=r.lines.get(e[1]);if(!n)return;const o=r.translateBufferLineToString(e[1],!1);let a=this._convertViewportColToCharacterIndex(n,e[0]),h=a;const c=e[0]-a;let l=0,d=0,_=0,u=0;if(" "===o.charAt(a)){for(;a>0&&" "===o.charAt(a-1);)a--;for(;h1&&(u+=s-1,h+=s-1);t>0&&a>0&&!this._isCharWordSeparator(n.loadCell(t-1,this._workCell));){n.loadCell(t-1,this._workCell);const e=this._workCell.getChars().length;0===this._workCell.getWidth()?(l++,t--):e>1&&(_+=e-1,a-=e-1),a--,t--}for(;i1&&(u+=e-1,h+=e-1),h++,i++}}h++;let f=a+c-l+_,v=Math.min(this._bufferService.cols,h-a+l+d-_-u);if(t||""!==o.slice(a,h).trim()){if(i&&0===f&&32!==n.getCodePoint(0)){const t=r.lines.get(e[1]-1);if(t&&n.isWrapped&&32!==t.getCodePoint(this._bufferService.cols-1)){const t=this._getWordAt([this._bufferService.cols-1,e[1]-1],!1,!0,!1);if(t){const e=this._bufferService.cols-t.start;f-=e,v+=e}}}if(s&&f+v===this._bufferService.cols&&32!==n.getCodePoint(this._bufferService.cols-1)){const t=r.lines.get(e[1]+1);if(t?.isWrapped&&32!==t.getCodePoint(0)){const t=this._getWordAt([0,e[1]+1],!1,!1,!0);t&&(v+=t.length)}}return{start:f,length:v}}}_selectWordAt(e,t){const i=this._getWordAt(e,t);if(i){for(;i.start<0;)i.start+=this._bufferService.cols,e[1]--;this._model.selectionStart=[i.start,e[1]],this._model.selectionStartLength=i.length}}_selectToWordAt(e){const t=this._getWordAt(e,!0);if(t){let i=e[1];for(;t.start<0;)t.start+=this._bufferService.cols,i--;if(!this._model.areSelectionValuesReversed())for(;t.start+t.length>this._bufferService.cols;)t.length-=this._bufferService.cols,i++;this._model.selectionEnd=[this._model.areSelectionValuesReversed()?t.start:t.start+t.length,i]}}_isCharWordSeparator(e){return 0!==e.getWidth()&&this._optionsService.rawOptions.wordSeparator.indexOf(e.getChars())>=0}_selectLineAt(e){const t=this._bufferService.buffer.getWrappedRangeForLine(e),i={start:{x:0,y:t.first},end:{x:this._bufferService.cols-1,y:t.last}};this._model.selectionStart=[0,t.first],this._model.selectionEnd=void 0,this._model.selectionStartLength=(0,_.getRangeLength)(i,this._bufferService.cols)}};t.SelectionService=g=s([r(3,f.IBufferService),r(4,f.ICoreService),r(5,h.IMouseService),r(6,f.IOptionsService),r(7,h.IRenderService),r(8,h.ICoreBrowserService)],g)},4725:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.ILinkProviderService=t.IThemeService=t.ICharacterJoinerService=t.ISelectionService=t.IRenderService=t.IMouseService=t.ICoreBrowserService=t.ICharSizeService=void 0;const s=i(8343);t.ICharSizeService=(0,s.createDecorator)("CharSizeService"),t.ICoreBrowserService=(0,s.createDecorator)("CoreBrowserService"),t.IMouseService=(0,s.createDecorator)("MouseService"),t.IRenderService=(0,s.createDecorator)("RenderService"),t.ISelectionService=(0,s.createDecorator)("SelectionService"),t.ICharacterJoinerService=(0,s.createDecorator)("CharacterJoinerService"),t.IThemeService=(0,s.createDecorator)("ThemeService"),t.ILinkProviderService=(0,s.createDecorator)("LinkProviderService")},6731:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.ThemeService=t.DEFAULT_ANSI_COLORS=void 0;const n=i(7239),o=i(8055),a=i(8460),h=i(844),c=i(2585),l=o.css.toColor("#ffffff"),d=o.css.toColor("#000000"),_=o.css.toColor("#ffffff"),u=o.css.toColor("#000000"),f={css:"rgba(255, 255, 255, 0.3)",rgba:4294967117};t.DEFAULT_ANSI_COLORS=Object.freeze((()=>{const e=[o.css.toColor("#2e3436"),o.css.toColor("#cc0000"),o.css.toColor("#4e9a06"),o.css.toColor("#c4a000"),o.css.toColor("#3465a4"),o.css.toColor("#75507b"),o.css.toColor("#06989a"),o.css.toColor("#d3d7cf"),o.css.toColor("#555753"),o.css.toColor("#ef2929"),o.css.toColor("#8ae234"),o.css.toColor("#fce94f"),o.css.toColor("#729fcf"),o.css.toColor("#ad7fa8"),o.css.toColor("#34e2e2"),o.css.toColor("#eeeeec")],t=[0,95,135,175,215,255];for(let i=0;i<216;i++){const s=t[i/36%6|0],r=t[i/6%6|0],n=t[i%6];e.push({css:o.channels.toCss(s,r,n),rgba:o.channels.toRgba(s,r,n)})}for(let t=0;t<24;t++){const i=8+10*t;e.push({css:o.channels.toCss(i,i,i),rgba:o.channels.toRgba(i,i,i)})}return e})());let v=t.ThemeService=class extends h.Disposable{get colors(){return this._colors}constructor(e){super(),this._optionsService=e,this._contrastCache=new n.ColorContrastCache,this._halfContrastCache=new n.ColorContrastCache,this._onChangeColors=this.register(new a.EventEmitter),this.onChangeColors=this._onChangeColors.event,this._colors={foreground:l,background:d,cursor:_,cursorAccent:u,selectionForeground:void 0,selectionBackgroundTransparent:f,selectionBackgroundOpaque:o.color.blend(d,f),selectionInactiveBackgroundTransparent:f,selectionInactiveBackgroundOpaque:o.color.blend(d,f),ansi:t.DEFAULT_ANSI_COLORS.slice(),contrastCache:this._contrastCache,halfContrastCache:this._halfContrastCache},this._updateRestoreColors(),this._setTheme(this._optionsService.rawOptions.theme),this.register(this._optionsService.onSpecificOptionChange("minimumContrastRatio",(()=>this._contrastCache.clear()))),this.register(this._optionsService.onSpecificOptionChange("theme",(()=>this._setTheme(this._optionsService.rawOptions.theme))))}_setTheme(e={}){const i=this._colors;if(i.foreground=p(e.foreground,l),i.background=p(e.background,d),i.cursor=p(e.cursor,_),i.cursorAccent=p(e.cursorAccent,u),i.selectionBackgroundTransparent=p(e.selectionBackground,f),i.selectionBackgroundOpaque=o.color.blend(i.background,i.selectionBackgroundTransparent),i.selectionInactiveBackgroundTransparent=p(e.selectionInactiveBackground,i.selectionBackgroundTransparent),i.selectionInactiveBackgroundOpaque=o.color.blend(i.background,i.selectionInactiveBackgroundTransparent),i.selectionForeground=e.selectionForeground?p(e.selectionForeground,o.NULL_COLOR):void 0,i.selectionForeground===o.NULL_COLOR&&(i.selectionForeground=void 0),o.color.isOpaque(i.selectionBackgroundTransparent)){const e=.3;i.selectionBackgroundTransparent=o.color.opacity(i.selectionBackgroundTransparent,e)}if(o.color.isOpaque(i.selectionInactiveBackgroundTransparent)){const e=.3;i.selectionInactiveBackgroundTransparent=o.color.opacity(i.selectionInactiveBackgroundTransparent,e)}if(i.ansi=t.DEFAULT_ANSI_COLORS.slice(),i.ansi[0]=p(e.black,t.DEFAULT_ANSI_COLORS[0]),i.ansi[1]=p(e.red,t.DEFAULT_ANSI_COLORS[1]),i.ansi[2]=p(e.green,t.DEFAULT_ANSI_COLORS[2]),i.ansi[3]=p(e.yellow,t.DEFAULT_ANSI_COLORS[3]),i.ansi[4]=p(e.blue,t.DEFAULT_ANSI_COLORS[4]),i.ansi[5]=p(e.magenta,t.DEFAULT_ANSI_COLORS[5]),i.ansi[6]=p(e.cyan,t.DEFAULT_ANSI_COLORS[6]),i.ansi[7]=p(e.white,t.DEFAULT_ANSI_COLORS[7]),i.ansi[8]=p(e.brightBlack,t.DEFAULT_ANSI_COLORS[8]),i.ansi[9]=p(e.brightRed,t.DEFAULT_ANSI_COLORS[9]),i.ansi[10]=p(e.brightGreen,t.DEFAULT_ANSI_COLORS[10]),i.ansi[11]=p(e.brightYellow,t.DEFAULT_ANSI_COLORS[11]),i.ansi[12]=p(e.brightBlue,t.DEFAULT_ANSI_COLORS[12]),i.ansi[13]=p(e.brightMagenta,t.DEFAULT_ANSI_COLORS[13]),i.ansi[14]=p(e.brightCyan,t.DEFAULT_ANSI_COLORS[14]),i.ansi[15]=p(e.brightWhite,t.DEFAULT_ANSI_COLORS[15]),e.extendedAnsi){const s=Math.min(i.ansi.length-16,e.extendedAnsi.length);for(let r=0;r{Object.defineProperty(t,"__esModule",{value:!0}),t.CircularList=void 0;const s=i(8460),r=i(844);class n extends r.Disposable{constructor(e){super(),this._maxLength=e,this.onDeleteEmitter=this.register(new s.EventEmitter),this.onDelete=this.onDeleteEmitter.event,this.onInsertEmitter=this.register(new s.EventEmitter),this.onInsert=this.onInsertEmitter.event,this.onTrimEmitter=this.register(new s.EventEmitter),this.onTrim=this.onTrimEmitter.event,this._array=new Array(this._maxLength),this._startIndex=0,this._length=0}get maxLength(){return this._maxLength}set maxLength(e){if(this._maxLength===e)return;const t=new Array(e);for(let i=0;ithis._length)for(let t=this._length;t=e;t--)this._array[this._getCyclicIndex(t+i.length)]=this._array[this._getCyclicIndex(t)];for(let t=0;tthis._maxLength){const e=this._length+i.length-this._maxLength;this._startIndex+=e,this._length=this._maxLength,this.onTrimEmitter.fire(e)}else this._length+=i.length}trimStart(e){e>this._length&&(e=this._length),this._startIndex+=e,this._length-=e,this.onTrimEmitter.fire(e)}shiftElements(e,t,i){if(!(t<=0)){if(e<0||e>=this._length)throw new Error("start argument out of range");if(e+i<0)throw new Error("Cannot shift elements in list beyond index 0");if(i>0){for(let s=t-1;s>=0;s--)this.set(e+s+i,this.get(e+s));const s=e+t+i-this._length;if(s>0)for(this._length+=s;this._length>this._maxLength;)this._length--,this._startIndex++,this.onTrimEmitter.fire(1)}else for(let s=0;s{Object.defineProperty(t,"__esModule",{value:!0}),t.clone=void 0,t.clone=function e(t,i=5){if("object"!=typeof t)return t;const s=Array.isArray(t)?[]:{};for(const r in t)s[r]=i<=1?t[r]:t[r]&&e(t[r],i-1);return s}},8055:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.contrastRatio=t.toPaddedHex=t.rgba=t.rgb=t.css=t.color=t.channels=t.NULL_COLOR=void 0;let i=0,s=0,r=0,n=0;var o,a,h,c,l;function d(e){const t=e.toString(16);return t.length<2?"0"+t:t}function _(e,t){return e>>0},e.toColor=function(t,i,s,r){return{css:e.toCss(t,i,s,r),rgba:e.toRgba(t,i,s,r)}}}(o||(t.channels=o={})),function(e){function t(e,t){return n=Math.round(255*t),[i,s,r]=l.toChannels(e.rgba),{css:o.toCss(i,s,r,n),rgba:o.toRgba(i,s,r,n)}}e.blend=function(e,t){if(n=(255&t.rgba)/255,1===n)return{css:t.css,rgba:t.rgba};const a=t.rgba>>24&255,h=t.rgba>>16&255,c=t.rgba>>8&255,l=e.rgba>>24&255,d=e.rgba>>16&255,_=e.rgba>>8&255;return i=l+Math.round((a-l)*n),s=d+Math.round((h-d)*n),r=_+Math.round((c-_)*n),{css:o.toCss(i,s,r),rgba:o.toRgba(i,s,r)}},e.isOpaque=function(e){return 255==(255&e.rgba)},e.ensureContrastRatio=function(e,t,i){const s=l.ensureContrastRatio(e.rgba,t.rgba,i);if(s)return o.toColor(s>>24&255,s>>16&255,s>>8&255)},e.opaque=function(e){const t=(255|e.rgba)>>>0;return[i,s,r]=l.toChannels(t),{css:o.toCss(i,s,r),rgba:t}},e.opacity=t,e.multiplyOpacity=function(e,i){return n=255&e.rgba,t(e,n*i/255)},e.toColorRGB=function(e){return[e.rgba>>24&255,e.rgba>>16&255,e.rgba>>8&255]}}(a||(t.color=a={})),function(e){let t,a;try{const e=document.createElement("canvas");e.width=1,e.height=1;const i=e.getContext("2d",{willReadFrequently:!0});i&&(t=i,t.globalCompositeOperation="copy",a=t.createLinearGradient(0,0,1,1))}catch{}e.toColor=function(e){if(e.match(/#[\da-f]{3,8}/i))switch(e.length){case 4:return i=parseInt(e.slice(1,2).repeat(2),16),s=parseInt(e.slice(2,3).repeat(2),16),r=parseInt(e.slice(3,4).repeat(2),16),o.toColor(i,s,r);case 5:return i=parseInt(e.slice(1,2).repeat(2),16),s=parseInt(e.slice(2,3).repeat(2),16),r=parseInt(e.slice(3,4).repeat(2),16),n=parseInt(e.slice(4,5).repeat(2),16),o.toColor(i,s,r,n);case 7:return{css:e,rgba:(parseInt(e.slice(1),16)<<8|255)>>>0};case 9:return{css:e,rgba:parseInt(e.slice(1),16)>>>0}}const h=e.match(/rgba?\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*(,\s*(0|1|\d?\.(\d+))\s*)?\)/);if(h)return i=parseInt(h[1]),s=parseInt(h[2]),r=parseInt(h[3]),n=Math.round(255*(void 0===h[5]?1:parseFloat(h[5]))),o.toColor(i,s,r,n);if(!t||!a)throw new Error("css.toColor: Unsupported css format");if(t.fillStyle=a,t.fillStyle=e,"string"!=typeof t.fillStyle)throw new Error("css.toColor: Unsupported css format");if(t.fillRect(0,0,1,1),[i,s,r,n]=t.getImageData(0,0,1,1).data,255!==n)throw new Error("css.toColor: Unsupported css format");return{rgba:o.toRgba(i,s,r,n),css:e}}}(h||(t.css=h={})),function(e){function t(e,t,i){const s=e/255,r=t/255,n=i/255;return.2126*(s<=.03928?s/12.92:Math.pow((s+.055)/1.055,2.4))+.7152*(r<=.03928?r/12.92:Math.pow((r+.055)/1.055,2.4))+.0722*(n<=.03928?n/12.92:Math.pow((n+.055)/1.055,2.4))}e.relativeLuminance=function(e){return t(e>>16&255,e>>8&255,255&e)},e.relativeLuminance2=t}(c||(t.rgb=c={})),function(e){function t(e,t,i){const s=e>>24&255,r=e>>16&255,n=e>>8&255;let o=t>>24&255,a=t>>16&255,h=t>>8&255,l=_(c.relativeLuminance2(o,a,h),c.relativeLuminance2(s,r,n));for(;l0||a>0||h>0);)o-=Math.max(0,Math.ceil(.1*o)),a-=Math.max(0,Math.ceil(.1*a)),h-=Math.max(0,Math.ceil(.1*h)),l=_(c.relativeLuminance2(o,a,h),c.relativeLuminance2(s,r,n));return(o<<24|a<<16|h<<8|255)>>>0}function a(e,t,i){const s=e>>24&255,r=e>>16&255,n=e>>8&255;let o=t>>24&255,a=t>>16&255,h=t>>8&255,l=_(c.relativeLuminance2(o,a,h),c.relativeLuminance2(s,r,n));for(;l>>0}e.blend=function(e,t){if(n=(255&t)/255,1===n)return t;const a=t>>24&255,h=t>>16&255,c=t>>8&255,l=e>>24&255,d=e>>16&255,_=e>>8&255;return i=l+Math.round((a-l)*n),s=d+Math.round((h-d)*n),r=_+Math.round((c-_)*n),o.toRgba(i,s,r)},e.ensureContrastRatio=function(e,i,s){const r=c.relativeLuminance(e>>8),n=c.relativeLuminance(i>>8);if(_(r,n)>8));if(o_(r,c.relativeLuminance(t>>8))?n:t}return n}const o=a(e,i,s),h=_(r,c.relativeLuminance(o>>8));if(h_(r,c.relativeLuminance(n>>8))?o:n}return o}},e.reduceLuminance=t,e.increaseLuminance=a,e.toChannels=function(e){return[e>>24&255,e>>16&255,e>>8&255,255&e]}}(l||(t.rgba=l={})),t.toPaddedHex=d,t.contrastRatio=_},8969:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.CoreTerminal=void 0;const s=i(844),r=i(2585),n=i(4348),o=i(7866),a=i(744),h=i(7302),c=i(6975),l=i(8460),d=i(1753),_=i(1480),u=i(7994),f=i(9282),v=i(5435),p=i(5981),g=i(2660);let m=!1;class S extends s.Disposable{get onScroll(){return this._onScrollApi||(this._onScrollApi=this.register(new l.EventEmitter),this._onScroll.event((e=>{this._onScrollApi?.fire(e.position)}))),this._onScrollApi.event}get cols(){return this._bufferService.cols}get rows(){return this._bufferService.rows}get buffers(){return this._bufferService.buffers}get options(){return this.optionsService.options}set options(e){for(const t in e)this.optionsService.options[t]=e[t]}constructor(e){super(),this._windowsWrappingHeuristics=this.register(new s.MutableDisposable),this._onBinary=this.register(new l.EventEmitter),this.onBinary=this._onBinary.event,this._onData=this.register(new l.EventEmitter),this.onData=this._onData.event,this._onLineFeed=this.register(new l.EventEmitter),this.onLineFeed=this._onLineFeed.event,this._onResize=this.register(new l.EventEmitter),this.onResize=this._onResize.event,this._onWriteParsed=this.register(new l.EventEmitter),this.onWriteParsed=this._onWriteParsed.event,this._onScroll=this.register(new l.EventEmitter),this._instantiationService=new n.InstantiationService,this.optionsService=this.register(new h.OptionsService(e)),this._instantiationService.setService(r.IOptionsService,this.optionsService),this._bufferService=this.register(this._instantiationService.createInstance(a.BufferService)),this._instantiationService.setService(r.IBufferService,this._bufferService),this._logService=this.register(this._instantiationService.createInstance(o.LogService)),this._instantiationService.setService(r.ILogService,this._logService),this.coreService=this.register(this._instantiationService.createInstance(c.CoreService)),this._instantiationService.setService(r.ICoreService,this.coreService),this.coreMouseService=this.register(this._instantiationService.createInstance(d.CoreMouseService)),this._instantiationService.setService(r.ICoreMouseService,this.coreMouseService),this.unicodeService=this.register(this._instantiationService.createInstance(_.UnicodeService)),this._instantiationService.setService(r.IUnicodeService,this.unicodeService),this._charsetService=this._instantiationService.createInstance(u.CharsetService),this._instantiationService.setService(r.ICharsetService,this._charsetService),this._oscLinkService=this._instantiationService.createInstance(g.OscLinkService),this._instantiationService.setService(r.IOscLinkService,this._oscLinkService),this._inputHandler=this.register(new v.InputHandler(this._bufferService,this._charsetService,this.coreService,this._logService,this.optionsService,this._oscLinkService,this.coreMouseService,this.unicodeService)),this.register((0,l.forwardEvent)(this._inputHandler.onLineFeed,this._onLineFeed)),this.register(this._inputHandler),this.register((0,l.forwardEvent)(this._bufferService.onResize,this._onResize)),this.register((0,l.forwardEvent)(this.coreService.onData,this._onData)),this.register((0,l.forwardEvent)(this.coreService.onBinary,this._onBinary)),this.register(this.coreService.onRequestScrollToBottom((()=>this.scrollToBottom()))),this.register(this.coreService.onUserInput((()=>this._writeBuffer.handleUserInput()))),this.register(this.optionsService.onMultipleOptionChange(["windowsMode","windowsPty"],(()=>this._handleWindowsPtyOptionChange()))),this.register(this._bufferService.onScroll((e=>{this._onScroll.fire({position:this._bufferService.buffer.ydisp,source:0}),this._inputHandler.markRangeDirty(this._bufferService.buffer.scrollTop,this._bufferService.buffer.scrollBottom)}))),this.register(this._inputHandler.onScroll((e=>{this._onScroll.fire({position:this._bufferService.buffer.ydisp,source:0}),this._inputHandler.markRangeDirty(this._bufferService.buffer.scrollTop,this._bufferService.buffer.scrollBottom)}))),this._writeBuffer=this.register(new p.WriteBuffer(((e,t)=>this._inputHandler.parse(e,t)))),this.register((0,l.forwardEvent)(this._writeBuffer.onWriteParsed,this._onWriteParsed))}write(e,t){this._writeBuffer.write(e,t)}writeSync(e,t){this._logService.logLevel<=r.LogLevelEnum.WARN&&!m&&(this._logService.warn("writeSync is unreliable and will be removed soon."),m=!0),this._writeBuffer.writeSync(e,t)}input(e,t=!0){this.coreService.triggerDataEvent(e,t)}resize(e,t){isNaN(e)||isNaN(t)||(e=Math.max(e,a.MINIMUM_COLS),t=Math.max(t,a.MINIMUM_ROWS),this._bufferService.resize(e,t))}scroll(e,t=!1){this._bufferService.scroll(e,t)}scrollLines(e,t,i){this._bufferService.scrollLines(e,t,i)}scrollPages(e){this.scrollLines(e*(this.rows-1))}scrollToTop(){this.scrollLines(-this._bufferService.buffer.ydisp)}scrollToBottom(){this.scrollLines(this._bufferService.buffer.ybase-this._bufferService.buffer.ydisp)}scrollToLine(e){const t=e-this._bufferService.buffer.ydisp;0!==t&&this.scrollLines(t)}registerEscHandler(e,t){return this._inputHandler.registerEscHandler(e,t)}registerDcsHandler(e,t){return this._inputHandler.registerDcsHandler(e,t)}registerCsiHandler(e,t){return this._inputHandler.registerCsiHandler(e,t)}registerOscHandler(e,t){return this._inputHandler.registerOscHandler(e,t)}_setup(){this._handleWindowsPtyOptionChange()}reset(){this._inputHandler.reset(),this._bufferService.reset(),this._charsetService.reset(),this.coreService.reset(),this.coreMouseService.reset()}_handleWindowsPtyOptionChange(){let e=!1;const t=this.optionsService.rawOptions.windowsPty;t&&void 0!==t.buildNumber&&void 0!==t.buildNumber?e=!!("conpty"===t.backend&&t.buildNumber<21376):this.optionsService.rawOptions.windowsMode&&(e=!0),e?this._enableWindowsWrappingHeuristics():this._windowsWrappingHeuristics.clear()}_enableWindowsWrappingHeuristics(){if(!this._windowsWrappingHeuristics.value){const e=[];e.push(this.onLineFeed(f.updateWindowsModeWrappedState.bind(null,this._bufferService))),e.push(this.registerCsiHandler({final:"H"},(()=>((0,f.updateWindowsModeWrappedState)(this._bufferService),!1)))),this._windowsWrappingHeuristics.value=(0,s.toDisposable)((()=>{for(const t of e)t.dispose()}))}}}t.CoreTerminal=S},8460:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.runAndSubscribe=t.forwardEvent=t.EventEmitter=void 0,t.EventEmitter=class{constructor(){this._listeners=[],this._disposed=!1}get event(){return this._event||(this._event=e=>(this._listeners.push(e),{dispose:()=>{if(!this._disposed)for(let t=0;tt.fire(e)))},t.runAndSubscribe=function(e,t){return t(void 0),e((e=>t(e)))}},5435:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.InputHandler=t.WindowsOptionsReportType=void 0;const n=i(2584),o=i(7116),a=i(2015),h=i(844),c=i(482),l=i(8437),d=i(8460),_=i(643),u=i(511),f=i(3734),v=i(2585),p=i(1480),g=i(6242),m=i(6351),S=i(5941),C={"(":0,")":1,"*":2,"+":3,"-":1,".":2},b=131072;function w(e,t){if(e>24)return t.setWinLines||!1;switch(e){case 1:return!!t.restoreWin;case 2:return!!t.minimizeWin;case 3:return!!t.setWinPosition;case 4:return!!t.setWinSizePixels;case 5:return!!t.raiseWin;case 6:return!!t.lowerWin;case 7:return!!t.refreshWin;case 8:return!!t.setWinSizeChars;case 9:return!!t.maximizeWin;case 10:return!!t.fullscreenWin;case 11:return!!t.getWinState;case 13:return!!t.getWinPosition;case 14:return!!t.getWinSizePixels;case 15:return!!t.getScreenSizePixels;case 16:return!!t.getCellSizePixels;case 18:return!!t.getWinSizeChars;case 19:return!!t.getScreenSizeChars;case 20:return!!t.getIconTitle;case 21:return!!t.getWinTitle;case 22:return!!t.pushTitle;case 23:return!!t.popTitle;case 24:return!!t.setWinLines}return!1}var y;!function(e){e[e.GET_WIN_SIZE_PIXELS=0]="GET_WIN_SIZE_PIXELS",e[e.GET_CELL_SIZE_PIXELS=1]="GET_CELL_SIZE_PIXELS"}(y||(t.WindowsOptionsReportType=y={}));let E=0;class k extends h.Disposable{getAttrData(){return this._curAttrData}constructor(e,t,i,s,r,h,_,f,v=new a.EscapeSequenceParser){super(),this._bufferService=e,this._charsetService=t,this._coreService=i,this._logService=s,this._optionsService=r,this._oscLinkService=h,this._coreMouseService=_,this._unicodeService=f,this._parser=v,this._parseBuffer=new Uint32Array(4096),this._stringDecoder=new c.StringToUtf32,this._utf8Decoder=new c.Utf8ToUtf32,this._workCell=new u.CellData,this._windowTitle="",this._iconName="",this._windowTitleStack=[],this._iconNameStack=[],this._curAttrData=l.DEFAULT_ATTR_DATA.clone(),this._eraseAttrDataInternal=l.DEFAULT_ATTR_DATA.clone(),this._onRequestBell=this.register(new d.EventEmitter),this.onRequestBell=this._onRequestBell.event,this._onRequestRefreshRows=this.register(new d.EventEmitter),this.onRequestRefreshRows=this._onRequestRefreshRows.event,this._onRequestReset=this.register(new d.EventEmitter),this.onRequestReset=this._onRequestReset.event,this._onRequestSendFocus=this.register(new d.EventEmitter),this.onRequestSendFocus=this._onRequestSendFocus.event,this._onRequestSyncScrollBar=this.register(new d.EventEmitter),this.onRequestSyncScrollBar=this._onRequestSyncScrollBar.event,this._onRequestWindowsOptionsReport=this.register(new d.EventEmitter),this.onRequestWindowsOptionsReport=this._onRequestWindowsOptionsReport.event,this._onA11yChar=this.register(new d.EventEmitter),this.onA11yChar=this._onA11yChar.event,this._onA11yTab=this.register(new d.EventEmitter),this.onA11yTab=this._onA11yTab.event,this._onCursorMove=this.register(new d.EventEmitter),this.onCursorMove=this._onCursorMove.event,this._onLineFeed=this.register(new d.EventEmitter),this.onLineFeed=this._onLineFeed.event,this._onScroll=this.register(new d.EventEmitter),this.onScroll=this._onScroll.event,this._onTitleChange=this.register(new d.EventEmitter),this.onTitleChange=this._onTitleChange.event,this._onColor=this.register(new d.EventEmitter),this.onColor=this._onColor.event,this._parseStack={paused:!1,cursorStartX:0,cursorStartY:0,decodedLength:0,position:0},this._specialColors=[256,257,258],this.register(this._parser),this._dirtyRowTracker=new L(this._bufferService),this._activeBuffer=this._bufferService.buffer,this.register(this._bufferService.buffers.onBufferActivate((e=>this._activeBuffer=e.activeBuffer))),this._parser.setCsiHandlerFallback(((e,t)=>{this._logService.debug("Unknown CSI code: ",{identifier:this._parser.identToString(e),params:t.toArray()})})),this._parser.setEscHandlerFallback((e=>{this._logService.debug("Unknown ESC code: ",{identifier:this._parser.identToString(e)})})),this._parser.setExecuteHandlerFallback((e=>{this._logService.debug("Unknown EXECUTE code: ",{code:e})})),this._parser.setOscHandlerFallback(((e,t,i)=>{this._logService.debug("Unknown OSC code: ",{identifier:e,action:t,data:i})})),this._parser.setDcsHandlerFallback(((e,t,i)=>{"HOOK"===t&&(i=i.toArray()),this._logService.debug("Unknown DCS code: ",{identifier:this._parser.identToString(e),action:t,payload:i})})),this._parser.setPrintHandler(((e,t,i)=>this.print(e,t,i))),this._parser.registerCsiHandler({final:"@"},(e=>this.insertChars(e))),this._parser.registerCsiHandler({intermediates:" ",final:"@"},(e=>this.scrollLeft(e))),this._parser.registerCsiHandler({final:"A"},(e=>this.cursorUp(e))),this._parser.registerCsiHandler({intermediates:" ",final:"A"},(e=>this.scrollRight(e))),this._parser.registerCsiHandler({final:"B"},(e=>this.cursorDown(e))),this._parser.registerCsiHandler({final:"C"},(e=>this.cursorForward(e))),this._parser.registerCsiHandler({final:"D"},(e=>this.cursorBackward(e))),this._parser.registerCsiHandler({final:"E"},(e=>this.cursorNextLine(e))),this._parser.registerCsiHandler({final:"F"},(e=>this.cursorPrecedingLine(e))),this._parser.registerCsiHandler({final:"G"},(e=>this.cursorCharAbsolute(e))),this._parser.registerCsiHandler({final:"H"},(e=>this.cursorPosition(e))),this._parser.registerCsiHandler({final:"I"},(e=>this.cursorForwardTab(e))),this._parser.registerCsiHandler({final:"J"},(e=>this.eraseInDisplay(e,!1))),this._parser.registerCsiHandler({prefix:"?",final:"J"},(e=>this.eraseInDisplay(e,!0))),this._parser.registerCsiHandler({final:"K"},(e=>this.eraseInLine(e,!1))),this._parser.registerCsiHandler({prefix:"?",final:"K"},(e=>this.eraseInLine(e,!0))),this._parser.registerCsiHandler({final:"L"},(e=>this.insertLines(e))),this._parser.registerCsiHandler({final:"M"},(e=>this.deleteLines(e))),this._parser.registerCsiHandler({final:"P"},(e=>this.deleteChars(e))),this._parser.registerCsiHandler({final:"S"},(e=>this.scrollUp(e))),this._parser.registerCsiHandler({final:"T"},(e=>this.scrollDown(e))),this._parser.registerCsiHandler({final:"X"},(e=>this.eraseChars(e))),this._parser.registerCsiHandler({final:"Z"},(e=>this.cursorBackwardTab(e))),this._parser.registerCsiHandler({final:"`"},(e=>this.charPosAbsolute(e))),this._parser.registerCsiHandler({final:"a"},(e=>this.hPositionRelative(e))),this._parser.registerCsiHandler({final:"b"},(e=>this.repeatPrecedingCharacter(e))),this._parser.registerCsiHandler({final:"c"},(e=>this.sendDeviceAttributesPrimary(e))),this._parser.registerCsiHandler({prefix:">",final:"c"},(e=>this.sendDeviceAttributesSecondary(e))),this._parser.registerCsiHandler({final:"d"},(e=>this.linePosAbsolute(e))),this._parser.registerCsiHandler({final:"e"},(e=>this.vPositionRelative(e))),this._parser.registerCsiHandler({final:"f"},(e=>this.hVPosition(e))),this._parser.registerCsiHandler({final:"g"},(e=>this.tabClear(e))),this._parser.registerCsiHandler({final:"h"},(e=>this.setMode(e))),this._parser.registerCsiHandler({prefix:"?",final:"h"},(e=>this.setModePrivate(e))),this._parser.registerCsiHandler({final:"l"},(e=>this.resetMode(e))),this._parser.registerCsiHandler({prefix:"?",final:"l"},(e=>this.resetModePrivate(e))),this._parser.registerCsiHandler({final:"m"},(e=>this.charAttributes(e))),this._parser.registerCsiHandler({final:"n"},(e=>this.deviceStatus(e))),this._parser.registerCsiHandler({prefix:"?",final:"n"},(e=>this.deviceStatusPrivate(e))),this._parser.registerCsiHandler({intermediates:"!",final:"p"},(e=>this.softReset(e))),this._parser.registerCsiHandler({intermediates:" ",final:"q"},(e=>this.setCursorStyle(e))),this._parser.registerCsiHandler({final:"r"},(e=>this.setScrollRegion(e))),this._parser.registerCsiHandler({final:"s"},(e=>this.saveCursor(e))),this._parser.registerCsiHandler({final:"t"},(e=>this.windowOptions(e))),this._parser.registerCsiHandler({final:"u"},(e=>this.restoreCursor(e))),this._parser.registerCsiHandler({intermediates:"'",final:"}"},(e=>this.insertColumns(e))),this._parser.registerCsiHandler({intermediates:"'",final:"~"},(e=>this.deleteColumns(e))),this._parser.registerCsiHandler({intermediates:'"',final:"q"},(e=>this.selectProtected(e))),this._parser.registerCsiHandler({intermediates:"$",final:"p"},(e=>this.requestMode(e,!0))),this._parser.registerCsiHandler({prefix:"?",intermediates:"$",final:"p"},(e=>this.requestMode(e,!1))),this._parser.setExecuteHandler(n.C0.BEL,(()=>this.bell())),this._parser.setExecuteHandler(n.C0.LF,(()=>this.lineFeed())),this._parser.setExecuteHandler(n.C0.VT,(()=>this.lineFeed())),this._parser.setExecuteHandler(n.C0.FF,(()=>this.lineFeed())),this._parser.setExecuteHandler(n.C0.CR,(()=>this.carriageReturn())),this._parser.setExecuteHandler(n.C0.BS,(()=>this.backspace())),this._parser.setExecuteHandler(n.C0.HT,(()=>this.tab())),this._parser.setExecuteHandler(n.C0.SO,(()=>this.shiftOut())),this._parser.setExecuteHandler(n.C0.SI,(()=>this.shiftIn())),this._parser.setExecuteHandler(n.C1.IND,(()=>this.index())),this._parser.setExecuteHandler(n.C1.NEL,(()=>this.nextLine())),this._parser.setExecuteHandler(n.C1.HTS,(()=>this.tabSet())),this._parser.registerOscHandler(0,new g.OscHandler((e=>(this.setTitle(e),this.setIconName(e),!0)))),this._parser.registerOscHandler(1,new g.OscHandler((e=>this.setIconName(e)))),this._parser.registerOscHandler(2,new g.OscHandler((e=>this.setTitle(e)))),this._parser.registerOscHandler(4,new g.OscHandler((e=>this.setOrReportIndexedColor(e)))),this._parser.registerOscHandler(8,new g.OscHandler((e=>this.setHyperlink(e)))),this._parser.registerOscHandler(10,new g.OscHandler((e=>this.setOrReportFgColor(e)))),this._parser.registerOscHandler(11,new g.OscHandler((e=>this.setOrReportBgColor(e)))),this._parser.registerOscHandler(12,new g.OscHandler((e=>this.setOrReportCursorColor(e)))),this._parser.registerOscHandler(104,new g.OscHandler((e=>this.restoreIndexedColor(e)))),this._parser.registerOscHandler(110,new g.OscHandler((e=>this.restoreFgColor(e)))),this._parser.registerOscHandler(111,new g.OscHandler((e=>this.restoreBgColor(e)))),this._parser.registerOscHandler(112,new g.OscHandler((e=>this.restoreCursorColor(e)))),this._parser.registerEscHandler({final:"7"},(()=>this.saveCursor())),this._parser.registerEscHandler({final:"8"},(()=>this.restoreCursor())),this._parser.registerEscHandler({final:"D"},(()=>this.index())),this._parser.registerEscHandler({final:"E"},(()=>this.nextLine())),this._parser.registerEscHandler({final:"H"},(()=>this.tabSet())),this._parser.registerEscHandler({final:"M"},(()=>this.reverseIndex())),this._parser.registerEscHandler({final:"="},(()=>this.keypadApplicationMode())),this._parser.registerEscHandler({final:">"},(()=>this.keypadNumericMode())),this._parser.registerEscHandler({final:"c"},(()=>this.fullReset())),this._parser.registerEscHandler({final:"n"},(()=>this.setgLevel(2))),this._parser.registerEscHandler({final:"o"},(()=>this.setgLevel(3))),this._parser.registerEscHandler({final:"|"},(()=>this.setgLevel(3))),this._parser.registerEscHandler({final:"}"},(()=>this.setgLevel(2))),this._parser.registerEscHandler({final:"~"},(()=>this.setgLevel(1))),this._parser.registerEscHandler({intermediates:"%",final:"@"},(()=>this.selectDefaultCharset())),this._parser.registerEscHandler({intermediates:"%",final:"G"},(()=>this.selectDefaultCharset()));for(const e in o.CHARSETS)this._parser.registerEscHandler({intermediates:"(",final:e},(()=>this.selectCharset("("+e))),this._parser.registerEscHandler({intermediates:")",final:e},(()=>this.selectCharset(")"+e))),this._parser.registerEscHandler({intermediates:"*",final:e},(()=>this.selectCharset("*"+e))),this._parser.registerEscHandler({intermediates:"+",final:e},(()=>this.selectCharset("+"+e))),this._parser.registerEscHandler({intermediates:"-",final:e},(()=>this.selectCharset("-"+e))),this._parser.registerEscHandler({intermediates:".",final:e},(()=>this.selectCharset("."+e))),this._parser.registerEscHandler({intermediates:"/",final:e},(()=>this.selectCharset("/"+e)));this._parser.registerEscHandler({intermediates:"#",final:"8"},(()=>this.screenAlignmentPattern())),this._parser.setErrorHandler((e=>(this._logService.error("Parsing error: ",e),e))),this._parser.registerDcsHandler({intermediates:"$",final:"q"},new m.DcsHandler(((e,t)=>this.requestStatusString(e,t))))}_preserveStack(e,t,i,s){this._parseStack.paused=!0,this._parseStack.cursorStartX=e,this._parseStack.cursorStartY=t,this._parseStack.decodedLength=i,this._parseStack.position=s}_logSlowResolvingAsync(e){this._logService.logLevel<=v.LogLevelEnum.WARN&&Promise.race([e,new Promise(((e,t)=>setTimeout((()=>t("#SLOW_TIMEOUT")),5e3)))]).catch((e=>{if("#SLOW_TIMEOUT"!==e)throw e;console.warn("async parser handler taking longer than 5000 ms")}))}_getCurrentLinkId(){return this._curAttrData.extended.urlId}parse(e,t){let i,s=this._activeBuffer.x,r=this._activeBuffer.y,n=0;const o=this._parseStack.paused;if(o){if(i=this._parser.parse(this._parseBuffer,this._parseStack.decodedLength,t))return this._logSlowResolvingAsync(i),i;s=this._parseStack.cursorStartX,r=this._parseStack.cursorStartY,this._parseStack.paused=!1,e.length>b&&(n=this._parseStack.position+b)}if(this._logService.logLevel<=v.LogLevelEnum.DEBUG&&this._logService.debug("parsing data"+("string"==typeof e?` "${e}"`:` "${Array.prototype.map.call(e,(e=>String.fromCharCode(e))).join("")}"`),"string"==typeof e?e.split("").map((e=>e.charCodeAt(0))):e),this._parseBuffer.lengthb)for(let t=n;t0&&2===f.getWidth(this._activeBuffer.x-1)&&f.setCellFromCodepoint(this._activeBuffer.x-1,0,1,u);let v=this._parser.precedingJoinState;for(let g=t;ga)if(h){const e=f;let t=this._activeBuffer.x-m;for(this._activeBuffer.x=m,this._activeBuffer.y++,this._activeBuffer.y===this._activeBuffer.scrollBottom+1?(this._activeBuffer.y--,this._bufferService.scroll(this._eraseAttrData(),!0)):(this._activeBuffer.y>=this._bufferService.rows&&(this._activeBuffer.y=this._bufferService.rows-1),this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y).isWrapped=!0),f=this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y),m>0&&f instanceof l.BufferLine&&f.copyCellsFrom(e,t,0,m,!1);t=0;)f.setCellFromCodepoint(this._activeBuffer.x++,0,0,u)}else if(d&&(f.insertCells(this._activeBuffer.x,r-m,this._activeBuffer.getNullCell(u)),2===f.getWidth(a-1)&&f.setCellFromCodepoint(a-1,_.NULL_CELL_CODE,_.NULL_CELL_WIDTH,u)),f.setCellFromCodepoint(this._activeBuffer.x++,s,r,u),r>0)for(;--r;)f.setCellFromCodepoint(this._activeBuffer.x++,0,0,u)}this._parser.precedingJoinState=v,this._activeBuffer.x0&&0===f.getWidth(this._activeBuffer.x)&&!f.hasContent(this._activeBuffer.x)&&f.setCellFromCodepoint(this._activeBuffer.x,0,1,u),this._dirtyRowTracker.markDirty(this._activeBuffer.y)}registerCsiHandler(e,t){return"t"!==e.final||e.prefix||e.intermediates?this._parser.registerCsiHandler(e,t):this._parser.registerCsiHandler(e,(e=>!w(e.params[0],this._optionsService.rawOptions.windowOptions)||t(e)))}registerDcsHandler(e,t){return this._parser.registerDcsHandler(e,new m.DcsHandler(t))}registerEscHandler(e,t){return this._parser.registerEscHandler(e,t)}registerOscHandler(e,t){return this._parser.registerOscHandler(e,new g.OscHandler(t))}bell(){return this._onRequestBell.fire(),!0}lineFeed(){return this._dirtyRowTracker.markDirty(this._activeBuffer.y),this._optionsService.rawOptions.convertEol&&(this._activeBuffer.x=0),this._activeBuffer.y++,this._activeBuffer.y===this._activeBuffer.scrollBottom+1?(this._activeBuffer.y--,this._bufferService.scroll(this._eraseAttrData())):this._activeBuffer.y>=this._bufferService.rows?this._activeBuffer.y=this._bufferService.rows-1:this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y).isWrapped=!1,this._activeBuffer.x>=this._bufferService.cols&&this._activeBuffer.x--,this._dirtyRowTracker.markDirty(this._activeBuffer.y),this._onLineFeed.fire(),!0}carriageReturn(){return this._activeBuffer.x=0,!0}backspace(){if(!this._coreService.decPrivateModes.reverseWraparound)return this._restrictCursor(),this._activeBuffer.x>0&&this._activeBuffer.x--,!0;if(this._restrictCursor(this._bufferService.cols),this._activeBuffer.x>0)this._activeBuffer.x--;else if(0===this._activeBuffer.x&&this._activeBuffer.y>this._activeBuffer.scrollTop&&this._activeBuffer.y<=this._activeBuffer.scrollBottom&&this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y)?.isWrapped){this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y).isWrapped=!1,this._activeBuffer.y--,this._activeBuffer.x=this._bufferService.cols-1;const e=this._activeBuffer.lines.get(this._activeBuffer.ybase+this._activeBuffer.y);e.hasWidth(this._activeBuffer.x)&&!e.hasContent(this._activeBuffer.x)&&this._activeBuffer.x--}return this._restrictCursor(),!0}tab(){if(this._activeBuffer.x>=this._bufferService.cols)return!0;const e=this._activeBuffer.x;return this._activeBuffer.x=this._activeBuffer.nextStop(),this._optionsService.rawOptions.screenReaderMode&&this._onA11yTab.fire(this._activeBuffer.x-e),!0}shiftOut(){return this._charsetService.setgLevel(1),!0}shiftIn(){return this._charsetService.setgLevel(0),!0}_restrictCursor(e=this._bufferService.cols-1){this._activeBuffer.x=Math.min(e,Math.max(0,this._activeBuffer.x)),this._activeBuffer.y=this._coreService.decPrivateModes.origin?Math.min(this._activeBuffer.scrollBottom,Math.max(this._activeBuffer.scrollTop,this._activeBuffer.y)):Math.min(this._bufferService.rows-1,Math.max(0,this._activeBuffer.y)),this._dirtyRowTracker.markDirty(this._activeBuffer.y)}_setCursor(e,t){this._dirtyRowTracker.markDirty(this._activeBuffer.y),this._coreService.decPrivateModes.origin?(this._activeBuffer.x=e,this._activeBuffer.y=this._activeBuffer.scrollTop+t):(this._activeBuffer.x=e,this._activeBuffer.y=t),this._restrictCursor(),this._dirtyRowTracker.markDirty(this._activeBuffer.y)}_moveCursor(e,t){this._restrictCursor(),this._setCursor(this._activeBuffer.x+e,this._activeBuffer.y+t)}cursorUp(e){const t=this._activeBuffer.y-this._activeBuffer.scrollTop;return t>=0?this._moveCursor(0,-Math.min(t,e.params[0]||1)):this._moveCursor(0,-(e.params[0]||1)),!0}cursorDown(e){const t=this._activeBuffer.scrollBottom-this._activeBuffer.y;return t>=0?this._moveCursor(0,Math.min(t,e.params[0]||1)):this._moveCursor(0,e.params[0]||1),!0}cursorForward(e){return this._moveCursor(e.params[0]||1,0),!0}cursorBackward(e){return this._moveCursor(-(e.params[0]||1),0),!0}cursorNextLine(e){return this.cursorDown(e),this._activeBuffer.x=0,!0}cursorPrecedingLine(e){return this.cursorUp(e),this._activeBuffer.x=0,!0}cursorCharAbsolute(e){return this._setCursor((e.params[0]||1)-1,this._activeBuffer.y),!0}cursorPosition(e){return this._setCursor(e.length>=2?(e.params[1]||1)-1:0,(e.params[0]||1)-1),!0}charPosAbsolute(e){return this._setCursor((e.params[0]||1)-1,this._activeBuffer.y),!0}hPositionRelative(e){return this._moveCursor(e.params[0]||1,0),!0}linePosAbsolute(e){return this._setCursor(this._activeBuffer.x,(e.params[0]||1)-1),!0}vPositionRelative(e){return this._moveCursor(0,e.params[0]||1),!0}hVPosition(e){return this.cursorPosition(e),!0}tabClear(e){const t=e.params[0];return 0===t?delete this._activeBuffer.tabs[this._activeBuffer.x]:3===t&&(this._activeBuffer.tabs={}),!0}cursorForwardTab(e){if(this._activeBuffer.x>=this._bufferService.cols)return!0;let t=e.params[0]||1;for(;t--;)this._activeBuffer.x=this._activeBuffer.nextStop();return!0}cursorBackwardTab(e){if(this._activeBuffer.x>=this._bufferService.cols)return!0;let t=e.params[0]||1;for(;t--;)this._activeBuffer.x=this._activeBuffer.prevStop();return!0}selectProtected(e){const t=e.params[0];return 1===t&&(this._curAttrData.bg|=536870912),2!==t&&0!==t||(this._curAttrData.bg&=-536870913),!0}_eraseInBufferLine(e,t,i,s=!1,r=!1){const n=this._activeBuffer.lines.get(this._activeBuffer.ybase+e);n.replaceCells(t,i,this._activeBuffer.getNullCell(this._eraseAttrData()),r),s&&(n.isWrapped=!1)}_resetBufferLine(e,t=!1){const i=this._activeBuffer.lines.get(this._activeBuffer.ybase+e);i&&(i.fill(this._activeBuffer.getNullCell(this._eraseAttrData()),t),this._bufferService.buffer.clearMarkers(this._activeBuffer.ybase+e),i.isWrapped=!1)}eraseInDisplay(e,t=!1){let i;switch(this._restrictCursor(this._bufferService.cols),e.params[0]){case 0:for(i=this._activeBuffer.y,this._dirtyRowTracker.markDirty(i),this._eraseInBufferLine(i++,this._activeBuffer.x,this._bufferService.cols,0===this._activeBuffer.x,t);i=this._bufferService.cols&&(this._activeBuffer.lines.get(i+1).isWrapped=!1);i--;)this._resetBufferLine(i,t);this._dirtyRowTracker.markDirty(0);break;case 2:for(i=this._bufferService.rows,this._dirtyRowTracker.markDirty(i-1);i--;)this._resetBufferLine(i,t);this._dirtyRowTracker.markDirty(0);break;case 3:const e=this._activeBuffer.lines.length-this._bufferService.rows;e>0&&(this._activeBuffer.lines.trimStart(e),this._activeBuffer.ybase=Math.max(this._activeBuffer.ybase-e,0),this._activeBuffer.ydisp=Math.max(this._activeBuffer.ydisp-e,0),this._onScroll.fire(0))}return!0}eraseInLine(e,t=!1){switch(this._restrictCursor(this._bufferService.cols),e.params[0]){case 0:this._eraseInBufferLine(this._activeBuffer.y,this._activeBuffer.x,this._bufferService.cols,0===this._activeBuffer.x,t);break;case 1:this._eraseInBufferLine(this._activeBuffer.y,0,this._activeBuffer.x+1,!1,t);break;case 2:this._eraseInBufferLine(this._activeBuffer.y,0,this._bufferService.cols,!0,t)}return this._dirtyRowTracker.markDirty(this._activeBuffer.y),!0}insertLines(e){this._restrictCursor();let t=e.params[0]||1;if(this._activeBuffer.y>this._activeBuffer.scrollBottom||this._activeBuffer.ythis._activeBuffer.scrollBottom||this._activeBuffer.ythis._activeBuffer.scrollBottom||this._activeBuffer.ythis._activeBuffer.scrollBottom||this._activeBuffer.ythis._activeBuffer.scrollBottom||this._activeBuffer.ythis._activeBuffer.scrollBottom||this._activeBuffer.y65535?2:1}let h=a;for(let e=1;e0||(this._is("xterm")||this._is("rxvt-unicode")||this._is("screen")?this._coreService.triggerDataEvent(n.C0.ESC+"[?1;2c"):this._is("linux")&&this._coreService.triggerDataEvent(n.C0.ESC+"[?6c")),!0}sendDeviceAttributesSecondary(e){return e.params[0]>0||(this._is("xterm")?this._coreService.triggerDataEvent(n.C0.ESC+"[>0;276;0c"):this._is("rxvt-unicode")?this._coreService.triggerDataEvent(n.C0.ESC+"[>85;95;0c"):this._is("linux")?this._coreService.triggerDataEvent(e.params[0]+"c"):this._is("screen")&&this._coreService.triggerDataEvent(n.C0.ESC+"[>83;40003;0c")),!0}_is(e){return 0===(this._optionsService.rawOptions.termName+"").indexOf(e)}setMode(e){for(let t=0;te?1:2,u=e.params[0];return f=u,v=t?2===u?4:4===u?_(o.modes.insertMode):12===u?3:20===u?_(d.convertEol):0:1===u?_(i.applicationCursorKeys):3===u?d.windowOptions.setWinLines?80===h?2:132===h?1:0:0:6===u?_(i.origin):7===u?_(i.wraparound):8===u?3:9===u?_("X10"===s):12===u?_(d.cursorBlink):25===u?_(!o.isCursorHidden):45===u?_(i.reverseWraparound):66===u?_(i.applicationKeypad):67===u?4:1e3===u?_("VT200"===s):1002===u?_("DRAG"===s):1003===u?_("ANY"===s):1004===u?_(i.sendFocus):1005===u?4:1006===u?_("SGR"===r):1015===u?4:1016===u?_("SGR_PIXELS"===r):1048===u?1:47===u||1047===u||1049===u?_(c===l):2004===u?_(i.bracketedPasteMode):0,o.triggerDataEvent(`${n.C0.ESC}[${t?"":"?"}${f};${v}$y`),!0;var f,v}_updateAttrColor(e,t,i,s,r){return 2===t?(e|=50331648,e&=-16777216,e|=f.AttributeData.fromColorRGB([i,s,r])):5===t&&(e&=-50331904,e|=33554432|255&i),e}_extractColor(e,t,i){const s=[0,0,-1,0,0,0];let r=0,n=0;do{if(s[n+r]=e.params[t+n],e.hasSubParams(t+n)){const i=e.getSubParams(t+n);let o=0;do{5===s[1]&&(r=1),s[n+o+1+r]=i[o]}while(++o=2||2===s[1]&&n+r>=5)break;s[1]&&(r=1)}while(++n+t5)&&(e=1),t.extended.underlineStyle=e,t.fg|=268435456,0===e&&(t.fg&=-268435457),t.updateExtended()}_processSGR0(e){e.fg=l.DEFAULT_ATTR_DATA.fg,e.bg=l.DEFAULT_ATTR_DATA.bg,e.extended=e.extended.clone(),e.extended.underlineStyle=0,e.extended.underlineColor&=-67108864,e.updateExtended()}charAttributes(e){if(1===e.length&&0===e.params[0])return this._processSGR0(this._curAttrData),!0;const t=e.length;let i;const s=this._curAttrData;for(let r=0;r=30&&i<=37?(s.fg&=-50331904,s.fg|=16777216|i-30):i>=40&&i<=47?(s.bg&=-50331904,s.bg|=16777216|i-40):i>=90&&i<=97?(s.fg&=-50331904,s.fg|=16777224|i-90):i>=100&&i<=107?(s.bg&=-50331904,s.bg|=16777224|i-100):0===i?this._processSGR0(s):1===i?s.fg|=134217728:3===i?s.bg|=67108864:4===i?(s.fg|=268435456,this._processUnderline(e.hasSubParams(r)?e.getSubParams(r)[0]:1,s)):5===i?s.fg|=536870912:7===i?s.fg|=67108864:8===i?s.fg|=1073741824:9===i?s.fg|=2147483648:2===i?s.bg|=134217728:21===i?this._processUnderline(2,s):22===i?(s.fg&=-134217729,s.bg&=-134217729):23===i?s.bg&=-67108865:24===i?(s.fg&=-268435457,this._processUnderline(0,s)):25===i?s.fg&=-536870913:27===i?s.fg&=-67108865:28===i?s.fg&=-1073741825:29===i?s.fg&=2147483647:39===i?(s.fg&=-67108864,s.fg|=16777215&l.DEFAULT_ATTR_DATA.fg):49===i?(s.bg&=-67108864,s.bg|=16777215&l.DEFAULT_ATTR_DATA.bg):38===i||48===i||58===i?r+=this._extractColor(e,r,s):53===i?s.bg|=1073741824:55===i?s.bg&=-1073741825:59===i?(s.extended=s.extended.clone(),s.extended.underlineColor=-1,s.updateExtended()):100===i?(s.fg&=-67108864,s.fg|=16777215&l.DEFAULT_ATTR_DATA.fg,s.bg&=-67108864,s.bg|=16777215&l.DEFAULT_ATTR_DATA.bg):this._logService.debug("Unknown SGR attribute: %d.",i);return!0}deviceStatus(e){switch(e.params[0]){case 5:this._coreService.triggerDataEvent(`${n.C0.ESC}[0n`);break;case 6:const e=this._activeBuffer.y+1,t=this._activeBuffer.x+1;this._coreService.triggerDataEvent(`${n.C0.ESC}[${e};${t}R`)}return!0}deviceStatusPrivate(e){if(6===e.params[0]){const e=this._activeBuffer.y+1,t=this._activeBuffer.x+1;this._coreService.triggerDataEvent(`${n.C0.ESC}[?${e};${t}R`)}return!0}softReset(e){return this._coreService.isCursorHidden=!1,this._onRequestSyncScrollBar.fire(),this._activeBuffer.scrollTop=0,this._activeBuffer.scrollBottom=this._bufferService.rows-1,this._curAttrData=l.DEFAULT_ATTR_DATA.clone(),this._coreService.reset(),this._charsetService.reset(),this._activeBuffer.savedX=0,this._activeBuffer.savedY=this._activeBuffer.ybase,this._activeBuffer.savedCurAttrData.fg=this._curAttrData.fg,this._activeBuffer.savedCurAttrData.bg=this._curAttrData.bg,this._activeBuffer.savedCharset=this._charsetService.charset,this._coreService.decPrivateModes.origin=!1,!0}setCursorStyle(e){const t=e.params[0]||1;switch(t){case 1:case 2:this._optionsService.options.cursorStyle="block";break;case 3:case 4:this._optionsService.options.cursorStyle="underline";break;case 5:case 6:this._optionsService.options.cursorStyle="bar"}const i=t%2==1;return this._optionsService.options.cursorBlink=i,!0}setScrollRegion(e){const t=e.params[0]||1;let i;return(e.length<2||(i=e.params[1])>this._bufferService.rows||0===i)&&(i=this._bufferService.rows),i>t&&(this._activeBuffer.scrollTop=t-1,this._activeBuffer.scrollBottom=i-1,this._setCursor(0,0)),!0}windowOptions(e){if(!w(e.params[0],this._optionsService.rawOptions.windowOptions))return!0;const t=e.length>1?e.params[1]:0;switch(e.params[0]){case 14:2!==t&&this._onRequestWindowsOptionsReport.fire(y.GET_WIN_SIZE_PIXELS);break;case 16:this._onRequestWindowsOptionsReport.fire(y.GET_CELL_SIZE_PIXELS);break;case 18:this._bufferService&&this._coreService.triggerDataEvent(`${n.C0.ESC}[8;${this._bufferService.rows};${this._bufferService.cols}t`);break;case 22:0!==t&&2!==t||(this._windowTitleStack.push(this._windowTitle),this._windowTitleStack.length>10&&this._windowTitleStack.shift()),0!==t&&1!==t||(this._iconNameStack.push(this._iconName),this._iconNameStack.length>10&&this._iconNameStack.shift());break;case 23:0!==t&&2!==t||this._windowTitleStack.length&&this.setTitle(this._windowTitleStack.pop()),0!==t&&1!==t||this._iconNameStack.length&&this.setIconName(this._iconNameStack.pop())}return!0}saveCursor(e){return this._activeBuffer.savedX=this._activeBuffer.x,this._activeBuffer.savedY=this._activeBuffer.ybase+this._activeBuffer.y,this._activeBuffer.savedCurAttrData.fg=this._curAttrData.fg,this._activeBuffer.savedCurAttrData.bg=this._curAttrData.bg,this._activeBuffer.savedCharset=this._charsetService.charset,!0}restoreCursor(e){return this._activeBuffer.x=this._activeBuffer.savedX||0,this._activeBuffer.y=Math.max(this._activeBuffer.savedY-this._activeBuffer.ybase,0),this._curAttrData.fg=this._activeBuffer.savedCurAttrData.fg,this._curAttrData.bg=this._activeBuffer.savedCurAttrData.bg,this._charsetService.charset=this._savedCharset,this._activeBuffer.savedCharset&&(this._charsetService.charset=this._activeBuffer.savedCharset),this._restrictCursor(),!0}setTitle(e){return this._windowTitle=e,this._onTitleChange.fire(e),!0}setIconName(e){return this._iconName=e,!0}setOrReportIndexedColor(e){const t=[],i=e.split(";");for(;i.length>1;){const e=i.shift(),s=i.shift();if(/^\d+$/.exec(e)){const i=parseInt(e);if(D(i))if("?"===s)t.push({type:0,index:i});else{const e=(0,S.parseColor)(s);e&&t.push({type:1,index:i,color:e})}}}return t.length&&this._onColor.fire(t),!0}setHyperlink(e){const t=e.split(";");return!(t.length<2)&&(t[1]?this._createHyperlink(t[0],t[1]):!t[0]&&this._finishHyperlink())}_createHyperlink(e,t){this._getCurrentLinkId()&&this._finishHyperlink();const i=e.split(":");let s;const r=i.findIndex((e=>e.startsWith("id=")));return-1!==r&&(s=i[r].slice(3)||void 0),this._curAttrData.extended=this._curAttrData.extended.clone(),this._curAttrData.extended.urlId=this._oscLinkService.registerLink({id:s,uri:t}),this._curAttrData.updateExtended(),!0}_finishHyperlink(){return this._curAttrData.extended=this._curAttrData.extended.clone(),this._curAttrData.extended.urlId=0,this._curAttrData.updateExtended(),!0}_setOrReportSpecialColor(e,t){const i=e.split(";");for(let e=0;e=this._specialColors.length);++e,++t)if("?"===i[e])this._onColor.fire([{type:0,index:this._specialColors[t]}]);else{const s=(0,S.parseColor)(i[e]);s&&this._onColor.fire([{type:1,index:this._specialColors[t],color:s}])}return!0}setOrReportFgColor(e){return this._setOrReportSpecialColor(e,0)}setOrReportBgColor(e){return this._setOrReportSpecialColor(e,1)}setOrReportCursorColor(e){return this._setOrReportSpecialColor(e,2)}restoreIndexedColor(e){if(!e)return this._onColor.fire([{type:2}]),!0;const t=[],i=e.split(";");for(let e=0;e=this._bufferService.rows&&(this._activeBuffer.y=this._bufferService.rows-1),this._restrictCursor(),!0}tabSet(){return this._activeBuffer.tabs[this._activeBuffer.x]=!0,!0}reverseIndex(){if(this._restrictCursor(),this._activeBuffer.y===this._activeBuffer.scrollTop){const e=this._activeBuffer.scrollBottom-this._activeBuffer.scrollTop;this._activeBuffer.lines.shiftElements(this._activeBuffer.ybase+this._activeBuffer.y,e,1),this._activeBuffer.lines.set(this._activeBuffer.ybase+this._activeBuffer.y,this._activeBuffer.getBlankLine(this._eraseAttrData())),this._dirtyRowTracker.markRangeDirty(this._activeBuffer.scrollTop,this._activeBuffer.scrollBottom)}else this._activeBuffer.y--,this._restrictCursor();return!0}fullReset(){return this._parser.reset(),this._onRequestReset.fire(),!0}reset(){this._curAttrData=l.DEFAULT_ATTR_DATA.clone(),this._eraseAttrDataInternal=l.DEFAULT_ATTR_DATA.clone()}_eraseAttrData(){return this._eraseAttrDataInternal.bg&=-67108864,this._eraseAttrDataInternal.bg|=67108863&this._curAttrData.bg,this._eraseAttrDataInternal}setgLevel(e){return this._charsetService.setgLevel(e),!0}screenAlignmentPattern(){const e=new u.CellData;e.content=1<<22|"E".charCodeAt(0),e.fg=this._curAttrData.fg,e.bg=this._curAttrData.bg,this._setCursor(0,0);for(let t=0;t(this._coreService.triggerDataEvent(`${n.C0.ESC}${e}${n.C0.ESC}\\`),!0))('"q'===e?`P1$r${this._curAttrData.isProtected()?1:0}"q`:'"p'===e?'P1$r61;1"p':"r"===e?`P1$r${i.scrollTop+1};${i.scrollBottom+1}r`:"m"===e?"P1$r0m":" q"===e?`P1$r${{block:2,underline:4,bar:6}[s.cursorStyle]-(s.cursorBlink?1:0)} q`:"P0$r")}markRangeDirty(e,t){this._dirtyRowTracker.markRangeDirty(e,t)}}t.InputHandler=k;let L=class{constructor(e){this._bufferService=e,this.clearRange()}clearRange(){this.start=this._bufferService.buffer.y,this.end=this._bufferService.buffer.y}markDirty(e){ethis.end&&(this.end=e)}markRangeDirty(e,t){e>t&&(E=e,e=t,t=E),ethis.end&&(this.end=t)}markAllDirty(){this.markRangeDirty(0,this._bufferService.rows-1)}};function D(e){return 0<=e&&e<256}L=s([r(0,v.IBufferService)],L)},844:(e,t)=>{function i(e){for(const t of e)t.dispose();e.length=0}Object.defineProperty(t,"__esModule",{value:!0}),t.getDisposeArrayDisposable=t.disposeArray=t.toDisposable=t.MutableDisposable=t.Disposable=void 0,t.Disposable=class{constructor(){this._disposables=[],this._isDisposed=!1}dispose(){this._isDisposed=!0;for(const e of this._disposables)e.dispose();this._disposables.length=0}register(e){return this._disposables.push(e),e}unregister(e){const t=this._disposables.indexOf(e);-1!==t&&this._disposables.splice(t,1)}},t.MutableDisposable=class{constructor(){this._isDisposed=!1}get value(){return this._isDisposed?void 0:this._value}set value(e){this._isDisposed||e===this._value||(this._value?.dispose(),this._value=e)}clear(){this.value=void 0}dispose(){this._isDisposed=!0,this._value?.dispose(),this._value=void 0}},t.toDisposable=function(e){return{dispose:e}},t.disposeArray=i,t.getDisposeArrayDisposable=function(e){return{dispose:()=>i(e)}}},1505:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.FourKeyMap=t.TwoKeyMap=void 0;class i{constructor(){this._data={}}set(e,t,i){this._data[e]||(this._data[e]={}),this._data[e][t]=i}get(e,t){return this._data[e]?this._data[e][t]:void 0}clear(){this._data={}}}t.TwoKeyMap=i,t.FourKeyMap=class{constructor(){this._data=new i}set(e,t,s,r,n){this._data.get(e,t)||this._data.set(e,t,new i),this._data.get(e,t).set(s,r,n)}get(e,t,i,s){return this._data.get(e,t)?.get(i,s)}clear(){this._data.clear()}}},6114:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.isChromeOS=t.isLinux=t.isWindows=t.isIphone=t.isIpad=t.isMac=t.getSafariVersion=t.isSafari=t.isLegacyEdge=t.isFirefox=t.isNode=void 0,t.isNode="undefined"!=typeof process&&"title"in process;const i=t.isNode?"node":navigator.userAgent,s=t.isNode?"node":navigator.platform;t.isFirefox=i.includes("Firefox"),t.isLegacyEdge=i.includes("Edge"),t.isSafari=/^((?!chrome|android).)*safari/i.test(i),t.getSafariVersion=function(){if(!t.isSafari)return 0;const e=i.match(/Version\/(\d+)/);return null===e||e.length<2?0:parseInt(e[1])},t.isMac=["Macintosh","MacIntel","MacPPC","Mac68K"].includes(s),t.isIpad="iPad"===s,t.isIphone="iPhone"===s,t.isWindows=["Windows","Win16","Win32","WinCE"].includes(s),t.isLinux=s.indexOf("Linux")>=0,t.isChromeOS=/\bCrOS\b/.test(i)},6106:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.SortedList=void 0;let i=0;t.SortedList=class{constructor(e){this._getKey=e,this._array=[]}clear(){this._array.length=0}insert(e){0!==this._array.length?(i=this._search(this._getKey(e)),this._array.splice(i,0,e)):this._array.push(e)}delete(e){if(0===this._array.length)return!1;const t=this._getKey(e);if(void 0===t)return!1;if(i=this._search(t),-1===i)return!1;if(this._getKey(this._array[i])!==t)return!1;do{if(this._array[i]===e)return this._array.splice(i,1),!0}while(++i=this._array.length)&&this._getKey(this._array[i])===e))do{yield this._array[i]}while(++i=this._array.length)&&this._getKey(this._array[i])===e))do{t(this._array[i])}while(++i=t;){let s=t+i>>1;const r=this._getKey(this._array[s]);if(r>e)i=s-1;else{if(!(r0&&this._getKey(this._array[s-1])===e;)s--;return s}t=s+1}}return t}}},7226:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.DebouncedIdleTask=t.IdleTaskQueue=t.PriorityTaskQueue=void 0;const s=i(6114);class r{constructor(){this._tasks=[],this._i=0}enqueue(e){this._tasks.push(e),this._start()}flush(){for(;this._ir)return s-t<-20&&console.warn(`task queue exceeded allotted deadline by ${Math.abs(Math.round(s-t))}ms`),void this._start();s=r}this.clear()}}class n extends r{_requestCallback(e){return setTimeout((()=>e(this._createDeadline(16))))}_cancelCallback(e){clearTimeout(e)}_createDeadline(e){const t=Date.now()+e;return{timeRemaining:()=>Math.max(0,t-Date.now())}}}t.PriorityTaskQueue=n,t.IdleTaskQueue=!s.isNode&&"requestIdleCallback"in window?class extends r{_requestCallback(e){return requestIdleCallback(e)}_cancelCallback(e){cancelIdleCallback(e)}}:n,t.DebouncedIdleTask=class{constructor(){this._queue=new t.IdleTaskQueue}set(e){this._queue.clear(),this._queue.enqueue(e)}flush(){this._queue.flush()}}},9282:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.updateWindowsModeWrappedState=void 0;const s=i(643);t.updateWindowsModeWrappedState=function(e){const t=e.buffer.lines.get(e.buffer.ybase+e.buffer.y-1),i=t?.get(e.cols-1),r=e.buffer.lines.get(e.buffer.ybase+e.buffer.y);r&&i&&(r.isWrapped=i[s.CHAR_DATA_CODE_INDEX]!==s.NULL_CELL_CODE&&i[s.CHAR_DATA_CODE_INDEX]!==s.WHITESPACE_CELL_CODE)}},3734:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.ExtendedAttrs=t.AttributeData=void 0;class i{constructor(){this.fg=0,this.bg=0,this.extended=new s}static toColorRGB(e){return[e>>>16&255,e>>>8&255,255&e]}static fromColorRGB(e){return(255&e[0])<<16|(255&e[1])<<8|255&e[2]}clone(){const e=new i;return e.fg=this.fg,e.bg=this.bg,e.extended=this.extended.clone(),e}isInverse(){return 67108864&this.fg}isBold(){return 134217728&this.fg}isUnderline(){return this.hasExtendedAttrs()&&0!==this.extended.underlineStyle?1:268435456&this.fg}isBlink(){return 536870912&this.fg}isInvisible(){return 1073741824&this.fg}isItalic(){return 67108864&this.bg}isDim(){return 134217728&this.bg}isStrikethrough(){return 2147483648&this.fg}isProtected(){return 536870912&this.bg}isOverline(){return 1073741824&this.bg}getFgColorMode(){return 50331648&this.fg}getBgColorMode(){return 50331648&this.bg}isFgRGB(){return 50331648==(50331648&this.fg)}isBgRGB(){return 50331648==(50331648&this.bg)}isFgPalette(){return 16777216==(50331648&this.fg)||33554432==(50331648&this.fg)}isBgPalette(){return 16777216==(50331648&this.bg)||33554432==(50331648&this.bg)}isFgDefault(){return 0==(50331648&this.fg)}isBgDefault(){return 0==(50331648&this.bg)}isAttributeDefault(){return 0===this.fg&&0===this.bg}getFgColor(){switch(50331648&this.fg){case 16777216:case 33554432:return 255&this.fg;case 50331648:return 16777215&this.fg;default:return-1}}getBgColor(){switch(50331648&this.bg){case 16777216:case 33554432:return 255&this.bg;case 50331648:return 16777215&this.bg;default:return-1}}hasExtendedAttrs(){return 268435456&this.bg}updateExtended(){this.extended.isEmpty()?this.bg&=-268435457:this.bg|=268435456}getUnderlineColor(){if(268435456&this.bg&&~this.extended.underlineColor)switch(50331648&this.extended.underlineColor){case 16777216:case 33554432:return 255&this.extended.underlineColor;case 50331648:return 16777215&this.extended.underlineColor;default:return this.getFgColor()}return this.getFgColor()}getUnderlineColorMode(){return 268435456&this.bg&&~this.extended.underlineColor?50331648&this.extended.underlineColor:this.getFgColorMode()}isUnderlineColorRGB(){return 268435456&this.bg&&~this.extended.underlineColor?50331648==(50331648&this.extended.underlineColor):this.isFgRGB()}isUnderlineColorPalette(){return 268435456&this.bg&&~this.extended.underlineColor?16777216==(50331648&this.extended.underlineColor)||33554432==(50331648&this.extended.underlineColor):this.isFgPalette()}isUnderlineColorDefault(){return 268435456&this.bg&&~this.extended.underlineColor?0==(50331648&this.extended.underlineColor):this.isFgDefault()}getUnderlineStyle(){return 268435456&this.fg?268435456&this.bg?this.extended.underlineStyle:1:0}getUnderlineVariantOffset(){return this.extended.underlineVariantOffset}}t.AttributeData=i;class s{get ext(){return this._urlId?-469762049&this._ext|this.underlineStyle<<26:this._ext}set ext(e){this._ext=e}get underlineStyle(){return this._urlId?5:(469762048&this._ext)>>26}set underlineStyle(e){this._ext&=-469762049,this._ext|=e<<26&469762048}get underlineColor(){return 67108863&this._ext}set underlineColor(e){this._ext&=-67108864,this._ext|=67108863&e}get urlId(){return this._urlId}set urlId(e){this._urlId=e}get underlineVariantOffset(){const e=(3758096384&this._ext)>>29;return e<0?4294967288^e:e}set underlineVariantOffset(e){this._ext&=536870911,this._ext|=e<<29&3758096384}constructor(e=0,t=0){this._ext=0,this._urlId=0,this._ext=e,this._urlId=t}clone(){return new s(this._ext,this._urlId)}isEmpty(){return 0===this.underlineStyle&&0===this._urlId}}t.ExtendedAttrs=s},9092:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Buffer=t.MAX_BUFFER_SIZE=void 0;const s=i(6349),r=i(7226),n=i(3734),o=i(8437),a=i(4634),h=i(511),c=i(643),l=i(4863),d=i(7116);t.MAX_BUFFER_SIZE=4294967295,t.Buffer=class{constructor(e,t,i){this._hasScrollback=e,this._optionsService=t,this._bufferService=i,this.ydisp=0,this.ybase=0,this.y=0,this.x=0,this.tabs={},this.savedY=0,this.savedX=0,this.savedCurAttrData=o.DEFAULT_ATTR_DATA.clone(),this.savedCharset=d.DEFAULT_CHARSET,this.markers=[],this._nullCell=h.CellData.fromCharData([0,c.NULL_CELL_CHAR,c.NULL_CELL_WIDTH,c.NULL_CELL_CODE]),this._whitespaceCell=h.CellData.fromCharData([0,c.WHITESPACE_CELL_CHAR,c.WHITESPACE_CELL_WIDTH,c.WHITESPACE_CELL_CODE]),this._isClearing=!1,this._memoryCleanupQueue=new r.IdleTaskQueue,this._memoryCleanupPosition=0,this._cols=this._bufferService.cols,this._rows=this._bufferService.rows,this.lines=new s.CircularList(this._getCorrectBufferLength(this._rows)),this.scrollTop=0,this.scrollBottom=this._rows-1,this.setupTabStops()}getNullCell(e){return e?(this._nullCell.fg=e.fg,this._nullCell.bg=e.bg,this._nullCell.extended=e.extended):(this._nullCell.fg=0,this._nullCell.bg=0,this._nullCell.extended=new n.ExtendedAttrs),this._nullCell}getWhitespaceCell(e){return e?(this._whitespaceCell.fg=e.fg,this._whitespaceCell.bg=e.bg,this._whitespaceCell.extended=e.extended):(this._whitespaceCell.fg=0,this._whitespaceCell.bg=0,this._whitespaceCell.extended=new n.ExtendedAttrs),this._whitespaceCell}getBlankLine(e,t){return new o.BufferLine(this._bufferService.cols,this.getNullCell(e),t)}get hasScrollback(){return this._hasScrollback&&this.lines.maxLength>this._rows}get isCursorInViewport(){const e=this.ybase+this.y-this.ydisp;return e>=0&&et.MAX_BUFFER_SIZE?t.MAX_BUFFER_SIZE:i}fillViewportRows(e){if(0===this.lines.length){void 0===e&&(e=o.DEFAULT_ATTR_DATA);let t=this._rows;for(;t--;)this.lines.push(this.getBlankLine(e))}}clear(){this.ydisp=0,this.ybase=0,this.y=0,this.x=0,this.lines=new s.CircularList(this._getCorrectBufferLength(this._rows)),this.scrollTop=0,this.scrollBottom=this._rows-1,this.setupTabStops()}resize(e,t){const i=this.getNullCell(o.DEFAULT_ATTR_DATA);let s=0;const r=this._getCorrectBufferLength(t);if(r>this.lines.maxLength&&(this.lines.maxLength=r),this.lines.length>0){if(this._cols0&&this.lines.length<=this.ybase+this.y+n+1?(this.ybase--,n++,this.ydisp>0&&this.ydisp--):this.lines.push(new o.BufferLine(e,i)));else for(let e=this._rows;e>t;e--)this.lines.length>t+this.ybase&&(this.lines.length>this.ybase+this.y+1?this.lines.pop():(this.ybase++,this.ydisp++));if(r0&&(this.lines.trimStart(e),this.ybase=Math.max(this.ybase-e,0),this.ydisp=Math.max(this.ydisp-e,0),this.savedY=Math.max(this.savedY-e,0)),this.lines.maxLength=r}this.x=Math.min(this.x,e-1),this.y=Math.min(this.y,t-1),n&&(this.y+=n),this.savedX=Math.min(this.savedX,e-1),this.scrollTop=0}if(this.scrollBottom=t-1,this._isReflowEnabled&&(this._reflow(e,t),this._cols>e))for(let t=0;t.1*this.lines.length&&(this._memoryCleanupPosition=0,this._memoryCleanupQueue.enqueue((()=>this._batchedMemoryCleanup())))}_batchedMemoryCleanup(){let e=!0;this._memoryCleanupPosition>=this.lines.length&&(this._memoryCleanupPosition=0,e=!1);let t=0;for(;this._memoryCleanupPosition100)return!0;return e}get _isReflowEnabled(){const e=this._optionsService.rawOptions.windowsPty;return e&&e.buildNumber?this._hasScrollback&&"conpty"===e.backend&&e.buildNumber>=21376:this._hasScrollback&&!this._optionsService.rawOptions.windowsMode}_reflow(e,t){this._cols!==e&&(e>this._cols?this._reflowLarger(e,t):this._reflowSmaller(e,t))}_reflowLarger(e,t){const i=(0,a.reflowLargerGetLinesToRemove)(this.lines,this._cols,e,this.ybase+this.y,this.getNullCell(o.DEFAULT_ATTR_DATA));if(i.length>0){const s=(0,a.reflowLargerCreateNewLayout)(this.lines,i);(0,a.reflowLargerApplyNewLayout)(this.lines,s.layout),this._reflowLargerAdjustViewport(e,t,s.countRemoved)}}_reflowLargerAdjustViewport(e,t,i){const s=this.getNullCell(o.DEFAULT_ATTR_DATA);let r=i;for(;r-- >0;)0===this.ybase?(this.y>0&&this.y--,this.lines.length=0;n--){let h=this.lines.get(n);if(!h||!h.isWrapped&&h.getTrimmedLength()<=e)continue;const c=[h];for(;h.isWrapped&&n>0;)h=this.lines.get(--n),c.unshift(h);const l=this.ybase+this.y;if(l>=n&&l0&&(s.push({start:n+c.length+r,newLines:v}),r+=v.length),c.push(...v);let p=_.length-1,g=_[p];0===g&&(p--,g=_[p]);let m=c.length-u-1,S=d;for(;m>=0;){const e=Math.min(S,g);if(void 0===c[p])break;if(c[p].copyCellsFrom(c[m],S-e,g-e,e,!0),g-=e,0===g&&(p--,g=_[p]),S-=e,0===S){m--;const e=Math.max(m,0);S=(0,a.getWrappedLineTrimmedLength)(c,e,this._cols)}}for(let t=0;t0;)0===this.ybase?this.y0){const e=[],t=[];for(let e=0;e=0;c--)if(a&&a.start>n+h){for(let e=a.newLines.length-1;e>=0;e--)this.lines.set(c--,a.newLines[e]);c++,e.push({index:n+1,amount:a.newLines.length}),h+=a.newLines.length,a=s[++o]}else this.lines.set(c,t[n--]);let c=0;for(let t=e.length-1;t>=0;t--)e[t].index+=c,this.lines.onInsertEmitter.fire(e[t]),c+=e[t].amount;const l=Math.max(0,i+r-this.lines.maxLength);l>0&&this.lines.onTrimEmitter.fire(l)}}translateBufferLineToString(e,t,i=0,s){const r=this.lines.get(e);return r?r.translateToString(t,i,s):""}getWrappedRangeForLine(e){let t=e,i=e;for(;t>0&&this.lines.get(t).isWrapped;)t--;for(;i+10;);return e>=this._cols?this._cols-1:e<0?0:e}nextStop(e){for(null==e&&(e=this.x);!this.tabs[++e]&&e=this._cols?this._cols-1:e<0?0:e}clearMarkers(e){this._isClearing=!0;for(let t=0;t{t.line-=e,t.line<0&&t.dispose()}))),t.register(this.lines.onInsert((e=>{t.line>=e.index&&(t.line+=e.amount)}))),t.register(this.lines.onDelete((e=>{t.line>=e.index&&t.linee.index&&(t.line-=e.amount)}))),t.register(t.onDispose((()=>this._removeMarker(t)))),t}_removeMarker(e){this._isClearing||this.markers.splice(this.markers.indexOf(e),1)}}},8437:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.BufferLine=t.DEFAULT_ATTR_DATA=void 0;const s=i(3734),r=i(511),n=i(643),o=i(482);t.DEFAULT_ATTR_DATA=Object.freeze(new s.AttributeData);let a=0;class h{constructor(e,t,i=!1){this.isWrapped=i,this._combined={},this._extendedAttrs={},this._data=new Uint32Array(3*e);const s=t||r.CellData.fromCharData([0,n.NULL_CELL_CHAR,n.NULL_CELL_WIDTH,n.NULL_CELL_CODE]);for(let t=0;t>22,2097152&t?this._combined[e].charCodeAt(this._combined[e].length-1):i]}set(e,t){this._data[3*e+1]=t[n.CHAR_DATA_ATTR_INDEX],t[n.CHAR_DATA_CHAR_INDEX].length>1?(this._combined[e]=t[1],this._data[3*e+0]=2097152|e|t[n.CHAR_DATA_WIDTH_INDEX]<<22):this._data[3*e+0]=t[n.CHAR_DATA_CHAR_INDEX].charCodeAt(0)|t[n.CHAR_DATA_WIDTH_INDEX]<<22}getWidth(e){return this._data[3*e+0]>>22}hasWidth(e){return 12582912&this._data[3*e+0]}getFg(e){return this._data[3*e+1]}getBg(e){return this._data[3*e+2]}hasContent(e){return 4194303&this._data[3*e+0]}getCodePoint(e){const t=this._data[3*e+0];return 2097152&t?this._combined[e].charCodeAt(this._combined[e].length-1):2097151&t}isCombined(e){return 2097152&this._data[3*e+0]}getString(e){const t=this._data[3*e+0];return 2097152&t?this._combined[e]:2097151&t?(0,o.stringFromCodePoint)(2097151&t):""}isProtected(e){return 536870912&this._data[3*e+2]}loadCell(e,t){return a=3*e,t.content=this._data[a+0],t.fg=this._data[a+1],t.bg=this._data[a+2],2097152&t.content&&(t.combinedData=this._combined[e]),268435456&t.bg&&(t.extended=this._extendedAttrs[e]),t}setCell(e,t){2097152&t.content&&(this._combined[e]=t.combinedData),268435456&t.bg&&(this._extendedAttrs[e]=t.extended),this._data[3*e+0]=t.content,this._data[3*e+1]=t.fg,this._data[3*e+2]=t.bg}setCellFromCodepoint(e,t,i,s){268435456&s.bg&&(this._extendedAttrs[e]=s.extended),this._data[3*e+0]=t|i<<22,this._data[3*e+1]=s.fg,this._data[3*e+2]=s.bg}addCodepointToCell(e,t,i){let s=this._data[3*e+0];2097152&s?this._combined[e]+=(0,o.stringFromCodePoint)(t):2097151&s?(this._combined[e]=(0,o.stringFromCodePoint)(2097151&s)+(0,o.stringFromCodePoint)(t),s&=-2097152,s|=2097152):s=t|1<<22,i&&(s&=-12582913,s|=i<<22),this._data[3*e+0]=s}insertCells(e,t,i){if((e%=this.length)&&2===this.getWidth(e-1)&&this.setCellFromCodepoint(e-1,0,1,i),t=0;--i)this.setCell(e+t+i,this.loadCell(e+i,s));for(let s=0;sthis.length){if(this._data.buffer.byteLength>=4*i)this._data=new Uint32Array(this._data.buffer,0,i);else{const e=new Uint32Array(i);e.set(this._data),this._data=e}for(let i=this.length;i=e&&delete this._combined[s]}const s=Object.keys(this._extendedAttrs);for(let t=0;t=e&&delete this._extendedAttrs[i]}}return this.length=e,4*i*2=0;--e)if(4194303&this._data[3*e+0])return e+(this._data[3*e+0]>>22);return 0}getNoBgTrimmedLength(){for(let e=this.length-1;e>=0;--e)if(4194303&this._data[3*e+0]||50331648&this._data[3*e+2])return e+(this._data[3*e+0]>>22);return 0}copyCellsFrom(e,t,i,s,r){const n=e._data;if(r)for(let r=s-1;r>=0;r--){for(let e=0;e<3;e++)this._data[3*(i+r)+e]=n[3*(t+r)+e];268435456&n[3*(t+r)+2]&&(this._extendedAttrs[i+r]=e._extendedAttrs[t+r])}else for(let r=0;r=t&&(this._combined[r-t+i]=e._combined[r])}}translateToString(e,t,i,s){t=t??0,i=i??this.length,e&&(i=Math.min(i,this.getTrimmedLength())),s&&(s.length=0);let r="";for(;t>22||1}return s&&s.push(t),r}}t.BufferLine=h},4841:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.getRangeLength=void 0,t.getRangeLength=function(e,t){if(e.start.y>e.end.y)throw new Error(`Buffer range end (${e.end.x}, ${e.end.y}) cannot be before start (${e.start.x}, ${e.start.y})`);return t*(e.end.y-e.start.y)+(e.end.x-e.start.x+1)}},4634:(e,t)=>{function i(e,t,i){if(t===e.length-1)return e[t].getTrimmedLength();const s=!e[t].hasContent(i-1)&&1===e[t].getWidth(i-1),r=2===e[t+1].getWidth(0);return s&&r?i-1:i}Object.defineProperty(t,"__esModule",{value:!0}),t.getWrappedLineTrimmedLength=t.reflowSmallerGetNewLineLengths=t.reflowLargerApplyNewLayout=t.reflowLargerCreateNewLayout=t.reflowLargerGetLinesToRemove=void 0,t.reflowLargerGetLinesToRemove=function(e,t,s,r,n){const o=[];for(let a=0;a=a&&r0&&(e>d||0===l[e].getTrimmedLength());e--)v++;v>0&&(o.push(a+l.length-v),o.push(v)),a+=l.length-1}return o},t.reflowLargerCreateNewLayout=function(e,t){const i=[];let s=0,r=t[s],n=0;for(let o=0;oi(e,r,t))).reduce(((e,t)=>e+t));let o=0,a=0,h=0;for(;hc&&(o-=c,a++);const l=2===e[a].getWidth(o-1);l&&o--;const d=l?s-1:s;r.push(d),h+=d}return r},t.getWrappedLineTrimmedLength=i},5295:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.BufferSet=void 0;const s=i(8460),r=i(844),n=i(9092);class o extends r.Disposable{constructor(e,t){super(),this._optionsService=e,this._bufferService=t,this._onBufferActivate=this.register(new s.EventEmitter),this.onBufferActivate=this._onBufferActivate.event,this.reset(),this.register(this._optionsService.onSpecificOptionChange("scrollback",(()=>this.resize(this._bufferService.cols,this._bufferService.rows)))),this.register(this._optionsService.onSpecificOptionChange("tabStopWidth",(()=>this.setupTabStops())))}reset(){this._normal=new n.Buffer(!0,this._optionsService,this._bufferService),this._normal.fillViewportRows(),this._alt=new n.Buffer(!1,this._optionsService,this._bufferService),this._activeBuffer=this._normal,this._onBufferActivate.fire({activeBuffer:this._normal,inactiveBuffer:this._alt}),this.setupTabStops()}get alt(){return this._alt}get active(){return this._activeBuffer}get normal(){return this._normal}activateNormalBuffer(){this._activeBuffer!==this._normal&&(this._normal.x=this._alt.x,this._normal.y=this._alt.y,this._alt.clearAllMarkers(),this._alt.clear(),this._activeBuffer=this._normal,this._onBufferActivate.fire({activeBuffer:this._normal,inactiveBuffer:this._alt}))}activateAltBuffer(e){this._activeBuffer!==this._alt&&(this._alt.fillViewportRows(e),this._alt.x=this._normal.x,this._alt.y=this._normal.y,this._activeBuffer=this._alt,this._onBufferActivate.fire({activeBuffer:this._alt,inactiveBuffer:this._normal}))}resize(e,t){this._normal.resize(e,t),this._alt.resize(e,t),this.setupTabStops(e)}setupTabStops(e){this._normal.setupTabStops(e),this._alt.setupTabStops(e)}}t.BufferSet=o},511:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.CellData=void 0;const s=i(482),r=i(643),n=i(3734);class o extends n.AttributeData{constructor(){super(...arguments),this.content=0,this.fg=0,this.bg=0,this.extended=new n.ExtendedAttrs,this.combinedData=""}static fromCharData(e){const t=new o;return t.setFromCharData(e),t}isCombined(){return 2097152&this.content}getWidth(){return this.content>>22}getChars(){return 2097152&this.content?this.combinedData:2097151&this.content?(0,s.stringFromCodePoint)(2097151&this.content):""}getCode(){return this.isCombined()?this.combinedData.charCodeAt(this.combinedData.length-1):2097151&this.content}setFromCharData(e){this.fg=e[r.CHAR_DATA_ATTR_INDEX],this.bg=0;let t=!1;if(e[r.CHAR_DATA_CHAR_INDEX].length>2)t=!0;else if(2===e[r.CHAR_DATA_CHAR_INDEX].length){const i=e[r.CHAR_DATA_CHAR_INDEX].charCodeAt(0);if(55296<=i&&i<=56319){const s=e[r.CHAR_DATA_CHAR_INDEX].charCodeAt(1);56320<=s&&s<=57343?this.content=1024*(i-55296)+s-56320+65536|e[r.CHAR_DATA_WIDTH_INDEX]<<22:t=!0}else t=!0}else this.content=e[r.CHAR_DATA_CHAR_INDEX].charCodeAt(0)|e[r.CHAR_DATA_WIDTH_INDEX]<<22;t&&(this.combinedData=e[r.CHAR_DATA_CHAR_INDEX],this.content=2097152|e[r.CHAR_DATA_WIDTH_INDEX]<<22)}getAsCharData(){return[this.fg,this.getChars(),this.getWidth(),this.getCode()]}}t.CellData=o},643:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.WHITESPACE_CELL_CODE=t.WHITESPACE_CELL_WIDTH=t.WHITESPACE_CELL_CHAR=t.NULL_CELL_CODE=t.NULL_CELL_WIDTH=t.NULL_CELL_CHAR=t.CHAR_DATA_CODE_INDEX=t.CHAR_DATA_WIDTH_INDEX=t.CHAR_DATA_CHAR_INDEX=t.CHAR_DATA_ATTR_INDEX=t.DEFAULT_EXT=t.DEFAULT_ATTR=t.DEFAULT_COLOR=void 0,t.DEFAULT_COLOR=0,t.DEFAULT_ATTR=256|t.DEFAULT_COLOR<<9,t.DEFAULT_EXT=0,t.CHAR_DATA_ATTR_INDEX=0,t.CHAR_DATA_CHAR_INDEX=1,t.CHAR_DATA_WIDTH_INDEX=2,t.CHAR_DATA_CODE_INDEX=3,t.NULL_CELL_CHAR="",t.NULL_CELL_WIDTH=1,t.NULL_CELL_CODE=0,t.WHITESPACE_CELL_CHAR=" ",t.WHITESPACE_CELL_WIDTH=1,t.WHITESPACE_CELL_CODE=32},4863:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Marker=void 0;const s=i(8460),r=i(844);class n{get id(){return this._id}constructor(e){this.line=e,this.isDisposed=!1,this._disposables=[],this._id=n._nextId++,this._onDispose=this.register(new s.EventEmitter),this.onDispose=this._onDispose.event}dispose(){this.isDisposed||(this.isDisposed=!0,this.line=-1,this._onDispose.fire(),(0,r.disposeArray)(this._disposables),this._disposables.length=0)}register(e){return this._disposables.push(e),e}}t.Marker=n,n._nextId=1},7116:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.DEFAULT_CHARSET=t.CHARSETS=void 0,t.CHARSETS={},t.DEFAULT_CHARSET=t.CHARSETS.B,t.CHARSETS[0]={"`":"◆",a:"▒",b:"␉",c:"␌",d:"␍",e:"␊",f:"°",g:"±",h:"␤",i:"␋",j:"┘",k:"┐",l:"┌",m:"└",n:"┼",o:"⎺",p:"⎻",q:"─",r:"⎼",s:"⎽",t:"├",u:"┤",v:"┴",w:"┬",x:"│",y:"≤",z:"≥","{":"π","|":"≠","}":"£","~":"·"},t.CHARSETS.A={"#":"£"},t.CHARSETS.B=void 0,t.CHARSETS[4]={"#":"£","@":"¾","[":"ij","\\":"½","]":"|","{":"¨","|":"f","}":"¼","~":"´"},t.CHARSETS.C=t.CHARSETS[5]={"[":"Ä","\\":"Ö","]":"Å","^":"Ü","`":"é","{":"ä","|":"ö","}":"å","~":"ü"},t.CHARSETS.R={"#":"£","@":"à","[":"°","\\":"ç","]":"§","{":"é","|":"ù","}":"è","~":"¨"},t.CHARSETS.Q={"@":"à","[":"â","\\":"ç","]":"ê","^":"î","`":"ô","{":"é","|":"ù","}":"è","~":"û"},t.CHARSETS.K={"@":"§","[":"Ä","\\":"Ö","]":"Ü","{":"ä","|":"ö","}":"ü","~":"ß"},t.CHARSETS.Y={"#":"£","@":"§","[":"°","\\":"ç","]":"é","`":"ù","{":"à","|":"ò","}":"è","~":"ì"},t.CHARSETS.E=t.CHARSETS[6]={"@":"Ä","[":"Æ","\\":"Ø","]":"Å","^":"Ü","`":"ä","{":"æ","|":"ø","}":"å","~":"ü"},t.CHARSETS.Z={"#":"£","@":"§","[":"¡","\\":"Ñ","]":"¿","{":"°","|":"ñ","}":"ç"},t.CHARSETS.H=t.CHARSETS[7]={"@":"É","[":"Ä","\\":"Ö","]":"Å","^":"Ü","`":"é","{":"ä","|":"ö","}":"å","~":"ü"},t.CHARSETS["="]={"#":"ù","@":"à","[":"é","\\":"ç","]":"ê","^":"î",_:"è","`":"ô","{":"ä","|":"ö","}":"ü","~":"û"}},2584:(e,t)=>{var i,s,r;Object.defineProperty(t,"__esModule",{value:!0}),t.C1_ESCAPED=t.C1=t.C0=void 0,function(e){e.NUL="\0",e.SOH="",e.STX="",e.ETX="",e.EOT="",e.ENQ="",e.ACK="",e.BEL="",e.BS="\b",e.HT="\t",e.LF="\n",e.VT="\v",e.FF="\f",e.CR="\r",e.SO="",e.SI="",e.DLE="",e.DC1="",e.DC2="",e.DC3="",e.DC4="",e.NAK="",e.SYN="",e.ETB="",e.CAN="",e.EM="",e.SUB="",e.ESC="",e.FS="",e.GS="",e.RS="",e.US="",e.SP=" ",e.DEL=""}(i||(t.C0=i={})),function(e){e.PAD="€",e.HOP="",e.BPH="‚",e.NBH="ƒ",e.IND="„",e.NEL="…",e.SSA="†",e.ESA="‡",e.HTS="ˆ",e.HTJ="‰",e.VTS="Š",e.PLD="‹",e.PLU="Œ",e.RI="",e.SS2="Ž",e.SS3="",e.DCS="",e.PU1="‘",e.PU2="’",e.STS="“",e.CCH="”",e.MW="•",e.SPA="–",e.EPA="—",e.SOS="˜",e.SGCI="™",e.SCI="š",e.CSI="›",e.ST="œ",e.OSC="",e.PM="ž",e.APC="Ÿ"}(s||(t.C1=s={})),function(e){e.ST=`${i.ESC}\\`}(r||(t.C1_ESCAPED=r={}))},7399:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.evaluateKeyboardEvent=void 0;const s=i(2584),r={48:["0",")"],49:["1","!"],50:["2","@"],51:["3","#"],52:["4","$"],53:["5","%"],54:["6","^"],55:["7","&"],56:["8","*"],57:["9","("],186:[";",":"],187:["=","+"],188:[",","<"],189:["-","_"],190:[".",">"],191:["/","?"],192:["`","~"],219:["[","{"],220:["\\","|"],221:["]","}"],222:["'",'"']};t.evaluateKeyboardEvent=function(e,t,i,n){const o={type:0,cancel:!1,key:void 0},a=(e.shiftKey?1:0)|(e.altKey?2:0)|(e.ctrlKey?4:0)|(e.metaKey?8:0);switch(e.keyCode){case 0:"UIKeyInputUpArrow"===e.key?o.key=t?s.C0.ESC+"OA":s.C0.ESC+"[A":"UIKeyInputLeftArrow"===e.key?o.key=t?s.C0.ESC+"OD":s.C0.ESC+"[D":"UIKeyInputRightArrow"===e.key?o.key=t?s.C0.ESC+"OC":s.C0.ESC+"[C":"UIKeyInputDownArrow"===e.key&&(o.key=t?s.C0.ESC+"OB":s.C0.ESC+"[B");break;case 8:o.key=e.ctrlKey?"\b":s.C0.DEL,e.altKey&&(o.key=s.C0.ESC+o.key);break;case 9:if(e.shiftKey){o.key=s.C0.ESC+"[Z";break}o.key=s.C0.HT,o.cancel=!0;break;case 13:o.key=e.altKey?s.C0.ESC+s.C0.CR:s.C0.CR,o.cancel=!0;break;case 27:o.key=s.C0.ESC,e.altKey&&(o.key=s.C0.ESC+s.C0.ESC),o.cancel=!0;break;case 37:if(e.metaKey)break;a?(o.key=s.C0.ESC+"[1;"+(a+1)+"D",o.key===s.C0.ESC+"[1;3D"&&(o.key=s.C0.ESC+(i?"b":"[1;5D"))):o.key=t?s.C0.ESC+"OD":s.C0.ESC+"[D";break;case 39:if(e.metaKey)break;a?(o.key=s.C0.ESC+"[1;"+(a+1)+"C",o.key===s.C0.ESC+"[1;3C"&&(o.key=s.C0.ESC+(i?"f":"[1;5C"))):o.key=t?s.C0.ESC+"OC":s.C0.ESC+"[C";break;case 38:if(e.metaKey)break;a?(o.key=s.C0.ESC+"[1;"+(a+1)+"A",i||o.key!==s.C0.ESC+"[1;3A"||(o.key=s.C0.ESC+"[1;5A")):o.key=t?s.C0.ESC+"OA":s.C0.ESC+"[A";break;case 40:if(e.metaKey)break;a?(o.key=s.C0.ESC+"[1;"+(a+1)+"B",i||o.key!==s.C0.ESC+"[1;3B"||(o.key=s.C0.ESC+"[1;5B")):o.key=t?s.C0.ESC+"OB":s.C0.ESC+"[B";break;case 45:e.shiftKey||e.ctrlKey||(o.key=s.C0.ESC+"[2~");break;case 46:o.key=a?s.C0.ESC+"[3;"+(a+1)+"~":s.C0.ESC+"[3~";break;case 36:o.key=a?s.C0.ESC+"[1;"+(a+1)+"H":t?s.C0.ESC+"OH":s.C0.ESC+"[H";break;case 35:o.key=a?s.C0.ESC+"[1;"+(a+1)+"F":t?s.C0.ESC+"OF":s.C0.ESC+"[F";break;case 33:e.shiftKey?o.type=2:e.ctrlKey?o.key=s.C0.ESC+"[5;"+(a+1)+"~":o.key=s.C0.ESC+"[5~";break;case 34:e.shiftKey?o.type=3:e.ctrlKey?o.key=s.C0.ESC+"[6;"+(a+1)+"~":o.key=s.C0.ESC+"[6~";break;case 112:o.key=a?s.C0.ESC+"[1;"+(a+1)+"P":s.C0.ESC+"OP";break;case 113:o.key=a?s.C0.ESC+"[1;"+(a+1)+"Q":s.C0.ESC+"OQ";break;case 114:o.key=a?s.C0.ESC+"[1;"+(a+1)+"R":s.C0.ESC+"OR";break;case 115:o.key=a?s.C0.ESC+"[1;"+(a+1)+"S":s.C0.ESC+"OS";break;case 116:o.key=a?s.C0.ESC+"[15;"+(a+1)+"~":s.C0.ESC+"[15~";break;case 117:o.key=a?s.C0.ESC+"[17;"+(a+1)+"~":s.C0.ESC+"[17~";break;case 118:o.key=a?s.C0.ESC+"[18;"+(a+1)+"~":s.C0.ESC+"[18~";break;case 119:o.key=a?s.C0.ESC+"[19;"+(a+1)+"~":s.C0.ESC+"[19~";break;case 120:o.key=a?s.C0.ESC+"[20;"+(a+1)+"~":s.C0.ESC+"[20~";break;case 121:o.key=a?s.C0.ESC+"[21;"+(a+1)+"~":s.C0.ESC+"[21~";break;case 122:o.key=a?s.C0.ESC+"[23;"+(a+1)+"~":s.C0.ESC+"[23~";break;case 123:o.key=a?s.C0.ESC+"[24;"+(a+1)+"~":s.C0.ESC+"[24~";break;default:if(!e.ctrlKey||e.shiftKey||e.altKey||e.metaKey)if(i&&!n||!e.altKey||e.metaKey)!i||e.altKey||e.ctrlKey||e.shiftKey||!e.metaKey?e.key&&!e.ctrlKey&&!e.altKey&&!e.metaKey&&e.keyCode>=48&&1===e.key.length?o.key=e.key:e.key&&e.ctrlKey&&("_"===e.key&&(o.key=s.C0.US),"@"===e.key&&(o.key=s.C0.NUL)):65===e.keyCode&&(o.type=1);else{const t=r[e.keyCode],i=t?.[e.shiftKey?1:0];if(i)o.key=s.C0.ESC+i;else if(e.keyCode>=65&&e.keyCode<=90){const t=e.ctrlKey?e.keyCode-64:e.keyCode+32;let i=String.fromCharCode(t);e.shiftKey&&(i=i.toUpperCase()),o.key=s.C0.ESC+i}else if(32===e.keyCode)o.key=s.C0.ESC+(e.ctrlKey?s.C0.NUL:" ");else if("Dead"===e.key&&e.code.startsWith("Key")){let t=e.code.slice(3,4);e.shiftKey||(t=t.toLowerCase()),o.key=s.C0.ESC+t,o.cancel=!0}}else e.keyCode>=65&&e.keyCode<=90?o.key=String.fromCharCode(e.keyCode-64):32===e.keyCode?o.key=s.C0.NUL:e.keyCode>=51&&e.keyCode<=55?o.key=String.fromCharCode(e.keyCode-51+27):56===e.keyCode?o.key=s.C0.DEL:219===e.keyCode?o.key=s.C0.ESC:220===e.keyCode?o.key=s.C0.FS:221===e.keyCode&&(o.key=s.C0.GS)}return o}},482:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Utf8ToUtf32=t.StringToUtf32=t.utf32ToString=t.stringFromCodePoint=void 0,t.stringFromCodePoint=function(e){return e>65535?(e-=65536,String.fromCharCode(55296+(e>>10))+String.fromCharCode(e%1024+56320)):String.fromCharCode(e)},t.utf32ToString=function(e,t=0,i=e.length){let s="";for(let r=t;r65535?(t-=65536,s+=String.fromCharCode(55296+(t>>10))+String.fromCharCode(t%1024+56320)):s+=String.fromCharCode(t)}return s},t.StringToUtf32=class{constructor(){this._interim=0}clear(){this._interim=0}decode(e,t){const i=e.length;if(!i)return 0;let s=0,r=0;if(this._interim){const i=e.charCodeAt(r++);56320<=i&&i<=57343?t[s++]=1024*(this._interim-55296)+i-56320+65536:(t[s++]=this._interim,t[s++]=i),this._interim=0}for(let n=r;n=i)return this._interim=r,s;const o=e.charCodeAt(n);56320<=o&&o<=57343?t[s++]=1024*(r-55296)+o-56320+65536:(t[s++]=r,t[s++]=o)}else 65279!==r&&(t[s++]=r)}return s}},t.Utf8ToUtf32=class{constructor(){this.interim=new Uint8Array(3)}clear(){this.interim.fill(0)}decode(e,t){const i=e.length;if(!i)return 0;let s,r,n,o,a=0,h=0,c=0;if(this.interim[0]){let s=!1,r=this.interim[0];r&=192==(224&r)?31:224==(240&r)?15:7;let n,o=0;for(;(n=63&this.interim[++o])&&o<4;)r<<=6,r|=n;const h=192==(224&this.interim[0])?2:224==(240&this.interim[0])?3:4,l=h-o;for(;c=i)return 0;if(n=e[c++],128!=(192&n)){c--,s=!0;break}this.interim[o++]=n,r<<=6,r|=63&n}s||(2===h?r<128?c--:t[a++]=r:3===h?r<2048||r>=55296&&r<=57343||65279===r||(t[a++]=r):r<65536||r>1114111||(t[a++]=r)),this.interim.fill(0)}const l=i-4;let d=c;for(;d=i)return this.interim[0]=s,a;if(r=e[d++],128!=(192&r)){d--;continue}if(h=(31&s)<<6|63&r,h<128){d--;continue}t[a++]=h}else if(224==(240&s)){if(d>=i)return this.interim[0]=s,a;if(r=e[d++],128!=(192&r)){d--;continue}if(d>=i)return this.interim[0]=s,this.interim[1]=r,a;if(n=e[d++],128!=(192&n)){d--;continue}if(h=(15&s)<<12|(63&r)<<6|63&n,h<2048||h>=55296&&h<=57343||65279===h)continue;t[a++]=h}else if(240==(248&s)){if(d>=i)return this.interim[0]=s,a;if(r=e[d++],128!=(192&r)){d--;continue}if(d>=i)return this.interim[0]=s,this.interim[1]=r,a;if(n=e[d++],128!=(192&n)){d--;continue}if(d>=i)return this.interim[0]=s,this.interim[1]=r,this.interim[2]=n,a;if(o=e[d++],128!=(192&o)){d--;continue}if(h=(7&s)<<18|(63&r)<<12|(63&n)<<6|63&o,h<65536||h>1114111)continue;t[a++]=h}}return a}}},225:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.UnicodeV6=void 0;const s=i(1480),r=[[768,879],[1155,1158],[1160,1161],[1425,1469],[1471,1471],[1473,1474],[1476,1477],[1479,1479],[1536,1539],[1552,1557],[1611,1630],[1648,1648],[1750,1764],[1767,1768],[1770,1773],[1807,1807],[1809,1809],[1840,1866],[1958,1968],[2027,2035],[2305,2306],[2364,2364],[2369,2376],[2381,2381],[2385,2388],[2402,2403],[2433,2433],[2492,2492],[2497,2500],[2509,2509],[2530,2531],[2561,2562],[2620,2620],[2625,2626],[2631,2632],[2635,2637],[2672,2673],[2689,2690],[2748,2748],[2753,2757],[2759,2760],[2765,2765],[2786,2787],[2817,2817],[2876,2876],[2879,2879],[2881,2883],[2893,2893],[2902,2902],[2946,2946],[3008,3008],[3021,3021],[3134,3136],[3142,3144],[3146,3149],[3157,3158],[3260,3260],[3263,3263],[3270,3270],[3276,3277],[3298,3299],[3393,3395],[3405,3405],[3530,3530],[3538,3540],[3542,3542],[3633,3633],[3636,3642],[3655,3662],[3761,3761],[3764,3769],[3771,3772],[3784,3789],[3864,3865],[3893,3893],[3895,3895],[3897,3897],[3953,3966],[3968,3972],[3974,3975],[3984,3991],[3993,4028],[4038,4038],[4141,4144],[4146,4146],[4150,4151],[4153,4153],[4184,4185],[4448,4607],[4959,4959],[5906,5908],[5938,5940],[5970,5971],[6002,6003],[6068,6069],[6071,6077],[6086,6086],[6089,6099],[6109,6109],[6155,6157],[6313,6313],[6432,6434],[6439,6440],[6450,6450],[6457,6459],[6679,6680],[6912,6915],[6964,6964],[6966,6970],[6972,6972],[6978,6978],[7019,7027],[7616,7626],[7678,7679],[8203,8207],[8234,8238],[8288,8291],[8298,8303],[8400,8431],[12330,12335],[12441,12442],[43014,43014],[43019,43019],[43045,43046],[64286,64286],[65024,65039],[65056,65059],[65279,65279],[65529,65531]],n=[[68097,68099],[68101,68102],[68108,68111],[68152,68154],[68159,68159],[119143,119145],[119155,119170],[119173,119179],[119210,119213],[119362,119364],[917505,917505],[917536,917631],[917760,917999]];let o;t.UnicodeV6=class{constructor(){if(this.version="6",!o){o=new Uint8Array(65536),o.fill(1),o[0]=0,o.fill(0,1,32),o.fill(0,127,160),o.fill(2,4352,4448),o[9001]=2,o[9002]=2,o.fill(2,11904,42192),o[12351]=1,o.fill(2,44032,55204),o.fill(2,63744,64256),o.fill(2,65040,65050),o.fill(2,65072,65136),o.fill(2,65280,65377),o.fill(2,65504,65511);for(let e=0;et[r][1])return!1;for(;r>=s;)if(i=s+r>>1,e>t[i][1])s=i+1;else{if(!(e=131072&&e<=196605||e>=196608&&e<=262141?2:1}charProperties(e,t){let i=this.wcwidth(e),r=0===i&&0!==t;if(r){const e=s.UnicodeService.extractWidth(t);0===e?r=!1:e>i&&(i=e)}return s.UnicodeService.createPropertyValue(0,i,r)}}},5981:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.WriteBuffer=void 0;const s=i(8460),r=i(844);class n extends r.Disposable{constructor(e){super(),this._action=e,this._writeBuffer=[],this._callbacks=[],this._pendingData=0,this._bufferOffset=0,this._isSyncWriting=!1,this._syncCalls=0,this._didUserInput=!1,this._onWriteParsed=this.register(new s.EventEmitter),this.onWriteParsed=this._onWriteParsed.event}handleUserInput(){this._didUserInput=!0}writeSync(e,t){if(void 0!==t&&this._syncCalls>t)return void(this._syncCalls=0);if(this._pendingData+=e.length,this._writeBuffer.push(e),this._callbacks.push(void 0),this._syncCalls++,this._isSyncWriting)return;let i;for(this._isSyncWriting=!0;i=this._writeBuffer.shift();){this._action(i);const e=this._callbacks.shift();e&&e()}this._pendingData=0,this._bufferOffset=2147483647,this._isSyncWriting=!1,this._syncCalls=0}write(e,t){if(this._pendingData>5e7)throw new Error("write data discarded, use flow control to avoid losing data");if(!this._writeBuffer.length){if(this._bufferOffset=0,this._didUserInput)return this._didUserInput=!1,this._pendingData+=e.length,this._writeBuffer.push(e),this._callbacks.push(t),void this._innerWrite();setTimeout((()=>this._innerWrite()))}this._pendingData+=e.length,this._writeBuffer.push(e),this._callbacks.push(t)}_innerWrite(e=0,t=!0){const i=e||Date.now();for(;this._writeBuffer.length>this._bufferOffset;){const e=this._writeBuffer[this._bufferOffset],s=this._action(e,t);if(s){const e=e=>Date.now()-i>=12?setTimeout((()=>this._innerWrite(0,e))):this._innerWrite(i,e);return void s.catch((e=>(queueMicrotask((()=>{throw e})),Promise.resolve(!1)))).then(e)}const r=this._callbacks[this._bufferOffset];if(r&&r(),this._bufferOffset++,this._pendingData-=e.length,Date.now()-i>=12)break}this._writeBuffer.length>this._bufferOffset?(this._bufferOffset>50&&(this._writeBuffer=this._writeBuffer.slice(this._bufferOffset),this._callbacks=this._callbacks.slice(this._bufferOffset),this._bufferOffset=0),setTimeout((()=>this._innerWrite()))):(this._writeBuffer.length=0,this._callbacks.length=0,this._pendingData=0,this._bufferOffset=0),this._onWriteParsed.fire()}}t.WriteBuffer=n},5941:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.toRgbString=t.parseColor=void 0;const i=/^([\da-f])\/([\da-f])\/([\da-f])$|^([\da-f]{2})\/([\da-f]{2})\/([\da-f]{2})$|^([\da-f]{3})\/([\da-f]{3})\/([\da-f]{3})$|^([\da-f]{4})\/([\da-f]{4})\/([\da-f]{4})$/,s=/^[\da-f]+$/;function r(e,t){const i=e.toString(16),s=i.length<2?"0"+i:i;switch(t){case 4:return i[0];case 8:return s;case 12:return(s+s).slice(0,3);default:return s+s}}t.parseColor=function(e){if(!e)return;let t=e.toLowerCase();if(0===t.indexOf("rgb:")){t=t.slice(4);const e=i.exec(t);if(e){const t=e[1]?15:e[4]?255:e[7]?4095:65535;return[Math.round(parseInt(e[1]||e[4]||e[7]||e[10],16)/t*255),Math.round(parseInt(e[2]||e[5]||e[8]||e[11],16)/t*255),Math.round(parseInt(e[3]||e[6]||e[9]||e[12],16)/t*255)]}}else if(0===t.indexOf("#")&&(t=t.slice(1),s.exec(t)&&[3,6,9,12].includes(t.length))){const e=t.length/3,i=[0,0,0];for(let s=0;s<3;++s){const r=parseInt(t.slice(e*s,e*s+e),16);i[s]=1===e?r<<4:2===e?r:3===e?r>>4:r>>8}return i}},t.toRgbString=function(e,t=16){const[i,s,n]=e;return`rgb:${r(i,t)}/${r(s,t)}/${r(n,t)}`}},5770:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.PAYLOAD_LIMIT=void 0,t.PAYLOAD_LIMIT=1e7},6351:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.DcsHandler=t.DcsParser=void 0;const s=i(482),r=i(8742),n=i(5770),o=[];t.DcsParser=class{constructor(){this._handlers=Object.create(null),this._active=o,this._ident=0,this._handlerFb=()=>{},this._stack={paused:!1,loopPosition:0,fallThrough:!1}}dispose(){this._handlers=Object.create(null),this._handlerFb=()=>{},this._active=o}registerHandler(e,t){void 0===this._handlers[e]&&(this._handlers[e]=[]);const i=this._handlers[e];return i.push(t),{dispose:()=>{const e=i.indexOf(t);-1!==e&&i.splice(e,1)}}}clearHandler(e){this._handlers[e]&&delete this._handlers[e]}setHandlerFallback(e){this._handlerFb=e}reset(){if(this._active.length)for(let e=this._stack.paused?this._stack.loopPosition-1:this._active.length-1;e>=0;--e)this._active[e].unhook(!1);this._stack.paused=!1,this._active=o,this._ident=0}hook(e,t){if(this.reset(),this._ident=e,this._active=this._handlers[e]||o,this._active.length)for(let e=this._active.length-1;e>=0;e--)this._active[e].hook(t);else this._handlerFb(this._ident,"HOOK",t)}put(e,t,i){if(this._active.length)for(let s=this._active.length-1;s>=0;s--)this._active[s].put(e,t,i);else this._handlerFb(this._ident,"PUT",(0,s.utf32ToString)(e,t,i))}unhook(e,t=!0){if(this._active.length){let i=!1,s=this._active.length-1,r=!1;if(this._stack.paused&&(s=this._stack.loopPosition-1,i=t,r=this._stack.fallThrough,this._stack.paused=!1),!r&&!1===i){for(;s>=0&&(i=this._active[s].unhook(e),!0!==i);s--)if(i instanceof Promise)return this._stack.paused=!0,this._stack.loopPosition=s,this._stack.fallThrough=!1,i;s--}for(;s>=0;s--)if(i=this._active[s].unhook(!1),i instanceof Promise)return this._stack.paused=!0,this._stack.loopPosition=s,this._stack.fallThrough=!0,i}else this._handlerFb(this._ident,"UNHOOK",e);this._active=o,this._ident=0}};const a=new r.Params;a.addParam(0),t.DcsHandler=class{constructor(e){this._handler=e,this._data="",this._params=a,this._hitLimit=!1}hook(e){this._params=e.length>1||e.params[0]?e.clone():a,this._data="",this._hitLimit=!1}put(e,t,i){this._hitLimit||(this._data+=(0,s.utf32ToString)(e,t,i),this._data.length>n.PAYLOAD_LIMIT&&(this._data="",this._hitLimit=!0))}unhook(e){let t=!1;if(this._hitLimit)t=!1;else if(e&&(t=this._handler(this._data,this._params),t instanceof Promise))return t.then((e=>(this._params=a,this._data="",this._hitLimit=!1,e)));return this._params=a,this._data="",this._hitLimit=!1,t}}},2015:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.EscapeSequenceParser=t.VT500_TRANSITION_TABLE=t.TransitionTable=void 0;const s=i(844),r=i(8742),n=i(6242),o=i(6351);class a{constructor(e){this.table=new Uint8Array(e)}setDefault(e,t){this.table.fill(e<<4|t)}add(e,t,i,s){this.table[t<<8|e]=i<<4|s}addMany(e,t,i,s){for(let r=0;rt)),i=(e,i)=>t.slice(e,i),s=i(32,127),r=i(0,24);r.push(25),r.push.apply(r,i(28,32));const n=i(0,14);let o;for(o in e.setDefault(1,0),e.addMany(s,0,2,0),n)e.addMany([24,26,153,154],o,3,0),e.addMany(i(128,144),o,3,0),e.addMany(i(144,152),o,3,0),e.add(156,o,0,0),e.add(27,o,11,1),e.add(157,o,4,8),e.addMany([152,158,159],o,0,7),e.add(155,o,11,3),e.add(144,o,11,9);return e.addMany(r,0,3,0),e.addMany(r,1,3,1),e.add(127,1,0,1),e.addMany(r,8,0,8),e.addMany(r,3,3,3),e.add(127,3,0,3),e.addMany(r,4,3,4),e.add(127,4,0,4),e.addMany(r,6,3,6),e.addMany(r,5,3,5),e.add(127,5,0,5),e.addMany(r,2,3,2),e.add(127,2,0,2),e.add(93,1,4,8),e.addMany(s,8,5,8),e.add(127,8,5,8),e.addMany([156,27,24,26,7],8,6,0),e.addMany(i(28,32),8,0,8),e.addMany([88,94,95],1,0,7),e.addMany(s,7,0,7),e.addMany(r,7,0,7),e.add(156,7,0,0),e.add(127,7,0,7),e.add(91,1,11,3),e.addMany(i(64,127),3,7,0),e.addMany(i(48,60),3,8,4),e.addMany([60,61,62,63],3,9,4),e.addMany(i(48,60),4,8,4),e.addMany(i(64,127),4,7,0),e.addMany([60,61,62,63],4,0,6),e.addMany(i(32,64),6,0,6),e.add(127,6,0,6),e.addMany(i(64,127),6,0,0),e.addMany(i(32,48),3,9,5),e.addMany(i(32,48),5,9,5),e.addMany(i(48,64),5,0,6),e.addMany(i(64,127),5,7,0),e.addMany(i(32,48),4,9,5),e.addMany(i(32,48),1,9,2),e.addMany(i(32,48),2,9,2),e.addMany(i(48,127),2,10,0),e.addMany(i(48,80),1,10,0),e.addMany(i(81,88),1,10,0),e.addMany([89,90,92],1,10,0),e.addMany(i(96,127),1,10,0),e.add(80,1,11,9),e.addMany(r,9,0,9),e.add(127,9,0,9),e.addMany(i(28,32),9,0,9),e.addMany(i(32,48),9,9,12),e.addMany(i(48,60),9,8,10),e.addMany([60,61,62,63],9,9,10),e.addMany(r,11,0,11),e.addMany(i(32,128),11,0,11),e.addMany(i(28,32),11,0,11),e.addMany(r,10,0,10),e.add(127,10,0,10),e.addMany(i(28,32),10,0,10),e.addMany(i(48,60),10,8,10),e.addMany([60,61,62,63],10,0,11),e.addMany(i(32,48),10,9,12),e.addMany(r,12,0,12),e.add(127,12,0,12),e.addMany(i(28,32),12,0,12),e.addMany(i(32,48),12,9,12),e.addMany(i(48,64),12,0,11),e.addMany(i(64,127),12,12,13),e.addMany(i(64,127),10,12,13),e.addMany(i(64,127),9,12,13),e.addMany(r,13,13,13),e.addMany(s,13,13,13),e.add(127,13,0,13),e.addMany([27,156,24,26],13,14,0),e.add(h,0,2,0),e.add(h,8,5,8),e.add(h,6,0,6),e.add(h,11,0,11),e.add(h,13,13,13),e}();class c extends s.Disposable{constructor(e=t.VT500_TRANSITION_TABLE){super(),this._transitions=e,this._parseStack={state:0,handlers:[],handlerPos:0,transition:0,chunkPos:0},this.initialState=0,this.currentState=this.initialState,this._params=new r.Params,this._params.addParam(0),this._collect=0,this.precedingJoinState=0,this._printHandlerFb=(e,t,i)=>{},this._executeHandlerFb=e=>{},this._csiHandlerFb=(e,t)=>{},this._escHandlerFb=e=>{},this._errorHandlerFb=e=>e,this._printHandler=this._printHandlerFb,this._executeHandlers=Object.create(null),this._csiHandlers=Object.create(null),this._escHandlers=Object.create(null),this.register((0,s.toDisposable)((()=>{this._csiHandlers=Object.create(null),this._executeHandlers=Object.create(null),this._escHandlers=Object.create(null)}))),this._oscParser=this.register(new n.OscParser),this._dcsParser=this.register(new o.DcsParser),this._errorHandler=this._errorHandlerFb,this.registerEscHandler({final:"\\"},(()=>!0))}_identifier(e,t=[64,126]){let i=0;if(e.prefix){if(e.prefix.length>1)throw new Error("only one byte as prefix supported");if(i=e.prefix.charCodeAt(0),i&&60>i||i>63)throw new Error("prefix must be in range 0x3c .. 0x3f")}if(e.intermediates){if(e.intermediates.length>2)throw new Error("only two bytes as intermediates are supported");for(let t=0;ts||s>47)throw new Error("intermediate must be in range 0x20 .. 0x2f");i<<=8,i|=s}}if(1!==e.final.length)throw new Error("final must be a single byte");const s=e.final.charCodeAt(0);if(t[0]>s||s>t[1])throw new Error(`final must be in range ${t[0]} .. ${t[1]}`);return i<<=8,i|=s,i}identToString(e){const t=[];for(;e;)t.push(String.fromCharCode(255&e)),e>>=8;return t.reverse().join("")}setPrintHandler(e){this._printHandler=e}clearPrintHandler(){this._printHandler=this._printHandlerFb}registerEscHandler(e,t){const i=this._identifier(e,[48,126]);void 0===this._escHandlers[i]&&(this._escHandlers[i]=[]);const s=this._escHandlers[i];return s.push(t),{dispose:()=>{const e=s.indexOf(t);-1!==e&&s.splice(e,1)}}}clearEscHandler(e){this._escHandlers[this._identifier(e,[48,126])]&&delete this._escHandlers[this._identifier(e,[48,126])]}setEscHandlerFallback(e){this._escHandlerFb=e}setExecuteHandler(e,t){this._executeHandlers[e.charCodeAt(0)]=t}clearExecuteHandler(e){this._executeHandlers[e.charCodeAt(0)]&&delete this._executeHandlers[e.charCodeAt(0)]}setExecuteHandlerFallback(e){this._executeHandlerFb=e}registerCsiHandler(e,t){const i=this._identifier(e);void 0===this._csiHandlers[i]&&(this._csiHandlers[i]=[]);const s=this._csiHandlers[i];return s.push(t),{dispose:()=>{const e=s.indexOf(t);-1!==e&&s.splice(e,1)}}}clearCsiHandler(e){this._csiHandlers[this._identifier(e)]&&delete this._csiHandlers[this._identifier(e)]}setCsiHandlerFallback(e){this._csiHandlerFb=e}registerDcsHandler(e,t){return this._dcsParser.registerHandler(this._identifier(e),t)}clearDcsHandler(e){this._dcsParser.clearHandler(this._identifier(e))}setDcsHandlerFallback(e){this._dcsParser.setHandlerFallback(e)}registerOscHandler(e,t){return this._oscParser.registerHandler(e,t)}clearOscHandler(e){this._oscParser.clearHandler(e)}setOscHandlerFallback(e){this._oscParser.setHandlerFallback(e)}setErrorHandler(e){this._errorHandler=e}clearErrorHandler(){this._errorHandler=this._errorHandlerFb}reset(){this.currentState=this.initialState,this._oscParser.reset(),this._dcsParser.reset(),this._params.reset(),this._params.addParam(0),this._collect=0,this.precedingJoinState=0,0!==this._parseStack.state&&(this._parseStack.state=2,this._parseStack.handlers=[])}_preserveStack(e,t,i,s,r){this._parseStack.state=e,this._parseStack.handlers=t,this._parseStack.handlerPos=i,this._parseStack.transition=s,this._parseStack.chunkPos=r}parse(e,t,i){let s,r=0,n=0,o=0;if(this._parseStack.state)if(2===this._parseStack.state)this._parseStack.state=0,o=this._parseStack.chunkPos+1;else{if(void 0===i||1===this._parseStack.state)throw this._parseStack.state=1,new Error("improper continuation due to previous async handler, giving up parsing");const t=this._parseStack.handlers;let n=this._parseStack.handlerPos-1;switch(this._parseStack.state){case 3:if(!1===i&&n>-1)for(;n>=0&&(s=t[n](this._params),!0!==s);n--)if(s instanceof Promise)return this._parseStack.handlerPos=n,s;this._parseStack.handlers=[];break;case 4:if(!1===i&&n>-1)for(;n>=0&&(s=t[n](),!0!==s);n--)if(s instanceof Promise)return this._parseStack.handlerPos=n,s;this._parseStack.handlers=[];break;case 6:if(r=e[this._parseStack.chunkPos],s=this._dcsParser.unhook(24!==r&&26!==r,i),s)return s;27===r&&(this._parseStack.transition|=1),this._params.reset(),this._params.addParam(0),this._collect=0;break;case 5:if(r=e[this._parseStack.chunkPos],s=this._oscParser.end(24!==r&&26!==r,i),s)return s;27===r&&(this._parseStack.transition|=1),this._params.reset(),this._params.addParam(0),this._collect=0}this._parseStack.state=0,o=this._parseStack.chunkPos+1,this.precedingJoinState=0,this.currentState=15&this._parseStack.transition}for(let i=o;i>4){case 2:for(let s=i+1;;++s){if(s>=t||(r=e[s])<32||r>126&&r=t||(r=e[s])<32||r>126&&r=t||(r=e[s])<32||r>126&&r=t||(r=e[s])<32||r>126&&r=0&&(s=o[a](this._params),!0!==s);a--)if(s instanceof Promise)return this._preserveStack(3,o,a,n,i),s;a<0&&this._csiHandlerFb(this._collect<<8|r,this._params),this.precedingJoinState=0;break;case 8:do{switch(r){case 59:this._params.addParam(0);break;case 58:this._params.addSubParam(-1);break;default:this._params.addDigit(r-48)}}while(++i47&&r<60);i--;break;case 9:this._collect<<=8,this._collect|=r;break;case 10:const c=this._escHandlers[this._collect<<8|r];let l=c?c.length-1:-1;for(;l>=0&&(s=c[l](),!0!==s);l--)if(s instanceof Promise)return this._preserveStack(4,c,l,n,i),s;l<0&&this._escHandlerFb(this._collect<<8|r),this.precedingJoinState=0;break;case 11:this._params.reset(),this._params.addParam(0),this._collect=0;break;case 12:this._dcsParser.hook(this._collect<<8|r,this._params);break;case 13:for(let s=i+1;;++s)if(s>=t||24===(r=e[s])||26===r||27===r||r>127&&r=t||(r=e[s])<32||r>127&&r{Object.defineProperty(t,"__esModule",{value:!0}),t.OscHandler=t.OscParser=void 0;const s=i(5770),r=i(482),n=[];t.OscParser=class{constructor(){this._state=0,this._active=n,this._id=-1,this._handlers=Object.create(null),this._handlerFb=()=>{},this._stack={paused:!1,loopPosition:0,fallThrough:!1}}registerHandler(e,t){void 0===this._handlers[e]&&(this._handlers[e]=[]);const i=this._handlers[e];return i.push(t),{dispose:()=>{const e=i.indexOf(t);-1!==e&&i.splice(e,1)}}}clearHandler(e){this._handlers[e]&&delete this._handlers[e]}setHandlerFallback(e){this._handlerFb=e}dispose(){this._handlers=Object.create(null),this._handlerFb=()=>{},this._active=n}reset(){if(2===this._state)for(let e=this._stack.paused?this._stack.loopPosition-1:this._active.length-1;e>=0;--e)this._active[e].end(!1);this._stack.paused=!1,this._active=n,this._id=-1,this._state=0}_start(){if(this._active=this._handlers[this._id]||n,this._active.length)for(let e=this._active.length-1;e>=0;e--)this._active[e].start();else this._handlerFb(this._id,"START")}_put(e,t,i){if(this._active.length)for(let s=this._active.length-1;s>=0;s--)this._active[s].put(e,t,i);else this._handlerFb(this._id,"PUT",(0,r.utf32ToString)(e,t,i))}start(){this.reset(),this._state=1}put(e,t,i){if(3!==this._state){if(1===this._state)for(;t0&&this._put(e,t,i)}}end(e,t=!0){if(0!==this._state){if(3!==this._state)if(1===this._state&&this._start(),this._active.length){let i=!1,s=this._active.length-1,r=!1;if(this._stack.paused&&(s=this._stack.loopPosition-1,i=t,r=this._stack.fallThrough,this._stack.paused=!1),!r&&!1===i){for(;s>=0&&(i=this._active[s].end(e),!0!==i);s--)if(i instanceof Promise)return this._stack.paused=!0,this._stack.loopPosition=s,this._stack.fallThrough=!1,i;s--}for(;s>=0;s--)if(i=this._active[s].end(!1),i instanceof Promise)return this._stack.paused=!0,this._stack.loopPosition=s,this._stack.fallThrough=!0,i}else this._handlerFb(this._id,"END",e);this._active=n,this._id=-1,this._state=0}}},t.OscHandler=class{constructor(e){this._handler=e,this._data="",this._hitLimit=!1}start(){this._data="",this._hitLimit=!1}put(e,t,i){this._hitLimit||(this._data+=(0,r.utf32ToString)(e,t,i),this._data.length>s.PAYLOAD_LIMIT&&(this._data="",this._hitLimit=!0))}end(e){let t=!1;if(this._hitLimit)t=!1;else if(e&&(t=this._handler(this._data),t instanceof Promise))return t.then((e=>(this._data="",this._hitLimit=!1,e)));return this._data="",this._hitLimit=!1,t}}},8742:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Params=void 0;const i=2147483647;class s{static fromArray(e){const t=new s;if(!e.length)return t;for(let i=Array.isArray(e[0])?1:0;i256)throw new Error("maxSubParamsLength must not be greater than 256");this.params=new Int32Array(e),this.length=0,this._subParams=new Int32Array(t),this._subParamsLength=0,this._subParamsIdx=new Uint16Array(e),this._rejectDigits=!1,this._rejectSubDigits=!1,this._digitIsSub=!1}clone(){const e=new s(this.maxLength,this.maxSubParamsLength);return e.params.set(this.params),e.length=this.length,e._subParams.set(this._subParams),e._subParamsLength=this._subParamsLength,e._subParamsIdx.set(this._subParamsIdx),e._rejectDigits=this._rejectDigits,e._rejectSubDigits=this._rejectSubDigits,e._digitIsSub=this._digitIsSub,e}toArray(){const e=[];for(let t=0;t>8,s=255&this._subParamsIdx[t];s-i>0&&e.push(Array.prototype.slice.call(this._subParams,i,s))}return e}reset(){this.length=0,this._subParamsLength=0,this._rejectDigits=!1,this._rejectSubDigits=!1,this._digitIsSub=!1}addParam(e){if(this._digitIsSub=!1,this.length>=this.maxLength)this._rejectDigits=!0;else{if(e<-1)throw new Error("values lesser than -1 are not allowed");this._subParamsIdx[this.length]=this._subParamsLength<<8|this._subParamsLength,this.params[this.length++]=e>i?i:e}}addSubParam(e){if(this._digitIsSub=!0,this.length)if(this._rejectDigits||this._subParamsLength>=this.maxSubParamsLength)this._rejectSubDigits=!0;else{if(e<-1)throw new Error("values lesser than -1 are not allowed");this._subParams[this._subParamsLength++]=e>i?i:e,this._subParamsIdx[this.length-1]++}}hasSubParams(e){return(255&this._subParamsIdx[e])-(this._subParamsIdx[e]>>8)>0}getSubParams(e){const t=this._subParamsIdx[e]>>8,i=255&this._subParamsIdx[e];return i-t>0?this._subParams.subarray(t,i):null}getSubParamsAll(){const e={};for(let t=0;t>8,s=255&this._subParamsIdx[t];s-i>0&&(e[t]=this._subParams.slice(i,s))}return e}addDigit(e){let t;if(this._rejectDigits||!(t=this._digitIsSub?this._subParamsLength:this.length)||this._digitIsSub&&this._rejectSubDigits)return;const s=this._digitIsSub?this._subParams:this.params,r=s[t-1];s[t-1]=~r?Math.min(10*r+e,i):e}}t.Params=s},5741:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.AddonManager=void 0,t.AddonManager=class{constructor(){this._addons=[]}dispose(){for(let e=this._addons.length-1;e>=0;e--)this._addons[e].instance.dispose()}loadAddon(e,t){const i={instance:t,dispose:t.dispose,isDisposed:!1};this._addons.push(i),t.dispose=()=>this._wrappedAddonDispose(i),t.activate(e)}_wrappedAddonDispose(e){if(e.isDisposed)return;let t=-1;for(let i=0;i{Object.defineProperty(t,"__esModule",{value:!0}),t.BufferApiView=void 0;const s=i(3785),r=i(511);t.BufferApiView=class{constructor(e,t){this._buffer=e,this.type=t}init(e){return this._buffer=e,this}get cursorY(){return this._buffer.y}get cursorX(){return this._buffer.x}get viewportY(){return this._buffer.ydisp}get baseY(){return this._buffer.ybase}get length(){return this._buffer.lines.length}getLine(e){const t=this._buffer.lines.get(e);if(t)return new s.BufferLineApiView(t)}getNullCell(){return new r.CellData}}},3785:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.BufferLineApiView=void 0;const s=i(511);t.BufferLineApiView=class{constructor(e){this._line=e}get isWrapped(){return this._line.isWrapped}get length(){return this._line.length}getCell(e,t){if(!(e<0||e>=this._line.length))return t?(this._line.loadCell(e,t),t):this._line.loadCell(e,new s.CellData)}translateToString(e,t,i){return this._line.translateToString(e,t,i)}}},8285:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.BufferNamespaceApi=void 0;const s=i(8771),r=i(8460),n=i(844);class o extends n.Disposable{constructor(e){super(),this._core=e,this._onBufferChange=this.register(new r.EventEmitter),this.onBufferChange=this._onBufferChange.event,this._normal=new s.BufferApiView(this._core.buffers.normal,"normal"),this._alternate=new s.BufferApiView(this._core.buffers.alt,"alternate"),this._core.buffers.onBufferActivate((()=>this._onBufferChange.fire(this.active)))}get active(){if(this._core.buffers.active===this._core.buffers.normal)return this.normal;if(this._core.buffers.active===this._core.buffers.alt)return this.alternate;throw new Error("Active buffer is neither normal nor alternate")}get normal(){return this._normal.init(this._core.buffers.normal)}get alternate(){return this._alternate.init(this._core.buffers.alt)}}t.BufferNamespaceApi=o},7975:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.ParserApi=void 0,t.ParserApi=class{constructor(e){this._core=e}registerCsiHandler(e,t){return this._core.registerCsiHandler(e,(e=>t(e.toArray())))}addCsiHandler(e,t){return this.registerCsiHandler(e,t)}registerDcsHandler(e,t){return this._core.registerDcsHandler(e,((e,i)=>t(e,i.toArray())))}addDcsHandler(e,t){return this.registerDcsHandler(e,t)}registerEscHandler(e,t){return this._core.registerEscHandler(e,t)}addEscHandler(e,t){return this.registerEscHandler(e,t)}registerOscHandler(e,t){return this._core.registerOscHandler(e,t)}addOscHandler(e,t){return this.registerOscHandler(e,t)}}},7090:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.UnicodeApi=void 0,t.UnicodeApi=class{constructor(e){this._core=e}register(e){this._core.unicodeService.register(e)}get versions(){return this._core.unicodeService.versions}get activeVersion(){return this._core.unicodeService.activeVersion}set activeVersion(e){this._core.unicodeService.activeVersion=e}}},744:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.BufferService=t.MINIMUM_ROWS=t.MINIMUM_COLS=void 0;const n=i(8460),o=i(844),a=i(5295),h=i(2585);t.MINIMUM_COLS=2,t.MINIMUM_ROWS=1;let c=t.BufferService=class extends o.Disposable{get buffer(){return this.buffers.active}constructor(e){super(),this.isUserScrolling=!1,this._onResize=this.register(new n.EventEmitter),this.onResize=this._onResize.event,this._onScroll=this.register(new n.EventEmitter),this.onScroll=this._onScroll.event,this.cols=Math.max(e.rawOptions.cols||0,t.MINIMUM_COLS),this.rows=Math.max(e.rawOptions.rows||0,t.MINIMUM_ROWS),this.buffers=this.register(new a.BufferSet(e,this))}resize(e,t){this.cols=e,this.rows=t,this.buffers.resize(e,t),this._onResize.fire({cols:e,rows:t})}reset(){this.buffers.reset(),this.isUserScrolling=!1}scroll(e,t=!1){const i=this.buffer;let s;s=this._cachedBlankLine,s&&s.length===this.cols&&s.getFg(0)===e.fg&&s.getBg(0)===e.bg||(s=i.getBlankLine(e,t),this._cachedBlankLine=s),s.isWrapped=t;const r=i.ybase+i.scrollTop,n=i.ybase+i.scrollBottom;if(0===i.scrollTop){const e=i.lines.isFull;n===i.lines.length-1?e?i.lines.recycle().copyFrom(s):i.lines.push(s.clone()):i.lines.splice(n+1,0,s.clone()),e?this.isUserScrolling&&(i.ydisp=Math.max(i.ydisp-1,0)):(i.ybase++,this.isUserScrolling||i.ydisp++)}else{const e=n-r+1;i.lines.shiftElements(r+1,e-1,-1),i.lines.set(n,s.clone())}this.isUserScrolling||(i.ydisp=i.ybase),this._onScroll.fire(i.ydisp)}scrollLines(e,t,i){const s=this.buffer;if(e<0){if(0===s.ydisp)return;this.isUserScrolling=!0}else e+s.ydisp>=s.ybase&&(this.isUserScrolling=!1);const r=s.ydisp;s.ydisp=Math.max(Math.min(s.ydisp+e,s.ybase),0),r!==s.ydisp&&(t||this._onScroll.fire(s.ydisp))}};t.BufferService=c=s([r(0,h.IOptionsService)],c)},7994:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.CharsetService=void 0,t.CharsetService=class{constructor(){this.glevel=0,this._charsets=[]}reset(){this.charset=void 0,this._charsets=[],this.glevel=0}setgLevel(e){this.glevel=e,this.charset=this._charsets[e]}setgCharset(e,t){this._charsets[e]=t,this.glevel===e&&(this.charset=t)}}},1753:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.CoreMouseService=void 0;const n=i(2585),o=i(8460),a=i(844),h={NONE:{events:0,restrict:()=>!1},X10:{events:1,restrict:e=>4!==e.button&&1===e.action&&(e.ctrl=!1,e.alt=!1,e.shift=!1,!0)},VT200:{events:19,restrict:e=>32!==e.action},DRAG:{events:23,restrict:e=>32!==e.action||3!==e.button},ANY:{events:31,restrict:e=>!0}};function c(e,t){let i=(e.ctrl?16:0)|(e.shift?4:0)|(e.alt?8:0);return 4===e.button?(i|=64,i|=e.action):(i|=3&e.button,4&e.button&&(i|=64),8&e.button&&(i|=128),32===e.action?i|=32:0!==e.action||t||(i|=3)),i}const l=String.fromCharCode,d={DEFAULT:e=>{const t=[c(e,!1)+32,e.col+32,e.row+32];return t[0]>255||t[1]>255||t[2]>255?"":`${l(t[0])}${l(t[1])}${l(t[2])}`},SGR:e=>{const t=0===e.action&&4!==e.button?"m":"M";return`[<${c(e,!0)};${e.col};${e.row}${t}`},SGR_PIXELS:e=>{const t=0===e.action&&4!==e.button?"m":"M";return`[<${c(e,!0)};${e.x};${e.y}${t}`}};let _=t.CoreMouseService=class extends a.Disposable{constructor(e,t){super(),this._bufferService=e,this._coreService=t,this._protocols={},this._encodings={},this._activeProtocol="",this._activeEncoding="",this._lastEvent=null,this._onProtocolChange=this.register(new o.EventEmitter),this.onProtocolChange=this._onProtocolChange.event;for(const e of Object.keys(h))this.addProtocol(e,h[e]);for(const e of Object.keys(d))this.addEncoding(e,d[e]);this.reset()}addProtocol(e,t){this._protocols[e]=t}addEncoding(e,t){this._encodings[e]=t}get activeProtocol(){return this._activeProtocol}get areMouseEventsActive(){return 0!==this._protocols[this._activeProtocol].events}set activeProtocol(e){if(!this._protocols[e])throw new Error(`unknown protocol "${e}"`);this._activeProtocol=e,this._onProtocolChange.fire(this._protocols[e].events)}get activeEncoding(){return this._activeEncoding}set activeEncoding(e){if(!this._encodings[e])throw new Error(`unknown encoding "${e}"`);this._activeEncoding=e}reset(){this.activeProtocol="NONE",this.activeEncoding="DEFAULT",this._lastEvent=null}triggerMouseEvent(e){if(e.col<0||e.col>=this._bufferService.cols||e.row<0||e.row>=this._bufferService.rows)return!1;if(4===e.button&&32===e.action)return!1;if(3===e.button&&32!==e.action)return!1;if(4!==e.button&&(2===e.action||3===e.action))return!1;if(e.col++,e.row++,32===e.action&&this._lastEvent&&this._equalEvents(this._lastEvent,e,"SGR_PIXELS"===this._activeEncoding))return!1;if(!this._protocols[this._activeProtocol].restrict(e))return!1;const t=this._encodings[this._activeEncoding](e);return t&&("DEFAULT"===this._activeEncoding?this._coreService.triggerBinaryEvent(t):this._coreService.triggerDataEvent(t,!0)),this._lastEvent=e,!0}explainEvents(e){return{down:!!(1&e),up:!!(2&e),drag:!!(4&e),move:!!(8&e),wheel:!!(16&e)}}_equalEvents(e,t,i){if(i){if(e.x!==t.x)return!1;if(e.y!==t.y)return!1}else{if(e.col!==t.col)return!1;if(e.row!==t.row)return!1}return e.button===t.button&&e.action===t.action&&e.ctrl===t.ctrl&&e.alt===t.alt&&e.shift===t.shift}};t.CoreMouseService=_=s([r(0,n.IBufferService),r(1,n.ICoreService)],_)},6975:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.CoreService=void 0;const n=i(1439),o=i(8460),a=i(844),h=i(2585),c=Object.freeze({insertMode:!1}),l=Object.freeze({applicationCursorKeys:!1,applicationKeypad:!1,bracketedPasteMode:!1,origin:!1,reverseWraparound:!1,sendFocus:!1,wraparound:!0});let d=t.CoreService=class extends a.Disposable{constructor(e,t,i){super(),this._bufferService=e,this._logService=t,this._optionsService=i,this.isCursorInitialized=!1,this.isCursorHidden=!1,this._onData=this.register(new o.EventEmitter),this.onData=this._onData.event,this._onUserInput=this.register(new o.EventEmitter),this.onUserInput=this._onUserInput.event,this._onBinary=this.register(new o.EventEmitter),this.onBinary=this._onBinary.event,this._onRequestScrollToBottom=this.register(new o.EventEmitter),this.onRequestScrollToBottom=this._onRequestScrollToBottom.event,this.modes=(0,n.clone)(c),this.decPrivateModes=(0,n.clone)(l)}reset(){this.modes=(0,n.clone)(c),this.decPrivateModes=(0,n.clone)(l)}triggerDataEvent(e,t=!1){if(this._optionsService.rawOptions.disableStdin)return;const i=this._bufferService.buffer;t&&this._optionsService.rawOptions.scrollOnUserInput&&i.ybase!==i.ydisp&&this._onRequestScrollToBottom.fire(),t&&this._onUserInput.fire(),this._logService.debug(`sending data "${e}"`,(()=>e.split("").map((e=>e.charCodeAt(0))))),this._onData.fire(e)}triggerBinaryEvent(e){this._optionsService.rawOptions.disableStdin||(this._logService.debug(`sending binary "${e}"`,(()=>e.split("").map((e=>e.charCodeAt(0))))),this._onBinary.fire(e))}};t.CoreService=d=s([r(0,h.IBufferService),r(1,h.ILogService),r(2,h.IOptionsService)],d)},9074:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.DecorationService=void 0;const s=i(8055),r=i(8460),n=i(844),o=i(6106);let a=0,h=0;class c extends n.Disposable{get decorations(){return this._decorations.values()}constructor(){super(),this._decorations=new o.SortedList((e=>e?.marker.line)),this._onDecorationRegistered=this.register(new r.EventEmitter),this.onDecorationRegistered=this._onDecorationRegistered.event,this._onDecorationRemoved=this.register(new r.EventEmitter),this.onDecorationRemoved=this._onDecorationRemoved.event,this.register((0,n.toDisposable)((()=>this.reset())))}registerDecoration(e){if(e.marker.isDisposed)return;const t=new l(e);if(t){const e=t.marker.onDispose((()=>t.dispose()));t.onDispose((()=>{t&&(this._decorations.delete(t)&&this._onDecorationRemoved.fire(t),e.dispose())})),this._decorations.insert(t),this._onDecorationRegistered.fire(t)}return t}reset(){for(const e of this._decorations.values())e.dispose();this._decorations.clear()}*getDecorationsAtCell(e,t,i){let s=0,r=0;for(const n of this._decorations.getKeyIterator(t))s=n.options.x??0,r=s+(n.options.width??1),e>=s&&e{a=t.options.x??0,h=a+(t.options.width??1),e>=a&&e{Object.defineProperty(t,"__esModule",{value:!0}),t.InstantiationService=t.ServiceCollection=void 0;const s=i(2585),r=i(8343);class n{constructor(...e){this._entries=new Map;for(const[t,i]of e)this.set(t,i)}set(e,t){const i=this._entries.get(e);return this._entries.set(e,t),i}forEach(e){for(const[t,i]of this._entries.entries())e(t,i)}has(e){return this._entries.has(e)}get(e){return this._entries.get(e)}}t.ServiceCollection=n,t.InstantiationService=class{constructor(){this._services=new n,this._services.set(s.IInstantiationService,this)}setService(e,t){this._services.set(e,t)}getService(e){return this._services.get(e)}createInstance(e,...t){const i=(0,r.getServiceDependencies)(e).sort(((e,t)=>e.index-t.index)),s=[];for(const t of i){const i=this._services.get(t.id);if(!i)throw new Error(`[createInstance] ${e.name} depends on UNKNOWN service ${t.id}.`);s.push(i)}const n=i.length>0?i[0].index:t.length;if(t.length!==n)throw new Error(`[createInstance] First service dependency of ${e.name} at position ${n+1} conflicts with ${t.length} static arguments`);return new e(...[...t,...s])}}},7866:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.traceCall=t.setTraceLogger=t.LogService=void 0;const n=i(844),o=i(2585),a={trace:o.LogLevelEnum.TRACE,debug:o.LogLevelEnum.DEBUG,info:o.LogLevelEnum.INFO,warn:o.LogLevelEnum.WARN,error:o.LogLevelEnum.ERROR,off:o.LogLevelEnum.OFF};let h,c=t.LogService=class extends n.Disposable{get logLevel(){return this._logLevel}constructor(e){super(),this._optionsService=e,this._logLevel=o.LogLevelEnum.OFF,this._updateLogLevel(),this.register(this._optionsService.onSpecificOptionChange("logLevel",(()=>this._updateLogLevel()))),h=this}_updateLogLevel(){this._logLevel=a[this._optionsService.rawOptions.logLevel]}_evalLazyOptionalParams(e){for(let t=0;tJSON.stringify(e))).join(", ")})`);const t=s.apply(this,e);return h.trace(`GlyphRenderer#${s.name} return`,t),t}}},7302:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.OptionsService=t.DEFAULT_OPTIONS=void 0;const s=i(8460),r=i(844),n=i(6114);t.DEFAULT_OPTIONS={cols:80,rows:24,cursorBlink:!1,cursorStyle:"block",cursorWidth:1,cursorInactiveStyle:"outline",customGlyphs:!0,drawBoldTextInBrightColors:!0,documentOverride:null,fastScrollModifier:"alt",fastScrollSensitivity:5,fontFamily:"courier-new, courier, monospace",fontSize:15,fontWeight:"normal",fontWeightBold:"bold",ignoreBracketedPasteMode:!1,lineHeight:1,letterSpacing:0,linkHandler:null,logLevel:"info",logger:null,scrollback:1e3,scrollOnUserInput:!0,scrollSensitivity:1,screenReaderMode:!1,smoothScrollDuration:0,macOptionIsMeta:!1,macOptionClickForcesSelection:!1,minimumContrastRatio:1,disableStdin:!1,allowProposedApi:!1,allowTransparency:!1,tabStopWidth:8,theme:{},rescaleOverlappingGlyphs:!1,rightClickSelectsWord:n.isMac,windowOptions:{},windowsMode:!1,windowsPty:{},wordSeparator:" ()[]{}',\"`",altClickMovesCursor:!0,convertEol:!1,termName:"xterm",cancelEvents:!1,overviewRulerWidth:0};const o=["normal","bold","100","200","300","400","500","600","700","800","900"];class a extends r.Disposable{constructor(e){super(),this._onOptionChange=this.register(new s.EventEmitter),this.onOptionChange=this._onOptionChange.event;const i={...t.DEFAULT_OPTIONS};for(const t in e)if(t in i)try{const s=e[t];i[t]=this._sanitizeAndValidateOption(t,s)}catch(e){console.error(e)}this.rawOptions=i,this.options={...i},this._setupOptions(),this.register((0,r.toDisposable)((()=>{this.rawOptions.linkHandler=null,this.rawOptions.documentOverride=null})))}onSpecificOptionChange(e,t){return this.onOptionChange((i=>{i===e&&t(this.rawOptions[e])}))}onMultipleOptionChange(e,t){return this.onOptionChange((i=>{-1!==e.indexOf(i)&&t()}))}_setupOptions(){const e=e=>{if(!(e in t.DEFAULT_OPTIONS))throw new Error(`No option with key "${e}"`);return this.rawOptions[e]},i=(e,i)=>{if(!(e in t.DEFAULT_OPTIONS))throw new Error(`No option with key "${e}"`);i=this._sanitizeAndValidateOption(e,i),this.rawOptions[e]!==i&&(this.rawOptions[e]=i,this._onOptionChange.fire(e))};for(const t in this.rawOptions){const s={get:e.bind(this,t),set:i.bind(this,t)};Object.defineProperty(this.options,t,s)}}_sanitizeAndValidateOption(e,i){switch(e){case"cursorStyle":if(i||(i=t.DEFAULT_OPTIONS[e]),!function(e){return"block"===e||"underline"===e||"bar"===e}(i))throw new Error(`"${i}" is not a valid value for ${e}`);break;case"wordSeparator":i||(i=t.DEFAULT_OPTIONS[e]);break;case"fontWeight":case"fontWeightBold":if("number"==typeof i&&1<=i&&i<=1e3)break;i=o.includes(i)?i:t.DEFAULT_OPTIONS[e];break;case"cursorWidth":i=Math.floor(i);case"lineHeight":case"tabStopWidth":if(i<1)throw new Error(`${e} cannot be less than 1, value: ${i}`);break;case"minimumContrastRatio":i=Math.max(1,Math.min(21,Math.round(10*i)/10));break;case"scrollback":if((i=Math.min(i,4294967295))<0)throw new Error(`${e} cannot be less than 0, value: ${i}`);break;case"fastScrollSensitivity":case"scrollSensitivity":if(i<=0)throw new Error(`${e} cannot be less than or equal to 0, value: ${i}`);break;case"rows":case"cols":if(!i&&0!==i)throw new Error(`${e} must be numeric, value: ${i}`);break;case"windowsPty":i=i??{}}return i}}t.OptionsService=a},2660:function(e,t,i){var s=this&&this.__decorate||function(e,t,i,s){var r,n=arguments.length,o=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)o=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(r=e[a])&&(o=(n<3?r(o):n>3?r(t,i,o):r(t,i))||o);return n>3&&o&&Object.defineProperty(t,i,o),o},r=this&&this.__param||function(e,t){return function(i,s){t(i,s,e)}};Object.defineProperty(t,"__esModule",{value:!0}),t.OscLinkService=void 0;const n=i(2585);let o=t.OscLinkService=class{constructor(e){this._bufferService=e,this._nextId=1,this._entriesWithId=new Map,this._dataByLinkId=new Map}registerLink(e){const t=this._bufferService.buffer;if(void 0===e.id){const i=t.addMarker(t.ybase+t.y),s={data:e,id:this._nextId++,lines:[i]};return i.onDispose((()=>this._removeMarkerFromLink(s,i))),this._dataByLinkId.set(s.id,s),s.id}const i=e,s=this._getEntryIdKey(i),r=this._entriesWithId.get(s);if(r)return this.addLineToLink(r.id,t.ybase+t.y),r.id;const n=t.addMarker(t.ybase+t.y),o={id:this._nextId++,key:this._getEntryIdKey(i),data:i,lines:[n]};return n.onDispose((()=>this._removeMarkerFromLink(o,n))),this._entriesWithId.set(o.key,o),this._dataByLinkId.set(o.id,o),o.id}addLineToLink(e,t){const i=this._dataByLinkId.get(e);if(i&&i.lines.every((e=>e.line!==t))){const e=this._bufferService.buffer.addMarker(t);i.lines.push(e),e.onDispose((()=>this._removeMarkerFromLink(i,e)))}}getLinkData(e){return this._dataByLinkId.get(e)?.data}_getEntryIdKey(e){return`${e.id};;${e.uri}`}_removeMarkerFromLink(e,t){const i=e.lines.indexOf(t);-1!==i&&(e.lines.splice(i,1),0===e.lines.length&&(void 0!==e.data.id&&this._entriesWithId.delete(e.key),this._dataByLinkId.delete(e.id)))}};t.OscLinkService=o=s([r(0,n.IBufferService)],o)},8343:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.createDecorator=t.getServiceDependencies=t.serviceRegistry=void 0;const i="di$target",s="di$dependencies";t.serviceRegistry=new Map,t.getServiceDependencies=function(e){return e[s]||[]},t.createDecorator=function(e){if(t.serviceRegistry.has(e))return t.serviceRegistry.get(e);const r=function(e,t,n){if(3!==arguments.length)throw new Error("@IServiceName-decorator can only be used to decorate a parameter");!function(e,t,r){t[i]===t?t[s].push({id:e,index:r}):(t[s]=[{id:e,index:r}],t[i]=t)}(r,e,n)};return r.toString=()=>e,t.serviceRegistry.set(e,r),r}},2585:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.IDecorationService=t.IUnicodeService=t.IOscLinkService=t.IOptionsService=t.ILogService=t.LogLevelEnum=t.IInstantiationService=t.ICharsetService=t.ICoreService=t.ICoreMouseService=t.IBufferService=void 0;const s=i(8343);var r;t.IBufferService=(0,s.createDecorator)("BufferService"),t.ICoreMouseService=(0,s.createDecorator)("CoreMouseService"),t.ICoreService=(0,s.createDecorator)("CoreService"),t.ICharsetService=(0,s.createDecorator)("CharsetService"),t.IInstantiationService=(0,s.createDecorator)("InstantiationService"),function(e){e[e.TRACE=0]="TRACE",e[e.DEBUG=1]="DEBUG",e[e.INFO=2]="INFO",e[e.WARN=3]="WARN",e[e.ERROR=4]="ERROR",e[e.OFF=5]="OFF"}(r||(t.LogLevelEnum=r={})),t.ILogService=(0,s.createDecorator)("LogService"),t.IOptionsService=(0,s.createDecorator)("OptionsService"),t.IOscLinkService=(0,s.createDecorator)("OscLinkService"),t.IUnicodeService=(0,s.createDecorator)("UnicodeService"),t.IDecorationService=(0,s.createDecorator)("DecorationService")},1480:(e,t,i)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.UnicodeService=void 0;const s=i(8460),r=i(225);class n{static extractShouldJoin(e){return 0!=(1&e)}static extractWidth(e){return e>>1&3}static extractCharKind(e){return e>>3}static createPropertyValue(e,t,i=!1){return(16777215&e)<<3|(3&t)<<1|(i?1:0)}constructor(){this._providers=Object.create(null),this._active="",this._onChange=new s.EventEmitter,this.onChange=this._onChange.event;const e=new r.UnicodeV6;this.register(e),this._active=e.version,this._activeProvider=e}dispose(){this._onChange.dispose()}get versions(){return Object.keys(this._providers)}get activeVersion(){return this._active}set activeVersion(e){if(!this._providers[e])throw new Error(`unknown Unicode version "${e}"`);this._active=e,this._activeProvider=this._providers[e],this._onChange.fire(e)}register(e){this._providers[e.version]=e}wcwidth(e){return this._activeProvider.wcwidth(e)}getStringCellWidth(e){let t=0,i=0;const s=e.length;for(let r=0;r=s)return t+this.wcwidth(o);const i=e.charCodeAt(r);56320<=i&&i<=57343?o=1024*(o-55296)+i-56320+65536:t+=this.wcwidth(i)}const a=this.charProperties(o,i);let h=n.extractWidth(a);n.extractShouldJoin(a)&&(h-=n.extractWidth(i)),t+=h,i=a}return t}charProperties(e,t){return this._activeProvider.charProperties(e,t)}}t.UnicodeService=n}},t={};function i(s){var r=t[s];if(void 0!==r)return r.exports;var n=t[s]={exports:{}};return e[s].call(n.exports,n,n.exports,i),n.exports}var s={};return(()=>{var e=s;Object.defineProperty(e,"__esModule",{value:!0}),e.Terminal=void 0;const t=i(9042),r=i(3236),n=i(844),o=i(5741),a=i(8285),h=i(7975),c=i(7090),l=["cols","rows"];class d extends n.Disposable{constructor(e){super(),this._core=this.register(new r.Terminal(e)),this._addonManager=this.register(new o.AddonManager),this._publicOptions={...this._core.options};const t=e=>this._core.options[e],i=(e,t)=>{this._checkReadonlyOptions(e),this._core.options[e]=t};for(const e in this._core.options){const s={get:t.bind(this,e),set:i.bind(this,e)};Object.defineProperty(this._publicOptions,e,s)}}_checkReadonlyOptions(e){if(l.includes(e))throw new Error(`Option "${e}" can only be set in the constructor`)}_checkProposedApi(){if(!this._core.optionsService.rawOptions.allowProposedApi)throw new Error("You must set the allowProposedApi option to true to use proposed API")}get onBell(){return this._core.onBell}get onBinary(){return this._core.onBinary}get onCursorMove(){return this._core.onCursorMove}get onData(){return this._core.onData}get onKey(){return this._core.onKey}get onLineFeed(){return this._core.onLineFeed}get onRender(){return this._core.onRender}get onResize(){return this._core.onResize}get onScroll(){return this._core.onScroll}get onSelectionChange(){return this._core.onSelectionChange}get onTitleChange(){return this._core.onTitleChange}get onWriteParsed(){return this._core.onWriteParsed}get element(){return this._core.element}get parser(){return this._parser||(this._parser=new h.ParserApi(this._core)),this._parser}get unicode(){return this._checkProposedApi(),new c.UnicodeApi(this._core)}get textarea(){return this._core.textarea}get rows(){return this._core.rows}get cols(){return this._core.cols}get buffer(){return this._buffer||(this._buffer=this.register(new a.BufferNamespaceApi(this._core))),this._buffer}get markers(){return this._checkProposedApi(),this._core.markers}get modes(){const e=this._core.coreService.decPrivateModes;let t="none";switch(this._core.coreMouseService.activeProtocol){case"X10":t="x10";break;case"VT200":t="vt200";break;case"DRAG":t="drag";break;case"ANY":t="any"}return{applicationCursorKeysMode:e.applicationCursorKeys,applicationKeypadMode:e.applicationKeypad,bracketedPasteMode:e.bracketedPasteMode,insertMode:this._core.coreService.modes.insertMode,mouseTrackingMode:t,originMode:e.origin,reverseWraparoundMode:e.reverseWraparound,sendFocusMode:e.sendFocus,wraparoundMode:e.wraparound}}get options(){return this._publicOptions}set options(e){for(const t in e)this._publicOptions[t]=e[t]}blur(){this._core.blur()}focus(){this._core.focus()}input(e,t=!0){this._core.input(e,t)}resize(e,t){this._verifyIntegers(e,t),this._core.resize(e,t)}open(e){this._core.open(e)}attachCustomKeyEventHandler(e){this._core.attachCustomKeyEventHandler(e)}attachCustomWheelEventHandler(e){this._core.attachCustomWheelEventHandler(e)}registerLinkProvider(e){return this._core.registerLinkProvider(e)}registerCharacterJoiner(e){return this._checkProposedApi(),this._core.registerCharacterJoiner(e)}deregisterCharacterJoiner(e){this._checkProposedApi(),this._core.deregisterCharacterJoiner(e)}registerMarker(e=0){return this._verifyIntegers(e),this._core.registerMarker(e)}registerDecoration(e){return this._checkProposedApi(),this._verifyPositiveIntegers(e.x??0,e.width??0,e.height??0),this._core.registerDecoration(e)}hasSelection(){return this._core.hasSelection()}select(e,t,i){this._verifyIntegers(e,t,i),this._core.select(e,t,i)}getSelection(){return this._core.getSelection()}getSelectionPosition(){return this._core.getSelectionPosition()}clearSelection(){this._core.clearSelection()}selectAll(){this._core.selectAll()}selectLines(e,t){this._verifyIntegers(e,t),this._core.selectLines(e,t)}dispose(){super.dispose()}scrollLines(e){this._verifyIntegers(e),this._core.scrollLines(e)}scrollPages(e){this._verifyIntegers(e),this._core.scrollPages(e)}scrollToTop(){this._core.scrollToTop()}scrollToBottom(){this._core.scrollToBottom()}scrollToLine(e){this._verifyIntegers(e),this._core.scrollToLine(e)}clear(){this._core.clear()}write(e,t){this._core.write(e,t)}writeln(e,t){this._core.write(e),this._core.write("\r\n",t)}paste(e){this._core.paste(e)}refresh(e,t){this._verifyIntegers(e,t),this._core.refresh(e,t)}reset(){this._core.reset()}clearTextureAtlas(){this._core.clearTextureAtlas()}loadAddon(e){this._addonManager.loadAddon(this,e)}static get strings(){return t}_verifyIntegers(...e){for(const t of e)if(t===1/0||isNaN(t)||t%1!=0)throw new Error("This API only accepts integers")}_verifyPositiveIntegers(...e){for(const t of e)if(t&&(t===1/0||isNaN(t)||t%1!=0||t<0))throw new Error("This API only accepts positive integers")}}e.Terminal=d})(),s})())); +//# sourceMappingURL=xterm.js.map \ No newline at end of file diff --git a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs index b1f3a6802fd..f9e2ea307b3 100644 --- a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs +++ b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs @@ -2,6 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System.Runtime.CompilerServices; +using Aspire.Dashboard.Model; using Aspire.DashboardService.Proto.V1; using Aspire.Hosting.ApplicationModel; using Microsoft.Extensions.Logging; @@ -39,6 +40,27 @@ public DashboardServiceData( { static GenericResourceSnapshot CreateResourceSnapshot(IResource resource, string resourceId, DateTime creationTimestamp, CustomResourceSnapshot snapshot) { + // If the resource has a TerminalAnnotation, add a terminal property to the snapshot + // so the Dashboard can detect terminal-enabled resources. + var terminalAnnotation = resource.Annotations.OfType().FirstOrDefault(); + if (terminalAnnotation is not null) + { + snapshot = snapshot with + { + Properties = snapshot.Properties.Add( + new ResourcePropertySnapshot(KnownProperties.Terminal.Enabled, "true") { IsSensitive = false }) + }; + + if (terminalAnnotation.SocketPath is not null) + { + snapshot = snapshot with + { + Properties = snapshot.Properties.Add( + new ResourcePropertySnapshot(KnownProperties.Terminal.SocketPath, terminalAnnotation.SocketPath) { IsSensitive = false }) + }; + } + } + return new GenericResourceSnapshot(snapshot) { Uid = resourceId, diff --git a/src/Shared/Model/KnownProperties.cs b/src/Shared/Model/KnownProperties.cs index db917b32720..04c93efa455 100644 --- a/src/Shared/Model/KnownProperties.cs +++ b/src/Shared/Model/KnownProperties.cs @@ -56,6 +56,12 @@ public static class Project public const string LaunchProfile = "project.launchProfile"; } + public static class Terminal + { + public const string Enabled = "terminal.enabled"; + public const string SocketPath = "terminal.socketPath"; + } + public static class Parameter { public const string Value = "Value"; From 251a5cf996e49bf0dfe329a5a2359b7bc81a243b Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 14:33:07 +1000 Subject: [PATCH 07/20] Fix Dashboard terminal: use script tags for xterm.js and int IDs for JS interop MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two fixes for the Blazor unhandled error: 1. xterm.min.js is UMD format, not ES module — cannot use dynamic import(). Changed to load via script tags into window.Terminal / window.FitAddon. 2. initTerminal returned a plain JS object which can't be marshaled as IJSObjectReference. Changed to return an int ID and use a Map-based registry on the JS side. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Components/Controls/TerminalView.razor.cs | 23 ++++-- .../Components/Controls/TerminalView.razor.js | 80 ++++++++++++------- 2 files changed, 64 insertions(+), 39 deletions(-) diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs index b0abbd38a06..b892c156290 100644 --- a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs @@ -15,7 +15,7 @@ public sealed partial class TerminalView : ComponentBase, IAsyncDisposable { private ElementReference _terminalElement; private IJSObjectReference? _jsModule; - private IJSObjectReference? _terminalInstance; + private int _terminalId; [Parameter] public string? SocketPath { get; set; } @@ -47,7 +47,7 @@ private async Task InitializeTerminalAsync() var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(SocketPath!)}"; - _terminalInstance = await _jsModule.InvokeAsync( + _terminalId = await _jsModule.InvokeAsync( "initTerminal", _terminalElement, wsUrl); } catch (JSDisconnectedException) @@ -61,7 +61,7 @@ private async Task InitializeTerminalAsync() /// public async Task ReconnectAsync(string? newSocketPath) { - if (_jsModule is null || _terminalInstance is null) + if (_jsModule is null || _terminalId == 0) { SocketPath = newSocketPath; if (newSocketPath is not null) @@ -73,8 +73,8 @@ public async Task ReconnectAsync(string? newSocketPath) if (newSocketPath is null) { - await _jsModule.InvokeVoidAsync("disposeTerminal", _terminalInstance); - _terminalInstance = null; + await _jsModule.InvokeVoidAsync("disposeTerminal", _terminalId); + _terminalId = 0; return; } @@ -83,14 +83,21 @@ public async Task ReconnectAsync(string? newSocketPath) var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(newSocketPath)}"; - await _jsModule.InvokeVoidAsync("reconnectTerminal", _terminalInstance, wsUrl); + await _jsModule.InvokeVoidAsync("reconnectTerminal", _terminalId, wsUrl); } public async ValueTask DisposeAsync() { - if (_terminalInstance is not null) + if (_jsModule is not null && _terminalId != 0) { - await JSInteropHelpers.SafeDisposeAsync(_terminalInstance); + try + { + await _jsModule.InvokeVoidAsync("disposeTerminal", _terminalId); + } + catch (JSDisconnectedException) + { + // Expected during shutdown + } } if (_jsModule is not null) { diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js index caffbb99de6..4e2aa0a582a 100644 --- a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js @@ -2,30 +2,49 @@ // Connects to the Dashboard's WebSocket proxy which bridges to the // resource's UDS using the Aspire Terminal Protocol. -let Terminal, FitAddon; +// xterm.js is loaded via script tags (not ES module import) because +// the minified bundle uses UMD format, not ESM exports. -async function loadXterm() { - if (!Terminal) { - const xtermModule = await import('/js/xterm/xterm.min.js'); - Terminal = xtermModule.Terminal; - const fitModule = await import('/js/xterm/addon-fit.min.js'); - FitAddon = fitModule.FitAddon; +const terminals = new Map(); +let nextId = 1; - // Inject xterm.css if not already present +function ensureXtermLoaded() { + return new Promise((resolve, reject) => { + if (window.Terminal) { + resolve(); + return; + } + + // Load CSS if (!document.querySelector('link[href*="xterm.min.css"]')) { const link = document.createElement('link'); link.rel = 'stylesheet'; link.href = '/js/xterm/xterm.min.css'; document.head.appendChild(link); } - } + + // Load xterm.js + const xtermScript = document.createElement('script'); + xtermScript.src = '/js/xterm/xterm.min.js'; + xtermScript.onload = () => { + // Load fit addon + const fitScript = document.createElement('script'); + fitScript.src = '/js/xterm/addon-fit.min.js'; + fitScript.onload = () => resolve(); + fitScript.onerror = (e) => reject(new Error('Failed to load xterm fit addon')); + document.head.appendChild(fitScript); + }; + xtermScript.onerror = (e) => reject(new Error('Failed to load xterm.js')); + document.head.appendChild(xtermScript); + }); } export async function initTerminal(element, wsUrl) { - await loadXterm(); + await ensureXtermLoaded(); + const FitAddon = window.FitAddon.FitAddon; const fitAddon = new FitAddon(); - const term = new Terminal({ + const term = new window.Terminal({ cursorBlink: true, fontSize: 14, fontFamily: '"Cascadia Code", "Cascadia Mono", Menlo, Monaco, "Courier New", monospace', @@ -34,26 +53,29 @@ export async function initTerminal(element, wsUrl) { foreground: '#d4d4d4', cursor: '#d4d4d4', }, - allowProposedApi: true, }); term.loadAddon(fitAddon); term.open(element); + + // Small delay to let the DOM settle before fitting + await new Promise(r => setTimeout(r, 50)); fitAddon.fit(); + const id = nextId++; + const state = { id, ws: null, term, fitAddon, element }; + // Connect WebSocket - const state = { ws: null, term, fitAddon, element }; connectWebSocket(state, wsUrl); // Handle terminal resize const resizeObserver = new ResizeObserver(() => { - fitAddon.fit(); + try { fitAddon.fit(); } catch { /* ignore */ } }); resizeObserver.observe(element); term.onResize(({ cols, rows }) => { if (state.ws && state.ws.readyState === WebSocket.OPEN) { - // Send resize as JSON message (the proxy translates to protocol RESIZE frame) state.ws.send(JSON.stringify({ type: 'resize', cols, rows })); } }); @@ -65,19 +87,9 @@ export async function initTerminal(element, wsUrl) { } }); - // Handle binary input - term.onBinary((data) => { - if (state.ws && state.ws.readyState === WebSocket.OPEN) { - const buffer = new Uint8Array(data.length); - for (let i = 0; i < data.length; i++) { - buffer[i] = data.charCodeAt(i); - } - state.ws.send(buffer); - } - }); - state._resizeObserver = resizeObserver; - return state; + terminals.set(id, state); + return id; } function connectWebSocket(state, wsUrl) { @@ -85,7 +97,6 @@ function connectWebSocket(state, wsUrl) { ws.binaryType = 'arraybuffer'; ws.onopen = () => { - state.term.clear(); state.fitAddon.fit(); }; @@ -108,16 +119,22 @@ function connectWebSocket(state, wsUrl) { state.ws = ws; } -export function reconnectTerminal(state, wsUrl) { +export function reconnectTerminal(id, wsUrl) { + const state = terminals.get(id); + if (!state) return; + if (state.ws) { - state.ws.onclose = null; // prevent disconnect message + state.ws.onclose = null; state.ws.close(); } state.term.clear(); connectWebSocket(state, wsUrl); } -export function disposeTerminal(state) { +export function disposeTerminal(id) { + const state = terminals.get(id); + if (!state) return; + if (state._resizeObserver) { state._resizeObserver.disconnect(); } @@ -128,4 +145,5 @@ export function disposeTerminal(state) { if (state.term) { state.term.dispose(); } + terminals.delete(id); } From d438a0f7e1ae11f53cd13e12c30024d80b1c7a28 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 14:53:13 +1000 Subject: [PATCH 08/20] Add production Aspire.TerminalHost and wire into AppHost discovery MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New project: src/Aspire.TerminalHost/ - Console app using Hex1b with UnixDomainSocketPresentationAdapter - Speaks Aspire Terminal Protocol over UDS - Receives config via TERMINAL_SOCKET_PATH, TERMINAL_COLUMNS/ROWS/SHELL env vars - Bridges PTY shell ↔ UDS clients AppHost discovery (following Dashboard pattern): - DcpOptions.TerminalHostPath for path resolution - Three-tier discovery: env var (ASPIRE_TERMINAL_HOST_PATH) → config → assembly metadata - Assembly metadata key: 'aspireterminalhostpath' - MSBuild target SetTerminalHostDiscoveryAttributes in AppHost.in.targets - Development path: artifacts/bin/Aspire.TerminalHost/{Config}/net8.0/ WithTerminal lifecycle: - AddTerminalHostResource now generates UDS path and sets it on TerminalAnnotation - OnInitializeResource resolves terminal host binary via DcpOptions - Launches terminal host as child process with env var configuration - Forwards stderr to resource logs - Manages process lifecycle with clean shutdown DCP flow: - TerminalAnnotation.SocketPath → TerminalSpec on ExecutableSpec/ContainerSpec - DCP receives terminal.enabled + terminal.socketPath in the CRD spec - DCP can use socketPath to forward PTY I/O (Go implementation separate) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- Directory.Build.props | 1 + .../build/Aspire.Hosting.AppHost.in.targets | 16 ++ src/Aspire.Hosting/Dcp/DcpOptions.cs | 21 ++ .../TerminalResourceBuilderExtensions.cs | 112 ++++++++++ .../Aspire.TerminalHost.csproj | 21 ++ src/Aspire.TerminalHost/Program.cs | 70 ++++++ .../UnixDomainSocketPresentationAdapter.cs | 204 ++++++++++++++++++ 7 files changed, 445 insertions(+) create mode 100644 src/Aspire.TerminalHost/Aspire.TerminalHost.csproj create mode 100644 src/Aspire.TerminalHost/Program.cs create mode 100644 src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs diff --git a/Directory.Build.props b/Directory.Build.props index e06b96f9811..aeabebff56d 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -56,6 +56,7 @@ $(MSBuildThisFileDirectory)/artifacts/bin/Aspire.Dashboard/$(Configuration)/net8.0/ + $(MSBuildThisFileDirectory)/artifacts/bin/Aspire.TerminalHost/$(Configuration)/net8.0/ diff --git a/src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets b/src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets index 1b2c8bebf55..3109757dacb 100644 --- a/src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets +++ b/src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets @@ -230,6 +230,22 @@ namespace Projects%3B + + + $([MSBuild]::EnsureTrailingSlash('$(AspireTerminalHostDir)')) + $([MSBuild]::NormalizePath($(AspireTerminalHostDir), 'Aspire.TerminalHost')) + $(AspireTerminalHostPath).exe + $(AspireTerminalHostPath).dll + + + + + <_Parameter1>aspireterminalhostpath + <_Parameter2>$(AspireTerminalHostPath) + + + + diff --git a/src/Aspire.Hosting/Dcp/DcpOptions.cs b/src/Aspire.Hosting/Dcp/DcpOptions.cs index ed9d18df59f..d36d6a44221 100644 --- a/src/Aspire.Hosting/Dcp/DcpOptions.cs +++ b/src/Aspire.Hosting/Dcp/DcpOptions.cs @@ -34,6 +34,11 @@ internal sealed class DcpOptions /// public string? DashboardPath { get; set; } + /// + /// Optional path to the Aspire Terminal Host binary. + /// + public string? TerminalHostPath { get; set; } + /// /// Optional container runtime to override default runtime for DCP containers. /// @@ -139,6 +144,7 @@ internal class ConfigureDefaultDcpOptions( private const string DcpCliPathMetadataKey = "DcpCliPath"; private const string DcpExtensionsPathMetadataKey = "DcpExtensionsPath"; private const string DashboardPathMetadataKey = "aspiredashboardpath"; + private const string TerminalHostPathMetadataKey = "aspireterminalhostpath"; public static string DcpPublisher = nameof(DcpPublisher); @@ -190,6 +196,21 @@ public void Configure(DcpOptions options) options.DashboardPath = GetMetadataValue(assemblyMetadata, DashboardPathMetadataKey); } + // Terminal Host path resolution (same pattern as Dashboard) + var configTerminalHostPath = configuration["ASPIRE_TERMINAL_HOST_PATH"]; + if (!string.IsNullOrEmpty(configTerminalHostPath)) + { + options.TerminalHostPath = configTerminalHostPath; + } + else if (!string.IsNullOrEmpty(dcpPublisherConfiguration[nameof(options.TerminalHostPath)])) + { + options.TerminalHostPath = dcpPublisherConfiguration[nameof(options.TerminalHostPath)]; + } + else + { + options.TerminalHostPath = GetMetadataValue(assemblyMetadata, TerminalHostPathMetadataKey); + } + if (!string.IsNullOrEmpty(dcpPublisherConfiguration[nameof(options.ContainerRuntime)])) { options.ContainerRuntime = dcpPublisherConfiguration[nameof(options.ContainerRuntime)]; diff --git a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs index 22574787c16..81e0f0722b9 100644 --- a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs +++ b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs @@ -2,6 +2,9 @@ // The .NET Foundation licenses this file to you under the MIT license. using Aspire.Hosting.ApplicationModel; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; namespace Aspire.Hosting; @@ -123,8 +126,19 @@ private static void AddTerminalHostResource(IResourceBuilder builder) var terminalHostName = $"{builder.Resource.Name}-terminal-host"; var terminalHost = new TerminalHostResource(terminalHostName, builder.Resource); + // Generate a UDS path for this terminal session + var socketDir = Path.Combine(Path.GetTempPath(), "aspire-terminals"); + Directory.CreateDirectory(socketDir); + var socketPath = Path.Combine(socketDir, $"{builder.Resource.Name}-{Environment.ProcessId}.sock"); + + // Store the socket path on the terminal annotation + var terminalAnnotation = builder.Resource.Annotations.OfType().First(); + terminalAnnotation.SocketPath = socketPath; + var terminalHostBuilder = builder.ApplicationBuilder.AddResource(terminalHost); + var options = terminalAnnotation.Options; + terminalHostBuilder .WithInitialState(new CustomResourceSnapshot { @@ -135,6 +149,104 @@ private static void AddTerminalHostResource(IResourceBuilder builder) }) .ExcludeFromManifest(); + // Set up the terminal host lifecycle: when the resource initializes, + // resolve the terminal host binary path and launch it via DCP. + terminalHostBuilder.OnInitializeResource(async (resource, @event, token) => + { + var dcpOptions = @event.Services.GetService>(); + var notification = @event.Notifications; + var log = @event.Logger; + + var terminalHostPath = dcpOptions?.Value.TerminalHostPath; + if (string.IsNullOrEmpty(terminalHostPath)) + { + log.LogWarning("Terminal host binary path not configured. Terminal will not be available for resource '{ResourceName}'.", resource.Parent.Name); + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.FailedToStart + }).ConfigureAwait(false); + return; + } + + if (!File.Exists(terminalHostPath)) + { + log.LogWarning("Terminal host binary not found at '{Path}'. Build Aspire.TerminalHost first.", terminalHostPath); + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.FailedToStart + }).ConfigureAwait(false); + return; + } + + log.LogInformation("Starting terminal host for '{ResourceName}' at {SocketPath}", resource.Parent.Name, socketPath); + + // Launch the terminal host process + var psi = new System.Diagnostics.ProcessStartInfo(terminalHostPath) + { + UseShellExecute = false, + RedirectStandardError = true, + Environment = + { + ["TERMINAL_SOCKET_PATH"] = socketPath, + ["TERMINAL_COLUMNS"] = options.Columns.ToString(System.Globalization.CultureInfo.InvariantCulture), + ["TERMINAL_ROWS"] = options.Rows.ToString(System.Globalization.CultureInfo.InvariantCulture), + } + }; + + if (options.Shell is not null) + { + psi.Environment["TERMINAL_SHELL"] = options.Shell; + } + + var process = System.Diagnostics.Process.Start(psi); + if (process is null) + { + log.LogError("Failed to start terminal host process"); + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.FailedToStart + }).ConfigureAwait(false); + return; + } + + // Forward stderr to resource logs + _ = Task.Run(async () => + { + while (!process.HasExited && !token.IsCancellationRequested) + { + var line = await process.StandardError.ReadLineAsync(token).ConfigureAwait(false); + if (line is not null) + { + log.LogInformation("{Line}", line); + } + } + }, token); + + await notification.PublishUpdateAsync(resource, s => s with + { + StartTimeStamp = DateTime.UtcNow, + State = KnownResourceStates.Running + }).ConfigureAwait(false); + + try + { + await process.WaitForExitAsync(token).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + if (!process.HasExited) + { + process.Kill(entireProcessTree: true); + } + } + + await notification.PublishUpdateAsync(resource, s => s with + { + State = KnownResourceStates.Exited, + ExitCode = process.ExitCode + }).ConfigureAwait(false); + }); + // The parent resource waits for the terminal host to be started so that // the PTY forwarding infrastructure is in place before the process begins. if (builder.Resource is IResourceWithWaitSupport) diff --git a/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj b/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj new file mode 100644 index 00000000000..7fe617b5b18 --- /dev/null +++ b/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj @@ -0,0 +1,21 @@ + + + + Exe + $(DefaultTargetFramework) + enable + enable + Major + + $(NoWarn);CS8002;CA2007 + + + + + + + + + + + diff --git a/src/Aspire.TerminalHost/Program.cs b/src/Aspire.TerminalHost/Program.cs new file mode 100644 index 00000000000..11013f54499 --- /dev/null +++ b/src/Aspire.TerminalHost/Program.cs @@ -0,0 +1,70 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Terminal; +using Aspire.TerminalHost; +using Hex1b; + +// The Aspire Terminal Host bridges a PTY process to the Aspire Terminal Protocol +// over a Unix domain socket. It is launched by the AppHost orchestrator for resources +// with .WithTerminal() and serves as the terminal state manager using Hex1b. +// +// Environment variables: +// TERMINAL_SOCKET_PATH — UDS path for client connections (required) +// TERMINAL_COLUMNS — initial terminal width (default: 120) +// TERMINAL_ROWS — initial terminal height (default: 30) +// TERMINAL_SHELL — shell command to run (default: platform-specific) +// TERMINAL_SHELL_ARGS — shell arguments, semicolon-separated (default: platform-specific) + +var socketPath = Environment.GetEnvironmentVariable("TERMINAL_SOCKET_PATH"); +if (string.IsNullOrEmpty(socketPath)) +{ + Console.Error.WriteLine("Error: TERMINAL_SOCKET_PATH environment variable is required."); + return 1; +} + +var columns = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_COLUMNS"), out var c) ? c : 120; +var rows = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_ROWS"), out var r) ? r : 30; + +var shell = Environment.GetEnvironmentVariable("TERMINAL_SHELL") + ?? (OperatingSystem.IsWindows() ? "pwsh" : "/bin/bash"); + +var shellArgsStr = Environment.GetEnvironmentVariable("TERMINAL_SHELL_ARGS"); +var shellArgs = !string.IsNullOrEmpty(shellArgsStr) + ? shellArgsStr.Split(';', StringSplitOptions.RemoveEmptyEntries) + : (OperatingSystem.IsWindows() ? ["-NoLogo"] : ["--norc"]); + +Console.Error.WriteLine($"[Aspire.TerminalHost] shell={shell}, size={columns}x{rows}, socket={socketPath}"); + +var adapter = new UnixDomainSocketPresentationAdapter(socketPath, columns, rows); + +using var cts = new CancellationTokenSource(); +Console.CancelKeyPress += (_, e) => +{ + e.Cancel = true; + cts.Cancel(); +}; + +try +{ + // Wait for client connection before starting the shell + await adapter.WaitForClientAsync(cts.Token); + + // Build the Hex1b terminal: PTY process + UDS presentation + await using var terminal = Hex1bTerminal.CreateBuilder() + .WithPresentation(adapter) + .WithPtyProcess(shell, shellArgs) + .WithDimensions(columns, rows) + .Build(); + + var exitCode = await terminal.RunAsync(cts.Token); + Console.Error.WriteLine($"[Aspire.TerminalHost] Shell exited with code {exitCode}"); + + await adapter.SendExitAsync(exitCode, TerminalProtocol.ExitReason.Exited, CancellationToken.None); + return exitCode; +} +catch (OperationCanceledException) +{ + Console.Error.WriteLine("[Aspire.TerminalHost] Shutting down"); + return 0; +} diff --git a/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs b/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs new file mode 100644 index 00000000000..ff7e4a77bd6 --- /dev/null +++ b/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs @@ -0,0 +1,204 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Terminal; +using Hex1b; + +namespace Aspire.TerminalHost; + +/// +/// A Hex1b presentation adapter that serves terminal I/O over a Unix domain socket +/// using the Aspire Terminal Protocol (see docs/specs/terminal-protocol.md). +/// +internal sealed class UnixDomainSocketPresentationAdapter : IHex1bTerminalPresentationAdapter +{ + private readonly string _socketPath; + private readonly CancellationTokenSource _disposeCts = new(); + private Socket? _serverSocket; + private Socket? _clientSocket; + private NetworkStream? _clientStream; + private TerminalFrameReader? _reader; + private TerminalFrameWriter? _writer; + private bool _disposed; + private bool _helloSent; + + public UnixDomainSocketPresentationAdapter(string socketPath, int width, int height) + { + _socketPath = socketPath; + Width = width; + Height = height; + } + + public int Width { get; private set; } + public int Height { get; private set; } + + public TerminalCapabilities Capabilities => new() + { + SupportsTrueColor = true, + Supports256Colors = true, + SupportsAlternateScreen = true, + SupportsBracketedPaste = true, + }; + + public event Action? Resized; + public event Action? Disconnected; + + /// + /// Starts listening on the UDS and waits for a client to connect. + /// Sends the HELLO frame once connected. + /// + public async Task WaitForClientAsync(CancellationToken ct) + { + // Clean up stale socket + if (File.Exists(_socketPath)) + { + File.Delete(_socketPath); + } + + var socketDir = Path.GetDirectoryName(_socketPath); + if (socketDir is not null) + { + Directory.CreateDirectory(socketDir); + } + + _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); + _serverSocket.Listen(backlog: 1); + + Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); + + _clientSocket = await _serverSocket.AcceptAsync(ct); + _clientStream = new NetworkStream(_clientSocket, ownsSocket: false); + _reader = new TerminalFrameReader(_clientStream); + _writer = new TerminalFrameWriter(_clientStream); + + Console.Error.WriteLine("[TerminalHost] Client connected, sending HELLO"); + + // Send HELLO as the first frame per protocol spec + await _writer.WriteHelloAsync( + (ushort)Width, + (ushort)Height, + TerminalProtocol.HelloFlags.Pty, + ct); + + _helloSent = true; + } + + public async ValueTask WriteOutputAsync(ReadOnlyMemory data, CancellationToken ct = default) + { + if (_disposed || _writer is null || !_helloSent) + { + return; + } + + try + { + await _writer.WriteDataAsync(data, ct); + } + catch (IOException) + { + Disconnected?.Invoke(); + } + catch (SocketException) + { + Disconnected?.Invoke(); + } + } + + public async ValueTask> ReadInputAsync(CancellationToken ct = default) + { + if (_disposed || _reader is null) + { + return ReadOnlyMemory.Empty; + } + + try + { + using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); + var frame = await _reader.ReadFrameAsync(linkedCts.Token); + + if (frame is null) + { + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + return frame.Value.Payload; + + case TerminalProtocol.MessageType.Resize: + var (cols, rows) = frame.Value.ParseResize(); + Width = cols; + Height = rows; + Resized?.Invoke(cols, rows); + return await ReadInputAsync(ct); + + case TerminalProtocol.MessageType.Close: + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + + default: + // Unknown frame type — skip and read next + return await ReadInputAsync(ct); + } + } + catch (OperationCanceledException) + { + return ReadOnlyMemory.Empty; + } + catch (IOException) + { + Disconnected?.Invoke(); + return ReadOnlyMemory.Empty; + } + } + + public ValueTask FlushAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + + // Raw mode is handled by the client side, not the server + public ValueTask EnterRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + public ValueTask ExitRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; + public (int Row, int Column) GetCursorPosition() => (0, 0); + + /// + /// Sends an EXIT frame to the client. + /// + public async ValueTask SendExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) + { + if (_writer is not null && !_disposed) + { + try + { + await _writer.WriteExitAsync(exitCode, reason, ct); + await _writer.WriteCloseAsync(ct); + } + catch { /* best effort */ } + } + } + + public async ValueTask DisposeAsync() + { + if (_disposed) + { + return; + } + + _disposed = true; + await _disposeCts.CancelAsync(); + + _clientStream?.Dispose(); + _clientSocket?.Dispose(); + _serverSocket?.Dispose(); + + if (File.Exists(_socketPath)) + { + try { File.Delete(_socketPath); } + catch { /* ignore cleanup errors */ } + } + + _disposeCts.Dispose(); + } +} From 43241dccee18418ba1b5ab900097fedfd07e9e13 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 15:11:29 +1000 Subject: [PATCH 09/20] Fix playground: use custom socket path overload to avoid dual terminal host The playground's TerminalDemoResource manages its own terminal host process lifecycle, so it should use WithTerminal(socketPathProvider) instead of the bare WithTerminal() which now also launches a terminal host. Using the custom overload avoids creating a conflicting hidden TerminalHostResource. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs b/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs index 500f934f993..7ceeb7f899e 100644 --- a/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs +++ b/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs @@ -52,7 +52,7 @@ public static IResourceBuilder AddTerminalDemo( new("terminal.socketPath", socketPath) ] }) - .WithTerminal(); + .WithTerminal(_ => Task.FromResult(socketPath)); // Use OnInitializeResource to launch the terminal host process and manage its lifecycle. // This replaces what DCP would normally do (PTY allocation + UDS forwarding). From 9a0629a4243845f1c13f327951dae4085a4a7fe6 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 20 Apr 2026 16:39:09 +1000 Subject: [PATCH 10/20] Redesign terminal host for reconnection with state replay Replaces the presentation adapter approach with a presentation filter architecture (modeled after Hex1b's DiagnosticsSocketListener): - Terminal runs headless (Hex1b manages internal screen state) - TerminalSocketServer is an IHex1bTerminalPresentationFilter that intercepts all output via OnOutputAsync and broadcasts to clients - On client connect: CreateSnapshot().ToAnsi() captures current screen state and sends it as the first DATA frame after HELLO (with REPLAY flag) - On client disconnect: terminal keeps running, accepts new connections - On reconnect: fresh snapshot replayed, then live streaming resumes This enables navigating away from the terminal in the Dashboard and returning to find the same terminal state preserved. Key changes: - New TerminalSocketServer.cs (filter-based, session management) - Program.cs: WithHeadless() + AddPresentationFilter(server) instead of WithPresentation(adapter) - Old UnixDomainSocketPresentationAdapter kept for playground compatibility Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.TerminalHost/Program.cs | 26 +- .../TerminalSocketServer.cs | 322 ++++++++++++++++++ 2 files changed, 339 insertions(+), 9 deletions(-) create mode 100644 src/Aspire.TerminalHost/TerminalSocketServer.cs diff --git a/src/Aspire.TerminalHost/Program.cs b/src/Aspire.TerminalHost/Program.cs index 11013f54499..989bc8c240e 100644 --- a/src/Aspire.TerminalHost/Program.cs +++ b/src/Aspire.TerminalHost/Program.cs @@ -1,7 +1,6 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. -using Aspire.Terminal; using Aspire.TerminalHost; using Hex1b; @@ -9,6 +8,11 @@ // over a Unix domain socket. It is launched by the AppHost orchestrator for resources // with .WithTerminal() and serves as the terminal state manager using Hex1b. // +// Architecture: +// - Hex1b runs the shell in headless mode (manages internal terminal state) +// - A presentation filter intercepts all output and broadcasts to UDS clients +// - Clients can disconnect and reconnect; current screen state is replayed +// // Environment variables: // TERMINAL_SOCKET_PATH — UDS path for client connections (required) // TERMINAL_COLUMNS — initial terminal width (default: 120) @@ -36,7 +40,8 @@ Console.Error.WriteLine($"[Aspire.TerminalHost] shell={shell}, size={columns}x{rows}, socket={socketPath}"); -var adapter = new UnixDomainSocketPresentationAdapter(socketPath, columns, rows); +// Create the socket server (presentation filter) +await using var server = new TerminalSocketServer(socketPath, columns, rows); using var cts = new CancellationTokenSource(); Console.CancelKeyPress += (_, e) => @@ -47,20 +52,23 @@ try { - // Wait for client connection before starting the shell - await adapter.WaitForClientAsync(cts.Token); - - // Build the Hex1b terminal: PTY process + UDS presentation + // Build the terminal: headless presentation + PTY process + our filter for UDS broadcasting await using var terminal = Hex1bTerminal.CreateBuilder() - .WithPresentation(adapter) + .WithHeadless() .WithPtyProcess(shell, shellArgs) .WithDimensions(columns, rows) + .AddPresentationFilter(server) .Build(); + // Give the server access to the terminal for snapshots and input forwarding + server.SetTerminal(terminal); + + // Start accepting client connections + await server.StartListeningAsync(cts.Token); + + // Run the terminal (blocks until shell exits or cancellation) var exitCode = await terminal.RunAsync(cts.Token); Console.Error.WriteLine($"[Aspire.TerminalHost] Shell exited with code {exitCode}"); - - await adapter.SendExitAsync(exitCode, TerminalProtocol.ExitReason.Exited, CancellationToken.None); return exitCode; } catch (OperationCanceledException) diff --git a/src/Aspire.TerminalHost/TerminalSocketServer.cs b/src/Aspire.TerminalHost/TerminalSocketServer.cs new file mode 100644 index 00000000000..e1da6ee1a07 --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalSocketServer.cs @@ -0,0 +1,322 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using System.Text; +using System.Threading.Channels; +using Aspire.Terminal; +using Hex1b; +using Hex1b.Automation; +using Hex1b.Tokens; + +namespace Aspire.TerminalHost; + +/// +/// A Hex1b presentation filter that serves terminal I/O over a Unix domain socket +/// using the Aspire Terminal Protocol. Supports client disconnect and reconnect with +/// automatic terminal state replay. +/// +/// Architecture: +/// - The terminal runs headless (Hex1b manages internal state) +/// - This filter intercepts all output via OnOutputAsync and broadcasts to connected clients +/// - On client connect: snapshot the terminal, send HELLO + screen state, then stream live +/// - On client disconnect: terminal keeps running, ready for new connections +/// +internal sealed class TerminalSocketServer : IHex1bTerminalPresentationFilter, IAsyncDisposable +{ + private readonly string _socketPath; + private readonly int _columns; + private readonly int _rows; + private readonly CancellationTokenSource _disposeCts = new(); + + private Socket? _serverSocket; + private Hex1bTerminal? _terminal; + private ClientSession? _activeSession; + private readonly object _sessionLock = new(); + private bool _disposed; + + private int _currentWidth; + private int _currentHeight; + + public TerminalSocketServer(string socketPath, int columns, int rows) + { + _socketPath = socketPath; + _columns = columns; + _rows = rows; + _currentWidth = columns; + _currentHeight = rows; + } + + /// + /// Sets the terminal reference so the server can create snapshots for reconnection. + /// Must be called before the terminal starts running. + /// + public void SetTerminal(Hex1bTerminal terminal) + { + _terminal = terminal; + } + + /// + /// Starts the UDS listener and accepts client connections in the background. + /// + public Task StartListeningAsync(CancellationToken ct) + { + if (File.Exists(_socketPath)) + { + File.Delete(_socketPath); + } + + var socketDir = Path.GetDirectoryName(_socketPath); + if (socketDir is not null) + { + Directory.CreateDirectory(socketDir); + } + + _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); + _serverSocket.Listen(backlog: 2); + + Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); + + // Accept connections in the background + _ = AcceptConnectionsAsync(ct); + + return Task.CompletedTask; + } + + private async Task AcceptConnectionsAsync(CancellationToken ct) + { + try + { + while (!ct.IsCancellationRequested && !_disposed) + { + var clientSocket = await _serverSocket!.AcceptAsync(ct).ConfigureAwait(false); + Console.Error.WriteLine("[TerminalHost] Client connected"); + + _ = HandleClientAsync(clientSocket, ct); + } + } + catch (OperationCanceledException) { } + catch (ObjectDisposedException) { } + } + + private async Task HandleClientAsync(Socket clientSocket, CancellationToken ct) + { + var stream = new NetworkStream(clientSocket, ownsSocket: true); + var writer = new TerminalFrameWriter(stream); + var reader = new TerminalFrameReader(stream); + + var outputChannel = Channel.CreateBounded(new BoundedChannelOptions(1000) + { + FullMode = BoundedChannelFullMode.DropOldest, + SingleReader = true, + SingleWriter = false + }); + + var session = new ClientSession(stream, writer, reader, outputChannel); + + // Replace any existing session (single client at a time) + ClientSession? oldSession; + lock (_sessionLock) + { + oldSession = _activeSession; + _activeSession = session; + } + + if (oldSession is not null) + { + await oldSession.DisposeAsync().ConfigureAwait(false); + } + + try + { + // Send HELLO + var flags = TerminalProtocol.HelloFlags.Pty | TerminalProtocol.HelloFlags.Replay; + await writer.WriteHelloAsync( + (ushort)_currentWidth, + (ushort)_currentHeight, + flags, + ct).ConfigureAwait(false); + + // Snapshot and send current terminal state + if (_terminal is not null) + { + using var snapshot = _terminal.CreateSnapshot(); + var ansi = snapshot.ToAnsi(new TerminalAnsiOptions + { + IncludeClearScreen = true, + IncludeCursorPosition = true, + }); + var ansiBytes = Encoding.UTF8.GetBytes(ansi); + await writer.WriteDataAsync(ansiBytes, ct).ConfigureAwait(false); + } + + using var sessionCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); + + // Stream output from channel to client + var outputTask = Task.Run(async () => + { + try + { + await foreach (var data in outputChannel.Reader.ReadAllAsync(sessionCts.Token).ConfigureAwait(false)) + { + await writer.WriteDataAsync(data, sessionCts.Token).ConfigureAwait(false); + } + } + catch (OperationCanceledException) { } + catch (IOException) { } + }, sessionCts.Token); + + // Read input from client and forward to terminal + var inputTask = Task.Run(async () => + { + try + { + while (!sessionCts.Token.IsCancellationRequested) + { + var frame = await reader.ReadFrameAsync(sessionCts.Token).ConfigureAwait(false); + if (frame is null) + { + break; // Client disconnected + } + + switch (frame.Value.Type) + { + case TerminalProtocol.MessageType.Data: + // Forward input to terminal + if (_terminal is not null) + { + await _terminal.SendInputAsync(frame.Value.Payload, sessionCts.Token).ConfigureAwait(false); + } + break; + + case TerminalProtocol.MessageType.Resize: + var (cols, rows) = frame.Value.ParseResize(); + _terminal?.Resize(cols, rows); + break; + + case TerminalProtocol.MessageType.Close: + return; + } + } + } + catch (OperationCanceledException) { } + catch (IOException) { } + }, sessionCts.Token); + + await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); + await sessionCts.CancelAsync().ConfigureAwait(false); + + try { await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); } + catch (OperationCanceledException) { } + } + catch (OperationCanceledException) { } + catch (IOException) { } + finally + { + lock (_sessionLock) + { + if (_activeSession == session) + { + _activeSession = null; + } + } + + await session.DisposeAsync().ConfigureAwait(false); + Console.Error.WriteLine("[TerminalHost] Client disconnected"); + } + } + + #region IHex1bTerminalPresentationFilter + + public ValueTask OnSessionStartAsync(int width, int height, DateTimeOffset timestamp, CancellationToken ct = default) + { + _currentWidth = width; + _currentHeight = height; + return ValueTask.CompletedTask; + } + + public ValueTask> OnOutputAsync(IReadOnlyList appliedTokens, TimeSpan elapsed, CancellationToken ct = default) + { + var tokens = appliedTokens.Select(t => t.Token).ToList(); + + // Broadcast output to the active client session + lock (_sessionLock) + { + if (_activeSession is not null) + { + var ansi = AnsiTokenSerializer.Serialize(tokens); + if (ansi.Length > 0) + { + var bytes = Encoding.UTF8.GetBytes(ansi); + _activeSession.OutputChannel.Writer.TryWrite(bytes); + } + } + } + + return ValueTask.FromResult>(tokens); + } + + public ValueTask OnInputAsync(IReadOnlyList tokens, TimeSpan elapsed, CancellationToken ct = default) + { + return ValueTask.CompletedTask; + } + + public ValueTask OnResizeAsync(int width, int height, TimeSpan elapsed, CancellationToken ct = default) + { + _currentWidth = width; + _currentHeight = height; + return ValueTask.CompletedTask; + } + + public ValueTask OnSessionEndAsync(TimeSpan elapsed, CancellationToken ct = default) + { + return ValueTask.CompletedTask; + } + + #endregion + + public async ValueTask DisposeAsync() + { + if (_disposed) + { + return; + } + + _disposed = true; + await _disposeCts.CancelAsync().ConfigureAwait(false); + + lock (_sessionLock) + { + _activeSession?.OutputChannel.Writer.TryComplete(); + } + + _serverSocket?.Dispose(); + + if (File.Exists(_socketPath)) + { + try { File.Delete(_socketPath); } + catch { /* ignore */ } + } + + _disposeCts.Dispose(); + } + + private sealed class ClientSession( + NetworkStream stream, + TerminalFrameWriter writer, + TerminalFrameReader reader, + Channel outputChannel) : IAsyncDisposable + { + public TerminalFrameWriter Writer => writer; + public TerminalFrameReader Reader => reader; + public Channel OutputChannel => outputChannel; + + public ValueTask DisposeAsync() + { + outputChannel.Writer.TryComplete(); + stream.Dispose(); + return ValueTask.CompletedTask; + } + } +} From a62f2aa57f6baf4b1f09c27e2695f1fe7c9e5612 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 4 May 2026 17:10:56 +1000 Subject: [PATCH 11/20] WithTerminal Phase 1: refactor to per-replica UDS pair design MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Refactor the WithTerminal API to match the new architecture decided for the 13.4 end-to-end work: - TerminalAnnotation: drop SocketPath / SocketPathProvider; carry a strong reference to the hidden TerminalHostResource and the user-supplied TerminalOptions instead. The host owns its own UDS layout. - TerminalHostResource: now public and derives from ExecutableResource so DCP launches it as a regular hidden executable. Carries a Parent reference plus the per-resource TerminalHostLayout. Constructed with a placeholder command (UnresolvedCommand) so we can rewrite it later. - TerminalHostLayout (new): per-resource, per-run UDS layout — N producer paths under {tmp}/aspire-term-{guid}/dcp/, N consumer paths under host/, and one control.sock. Built via Directory.CreateTempSubdirectory per the repo temp-directory convention. - TerminalHostEventingSubscriber (new): subscribes to BeforeStartEvent and resolves the real terminal host binary from DcpOptions.TerminalHostPath before DCP launches the resource. Emits a warning if the path is unset or if the parent's replica count drifted between WithTerminal() and start. Registered via TryAddEventingSubscriber in the builder. - TerminalResourceBuilderExtensions: single overload, eager UDS layout, hidden host as ExecutableResource, args wired via a callback (--replica-count, --producer-uds xN, --consumer-uds xN, --control-uds, --columns, --rows, --shell). Adds a WaitAnnotation on the host (WaitUntilStarted for now; Phase 2 will upgrade to WaitUntilHealthy once the host exposes a health probe). Throws on double WithTerminal call. - Stub leftovers in ExecutableCreator, AuxiliaryBackchannelRpcTarget, and DashboardServiceData for proper wire-up in Phases 4/5/7. Each stub is marked with a comment. - Update WithTerminalTests to cover the new design (15 tests, all green). - Drop playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs and stub Terminals.AppHost itself; full playground rebuild lands in Phase 8. - Add a GetTerminalInfoAsync stub on TestAppHostAuxiliaryBackchannel so the CLI test fake satisfies the interface. Build is green with /p:SkipNativeBuild=true. WithTerminalTests pass 15/15. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Terminals/Terminals.AppHost/AppHost.cs | 12 +- .../Terminals.AppHost/TerminalDemoResource.cs | 174 ------------ .../ApplicationModel/TerminalAnnotation.cs | 46 ++-- .../ApplicationModel/TerminalHostLayout.cs | 103 ++++++++ .../ApplicationModel/TerminalHostResource.cs | 46 +++- .../AuxiliaryBackchannelRpcTarget.cs | 8 +- .../Dashboard/DashboardServiceData.cs | 12 +- src/Aspire.Hosting/Dcp/ExecutableCreator.cs | 7 +- .../DistributedApplicationBuilder.cs | 3 + .../TerminalHostEventingSubscriber.cs | 97 +++++++ .../TerminalResourceBuilderExtensions.cs | 248 ++++++------------ .../TestAppHostAuxiliaryBackchannel.cs | 10 + .../Aspire.Hosting.Tests/WithTerminalTests.cs | 158 +++++++++-- 13 files changed, 508 insertions(+), 416 deletions(-) delete mode 100644 playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs create mode 100644 src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs create mode 100644 src/Aspire.Hosting/Lifecycle/TerminalHostEventingSubscriber.cs diff --git a/playground/Terminals/Terminals.AppHost/AppHost.cs b/playground/Terminals/Terminals.AppHost/AppHost.cs index fd73db7a8aa..cd6d25f27c6 100644 --- a/playground/Terminals/Terminals.AppHost/AppHost.cs +++ b/playground/Terminals/Terminals.AppHost/AppHost.cs @@ -1,16 +1,12 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. -using Terminals.AppHost; - var builder = DistributedApplication.CreateBuilder(args); -// Add a terminal demo resource that runs a Hex1b-hosted shell session. -// The terminal host process receives the UDS path via environment variable, -// creates a Hex1b terminal with a custom presentation adapter, and bridges -// client connections over the socket to the shell's PTY. -// This demonstrates the full WithTerminal flow without requiring DCP PTY support. -builder.AddTerminalDemo("demo-shell"); +// Phase 8 of the WithTerminal work will rewrite this playground to demonstrate +// the new DCP-driven terminal flow against both an executable and a container. +// For now this is a no-op placeholder so the playground keeps building during +// Phase 1 (app-model refactor). #if !SKIP_DASHBOARD_REFERENCE // This project is only added in playground projects to support development/debugging diff --git a/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs b/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs deleted file mode 100644 index 7ceeb7f899e..00000000000 --- a/playground/Terminals/Terminals.AppHost/TerminalDemoResource.cs +++ /dev/null @@ -1,174 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Diagnostics; -using System.Globalization; -using Microsoft.Extensions.Logging; - -namespace Terminals.AppHost; - -/// -/// A custom resource that represents an interactive terminal session backed by -/// the Terminals.TerminalHost process. The terminal host runs Hex1b with a PTY -/// shell and serves the Aspire Terminal Protocol over a Unix domain socket. -/// -public sealed class TerminalDemoResource(string name) : Resource(name), IResourceWithWaitSupport; - -/// -/// Extension methods for adding terminal demo resources to the application builder. -/// -public static class TerminalDemoExtensions -{ - /// - /// Adds a terminal demo resource that launches a Hex1b-hosted shell session. - /// The terminal host process receives the UDS path via environment variable - /// and implements the Aspire Terminal Protocol for client connections. - /// - [AspireExportIgnore(Reason = "Playground-only terminal demo resource; not part of the supported ATS surface.")] - public static IResourceBuilder AddTerminalDemo( - this IDistributedApplicationBuilder builder, - string name) - { - var resource = new TerminalDemoResource(name); - - // Generate a UDS path for this terminal session - var socketDir = Path.Combine(Path.GetTempPath(), "aspire-terminals"); - Directory.CreateDirectory(socketDir); - var socketPath = Path.Combine(socketDir, $"{name}-{Environment.ProcessId}.sock"); - - // Find the terminal host project executable - var terminalHostProject = FindTerminalHostProject(); - - var resourceBuilder = builder.AddResource(resource) - .ExcludeFromManifest() - .WithInitialState(new CustomResourceSnapshot - { - ResourceType = "TerminalDemo", - CreationTimeStamp = DateTime.UtcNow, - State = KnownResourceStates.NotStarted, - Properties = - [ - new(CustomResourceKnownProperties.Source, "Terminal Demo"), - new("terminal.socketPath", socketPath) - ] - }) - .WithTerminal(_ => Task.FromResult(socketPath)); - - // Use OnInitializeResource to launch the terminal host process and manage its lifecycle. - // This replaces what DCP would normally do (PTY allocation + UDS forwarding). - resourceBuilder.OnInitializeResource(async (resource, @event, token) => - { - var log = @event.Logger; - var notification = @event.Notifications; - var eventing = @event.Eventing; - var services = @event.Services; - - await eventing.PublishAsync(new BeforeResourceStartedEvent(resource, services), token); - - log.LogInformation("Starting terminal host: {Project}", terminalHostProject); - log.LogInformation("Terminal socket: {SocketPath}", socketPath); - - // Store the socket path in the terminal annotation - if (resource.Annotations.OfType().FirstOrDefault() is { } terminalAnnotation) - { - terminalAnnotation.SocketPath = socketPath; - } - - // Launch the terminal host as a child process - var psi = new ProcessStartInfo("dotnet", ["run", "--project", terminalHostProject]) - { - UseShellExecute = false, - RedirectStandardOutput = true, - RedirectStandardError = true, - Environment = - { - ["TERMINAL_SOCKET_PATH"] = socketPath, - ["TERMINAL_COLUMNS"] = "120", - ["TERMINAL_ROWS"] = "30", - } - }; - - var process = Process.Start(psi); - if (process is null) - { - await notification.PublishUpdateAsync(resource, s => s with - { - State = KnownResourceStates.FailedToStart - }); - return; - } - - // Forward stderr to resource logs - _ = Task.Run(async () => - { - while (!process.HasExited && !token.IsCancellationRequested) - { - var line = await process.StandardError.ReadLineAsync(token); - if (line is not null) - { - log.LogInformation("{Line}", line); - } - } - }, token); - - await notification.PublishUpdateAsync(resource, s => s with - { - StartTimeStamp = DateTime.UtcNow, - State = KnownResourceStates.Running, - Properties = - [ - .. s.Properties, - new("terminal.pid", process.Id.ToString(CultureInfo.InvariantCulture)) - ] - }); - - try - { - await process.WaitForExitAsync(token); - } - catch (OperationCanceledException) - { - if (!process.HasExited) - { - process.Kill(entireProcessTree: true); - } - } - - await notification.PublishUpdateAsync(resource, s => s with - { - State = KnownResourceStates.Exited, - ExitCode = process.ExitCode - }); - }); - - return resourceBuilder; - } - - private static string FindTerminalHostProject() - { - // Walk up from the AppHost's directory to find the sibling TerminalHost project - var appHostDir = AppContext.BaseDirectory; - var current = new DirectoryInfo(appHostDir); - - while (current is not null) - { - var candidate = Path.Combine(current.FullName, "playground", "Terminals", "Terminals.TerminalHost", "Terminals.TerminalHost.csproj"); - if (File.Exists(candidate)) - { - return candidate; - } - - // Also check sibling directory (for when running from bin output) - var sibling = Path.Combine(current.FullName, "Terminals.TerminalHost", "Terminals.TerminalHost.csproj"); - if (File.Exists(sibling)) - { - return sibling; - } - - current = current.Parent; - } - - // Fallback: assume relative path from working directory - return Path.GetFullPath(Path.Combine("..", "Terminals.TerminalHost", "Terminals.TerminalHost.csproj")); - } -} diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs index e2eab39ada1..5d0e79ec78a 100644 --- a/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs +++ b/src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs @@ -6,39 +6,47 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents terminal configuration for a resource that supports interactive terminal sessions. +/// Marks a resource as having an interactive terminal session. /// /// -/// When this annotation is present on a resource, the orchestrator will allocate a pseudo-terminal (PTY) -/// for the resource's process and make it available for interactive access via a Unix domain socket. +/// +/// When this annotation is present on a resource, the orchestrator (DCP) allocates a +/// pseudo-terminal (PTY) per replica and a hidden bridges +/// the PTY traffic over Hex1b's HMP v1 protocol so that the Aspire Dashboard and the +/// aspire terminal CLI command can attach to live sessions. +/// +/// +/// The set of Unix domain socket paths used to wire DCP, the host, and viewers together is +/// described by on the resource referenced by +/// . +/// /// -[DebuggerDisplay("Type = {GetType().Name,nq}, SocketPath = {SocketPath}")] +[DebuggerDisplay("Type = {GetType().Name,nq}, TerminalHost = {TerminalHost.Name}")] public sealed class TerminalAnnotation : IResourceAnnotation { /// - /// Gets or sets the path to the Unix domain socket used for terminal I/O. + /// Initializes a new instance of the class. /// - /// - /// This path is set by the orchestrator when the terminal host is started, - /// or resolved from for custom terminal resources. - /// Clients connect to this socket to interact with the resource's terminal session. - /// - public string? SocketPath { get; set; } + /// The hidden terminal host resource that bridges PTY traffic for the annotated resource. + /// The terminal options for this annotation. + public TerminalAnnotation(TerminalHostResource terminalHost, TerminalOptions options) + { + ArgumentNullException.ThrowIfNull(terminalHost); + ArgumentNullException.ThrowIfNull(options); + + TerminalHost = terminalHost; + Options = options; + } /// - /// Gets or sets an optional callback that provides the UDS socket path. + /// Gets the hidden terminal host resource that bridges PTY traffic for the annotated resource. /// - /// - /// Used by custom terminal resources that manage their own terminal server. - /// When set, the orchestrator calls this during resource initialization to obtain the socket path - /// instead of creating a hidden terminal host resource. - /// - public Func>? SocketPathProvider { get; set; } + public TerminalHostResource TerminalHost { get; } /// /// Gets the terminal options for this annotation. /// - public TerminalOptions Options { get; init; } = new(); + public TerminalOptions Options { get; } } /// diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs b/src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs new file mode 100644 index 00000000000..d764b8d6f77 --- /dev/null +++ b/src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs @@ -0,0 +1,103 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Diagnostics; + +namespace Aspire.Hosting.ApplicationModel; + +/// +/// Describes the Unix domain socket layout used by a to +/// bridge per-replica PTY traffic between DCP and clients (Dashboard, CLI). +/// +/// +/// +/// For a target resource with N replicas, the layout owns 2N + 1 stable +/// socket paths under a per-run temporary directory: +/// +/// +/// +/// +/// {base}/dcp/r{i}.sock — the producer socket for replica i. DCP listens +/// on this path and the terminal host connects as an HMP v1 client to consume PTY output +/// and forward input. +/// +/// +/// +/// +/// {base}/host/r{i}.sock — the consumer socket for replica i. The terminal +/// host listens on this path as an HMP v1 server and viewers (Dashboard, CLI) connect to +/// attach. +/// +/// +/// +/// +/// {base}/control.sock — a single control socket that the terminal host listens on +/// for the AppHost backchannel to query the live replica list and request shutdown. +/// +/// +/// +/// +[DebuggerDisplay("Type = {GetType().Name,nq}, ReplicaCount = {ReplicaCount}, BaseDirectory = {BaseDirectory}")] +public sealed class TerminalHostLayout +{ + /// + /// Initializes a new instance of the class. + /// + /// The base directory that owns all socket paths in this layout. + /// The producer (DCP-listens-on) UDS path for each replica. + /// The consumer (host-listens-on) UDS path for each replica. + /// The control UDS path for AppHost ↔ terminal host RPC. + public TerminalHostLayout(string baseDirectory, IReadOnlyList producerUdsPaths, IReadOnlyList consumerUdsPaths, string controlUdsPath) + { + ArgumentException.ThrowIfNullOrEmpty(baseDirectory); + ArgumentNullException.ThrowIfNull(producerUdsPaths); + ArgumentNullException.ThrowIfNull(consumerUdsPaths); + ArgumentException.ThrowIfNullOrEmpty(controlUdsPath); + + if (producerUdsPaths.Count == 0) + { + throw new ArgumentException("At least one producer UDS path is required.", nameof(producerUdsPaths)); + } + + if (producerUdsPaths.Count != consumerUdsPaths.Count) + { + throw new ArgumentException( + $"Producer ({producerUdsPaths.Count}) and consumer ({consumerUdsPaths.Count}) UDS path counts must match.", + nameof(consumerUdsPaths)); + } + + BaseDirectory = baseDirectory; + ProducerUdsPaths = producerUdsPaths; + ConsumerUdsPaths = consumerUdsPaths; + ControlUdsPath = controlUdsPath; + } + + /// + /// Gets the number of replicas this layout was sized for. Equal to the length of + /// and . + /// + public int ReplicaCount => ProducerUdsPaths.Count; + + /// + /// Gets the base directory that owns the socket paths in this layout. + /// + public string BaseDirectory { get; } + + /// + /// Gets the producer UDS path for each replica. DCP listens on these paths and the + /// terminal host connects to them as an HMP v1 client. + /// + public IReadOnlyList ProducerUdsPaths { get; } + + /// + /// Gets the consumer UDS path for each replica. The terminal host listens on these paths + /// as an HMP v1 server and viewers connect to them. + /// + public IReadOnlyList ConsumerUdsPaths { get; } + + /// + /// Gets the control UDS path. The terminal host listens on this path for AppHost RPC + /// (replica enumeration, shutdown). + /// + public string ControlUdsPath { get; } +} diff --git a/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs b/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs index 61a9653af87..452c6b1e992 100644 --- a/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs +++ b/src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs @@ -1,33 +1,59 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System.Diagnostics; + namespace Aspire.Hosting.ApplicationModel; /// -/// A hidden resource that manages the terminal host process for a parent resource. +/// A hidden, DCP-launched executable resource that bridges per-replica PTY traffic between +/// DCP (the producer) and viewers like the Aspire Dashboard and the aspire terminal +/// CLI command (the consumers) using Hex1b's HMP v1 muxer. /// /// -/// The terminal host process uses Hex1b to maintain a headless terminal state and serves -/// as the bridge between DCP's PTY forwarding and clients (Dashboard, CLI) that connect -/// via Unix domain socket. One terminal host is created per resource that has -/// applied. +/// +/// One instance is created for each target resource that +/// is configured with . +/// +/// +/// Because derives from , DCP +/// launches it like any other executable, which keeps the host process out-of-process and +/// isolates PTY state from the AppHost. The actual binary path is resolved during +/// from . +/// /// -internal sealed class TerminalHostResource : Resource, IResourceWithParent, IResourceWithWaitSupport +[DebuggerDisplay("Type = {GetType().Name,nq}, Name = {Name}, Parent = {Parent.Name}, ReplicaCount = {Layout.ReplicaCount}")] +public sealed class TerminalHostResource : ExecutableResource, IResourceWithParent { + // The host is created before its real binary path is known (DcpOptions is not yet + // configured at WithTerminal time). A BeforeStartEvent subscriber rewrites the + // ExecutableAnnotation.Command before DCP launches the resource. This sentinel makes + // misconfiguration easy to spot if the BeforeStart hook is somehow skipped. + internal const string UnresolvedCommand = ""; + /// /// Initializes a new instance of the class. /// /// The name of the terminal host resource. - /// The resource that this terminal host serves. - public TerminalHostResource(string name, IResource parent) - : base(name) + /// The target resource that this terminal host serves. + /// The Unix domain socket layout this host will own. + public TerminalHostResource(string name, IResource parent, TerminalHostLayout layout) + : base(name, UnresolvedCommand, layout?.BaseDirectory ?? string.Empty) { ArgumentNullException.ThrowIfNull(parent); + ArgumentNullException.ThrowIfNull(layout); + Parent = parent; + Layout = layout; } /// - /// Gets the parent resource that this terminal host serves. + /// Gets the target resource that this terminal host serves. /// public IResource Parent { get; } + + /// + /// Gets the Unix domain socket layout this host owns. + /// + public TerminalHostLayout Layout { get; } } diff --git a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs index 73cfc0e372f..5b892d50192 100644 --- a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs +++ b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs @@ -264,8 +264,12 @@ public Task GetTerminalInfoAsync(GetTerminalInfoRequest return Task.FromResult(new GetTerminalInfoResponse { - IsAvailable = !string.IsNullOrEmpty(terminalAnnotation.SocketPath), - SocketPath = terminalAnnotation.SocketPath, + // Phase 5 of WithTerminal will populate per-replica info (consumer UDS + // paths from TerminalAnnotation.TerminalHost.Layout) over the host's + // control UDS. Until that work lands the response shape only carries + // the legacy single-socket fields, so we report unavailable rather than + // mis-route a stale path that the new host design no longer publishes. + IsAvailable = false, Columns = terminalAnnotation.Options.Columns, Rows = terminalAnnotation.Options.Rows }); diff --git a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs index f9e2ea307b3..e0e2ff35a50 100644 --- a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs +++ b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs @@ -51,14 +51,10 @@ static GenericResourceSnapshot CreateResourceSnapshot(IResource resource, string new ResourcePropertySnapshot(KnownProperties.Terminal.Enabled, "true") { IsSensitive = false }) }; - if (terminalAnnotation.SocketPath is not null) - { - snapshot = snapshot with - { - Properties = snapshot.Properties.Add( - new ResourcePropertySnapshot(KnownProperties.Terminal.SocketPath, terminalAnnotation.SocketPath) { IsSensitive = false }) - }; - } + // Phase 7 of WithTerminal replaces this single-socket property with + // a per-replica view sourced from TerminalAnnotation.TerminalHost.Layout + // and routed through the dashboard backchannel; the snapshot just + // signals availability for now. } return new GenericResourceSnapshot(snapshot) diff --git a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs index 5200e2ee008..c51876558d1 100644 --- a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs +++ b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs @@ -105,7 +105,11 @@ public async Task CreateObjectAsync(RenderedModelResource er, EmptyC spec.Env = configuration.EnvironmentVariables.Select(kvp => new EnvVar { Name = kvp.Key, Value = kvp.Value }).ToList(); - // Configure terminal spec if the resource has a TerminalAnnotation + // Configure terminal spec if the resource has a TerminalAnnotation. + // Phase 4 of WithTerminal will populate per-replica TerminalSpec values from + // TerminalAnnotation.TerminalHost.Layout.ProducerUdsPaths[replicaIndex]; the + // current ExecutableSpec.Terminal shape (single SocketPath) is being replaced + // with per-replica routing in DCP, so we leave the spec unset here for now. if (er.ModelResource.TryGetAnnotationsOfType(out var terminalAnnotations)) { var terminalAnnotation = terminalAnnotations.FirstOrDefault(); @@ -114,7 +118,6 @@ public async Task CreateObjectAsync(RenderedModelResource er, EmptyC spec.Terminal = new TerminalSpec { Enabled = true, - SocketPath = terminalAnnotation.SocketPath, Columns = terminalAnnotation.Options.Columns, Rows = terminalAnnotation.Options.Rows }; diff --git a/src/Aspire.Hosting/DistributedApplicationBuilder.cs b/src/Aspire.Hosting/DistributedApplicationBuilder.cs index afc2733b512..6f92e6d5560 100644 --- a/src/Aspire.Hosting/DistributedApplicationBuilder.cs +++ b/src/Aspire.Hosting/DistributedApplicationBuilder.cs @@ -487,6 +487,9 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options) _innerBuilder.Services.TryAddSingleton(); #pragma warning restore ASPIRECOMMAND001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed. _innerBuilder.Services.TryAddEventingSubscriber(); + + // Terminal host binary path resolution (WithTerminal) + _innerBuilder.Services.TryAddEventingSubscriber(); } if (ExecutionContext.IsRunMode) diff --git a/src/Aspire.Hosting/Lifecycle/TerminalHostEventingSubscriber.cs b/src/Aspire.Hosting/Lifecycle/TerminalHostEventingSubscriber.cs new file mode 100644 index 00000000000..af024a6b99b --- /dev/null +++ b/src/Aspire.Hosting/Lifecycle/TerminalHostEventingSubscriber.cs @@ -0,0 +1,97 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Hosting.ApplicationModel; +using Aspire.Hosting.Dcp; +using Aspire.Hosting.Eventing; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; + +namespace Aspire.Hosting.Lifecycle; + +/// +/// Resolves the path to the aspire.terminalhost binary on each +/// before DCP launches it. The resource is created +/// during WithTerminal() with a placeholder command because +/// is not yet configured at that point; this subscriber +/// finalises the executable command before completes +/// and DCP picks the resource up. +/// +internal sealed class TerminalHostEventingSubscriber( + IOptions dcpOptions, + ILogger logger) : IDistributedApplicationEventingSubscriber +{ + private readonly IOptions _dcpOptions = dcpOptions ?? throw new ArgumentNullException(nameof(dcpOptions)); + private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + + /// + public Task SubscribeAsync(IDistributedApplicationEventing eventing, DistributedApplicationExecutionContext executionContext, CancellationToken cancellationToken) + { + ArgumentNullException.ThrowIfNull(eventing); + eventing.Subscribe(ResolveTerminalHostsAsync); + return Task.CompletedTask; + } + + private Task ResolveTerminalHostsAsync(BeforeStartEvent @event, CancellationToken cancellationToken) + { + var terminalHostPath = _dcpOptions.Value.TerminalHostPath; + + foreach (var host in @event.Model.Resources.OfType()) + { + ValidateReplicaCount(host); + + if (host.Annotations.OfType().LastOrDefault() is not { } annotation) + { + continue; + } + + if (annotation.Command != TerminalHostResource.UnresolvedCommand) + { + continue; + } + + if (string.IsNullOrEmpty(terminalHostPath)) + { + _logger.LogWarning( + "Terminal host binary path is not configured. The terminal for resource '{TargetName}' will not be available. Set ASPIRE_TERMINAL_HOST_PATH or ensure the Aspire SDK provides the 'aspireterminalhostpath' assembly metadata.", + host.Parent.Name); + continue; + } + + if (!File.Exists(terminalHostPath)) + { + _logger.LogWarning( + "Terminal host binary not found at '{TerminalHostPath}'. The terminal for resource '{TargetName}' will not be available.", + terminalHostPath, + host.Parent.Name); + continue; + } + + annotation.Command = terminalHostPath; + + _logger.LogDebug( + "Resolved terminal host '{HostName}' for target '{TargetName}' to '{TerminalHostPath}' with {ReplicaCount} replica(s).", + host.Name, + host.Parent.Name, + terminalHostPath, + host.Layout.ReplicaCount); + } + + return Task.CompletedTask; + } + + private void ValidateReplicaCount(TerminalHostResource host) + { + var declaredReplicas = host.Parent.Annotations.OfType().LastOrDefault()?.Replicas ?? 1; + + if (declaredReplicas != host.Layout.ReplicaCount) + { + _logger.LogWarning( + "Terminal host for '{TargetName}' was sized for {LayoutReplicas} replica(s) at WithTerminal() time but the resource now declares {DeclaredReplicas}. Call WithReplicas(...) before WithTerminal() to avoid this. Only the first {LayoutReplicas} replica(s) will have an attachable terminal.", + host.Parent.Name, + host.Layout.ReplicaCount, + declaredReplicas, + host.Layout.ReplicaCount); + } + } +} diff --git a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs index 81e0f0722b9..4c3b0e794d2 100644 --- a/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs +++ b/src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs @@ -1,10 +1,8 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System.Globalization; using Aspire.Hosting.ApplicationModel; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; -using Microsoft.Extensions.Options; namespace Aspire.Hosting; @@ -14,7 +12,7 @@ namespace Aspire.Hosting; public static class TerminalResourceBuilderExtensions { /// - /// Configures a resource to have an interactive terminal session. + /// Configures a resource to expose an interactive terminal session. /// /// The type of the resource. /// The resource builder. @@ -22,13 +20,17 @@ public static class TerminalResourceBuilderExtensions /// A reference to the for chaining additional configuration. /// /// - /// When a resource is configured with .WithTerminal(), the orchestrator allocates a pseudo-terminal (PTY) - /// for the resource's process and makes it available for interactive access. The terminal session can be accessed - /// from the Aspire Dashboard's "Terminal" tab or via the aspire terminal CLI command. + /// When a resource is configured with .WithTerminal(), DCP allocates a pseudo-terminal + /// (PTY) per replica and a hidden bridges the PTY traffic + /// over Hex1b's HMP v1 protocol. The terminal session can be accessed from the Aspire + /// Dashboard's terminal page or via the aspire terminal CLI command. /// /// - /// A hidden terminal host resource is created automatically to manage the terminal state using Hex1b. - /// The parent resource will wait for the terminal host to be ready before starting. + /// The set of socket paths used to wire DCP, the host, and viewers together is sized from + /// the target resource's . Call + /// WithReplicas(...) before WithTerminal(); if the replica count + /// changes after this call, only the first N replicas (where N was the count + /// at WithTerminal() time) will have an attachable terminal. /// /// /// @@ -39,9 +41,10 @@ public static class TerminalResourceBuilderExtensions /// /// /// - /// Add terminal support with custom dimensions: + /// Add terminal support with custom dimensions to a multi-replica resource: /// /// var agent = builder.AddExecutable("agent", "my-agent", ".") + /// .WithReplicas(3) /// .WithTerminal(options => /// { /// options.Columns = 200; @@ -55,90 +58,25 @@ public static IResourceBuilder WithTerminal(this IResourceBuilder build { ArgumentNullException.ThrowIfNull(builder); - var options = new TerminalOptions(); - configure?.Invoke(options); - - var annotation = new TerminalAnnotation + if (builder.Resource.Annotations.OfType().Any()) { - Options = options - }; - - builder.WithAnnotation(annotation); - - AddTerminalHostResource(builder); - - return builder; - } - - /// - /// Configures a resource with a custom terminal socket path provider. - /// - /// The type of the resource. - /// The resource builder. - /// - /// A callback that returns the UDS path for the terminal session. This is called during resource - /// initialization. Use this overload for resources that manage their own terminal host process - /// (e.g., remote resources, SSH sessions, or custom terminal bridges). - /// - /// An optional callback to configure the terminal options. - /// A reference to the for chaining additional configuration. - /// - /// Unlike the parameterless overload, - /// this method does not create a hidden terminal host resource. The caller is responsible for ensuring - /// a terminal server is listening on the provided socket path and speaking the Aspire Terminal Protocol. - /// - /// - /// Add terminal support with a custom socket path: - /// - /// var agent = builder.AddResource(new MyCustomResource("agent")) - /// .WithTerminal(ct => Task.FromResult("/tmp/my-terminal.sock")); - /// - /// - [AspireExportIgnore(Reason = "Func delegate parameter is not ATS-compatible.")] - public static IResourceBuilder WithTerminal( - this IResourceBuilder builder, - Func> socketPathProvider, - Action? configure = null) - where T : IResource - { - ArgumentNullException.ThrowIfNull(builder); - ArgumentNullException.ThrowIfNull(socketPathProvider); + throw new InvalidOperationException( + $"Resource '{builder.Resource.Name}' already has a terminal configured. Call WithTerminal() only once per resource."); + } var options = new TerminalOptions(); configure?.Invoke(options); - var annotation = new TerminalAnnotation - { - Options = options, - SocketPathProvider = socketPathProvider - }; - - builder.WithAnnotation(annotation); - - // No hidden terminal host resource — the caller manages the terminal server. - - return builder; - } - - private static void AddTerminalHostResource(IResourceBuilder builder) - where T : IResource - { - var terminalHostName = $"{builder.Resource.Name}-terminal-host"; - var terminalHost = new TerminalHostResource(terminalHostName, builder.Resource); + var replicaCount = builder.Resource.Annotations.OfType().LastOrDefault()?.Replicas ?? 1; + var layout = CreateTerminalHostLayout(replicaCount); - // Generate a UDS path for this terminal session - var socketDir = Path.Combine(Path.GetTempPath(), "aspire-terminals"); - Directory.CreateDirectory(socketDir); - var socketPath = Path.Combine(socketDir, $"{builder.Resource.Name}-{Environment.ProcessId}.sock"); + var terminalHostName = $"{builder.Resource.Name}-terminalhost"; + var terminalHost = new TerminalHostResource(terminalHostName, builder.Resource, layout); - // Store the socket path on the terminal annotation - var terminalAnnotation = builder.Resource.Annotations.OfType().First(); - terminalAnnotation.SocketPath = socketPath; + builder.WithAnnotation(new TerminalAnnotation(terminalHost, options)); var terminalHostBuilder = builder.ApplicationBuilder.AddResource(terminalHost); - var options = terminalAnnotation.Options; - terminalHostBuilder .WithInitialState(new CustomResourceSnapshot { @@ -147,111 +85,77 @@ private static void AddTerminalHostResource(IResourceBuilder builder) Properties = [], IsHidden = true, }) - .ExcludeFromManifest(); - - // Set up the terminal host lifecycle: when the resource initializes, - // resolve the terminal host binary path and launch it via DCP. - terminalHostBuilder.OnInitializeResource(async (resource, @event, token) => - { - var dcpOptions = @event.Services.GetService>(); - var notification = @event.Notifications; - var log = @event.Logger; - - var terminalHostPath = dcpOptions?.Value.TerminalHostPath; - if (string.IsNullOrEmpty(terminalHostPath)) + .ExcludeFromManifest() + .WithArgs(context => { - log.LogWarning("Terminal host binary path not configured. Terminal will not be available for resource '{ResourceName}'.", resource.Parent.Name); - await notification.PublishUpdateAsync(resource, s => s with - { - State = KnownResourceStates.FailedToStart - }).ConfigureAwait(false); - return; - } + context.Args.Add("--replica-count"); + context.Args.Add(layout.ReplicaCount.ToString(CultureInfo.InvariantCulture)); - if (!File.Exists(terminalHostPath)) - { - log.LogWarning("Terminal host binary not found at '{Path}'. Build Aspire.TerminalHost first.", terminalHostPath); - await notification.PublishUpdateAsync(resource, s => s with + foreach (var path in layout.ProducerUdsPaths) { - State = KnownResourceStates.FailedToStart - }).ConfigureAwait(false); - return; - } - - log.LogInformation("Starting terminal host for '{ResourceName}' at {SocketPath}", resource.Parent.Name, socketPath); + context.Args.Add("--producer-uds"); + context.Args.Add(path); + } - // Launch the terminal host process - var psi = new System.Diagnostics.ProcessStartInfo(terminalHostPath) - { - UseShellExecute = false, - RedirectStandardError = true, - Environment = + foreach (var path in layout.ConsumerUdsPaths) { - ["TERMINAL_SOCKET_PATH"] = socketPath, - ["TERMINAL_COLUMNS"] = options.Columns.ToString(System.Globalization.CultureInfo.InvariantCulture), - ["TERMINAL_ROWS"] = options.Rows.ToString(System.Globalization.CultureInfo.InvariantCulture), + context.Args.Add("--consumer-uds"); + context.Args.Add(path); } - }; - if (options.Shell is not null) - { - psi.Environment["TERMINAL_SHELL"] = options.Shell; - } - - var process = System.Diagnostics.Process.Start(psi); - if (process is null) - { - log.LogError("Failed to start terminal host process"); - await notification.PublishUpdateAsync(resource, s => s with - { - State = KnownResourceStates.FailedToStart - }).ConfigureAwait(false); - return; - } + context.Args.Add("--control-uds"); + context.Args.Add(layout.ControlUdsPath); - // Forward stderr to resource logs - _ = Task.Run(async () => - { - while (!process.HasExited && !token.IsCancellationRequested) - { - var line = await process.StandardError.ReadLineAsync(token).ConfigureAwait(false); - if (line is not null) - { - log.LogInformation("{Line}", line); - } - } - }, token); + context.Args.Add("--columns"); + context.Args.Add(options.Columns.ToString(CultureInfo.InvariantCulture)); - await notification.PublishUpdateAsync(resource, s => s with - { - StartTimeStamp = DateTime.UtcNow, - State = KnownResourceStates.Running - }).ConfigureAwait(false); + context.Args.Add("--rows"); + context.Args.Add(options.Rows.ToString(CultureInfo.InvariantCulture)); - try - { - await process.WaitForExitAsync(token).ConfigureAwait(false); - } - catch (OperationCanceledException) - { - if (!process.HasExited) + if (!string.IsNullOrEmpty(options.Shell)) { - process.Kill(entireProcessTree: true); + context.Args.Add("--shell"); + context.Args.Add(options.Shell); } - } - await notification.PublishUpdateAsync(resource, s => s with - { - State = KnownResourceStates.Exited, - ExitCode = process.ExitCode - }).ConfigureAwait(false); - }); + return Task.CompletedTask; + }); - // The parent resource waits for the terminal host to be started so that - // the PTY forwarding infrastructure is in place before the process begins. + // The target waits until the host has started so its viewer-facing UDS listeners are + // bound before any consumer (Dashboard or CLI) tries to connect. Phase 2 will switch + // this to WaitUntilHealthy once the host implements a real health probe. if (builder.Resource is IResourceWithWaitSupport) { builder.WithAnnotation(new WaitAnnotation(terminalHost, WaitType.WaitUntilStarted)); } + + return builder; + } + + private static TerminalHostLayout CreateTerminalHostLayout(int replicaCount) + { + if (replicaCount <= 0) + { + throw new ArgumentOutOfRangeException(nameof(replicaCount), replicaCount, "Replica count must be at least 1."); + } + + // Use Directory.CreateTempSubdirectory so we get a securely-created, unique directory + // for each AppHost run. The guid in the directory name protects against collisions. + var baseDir = Directory.CreateTempSubdirectory("aspire-term-").FullName; + Directory.CreateDirectory(Path.Combine(baseDir, "dcp")); + Directory.CreateDirectory(Path.Combine(baseDir, "host")); + + var producerPaths = new string[replicaCount]; + var consumerPaths = new string[replicaCount]; + + for (var i = 0; i < replicaCount; i++) + { + producerPaths[i] = Path.Combine(baseDir, "dcp", $"r{i.ToString(CultureInfo.InvariantCulture)}.sock"); + consumerPaths[i] = Path.Combine(baseDir, "host", $"r{i.ToString(CultureInfo.InvariantCulture)}.sock"); + } + + var controlPath = Path.Combine(baseDir, "control.sock"); + + return new TerminalHostLayout(baseDir, producerPaths, consumerPaths, controlPath); } } diff --git a/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs b/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs index 58982867b2a..e6becd1a175 100644 --- a/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs +++ b/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs @@ -174,6 +174,16 @@ public Task CallResourceMcpToolAsync( return Task.FromResult(DashboardInfoResponse); } + /// + /// Gets or sets the terminal info response to return from GetTerminalInfoAsync. + /// + public GetTerminalInfoResponse TerminalInfoResponse { get; set; } = new GetTerminalInfoResponse { IsAvailable = false }; + + public Task GetTerminalInfoAsync(string resourceName, CancellationToken cancellationToken = default) + { + return Task.FromResult(TerminalInfoResponse); + } + public void Dispose() { // Nothing to dispose in the test implementation diff --git a/tests/Aspire.Hosting.Tests/WithTerminalTests.cs b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs index 41fc81338f5..7a6ae74f078 100644 --- a/tests/Aspire.Hosting.Tests/WithTerminalTests.cs +++ b/tests/Aspire.Hosting.Tests/WithTerminalTests.cs @@ -21,6 +21,7 @@ public void WithTerminalAddsTerminalAnnotation() Assert.Equal(120, annotation.Options.Columns); Assert.Equal(30, annotation.Options.Rows); Assert.Null(annotation.Options.Shell); + Assert.NotNull(annotation.TerminalHost); } [Fact] @@ -56,10 +57,26 @@ public void WithTerminalCreatesHiddenTerminalHostResource() var terminalHost = model.Resources.OfType().SingleOrDefault(); Assert.NotNull(terminalHost); - Assert.Equal("myapp-terminal-host", terminalHost.Name); + Assert.Equal("myapp-terminalhost", terminalHost.Name); Assert.Same(resource.Resource, terminalHost.Parent); } + [Fact] + public void WithTerminalLinksAnnotationToHostResource() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); + + resource.WithTerminal(); + + var app = builder.Build(); + var model = app.Services.GetRequiredService(); + + var annotation = resource.Resource.Annotations.OfType().Single(); + var hostFromModel = model.Resources.OfType().Single(); + Assert.Same(hostFromModel, annotation.TerminalHost); + } + [Fact] public void WithTerminalAddsWaitAnnotationForWaitSupportedResources() { @@ -101,7 +118,7 @@ public void WithTerminalWorksOnContainerResources() var terminalHost = model.Resources.OfType().SingleOrDefault(); Assert.NotNull(terminalHost); - Assert.Equal("mycontainer-terminal-host", terminalHost.Name); + Assert.Equal("mycontainer-terminalhost", terminalHost.Name); } [Fact] @@ -131,40 +148,139 @@ public void WithTerminalThrowsForNullBuilder() } [Fact] - public void WithTerminalCustomSocketPathDoesNotCreateTerminalHostResource() + public void WithTerminalThrowsWhenCalledTwiceOnSameResource() { using var builder = TestDistributedApplicationBuilder.Create(); var resource = builder.AddExecutable("myapp", "myapp", "."); - resource.WithTerminal(_ => Task.FromResult("/tmp/my-socket.sock")); + resource.WithTerminal(); - var app = builder.Build(); - var model = app.Services.GetRequiredService(); + Assert.Throws(() => resource.WithTerminal()); + } - // Custom socket path provider should NOT create a hidden terminal host - var terminalHost = model.Resources.OfType().SingleOrDefault(); - Assert.Null(terminalHost); + [Fact] + public void WithTerminalDefaultsToOneReplicaWorthOfPaths() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", "."); - // But the annotation should be present with the provider - var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); - Assert.NotNull(annotation); - Assert.NotNull(annotation.SocketPathProvider); + resource.WithTerminal(); + + var host = resource.Resource.Annotations.OfType().Single().TerminalHost; + Assert.Equal(1, host.Layout.ReplicaCount); + Assert.Single(host.Layout.ProducerUdsPaths); + Assert.Single(host.Layout.ConsumerUdsPaths); + Assert.NotEmpty(host.Layout.ControlUdsPath); } [Fact] - public async Task WithTerminalCustomSocketPathProviderReturnsPath() + public void WithTerminalAfterWithReplicasCreatesPathPerReplica() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", ".") + .WithAnnotation(new ReplicaAnnotation(3)); + + resource.WithTerminal(); + + var host = resource.Resource.Annotations.OfType().Single().TerminalHost; + Assert.Equal(3, host.Layout.ReplicaCount); + Assert.Equal(3, host.Layout.ProducerUdsPaths.Count); + Assert.Equal(3, host.Layout.ConsumerUdsPaths.Count); + + for (var i = 0; i < 3; i++) + { + Assert.EndsWith($"r{i}.sock", host.Layout.ProducerUdsPaths[i]); + Assert.EndsWith($"r{i}.sock", host.Layout.ConsumerUdsPaths[i]); + } + } + + [Fact] + public void TerminalHostLayoutPathsAreUnderTheSameTempBaseDirectory() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", ".") + .WithAnnotation(new ReplicaAnnotation(2)); + + resource.WithTerminal(); + + var layout = resource.Resource.Annotations.OfType().Single().TerminalHost.Layout; + + foreach (var path in layout.ProducerUdsPaths) + { + Assert.StartsWith(layout.BaseDirectory, path); + } + + foreach (var path in layout.ConsumerUdsPaths) + { + Assert.StartsWith(layout.BaseDirectory, path); + } + + Assert.StartsWith(layout.BaseDirectory, layout.ControlUdsPath); + } + + [Fact] + public async Task TerminalHostHasCommandLineArgsForLayoutPaths() + { + using var builder = TestDistributedApplicationBuilder.Create(); + var resource = builder.AddExecutable("myapp", "myapp", ".") + .WithAnnotation(new ReplicaAnnotation(2)); + + resource.WithTerminal(options => + { + options.Columns = 200; + options.Rows = 50; + options.Shell = "/bin/bash"; + }); + + var host = resource.Resource.Annotations.OfType().Single().TerminalHost; + var args = await GetResolvedCommandLineArgsAsync(host); + + Assert.Contains("--replica-count", args); + Assert.Contains("2", args); + + Assert.Equal(2, args.Count(a => a == "--producer-uds")); + Assert.Equal(2, args.Count(a => a == "--consumer-uds")); + Assert.Single(args, a => a == "--control-uds"); + + foreach (var path in host.Layout.ProducerUdsPaths) + { + Assert.Contains(path, args); + } + + foreach (var path in host.Layout.ConsumerUdsPaths) + { + Assert.Contains(path, args); + } + + Assert.Contains(host.Layout.ControlUdsPath, args); + + Assert.Contains("--columns", args); + Assert.Contains("200", args); + Assert.Contains("--rows", args); + Assert.Contains("50", args); + Assert.Contains("--shell", args); + Assert.Contains("/bin/bash", args); + } + + [Fact] + public void TerminalHostResourceHasUnresolvedCommandUntilBeforeStart() { using var builder = TestDistributedApplicationBuilder.Create(); var resource = builder.AddExecutable("myapp", "myapp", "."); - var expectedPath = "/tmp/custom-terminal.sock"; - resource.WithTerminal(_ => Task.FromResult(expectedPath)); + resource.WithTerminal(); - var annotation = resource.Resource.Annotations.OfType().SingleOrDefault(); - Assert.NotNull(annotation); - Assert.NotNull(annotation.SocketPathProvider); + var host = resource.Resource.Annotations.OfType().Single().TerminalHost; + Assert.Equal(TerminalHostResource.UnresolvedCommand, host.Command); + } - var actualPath = await annotation.SocketPathProvider(CancellationToken.None); - Assert.Equal(expectedPath, actualPath); + private static async Task> GetResolvedCommandLineArgsAsync(TerminalHostResource host) + { + var argsList = new List(); + foreach (var callbackAnnotation in host.Annotations.OfType()) + { + await callbackAnnotation.Callback(new CommandLineArgsCallbackContext(argsList, CancellationToken.None)); + } + return argsList.Select(a => a?.ToString() ?? string.Empty).ToList(); } } From d309bee85f73c781edabcfe899d1ab004ba561f3 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 4 May 2026 17:40:31 +1000 Subject: [PATCH 12/20] WithTerminal Phase 2: Aspire.TerminalHost on Hex1b HMP v1 Replaces the custom binary frame protocol with Hex1b 0.137 HMP v1 and adopts the per-replica UDS pair design from Phase 1. The host now creates one independent Hex1bTerminal per replica using WithHmp1UdsClient(producerUds[i]).WithHmp1UdsServer(consumerUds[i]). DCP runs the HMP v1 producer side; viewers (CLI / Dashboard) connect to the consumer side. State replay on reconnect is handled by Hex1b. A small StreamJsonRpc control listener on a separate UDS exposes GetReplicas() and Shutdown() so the AppHost backchannel can populate GetTerminalInfoAsync() without sharing the data plane. The host no longer auto-exits when all replicas exit -- DCP owns the host lifetime via cancellation or the control protocol. Removed: src/Shared/Terminal/* (custom protocol), TerminalSocketServer, UnixDomainSocketPresentationAdapter, playground/Terminals.TerminalHost. Added: tests/Aspire.TerminalHost.Tests with 17 tests (12 args, 5 app) covering arg parsing edge cases plus end-to-end control-listener + replica startup over real UDS sockets. All 17 pass on Windows. Phase 1 WithTerminalTests (15/15) still pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- Aspire.slnx | 2 + Directory.Packages.props | 6 +- .../Terminals.AppHost.csproj | 4 - .../Terminals/Terminals.Client/Program.cs | 158 --------- .../Terminals.Client/Terminals.Client.csproj | 14 - .../Terminals.TerminalHost/Program.cs | 66 ---- .../Terminals.TerminalHost.csproj | 20 -- .../UnixDomainSocketPresentationAdapter.cs | 204 ----------- src/Aspire.Cli/Aspire.Cli.csproj | 2 - src/Aspire.Cli/Commands/TerminalCommand.cs | 226 +----------- src/Aspire.Dashboard/Aspire.Dashboard.csproj | 2 - .../Terminal/TerminalWebSocketProxy.cs | 196 +---------- .../Aspire.TerminalHost.csproj | 9 +- src/Aspire.TerminalHost/Program.cs | 68 +--- .../StderrLoggerProvider.cs | 57 ++++ src/Aspire.TerminalHost/TerminalHostApp.cs | 230 +++++++++++++ src/Aspire.TerminalHost/TerminalHostArgs.cs | 154 +++++++++ .../TerminalHostControlListener.cs | 215 ++++++++++++ .../TerminalHostControlRpcTarget.cs | 55 +++ src/Aspire.TerminalHost/TerminalReplica.cs | 137 ++++++++ .../TerminalSocketServer.cs | 322 ------------------ .../UnixDomainSocketPresentationAdapter.cs | 204 ----------- .../Terminal/TerminalFrameReaderWriter.cs | 221 ------------ src/Shared/Terminal/TerminalProtocol.cs | 99 ------ .../TerminalHostControlProtocol.cs | 89 +++++ .../Aspire.TerminalHost.Tests.csproj | 38 +++ .../TerminalHostAppTests.cs | 207 +++++++++++ .../TerminalHostArgsTests.cs | 164 +++++++++ 28 files changed, 1387 insertions(+), 1782 deletions(-) delete mode 100644 playground/Terminals/Terminals.Client/Program.cs delete mode 100644 playground/Terminals/Terminals.Client/Terminals.Client.csproj delete mode 100644 playground/Terminals/Terminals.TerminalHost/Program.cs delete mode 100644 playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj delete mode 100644 playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs create mode 100644 src/Aspire.TerminalHost/StderrLoggerProvider.cs create mode 100644 src/Aspire.TerminalHost/TerminalHostApp.cs create mode 100644 src/Aspire.TerminalHost/TerminalHostArgs.cs create mode 100644 src/Aspire.TerminalHost/TerminalHostControlListener.cs create mode 100644 src/Aspire.TerminalHost/TerminalHostControlRpcTarget.cs create mode 100644 src/Aspire.TerminalHost/TerminalReplica.cs delete mode 100644 src/Aspire.TerminalHost/TerminalSocketServer.cs delete mode 100644 src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs delete mode 100644 src/Shared/Terminal/TerminalFrameReaderWriter.cs delete mode 100644 src/Shared/Terminal/TerminalProtocol.cs create mode 100644 src/Shared/TerminalHost/TerminalHostControlProtocol.cs create mode 100644 tests/Aspire.TerminalHost.Tests/Aspire.TerminalHost.Tests.csproj create mode 100644 tests/Aspire.TerminalHost.Tests/TerminalHostAppTests.cs create mode 100644 tests/Aspire.TerminalHost.Tests/TerminalHostArgsTests.cs diff --git a/Aspire.slnx b/Aspire.slnx index 4cb8040f922..9dcec37b371 100644 --- a/Aspire.slnx +++ b/Aspire.slnx @@ -78,6 +78,7 @@ + @@ -507,6 +508,7 @@ + diff --git a/Directory.Packages.props b/Directory.Packages.props index 8dc3cabab9f..4fcf9c4ac09 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -99,9 +99,9 @@ - - - + + + diff --git a/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj index e04b2b4e61b..f396eeea262 100644 --- a/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj +++ b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj @@ -16,8 +16,4 @@ - - - - diff --git a/playground/Terminals/Terminals.Client/Program.cs b/playground/Terminals/Terminals.Client/Program.cs deleted file mode 100644 index ae3bac6e7aa..00000000000 --- a/playground/Terminals/Terminals.Client/Program.cs +++ /dev/null @@ -1,158 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Net.Sockets; -using Aspire.Terminal; - -if (args.Length < 1) -{ - Console.Error.WriteLine("Usage: Terminals.Client "); - Console.Error.WriteLine(); - Console.Error.WriteLine("Connects to an Aspire Terminal Protocol server on the given UDS path."); - Console.Error.WriteLine("Ctrl+] to detach."); - return 1; -} - -var socketPath = args[0]; - -if (!File.Exists(socketPath)) -{ - Console.Error.WriteLine($"Socket not found: {socketPath}"); - return 1; -} - -Console.Error.WriteLine($"Connecting to {socketPath}..."); - -using var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); -await socket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath)); - -await using var stream = new NetworkStream(socket, ownsSocket: false); -var reader = new TerminalFrameReader(stream); -var writer = new TerminalFrameWriter(stream); - -// Read HELLO -var helloFrame = await reader.ReadFrameAsync(); -if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) -{ - Console.Error.WriteLine("Error: did not receive HELLO frame"); - return 1; -} - -var (version, cols, rows, flags) = helloFrame.Value.ParseHello(); -Console.Error.WriteLine($"Connected! Protocol v{version}, {cols}x{rows}, flags={flags}"); -Console.Error.WriteLine("Press Ctrl+] to detach."); -Console.Error.WriteLine(); - -using var cts = new CancellationTokenSource(); - -// Put console in raw mode -var originalMode = Console.TreatControlCAsInput; -Console.TreatControlCAsInput = true; - -try -{ - // Start reading output from server - var outputTask = Task.Run(async () => - { - try - { - while (!cts.Token.IsCancellationRequested) - { - var frame = await reader.ReadFrameAsync(cts.Token); - if (frame is null) - { - break; - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - using (var stdout = Console.OpenStandardOutput()) - { - await stdout.WriteAsync(frame.Value.Payload, cts.Token); - await stdout.FlushAsync(cts.Token); - } - break; - - case TerminalProtocol.MessageType.Exit: - var (exitCode, reason) = frame.Value.ParseExit(); - Console.Error.WriteLine($"\r\n[Terminal exited: code={exitCode}, reason={reason}]"); - await cts.CancelAsync(); - break; - - case TerminalProtocol.MessageType.Close: - Console.Error.WriteLine("\r\n[Server closed connection]"); - await cts.CancelAsync(); - break; - - case TerminalProtocol.MessageType.Resize: - var (newCols, newRows) = frame.Value.ParseResize(); - Console.Error.WriteLine($"\r\n[Server resized to {newCols}x{newRows}]"); - break; - } - } - } - catch (OperationCanceledException) { } - catch (IOException) { } - }, cts.Token); - - // Read input from local console and send to server - var inputTask = Task.Run(async () => - { - try - { - using var stdin = Console.OpenStandardInput(); - var buffer = new byte[256]; - - while (!cts.Token.IsCancellationRequested) - { - var bytesRead = await stdin.ReadAsync(buffer, cts.Token); - if (bytesRead == 0) - { - break; - } - - // Check for Ctrl+] (0x1D) to detach - for (var i = 0; i < bytesRead; i++) - { - if (buffer[i] == 0x1D) // Ctrl+] - { - Console.Error.WriteLine("\r\n[Detached]"); - await writer.WriteCloseAsync(cts.Token); - await cts.CancelAsync(); - return; - } - } - - await writer.WriteDataAsync(buffer.AsMemory(0, bytesRead), cts.Token); - } - } - catch (OperationCanceledException) { } - catch (IOException) { } - }, cts.Token); - - // Send initial resize based on current console size - if (!Console.IsInputRedirected) - { - try - { - await writer.WriteResizeAsync( - (ushort)Console.WindowWidth, - (ushort)Console.WindowHeight, - cts.Token); - } - catch { /* console may not support this */ } - } - - await Task.WhenAny(outputTask, inputTask); - await cts.CancelAsync(); - - try { await Task.WhenAll(outputTask, inputTask); } - catch (OperationCanceledException) { } -} -finally -{ - Console.TreatControlCAsInput = originalMode; -} - -return 0; diff --git a/playground/Terminals/Terminals.Client/Terminals.Client.csproj b/playground/Terminals/Terminals.Client/Terminals.Client.csproj deleted file mode 100644 index 27b4e2982f6..00000000000 --- a/playground/Terminals/Terminals.Client/Terminals.Client.csproj +++ /dev/null @@ -1,14 +0,0 @@ - - - - Exe - $(DefaultTargetFramework) - enable - enable - - - - - - - diff --git a/playground/Terminals/Terminals.TerminalHost/Program.cs b/playground/Terminals/Terminals.TerminalHost/Program.cs deleted file mode 100644 index 9296edd480a..00000000000 --- a/playground/Terminals/Terminals.TerminalHost/Program.cs +++ /dev/null @@ -1,66 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using Hex1b; -using Terminals.TerminalHost; - -// The terminal host process receives configuration via environment variables: -// TERMINAL_SOCKET_PATH — path to the Unix domain socket for client connections -// TERMINAL_COLUMNS — initial terminal width (default: 120) -// TERMINAL_ROWS — initial terminal height (default: 30) -// TERMINAL_SHELL — shell to run (default: platform-specific) - -var socketPath = Environment.GetEnvironmentVariable("TERMINAL_SOCKET_PATH"); -if (string.IsNullOrEmpty(socketPath)) -{ - Console.Error.WriteLine("Error: TERMINAL_SOCKET_PATH environment variable is required."); - return 1; -} - -var columns = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_COLUMNS"), out var c) ? c : 120; -var rows = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_ROWS"), out var r) ? r : 30; -var shell = Environment.GetEnvironmentVariable("TERMINAL_SHELL") - ?? (OperatingSystem.IsWindows() ? "pwsh" : "/bin/bash"); - -Console.Error.WriteLine($"[TerminalHost] Starting: shell={shell}, size={columns}x{rows}, socket={socketPath}"); - -// Create the UDS presentation adapter — this is the "display" side that clients connect to -var adapter = new UnixDomainSocketPresentationAdapter(socketPath, columns, rows); - -using var cts = new CancellationTokenSource(); -Console.CancelKeyPress += (_, e) => -{ - e.Cancel = true; - cts.Cancel(); -}; - -try -{ - // Wait for a client to connect before starting the terminal - await adapter.WaitForClientAsync(cts.Token); - - // Build the Hex1b terminal: - // - WithPresentation: our UDS adapter serves as the display - // - WithPtyProcess: the shell runs as a child process with a real PTY - await using var terminal = Hex1bTerminal.CreateBuilder() - .WithPresentation(adapter) - .WithPtyProcess(shell) - .WithDimensions(columns, rows) - .Build(); - - Console.Error.WriteLine($"[TerminalHost] Terminal running with PID shell"); - - // RunAsync blocks until the shell exits or cancellation - var exitCode = await terminal.RunAsync(cts.Token); - Console.Error.WriteLine($"[TerminalHost] Shell exited with code {exitCode}"); - - // Send EXIT + CLOSE per protocol spec - await adapter.SendExitAsync(exitCode, Aspire.Terminal.TerminalProtocol.ExitReason.Exited, cts.Token); - - return exitCode; -} -catch (OperationCanceledException) -{ - Console.Error.WriteLine("[TerminalHost] Shutting down"); - return 0; -} diff --git a/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj b/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj deleted file mode 100644 index 3bd4fdfc6b9..00000000000 --- a/playground/Terminals/Terminals.TerminalHost/Terminals.TerminalHost.csproj +++ /dev/null @@ -1,20 +0,0 @@ - - - - Exe - $(DefaultTargetFramework) - enable - enable - - $(NoWarn);CS8002 - - - - - - - - - - - diff --git a/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs b/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs deleted file mode 100644 index a84fc3f2674..00000000000 --- a/playground/Terminals/Terminals.TerminalHost/UnixDomainSocketPresentationAdapter.cs +++ /dev/null @@ -1,204 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Net.Sockets; -using Aspire.Terminal; -using Hex1b; - -namespace Terminals.TerminalHost; - -/// -/// A Hex1b presentation adapter that serves terminal I/O over a Unix domain socket -/// using the Aspire Terminal Protocol (see docs/specs/terminal-protocol.md). -/// -internal sealed class UnixDomainSocketPresentationAdapter : IHex1bTerminalPresentationAdapter -{ - private readonly string _socketPath; - private readonly CancellationTokenSource _disposeCts = new(); - private Socket? _serverSocket; - private Socket? _clientSocket; - private NetworkStream? _clientStream; - private TerminalFrameReader? _reader; - private TerminalFrameWriter? _writer; - private bool _disposed; - private bool _helloSent; - - public UnixDomainSocketPresentationAdapter(string socketPath, int width, int height) - { - _socketPath = socketPath; - Width = width; - Height = height; - } - - public int Width { get; private set; } - public int Height { get; private set; } - - public TerminalCapabilities Capabilities => new() - { - SupportsTrueColor = true, - Supports256Colors = true, - SupportsAlternateScreen = true, - SupportsBracketedPaste = true, - }; - - public event Action? Resized; - public event Action? Disconnected; - - /// - /// Starts listening on the UDS and waits for a client to connect. - /// Sends the HELLO frame once connected. - /// - public async Task WaitForClientAsync(CancellationToken ct) - { - // Clean up stale socket - if (File.Exists(_socketPath)) - { - File.Delete(_socketPath); - } - - var socketDir = Path.GetDirectoryName(_socketPath); - if (socketDir is not null) - { - Directory.CreateDirectory(socketDir); - } - - _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); - _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); - _serverSocket.Listen(backlog: 1); - - Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); - - _clientSocket = await _serverSocket.AcceptAsync(ct); - _clientStream = new NetworkStream(_clientSocket, ownsSocket: false); - _reader = new TerminalFrameReader(_clientStream); - _writer = new TerminalFrameWriter(_clientStream); - - Console.Error.WriteLine("[TerminalHost] Client connected, sending HELLO"); - - // Send HELLO as the first frame per protocol spec - await _writer.WriteHelloAsync( - (ushort)Width, - (ushort)Height, - TerminalProtocol.HelloFlags.Pty, - ct); - - _helloSent = true; - } - - public async ValueTask WriteOutputAsync(ReadOnlyMemory data, CancellationToken ct = default) - { - if (_disposed || _writer is null || !_helloSent) - { - return; - } - - try - { - await _writer.WriteDataAsync(data, ct); - } - catch (IOException) - { - Disconnected?.Invoke(); - } - catch (SocketException) - { - Disconnected?.Invoke(); - } - } - - public async ValueTask> ReadInputAsync(CancellationToken ct = default) - { - if (_disposed || _reader is null) - { - return ReadOnlyMemory.Empty; - } - - try - { - using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); - var frame = await _reader.ReadFrameAsync(linkedCts.Token); - - if (frame is null) - { - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - return frame.Value.Payload; - - case TerminalProtocol.MessageType.Resize: - var (cols, rows) = frame.Value.ParseResize(); - Width = cols; - Height = rows; - Resized?.Invoke(cols, rows); - return await ReadInputAsync(ct); - - case TerminalProtocol.MessageType.Close: - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - - default: - // Unknown frame type — skip and read next - return await ReadInputAsync(ct); - } - } - catch (OperationCanceledException) - { - return ReadOnlyMemory.Empty; - } - catch (IOException) - { - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - } - } - - public ValueTask FlushAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - - // Raw mode is handled by the client side, not the server - public ValueTask EnterRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - public ValueTask ExitRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - public (int Row, int Column) GetCursorPosition() => (0, 0); - - /// - /// Sends an EXIT frame to the client. - /// - public async ValueTask SendExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) - { - if (_writer is not null && !_disposed) - { - try - { - await _writer.WriteExitAsync(exitCode, reason, ct); - await _writer.WriteCloseAsync(ct); - } - catch { /* best effort */ } - } - } - - public async ValueTask DisposeAsync() - { - if (_disposed) - { - return; - } - - _disposed = true; - await _disposeCts.CancelAsync(); - - _clientStream?.Dispose(); - _clientSocket?.Dispose(); - _serverSocket?.Dispose(); - - if (File.Exists(_socketPath)) - { - try { File.Delete(_socketPath); } - catch { /* ignore cleanup errors */ } - } - - _disposeCts.Dispose(); - } -} diff --git a/src/Aspire.Cli/Aspire.Cli.csproj b/src/Aspire.Cli/Aspire.Cli.csproj index 93fd0e852de..887be4f50bb 100644 --- a/src/Aspire.Cli/Aspire.Cli.csproj +++ b/src/Aspire.Cli/Aspire.Cli.csproj @@ -131,8 +131,6 @@ - - diff --git a/src/Aspire.Cli/Commands/TerminalCommand.cs b/src/Aspire.Cli/Commands/TerminalCommand.cs index 03cf26738f5..d367441ebf3 100644 --- a/src/Aspire.Cli/Commands/TerminalCommand.cs +++ b/src/Aspire.Cli/Commands/TerminalCommand.cs @@ -2,32 +2,30 @@ // The .NET Foundation licenses this file to you under the MIT license. using System.CommandLine; -using System.Globalization; -using System.Net.Sockets; using Aspire.Cli.Backchannel; using Aspire.Cli.Configuration; using Aspire.Cli.Interaction; -using Aspire.Cli.Resources; using Aspire.Cli.Telemetry; using Aspire.Cli.Utils; -using Aspire.Terminal; using Microsoft.Extensions.Logging; namespace Aspire.Cli.Commands; /// /// Attaches to an interactive terminal session for a resource. -/// Connects to the resource's terminal UDS using the Aspire Terminal Protocol, -/// puts the local console in raw mode, and bridges stdin/stdout bidirectionally. -/// Press Ctrl+] to detach. +/// +/// PHASE 6 PENDING: this command is a placeholder during the WithTerminal end-to-end +/// refactor. Once the per-replica HMP v1 wiring lands (Phases 4 + 5), this command +/// will: (1) call the auxiliary backchannel's GetTerminalInfoAsync to discover +/// per-replica consumer UDS paths, (2) prompt the user to pick a replica when there +/// is more than one, and (3) attach via Hex1b's HMP v1 client to bridge the local +/// terminal to the chosen replica. /// internal sealed class TerminalCommand : BaseCommand { internal override HelpGroup HelpGroup => HelpGroup.Monitoring; private readonly IInteractionService _interactionService; - private readonly AppHostConnectionResolver _connectionResolver; - private readonly ILogger _logger; private static readonly Argument s_resourceArgument = new("resource") { @@ -35,7 +33,7 @@ internal sealed class TerminalCommand : BaseCommand }; private static readonly OptionWithLegacy s_appHostOption = - new("--apphost", "--project", SharedCommandStrings.AppHostOptionDescription); + new("--apphost", "--project", Resources.SharedCommandStrings.AppHostOptionDescription); public TerminalCommand( IInteractionService interactionService, @@ -48,212 +46,18 @@ public TerminalCommand( : base("terminal", "Attach to an interactive terminal session for a resource.", features, updateNotifier, executionContext, interactionService, telemetry) { _interactionService = interactionService; - _logger = logger; - _connectionResolver = new AppHostConnectionResolver(backchannelMonitor, interactionService, executionContext, logger); + _ = backchannelMonitor; + _ = logger; Arguments.Add(s_resourceArgument); Options.Add(s_appHostOption); } - protected override async Task ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken) + protected override Task ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken) { - using var activity = Telemetry.StartDiagnosticActivity(Name); - - var resourceName = parseResult.GetValue(s_resourceArgument)!; - var passedAppHostProjectFile = parseResult.GetValue(s_appHostOption); - - var result = await _connectionResolver.ResolveConnectionAsync( - passedAppHostProjectFile, - SharedCommandStrings.ScanningForRunningAppHosts, - string.Format(CultureInfo.CurrentCulture, SharedCommandStrings.SelectAppHost, "attach terminal to"), - SharedCommandStrings.AppHostNotRunning, - cancellationToken).ConfigureAwait(false); - - if (!result.Success) - { - _interactionService.DisplayMessage(KnownEmojis.Information, result.ErrorMessage); - return ExitCodeConstants.Success; - } - - var connection = result.Connection!; - - // Get terminal info from the AppHost - var terminalInfo = await connection.GetTerminalInfoAsync(resourceName, cancellationToken).ConfigureAwait(false); - - if (!terminalInfo.IsAvailable || string.IsNullOrEmpty(terminalInfo.SocketPath)) - { - _interactionService.DisplayError($"Terminal is not available for resource '{resourceName}'. Ensure the resource has .WithTerminal() configured."); - return ExitCodeConstants.FailedToDotnetRunAppHost; - } - - _logger.LogDebug("Connecting to terminal at {SocketPath}", terminalInfo.SocketPath); - - // Connect to the terminal UDS - using var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); - try - { - await socket.ConnectAsync(new UnixDomainSocketEndPoint(terminalInfo.SocketPath), cancellationToken).ConfigureAwait(false); - } - catch (SocketException ex) - { - _interactionService.DisplayError($"Failed to connect to terminal socket: {ex.Message}"); - return ExitCodeConstants.FailedToDotnetRunAppHost; - } - - await using var stream = new NetworkStream(socket, ownsSocket: false); - var reader = new TerminalFrameReader(stream); - var writer = new TerminalFrameWriter(stream); - - // Read HELLO - var helloFrame = await reader.ReadFrameAsync(cancellationToken).ConfigureAwait(false); - if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) - { - _interactionService.DisplayError("Terminal protocol error: did not receive HELLO frame."); - return ExitCodeConstants.FailedToDotnetRunAppHost; - } - - var (version, cols, rows, flags) = helloFrame.Value.ParseHello(); - _logger.LogDebug("Terminal HELLO: v{Version}, {Cols}x{Rows}, flags={Flags}", version, cols, rows, flags); - - _interactionService.DisplayMessage(KnownEmojis.Gear, $"Connected to terminal for '{resourceName}' ({cols}x{rows}). Press Ctrl+] to detach."); - - // Enter raw mode and bridge I/O - var originalControlC = Console.TreatControlCAsInput; - Console.TreatControlCAsInput = true; - - try - { - using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); - - // Send initial resize - if (!Console.IsInputRedirected) - { - try - { - await writer.WriteResizeAsync( - (ushort)Console.WindowWidth, - (ushort)Console.WindowHeight, - cts.Token).ConfigureAwait(false); - } - catch - { - // Console may not support dimensions - } - } - - var outputTask = ReadOutputAsync(reader, cts); - var inputTask = ReadInputAsync(writer, cts); - - await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); - await cts.CancelAsync().ConfigureAwait(false); - - try - { - await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); - } - catch (OperationCanceledException) - { - // Expected - } - } - finally - { - Console.TreatControlCAsInput = originalControlC; - } - - return ExitCodeConstants.Success; - } - - private static async Task ReadOutputAsync(TerminalFrameReader reader, CancellationTokenSource cts) - { - try - { - while (!cts.Token.IsCancellationRequested) - { - var frame = await reader.ReadFrameAsync(cts.Token).ConfigureAwait(false); - if (frame is null) - { - break; - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - using (var stdout = Console.OpenStandardOutput()) - { - await stdout.WriteAsync(frame.Value.Payload, cts.Token).ConfigureAwait(false); - await stdout.FlushAsync(cts.Token).ConfigureAwait(false); - } - break; - - case TerminalProtocol.MessageType.Exit: - var (exitCode, reason) = frame.Value.ParseExit(); - Console.Error.WriteLine($"\r\n[Process exited: code={exitCode}, reason={reason}]"); - await cts.CancelAsync().ConfigureAwait(false); - return; - - case TerminalProtocol.MessageType.Close: - Console.Error.WriteLine("\r\n[Server closed connection]"); - await cts.CancelAsync().ConfigureAwait(false); - return; - } - } - } - catch (OperationCanceledException) - { - // Expected - } - catch (IOException) - { - // Disconnected - } - } - - private static async Task ReadInputAsync(TerminalFrameWriter writer, CancellationTokenSource cts) - { - try - { - using var stdin = Console.OpenStandardInput(); - var buffer = new byte[256]; - - while (!cts.Token.IsCancellationRequested) - { - var bytesRead = await stdin.ReadAsync(buffer, cts.Token).ConfigureAwait(false); - if (bytesRead == 0) - { - break; - } - - // Check for Ctrl+] (0x1D) to detach - for (var i = 0; i < bytesRead; i++) - { - if (buffer[i] == 0x1D) - { - Console.Error.WriteLine("\r\n[Detached]"); - try - { - await writer.WriteCloseAsync(cts.Token).ConfigureAwait(false); - } - catch - { - // Best effort - } - - await cts.CancelAsync().ConfigureAwait(false); - return; - } - } - - await writer.WriteDataAsync(buffer.AsMemory(0, bytesRead), cts.Token).ConfigureAwait(false); - } - } - catch (OperationCanceledException) - { - // Expected - } - catch (IOException) - { - // Disconnected - } + _interactionService.DisplayMessage( + KnownEmojis.Information, + "The 'aspire terminal' command is being rewritten as part of the WithTerminal feature for Aspire 13.4. Try again on a build that includes the Phase 6 wire-up."); + return Task.FromResult(ExitCodeConstants.Success); } } diff --git a/src/Aspire.Dashboard/Aspire.Dashboard.csproj b/src/Aspire.Dashboard/Aspire.Dashboard.csproj index df741ce8856..a7f23195565 100644 --- a/src/Aspire.Dashboard/Aspire.Dashboard.csproj +++ b/src/Aspire.Dashboard/Aspire.Dashboard.csproj @@ -294,8 +294,6 @@ - - diff --git a/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs index 2fb8d096673..3076485e2b5 100644 --- a/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs +++ b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs @@ -1,204 +1,30 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. -#pragma warning disable CA2007 // Consider calling ConfigureAwait -using System.Net.Sockets; -using System.Net.WebSockets; -using System.Text; -using System.Text.Json; -using Aspire.Terminal; - namespace Aspire.Dashboard.Terminal; /// /// ASP.NET Core middleware that proxies WebSocket connections from the browser -/// to a Unix domain socket speaking the Aspire Terminal Protocol. +/// to a terminal-host UDS using HMP v1. +/// +/// PHASE 7 PENDING: during the WithTerminal end-to-end refactor this proxy is +/// stubbed to return 503. Once the per-replica HMP v1 wire-up lands (Phases 4 + 5), +/// the proxy will look up the consumer UDS path for the requested resource/replica +/// via the AppHost backchannel and bridge the WebSocket to a Hex1b HMP v1 client. /// internal static class TerminalWebSocketProxy { /// - /// Maps the terminal WebSocket endpoint at /api/terminal. + /// Maps the terminal WebSocket endpoint at /api/terminal as a 503 stub. /// public static void MapTerminalWebSocket(this WebApplication app) { app.Map("/api/terminal", async (HttpContext context) => { - if (!context.WebSockets.IsWebSocketRequest) - { - context.Response.StatusCode = 400; - await context.Response.WriteAsync("WebSocket connection required."); - return; - } - - var socketPath = context.Request.Query["socketPath"].FirstOrDefault(); - if (string.IsNullOrEmpty(socketPath)) - { - context.Response.StatusCode = 400; - await context.Response.WriteAsync("socketPath query parameter is required."); - return; - } - - if (!File.Exists(socketPath)) - { - context.Response.StatusCode = 404; - await context.Response.WriteAsync("Terminal socket not found."); - return; - } - - var webSocket = await context.WebSockets.AcceptWebSocketAsync(); - await ProxyTerminalAsync(webSocket, socketPath, context.RequestAborted); + context.Response.StatusCode = 503; + await context.Response.WriteAsync( + "Terminal endpoint is not yet available in this build. " + + "Pending Phase 7 of the WithTerminal end-to-end work.").ConfigureAwait(false); }); } - - private static async Task ProxyTerminalAsync(WebSocket webSocket, string socketPath, CancellationToken ct) - { - using var udsSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); - try - { - await udsSocket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath), ct); - } - catch (SocketException) - { - await webSocket.CloseAsync(WebSocketCloseStatus.EndpointUnavailable, "Cannot connect to terminal socket", ct); - return; - } - - await using var udsStream = new NetworkStream(udsSocket, ownsSocket: false); - var reader = new TerminalFrameReader(udsStream); - var writer = new TerminalFrameWriter(udsStream); - - // Read HELLO from UDS - var helloFrame = await reader.ReadFrameAsync(ct); - if (helloFrame is null || helloFrame.Value.Type != TerminalProtocol.MessageType.Hello) - { - await webSocket.CloseAsync(WebSocketCloseStatus.ProtocolError, "No HELLO from terminal", ct); - return; - } - - // Parse HELLO but don't send it to the browser — xterm.js doesn't need it - var (_, cols, rows, _) = helloFrame.Value.ParseHello(); - - using var cts = CancellationTokenSource.CreateLinkedTokenSource(ct); - - // UDS → WebSocket (terminal output to browser) - var outputTask = Task.Run(async () => - { - try - { - while (!cts.Token.IsCancellationRequested) - { - var frame = await reader.ReadFrameAsync(cts.Token).ConfigureAwait(false); - if (frame is null) - { - break; - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - await webSocket.SendAsync( - frame.Value.Payload, - WebSocketMessageType.Binary, - endOfMessage: true, - cts.Token).ConfigureAwait(false); - break; - - case TerminalProtocol.MessageType.Exit: - case TerminalProtocol.MessageType.Close: - await cts.CancelAsync().ConfigureAwait(false); - return; - } - } - } - catch (OperationCanceledException) { } - catch (WebSocketException) { } - catch (IOException) { } - }, cts.Token); - - // WebSocket → UDS (browser input to terminal) - var inputTask = Task.Run(async () => - { - var buffer = new byte[4096]; - try - { - while (!cts.Token.IsCancellationRequested) - { - var result = await webSocket.ReceiveAsync(buffer, cts.Token).ConfigureAwait(false); - - if (result.MessageType == WebSocketMessageType.Close) - { - await writer.WriteCloseAsync(cts.Token).ConfigureAwait(false); - await cts.CancelAsync().ConfigureAwait(false); - return; - } - - if (result.MessageType == WebSocketMessageType.Text) - { - // Check for JSON resize message from xterm.js - var text = Encoding.UTF8.GetString(buffer, 0, result.Count); - if (TryParseResize(text, out var newCols, out var newRows)) - { - await writer.WriteResizeAsync((ushort)newCols, (ushort)newRows, cts.Token).ConfigureAwait(false); - continue; - } - - // Text input — convert to bytes and send as DATA - var inputBytes = Encoding.UTF8.GetBytes(text); - await writer.WriteDataAsync(inputBytes, cts.Token).ConfigureAwait(false); - } - else - { - // Binary input - await writer.WriteDataAsync( - buffer.AsMemory(0, result.Count), - cts.Token).ConfigureAwait(false); - } - } - } - catch (OperationCanceledException) { } - catch (WebSocketException) { } - catch (IOException) { } - }, cts.Token); - - await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); - await cts.CancelAsync().ConfigureAwait(false); - - try { await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); } - catch (OperationCanceledException) { } - - if (webSocket.State == WebSocketState.Open) - { - try - { - await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Terminal closed", CancellationToken.None); - } - catch { /* best effort */ } - } - } - - private static bool TryParseResize(string text, out int cols, out int rows) - { - cols = 0; - rows = 0; - - try - { - using var doc = JsonDocument.Parse(text); - if (doc.RootElement.TryGetProperty("type", out var typeEl) && - typeEl.GetString() == "resize" && - doc.RootElement.TryGetProperty("cols", out var colsEl) && - doc.RootElement.TryGetProperty("rows", out var rowsEl)) - { - cols = colsEl.GetInt32(); - rows = rowsEl.GetInt32(); - return true; - } - } - catch (JsonException) - { - // Not JSON, treat as text input - } - - return false; - } } diff --git a/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj b/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj index 7fe617b5b18..4d6b0bb0b71 100644 --- a/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj +++ b/src/Aspire.TerminalHost/Aspire.TerminalHost.csproj @@ -12,10 +12,17 @@ + + + - + + + + + diff --git a/src/Aspire.TerminalHost/Program.cs b/src/Aspire.TerminalHost/Program.cs index 989bc8c240e..574703b0f35 100644 --- a/src/Aspire.TerminalHost/Program.cs +++ b/src/Aspire.TerminalHost/Program.cs @@ -2,77 +2,13 @@ // The .NET Foundation licenses this file to you under the MIT license. using Aspire.TerminalHost; -using Hex1b; - -// The Aspire Terminal Host bridges a PTY process to the Aspire Terminal Protocol -// over a Unix domain socket. It is launched by the AppHost orchestrator for resources -// with .WithTerminal() and serves as the terminal state manager using Hex1b. -// -// Architecture: -// - Hex1b runs the shell in headless mode (manages internal terminal state) -// - A presentation filter intercepts all output and broadcasts to UDS clients -// - Clients can disconnect and reconnect; current screen state is replayed -// -// Environment variables: -// TERMINAL_SOCKET_PATH — UDS path for client connections (required) -// TERMINAL_COLUMNS — initial terminal width (default: 120) -// TERMINAL_ROWS — initial terminal height (default: 30) -// TERMINAL_SHELL — shell command to run (default: platform-specific) -// TERMINAL_SHELL_ARGS — shell arguments, semicolon-separated (default: platform-specific) - -var socketPath = Environment.GetEnvironmentVariable("TERMINAL_SOCKET_PATH"); -if (string.IsNullOrEmpty(socketPath)) -{ - Console.Error.WriteLine("Error: TERMINAL_SOCKET_PATH environment variable is required."); - return 1; -} - -var columns = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_COLUMNS"), out var c) ? c : 120; -var rows = int.TryParse(Environment.GetEnvironmentVariable("TERMINAL_ROWS"), out var r) ? r : 30; - -var shell = Environment.GetEnvironmentVariable("TERMINAL_SHELL") - ?? (OperatingSystem.IsWindows() ? "pwsh" : "/bin/bash"); - -var shellArgsStr = Environment.GetEnvironmentVariable("TERMINAL_SHELL_ARGS"); -var shellArgs = !string.IsNullOrEmpty(shellArgsStr) - ? shellArgsStr.Split(';', StringSplitOptions.RemoveEmptyEntries) - : (OperatingSystem.IsWindows() ? ["-NoLogo"] : ["--norc"]); - -Console.Error.WriteLine($"[Aspire.TerminalHost] shell={shell}, size={columns}x{rows}, socket={socketPath}"); - -// Create the socket server (presentation filter) -await using var server = new TerminalSocketServer(socketPath, columns, rows); using var cts = new CancellationTokenSource(); + Console.CancelKeyPress += (_, e) => { e.Cancel = true; cts.Cancel(); }; -try -{ - // Build the terminal: headless presentation + PTY process + our filter for UDS broadcasting - await using var terminal = Hex1bTerminal.CreateBuilder() - .WithHeadless() - .WithPtyProcess(shell, shellArgs) - .WithDimensions(columns, rows) - .AddPresentationFilter(server) - .Build(); - - // Give the server access to the terminal for snapshots and input forwarding - server.SetTerminal(terminal); - - // Start accepting client connections - await server.StartListeningAsync(cts.Token); - - // Run the terminal (blocks until shell exits or cancellation) - var exitCode = await terminal.RunAsync(cts.Token); - Console.Error.WriteLine($"[Aspire.TerminalHost] Shell exited with code {exitCode}"); - return exitCode; -} -catch (OperationCanceledException) -{ - Console.Error.WriteLine("[Aspire.TerminalHost] Shutting down"); - return 0; -} +return await TerminalHostApp.RunAsync(args, cts.Token).ConfigureAwait(false); diff --git a/src/Aspire.TerminalHost/StderrLoggerProvider.cs b/src/Aspire.TerminalHost/StderrLoggerProvider.cs new file mode 100644 index 00000000000..85cf990203a --- /dev/null +++ b/src/Aspire.TerminalHost/StderrLoggerProvider.cs @@ -0,0 +1,57 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Microsoft.Extensions.Logging; + +namespace Aspire.TerminalHost; + +/// +/// Minimal logger provider that writes a single line per record to stderr. +/// Used by the terminal host so it doesn't pull in +/// Microsoft.Extensions.Logging.Console (which is not centrally managed in this repo). +/// +internal sealed class StderrLoggerProvider : ILoggerProvider +{ + public ILogger CreateLogger(string categoryName) => new StderrLogger(categoryName); + + public void Dispose() + { + } + + private sealed class StderrLogger(string category) : ILogger + { + IDisposable? ILogger.BeginScope(TState state) => null; + + public bool IsEnabled(LogLevel logLevel) => logLevel != LogLevel.None; + + public void Log( + LogLevel logLevel, + EventId eventId, + TState state, + Exception? exception, + Func formatter) + { + if (!IsEnabled(logLevel)) + { + return; + } + + var ts = DateTimeOffset.UtcNow.ToString("HH:mm:ss.fff", System.Globalization.CultureInfo.InvariantCulture); + var msg = formatter(state, exception); + var line = $"{ts} [{logLevel,-11}] {category}: {msg}"; + + try + { + Console.Error.WriteLine(line); + if (exception is not null) + { + Console.Error.WriteLine(exception); + } + } + catch + { + // stderr unavailable — give up silently rather than tearing down the host. + } + } + } +} diff --git a/src/Aspire.TerminalHost/TerminalHostApp.cs b/src/Aspire.TerminalHost/TerminalHostApp.cs new file mode 100644 index 00000000000..bdd730bc470 --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalHostApp.cs @@ -0,0 +1,230 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Shared.TerminalHost; +using Microsoft.Extensions.Logging; + +namespace Aspire.TerminalHost; + +/// +/// In-process entry point for the Aspire terminal host. Owns the per-replica +/// relay terminals, the control listener, and the lifecycle/shutdown handshake. +/// +/// Exposed as a class so tests can drive the host without spawning a process. +/// +internal sealed class TerminalHostApp : IAsyncDisposable +{ + private readonly TerminalHostArgs _args; + private readonly ILogger _logger; + private readonly ILoggerFactory _loggerFactory; + private readonly CancellationTokenSource _shutdownCts = new(); + private readonly List _replicas = new(); + private readonly object _gate = new(); + private TerminalHostControlListener? _controlListener; + private bool _disposed; + + public TerminalHostApp(TerminalHostArgs args, ILoggerFactory loggerFactory) + { + ArgumentNullException.ThrowIfNull(args); + ArgumentNullException.ThrowIfNull(loggerFactory); + + _args = args; + _loggerFactory = loggerFactory; + _logger = loggerFactory.CreateLogger(); + } + + public int ReplicaCount => _args.ReplicaCount; + + /// + /// Snapshot of all replica states, suitable for marshalling to the AppHost + /// via the control protocol. + /// + public TerminalHostReplicaInfo[] SnapshotReplicas() + { + lock (_gate) + { + var snap = new TerminalHostReplicaInfo[_replicas.Count]; + for (var i = 0; i < _replicas.Count; i++) + { + var r = _replicas[i]; + snap[i] = new TerminalHostReplicaInfo + { + Index = r.Index, + ProducerUdsPath = r.ProducerUdsPath, + ConsumerUdsPath = r.ConsumerUdsPath, + IsAlive = r.IsAlive, + ExitCode = r.ExitCode, + }; + } + return snap; + } + } + + /// + /// Starts each replica relay and the control listener, then waits for either + /// the external cancellation token or a shutdown request to fire. Returns the + /// process exit code. + /// + public async Task RunAsync(CancellationToken cancellationToken) + { + if (_args.Shell is { } shell) + { + _logger.LogInformation( + "Aspire terminal host starting: {Replicas} replica(s), shell hint='{Shell}', size={Cols}x{Rows}.", + _args.ReplicaCount, shell, _args.Columns, _args.Rows); + } + else + { + _logger.LogInformation( + "Aspire terminal host starting: {Replicas} replica(s), size={Cols}x{Rows}.", + _args.ReplicaCount, _args.Columns, _args.Rows); + } + + using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource( + cancellationToken, _shutdownCts.Token); + var token = linkedCts.Token; + + try + { + // Start replicas first, then the control listener; that way as soon as + // the AppHost can connect to control, all consumer UDS paths are bound. + for (var i = 0; i < _args.ReplicaCount; i++) + { + var replicaLogger = _loggerFactory.CreateLogger($"Aspire.TerminalHost.Replica[{i}]"); + var replica = TerminalReplica.Start( + i, + _args.ProducerUdsPaths[i], + _args.ConsumerUdsPaths[i], + _args.Columns, + _args.Rows, + replicaLogger, + token); + lock (_gate) + { + _replicas.Add(replica); + } + } + + _controlListener = new TerminalHostControlListener( + _args.ControlUdsPath, + new TerminalHostControlRpcTarget(this), + _loggerFactory.CreateLogger()); + await _controlListener.StartAsync().ConfigureAwait(false); + + _logger.LogInformation("Terminal host ready."); + + await WaitForShutdownAsync(token).ConfigureAwait(false); + return 0; + } + catch (OperationCanceledException) + { + return 0; + } + catch (Exception ex) + { + _logger.LogError(ex, "Terminal host failed."); + return 1; + } + finally + { + await TearDownAsync().ConfigureAwait(false); + } + } + + private static async Task WaitForShutdownAsync(CancellationToken cancellationToken) + { + // Wait for external cancellation or an explicit shutdown request via the + // control protocol. We do not auto-exit when all replicas have exited: + // a replica failing/disconnecting is recoverable in normal operation + // (DCP may relaunch the upstream PTY), and DCP is responsible for + // tearing down the host when the resource is fully stopped. + try + { + await Task.Delay(Timeout.Infinite, cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + } + } + + /// + /// Signals a graceful shutdown. Returns immediately; + /// will exit shortly after. + /// + public void RequestShutdown() + { + if (!_shutdownCts.IsCancellationRequested) + { + _logger.LogInformation("Shutdown requested."); + _shutdownCts.Cancel(); + } + } + + private async Task TearDownAsync() + { + if (_controlListener is not null) + { + await _controlListener.DisposeAsync().ConfigureAwait(false); + _controlListener = null; + } + + TerminalReplica[] toDispose; + lock (_gate) + { + toDispose = [.. _replicas]; + _replicas.Clear(); + } + foreach (var r in toDispose) + { + try + { + await r.DisposeAsync().ConfigureAwait(false); + } + catch (Exception ex) + { + _logger.LogDebug(ex, "Error while disposing replica {Index}.", r.Index); + } + } + } + + public async ValueTask DisposeAsync() + { + if (_disposed) + { + return; + } + + _disposed = true; + RequestShutdown(); + await TearDownAsync().ConfigureAwait(false); + _shutdownCts.Dispose(); + } + + /// + /// Convenience entry point used by both Program.Main and tests. + /// Catches argument-parsing errors and writes a friendly message to stderr. + /// + public static async Task RunAsync(string[] args, CancellationToken cancellationToken) + { + TerminalHostArgs parsed; + try + { + parsed = TerminalHostArgs.Parse(args); + } + catch (TerminalHostArgsException ex) + { + await Console.Error.WriteLineAsync($"[Aspire.TerminalHost] {ex.Message}") + .ConfigureAwait(false); + return 64; // EX_USAGE + } + + using var loggerFactory = LoggerFactory.Create(builder => + { + builder.AddProvider(new StderrLoggerProvider()); + builder.SetMinimumLevel(LogLevel.Information); + }); + + await using var app = new TerminalHostApp(parsed, loggerFactory); + return await app.RunAsync(cancellationToken).ConfigureAwait(false); + } +} diff --git a/src/Aspire.TerminalHost/TerminalHostArgs.cs b/src/Aspire.TerminalHost/TerminalHostArgs.cs new file mode 100644 index 00000000000..459f572c3c7 --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalHostArgs.cs @@ -0,0 +1,154 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Globalization; + +namespace Aspire.TerminalHost; + +/// +/// Parsed command-line arguments for the Aspire terminal host. +/// +internal sealed class TerminalHostArgs +{ + public required int ReplicaCount { get; init; } + public required string[] ProducerUdsPaths { get; init; } + public required string[] ConsumerUdsPaths { get; init; } + public required string ControlUdsPath { get; init; } + public int Columns { get; init; } = 120; + public int Rows { get; init; } = 30; + + /// + /// Optional shell name. Informational only (the host does not spawn a PTY itself — + /// that is DCP's responsibility); included so the host can log it on startup. + /// + public string? Shell { get; init; } + + /// + /// Parses command-line arguments. The argument shape is: + /// + /// --replica-count N (required, >= 1) + /// --producer-uds PATH (repeated N times) + /// --consumer-uds PATH (repeated N times) + /// --control-uds PATH (required) + /// --columns N (optional, default 120) + /// --rows N (optional, default 30) + /// --shell NAME (optional, informational) + /// + /// Throws with a human-readable message on any + /// parse error so the host can write a friendly message to stderr. + /// + public static TerminalHostArgs Parse(string[] args) + { + ArgumentNullException.ThrowIfNull(args); + + int? replicaCount = null; + var producers = new List(); + var consumers = new List(); + string? control = null; + int columns = 120; + int rows = 30; + string? shell = null; + + for (var i = 0; i < args.Length; i++) + { + var arg = args[i]; + switch (arg) + { + case "--replica-count": + replicaCount = ParseInt(args, ref i, "--replica-count"); + break; + case "--producer-uds": + producers.Add(ParseString(args, ref i, "--producer-uds")); + break; + case "--consumer-uds": + consumers.Add(ParseString(args, ref i, "--consumer-uds")); + break; + case "--control-uds": + control = ParseString(args, ref i, "--control-uds"); + break; + case "--columns": + columns = ParseInt(args, ref i, "--columns"); + break; + case "--rows": + rows = ParseInt(args, ref i, "--rows"); + break; + case "--shell": + shell = ParseString(args, ref i, "--shell"); + break; + default: + throw new TerminalHostArgsException($"Unknown argument: '{arg}'."); + } + } + + if (replicaCount is null) + { + throw new TerminalHostArgsException("Missing required argument: --replica-count."); + } + + if (replicaCount.Value < 1) + { + throw new TerminalHostArgsException( + $"--replica-count must be >= 1 (got {replicaCount.Value})."); + } + + if (producers.Count != replicaCount.Value) + { + throw new TerminalHostArgsException( + $"Expected {replicaCount.Value} --producer-uds argument(s), got {producers.Count}."); + } + + if (consumers.Count != replicaCount.Value) + { + throw new TerminalHostArgsException( + $"Expected {replicaCount.Value} --consumer-uds argument(s), got {consumers.Count}."); + } + + if (string.IsNullOrEmpty(control)) + { + throw new TerminalHostArgsException("Missing required argument: --control-uds."); + } + + if (columns < 1 || rows < 1) + { + throw new TerminalHostArgsException( + $"--columns and --rows must be >= 1 (got {columns}x{rows})."); + } + + return new TerminalHostArgs + { + ReplicaCount = replicaCount.Value, + ProducerUdsPaths = [.. producers], + ConsumerUdsPaths = [.. consumers], + ControlUdsPath = control, + Columns = columns, + Rows = rows, + Shell = shell, + }; + } + + private static string ParseString(string[] args, ref int i, string name) + { + if (i + 1 >= args.Length) + { + throw new TerminalHostArgsException($"Missing value for argument '{name}'."); + } + + return args[++i]; + } + + private static int ParseInt(string[] args, ref int i, string name) + { + var raw = ParseString(args, ref i, name); + if (!int.TryParse(raw, NumberStyles.Integer, CultureInfo.InvariantCulture, out var value)) + { + throw new TerminalHostArgsException($"Argument '{name}' expects an integer (got '{raw}')."); + } + + return value; + } +} + +/// +/// Thrown when the terminal host receives malformed command-line arguments. +/// +internal sealed class TerminalHostArgsException(string message) : Exception(message); diff --git a/src/Aspire.TerminalHost/TerminalHostControlListener.cs b/src/Aspire.TerminalHost/TerminalHostControlListener.cs new file mode 100644 index 00000000000..32d87ec65f5 --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalHostControlListener.cs @@ -0,0 +1,215 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Shared.TerminalHost; +using Microsoft.Extensions.Logging; +using StreamJsonRpc; + +namespace Aspire.TerminalHost; + +/// +/// Listens on the control UDS and serves a +/// over StreamJsonRpc to each connecting client (typically the Aspire AppHost). +/// +internal sealed class TerminalHostControlListener : IAsyncDisposable +{ + private readonly string _socketPath; + private readonly TerminalHostControlRpcTarget _target; + private readonly ILogger _logger; + private Socket? _socket; + private Task? _acceptLoop; + private readonly CancellationTokenSource _disposeCts = new(); + private readonly List _activeRpcs = new(); + private readonly object _gate = new(); + private bool _disposed; + + public TerminalHostControlListener( + string socketPath, + TerminalHostControlRpcTarget target, + ILogger logger) + { + ArgumentException.ThrowIfNullOrWhiteSpace(socketPath); + ArgumentNullException.ThrowIfNull(target); + ArgumentNullException.ThrowIfNull(logger); + + _socketPath = socketPath; + _target = target; + _logger = logger; + } + + /// + /// Binds the UDS and starts the background accept loop. + /// + public Task StartAsync() + { + var dir = Path.GetDirectoryName(_socketPath); + if (!string.IsNullOrEmpty(dir)) + { + Directory.CreateDirectory(dir); + } + + if (File.Exists(_socketPath)) + { + try + { + File.Delete(_socketPath); + } + catch (IOException) + { + // Best effort — fall through and let Bind report the error. + } + } + + var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + socket.Bind(new UnixDomainSocketEndPoint(_socketPath)); + socket.Listen(backlog: 5); + _socket = socket; + + _logger.LogInformation("Control listener bound to '{Path}'.", _socketPath); + + _acceptLoop = Task.Run(() => AcceptLoopAsync(_disposeCts.Token)); + return Task.CompletedTask; + } + + private async Task AcceptLoopAsync(CancellationToken cancellationToken) + { + if (_socket is null) + { + return; + } + + while (!cancellationToken.IsCancellationRequested) + { + Socket client; + try + { + client = await _socket.AcceptAsync(cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + return; + } + catch (ObjectDisposedException) + { + return; + } + catch (SocketException ex) + { + _logger.LogDebug(ex, "Control listener accept failed; stopping."); + return; + } + + _ = Task.Run(() => ServeClientAsync(client, cancellationToken), cancellationToken); + } + } + + private async Task ServeClientAsync(Socket client, CancellationToken cancellationToken) + { + await using var stream = new NetworkStream(client, ownsSocket: true); + + var formatter = new SystemTextJsonFormatter(); + var handler = new HeaderDelimitedMessageHandler(stream, stream, formatter); + + var rpc = new JsonRpc(handler); + rpc.AddLocalRpcMethod( + TerminalHostControlProtocol.GetReplicasMethod, + _target.GetType().GetMethod(nameof(TerminalHostControlRpcTarget.GetReplicasAsync))!, + _target); + rpc.AddLocalRpcMethod( + TerminalHostControlProtocol.GetInfoMethod, + _target.GetType().GetMethod(nameof(TerminalHostControlRpcTarget.GetInfoAsync))!, + _target); + rpc.AddLocalRpcMethod( + TerminalHostControlProtocol.ShutdownMethod, + _target.GetType().GetMethod(nameof(TerminalHostControlRpcTarget.ShutdownAsync))!, + _target); + + lock (_gate) + { + if (_disposed) + { + rpc.Dispose(); + return; + } + _activeRpcs.Add(rpc); + } + + try + { + rpc.StartListening(); + await rpc.Completion.WaitAsync(cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + } + catch (Exception ex) + { + _logger.LogDebug(ex, "Control RPC connection ended with an error."); + } + finally + { + lock (_gate) + { + _activeRpcs.Remove(rpc); + } + rpc.Dispose(); + } + } + + public async ValueTask DisposeAsync() + { + lock (_gate) + { + if (_disposed) + { + return; + } + _disposed = true; + } + + await _disposeCts.CancelAsync().ConfigureAwait(false); + + try + { + _socket?.Dispose(); + } + catch + { + // Best effort. + } + + if (_acceptLoop is not null) + { + try + { + await _acceptLoop.ConfigureAwait(false); + } + catch (OperationCanceledException) + { + } + } + + List rpcs; + lock (_gate) + { + rpcs = [.. _activeRpcs]; + _activeRpcs.Clear(); + } + foreach (var rpc in rpcs) + { + rpc.Dispose(); + } + + _disposeCts.Dispose(); + + try + { + File.Delete(_socketPath); + } + catch + { + // Best effort. + } + } +} diff --git a/src/Aspire.TerminalHost/TerminalHostControlRpcTarget.cs b/src/Aspire.TerminalHost/TerminalHostControlRpcTarget.cs new file mode 100644 index 00000000000..aaf7a84b2ea --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalHostControlRpcTarget.cs @@ -0,0 +1,55 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Shared.TerminalHost; + +namespace Aspire.TerminalHost; + +/// +/// StreamJsonRpc target exposed over the terminal host's control UDS. Handles +/// status queries and shutdown requests from the AppHost. +/// +internal sealed class TerminalHostControlRpcTarget +{ + private readonly TerminalHostApp _app; + + public TerminalHostControlRpcTarget(TerminalHostApp app) + { + _app = app; + } + + /// + /// Returns the current set of replica sessions and their liveness state. + /// + public Task GetReplicasAsync(CancellationToken cancellationToken = default) + { + _ = cancellationToken; + var replicas = _app.SnapshotReplicas(); + return Task.FromResult(new TerminalHostReplicasResponse { Replicas = replicas }); + } + + /// + /// Returns the host's protocol version and replica count. Useful as a + /// fast liveness probe and to negotiate future protocol upgrades. + /// + public Task GetInfoAsync(CancellationToken cancellationToken = default) + { + _ = cancellationToken; + return Task.FromResult(new TerminalHostInfoResponse + { + ProtocolVersion = TerminalHostControlProtocol.ProtocolVersion, + ReplicaCount = _app.ReplicaCount, + }); + } + + /// + /// Requests a clean shutdown of the terminal host. The host will tear down + /// each replica relay and exit shortly after this call returns. + /// + public Task ShutdownAsync(CancellationToken cancellationToken = default) + { + _ = cancellationToken; + _app.RequestShutdown(); + return Task.CompletedTask; + } +} diff --git a/src/Aspire.TerminalHost/TerminalReplica.cs b/src/Aspire.TerminalHost/TerminalReplica.cs new file mode 100644 index 00000000000..603c7055bcf --- /dev/null +++ b/src/Aspire.TerminalHost/TerminalReplica.cs @@ -0,0 +1,137 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Hex1b; +using Microsoft.Extensions.Logging; + +namespace Aspire.TerminalHost; + +/// +/// A single replica relay session inside the terminal host. +/// +/// The relay is a that: +/// +/// Consumes HMP v1 frames from the producer UDS (DCP listens here). +/// Maintains internal terminal state via Hex1b's headless presentation. +/// Re-broadcasts HMP v1 frames over the consumer UDS so any number of +/// viewers (Dashboard, CLI) can attach with full state replay. +/// +/// +/// One is owned by the host per replica. They are +/// independent — a crash or exit on one replica does not affect the others. +/// +internal sealed class TerminalReplica : IAsyncDisposable +{ + private readonly ILogger _logger; + private readonly Hex1bTerminal _terminal; + private readonly Task _runTask; + private bool _disposed; + private int? _exitCode; + + public int Index { get; } + public string ProducerUdsPath { get; } + public string ConsumerUdsPath { get; } + + /// + /// True until completes. The terminal is considered alive + /// while it is actively relaying frames; once it completes (upstream EOF, error, + /// or cancellation), the replica is marked dead. + /// + public bool IsAlive => !_runTask.IsCompleted; + + /// + /// Exit code from the relay's + /// once it has completed. Null while alive. + /// + public int? ExitCode => _exitCode; + + /// + /// Task that completes when the relay exits. + /// + public Task RunTask => _runTask; + + private TerminalReplica( + int index, + string producerUdsPath, + string consumerUdsPath, + Hex1bTerminal terminal, + Task runTask, + ILogger logger) + { + Index = index; + ProducerUdsPath = producerUdsPath; + ConsumerUdsPath = consumerUdsPath; + _terminal = terminal; + _runTask = runTask; + _logger = logger; + } + + /// + /// Builds the relay terminal and starts its run loop. The relay does not + /// connect synchronously — the producer connection happens lazily inside + /// the Hex1b workload, so this method always returns quickly. + /// + public static TerminalReplica Start( + int index, + string producerUdsPath, + string consumerUdsPath, + int columns, + int rows, + ILogger logger, + CancellationToken cancellationToken) + { + ArgumentException.ThrowIfNullOrWhiteSpace(producerUdsPath); + ArgumentException.ThrowIfNullOrWhiteSpace(consumerUdsPath); + ArgumentNullException.ThrowIfNull(logger); + + var terminal = Hex1bTerminal.CreateBuilder() + .WithDimensions(columns, rows) + .WithHmp1UdsClient(producerUdsPath) + .WithHmp1UdsServer(consumerUdsPath) + .Build(); + + logger.LogInformation( + "Starting replica {Index}: producer='{Producer}', consumer='{Consumer}'", + index, producerUdsPath, consumerUdsPath); + + var runTask = Task.Run(async () => + { + try + { + var code = await terminal.RunAsync(cancellationToken).ConfigureAwait(false); + logger.LogInformation("Replica {Index} exited with code {ExitCode}.", index, code); + return code; + } + catch (OperationCanceledException) + { + logger.LogInformation("Replica {Index} cancelled.", index); + return 0; + } + catch (Exception ex) + { + logger.LogError(ex, "Replica {Index} terminated with an error.", index); + return -1; + } + }, cancellationToken); + + var replica = new TerminalReplica( + index, producerUdsPath, consumerUdsPath, terminal, runTask, logger); + + _ = runTask.ContinueWith( + t => replica._exitCode = t.IsCompletedSuccessfully ? t.Result : -1, + TaskScheduler.Default); + + return replica; + } + + public async ValueTask DisposeAsync() + { + if (_disposed) + { + return; + } + + _disposed = true; + await _terminal.DisposeAsync().ConfigureAwait(false); + } +} diff --git a/src/Aspire.TerminalHost/TerminalSocketServer.cs b/src/Aspire.TerminalHost/TerminalSocketServer.cs deleted file mode 100644 index e1da6ee1a07..00000000000 --- a/src/Aspire.TerminalHost/TerminalSocketServer.cs +++ /dev/null @@ -1,322 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Net.Sockets; -using System.Text; -using System.Threading.Channels; -using Aspire.Terminal; -using Hex1b; -using Hex1b.Automation; -using Hex1b.Tokens; - -namespace Aspire.TerminalHost; - -/// -/// A Hex1b presentation filter that serves terminal I/O over a Unix domain socket -/// using the Aspire Terminal Protocol. Supports client disconnect and reconnect with -/// automatic terminal state replay. -/// -/// Architecture: -/// - The terminal runs headless (Hex1b manages internal state) -/// - This filter intercepts all output via OnOutputAsync and broadcasts to connected clients -/// - On client connect: snapshot the terminal, send HELLO + screen state, then stream live -/// - On client disconnect: terminal keeps running, ready for new connections -/// -internal sealed class TerminalSocketServer : IHex1bTerminalPresentationFilter, IAsyncDisposable -{ - private readonly string _socketPath; - private readonly int _columns; - private readonly int _rows; - private readonly CancellationTokenSource _disposeCts = new(); - - private Socket? _serverSocket; - private Hex1bTerminal? _terminal; - private ClientSession? _activeSession; - private readonly object _sessionLock = new(); - private bool _disposed; - - private int _currentWidth; - private int _currentHeight; - - public TerminalSocketServer(string socketPath, int columns, int rows) - { - _socketPath = socketPath; - _columns = columns; - _rows = rows; - _currentWidth = columns; - _currentHeight = rows; - } - - /// - /// Sets the terminal reference so the server can create snapshots for reconnection. - /// Must be called before the terminal starts running. - /// - public void SetTerminal(Hex1bTerminal terminal) - { - _terminal = terminal; - } - - /// - /// Starts the UDS listener and accepts client connections in the background. - /// - public Task StartListeningAsync(CancellationToken ct) - { - if (File.Exists(_socketPath)) - { - File.Delete(_socketPath); - } - - var socketDir = Path.GetDirectoryName(_socketPath); - if (socketDir is not null) - { - Directory.CreateDirectory(socketDir); - } - - _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); - _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); - _serverSocket.Listen(backlog: 2); - - Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); - - // Accept connections in the background - _ = AcceptConnectionsAsync(ct); - - return Task.CompletedTask; - } - - private async Task AcceptConnectionsAsync(CancellationToken ct) - { - try - { - while (!ct.IsCancellationRequested && !_disposed) - { - var clientSocket = await _serverSocket!.AcceptAsync(ct).ConfigureAwait(false); - Console.Error.WriteLine("[TerminalHost] Client connected"); - - _ = HandleClientAsync(clientSocket, ct); - } - } - catch (OperationCanceledException) { } - catch (ObjectDisposedException) { } - } - - private async Task HandleClientAsync(Socket clientSocket, CancellationToken ct) - { - var stream = new NetworkStream(clientSocket, ownsSocket: true); - var writer = new TerminalFrameWriter(stream); - var reader = new TerminalFrameReader(stream); - - var outputChannel = Channel.CreateBounded(new BoundedChannelOptions(1000) - { - FullMode = BoundedChannelFullMode.DropOldest, - SingleReader = true, - SingleWriter = false - }); - - var session = new ClientSession(stream, writer, reader, outputChannel); - - // Replace any existing session (single client at a time) - ClientSession? oldSession; - lock (_sessionLock) - { - oldSession = _activeSession; - _activeSession = session; - } - - if (oldSession is not null) - { - await oldSession.DisposeAsync().ConfigureAwait(false); - } - - try - { - // Send HELLO - var flags = TerminalProtocol.HelloFlags.Pty | TerminalProtocol.HelloFlags.Replay; - await writer.WriteHelloAsync( - (ushort)_currentWidth, - (ushort)_currentHeight, - flags, - ct).ConfigureAwait(false); - - // Snapshot and send current terminal state - if (_terminal is not null) - { - using var snapshot = _terminal.CreateSnapshot(); - var ansi = snapshot.ToAnsi(new TerminalAnsiOptions - { - IncludeClearScreen = true, - IncludeCursorPosition = true, - }); - var ansiBytes = Encoding.UTF8.GetBytes(ansi); - await writer.WriteDataAsync(ansiBytes, ct).ConfigureAwait(false); - } - - using var sessionCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); - - // Stream output from channel to client - var outputTask = Task.Run(async () => - { - try - { - await foreach (var data in outputChannel.Reader.ReadAllAsync(sessionCts.Token).ConfigureAwait(false)) - { - await writer.WriteDataAsync(data, sessionCts.Token).ConfigureAwait(false); - } - } - catch (OperationCanceledException) { } - catch (IOException) { } - }, sessionCts.Token); - - // Read input from client and forward to terminal - var inputTask = Task.Run(async () => - { - try - { - while (!sessionCts.Token.IsCancellationRequested) - { - var frame = await reader.ReadFrameAsync(sessionCts.Token).ConfigureAwait(false); - if (frame is null) - { - break; // Client disconnected - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - // Forward input to terminal - if (_terminal is not null) - { - await _terminal.SendInputAsync(frame.Value.Payload, sessionCts.Token).ConfigureAwait(false); - } - break; - - case TerminalProtocol.MessageType.Resize: - var (cols, rows) = frame.Value.ParseResize(); - _terminal?.Resize(cols, rows); - break; - - case TerminalProtocol.MessageType.Close: - return; - } - } - } - catch (OperationCanceledException) { } - catch (IOException) { } - }, sessionCts.Token); - - await Task.WhenAny(outputTask, inputTask).ConfigureAwait(false); - await sessionCts.CancelAsync().ConfigureAwait(false); - - try { await Task.WhenAll(outputTask, inputTask).ConfigureAwait(false); } - catch (OperationCanceledException) { } - } - catch (OperationCanceledException) { } - catch (IOException) { } - finally - { - lock (_sessionLock) - { - if (_activeSession == session) - { - _activeSession = null; - } - } - - await session.DisposeAsync().ConfigureAwait(false); - Console.Error.WriteLine("[TerminalHost] Client disconnected"); - } - } - - #region IHex1bTerminalPresentationFilter - - public ValueTask OnSessionStartAsync(int width, int height, DateTimeOffset timestamp, CancellationToken ct = default) - { - _currentWidth = width; - _currentHeight = height; - return ValueTask.CompletedTask; - } - - public ValueTask> OnOutputAsync(IReadOnlyList appliedTokens, TimeSpan elapsed, CancellationToken ct = default) - { - var tokens = appliedTokens.Select(t => t.Token).ToList(); - - // Broadcast output to the active client session - lock (_sessionLock) - { - if (_activeSession is not null) - { - var ansi = AnsiTokenSerializer.Serialize(tokens); - if (ansi.Length > 0) - { - var bytes = Encoding.UTF8.GetBytes(ansi); - _activeSession.OutputChannel.Writer.TryWrite(bytes); - } - } - } - - return ValueTask.FromResult>(tokens); - } - - public ValueTask OnInputAsync(IReadOnlyList tokens, TimeSpan elapsed, CancellationToken ct = default) - { - return ValueTask.CompletedTask; - } - - public ValueTask OnResizeAsync(int width, int height, TimeSpan elapsed, CancellationToken ct = default) - { - _currentWidth = width; - _currentHeight = height; - return ValueTask.CompletedTask; - } - - public ValueTask OnSessionEndAsync(TimeSpan elapsed, CancellationToken ct = default) - { - return ValueTask.CompletedTask; - } - - #endregion - - public async ValueTask DisposeAsync() - { - if (_disposed) - { - return; - } - - _disposed = true; - await _disposeCts.CancelAsync().ConfigureAwait(false); - - lock (_sessionLock) - { - _activeSession?.OutputChannel.Writer.TryComplete(); - } - - _serverSocket?.Dispose(); - - if (File.Exists(_socketPath)) - { - try { File.Delete(_socketPath); } - catch { /* ignore */ } - } - - _disposeCts.Dispose(); - } - - private sealed class ClientSession( - NetworkStream stream, - TerminalFrameWriter writer, - TerminalFrameReader reader, - Channel outputChannel) : IAsyncDisposable - { - public TerminalFrameWriter Writer => writer; - public TerminalFrameReader Reader => reader; - public Channel OutputChannel => outputChannel; - - public ValueTask DisposeAsync() - { - outputChannel.Writer.TryComplete(); - stream.Dispose(); - return ValueTask.CompletedTask; - } - } -} diff --git a/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs b/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs deleted file mode 100644 index ff7e4a77bd6..00000000000 --- a/src/Aspire.TerminalHost/UnixDomainSocketPresentationAdapter.cs +++ /dev/null @@ -1,204 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Net.Sockets; -using Aspire.Terminal; -using Hex1b; - -namespace Aspire.TerminalHost; - -/// -/// A Hex1b presentation adapter that serves terminal I/O over a Unix domain socket -/// using the Aspire Terminal Protocol (see docs/specs/terminal-protocol.md). -/// -internal sealed class UnixDomainSocketPresentationAdapter : IHex1bTerminalPresentationAdapter -{ - private readonly string _socketPath; - private readonly CancellationTokenSource _disposeCts = new(); - private Socket? _serverSocket; - private Socket? _clientSocket; - private NetworkStream? _clientStream; - private TerminalFrameReader? _reader; - private TerminalFrameWriter? _writer; - private bool _disposed; - private bool _helloSent; - - public UnixDomainSocketPresentationAdapter(string socketPath, int width, int height) - { - _socketPath = socketPath; - Width = width; - Height = height; - } - - public int Width { get; private set; } - public int Height { get; private set; } - - public TerminalCapabilities Capabilities => new() - { - SupportsTrueColor = true, - Supports256Colors = true, - SupportsAlternateScreen = true, - SupportsBracketedPaste = true, - }; - - public event Action? Resized; - public event Action? Disconnected; - - /// - /// Starts listening on the UDS and waits for a client to connect. - /// Sends the HELLO frame once connected. - /// - public async Task WaitForClientAsync(CancellationToken ct) - { - // Clean up stale socket - if (File.Exists(_socketPath)) - { - File.Delete(_socketPath); - } - - var socketDir = Path.GetDirectoryName(_socketPath); - if (socketDir is not null) - { - Directory.CreateDirectory(socketDir); - } - - _serverSocket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); - _serverSocket.Bind(new UnixDomainSocketEndPoint(_socketPath)); - _serverSocket.Listen(backlog: 1); - - Console.Error.WriteLine($"[TerminalHost] Listening on {_socketPath}"); - - _clientSocket = await _serverSocket.AcceptAsync(ct); - _clientStream = new NetworkStream(_clientSocket, ownsSocket: false); - _reader = new TerminalFrameReader(_clientStream); - _writer = new TerminalFrameWriter(_clientStream); - - Console.Error.WriteLine("[TerminalHost] Client connected, sending HELLO"); - - // Send HELLO as the first frame per protocol spec - await _writer.WriteHelloAsync( - (ushort)Width, - (ushort)Height, - TerminalProtocol.HelloFlags.Pty, - ct); - - _helloSent = true; - } - - public async ValueTask WriteOutputAsync(ReadOnlyMemory data, CancellationToken ct = default) - { - if (_disposed || _writer is null || !_helloSent) - { - return; - } - - try - { - await _writer.WriteDataAsync(data, ct); - } - catch (IOException) - { - Disconnected?.Invoke(); - } - catch (SocketException) - { - Disconnected?.Invoke(); - } - } - - public async ValueTask> ReadInputAsync(CancellationToken ct = default) - { - if (_disposed || _reader is null) - { - return ReadOnlyMemory.Empty; - } - - try - { - using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct, _disposeCts.Token); - var frame = await _reader.ReadFrameAsync(linkedCts.Token); - - if (frame is null) - { - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - } - - switch (frame.Value.Type) - { - case TerminalProtocol.MessageType.Data: - return frame.Value.Payload; - - case TerminalProtocol.MessageType.Resize: - var (cols, rows) = frame.Value.ParseResize(); - Width = cols; - Height = rows; - Resized?.Invoke(cols, rows); - return await ReadInputAsync(ct); - - case TerminalProtocol.MessageType.Close: - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - - default: - // Unknown frame type — skip and read next - return await ReadInputAsync(ct); - } - } - catch (OperationCanceledException) - { - return ReadOnlyMemory.Empty; - } - catch (IOException) - { - Disconnected?.Invoke(); - return ReadOnlyMemory.Empty; - } - } - - public ValueTask FlushAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - - // Raw mode is handled by the client side, not the server - public ValueTask EnterRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - public ValueTask ExitRawModeAsync(CancellationToken ct = default) => ValueTask.CompletedTask; - public (int Row, int Column) GetCursorPosition() => (0, 0); - - /// - /// Sends an EXIT frame to the client. - /// - public async ValueTask SendExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) - { - if (_writer is not null && !_disposed) - { - try - { - await _writer.WriteExitAsync(exitCode, reason, ct); - await _writer.WriteCloseAsync(ct); - } - catch { /* best effort */ } - } - } - - public async ValueTask DisposeAsync() - { - if (_disposed) - { - return; - } - - _disposed = true; - await _disposeCts.CancelAsync(); - - _clientStream?.Dispose(); - _clientSocket?.Dispose(); - _serverSocket?.Dispose(); - - if (File.Exists(_socketPath)) - { - try { File.Delete(_socketPath); } - catch { /* ignore cleanup errors */ } - } - - _disposeCts.Dispose(); - } -} diff --git a/src/Shared/Terminal/TerminalFrameReaderWriter.cs b/src/Shared/Terminal/TerminalFrameReaderWriter.cs deleted file mode 100644 index b5c4ca20031..00000000000 --- a/src/Shared/Terminal/TerminalFrameReaderWriter.cs +++ /dev/null @@ -1,221 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using System.Buffers.Binary; - -namespace Aspire.Terminal; - -/// -/// Reads Aspire Terminal Protocol frames from a stream. -/// See docs/specs/terminal-protocol.md for the full specification. -/// -internal sealed class TerminalFrameReader(Stream stream) -{ - private readonly byte[] _headerBuffer = new byte[TerminalProtocol.FrameHeaderSize]; - - /// - /// Reads the next frame from the stream. Returns null if the stream is closed. - /// - public async ValueTask ReadFrameAsync(CancellationToken ct = default) - { - // Read the 5-byte header - var bytesRead = await ReadExactAsync(_headerBuffer, ct).ConfigureAwait(false); - if (bytesRead == 0) - { - return null; // Stream closed - } - - var type = _headerBuffer[0]; - var payloadLength = (int)BinaryPrimitives.ReadUInt32BigEndian(_headerBuffer.AsSpan(1)); - - if (payloadLength > TerminalProtocol.MaxPayloadSize) - { - throw new InvalidOperationException( - $"Terminal protocol error: payload length {payloadLength} exceeds maximum {TerminalProtocol.MaxPayloadSize}."); - } - - // Read the payload - byte[] payload; - if (payloadLength > 0) - { - payload = new byte[payloadLength]; - var payloadRead = await ReadExactAsync(payload, ct).ConfigureAwait(false); - if (payloadRead == 0) - { - return null; // Stream closed mid-frame - } - } - else - { - payload = []; - } - - return new TerminalFrame(type, payload); - } - - /// - /// Reads exactly .Length bytes, handling partial reads. - /// Returns 0 if the stream is closed before any bytes are read. - /// - private async ValueTask ReadExactAsync(byte[] buffer, CancellationToken ct) - { - var offset = 0; - while (offset < buffer.Length) - { - var read = await stream.ReadAsync(buffer.AsMemory(offset, buffer.Length - offset), ct).ConfigureAwait(false); - if (read == 0) - { - return offset == 0 ? 0 : throw new InvalidOperationException( - "Terminal protocol error: stream closed mid-frame."); - } - - offset += read; - } - - return offset; - } -} - -/// -/// Writes Aspire Terminal Protocol frames to a stream. -/// See docs/specs/terminal-protocol.md for the full specification. -/// -internal sealed class TerminalFrameWriter(Stream stream) -{ - private readonly byte[] _headerBuffer = new byte[TerminalProtocol.FrameHeaderSize]; - - /// - /// Writes a frame to the stream. - /// - public async ValueTask WriteFrameAsync(byte type, ReadOnlyMemory payload, CancellationToken ct = default) - { - if (payload.Length > TerminalProtocol.MaxPayloadSize) - { - throw new ArgumentException( - $"Payload length {payload.Length} exceeds maximum {TerminalProtocol.MaxPayloadSize}.", - nameof(payload)); - } - - _headerBuffer[0] = type; - BinaryPrimitives.WriteUInt32BigEndian(_headerBuffer.AsSpan(1), (uint)payload.Length); - - await stream.WriteAsync(_headerBuffer, ct).ConfigureAwait(false); - - if (payload.Length > 0) - { - await stream.WriteAsync(payload, ct).ConfigureAwait(false); - } - - await stream.FlushAsync(ct).ConfigureAwait(false); - } - - /// - /// Writes a HELLO frame with the specified dimensions and flags. - /// - public ValueTask WriteHelloAsync(ushort cols, ushort rows, TerminalProtocol.HelloFlags flags, CancellationToken ct = default) - { - Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Hello]; - payload[0] = TerminalProtocol.Version; - BinaryPrimitives.WriteUInt16BigEndian(payload[1..], cols); - BinaryPrimitives.WriteUInt16BigEndian(payload[3..], rows); - payload[5] = (byte)flags; - return WriteFrameAsync(TerminalProtocol.MessageType.Hello, payload.ToArray(), ct); - } - - /// - /// Writes a DATA frame with the specified raw terminal bytes. - /// - public ValueTask WriteDataAsync(ReadOnlyMemory data, CancellationToken ct = default) - { - return WriteFrameAsync(TerminalProtocol.MessageType.Data, data, ct); - } - - /// - /// Writes a RESIZE frame with the specified dimensions. - /// - public ValueTask WriteResizeAsync(ushort cols, ushort rows, CancellationToken ct = default) - { - Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Resize]; - BinaryPrimitives.WriteUInt16BigEndian(payload, cols); - BinaryPrimitives.WriteUInt16BigEndian(payload[2..], rows); - return WriteFrameAsync(TerminalProtocol.MessageType.Resize, payload.ToArray(), ct); - } - - /// - /// Writes an EXIT frame with the specified exit code and reason. - /// - public ValueTask WriteExitAsync(int exitCode, TerminalProtocol.ExitReason reason, CancellationToken ct = default) - { - Span payload = stackalloc byte[TerminalProtocol.PayloadSize.Exit]; - BinaryPrimitives.WriteInt32BigEndian(payload, exitCode); - payload[4] = (byte)reason; - return WriteFrameAsync(TerminalProtocol.MessageType.Exit, payload.ToArray(), ct); - } - - /// - /// Writes a CLOSE frame. - /// - public ValueTask WriteCloseAsync(CancellationToken ct = default) - { - return WriteFrameAsync(TerminalProtocol.MessageType.Close, ReadOnlyMemory.Empty, ct); - } -} - -/// -/// Represents a single frame in the Aspire Terminal Protocol. -/// -internal readonly record struct TerminalFrame(byte Type, byte[] Payload) -{ - /// - /// Parses the payload as a HELLO message. - /// - public (byte Version, ushort Cols, ushort Rows, TerminalProtocol.HelloFlags Flags) ParseHello() - { - if (Payload.Length < TerminalProtocol.PayloadSize.Hello) - { - throw new InvalidOperationException( - $"Invalid HELLO payload: expected {TerminalProtocol.PayloadSize.Hello} bytes, got {Payload.Length}."); - } - - return ( - Payload[0], - BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(1)), - BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(3)), - (TerminalProtocol.HelloFlags)Payload[5] - ); - } - - /// - /// Parses the payload as a RESIZE message. - /// - public (ushort Cols, ushort Rows) ParseResize() - { - if (Payload.Length < TerminalProtocol.PayloadSize.Resize) - { - throw new InvalidOperationException( - $"Invalid RESIZE payload: expected {TerminalProtocol.PayloadSize.Resize} bytes, got {Payload.Length}."); - } - - return ( - BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(0)), - BinaryPrimitives.ReadUInt16BigEndian(Payload.AsSpan(2)) - ); - } - - /// - /// Parses the payload as an EXIT message. - /// - public (int ExitCode, TerminalProtocol.ExitReason Reason) ParseExit() - { - if (Payload.Length < TerminalProtocol.PayloadSize.Exit) - { - throw new InvalidOperationException( - $"Invalid EXIT payload: expected {TerminalProtocol.PayloadSize.Exit} bytes, got {Payload.Length}."); - } - - return ( - BinaryPrimitives.ReadInt32BigEndian(Payload.AsSpan(0)), - (TerminalProtocol.ExitReason)Payload[4] - ); - } -} diff --git a/src/Shared/Terminal/TerminalProtocol.cs b/src/Shared/Terminal/TerminalProtocol.cs deleted file mode 100644 index 90df23274c9..00000000000 --- a/src/Shared/Terminal/TerminalProtocol.cs +++ /dev/null @@ -1,99 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -namespace Aspire.Terminal; - -/// -/// Constants and types for the Aspire Terminal Protocol. -/// See docs/specs/terminal-protocol.md for the full specification. -/// -internal static class TerminalProtocol -{ - /// - /// Current protocol version. - /// - public const byte Version = 1; - - /// - /// Maximum allowed payload size (1 MiB). - /// - public const int MaxPayloadSize = 1_048_576; - - /// - /// Size of the frame header (1 byte type + 4 bytes length). - /// - public const int FrameHeaderSize = 5; - - /// - /// Frame message types. - /// - public static class MessageType - { - /// Server → Client. First frame on connection with version, dimensions, and flags. - public const byte Hello = 0x01; - - /// Either direction. Raw terminal bytes (PTY output or user input). - public const byte Data = 0x02; - - /// Either direction. Terminal resize notification. - public const byte Resize = 0x03; - - /// Server → Client. Process exited with exit code and reason. - public const byte Exit = 0x04; - - /// Either direction. Graceful session shutdown. - public const byte Close = 0x05; - } - - /// - /// HELLO frame flags. - /// - [Flags] - public enum HelloFlags : byte - { - /// No flags set. - None = 0, - - /// The server has a real PTY allocated. - Pty = 1 << 0, - - /// The server will replay buffered terminal state after HELLO. - Replay = 1 << 1, - } - - /// - /// EXIT frame reason codes. - /// - public enum ExitReason : byte - { - /// Process exited normally. - Exited = 0x00, - - /// Process was killed. - Killed = 0x01, - - /// Server is detaching from the PTY (process may continue). - Detached = 0x02, - - /// Server encountered an unrecoverable error. - Error = 0x03, - } - - /// - /// Fixed payload sizes for structured message types. - /// - public static class PayloadSize - { - /// HELLO: version(1) + cols(2) + rows(2) + flags(1) = 6 bytes. - public const int Hello = 6; - - /// RESIZE: cols(2) + rows(2) = 4 bytes. - public const int Resize = 4; - - /// EXIT: exitCode(4) + reason(1) = 5 bytes. - public const int Exit = 5; - - /// CLOSE: no payload. - public const int Close = 0; - } -} diff --git a/src/Shared/TerminalHost/TerminalHostControlProtocol.cs b/src/Shared/TerminalHost/TerminalHostControlProtocol.cs new file mode 100644 index 00000000000..7625995a4c2 --- /dev/null +++ b/src/Shared/TerminalHost/TerminalHostControlProtocol.cs @@ -0,0 +1,89 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Shared.TerminalHost; + +/// +/// Wire-types exchanged over the terminal host's control UDS via StreamJsonRpc. +/// Shared between the AppHost (caller) and the Aspire.TerminalHost (callee). +/// +internal static class TerminalHostControlProtocol +{ + /// + /// Current control protocol version. Incremented on breaking changes. + /// + public const int ProtocolVersion = 1; + + /// + /// JSON-RPC method name for retrieving the current set of replica sessions. + /// + public const string GetReplicasMethod = "getReplicas"; + + /// + /// JSON-RPC method name for requesting a clean shutdown of the terminal host. + /// + public const string ShutdownMethod = "shutdown"; + + /// + /// JSON-RPC method name for retrieving the protocol/host version. + /// + public const string GetInfoMethod = "getInfo"; +} + +/// +/// Information about a single replica session managed by the terminal host. +/// +internal sealed class TerminalHostReplicaInfo +{ + /// + /// Zero-based replica index. Stable across the lifetime of the host. + /// + public required int Index { get; init; } + + /// + /// Path to the producer-side UDS the host is consuming from (DCP listens on this). + /// + public required string ProducerUdsPath { get; init; } + + /// + /// Path to the consumer-side UDS the host is serving on. Viewers (Dashboard, CLI) + /// connect here. + /// + public required string ConsumerUdsPath { get; init; } + + /// + /// True when the replica's relay terminal is still running. + /// False once the upstream PTY has exited or the relay was torn down. + /// + public required bool IsAlive { get; init; } + + /// + /// Exit code of the upstream process if the replica has terminated. + /// Null while the replica is still alive. + /// + public int? ExitCode { get; init; } +} + +/// +/// Response from . +/// +internal sealed class TerminalHostReplicasResponse +{ + public required TerminalHostReplicaInfo[] Replicas { get; init; } +} + +/// +/// Response from . +/// +internal sealed class TerminalHostInfoResponse +{ + /// + /// Control protocol version. See . + /// + public required int ProtocolVersion { get; init; } + + /// + /// Number of replicas the host was started with. + /// + public required int ReplicaCount { get; init; } +} diff --git a/tests/Aspire.TerminalHost.Tests/Aspire.TerminalHost.Tests.csproj b/tests/Aspire.TerminalHost.Tests/Aspire.TerminalHost.Tests.csproj new file mode 100644 index 00000000000..faf96d24f0e --- /dev/null +++ b/tests/Aspire.TerminalHost.Tests/Aspire.TerminalHost.Tests.csproj @@ -0,0 +1,38 @@ + + + + $(DefaultTargetFramework) + enable + enable + false + + + $(NoWarn);CS8002 + + + false + false + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/Aspire.TerminalHost.Tests/TerminalHostAppTests.cs b/tests/Aspire.TerminalHost.Tests/TerminalHostAppTests.cs new file mode 100644 index 00000000000..1e8c9aeacde --- /dev/null +++ b/tests/Aspire.TerminalHost.Tests/TerminalHostAppTests.cs @@ -0,0 +1,207 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Shared.TerminalHost; +using Microsoft.Extensions.Logging.Abstractions; +using StreamJsonRpc; + +namespace Aspire.TerminalHost.Tests; + +[CollectionDefinition(nameof(TerminalHostAppTestsCollection), DisableParallelization = true)] +public sealed class TerminalHostAppTestsCollection; + +[Collection(nameof(TerminalHostAppTestsCollection))] +public class TerminalHostAppTests +{ + private static (TerminalHostArgs args, TestTempDirectory tmp, string controlPath) BuildArgs(int replicaCount) + { + var tmp = new TestTempDirectory(); + var dcpDir = Path.Combine(tmp.Path, "dcp"); + var hostDir = Path.Combine(tmp.Path, "host"); + var ctrlDir = Path.Combine(tmp.Path, "control"); + Directory.CreateDirectory(dcpDir); + Directory.CreateDirectory(hostDir); + Directory.CreateDirectory(ctrlDir); + + var producers = new string[replicaCount]; + var consumers = new string[replicaCount]; + for (var i = 0; i < replicaCount; i++) + { + producers[i] = Path.Combine(dcpDir, $"r{i}.sock"); + consumers[i] = Path.Combine(hostDir, $"r{i}.sock"); + } + var control = Path.Combine(ctrlDir, "ctrl.sock"); + + var argList = new List { "--replica-count", replicaCount.ToString() }; + foreach (var p in producers) + { + argList.Add("--producer-uds"); + argList.Add(p); + } + foreach (var c in consumers) + { + argList.Add("--consumer-uds"); + argList.Add(c); + } + argList.Add("--control-uds"); + argList.Add(control); + + return (TerminalHostArgs.Parse([.. argList]), tmp, control); + } + + [Fact] + public async Task RunAsyncBindsControlListenerWhenStarted() + { + var (args, tmp, control) = BuildArgs(1); + using var disp = tmp; + + await using var app = new TerminalHostApp(args, NullLoggerFactory.Instance); + using var hostCts = new CancellationTokenSource(); + var hostTask = app.RunAsync(hostCts.Token); + + try + { + await WaitForFileAsync(control, TimeSpan.FromSeconds(10)); + Assert.True(File.Exists(control)); + } + finally + { + app.RequestShutdown(); + hostCts.Cancel(); + await hostTask.WaitAsync(TimeSpan.FromSeconds(10)); + } + } + + [Fact] + public async Task ControlEndpointReturnsReplicaInfo() + { + var (args, tmp, control) = BuildArgs(2); + using var disp = tmp; + + await using var app = new TerminalHostApp(args, NullLoggerFactory.Instance); + using var hostCts = new CancellationTokenSource(); + var hostTask = app.RunAsync(hostCts.Token); + + try + { + await WaitForFileAsync(control, TimeSpan.FromSeconds(10)); + + using var rpc = await OpenControlRpcAsync(control); + var info = await rpc.InvokeAsync( + TerminalHostControlProtocol.GetInfoMethod); + var replicas = await rpc.InvokeAsync( + TerminalHostControlProtocol.GetReplicasMethod); + + Assert.Equal(TerminalHostControlProtocol.ProtocolVersion, info.ProtocolVersion); + Assert.Equal(2, info.ReplicaCount); + Assert.Equal(2, replicas.Replicas.Length); + Assert.Equal(0, replicas.Replicas[0].Index); + Assert.Equal(1, replicas.Replicas[1].Index); + Assert.Equal(args.ProducerUdsPaths[0], replicas.Replicas[0].ProducerUdsPath); + Assert.Equal(args.ConsumerUdsPaths[1], replicas.Replicas[1].ConsumerUdsPath); + } + finally + { + app.RequestShutdown(); + hostCts.Cancel(); + await hostTask.WaitAsync(TimeSpan.FromSeconds(10)); + } + } + + [Fact] + public async Task ShutdownRequestCausesRunAsyncToReturn() + { + var (args, tmp, control) = BuildArgs(1); + using var disp = tmp; + + await using var app = new TerminalHostApp(args, NullLoggerFactory.Instance); + using var hostCts = new CancellationTokenSource(); + var hostTask = app.RunAsync(hostCts.Token); + + await WaitForFileAsync(control, TimeSpan.FromSeconds(10)); + + using (var rpc = await OpenControlRpcAsync(control)) + { + // Fire and forget — the host may close the socket before the RPC ack arrives. + _ = rpc.InvokeAsync(TerminalHostControlProtocol.ShutdownMethod); + } + + var exitCode = await hostTask.WaitAsync(TimeSpan.FromSeconds(10)); + Assert.Equal(0, exitCode); + } + + [Fact] + public async Task SnapshotReplicasReturnsConfiguredReplicas() + { + var (args, tmp, control) = BuildArgs(3); + using var disp = tmp; + + await using var app = new TerminalHostApp(args, NullLoggerFactory.Instance); + using var hostCts = new CancellationTokenSource(); + var hostTask = app.RunAsync(hostCts.Token); + + try + { + await WaitForFileAsync(control, TimeSpan.FromSeconds(10)); + + var snap = app.SnapshotReplicas(); + Assert.Equal(3, snap.Length); + for (var i = 0; i < 3; i++) + { + Assert.Equal(i, snap[i].Index); + Assert.Equal(args.ProducerUdsPaths[i], snap[i].ProducerUdsPath); + Assert.Equal(args.ConsumerUdsPaths[i], snap[i].ConsumerUdsPath); + } + } + finally + { + app.RequestShutdown(); + hostCts.Cancel(); + await hostTask.WaitAsync(TimeSpan.FromSeconds(10)); + } + } + + [Fact] + public async Task RunAsyncWithBadArgsViaStaticEntryPointReturnsExUsage() + { + var exitCode = await TerminalHostApp.RunAsync(["--bogus"], CancellationToken.None); + Assert.Equal(64, exitCode); // EX_USAGE + } + + private static async Task OpenControlRpcAsync(string socketPath) + { + var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + try + { + await socket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath)); + } + catch + { + socket.Dispose(); + throw; + } + + var stream = new NetworkStream(socket, ownsSocket: true); + var formatter = new SystemTextJsonFormatter(); + var handler = new HeaderDelimitedMessageHandler(stream, stream, formatter); + var rpc = new JsonRpc(handler); + rpc.StartListening(); + return rpc; + } + + private static async Task WaitForFileAsync(string path, TimeSpan timeout) + { + var sw = System.Diagnostics.Stopwatch.StartNew(); + while (sw.Elapsed < timeout) + { + if (File.Exists(path)) + { + return; + } + await Task.Delay(50); + } + + throw new TimeoutException($"Timed out waiting for '{path}' after {timeout.TotalSeconds:F1}s."); + } +} diff --git a/tests/Aspire.TerminalHost.Tests/TerminalHostArgsTests.cs b/tests/Aspire.TerminalHost.Tests/TerminalHostArgsTests.cs new file mode 100644 index 00000000000..a8f3f2ef2e7 --- /dev/null +++ b/tests/Aspire.TerminalHost.Tests/TerminalHostArgsTests.cs @@ -0,0 +1,164 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.TerminalHost.Tests; + +public class TerminalHostArgsTests +{ + [Fact] + public void ParseAllRequiredArgsSucceeds() + { + var args = TerminalHostArgs.Parse([ + "--replica-count", "2", + "--producer-uds", "/tmp/p0.sock", + "--producer-uds", "/tmp/p1.sock", + "--consumer-uds", "/tmp/c0.sock", + "--consumer-uds", "/tmp/c1.sock", + "--control-uds", "/tmp/ctrl.sock", + ]); + + Assert.Equal(2, args.ReplicaCount); + Assert.Equal(["/tmp/p0.sock", "/tmp/p1.sock"], args.ProducerUdsPaths); + Assert.Equal(["/tmp/c0.sock", "/tmp/c1.sock"], args.ConsumerUdsPaths); + Assert.Equal("/tmp/ctrl.sock", args.ControlUdsPath); + Assert.Equal(120, args.Columns); + Assert.Equal(30, args.Rows); + Assert.Null(args.Shell); + } + + [Fact] + public void ParseAcceptsOptionalDimensionsAndShell() + { + var args = TerminalHostArgs.Parse([ + "--replica-count", "1", + "--producer-uds", "/tmp/p.sock", + "--consumer-uds", "/tmp/c.sock", + "--control-uds", "/tmp/ctrl.sock", + "--columns", "200", + "--rows", "50", + "--shell", "/bin/bash", + ]); + + Assert.Equal(200, args.Columns); + Assert.Equal(50, args.Rows); + Assert.Equal("/bin/bash", args.Shell); + } + + [Fact] + public void ParseMissingReplicaCountThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--producer-uds", "/tmp/p.sock", + "--consumer-uds", "/tmp/c.sock", + "--control-uds", "/tmp/ctrl.sock", + ])); + + Assert.Contains("--replica-count", ex.Message); + } + + [Fact] + public void ParseMissingControlUdsThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "1", + "--producer-uds", "/tmp/p.sock", + "--consumer-uds", "/tmp/c.sock", + ])); + + Assert.Contains("--control-uds", ex.Message); + } + + [Fact] + public void ParseProducerCountMismatchThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "2", + "--producer-uds", "/tmp/p0.sock", + "--consumer-uds", "/tmp/c0.sock", + "--consumer-uds", "/tmp/c1.sock", + "--control-uds", "/tmp/ctrl.sock", + ])); + + Assert.Contains("--producer-uds", ex.Message); + } + + [Fact] + public void ParseConsumerCountMismatchThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "2", + "--producer-uds", "/tmp/p0.sock", + "--producer-uds", "/tmp/p1.sock", + "--consumer-uds", "/tmp/c0.sock", + "--control-uds", "/tmp/ctrl.sock", + ])); + + Assert.Contains("--consumer-uds", ex.Message); + } + + [Fact] + public void ParseZeroReplicaCountThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "0", + "--control-uds", "/tmp/ctrl.sock", + ])); + + Assert.Contains("--replica-count", ex.Message); + } + + [Fact] + public void ParseNegativeColumnsThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "1", + "--producer-uds", "/tmp/p.sock", + "--consumer-uds", "/tmp/c.sock", + "--control-uds", "/tmp/ctrl.sock", + "--columns", "-5", + ])); + + Assert.Contains("--columns", ex.Message); + } + + [Fact] + public void ParseUnknownArgumentThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "1", + "--producer-uds", "/tmp/p.sock", + "--consumer-uds", "/tmp/c.sock", + "--control-uds", "/tmp/ctrl.sock", + "--bogus", + ])); + + Assert.Contains("--bogus", ex.Message); + } + + [Fact] + public void ParseMissingValueForArgumentThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", + ])); + + Assert.Contains("--replica-count", ex.Message); + } + + [Fact] + public void ParseNonIntegerForReplicaCountThrows() + { + var ex = Assert.Throws(() => TerminalHostArgs.Parse([ + "--replica-count", "abc", + "--control-uds", "/tmp/ctrl.sock", + ])); + + Assert.Contains("--replica-count", ex.Message); + } + + [Fact] + public void ParseNullArgsThrows() + { + Assert.Throws(() => TerminalHostArgs.Parse(null!)); + } +} From a73d19578a3c4376aeb598e29cecb24ad9f426fe Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Mon, 4 May 2026 21:28:03 +1000 Subject: [PATCH 13/20] WithTerminal Phase 4: wire per-replica TerminalSpec into DCP ExecutableCreator ExecutableCreator now populates spec.Terminal per replica when the resource has a TerminalAnnotation, indexing into TerminalHostLayout.ProducerUdsPaths via the ResourceReplicaIndex annotation. Gated on Windows for the 13.4 ship; logs a warning + skips on other platforms (Linux/macOS PTY support tracked as a follow-up). TerminalSpec.cs aligned with the Go-side DCP API in microsoft/dcp PR #133: enabled / udsPath / cols / rows JSON tags with no client-side defaults (DCP applies 80x24 if zero). Adds two DcpExecutorTests cases: Project_WithTerminal_PopulatesPerReplicaTerminalSpecOnWindows (assertion-rich, replica-ordered, Windows-gated) and Project_WithoutTerminal_HasNullTerminalSpec (negative case). Tracking: microsoft/aspire#16317 + microsoft/dcp#6 + DCP PR microsoft/dcp#133. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.Hosting/Dcp/ExecutableCreator.cs | 58 ++++++++++++++--- src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs | 32 ++++++---- .../Dcp/DcpExecutorTests.cs | 63 +++++++++++++++++++ 3 files changed, 130 insertions(+), 23 deletions(-) diff --git a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs index c51876558d1..09684c457c7 100644 --- a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs +++ b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs @@ -7,6 +7,7 @@ using System.Diagnostics; using System.Globalization; +using System.Runtime.InteropServices; using System.Text; using Aspire.Hosting.ApplicationModel; using Aspire.Hosting.Dcp.Model; @@ -105,22 +106,43 @@ public async Task CreateObjectAsync(RenderedModelResource er, EmptyC spec.Env = configuration.EnvironmentVariables.Select(kvp => new EnvVar { Name = kvp.Key, Value = kvp.Value }).ToList(); - // Configure terminal spec if the resource has a TerminalAnnotation. - // Phase 4 of WithTerminal will populate per-replica TerminalSpec values from - // TerminalAnnotation.TerminalHost.Layout.ProducerUdsPaths[replicaIndex]; the - // current ExecutableSpec.Terminal shape (single SocketPath) is being replaced - // with per-replica routing in DCP, so we leave the spec unset here for now. + // Configure the per-replica terminal spec if the resource has a TerminalAnnotation. + // Each replica gets its own DCP UDS producer endpoint from the layout so the + // terminal host can multiplex viewers per (resource, replica). + // + // DCP currently implements PTY support for Executables on Windows only (ConPTY). + // On other platforms we leave Terminal unset, log a warning, and the resource runs + // without an attachable terminal session — the TerminalHostResource itself still + // starts but never receives any HMP v1 producer connection. if (er.ModelResource.TryGetAnnotationsOfType(out var terminalAnnotations)) { var terminalAnnotation = terminalAnnotations.FirstOrDefault(); if (terminalAnnotation is not null) { - spec.Terminal = new TerminalSpec + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { - Enabled = true, - Columns = terminalAnnotation.Options.Columns, - Rows = terminalAnnotation.Options.Rows - }; + _logger.LogWarning( + "WithTerminal() is currently only supported on Windows. Resource '{ResourceName}' will run without an attachable terminal in this Aspire version.", + er.ModelResource.Name); + } + else if (TryGetReplicaIndex(exe, out var replicaIndex) + && replicaIndex >= 0 + && replicaIndex < terminalAnnotation.TerminalHost.Layout.ProducerUdsPaths.Count) + { + spec.Terminal = new TerminalSpec + { + Enabled = true, + UdsPath = terminalAnnotation.TerminalHost.Layout.ProducerUdsPaths[replicaIndex], + Cols = terminalAnnotation.Options.Columns, + Rows = terminalAnnotation.Options.Rows + }; + } + else + { + _logger.LogWarning( + "Could not determine a producer UDS path for replica of resource '{ResourceName}'; terminal will not be attached for this replica.", + er.ModelResource.Name); + } } } @@ -524,4 +546,20 @@ private void EnsureRequiredAnnotations(IResource resource) resource.AddLifeCycleCommands(); _nameGenerator.EnsureDcpInstancesPopulated(resource); } + + private static bool TryGetReplicaIndex(Executable exe, out int replicaIndex) + { + replicaIndex = -1; + if (exe.Metadata.Annotations is not { } annotations) + { + return false; + } + + if (!annotations.TryGetValue(CustomResource.ResourceReplicaIndex, out var value)) + { + return false; + } + + return int.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture, out replicaIndex); + } } diff --git a/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs b/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs index cae29d6f733..109bcd61485 100644 --- a/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs +++ b/src/Aspire.Hosting/Dcp/Model/TerminalSpec.cs @@ -6,34 +6,40 @@ namespace Aspire.Hosting.Dcp.Model; /// -/// Terminal configuration for a DCP resource. When present, DCP allocates a pseudo-terminal -/// and forwards I/O over a Unix domain socket using the Aspire Terminal Protocol. +/// Terminal configuration for a DCP resource. When set, DCP allocates a pseudo-terminal +/// for the process and serves the per-replica HMP v1 producer endpoint at . +/// The Aspire terminal host connects to that endpoint as an HMP v1 client. /// +/// +/// Mirrors api/v1/terminal_types.go in microsoft/dcp; field names and JSON tags must +/// stay in lockstep with the Go side. +/// internal sealed class TerminalSpec { /// - /// Whether terminal (PTY) mode is enabled for this resource. - /// When true, DCP allocates a pseudo-terminal instead of pipes for the process I/O. + /// Whether terminal (PTY) mode is enabled for this resource. When true, DCP allocates + /// a pseudo-terminal instead of pipes for the process I/O and exposes an HMP v1 + /// producer endpoint at . /// [JsonPropertyName("enabled")] public bool Enabled { get; set; } /// - /// Path to the Unix domain socket where DCP will serve the Aspire Terminal Protocol. - /// If not specified, DCP will generate a path and report it in the resource status. + /// Path to the Unix domain socket that DCP listens on for the terminal host's HMP v1 + /// client connection. Required when is true. /// - [JsonPropertyName("socketPath")] - public string? SocketPath { get; set; } + [JsonPropertyName("udsPath")] + public string? UdsPath { get; set; } /// - /// Initial terminal width in columns. + /// Initial terminal width in columns. When 0, DCP applies a default of 80. /// - [JsonPropertyName("columns")] - public int Columns { get; set; } = 120; + [JsonPropertyName("cols")] + public int Cols { get; set; } /// - /// Initial terminal height in rows. + /// Initial terminal height in rows. When 0, DCP applies a default of 24. /// [JsonPropertyName("rows")] - public int Rows { get; set; } = 30; + public int Rows { get; set; } } diff --git a/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs b/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs index 2e8bc748217..2afd779dee0 100644 --- a/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs +++ b/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs @@ -3222,6 +3222,69 @@ public async Task Project_NonProjectLaunchConfig_UnsupportedByExtension_RunsInPr Assert.Equal(ExecutionType.Process, exe.Spec.ExecutionType); } + [Fact] + public async Task Project_WithTerminal_PopulatesPerReplicaTerminalSpecOnWindows() + { + // Phase 4 wire-up: when a project resource is configured with WithTerminal() + // (and runs on Windows where DCP currently supports PTY), each replica's + // Executable spec should carry a Terminal block whose UdsPath matches the + // per-replica producer path from TerminalHostLayout.ProducerUdsPaths. + Assert.SkipUnless(OperatingSystem.IsWindows(), "DCP terminal support is currently Windows-only."); + + var builder = DistributedApplication.CreateBuilder(); + var resource = builder.AddProject("ServiceA") + .WithReplicas(2) + .WithTerminal(options => + { + options.Columns = 100; + options.Rows = 30; + }) + .Resource; + + var kubernetesService = new TestKubernetesService(); + using var app = builder.Build(); + var distributedAppModel = app.Services.GetRequiredService(); + + var appExecutor = CreateAppExecutor(distributedAppModel, kubernetesService: kubernetesService); + await appExecutor.RunApplicationAsync(); + + var exes = kubernetesService.CreatedResources.OfType() + .Where(e => e.AppModelResourceName == "ServiceA") + .OrderBy(e => e.Metadata.Annotations?[CustomResource.ResourceReplicaIndex], StringComparer.Ordinal) + .ToList(); + Assert.Equal(2, exes.Count); + + var layout = resource.Annotations.OfType().Single().TerminalHost.Layout; + Assert.Equal(2, layout.ProducerUdsPaths.Count); + + for (var i = 0; i < exes.Count; i++) + { + var spec = exes[i].Spec.Terminal; + Assert.NotNull(spec); + Assert.True(spec!.Enabled); + Assert.Equal(layout.ProducerUdsPaths[i], spec.UdsPath); + Assert.Equal(100, spec.Cols); + Assert.Equal(30, spec.Rows); + } + } + + [Fact] + public async Task Project_WithoutTerminal_HasNullTerminalSpec() + { + var builder = DistributedApplication.CreateBuilder(); + builder.AddProject("ServiceA"); + + var kubernetesService = new TestKubernetesService(); + using var app = builder.Build(); + var distributedAppModel = app.Services.GetRequiredService(); + + var appExecutor = CreateAppExecutor(distributedAppModel, kubernetesService: kubernetesService); + await appExecutor.RunApplicationAsync(); + + var exe = Assert.Single(kubernetesService.CreatedResources.OfType(), e => e.AppModelResourceName == "ServiceA"); + Assert.Null(exe.Spec.Terminal); + } + private static DcpExecutor CreateAppExecutor( DistributedApplicationModel distributedAppModel, IHostEnvironment? hostEnvironment = null, From 05e6cf3f8be7077e10eb4379731dea6088231b55 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 10:18:40 +1000 Subject: [PATCH 14/20] WithTerminal Phase 5: backchannel exposes per-replica terminal endpoints GetTerminalInfoAsync now opens the hidden terminal host's control UDS, calls getReplicas, and returns a TerminalReplicaInfo[] populated with the AppHost-canonical consumer UDS path for each replica. Connection retries are bounded by a 3 s budget so a request issued while DCP is still launching the host doesn't fail-fast. Wire shape evolution is additive: SocketPath/Columns/Rows are preserved, Replicas is added as a new optional array. Older CLI builds that only check IsAvailable continue to work. New clients gate UI on the new terminals.v1 capability advertised by GetCapabilitiesAsync. Out-of-range replica indices reported by the host are skipped with a warning so a buggy host can never crash a backchannel call. Tests cover the resource-not-found, no-annotation, unreachable-host, happy-path, out-of-range-index, and capability-advertisement scenarios. Tracking: microsoft/aspire#16317. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../AppHostAuxiliaryBackchannel.cs | 4 +- .../BackchannelJsonSerializerContext.cs | 4 + src/Aspire.Hosting/Aspire.Hosting.csproj | 1 + .../AuxiliaryBackchannelRpcTarget.cs | 86 ++++- .../Backchannel/BackchannelDataTypes.cs | 61 +++- .../Backchannel/TerminalHostControlClient.cs | 89 +++++ .../Backchannel/BackchannelContractTests.cs | 6 +- .../Backchannel/GetTerminalInfoAsyncTests.cs | 323 ++++++++++++++++++ 8 files changed, 553 insertions(+), 21 deletions(-) create mode 100644 src/Aspire.Hosting/Backchannel/TerminalHostControlClient.cs create mode 100644 tests/Aspire.Hosting.Tests/Backchannel/GetTerminalInfoAsyncTests.cs diff --git a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs index 57ebbaf0d67..e3a362b23a7 100644 --- a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs +++ b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs @@ -773,8 +773,8 @@ public async Task GetTerminalInfoAsync(string resourceN [request], cancellationToken).ConfigureAwait(false); - _logger?.LogDebug("Terminal info for '{ResourceName}': available={Available}, socket={Socket}", - resourceName, response.IsAvailable, response.SocketPath); + _logger?.LogDebug("Terminal info for '{ResourceName}': available={Available}, replicas={ReplicaCount}", + resourceName, response.IsAvailable, response.Replicas?.Length ?? 0); return response; } diff --git a/src/Aspire.Cli/Backchannel/BackchannelJsonSerializerContext.cs b/src/Aspire.Cli/Backchannel/BackchannelJsonSerializerContext.cs index 397c4194ae1..7943ef4754f 100644 --- a/src/Aspire.Cli/Backchannel/BackchannelJsonSerializerContext.cs +++ b/src/Aspire.Cli/Backchannel/BackchannelJsonSerializerContext.cs @@ -80,6 +80,10 @@ namespace Aspire.Cli.Backchannel; [JsonSerializable(typeof(PipelineStepInfo[]))] [JsonSerializable(typeof(GetPipelineStepsRequest))] [JsonSerializable(typeof(GetPipelineStepsResponse))] +[JsonSerializable(typeof(GetTerminalInfoRequest))] +[JsonSerializable(typeof(GetTerminalInfoResponse))] +[JsonSerializable(typeof(TerminalReplicaInfo))] +[JsonSerializable(typeof(TerminalReplicaInfo[]))] internal partial class BackchannelJsonSerializerContext : JsonSerializerContext { [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification = "Using the Json source generator.")] diff --git a/src/Aspire.Hosting/Aspire.Hosting.csproj b/src/Aspire.Hosting/Aspire.Hosting.csproj index adc80988fc4..4b921f9c0ee 100644 --- a/src/Aspire.Hosting/Aspire.Hosting.csproj +++ b/src/Aspire.Hosting/Aspire.Hosting.csproj @@ -53,6 +53,7 @@ + diff --git a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs index 5b892d50192..9910c57835c 100644 --- a/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs +++ b/src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs @@ -41,7 +41,12 @@ public Task GetCapabilitiesAsync(GetCapabilitiesRequest return Task.FromResult(new GetCapabilitiesResponse { - Capabilities = [AuxiliaryBackchannelCapabilities.V1, AuxiliaryBackchannelCapabilities.V2] + Capabilities = + [ + AuxiliaryBackchannelCapabilities.V1, + AuxiliaryBackchannelCapabilities.V2, + AuxiliaryBackchannelCapabilities.Terminals_V1 + ] }); } @@ -241,11 +246,15 @@ public async Task ExecuteResourceCommandAsync(Ex } /// - /// Gets terminal information for a resource. + /// Gets terminal information for a resource. When the resource is configured with + /// WithTerminal(), this enumerates the per-replica consumer-side UDS endpoints by + /// asking the hidden terminal host process over its control UDS. Returns + /// = false on any failure (no annotation, + /// host not running, control RPC timeout, etc.) so the caller can fall back to a + /// "terminal unavailable" UI without an exception. /// - public Task GetTerminalInfoAsync(GetTerminalInfoRequest request, CancellationToken cancellationToken = default) + public async Task GetTerminalInfoAsync(GetTerminalInfoRequest request, CancellationToken cancellationToken = default) { - _ = cancellationToken; // Required by RPC contract ArgumentNullException.ThrowIfNull(request); var appModel = serviceProvider.GetRequiredService(); @@ -253,26 +262,73 @@ public Task GetTerminalInfoAsync(GetTerminalInfoRequest if (resource is null) { - return Task.FromResult(new GetTerminalInfoResponse { IsAvailable = false }); + logger.LogDebug("GetTerminalInfo: resource '{ResourceName}' not found.", request.ResourceName); + return new GetTerminalInfoResponse { IsAvailable = false }; } var terminalAnnotation = resource.Annotations.OfType().FirstOrDefault(); if (terminalAnnotation is null) { - return Task.FromResult(new GetTerminalInfoResponse { IsAvailable = false }); + logger.LogDebug("GetTerminalInfo: resource '{ResourceName}' has no TerminalAnnotation.", request.ResourceName); + return new GetTerminalInfoResponse { IsAvailable = false }; } - return Task.FromResult(new GetTerminalInfoResponse + var layout = terminalAnnotation.TerminalHost.Layout; + Aspire.Shared.TerminalHost.TerminalHostReplicasResponse hostReplicas; + try + { + hostReplicas = await TerminalHostControlClient.GetReplicasAsync( + layout.ControlUdsPath, + totalTimeout: TimeSpan.FromSeconds(3), + cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) when (!cancellationToken.IsCancellationRequested) + { + logger.LogDebug( + "GetTerminalInfo: timed out waiting for terminal host control RPC for resource '{ResourceName}' (control path '{ControlPath}').", + request.ResourceName, layout.ControlUdsPath); + return new GetTerminalInfoResponse { IsAvailable = false }; + } + catch (Exception ex) when (ex is not OperationCanceledException) + { + logger.LogDebug( + ex, + "GetTerminalInfo: terminal host control RPC failed for resource '{ResourceName}' (control path '{ControlPath}').", + request.ResourceName, layout.ControlUdsPath); + return new GetTerminalInfoResponse { IsAvailable = false }; + } + + var replicas = new List(hostReplicas.Replicas.Length); + foreach (var hostReplica in hostReplicas.Replicas) + { + // The AppHost is the source of truth for the consumer UDS layout. The host echoes + // it back, but if the host's index is out of range we drop the entry rather than + // throw, so a bug in the host can never crash a backchannel call. + if (hostReplica.Index < 0 || hostReplica.Index >= layout.ConsumerUdsPaths.Count) + { + logger.LogWarning( + "GetTerminalInfo: terminal host for resource '{ResourceName}' returned out-of-range replica index {Index} (replica count {Count}); skipping.", + request.ResourceName, hostReplica.Index, layout.ConsumerUdsPaths.Count); + continue; + } + + replicas.Add(new TerminalReplicaInfo + { + ReplicaIndex = hostReplica.Index, + Label = $"replica {hostReplica.Index}", + ConsumerUdsPath = layout.ConsumerUdsPaths[hostReplica.Index], + IsAlive = hostReplica.IsAlive, + ExitCode = hostReplica.ExitCode, + }); + } + + return new GetTerminalInfoResponse { - // Phase 5 of WithTerminal will populate per-replica info (consumer UDS - // paths from TerminalAnnotation.TerminalHost.Layout) over the host's - // control UDS. Until that work lands the response shape only carries - // the legacy single-socket fields, so we report unavailable rather than - // mis-route a stale path that the new host design no longer publishes. - IsAvailable = false, + IsAvailable = true, + Replicas = [.. replicas], Columns = terminalAnnotation.Options.Columns, - Rows = terminalAnnotation.Options.Rows - }); + Rows = terminalAnnotation.Options.Rows, + }; } /// diff --git a/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs b/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs index 00c7c7ce0ea..51c297710c1 100644 --- a/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs +++ b/src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs @@ -43,6 +43,13 @@ internal static class AuxiliaryBackchannelCapabilities /// Version 2 capabilities (13.2+): Request objects, new methods. /// public const string V2 = "aux.v2"; + + /// + /// Terminal feature flag (13.4+): is populated for + /// resources configured with WithTerminal. Older clients ignore the new array; new clients + /// gate UI/CLI affordances on the presence of this capability. + /// + public const string Terminals_V1 = "terminals.v1"; } #endregion @@ -1126,6 +1133,43 @@ internal sealed class GetTerminalInfoRequest public required string ResourceName { get; init; } } +/// +/// Per-replica endpoint information for an interactive terminal session. One entry per +/// replica of a resource configured with WithTerminal. Returned inside +/// when the auxiliary backchannel reports +/// the capability. +/// +internal sealed class TerminalReplicaInfo +{ + /// + /// Gets the zero-based replica index. Stable across the lifetime of the AppHost run. + /// + public required int ReplicaIndex { get; init; } + + /// + /// Gets a short human-readable label for the replica, suitable for selection prompts and logs. + /// + public required string Label { get; init; } + + /// + /// Gets the consumer-side Unix domain socket path that viewers (Dashboard, CLI) connect to in + /// order to attach to this replica's PTY via Hex1b's HMP v1 protocol. + /// + public required string ConsumerUdsPath { get; init; } + + /// + /// Gets a value indicating whether this replica's relay terminal is still running. False once + /// the upstream PTY has exited. + /// + public required bool IsAlive { get; init; } + + /// + /// Gets the exit code of the upstream process if the replica has terminated, or null while it + /// is still alive. + /// + public int? ExitCode { get; init; } +} + /// /// Response containing terminal information for a resource. /// @@ -1137,17 +1181,28 @@ internal sealed class GetTerminalInfoResponse public required bool IsAvailable { get; init; } /// - /// Gets the UDS socket path for terminal I/O, if available. + /// Gets the per-replica endpoint information when is true. + /// Null for older AppHosts that predate the + /// capability. + /// + public TerminalReplicaInfo[]? Replicas { get; init; } + + /// + /// Gets the legacy single-socket UDS path. Always null in 13.4+; preserved on the wire + /// so older CLI builds that deserialize this response keep working without crashing on an + /// unexpected schema. /// public string? SocketPath { get; init; } /// - /// Gets the current terminal width in columns. + /// Gets the AppHost-configured initial terminal width in columns. Hint only; viewers may + /// negotiate a different size after attaching. /// public int Columns { get; init; } /// - /// Gets the current terminal height in rows. + /// Gets the AppHost-configured initial terminal height in rows. Hint only; viewers may + /// negotiate a different size after attaching. /// public int Rows { get; init; } } diff --git a/src/Aspire.Hosting/Backchannel/TerminalHostControlClient.cs b/src/Aspire.Hosting/Backchannel/TerminalHostControlClient.cs new file mode 100644 index 00000000000..966754fd5f3 --- /dev/null +++ b/src/Aspire.Hosting/Backchannel/TerminalHostControlClient.cs @@ -0,0 +1,89 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Shared.TerminalHost; +using StreamJsonRpc; + +namespace Aspire.Hosting.Backchannel; + +/// +/// AppHost-side client for the terminal host's control UDS. Opens a fresh JsonRpc +/// connection per call, invokes the requested method, and disposes the connection. +/// +/// +/// Connection retries are bounded by the per-call totalTimeout with a short per-attempt +/// delay so that a control RPC issued shortly after the AppHost has asked DCP to launch the +/// host doesn't see a transient connection-refused error. +/// +internal static class TerminalHostControlClient +{ + private static readonly TimeSpan s_defaultRetryDelay = TimeSpan.FromMilliseconds(150); + + /// + /// Opens the control UDS at and invokes + /// , returning the host's + /// snapshot of replica session state. Throws on transport failures and times out per + /// . + /// + public static async Task GetReplicasAsync( + string socketPath, + TimeSpan totalTimeout, + CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(socketPath); + + using var timeoutCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); + timeoutCts.CancelAfter(totalTimeout); + + using var rpc = await ConnectWithRetryAsync(socketPath, timeoutCts.Token).ConfigureAwait(false); + + return await rpc.InvokeWithCancellationAsync( + TerminalHostControlProtocol.GetReplicasMethod, + arguments: null, + timeoutCts.Token).ConfigureAwait(false); + } + + private static async Task ConnectWithRetryAsync(string socketPath, CancellationToken cancellationToken) + { + // Bounded retry loop: keep trying to connect until the linked timeout fires. + // The host's accept loop binds the UDS during StartAsync, but if the AppHost + // races the host process startup we want to wait for it rather than fail-fast. + SocketException? lastException = null; + while (!cancellationToken.IsCancellationRequested) + { + var socket = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + try + { + await socket.ConnectAsync(new UnixDomainSocketEndPoint(socketPath), cancellationToken).ConfigureAwait(false); + var stream = new NetworkStream(socket, ownsSocket: true); + var formatter = new SystemTextJsonFormatter(); + var handler = new HeaderDelimitedMessageHandler(stream, stream, formatter); + var rpc = new JsonRpc(handler); + rpc.StartListening(); + return rpc; + } + catch (SocketException ex) + { + socket.Dispose(); + lastException = ex; + try + { + await Task.Delay(s_defaultRetryDelay, cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + break; + } + } + catch + { + socket.Dispose(); + throw; + } + } + + cancellationToken.ThrowIfCancellationRequested(); + throw lastException ?? new SocketException(); + } +} diff --git a/tests/Aspire.Hosting.Tests/Backchannel/BackchannelContractTests.cs b/tests/Aspire.Hosting.Tests/Backchannel/BackchannelContractTests.cs index 9ce409a6212..45cc1961dd8 100644 --- a/tests/Aspire.Hosting.Tests/Backchannel/BackchannelContractTests.cs +++ b/tests/Aspire.Hosting.Tests/Backchannel/BackchannelContractTests.cs @@ -30,6 +30,9 @@ public class BackchannelContractTests typeof(McpToolContentItem), typeof(StopAppHostRequest), typeof(StopAppHostResponse), + typeof(GetTerminalInfoRequest), + typeof(GetTerminalInfoResponse), + typeof(TerminalReplicaInfo), typeof(ResourceSnapshot), typeof(ResourceSnapshotUrl), typeof(ResourceSnapshotUrlDisplayProperties), @@ -76,7 +79,8 @@ public void BackchannelTypes_FollowContractRules() // Rule 6: Naming convention (skip helper types) if (!type.Name.StartsWith("ResourceSnapshot") && type.Name != "McpToolContentItem" && - type.Name != "ResourceLogLine") + type.Name != "ResourceLogLine" && + type.Name != "TerminalReplicaInfo") { if (!type.Name.EndsWith("Request") && !type.Name.EndsWith("Response")) { diff --git a/tests/Aspire.Hosting.Tests/Backchannel/GetTerminalInfoAsyncTests.cs b/tests/Aspire.Hosting.Tests/Backchannel/GetTerminalInfoAsyncTests.cs new file mode 100644 index 00000000000..0ad27c9161b --- /dev/null +++ b/tests/Aspire.Hosting.Tests/Backchannel/GetTerminalInfoAsyncTests.cs @@ -0,0 +1,323 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Net.Sockets; +using Aspire.Hosting.Backchannel; +using Aspire.Shared.TerminalHost; +using Microsoft.AspNetCore.InternalTesting; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging.Abstractions; +using StreamJsonRpc; + +namespace Aspire.Hosting.Tests.Backchannel; + +[Trait("Partition", "4")] +public class GetTerminalInfoAsyncTests : IAsyncDisposable +{ + private readonly List _toDispose = []; + private readonly List _tempDirs = []; + + [Fact] + public async Task ReturnsUnavailable_WhenResourceDoesNotExist() + { + var (model, _) = BuildModel(replicaCount: 1, controlListener: null); + + var target = CreateTarget(model); + + var result = await target.GetTerminalInfoAsync( + new GetTerminalInfoRequest { ResourceName = "nope" }).DefaultTimeout(); + + Assert.False(result.IsAvailable); + Assert.Null(result.Replicas); + } + + [Fact] + public async Task ReturnsUnavailable_WhenResourceHasNoTerminalAnnotation() + { + var model = new DistributedApplicationModel(new ResourceCollection + { + new CustomResource("plain"), + }); + + var target = CreateTarget(model); + + var result = await target.GetTerminalInfoAsync( + new GetTerminalInfoRequest { ResourceName = "plain" }).DefaultTimeout(); + + Assert.False(result.IsAvailable); + Assert.Null(result.Replicas); + } + + [Fact] + public async Task ReturnsUnavailable_WhenControlSocketIsUnreachable() + { + // Build a layout pointing at a control socket nobody is listening on. The retry loop + // should burn its 3-second budget and report unavailable rather than throw. + var (model, _) = BuildModel(replicaCount: 2, controlListener: null); + + var target = CreateTarget(model); + + var result = await target.GetTerminalInfoAsync( + new GetTerminalInfoRequest { ResourceName = "myapp" }).DefaultTimeout(TimeSpan.FromSeconds(10)); + + Assert.False(result.IsAvailable); + Assert.Null(result.Replicas); + } + + [Fact] + public async Task ReturnsPerReplicaInfo_WhenHostIsReachable() + { + var hostReplicas = new[] + { + new TerminalHostReplicaInfo + { + Index = 0, + ProducerUdsPath = "ignored-by-apphost", + ConsumerUdsPath = "host-claim-r0", + IsAlive = true, + }, + new TerminalHostReplicaInfo + { + Index = 1, + ProducerUdsPath = "ignored-by-apphost", + ConsumerUdsPath = "host-claim-r1", + IsAlive = false, + ExitCode = 7, + }, + }; + var fakeHost = await StartFakeControlHostAsync(hostReplicas).DefaultTimeout(); + + var (model, layout) = BuildModel( + replicaCount: 2, + controlListener: fakeHost); + + var target = CreateTarget(model); + + var result = await target.GetTerminalInfoAsync( + new GetTerminalInfoRequest { ResourceName = "myapp" }).DefaultTimeout(TimeSpan.FromSeconds(10)); + + Assert.True(result.IsAvailable); + Assert.Equal(132, result.Columns); + Assert.Equal(40, result.Rows); + Assert.Null(result.SocketPath); + + Assert.NotNull(result.Replicas); + Assert.Equal(2, result.Replicas!.Length); + + Assert.Equal(0, result.Replicas[0].ReplicaIndex); + Assert.Equal("replica 0", result.Replicas[0].Label); + // AppHost is the source of truth for the consumer UDS path even though the host + // echoed back its own claim — verify we trust the layout. + Assert.Equal(layout.ConsumerUdsPaths[0], result.Replicas[0].ConsumerUdsPath); + Assert.True(result.Replicas[0].IsAlive); + Assert.Null(result.Replicas[0].ExitCode); + + Assert.Equal(1, result.Replicas[1].ReplicaIndex); + Assert.Equal("replica 1", result.Replicas[1].Label); + Assert.Equal(layout.ConsumerUdsPaths[1], result.Replicas[1].ConsumerUdsPath); + Assert.False(result.Replicas[1].IsAlive); + Assert.Equal(7, result.Replicas[1].ExitCode); + } + + [Fact] + public async Task SkipsOutOfRangeIndices_FromMisbehavingHost() + { + var hostReplicas = new[] + { + new TerminalHostReplicaInfo { Index = 0, ProducerUdsPath = "p0", ConsumerUdsPath = "c0", IsAlive = true }, + new TerminalHostReplicaInfo { Index = 99, ProducerUdsPath = "px", ConsumerUdsPath = "cx", IsAlive = true }, + new TerminalHostReplicaInfo { Index = -1, ProducerUdsPath = "py", ConsumerUdsPath = "cy", IsAlive = true }, + }; + var fakeHost = await StartFakeControlHostAsync(hostReplicas).DefaultTimeout(); + + var (model, layout) = BuildModel(replicaCount: 1, controlListener: fakeHost); + + var target = CreateTarget(model); + + var result = await target.GetTerminalInfoAsync( + new GetTerminalInfoRequest { ResourceName = "myapp" }).DefaultTimeout(TimeSpan.FromSeconds(10)); + + Assert.True(result.IsAvailable); + Assert.NotNull(result.Replicas); + var single = Assert.Single(result.Replicas!); + Assert.Equal(0, single.ReplicaIndex); + Assert.Equal(layout.ConsumerUdsPaths[0], single.ConsumerUdsPath); + } + + [Fact] + public async Task GetCapabilities_AdvertisesTerminalsV1() + { + var model = new DistributedApplicationModel(new ResourceCollection()); + var target = CreateTarget(model); + + var result = await target.GetCapabilitiesAsync().DefaultTimeout(); + + Assert.Contains(AuxiliaryBackchannelCapabilities.V1, result.Capabilities); + Assert.Contains(AuxiliaryBackchannelCapabilities.V2, result.Capabilities); + Assert.Contains(AuxiliaryBackchannelCapabilities.Terminals_V1, result.Capabilities); + } + + private (DistributedApplicationModel Model, TerminalHostLayout Layout) BuildModel( + int replicaCount, + FakeControlHost? controlListener) + { + var baseDir = CreateShortTempDir(); + Directory.CreateDirectory(Path.Combine(baseDir, "dcp")); + Directory.CreateDirectory(Path.Combine(baseDir, "host")); + + var producer = new string[replicaCount]; + var consumer = new string[replicaCount]; + for (var i = 0; i < replicaCount; i++) + { + producer[i] = Path.Combine(baseDir, "dcp", $"r{i}.sock"); + consumer[i] = Path.Combine(baseDir, "host", $"r{i}.sock"); + } + + // If a fake host is supplied, point the layout at its real socket path. Otherwise use + // a path that does not exist — the retry loop will exhaust its budget and IsAvailable + // will be false, exercising the unreachable path. + var controlPath = controlListener?.SocketPath ?? Path.Combine(baseDir, "control.sock"); + var layout = new TerminalHostLayout(baseDir, producer, consumer, controlPath); + + var target = new CustomResource("myapp"); + var host = new TerminalHostResource("myapp-terminalhost", target, layout); + var annotation = new TerminalAnnotation(host, new TerminalOptions { Columns = 132, Rows = 40 }); + target.Annotations.Add(annotation); + + var model = new DistributedApplicationModel(new ResourceCollection + { + target, + host, + }); + + return (model, layout); + } + + private static AuxiliaryBackchannelRpcTarget CreateTarget(DistributedApplicationModel model) + { + var services = new ServiceCollection(); + services.AddSingleton(model); + var sp = services.BuildServiceProvider(); + return new AuxiliaryBackchannelRpcTarget(NullLogger.Instance, sp); + } + + private async Task StartFakeControlHostAsync(TerminalHostReplicaInfo[] replicas) + { + var dir = CreateShortTempDir(); + var socketPath = Path.Combine(dir, "ctrl.sock"); + var host = new FakeControlHost(socketPath, replicas); + await host.StartAsync().ConfigureAwait(false); + _toDispose.Add(host); + return host; + } + + private string CreateShortTempDir() + { + // Windows has a 108-byte limit on AF_UNIX paths (and 104 on macOS), and the default + // %TEMP% can be deep. Allocate a short subdirectory we control. + var dir = Directory.CreateTempSubdirectory("at-").FullName; + _tempDirs.Add(dir); + return dir; + } + + public async ValueTask DisposeAsync() + { + foreach (var d in _toDispose) + { + try { await d.DisposeAsync().ConfigureAwait(false); } + catch { } + } + foreach (var dir in _tempDirs) + { + try { Directory.Delete(dir, recursive: true); } + catch { } + } + } + + private sealed class FakeControlHost(string socketPath, TerminalHostReplicaInfo[] replicas) : IAsyncDisposable + { + private Socket? _listenSocket; + private CancellationTokenSource? _cts; + private Task? _acceptLoop; + private readonly List _rpcs = []; + + public string SocketPath { get; } = socketPath; + + public Task StartAsync() + { + var dir = Path.GetDirectoryName(SocketPath); + if (!string.IsNullOrEmpty(dir)) + { + Directory.CreateDirectory(dir); + } + + var sock = new Socket(AddressFamily.Unix, SocketType.Stream, ProtocolType.Unspecified); + sock.Bind(new UnixDomainSocketEndPoint(SocketPath)); + sock.Listen(8); + _listenSocket = sock; + + _cts = new CancellationTokenSource(); + _acceptLoop = Task.Run(() => AcceptLoopAsync(_cts.Token)); + return Task.CompletedTask; + } + + private async Task AcceptLoopAsync(CancellationToken ct) + { + while (!ct.IsCancellationRequested) + { + Socket client; + try + { + client = await _listenSocket!.AcceptAsync(ct).ConfigureAwait(false); + } + catch + { + return; + } + + _ = Task.Run(async () => + { + var stream = new NetworkStream(client, ownsSocket: true); + var formatter = new SystemTextJsonFormatter(); + var handler = new HeaderDelimitedMessageHandler(stream, stream, formatter); + var rpc = new JsonRpc(handler); + + rpc.AddLocalRpcMethod( + TerminalHostControlProtocol.GetReplicasMethod, + new Func(() => new TerminalHostReplicasResponse { Replicas = replicas })); + + lock (_rpcs) + { + _rpcs.Add(rpc); + } + + rpc.StartListening(); + try { await rpc.Completion.ConfigureAwait(false); } + catch { } + }, ct); + } + } + + public async ValueTask DisposeAsync() + { + try { _cts?.Cancel(); } catch { } + try { _listenSocket?.Dispose(); } catch { } + if (_acceptLoop is not null) + { + try { await _acceptLoop.ConfigureAwait(false); } catch { } + } + lock (_rpcs) + { + foreach (var rpc in _rpcs) + { + try { rpc.Dispose(); } catch { } + } + _rpcs.Clear(); + } + try { File.Delete(SocketPath); } catch { } + _cts?.Dispose(); + } + } + + private sealed class CustomResource(string name) : Resource(name); +} From d0a6664f1542f97f9ad9165e68f6799af5dc57d5 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 10:37:46 +1000 Subject: [PATCH 15/20] WithTerminal Phase 6: aspire terminal CLI command on Hex1b HMP v1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replaces the placeholder TerminalCommand with the full discovery, selection, and attach flow defined in the Phase 6 plan. - Add IAppHostAuxiliaryBackchannel.SupportsTerminalsV1 capability gate alongside the existing SupportsV2 surface so the CLI can fail fast against pre-13.4 AppHosts with a clear "Update Aspire.Hosting" message instead of a misleading "resource not found" or socket-connect error. - Add Hex1b PackageReference to Aspire.Cli (already pinned via Directory.Packages.props; Hex1b 0.135+ is fully Native AOT-compatible so no new IL/AOT warnings are introduced versus the baseline). - TerminalCommand flow: 1. Resolve AppHost via AppHostConnectionResolver. 2. Verify SupportsTerminalsV1; otherwise return AppHostIncompatible. 3. Look up the resource via ResourceSnapshotMapper.WhereMatchesResourceName (matches by Name OR DisplayName so users can target replicated resources by the parent name). 4. Canonicalise to the parent name (matches[0].DisplayName ?? Name) so GetTerminalInfoAsync receives the same identifier the AppHost knows. 5. Call backchannel.GetTerminalInfoAsync. 6. Pick a replica: - --replica/-r N → exact match (out-of-range → InvalidCommand) - 1 replica → auto-pick - non-interactive → require --replica explicitly - interactive multi → PromptForSelectionAsync 7. If the chosen replica has exited, warn and continue (the historical buffer is still served via HMP v1 StateSync). 8. Hand off to Hex1bTerminal.CreateBuilder().WithHmp1UdsClient(...).Build() and await RunAsync. Ctrl+C cancels via the SCL cancellation token. - Catches OperationCanceledException, SocketException, and IOException(SocketException) explicitly so connect failures and mid-session disconnects produce friendly messages instead of stack traces. Tests (10 new in TerminalCommandTests): - Help works. - Missing resource argument fails parsing. - No running AppHost returns Success (matches LogsCommand convention). - Lacking SupportsTerminalsV1 returns AppHostIncompatible. - Resource not found returns InvalidCommand. - IsAvailable=false / empty replicas array return InvalidCommand. - --replica out-of-range returns InvalidCommand. - DisplayName lookup canonicalises to the parent resource name when calling GetTerminalInfoAsync (verified via a CapturingTerminalAppHostBackchannel decorator). - Non-interactive multi-replica without --replica returns InvalidCommand. The CLI test helper now registers TerminalCommand alongside the other commands so the new tests can resolve the RootCommand. --- src/Aspire.Cli/Aspire.Cli.csproj | 1 + .../AppHostAuxiliaryBackchannel.cs | 3 + .../IAppHostAuxiliaryBackchannel.cs | 7 + src/Aspire.Cli/Commands/TerminalCommand.cs | 209 +++++++++- .../Commands/TerminalCommandTests.cs | 364 ++++++++++++++++++ .../TestAppHostAuxiliaryBackchannel.cs | 1 + tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs | 1 + 7 files changed, 570 insertions(+), 16 deletions(-) create mode 100644 tests/Aspire.Cli.Tests/Commands/TerminalCommandTests.cs diff --git a/src/Aspire.Cli/Aspire.Cli.csproj b/src/Aspire.Cli/Aspire.Cli.csproj index 887be4f50bb..0f2701a13f4 100644 --- a/src/Aspire.Cli/Aspire.Cli.csproj +++ b/src/Aspire.Cli/Aspire.Cli.csproj @@ -47,6 +47,7 @@ + diff --git a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs index e3a362b23a7..ab2e7923203 100644 --- a/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs +++ b/src/Aspire.Cli/Backchannel/AppHostAuxiliaryBackchannel.cs @@ -76,6 +76,9 @@ internal AppHostAuxiliaryBackchannel( /// public bool SupportsV2 => _capabilities.Contains(AuxiliaryBackchannelCapabilities.V2); + /// + public bool SupportsTerminalsV1 => _capabilities.Contains(AuxiliaryBackchannelCapabilities.Terminals_V1); + /// /// Gets the JSON-RPC proxy for communicating with the AppHost. /// diff --git a/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs b/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs index 4dff13fae47..e3043b532d0 100644 --- a/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs +++ b/src/Aspire.Cli/Backchannel/IAppHostAuxiliaryBackchannel.cs @@ -41,6 +41,13 @@ internal interface IAppHostAuxiliaryBackchannel : IDisposable /// bool SupportsV2 { get; } + /// + /// Gets a value indicating whether the AppHost advertises the + /// terminals.v1 capability — the per-replica terminal info + /// surface returned by . + /// + bool SupportsTerminalsV1 { get; } + /// /// Gets the Dashboard URLs from the AppHost. /// diff --git a/src/Aspire.Cli/Commands/TerminalCommand.cs b/src/Aspire.Cli/Commands/TerminalCommand.cs index d367441ebf3..94ca3cf2294 100644 --- a/src/Aspire.Cli/Commands/TerminalCommand.cs +++ b/src/Aspire.Cli/Commands/TerminalCommand.cs @@ -2,30 +2,42 @@ // The .NET Foundation licenses this file to you under the MIT license. using System.CommandLine; +using System.Diagnostics; +using System.Globalization; +using System.Net.Sockets; using Aspire.Cli.Backchannel; using Aspire.Cli.Configuration; using Aspire.Cli.Interaction; +using Aspire.Cli.Resources; using Aspire.Cli.Telemetry; using Aspire.Cli.Utils; +using Hex1b; using Microsoft.Extensions.Logging; namespace Aspire.Cli.Commands; /// -/// Attaches to an interactive terminal session for a resource. -/// -/// PHASE 6 PENDING: this command is a placeholder during the WithTerminal end-to-end -/// refactor. Once the per-replica HMP v1 wiring lands (Phases 4 + 5), this command -/// will: (1) call the auxiliary backchannel's GetTerminalInfoAsync to discover -/// per-replica consumer UDS paths, (2) prompt the user to pick a replica when there -/// is more than one, and (3) attach via Hex1b's HMP v1 client to bridge the local -/// terminal to the chosen replica. +/// Attaches the local terminal to an interactive PTY session for a resource that +/// was registered with WithTerminal(). /// +/// +/// The command: +/// 1. Resolves the running AppHost via . +/// 2. Verifies the AppHost advertises the terminals.v1 capability. +/// 3. Looks up the resource (by Name or DisplayName) and asks the AppHost for the +/// list of terminal replicas via . +/// 4. Picks a replica (auto if 1; --replica N if specified; interactive prompt +/// otherwise; errors in non-interactive contexts when no --replica is given). +/// 5. Hands the local console off to a Hex1b HMP v1 client connected to the chosen +/// replica's consumer UDS endpoint exposed by the hidden Aspire.TerminalHost. +/// internal sealed class TerminalCommand : BaseCommand { internal override HelpGroup HelpGroup => HelpGroup.Monitoring; private readonly IInteractionService _interactionService; + private readonly AppHostConnectionResolver _connectionResolver; + private readonly ILogger _logger; private static readonly Argument s_resourceArgument = new("resource") { @@ -33,7 +45,12 @@ internal sealed class TerminalCommand : BaseCommand }; private static readonly OptionWithLegacy s_appHostOption = - new("--apphost", "--project", Resources.SharedCommandStrings.AppHostOptionDescription); + new("--apphost", "--project", SharedCommandStrings.AppHostOptionDescription); + + private static readonly Option s_replicaOption = new("--replica", "-r") + { + Description = "The 0-based replica index to attach to. Required when the resource has more than one replica and the CLI is not running interactively." + }; public TerminalCommand( IInteractionService interactionService, @@ -46,18 +63,178 @@ public TerminalCommand( : base("terminal", "Attach to an interactive terminal session for a resource.", features, updateNotifier, executionContext, interactionService, telemetry) { _interactionService = interactionService; - _ = backchannelMonitor; - _ = logger; + _logger = logger; + _connectionResolver = new AppHostConnectionResolver(backchannelMonitor, interactionService, executionContext, logger); Arguments.Add(s_resourceArgument); Options.Add(s_appHostOption); + Options.Add(s_replicaOption); + } + + protected override async Task ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken) + { + using var activity = Telemetry.StartDiagnosticActivity(Name); + + var resourceName = parseResult.GetValue(s_resourceArgument)!; + var passedAppHostProjectFile = parseResult.GetValue(s_appHostOption); + var requestedReplica = parseResult.GetValue(s_replicaOption); + + if (string.IsNullOrWhiteSpace(resourceName)) + { + _interactionService.DisplayError("A resource name is required."); + return ExitCodeConstants.InvalidCommand; + } + + var connectionResult = await _connectionResolver.ResolveConnectionAsync( + passedAppHostProjectFile, + SharedCommandStrings.ScanningForRunningAppHosts, + string.Format(CultureInfo.CurrentCulture, SharedCommandStrings.SelectAppHost, "attach a terminal"), + SharedCommandStrings.AppHostNotRunning, + cancellationToken); + + if (!connectionResult.Success) + { + _interactionService.DisplayMessage(KnownEmojis.Information, connectionResult.ErrorMessage); + return ExitCodeConstants.Success; + } + + var connection = connectionResult.Connection!; + + if (!connection.SupportsTerminalsV1) + { + _interactionService.DisplayError( + "The connected AppHost does not support 'aspire terminal'. Update Aspire.Hosting to 13.4 or later."); + return ExitCodeConstants.AppHostIncompatible; + } + + var snapshots = await _interactionService.ShowStatusAsync( + "Looking up resource...", + async () => await connection.GetResourceSnapshotsAsync(includeHidden: true, cancellationToken).ConfigureAwait(false)); + + var matches = ResourceSnapshotMapper.WhereMatchesResourceName(snapshots, resourceName).ToList(); + if (matches.Count == 0) + { + _interactionService.DisplayError(string.Format(CultureInfo.CurrentCulture, + "Resource '{0}' was not found.", resourceName)); + return ExitCodeConstants.InvalidCommand; + } + + // For replicated resources, all snapshots share the same DisplayName which + // matches the parent resource name (the one carrying the TerminalAnnotation). + // Fall back to Name for non-replicated resources where DisplayName is null/equal. + var canonicalName = !string.IsNullOrEmpty(matches[0].DisplayName) + ? matches[0].DisplayName! + : matches[0].Name; + + var info = await _interactionService.ShowStatusAsync( + "Discovering terminal sessions...", + async () => await connection.GetTerminalInfoAsync(canonicalName, cancellationToken).ConfigureAwait(false)); + + if (!info.IsAvailable || info.Replicas is null || info.Replicas.Length == 0) + { + _interactionService.DisplayError(string.Format(CultureInfo.CurrentCulture, + "Resource '{0}' is not available for terminal attachment. Make sure the resource was registered with '.WithTerminal()' and that the terminal host has started.", + canonicalName)); + return ExitCodeConstants.InvalidCommand; + } + + var (replica, selectionError) = await SelectReplicaAsync(info.Replicas, requestedReplica, canonicalName, cancellationToken).ConfigureAwait(false); + if (selectionError != ExitCodeConstants.Success) + { + return selectionError; + } + Debug.Assert(replica is not null, "SelectReplicaAsync returns a non-null replica when error == Success."); + + if (!replica!.IsAlive) + { + _interactionService.DisplayMessage(KnownEmojis.Warning, + string.Format(CultureInfo.CurrentCulture, + "Replica {0} of '{1}' has exited (code {2}). Attaching to the historical buffer; no live input will be sent.", + replica.ReplicaIndex, + canonicalName, + replica.ExitCode?.ToString(CultureInfo.InvariantCulture) ?? "unknown")); + } + + _interactionService.DisplayMessage(KnownEmojis.Information, + string.Format(CultureInfo.CurrentCulture, + "Attaching to '{0}' replica {1}. Press Ctrl+C to detach.", + canonicalName, + replica.ReplicaIndex)); + + try + { + await using var terminal = Hex1bTerminal.CreateBuilder() + .WithHmp1UdsClient(replica.ConsumerUdsPath) + .Build(); + + return await terminal.RunAsync(cancellationToken).ConfigureAwait(false); + } + catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested) + { + return ExitCodeConstants.Success; + } + catch (SocketException ex) + { + _logger.LogDebug(ex, "Failed to connect to terminal at {Path}", replica.ConsumerUdsPath); + _interactionService.DisplayError(string.Format(CultureInfo.CurrentCulture, + "Could not connect to terminal session for '{0}' (replica {1}). Is the AppHost still running?", + canonicalName, replica.ReplicaIndex)); + return ExitCodeConstants.FailedToExecuteResourceCommand; + } + catch (IOException ex) when (ex.InnerException is SocketException) + { + _logger.LogDebug(ex, "Terminal session connection lost at {Path}", replica.ConsumerUdsPath); + _interactionService.DisplayMessage(KnownEmojis.Information, + string.Format(CultureInfo.CurrentCulture, + "Terminal session for '{0}' (replica {1}) ended.", + canonicalName, replica.ReplicaIndex)); + return ExitCodeConstants.Success; + } } - protected override Task ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken) + private async Task<(TerminalReplicaInfo? Replica, int ErrorExitCode)> SelectReplicaAsync( + TerminalReplicaInfo[] replicas, + int? requestedReplica, + string canonicalName, + CancellationToken cancellationToken) { - _interactionService.DisplayMessage( - KnownEmojis.Information, - "The 'aspire terminal' command is being rewritten as part of the WithTerminal feature for Aspire 13.4. Try again on a build that includes the Phase 6 wire-up."); - return Task.FromResult(ExitCodeConstants.Success); + if (requestedReplica.HasValue) + { + var match = Array.Find(replicas, r => r.ReplicaIndex == requestedReplica.Value); + if (match is null) + { + _interactionService.DisplayError(string.Format(CultureInfo.CurrentCulture, + "Replica index {0} is not available for resource '{1}'. Available indices: {2}.", + requestedReplica.Value, + canonicalName, + string.Join(", ", replicas.Select(r => r.ReplicaIndex.ToString(CultureInfo.InvariantCulture))))); + return (null, ExitCodeConstants.InvalidCommand); + } + return (match, ExitCodeConstants.Success); + } + + if (replicas.Length == 1) + { + return (replicas[0], ExitCodeConstants.Success); + } + + if (Console.IsInputRedirected || Console.IsOutputRedirected) + { + _interactionService.DisplayError(string.Format(CultureInfo.CurrentCulture, + "Resource '{0}' has {1} replicas. Pass --replica to choose one in non-interactive mode.", + canonicalName, + replicas.Length)); + return (null, ExitCodeConstants.InvalidCommand); + } + + var picked = await _interactionService.PromptForSelectionAsync( + string.Format(CultureInfo.CurrentCulture, "Select a replica of '{0}' to attach to:", canonicalName), + replicas, + r => r.IsAlive + ? string.Format(CultureInfo.CurrentCulture, "{0} (running)", r.Label) + : string.Format(CultureInfo.CurrentCulture, "{0} (exited code={1})", r.Label, r.ExitCode?.ToString(CultureInfo.InvariantCulture) ?? "unknown"), + cancellationToken).ConfigureAwait(false); + + return (picked, ExitCodeConstants.Success); } } diff --git a/tests/Aspire.Cli.Tests/Commands/TerminalCommandTests.cs b/tests/Aspire.Cli.Tests/Commands/TerminalCommandTests.cs new file mode 100644 index 00000000000..d36290882c8 --- /dev/null +++ b/tests/Aspire.Cli.Tests/Commands/TerminalCommandTests.cs @@ -0,0 +1,364 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Cli.Backchannel; +using Aspire.Cli.Commands; +using Aspire.Cli.Tests.TestServices; +using Aspire.Cli.Tests.Utils; +using Microsoft.AspNetCore.InternalTesting; +using Microsoft.Extensions.DependencyInjection; + +namespace Aspire.Cli.Tests.Commands; + +public class TerminalCommandTests(ITestOutputHelper outputHelper) +{ + [Fact] + public async Task TerminalCommand_Help_Works() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var services = CliTestHelper.CreateServiceCollection(workspace, outputHelper); + using var provider = services.BuildServiceProvider(); + + var command = provider.GetRequiredService(); + var result = command.Parse("terminal --help"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.Success, exitCode); + } + + [Fact] + public async Task TerminalCommand_WhenNoResourceArgument_FailsParsing() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var services = CliTestHelper.CreateServiceCollection(workspace, outputHelper); + using var provider = services.BuildServiceProvider(); + + var command = provider.GetRequiredService(); + var result = command.Parse("terminal"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.NotEqual(ExitCodeConstants.Success, exitCode); + } + + [Fact] + public async Task TerminalCommand_WhenNoAppHostRunning_ReturnsSuccess() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var services = CliTestHelper.CreateServiceCollection(workspace, outputHelper); + using var provider = services.BuildServiceProvider(); + + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + // Mirrors the LogsCommand behavior: no running AppHost is informational, not an error. + Assert.Equal(ExitCodeConstants.Success, exitCode); + } + + [Fact] + public async Task TerminalCommand_WhenAppHostLacksTerminalsV1Capability_ReturnsAppHostIncompatible() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.SupportsTerminalsV1 = false; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.AppHostIncompatible, exitCode); + } + } + + [Fact] + public async Task TerminalCommand_WhenResourceNotFound_ReturnsInvalidCommand() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.ResourceSnapshots = []; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal does-not-exist"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + } + } + + [Fact] + public async Task TerminalCommand_WhenTerminalNotAvailable_ReturnsInvalidCommand() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.ResourceSnapshots = [CreateSnapshot("myresource")]; + backchannel.TerminalInfoResponse = new GetTerminalInfoResponse + { + IsAvailable = false, + Replicas = null + }; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + } + } + + [Fact] + public async Task TerminalCommand_WhenReplicasArrayEmpty_ReturnsInvalidCommand() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.ResourceSnapshots = [CreateSnapshot("myresource")]; + backchannel.TerminalInfoResponse = new GetTerminalInfoResponse + { + IsAvailable = true, + Replicas = [] + }; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + } + } + + [Fact] + public async Task TerminalCommand_WhenReplicaIndexOutOfRange_ReturnsInvalidCommand() + { + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.ResourceSnapshots = [CreateSnapshot("myresource")]; + backchannel.TerminalInfoResponse = new GetTerminalInfoResponse + { + IsAvailable = true, + Replicas = + [ + new TerminalReplicaInfo + { + ReplicaIndex = 0, + Label = "myresource-0", + ConsumerUdsPath = "/tmp/does-not-exist-0.sock", + IsAlive = true + }, + new TerminalReplicaInfo + { + ReplicaIndex = 1, + Label = "myresource-1", + ConsumerUdsPath = "/tmp/does-not-exist-1.sock", + IsAlive = true + } + ] + }; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource --replica 99"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + } + } + + [Fact] + public async Task TerminalCommand_DisplayNameMatchesParentResource() + { + // Replicated resources share a DisplayName equal to the parent resource that + // carries the TerminalAnnotation. Passing the parent name on the CLI must + // resolve to the same canonical name when looking up terminal info. + using var workspace = TemporaryWorkspace.Create(outputHelper); + string? capturedResourceName = null; + + var (provider, backchannel) = CreateProviderWithBackchannel( + workspace, + bc => + { + bc.ResourceSnapshots = + [ + CreateSnapshot("myresource-0", displayName: "myresource"), + CreateSnapshot("myresource-1", displayName: "myresource") + ]; + bc.TerminalInfoResponse = new GetTerminalInfoResponse + { + IsAvailable = false + }; + }); + using (provider) + { + // Wrap the test backchannel's terminal info call to capture the canonical name. + var monitor = (TestAuxiliaryBackchannelMonitor)provider.GetRequiredService(); + var capturing = new CapturingTerminalAppHostBackchannel(backchannel, name => capturedResourceName = name); + monitor.ClearConnections(); + monitor.AddConnection("hash1", "socket.hash1", capturing); + + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + // IsAvailable=false → InvalidCommand, but we should see the canonical + // parent name "myresource" passed to GetTerminalInfoAsync, not "myresource-0". + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + Assert.Equal("myresource", capturedResourceName); + } + } + + [Fact] + public async Task TerminalCommand_NonInteractiveMultiReplicaWithoutFlag_ReturnsInvalidCommand() + { + // When stdin or stdout is redirected and the resource has more than one replica, + // the command must require --replica explicitly (rather than try to prompt). + using var workspace = TemporaryWorkspace.Create(outputHelper); + var (provider, _) = CreateProviderWithBackchannel( + workspace, + backchannel => + { + backchannel.ResourceSnapshots = [CreateSnapshot("myresource")]; + backchannel.TerminalInfoResponse = new GetTerminalInfoResponse + { + IsAvailable = true, + Replicas = + [ + new TerminalReplicaInfo + { + ReplicaIndex = 0, + Label = "myresource-0", + ConsumerUdsPath = "/tmp/does-not-exist-0.sock", + IsAlive = true + }, + new TerminalReplicaInfo + { + ReplicaIndex = 1, + Label = "myresource-1", + ConsumerUdsPath = "/tmp/does-not-exist-1.sock", + IsAlive = true + } + ] + }; + }); + using (provider) + { + var command = provider.GetRequiredService(); + var result = command.Parse("terminal myresource"); + // Tests run with both stdout and stdin redirected (xUnit pipes them), so + // Console.IsInputRedirected and Console.IsOutputRedirected are both true. + var exitCode = await result.InvokeAsync().DefaultTimeout(); + + Assert.Equal(ExitCodeConstants.InvalidCommand, exitCode); + } + } + + private (ServiceProvider Provider, TestAppHostAuxiliaryBackchannel Backchannel) CreateProviderWithBackchannel( + TemporaryWorkspace workspace, + Action configure) + { + var monitor = new TestAuxiliaryBackchannelMonitor(); + var backchannel = new TestAppHostAuxiliaryBackchannel + { + IsInScope = true, + AppHostInfo = new AppHostInformation + { + AppHostPath = Path.Combine(workspace.WorkspaceRoot.FullName, "TestAppHost", "TestAppHost.csproj"), + ProcessId = 1234 + }, + SupportsTerminalsV1 = true + }; + configure(backchannel); + monitor.AddConnection("hash1", "socket.hash1", backchannel); + + var services = CliTestHelper.CreateServiceCollection(workspace, outputHelper, options => + { + options.AuxiliaryBackchannelMonitorFactory = _ => monitor; + }); + + return (services.BuildServiceProvider(), backchannel); + } + + private static ResourceSnapshot CreateSnapshot(string name, string? displayName = null) + { + return new ResourceSnapshot + { + Name = name, + DisplayName = displayName, + ResourceType = "Project", + State = "Running" + }; + } + + /// + /// Wraps an inner backchannel and captures the resource name passed to + /// . All other calls + /// delegate to the inner instance. + /// + private sealed class CapturingTerminalAppHostBackchannel : IAppHostAuxiliaryBackchannel + { + private readonly TestAppHostAuxiliaryBackchannel _inner; + private readonly Action _onGetTerminalInfo; + + public CapturingTerminalAppHostBackchannel(TestAppHostAuxiliaryBackchannel inner, Action onGetTerminalInfo) + { + _inner = inner; + _onGetTerminalInfo = onGetTerminalInfo; + } + + public string Hash => _inner.Hash; + public string SocketPath => _inner.SocketPath; + public AppHostInformation? AppHostInfo => _inner.AppHostInfo; + public bool IsInScope => _inner.IsInScope; + public DateTimeOffset ConnectedAt => _inner.ConnectedAt; + public bool SupportsV2 => _inner.SupportsV2; + public bool SupportsTerminalsV1 => _inner.SupportsTerminalsV1; + + public Task GetTerminalInfoAsync(string resourceName, CancellationToken cancellationToken = default) + { + _onGetTerminalInfo(resourceName); + return _inner.GetTerminalInfoAsync(resourceName, cancellationToken); + } + + public Task GetDashboardUrlsAsync(CancellationToken cancellationToken = default) + => _inner.GetDashboardUrlsAsync(cancellationToken); + public Task> GetResourceSnapshotsAsync(bool includeHidden, CancellationToken cancellationToken = default) + => _inner.GetResourceSnapshotsAsync(includeHidden, cancellationToken); + public IAsyncEnumerable WatchResourceSnapshotsAsync(bool includeHidden, CancellationToken cancellationToken = default) + => _inner.WatchResourceSnapshotsAsync(includeHidden, cancellationToken); + public IAsyncEnumerable GetResourceLogsAsync(string? resourceName = null, bool follow = false, CancellationToken cancellationToken = default) + => _inner.GetResourceLogsAsync(resourceName, follow, cancellationToken); + public Task StopAppHostAsync(CancellationToken cancellationToken = default) + => _inner.StopAppHostAsync(cancellationToken); + public Task ExecuteResourceCommandAsync(string resourceName, string commandName, CancellationToken cancellationToken = default) + => _inner.ExecuteResourceCommandAsync(resourceName, commandName, cancellationToken); + public Task WaitForResourceAsync(string resourceName, string status, int timeoutSeconds, CancellationToken cancellationToken = default) + => _inner.WaitForResourceAsync(resourceName, status, timeoutSeconds, cancellationToken); + public Task CallResourceMcpToolAsync(string resourceName, string toolName, IReadOnlyDictionary? arguments, CancellationToken cancellationToken = default) + => _inner.CallResourceMcpToolAsync(resourceName, toolName, arguments, cancellationToken); + public Task GetDashboardInfoV2Async(CancellationToken cancellationToken = default) + => _inner.GetDashboardInfoV2Async(cancellationToken); + + public void Dispose() => _inner.Dispose(); + } +} diff --git a/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs b/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs index e6becd1a175..e25f3acc131 100644 --- a/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs +++ b/tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs @@ -19,6 +19,7 @@ internal sealed class TestAppHostAuxiliaryBackchannel : IAppHostAuxiliaryBackcha public bool IsInScope { get; set; } = true; public DateTimeOffset ConnectedAt { get; set; } = DateTimeOffset.UtcNow; public bool SupportsV2 { get; set; } = true; + public bool SupportsTerminalsV1 { get; set; } = true; /// /// Gets or sets the resource snapshots to return from GetResourceSnapshotsAsync and WatchResourceSnapshotsAsync. diff --git a/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs b/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs index 9e1d783be75..c605560a52c 100644 --- a/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs +++ b/tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs @@ -192,6 +192,7 @@ public static IServiceCollection CreateServiceCollection(TemporaryWorkspace work services.AddTransient(); services.AddTransient(); services.AddTransient(); + services.AddTransient(); services.AddTransient(); services.AddTransient(); services.AddTransient(); From 16339c57133035220a12755a17fd7459c808b983 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 11:33:31 +1000 Subject: [PATCH 16/20] Phase 7: Dashboard /api/terminal WebSocket proxy + per-replica TerminalView Wires the Aspire Dashboard end-to-end with the per-replica HMP v1 producer endpoints introduced in Phase 1-5: the dashboard now exposes an authenticated WebSocket endpoint at /api/terminal that proxies xterm.js byte streams to the correct per-replica UDS without trusting any browser-supplied filesystem path. Server side: * New abstraction: Aspire.Dashboard.Terminal.ITerminalConnectionResolver exposes (resourceName, replicaIndex) -> Stream resolution. The default implementation (DefaultTerminalConnectionResolver) walks the live IDashboardClient.GetResources() snapshot, matches by display name + TryGetTerminalReplicaInfo, and connects via Hex1b Hmp1Transports.ConnectUnixSocket. NullTerminalConnectionResolver is kept as a hook for tests / unsupported hosts. * TerminalWebSocketProxy is rewritten: - Endpoint /api/terminal is mapped with RequireAuthorization(Frontend) so only authenticated dashboard users can open a session. - Query string ?resource=&replica= is the only client-controlled state; the consumer UDS path is resolved server-side via the resolver, not accepted from the browser. - Two pumps: * inbound (browser -> producer): binary frames carry keystroke bytes (forwarded as HMP v1 Input); text frames carry JSON resize control messages parsed via Utf8JsonReader. * outbound (producer -> browser): VT byte stream from the Hmp1WorkloadAdapter is sent as binary WS frames; resize hints from the producer become JSON text frames. - ReassembledFrame uses ArrayPool to handle multi-fragment WS reads without per-message allocation. - Graceful close via WebSocket.TryCloseAsync; resolver/protocol errors return an HTTP 5xx instead of leaking diagnostic detail. * DefaultTerminalConnectionResolver registered as singleton in DashboardWebApplication.cs alongside the other resource-snapshot-aware services. * Hex1b PackageReference added to Aspire.Dashboard.csproj (Hex1b 0.137, pinned via Directory.Packages.props). Property contract: * KnownProperties.Terminal: replaced the legacy single SocketPath constant with per-replica ReplicaIndex, ReplicaCount, and ConsumerUdsPath. The per-replica index is resolved from DcpInstancesAnnotation (DCP-allocated, stable) rather than parsing the random-suffixed resource name. * ResourceViewModelExtensions: TryGetTerminalSocketPath is replaced by TryGetTerminalReplicaInfo(out int replicaIndex, out int replicaCount) and TryGetTerminalConsumerUdsPath(out string?). * Aspire.Hosting/Dashboard/DashboardServiceData stamps these per-replica properties on each snapshot. ConsumerUdsPath is marked IsSensitive=true so the dashboard UI masks it; the value still rides the gRPC stream because it is required server-side, but it is never echoed back to the browser through the WS endpoint. Browser side: * TerminalView.razor.cs takes ResourceName + ReplicaIndex parameters instead of SocketPath; builds the WS URL as /api/terminal?resource=...&replica=... using the request's authority. ReconnectAsync(string?, int) is the new reconnect signature. * TerminalView.razor.js sends keystrokes as binary frames via TextEncoder; resize messages remain text JSON. Framing is WS-frame-type-driven, not content sniffed. * ConsoleLogs.razor / ConsoleLogs.razor.cs forward DisplayName + ReplicaIndex into TerminalView (no socket path leaves the server). Tests: * Aspire.Dashboard.Tests.Terminal.DefaultTerminalConnectionResolverTests covers: client-disabled, resource-not-found, replica mismatch, missing terminal-enabled marker, missing UDS path, and the bad-path-throws negative case. * Aspire.Dashboard.Tests.Model.ResourceViewModelExtensionsTerminalTests covers HasTerminal, TryGetTerminalReplicaInfo, and TryGetTerminalConsumerUdsPath positive / negative paths. Verified: * dotnet build src/Aspire.Dashboard -> 0 warnings, 0 errors * dotnet build src/Aspire.Hosting -> 0 warnings, 0 errors * full ./build.cmd -> 0 warnings, 0 errors * Aspire.Hosting.Tests *WithTerminal* -> 16/16 passing * Aspire.Cli.Tests *Terminal* -> 11/11 passing * Aspire.Dashboard.Tests *Terminal* -> 13/13 passing * Aspire.Dashboard.Tests (excl Playwright) -> 1255/1255 passing * Aspire.Hosting.Tests Dashboard ns -> 98/98 passing * AOT publish: no new IL warnings from Terminal/* or TerminalView* (pre-existing Dashboard AOT warnings are unchanged; Dashboard is not AOT-compiled in the ship pipeline) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Aspire.Dashboard/Aspire.Dashboard.csproj | 1 + .../Components/Controls/TerminalView.razor.cs | 50 ++- .../Components/Controls/TerminalView.razor.js | 7 +- .../Components/Pages/ConsoleLogs.razor | 4 +- .../Components/Pages/ConsoleLogs.razor.cs | 13 +- .../DashboardWebApplication.cs | 6 + .../Model/ResourceViewModelExtensions.cs | 40 ++- .../DefaultTerminalConnectionResolver.cs | 79 +++++ .../Terminal/ITerminalConnectionResolver.cs | 37 ++ .../NullTerminalConnectionResolver.cs | 17 + .../Terminal/TerminalWebSocketProxy.cs | 329 +++++++++++++++++- .../Dashboard/DashboardServiceData.cs | 67 +++- src/Shared/Model/KnownProperties.cs | 4 +- ...esourceViewModelExtensionsTerminalTests.cs | 105 ++++++ .../DefaultTerminalConnectionResolverTests.cs | 153 ++++++++ 15 files changed, 856 insertions(+), 56 deletions(-) create mode 100644 src/Aspire.Dashboard/Terminal/DefaultTerminalConnectionResolver.cs create mode 100644 src/Aspire.Dashboard/Terminal/ITerminalConnectionResolver.cs create mode 100644 src/Aspire.Dashboard/Terminal/NullTerminalConnectionResolver.cs create mode 100644 tests/Aspire.Dashboard.Tests/Model/ResourceViewModelExtensionsTerminalTests.cs create mode 100644 tests/Aspire.Dashboard.Tests/Terminal/DefaultTerminalConnectionResolverTests.cs diff --git a/src/Aspire.Dashboard/Aspire.Dashboard.csproj b/src/Aspire.Dashboard/Aspire.Dashboard.csproj index a7f23195565..3f0d9b127f3 100644 --- a/src/Aspire.Dashboard/Aspire.Dashboard.csproj +++ b/src/Aspire.Dashboard/Aspire.Dashboard.csproj @@ -52,6 +52,7 @@ + diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs index b892c156290..5a0ac9bb00d 100644 --- a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs @@ -9,7 +9,8 @@ namespace Aspire.Dashboard.Components.Controls; /// /// Renders an interactive terminal using xterm.js, connected to the resource's -/// terminal session via WebSocket → Aspire Terminal Protocol over UDS. +/// per-replica terminal session via a WebSocket bridge to the AppHost-owned +/// terminal host (HMP v1 over Unix domain socket). /// public sealed partial class TerminalView : ComponentBase, IAsyncDisposable { @@ -17,8 +18,19 @@ public sealed partial class TerminalView : ComponentBase, IAsyncDisposable private IJSObjectReference? _jsModule; private int _terminalId; + /// + /// Gets or sets the user-facing display name of the resource that owns the + /// terminal session (e.g. myapp, not the per-replica DCP suffix). + /// + [Parameter] + public string? ResourceName { get; set; } + + /// + /// Gets or sets the stable 0-based replica index for the terminal session. + /// Defaults to 0 for single-replica resources. + /// [Parameter] - public string? SocketPath { get; set; } + public int ReplicaIndex { get; set; } [Inject] public required IJSRuntime JS { get; init; } @@ -28,7 +40,7 @@ public sealed partial class TerminalView : ComponentBase, IAsyncDisposable protected override async Task OnAfterRenderAsync(bool firstRender) { - if (firstRender && SocketPath is not null) + if (firstRender && !string.IsNullOrEmpty(ResourceName)) { await InitializeTerminalAsync(); } @@ -41,14 +53,8 @@ private async Task InitializeTerminalAsync() _jsModule = await JS.InvokeAsync( "import", "/Components/Controls/TerminalView.razor.js"); - // Build the WebSocket URL for the terminal proxy. - // The Dashboard exposes a WebSocket endpoint at /api/terminal?socketPath=... - var baseUri = new Uri(NavigationManager.BaseUri); - var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; - var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(SocketPath!)}"; - _terminalId = await _jsModule.InvokeAsync( - "initTerminal", _terminalElement, wsUrl); + "initTerminal", _terminalElement, BuildWebSocketUrl(ResourceName!, ReplicaIndex)); } catch (JSDisconnectedException) { @@ -57,33 +63,39 @@ private async Task InitializeTerminalAsync() } /// - /// Called when the socket path changes (e.g., resource selection changes). + /// Reconnects the terminal to a different resource/replica. When both + /// arguments match the current values this is a no-op. /// - public async Task ReconnectAsync(string? newSocketPath) + public async Task ReconnectAsync(string? newResourceName, int newReplicaIndex) { if (_jsModule is null || _terminalId == 0) { - SocketPath = newSocketPath; - if (newSocketPath is not null) + ResourceName = newResourceName; + ReplicaIndex = newReplicaIndex; + if (!string.IsNullOrEmpty(newResourceName)) { await InitializeTerminalAsync(); } return; } - if (newSocketPath is null) + if (string.IsNullOrEmpty(newResourceName)) { await _jsModule.InvokeVoidAsync("disposeTerminal", _terminalId); _terminalId = 0; return; } - SocketPath = newSocketPath; + ResourceName = newResourceName; + ReplicaIndex = newReplicaIndex; + await _jsModule.InvokeVoidAsync("reconnectTerminal", _terminalId, BuildWebSocketUrl(newResourceName, newReplicaIndex)); + } + + private string BuildWebSocketUrl(string resource, int replica) + { var baseUri = new Uri(NavigationManager.BaseUri); var wsScheme = baseUri.Scheme == "https" ? "wss" : "ws"; - var wsUrl = $"{wsScheme}://{baseUri.Host}:{baseUri.Port}/api/terminal?socketPath={Uri.EscapeDataString(newSocketPath)}"; - - await _jsModule.InvokeVoidAsync("reconnectTerminal", _terminalId, wsUrl); + return $"{wsScheme}://{baseUri.Authority}/api/terminal?resource={Uri.EscapeDataString(resource)}&replica={replica}"; } public async ValueTask DisposeAsync() diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js index 4e2aa0a582a..a572d8a6d9d 100644 --- a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.js @@ -7,6 +7,7 @@ const terminals = new Map(); let nextId = 1; +const textEncoder = new TextEncoder(); function ensureXtermLoaded() { return new Promise((resolve, reject) => { @@ -80,10 +81,12 @@ export async function initTerminal(element, wsUrl) { } }); - // Handle user input + // Handle user input. Send keystrokes as binary frames so the server can + // distinguish them from text-mode JSON control frames (resize, etc.) by + // WebSocket frame type rather than by content sniffing. term.onData((data) => { if (state.ws && state.ws.readyState === WebSocket.OPEN) { - state.ws.send(data); + state.ws.send(textEncoder.encode(data)); } }); diff --git a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor index e2d72097edb..31bc93fe78a 100644 --- a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor +++ b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor @@ -104,9 +104,9 @@ - @if (_selectedResourceHasTerminal && _terminalSocketPath is not null) + @if (_selectedResourceHasTerminal && _terminalResourceName is not null) { - + } else { diff --git a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs index 7d8685f4aec..2ea1e55f093 100644 --- a/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs +++ b/src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs @@ -160,7 +160,8 @@ private record struct LogEntryToWrite(string ResourceName, LogEntry LogEntry, in private LogViewer? _logViewerRef; private Controls.TerminalView? _terminalViewRef; private bool _selectedResourceHasTerminal; - private string? _terminalSocketPath; + private string? _terminalResourceName; + private int _terminalReplicaIndex; // UI private SelectViewModel _allResource = null!; @@ -399,16 +400,18 @@ private async Task SubscribeAsync(bool isAllSelected, string? selectedResourceNa // Detect whether the selected resource has terminal support _selectedResourceHasTerminal = false; - _terminalSocketPath = null; + _terminalResourceName = null; + _terminalReplicaIndex = 0; if (!isAllSelected && selectedResourceName is not null && _resourceByName.TryGetValue(selectedResourceName, out var selectedResource) && selectedResource.HasTerminal() && - selectedResource.TryGetTerminalSocketPath(out var socketPath)) + selectedResource.TryGetTerminalReplicaInfo(out var replicaIndex, out _)) { _selectedResourceHasTerminal = true; - _terminalSocketPath = socketPath; - Logger.LogDebug("Resource '{ResourceName}' has terminal at {SocketPath}", selectedResourceName, socketPath); + _terminalResourceName = selectedResource.DisplayName; + _terminalReplicaIndex = replicaIndex; + Logger.LogDebug("Resource '{ResourceName}' has terminal at replica {ReplicaIndex}", selectedResourceName, replicaIndex); // Don't subscribe to console logs for terminal resources — // the terminal view replaces the log viewer. diff --git a/src/Aspire.Dashboard/DashboardWebApplication.cs b/src/Aspire.Dashboard/DashboardWebApplication.cs index a221f340ab1..0b7004671ab 100644 --- a/src/Aspire.Dashboard/DashboardWebApplication.cs +++ b/src/Aspire.Dashboard/DashboardWebApplication.cs @@ -329,6 +329,12 @@ public DashboardWebApplication( builder.Services.AddSingleton(); + // Resolves per-replica HMP v1 producer streams server-side from the live + // resource snapshot stream. Default impl looks up by display name and + // replica index in IDashboardClient and connects to the consumer UDS + // path the AppHost stamped onto the snapshot. + builder.Services.TryAddSingleton(); + builder.Services.AddScoped(); builder.Services.AddScoped(); builder.Services.AddScoped(); diff --git a/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs b/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs index 02c893c59da..758e398ea76 100644 --- a/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs +++ b/src/Aspire.Dashboard/Model/ResourceViewModelExtensions.cs @@ -3,6 +3,7 @@ using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; +using System.Globalization; using Aspire.Dashboard.Utils; namespace Aspire.Dashboard.Model; @@ -108,11 +109,44 @@ public static bool HasTerminal(this ResourceViewModel resource) } /// - /// Tries to get the terminal socket path for the resource. + /// Tries to get the per-replica terminal info: the stable replica index and the + /// total replica count for the parent resource. Both values are stamped onto + /// each replica snapshot by the AppHost when the resource has + /// WithTerminal() applied. The pair is sufficient for the dashboard to + /// build a ?resource=<name>&replica=<index> URL that the + /// terminal WebSocket proxy can resolve to a per-replica HMP v1 producer + /// socket without exposing the socket path to the browser. /// - public static bool TryGetTerminalSocketPath(this ResourceViewModel resource, [NotNullWhen(returnValue: true)] out string? socketPath) + public static bool TryGetTerminalReplicaInfo(this ResourceViewModel resource, out int replicaIndex, out int replicaCount) { - return resource.TryGetCustomDataString(KnownProperties.Terminal.SocketPath, out socketPath); + replicaIndex = 0; + replicaCount = 0; + + if (!resource.TryGetCustomDataString(KnownProperties.Terminal.ReplicaIndex, out var indexString) || + !int.TryParse(indexString, NumberStyles.Integer, CultureInfo.InvariantCulture, out replicaIndex)) + { + return false; + } + + if (!resource.TryGetCustomDataString(KnownProperties.Terminal.ReplicaCount, out var countString) || + !int.TryParse(countString, NumberStyles.Integer, CultureInfo.InvariantCulture, out replicaCount)) + { + return false; + } + + return true; + } + + /// + /// Tries to get the per-replica consumer UDS path stamped onto the snapshot + /// by the AppHost. Used by the dashboard's terminal WebSocket proxy to + /// connect a local HMP v1 client to the terminal host. Returns false + /// for resources that don't have a terminal or for snapshots from older + /// AppHost builds that don't stamp this property. + /// + public static bool TryGetTerminalConsumerUdsPath(this ResourceViewModel resource, [NotNullWhen(returnValue: true)] out string? consumerUdsPath) + { + return resource.TryGetCustomDataString(KnownProperties.Terminal.ConsumerUdsPath, out consumerUdsPath); } private static bool TryGetCustomDataString(this ResourceViewModel resource, string key, [NotNullWhen(returnValue: true)] out string? s) diff --git a/src/Aspire.Dashboard/Terminal/DefaultTerminalConnectionResolver.cs b/src/Aspire.Dashboard/Terminal/DefaultTerminalConnectionResolver.cs new file mode 100644 index 00000000000..faa078a4563 --- /dev/null +++ b/src/Aspire.Dashboard/Terminal/DefaultTerminalConnectionResolver.cs @@ -0,0 +1,79 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Dashboard.Model; +using Hex1b; + +namespace Aspire.Dashboard.Terminal; + +/// +/// Resolves per-replica HMP v1 producer streams by walking the live resource +/// snapshot stream from . The dashboard receives +/// the consumer UDS path inside each replica snapshot's properties; this +/// resolver looks up the requested resource by display name + replica index and +/// connects to the matching local socket. +/// +/// +/// The path itself is included in the gRPC stream from the AppHost. In Aspire's +/// single-user, single-machine local-dev scenario the path is not a privileged +/// secret (the user already controls the AppHost process and can read or write +/// anything in its temp directory), but the path never reaches the browser via +/// the terminal WebSocket because the proxy takes only +/// resource/replica identifiers. +/// +internal sealed class DefaultTerminalConnectionResolver : ITerminalConnectionResolver +{ + private readonly IDashboardClient _client; + + public DefaultTerminalConnectionResolver(IDashboardClient client) + { + _client = client ?? throw new ArgumentNullException(nameof(client)); + } + + public async Task ConnectAsync(string resourceName, int replicaIndex, CancellationToken cancellationToken) + { + if (!_client.IsEnabled) + { + return null; + } + + // Locate the replica snapshot for (resourceName, replicaIndex). DCP names + // each replica with a random suffix (e.g. myapp-abc123), but every snapshot + // also carries the user-facing display name and the stable terminal + // properties stamped by DashboardServiceData. We match by display name + + // replica index rather than by the synthetic snapshot name. + ResourceViewModel? match = null; + foreach (var resource in _client.GetResources()) + { + if (!string.Equals(resource.DisplayName, resourceName, StringComparison.Ordinal)) + { + continue; + } + + if (!resource.HasTerminal()) + { + continue; + } + + if (!resource.TryGetTerminalReplicaInfo(out var index, out _) || index != replicaIndex) + { + continue; + } + + match = resource; + break; + } + + if (match is null) + { + return null; + } + + if (!match.TryGetTerminalConsumerUdsPath(out var udsPath)) + { + return null; + } + + return await Hmp1Transports.ConnectUnixSocket(udsPath, cancellationToken).ConfigureAwait(false); + } +} diff --git a/src/Aspire.Dashboard/Terminal/ITerminalConnectionResolver.cs b/src/Aspire.Dashboard/Terminal/ITerminalConnectionResolver.cs new file mode 100644 index 00000000000..ab53b3b1ea1 --- /dev/null +++ b/src/Aspire.Dashboard/Terminal/ITerminalConnectionResolver.cs @@ -0,0 +1,37 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Dashboard.Terminal; + +/// +/// Resolves an HMP v1 producer stream for a specific (resourceName, replicaIndex) +/// pair. The dashboard's terminal WebSocket proxy uses this abstraction to keep +/// per-replica consumer UDS paths server-side, so an authenticated browser cannot +/// coerce the dashboard into connecting to arbitrary local sockets. +/// +/// +/// The default registration is , which +/// always returns null. The standalone dashboard uses this default since +/// terminal sessions are inherently a local-dev / DCP feature. The in-process +/// dashboard composition in Aspire.Hosting replaces this with a real +/// implementation that walks the resource graph and connects to the matching +/// Hex1b.Hmp1 server. +/// +public interface ITerminalConnectionResolver +{ + /// + /// Connects to the HMP v1 producer for the requested replica and returns the + /// raw bidirectional stream the caller should hand to + /// Hmp1WorkloadAdapter. Returns null if the resource does not + /// have an interactive terminal, the replica index is out of range, or the + /// dashboard is not co-hosted with an AppHost that exposes terminal + /// information. + /// + /// + /// The user-facing display name of the parent resource (e.g. myapp), + /// not the per-replica DCP suffix. + /// + /// The stable 0-based replica index. + /// Cancellation token. + Task ConnectAsync(string resourceName, int replicaIndex, CancellationToken cancellationToken); +} diff --git a/src/Aspire.Dashboard/Terminal/NullTerminalConnectionResolver.cs b/src/Aspire.Dashboard/Terminal/NullTerminalConnectionResolver.cs new file mode 100644 index 00000000000..934dcd0597c --- /dev/null +++ b/src/Aspire.Dashboard/Terminal/NullTerminalConnectionResolver.cs @@ -0,0 +1,17 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Dashboard.Terminal; + +/// +/// Default no-op resolver used when the dashboard runs standalone (not co-hosted +/// inside an AppHost). It always reports that no terminal is available, which +/// causes to return 404. +/// +internal sealed class NullTerminalConnectionResolver : ITerminalConnectionResolver +{ + public Task ConnectAsync(string resourceName, int replicaIndex, CancellationToken cancellationToken) + { + return Task.FromResult(null); + } +} diff --git a/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs index 3076485e2b5..644e1f63348 100644 --- a/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs +++ b/src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs @@ -1,30 +1,333 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System.Buffers; +using System.Net.WebSockets; +using System.Text; +using System.Text.Json; +using Aspire.Dashboard.Configuration; +using Hex1b; + namespace Aspire.Dashboard.Terminal; /// /// ASP.NET Core middleware that proxies WebSocket connections from the browser -/// to a terminal-host UDS using HMP v1. -/// -/// PHASE 7 PENDING: during the WithTerminal end-to-end refactor this proxy is -/// stubbed to return 503. Once the per-replica HMP v1 wire-up lands (Phases 4 + 5), -/// the proxy will look up the consumer UDS path for the requested resource/replica -/// via the AppHost backchannel and bridge the WebSocket to a Hex1b HMP v1 client. +/// to a per-replica HMP v1 producer (the AppHost-owned terminal host) and bridges +/// raw VT byte streams in both directions. The browser identifies the target +/// replica with ?resource=<name>&replica=<index>; the +/// actual UDS path is resolved server-side by +/// so the dashboard never trusts a +/// browser-supplied filesystem path. /// internal static class TerminalWebSocketProxy { /// - /// Maps the terminal WebSocket endpoint at /api/terminal as a 503 stub. + /// Maps the terminal WebSocket endpoint at /api/terminal. The handler + /// requires the same browser authentication as the rest of the Blazor UI. /// public static void MapTerminalWebSocket(this WebApplication app) { - app.Map("/api/terminal", async (HttpContext context) => + app.Map("/api/terminal", async (HttpContext context, + ITerminalConnectionResolver resolver, + ILoggerFactory loggerFactory) => + { + var logger = loggerFactory.CreateLogger("Aspire.Dashboard.Terminal.TerminalWebSocketProxy"); + + if (!context.WebSockets.IsWebSocketRequest) + { + context.Response.StatusCode = StatusCodes.Status400BadRequest; + await context.Response.WriteAsync("Expected a WebSocket upgrade request.").ConfigureAwait(false); + return; + } + + var resourceName = context.Request.Query["resource"].ToString(); + var replicaText = context.Request.Query["replica"].ToString(); + + if (string.IsNullOrWhiteSpace(resourceName)) + { + context.Response.StatusCode = StatusCodes.Status400BadRequest; + await context.Response.WriteAsync("Missing 'resource' query parameter.").ConfigureAwait(false); + return; + } + + // Default to replica 0 when omitted (single-replica resources). + var replicaIndex = 0; + if (!string.IsNullOrWhiteSpace(replicaText) && + !int.TryParse(replicaText, System.Globalization.NumberStyles.Integer, System.Globalization.CultureInfo.InvariantCulture, out replicaIndex)) + { + context.Response.StatusCode = StatusCodes.Status400BadRequest; + await context.Response.WriteAsync("Invalid 'replica' query parameter.").ConfigureAwait(false); + return; + } + + if (replicaIndex < 0) + { + context.Response.StatusCode = StatusCodes.Status400BadRequest; + await context.Response.WriteAsync("'replica' must be non-negative.").ConfigureAwait(false); + return; + } + + // Resolve the producer stream entirely server-side. This is the only + // step that knows the consumer UDS path; nothing about the path leaks + // out to the browser. + Stream? producerStream; + try + { + producerStream = await resolver.ConnectAsync(resourceName, replicaIndex, context.RequestAborted).ConfigureAwait(false); + } + catch (Exception ex) when (ex is not OperationCanceledException) + { + logger.LogWarning(ex, "Failed to resolve terminal connection for {Resource}/{Replica}.", resourceName, replicaIndex); + context.Response.StatusCode = StatusCodes.Status503ServiceUnavailable; + await context.Response.WriteAsync("Terminal is unavailable.").ConfigureAwait(false); + return; + } + + if (producerStream is null) + { + context.Response.StatusCode = StatusCodes.Status404NotFound; + await context.Response.WriteAsync("Terminal is not available for the requested resource and replica.").ConfigureAwait(false); + return; + } + + using var ws = await context.WebSockets.AcceptWebSocketAsync().ConfigureAwait(false); + var adapter = new Hmp1WorkloadAdapter(producerStream); + + try + { + await adapter.ConnectAsync(context.RequestAborted).ConfigureAwait(false); + } + catch (Exception ex) when (ex is not OperationCanceledException) + { + logger.LogWarning(ex, "HMP v1 handshake failed for {Resource}/{Replica}.", resourceName, replicaIndex); + await TryCloseAsync(ws, WebSocketCloseStatus.InternalServerError, "Handshake failed").ConfigureAwait(false); + producerStream.Dispose(); + return; + } + + using var pumpCts = CancellationTokenSource.CreateLinkedTokenSource(context.RequestAborted); + + // Producer → browser: VT bytes flow as Binary frames so xterm.js can + // hand them straight to terminal.write(). + var outboundPump = Task.Run(async () => + { + try + { + while (!pumpCts.IsCancellationRequested) + { + var data = await adapter.ReadOutputAsync(pumpCts.Token).ConfigureAwait(false); + if (data.IsEmpty) + { + // Adapter signals end-of-stream with an empty buffer. + break; + } + + if (ws.State != WebSocketState.Open) + { + break; + } + + await ws.SendAsync(data, WebSocketMessageType.Binary, endOfMessage: true, pumpCts.Token).ConfigureAwait(false); + } + } + catch (OperationCanceledException) { } + catch (Exception ex) when (ex is WebSocketException or IOException or ObjectDisposedException) + { + logger.LogDebug(ex, "Outbound terminal pump ended for {Resource}/{Replica}.", resourceName, replicaIndex); + } + }, pumpCts.Token); + + // Browser → producer: + // * Binary frames carry raw keystroke bytes (UTF-8 of xterm.js + // onData), forwarded as HMP v1 Input frames. + // * Text frames carry JSON control messages, currently + // {"type":"resize","cols":N,"rows":N}. + // Splitting keystrokes from controls by frame type avoids the + // ambiguity of trying to JSON-parse arbitrary user input. + var inboundPump = Task.Run(async () => + { + var pool = ArrayPool.Shared; + var buffer = pool.Rent(8192); + try + { + while (!pumpCts.IsCancellationRequested && ws.State == WebSocketState.Open) + { + using var assembly = new ReassembledFrame(pool); + ValueWebSocketReceiveResult result; + do + { + result = await ws.ReceiveAsync(buffer.AsMemory(), pumpCts.Token).ConfigureAwait(false); + if (result.MessageType == WebSocketMessageType.Close) + { + return; + } + + assembly.Append(buffer.AsSpan(0, result.Count)); + } + while (!result.EndOfMessage); + + var payload = assembly.WrittenMemory; + + switch (result.MessageType) + { + case WebSocketMessageType.Binary: + if (!payload.IsEmpty) + { + await adapter.WriteInputAsync(payload, pumpCts.Token).ConfigureAwait(false); + } + break; + + case WebSocketMessageType.Text: + TryHandleControlFrame(payload.Span, adapter, logger, resourceName, replicaIndex, pumpCts.Token); + break; + } + } + } + catch (OperationCanceledException) { } + catch (Exception ex) when (ex is WebSocketException or IOException or ObjectDisposedException) + { + logger.LogDebug(ex, "Inbound terminal pump ended for {Resource}/{Replica}.", resourceName, replicaIndex); + } + finally + { + pool.Return(buffer); + } + }, pumpCts.Token); + + // Wait for either side to drop, then tear down both pumps and the + // upstream HMP v1 connection. + try + { + await Task.WhenAny(outboundPump, inboundPump).ConfigureAwait(false); + } + finally + { + pumpCts.Cancel(); + try { await outboundPump.ConfigureAwait(false); } catch { /* swallow */ } + try { await inboundPump.ConfigureAwait(false); } catch { /* swallow */ } + producerStream.Dispose(); + await TryCloseAsync(ws, WebSocketCloseStatus.NormalClosure, "Terminal session ended").ConfigureAwait(false); + } + }).RequireAuthorization(FrontendAuthorizationDefaults.PolicyName); + } + + private static void TryHandleControlFrame(ReadOnlySpan payload, + Hmp1WorkloadAdapter adapter, + ILogger logger, + string resourceName, + int replicaIndex, + CancellationToken cancellationToken) + { + // Expected control-frame format (UTF-8 text): + // { "type": "resize", "cols": , "rows": } + // Anything else is logged at debug and discarded. + try + { + var reader = new Utf8JsonReader(payload); + string? type = null; + int? cols = null; + int? rows = null; + + if (!reader.Read() || reader.TokenType != JsonTokenType.StartObject) + { + return; + } + + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType != JsonTokenType.PropertyName) + { + return; + } + + var propertyName = reader.GetString(); + if (!reader.Read()) + { + return; + } + + switch (propertyName) + { + case "type": + type = reader.GetString(); + break; + case "cols": + cols = reader.GetInt32(); + break; + case "rows": + rows = reader.GetInt32(); + break; + default: + reader.Skip(); + break; + } + } + + if (type == "resize" && cols is { } c && rows is { } r && c > 0 && r > 0) + { + _ = adapter.ResizeAsync(c, r, cancellationToken).AsTask(); + } + } + catch (JsonException ex) + { + logger.LogDebug(ex, "Discarding malformed terminal control frame for {Resource}/{Replica}: {Payload}", + resourceName, replicaIndex, Encoding.UTF8.GetString(payload)); + } + } + + private static async Task TryCloseAsync(WebSocket ws, WebSocketCloseStatus status, string description) + { + if (ws.State is WebSocketState.Open or WebSocketState.CloseReceived) { - context.Response.StatusCode = 503; - await context.Response.WriteAsync( - "Terminal endpoint is not yet available in this build. " + - "Pending Phase 7 of the WithTerminal end-to-end work.").ConfigureAwait(false); - }); + try + { + using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(2)); + await ws.CloseAsync(status, description, cts.Token).ConfigureAwait(false); + } + catch (Exception ex) when (ex is WebSocketException or IOException or ObjectDisposedException or OperationCanceledException) + { + // Best effort. + } + } + } + + private sealed class ReassembledFrame : IDisposable + { + private readonly ArrayPool _pool; + private byte[] _buffer; + private int _length; + + public ReassembledFrame(ArrayPool pool) + { + _pool = pool; + _buffer = _pool.Rent(8192); + _length = 0; + } + + public ReadOnlyMemory WrittenMemory => _buffer.AsMemory(0, _length); + + public void Append(ReadOnlySpan data) + { + if (_length + data.Length > _buffer.Length) + { + var bigger = _pool.Rent(Math.Max(_buffer.Length * 2, _length + data.Length)); + Buffer.BlockCopy(_buffer, 0, bigger, 0, _length); + _pool.Return(_buffer); + _buffer = bigger; + } + + data.CopyTo(_buffer.AsSpan(_length)); + _length += data.Length; + } + + public void Dispose() + { + if (_buffer is not null) + { + _pool.Return(_buffer); + _buffer = null!; + } + } } } + diff --git a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs index e0e2ff35a50..125d3654396 100644 --- a/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs +++ b/src/Aspire.Hosting/Dashboard/DashboardServiceData.cs @@ -40,21 +40,42 @@ public DashboardServiceData( { static GenericResourceSnapshot CreateResourceSnapshot(IResource resource, string resourceId, DateTime creationTimestamp, CustomResourceSnapshot snapshot) { - // If the resource has a TerminalAnnotation, add a terminal property to the snapshot - // so the Dashboard can detect terminal-enabled resources. + // If the resource has a TerminalAnnotation, stamp the per-replica terminal + // properties onto the snapshot so the Dashboard can: + // * detect that a terminal is available (HasTerminal), + // * build a /api/terminal?resource=&replica= URL pointing + // at the right replica (TryGetTerminalReplicaInfo). + // + // The actual consumer UDS path is *intentionally* not surfaced in the + // snapshot. The dashboard resolves it server-side via + // ITerminalConnectionResolver so an authenticated browser cannot coerce + // the dashboard into connecting to arbitrary UDS endpoints. var terminalAnnotation = resource.Annotations.OfType().FirstOrDefault(); if (terminalAnnotation is not null) { - snapshot = snapshot with + var consumerUdsPaths = terminalAnnotation.TerminalHost.Layout.ConsumerUdsPaths; + var replicaCount = consumerUdsPaths.Count; + var replicaIndex = ResolveReplicaIndex(resource, resourceId); + var consumerUdsPath = (uint)replicaIndex < (uint)consumerUdsPaths.Count + ? consumerUdsPaths[replicaIndex] + : null; + + var properties = snapshot.Properties + .Add(new ResourcePropertySnapshot(KnownProperties.Terminal.Enabled, "true") { IsSensitive = false }) + .Add(new ResourcePropertySnapshot(KnownProperties.Terminal.ReplicaIndex, replicaIndex.ToString(System.Globalization.CultureInfo.InvariantCulture)) { IsSensitive = false }) + .Add(new ResourcePropertySnapshot(KnownProperties.Terminal.ReplicaCount, replicaCount.ToString(System.Globalization.CultureInfo.InvariantCulture)) { IsSensitive = false }); + + if (consumerUdsPath is not null) { - Properties = snapshot.Properties.Add( - new ResourcePropertySnapshot(KnownProperties.Terminal.Enabled, "true") { IsSensitive = false }) - }; - - // Phase 7 of WithTerminal replaces this single-socket property with - // a per-replica view sourced from TerminalAnnotation.TerminalHost.Layout - // and routed through the dashboard backchannel; the snapshot just - // signals availability for now. + // Mark the UDS path sensitive so the dashboard masks it in the + // resource details panel. The path still flows through gRPC to + // the dashboard process (which is intentional - it needs the + // path to open the local socket on the user's behalf). + properties = properties.Add( + new ResourcePropertySnapshot(KnownProperties.Terminal.ConsumerUdsPath, consumerUdsPath) { IsSensitive = true }); + } + + snapshot = snapshot with { Properties = properties }; } return new GenericResourceSnapshot(snapshot) @@ -81,6 +102,30 @@ static GenericResourceSnapshot CreateResourceSnapshot(IResource resource, string }; } + // Maps the per-replica DCP resourceId (e.g. "myapp-abc123") back to its + // stable 0-based replica index by consulting DcpInstancesAnnotation, which + // DcpNameGenerator populates at instance-allocation time. Falls back to 0 + // for non-DCP resources or when the annotation isn't present yet (e.g. + // initial pre-DCP snapshots). + static int ResolveReplicaIndex(IResource resource, string resourceId) + { + var instances = resource.Annotations.OfType().FirstOrDefault(); + if (instances is null) + { + return 0; + } + + foreach (var instance in instances.Instances) + { + if (string.Equals(instance.Name, resourceId, StringComparison.Ordinal)) + { + return instance.Index; + } + } + + return 0; + } + var timestamp = DateTime.UtcNow; await foreach (var @event in resourceNotificationService.WatchAsync().WithCancellation(cancellationToken).ConfigureAwait(false)) diff --git a/src/Shared/Model/KnownProperties.cs b/src/Shared/Model/KnownProperties.cs index 04c93efa455..7ed695138cc 100644 --- a/src/Shared/Model/KnownProperties.cs +++ b/src/Shared/Model/KnownProperties.cs @@ -59,7 +59,9 @@ public static class Project public static class Terminal { public const string Enabled = "terminal.enabled"; - public const string SocketPath = "terminal.socketPath"; + public const string ReplicaIndex = "terminal.replicaIndex"; + public const string ReplicaCount = "terminal.replicaCount"; + public const string ConsumerUdsPath = "terminal.consumerUdsPath"; } public static class Parameter diff --git a/tests/Aspire.Dashboard.Tests/Model/ResourceViewModelExtensionsTerminalTests.cs b/tests/Aspire.Dashboard.Tests/Model/ResourceViewModelExtensionsTerminalTests.cs new file mode 100644 index 00000000000..16704596fba --- /dev/null +++ b/tests/Aspire.Dashboard.Tests/Model/ResourceViewModelExtensionsTerminalTests.cs @@ -0,0 +1,105 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Dashboard.Model; +using Aspire.Tests.Shared.DashboardModel; +using Xunit; +using Value = Google.Protobuf.WellKnownTypes.Value; + +namespace Aspire.Dashboard.Tests.Model; + +public class ResourceViewModelExtensionsTerminalTests +{ + [Fact] + public void HasTerminal_TrueWhenEnabledMarkerPresent() + { + var resource = ModelTestHelpers.CreateResource( + properties: new Dictionary + { + [KnownProperties.Terminal.Enabled] = StringProperty(KnownProperties.Terminal.Enabled, "true"), + }); + + Assert.True(resource.HasTerminal()); + } + + [Fact] + public void HasTerminal_FalseWhenEnabledMarkerAbsent() + { + var resource = ModelTestHelpers.CreateResource(); + + Assert.False(resource.HasTerminal()); + } + + [Fact] + public void TryGetTerminalReplicaInfo_ReturnsParsedValues() + { + var resource = ModelTestHelpers.CreateResource( + properties: new Dictionary + { + [KnownProperties.Terminal.ReplicaIndex] = StringProperty(KnownProperties.Terminal.ReplicaIndex, "2"), + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, "5"), + }); + + Assert.True(resource.TryGetTerminalReplicaInfo(out var index, out var count)); + Assert.Equal(2, index); + Assert.Equal(5, count); + } + + [Fact] + public void TryGetTerminalReplicaInfo_FalseWhenIndexMissing() + { + var resource = ModelTestHelpers.CreateResource( + properties: new Dictionary + { + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, "1"), + }); + + Assert.False(resource.TryGetTerminalReplicaInfo(out _, out _)); + } + + [Fact] + public void TryGetTerminalReplicaInfo_FalseWhenIndexUnparseable() + { + var resource = ModelTestHelpers.CreateResource( + properties: new Dictionary + { + [KnownProperties.Terminal.ReplicaIndex] = StringProperty(KnownProperties.Terminal.ReplicaIndex, "not-a-number"), + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, "1"), + }); + + Assert.False(resource.TryGetTerminalReplicaInfo(out _, out _)); + } + + [Fact] + public void TryGetTerminalConsumerUdsPath_ReturnsValueWhenPresent() + { + const string path = "/tmp/aspire-term/svc-r0.sock"; + var resource = ModelTestHelpers.CreateResource( + properties: new Dictionary + { + [KnownProperties.Terminal.ConsumerUdsPath] = StringProperty(KnownProperties.Terminal.ConsumerUdsPath, path), + }); + + Assert.True(resource.TryGetTerminalConsumerUdsPath(out var actual)); + Assert.Equal(path, actual); + } + + [Fact] + public void TryGetTerminalConsumerUdsPath_FalseWhenAbsent() + { + var resource = ModelTestHelpers.CreateResource(); + + Assert.False(resource.TryGetTerminalConsumerUdsPath(out var actual)); + Assert.Null(actual); + } + + private static ResourcePropertyViewModel StringProperty(string name, string value) + { + return new ResourcePropertyViewModel( + name, + new Value { StringValue = value }, + isValueSensitive: false, + knownProperty: null, + priority: 0); + } +} diff --git a/tests/Aspire.Dashboard.Tests/Terminal/DefaultTerminalConnectionResolverTests.cs b/tests/Aspire.Dashboard.Tests/Terminal/DefaultTerminalConnectionResolverTests.cs new file mode 100644 index 00000000000..1cee5fb2f2d --- /dev/null +++ b/tests/Aspire.Dashboard.Tests/Terminal/DefaultTerminalConnectionResolverTests.cs @@ -0,0 +1,153 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Aspire.Dashboard.Model; +using Aspire.Dashboard.Terminal; +using Aspire.Dashboard.Tests.Integration.Playwright.Infrastructure; +using Aspire.DashboardService.Proto.V1; +using Aspire.Tests.Shared.DashboardModel; +using Xunit; +using Value = Google.Protobuf.WellKnownTypes.Value; + +namespace Aspire.Dashboard.Tests.Terminal; + +public class DefaultTerminalConnectionResolverTests +{ + [Fact] + public async Task ConnectAsync_WhenClientNotEnabled_ReturnsNull() + { + var client = new DisabledDashboardClient(); + var resolver = new DefaultTerminalConnectionResolver(client); + + var stream = await resolver.ConnectAsync("anything", 0, CancellationToken.None); + + Assert.Null(stream); + } + + [Fact] + public async Task ConnectAsync_WhenResourceNotFound_ReturnsNull() + { + var client = new MockDashboardClient(resources: + [ + CreateTerminalResource("other-abc", displayName: "other", replicaIndex: 0, replicaCount: 1, udsPath: "/tmp/other-r0.sock"), + ]); + var resolver = new DefaultTerminalConnectionResolver(client); + + var stream = await resolver.ConnectAsync("missing", 0, CancellationToken.None); + + Assert.Null(stream); + } + + [Fact] + public async Task ConnectAsync_WhenReplicaIndexDoesNotMatch_ReturnsNull() + { + var client = new MockDashboardClient(resources: + [ + CreateTerminalResource("svc-abc", displayName: "svc", replicaIndex: 0, replicaCount: 2, udsPath: "/tmp/svc-r0.sock"), + CreateTerminalResource("svc-def", displayName: "svc", replicaIndex: 1, replicaCount: 2, udsPath: "/tmp/svc-r1.sock"), + ]); + var resolver = new DefaultTerminalConnectionResolver(client); + + var stream = await resolver.ConnectAsync("svc", 5, CancellationToken.None); + + Assert.Null(stream); + } + + [Fact] + public async Task ConnectAsync_WhenSnapshotMissingTerminalEnabledMarker_ReturnsNull() + { + var resource = ModelTestHelpers.CreateResource( + resourceName: "svc-abc", + displayName: "svc", + properties: new Dictionary + { + [KnownProperties.Terminal.ReplicaIndex] = StringProperty(KnownProperties.Terminal.ReplicaIndex, "0"), + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, "1"), + [KnownProperties.Terminal.ConsumerUdsPath] = StringProperty(KnownProperties.Terminal.ConsumerUdsPath, "/tmp/svc.sock"), + }); + var client = new MockDashboardClient(resources: [resource]); + var resolver = new DefaultTerminalConnectionResolver(client); + + var stream = await resolver.ConnectAsync("svc", 0, CancellationToken.None); + + Assert.Null(stream); + } + + [Fact] + public async Task ConnectAsync_WhenSnapshotMissingConsumerUdsPath_ReturnsNull() + { + var resource = ModelTestHelpers.CreateResource( + resourceName: "svc-abc", + displayName: "svc", + properties: new Dictionary + { + [KnownProperties.Terminal.Enabled] = StringProperty(KnownProperties.Terminal.Enabled, "true"), + [KnownProperties.Terminal.ReplicaIndex] = StringProperty(KnownProperties.Terminal.ReplicaIndex, "0"), + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, "1"), + }); + var client = new MockDashboardClient(resources: [resource]); + var resolver = new DefaultTerminalConnectionResolver(client); + + var stream = await resolver.ConnectAsync("svc", 0, CancellationToken.None); + + Assert.Null(stream); + } + + [Fact] + public async Task ConnectAsync_WhenUdsPathDoesNotExist_FailsToConnect() + { + // Resolver locates the snapshot and the path; the actual UDS connect throws + // because the path is not a live socket. We just assert that the resolver + // attempted the connection — transport errors bubble up to the WS proxy. + var resource = CreateTerminalResource( + resourceName: "svc-abc", + displayName: "svc", + replicaIndex: 0, + replicaCount: 1, + udsPath: Path.Combine(Path.GetTempPath(), "nonexistent-aspire-term-" + Guid.NewGuid().ToString("N") + ".sock")); + var client = new MockDashboardClient(resources: [resource]); + var resolver = new DefaultTerminalConnectionResolver(client); + + await Assert.ThrowsAnyAsync(() => resolver.ConnectAsync("svc", 0, CancellationToken.None)); + } + + private static ResourceViewModel CreateTerminalResource(string resourceName, string displayName, int replicaIndex, int replicaCount, string udsPath) + { + return ModelTestHelpers.CreateResource( + resourceName: resourceName, + displayName: displayName, + properties: new Dictionary + { + [KnownProperties.Terminal.Enabled] = StringProperty(KnownProperties.Terminal.Enabled, "true"), + [KnownProperties.Terminal.ReplicaIndex] = StringProperty(KnownProperties.Terminal.ReplicaIndex, replicaIndex.ToString()), + [KnownProperties.Terminal.ReplicaCount] = StringProperty(KnownProperties.Terminal.ReplicaCount, replicaCount.ToString()), + [KnownProperties.Terminal.ConsumerUdsPath] = StringProperty(KnownProperties.Terminal.ConsumerUdsPath, udsPath), + }); + } + + private static ResourcePropertyViewModel StringProperty(string name, string value) + { + return new ResourcePropertyViewModel( + name, + new Value { StringValue = value }, + isValueSensitive: false, + knownProperty: null, + priority: 0); + } + + private sealed class DisabledDashboardClient : IDashboardClient + { + public bool IsEnabled => false; + public Task WhenConnected => Task.CompletedTask; + public string ApplicationName => "Disabled"; + public ValueTask DisposeAsync() => ValueTask.CompletedTask; + public Task ExecuteResourceCommandAsync(string resourceName, string resourceType, CommandViewModel command, CancellationToken cancellationToken) => throw new NotImplementedException(); + public IAsyncEnumerable> SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException(); + public IAsyncEnumerable> GetConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException(); + public Task SubscribeResourcesAsync(CancellationToken cancellationToken) => throw new NotImplementedException(); + public IAsyncEnumerable SubscribeInteractionsAsync(CancellationToken cancellationToken) => throw new NotImplementedException(); + public Task SendInteractionRequestAsync(WatchInteractionsRequestUpdate request, CancellationToken cancellationToken) => throw new NotImplementedException(); + public ResourceViewModel? GetResource(string resourceName) => null; + public IReadOnlyList GetResources() => []; + } +} From e5535e9855c69437ac4d3d35779bd416e9236c02 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 12:23:09 +1000 Subject: [PATCH 17/20] Phase 8: WithTerminal end-to-end playground + plain-executable fix Wires up the Terminals playground end-to-end so WithTerminal() can be exercised against both a project-style resource (REPL, 2 replicas) and a plain executable (cmd.exe on Windows). Validated full pipeline: DCP ConPTY -> HMP1 producer UDS -> Aspire.TerminalHost (per-replica Hex1bTerminal) -> HMP1 consumer UDS -> external viewer. Changes: * New playground project Terminals.Repl: interactive ANSI REPL with help/whoami/time/size/echo/rainbow/clear/exit. Produces ANSI banner + prompt suitable for exercising terminal emulation through the full WithTerminal pipeline. * Terminals.AppHost: add the REPL with WithReplicas(2) and WithTerminal(120x32); add a Windows-gated 'shell' resource (AddExecutable cmd.exe + WithTerminal()) to cover the plain-executable path. * Bug fix in ExecutableCreator.PreparePlainExecutables: plain executables added via AddExecutable() were missing both ResourceReplicaIndex and ResourceReplicaCount annotations, which caused BuildExecutableConfiguration's per-replica producer UDS lookup to fail silently and skip the spec.Terminal wire-up entirely. Added regression test PlainExecutable_WithTerminal_PopulatesTerminalSpecOnWindows. * docs/specs/with-terminal.md: replaces the deleted terminal-protocol.md (which described an obsolete custom protocol) with the current Aspire-side architecture spec for WithTerminal(). Validation: * Aspire.Hosting + Terminals.AppHost + Terminals.Repl all build clean (0 warnings 0 errors). * All 15 WithTerminalTests pass. * New PlainExecutable_WithTerminal_PopulatesTerminalSpecOnWindows test passes alongside existing Project_WithTerminal_/WithoutTerminal_ tests. * Manually validated end-to-end with a small HMP1 probe: connecting to each consumer UDS yields a Hello frame and a multi-KB StateSync frame containing the live PTY output (cmd.exe banner / REPL banner). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/specs/terminal-protocol.md | 300 ------------------ docs/specs/with-terminal.md | 156 +++++++++ .../Terminals/Terminals.AppHost/AppHost.cs | 28 +- .../Terminals.AppHost.csproj | 4 + .../Terminals/Terminals.Repl/Program.cs | 112 +++++++ .../Terminals.Repl/Terminals.Repl.csproj | 11 + src/Aspire.Hosting/Dcp/ExecutableCreator.cs | 6 + .../Dcp/DcpExecutorTests.cs | 41 +++ 8 files changed, 354 insertions(+), 304 deletions(-) delete mode 100644 docs/specs/terminal-protocol.md create mode 100644 docs/specs/with-terminal.md create mode 100644 playground/Terminals/Terminals.Repl/Program.cs create mode 100644 playground/Terminals/Terminals.Repl/Terminals.Repl.csproj diff --git a/docs/specs/terminal-protocol.md b/docs/specs/terminal-protocol.md deleted file mode 100644 index a07892eb658..00000000000 --- a/docs/specs/terminal-protocol.md +++ /dev/null @@ -1,300 +0,0 @@ -# Aspire Terminal Protocol Specification - -**Version:** 1 -**Status:** Draft -**Issue:** https://github.com/microsoft/aspire/issues/16317 -**DCP Issue:** https://github.com/microsoft/dcp/issues/6 - -## Overview - -The Aspire Terminal Protocol defines a binary framing protocol for interactive terminal I/O over Unix domain sockets (UDS). It is used to stream PTY data between a terminal producer (DCP or a terminal host process) and a terminal consumer (Aspire Dashboard, Aspire CLI, or other clients). - -The protocol is intentionally simple so that it can be implemented in both C# (Aspire) and Go (DCP) without shared code generation or IDL. - -## Transport - -- **Socket type:** Unix domain socket (`AF_UNIX`, `SOCK_STREAM`) -- **Byte order:** Big-endian (network byte order) for all multi-byte integers -- **Connection model:** A server listens on a UDS path. Clients connect to that path. Each connection is an independent terminal session. - -## Frame Format - -Every message on the wire is a **frame** with the following layout: - -``` -+--------+----------------+-----------------+ -| Type | Payload Length | Payload | -| 1 byte | 4 bytes (BE) | 0..N bytes | -+--------+----------------+-----------------+ -``` - -| Field | Size | Description | -|----------------|---------|-------------------------------------------------------| -| Type | 1 byte | Message type identifier (see table below) | -| Payload Length | 4 bytes | Unsigned 32-bit big-endian integer, length of payload | -| Payload | N bytes | Type-specific payload data | - -### Maximum Frame Size - -The maximum payload length is **1,048,576 bytes** (1 MiB). Receivers **must** reject frames with a payload length exceeding this limit and close the connection. This prevents memory exhaustion from malformed or malicious input. - -### Partial Reads/Writes - -Since UDS is a stream socket, a single `write()` does not guarantee a single `read()` on the other side. Implementations **must** handle partial reads by buffering until a complete frame header (5 bytes) and its full payload have been received. - -## Message Types - -| Type | Name | Direction | Payload | -|------|-------------|--------------------|----------------------------------| -| 0x01 | HELLO | Server → Client | Version + dimensions + flags | -| 0x02 | DATA | Either direction | Raw terminal bytes | -| 0x03 | RESIZE | Either direction | New dimensions | -| 0x04 | EXIT | Server → Client | Exit code + reason | -| 0x05 | CLOSE | Either direction | *(empty — payload length is 0)* | - -### 0x01 — HELLO - -Sent by the server as the **first frame** on every new connection. Establishes the protocol version and initial terminal dimensions. - -``` -+----------+--------+--------+--------+ -| Version | Cols | Rows | Flags | -| 1 byte | 2 BE | 2 BE | 1 byte | -+----------+--------+--------+--------+ -``` - -| Field | Size | Description | -|---------|---------|-----------------------------------------------------| -| Version | 1 byte | Protocol version. Currently `0x01`. | -| Cols | 2 bytes | Terminal width in columns (unsigned 16-bit BE) | -| Rows | 2 bytes | Terminal height in rows (unsigned 16-bit BE) | -| Flags | 1 byte | Capability flags (see below) | - -**Payload length:** 6 bytes (fixed). - -**Flags:** - -| Bit | Name | Description | -|-----|----------------|----------------------------------------------------| -| 0 | PTY | `1` if the server has a real PTY allocated | -| 1 | REPLAY | `1` if the server will replay buffered terminal state after HELLO | -| 2-7 | *(reserved)* | Must be `0`. Receivers must ignore unknown flags. | - -**Rules:** -- The server **must** send HELLO before any DATA frames. -- The server **must** buffer PTY output until HELLO has been written to the socket. -- The client **must** wait for HELLO before sending any frames. -- If the client receives a HELLO with an unsupported version, it **should** close the connection. - -### 0x02 — DATA - -Carries raw terminal bytes in either direction. - -- **Server → Client:** PTY output (stdout/stderr interleaved, as a real terminal would produce). These are raw bytes including ANSI escape sequences, UTF-8 text, and control characters. -- **Client → Server:** User input (keystrokes, mouse events encoded as ANSI escape sequences). These are raw bytes as a terminal emulator would generate. - -**Payload:** Variable-length raw bytes. Minimum 1 byte. Maximum 1 MiB. - -**Rules:** -- DATA frames carry opaque byte streams. Neither side should assume anything about framing alignment with respect to UTF-8 characters, escape sequences, or line boundaries. A single escape sequence may span multiple DATA frames, and a single DATA frame may contain multiple escape sequences. -- Empty DATA frames (payload length 0) are permitted but have no effect. - -### 0x03 — RESIZE - -Notifies the other side of a terminal dimension change. - -``` -+--------+--------+ -| Cols | Rows | -| 2 BE | 2 BE | -+--------+--------+ -``` - -| Field | Size | Description | -|-------|---------|------------------------------------------------| -| Cols | 2 bytes | New terminal width in columns (unsigned 16-bit BE) | -| Rows | 2 bytes | New terminal height in rows (unsigned 16-bit BE) | - -**Payload length:** 4 bytes (fixed). - -**Direction:** -- **Client → Server:** The client's display area changed (e.g., browser window resized, CLI terminal resized via `SIGWINCH`). The server should forward this to the PTY via `TIOCSWINSZ` / `SIGWINCH`. -- **Server → Client:** The server-side terminal dimensions changed (informational). The client should update its terminal emulator dimensions. - -### 0x04 — EXIT - -Sent by the server when the underlying process terminates. - -``` -+-----------+--------+ -| Exit Code | Reason | -| 4 bytes | 1 byte | -+-----------+--------+ -``` - -| Field | Size | Description | -|-----------|---------|--------------------------------------------------| -| Exit Code | 4 bytes | Signed 32-bit big-endian integer. Process exit code. `-1` if unknown. | -| Reason | 1 byte | Termination reason (see below) | - -**Payload length:** 5 bytes (fixed). - -**Reason values:** - -| Value | Name | Description | -|-------|-------------|--------------------------------------------------| -| 0x00 | EXITED | Process exited normally | -| 0x01 | KILLED | Process was killed (e.g., `SIGKILL`, `TerminateProcess`) | -| 0x02 | DETACHED | Server is detaching from the PTY (process may continue) | -| 0x03 | ERROR | Server encountered an unrecoverable error | - -**Rules:** -- After sending EXIT, the server **may** send a CLOSE frame or simply close the socket. -- After receiving EXIT, the client **should** stop sending DATA/RESIZE frames. - -### 0x05 — CLOSE - -Graceful session shutdown. Either side may send this to indicate it is done. - -**Payload length:** 0 bytes (fixed). - -**Rules:** -- After sending CLOSE, the sender **must not** send any further frames. -- After receiving CLOSE, the receiver **should** close its end of the socket. -- A CLOSE without a preceding EXIT from the server indicates an abnormal disconnection (e.g., the server crashed). - -## Connection Lifecycle - -### Normal Session - -``` -Client Server - | | - |-------- connect() ----------->| - | | - |<------- HELLO(v1, 80x24) -----| (server sends HELLO first) - |<------- DATA(buffered state) -| (optional: replay if REPLAY flag set) - |<------- DATA(live output) ----| - | | - |-------- DATA(keystroke) ----->| - |<------- DATA(echo + output) --| - | | - |-------- RESIZE(120x40) ----->| (client window resized) - |<------- DATA(repaint) --------| - | | - |<------- EXIT(0, EXITED) ------| (process exited) - |<------- CLOSE ----------------| - |-------- CLOSE --------------->| - | | -``` - -### Client-Initiated Disconnect - -``` -Client Server - | | - |-------- CLOSE --------------->| (user detached) - | | (server may keep process running) -``` - -### Server Crash - -``` -Client Server - | | - |<------- [socket closed] ------| (no CLOSE/EXIT — abnormal) - | | -``` - -## Error Handling - -| Condition | Action | -|----------------------------------|-------------------------------------------| -| Unknown message type received | Close socket immediately (protocol error) | -| Payload length exceeds 1 MiB | Close socket immediately (protocol error) | -| HELLO not received as first frame| Close socket immediately (protocol error) | -| Unsupported protocol version | Close socket (version mismatch) | -| Socket read returns 0 bytes | Peer disconnected, clean up | -| Socket write fails with EPIPE | Peer disconnected, clean up | -| Fixed-length payload has wrong size | Close socket (protocol error) | - -## Implementation Notes - -### For DCP (Go) - -- When `terminal.enabled = true` on an Executable/Container spec, DCP allocates a PTY and starts the UDS server at `terminal.socketPath`. -- DCP writes `HELLO` to each new client connection, then streams PTY output as `DATA` frames. -- DCP reads `DATA` frames from the client and writes them to the PTY's stdin. -- DCP reads `RESIZE` frames and calls `ioctl(TIOCSWINSZ)` on the PTY master. -- When the process exits, DCP sends `EXIT` followed by `CLOSE`. - -### For Aspire Terminal Host (C#) - -- The terminal host is used for non-DCP resources. It runs Hex1b with a custom `IHex1bTerminalPresentationAdapter` that implements the server side of this protocol. -- The adapter listens on the UDS, sends `HELLO`, bridges `DATA` frames to/from Hex1b's presentation interface, and forwards `RESIZE` events. - -### For Aspire Dashboard (C#/Blazor) - -- The Dashboard connects to the UDS (directly or via backchannel proxy), receives `HELLO`, and configures xterm.js with the initial dimensions. -- `DATA` frames from the server are written to xterm.js for rendering. -- Keystrokes from xterm.js are sent as `DATA` frames to the server. -- Browser resize events trigger `RESIZE` frames. - -### For Aspire CLI (C#) - -- The CLI connects to the UDS, receives `HELLO`, puts the local terminal in raw mode, and forwards bytes bidirectionally. -- `SIGWINCH` triggers a `RESIZE` frame to the server. -- `Ctrl+]` detaches by sending `CLOSE`. - -## Wire Examples - -### HELLO frame (version 1, 120 columns, 30 rows, PTY flag set) - -``` -01 # Type: HELLO -00 00 00 06 # Payload length: 6 -01 # Version: 1 -00 78 # Cols: 120 -00 1E # Rows: 30 -01 # Flags: PTY=1 -``` - -### DATA frame (5 bytes: "Hello") - -``` -02 # Type: DATA -00 00 00 05 # Payload length: 5 -48 65 6C 6C 6F # "Hello" -``` - -### RESIZE frame (200 columns, 50 rows) - -``` -03 # Type: RESIZE -00 00 00 04 # Payload length: 4 -00 C8 # Cols: 200 -00 32 # Rows: 50 -``` - -### EXIT frame (exit code 0, reason EXITED) - -``` -04 # Type: EXIT -00 00 00 05 # Payload length: 5 -00 00 00 00 # Exit code: 0 -00 # Reason: EXITED -``` - -### CLOSE frame - -``` -05 # Type: CLOSE -00 00 00 00 # Payload length: 0 -``` - -## Future Considerations - -- **Multiple clients:** The current design is single-client per UDS. Supporting multiple concurrent viewers would require a fan-out layer (e.g., the terminal host, or a backchannel proxy). The protocol itself does not need to change. -- **Authentication:** If the UDS needs access control beyond filesystem permissions, a future version could add an AUTH message type after HELLO. -- **Compression:** For high-throughput scenarios, a future version could negotiate compression in the HELLO flags. -- **Flow control:** The current design has no backpressure mechanism. If a client cannot keep up with output, it will buffer or lose frames. A future version could add windowed flow control. diff --git a/docs/specs/with-terminal.md b/docs/specs/with-terminal.md new file mode 100644 index 00000000000..fe0d78bf583 --- /dev/null +++ b/docs/specs/with-terminal.md @@ -0,0 +1,156 @@ +# `WithTerminal()` — Aspire interactive terminal architecture + +**Status:** Implemented for Aspire 13.4 (Windows executables). +**Issue:** [microsoft/aspire#16317](https://github.com/microsoft/aspire/issues/16317) +**DCP integration:** [microsoft/dcp#133](https://github.com/microsoft/dcp/pull/133) + +## Goal + +Let an Aspire AppHost author opt any executable or container resource into +interactive terminal access: + +```csharp +builder.AddProject("agent") + .WithReplicas(2) + .WithTerminal(); +``` + +The dashboard then renders an xterm.js terminal per replica, and the CLI +exposes the same session as `aspire terminal agent --replica 0`. + +## Process topology + +``` + ┌────────────────────────────┐ + │ AppHost (dotnet run) │ + │ - Aspire.Hosting │ + │ - DCP control plane │ + │ - per-resource: │ + │ Aspire.TerminalHost │ (1 process / WithTerminal()) + └─────────────┬──────────────┘ + │ spawn + ▼ +┌──────────────────────┐ ┌───────────────────────┐ ┌────────────────────────┐ +│ DCP-launched │ PTY (Win) │ TerminalHost │ HMP v1 UDS │ Consumers │ +│ replica process │ ─────────────▶ │ (Hex1b HMP v1 broker) │ ─────────────▶ │ - Dashboard │ +│ (executable, repl…) │ ◀───── stdin ─ │ │ ◀───── input ─ │ /api/terminal proxy │ +└──────────────────────┘ └───────────────────────┘ │ - aspire CLI │ + └────────────────────────┘ +``` + +Three actors and three socket roles: + +| Actor | Socket | Direction | Lifetime | +|----------------|---------------------|----------------------------------|----------| +| **DCP** | `producerUdsPath` | DCP → host (PTY bytes + control) | Per replica | +| **TerminalHost** | `consumerUdsPath` | host → consumers (broadcast) | Per replica | +| **TerminalHost** | `controlUdsPath` | AppHost → host (lifecycle, stats)| Per resource | + +The producer/consumer split lets multiple consumers (dashboard + multiple CLI +sessions) attach simultaneously without coupling DCP to consumer counts. + +## Wire protocol + +We do **not** define a custom protocol. The terminal traffic uses +[Hex1b](https://github.com/dotnet/hex1b)'s `HMP v1` (Hex Multiplex Protocol, +version 1), which already handles: + +- VT byte streaming with backpressure +- Resize requests in both directions +- Hello/StateSync replay so a late-attaching consumer sees the current + scrollback +- Connection lifecycle (close, disconnect, reconnect) +- Authenticated stream factory hooks (we only use Unix-socket transport + today) + +The `Hmp1WorkloadAdapter` is what the AppHost-side terminal host uses to +multiplex DCP's PTY traffic to the consumer-facing listener; the +`Hmp1PresentationAdapter` is what consumers (Dashboard WebSocket proxy and +the CLI) use to attach. + +## Property contract (gRPC `ResourceService` snapshots) + +When `WithTerminal()` is applied to a resource, every replica snapshot +emitted by the dashboard service carries four properties: + +| Key | Sensitivity | Meaning | +|---------------------------|-----------------|----------------------------------------------| +| `terminal.enabled` | non-sensitive | Marker. `"true"` when the replica has a PTY. | +| `terminal.replicaIndex` | non-sensitive | 0-based stable index from `DcpInstancesAnnotation`. | +| `terminal.replicaCount` | non-sensitive | Total replicas for the parent resource. | +| `terminal.consumerUdsPath`| **sensitive** | The local UDS that consumers connect to. | + +The consumer UDS path is marked `IsSensitive=true` so the dashboard UI masks +the value in the property list. The path still rides the gRPC stream because +the dashboard's WebSocket proxy needs it server-side to resolve +`?resource=&replica=` query parameters into a real socket; the path is never +echoed back to the browser. + +## Dashboard `/api/terminal` WebSocket endpoint + +Authenticated (`RequireAuthorization(FrontendAuthorizationDefaults.PolicyName)`) +endpoint at `/api/terminal?resource=&replica=`. + +`TerminalWebSocketProxy` resolves the connection entirely server-side: + +1. `ITerminalConnectionResolver.ConnectAsync(resourceName, replicaIndex, ct)` + walks `IDashboardClient.GetResources()`, matches by `DisplayName` + + `TryGetTerminalReplicaInfo`, and connects via + `Hmp1Transports.ConnectUnixSocket(consumerUdsPath, ct)`. +2. The proxy wraps the resulting stream in `Hmp1WorkloadAdapter` and runs + two pumps: + - **Inbound (browser → producer):** binary frames are forwarded as HMP v1 + `Input` (keystrokes); text frames are parsed as JSON resize control + messages (`{"type":"resize","cols":N,"rows":N}`). + - **Outbound (producer → browser):** VT bytes from the producer become + binary WebSocket frames; resize hints from the producer become JSON + text frames. +3. Frame type — not content — distinguishes keystroke from control. This + keeps the proxy's parser cheap and avoids ambiguity around binary input + that happens to look like JSON. +4. Multi-fragment WS reads are reassembled in `ReassembledFrame` using + `ArrayPool`. + +The browser never sees `consumerUdsPath` and cannot induce the dashboard +to connect to an arbitrary local socket — it can only ask for +`(resource, replica)` pairs that are present in the resource snapshot +stream. + +## CLI + +`aspire terminal [--replica N]` (`Aspire.Cli/Commands/TerminalCommand.cs`) +opens its own `Hmp1PresentationAdapter` against the consumer UDS path +returned by `IBackchannel.GetTerminalInfoAsync(resource, replica)` and +renders frames into the host terminal via Hex1b's `Hex1bTerminal`. When the +resource has more than one replica and the CLI is interactive, it prompts +for a selection; in non-interactive mode the `--replica` flag is required. + +## DCP integration + +DCP allocates a Windows ConPTY per replica when the spec carries +`terminal.enabled=true` and the supplied `terminal.producerUdsPath`, +`terminal.consumerUdsPath`, and `terminal.controlUdsPath` properties. DCP +opens the producer-side UDS and writes PTY traffic into it; the +TerminalHost owns the consumer-side listener and broadcasts to attached +clients. + +Linux / macOS / container PTY support is tracked as Phase 3 follow-ups in +the parent issue; for the 13.4 release, the playground guards +non-Windows code paths with `OperatingSystem.IsWindows()` checks. + +## Files of interest + +| Concern | File | +|--------------------------------------|---------------------------------------------------------------------| +| Public API entry point | `src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs` | +| Per-resource hidden host resource | `src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs` | +| DCP wire-up | `src/Aspire.Hosting/Dcp/ExecutableCreator.cs` | +| Backchannel `GetTerminalInfoAsync` | `src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs` | +| Snapshot stamping | `src/Aspire.Hosting/Dashboard/DashboardServiceData.cs` | +| TerminalHost process | `src/Aspire.TerminalHost/` | +| CLI command | `src/Aspire.Cli/Commands/TerminalCommand.cs` | +| Dashboard WebSocket proxy | `src/Aspire.Dashboard/Terminal/TerminalWebSocketProxy.cs` | +| Dashboard resolver | `src/Aspire.Dashboard/Terminal/DefaultTerminalConnectionResolver.cs`| +| `TerminalView` (xterm.js host) | `src/Aspire.Dashboard/Components/Controls/TerminalView.razor.*` | +| Property keys | `src/Shared/Model/KnownProperties.cs` (`Terminal.*`) | +| Playground sample | `playground/Terminals/Terminals.AppHost/AppHost.cs` | diff --git a/playground/Terminals/Terminals.AppHost/AppHost.cs b/playground/Terminals/Terminals.AppHost/AppHost.cs index cd6d25f27c6..5f350efaf77 100644 --- a/playground/Terminals/Terminals.AppHost/AppHost.cs +++ b/playground/Terminals/Terminals.AppHost/AppHost.cs @@ -3,10 +3,29 @@ var builder = DistributedApplication.CreateBuilder(args); -// Phase 8 of the WithTerminal work will rewrite this playground to demonstrate -// the new DCP-driven terminal flow against both an executable and a container. -// For now this is a no-op placeholder so the playground keeps building during -// Phase 1 (app-model refactor). +// A multi-replica project that calls `WithTerminal()` so each replica gets its +// own pseudo-terminal and the dashboard can attach to any of them via +// `/api/terminal?resource=repl&replica=`. The replica index is forwarded as +// an environment variable so the REPL can stamp it on its banner. +builder.AddProject("repl") + .WithReplicas(2) + .WithEnvironment("ASPIRE_RESOURCE_NAME", "repl") + .WithTerminal(options => + { + options.Columns = 120; + options.Rows = 32; + }); + +if (OperatingSystem.IsWindows()) +{ + // Single-replica executable wrapping cmd.exe to demonstrate that + // WithTerminal() also works for arbitrary executables, not just projects. + // DCP's PTY allocator currently only supports Windows, so this branch is + // gated behind an OS check; future Phase 3 follow-ups will extend it to + // Linux and macOS. + builder.AddExecutable("shell", "cmd.exe", ".") + .WithTerminal(); +} #if !SKIP_DASHBOARD_REFERENCE // This project is only added in playground projects to support development/debugging @@ -19,3 +38,4 @@ #endif builder.Build().Run(); + diff --git a/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj index f396eeea262..2188093f6b6 100644 --- a/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj +++ b/playground/Terminals/Terminals.AppHost/Terminals.AppHost.csproj @@ -12,6 +12,10 @@ + + + + diff --git a/playground/Terminals/Terminals.Repl/Program.cs b/playground/Terminals/Terminals.Repl/Program.cs new file mode 100644 index 00000000000..17a957cbd9c --- /dev/null +++ b/playground/Terminals/Terminals.Repl/Program.cs @@ -0,0 +1,112 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Globalization; + +const string Reset = "\u001b[0m"; +const string Bold = "\u001b[1m"; +const string Cyan = "\u001b[36m"; +const string Green = "\u001b[32m"; +const string Yellow = "\u001b[33m"; +const string Magenta = "\u001b[35m"; + +var resourceName = Environment.GetEnvironmentVariable("ASPIRE_RESOURCE_NAME") ?? "repl"; +var processId = Environment.ProcessId.ToString(CultureInfo.InvariantCulture); + +PrintBanner(resourceName, processId); + +while (true) +{ + Console.Write($"{Bold}{Magenta}{resourceName}#{processId}{Reset}{Cyan}>{Reset} "); + var line = Console.ReadLine(); + if (line is null) + { + // PTY closed. + break; + } + + var trimmed = line.Trim(); + if (trimmed.Length == 0) + { + continue; + } + + var parts = trimmed.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries); + var command = parts[0].ToLowerInvariant(); + var rest = parts.Length > 1 ? parts[1] : string.Empty; + + switch (command) + { + case "help" or "?": + PrintHelp(); + break; + case "exit" or "quit": + Console.WriteLine($"{Yellow}Goodbye from {resourceName} pid {processId}.{Reset}"); + return 0; + case "clear" or "cls": + // ANSI clear screen + cursor to home. + Console.Write("\u001b[2J\u001b[H"); + break; + case "time": + Console.WriteLine($"{Green}{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff zzz", CultureInfo.InvariantCulture)}{Reset}"); + break; + case "size": + Console.WriteLine($"{Green}{Console.WindowWidth} cols x {Console.WindowHeight} rows{Reset}"); + break; + case "rainbow": + PrintRainbow(rest.Length > 0 ? rest : "Hello from Aspire!"); + break; + case "echo": + Console.WriteLine(rest); + break; + case "whoami": + Console.WriteLine($"{Bold}{Cyan}{resourceName}{Reset} pid {Bold}{processId}{Reset}"); + break; + default: + Console.WriteLine($"{Yellow}Unknown command:{Reset} {trimmed}. Type {Bold}help{Reset} for a list."); + break; + } +} + +return 0; + +static void PrintBanner(string resourceName, string processId) +{ + Console.WriteLine(); + Console.WriteLine($"{Cyan}┌─────────────────────────────────────────────────────┐{Reset}"); + Console.WriteLine($"{Cyan}│{Reset} {Bold}Aspire WithTerminal demo REPL{Reset} {Cyan}│{Reset}"); + Console.WriteLine($"{Cyan}│{Reset} resource: {Bold}{Magenta}{resourceName,-20}{Reset} pid: {Bold}{processId,-7}{Reset} {Cyan}│{Reset}"); + Console.WriteLine($"{Cyan}└─────────────────────────────────────────────────────┘{Reset}"); + Console.WriteLine($"Type {Bold}help{Reset} to see available commands. Type {Bold}exit{Reset} to leave."); + Console.WriteLine(); +} + +static void PrintHelp() +{ + Console.WriteLine($"{Bold}Available commands:{Reset}"); + Console.WriteLine($" {Cyan}help{Reset} Show this help"); + Console.WriteLine($" {Cyan}whoami{Reset} Show resource name + process id"); + Console.WriteLine($" {Cyan}time{Reset} Show local time"); + Console.WriteLine($" {Cyan}size{Reset} Show terminal dimensions (resize the window!)"); + Console.WriteLine($" {Cyan}echo {Reset} Echo a line back"); + Console.WriteLine($" {Cyan}rainbow [text]{Reset} Print rainbow text"); + Console.WriteLine($" {Cyan}clear{Reset} Clear the screen"); + Console.WriteLine($" {Cyan}exit{Reset} Quit the REPL"); +} + +static void PrintRainbow(string text) +{ + string[] colors = + [ + "\u001b[31m", "\u001b[33m", "\u001b[32m", "\u001b[36m", "\u001b[34m", "\u001b[35m", + ]; + + var sb = new System.Text.StringBuilder(); + for (var i = 0; i < text.Length; i++) + { + sb.Append(colors[i % colors.Length]).Append(text[i]); + } + + sb.Append(Reset); + Console.WriteLine(sb.ToString()); +} diff --git a/playground/Terminals/Terminals.Repl/Terminals.Repl.csproj b/playground/Terminals/Terminals.Repl/Terminals.Repl.csproj new file mode 100644 index 00000000000..d826a2af06f --- /dev/null +++ b/playground/Terminals/Terminals.Repl/Terminals.Repl.csproj @@ -0,0 +1,11 @@ + + + + Exe + $(DefaultTargetFramework) + enable + enable + Terminals.Repl + + + diff --git a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs index 09684c457c7..5a164115c30 100644 --- a/src/Aspire.Hosting/Dcp/ExecutableCreator.cs +++ b/src/Aspire.Hosting/Dcp/ExecutableCreator.cs @@ -312,6 +312,12 @@ private void PreparePlainExecutables() exe.Annotate(CustomResource.OtelServiceNameAnnotation, executable.Name); exe.Annotate(CustomResource.OtelServiceInstanceIdAnnotation, exeInstance.Suffix); exe.Annotate(CustomResource.ResourceNameAnnotation, executable.Name); + // Plain executables are always single-replica today, but the terminal wire-up + // (and any other replica-aware downstream logic) needs both annotations to be + // present. Without them WithTerminal() can't resolve the producer UDS for the + // replica and silently falls back to a no-op. + exe.Annotate(CustomResource.ResourceReplicaCount, "1"); + exe.Annotate(CustomResource.ResourceReplicaIndex, "0"); if (executable.SupportsDebugging(_configuration, out _)) { diff --git a/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs b/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs index 2afd779dee0..5d65a6a5c0e 100644 --- a/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs +++ b/tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs @@ -3285,6 +3285,47 @@ public async Task Project_WithoutTerminal_HasNullTerminalSpec() Assert.Null(exe.Spec.Terminal); } + [Fact] + public async Task PlainExecutable_WithTerminal_PopulatesTerminalSpecOnWindows() + { + // Regression test: plain executables added via AddExecutable() were missing + // the ResourceReplicaIndex/ResourceReplicaCount annotations, which caused + // BuildExecutableConfiguration to skip the spec.Terminal wire-up entirely + // (the per-replica producer UDS path lookup in TerminalHostLayout was guarded + // by a successful TryGetReplicaIndex). + Assert.SkipUnless(OperatingSystem.IsWindows(), "DCP terminal support is currently Windows-only."); + + var builder = DistributedApplication.CreateBuilder(); + var resource = builder.AddExecutable("shell", "cmd.exe", ".") + .WithTerminal(options => + { + options.Columns = 100; + options.Rows = 30; + }) + .Resource; + + var kubernetesService = new TestKubernetesService(); + using var app = builder.Build(); + var distributedAppModel = app.Services.GetRequiredService(); + + var appExecutor = CreateAppExecutor(distributedAppModel, kubernetesService: kubernetesService); + await appExecutor.RunApplicationAsync(); + + var exe = Assert.Single(kubernetesService.CreatedResources.OfType(), e => e.AppModelResourceName == "shell"); + var layout = resource.Annotations.OfType().Single().TerminalHost.Layout; + + Assert.NotNull(exe.Spec.Terminal); + Assert.True(exe.Spec.Terminal!.Enabled); + Assert.Equal(layout.ProducerUdsPaths[0], exe.Spec.Terminal.UdsPath); + Assert.Equal(100, exe.Spec.Terminal.Cols); + Assert.Equal(30, exe.Spec.Terminal.Rows); + + // Plain executables are always single-replica today; both annotations must + // be present for the per-replica lookup to succeed. + Assert.Equal("1", exe.Metadata.Annotations?[CustomResource.ResourceReplicaCount]); + Assert.Equal("0", exe.Metadata.Annotations?[CustomResource.ResourceReplicaIndex]); + } + private static DcpExecutor CreateAppExecutor( DistributedApplicationModel distributedAppModel, IHostEnvironment? hostEnvironment = null, From e8e6aef545abbb8056613c6abf7a3a8133a648df Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 12:41:00 +1000 Subject: [PATCH 18/20] Phase 8 fix: TerminalView reacts to resource/replica parameter changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The Dashboard ConsoleLogs page reuses the same TerminalView instance when the user switches between terminal-enabled resources (or between replicas of the same resource), so firstRender is never true again after the first switch. The original implementation only initialized the xterm.js / WebSocket bridge on firstRender, which left the view stuck on whichever resource was initially selected. Track the (resource, replica) pair we last connected to, and call the existing ReconnectAsync path from OnAfterRenderAsync whenever the parameters change. The JS side already has reconnectTerminal which closes the old WebSocket, clears the screen, and opens a new connection — the StateSync replay from the new producer fills the buffer with the right replica's content. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Components/Controls/TerminalView.razor.cs | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs index 5a0ac9bb00d..ee01cbb1707 100644 --- a/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs +++ b/src/Aspire.Dashboard/Components/Controls/TerminalView.razor.cs @@ -17,6 +17,8 @@ public sealed partial class TerminalView : ComponentBase, IAsyncDisposable private ElementReference _terminalElement; private IJSObjectReference? _jsModule; private int _terminalId; + private string? _connectedResourceName; + private int _connectedReplicaIndex = -1; /// /// Gets or sets the user-facing display name of the resource that owns the @@ -40,9 +42,32 @@ public sealed partial class TerminalView : ComponentBase, IAsyncDisposable protected override async Task OnAfterRenderAsync(bool firstRender) { - if (firstRender && !string.IsNullOrEmpty(ResourceName)) + if (string.IsNullOrEmpty(ResourceName)) + { + return; + } + + if (firstRender) { await InitializeTerminalAsync(); + _connectedResourceName = ResourceName; + _connectedReplicaIndex = ReplicaIndex; + return; + } + + // The same TerminalView instance is reused across resource/replica + // switches in the parent (e.g. ConsoleLogs page selects a different + // terminal-enabled resource). Detect that here and rebind the + // underlying WebSocket; xterm.js is preserved and just gets cleared + // and refilled by the new connection's StateSync replay. + if (!string.Equals(ResourceName, _connectedResourceName, StringComparison.Ordinal) || + ReplicaIndex != _connectedReplicaIndex) + { + var newResource = ResourceName; + var newReplica = ReplicaIndex; + await ReconnectAsync(newResource, newReplica); + _connectedResourceName = newResource; + _connectedReplicaIndex = newReplica; } } From d7ecb7b2360094fb85679a7187602fd5737f78af Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 14:10:25 +1000 Subject: [PATCH 19/20] WithTerminal: container support + Node.js playground ContainerCreator now mirrors the per-resource TerminalAnnotation -> DCP TerminalSpec wiring that ExecutableCreator already does. Containers are single-replica in DCP, so we always reference index 0 of the host's UDS layout (the same layout the executable path uses for replica index 0). The companion DCP-side change is in microsoft/dcp#138 (stacked on microsoft/dcp#133): when ContainerSpec.Terminal is set, DCP creates the container with `-t -i` and runs `docker start --attach --interactive` under a host ConPTY exposing the resulting byte stream as an HMP v1 producer at TerminalSpec.UDSPath. The Aspire-side terminal host then connects as an HMP v1 client, identical to the executable case. Like the executable path, this is currently gated behind a Windows OS check; on other platforms ContainerCreator logs a warning and leaves TerminalSpec unset so the container runs without an attachable terminal. Playground: adds a `nodebox` container resource (node:lts) with `WithEntrypoint(""/bin/bash"")` so users can attach the dashboard terminal and use `npx` / `node` interactively. Also re-enables `WithTerminal()` on the existing `shell` (cmd.exe) executable that was commented out for IDE-debug investigation in Phase 8. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../Terminals/Terminals.AppHost/AppHost.cs | 10 ++++++ src/Aspire.Hosting/Dcp/ContainerCreator.cs | 34 +++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/playground/Terminals/Terminals.AppHost/AppHost.cs b/playground/Terminals/Terminals.AppHost/AppHost.cs index 5f350efaf77..92c4af396f3 100644 --- a/playground/Terminals/Terminals.AppHost/AppHost.cs +++ b/playground/Terminals/Terminals.AppHost/AppHost.cs @@ -25,6 +25,16 @@ // Linux and macOS. builder.AddExecutable("shell", "cmd.exe", ".") .WithTerminal(); + + // Container resource exercising the container-side WithTerminal() path. + // We launch a long-running Node.js LTS image with bash as the entry point + // so the terminal attaches to an interactive shell where `npx`, `node`, + // and friends are available. `WithContainerRuntimeArgs("-i")` is not + // needed here — DCP injects `-t -i` automatically when the spec has + // Terminal enabled (see internal/docker/cli_orchestrator.go). + builder.AddContainer("nodebox", "node", "lts") + .WithEntrypoint("/bin/bash") + .WithTerminal(); } #if !SKIP_DASHBOARD_REFERENCE diff --git a/src/Aspire.Hosting/Dcp/ContainerCreator.cs b/src/Aspire.Hosting/Dcp/ContainerCreator.cs index 727bd2b4d81..4d0c8eb9844 100644 --- a/src/Aspire.Hosting/Dcp/ContainerCreator.cs +++ b/src/Aspire.Hosting/Dcp/ContainerCreator.cs @@ -303,6 +303,40 @@ private async Task BuildAndCreateContainerAsync(RenderedModelResource } spec.PemCertificates = pemCertificates; + // Configure the terminal spec if the resource has a TerminalAnnotation. + // Containers are always single-replica, so the layout's index 0 paths + // are used directly. DCP currently implements PTY support on Windows + // only; on other platforms we leave Terminal unset and log a warning. + if (modelContainer.TryGetAnnotationsOfType(out var terminalAnnotations)) + { + var terminalAnnotation = terminalAnnotations.FirstOrDefault(); + if (terminalAnnotation is not null) + { + if (!System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(System.Runtime.InteropServices.OSPlatform.Windows)) + { + logger.LogWarning( + "WithTerminal() is currently only supported on Windows. Container resource '{ResourceName}' will run without an attachable terminal in this Aspire version.", + modelContainer.Name); + } + else if (terminalAnnotation.TerminalHost.Layout.ProducerUdsPaths.Count > 0) + { + spec.Terminal = new TerminalSpec + { + Enabled = true, + UdsPath = terminalAnnotation.TerminalHost.Layout.ProducerUdsPaths[0], + Cols = terminalAnnotation.Options.Columns, + Rows = terminalAnnotation.Options.Rows + }; + } + else + { + logger.LogWarning( + "Could not determine a producer UDS path for container resource '{ResourceName}'; terminal will not be attached.", + modelContainer.Name); + } + } + } + var dcpInfo = await _dcpDependencyCheckService.GetDcpInfoAsync(cancellationToken: cToken).ConfigureAwait(false); if (dcpInfo is not null) { From 3f5491c63c8abdc42414fdda5e3a00cc92804849 Mon Sep 17 00:00:00 2001 From: Mitch Denny Date: Tue, 5 May 2026 14:56:59 +1000 Subject: [PATCH 20/20] Terminals playground: nodebox fix - override CMD instead of entrypoint WithEntrypoint(""/bin/bash"") only overrides the image's ENTRYPOINT; the image's CMD (""node"") is still inherited, so docker actually executes `/bin/bash node` which makes bash treat `node` as a missing script file and exit immediately - the container is gone before the dashboard's Terminal tab even gets a chance to attach. Switching to `WithArgs(""bash"", ""-l"")` keeps the image's docker-entrypoint.sh in place and overrides the CMD, so the entrypoint exec's an interactive login bash, which sticks around for the terminal session and exits cleanly when the user types `exit` (which then propagates through the host PTY's docker-start-attach process and signals container exit via Session.Done()). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- playground/Terminals/Terminals.AppHost/AppHost.cs | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/playground/Terminals/Terminals.AppHost/AppHost.cs b/playground/Terminals/Terminals.AppHost/AppHost.cs index 92c4af396f3..9b02a0454cf 100644 --- a/playground/Terminals/Terminals.AppHost/AppHost.cs +++ b/playground/Terminals/Terminals.AppHost/AppHost.cs @@ -27,13 +27,14 @@ .WithTerminal(); // Container resource exercising the container-side WithTerminal() path. - // We launch a long-running Node.js LTS image with bash as the entry point - // so the terminal attaches to an interactive shell where `npx`, `node`, - // and friends are available. `WithContainerRuntimeArgs("-i")` is not - // needed here — DCP injects `-t -i` automatically when the spec has - // Terminal enabled (see internal/docker/cli_orchestrator.go). + // Launches a long-running Node.js LTS image with an interactive bash so + // the terminal attaches to a shell where `npx`, `node`, and friends are + // available. We override the image CMD (not the entrypoint!) so the + // image's docker-entrypoint.sh keeps running and exec's bash for us; + // overriding the entrypoint instead would leave the image's CMD + // ("node") appended after bash and immediately exit. builder.AddContainer("nodebox", "node", "lts") - .WithEntrypoint("/bin/bash") + .WithArgs("bash", "-l") .WithTerminal(); }