Compare commits
85
Commits
No files matched your search
@@ -334,7 +334,9 @@ jobs:
|
||||
run: npx vitest run
|
||||
|
||||
# `--locked`: test against the committed Cargo.lock, never a re-resolved
|
||||
# one, for the same reason the frontend uses `npm ci`.
|
||||
# one, for the same reason the frontend uses `npm ci`. No plugin fetch
|
||||
# here: a debug build gets a placeholder for the session-manager-plugin
|
||||
# sidecar from build.rs, so tests never build Go or download anything.
|
||||
- name: Backend tests (cargo test)
|
||||
working-directory: ./app/src-tauri
|
||||
run: |
|
||||
@@ -468,6 +470,14 @@ jobs:
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri --version || npm install @tauri-apps/cli
|
||||
|
||||
# The AWS Session Manager plugin, bundled as a sidecar (bundle.externalBin)
|
||||
# so AWS workspaces work without the user installing it. Built here from
|
||||
# AWS's Apache-2.0 source (pinned commit + archive SHA-256) with a pinned,
|
||||
# hash-checked Go; the output must match a pinned SHA-256 (reproducible
|
||||
# build). A release build refuses to start without it (build.rs).
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: bash scripts/build-ssm-plugin.sh x86_64-unknown-linux-gnu
|
||||
|
||||
- name: Build Tauri app
|
||||
working-directory: ./app
|
||||
env:
|
||||
@@ -597,6 +607,15 @@ jobs:
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri --version || npm install @tauri-apps/cli
|
||||
|
||||
# The AWS Session Manager plugin sidecar (bundle.externalBin), built from
|
||||
# source (see build-ssm-plugin.sh): both thin slices (tauri-build checks
|
||||
# each arch it compiles) and the lipo'd universal one the bundler copies
|
||||
# into Contents/MacOS. Each must match its pinned SHA-256. Signed exactly
|
||||
# like the app: Go ad-hoc signs the arm64 slice, and with APPLE_* signing
|
||||
# configured Tauri would sign the sidecar with the app's identity.
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: bash scripts/build-ssm-plugin.sh universal-apple-darwin
|
||||
|
||||
- name: Build Tauri app (universal)
|
||||
working-directory: ./app
|
||||
env:
|
||||
@@ -606,6 +625,21 @@ jobs:
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri build --target universal-apple-darwin
|
||||
|
||||
# The sidecar and its notices must be in the bundle Tauri made: the
|
||||
# plugin in Contents/MacOS with both slices, THIRD_PARTY_NOTICES in
|
||||
# Contents/Resources (bundle.resources).
|
||||
- name: Check the bundled Session Manager plugin
|
||||
run: |
|
||||
app_dir="$(ls -d app/src-tauri/target/universal-apple-darwin/release/bundle/macos/*.app | head -n1)"
|
||||
[ -n "$app_dir" ] || { echo "no .app bundle"; exit 1; }
|
||||
plugin="$app_dir/Contents/MacOS/session-manager-plugin"
|
||||
[ -x "$plugin" ] || { echo "missing $plugin"; exit 1; }
|
||||
archs="$(lipo -archs "$plugin")"
|
||||
case " $archs " in *" x86_64 "*) ;; *) echo "plugin lacks x86_64 ($archs)"; exit 1 ;; esac
|
||||
case " $archs " in *" arm64 "*) ;; *) echo "plugin lacks arm64 ($archs)"; exit 1 ;; esac
|
||||
"$plugin" --version
|
||||
[ -f "$app_dir/Contents/Resources/THIRD_PARTY_NOTICES" ] || { echo "missing Contents/Resources/THIRD_PARTY_NOTICES"; exit 1; }
|
||||
|
||||
- name: Collect artifacts
|
||||
run: |
|
||||
mkdir -p artifacts
|
||||
@@ -729,6 +763,13 @@ jobs:
|
||||
set "PATH=%USERPROFILE%\.cargo\bin;C:\Program Files\nodejs;%PATH%"
|
||||
npm run build
|
||||
|
||||
# The AWS Session Manager plugin sidecar (bundle.externalBin), built from
|
||||
# source (see build-ssm-plugin.ps1); must match its pinned SHA-256. It
|
||||
# comes out unsigned, so it ships unsigned in previews, like the
|
||||
# app (releases sign it: see build-app.yml).
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: powershell -NoProfile -NonInteractive -ExecutionPolicy Bypass -File scripts\build-ssm-plugin.ps1
|
||||
|
||||
- name: Build Tauri app
|
||||
working-directory: ./app
|
||||
# Previews are not code-signed: signing is metered, previews are built
|
||||
|
||||
@@ -227,6 +227,14 @@ jobs:
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri --version || npm install @tauri-apps/cli
|
||||
|
||||
# The AWS Session Manager plugin, bundled as a sidecar (bundle.externalBin)
|
||||
# so AWS workspaces work without the user installing it. Built here from
|
||||
# AWS's Apache-2.0 source (pinned commit + archive SHA-256) with a pinned,
|
||||
# hash-checked Go; the output must match a pinned SHA-256 (reproducible
|
||||
# build). A release build refuses to start without it (build.rs).
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: bash scripts/build-ssm-plugin.sh x86_64-unknown-linux-gnu
|
||||
|
||||
- name: Build Tauri app
|
||||
working-directory: ./app
|
||||
run: |
|
||||
@@ -417,12 +425,36 @@ jobs:
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri --version || npm install @tauri-apps/cli
|
||||
|
||||
# The AWS Session Manager plugin sidecar (bundle.externalBin), built from
|
||||
# source (see build-ssm-plugin.sh): both thin slices (tauri-build checks
|
||||
# each arch it compiles) and the lipo'd universal one the bundler copies
|
||||
# into Contents/MacOS. Each must match its pinned SHA-256. Signed exactly
|
||||
# like the app: Go ad-hoc signs the arm64 slice, and with APPLE_* signing
|
||||
# configured Tauri would sign the sidecar with the app's identity.
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: bash scripts/build-ssm-plugin.sh universal-apple-darwin
|
||||
|
||||
- name: Build Tauri app (universal)
|
||||
working-directory: ./app
|
||||
run: |
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
npx tauri build --target universal-apple-darwin
|
||||
|
||||
# The sidecar and its notices must be in the bundle Tauri made: the
|
||||
# plugin in Contents/MacOS with both slices, THIRD_PARTY_NOTICES in
|
||||
# Contents/Resources (bundle.resources).
|
||||
- name: Check the bundled Session Manager plugin
|
||||
run: |
|
||||
app_dir="$(ls -d app/src-tauri/target/universal-apple-darwin/release/bundle/macos/*.app | head -n1)"
|
||||
[ -n "$app_dir" ] || { echo "no .app bundle"; exit 1; }
|
||||
plugin="$app_dir/Contents/MacOS/session-manager-plugin"
|
||||
[ -x "$plugin" ] || { echo "missing $plugin"; exit 1; }
|
||||
archs="$(lipo -archs "$plugin")"
|
||||
case " $archs " in *" x86_64 "*) ;; *) echo "plugin lacks x86_64 ($archs)"; exit 1 ;; esac
|
||||
case " $archs " in *" arm64 "*) ;; *) echo "plugin lacks arm64 ($archs)"; exit 1 ;; esac
|
||||
"$plugin" --version
|
||||
[ -f "$app_dir/Contents/Resources/THIRD_PARTY_NOTICES" ] || { echo "missing Contents/Resources/THIRD_PARTY_NOTICES"; exit 1; }
|
||||
|
||||
- name: Collect artifacts
|
||||
run: |
|
||||
mkdir -p artifacts
|
||||
@@ -656,6 +688,13 @@ jobs:
|
||||
set "PATH=%USERPROFILE%\.cargo\bin;C:\Program Files\nodejs;%PATH%"
|
||||
npm run build
|
||||
|
||||
# The AWS Session Manager plugin sidecar (bundle.externalBin), built from
|
||||
# source (see build-ssm-plugin.ps1); must match its pinned SHA-256. It
|
||||
# comes out unsigned, so Tauri hands it to the sign command and
|
||||
# "Verify signatures" requires our signature on it in both installers.
|
||||
- name: Build the AWS Session Manager plugin
|
||||
run: powershell -NoProfile -NonInteractive -ExecutionPolicy Bypass -File scripts\build-ssm-plugin.ps1
|
||||
|
||||
# Releases are signed with Azure Artifact Signing (scripts/windows-*.ps1).
|
||||
# The setup fetches the signing client and a job-local .NET runtime, and
|
||||
# writes the Tauri config holding the sign command, which "Build Tauri
|
||||
|
||||
@@ -27,3 +27,7 @@ screenshot_for_fix/
|
||||
*.tfstate
|
||||
*.tfstate.*
|
||||
.terraform.tfstate.lock.info
|
||||
|
||||
# The bundled AWS session-manager-plugin sidecar (scripts/build-ssm-plugin.*, built from source) and the
|
||||
# debug-build placeholder build.rs writes there. Never committed.
|
||||
app/src-tauri/binaries/
|
||||
@@ -14,7 +14,8 @@ All frontend/tauri commands run from the `app/` directory:
|
||||
cd app
|
||||
npm ci # Install dependencies (required first time)
|
||||
npx tauri dev # Launch app in dev mode with hot reload (Vite on port 1420)
|
||||
npx tauri build # Production build (outputs to src-tauri/target/release/bundle/)
|
||||
npx tauri build # Production build (outputs to src-tauri/target/release/bundle/);
|
||||
# run ../scripts/build-ssm-plugin.sh first (bundled AWS plugin, see Packaging)
|
||||
npm run build # Frontend-only build (tsc + vite)
|
||||
npm run test # Run Vitest once
|
||||
npm run test:watch # Run Vitest in watch mode
|
||||
@@ -284,7 +285,7 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
users have migrated.
|
||||
- **`host/`** — Where a project's container runs, and the only way into it. `ContainerTarget`
|
||||
(`Docker`, and `Agent` — reached through the in-container `triple-c-agent` by `agent.rs`, per
|
||||
`docs/superpowers/specs/2026-11-13-triple-c-agent-protocol.md`; AWS planned —
|
||||
`docs/superpowers/specs/2026-11-13-triple-c-agent-protocol.md`; AWS host, designed in
|
||||
`docs/superpowers/specs/2026-11-13-aws-ecs-host-design.md`)
|
||||
wraps execs, file transfer and `is_running`; `sessions.rs` holds `ExecSessionManager`.
|
||||
`ssm.rs` is the AWS transport to an `Agent` target: one SSM port-forward per task, run through
|
||||
@@ -292,7 +293,7 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
when it drops, so an `AgentEndpoint` stays valid. The `StartSession` token goes to the plugin
|
||||
through its environment, never argv, and the plugin's environment is stripped of every
|
||||
inherited `AWS_*` variable before the session's own credentials are added.
|
||||
`aws_host.rs` is `ProjectHost::Aws` (an ECS Fargate task per project; a running task is
|
||||
`aws_host.rs` is `ProjectHost::Aws` (an ECS task per project, Fargate or, on the user's own instance, EC2; a running task is
|
||||
attached to with the token read back from its secret, never rotated; a task a failed start ran
|
||||
is stopped again) and `tunnels.rs` the registry of open tunnels by project — an AWS project's
|
||||
`ContainerTarget::for_project` is its tunnel's endpoint, its stored `container_id` is that
|
||||
@@ -300,6 +301,78 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
every tunnel (`for_project` is `None` while none is open; `for_project_waiting` covers the
|
||||
background re-attach after an app restart). AWS SDK calls stay in `aws/` (`runtime.rs`,
|
||||
`tasks.rs`, `workspace.rs`).
|
||||
`port_forwards.rs` is an AWS project's port mappings: each TCP mapping is a **loopback-only**
|
||||
auth-bridge `PortForward::bind_mapping` over socat-over-attach. Two deliberate differences from
|
||||
Docker: it reaches the workspace's **loopback** (Docker publishes to eth0), so the agent port,
|
||||
the browser-view ranges and — with `gateway_sidecar` on — the sidecar's 4000 are refused; and it
|
||||
has **no gate** (no first-byte wait, no cross-site check, unlike the bridge). Validated on save
|
||||
(rows the save adds/edits; everything when newly on AWS or the sidecar is switched); a stored row
|
||||
that would be refused is skipped with a warning at connect. Opens are serialised per project and
|
||||
re-read the stored mappings under that lock; unchanged forwards are kept with their connections.
|
||||
Opened after every connect and on a save while connected; closed by every `tunnels::close*`
|
||||
path. A failing mapping is a `workspace-warning` (`topic: "ports"`), and so is a Running project
|
||||
whose mappings could not be opened at all (no tunnel / tunnel replaced) — never silent; a stored
|
||||
row missing a port (0) is skipped with one too ("incomplete, both ports are needed").
|
||||
`PortMappingsEditor` saves only complete rows (half-filled ones stay local, marked), adopts a
|
||||
stored value only when it differs by value and no field in it has focus, and uses word
|
||||
placeholders — a "8080" placeholder once read as a typed 8080 → 8080 that was saved as 0 → 0. In the
|
||||
workspace each connection picks `127.0.0.1` or `[::1]` from `/proc/net/tcp{,6}`
|
||||
(`tunnel::mapping_command`; no probe connection), and the first socat "Connection refused" per
|
||||
mapping is a `ports` warning ("nothing is listening on port N"). An idle listener makes no
|
||||
agent request; a connection carrying traffic is activity (keeps the workspace from idling).
|
||||
**`persistent.rs` is persistent AWS terminals** (Docker projects never reach it): every tab on an
|
||||
AWS project — Claude and bash, desktop and web terminal — runs its **unchanged** launch command
|
||||
(update prelude and all, or `bash -l`) inside **its own tmux server**,
|
||||
`tmux -L triple-c-<session id> -f /etc/triple-c/tmux.conf new-session -A -s <claude|bash> -- <cmd>`.
|
||||
Rules, each for a reason:
|
||||
- **One server per tab, never one shared server**: a server takes its environment from the
|
||||
client that started it, so each tab keeps exactly its own `ExecSpec.env` (copy-at-connect
|
||||
`terminal_env` pairs). Never `new-session -e` — that puts the values on argv (`ps`). A later
|
||||
connect's new credentials do not reach a session already running (like any running process).
|
||||
The client gets `TERM=xterm-256color` (the agent would default a tty to `xterm`, 8 colours).
|
||||
- **The tab's session id is the tmux key** (validated `[A-Za-z0-9-]{1,64}`), remembered per
|
||||
project in `storage/terminal_store.rs` (`terminal-sessions.json` beside `projects.json`; a
|
||||
hint pruned by the workspace's own listing, cleared on Stop/Remove; not a `Project` field, for
|
||||
the reason notes aren't). Same id after a restart, so `renamed_session_names` still applies.
|
||||
- **Closing a tab ends the session** (`kill-server`); app exit, a dropped tunnel and the agent's
|
||||
SIGHUP on a vanished client only **detach** (the server daemonised out of the client's
|
||||
process group). **Reattach is `attach-session`, never `new-session -A`**: a session that
|
||||
ended while the app was away must not come back as a fresh `claude` (and the update prelude
|
||||
runs once, inside, never again on reattach).
|
||||
- **Stop ends every tmux server** (`persistent::END_ALL_SCRIPT`: the panes' pids are taken
|
||||
before `kill-server`, then a bounded 5 s wait for them and the servers) in the same
|
||||
`close_first` step that closes the tabs, **before** the stop guard's push snapshot. The
|
||||
entrypoint's TERM hook (`aws_end_terminals`) and the idle watcher's lifetime-cap push run the
|
||||
same script verbatim (a test pins all three). The store is cleared on Stop, Remove, a move to
|
||||
Docker and a death-watch stop.
|
||||
- **The probe** (`command -v tmux` + the config) runs once per tunnel, cached by target id and
|
||||
forgotten in `tunnels::register*`, and is **three-state**: yes → persistent; a real no (an
|
||||
image without tmux) → the old launch plus a one-time notice; **unanswered → `Err`**, never
|
||||
"no" — read as no, a listing would prune every remembered tab and a reattach would end tabs
|
||||
whose Claude still runs. Nothing is pruned or ended on an `Err`; the frontend asks again.
|
||||
Every tmux exec except the attach goes through `exec_oneshot_background` (never idle-stop
|
||||
activity). `TMUX`/`TMUX_TMPDIR` are dropped from the client env and reserved custom names.
|
||||
- **A tab closed while disconnected** is queued (`terminal_store` `pending_end`) and ended at the
|
||||
next connect (`list_workspace_terminals` runs it first); a reattach of a closed or queued id
|
||||
is `Ended`, and a reattach that finishes after its tab closed does not remember it again.
|
||||
- **The web terminal's exec ids are `web-<tmux key>`**, never the bare key the desktop uses:
|
||||
sharing one `ExecSessionManager` id would let either front end's attach supersede the
|
||||
other's exec (no exit callback, a frozen tab) or its close/disconnect end the other's.
|
||||
- **Cost, by ruling:** a detached `claude` still counts for the idle watcher — that *is* the
|
||||
feature (remote control keeps working with the app closed) — so a Claude left running keeps
|
||||
the workspace up and billed until it ends, it is ended (Project Home → Sessions flags
|
||||
detached Claude sessions, with End), Stop, or the lifetime cap. HostSection's notes say so
|
||||
(`PERSISTENT_TERMINALS_NOTE`). A detached shell does not keep it up.
|
||||
- Frontend: a persistent tab reattaches on exit (retrying while the tunnel comes back) and shows
|
||||
"[Session ended]" only when the workspace says the session is gone or the project stopped;
|
||||
`usePersistentTerminals` reopens this app's sessions once per connection (`id|container_id`)
|
||||
without taking focus; a reopened tab calls `reattach_terminal_session` only after its output
|
||||
*and* exit listeners are registered (history replay + tmux's first draw would be lost). Project
|
||||
Home → Sessions lists every session in the workspace (web terminal and other machines too:
|
||||
those are never auto-opened) with Reattach / End. `ExecSessionManager` ends an exec whose
|
||||
session id was taken over without its exit callback (else a reattach loops on its own exit).
|
||||
- The live check is `host::persistent::live_tests` (ignored; an agent image with tmux,
|
||||
`TRIPLEC_PERSIST_E2E_IMAGE`).
|
||||
`agent.rs` reuses `docker/exec.rs`'s `OneshotOutput`, host-file reader and uid probe so the two
|
||||
variants cannot drift; an `Agent` target's token never appears in `Debug` or error text.
|
||||
**Container-interior code must go through `ContainerTarget`, never `docker::exec`, bollard or
|
||||
@@ -355,9 +428,81 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
through the agent, closes the project's terminals and auth bridge (so nothing is written after the
|
||||
push's snapshot), may push first (under an in-container `timeout`, since the agent does not kill an
|
||||
exec the client gave up on), then writes `pushed` or `discard` to `/run/triple-c/stop-reason`
|
||||
(root-owned; the entrypoint's TERM hook reads it, and the idle watcher writes `idle`) so the hook
|
||||
doesn't push twice; the marker is cleared if StopTask fails. Claude Code's sandbox is forced off in
|
||||
the generated settings (bubblewrap can't create namespaces on Fargate, verified live).
|
||||
(root-owned; the entrypoint's TERM hook reads it, and the idle watcher writes `idle` or `lifetime`) so the hook
|
||||
doesn't push twice; the marker is cleared if StopTask fails. **Claude Code's sandbox is forced off
|
||||
on every AWS project, Fargate and EC2** in the generated settings (`sandbox_allowed` is false; the
|
||||
Runtime toggle is locked off, `sandboxEffective` in `awsWorkspace.ts`): bubblewrap fails on Fargate
|
||||
and under Docker's default seccomp profile on EC2 too ("No permissions to create new namespace",
|
||||
verified live), so a `sandbox_allowed` that said yes would only break every command.
|
||||
**LLM gateway sidecar** (`gateway_sidecar`, Q7): a second, `essential: false` container `gateway`
|
||||
(`docker::gateway::registry_image_ref`, digest-pinned, amd64+arm64; `memoryReservation` 512; no
|
||||
`environment`, no `dependsOn`) whose `secrets` are exactly `TRIPLEC_GATEWAY_{CONFIG,API_KEY,MASTER_KEY}`
|
||||
— the workspace container gets every key but those. The config is `sidecar_config` (Docker's
|
||||
`render_config` with `os.environ/…` key references, so it holds no key); `/bin/sh -c` writes it to a
|
||||
0600 `/tmp/litellm.yaml` and `exec`s LiteLLM on **127.0.0.1:4000** only (the image's own entrypoint
|
||||
can't write a file). The master key is **random per task start** (the Docker gateway's never leaves
|
||||
the machine); the payload overrides `ANTHROPIC_BASE_URL`/`ANTHROPIC_AUTH_TOKEN` with the sidecar's,
|
||||
and under copy-at-connect that token stays in the secret too (R1; terminals don't override it).
|
||||
Log streams: `<prefix>/gateway/<task-id>` (the tail reads `workspace` only). Needs the
|
||||
OpenAI-compatible backend, a gateway model and ≥ 1 vCPU / 2 GiB; off = the request is unchanged.
|
||||
**Cost estimate** (`pricing.rs`, Q5): `pricing:GetProducts` (us-east-1, `AmazonECS`, filters in
|
||||
`FILTERS`) → per-region x86/ARM rates cached at `<data_dir>/triple-c/aws-pricing/<region>.json` for
|
||||
24 h; `aws_cost_estimate(connection_id, region, config)` never errors — denied/offline/slow (8 s) is
|
||||
`None` ("Estimate unavailable"), a failed region isn't re-asked for 5 min, a stale cache still answers.
|
||||
EC2 projects (E10) pass `instance_type` (the user's, from `aws_ec2_capacity`): the `AmazonEC2`
|
||||
on-demand Linux/shared-tenancy hourly price (`EC2_FILTERS`), cached as `<region>--ec2-<type>.json`
|
||||
with the same rules — the instance's price, not the reservations — plus the 50 GiB gp3 root volume
|
||||
(`GP3_FILTERS`, `<region>--ebs-gp3.json`, best effort: without it the note says it's missing;
|
||||
`EC2_ROOT_VOLUME_GIB` is pinned to `ec2.tf`). A public IPv4 address ($0.005/h) is only in the note.
|
||||
**ECS on EC2 (phase 7; `aws/terraform/user-onboard/ec2.tf`, `workspace.rs` `ec2_plan`, `aws_host.rs`).**
|
||||
Opt-in per onboarding (`ec2_instance_type`); a project's `launch_type` is `Fargate | Ec2`. Why the
|
||||
rules are what they are:
|
||||
- **Per-user cluster `triple-c-<env>--u-<tag>`**, named by the principal tag `triple-c-user`
|
||||
(`user_ec2_stem` in `tofu_modules.rs`, the only place). One capacity provider per cluster,
|
||||
because `PutClusterCapacityProviders` replaces the list and two modules would undo each other on
|
||||
a shared cluster. Environment names and tags never contain `--`, so `triple-c-*--u-*` matches
|
||||
exactly the per-user clusters. **Two Denies in `workspace-user-tasks.json`** (`RunTask`/`StartTask`
|
||||
on a `--u-*` cluster other than the caller's own, and on any when the caller has **no**
|
||||
`triple-c-user` principal tag) are the whole isolation between EC2 users: don't loosen them, and
|
||||
keep the missing-tag Deny (a variable that resolves to nothing must not fall through). A denial
|
||||
maps to `EC2_TAG_MISMATCH` ("different triple-c-user value").
|
||||
- **The instance role is scoped by its own cluster tag.** `triple-c-<env>-<owner_key>-instance`
|
||||
(owner key, not user tag: role names are account-global) has only the ECS agent's calls, and the
|
||||
**boundary** allows them on `cluster/${aws:PrincipalTag/triple-c:cluster}` (must match `--u-*`).
|
||||
A Docker-access project is root on its instance and holds that role, so the tag is what stops it
|
||||
registering the instance into someone else's cluster. No SSM core and **no log rights** on the
|
||||
instance (awslogs writes with the execution role: `ECS_ENABLE_AWSLOGS_EXECUTIONROLE_OVERRIDE`).
|
||||
The task and execution roles `PutLogEvents` only into `log-stream:<owner_key>/*` of the shared
|
||||
log group, so `log_stream_prefix` must keep starting with the owner key. The boundary
|
||||
is versioned (2): an account admin re-applies it once before anyone onboards with EC2.
|
||||
- **Launch templates and groups are pinned to a numeric template version, and the admin policy
|
||||
denies `$Latest`/`$Default`**: the admin's `iam:PassRole` and `ec2:RunInstances` checks look at the
|
||||
template when it is created, and a version edited afterwards would carry any instance type or
|
||||
role (a PassRole bypass). The type list (`ec2_instance_spec` in `models/project.rs`) lives in the
|
||||
model table, the HCL variable and the policy (`ec2:InstanceType` in the compute file,
|
||||
`autoscaling:InstanceTypes` twice in the scaling file); change all together. A template-only group
|
||||
create sends no `autoscaling:InstanceTypes`, so don't add a `Null` condition on it (live-verified).
|
||||
- **Bridge networking, not awsvpc (R2):** the instance is the user's alone, awsvpc tasks on EC2 get
|
||||
no public IP, and bridge keeps IMDS out of reach with hop limit 1 (the agent on the host network
|
||||
still reaches it). The ECS agent's introspection port (172.17.0.1:51678) stays reachable;
|
||||
accepted. The gateway sidecar is refused on EC2 (no shared loopback).
|
||||
- **Cold-start rerun + orphan rule.** ECS turns ECS Exec **off** for a task that has to wait for an
|
||||
instance (the agent tunnel needs it), so the first RunTask only brings the instance up; once
|
||||
placed, the app stops it, waits for STOPPED and runs again via `find_or_run` (so a concurrent
|
||||
start never doubles a task: `START_RACE`), requiring exec on (`EXEC_OFF`). A found exec-off task
|
||||
that is still waiting for an instance is another start's (`INSTANCE_RACE`) while younger than
|
||||
`ec2_wait + ORPHAN_MARGIN`; older is an orphan, stopped (`REPLACED_REASON`) and replaced. Keep
|
||||
both launches going through `find_or_run`.
|
||||
- **Docker access = the instance's own socket**, mounted at `/var/run/docker.sock` (root on the
|
||||
user's own instance, acceptable only because nobody else's task can land there); VPN =
|
||||
`NET_ADMIN` + `/dev/net/tun` + `src_valid_mark`. A Fargate project can't keep either: switching
|
||||
to Fargate clears both flags (`launchTypePatch`, R1).
|
||||
- **Collision check before an apply** (`ec2_collision_refusal`, `prepare_onboarding`): the module
|
||||
would adopt another user's cluster of the same name, so the app refuses a name owned by someone
|
||||
else (resources' `triple-c:owner` tag, the user record `/triple-c/users/<env>/<owner_key>` as
|
||||
fallback). Admin bundles carry the same check in `README.txt`.
|
||||
- Scale to zero (min 0): the first start after ~17 min idle is cold (~3.5-4 min), warm ~20-30 s.
|
||||
Re-applying onboarding without EC2 drains and deletes the group even with an instance running.
|
||||
**Environments are OpenTofu modules** (`aws/terraform/{environment,user-onboard,permissions-boundary}`;
|
||||
spec D2–D10). `tofu_modules.rs` embeds them and is the **only** place the shared names are built
|
||||
(environment, `/triple-c/environments/<env>` record, owner key — `sha256("<region>:<aws:userid>")`,
|
||||
@@ -396,20 +541,105 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
every terminal's env and the files hold private keys). Repos clone in the background after the agent
|
||||
starts (terminals are usable before they arrive). Hybrid storage mounts EFS at `/mnt/triple-c-home`
|
||||
and symlinks `~/.claude`, `~/.claude.json`, `~/.ssh` into it (mounting over `/home/claude` would hide
|
||||
the image's tooling); root never follows those links outside the mount (`aws_hybrid_ssh_dir`). On
|
||||
TERM the hook pushes unsaved work to a `triple-c/wip/<stamp>` branch via a temporary index (the
|
||||
user's index is untouched; needs the task definition's `stopTimeout` raised, 120 s) unless the stop
|
||||
marker says the app handled it. The idle watcher runs as root under a supervisor and signals the
|
||||
the image's tooling); root never follows those links outside the mount (`aws_hybrid_ssh_dir`). EFS storage
|
||||
is Hybrid plus a second access point (root `/triple-c-workspaces/<owner_key>/<project>`, a sibling of
|
||||
the home roots) mounted straight at `/workspace`; the entrypoint links home state the same way
|
||||
(`aws_storage_links_home`) and never creates or chowns `/workspace`. Because `/workspace` then
|
||||
outlives the task, `clone_repos` clones into `/workspace/.triple-c-clone/<folder>` and renames
|
||||
into place only on success; it never deletes anything at a final path, empties scratch at each
|
||||
start, and `triple-c-wip-push` skips scratch.
|
||||
Switching EFS → Hybrid/Ephemeral keeps `workspace_access_point_id` (store-owned) until "Remove AWS
|
||||
resources" with discard deletes both access points. On
|
||||
TERM the hook pushes unsaved work to the run's `triple-c/wip/<run-id>-<folder>` branch via a
|
||||
temporary index (the user's index is untouched; needs the task definition's `stopTimeout` raised,
|
||||
120 s) unless the stop marker says the app handled it.
|
||||
**One WIP branch per task run and folder:** `aws_prepare_run` (right after the agent-token block)
|
||||
writes `/run/triple-c/run-id` (`<UTC stamp>-<task id 8 | local>`, task id from ECS task metadata)
|
||||
and `start-epoch`; `/run/triple-c` is root 0711 (the stop guard keeps that mode — at 0700 `claude`
|
||||
could not read the run id). The folder is sanitised to `[A-Za-z0-9._-]` (a name that changed gets
|
||||
`-<8 hex of sha256(raw name)>`, so `a b` and `a_b` never share a ref) and the ref checked with
|
||||
`git check-ref-format`; later pushes force (`+`) only that run's own branch, and a tree equal to
|
||||
`/run/triple-c/wip-last/<folder>` (claude-owned dir, written after a successful push) is skipped.
|
||||
No usable run id (Docker) keeps a per-push `<stamp>-<folder>`, never forced.
|
||||
**Setup script** (`TRIPLEC_SETUP_SCRIPT`, unset before the snapshot like `TRIPLEC_FILES`): written
|
||||
to `/run/triple-c-setup/script` (root 0755 dir; root opens `log` and hands the descriptor over, so
|
||||
claude writes nothing there), run as `claude`, `bash -e`, stdin `/dev/null`,
|
||||
`timeout -k 10 1800`, chained after the background clone's `done` in the same background
|
||||
subshell; `status` is `running` from the start until `ok` / `failed <code>` (a chain that dies
|
||||
early writes `failed`, so the idle stop is never blocked). `triple-c-workspace-status` (python,
|
||||
no secrets) prints `{clone:{done,repos},setup:{state,code,tail}}`. Edited in HostSection's
|
||||
"Setup script" textarea (saved on blur, blank → `null`; the 32 KiB UTF-8 limit is checked in TS
|
||||
with Rust's own message, `setupScriptProblem`).
|
||||
**The start does not wait for them** (it ends after "Connecting…": Running, lock released);
|
||||
`aws_host::spawn_follow` follows in a background task (`host/aws_host/status.rs`: background exec
|
||||
every 2 s, at most 35 min, holds no project lock; ended by `tunnels::cancel_follow` on Stop/Remove
|
||||
and by any tunnel close or app exit). Its only output is a `workspace-warning` event (warning
|
||||
toast) for a failure it saw happen or one on a task this start ran; progress shows in Project
|
||||
Home's Overview card, which polls `aws_workspace_status` every 5 s while Running and visible.
|
||||
At load, a Starting/Stopping AWS project becomes Error (not Stopped — a crash mid-start may have
|
||||
left a billed task), and `reconcile_aws_projects` also checks a Stopped one still holding a task ARN.
|
||||
**Lifetime cap** (`TRIPLEC_MAX_LIFETIME_MINUTES`, advisory — sudo can kill it): the idle watcher
|
||||
(started when idle stop *or* a non-zero cap is set) pushes best effort, records `lifetime` and
|
||||
sends TERM; the hook exits 76 (`aws::tasks::LIFETIME_EXIT_CODE` → `StopKind::LifetimeCap` →
|
||||
`lifetime` toast). HostSection shows a non-zero cap ("stops workspaces after N h (advisory)") from
|
||||
`aws_environment_max_hours` (reads the environment record; `None` when it can't, never an error).
|
||||
The idle watcher runs as root under a supervisor and signals the
|
||||
entrypoint's own PID (not PID 1, which is docker-init), so idle and ECS stops share one trap.
|
||||
Idle = the agent's `last_activity_unix` older than N minutes (open-but-silent attaches/tunnels
|
||||
don't count; requests with `X-Triple-C-Background: 1` — the auth bridge's and the file viewer's polls — never do),
|
||||
no `claude`, no scheduler job, no running clone, and no unsaved git work: with the WIP push on the
|
||||
no `claude`, no scheduler job, no running clone or setup script, and no unsaved git work: with the WIP push on the
|
||||
watcher pushes *before* signalling and stays up if that fails; with it off, dirty repos keep the
|
||||
workspace up; activity during the watcher's push sends it back to watching. A repo the background
|
||||
clone is still writing (`/run/triple-c-clone/repos` last says `cloning`, no `done`) is skipped by
|
||||
`triple-c-wip-push` (dry run: `"cloning": true`). The stop trap is set before any background work
|
||||
starts. An idle stop exits 75 (`aws::tasks::IDLE_EXIT_CODE`) so the death watch can tell it
|
||||
from a crash (`classify_stop` → the `ContainerExited` toast).
|
||||
**Copy-at-connect** (`secrets_delivery: copy_at_connect`, Q2): the secret keeps settings, repos and
|
||||
the agent token but no `TRIPLEC_FILES` and no credential pairs (`SECRET_ENV_KEYS` + every custom
|
||||
variable; `TRIPLEC_CREDENTIALS=connect` instead — the gateway sidecar's `TRIPLEC_GATEWAY_*` keys
|
||||
stay, R1). After every connect (start, attach, background re-attach) `aws_host::connect`
|
||||
uploads the files and `connect.env` (`KEY=<base64>` lines) as root into this connect's own
|
||||
`/dev/shm/triple-c/connect/<nonce>/` (root 0700 tmpfs; `--prepare` prints the nonce, so two
|
||||
connects at once never mix) and runs `triple-c-apply-connect <nonce>`: CA install as root, SSH merge and git
|
||||
credential helper **as `claude`** (root never walks a live `~/.ssh`), `/run/triple-c/connected`,
|
||||
then a background re-clone of `failed` repos only (GIT_TOKEN in that clone's env only). The
|
||||
first clone waits up to 5 min for `connected` (`aws_wait_connect`) — when there are repos **or a
|
||||
setup script** (the script runs after the clone and needs the CA, SSH and Git credentials). The
|
||||
CA files are swapped in (`connect-ca.new` → `connect-ca`, old removed last), so a failed move
|
||||
keeps the CA installed before. Terminals the app opens add
|
||||
the pairs to their own `ExecSpec.env` (`aws_host::terminal_env`, pairs only — no file read);
|
||||
nothing reaches the agent's snapshot, so cron/scheduled jobs and the setup script never get them.
|
||||
A failed push is a `workspace-warning`. Hybrid/EFS do **not** link `~/.ssh` to EFS under
|
||||
copy-at-connect (R6: keys vanish with the task). When a copy-at-connect start finds the secret
|
||||
already there (CreateSecret's ResourceExists; a new project's secret is never read first) and it
|
||||
`holds_credentials`, it is force-deleted and created again (R7: `PutSecretValue` would keep the
|
||||
old values as AWSPREVIOUS); `TRIPLE_C_CUSTOM_ENV` is left out too. A replace whose re-create
|
||||
times out (AWS still finishing the forced delete) leaves no secret; every secret write retries
|
||||
while the name is pending deletion (≤ 30 s), then says to start again in a minute.
|
||||
**Copy-at-connect limits** (also listed in HostSection's notes): there is no corporate CA until
|
||||
the first connect (Claude Code's self-update may fail behind a TLS-inspecting proxy until then);
|
||||
SSH keys, a Git token or variables removed from the project stay in the running task until it
|
||||
stops (a connect only adds/overwrites them; a removed CA does go at the next connect); the setup script is not re-run
|
||||
after a later connect's re-clone of a failed repo.
|
||||
The re-clone closes the apply lock's fd (a later connect never waits for it); `--prepare` takes it.
|
||||
The functions both scripts use live in `container/entrypoint-lib.sh`
|
||||
(`/usr/local/lib/triple-c/`), sourced by the entrypoint first; it only defines things.
|
||||
**Persistent terminals** (`host/persistent.rs`): the image has `tmux` (in the Python apt layer)
|
||||
and `/etc/triple-c/tmux.conf` (`container/triple-c-tmux.conf`, outside the seed-only home): no
|
||||
prefix key (Ctrl+B reaches Claude/readline), no status line, `escape-time 0` (ESC+CR stays one
|
||||
Meta-Enter), no mouse, `window-size latest`, and three outer-terminal overrides that were each
|
||||
**measured by feeding tmux's real output into xterm.js** — keep all three: `smcup@:rmcup@`
|
||||
(draw in xterm.js's normal screen, so its scrollback, copy cleanup and link detection work),
|
||||
`indn@` (tmux's CSI S scroll is a *delete* in xterm.js: 4 of 300 fast lines reached scrollback
|
||||
with it, 300 without) and `clear=\E[H` (tmux sends `clear` when its client exits, which wiped
|
||||
the session's last screen from the tab; its full redraws repaint every row anyway). The idle
|
||||
watcher still sees `claude` inside tmux (`pgrep -x claude`; tmux's processes are `tmux:
|
||||
server`/`tmux: client`), so a running Claude keeps the workspace up and a detached shell does
|
||||
not; the lifetime cap still applies.
|
||||
**The Docker-socket group step** (`# >>> docker_socket`) runs in aws mode as well as Docker mode: an
|
||||
EC2 project with Docker access mounts the instance's `/var/run/docker.sock`, and the step adds
|
||||
`claude` to a group with the socket's gid (`docker-host` if none exists). Fargate never has the
|
||||
socket, so it is inert there.
|
||||
**The `TRIPLEC_` env prefix is reserved** on both hosts (`RESERVED_ENV_PREFIXES`; `workspace.rs`
|
||||
drops custom variables in it): the entrypoint's settings live there.
|
||||
- **Browser runtime libraries are baked in; browser *binaries* are not.** A layer runs
|
||||
@@ -431,7 +661,7 @@ docker exec stdout → tokio task → emit("terminal-output-{sessionId}") → li
|
||||
approach converges on the worst state: a 400 MB browser present with its libraries gone.
|
||||
- The layer sits immediately after Node (npx is its only prerequisite) and well above the shim
|
||||
`COPY`s, so editing a shim does not re-run a multi-hundred-megabyte apt install.
|
||||
- **`entrypoint.sh`** — UID/GID remapping to match host user, SSH key setup (`sync_host_ssh` *merges* the host dir into `~/.ssh`; never wipe it — container-made keys live there on the home volume), git config, docker socket permissions, Claude Code settings.json injection, then stays resident **as root** waiting on a root-owned
|
||||
- **`entrypoint.sh`** (+ `entrypoint-lib.sh`, the CA/SSH/git-credential/clone functions it sources) — UID/GID remapping to match host user, SSH key setup (`sync_host_ssh` *merges* the host dir into `~/.ssh`; never wipe it — container-made keys live there on the home volume), git config, docker socket permissions, Claude Code settings.json injection, then stays resident **as root** waiting on a root-owned
|
||||
`triple-c-keepalive` sleep (respawned if killed; SIGTERM trap so `docker stop` is immediate).
|
||||
**Never hand the container's lifetime to a process the `claude` user owns** — it used to end in
|
||||
`exec su … claude -c "exec sleep infinity"`, and any `pkill sleep` / `kill -9 -1` a Claude
|
||||
@@ -602,7 +832,10 @@ friendly message one line before `exec claude` ran it. `-E 0` makes losing the r
|
||||
because the holder just did the work. The per-session copy is what forced the non-Bedrock path from a bare `["claude", ...]`
|
||||
argv into a `bash -c` wrapper — the flags and the session name are interpolated into a shell
|
||||
string now, so **anything added there must go through `shell_quote_arg`**. Bash sessions are
|
||||
deliberately untouched.
|
||||
deliberately untouched. On AWS that whole command (not a copy of it) becomes the argv of a tmux
|
||||
`new-session` (`host::persistent::new_session_cmd`), so it runs once per session, never on a
|
||||
reattach; tmux reads an argument that *ends* in `;` as a command separator, so the scripts keep
|
||||
ending in a newline (`new_session_cmd` refuses otherwise).
|
||||
|
||||
### Container Lifecycle
|
||||
|
||||
@@ -1069,10 +1302,77 @@ verbatim copy yields a launcher entry that starts nothing. It keeps `StartupWMCl
|
||||
the bundle sets it, which is what lets the shell match the window to the entry. Extraction uses
|
||||
`--appimage-extract`, which needs no FUSE, so the script works before `fuse2` is installed.
|
||||
|
||||
### The bundled AWS Session Manager plugin
|
||||
|
||||
AWS workspaces connect through AWS's `session-manager-plugin` (`host/ssm.rs`), and the app
|
||||
**bundles it as a Tauri sidecar** (`bundle.externalBin: binaries/session-manager-plugin`) so users
|
||||
need not install it. Tauri copies it beside the app binary with the `-<target-triple>` suffix
|
||||
stripped — `usr/bin/session-manager-plugin` in the AppImage, `Contents/MacOS/` on macOS, the
|
||||
install directory on Windows (`session-manager-plugin.exe`), and `target/<profile>/` under
|
||||
`tauri dev`. `find_plugin()` resolves `TRIPLEC_SSM_PLUGIN` → **that sidecar (beside
|
||||
`current_exe()`)** → `PATH` → AWS's install locations → the install hint; the order is
|
||||
unit-tested (`host/ssm/tests.rs`, `plugin_resolution`).
|
||||
|
||||
- **We build it from source; we never ship AWS's binaries.** AWS distributes its prebuilt plugin
|
||||
as "AWS Content" under the AWS Customer Agreement; the source (github.com/aws/session-manager-plugin)
|
||||
is Apache-2.0. `scripts/build-ssm-plugin.sh <triple>…` (Linux/macOS; any triple, it
|
||||
cross-compiles) and `scripts/build-ssm-plugin.ps1` (the Windows runner, which has no bash) take
|
||||
the tag's **commit** as GitHub's archive (pinned SHA-256, checked before extraction; the
|
||||
vendored SDK's Java `codegen/` and test `snapshot/` trees are not extracted — they reach 258
|
||||
characters, past Windows' MAX_PATH, so the `.ps1` also works under a short `C:\ssm-<8hex>` root)
|
||||
and a
|
||||
**pinned Go** from go.dev (go.dev's published SHA-256), and run the repo's own build — GOPATH
|
||||
mode over its vendored deps, `-ldflags "-s -w"`, `sessionmanagerplugin-main` — with `VERSION`
|
||||
stamped to the tag (the repo's file says `1.3.0.0`; AWS's pipeline stamps the real one, so
|
||||
`--version` would otherwise lie), plus `-trimpath`, no VCS stamp, empty build id, `CGO_ENABLED=0`
|
||||
and a scrubbed Go environment. **The output must equal a pinned SHA-256 per target**: Go builds
|
||||
are reproducible across hosts, so every runner must produce the exact bytes recorded in the
|
||||
scripts (verified locally: Linux-hosted builds of every target, repeated in fresh directories,
|
||||
and the `.ps1` flow, are identical). A mismatch fails the build and means the source, toolchain
|
||||
or flags changed — never "update the hash" without knowing which.
|
||||
- **Each platform job builds its own targets** before `tauri build` (Linux: `x86_64-unknown-linux-gnu`;
|
||||
macOS: `universal-apple-darwin`, i.e. both thin slices — tauri-build checks the arch it compiles —
|
||||
plus the `lipo`'d universal file the bundler wants, whose slices must thin back out byte-identical
|
||||
to the pins; Windows: the `.ps1`). Not one Linux job feeding the others: workflow artifacts do
|
||||
not work on this Gitea (see `build-app-preview.yml`'s header), and with reproducible output and
|
||||
pinned hashes nothing is gained by building once.
|
||||
- **Bumping** the plugin or Go: new pins in **both** scripts, rebuild every target, record the new
|
||||
output hashes, and update `app/src-tauri/THIRD_PARTY_NOTICES` (the scripts refuse to run unless
|
||||
its `Version:`/`Commit:` lines match) including its dependency licences.
|
||||
- **Debug builds get a placeholder; release builds refuse one.** tauri-build fails *any* build
|
||||
whose externalBin file is missing, `cargo test` included. `build.rs` (`ensure_ssm_sidecar`)
|
||||
writes a marked placeholder (`src/sidecar_placeholder.rs`) for a missing file when
|
||||
`PROFILE=debug`, so `cargo test`/`cargo check`/`tauri dev` and CI's `test` job need neither Go
|
||||
nor the network, and `find_plugin()` skips it (falling back to an installed plugin). With
|
||||
`PROFILE=release` a missing file **or** a placeholder stops the build, so a local `cargo build
|
||||
--release` needs the build script first. **build.rs rejects only a missing file or the
|
||||
placeholder, not a stale or wrong binary**: re-run `scripts/build-ssm-plugin.sh` before every
|
||||
local release build (it is a no-op when the file already matches the pin, and rebuilds it
|
||||
otherwise — e.g. after a pin bump, or after a Windows release build signed it in place). `finalize-appimage.sh` asserts the shipped
|
||||
`usr/bin/session-manager-plugin` is an ELF that runs `--version`.
|
||||
- **Windows: our build is unsigned, so the release signs it with our certificate.** Tauri runs
|
||||
`signtool verify /pa` on each sidecar and hands the unsigned one to the sign command, in place
|
||||
under `app\src-tauri\binaries` before any bundle (both MSI and NSIS pack that file);
|
||||
`windows-sign.ps1`'s allowlist includes it (one more metered signature per release: 6).
|
||||
`windows-verify-signatures.ps1` requires exactly one `session-manager-plugin.exe` in the MSI and
|
||||
the file NSIS packed to be validly signed, timestamped, **by the same signing identity
|
||||
(subject + issuer) as the installer** — not the thumbprint: Artifact Signing certificates are
|
||||
short-lived and rotate — and the signing log to show it. The MSI must also carry
|
||||
`THIRD_PARTY_NOTICES`; on macOS a workflow step checks the `.app` holds the two-slice plugin in
|
||||
`Contents/MacOS` and the notices in `Contents/Resources`. Previews ship it unsigned, like the app.
|
||||
- **macOS: signed exactly like the app.** The app is not code-signed (no `APPLE_*`/`signingIdentity`
|
||||
in the workflows); Go's linker ad-hoc signs the arm64 slice (needed to run on Apple Silicon). If
|
||||
signing is ever configured, Tauri signs externalBin with the app's identity, inside-out.
|
||||
- **Licence:** `app/src-tauri/THIRD_PARTY_NOTICES` (bundled as a resource; `usr/lib/Triple-C/` in
|
||||
the AppImage, asserted by `finalize-appimage.sh`) carries the plugin's Apache-2.0 LICENSE and
|
||||
NOTICE, the commit we build, the repo's own `THIRD-PARTY` file verbatim, the licence of every
|
||||
vendored module linked in (`go list -deps` for linux/darwin/windows) and Go's own. Note that the
|
||||
repo's `THIRD-PARTY` file opens with the same "AWS Content" sentence as the binary packages.
|
||||
|
||||
### Windows code signing
|
||||
|
||||
Windows **releases** (`build-app.yml`) are signed with **Azure Artifact Signing**: the app binary,
|
||||
the MSI, the NSIS installer and its uninstaller. Three scripts do it, and "Verify signatures"
|
||||
the bundled `session-manager-plugin`, the MSI, the NSIS installer and its uninstaller. Three scripts do it, and "Verify signatures"
|
||||
fails the job if any of them is unsigned or untimestamped, so an unsigned installer cannot ship
|
||||
quietly. **PR previews are deliberately not signed**, and `build-app-preview.yml` must not
|
||||
reference the signing secrets. Two reasons: signing is metered (about 1000 signatures a month,
|
||||
@@ -1090,12 +1390,13 @@ without releasing (see Releases above).
|
||||
- `scripts/windows-sign.ps1` is the sign command: `signtool sign /dlib` with SHA-256 and the
|
||||
Microsoft timestamp server, retried. Credentials never reach a command line — the dlib reads
|
||||
`AZURE_TENANT_ID` / `AZURE_CLIENT_ID` / `AZURE_CLIENT_SECRET` from the environment.
|
||||
**It signs only an allowlist of what ships**: 5 signatures per release (the app binary twice,
|
||||
**It signs only an allowlist of what ships**: 6 signatures per release (the app binary twice,
|
||||
because Tauri re-patches it between the MSI and NSIS bundles; the MSI; the NSIS installer;
|
||||
and its uninstaller). Tauri also presents build-time tools, the WiX extension DLLs and NSIS
|
||||
its uninstaller; and the `session-manager-plugin` sidecar we build from source). Tauri also presents build-time tools, the WiX extension DLLs and NSIS
|
||||
plugins, and signing those would more than double the metered count for no user-visible
|
||||
benefit. If the app ever ships resource DLLs or sidecars, extend the
|
||||
allowlist, or they will go out unsigned. Tauri reports a failed sign command only as
|
||||
allowlist, or they will go out unsigned (as `session-manager-plugin`'s entry does; see the
|
||||
section above). Tauri reports a failed sign command only as
|
||||
"failed to run powershell", so the script keeps a transcript (`.code-signing/sign-output.log`,
|
||||
`signtool /debug` included), and the job prints it on failure.
|
||||
- `scripts/windows-verify-signatures.ps1` checks `signtool verify /pa` plus a timestamp on the
|
||||
|
||||
Generated
+53
@@ -367,6 +367,32 @@ dependencies = [
|
||||
"uuid",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "aws-sdk-autoscaling"
|
||||
version = "1.144.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a08cb197f98dad7b1a3d4e7fcc94fbc13a66c2ea5465ba57fdb5dd00f865d6e8"
|
||||
dependencies = [
|
||||
"arc-swap",
|
||||
"aws-credential-types",
|
||||
"aws-runtime",
|
||||
"aws-smithy-async",
|
||||
"aws-smithy-http",
|
||||
"aws-smithy-json",
|
||||
"aws-smithy-observability",
|
||||
"aws-smithy-query",
|
||||
"aws-smithy-runtime",
|
||||
"aws-smithy-runtime-api",
|
||||
"aws-smithy-schema",
|
||||
"aws-smithy-types",
|
||||
"aws-smithy-xml",
|
||||
"aws-types",
|
||||
"fastrand",
|
||||
"http",
|
||||
"regex-lite",
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "aws-sdk-cloudwatchlogs"
|
||||
version = "1.165.0"
|
||||
@@ -488,6 +514,31 @@ dependencies = [
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "aws-sdk-pricing"
|
||||
version = "1.125.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4bb09af014cbcee1ad1753d54d70c4afd7565dfd7ca4d84d8b702292462fe80f"
|
||||
dependencies = [
|
||||
"arc-swap",
|
||||
"aws-credential-types",
|
||||
"aws-runtime",
|
||||
"aws-smithy-async",
|
||||
"aws-smithy-http",
|
||||
"aws-smithy-json",
|
||||
"aws-smithy-observability",
|
||||
"aws-smithy-runtime",
|
||||
"aws-smithy-runtime-api",
|
||||
"aws-smithy-schema",
|
||||
"aws-smithy-types",
|
||||
"aws-types",
|
||||
"bytes",
|
||||
"fastrand",
|
||||
"http",
|
||||
"regex-lite",
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "aws-sdk-s3"
|
||||
version = "1.159.0"
|
||||
@@ -7441,11 +7492,13 @@ dependencies = [
|
||||
"aws-config",
|
||||
"aws-credential-types",
|
||||
"aws-runtime",
|
||||
"aws-sdk-autoscaling",
|
||||
"aws-sdk-cloudwatchlogs",
|
||||
"aws-sdk-ecs",
|
||||
"aws-sdk-efs",
|
||||
"aws-sdk-iam",
|
||||
"aws-sdk-kms",
|
||||
"aws-sdk-pricing",
|
||||
"aws-sdk-s3",
|
||||
"aws-sdk-secretsmanager",
|
||||
"aws-sdk-ssm",
|
||||
|
||||
@@ -70,6 +70,8 @@ aws-sdk-iam = { version = "1.136.0", default-features = false, features = ["defa
|
||||
aws-sdk-secretsmanager = { version = "1.128.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
aws-sdk-efs = { version = "1.125.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
aws-sdk-cloudwatchlogs = { version = "1.165.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
# aws/pricing.rs: the Fargate rates behind the hourly cost estimate (Q5).
|
||||
aws-sdk-pricing = { version = "1.125.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
# Named by src/aws/connection.rs: the credentials-provider trait (its profile
|
||||
# wrapper) and the profile-file set (aws-config's alias for it is deprecated).
|
||||
# Both are the versions aws-config already resolves.
|
||||
@@ -78,6 +80,9 @@ aws-runtime = { version = "1.10.4", default-features = false }
|
||||
# The default sleep and time source for the hand-built SdkConfig (no env/profile
|
||||
# loading); the version and feature already in the tree.
|
||||
aws-smithy-async = { version = "1.3.1", default-features = false, features = ["rt-tokio"] }
|
||||
# commands/environment_commands.rs: the pre-apply check that a user's EC2 names
|
||||
# (Auto Scaling group) are not another onboarding's (phase 7, R3).
|
||||
aws-sdk-autoscaling = { version = "1.144.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
aws-sdk-s3 = { version = "1.159.0", default-features = false, features = ["default-https-client", "rt-tokio", "behavior-version-latest"] }
|
||||
|
||||
# aws/tofu.rs: `setsid` puts the detached OpenTofu runner in its own session,
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -14,6 +14,8 @@
|
||||
|
||||
#[path = "src/command_census.rs"]
|
||||
mod command_census;
|
||||
#[path = "src/sidecar_placeholder.rs"]
|
||||
mod sidecar_placeholder;
|
||||
|
||||
use std::path::Path;
|
||||
|
||||
@@ -79,6 +81,7 @@ fn main() {
|
||||
}
|
||||
|
||||
prune_permissions(&commands);
|
||||
ensure_ssm_sidecar();
|
||||
|
||||
// `AppManifest::commands` takes `&'static [&'static str]` and the struct is `Copy`, so
|
||||
// there is no owned form; leaking is fine in a process that exits right after.
|
||||
@@ -206,3 +209,50 @@ fn check_tauri_config() {
|
||||
fail("capabilities declared outside capabilities/", &problems, LAYOUT_HINT);
|
||||
}
|
||||
}
|
||||
|
||||
/// `bundle.externalBin` names `binaries/session-manager-plugin`, and tauri-build stops on a
|
||||
/// missing `binaries/session-manager-plugin-<target-triple>[.exe]` for every build, tests
|
||||
/// included. The real one is built from AWS's source by `scripts/build-ssm-plugin.sh` (`.ps1` on
|
||||
/// Windows), which CI runs before `tauri build`.
|
||||
///
|
||||
/// - **Release profile:** the real plugin is required. A missing file or a placeholder stops
|
||||
/// the build here, so a placeholder can never ship.
|
||||
/// - **Debug profile** (`cargo test`, `cargo check`, `tauri dev`): a missing file is replaced
|
||||
/// by a placeholder (`src/sidecar_placeholder.rs`) so no test run needs Go or the network. The app's
|
||||
/// `find_plugin` skips a placeholder and falls back to an installed plugin.
|
||||
fn ensure_ssm_sidecar() {
|
||||
let target = std::env::var("TARGET").expect("cargo sets TARGET");
|
||||
let ext = if target.contains("windows") { ".exe" } else { "" };
|
||||
let path = Path::new("binaries").join(format!("session-manager-plugin-{target}{ext}"));
|
||||
println!("cargo:rerun-if-changed={}", path.display());
|
||||
let release = std::env::var("PROFILE").as_deref() == Ok("release");
|
||||
let head = std::fs::read(&path).ok().map(|b| sidecar_placeholder::is_placeholder(&b));
|
||||
let build = if target.contains("windows") {
|
||||
"scripts\\build-ssm-plugin.ps1"
|
||||
} else {
|
||||
"scripts/build-ssm-plugin.sh"
|
||||
};
|
||||
match (head, release) {
|
||||
(Some(false), _) => {}
|
||||
(state, true) => fail(
|
||||
"the AWS Session Manager plugin sidecar is missing",
|
||||
&[format!(
|
||||
"{} is {} (release builds bundle the real plugin)",
|
||||
path.display(),
|
||||
if state.is_some() { "a debug-build placeholder" } else { "missing" }
|
||||
)],
|
||||
&format!("Run {build} {target} from the repository root first."),
|
||||
),
|
||||
(None, false) => {
|
||||
std::fs::create_dir_all("binaries").expect("create src-tauri/binaries");
|
||||
std::fs::write(&path, sidecar_placeholder::contents())
|
||||
.unwrap_or_else(|e| panic!("cannot write {}: {e}", path.display()));
|
||||
println!(
|
||||
"cargo:warning=no {} - wrote a placeholder (debug only; AWS workspaces use an \
|
||||
installed plugin). Run {build} to build the real one.",
|
||||
path.display()
|
||||
);
|
||||
}
|
||||
(Some(true), false) => {}
|
||||
}
|
||||
}
|
||||
@@ -9,6 +9,7 @@
|
||||
"dialog:allow-open",
|
||||
"dialog:allow-save",
|
||||
"allow-check-docker",
|
||||
"allow-check-docker-status",
|
||||
"allow-check-image-exists",
|
||||
"allow-build-image",
|
||||
"allow-get-container-info",
|
||||
@@ -20,6 +21,10 @@
|
||||
"allow-stop-project-container",
|
||||
"allow-check-unsaved-work",
|
||||
"allow-aws-task-log",
|
||||
"allow-aws-workspace-status",
|
||||
"allow-aws-environment-max-hours",
|
||||
"allow-aws-ec2-capacity",
|
||||
"allow-ec2-fit-problem",
|
||||
"allow-remove-aws-resources",
|
||||
"allow-rebuild-project-container",
|
||||
"allow-reconcile-project-statuses",
|
||||
@@ -69,6 +74,7 @@
|
||||
"allow-aws-connection-sso-login",
|
||||
"allow-check-aws-permissions",
|
||||
"allow-aws-policy-document",
|
||||
"allow-aws-cost-estimate",
|
||||
"allow-detect-aws-environments",
|
||||
"allow-deploy-aws-environment",
|
||||
"allow-update-aws-environment",
|
||||
@@ -79,6 +85,7 @@
|
||||
"allow-cancel-aws-deployment",
|
||||
"allow-push-aws-saved-state",
|
||||
"allow-onboard-aws-user",
|
||||
"allow-list-ec2-instance-types",
|
||||
"allow-deploy-aws-permissions-boundary",
|
||||
"allow-save-aws-admin-bundle",
|
||||
"allow-detect-host-timezone",
|
||||
@@ -89,6 +96,9 @@
|
||||
"allow-terminal-input",
|
||||
"allow-terminal-resize",
|
||||
"allow-close-terminal-session",
|
||||
"allow-list-workspace-terminals",
|
||||
"allow-reattach-terminal-session",
|
||||
"allow-end-workspace-terminal",
|
||||
"allow-paste-image-to-terminal",
|
||||
"allow-upload-host-file-to-terminal",
|
||||
"allow-start-audio-bridge",
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"__app-acl__":{"default_permission":null,"permissions":{"allow-acquire-claude-token":{"identifier":"allow-acquire-claude-token","description":"Enables the acquire_claude_token command without any pre-configured scope.","commands":{"allow":["acquire_claude_token"],"deny":[]}},"allow-add-aws-keys-connection":{"identifier":"allow-add-aws-keys-connection","description":"Enables the add_aws_keys_connection command without any pre-configured scope.","commands":{"allow":["add_aws_keys_connection"],"deny":[]}},"allow-add-aws-profile-connection":{"identifier":"allow-add-aws-profile-connection","description":"Enables the add_aws_profile_connection command without any pre-configured scope.","commands":{"allow":["add_aws_profile_connection"],"deny":[]}},"allow-add-marketplace":{"identifier":"allow-add-marketplace","description":"Enables the add_marketplace command without any pre-configured scope.","commands":{"allow":["add_marketplace"],"deny":[]}},"allow-add-marketplace-gh-host-account":{"identifier":"allow-add-marketplace-gh-host-account","description":"Enables the add_marketplace_gh_host_account command without any pre-configured scope.","commands":{"allow":["add_marketplace_gh_host_account"],"deny":[]}},"allow-add-marketplace-token-account":{"identifier":"allow-add-marketplace-token-account","description":"Enables the add_marketplace_token_account command without any pre-configured scope.","commands":{"allow":["add_marketplace_token_account"],"deny":[]}},"allow-add-project":{"identifier":"allow-add-project","description":"Enables the add_project command without any pre-configured scope.","commands":{"allow":["add_project"],"deny":[]}},"allow-add-scheduled-task":{"identifier":"allow-add-scheduled-task","description":"Enables the add_scheduled_task command without any pre-configured scope.","commands":{"allow":["add_scheduled_task"],"deny":[]}},"allow-apply-marketplace-now":{"identifier":"allow-apply-marketplace-now","description":"Enables the apply_marketplace_now command without any pre-configured scope.","commands":{"allow":["apply_marketplace_now"],"deny":[]}},"allow-apply-settings-import":{"identifier":"allow-apply-settings-import","description":"Enables the apply_settings_import command without any pre-configured scope.","commands":{"allow":["apply_settings_import"],"deny":[]}},"allow-aws-connection-identity":{"identifier":"allow-aws-connection-identity","description":"Enables the aws_connection_identity command without any pre-configured scope.","commands":{"allow":["aws_connection_identity"],"deny":[]}},"allow-aws-connection-sso-login":{"identifier":"allow-aws-connection-sso-login","description":"Enables the aws_connection_sso_login command without any pre-configured scope.","commands":{"allow":["aws_connection_sso_login"],"deny":[]}},"allow-aws-policy-document":{"identifier":"allow-aws-policy-document","description":"Enables the aws_policy_document command without any pre-configured scope.","commands":{"allow":["aws_policy_document"],"deny":[]}},"allow-aws-sso-refresh":{"identifier":"allow-aws-sso-refresh","description":"Enables the aws_sso_refresh command without any pre-configured scope.","commands":{"allow":["aws_sso_refresh"],"deny":[]}},"allow-aws-task-log":{"identifier":"allow-aws-task-log","description":"Enables the aws_task_log command without any pre-configured scope.","commands":{"allow":["aws_task_log"],"deny":[]}},"allow-build-gateway-image":{"identifier":"allow-build-gateway-image","description":"Enables the build_gateway_image command without any pre-configured scope.","commands":{"allow":["build_gateway_image"],"deny":[]}},"allow-build-image":{"identifier":"allow-build-image","description":"Enables the build_image command without any pre-configured scope.","commands":{"allow":["build_image"],"deny":[]}},"allow-build-stt-image":{"identifier":"allow-build-stt-image","description":"Enables the build_stt_image command without any pre-configured scope.","commands":{"allow":["build_stt_image"],"deny":[]}},"allow-cancel-aws-deployment":{"identifier":"allow-cancel-aws-deployment","description":"Enables the cancel_aws_deployment command without any pre-configured scope.","commands":{"allow":["cancel_aws_deployment"],"deny":[]}},"allow-cancel-claude-token":{"identifier":"allow-cancel-claude-token","description":"Enables the cancel_claude_token command without any pre-configured scope.","commands":{"allow":["cancel_claude_token"],"deny":[]}},"allow-cancel-marketplace-gh-login":{"identifier":"allow-cancel-marketplace-gh-login","description":"Enables the cancel_marketplace_gh_login command without any pre-configured scope.","commands":{"allow":["cancel_marketplace_gh_login"],"deny":[]}},"allow-check-aws-permissions":{"identifier":"allow-check-aws-permissions","description":"Enables the check_aws_permissions command without any pre-configured scope.","commands":{"allow":["check_aws_permissions"],"deny":[]}},"allow-check-browser-view-support":{"identifier":"allow-check-browser-view-support","description":Line truncated
|
||||
{"__app-acl__":{"default_permission":null,"permissions":{"allow-acquire-claude-token":{"identifier":"allow-acquire-claude-token","description":"Enables the acquire_claude_token command without any pre-configured scope.","commands":{"allow":["acquire_claude_token"],"deny":[]}},"allow-add-aws-keys-connection":{"identifier":"allow-add-aws-keys-connection","description":"Enables the add_aws_keys_connection command without any pre-configured scope.","commands":{"allow":["add_aws_keys_connection"],"deny":[]}},"allow-add-aws-profile-connection":{"identifier":"allow-add-aws-profile-connection","description":"Enables the add_aws_profile_connection command without any pre-configured scope.","commands":{"allow":["add_aws_profile_connection"],"deny":[]}},"allow-add-marketplace":{"identifier":"allow-add-marketplace","description":"Enables the add_marketplace command without any pre-configured scope.","commands":{"allow":["add_marketplace"],"deny":[]}},"allow-add-marketplace-gh-host-account":{"identifier":"allow-add-marketplace-gh-host-account","description":"Enables the add_marketplace_gh_host_account command without any pre-configured scope.","commands":{"allow":["add_marketplace_gh_host_account"],"deny":[]}},"allow-add-marketplace-token-account":{"identifier":"allow-add-marketplace-token-account","description":"Enables the add_marketplace_token_account command without any pre-configured scope.","commands":{"allow":["add_marketplace_token_account"],"deny":[]}},"allow-add-project":{"identifier":"allow-add-project","description":"Enables the add_project command without any pre-configured scope.","commands":{"allow":["add_project"],"deny":[]}},"allow-add-scheduled-task":{"identifier":"allow-add-scheduled-task","description":"Enables the add_scheduled_task command without any pre-configured scope.","commands":{"allow":["add_scheduled_task"],"deny":[]}},"allow-apply-marketplace-now":{"identifier":"allow-apply-marketplace-now","description":"Enables the apply_marketplace_now command without any pre-configured scope.","commands":{"allow":["apply_marketplace_now"],"deny":[]}},"allow-apply-settings-import":{"identifier":"allow-apply-settings-import","description":"Enables the apply_settings_import command without any pre-configured scope.","commands":{"allow":["apply_settings_import"],"deny":[]}},"allow-aws-connection-identity":{"identifier":"allow-aws-connection-identity","description":"Enables the aws_connection_identity command without any pre-configured scope.","commands":{"allow":["aws_connection_identity"],"deny":[]}},"allow-aws-connection-sso-login":{"identifier":"allow-aws-connection-sso-login","description":"Enables the aws_connection_sso_login command without any pre-configured scope.","commands":{"allow":["aws_connection_sso_login"],"deny":[]}},"allow-aws-cost-estimate":{"identifier":"allow-aws-cost-estimate","description":"Enables the aws_cost_estimate command without any pre-configured scope.","commands":{"allow":["aws_cost_estimate"],"deny":[]}},"allow-aws-ec2-capacity":{"identifier":"allow-aws-ec2-capacity","description":"Enables the aws_ec2_capacity command without any pre-configured scope.","commands":{"allow":["aws_ec2_capacity"],"deny":[]}},"allow-aws-environment-max-hours":{"identifier":"allow-aws-environment-max-hours","description":"Enables the aws_environment_max_hours command without any pre-configured scope.","commands":{"allow":["aws_environment_max_hours"],"deny":[]}},"allow-aws-policy-document":{"identifier":"allow-aws-policy-document","description":"Enables the aws_policy_document command without any pre-configured scope.","commands":{"allow":["aws_policy_document"],"deny":[]}},"allow-aws-sso-refresh":{"identifier":"allow-aws-sso-refresh","description":"Enables the aws_sso_refresh command without any pre-configured scope.","commands":{"allow":["aws_sso_refresh"],"deny":[]}},"allow-aws-task-log":{"identifier":"allow-aws-task-log","description":"Enables the aws_task_log command without any pre-configured scope.","commands":{"allow":["aws_task_log"],"deny":[]}},"allow-aws-workspace-status":{"identifier":"allow-aws-workspace-status","description":"Enables the aws_workspace_status command without any pre-configured scope.","commands":{"allow":["aws_workspace_status"],"deny":[]}},"allow-build-gateway-image":{"identifier":"allow-build-gateway-image","description":"Enables the build_gateway_image command without any pre-configured scope.","commands":{"allow":["build_gateway_image"],"deny":[]}},"allow-build-image":{"identifier":"allow-build-image","description":"Enables the build_image command without any pre-configured scope.","commands":{"allow":["build_image"],"deny":[]}},"allow-build-stt-image":{"identifier":"allow-build-stt-image","description":"Enables the build_stt_image command without any pre-configured scope.","commands":{"allow":["build_stt_image"],"deny":[]}},"allow-cancel-aws-deployment":{"identifier":"allow-cancel-aws-deployment","description":"Enables the cancel_aws_deployment command withoutLine truncated
|
||||
@@ -1 +1 @@
|
||||
{"default":{"identifier":"default","description":"Default capabilities for Triple-C. Every entry here is an IPC command a compromised webview can call directly, so the set is an enumeration of what `app/src` actually invokes — plugin and core grants verified against tauri 2.11.0's `PLUGINS` table in tauri's own `build.rs` rather than assumed from a plugin's `default` set, app-command grants (the bare `allow-*` entries) cross-checked by this crate's `build.rs` against `generate_handler!`. `core:default` in particular is NOT used: it is an alias for `core:{path,event,window,webview,app,image,resources,menu,tray}:default`, and `core:image:default` carries `allow-from-path`, whose handler (`tauri-2.11.0/src/image/plugin.rs:41` → `src/image/mod.rs:96`) is a bare `std::fs::read(path)` with no scope mechanism of any kind. Nothing imports `@tauri-apps/api/image`, so the whole plugin is dropped rather than scoped — there is nothing to scope it with. `core:menu` and `core:tray` are dropped for the same reason (no menu, no tray icon); `core:window` and `core:path` because nothing imports them; `core:resources:allow-close` because no frontend value is a `Resource`; and `core:event`'s `allow-emit`/`allow-emit-to` because the frontend only ever *listens* — every emit in this app originates in Rust. Three notes on what is deliberately kept or accepted: (1) `core:webview:allow-internal-toggle-devtools` is not called by `app/src` at all — it is called by Tauri's own injected `toggle-devtools.js`, which binds Ctrl/Cmd+Shift+I. Both that script and the command behind it are `#[cfg(any(debug_assertions, feature = \"devtools\"))]`, so this grant is a `tauri dev` convenience that does not exist in a release bundle. (2) `opener:allow-open-url` is **gone**. It could not be narrowed by host — `TerminalView`'s `WebLinksAddon` opens links Claude printed inside the container, which are arbitrary by construction, so a host allowlist would have deleted the feature rather than bounded it — and it was carried here as an accepted residual risk: a compromised webview could make the OS open an attacker-chosen http(s) URL, an outbound channel. That risk is now closed rather than recorded. Every host-browser open in the app goes through the `open_url_external` command in `url_open.rs`, which exists because the AppImage environment leaks into a cold-launched browser on Linux (triple-c#34) and which re-validates the URL in Rust — scheme allowlist, no embedded credentials, no control characters, length cap, ASCII asserted before `execvp`. On macOS and Windows that command reaches the same plugin as before, via `OpenerExt::open_url`, whose desktop implementation calls `crate::open::open` directly and is therefore not gated by this file at all (`tauri-plugin-opener-2.5.3/src/lib.rs:60`). The plugin stays a dependency for exactly that reason; what is removed is the webview's ability to reach it without passing the Rust validation. (3) `drag:allow-start-drag` is **gone**, together with the OS drag-out it existed for. It could not be scoped — `tauri-plugin-drag` takes the item paths from the caller and has no scope mechanism, so a compromised webview could call `startDrag({ item: ['~/.ssh/id_rsa'] })` against any host path the user can read — and it was carried as an accepted residual risk for one gesture. Drag-out was held back for separate hardening (see branch `hold/disk-and-dragout`) and the plugin is no longer a dependency. Getting a file *out* of a container is either \"Back up container\" on the project's Overview tab, which archives a tree through the Docker API, or the Files tab's per-row \"Save to host…\", which copies one file; getting one *in* is a drop on the Terminal or the Files tab's \"Upload…\". None of the four touches this permission. The Files tab's two are worth separating out here, because they are the only host-path commands in the app whose dialog is opened by **Rust** rather than by the webview — `pick_save_path` and `pick_files_to_upload` in `commands/file_commands.rs` drive `tauri-plugin-dialog` from the backend, so a compromised webview can ask for a picker and nothing more: it cannot name a host path as an *input* to either command. Be precise about the limit of that claim — host paths do still travel outward in error text (`Failed to create /home/j/Documents/x.txt.triple-c-part-1a2b3c4d: Permission denied`), including canonicalized ones, which disclose symlink targets. That is accepted; the app already hands the webview the project paths. What is closed is the direction that mattered — the webview naming where bytes go. That is the shape an earlier revision of this file named as the honest one if the Files tab ever regained host I/O, and it is the shape it regained it in. The `dialog:allow-open` / `dialog:allow-save` grants below are therefore *not* what those two use; they remain for the frontend pickers in Add Project, the Config tab's workspace and access sections, the CA-certificate fielLine truncated
|
||||
{"default":{"identifier":"default","description":"Default capabilities for Triple-C. Every entry here is an IPC command a compromised webview can call directly, so the set is an enumeration of what `app/src` actually invokes — plugin and core grants verified against tauri 2.11.0's `PLUGINS` table in tauri's own `build.rs` rather than assumed from a plugin's `default` set, app-command grants (the bare `allow-*` entries) cross-checked by this crate's `build.rs` against `generate_handler!`. `core:default` in particular is NOT used: it is an alias for `core:{path,event,window,webview,app,image,resources,menu,tray}:default`, and `core:image:default` carries `allow-from-path`, whose handler (`tauri-2.11.0/src/image/plugin.rs:41` → `src/image/mod.rs:96`) is a bare `std::fs::read(path)` with no scope mechanism of any kind. Nothing imports `@tauri-apps/api/image`, so the whole plugin is dropped rather than scoped — there is nothing to scope it with. `core:menu` and `core:tray` are dropped for the same reason (no menu, no tray icon); `core:window` and `core:path` because nothing imports them; `core:resources:allow-close` because no frontend value is a `Resource`; and `core:event`'s `allow-emit`/`allow-emit-to` because the frontend only ever *listens* — every emit in this app originates in Rust. Three notes on what is deliberately kept or accepted: (1) `core:webview:allow-internal-toggle-devtools` is not called by `app/src` at all — it is called by Tauri's own injected `toggle-devtools.js`, which binds Ctrl/Cmd+Shift+I. Both that script and the command behind it are `#[cfg(any(debug_assertions, feature = \"devtools\"))]`, so this grant is a `tauri dev` convenience that does not exist in a release bundle. (2) `opener:allow-open-url` is **gone**. It could not be narrowed by host — `TerminalView`'s `WebLinksAddon` opens links Claude printed inside the container, which are arbitrary by construction, so a host allowlist would have deleted the feature rather than bounded it — and it was carried here as an accepted residual risk: a compromised webview could make the OS open an attacker-chosen http(s) URL, an outbound channel. That risk is now closed rather than recorded. Every host-browser open in the app goes through the `open_url_external` command in `url_open.rs`, which exists because the AppImage environment leaks into a cold-launched browser on Linux (triple-c#34) and which re-validates the URL in Rust — scheme allowlist, no embedded credentials, no control characters, length cap, ASCII asserted before `execvp`. On macOS and Windows that command reaches the same plugin as before, via `OpenerExt::open_url`, whose desktop implementation calls `crate::open::open` directly and is therefore not gated by this file at all (`tauri-plugin-opener-2.5.3/src/lib.rs:60`). The plugin stays a dependency for exactly that reason; what is removed is the webview's ability to reach it without passing the Rust validation. (3) `drag:allow-start-drag` is **gone**, together with the OS drag-out it existed for. It could not be scoped — `tauri-plugin-drag` takes the item paths from the caller and has no scope mechanism, so a compromised webview could call `startDrag({ item: ['~/.ssh/id_rsa'] })` against any host path the user can read — and it was carried as an accepted residual risk for one gesture. Drag-out was held back for separate hardening (see branch `hold/disk-and-dragout`) and the plugin is no longer a dependency. Getting a file *out* of a container is either \"Back up container\" on the project's Overview tab, which archives a tree through the Docker API, or the Files tab's per-row \"Save to host…\", which copies one file; getting one *in* is a drop on the Terminal or the Files tab's \"Upload…\". None of the four touches this permission. The Files tab's two are worth separating out here, because they are the only host-path commands in the app whose dialog is opened by **Rust** rather than by the webview — `pick_save_path` and `pick_files_to_upload` in `commands/file_commands.rs` drive `tauri-plugin-dialog` from the backend, so a compromised webview can ask for a picker and nothing more: it cannot name a host path as an *input* to either command. Be precise about the limit of that claim — host paths do still travel outward in error text (`Failed to create /home/j/Documents/x.txt.triple-c-part-1a2b3c4d: Permission denied`), including canonicalized ones, which disclose symlink targets. That is accepted; the app already hands the webview the project paths. What is closed is the direction that mattered — the webview naming where bytes go. That is the shape an earlier revision of this file named as the honest one if the Files tab ever regained host I/O, and it is the shape it regained it in. The `dialog:allow-open` / `dialog:allow-save` grants below are therefore *not* what those two use; they remain for the frontend pickers in Add Project, the Config tab's workspace and access sections, the CA-certificate fielLine truncated
|
||||
@@ -416,6 +416,24 @@
|
||||
"const": "allow-aws-connection-sso-login",
|
||||
"markdownDescription": "Enables the aws_connection_sso_login command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_cost_estimate command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-cost-estimate",
|
||||
"markdownDescription": "Enables the aws_cost_estimate command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_ec2_capacity command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-ec2-capacity",
|
||||
"markdownDescription": "Enables the aws_ec2_capacity command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_environment_max_hours command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-environment-max-hours",
|
||||
"markdownDescription": "Enables the aws_environment_max_hours command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_policy_document command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -434,6 +452,12 @@
|
||||
"const": "allow-aws-task-log",
|
||||
"markdownDescription": "Enables the aws_task_log command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_workspace_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-workspace-status",
|
||||
"markdownDescription": "Enables the aws_workspace_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the build_gateway_image command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -488,6 +512,12 @@
|
||||
"const": "allow-check-docker",
|
||||
"markdownDescription": "Enables the check_docker command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the check_docker_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-check-docker-status",
|
||||
"markdownDescription": "Enables the check_docker_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the check_for_updates command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -626,6 +656,18 @@
|
||||
"const": "allow-download-container-file",
|
||||
"markdownDescription": "Enables the download_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the ec2_fit_problem command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-ec2-fit-problem",
|
||||
"markdownDescription": "Enables the ec2_fit_problem command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the end_workspace_terminal command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-end-workspace-terminal",
|
||||
"markdownDescription": "Enables the end_workspace_terminal command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the export_settings command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -806,6 +848,12 @@
|
||||
"const": "allow-list-container-files",
|
||||
"markdownDescription": "Enables the list_container_files command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_ec2_instance_types command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-list-ec2-instance-types",
|
||||
"markdownDescription": "Enables the list_ec2_instance_types command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_marketplace_snapshots command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -836,6 +884,12 @@
|
||||
"const": "allow-list-scheduled-tasks",
|
||||
"markdownDescription": "Enables the list_scheduled_tasks command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_workspace_terminals command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-list-workspace-terminals",
|
||||
"markdownDescription": "Enables the list_workspace_terminals command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the marketplace_gh_host_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -932,6 +986,12 @@
|
||||
"const": "allow-read-container-file",
|
||||
"markdownDescription": "Enables the read_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the reattach_terminal_session command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-reattach-terminal-session",
|
||||
"markdownDescription": "Enables the reattach_terminal_session command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the rebuild_project_container command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1370,6 +1430,24 @@
|
||||
"const": "deny-aws-connection-sso-login",
|
||||
"markdownDescription": "Denies the aws_connection_sso_login command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_cost_estimate command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-cost-estimate",
|
||||
"markdownDescription": "Denies the aws_cost_estimate command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_ec2_capacity command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-ec2-capacity",
|
||||
"markdownDescription": "Denies the aws_ec2_capacity command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_environment_max_hours command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-environment-max-hours",
|
||||
"markdownDescription": "Denies the aws_environment_max_hours command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_policy_document command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1388,6 +1466,12 @@
|
||||
"const": "deny-aws-task-log",
|
||||
"markdownDescription": "Denies the aws_task_log command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_workspace_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-workspace-status",
|
||||
"markdownDescription": "Denies the aws_workspace_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the build_gateway_image command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1442,6 +1526,12 @@
|
||||
"const": "deny-check-docker",
|
||||
"markdownDescription": "Denies the check_docker command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the check_docker_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-check-docker-status",
|
||||
"markdownDescription": "Denies the check_docker_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the check_for_updates command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1580,6 +1670,18 @@
|
||||
"const": "deny-download-container-file",
|
||||
"markdownDescription": "Denies the download_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the ec2_fit_problem command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-ec2-fit-problem",
|
||||
"markdownDescription": "Denies the ec2_fit_problem command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the end_workspace_terminal command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-end-workspace-terminal",
|
||||
"markdownDescription": "Denies the end_workspace_terminal command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the export_settings command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1760,6 +1862,12 @@
|
||||
"const": "deny-list-container-files",
|
||||
"markdownDescription": "Denies the list_container_files command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_ec2_instance_types command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-list-ec2-instance-types",
|
||||
"markdownDescription": "Denies the list_ec2_instance_types command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_marketplace_snapshots command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1790,6 +1898,12 @@
|
||||
"const": "deny-list-scheduled-tasks",
|
||||
"markdownDescription": "Denies the list_scheduled_tasks command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_workspace_terminals command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-list-workspace-terminals",
|
||||
"markdownDescription": "Denies the list_workspace_terminals command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the marketplace_gh_host_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1886,6 +2000,12 @@
|
||||
"const": "deny-read-container-file",
|
||||
"markdownDescription": "Denies the read_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the reattach_terminal_session command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-reattach-terminal-session",
|
||||
"markdownDescription": "Denies the reattach_terminal_session command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the rebuild_project_container command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
|
||||
@@ -416,6 +416,24 @@
|
||||
"const": "allow-aws-connection-sso-login",
|
||||
"markdownDescription": "Enables the aws_connection_sso_login command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_cost_estimate command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-cost-estimate",
|
||||
"markdownDescription": "Enables the aws_cost_estimate command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_ec2_capacity command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-ec2-capacity",
|
||||
"markdownDescription": "Enables the aws_ec2_capacity command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_environment_max_hours command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-environment-max-hours",
|
||||
"markdownDescription": "Enables the aws_environment_max_hours command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_policy_document command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -434,6 +452,12 @@
|
||||
"const": "allow-aws-task-log",
|
||||
"markdownDescription": "Enables the aws_task_log command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the aws_workspace_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-aws-workspace-status",
|
||||
"markdownDescription": "Enables the aws_workspace_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the build_gateway_image command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -488,6 +512,12 @@
|
||||
"const": "allow-check-docker",
|
||||
"markdownDescription": "Enables the check_docker command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the check_docker_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-check-docker-status",
|
||||
"markdownDescription": "Enables the check_docker_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the check_for_updates command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -626,6 +656,18 @@
|
||||
"const": "allow-download-container-file",
|
||||
"markdownDescription": "Enables the download_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the ec2_fit_problem command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-ec2-fit-problem",
|
||||
"markdownDescription": "Enables the ec2_fit_problem command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the end_workspace_terminal command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-end-workspace-terminal",
|
||||
"markdownDescription": "Enables the end_workspace_terminal command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the export_settings command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -806,6 +848,12 @@
|
||||
"const": "allow-list-container-files",
|
||||
"markdownDescription": "Enables the list_container_files command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_ec2_instance_types command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-list-ec2-instance-types",
|
||||
"markdownDescription": "Enables the list_ec2_instance_types command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_marketplace_snapshots command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -836,6 +884,12 @@
|
||||
"const": "allow-list-scheduled-tasks",
|
||||
"markdownDescription": "Enables the list_scheduled_tasks command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the list_workspace_terminals command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-list-workspace-terminals",
|
||||
"markdownDescription": "Enables the list_workspace_terminals command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the marketplace_gh_host_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -932,6 +986,12 @@
|
||||
"const": "allow-read-container-file",
|
||||
"markdownDescription": "Enables the read_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the reattach_terminal_session command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-reattach-terminal-session",
|
||||
"markdownDescription": "Enables the reattach_terminal_session command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the rebuild_project_container command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1370,6 +1430,24 @@
|
||||
"const": "deny-aws-connection-sso-login",
|
||||
"markdownDescription": "Denies the aws_connection_sso_login command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_cost_estimate command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-cost-estimate",
|
||||
"markdownDescription": "Denies the aws_cost_estimate command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_ec2_capacity command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-ec2-capacity",
|
||||
"markdownDescription": "Denies the aws_ec2_capacity command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_environment_max_hours command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-environment-max-hours",
|
||||
"markdownDescription": "Denies the aws_environment_max_hours command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_policy_document command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1388,6 +1466,12 @@
|
||||
"const": "deny-aws-task-log",
|
||||
"markdownDescription": "Denies the aws_task_log command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the aws_workspace_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-aws-workspace-status",
|
||||
"markdownDescription": "Denies the aws_workspace_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the build_gateway_image command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1442,6 +1526,12 @@
|
||||
"const": "deny-check-docker",
|
||||
"markdownDescription": "Denies the check_docker command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the check_docker_status command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-check-docker-status",
|
||||
"markdownDescription": "Denies the check_docker_status command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the check_for_updates command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1580,6 +1670,18 @@
|
||||
"const": "deny-download-container-file",
|
||||
"markdownDescription": "Denies the download_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the ec2_fit_problem command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-ec2-fit-problem",
|
||||
"markdownDescription": "Denies the ec2_fit_problem command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the end_workspace_terminal command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-end-workspace-terminal",
|
||||
"markdownDescription": "Denies the end_workspace_terminal command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the export_settings command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1760,6 +1862,12 @@
|
||||
"const": "deny-list-container-files",
|
||||
"markdownDescription": "Denies the list_container_files command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_ec2_instance_types command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-list-ec2-instance-types",
|
||||
"markdownDescription": "Denies the list_ec2_instance_types command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_marketplace_snapshots command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1790,6 +1898,12 @@
|
||||
"const": "deny-list-scheduled-tasks",
|
||||
"markdownDescription": "Denies the list_scheduled_tasks command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the list_workspace_terminals command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-list-workspace-terminals",
|
||||
"markdownDescription": "Denies the list_workspace_terminals command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the marketplace_gh_host_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
@@ -1886,6 +2000,12 @@
|
||||
"const": "deny-read-container-file",
|
||||
"markdownDescription": "Denies the read_container_file command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the reattach_terminal_session command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-reattach-terminal-session",
|
||||
"markdownDescription": "Denies the reattach_terminal_session command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the rebuild_project_container command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
|
||||
@@ -583,7 +583,7 @@ async fn reconcile(
|
||||
);
|
||||
continue;
|
||||
}
|
||||
match PortForward::bind(container.clone(), port, family).await {
|
||||
match PortForward::bind(container.clone(), port, port, family).await {
|
||||
Ok(forward) => {
|
||||
if st.conflicts.remove(&port).is_some() {
|
||||
log::info!("Auth bridge: host port {} became available", port);
|
||||
|
||||
@@ -54,6 +54,8 @@
|
||||
//! ([`IDLE_TIMEOUT`]).
|
||||
|
||||
use std::net::{Ipv4Addr, Ipv6Addr, SocketAddr};
|
||||
use std::sync::atomic::{AtomicBool, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use crate::host::{AttachedExec, ContainerTarget, ExecChunk};
|
||||
@@ -119,7 +121,11 @@ impl Drop for AbortOnDrop {
|
||||
/// also awaiting the aborted task, which guarantees the socket is closed before
|
||||
/// the caller proceeds (important when a port is rebound right after).
|
||||
pub struct PortForward {
|
||||
/// The host loopback port.
|
||||
pub port: u16,
|
||||
/// The container loopback port it reaches. The auth bridge mirrors a
|
||||
/// port onto the same number; a project's port mapping may not.
|
||||
pub container_port: u16,
|
||||
pub family: PortFamily,
|
||||
pub bridged_at: String,
|
||||
/// Why `[::1]` could not be taken alongside `127.0.0.1`, if it could not.
|
||||
@@ -141,15 +147,47 @@ impl Drop for PortForward {
|
||||
}
|
||||
|
||||
impl PortForward {
|
||||
/// Bind `port` on the host loopback and start proxying into `container`.
|
||||
/// Bind `host_port` on the host loopback and start proxying into
|
||||
/// `container_port` on the container's loopback — the auth bridge's
|
||||
/// forward, gated (see [`Gate::SignInCallback`]).
|
||||
///
|
||||
/// The bind happens before the task is spawned, so an already-taken port is
|
||||
/// reported to the caller as an error rather than disappearing into a
|
||||
/// background task.
|
||||
pub async fn bind(
|
||||
container: ContainerTarget,
|
||||
port: u16,
|
||||
host_port: u16,
|
||||
container_port: u16,
|
||||
family: PortFamily,
|
||||
) -> Result<Self, std::io::Error> {
|
||||
Self::bind_with(container, host_port, container_port, family, Gate::SignInCallback, None).await
|
||||
}
|
||||
|
||||
/// As [`bind`](Self::bind), for a project's port mapping on a host with
|
||||
/// no Docker port publishing (AWS): every connection is carried as is
|
||||
/// (see [`Gate::None`]).
|
||||
///
|
||||
/// Inside the workspace each connection goes to whichever loopback
|
||||
/// family has a listener on `container_port` ([`mapping_command`]), so a
|
||||
/// server bound to `[::1]` only is reached as well as one on
|
||||
/// `127.0.0.1`/`0.0.0.0`. `on_refused` is called (once per forward) the
|
||||
/// first time a connection finds nothing listening there.
|
||||
pub async fn bind_mapping(
|
||||
container: ContainerTarget,
|
||||
host_port: u16,
|
||||
container_port: u16,
|
||||
on_refused: Option<RefusedNotice>,
|
||||
) -> Result<Self, std::io::Error> {
|
||||
Self::bind_with(container, host_port, container_port, PortFamily::Dual, Gate::None, on_refused).await
|
||||
}
|
||||
|
||||
async fn bind_with(
|
||||
container: ContainerTarget,
|
||||
port: u16,
|
||||
container_port: u16,
|
||||
family: PortFamily,
|
||||
gate: Gate,
|
||||
on_refused: Option<RefusedNotice>,
|
||||
) -> Result<Self, std::io::Error> {
|
||||
// SECURITY BOUNDARY: the host side binds loopback ONLY — 127.0.0.1 and
|
||||
// ::1, never 0.0.0.0 / ::. Everything reachable through this socket is
|
||||
@@ -176,8 +214,8 @@ impl PortForward {
|
||||
// bridge reports itself healthy — a silent failure with no
|
||||
// thread back to this line.
|
||||
log::warn!(
|
||||
"Auth bridge: bound 127.0.0.1:{} but not [::1]:{} ({}) — continuing with IPv4 only; \
|
||||
a client that resolves localhost to ::1 without falling back will not reach it",
|
||||
"{}: bound 127.0.0.1:{} but not [::1]:{} ({}) — continuing with IPv4 only; \
|
||||
a client that resolves localhost to ::1 without falling back will not reach it", gate.label(),
|
||||
port,
|
||||
port,
|
||||
e
|
||||
@@ -193,11 +231,16 @@ impl PortForward {
|
||||
}
|
||||
};
|
||||
|
||||
let target = family.socat_target(port);
|
||||
let task = tokio::spawn(accept_loop(container, port, target, v4, v6));
|
||||
let cmd = match gate {
|
||||
Gate::SignInCallback => socat_command(&family.socat_target(container_port)),
|
||||
Gate::None => mapping_command(container_port),
|
||||
};
|
||||
let refused = on_refused.map(|f| Arc::new(RefusedOnce { notice: f, fired: AtomicBool::new(false) }));
|
||||
let task = tokio::spawn(accept_loop(container, port, cmd, v4, v6, gate, refused));
|
||||
|
||||
Ok(Self {
|
||||
port,
|
||||
container_port,
|
||||
family,
|
||||
bridged_at: chrono::Utc::now().to_rfc3339(),
|
||||
ipv6_warning,
|
||||
@@ -214,14 +257,40 @@ impl PortForward {
|
||||
}
|
||||
}
|
||||
|
||||
/// What an accepted connection must show before it is carried in.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
enum Gate {
|
||||
/// The auth bridge: a client must speak within [`FIRST_BYTE_TIMEOUT`],
|
||||
/// and a cross-site sub-resource request is refused
|
||||
/// ([`web_request_verdict`]).
|
||||
SignInCallback,
|
||||
/// A port mapping the user configured: carried as is, like Docker's own
|
||||
/// port publishing (which has no gate either) — a server-speaks-first
|
||||
/// protocol such as MySQL or SMTP must work, so nothing waits for the
|
||||
/// client's first byte.
|
||||
None,
|
||||
}
|
||||
|
||||
impl Gate {
|
||||
/// The log prefix of a forward of this kind.
|
||||
fn label(self) -> &'static str {
|
||||
match self {
|
||||
Gate::SignInCallback => "Auth bridge",
|
||||
Gate::None => "Port mapping",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Accept on both loopback listeners until aborted. Dropping this future drops
|
||||
/// the listeners (freeing the port) and the `JoinSet` (aborting live tunnels).
|
||||
async fn accept_loop(
|
||||
container: ContainerTarget,
|
||||
port: u16,
|
||||
target: String,
|
||||
cmd: Vec<String>,
|
||||
v4: TcpListener,
|
||||
v6: Option<TcpListener>,
|
||||
gate: Gate,
|
||||
refused: Option<Arc<RefusedOnce>>,
|
||||
) {
|
||||
let mut conns: JoinSet<()> = JoinSet::new();
|
||||
|
||||
@@ -245,25 +314,36 @@ async fn accept_loop(
|
||||
// client side is whatever can dial loopback, so a queue is
|
||||
// just a slower way to run out of execs.
|
||||
log::warn!(
|
||||
"Auth bridge: refusing connection from {} to bridged port {} — \
|
||||
{} concurrent connections already open on it",
|
||||
"{}: refusing connection from {} to bridged port {} — \
|
||||
{} concurrent connections already open on it", gate.label(),
|
||||
peer,
|
||||
port,
|
||||
MAX_CONNECTIONS
|
||||
);
|
||||
continue;
|
||||
}
|
||||
log::debug!("Auth bridge: connection from {} to bridged port {}", peer, port);
|
||||
log::debug!("{}: connection from {} to bridged port {}", gate.label(), peer, port);
|
||||
let _ = stream.set_nodelay(true);
|
||||
conns.spawn(tunnel_connection(
|
||||
container.clone(),
|
||||
target.clone(),
|
||||
stream,
|
||||
port,
|
||||
));
|
||||
match gate {
|
||||
Gate::SignInCallback => conns.spawn(tunnel_connection(
|
||||
container.clone(),
|
||||
cmd.clone(),
|
||||
stream,
|
||||
port,
|
||||
)),
|
||||
Gate::None => conns.spawn(tunnel_labelled(
|
||||
gate.label(),
|
||||
container.clone(),
|
||||
cmd.clone(),
|
||||
stream,
|
||||
port,
|
||||
Vec::new(),
|
||||
refused.clone(),
|
||||
)),
|
||||
};
|
||||
}
|
||||
Err(e) => {
|
||||
log::warn!("Auth bridge: accept failed on port {}: {} — stopping listener", port, e);
|
||||
log::warn!("{}: accept failed on port {}: {} — stopping listener", gate.label(), port, e);
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -288,7 +368,7 @@ async fn accept_optional(
|
||||
/// reaches the container at all — not even a `docker exec`.
|
||||
async fn tunnel_connection(
|
||||
container: ContainerTarget,
|
||||
target: String,
|
||||
cmd: Vec<String>,
|
||||
mut stream: TcpStream,
|
||||
port: u16,
|
||||
) {
|
||||
@@ -322,7 +402,7 @@ async fn tunnel_connection(
|
||||
}
|
||||
|
||||
// The bytes already off the socket go back on the wire first, byte-exact.
|
||||
tunnel_connection_with_prelude(container, target, stream, port, head.into_buffer()).await
|
||||
tunnel_labelled("Auth bridge", container, cmd, stream, port, head.into_buffer(), None).await
|
||||
}
|
||||
|
||||
/// What the first bytes of an accepted connection turned out to be.
|
||||
@@ -521,7 +601,20 @@ pub async fn tunnel_connection_with_prelude(
|
||||
port: u16,
|
||||
prelude: Vec<u8>,
|
||||
) {
|
||||
let cmd = vec!["socat".to_string(), "-".to_string(), target.clone()];
|
||||
tunnel_labelled("Auth bridge", container, socat_command(&target), stream, port, prelude, None).await
|
||||
}
|
||||
|
||||
/// [`tunnel_connection_with_prelude`], logging under `label`.
|
||||
async fn tunnel_labelled(
|
||||
label: &'static str,
|
||||
container: ContainerTarget,
|
||||
cmd: Vec<String>,
|
||||
stream: TcpStream,
|
||||
port: u16,
|
||||
prelude: Vec<u8>,
|
||||
refused: Option<Arc<RefusedOnce>>,
|
||||
) {
|
||||
let target = cmd.last().cloned().unwrap_or_default();
|
||||
|
||||
let AttachedExec {
|
||||
mut output,
|
||||
@@ -531,7 +624,7 @@ pub async fn tunnel_connection_with_prelude(
|
||||
Ok(e) => e,
|
||||
Err(e) => {
|
||||
log::warn!(
|
||||
"Auth bridge: failed to open tunnel exec for port {} ({}): {}",
|
||||
"{}: failed to open tunnel exec for port {} ({}): {}", label,
|
||||
port,
|
||||
target,
|
||||
e
|
||||
@@ -579,7 +672,7 @@ pub async fn tunnel_connection_with_prelude(
|
||||
Ok(chunk) => chunk,
|
||||
Err(_) => {
|
||||
log::debug!(
|
||||
"Auth bridge: bridged port {} idle for {}s — closing the tunnel",
|
||||
"{}: bridged port {} idle for {}s — closing the tunnel", label,
|
||||
port,
|
||||
IDLE_TIMEOUT.as_secs()
|
||||
);
|
||||
@@ -596,15 +689,21 @@ pub async fn tunnel_connection_with_prelude(
|
||||
}
|
||||
}
|
||||
Ok(ExecChunk::StdErr(message)) => {
|
||||
if let Some(r) = &refused {
|
||||
if is_connection_refused(&message) {
|
||||
log::warn!("{}: host port {}: nothing is listening in the workspace", label, port);
|
||||
r.fire();
|
||||
}
|
||||
}
|
||||
log::debug!(
|
||||
"Auth bridge: socat stderr for port {}: {}",
|
||||
"{}: socat stderr for port {}: {}", label,
|
||||
port,
|
||||
String::from_utf8_lossy(&message).trim()
|
||||
);
|
||||
}
|
||||
Ok(_) => {}
|
||||
Err(e) => {
|
||||
log::debug!("Auth bridge: tunnel stream error on port {}: {}", port, e);
|
||||
log::debug!("{}: tunnel stream error on port {}: {}", label, port, e);
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -615,10 +714,113 @@ pub async fn tunnel_connection_with_prelude(
|
||||
drop(upstream);
|
||||
}
|
||||
|
||||
/// Called the first time a port mapping's connection finds nothing
|
||||
/// listening on its workspace port.
|
||||
pub type RefusedNotice = Arc<dyn Fn() + Send + Sync>;
|
||||
|
||||
/// A [`RefusedNotice`] that fires once per forward.
|
||||
struct RefusedOnce {
|
||||
notice: RefusedNotice,
|
||||
fired: AtomicBool,
|
||||
}
|
||||
|
||||
impl RefusedOnce {
|
||||
fn fire(&self) {
|
||||
if !self.fired.swap(true, Ordering::SeqCst) {
|
||||
(self.notice)();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `socat` relaying stdio to `target`.
|
||||
fn socat_command(target: &str) -> Vec<String> {
|
||||
vec!["socat".to_string(), "-".to_string(), target.to_string()]
|
||||
}
|
||||
|
||||
/// Whether socat's stderr says the connect was refused (nothing listening).
|
||||
fn is_connection_refused(stderr: &[u8]) -> bool {
|
||||
String::from_utf8_lossy(stderr).contains("Connection refused")
|
||||
}
|
||||
|
||||
/// The in-workspace command of one port-mapping connection.
|
||||
///
|
||||
/// Docker publishes to the container's interface; a mapping reaches its
|
||||
/// loopback instead, where a server may listen on either family (Vite, or
|
||||
/// Node's `localhost` where it resolves to `::1`, listen on `[::1]` only).
|
||||
/// So the command picks, from `/proc/net/tcp{,6}` (the image has no `ss`),
|
||||
/// the family with a listener on `port`: `127.0.0.1` when one listens on
|
||||
/// `127.0.0.1` or `0.0.0.0`, else `[::1]` when one listens on `::1` or `::`.
|
||||
/// Nothing found: `127.0.0.1` anyway, and socat's "Connection refused" is
|
||||
/// what tells the host nothing listens. Reading `/proc` rather than trying
|
||||
/// a connect first means a server never sees a probe connection.
|
||||
pub(crate) fn mapping_command(port: u16) -> Vec<String> {
|
||||
// `port` is a u16: interpolating it into the script is safe.
|
||||
let script = format!(
|
||||
"h=$(printf ':%04X' {port}); \
|
||||
l() {{ awk -v a=\"$2$h\" -v b=\"$3$h\" '$4==\"0A\" && ($2==a || $2==b) {{f=1}} END {{exit !f}}' \"$1\" 2>/dev/null; }}; \
|
||||
if l /proc/net/tcp 0100007F 00000000; then exec socat - TCP:127.0.0.1:{port}; fi; \
|
||||
if l /proc/net/tcp6 00000000000000000000000001000000 00000000000000000000000000000000; \
|
||||
then exec socat - TCP6:[::1]:{port}; fi; \
|
||||
exec socat - TCP:127.0.0.1:{port}"
|
||||
);
|
||||
vec!["sh".to_string(), "-c".to_string(), script]
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn a_mapping_command_names_only_its_port_and_both_loopbacks() {
|
||||
let cmd = mapping_command(8080);
|
||||
assert_eq!(&cmd[..2], ["sh", "-c"]);
|
||||
let s = &cmd[2];
|
||||
assert!(s.contains("printf ':%04X' 8080"), "{s}");
|
||||
assert!(s.contains("TCP:127.0.0.1:8080") && s.contains("TCP6:[::1]:8080"), "{s}");
|
||||
// v4 first; the last resort is v4 too.
|
||||
assert!(s.find("TCP:127.0.0.1").unwrap() < s.find("TCP6:[::1]").unwrap());
|
||||
assert!(s.trim_end().ends_with("exec socat - TCP:127.0.0.1:8080"), "{s}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn socats_refusal_is_recognised() {
|
||||
assert!(is_connection_refused(
|
||||
b"2026/11/17 10:00:00 socat[42] E connect(5, AF=2 127.0.0.1:8080, 16): Connection refused\n"
|
||||
));
|
||||
assert!(!is_connection_refused(b"socat[42] N exiting with status 0"));
|
||||
}
|
||||
|
||||
/// The command picks the family from `/proc/net/tcp{,6}`: run it against
|
||||
/// real listeners where `sh`, `awk` and `socat` exist (skipped elsewhere).
|
||||
#[tokio::test]
|
||||
async fn a_mapping_command_reaches_a_v4_or_a_v6_only_listener() {
|
||||
let have = |b: &str| std::process::Command::new("sh").args(["-c", &format!("command -v {b}")]).output()
|
||||
.is_ok_and(|o| o.status.success());
|
||||
if !(have("awk") && have("socat") && std::path::Path::new("/proc/net/tcp").exists()) {
|
||||
eprintln!("skipped: needs sh, awk, socat and /proc/net");
|
||||
return;
|
||||
}
|
||||
for addr in ["127.0.0.1:0", "[::1]:0"] {
|
||||
let Ok(l) = TcpListener::bind(addr).await else { continue };
|
||||
let port = l.local_addr().unwrap().port();
|
||||
tokio::spawn(async move {
|
||||
if let Ok((mut s, _)) = l.accept().await {
|
||||
let _ = s.write_all(b"hello").await;
|
||||
}
|
||||
});
|
||||
let cmd = mapping_command(port);
|
||||
let out = tokio::process::Command::new(&cmd[0]).args(&cmd[1..])
|
||||
.stdin(std::process::Stdio::null()).output().await.unwrap();
|
||||
assert_eq!(String::from_utf8_lossy(&out.stdout), "hello", "{addr}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
}
|
||||
// Nothing listening: refused, in socat's words.
|
||||
let port = std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port();
|
||||
let cmd = mapping_command(port);
|
||||
let out = tokio::process::Command::new(&cmd[0]).args(&cmd[1..])
|
||||
.stdin(std::process::Stdio::null()).output().await.unwrap();
|
||||
assert!(is_connection_refused(&out.stderr), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
}
|
||||
|
||||
fn head(lines: &[&str]) -> String {
|
||||
format!("{}\r\n\r\n", lines.join("\r\n"))
|
||||
}
|
||||
|
||||
@@ -29,8 +29,9 @@ use serde_json::{json, Map, Value};
|
||||
use super::error::{classify_sdk_error, AwsError};
|
||||
use super::identity::CallerIdentity;
|
||||
use super::tofu_modules::{
|
||||
environment_parameter_name, owner_key, state_bucket_name, state_key, user_role_names,
|
||||
validate_environment_name, Deployment, BOUNDARY_POLICY_NAME,
|
||||
environment_parameter_name, owner_key, state_bucket_name, state_key, user_ec2_stem,
|
||||
user_record_parameter_name, user_role_names, validate_ec2_user_tag, validate_environment_name,
|
||||
Deployment, BOUNDARY_POLICY_NAME, EC2_MAX_INSTANCES,
|
||||
};
|
||||
use crate::models::host_connection::validate_supported_region;
|
||||
|
||||
@@ -75,6 +76,10 @@ pub struct EnvironmentInfo {
|
||||
pub log_group: String,
|
||||
pub network_mode: String,
|
||||
pub tenancy: String,
|
||||
/// Advisory lifetime cap for workspaces, in hours; 0 = none. Absent in
|
||||
/// records written by module version 1.
|
||||
#[serde(default)]
|
||||
pub max_workspace_hours: u32,
|
||||
}
|
||||
|
||||
fn field<'a>(obj: &'a Map<String, Value>, name: &str) -> Result<&'a Value, String> {
|
||||
@@ -187,6 +192,15 @@ pub fn parse_environment_record(
|
||||
return Err("tenancy is not strict".into());
|
||||
}
|
||||
|
||||
let max_workspace_hours = match obj.get("max_workspace_hours") {
|
||||
None => 0,
|
||||
Some(v) => v
|
||||
.as_u64()
|
||||
.and_then(|v| u32::try_from(v).ok())
|
||||
.filter(|v| *v <= super::tofu_modules::MAX_WORKSPACE_HOURS)
|
||||
.ok_or_else(|| "max_workspace_hours is not a number from 0 to 168".to_string())?,
|
||||
};
|
||||
|
||||
Ok(EnvironmentInfo {
|
||||
schema: RECORD_SCHEMA as u32,
|
||||
name: name.clone(),
|
||||
@@ -199,6 +213,7 @@ pub fn parse_environment_record(
|
||||
log_group: log_group.to_string(),
|
||||
network_mode: network_mode.to_string(),
|
||||
tenancy: "strict".to_string(),
|
||||
max_workspace_hours,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -295,15 +310,97 @@ pub enum EnvironmentAction {
|
||||
#[serde(tag = "state", rename_all = "snake_case")]
|
||||
pub enum OnboardingState {
|
||||
/// Their task role exists and, where the bucket is readable, their state
|
||||
/// records a finished apply (its `onboarding_complete` output).
|
||||
Joined,
|
||||
/// records a finished apply (its `onboarding_complete` output). `ec2` is
|
||||
/// their EC2 capacity, from their user record.
|
||||
Joined { ec2: Option<UserCompute> },
|
||||
NotJoined,
|
||||
/// A local runner, or a recent lock.
|
||||
InProgress { lock: Option<LockInfo> },
|
||||
/// The last onboarding run didn't finish: a stale lock, a failed run on
|
||||
/// this machine, or a state without the completion output. Join is a
|
||||
/// re-apply and finishes it.
|
||||
Incomplete { lock: Option<LockInfo> },
|
||||
/// re-apply and finishes it; `ec2` is what their record still holds, so
|
||||
/// the re-apply can keep it.
|
||||
Incomplete {
|
||||
lock: Option<LockInfo>,
|
||||
ec2: Option<UserCompute>,
|
||||
},
|
||||
}
|
||||
|
||||
impl OnboardingState {
|
||||
fn with_ec2(self, compute: Option<UserCompute>) -> Self {
|
||||
match self {
|
||||
OnboardingState::Joined { .. } => OnboardingState::Joined { ec2: compute },
|
||||
OnboardingState::Incomplete { lock, .. } => OnboardingState::Incomplete { lock, ec2: compute },
|
||||
other => other,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A user's EC2 capacity in one environment: their validated user record
|
||||
/// (`tofu_modules::user_record_parameter_name`). A missing record means no
|
||||
/// NEW EC2 runs there, not that nothing runs (teardown removes it first).
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
|
||||
pub struct UserCompute {
|
||||
pub instance_type: String,
|
||||
pub max_instances: u32,
|
||||
/// The `triple-c-user` value the cluster is named after.
|
||||
pub user_tag: String,
|
||||
pub cluster_arn: String,
|
||||
pub capacity_provider: String,
|
||||
}
|
||||
|
||||
/// Validate a user record read from `user_record_parameter_name(env, …)`:
|
||||
/// schema 1, a type the app's table knows, 1 to `EC2_MAX_INSTANCES`
|
||||
/// instances (absent in records written before the field: 1), a valid user
|
||||
/// tag, and the cluster and capacity provider of exactly that tag's per-user
|
||||
/// names in `account` and `region`. The error names the field, never its
|
||||
/// value.
|
||||
pub fn parse_user_record(
|
||||
env: &str,
|
||||
value: &str,
|
||||
account: &str,
|
||||
region: &str,
|
||||
) -> Result<UserCompute, String> {
|
||||
if value.len() > MAX_UNTRUSTED_BYTES {
|
||||
return Err("the record is larger than 4 KiB".into());
|
||||
}
|
||||
let parsed: Value =
|
||||
serde_json::from_str(value).map_err(|_| "the record is not JSON".to_string())?;
|
||||
let obj = parsed
|
||||
.as_object()
|
||||
.ok_or_else(|| "the record is not a JSON object".to_string())?;
|
||||
if field(obj, "schema")?.as_u64() != Some(RECORD_SCHEMA) {
|
||||
return Err("schema is not 1".into());
|
||||
}
|
||||
let instance_type = str_field(obj, "instance_type")?;
|
||||
if crate::models::project::ec2_instance_spec(instance_type).is_none() {
|
||||
return Err("instance_type is not a supported instance type".into());
|
||||
}
|
||||
let max_instances = match obj.get("max_instances") {
|
||||
None => 1,
|
||||
Some(v) => v
|
||||
.as_u64()
|
||||
.and_then(|v| u32::try_from(v).ok())
|
||||
.filter(|v| (1..=EC2_MAX_INSTANCES).contains(v))
|
||||
.ok_or_else(|| format!("max_instances is not a number from 1 to {EC2_MAX_INSTANCES}"))?,
|
||||
};
|
||||
let user_tag = validate_ec2_user_tag(str_field(obj, "user_tag")?)
|
||||
.map_err(|_| "user_tag is not a valid triple-c-user value".to_string())?;
|
||||
let stem = user_ec2_stem(env, &user_tag);
|
||||
let cluster_arn = str_field(obj, "cluster_arn")?;
|
||||
if cluster_arn != format!("arn:aws:ecs:{region}:{account}:cluster/{stem}") {
|
||||
return Err("cluster_arn is not this user's cluster in this account and region".into());
|
||||
}
|
||||
if str_field(obj, "capacity_provider")? != stem {
|
||||
return Err("capacity_provider is not this user's capacity provider".into());
|
||||
}
|
||||
Ok(UserCompute {
|
||||
instance_type: instance_type.to_string(),
|
||||
max_instances,
|
||||
user_tag,
|
||||
cluster_arn: cluster_arn.to_string(),
|
||||
capacity_provider: stem,
|
||||
})
|
||||
}
|
||||
|
||||
#[derive(Serialize, Clone, Debug, PartialEq)]
|
||||
@@ -551,9 +648,12 @@ fn onboarding_from_runs(
|
||||
Some(OnboardingState::InProgress { lock })
|
||||
} else if lock.is_some() {
|
||||
actions.push(Unlock);
|
||||
Some(OnboardingState::Incomplete { lock })
|
||||
Some(OnboardingState::Incomplete { lock, ec2: None })
|
||||
} else if run.failed || run.errored_state {
|
||||
Some(OnboardingState::Incomplete { lock: None })
|
||||
Some(OnboardingState::Incomplete {
|
||||
lock: None,
|
||||
ec2: None,
|
||||
})
|
||||
} else {
|
||||
None
|
||||
};
|
||||
@@ -583,6 +683,8 @@ pub trait DetectApi: Send + Sync {
|
||||
account: &str,
|
||||
) -> impl Future<Output = Result<Knowable, AwsError>> + Send;
|
||||
fn role_exists(&self, name: &str) -> impl Future<Output = Result<Knowable, AwsError>> + Send;
|
||||
/// An SSM String parameter (a user record).
|
||||
fn parameter(&self, name: &str) -> impl Future<Output = Result<Param, AwsError>> + Send;
|
||||
/// A state object's contents, capped; `None` when it is missing, can't
|
||||
/// be read or is too large.
|
||||
fn state_document(
|
||||
@@ -661,8 +763,13 @@ pub(crate) async fn scan_in_bucket<D: DetectApi>(
|
||||
// role), which is not Joined.
|
||||
None if objects.as_ref().is_some_and(|o| o.has_state(&user_state)) => {
|
||||
match d.state_document(bucket, &user_state).await? {
|
||||
Some(text) if onboarding_complete(&text) => OnboardingState::Joined,
|
||||
_ => OnboardingState::Incomplete { lock: None },
|
||||
Some(text) if onboarding_complete(&text) => {
|
||||
OnboardingState::Joined { ec2: None }
|
||||
}
|
||||
_ => OnboardingState::Incomplete {
|
||||
lock: None,
|
||||
ec2: None,
|
||||
},
|
||||
}
|
||||
}
|
||||
// Without a state here (a workspace user, who can't list the
|
||||
@@ -671,11 +778,20 @@ pub(crate) async fn scan_in_bucket<D: DetectApi>(
|
||||
None => {
|
||||
let (task_role, _) = user_role_names(&env.name, &key);
|
||||
match d.role_exists(&task_role).await? {
|
||||
Knowable::Yes => OnboardingState::Joined,
|
||||
Knowable::Yes => OnboardingState::Joined { ec2: None },
|
||||
Knowable::No | Knowable::Unknown => OnboardingState::NotJoined,
|
||||
}
|
||||
}
|
||||
});
|
||||
if let Some(state) = env.onboarding.take() {
|
||||
let compute = match state {
|
||||
OnboardingState::Joined { .. } | OnboardingState::Incomplete { .. } => {
|
||||
user_compute(d, &env.name, &key, &who.account, region).await?
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
env.onboarding = Some(state.with_ec2(compute));
|
||||
}
|
||||
}
|
||||
|
||||
Ok(EnvironmentScan {
|
||||
@@ -689,6 +805,234 @@ pub(crate) async fn scan_in_bucket<D: DetectApi>(
|
||||
})
|
||||
}
|
||||
|
||||
/// An SSM parameter read: its value, missing, or this caller can't read it.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub enum Param {
|
||||
Value(String),
|
||||
Missing,
|
||||
Denied,
|
||||
}
|
||||
|
||||
/// A user record as read: none, valid, or present but unusable (unreadable
|
||||
/// or failing validation; the reason names a field, never a value).
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub enum UserRecord {
|
||||
Absent,
|
||||
Valid(UserCompute),
|
||||
Unusable(String),
|
||||
}
|
||||
|
||||
impl UserRecord {
|
||||
pub fn valid(&self) -> Option<&UserCompute> {
|
||||
match self {
|
||||
UserRecord::Valid(c) => Some(c),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// [`UserRecord`] from a read of `user_record_parameter_name(env, …)`.
|
||||
pub fn user_record_from(read: Param, env: &str, account: &str, region: &str) -> UserRecord {
|
||||
match read {
|
||||
Param::Missing => UserRecord::Absent,
|
||||
Param::Denied => UserRecord::Unusable("it can't be read with these credentials".into()),
|
||||
Param::Value(text) => match parse_user_record(env, &text, account, region) {
|
||||
Ok(c) => UserRecord::Valid(c),
|
||||
Err(reason) => UserRecord::Unusable(reason),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/// The caller's EC2 capacity in `env` from their user record; `None` when
|
||||
/// there is no usable record (an unusable one is logged, never echoed).
|
||||
pub(crate) async fn user_compute<D: DetectApi>(
|
||||
d: &D,
|
||||
env: &str,
|
||||
owner_key: &str,
|
||||
account: &str,
|
||||
region: &str,
|
||||
) -> Result<Option<UserCompute>, AwsError> {
|
||||
let read = d.parameter(&user_record_parameter_name(env, owner_key)).await?;
|
||||
match user_record_from(read, env, account, region) {
|
||||
UserRecord::Valid(c) => Ok(Some(c)),
|
||||
UserRecord::Absent => Ok(None),
|
||||
UserRecord::Unusable(reason) => {
|
||||
log::warn!("Ignoring the EC2 user record for environment {env}: {reason}");
|
||||
Ok(None)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Who holds a per-user EC2 name (`tofu_modules::user_ec2_stem`): an ECS
|
||||
/// cluster or Auto Scaling group of that name and its `triple-c:owner` tag.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub struct NameHolder {
|
||||
/// "ECS cluster" or "Auto Scaling group".
|
||||
pub kind: &'static str,
|
||||
pub owner: Option<String>,
|
||||
}
|
||||
|
||||
/// An ECS cluster or Auto Scaling group found by name: its status (clusters
|
||||
/// only) and tags.
|
||||
#[derive(Clone, Debug, PartialEq, Default)]
|
||||
pub struct NamedResource {
|
||||
pub status: Option<String>,
|
||||
pub tags: Vec<(String, String)>,
|
||||
}
|
||||
|
||||
/// What an onboarding apply asks AWS before it starts (R3): the caller's
|
||||
/// user record and whether the per-user EC2 names are taken. The cluster
|
||||
/// read needs `ecs:DescribeClusters` (tags included); the group read
|
||||
/// `autoscaling:DescribeAutoScalingGroups`, which only the environment-admin
|
||||
/// tier has.
|
||||
pub trait OnboardApi: Send + Sync {
|
||||
fn parameter(&self, name: &str) -> impl Future<Output = Result<Param, AwsError>> + Send;
|
||||
fn cluster(
|
||||
&self,
|
||||
name: &str,
|
||||
) -> impl Future<Output = Result<Option<NamedResource>, AwsError>> + Send;
|
||||
fn group(
|
||||
&self,
|
||||
name: &str,
|
||||
) -> impl Future<Output = Result<Option<NamedResource>, AwsError>> + Send;
|
||||
}
|
||||
|
||||
const OWNER_TAG: &str = "triple-c:owner";
|
||||
|
||||
fn owner_of(r: &NamedResource) -> Option<String> {
|
||||
r.tags
|
||||
.iter()
|
||||
.find(|(k, _)| k == OWNER_TAG)
|
||||
.map(|(_, v)| v.clone())
|
||||
}
|
||||
|
||||
/// The cluster holding `stem`, if any. Every status but INACTIVE (a deleted
|
||||
/// cluster) holds the name: PROVISIONING, DEPROVISIONING and FAILED too.
|
||||
pub async fn cluster_holder<A: OnboardApi>(
|
||||
api: &A,
|
||||
stem: &str,
|
||||
) -> Result<Option<NameHolder>, AwsError> {
|
||||
Ok(api
|
||||
.cluster(stem)
|
||||
.await?
|
||||
.filter(|c| c.status.as_deref() != Some("INACTIVE"))
|
||||
.map(|c| NameHolder {
|
||||
kind: "ECS cluster",
|
||||
owner: owner_of(&c),
|
||||
}))
|
||||
}
|
||||
|
||||
/// Everything holding `stem`: its cluster and its Auto Scaling group.
|
||||
pub async fn ec2_name_holders<A: OnboardApi>(
|
||||
api: &A,
|
||||
stem: &str,
|
||||
) -> Result<Vec<NameHolder>, AwsError> {
|
||||
let mut out: Vec<NameHolder> = cluster_holder(api, stem).await?.into_iter().collect();
|
||||
if let Some(g) = api.group(stem).await? {
|
||||
out.push(NameHolder {
|
||||
kind: "Auto Scaling group",
|
||||
owner: owner_of(&g),
|
||||
});
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// `ssm:GetParameter` as a [`Param`].
|
||||
pub(crate) async fn get_parameter(ssm: &aws_sdk_ssm::Client, name: &str) -> Result<Param, AwsError> {
|
||||
let res = ssm
|
||||
.get_parameter()
|
||||
.name(name)
|
||||
.with_decryption(false)
|
||||
.send()
|
||||
.await;
|
||||
match res {
|
||||
Ok(out) => Ok(out
|
||||
.parameter()
|
||||
.and_then(|p| p.value())
|
||||
.map_or(Param::Missing, |v| Param::Value(v.to_string()))),
|
||||
Err(e) if e.as_service_error().is_some_and(|s| s.is_parameter_not_found()) => {
|
||||
Ok(Param::Missing)
|
||||
}
|
||||
Err(e) => {
|
||||
let (code, status) = error_parts(&e);
|
||||
match lookup_outcome(code.as_deref(), status) {
|
||||
Lookup::Missing => Ok(Param::Missing),
|
||||
Lookup::Denied => Ok(Param::Denied),
|
||||
Lookup::Error => Err(classify_sdk_error("ssm:GetParameter", &e)),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The real [`OnboardApi`], from a connection's `SdkConfig`.
|
||||
pub struct SdkOnboardApi {
|
||||
ssm: aws_sdk_ssm::Client,
|
||||
ecs: aws_sdk_ecs::Client,
|
||||
autoscaling: aws_sdk_autoscaling::Client,
|
||||
}
|
||||
|
||||
impl SdkOnboardApi {
|
||||
pub fn new(cfg: &SdkConfig) -> Self {
|
||||
SdkOnboardApi {
|
||||
ssm: aws_sdk_ssm::Client::new(cfg),
|
||||
ecs: aws_sdk_ecs::Client::new(cfg),
|
||||
autoscaling: aws_sdk_autoscaling::Client::new(cfg),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl OnboardApi for SdkOnboardApi {
|
||||
async fn parameter(&self, name: &str) -> Result<Param, AwsError> {
|
||||
get_parameter(&self.ssm, name).await
|
||||
}
|
||||
|
||||
async fn cluster(&self, name: &str) -> Result<Option<NamedResource>, AwsError> {
|
||||
// A missing name is a `failures` entry, not an error.
|
||||
let out = self
|
||||
.ecs
|
||||
.describe_clusters()
|
||||
.clusters(name)
|
||||
.include(aws_sdk_ecs::types::ClusterField::Tags)
|
||||
.send()
|
||||
.await
|
||||
.map_err(|e| classify_sdk_error("ecs:DescribeClusters", &e))?;
|
||||
Ok(out
|
||||
.clusters()
|
||||
.iter()
|
||||
.find(|c| c.cluster_name() == Some(name))
|
||||
.map(|c| NamedResource {
|
||||
status: c.status().map(str::to_string),
|
||||
tags: c
|
||||
.tags()
|
||||
.iter()
|
||||
.filter_map(|t| Some((t.key()?.to_string(), t.value()?.to_string())))
|
||||
.collect(),
|
||||
}))
|
||||
}
|
||||
|
||||
async fn group(&self, name: &str) -> Result<Option<NamedResource>, AwsError> {
|
||||
let out = self
|
||||
.autoscaling
|
||||
.describe_auto_scaling_groups()
|
||||
.auto_scaling_group_names(name)
|
||||
.send()
|
||||
.await
|
||||
.map_err(|e| classify_sdk_error("autoscaling:DescribeAutoScalingGroups", &e))?;
|
||||
Ok(out
|
||||
.auto_scaling_groups()
|
||||
.iter()
|
||||
.find(|g| g.auto_scaling_group_name() == Some(name))
|
||||
.map(|g| NamedResource {
|
||||
status: None,
|
||||
tags: g
|
||||
.tags()
|
||||
.iter()
|
||||
.filter_map(|t| Some((t.key()?.to_string(), t.value()?.to_string())))
|
||||
.collect(),
|
||||
}))
|
||||
}
|
||||
}
|
||||
|
||||
/// An OpenTofu state that manages nothing (what `tofu destroy` leaves):
|
||||
/// valid JSON whose `resources` is an empty list. Anything else, unreadable
|
||||
/// contents included, counts as a deployment.
|
||||
@@ -1001,6 +1345,10 @@ impl DetectApi for SdkDetectApi {
|
||||
knowable("iam:GetRole", res)
|
||||
}
|
||||
|
||||
async fn parameter(&self, name: &str) -> Result<Param, AwsError> {
|
||||
get_parameter(&self.ssm, name).await
|
||||
}
|
||||
|
||||
async fn state_document(&self, bucket: &str, key: &str) -> Result<Option<String>, AwsError> {
|
||||
const ACTION: &str = "s3:GetObject";
|
||||
let res = self
|
||||
|
||||
@@ -44,6 +44,22 @@ fn without(name: &str, field: &str) -> String {
|
||||
r.to_string()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_lifetime_cap_is_read_when_present() {
|
||||
for hours in [0, 8, 168] {
|
||||
let rec = with("dev", "max_workspace_hours", json!(hours));
|
||||
let info = parse_environment_record("dev", &rec, ACCOUNT, REGION).unwrap();
|
||||
assert_eq!(info.max_workspace_hours, hours);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_version_1_record_reads_as_update_available() {
|
||||
use crate::aws::tofu_modules::ENVIRONMENT_MODULE_VERSION;
|
||||
let v1 = parsed("dev", 1);
|
||||
assert!(v1.template_version < ENVIRONMENT_MODULE_VERSION);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn untrusted_environment_records_are_rejected() {
|
||||
let valid = parsed("dev", 1);
|
||||
@@ -52,6 +68,7 @@ fn untrusted_environment_records_are_rejected() {
|
||||
assert_eq!(valid.subnet_ids.len(), 2);
|
||||
assert!(valid.assign_public_ip);
|
||||
assert_eq!(valid.tenancy, "strict");
|
||||
assert_eq!(valid.max_workspace_hours, 0, "a v1 record has no cap");
|
||||
|
||||
let other_account = "999999999999";
|
||||
let secret = "s3cr3t-value-never-echoed";
|
||||
@@ -182,6 +199,21 @@ fn untrusted_environment_records_are_rejected() {
|
||||
with("dev", "template_version", json!(secret)),
|
||||
"template_version",
|
||||
),
|
||||
(
|
||||
"cap above a week",
|
||||
with("dev", "max_workspace_hours", json!(169)),
|
||||
"max_workspace_hours",
|
||||
),
|
||||
(
|
||||
"cap not a number",
|
||||
with("dev", "max_workspace_hours", json!(secret)),
|
||||
"max_workspace_hours",
|
||||
),
|
||||
(
|
||||
"negative cap",
|
||||
with("dev", "max_workspace_hours", json!(-1)),
|
||||
"max_workspace_hours",
|
||||
),
|
||||
];
|
||||
for (what, value, field) in cases {
|
||||
let err = parse_environment_record("dev", &value, ACCOUNT, REGION)
|
||||
@@ -462,6 +494,8 @@ struct FakeDetect {
|
||||
roles: HashMap<String, Knowable>,
|
||||
/// State objects' contents, by key.
|
||||
documents: HashMap<String, String>,
|
||||
/// SSM parameters (user records), by name.
|
||||
parameters: HashMap<String, String>,
|
||||
calls: Mutex<Vec<String>>,
|
||||
}
|
||||
|
||||
@@ -474,6 +508,7 @@ impl FakeDetect {
|
||||
boundary: Knowable::Yes,
|
||||
roles: HashMap::new(),
|
||||
documents: HashMap::new(),
|
||||
parameters: HashMap::new(),
|
||||
calls: Mutex::new(Vec::new()),
|
||||
}
|
||||
}
|
||||
@@ -516,6 +551,10 @@ impl DetectApi for FakeDetect {
|
||||
self.log(format!("role {name}"));
|
||||
Ok(self.roles.get(name).cloned().unwrap_or(Knowable::No))
|
||||
}
|
||||
async fn parameter(&self, name: &str) -> Result<Param, AwsError> {
|
||||
self.log(format!("parameter {name}"));
|
||||
Ok(self.parameters.get(name).cloned().map_or(Param::Missing, Param::Value))
|
||||
}
|
||||
async fn state_document(&self, bucket: &str, key: &str) -> Result<Option<String>, AwsError> {
|
||||
self.log(format!("document {bucket} {key}"));
|
||||
Ok(self.documents.get(key).cloned())
|
||||
@@ -580,8 +619,8 @@ fn onboarding_is_found_by_state_then_by_role() {
|
||||
assert_eq!(scan.owner_id, USER_ID);
|
||||
assert_eq!(scan.owner_key, owner_key(REGION, USER_ID));
|
||||
let onboarding = |n: &str| find(&scan.environments, n).onboarding.clone();
|
||||
assert_eq!(onboarding("bystate"), Some(OnboardingState::Joined));
|
||||
assert_eq!(onboarding("byrole"), Some(OnboardingState::Joined));
|
||||
assert_eq!(onboarding("bystate"), Some(OnboardingState::Joined { ec2: None }));
|
||||
assert_eq!(onboarding("byrole"), Some(OnboardingState::Joined { ec2: None }));
|
||||
assert_eq!(onboarding("denied"), Some(OnboardingState::NotJoined));
|
||||
assert_eq!(onboarding("absent"), Some(OnboardingState::NotJoined));
|
||||
assert!(matches!(
|
||||
@@ -630,7 +669,7 @@ fn onboarding_is_found_by_state_then_by_role() {
|
||||
assert_eq!(x.onboarding, Some(OnboardingState::InProgress { lock: None }));
|
||||
assert_eq!(x.onboarding_actions, vec![EnvironmentAction::Follow]);
|
||||
let y = find(&scan.environments, "y");
|
||||
let Some(OnboardingState::Incomplete { lock: Some(lock) }) = &y.onboarding else {
|
||||
let Some(OnboardingState::Incomplete { lock: Some(lock), ec2: None }) = &y.onboarding else {
|
||||
panic!("{y:#?}");
|
||||
};
|
||||
assert!(!lock.local_process);
|
||||
@@ -950,12 +989,12 @@ fn a_failed_onboarding_is_incomplete_not_joined() {
|
||||
let scan = run_scan(&d, &local);
|
||||
let row = |n: &str| find(&scan.environments, n).clone();
|
||||
|
||||
assert_eq!(row("done").onboarding, Some(OnboardingState::Joined));
|
||||
assert_eq!(row("done").onboarding, Some(OnboardingState::Joined { ec2: None }));
|
||||
for name in ["partial", "failedhere", "errored"] {
|
||||
let r = row(name);
|
||||
assert_eq!(
|
||||
r.onboarding,
|
||||
Some(OnboardingState::Incomplete { lock: None }),
|
||||
Some(OnboardingState::Incomplete { lock: None, ec2: None }),
|
||||
"{name}"
|
||||
);
|
||||
// Join is kept: an idempotent re-apply finishes it.
|
||||
@@ -1075,3 +1114,171 @@ fn the_tls_statement_is_added_to_a_bucket_policy_never_replacing_it() {
|
||||
// Something that isn't a policy is never overwritten.
|
||||
assert!(state_bucket_policy_update(Some("not json"), &bucket).is_err());
|
||||
}
|
||||
|
||||
fn user_record(env: &str, tag: &str) -> Value {
|
||||
let stem = crate::aws::tofu_modules::user_ec2_stem(env, tag);
|
||||
json!({
|
||||
"schema": 1,
|
||||
"instance_type": "m7g.large",
|
||||
"cluster_arn": format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/{stem}"),
|
||||
"capacity_provider": stem,
|
||||
"user_tag": tag,
|
||||
"max_instances": 3,
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_user_record_reads_as_the_users_compute() {
|
||||
let rec = user_record("dev", "alice");
|
||||
let c = parse_user_record("dev", &rec.to_string(), ACCOUNT, REGION).unwrap();
|
||||
assert_eq!(
|
||||
c,
|
||||
UserCompute {
|
||||
instance_type: "m7g.large".into(),
|
||||
max_instances: 3,
|
||||
user_tag: "alice".into(),
|
||||
cluster_arn: format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-alice"),
|
||||
capacity_provider: "triple-c-dev--u-alice".into(),
|
||||
}
|
||||
);
|
||||
// A record written before max_instances existed: the module's default.
|
||||
let mut old = rec.clone();
|
||||
old.as_object_mut().unwrap().remove("max_instances");
|
||||
let c = parse_user_record("dev", &old.to_string(), ACCOUNT, REGION).unwrap();
|
||||
assert_eq!(c.max_instances, 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_user_record_is_untrusted() {
|
||||
let bad = |field: &str, value: Value, why: &str| {
|
||||
let mut rec = user_record("dev", "alice");
|
||||
rec[field] = value;
|
||||
let err = parse_user_record("dev", &rec.to_string(), ACCOUNT, REGION).unwrap_err();
|
||||
assert!(err.contains(why), "{field}: {err}");
|
||||
assert!(!err.contains("evil"), "{err}");
|
||||
};
|
||||
bad("schema", json!(2), "schema");
|
||||
bad("instance_type", json!("p5.48xlarge"), "instance_type");
|
||||
bad("instance_type", json!(7), "instance_type");
|
||||
bad("max_instances", json!(0), "max_instances");
|
||||
bad("max_instances", json!(5), "max_instances");
|
||||
bad("max_instances", json!("2"), "max_instances");
|
||||
bad("user_tag", json!("evil--tag"), "user_tag");
|
||||
// Another user's cluster, or one in another account or region.
|
||||
bad(
|
||||
"cluster_arn",
|
||||
json!(format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-bob")),
|
||||
"cluster_arn",
|
||||
);
|
||||
bad(
|
||||
"cluster_arn",
|
||||
json!(format!("arn:aws:ecs:us-east-1:{ACCOUNT}:cluster/triple-c-dev--u-alice")),
|
||||
"cluster_arn",
|
||||
);
|
||||
bad(
|
||||
"cluster_arn",
|
||||
json!(format!("arn:aws:ecs:{REGION}:999999999999:cluster/triple-c-dev--u-alice")),
|
||||
"cluster_arn",
|
||||
);
|
||||
bad("capacity_provider", json!("evil"), "capacity_provider");
|
||||
// Another environment's record.
|
||||
let rec = user_record("prod", "alice").to_string();
|
||||
assert!(parse_user_record("dev", &rec, ACCOUNT, REGION).is_err());
|
||||
for text in ["", "not json", "[]", &"x".repeat(5000)] {
|
||||
assert!(parse_user_record("dev", text, ACCOUNT, REGION).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
fn compute_of(s: &OnboardingState) -> Option<&UserCompute> {
|
||||
match s {
|
||||
OnboardingState::Joined { ec2 } | OnboardingState::Incomplete { ec2, .. } => ec2.as_ref(),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn onboarding_carries_the_users_compute_from_their_record() {
|
||||
use crate::aws::tofu_modules::user_record_parameter_name;
|
||||
let ok = owner_key(REGION, USER_ID);
|
||||
let mut d = FakeDetect::new()
|
||||
.with_record("joined", 1)
|
||||
.with_record("fargate", 1)
|
||||
.with_record("broken", 1)
|
||||
.with_record("partial", 1)
|
||||
.with_record("absent", 1);
|
||||
d.roles.insert(task_role("joined"), Knowable::Yes);
|
||||
d.roles.insert(task_role("fargate"), Knowable::Yes);
|
||||
d.roles.insert(task_role("broken"), Knowable::Yes);
|
||||
d.objects = Some(StateObjects {
|
||||
states: vec![
|
||||
env_key("joined"),
|
||||
env_key("fargate"),
|
||||
env_key("broken"),
|
||||
env_key("partial"),
|
||||
env_key("absent"),
|
||||
user_key("partial"),
|
||||
],
|
||||
locks: vec![],
|
||||
});
|
||||
d.documents.insert(user_key("partial"), "{\"resources\":[{}]}".into());
|
||||
for env in ["joined", "partial", "absent"] {
|
||||
d.parameters.insert(
|
||||
user_record_parameter_name(env, &ok),
|
||||
user_record(env, "alice").to_string(),
|
||||
);
|
||||
}
|
||||
d.parameters.insert(
|
||||
user_record_parameter_name("broken", &ok),
|
||||
user_record("other", "alice").to_string(),
|
||||
);
|
||||
// `joined`'s state is not readable here: found by role.
|
||||
d.objects.as_mut().unwrap().states.retain(|k| *k != user_key("joined"));
|
||||
|
||||
let scan = run_scan(&d, &nobody_local);
|
||||
let onboarding = |n: &str| find(&scan.environments, n).onboarding.clone().unwrap();
|
||||
let joined = onboarding("joined");
|
||||
let compute = compute_of(&joined).expect("joined has compute");
|
||||
assert_eq!(compute.instance_type, "m7g.large");
|
||||
assert_eq!(compute.max_instances, 3);
|
||||
assert_eq!(compute.user_tag, "alice");
|
||||
assert_eq!(onboarding("fargate"), OnboardingState::Joined { ec2: None });
|
||||
// A record that doesn't validate is no compute.
|
||||
assert_eq!(onboarding("broken"), OnboardingState::Joined { ec2: None });
|
||||
// An incomplete onboarding keeps what its record still says.
|
||||
let partial = onboarding("partial");
|
||||
assert!(matches!(partial, OnboardingState::Incomplete { .. }), "{partial:?}");
|
||||
assert_eq!(compute_of(&partial).map(|c| c.max_instances), Some(3));
|
||||
// Not joined: the record isn't even read.
|
||||
assert_eq!(onboarding("absent"), OnboardingState::NotJoined);
|
||||
assert!(!d
|
||||
.calls()
|
||||
.contains(&format!("parameter {}", user_record_parameter_name("absent", &ok))));
|
||||
|
||||
// Serialized for the UI: the state tag plus `ec2`.
|
||||
let v = serde_json::to_value(&joined).unwrap();
|
||||
assert_eq!(v["state"], "joined");
|
||||
assert_eq!(v["ec2"]["capacity_provider"], "triple-c-joined--u-alice");
|
||||
assert_eq!(
|
||||
serde_json::to_value(OnboardingState::Joined { ec2: None }).unwrap(),
|
||||
json!({"state": "joined", "ec2": null})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_user_record_read_is_absent_valid_or_unusable() {
|
||||
let ok = user_record("dev", "alice").to_string();
|
||||
assert_eq!(user_record_from(Param::Missing, "dev", ACCOUNT, REGION), UserRecord::Absent);
|
||||
assert!(matches!(
|
||||
user_record_from(Param::Value(ok), "dev", ACCOUNT, REGION),
|
||||
UserRecord::Valid(_)
|
||||
));
|
||||
// Denied or invalid: there may be capacity, so it is not "absent".
|
||||
assert!(matches!(
|
||||
user_record_from(Param::Denied, "dev", ACCOUNT, REGION),
|
||||
UserRecord::Unusable(_)
|
||||
));
|
||||
assert!(matches!(
|
||||
user_record_from(Param::Value("{}".into()), "dev", ACCOUNT, REGION),
|
||||
UserRecord::Unusable(_)
|
||||
));
|
||||
}
|
||||
+1424
-100
File diff suppressed because it is too large.
Load diff
@@ -11,6 +11,7 @@ mod identity;
|
||||
mod live_tests;
|
||||
pub mod permissions;
|
||||
pub mod policies;
|
||||
pub mod pricing;
|
||||
#[cfg(test)]
|
||||
mod policy_eval;
|
||||
pub mod runtime;
|
||||
|
||||
@@ -37,8 +37,20 @@ impl ContextEntry {
|
||||
pub fn is_list(&self) -> bool {
|
||||
self.values.len() > 1
|
||||
}
|
||||
|
||||
/// Keys IAM types as Boolean (a `Bool` condition does not match a
|
||||
/// String-typed simulation value).
|
||||
pub fn is_boolean(&self) -> bool {
|
||||
BOOLEAN_KEYS.contains(&self.key.as_str())
|
||||
}
|
||||
}
|
||||
|
||||
/// The Boolean condition keys the checks send.
|
||||
const BOOLEAN_KEYS: &[&str] = &[
|
||||
"autoscaling:LaunchTemplateVersionSpecified",
|
||||
"ec2:IsLaunchTemplateResource",
|
||||
];
|
||||
|
||||
/// Builds the simulation for `check`: the resource and every literal context
|
||||
/// value rendered with `p`, `OwnerId` as `user_id`, and `aws:userid` =
|
||||
/// `user_id` added. A key appearing more than once becomes one entry holding
|
||||
@@ -175,7 +187,9 @@ impl PermissionApi for SdkPermissionApi {
|
||||
SdkEntry::builder()
|
||||
.context_key_name(&e.key)
|
||||
.set_context_key_values(Some(e.values.clone()))
|
||||
.context_key_type(if e.is_list() {
|
||||
.context_key_type(if e.is_boolean() {
|
||||
ContextKeyTypeEnum::Boolean
|
||||
} else if e.is_list() {
|
||||
ContextKeyTypeEnum::StringList
|
||||
} else {
|
||||
ContextKeyTypeEnum::String
|
||||
|
||||
@@ -344,6 +344,29 @@ fn a_repeated_context_key_is_one_string_list_entry() {
|
||||
);
|
||||
assert!(req.context[0].is_list());
|
||||
assert!(!req.context[1].is_list());
|
||||
assert!(!req.context[1].is_boolean());
|
||||
}
|
||||
|
||||
/// Every Boolean-typed key a check sends is one `is_boolean` knows, so the
|
||||
/// simulator gets it as Boolean (a `Bool` condition never matches a String).
|
||||
#[test]
|
||||
fn boolean_context_keys_are_sent_as_booleans() {
|
||||
let mut seen = 0;
|
||||
for tier in [Tier::WorkspaceUser, Tier::EnvironmentAdmin] {
|
||||
for c in checks(tier) {
|
||||
for (key, value) in c.context {
|
||||
if matches!(value, ContextValue::Literal("true" | "false")) {
|
||||
let e = ContextEntry {
|
||||
key: key.to_string(),
|
||||
values: vec!["true".into()],
|
||||
};
|
||||
assert!(e.is_boolean(), "{key} is sent as a String");
|
||||
seen += 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
assert!(seen >= 2, "only {seen} Boolean keys");
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -208,10 +208,11 @@ pub(crate) fn conditions_hold(stmt: &Value, req: &Request) -> bool {
|
||||
// A negated operator holds when the key is absent, and
|
||||
// otherwise when no value matches.
|
||||
let (matches, negated): (fn(&str, &str) -> bool, bool) = match base {
|
||||
"StringEquals" => (|p, v| p == v, false),
|
||||
// IAM's Bool compares "true"/"false"; the checks send strings.
|
||||
"StringEquals" | "Bool" => (|p, v| p == v, false),
|
||||
"StringLike" | "ArnLike" => (glob, false),
|
||||
"StringNotEquals" => (|p, v| p == v, true),
|
||||
"StringNotLike" => (glob, true),
|
||||
"StringNotLike" | "ArnNotLike" => (glob, true),
|
||||
other => panic!("{}: unsupported condition operator {other}", sid(stmt)),
|
||||
};
|
||||
entries
|
||||
@@ -268,6 +269,37 @@ mod tests {
|
||||
assert!(!glob(&literal, "arn:aws:ec2:us-west-2:1:elastic-ip/eipalloc-1"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bool_needs_the_key_and_bool_if_exists_does_not() {
|
||||
let stmt = |op: &str| -> Value {
|
||||
serde_json::json!({
|
||||
"Sid": "T", "Effect": "Allow", "Action": "x:Y", "Resource": "*",
|
||||
"Condition": { op: { "k:Pinned": "true" } }
|
||||
})
|
||||
};
|
||||
let holds = |op: &str, context| {
|
||||
let c = Check {
|
||||
action: "x:Y",
|
||||
resource: "*",
|
||||
context,
|
||||
write: true,
|
||||
};
|
||||
conditions_hold(
|
||||
&stmt(op),
|
||||
&Request {
|
||||
check: &c,
|
||||
caller: ME,
|
||||
owner: ME,
|
||||
},
|
||||
)
|
||||
};
|
||||
assert!(holds("Bool", &[("k:Pinned", Literal("true"))]));
|
||||
assert!(!holds("Bool", &[("k:Pinned", Literal("false"))]));
|
||||
assert!(!holds("Bool", &[]));
|
||||
assert!(holds("BoolIfExists", &[]));
|
||||
assert!(!holds("BoolIfExists", &[("k:Pinned", Literal("false"))]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn for_all_values_is_vacuous_on_an_absent_key() {
|
||||
let stmt: Value = serde_json::json!({
|
||||
|
||||
@@ -0,0 +1,684 @@
|
||||
//! The estimated hourly cost of a Fargate workspace (Q5): on-demand rates
|
||||
//! from the Price List API (`pricing:GetProducts`, service `AmazonECS`,
|
||||
//! served from us-east-1 only), cached on disk per region for a day. An EC2
|
||||
//! workspace (phase 7 E10) is priced as its instance: the `AmazonEC2`
|
||||
//! on-demand Linux, shared-tenancy price of the user's instance type, cached
|
||||
//! per region and type the same way.
|
||||
//!
|
||||
//! Everything here is best effort. A denied call, no network, a slow answer
|
||||
//! or a price list we can't read all end in "no estimate" (`None`), never an
|
||||
//! error: the estimate is a hint next to the settings, not something a start
|
||||
//! depends on.
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::future::Future;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::Mutex;
|
||||
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
||||
|
||||
use serde::de::DeserializeOwned;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::Value;
|
||||
|
||||
use crate::models::project::{Arch, AwsWorkspaceConfig, StorageMode};
|
||||
|
||||
/// The Price List API's endpoint region (it also has ap-south-1 and
|
||||
/// eu-central-1; any of them serves every region's prices).
|
||||
pub const PRICING_REGION: &str = "us-east-1";
|
||||
pub const SERVICE_CODE: &str = "AmazonECS";
|
||||
/// EC2 instances' prices (phase 7 E10).
|
||||
pub const EC2_SERVICE_CODE: &str = "AmazonEC2";
|
||||
/// How long a region's rates are used before they are fetched again.
|
||||
pub const CACHE_TTL: Duration = Duration::from_secs(24 * 60 * 60);
|
||||
/// The whole fetch (every page), so the command answers quickly offline.
|
||||
pub const FETCH_TIMEOUT: Duration = Duration::from_secs(8);
|
||||
/// After a failed fetch, the region is not asked again for this long (the
|
||||
/// settings call the estimate on every change).
|
||||
pub const RETRY_AFTER_FAILURE: Duration = Duration::from_secs(5 * 60);
|
||||
/// Fargate includes 20 GiB of ephemeral storage; only the rest is billed.
|
||||
pub const FREE_EPHEMERAL_GIB: u32 = 20;
|
||||
/// The filtered list is 8 rows (one page); more pages than this is not a
|
||||
/// price list we understand.
|
||||
const MAX_PAGES: usize = 5;
|
||||
|
||||
/// `GetProducts` filters as (type, field, value); `{region}` is the
|
||||
/// workspace's region. Verified against the live API (2026-11-16): eight
|
||||
/// rows per region — Linux x86 and ARM vCPU-hours and GB-hours, ephemeral
|
||||
/// storage GB-hours and three Windows rows, which the parser skips.
|
||||
pub const FILTERS: &[(&str, &str, &str)] = &[
|
||||
("TERM_MATCH", "regionCode", "{region}"),
|
||||
("TERM_MATCH", "termType", "OnDemand"),
|
||||
("CONTAINS", "usagetype", "Fargate"),
|
||||
];
|
||||
|
||||
/// `GetProducts` filters for one EC2 instance type's on-demand Linux price
|
||||
/// (`{region}`, `{instance_type}` filled in). Verified against the live API
|
||||
/// (2026-11-16): exactly one row per type and region (`USW2-BoxUsage:m7i.large`,
|
||||
/// $0.1008/hour), carrying both its OnDemand and Reserved terms.
|
||||
pub const EC2_FILTERS: &[(&str, &str, &str)] = &[
|
||||
("TERM_MATCH", "regionCode", "{region}"),
|
||||
("TERM_MATCH", "instanceType", "{instance_type}"),
|
||||
("TERM_MATCH", "operatingSystem", "Linux"),
|
||||
("TERM_MATCH", "tenancy", "Shared"),
|
||||
("TERM_MATCH", "preInstalledSw", "NA"),
|
||||
("TERM_MATCH", "capacitystatus", "Used"),
|
||||
("TERM_MATCH", "licenseModel", "No License required"),
|
||||
];
|
||||
|
||||
/// `GetProducts` filters for gp3 EBS storage in `{region}`. Verified against
|
||||
/// the live API (2026-11-16): one row (`USW2-EBS:VolumeUsage.gp3`, $0.08 per
|
||||
/// GB-month).
|
||||
pub const GP3_FILTERS: &[(&str, &str, &str)] = &[
|
||||
("TERM_MATCH", "regionCode", "{region}"),
|
||||
("TERM_MATCH", "productFamily", "Storage"),
|
||||
("TERM_MATCH", "volumeApiName", "gp3"),
|
||||
];
|
||||
|
||||
/// The EC2 instance's root volume (`ec2.tf`'s `volume_size`, gp3), billed
|
||||
/// while the instance exists.
|
||||
pub const EC2_ROOT_VOLUME_GIB: u32 = 50;
|
||||
|
||||
/// Hours in a billing month, as AWS converts GB-month prices.
|
||||
pub const HOURS_PER_MONTH: f64 = 730.0;
|
||||
|
||||
/// One `GetProducts` query: a service and its filters, values filled in.
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub struct Query {
|
||||
pub service_code: &'static str,
|
||||
pub filters: Vec<(&'static str, &'static str, String)>,
|
||||
}
|
||||
|
||||
fn fill(filters: &[(&'static str, &'static str, &str)], vars: &[(&str, &str)]) -> Vec<(&'static str, &'static str, String)> {
|
||||
filters
|
||||
.iter()
|
||||
.map(|(kind, field, value)| {
|
||||
let value = vars
|
||||
.iter()
|
||||
.fold(value.to_string(), |v, (name, with)| v.replace(&format!("{{{name}}}"), with));
|
||||
(*kind, *field, value)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The Fargate rates of `region` ([`FILTERS`]).
|
||||
pub fn fargate_query(region: &str) -> Query {
|
||||
Query {
|
||||
service_code: SERVICE_CODE,
|
||||
filters: fill(FILTERS, &[("region", region)]),
|
||||
}
|
||||
}
|
||||
|
||||
/// The on-demand price of `instance_type` in `region` ([`EC2_FILTERS`]).
|
||||
pub fn ec2_query(region: &str, instance_type: &str) -> Query {
|
||||
Query {
|
||||
service_code: EC2_SERVICE_CODE,
|
||||
filters: fill(EC2_FILTERS, &[("region", region), ("instance_type", instance_type)]),
|
||||
}
|
||||
}
|
||||
|
||||
/// The gp3 storage price of `region` ([`GP3_FILTERS`]).
|
||||
pub fn gp3_query(region: &str) -> Query {
|
||||
Query {
|
||||
service_code: EC2_SERVICE_CODE,
|
||||
filters: fill(GP3_FILTERS, &[("region", region)]),
|
||||
}
|
||||
}
|
||||
|
||||
/// One architecture's on-demand rates in a region, in USD.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
|
||||
pub struct FargateRates {
|
||||
pub vcpu_hour: f64,
|
||||
pub gb_hour: f64,
|
||||
pub storage_gb_hour: f64,
|
||||
}
|
||||
|
||||
/// A region's rates per architecture. An architecture the price list did
|
||||
/// not fully cover is `None`.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
|
||||
pub struct RegionRates {
|
||||
pub x86_64: Option<FargateRates>,
|
||||
pub arm64: Option<FargateRates>,
|
||||
}
|
||||
|
||||
impl RegionRates {
|
||||
pub fn for_arch(&self, arch: Arch) -> Option<FargateRates> {
|
||||
match arch {
|
||||
Arch::X86_64 => self.x86_64,
|
||||
Arch::Arm64 => self.arm64,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// What the UI shows: the on-demand price per hour of the task while it
|
||||
/// runs. A gateway sidecar shares the task's CPU and memory, so it adds
|
||||
/// nothing; Spot isn't in the Price List API (`note_spot`: say it is
|
||||
/// usually cheaper); EFS is billed per GB-month, not per hour
|
||||
/// (`efs_billed_separately`). `ec2_instance`: the figure is the user's EC2
|
||||
/// instance's hourly price, whatever the project reserves of it, and
|
||||
/// instances scale to zero when no workspace is running (E10);
|
||||
/// `root_volume_included`: it also has the instance's 50 GiB gp3 root
|
||||
/// volume (when its price could be read). An instance's public IPv4
|
||||
/// address (public-mode environments) is never in it.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Serialize)]
|
||||
pub struct HourlyEstimate {
|
||||
pub usd_per_hour: f64,
|
||||
pub note_spot: bool,
|
||||
pub efs_billed_separately: bool,
|
||||
pub ec2_instance: bool,
|
||||
pub root_volume_included: bool,
|
||||
}
|
||||
|
||||
pub fn estimate(cfg: &AwsWorkspaceConfig, rates: &FargateRates) -> HourlyEstimate {
|
||||
let vcpu = f64::from(cfg.cpu) / 1024.0;
|
||||
let gb = f64::from(cfg.memory_mib) / 1024.0;
|
||||
let billed_storage = f64::from(cfg.ephemeral_gib.saturating_sub(FREE_EPHEMERAL_GIB));
|
||||
HourlyEstimate {
|
||||
usd_per_hour: vcpu * rates.vcpu_hour
|
||||
+ gb * rates.gb_hour
|
||||
+ billed_storage * rates.storage_gb_hour,
|
||||
note_spot: cfg.spot,
|
||||
efs_billed_separately: cfg.storage != StorageMode::Ephemeral,
|
||||
ec2_instance: false,
|
||||
root_volume_included: false,
|
||||
}
|
||||
}
|
||||
|
||||
/// An EC2 project's estimate: its instance's on-demand hourly price — the
|
||||
/// instance is billed whole while it runs, so the reservations, the
|
||||
/// ephemeral size and Spot (none on EC2) change nothing — plus its
|
||||
/// [`EC2_ROOT_VOLUME_GIB`] gp3 root volume at `gp3_usd_per_gb_month` (per
|
||||
/// hour, over [`HOURS_PER_MONTH`]) when that price is known.
|
||||
pub fn estimate_ec2(
|
||||
cfg: &AwsWorkspaceConfig,
|
||||
instance_usd_per_hour: f64,
|
||||
gp3_usd_per_gb_month: Option<f64>,
|
||||
) -> HourlyEstimate {
|
||||
let root = gp3_usd_per_gb_month.map(|p| f64::from(EC2_ROOT_VOLUME_GIB) * p / HOURS_PER_MONTH);
|
||||
HourlyEstimate {
|
||||
usd_per_hour: instance_usd_per_hour + root.unwrap_or(0.0),
|
||||
note_spot: false,
|
||||
efs_billed_separately: cfg.storage != StorageMode::Ephemeral,
|
||||
ec2_instance: true,
|
||||
root_volume_included: root.is_some(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The gp3 storage price per GB-month in a [`GP3_FILTERS`] price list for
|
||||
/// `region`; `None` when no row matches.
|
||||
pub fn parse_gp3_price(region: &str, items: &[String]) -> Option<f64> {
|
||||
items.iter().find_map(|item| {
|
||||
let product = serde_json::from_str::<Value>(item).ok()?;
|
||||
let attrs = &product["product"]["attributes"];
|
||||
let is = |k: &str, v: &str| attrs[k].as_str() == Some(v);
|
||||
if !(is("regionCode", region) && is("volumeApiName", "gp3")) {
|
||||
return None;
|
||||
}
|
||||
on_demand_usd(&product).filter(|p| *p > 0.0)
|
||||
})
|
||||
}
|
||||
|
||||
/// The on-demand hourly price of `instance_type` (Linux, shared tenancy) in
|
||||
/// an `AmazonEC2` price list for `region`. The filters already narrow it to
|
||||
/// one row; the attributes are checked again so a looser answer can't price
|
||||
/// the wrong product. `None` when no row matches.
|
||||
pub fn parse_ec2_price(region: &str, instance_type: &str, items: &[String]) -> Option<f64> {
|
||||
items.iter().find_map(|item| {
|
||||
let product = serde_json::from_str::<Value>(item).ok()?;
|
||||
let attrs = &product["product"]["attributes"];
|
||||
let is = |k: &str, v: &str| attrs[k].as_str() == Some(v);
|
||||
let matches = is("regionCode", region)
|
||||
&& is("instanceType", instance_type)
|
||||
&& is("operatingSystem", "Linux")
|
||||
&& is("tenancy", "Shared")
|
||||
&& is("preInstalledSw", "NA")
|
||||
&& is("capacitystatus", "Used")
|
||||
&& is("licenseModel", "No License required");
|
||||
if !matches {
|
||||
return None;
|
||||
}
|
||||
on_demand_usd(&product).filter(|p| *p > 0.0)
|
||||
})
|
||||
}
|
||||
|
||||
/// Whether `instance_type` is safe in a cache file name and a filter value
|
||||
/// (`m7i.large`): lowercase letters, digits, one dot.
|
||||
fn plain_instance_type(instance_type: &str) -> bool {
|
||||
instance_type.split_once('.').is_some_and(|(family, size)| {
|
||||
let ok = |s: &str| !s.is_empty() && s.bytes().all(|b| b.is_ascii_lowercase() || b.is_ascii_digit());
|
||||
ok(family) && ok(size)
|
||||
}) && instance_type.len() <= 32
|
||||
}
|
||||
|
||||
/// The rates in a `GetProducts` price list (each item one product's JSON)
|
||||
/// for `region`. `None` when no architecture is complete.
|
||||
pub fn parse_price_list(region: &str, items: &[String]) -> Option<RegionRates> {
|
||||
#[derive(Default)]
|
||||
struct Partial {
|
||||
vcpu: Option<f64>,
|
||||
gb: Option<f64>,
|
||||
}
|
||||
let (mut x86, mut arm, mut storage) = (Partial::default(), Partial::default(), None);
|
||||
for item in items {
|
||||
let Ok(product) = serde_json::from_str::<Value>(item) else {
|
||||
continue;
|
||||
};
|
||||
let attrs = &product["product"]["attributes"];
|
||||
if attrs["regionCode"].as_str() != Some(region) {
|
||||
continue;
|
||||
}
|
||||
if attrs["operatingSystem"]
|
||||
.as_str()
|
||||
.is_some_and(|os| os != "Linux")
|
||||
{
|
||||
continue;
|
||||
}
|
||||
let Some(usage) = attrs["usagetype"].as_str() else {
|
||||
continue;
|
||||
};
|
||||
// `USW2-Fargate-ARM-vCPU-Hours:perCPU`; us-east-1's prefix is
|
||||
// `USE1-`, Ireland's `EU-`.
|
||||
let Some((_, kind)) = usage.split_once("Fargate-") else {
|
||||
continue;
|
||||
};
|
||||
let slot = match kind {
|
||||
"vCPU-Hours:perCPU" => &mut x86.vcpu,
|
||||
"GB-Hours" => &mut x86.gb,
|
||||
"ARM-vCPU-Hours:perCPU" => &mut arm.vcpu,
|
||||
"ARM-GB-Hours" => &mut arm.gb,
|
||||
"EphemeralStorage-GB-Hours" => &mut storage,
|
||||
_ => continue,
|
||||
};
|
||||
if slot.is_none() {
|
||||
*slot = on_demand_usd(&product);
|
||||
}
|
||||
}
|
||||
let storage = storage?;
|
||||
let complete = |p: Partial| {
|
||||
Some(FargateRates {
|
||||
vcpu_hour: p.vcpu?,
|
||||
gb_hour: p.gb?,
|
||||
storage_gb_hour: storage,
|
||||
})
|
||||
};
|
||||
let rates = RegionRates {
|
||||
x86_64: complete(x86),
|
||||
arm64: complete(arm),
|
||||
};
|
||||
(rates.x86_64.is_some() || rates.arm64.is_some()).then_some(rates)
|
||||
}
|
||||
|
||||
/// The product's on-demand USD price per unit. A price list gives one term
|
||||
/// with one dimension for these rows; anything not a sane non-negative
|
||||
/// number is ignored.
|
||||
fn on_demand_usd(product: &Value) -> Option<f64> {
|
||||
product["terms"]["OnDemand"]
|
||||
.as_object()?
|
||||
.values()
|
||||
.filter_map(|term| term["priceDimensions"].as_object())
|
||||
.flat_map(|dims| dims.values())
|
||||
.filter_map(|d| d["pricePerUnit"]["USD"].as_str()?.parse::<f64>().ok())
|
||||
.find(|p| p.is_finite() && (0.0..100.0).contains(p))
|
||||
}
|
||||
|
||||
/// One page of `GetProducts`.
|
||||
pub struct Page {
|
||||
pub items: Vec<String>,
|
||||
pub next_token: Option<String>,
|
||||
}
|
||||
|
||||
/// The Price List API, faked in tests.
|
||||
pub trait PricingApi {
|
||||
/// One page of the products `query` matches.
|
||||
fn get_products(
|
||||
&self,
|
||||
query: &Query,
|
||||
next_token: Option<String>,
|
||||
) -> impl Future<Output = Result<Page, String>> + Send;
|
||||
}
|
||||
|
||||
/// The real thing: a client in [`PRICING_REGION`] from a connection's
|
||||
/// `SdkConfig` (`aws::sdk_config(conn, PRICING_REGION)`).
|
||||
pub struct SdkPricingApi {
|
||||
client: aws_sdk_pricing::Client,
|
||||
}
|
||||
|
||||
impl SdkPricingApi {
|
||||
pub fn new(cfg: &aws_config::SdkConfig) -> Self {
|
||||
Self {
|
||||
client: aws_sdk_pricing::Client::new(cfg),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl PricingApi for SdkPricingApi {
|
||||
async fn get_products(&self, query: &Query, next_token: Option<String>) -> Result<Page, String> {
|
||||
use aws_sdk_pricing::types::{Filter, FilterType};
|
||||
let mut req = self
|
||||
.client
|
||||
.get_products()
|
||||
.service_code(query.service_code)
|
||||
.format_version("aws_v1")
|
||||
.max_results(100)
|
||||
.set_next_token(next_token);
|
||||
for (kind, field, value) in &query.filters {
|
||||
let filter = Filter::builder()
|
||||
.r#type(FilterType::from(*kind))
|
||||
.field(*field)
|
||||
.value(value)
|
||||
.build()
|
||||
.map_err(|e| e.to_string())?;
|
||||
req = req.filters(filter);
|
||||
}
|
||||
let out = req
|
||||
.send()
|
||||
.await
|
||||
.map_err(|e| super::classify_sdk_error("pricing:GetProducts", &e).to_string())?;
|
||||
Ok(Page {
|
||||
items: out.price_list().to_vec(),
|
||||
next_token: out.next_token().map(str::to_string),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// Every page `query` matches.
|
||||
async fn fetch_items<A: PricingApi>(api: &A, query: &Query) -> Result<Vec<String>, String> {
|
||||
let mut items = Vec::new();
|
||||
let mut token = None;
|
||||
for _ in 0..MAX_PAGES {
|
||||
let page = api.get_products(query, token).await?;
|
||||
items.extend(page.items);
|
||||
token = page.next_token.filter(|t| !t.is_empty());
|
||||
if token.is_none() {
|
||||
return Ok(items);
|
||||
}
|
||||
}
|
||||
Err(format!("the {} price list has more than {MAX_PAGES} pages", query.service_code))
|
||||
}
|
||||
|
||||
/// Every page for `region`, parsed (the live tests' direct call).
|
||||
#[cfg_attr(not(test), allow(dead_code))]
|
||||
pub async fn fetch_rates<A: PricingApi>(api: &A, region: &str) -> Result<RegionRates, String> {
|
||||
let items = fetch_items(api, &fargate_query(region)).await?;
|
||||
parse_price_list(region, &items).ok_or_else(|| format!("no Fargate rates for {region} in the price list"))
|
||||
}
|
||||
|
||||
/// The on-demand hourly price of `instance_type` in `region` (the live
|
||||
/// tests' direct call).
|
||||
#[cfg_attr(not(test), allow(dead_code))]
|
||||
pub async fn fetch_ec2_price<A: PricingApi>(api: &A, region: &str, instance_type: &str) -> Result<f64, String> {
|
||||
if !plain_instance_type(instance_type) {
|
||||
return Err(format!("{instance_type:?} is not an instance type"));
|
||||
}
|
||||
let items = fetch_items(api, &ec2_query(region, instance_type)).await?;
|
||||
parse_ec2_price(region, instance_type, &items)
|
||||
.ok_or_else(|| format!("no {instance_type} price for {region} in the price list"))
|
||||
}
|
||||
|
||||
/// One cached answer: Fargate rates under `<region>.json`, an instance's
|
||||
/// price under `<region>--ec2-<type>.json`. `key` is what the file must say
|
||||
/// it holds (the region, or `<region> <type>`), and what failures are
|
||||
/// remembered under.
|
||||
struct CacheKey {
|
||||
key: String,
|
||||
file: String,
|
||||
}
|
||||
|
||||
impl CacheKey {
|
||||
fn fargate(region: &str) -> Self {
|
||||
Self {
|
||||
key: region.to_string(),
|
||||
file: format!("{region}.json"),
|
||||
}
|
||||
}
|
||||
fn ec2(region: &str, instance_type: &str) -> Self {
|
||||
Self {
|
||||
key: format!("{region} {instance_type}"),
|
||||
file: format!("{region}--ec2-{instance_type}.json"),
|
||||
}
|
||||
}
|
||||
fn gp3(region: &str) -> Self {
|
||||
Self {
|
||||
key: format!("{region} gp3"),
|
||||
file: format!("{region}--ebs-gp3.json"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A cache file. `key` was `region` before EC2 prices were cached too (an
|
||||
/// older file still reads).
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
struct CacheFile<V> {
|
||||
#[serde(alias = "region")]
|
||||
key: String,
|
||||
/// Unix seconds.
|
||||
fetched_at: u64,
|
||||
rates: V,
|
||||
}
|
||||
|
||||
/// The per-region rate files and the memory of recent failures.
|
||||
pub struct RatesCache {
|
||||
dir: PathBuf,
|
||||
failed_at: Mutex<HashMap<String, SystemTime>>,
|
||||
}
|
||||
|
||||
/// `<data dir>/triple-c/aws-pricing/`.
|
||||
pub fn default_cache_dir() -> Option<PathBuf> {
|
||||
Some(dirs::data_dir()?.join("triple-c").join("aws-pricing"))
|
||||
}
|
||||
|
||||
fn unix_secs(t: SystemTime) -> u64 {
|
||||
t.duration_since(UNIX_EPOCH).map_or(0, |d| d.as_secs())
|
||||
}
|
||||
|
||||
impl RatesCache {
|
||||
pub fn new(dir: PathBuf) -> Self {
|
||||
Self {
|
||||
dir,
|
||||
failed_at: Mutex::new(HashMap::new()),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub fn dir(&self) -> &Path {
|
||||
&self.dir
|
||||
}
|
||||
|
||||
/// The cached rates and whether they are still fresh at `now`. A
|
||||
/// missing, unreadable or corrupt file, or one for another region, is
|
||||
/// no cache. The region must already be validated (it names a file).
|
||||
pub fn read(&self, region: &str, now: SystemTime) -> Option<(RegionRates, bool)> {
|
||||
self.read_key(&CacheKey::fargate(region), now)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub fn write(&self, region: &str, rates: &RegionRates, now: SystemTime) -> Result<(), String> {
|
||||
self.write_key(&CacheKey::fargate(region), rates, now)
|
||||
}
|
||||
|
||||
/// [`Self::read`] for an instance type's hourly price.
|
||||
pub fn read_ec2(&self, region: &str, instance_type: &str, now: SystemTime) -> Option<(f64, bool)> {
|
||||
if !plain_instance_type(instance_type) {
|
||||
return None;
|
||||
}
|
||||
self.read_key(&CacheKey::ec2(region, instance_type), now)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub fn write_ec2(&self, region: &str, instance_type: &str, usd_per_hour: f64, now: SystemTime) -> Result<(), String> {
|
||||
if !plain_instance_type(instance_type) {
|
||||
return Err(format!("{instance_type:?} is not an instance type"));
|
||||
}
|
||||
self.write_key(&CacheKey::ec2(region, instance_type), &usd_per_hour, now)
|
||||
}
|
||||
|
||||
fn read_key<V: DeserializeOwned>(&self, key: &CacheKey, now: SystemTime) -> Option<(V, bool)> {
|
||||
let text = std::fs::read_to_string(self.dir.join(&key.file)).ok()?;
|
||||
let file: CacheFile<V> = serde_json::from_str(&text).ok()?;
|
||||
if file.key != key.key {
|
||||
return None;
|
||||
}
|
||||
let now = unix_secs(now);
|
||||
// A timestamp from the future (a clock change) counts as stale.
|
||||
let fresh = file.fetched_at <= now && now - file.fetched_at < CACHE_TTL.as_secs();
|
||||
Some((file.rates, fresh))
|
||||
}
|
||||
|
||||
fn write_key<V: Serialize>(&self, key: &CacheKey, rates: &V, now: SystemTime) -> Result<(), String> {
|
||||
std::fs::create_dir_all(&self.dir).map_err(|e| e.to_string())?;
|
||||
let file = CacheFile {
|
||||
key: key.key.clone(),
|
||||
fetched_at: unix_secs(now),
|
||||
rates,
|
||||
};
|
||||
let text = serde_json::to_string_pretty(&file).map_err(|e| e.to_string())?;
|
||||
// Write then rename, so a concurrent reader never sees half a file.
|
||||
let tmp = self
|
||||
.dir
|
||||
.join(format!(".{}.tmp-{}", key.file, std::process::id()));
|
||||
std::fs::write(&tmp, text).map_err(|e| e.to_string())?;
|
||||
std::fs::rename(&tmp, self.dir.join(&key.file)).map_err(|e| {
|
||||
let _ = std::fs::remove_file(&tmp);
|
||||
e.to_string()
|
||||
})
|
||||
}
|
||||
|
||||
fn recently_failed(&self, region: &str, now: SystemTime) -> bool {
|
||||
let map = self.failed_at.lock().unwrap_or_else(|e| e.into_inner());
|
||||
map.get(region).is_some_and(|t| {
|
||||
now.duration_since(*t)
|
||||
.is_ok_and(|age| age < RETRY_AFTER_FAILURE)
|
||||
})
|
||||
}
|
||||
|
||||
fn note_failure(&self, region: &str, now: SystemTime, failed: bool) {
|
||||
let mut map = self.failed_at.lock().unwrap_or_else(|e| e.into_inner());
|
||||
if failed {
|
||||
map.insert(region.to_string(), now);
|
||||
} else {
|
||||
map.remove(region);
|
||||
}
|
||||
}
|
||||
|
||||
/// Fresh cached rates, else a fetch (bounded by [`FETCH_TIMEOUT`])
|
||||
/// that refreshes the cache, else the stale cache, else `None`. `api`
|
||||
/// is `None` when no client could be built (the stale cache still
|
||||
/// answers). A region whose fetch failed is not asked again for
|
||||
/// [`RETRY_AFTER_FAILURE`].
|
||||
pub async fn rates<A: PricingApi>(
|
||||
&self,
|
||||
api: Option<&A>,
|
||||
region: &str,
|
||||
now: SystemTime,
|
||||
) -> Option<RegionRates> {
|
||||
self.rates_with::<A, _>(async { api }, region, now).await
|
||||
}
|
||||
|
||||
/// [`Self::rates`] with the client built by `api`, which is awaited only
|
||||
/// when the cache can't answer, and within the same [`FETCH_TIMEOUT`] as
|
||||
/// the fetch (building one reads credentials, which can hang too).
|
||||
pub async fn rates_with<A: PricingApi, B: std::borrow::Borrow<A>>(
|
||||
&self,
|
||||
api: impl Future<Output = Option<B>>,
|
||||
region: &str,
|
||||
now: SystemTime,
|
||||
) -> Option<RegionRates> {
|
||||
let parse = |items: &[String]| {
|
||||
parse_price_list(region, items).ok_or_else(|| format!("no Fargate rates for {region} in the price list"))
|
||||
};
|
||||
self.cached::<A, B, _>(&CacheKey::fargate(region), api, fargate_query(region), parse, now)
|
||||
.await
|
||||
}
|
||||
|
||||
/// [`Self::rates_with`] for `instance_type`'s on-demand hourly price in
|
||||
/// `region` (E10): the same cache rules, failure back-off and timeout.
|
||||
pub async fn ec2_price_with<A: PricingApi, B: std::borrow::Borrow<A>>(
|
||||
&self,
|
||||
api: impl Future<Output = Option<B>>,
|
||||
region: &str,
|
||||
instance_type: &str,
|
||||
now: SystemTime,
|
||||
) -> Option<f64> {
|
||||
if !plain_instance_type(instance_type) {
|
||||
return None;
|
||||
}
|
||||
let parse = |items: &[String]| {
|
||||
parse_ec2_price(region, instance_type, items)
|
||||
.ok_or_else(|| format!("no {instance_type} price for {region} in the price list"))
|
||||
};
|
||||
let query = ec2_query(region, instance_type);
|
||||
self.cached::<A, B, _>(&CacheKey::ec2(region, instance_type), api, query, parse, now)
|
||||
.await
|
||||
}
|
||||
|
||||
/// [`Self::rates_with`] for `region`'s gp3 storage price per GB-month
|
||||
/// (an EC2 instance's root volume).
|
||||
pub async fn gp3_price_with<A: PricingApi, B: std::borrow::Borrow<A>>(
|
||||
&self,
|
||||
api: impl Future<Output = Option<B>>,
|
||||
region: &str,
|
||||
now: SystemTime,
|
||||
) -> Option<f64> {
|
||||
let parse = |items: &[String]| {
|
||||
parse_gp3_price(region, items).ok_or_else(|| format!("no gp3 price for {region} in the price list"))
|
||||
};
|
||||
self.cached::<A, B, _>(&CacheKey::gp3(region), api, gp3_query(region), parse, now)
|
||||
.await
|
||||
}
|
||||
|
||||
/// Fresh cache, else a fetch of `query` (client build included, within
|
||||
/// [`FETCH_TIMEOUT`]) parsed by `parse` that refreshes the cache, else
|
||||
/// the stale cache, else `None`; a key whose fetch failed is not asked
|
||||
/// again for [`RETRY_AFTER_FAILURE`].
|
||||
async fn cached<A: PricingApi, B: std::borrow::Borrow<A>, V: Serialize + DeserializeOwned + Clone>(
|
||||
&self,
|
||||
key: &CacheKey,
|
||||
api: impl Future<Output = Option<B>>,
|
||||
query: Query,
|
||||
parse: impl FnOnce(&[String]) -> Result<V, String>,
|
||||
now: SystemTime,
|
||||
) -> Option<V> {
|
||||
let cached = self.read_key::<V>(key, now);
|
||||
let stale = match cached {
|
||||
Some((rates, true)) => return Some(rates),
|
||||
Some((rates, false)) => Some(rates),
|
||||
None => None,
|
||||
};
|
||||
let what = &key.key;
|
||||
if self.recently_failed(what, now) {
|
||||
return stale;
|
||||
}
|
||||
let fetch = async {
|
||||
let api = api.await?;
|
||||
Some(fetch_items(api.borrow(), &query).await.and_then(|items| parse(&items)))
|
||||
};
|
||||
let fetched = match tokio::time::timeout(FETCH_TIMEOUT, fetch).await {
|
||||
Ok(Some(r)) => r,
|
||||
// No client could be built: a failure like any other (building
|
||||
// one reads credentials, which can be slow), and the stale cache
|
||||
// answers.
|
||||
Ok(None) => {
|
||||
log::info!("No prices for {what}: no Pricing client could be built");
|
||||
self.note_failure(what, now, true);
|
||||
return stale;
|
||||
}
|
||||
Err(_) => Err(format!("timed out after {}s", FETCH_TIMEOUT.as_secs())),
|
||||
};
|
||||
match fetched {
|
||||
Ok(rates) => {
|
||||
self.note_failure(what, now, false);
|
||||
if let Err(e) = self.write_key(key, &rates, now) {
|
||||
log::warn!("Could not cache the prices for {what}: {e}");
|
||||
}
|
||||
Some(rates)
|
||||
}
|
||||
Err(e) => {
|
||||
log::info!("No prices for {what}: {e}");
|
||||
self.note_failure(what, now, true);
|
||||
stale
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"PriceList": [
|
||||
"{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"maxThroughputvolume\":\"2000 MiB/s\",\"volumeType\":\"General Purpose\",\"maxIopsvolume\":\"80000\",\"usagetype\":\"USW2-EBS:VolumeUsage.gp3\",\"locationType\":\"AWS Region\",\"maxVolumeSize\":\"64 TiB\",\"storageMedia\":\"SSD-backed\",\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonEC2\",\"volumeApiName\":\"gp3\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"operation\":\"\",\"group\":\"EBS Storage\"},\"sku\":\"BB8UJWJ4XPFJB95G\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"BB8UJWJ4XPFJB95G.JRTCKXETXF\":{\"priceDimensions\":{\"BB8UJWJ4XPFJB95G.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.08 per GB-month of General Purpose (gp3) provisioned storage - US West (Oregon)\",\"appliesTo\":[],\"rateCode\":\"BB8UJWJ4XPFJB95G.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0800000000\"}}},\"sku\":\"BB8UJWJ4XPFJB95G\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261114012926\",\"publicationDate\":\"2026-11-14T01:29:26Z\"}"
|
||||
],
|
||||
"FormatVersion": "aws_v1"
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"FormatVersion": "aws_v1",
|
||||
"PriceList": [
|
||||
"{\"product\":{\"productFamily\":\"Compute Instance\",\"attributes\":{\"enhancedNetworkingSupported\":\"Yes\",\"intelTurboAvailable\":\"Yes\",\"memory\":\"8 GiB\",\"dedicatedEbsThroughput\":\"Up to 10000 Mbps\",\"vcpu\":\"2\",\"classicnetworkingsupport\":\"false\",\"capacitystatus\":\"Used\",\"locationType\":\"AWS Region\",\"storage\":\"EBS only\",\"instanceFamily\":\"General purpose\",\"operatingSystem\":\"Linux\",\"intelAvx2Available\":\"Yes\",\"instanceFamilyCategory\":\"General Purpose\",\"regionCode\":\"us-west-2\",\"physicalProcessor\":\"Intel Xeon Scalable (Sapphire Rapids)\",\"clockSpeed\":\"3.2 GHz\",\"ecu\":\"NA\",\"networkPerformance\":\"Up to 12500 Megabit\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"gpuMemory\":\"NA\",\"dedicatedEbsThroughputDescription\":\"650 Mbps\",\"vpcnetworkingsupport\":\"true\",\"instanceType\":\"m7i.large\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-BoxUsage:m7i.large\",\"normalizationSizeFactor\":\"4\",\"intelAvxAvailable\":\"Yes\",\"processorFeatures\":\"Intel AVX; Intel AVX2; Intel AVX512; Intel Turbo; Intel AMX\",\"servicecode\":\"AmazonEC2\",\"licenseModel\":\"No License required\",\"currentGeneration\":\"Yes\",\"preInstalledSw\":\"NA\",\"location\":\"US West (Oregon)\",\"processorArchitecture\":\"64-bit\",\"marketoption\":\"OnDemand\",\"operation\":\"RunInstances\",\"availabilityzone\":\"NA\"},\"sku\":\"76SYQ5S6SHTVH6CA\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"76SYQ5S6SHTVH6CA.JRTCKXETXF\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"$0.1008 per On Demand Linux m7i.large Instance Hour\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1008000000\"}}},\"sku\":\"76SYQ5S6SHTVH6CA\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}},\"Reserved\":{\"76SYQ5S6SHTVH6CA.VJWZNREJX2\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.VJWZNREJX2.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"USD 0.0 per Linux/UNIX (Amazon VPC), m7i.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.VJWZNREJX2.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0000000000\"}},\"76SYQ5S6SHTVH6CA.VJWZNREJX2.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.VJWZNREJX2.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"605\"}}},\"sku\":\"76SYQ5S6SHTVH6CA\",\"effectiveDate\":\"2026-11-14T01:50:11Z\",\"offerTermCode\":\"VJWZNREJX2\",\"termAttributes\":{\"LeaseContractLength\":\"1yr\",\"OfferingClass\":\"convertible\",\"PurchaseOption\":\"All Upfront\"}},\"76SYQ5S6SHTVH6CA.BPH4J8HBKS\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.BPH4J8HBKS.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7i.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.BPH4J8HBKS.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0457200000\"}}},\"sku\":\"76SYQ5S6SHTVH6CA\",\"effectiveDate\":\"2026-11-14T01:50:09Z\",\"offerTermCode\":\"BPH4J8HBKS\",\"termAttributes\":{\"LeaseContractLength\":\"3yr\",\"OfferingClass\":\"standard\",\"PurchaseOption\":\"No Upfront\"}},\"76SYQ5S6SHTVH6CA.NQ3QZPMQV9\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.NQ3QZPMQV9.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"USD 0.0 per Linux/UNIX (Amazon VPC), m7i.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.NQ3QZPMQV9.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0000000000\"}},\"76SYQ5S6SHTVH6CA.NQ3QZPMQV9.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.NQ3QZPMQV9.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"1046\"}}},\"sku\":\"76SYQ5S6SHTVH6CA\",\"effectiveDate\":\"2026-11-14T01:50:12Z\",\"offerTermCode\":\"NQ3QZPMQV9\",\"termAttributes\":{\"LeaseContractLength\":\"3yr\",\"OfferingClass\":\"standard\",\"PurchaseOption\":\"All Upfront\"}},\"76SYQ5S6SHTVH6CA.HU7G6KETJZ\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.HU7G6KETJZ.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7i.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.HU7G6KETJZ.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0317500000\"}},\"76SYQ5S6SHTVH6CA.HU7G6KETJZ.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"76SYQ5S6SHTVH6CA.HU7G6KETJZ.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"278\"}}},\"sku\":\"76SYQ5S6SHTVH6CA\",\"effectiveDate\":\"2026-11-14T01:50:08Z\",\"offerTermCode\":\"HU7G6KETJZ\",\"termAttributes\":{\"LeaseContractLength\":\"1yr\",\"OfferingClass\":\"standard\",\"PurchaseOption\":\"Partial Upfront\"}},\"76SYQ5S6SHTVH6CA.38NPMPTW36\":{\"priceDimensions\":{\"76SYQ5S6SHTVH6CA.Line truncated
|
||||
"{\"product\":{\"productFamily\":\"Compute Instance\",\"attributes\":{\"enhancedNetworkingSupported\":\"Yes\",\"intelTurboAvailable\":\"No\",\"memory\":\"8 GiB\",\"dedicatedEbsThroughput\":\"Up to 10000 Mbps\",\"vcpu\":\"2\",\"classicnetworkingsupport\":\"false\",\"capacitystatus\":\"Used\",\"locationType\":\"AWS Region\",\"storage\":\"EBS only\",\"instanceFamily\":\"General purpose\",\"operatingSystem\":\"Linux\",\"intelAvx2Available\":\"No\",\"instanceFamilyCategory\":\"General Purpose\",\"regionCode\":\"us-west-2\",\"physicalProcessor\":\"AWS Graviton3 Processor\",\"clockSpeed\":\"2.5 GHz\",\"ecu\":\"NA\",\"networkPerformance\":\"Up to 12500 Megabit\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"gpuMemory\":\"NA\",\"dedicatedEbsThroughputDescription\":\"630 Mbps\",\"vpcnetworkingsupport\":\"true\",\"instanceType\":\"m7g.large\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-BoxUsage:m7g.large\",\"normalizationSizeFactor\":\"4\",\"intelAvxAvailable\":\"No\",\"servicecode\":\"AmazonEC2\",\"licenseModel\":\"No License required\",\"currentGeneration\":\"Yes\",\"preInstalledSw\":\"NA\",\"location\":\"US West (Oregon)\",\"processorArchitecture\":\"64-bit\",\"marketoption\":\"OnDemand\",\"operation\":\"RunInstances\",\"availabilityzone\":\"NA\"},\"sku\":\"NWX8JZYSP4RSV4Q2\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"NWX8JZYSP4RSV4Q2.JRTCKXETXF\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"$0.0816 per On Demand Linux m7g.large Instance Hour\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0816000000\"}}},\"sku\":\"NWX8JZYSP4RSV4Q2\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}},\"Reserved\":{\"NWX8JZYSP4RSV4Q2.HU7G6KETJZ\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.HU7G6KETJZ.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7g.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.HU7G6KETJZ.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0257000000\"}},\"NWX8JZYSP4RSV4Q2.HU7G6KETJZ.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.HU7G6KETJZ.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"225\"}}},\"sku\":\"NWX8JZYSP4RSV4Q2\",\"effectiveDate\":\"2026-11-14T01:50:10Z\",\"offerTermCode\":\"HU7G6KETJZ\",\"termAttributes\":{\"LeaseContractLength\":\"1yr\",\"OfferingClass\":\"standard\",\"PurchaseOption\":\"Partial Upfront\"}},\"NWX8JZYSP4RSV4Q2.R5XV2EPZQZ\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.R5XV2EPZQZ.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.R5XV2EPZQZ.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"503\"}},\"NWX8JZYSP4RSV4Q2.R5XV2EPZQZ.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7g.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.R5XV2EPZQZ.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0192000000\"}}},\"sku\":\"NWX8JZYSP4RSV4Q2\",\"effectiveDate\":\"2026-11-14T01:50:09Z\",\"offerTermCode\":\"R5XV2EPZQZ\",\"termAttributes\":{\"LeaseContractLength\":\"3yr\",\"OfferingClass\":\"convertible\",\"PurchaseOption\":\"Partial Upfront\"}},\"NWX8JZYSP4RSV4Q2.38NPMPTW36\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.38NPMPTW36.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7g.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.38NPMPTW36.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0171000000\"}},\"NWX8JZYSP4RSV4Q2.38NPMPTW36.2TG2D8R56U\":{\"unit\":\"Quantity\",\"description\":\"Upfront Fee\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.38NPMPTW36.2TG2D8R56U\",\"pricePerUnit\":{\"USD\":\"450\"}}},\"sku\":\"NWX8JZYSP4RSV4Q2\",\"effectiveDate\":\"2026-11-14T01:50:09Z\",\"offerTermCode\":\"38NPMPTW36\",\"termAttributes\":{\"LeaseContractLength\":\"3yr\",\"OfferingClass\":\"standard\",\"PurchaseOption\":\"Partial Upfront\"}},\"NWX8JZYSP4RSV4Q2.Z2E3P23VKM\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.Z2E3P23VKM.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"Linux/UNIX (Amazon VPC), m7g.large reserved instance applied\",\"appliesTo\":[],\"rateCode\":\"NWX8JZYSP4RSV4Q2.Z2E3P23VKM.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0414000000\"}}},\"sku\":\"NWX8JZYSP4RSV4Q2\",\"effectiveDate\":\"2026-11-14T01:50:12Z\",\"offerTermCode\":\"Z2E3P23VKM\",\"termAttributes\":{\"LeaseContractLength\":\"3yr\",\"OfferingClass\":\"convertible\",\"PurchaseOption\":\"No Upfront\"}},\"NWX8JZYSP4RSV4Q2.NQ3QZPMQV9\":{\"priceDimensions\":{\"NWX8JZYSP4RSV4Q2.NQ3QZPMQV9.6YS6EN2CT7\":{\"unit\":\"Hrs\",\"endRange\":\"Inf\",\"description\":\"USD 0.0 per Linux/UNIX (Amazon VPC),Line truncated
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"FormatVersion": "aws_v1",
|
||||
"PriceList": [
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"resource\":\"per vCPU per hour\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-Windows-vCPU-Hours:perCPU\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"cputype\":\"perCPU\",\"operatingSystem\":\"Windows\",\"operation\":\"\"},\"sku\":\"58AWBVRMPKQ3HVG6\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"58AWBVRMPKQ3HVG6.JRTCKXETXF\":{\"priceDimensions\":{\"58AWBVRMPKQ3HVG6.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - Windows - vCPU - US West 2 (Oregon)\",\"appliesTo\":[],\"rateCode\":\"58AWBVRMPKQ3HVG6.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0465520000\"}}},\"sku\":\"58AWBVRMPKQ3HVG6\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"resource\":\"per vCPU per hour\",\"cpuArchitecture\":\"ARM\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-ARM-vCPU-Hours:perCPU\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"cputype\":\"perCPU\",\"operation\":\"\"},\"sku\":\"5UAMYEN99PSY23D6\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"5UAMYEN99PSY23D6.JRTCKXETXF\":{\"priceDimensions\":{\"5UAMYEN99PSY23D6.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - ARM - vCPU - US West (Oregon)\",\"appliesTo\":[],\"rateCode\":\"5UAMYEN99PSY23D6.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0323800000\"}}},\"sku\":\"5UAMYEN99PSY23D6\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-vCPU-Hours:perCPU\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"cputype\":\"perCPU\",\"operation\":\"\"},\"sku\":\"EKCCQUSFCBDDTKTS\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"EKCCQUSFCBDDTKTS.JRTCKXETXF\":{\"priceDimensions\":{\"EKCCQUSFCBDDTKTS.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - vCPU - US West 2 (Oregon)\",\"appliesTo\":[],\"rateCode\":\"EKCCQUSFCBDDTKTS.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0404800000\"}}},\"sku\":\"EKCCQUSFCBDDTKTS\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"resource\":\"OS License Fee per vCPU per hour\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-Windows-OS-Hours:perCPU\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"cputype\":\"perCPU OS License Fee\",\"operatingSystem\":\"Windows\",\"operation\":\"\"},\"sku\":\"HTBGRCKVHYXUYEAC\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"HTBGRCKVHYXUYEAC.JRTCKXETXF\":{\"priceDimensions\":{\"HTBGRCKVHYXUYEAC.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - Windows - OS - US West 2 (Oregon)\",\"appliesTo\":[],\"rateCode\":\"HTBGRCKVHYXUYEAC.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0460000000\"}}},\"sku\":\"HTBGRCKVHYXUYEAC\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-GB-Hours\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"memorytype\":\"perGB\",\"operation\":\"\"},\"sku\":\"NTC2QZFJW79R5XVK\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"NTC2QZFJW79R5XVK.JRTCKXETXF\":{\"priceDimensions\":{\"NTC2QZFJW79R5XVK.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - Memory - US West 2 (Oregon)\",\"appliesTo\":[],\"rateCode\":\"NTC2QZFJW79R5XVK.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0044450000\"}}},\"sku\":\"NTC2QZFJW79R5XVK\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"resource\":\"per GB per hour\",\"cpuArchitecture\":\"ARM\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-ARM-GB-Hours\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"memorytype\":\"perGB\",\"operation\":\"\"},\"sku\":\"TAE28FJERF797NWS\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"TAE28FJERF797NWS.JRTCKXETXF\":{\"priceDimensions\":{\"TAE28FJERF797NWS.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - ARM - Memory - US West (Oregon)\",\"appliesTo\":[],\"rateCode\":\"TAE28FJERF797NWS.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0035600000\"}}},\"sku\":\"TAE28FJERF797NWS\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"usagetype\":\"USW2-Fargate-EphemeralStorage-GB-Hours\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"operation\":\"\",\"storagetype\":\"default\"},\"sku\":\"TTWDU5N74ZQ26XMP\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"TTWDU5N74ZQ26XMP.JRTCKXETXF\":{\"priceDimensions\":{\"TTWDU5N74ZQ26XMP.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - Ephemeral Storage - US West (Oregon)\",\"appliesTo\":[],\"rateCode\":\"TTWDU5N74ZQ26XMP.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0001110000\"}}},\"sku\":\"TTWDU5N74ZQ26XMP\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}",
|
||||
"{\"product\":{\"productFamily\":\"Compute\",\"attributes\":{\"regionCode\":\"us-west-2\",\"servicecode\":\"AmazonECS\",\"resource\":\"per GB per hour\",\"tenancy\":\"Shared\",\"usagetype\":\"USW2-Fargate-Windows-GB-Hours\",\"locationType\":\"AWS Region\",\"location\":\"US West (Oregon)\",\"servicename\":\"Amazon Elastic Container Service\",\"memorytype\":\"perGB\",\"operatingSystem\":\"Windows\",\"operation\":\"\"},\"sku\":\"ZPUB3WBJWT6K7RSF\"},\"serviceCode\":\"AmazonECS\",\"terms\":{\"OnDemand\":{\"ZPUB3WBJWT6K7RSF.JRTCKXETXF\":{\"priceDimensions\":{\"ZPUB3WBJWT6K7RSF.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"hours\",\"endRange\":\"Inf\",\"description\":\"AWS Fargate - Windows - Memory - US West 2 (Oregon)\",\"appliesTo\":[],\"rateCode\":\"ZPUB3WBJWT6K7RSF.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.0051117500\"}}},\"sku\":\"ZPUB3WBJWT6K7RSF\",\"effectiveDate\":\"2026-11-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20261111234623\",\"publicationDate\":\"2026-11-11T23:46:23Z\"}"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,649 @@
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Mutex;
|
||||
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
||||
|
||||
use super::*;
|
||||
use crate::models::project::{Arch, AwsWorkspaceConfig, StorageMode};
|
||||
|
||||
/// A real `GetProducts` answer for us-west-2 with [`FILTERS`] (recorded
|
||||
/// 2026-11-16): the eight Fargate rows, Windows ones included.
|
||||
const FIXTURE: &str = include_str!("fixtures/get-products-us-west-2.json");
|
||||
|
||||
fn fixture_items() -> Vec<String> {
|
||||
let v: Value = serde_json::from_str(FIXTURE).unwrap();
|
||||
v["PriceList"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.map(|s| s.as_str().unwrap().to_string())
|
||||
.collect()
|
||||
}
|
||||
|
||||
const X86: FargateRates = FargateRates {
|
||||
vcpu_hour: 0.04048,
|
||||
gb_hour: 0.004445,
|
||||
storage_gb_hour: 0.000111,
|
||||
};
|
||||
const ARM: FargateRates = FargateRates {
|
||||
vcpu_hour: 0.03238,
|
||||
gb_hour: 0.00356,
|
||||
storage_gb_hour: 0.000111,
|
||||
};
|
||||
const RATES: RegionRates = RegionRates {
|
||||
x86_64: Some(X86),
|
||||
arm64: Some(ARM),
|
||||
};
|
||||
|
||||
fn close(a: f64, b: f64) -> bool {
|
||||
(a - b).abs() < 1e-9
|
||||
}
|
||||
|
||||
fn cfg(cpu: u32, memory_mib: u32, ephemeral_gib: u32) -> AwsWorkspaceConfig {
|
||||
AwsWorkspaceConfig {
|
||||
cpu,
|
||||
memory_mib,
|
||||
ephemeral_gib,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
// ---- estimate ----
|
||||
|
||||
#[test]
|
||||
fn estimate_is_vcpus_plus_gbs_at_the_pinned_rates() {
|
||||
// 1 vCPU, 4 GiB, 21 GiB disk (1 billed).
|
||||
let e = estimate(&cfg(1024, 4096, 21), &X86);
|
||||
assert!(
|
||||
close(e.usd_per_hour, 0.04048 + 4.0 * 0.004445 + 0.000111),
|
||||
"{e:?}"
|
||||
);
|
||||
// 0.25 vCPU, 0.5 GiB, the free 20 GiB only.
|
||||
let e = estimate(&cfg(256, 512, 20), &X86);
|
||||
assert!(
|
||||
close(e.usd_per_hour, 0.25 * 0.04048 + 0.5 * 0.004445),
|
||||
"{e:?}"
|
||||
);
|
||||
// 4 vCPU, 16 GiB on ARM, 200 GiB disk (180 billed).
|
||||
let e = estimate(&cfg(4096, 16384, 200), &ARM);
|
||||
assert!(
|
||||
close(
|
||||
e.usd_per_hour,
|
||||
4.0 * 0.03238 + 16.0 * 0.00356 + 180.0 * 0.000111
|
||||
),
|
||||
"{e:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ephemeral_storage_is_billed_only_above_twenty_gib() {
|
||||
let free = estimate(&cfg(1024, 2048, 20), &X86).usd_per_hour;
|
||||
let one = estimate(&cfg(1024, 2048, 21), &X86).usd_per_hour;
|
||||
let fifty = estimate(&cfg(1024, 2048, 50), &X86).usd_per_hour;
|
||||
assert!(close(one - free, 0.000111));
|
||||
assert!(close(fifty - free, 30.0 * 0.000111));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn notes_follow_spot_and_storage_and_the_sidecar_adds_nothing() {
|
||||
let mut c = cfg(1024, 4096, 21);
|
||||
c.storage = StorageMode::Ephemeral;
|
||||
let base = estimate(&c, &X86);
|
||||
assert!(!base.note_spot && !base.efs_billed_separately);
|
||||
c.spot = true;
|
||||
assert!(estimate(&c, &X86).note_spot);
|
||||
for storage in [StorageMode::Hybrid, StorageMode::Efs] {
|
||||
c.storage = storage;
|
||||
assert!(estimate(&c, &X86).efs_billed_separately, "{storage:?}");
|
||||
}
|
||||
c.gateway_sidecar = true;
|
||||
assert!(close(estimate(&c, &X86).usd_per_hour, base.usd_per_hour));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rates_are_picked_by_arch() {
|
||||
assert_eq!(RATES.for_arch(Arch::X86_64), Some(X86));
|
||||
assert_eq!(RATES.for_arch(Arch::Arm64), Some(ARM));
|
||||
}
|
||||
|
||||
// ---- parsing ----
|
||||
|
||||
#[test]
|
||||
fn the_recorded_price_list_parses_to_x86_and_arm_rates() {
|
||||
let rates = parse_price_list("us-west-2", &fixture_items()).expect("rates");
|
||||
assert_eq!(rates, RATES);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_price_list_for_another_region_gives_nothing() {
|
||||
assert_eq!(parse_price_list("eu-west-1", &fixture_items()), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn windows_rows_never_count() {
|
||||
let items: Vec<String> = fixture_items()
|
||||
.into_iter()
|
||||
.filter(|s| s.contains("Windows"))
|
||||
.collect();
|
||||
assert_eq!(items.len(), 3);
|
||||
assert_eq!(parse_price_list("us-west-2", &items), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_incomplete_architecture_is_none_and_storage_is_required() {
|
||||
let no_arm: Vec<String> = fixture_items()
|
||||
.into_iter()
|
||||
.filter(|s| !s.contains("Fargate-ARM-"))
|
||||
.collect();
|
||||
let rates = parse_price_list("us-west-2", &no_arm).unwrap();
|
||||
assert_eq!(rates.x86_64, Some(X86));
|
||||
assert_eq!(rates.arm64, None);
|
||||
|
||||
let no_storage: Vec<String> = fixture_items()
|
||||
.into_iter()
|
||||
.filter(|s| !s.contains("EphemeralStorage"))
|
||||
.collect();
|
||||
assert_eq!(parse_price_list("us-west-2", &no_storage), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn garbage_and_bad_prices_are_skipped() {
|
||||
let mut items = vec!["not json".to_string(), "{}".to_string()];
|
||||
// A negative x86 vCPU price ahead of the real one is ignored.
|
||||
let bad = fixture_items()
|
||||
.into_iter()
|
||||
.find(|s| s.contains("USW2-Fargate-vCPU-Hours"))
|
||||
.unwrap()
|
||||
.replace("0.0404800000", "-1");
|
||||
items.push(bad);
|
||||
items.extend(fixture_items());
|
||||
assert_eq!(parse_price_list("us-west-2", &items), Some(RATES));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_filters_name_the_region_on_demand_and_fargate() {
|
||||
assert_eq!(PRICING_REGION, "us-east-1");
|
||||
assert_eq!(SERVICE_CODE, "AmazonECS");
|
||||
assert!(FILTERS.contains(&("TERM_MATCH", "regionCode", "{region}")));
|
||||
assert!(FILTERS.contains(&("TERM_MATCH", "termType", "OnDemand")));
|
||||
assert!(FILTERS.contains(&("CONTAINS", "usagetype", "Fargate")));
|
||||
}
|
||||
|
||||
// ---- the API, faked ----
|
||||
|
||||
struct FakeApi {
|
||||
pages: Mutex<Vec<Result<Page, String>>>,
|
||||
calls: AtomicUsize,
|
||||
queries: Mutex<Vec<Query>>,
|
||||
hang: bool,
|
||||
}
|
||||
|
||||
impl FakeApi {
|
||||
fn answering(pages: Vec<Result<Page, String>>) -> Self {
|
||||
Self {
|
||||
pages: Mutex::new(pages),
|
||||
calls: AtomicUsize::new(0),
|
||||
queries: Mutex::new(Vec::new()),
|
||||
hang: false,
|
||||
}
|
||||
}
|
||||
fn fixture() -> Self {
|
||||
Self::answering(vec![Ok(Page {
|
||||
items: fixture_items(),
|
||||
next_token: None,
|
||||
})])
|
||||
}
|
||||
fn denied() -> Self {
|
||||
Self::answering(vec![Err("Access denied: pricing:GetProducts".to_string())])
|
||||
}
|
||||
fn hanging() -> Self {
|
||||
Self {
|
||||
hang: true,
|
||||
..Self::answering(vec![])
|
||||
}
|
||||
}
|
||||
fn calls(&self) -> usize {
|
||||
self.calls.load(Ordering::SeqCst)
|
||||
}
|
||||
}
|
||||
|
||||
impl PricingApi for FakeApi {
|
||||
async fn get_products(&self, query: &Query, _token: Option<String>) -> Result<Page, String> {
|
||||
assert!(
|
||||
query.filters.contains(&("TERM_MATCH", "regionCode", "us-west-2".to_string())),
|
||||
"{query:?}"
|
||||
);
|
||||
self.queries.lock().unwrap().push(query.clone());
|
||||
self.calls.fetch_add(1, Ordering::SeqCst);
|
||||
if self.hang {
|
||||
std::future::pending::<()>().await;
|
||||
}
|
||||
let mut pages = self.pages.lock().unwrap();
|
||||
if pages.is_empty() {
|
||||
return Err("no more pages".to_string());
|
||||
}
|
||||
pages.remove(0)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn pages_are_joined() {
|
||||
let items = fixture_items();
|
||||
let (a, b) = items.split_at(4);
|
||||
let api = FakeApi::answering(vec![
|
||||
Ok(Page {
|
||||
items: a.to_vec(),
|
||||
next_token: Some("t".to_string()),
|
||||
}),
|
||||
Ok(Page {
|
||||
items: b.to_vec(),
|
||||
next_token: None,
|
||||
}),
|
||||
]);
|
||||
assert_eq!(fetch_rates(&api, "us-west-2").await, Ok(RATES));
|
||||
assert_eq!(api.calls(), 2);
|
||||
}
|
||||
|
||||
// ---- the cache ----
|
||||
|
||||
fn at(secs: u64) -> SystemTime {
|
||||
UNIX_EPOCH + Duration::from_secs(secs)
|
||||
}
|
||||
const T0: u64 = 1_800_000_000;
|
||||
const DAY: u64 = 24 * 60 * 60;
|
||||
|
||||
fn cache() -> (tempfile::TempDir, RatesCache) {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let cache = RatesCache::new(dir.path().join("aws-pricing"));
|
||||
(dir, cache)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_cache_file_is_fresh_for_a_day() {
|
||||
let (_d, c) = cache();
|
||||
assert_eq!(c.read("us-west-2", at(T0)), None);
|
||||
c.write("us-west-2", &RATES, at(T0)).unwrap();
|
||||
assert!(c.dir().join("us-west-2.json").is_file());
|
||||
assert_eq!(c.read("us-west-2", at(T0 + DAY - 1)), Some((RATES, true)));
|
||||
assert_eq!(c.read("us-west-2", at(T0 + DAY)), Some((RATES, false)));
|
||||
// From the future (the clock went back): stale.
|
||||
assert_eq!(c.read("us-west-2", at(T0 - 10)), Some((RATES, false)));
|
||||
// Another region's file is not this one's.
|
||||
assert_eq!(c.read("eu-west-1", at(T0)), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_corrupt_or_mislabelled_cache_file_is_no_cache() {
|
||||
let (_d, c) = cache();
|
||||
std::fs::create_dir_all(c.dir()).unwrap();
|
||||
std::fs::write(c.dir().join("us-west-2.json"), "{ not json").unwrap();
|
||||
assert_eq!(c.read("us-west-2", at(T0)), None);
|
||||
c.write("eu-west-1", &RATES, at(T0)).unwrap();
|
||||
std::fs::copy(
|
||||
c.dir().join("eu-west-1.json"),
|
||||
c.dir().join("us-west-2.json"),
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(c.read("us-west-2", at(T0)), None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_fresh_cache_answers_without_a_call() {
|
||||
let (_d, c) = cache();
|
||||
c.write("us-west-2", &RATES, at(T0)).unwrap();
|
||||
let api = FakeApi::denied();
|
||||
assert_eq!(
|
||||
c.rates(Some(&api), "us-west-2", at(T0 + 60)).await,
|
||||
Some(RATES)
|
||||
);
|
||||
assert_eq!(api.calls(), 0);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_miss_fetches_and_writes_the_cache() {
|
||||
let (_d, c) = cache();
|
||||
let api = FakeApi::fixture();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(T0)).await, Some(RATES));
|
||||
assert_eq!(api.calls(), 1);
|
||||
assert_eq!(c.read("us-west-2", at(T0 + 1)), Some((RATES, true)));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_expired_cache_is_fetched_again() {
|
||||
let (_d, c) = cache();
|
||||
let old = RegionRates {
|
||||
x86_64: Some(FargateRates {
|
||||
vcpu_hour: 1.0,
|
||||
..X86
|
||||
}),
|
||||
arm64: None,
|
||||
};
|
||||
c.write("us-west-2", &old, at(T0)).unwrap();
|
||||
let api = FakeApi::fixture();
|
||||
assert_eq!(
|
||||
c.rates(Some(&api), "us-west-2", at(T0 + DAY)).await,
|
||||
Some(RATES)
|
||||
);
|
||||
assert_eq!(api.calls(), 1);
|
||||
assert_eq!(c.read("us-west-2", at(T0 + DAY)), Some((RATES, true)));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_corrupt_cache_is_fetched_again() {
|
||||
let (_d, c) = cache();
|
||||
std::fs::create_dir_all(c.dir()).unwrap();
|
||||
std::fs::write(c.dir().join("us-west-2.json"), "garbage").unwrap();
|
||||
let api = FakeApi::fixture();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(T0)).await, Some(RATES));
|
||||
assert_eq!(c.read("us-west-2", at(T0)), Some((RATES, true)));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn denied_is_none_and_is_not_asked_again_for_a_while() {
|
||||
let (_d, c) = cache();
|
||||
let api = FakeApi::denied();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(T0)).await, None);
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(T0 + 60)).await, None);
|
||||
assert_eq!(api.calls(), 1, "a recent failure is not retried");
|
||||
let later = T0 + RETRY_AFTER_FAILURE.as_secs();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(later)).await, None);
|
||||
assert_eq!(api.calls(), 2);
|
||||
assert!(!c.dir().join("us-west-2.json").exists());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_failed_refresh_falls_back_to_the_stale_cache() {
|
||||
let (_d, c) = cache();
|
||||
c.write("us-west-2", &RATES, at(T0)).unwrap();
|
||||
let api = FakeApi::denied();
|
||||
assert_eq!(
|
||||
c.rates(Some(&api), "us-west-2", at(T0 + 2 * DAY)).await,
|
||||
Some(RATES)
|
||||
);
|
||||
assert_eq!(api.calls(), 1);
|
||||
// No client at all (e.g. the connection's keys are gone): stale still answers.
|
||||
assert_eq!(
|
||||
c.rates(None::<&FakeApi>, "us-west-2", at(T0 + 2 * DAY))
|
||||
.await,
|
||||
Some(RATES)
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_hanging_api_times_out_to_none() {
|
||||
let (_d, c) = cache();
|
||||
let api = FakeApi::hanging();
|
||||
let started = tokio::time::Instant::now();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(T0)).await, None);
|
||||
assert_eq!(started.elapsed(), FETCH_TIMEOUT);
|
||||
assert_eq!(api.calls(), 1);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn building_the_client_counts_against_the_same_timeout() {
|
||||
let (_d, c) = cache();
|
||||
c.write("us-west-2", &RATES, at(T0)).unwrap();
|
||||
let started = tokio::time::Instant::now();
|
||||
// The client never gets built (credentials that hang): stale answers at
|
||||
// the fetch's own bound, not later.
|
||||
let r = c
|
||||
.rates_with::<FakeApi, FakeApi>(std::future::pending(), "us-west-2", at(T0 + 2 * DAY))
|
||||
.await;
|
||||
assert_eq!(r, Some(RATES));
|
||||
assert_eq!(started.elapsed(), FETCH_TIMEOUT);
|
||||
|
||||
// A fresh cache never builds a client at all.
|
||||
let fresh = c
|
||||
.rates_with::<FakeApi, FakeApi>(
|
||||
async { panic!("no client is built for a fresh cache") },
|
||||
"us-west-2",
|
||||
at(T0 + 60),
|
||||
)
|
||||
.await;
|
||||
assert_eq!(fresh, Some(RATES));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn no_client_counts_as_a_failure_and_is_not_asked_again_for_a_while() {
|
||||
let (_d, c) = cache();
|
||||
let none = || async { None::<FakeApi> };
|
||||
assert_eq!(c.rates_with::<FakeApi, FakeApi>(none(), "us-west-2", at(T0)).await, None);
|
||||
// Within the back-off the client is not even built.
|
||||
let r = c
|
||||
.rates_with::<FakeApi, FakeApi>(
|
||||
async { panic!("no client is built within the back-off") },
|
||||
"us-west-2",
|
||||
at(T0 + 60),
|
||||
)
|
||||
.await;
|
||||
assert_eq!(r, None);
|
||||
// After it, a working client is asked and clears the failure.
|
||||
let api = FakeApi::fixture();
|
||||
let later = T0 + RETRY_AFTER_FAILURE.as_secs();
|
||||
assert_eq!(c.rates(Some(&api), "us-west-2", at(later)).await, Some(RATES));
|
||||
assert_eq!(api.calls(), 1);
|
||||
}
|
||||
|
||||
// ---- EC2 (phase 7 E10) ----
|
||||
|
||||
/// Real `AmazonEC2` `GetProducts` answers for us-west-2 with [`EC2_FILTERS`]
|
||||
/// (recorded 2026-11-16): one row each for m7i.large and m7g.large.
|
||||
const EC2_FIXTURE: &str = include_str!("fixtures/ec2-get-products-us-west-2.json");
|
||||
const M7I_LARGE: f64 = 0.1008;
|
||||
const M7G_LARGE: f64 = 0.0816;
|
||||
|
||||
fn ec2_items() -> Vec<String> {
|
||||
let v: Value = serde_json::from_str(EC2_FIXTURE).unwrap();
|
||||
v["PriceList"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.map(|s| s.as_str().unwrap().to_string())
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn ec2_cfg(cpu: u32, memory_mib: u32, storage: StorageMode) -> AwsWorkspaceConfig {
|
||||
AwsWorkspaceConfig {
|
||||
launch_type: crate::models::project::LaunchType::Ec2,
|
||||
cpu,
|
||||
memory_mib,
|
||||
storage,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_recorded_ec2_price_list_gives_each_instance_types_hourly_price() {
|
||||
let items = ec2_items();
|
||||
assert_eq!(parse_ec2_price("us-west-2", "m7i.large", &items), Some(M7I_LARGE));
|
||||
assert_eq!(parse_ec2_price("us-west-2", "m7g.large", &items), Some(M7G_LARGE));
|
||||
// Not a type in the list, or another region: nothing.
|
||||
assert_eq!(parse_ec2_price("us-west-2", "c7i.large", &items), None);
|
||||
assert_eq!(parse_ec2_price("eu-west-1", "m7i.large", &items), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ec2_row_for_other_software_tenancy_or_capacity_never_counts() {
|
||||
let row = ec2_items().into_iter().find(|s| s.contains("m7i.large")).unwrap();
|
||||
for (from, to) in [
|
||||
("\"tenancy\":\"Shared\"", "\"tenancy\":\"Dedicated\""),
|
||||
("\"preInstalledSw\":\"NA\"", "\"preInstalledSw\":\"SQL Web\""),
|
||||
("\"capacitystatus\":\"Used\"", "\"capacitystatus\":\"UnusedCapacityReservation\""),
|
||||
("\"operatingSystem\":\"Linux\"", "\"operatingSystem\":\"Windows\""),
|
||||
("\"licenseModel\":\"No License required\"", "\"licenseModel\":\"Bring your own license\""),
|
||||
] {
|
||||
assert!(row.contains(from), "{from}");
|
||||
let other = row.replace(from, to);
|
||||
assert_eq!(parse_ec2_price("us-west-2", "m7i.large", &[other]), None, "{to}");
|
||||
}
|
||||
// A zero price (what an unused reservation row says) is not a price.
|
||||
let zero = row.replace("0.1008000000", "0.0000000000");
|
||||
assert_eq!(parse_ec2_price("us-west-2", "m7i.large", &[zero]), None);
|
||||
assert_eq!(parse_ec2_price("us-west-2", "m7i.large", &["garbage".into()]), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_ec2_filters_name_linux_shared_tenancy_on_demand_for_the_type() {
|
||||
assert_eq!(EC2_SERVICE_CODE, "AmazonEC2");
|
||||
let q = ec2_query("us-west-2", "m7i.large");
|
||||
assert_eq!(q.service_code, "AmazonEC2");
|
||||
let f = |field: &'static str, value: &str| ("TERM_MATCH", field, value.to_string());
|
||||
assert_eq!(
|
||||
q.filters,
|
||||
vec![
|
||||
f("regionCode", "us-west-2"),
|
||||
f("instanceType", "m7i.large"),
|
||||
f("operatingSystem", "Linux"),
|
||||
f("tenancy", "Shared"),
|
||||
f("preInstalledSw", "NA"),
|
||||
f("capacitystatus", "Used"),
|
||||
f("licenseModel", "No License required"),
|
||||
]
|
||||
);
|
||||
// The Fargate query is unchanged.
|
||||
let fq = fargate_query("us-west-2");
|
||||
assert_eq!(fq.service_code, "AmazonECS");
|
||||
assert_eq!(
|
||||
fq.filters,
|
||||
vec![
|
||||
("TERM_MATCH", "regionCode", "us-west-2".to_string()),
|
||||
("TERM_MATCH", "termType", "OnDemand".to_string()),
|
||||
("CONTAINS", "usagetype", "Fargate".to_string()),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ec2_estimate_is_the_instances_price_whatever_the_reservations() {
|
||||
let small = estimate_ec2(&ec2_cfg(512, 1024, StorageMode::Ephemeral), M7I_LARGE, None);
|
||||
let big = estimate_ec2(&ec2_cfg(1920, 7373, StorageMode::Ephemeral), M7I_LARGE, None);
|
||||
assert!(close(small.usd_per_hour, 0.1008) && close(big.usd_per_hour, 0.1008));
|
||||
assert!(small.ec2_instance && !small.note_spot && !small.efs_billed_separately);
|
||||
assert!(!small.root_volume_included);
|
||||
// Ephemeral size and Spot don't apply on EC2; EFS is still billed apart.
|
||||
let mut c = ec2_cfg(1024, 4096, StorageMode::Hybrid);
|
||||
c.ephemeral_gib = 200;
|
||||
c.spot = true;
|
||||
let e = estimate_ec2(&c, M7G_LARGE, None);
|
||||
assert!(close(e.usd_per_hour, 0.0816));
|
||||
assert!(e.efs_billed_separately && !e.note_spot && e.ec2_instance);
|
||||
// Fargate estimates say they are not an instance's.
|
||||
assert!(!estimate(&cfg(1024, 4096, 21), &X86).ec2_instance);
|
||||
}
|
||||
|
||||
fn ec2_api() -> FakeApi {
|
||||
FakeApi::answering(vec![Ok(Page {
|
||||
items: ec2_items(),
|
||||
next_token: None,
|
||||
})])
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_ec2_price_is_fetched_once_and_cached_per_region_and_type() {
|
||||
let (_d, c) = cache();
|
||||
let api = ec2_api();
|
||||
let price = c.ec2_price_with::<FakeApi, _>(async { Some(&api) }, "us-west-2", "m7i.large", at(T0)).await;
|
||||
assert_eq!(price, Some(M7I_LARGE));
|
||||
assert_eq!(api.calls(), 1);
|
||||
assert_eq!(api.queries.lock().unwrap()[0], ec2_query("us-west-2", "m7i.large"));
|
||||
assert!(c.dir().join("us-west-2--ec2-m7i.large.json").is_file());
|
||||
assert_eq!(c.read_ec2("us-west-2", "m7i.large", at(T0 + DAY - 1)), Some((M7I_LARGE, true)));
|
||||
assert_eq!(c.read_ec2("us-west-2", "m7i.large", at(T0 + DAY)), Some((M7I_LARGE, false)));
|
||||
// Fresh: no call. Another type, or the region's Fargate rates, are not it.
|
||||
let again = c
|
||||
.ec2_price_with::<FakeApi, FakeApi>(async { panic!("no client for a fresh cache") }, "us-west-2", "m7i.large", at(T0 + 60))
|
||||
.await;
|
||||
assert_eq!(again, Some(M7I_LARGE));
|
||||
assert_eq!(c.read_ec2("us-west-2", "m7g.large", at(T0)), None);
|
||||
assert_eq!(c.read("us-west-2", at(T0)), None);
|
||||
// A file renamed to another type's name is no cache.
|
||||
std::fs::copy(
|
||||
c.dir().join("us-west-2--ec2-m7i.large.json"),
|
||||
c.dir().join("us-west-2--ec2-m7g.large.json"),
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(c.read_ec2("us-west-2", "m7g.large", at(T0)), None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_ec2_price_backs_off_after_a_failure_and_falls_back_to_the_stale_cache() {
|
||||
let (_d, c) = cache();
|
||||
let denied = FakeApi::denied();
|
||||
assert_eq!(c.ec2_price_with::<FakeApi, _>(async { Some(&denied) }, "us-west-2", "m7i.large", at(T0)).await, None);
|
||||
assert_eq!(c.ec2_price_with::<FakeApi, _>(async { Some(&denied) }, "us-west-2", "m7i.large", at(T0 + 60)).await, None);
|
||||
assert_eq!(denied.calls(), 1, "a recent failure is not retried");
|
||||
// The failure is per type: another type is still asked.
|
||||
let other = FakeApi::denied();
|
||||
let _ = c.ec2_price_with::<FakeApi, _>(async { Some(&other) }, "us-west-2", "m7g.large", at(T0 + 60)).await;
|
||||
assert_eq!(other.calls(), 1);
|
||||
// A stale price answers when the refresh fails.
|
||||
c.write_ec2("us-west-2", "c7i.large", 0.0893, at(T0)).unwrap();
|
||||
let r = c.ec2_price_with::<FakeApi, _>(async { Some(&denied) }, "us-west-2", "c7i.large", at(T0 + 2 * DAY)).await;
|
||||
assert_eq!(r, Some(0.0893));
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_hanging_ec2_price_times_out_to_none() {
|
||||
let (_d, c) = cache();
|
||||
let api = FakeApi::hanging();
|
||||
let started = tokio::time::Instant::now();
|
||||
assert_eq!(c.ec2_price_with::<FakeApi, _>(async { Some(&api) }, "us-west-2", "m7i.large", at(T0)).await, None);
|
||||
assert_eq!(started.elapsed(), FETCH_TIMEOUT);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_instance_type_that_could_name_another_file_is_never_used() {
|
||||
let (_d, c) = cache();
|
||||
for bad in ["../x", "m7i.large/..", "M7I.large", "m7i", "", "m7i.large.json", "m7i .large"] {
|
||||
let r = c
|
||||
.ec2_price_with::<FakeApi, FakeApi>(async { panic!("no client for {bad:?}") }, "us-west-2", bad, at(T0))
|
||||
.await;
|
||||
assert_eq!(r, None, "{bad}");
|
||||
assert_eq!(c.read_ec2("us-west-2", bad, at(T0)), None);
|
||||
assert!(c.write_ec2("us-west-2", bad, 1.0, at(T0)).is_err(), "{bad}");
|
||||
assert!(fetch_ec2_price(&ec2_api(), "us-west-2", bad).await.is_err());
|
||||
}
|
||||
assert_eq!(fetch_ec2_price(&ec2_api(), "us-west-2", "m7g.large").await, Ok(M7G_LARGE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_fargate_cache_file_written_before_ec2_prices_still_reads() {
|
||||
let (_d, c) = cache();
|
||||
std::fs::create_dir_all(c.dir()).unwrap();
|
||||
let old = serde_json::json!({ "region": "us-west-2", "fetched_at": T0, "rates": RATES });
|
||||
std::fs::write(c.dir().join("us-west-2.json"), old.to_string()).unwrap();
|
||||
assert_eq!(c.read("us-west-2", at(T0)), Some((RATES, true)));
|
||||
}
|
||||
|
||||
const GP3_FIXTURE: &str = include_str!("fixtures/ebs-gp3-get-products-us-west-2.json");
|
||||
|
||||
fn gp3_items() -> Vec<String> {
|
||||
let v: Value = serde_json::from_str(GP3_FIXTURE).unwrap();
|
||||
v["PriceList"].as_array().unwrap().iter().map(|s| s.as_str().unwrap().to_string()).collect()
|
||||
}
|
||||
|
||||
/// The root volume (50 GiB gp3, `ec2.tf`) is in an EC2 estimate when its
|
||||
/// price is known: $0.08/GB-month in us-west-2 (recorded 2026-11-16) is
|
||||
/// 50 × 0.08 / 730 ≈ $0.0055/h on top of the instance.
|
||||
#[test]
|
||||
fn an_ec2_estimate_adds_the_gp3_root_volume_when_its_price_is_known() {
|
||||
assert_eq!(parse_gp3_price("us-west-2", &gp3_items()), Some(0.08));
|
||||
assert_eq!(parse_gp3_price("eu-west-1", &gp3_items()), None, "another region's row");
|
||||
assert_eq!(parse_gp3_price("us-west-2", &ec2_items()), None, "not a gp3 row");
|
||||
let e = estimate_ec2(&ec2_cfg(1024, 4096, StorageMode::Ephemeral), M7I_LARGE, Some(0.08));
|
||||
assert!(close(e.usd_per_hour, 0.1008 + 50.0 * 0.08 / 730.0), "{}", e.usd_per_hour);
|
||||
assert!(e.root_volume_included && e.ec2_instance);
|
||||
assert_eq!(gp3_query("us-west-2").service_code, "AmazonEC2");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_gp3_price_is_fetched_once_and_cached_per_region() {
|
||||
let (_d, c) = cache();
|
||||
let api = FakeApi::answering(vec![Ok(Page { items: gp3_items(), next_token: None })]);
|
||||
let price = c.gp3_price_with::<FakeApi, _>(async { Some(&api) }, "us-west-2", at(T0)).await;
|
||||
assert_eq!(price, Some(0.08));
|
||||
assert_eq!(api.queries.lock().unwrap()[0], gp3_query("us-west-2"));
|
||||
assert!(c.dir().join("us-west-2--ebs-gp3.json").is_file());
|
||||
let again = c.gp3_price_with::<FakeApi, _>(async { Some(&api) }, "us-west-2", at(T0 + 1)).await;
|
||||
assert_eq!(again, Some(0.08));
|
||||
assert_eq!(api.calls(), 1);
|
||||
}
|
||||
@@ -14,12 +14,15 @@ use std::time::Duration;
|
||||
use aws_config::SdkConfig;
|
||||
use aws_sdk_secretsmanager::error::ProvideErrorMetadata;
|
||||
|
||||
use super::environments::{knowable, parse_environment_record, EnvironmentInfo, Knowable};
|
||||
use super::environments::{
|
||||
get_parameter, knowable, parse_environment_record, user_record_from, EnvironmentInfo, Knowable,
|
||||
Param, UserRecord,
|
||||
};
|
||||
use super::error::{classify_sdk_error, AwsError};
|
||||
use super::tasks::{find_project_task, TaskApi, STOP_REASON};
|
||||
use super::tofu_modules::{
|
||||
access_point_root, environment_cluster_name, environment_parameter_name, project_secret_name, task_family,
|
||||
user_file_system_token, user_role_names,
|
||||
access_point_root, workspace_access_point_root, environment_cluster_name, environment_parameter_name, project_secret_name, task_family,
|
||||
is_user_ec2_cluster, user_file_system_token, user_record_parameter_name, user_role_names,
|
||||
};
|
||||
use super::workspace::WorkspaceApi;
|
||||
|
||||
@@ -40,6 +43,13 @@ pub trait RuntimeApi: Send + Sync {
|
||||
&self,
|
||||
env: &str,
|
||||
) -> impl Future<Output = Result<Option<String>, AwsError>> + Send;
|
||||
/// `ssm:GetParameter` of the caller's EC2 record in `env`
|
||||
/// (`user_record_parameter_name`).
|
||||
fn user_record(
|
||||
&self,
|
||||
env: &str,
|
||||
owner_key: &str,
|
||||
) -> impl Future<Output = Result<Param, AwsError>> + Send;
|
||||
/// `iam:GetRole`.
|
||||
fn role_exists(&self, name: &str) -> impl Future<Output = Result<Knowable, AwsError>> + Send;
|
||||
/// `secretsmanager:GetSecretValue`'s `SecretString`.
|
||||
@@ -80,6 +90,50 @@ pub async fn read_environment<R: RuntimeApi>(
|
||||
})
|
||||
}
|
||||
|
||||
/// The caller's EC2 record in `env`, validated (untrusted: `parse_user_record`).
|
||||
/// Absent = no EC2 capacity for NEW runs; a task already running on the
|
||||
/// user's cluster may outlive the record (teardown removes it first).
|
||||
pub async fn read_user_record<R: RuntimeApi>(
|
||||
rt: &R,
|
||||
env: &str,
|
||||
owner_key: &str,
|
||||
account: &str,
|
||||
region: &str,
|
||||
) -> Result<UserRecord, AwsError> {
|
||||
Ok(user_record_from(rt.user_record(env, owner_key).await?, env, account, region))
|
||||
}
|
||||
|
||||
/// The per-user EC2 cluster (ARN) a stored task ARN names, when it is one of
|
||||
/// `env`'s: where a project that ran on EC2 is still looked for after its
|
||||
/// user record is gone.
|
||||
pub fn ec2_cluster_of_task(env: &str, task_arn: &str) -> Option<String> {
|
||||
cluster_of_task(task_arn)
|
||||
.filter(|c| is_user_ec2_cluster(env, c))
|
||||
.and_then(|_| cluster_arn_of_task(task_arn))
|
||||
}
|
||||
|
||||
/// Where a project's task may be: `env_cluster` (the environment's), then
|
||||
/// the user's EC2 cluster from their record, then the per-user cluster
|
||||
/// `stored_task_arn` names (the record may be gone while that task runs),
|
||||
/// without repeats.
|
||||
pub fn project_task_clusters(
|
||||
env: &str,
|
||||
env_cluster: String,
|
||||
ec2_cluster: Option<String>,
|
||||
stored_task_arn: Option<&str>,
|
||||
) -> Vec<String> {
|
||||
let mut out = vec![env_cluster];
|
||||
for c in [ec2_cluster, stored_task_arn.and_then(|a| ec2_cluster_of_task(env, a))]
|
||||
.into_iter()
|
||||
.flatten()
|
||||
{
|
||||
if !out.contains(&c) {
|
||||
out.push(c);
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Whether the caller's task role exists in the environment: the onboarding
|
||||
/// signal a workspace user can read. A denied lookup is not an answer, so
|
||||
/// it is let through (RunTask will say what is wrong).
|
||||
@@ -234,15 +288,21 @@ pub struct RemoveRequest<'a> {
|
||||
/// missed it).
|
||||
pub stored_task_arn: Option<&'a str>,
|
||||
pub stored_access_point_id: Option<&'a str>,
|
||||
/// Delete the EFS access point (ruling R9). The files stay on the
|
||||
/// user's own file system (only their task role can read it) until
|
||||
/// offboarding destroys it; a later start of the same project gets a new
|
||||
/// access point onto the same directory.
|
||||
/// The EFS-mode `/workspace` access point the store has (kept after a
|
||||
/// switch to Hybrid or Ephemeral, Q1).
|
||||
pub stored_workspace_access_point_id: Option<&'a str>,
|
||||
/// The user's EC2 cluster (their record's), looked in too: a project
|
||||
/// may have run there.
|
||||
pub ec2_cluster: Option<&'a str>,
|
||||
/// Delete the EFS access points, home and `/workspace` (ruling R9). The
|
||||
/// files stay on the user's own file system (only their task role can
|
||||
/// read it) until offboarding destroys it; a later start of the same
|
||||
/// project gets new access points onto the same directories.
|
||||
pub discard_data: bool,
|
||||
}
|
||||
|
||||
/// Stop the project's task, delete its secret (no recovery window, R10) and,
|
||||
/// with `discard_data`, delete its access point (not the files, R9). Task definition revisions
|
||||
/// with `discard_data`, delete its access points (not the files, R9). Task definition revisions
|
||||
/// are left registered (R8). A task that can't be stopped stops the removal (nothing
|
||||
/// billed may be left running); the rest is attempted in full and every
|
||||
/// failure reported.
|
||||
@@ -255,17 +315,33 @@ pub async fn remove_workspace_resources<T: TaskApi, W: WorkspaceApi, R: RuntimeA
|
||||
let cluster = environment_cluster_name(req.env);
|
||||
let family = task_family(req.env, req.owner_key, req.project_id);
|
||||
|
||||
// 1. The task.
|
||||
let live =
|
||||
find_project_task(tasks, &cluster, &family, req.owner_user_id, req.project_id).await?;
|
||||
let mut to_stop: Vec<String> = live.into_iter().map(|t| t.arn).collect();
|
||||
if let Some(arn) = req.stored_task_arn {
|
||||
if cluster_of_task(arn) == Some(cluster.as_str()) && !to_stop.iter().any(|a| a == arn) {
|
||||
to_stop.push(arn.to_string());
|
||||
// 1. The task: in the environment's cluster, the user's EC2 cluster (the
|
||||
// record's, and the stored task's when that is a per-user cluster of
|
||||
// this environment — the record may be gone).
|
||||
let clusters = project_task_clusters(
|
||||
req.env,
|
||||
cluster.clone(),
|
||||
req.ec2_cluster.map(str::to_string),
|
||||
req.stored_task_arn,
|
||||
);
|
||||
let mut to_stop: Vec<(String, String)> = Vec::new();
|
||||
for c in &clusters {
|
||||
if let Some(t) =
|
||||
find_project_task(tasks, c, &family, req.owner_user_id, req.project_id).await?
|
||||
{
|
||||
to_stop.push((c.clone(), t.arn));
|
||||
}
|
||||
}
|
||||
for arn in &to_stop {
|
||||
tasks.stop_task(&cluster, arn, STOP_REASON).await?;
|
||||
if let Some(arn) = req.stored_task_arn {
|
||||
let ours = cluster_of_task(arn) == Some(cluster.as_str())
|
||||
|| ec2_cluster_of_task(req.env, arn).is_some();
|
||||
if ours && !to_stop.iter().any(|(_, a)| a == arn) {
|
||||
let c = cluster_of_task(arn).map_or_else(|| cluster.clone(), str::to_string);
|
||||
to_stop.push((c, arn.to_string()));
|
||||
}
|
||||
}
|
||||
for (c, arn) in &to_stop {
|
||||
tasks.stop_task(c, arn, STOP_REASON).await?;
|
||||
}
|
||||
|
||||
let mut failures: Vec<String> = Vec::new();
|
||||
@@ -288,20 +364,27 @@ pub async fn remove_workspace_resources<T: TaskApi, W: WorkspaceApi, R: RuntimeA
|
||||
failures.push(format!("secret {secret}: {e}"));
|
||||
}
|
||||
|
||||
// 4. The access point, only when asked.
|
||||
// 4. The access points (home, and EFS mode's `/workspace`), only when asked.
|
||||
if req.discard_data {
|
||||
let mut ids: Vec<String> = req.stored_access_point_id.map(String::from).into_iter().collect();
|
||||
let mut ids: Vec<String> = [req.stored_access_point_id, req.stored_workspace_access_point_id]
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.map(String::from)
|
||||
.collect();
|
||||
let token = user_file_system_token(req.env, req.owner_key);
|
||||
match work.find_file_system(&token).await {
|
||||
Ok(Some(fs)) if fs.owner.as_deref() == Some(req.owner_user_id) => {
|
||||
let root = access_point_root(req.owner_key, req.project_id);
|
||||
let roots = [
|
||||
access_point_root(req.owner_key, req.project_id),
|
||||
workspace_access_point_root(req.owner_key, req.project_id),
|
||||
];
|
||||
match work.access_points(&fs.id).await {
|
||||
Ok(points) => ids.extend(
|
||||
points
|
||||
.into_iter()
|
||||
.filter(|a| {
|
||||
a.file_system_id == fs.id
|
||||
&& a.root_path.as_deref() == Some(root.as_str())
|
||||
&& a.root_path.as_ref().is_some_and(|r| roots.contains(r))
|
||||
&& a.owner.as_deref() == Some(req.owner_user_id)
|
||||
&& a.project.as_deref() == Some(req.project_id)
|
||||
})
|
||||
@@ -375,6 +458,10 @@ impl RuntimeApi for SdkRuntimeApi {
|
||||
}
|
||||
}
|
||||
|
||||
async fn user_record(&self, env: &str, owner_key: &str) -> Result<Param, AwsError> {
|
||||
get_parameter(&self.ssm, &user_record_parameter_name(env, owner_key)).await
|
||||
}
|
||||
|
||||
async fn role_exists(&self, name: &str) -> Result<Knowable, AwsError> {
|
||||
let res = self.iam.get_role().role_name(name).send().await;
|
||||
knowable("iam:GetRole", res)
|
||||
|
||||
@@ -5,7 +5,7 @@ use aws_sdk_ecs::operation::run_task::RunTaskInput;
|
||||
|
||||
use super::*;
|
||||
use crate::aws::tasks::TaskInfo;
|
||||
use crate::aws::tofu_modules::owner_key;
|
||||
use crate::aws::tofu_modules::{owner_key, workspace_access_point_root};
|
||||
use crate::aws::workspace::{AccessPointRef, FileSystemRef, TaskDefinitionRef};
|
||||
|
||||
const REGION: &str = "eu-west-1";
|
||||
@@ -36,6 +36,8 @@ struct Fake {
|
||||
revisions: Vec<TaskDefinitionRef>,
|
||||
access_points: Vec<AccessPointRef>,
|
||||
fail_secret_delete: bool,
|
||||
/// The clusters ListTasks was asked about, by name.
|
||||
lists: Mutex<Vec<String>>,
|
||||
}
|
||||
|
||||
impl Fake {
|
||||
@@ -52,6 +54,10 @@ impl RuntimeApi for Fake {
|
||||
self.log(format!("record {env}"));
|
||||
Ok(self.record.clone())
|
||||
}
|
||||
async fn user_record(&self, env: &str, owner_key: &str) -> Result<crate::aws::environments::Param, AwsError> {
|
||||
self.log(format!("user-record {env} {owner_key}"));
|
||||
Ok(crate::aws::environments::Param::Missing)
|
||||
}
|
||||
async fn role_exists(&self, name: &str) -> Result<Knowable, AwsError> {
|
||||
self.log(format!("role {name}"));
|
||||
Ok(self.role.clone().unwrap_or(Knowable::Yes))
|
||||
@@ -85,8 +91,16 @@ impl TaskApi for Fake {
|
||||
async fn describe(&self, _c: &str, arns: &[String]) -> Result<Vec<TaskInfo>, AwsError> {
|
||||
Ok(self.live_tasks.iter().filter(|t| arns.contains(&t.arn)).cloned().collect())
|
||||
}
|
||||
async fn list_project_tasks(&self, _c: &str, _f: &str) -> Result<Vec<String>, AwsError> {
|
||||
Ok(self.live_tasks.iter().map(|t| t.arn.clone()).collect())
|
||||
async fn list_project_tasks(&self, c: &str, _f: &str) -> Result<Vec<String>, AwsError> {
|
||||
// By cluster name or ARN, like ECS.
|
||||
let name = c.rsplit_once(":cluster/").map_or(c, |(_, n)| n);
|
||||
self.lists.lock().unwrap().push(name.to_string());
|
||||
Ok(self
|
||||
.live_tasks
|
||||
.iter()
|
||||
.filter(|t| cluster_of_task(&t.arn) == Some(name))
|
||||
.map(|t| t.arn.clone())
|
||||
.collect())
|
||||
}
|
||||
async fn stop_task(&self, cluster: &str, arn: &str, reason: &str) -> Result<(), AwsError> {
|
||||
self.log(format!("stop {cluster} {arn} {reason}"));
|
||||
@@ -112,6 +126,22 @@ impl WorkspaceApi for Fake {
|
||||
) -> Result<String, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn project_secret_value(&self, _n: &str) -> Result<Option<String>, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn create_project_secret(
|
||||
&self,
|
||||
n: &str,
|
||||
k: &str,
|
||||
j: &str,
|
||||
t: &[(String, String)],
|
||||
) -> Result<Option<String>, AwsError> {
|
||||
let _ = (n, k, j, t);
|
||||
unreachable!()
|
||||
}
|
||||
async fn delete_project_secret(&self, _n: &str) -> Result<(), AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn put_project_secret(
|
||||
&self,
|
||||
_n: &str,
|
||||
@@ -246,6 +276,9 @@ fn live(id: &str) -> TaskInfo {
|
||||
family()
|
||||
),
|
||||
runtime_id: None,
|
||||
container_instance_arn: None,
|
||||
exec_enabled: true,
|
||||
created_unix: None,
|
||||
exec_agent_running: false,
|
||||
exit_code: None,
|
||||
owner: Some(USER.into()),
|
||||
@@ -288,6 +321,8 @@ async fn removal_stops_the_task_leaves_the_revisions_and_schedules_the_secret()
|
||||
project_id: PROJECT,
|
||||
stored_task_arn: Some(&t0),
|
||||
stored_access_point_id: Some("fsap-stored"),
|
||||
stored_workspace_access_point_id: None,
|
||||
ec2_cluster: None,
|
||||
discard_data: false,
|
||||
};
|
||||
remove_workspace_resources(&fake, &fake, &fake, &r).await.unwrap();
|
||||
@@ -323,9 +358,185 @@ async fn a_failed_step_is_reported_but_the_rest_still_runs() {
|
||||
project_id: PROJECT,
|
||||
stored_task_arn: None,
|
||||
stored_access_point_id: Some("fsap-1"),
|
||||
stored_workspace_access_point_id: None,
|
||||
ec2_cluster: None,
|
||||
discard_data: true,
|
||||
};
|
||||
let e = remove_workspace_resources(&fake, &fake, &fake, &r).await.unwrap_err();
|
||||
assert!(e.to_string().contains("secret"), "{e}");
|
||||
assert!(fake.calls().contains(&"delete-ap fsap-1".to_string()));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn removal_with_discard_deletes_both_access_points_and_without_keeps_both() {
|
||||
let ap = |id: &str, root: String| AccessPointRef {
|
||||
id: id.into(),
|
||||
file_system_id: "fs-1".into(),
|
||||
root_path: Some(root),
|
||||
owner: Some(USER.into()),
|
||||
project: Some(PROJECT.into()),
|
||||
state: Some("available".into()),
|
||||
};
|
||||
let points = vec![
|
||||
ap("fsap-home", access_point_root(&ok(), PROJECT)),
|
||||
ap("fsap-ws", workspace_access_point_root(&ok(), PROJECT)),
|
||||
AccessPointRef {
|
||||
owner: Some("AROAOTHER:mallory".into()),
|
||||
..ap("fsap-foreign", workspace_access_point_root(&ok(), PROJECT))
|
||||
},
|
||||
AccessPointRef {
|
||||
project: Some("another".into()),
|
||||
..ap("fsap-other-project", workspace_access_point_root(&ok(), PROJECT))
|
||||
},
|
||||
];
|
||||
let key = ok();
|
||||
let mut r = RemoveRequest {
|
||||
env: "dev",
|
||||
region: REGION,
|
||||
owner_user_id: USER,
|
||||
owner_key: &key,
|
||||
project_id: PROJECT,
|
||||
stored_task_arn: None,
|
||||
stored_access_point_id: Some("fsap-home"),
|
||||
// Kept in the store after switching EFS -> Hybrid.
|
||||
stored_workspace_access_point_id: Some("fsap-ws-stored"),
|
||||
ec2_cluster: None,
|
||||
discard_data: false,
|
||||
};
|
||||
let keep = Fake { access_points: points.clone(), ..Default::default() };
|
||||
remove_workspace_resources(&keep, &keep, &keep, &r).await.unwrap();
|
||||
assert!(
|
||||
keep.calls().iter().all(|c| !c.starts_with("delete-ap")),
|
||||
"{:?}",
|
||||
keep.calls()
|
||||
);
|
||||
|
||||
r.discard_data = true;
|
||||
let discard = Fake { access_points: points, ..Default::default() };
|
||||
remove_workspace_resources(&discard, &discard, &discard, &r).await.unwrap();
|
||||
let mut deleted: Vec<String> = discard
|
||||
.calls()
|
||||
.into_iter()
|
||||
.filter_map(|c| c.strip_prefix("delete-ap ").map(String::from))
|
||||
.collect();
|
||||
deleted.sort();
|
||||
assert_eq!(deleted, vec!["fsap-home", "fsap-ws", "fsap-ws-stored"]);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------- EC2 (phase 7)
|
||||
|
||||
fn ec2_task_arn(id: &str) -> String {
|
||||
format!("arn:aws:ecs:{REGION}:{ACCOUNT}:task/triple-c-dev--u-alice/{id}")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_stored_task_on_a_per_user_cluster_names_that_cluster() {
|
||||
assert_eq!(
|
||||
ec2_cluster_of_task("dev", &ec2_task_arn("t")).as_deref(),
|
||||
Some(format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-alice").as_str())
|
||||
);
|
||||
// The environment's own cluster, another environment's per-user
|
||||
// cluster and anything else are not.
|
||||
assert_eq!(ec2_cluster_of_task("dev", &task_arn("t")), None);
|
||||
assert_eq!(ec2_cluster_of_task("prod", &ec2_task_arn("t")), None);
|
||||
let odd = format!("arn:aws:ecs:{REGION}:{ACCOUNT}:task/triple-c-dev--u-a--b/t");
|
||||
assert_eq!(ec2_cluster_of_task("dev", &odd), None);
|
||||
assert_eq!(ec2_cluster_of_task("dev", "not-an-arn"), None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_user_record_is_read_and_validated() {
|
||||
struct Rec(Param);
|
||||
impl Rec {
|
||||
async fn read(&self) -> UserRecord {
|
||||
let fake = RecFake(self.0.clone(), Mutex::new(Vec::new()));
|
||||
let r = read_user_record(&fake, "dev", &ok(), ACCOUNT, REGION).await.unwrap();
|
||||
assert_eq!(*fake.1.lock().unwrap(), vec![format!("dev {}", ok())]);
|
||||
r
|
||||
}
|
||||
}
|
||||
let valid = serde_json::json!({
|
||||
"schema": 1, "instance_type": "m7i.large", "max_instances": 2, "user_tag": "alice",
|
||||
"cluster_arn": format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-alice"),
|
||||
"capacity_provider": "triple-c-dev--u-alice",
|
||||
})
|
||||
.to_string();
|
||||
let UserRecord::Valid(c) = Rec(Param::Value(valid)).read().await else { panic!() };
|
||||
assert_eq!((c.instance_type.as_str(), c.max_instances), ("m7i.large", 2));
|
||||
assert_eq!(Rec(Param::Missing).read().await, UserRecord::Absent);
|
||||
assert!(matches!(Rec(Param::Denied).read().await, UserRecord::Unusable(_)));
|
||||
assert!(matches!(Rec(Param::Value("{}".into())).read().await, UserRecord::Unusable(_)));
|
||||
}
|
||||
|
||||
/// Only `user_record` is asked of it.
|
||||
struct RecFake(Param, Mutex<Vec<String>>);
|
||||
|
||||
impl RuntimeApi for RecFake {
|
||||
async fn environment_record(&self, _env: &str) -> Result<Option<String>, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn user_record(&self, env: &str, owner_key: &str) -> Result<Param, AwsError> {
|
||||
self.1.lock().unwrap().push(format!("{env} {owner_key}"));
|
||||
Ok(self.0.clone())
|
||||
}
|
||||
async fn role_exists(&self, _name: &str) -> Result<Knowable, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn secret_string(&self, _name: &str) -> Result<String, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn access_point_state(&self, _id: &str) -> Result<Option<String>, AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn delete_secret(&self, _name: &str) -> Result<(), AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
async fn delete_access_point(&self, _id: &str) -> Result<(), AwsError> {
|
||||
unreachable!()
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn removal_finds_and_stops_a_task_on_the_users_ec2_cluster() {
|
||||
let key = ok();
|
||||
let user_cluster = format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-alice");
|
||||
let base = RemoveRequest {
|
||||
env: "dev",
|
||||
region: REGION,
|
||||
owner_user_id: USER,
|
||||
owner_key: &key,
|
||||
project_id: PROJECT,
|
||||
stored_task_arn: None,
|
||||
stored_access_point_id: None,
|
||||
stored_workspace_access_point_id: None,
|
||||
ec2_cluster: Some(&user_cluster),
|
||||
discard_data: false,
|
||||
};
|
||||
// Found through the record's cluster.
|
||||
let mut t = live("e1");
|
||||
t.arn = ec2_task_arn("e1");
|
||||
let fake = Fake { live_tasks: vec![t.clone()], ..Default::default() };
|
||||
remove_workspace_resources(&fake, &fake, &fake, &base).await.unwrap();
|
||||
assert_eq!(*fake.lists.lock().unwrap(), ["triple-c-dev", "triple-c-dev--u-alice"]);
|
||||
let calls = fake.calls();
|
||||
assert!(
|
||||
calls.contains(&format!("stop {user_cluster} {} {STOP_REASON}", ec2_task_arn("e1"))),
|
||||
"{calls:?}"
|
||||
);
|
||||
|
||||
// The record is gone: the stored ARN still leads to its cluster.
|
||||
let stored = ec2_task_arn("e1");
|
||||
let fake = Fake { live_tasks: vec![t], ..Default::default() };
|
||||
let r = RemoveRequest { ec2_cluster: None, stored_task_arn: Some(&stored), ..base };
|
||||
remove_workspace_resources(&fake, &fake, &fake, &r).await.unwrap();
|
||||
let stops: Vec<String> = fake.calls().into_iter().filter(|c| c.starts_with("stop")).collect();
|
||||
assert_eq!(stops.len(), 1, "{stops:?}");
|
||||
assert!(stops[0].contains(&ec2_task_arn("e1")), "{stops:?}");
|
||||
|
||||
// A stored ARN on someone else's kind of cluster is not stopped.
|
||||
let foreign = format!("arn:aws:ecs:{REGION}:{ACCOUNT}:task/other-cluster/x");
|
||||
let fake = Fake::default();
|
||||
let r = RemoveRequest { ec2_cluster: None, stored_task_arn: Some(&foreign), ..base };
|
||||
remove_workspace_resources(&fake, &fake, &fake, &r).await.unwrap();
|
||||
assert!(!fake.calls().iter().any(|c| c.starts_with("stop")));
|
||||
}
|
||||
@@ -25,7 +25,7 @@ use aws_sdk_ecs::types::{
|
||||
ManagedAgentName, NetworkConfiguration, Tag, Task, TaskField,
|
||||
};
|
||||
|
||||
use super::environments::EnvironmentInfo;
|
||||
use super::environments::{EnvironmentInfo, UserCompute};
|
||||
use super::error::{classify_sdk_error, AwsError};
|
||||
pub use super::tofu_modules::task_log_stream;
|
||||
use super::workspace::{workspace_tags, CONTAINER_NAME, TAG_OWNER, TAG_PROJECT};
|
||||
@@ -62,8 +62,17 @@ pub struct TaskInfo {
|
||||
pub task_definition_arn: String,
|
||||
/// The `workspace` container's runtime id (needed for an SSM target).
|
||||
pub runtime_id: Option<String>,
|
||||
/// The EC2 container instance the task was placed on; `None` on Fargate,
|
||||
/// and on EC2 until an instance has room for it.
|
||||
pub container_instance_arn: Option<String>,
|
||||
/// The `workspace` container's ExecuteCommandAgent is RUNNING.
|
||||
pub exec_agent_running: bool,
|
||||
/// ECS Exec is on for the task (`enableExecuteCommand`). ECS turns it
|
||||
/// off on a RunTask that has to wait for an EC2 instance (verified live,
|
||||
/// phase 7), and such a task can never be reached.
|
||||
pub exec_enabled: bool,
|
||||
/// When ECS created the task (Unix seconds), if it says.
|
||||
pub created_unix: Option<i64>,
|
||||
/// The `workspace` container's exit code, once it has one.
|
||||
pub exit_code: Option<i32>,
|
||||
/// Its `triple-c:owner` / `triple-c:project` tags (DescribeTasks with
|
||||
@@ -112,6 +121,9 @@ pub(crate) fn task_info(t: &Task) -> TaskInfo {
|
||||
stopped_reason: t.stopped_reason().map(str::to_string),
|
||||
task_definition_arn: t.task_definition_arn().unwrap_or_default().to_string(),
|
||||
runtime_id: workspace.and_then(|c| c.runtime_id()).map(str::to_string),
|
||||
container_instance_arn: t.container_instance_arn().map(str::to_string),
|
||||
exec_enabled: t.enable_execute_command(),
|
||||
created_unix: t.created_at().map(|d| d.secs()),
|
||||
exec_agent_running: workspace.is_some_and(|c| {
|
||||
c.managed_agents().iter().any(|a| {
|
||||
a.name() == Some(&ManagedAgentName::ExecuteCommandAgent)
|
||||
@@ -216,6 +228,65 @@ pub fn run_task_request(
|
||||
req.build().expect(BUILT)
|
||||
}
|
||||
|
||||
/// Where a new task runs.
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub enum RunOn<'a> {
|
||||
/// The environment's cluster, Fargate (or `FARGATE_SPOT`).
|
||||
Fargate { spot: bool },
|
||||
/// The user's own cluster and capacity provider (phase 7), from their
|
||||
/// record.
|
||||
Ec2(&'a UserCompute),
|
||||
}
|
||||
|
||||
impl RunOn<'_> {
|
||||
/// The cluster a task runs on, and is looked for in.
|
||||
pub fn cluster<'e>(&'e self, env: &'e EnvironmentInfo) -> &'e str {
|
||||
match self {
|
||||
RunOn::Fargate { .. } => &env.cluster_arn,
|
||||
RunOn::Ec2(c) => &c.cluster_arn,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The RunTask request on the user's EC2 capacity: the exact revision, on
|
||||
/// their cluster, placed by their capacity provider (weight 1). No launch
|
||||
/// type (exclusive with a strategy) and no network configuration: EC2 tasks
|
||||
/// use `bridge` networking (ruling R2). ECS Exec, tags, the client token and
|
||||
/// no overrides as on Fargate (P1).
|
||||
pub fn ec2_run_task_request(
|
||||
compute: &UserCompute,
|
||||
task_def_arn: &str,
|
||||
tags: &[(String, String)],
|
||||
) -> RunTaskInput {
|
||||
const BUILT: &str = "every required field is set";
|
||||
RunTaskInput::builder()
|
||||
.cluster(&compute.cluster_arn)
|
||||
.task_definition(task_def_arn)
|
||||
.count(1)
|
||||
.enable_execute_command(true)
|
||||
.capacity_provider_strategy(
|
||||
CapacityProviderStrategyItem::builder()
|
||||
.capacity_provider(&compute.capacity_provider)
|
||||
.weight(1)
|
||||
.build()
|
||||
.expect(BUILT),
|
||||
)
|
||||
.set_tags(Some(
|
||||
tags.iter()
|
||||
.map(|(k, v)| Tag::builder().key(k).value(v).build())
|
||||
.collect(),
|
||||
))
|
||||
.client_token(uuid::Uuid::new_v4().to_string())
|
||||
.build()
|
||||
.expect(BUILT)
|
||||
}
|
||||
|
||||
/// RunTask refused on a per-user cluster: the workspace policy lets a caller
|
||||
/// run tasks only on the cluster named after their own `triple-c-user`
|
||||
/// principal tag.
|
||||
pub const EC2_TAG_MISMATCH: &str = "This EC2 capacity belongs to a different triple-c-user value \
|
||||
than your sign-in's (or your sign-in has no triple-c-user tag). Ask an admin.";
|
||||
|
||||
/// The family of `arn:...:task-definition/<family>:<revision>`, when the
|
||||
/// revision is a number. `None` for a bare family or anything else.
|
||||
pub fn revision_family(arn: &str) -> Option<&str> {
|
||||
@@ -271,14 +342,15 @@ pub struct TaskStart {
|
||||
}
|
||||
|
||||
/// The project's live task if there is one (Review Focus 2: never a second
|
||||
/// task for a project), else RunTask with the exact `task_def_arn`.
|
||||
/// task for a project), else RunTask with the exact `task_def_arn` where
|
||||
/// `run_on` says.
|
||||
pub async fn find_or_run<A: TaskApi>(
|
||||
api: &A,
|
||||
env: &EnvironmentInfo,
|
||||
owner_user_id: &str,
|
||||
project_id: &str,
|
||||
task_def_arn: &str,
|
||||
spot: bool,
|
||||
run_on: RunOn<'_>,
|
||||
) -> Result<TaskStart, AwsError> {
|
||||
let family = revision_family(task_def_arn).ok_or_else(|| {
|
||||
other(format!(
|
||||
@@ -291,20 +363,43 @@ pub async fn find_or_run<A: TaskApi>(
|
||||
)));
|
||||
}
|
||||
if let Some(task) =
|
||||
find_project_task(api, &env.cluster_arn, family, owner_user_id, project_id).await?
|
||||
find_project_task(api, run_on.cluster(env), family, owner_user_id, project_id).await?
|
||||
{
|
||||
return Ok(TaskStart { task, reused: true });
|
||||
}
|
||||
let tags = workspace_tags(owner_user_id, project_id, &env.name);
|
||||
let task = api
|
||||
.run_task(run_task_request(env, task_def_arn, spot, &tags))
|
||||
.await?;
|
||||
let task = match run_on {
|
||||
RunOn::Fargate { spot } => {
|
||||
api.run_task(run_task_request(env, task_def_arn, spot, &tags)).await?
|
||||
}
|
||||
RunOn::Ec2(compute) => api
|
||||
.run_task(ec2_run_task_request(compute, task_def_arn, &tags))
|
||||
.await
|
||||
.map_err(ec2_run_error)?,
|
||||
};
|
||||
Ok(TaskStart {
|
||||
task,
|
||||
reused: false,
|
||||
})
|
||||
}
|
||||
|
||||
/// A RunTask error on the user's EC2 capacity, in its terms: access denied is
|
||||
/// the `triple-c-user` mismatch ([`EC2_TAG_MISMATCH`]); a placement failure
|
||||
/// (`RESOURCE:CPU`/`RESOURCE:MEMORY`) means no instance can take the task.
|
||||
pub fn ec2_run_error(e: AwsError) -> AwsError {
|
||||
match e {
|
||||
AwsError::AccessDenied { action, message } => AwsError::AccessDenied {
|
||||
action,
|
||||
message: format!("{EC2_TAG_MISMATCH} (AWS said: {message})"),
|
||||
},
|
||||
AwsError::Other { message } if message.contains("RESOURCE:") => other(format!(
|
||||
"{message}. No instance of your EC2 capacity has room for this task: lower its CPU \
|
||||
or memory reservation, or stop another EC2 workspace."
|
||||
)),
|
||||
e => e,
|
||||
}
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------ quotas
|
||||
|
||||
/// Whether an AWS message says an account limit or quota was hit.
|
||||
@@ -386,6 +481,30 @@ impl Default for WaitTiming {
|
||||
}
|
||||
}
|
||||
|
||||
impl WaitTiming {
|
||||
/// An EC2 task's wait: a cold start (capacity scaled to zero) launches
|
||||
/// an instance and pulls the image before the task can run.
|
||||
pub fn ec2() -> Self {
|
||||
WaitTiming {
|
||||
timeout: Duration::from_secs(10 * 60),
|
||||
..Self::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// An EC2 task still waiting for an instance with room: ECS keeps it
|
||||
/// PROVISIONING (or PENDING) with no container instance while the capacity
|
||||
/// provider's managed scaling launches one. (A Fargate task never has a
|
||||
/// container instance, so ask this only of EC2 tasks.)
|
||||
pub fn waiting_for_instance(t: &TaskInfo) -> bool {
|
||||
t.container_instance_arn.is_none()
|
||||
&& t.desired_status == "RUNNING"
|
||||
&& matches!(t.last_status.as_str(), "PROVISIONING" | "PENDING")
|
||||
}
|
||||
|
||||
/// How a [`wait_ready`] timeout begins.
|
||||
pub const WAIT_TIMED_OUT: &str = "The task did not become ready within";
|
||||
|
||||
/// Where a project's task logs go: the environment's log group and the
|
||||
/// project's `awslogs-stream-prefix` (Task 4's `log_stream_prefix`).
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
@@ -440,7 +559,7 @@ pub async fn wait_ready<A: TaskApi>(
|
||||
}
|
||||
if tokio::time::Instant::now() + timing.interval > deadline {
|
||||
return Err(other(format!(
|
||||
"The task did not become ready within {} (last status {}{}). It may still \
|
||||
"{WAIT_TIMED_OUT} {} (last status {}{}). It may still \
|
||||
be starting; check the ECS console, or stop the project and start it again.",
|
||||
describe_timeout(timing.timeout),
|
||||
t.last_status,
|
||||
@@ -483,6 +602,11 @@ async fn stopped_error<A: TaskApi>(api: &A, logs: &TaskLogs, t: &TaskInfo) -> Aw
|
||||
/// so an idle stop (`EssentialContainerExited`) is not mistaken for a crash.
|
||||
pub const IDLE_EXIT_CODE: i32 = 75;
|
||||
|
||||
/// The entrypoint's exit status after the environment's lifetime cap stopped
|
||||
/// the workspace (`TRIPLEC_MAX_LIFETIME_MINUTES`, enforced by the in-container
|
||||
/// idle watcher — advisory, see the phase 6 constraints, Q8).
|
||||
pub const LIFETIME_EXIT_CODE: i32 = 76;
|
||||
|
||||
/// Why a task stopped, as the app reports it (spec, "Lifecycle and status").
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum StopKind {
|
||||
@@ -491,6 +615,8 @@ pub enum StopKind {
|
||||
Exited(Option<String>),
|
||||
/// The workspace's own idle stop ([`IDLE_EXIT_CODE`]).
|
||||
Idle,
|
||||
/// The environment's maximum workspace lifetime ([`LIFETIME_EXIT_CODE`]).
|
||||
LifetimeCap,
|
||||
/// A Fargate Spot interruption (P8).
|
||||
Spot,
|
||||
/// Never got going: the project goes to Error with this reason.
|
||||
@@ -510,6 +636,9 @@ pub fn classify_stop(info: &TaskInfo) -> StopKind {
|
||||
),
|
||||
Some("UserInitiated") => StopKind::UserInitiated,
|
||||
Some("EssentialContainerExited") if info.exit_code == Some(IDLE_EXIT_CODE) => StopKind::Idle,
|
||||
Some("EssentialContainerExited") if info.exit_code == Some(LIFETIME_EXIT_CODE) => {
|
||||
StopKind::LifetimeCap
|
||||
}
|
||||
_ => StopKind::Exited(info.stopped_reason.clone().filter(|r| !r.trim().is_empty())),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,6 +41,7 @@ fn env_info() -> EnvironmentInfo {
|
||||
log_group: "/triple-c/dev".into(),
|
||||
network_mode: "public".into(),
|
||||
tenancy: "strict".into(),
|
||||
max_workspace_hours: 0,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -63,6 +64,9 @@ fn info(id: &str, last: &str) -> TaskInfo {
|
||||
stopped_reason: None,
|
||||
task_definition_arn: td_arn(3),
|
||||
runtime_id: None,
|
||||
container_instance_arn: None,
|
||||
exec_enabled: true,
|
||||
created_unix: None,
|
||||
exec_agent_running: false,
|
||||
exit_code: None,
|
||||
owner: Some(USER.into()),
|
||||
@@ -229,7 +233,7 @@ async fn an_existing_running_task_is_reused_and_nothing_is_run() {
|
||||
..Default::default()
|
||||
}
|
||||
.describing(vec![vec![ready("t1")]]);
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(4), false)
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(4), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(got.reused);
|
||||
@@ -245,7 +249,7 @@ async fn a_pending_task_is_reused_too() {
|
||||
..Default::default()
|
||||
}
|
||||
.describing(vec![vec![info("t1", "PENDING")]]);
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), false)
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(got.reused);
|
||||
@@ -271,7 +275,7 @@ async fn a_task_of_another_owner_or_project_in_the_family_is_never_reused() {
|
||||
..Default::default()
|
||||
}
|
||||
.describing(vec![vec![foreign, other_project, untagged]]);
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), false)
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(!got.reused);
|
||||
@@ -288,7 +292,7 @@ async fn a_task_already_stopping_is_not_reused() {
|
||||
..Default::default()
|
||||
}
|
||||
.describing(vec![vec![stopping, info("t2", "DEPROVISIONING")]]);
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), false)
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(!got.reused);
|
||||
@@ -311,7 +315,7 @@ async fn a_running_task_is_preferred_over_a_pending_one() {
|
||||
#[tokio::test]
|
||||
async fn nothing_listed_means_no_describe_and_a_run_with_the_exact_revision_and_tags() {
|
||||
let api = Fake::default();
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(7), true)
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(7), RunOn::Fargate { spot: true })
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(!got.reused);
|
||||
@@ -344,7 +348,7 @@ async fn a_bare_family_or_foreign_arn_is_refused_before_any_call() {
|
||||
format!("arn:aws:ecs:{REGION}:{ACCOUNT}:task-definition/{FAMILY}:latest"),
|
||||
"arn:aws:ecs:eu-west-1:1:task-definition/someone-else:1".to_string(),
|
||||
] {
|
||||
let err = find_or_run(&api, &env_info(), USER, PROJECT_ID, &bad, false)
|
||||
let err = find_or_run(&api, &env_info(), USER, PROJECT_ID, &bad, RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert!(matches!(err, AwsError::Other { .. }), "{bad}: {err:?}");
|
||||
@@ -357,7 +361,7 @@ async fn a_quota_refusal_is_reported_once_without_retrying() {
|
||||
let api = Fake::default().running(Err(quota_error(
|
||||
"You've reached the limit on the number of vCPUs you can run concurrently",
|
||||
)));
|
||||
let err = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), false)
|
||||
let err = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert!(is_quota_error(&err));
|
||||
@@ -651,6 +655,11 @@ fn classify_stop_follows_the_spec_table() {
|
||||
// The entrypoint's idle stop exits with its own status.
|
||||
let idle = TaskInfo { exit_code: Some(IDLE_EXIT_CODE), ..with(Some("EssentialContainerExited"), None) };
|
||||
assert_eq!(classify_stop(&idle), StopKind::Idle);
|
||||
// So does its lifetime-cap stop.
|
||||
let capped = TaskInfo { exit_code: Some(LIFETIME_EXIT_CODE), ..with(Some("EssentialContainerExited"), None) };
|
||||
assert_eq!(classify_stop(&capped), StopKind::LifetimeCap);
|
||||
let user_capped = TaskInfo { exit_code: Some(LIFETIME_EXIT_CODE), ..with(Some("UserInitiated"), None) };
|
||||
assert_eq!(classify_stop(&user_capped), StopKind::UserInitiated);
|
||||
let crashed = TaskInfo { exit_code: Some(137), ..with(Some("EssentialContainerExited"), None) };
|
||||
assert_eq!(classify_stop(&crashed), StopKind::Exited(None));
|
||||
// Only with that stop code: a user stop of a task that exits 75 is a user stop.
|
||||
@@ -742,3 +751,133 @@ fn task_info_reads_the_workspace_container_and_its_exec_agent() {
|
||||
assert_eq!(bare.exit_code, None);
|
||||
assert_eq!(bare.owner, None);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------- EC2 (phase 7)
|
||||
|
||||
fn user_cluster() -> String {
|
||||
format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/triple-c-dev--u-alice")
|
||||
}
|
||||
|
||||
fn compute() -> UserCompute {
|
||||
UserCompute {
|
||||
instance_type: "m7i.large".into(),
|
||||
max_instances: 2,
|
||||
user_tag: "alice".into(),
|
||||
cluster_arn: user_cluster(),
|
||||
capacity_provider: "triple-c-dev--u-alice".into(),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ec2_run_uses_the_users_cluster_and_capacity_provider_and_no_network() {
|
||||
let c = compute();
|
||||
let req = ec2_run_task_request(&c, &td_arn(3), &tags());
|
||||
assert_eq!(req.cluster(), Some(user_cluster().as_str()));
|
||||
assert_eq!(req.task_definition(), Some(td_arn(3).as_str()));
|
||||
assert_eq!(req.launch_type(), None, "exclusive with a capacity provider strategy");
|
||||
let strategy = req.capacity_provider_strategy();
|
||||
assert_eq!(strategy.len(), 1);
|
||||
assert_eq!(strategy[0].capacity_provider(), "triple-c-dev--u-alice");
|
||||
assert_eq!(strategy[0].weight(), 1);
|
||||
assert!(req.network_configuration().is_none(), "bridge networking (R2)");
|
||||
assert_eq!(req.enable_execute_command(), Some(true));
|
||||
assert_eq!(req.count(), Some(1));
|
||||
assert!(req.client_token().is_some_and(|t| !t.is_empty()));
|
||||
let got: Vec<(String, String)> = req
|
||||
.tags()
|
||||
.iter()
|
||||
.map(|t| (t.key().unwrap().to_string(), t.value().unwrap().to_string()))
|
||||
.collect();
|
||||
assert_eq!(got, tags());
|
||||
assert!(req.overrides().is_none());
|
||||
assert!(req.propagate_tags().is_none());
|
||||
assert!(req.enable_ecs_managed_tags().is_none());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_ec2_find_or_run_looks_and_runs_on_the_users_cluster() {
|
||||
let api = Fake::default();
|
||||
let c = compute();
|
||||
let got = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Ec2(&c))
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(!got.reused);
|
||||
assert_eq!(api.calls(), vec![format!("list {} {FAMILY}", user_cluster()), "run".to_string()]);
|
||||
let req = &api.run_requests.lock().unwrap()[0];
|
||||
assert_eq!(req.cluster(), Some(user_cluster().as_str()));
|
||||
assert_eq!(req.capacity_provider_strategy()[0].capacity_provider(), "triple-c-dev--u-alice");
|
||||
assert_eq!(RunOn::Ec2(&c).cluster(&env_info()), user_cluster());
|
||||
assert_eq!(RunOn::Fargate { spot: true }.cluster(&env_info()), cluster());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn access_denied_on_the_users_cluster_says_the_triple_c_user_value_is_wrong() {
|
||||
let api = Fake::default().running(Err(AwsError::AccessDenied {
|
||||
action: "ecs:RunTask".into(),
|
||||
message: "not authorized to perform ecs:RunTask on cluster/triple-c-dev--u-alice".into(),
|
||||
}));
|
||||
let c = compute();
|
||||
let e = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Ec2(&c))
|
||||
.await
|
||||
.unwrap_err();
|
||||
let AwsError::AccessDenied { action, message } = &e else { panic!("{e:?}") };
|
||||
assert_eq!(action, "ecs:RunTask");
|
||||
assert!(message.starts_with(EC2_TAG_MISMATCH), "{message}");
|
||||
assert!(message.contains("not authorized"), "AWS's words are kept: {message}");
|
||||
assert!(EC2_TAG_MISMATCH.contains("different triple-c-user value"));
|
||||
assert!(EC2_TAG_MISMATCH.contains("Ask an admin"));
|
||||
|
||||
// The same refusal on Fargate is left as it is.
|
||||
let api = Fake::default().running(Err(AwsError::AccessDenied {
|
||||
action: "ecs:RunTask".into(),
|
||||
message: "nope".into(),
|
||||
}));
|
||||
let e = find_or_run(&api, &env_info(), USER, PROJECT_ID, &td_arn(3), RunOn::Fargate { spot: false })
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert_eq!(e, AwsError::AccessDenied { action: "ecs:RunTask".into(), message: "nope".into() });
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_placement_failure_on_ec2_says_no_instance_has_room() {
|
||||
let e = ec2_run_error(
|
||||
run_task_outcome(Vec::new(), vec![(Some("RESOURCE:MEMORY".into()), None)]).unwrap_err(),
|
||||
);
|
||||
assert!(e.to_string().contains("RESOURCE:MEMORY"), "{e}");
|
||||
assert!(e.to_string().contains("No instance of your EC2 capacity has room"), "{e}");
|
||||
// Anything else passes through.
|
||||
let q = quota_error("limit");
|
||||
assert_eq!(ec2_run_error(q.clone()), q);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ec2_task_without_an_instance_is_waiting_for_one() {
|
||||
let provisioning = info("t", "PROVISIONING");
|
||||
assert!(waiting_for_instance(&provisioning));
|
||||
assert!(waiting_for_instance(&info("t", "PENDING")));
|
||||
let placed = TaskInfo {
|
||||
container_instance_arn: Some(format!(
|
||||
"arn:aws:ecs:{REGION}:{ACCOUNT}:container-instance/triple-c-dev--u-alice/abc"
|
||||
)),
|
||||
..info("t", "PENDING")
|
||||
};
|
||||
assert!(!waiting_for_instance(&placed));
|
||||
assert!(!waiting_for_instance(&info("t", "RUNNING")));
|
||||
assert!(!waiting_for_instance(&info("t", "STOPPED")));
|
||||
// The EC2 wait leaves room for an instance launch and an image pull.
|
||||
assert_eq!(WaitTiming::ec2().timeout, Duration::from_secs(600));
|
||||
assert_eq!(WaitTiming::ec2().interval, WaitTiming::default().interval);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn task_info_reads_the_container_instance() {
|
||||
let t = Task::builder()
|
||||
.task_arn(task_arn("t"))
|
||||
.container_instance_arn("arn:aws:ecs:eu-west-1:111122223333:container-instance/c/1")
|
||||
.build();
|
||||
assert_eq!(
|
||||
task_info(&t).container_instance_arn.as_deref(),
|
||||
Some("arn:aws:ecs:eu-west-1:111122223333:container-instance/c/1")
|
||||
);
|
||||
assert_eq!(task_info(&Task::builder().build()).container_instance_arn, None);
|
||||
}
|
||||
@@ -15,10 +15,17 @@ use crate::models::host_connection::validate_supported_region;
|
||||
|
||||
/// `locals.template_version` (and the `triple-c:template-version` default
|
||||
/// tag) of `aws/terraform/environment`.
|
||||
pub const ENVIRONMENT_MODULE_VERSION: u32 = 1;
|
||||
/// The same for the user-onboarding module.
|
||||
pub const ENVIRONMENT_MODULE_VERSION: u32 = 2;
|
||||
/// The same for the user-onboarding module. 2: optional per-user EC2
|
||||
/// capacity (phase 7); an onboarding without it plans as version 1 did,
|
||||
/// apart from this tag.
|
||||
#[allow(dead_code)] // the onboarding module's version; checked against its HCL by a test
|
||||
pub const ONBOARD_MODULE_VERSION: u32 = 1;
|
||||
pub const ONBOARD_MODULE_VERSION: u32 = 2;
|
||||
/// The same for the permissions-boundary module. 2: the instance role's ECS
|
||||
/// agent actions, on its own cluster (phase 7, E4); an account admin
|
||||
/// re-applies the boundary once.
|
||||
#[allow(dead_code)] // checked against its HCL by a test; nothing reads the tag yet
|
||||
pub const BOUNDARY_MODULE_VERSION: u32 = 2;
|
||||
/// The permissions boundary every module-created role carries (no path).
|
||||
/// Equal to [`super::policies::PERMISSIONS_BOUNDARY_NAME`]; a test checks it.
|
||||
pub const BOUNDARY_POLICY_NAME: &str = "triple-c-permissions-boundary";
|
||||
@@ -52,6 +59,7 @@ const USER_ONBOARD_FILES: &[(&str, &str)] = module!("user-onboard":
|
||||
"main.tf",
|
||||
"iam.tf",
|
||||
"efs.tf",
|
||||
"ec2.tf",
|
||||
"outputs.tf",
|
||||
".terraform.lock.hcl",
|
||||
);
|
||||
@@ -132,6 +140,100 @@ pub fn user_role_names(env: &str, owner_key: &str) -> (String, String) {
|
||||
)
|
||||
}
|
||||
|
||||
/// The principal tag every EC2 user's sign-in carries (phase 7, amended E1):
|
||||
/// an admin sets it (an IAM Identity Center attribute for access control,
|
||||
/// or a tag on the IAM user or role), and the workspace policy lets a
|
||||
/// caller run tasks only on the per-user cluster named after its value.
|
||||
#[allow(dead_code)] // the onboarding module (Task 3) and the UI read it
|
||||
pub const EC2_USER_TAG_KEY: &str = "triple-c-user";
|
||||
|
||||
/// Checks a `triple-c-user` tag value: 1 to 32 characters of
|
||||
/// `[A-Za-z0-9-]`, not starting or ending with a hyphen and without `--`
|
||||
/// (the separator in [`user_ec2_stem`], which environment names can't hold
|
||||
/// either, so a per-user name can be read back only one way).
|
||||
pub fn validate_ec2_user_tag(tag: &str) -> Result<String, String> {
|
||||
let ok = (1..=32).contains(&tag.len())
|
||||
&& tag.bytes().all(|c| c.is_ascii_alphanumeric() || c == b'-')
|
||||
&& !tag.starts_with('-')
|
||||
&& !tag.ends_with('-')
|
||||
&& !tag.contains("--");
|
||||
if ok {
|
||||
Ok(tag.to_string())
|
||||
} else {
|
||||
Err(format!(
|
||||
"\"{}\" is not a valid triple-c-user tag: use 1 to 32 letters, digits and single \
|
||||
hyphens, not starting or ending with a hyphen",
|
||||
tag.escape_debug()
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
/// The name of a user's EC2 cluster, capacity provider, Auto Scaling group
|
||||
/// and launch template: `triple-c-<env>--u-<user tag>` (at most 65
|
||||
/// characters). Environment names and user tags never contain `--`, so the
|
||||
/// workspace policy's `cluster/triple-c-*--u-*` matches exactly the
|
||||
/// per-user clusters, and `triple-c-*--u-<tag>` exactly that user's.
|
||||
pub fn user_ec2_stem(env: &str, user_tag: &str) -> String {
|
||||
format!("triple-c-{env}--u-{user_tag}")
|
||||
}
|
||||
|
||||
/// Whether `cluster` (a cluster *name*) is one of `env`'s per-user EC2
|
||||
/// clusters ([`user_ec2_stem`] of a valid tag).
|
||||
pub fn is_user_ec2_cluster(env: &str, cluster: &str) -> bool {
|
||||
cluster
|
||||
.strip_prefix(&format!("{}--u-", environment_cluster_name(env)))
|
||||
.is_some_and(|tag| validate_ec2_user_tag(tag).is_ok())
|
||||
}
|
||||
|
||||
/// A user's EC2 instance role (and instance profile): named by owner key,
|
||||
/// not the user tag, because role names are account-global and at most 64
|
||||
/// characters (this is at most 51). The admin's PassRole to EC2 names
|
||||
/// `role/triple-c-*-instance`.
|
||||
#[allow(dead_code)] // the onboarding module builds it; pinned by tests
|
||||
pub fn user_instance_role_name(env: &str, owner_key: &str) -> String {
|
||||
format!("triple-c-{env}-{owner_key}-instance")
|
||||
}
|
||||
|
||||
/// The SSM parameter holding a user's EC2 record (E11), written by their
|
||||
/// onboarding module only while it has EC2 capacity: a String of JSON with
|
||||
/// exactly [`USER_RECORD_FIELDS`]. Workspace users can read it
|
||||
/// (`parameter/triple-c/*`) though not the state bucket; it lives outside
|
||||
/// `/triple-c/environments/`, which environment detection lists.
|
||||
#[allow(dead_code)] // the app reads it from Task 4 on
|
||||
pub fn user_record_parameter_name(env: &str, owner_key: &str) -> String {
|
||||
format!("/triple-c/users/{env}/{owner_key}")
|
||||
}
|
||||
|
||||
/// The fields of a user's EC2 record, schema 1: `instance_type`,
|
||||
/// `cluster_arn` (the user's cluster, [`user_ec2_stem`]),
|
||||
/// `capacity_provider` (its one provider, the same name) and `user_tag`
|
||||
/// (the `triple-c-user` value the cluster is named after) and
|
||||
/// `max_instances` (the group's maximum), so a re-apply can keep them.
|
||||
/// `environments::parse_user_record` reads them; a test pins the HCL to it.
|
||||
#[allow(dead_code)]
|
||||
pub const USER_RECORD_FIELDS: [&str; 6] = [
|
||||
"schema",
|
||||
"instance_type",
|
||||
"cluster_arn",
|
||||
"capacity_provider",
|
||||
"user_tag",
|
||||
"max_instances",
|
||||
];
|
||||
|
||||
/// The most instances a user's EC2 capacity may run at once.
|
||||
pub const EC2_MAX_INSTANCES: u32 = 4;
|
||||
|
||||
/// A user's optional EC2 capacity, as the onboarding module takes it.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
||||
pub struct Ec2Compute {
|
||||
/// One of the types `ec2_instance_spec` knows.
|
||||
pub instance_type: String,
|
||||
/// 1 to [`EC2_MAX_INSTANCES`].
|
||||
pub max_instances: u32,
|
||||
/// The user's `triple-c-user` principal tag value.
|
||||
pub user_tag: String,
|
||||
}
|
||||
|
||||
/// Whether a project id is used in names as it is: 1 to 64 characters of
|
||||
/// `[A-Za-z0-9-]`. Every UUID (how the app makes ids) is.
|
||||
fn is_clean_project_id(id: &str) -> bool {
|
||||
@@ -202,6 +304,17 @@ pub fn access_point_root(owner_key: &str, project_id: &str) -> String {
|
||||
format!("/triple-c/{owner_key}/{}", project_component(project_id))
|
||||
}
|
||||
|
||||
/// The root of the project's EFS-mode `/workspace` access point (Q1):
|
||||
/// `/triple-c-workspaces/<owner_key>/<project>`, a sibling tree of the home
|
||||
/// roots (under [`access_point_root`] it would sit inside the home access
|
||||
/// point). At most 100 characters.
|
||||
pub fn workspace_access_point_root(owner_key: &str, project_id: &str) -> String {
|
||||
format!(
|
||||
"/triple-c-workspaces/{owner_key}/{}",
|
||||
project_component(project_id)
|
||||
)
|
||||
}
|
||||
|
||||
/// The container's `awslogs-stream-prefix`; ECS names the stream
|
||||
/// `<prefix>/workspace/<task id>`.
|
||||
pub fn log_stream_prefix(owner_key: &str, project_id: &str) -> String {
|
||||
@@ -274,14 +387,23 @@ fn is_aws_id(id: &str, prefix: &str) -> bool {
|
||||
})
|
||||
}
|
||||
|
||||
/// The longest lifetime cap an environment can carry, in hours (a week).
|
||||
pub const MAX_WORKSPACE_HOURS: u32 = 168;
|
||||
|
||||
/// The environment module's `terraform.tfvars.json`. Applies the same rules
|
||||
/// as the module's variable validations, so a bad value fails here first.
|
||||
pub fn environment_vars(
|
||||
env: &str,
|
||||
region: &str,
|
||||
network: &NetworkChoice,
|
||||
max_workspace_hours: u32,
|
||||
) -> Result<serde_json::Value, String> {
|
||||
let env = validate_environment_name(env)?;
|
||||
if max_workspace_hours > MAX_WORKSPACE_HOURS {
|
||||
return Err(format!(
|
||||
"The maximum workspace lifetime is at most {MAX_WORKSPACE_HOURS} hours (0 = no cap)"
|
||||
));
|
||||
}
|
||||
let region = validate_supported_region(region)?;
|
||||
let (mode, vpc_id, subnet_ids, assign_public_ip) = match network {
|
||||
NetworkChoice::Public => ("public", String::new(), Vec::new(), false),
|
||||
@@ -322,20 +444,51 @@ pub fn environment_vars(
|
||||
"vpc_id": vpc_id,
|
||||
"subnet_ids": subnet_ids,
|
||||
"assign_public_ip": assign_public_ip,
|
||||
"max_workspace_hours": max_workspace_hours,
|
||||
}))
|
||||
}
|
||||
|
||||
/// The onboarding module's `terraform.tfvars.json` for the user whose
|
||||
/// `aws:userid` is `owner_id`. Bedrock stays on the workspace user's own
|
||||
/// credentials unless a later setting opts the task role in.
|
||||
pub fn onboarding_vars(env: &str, region: &str, owner_id: &str) -> serde_json::Value {
|
||||
json!({
|
||||
/// `aws:userid` is `owner_id`, with their EC2 capacity or none (empty
|
||||
/// `ec2_instance_type`: the module makes nothing for EC2). Applies the same
|
||||
/// rules as the module's EC2 variable validations. Bedrock stays on the
|
||||
/// workspace user's own credentials unless a later setting opts the task
|
||||
/// role in.
|
||||
pub fn onboarding_vars(
|
||||
env: &str,
|
||||
region: &str,
|
||||
owner_id: &str,
|
||||
ec2: Option<&Ec2Compute>,
|
||||
) -> Result<serde_json::Value, String> {
|
||||
let (instance_type, max_instances, user_tag) = match ec2 {
|
||||
None => (String::new(), 1, String::new()),
|
||||
Some(c) => {
|
||||
if crate::models::project::ec2_instance_spec(&c.instance_type).is_none() {
|
||||
return Err(format!(
|
||||
"\"{}\" is not an instance type Triple-C supports (m7i, m7g, c7i, c7g, r7i, \
|
||||
r7g from large to 4xlarge; t3, t4g from large to 2xlarge)",
|
||||
c.instance_type.escape_debug()
|
||||
));
|
||||
}
|
||||
if !(1..=EC2_MAX_INSTANCES).contains(&c.max_instances) {
|
||||
return Err(format!(
|
||||
"The number of instances must be from 1 to {EC2_MAX_INSTANCES}"
|
||||
));
|
||||
}
|
||||
let tag = validate_ec2_user_tag(&c.user_tag)?;
|
||||
(c.instance_type.clone(), c.max_instances, tag)
|
||||
}
|
||||
};
|
||||
Ok(json!({
|
||||
"environment_name": env,
|
||||
"region": region,
|
||||
"owner_id": owner_id,
|
||||
"owner_key": owner_key(region, owner_id),
|
||||
"bedrock_on_task_role": false,
|
||||
})
|
||||
"ec2_instance_type": instance_type,
|
||||
"ec2_max_instances": max_instances,
|
||||
"ec2_user_tag": user_tag,
|
||||
}))
|
||||
}
|
||||
|
||||
/// The boundary module's `terraform.tfvars.json`: the shipped boundary
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
+839
-121
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -9,6 +9,12 @@ pub async fn check_docker() -> Result<bool, String> {
|
||||
docker::check_docker_available().await
|
||||
}
|
||||
|
||||
/// Like `check_docker`, but says *why* Docker is unavailable.
|
||||
#[tauri::command]
|
||||
pub async fn check_docker_status() -> Result<docker::status::DockerStatus, String> {
|
||||
Ok(docker::client::docker_status().await)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn check_image_exists(state: State<'_, AppState>) -> Result<bool, String> {
|
||||
let settings = state.settings_store.get();
|
||||
|
||||
@@ -30,7 +30,7 @@ use std::sync::{Mutex, OnceLock};
|
||||
use std::time::Duration;
|
||||
|
||||
use aws_config::SdkConfig;
|
||||
use serde::Serialize;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::Value;
|
||||
use tauri::{AppHandle, Emitter, State};
|
||||
|
||||
@@ -38,17 +38,20 @@ use aws_sdk_s3::error::ProvideErrorMetadata;
|
||||
use tokio::sync::oneshot;
|
||||
|
||||
use crate::aws::environments::{
|
||||
ensure_state_bucket, scan, state_bucket_policy, LIVE_LOCK_SECS, DetectedEnvironment,
|
||||
EnvironmentAction, EnvironmentInfo, EnvironmentScan, EnvironmentState, Knowable, LocalRun,
|
||||
OnboardingState, SdkDetectApi,
|
||||
cluster_holder, ec2_name_holders, ensure_state_bucket, scan, state_bucket_policy,
|
||||
user_record_from, DetectedEnvironment, EnvironmentAction, EnvironmentInfo, EnvironmentScan,
|
||||
EnvironmentState, Knowable, LocalRun, NameHolder, OnboardApi, OnboardingState, SdkDetectApi,
|
||||
SdkOnboardApi, UserCompute, UserRecord, LIVE_LOCK_SECS,
|
||||
};
|
||||
use crate::aws::tofu::{
|
||||
self, backend_hcl, StartError, TofuEvent, TofuOp, TofuOutcome, Workdir,
|
||||
};
|
||||
use crate::aws::tofu_modules::{
|
||||
boundary_vars, environment_vars, module_files, onboarding_vars, owner_key, state_bucket_name,
|
||||
state_key, validate_environment_name, Deployment, ModuleKind, NetworkChoice,
|
||||
state_key, user_ec2_stem, user_record_parameter_name, validate_ec2_user_tag,
|
||||
validate_environment_name, Deployment, Ec2Compute, ModuleKind, NetworkChoice,
|
||||
};
|
||||
use crate::models::project::{ec2_instance_types, Ec2InstanceType, DEFAULT_EC2_INSTANCE_TYPE};
|
||||
use crate::aws::{caller_identity, sdk_config, AwsError, CallerIdentity};
|
||||
use crate::models::{validate_supported_region, AwsAuth, HostConnection, HostKind};
|
||||
use crate::storage::secure;
|
||||
@@ -178,8 +181,9 @@ pub(crate) fn network_from_record(
|
||||
subnet_ids: info.subnet_ids.clone(),
|
||||
assign_public_ip: info.assign_public_ip,
|
||||
};
|
||||
// The same checks as the apply's variables.
|
||||
environment_vars(&info.name, "us-east-1", &choice)?;
|
||||
// The same checks as the apply's variables. Only the network is
|
||||
// checked here, so the lifetime cap is a valid placeholder (0).
|
||||
environment_vars(&info.name, "us-east-1", &choice, 0)?;
|
||||
Ok(choice)
|
||||
}
|
||||
_ => Err("The environment record names an unknown network mode".into()),
|
||||
@@ -271,7 +275,7 @@ pub(crate) fn onboarding_unlock_refusal(
|
||||
}
|
||||
let env = find(scan, name).ok_or_else(|| format!("No environment named \"{name}\" was found"))?;
|
||||
match &env.onboarding {
|
||||
Some(OnboardingState::Incomplete { lock: Some(l) })
|
||||
Some(OnboardingState::Incomplete { lock: Some(l), .. })
|
||||
if !l.local_process && env.onboarding_actions.contains(&EnvironmentAction::Unlock) =>
|
||||
{
|
||||
Ok(())
|
||||
@@ -297,6 +301,140 @@ pub(crate) fn onboard_refusal(scan: &EnvironmentScan, name: &str) -> Result<(),
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The EC2 capacity an onboarding asks for: none (Fargate only), or EC2
|
||||
/// with these values. A command given no choice keeps what the user's
|
||||
/// record holds ([`resolve_ec2`]).
|
||||
#[derive(Deserialize, Serialize, Clone, Debug, PartialEq)]
|
||||
#[serde(tag = "kind", rename_all = "snake_case")]
|
||||
pub enum Ec2Choice {
|
||||
None,
|
||||
Ec2(Ec2Compute),
|
||||
}
|
||||
|
||||
/// What an onboarding apply uses: the explicit choice, or with none given
|
||||
/// the recorded capacity (a re-apply keeps it unless changed). With none
|
||||
/// given and a record that exists but can't be used, it refuses rather than
|
||||
/// apply without EC2, which would tear the capacity down.
|
||||
pub(crate) fn resolve_ec2(
|
||||
choice: Option<Ec2Choice>,
|
||||
record: &UserRecord,
|
||||
) -> Result<Option<Ec2Compute>, String> {
|
||||
match (choice, record) {
|
||||
(Some(Ec2Choice::None), _) => Ok(None),
|
||||
(Some(Ec2Choice::Ec2(c)), _) => Ok(Some(c)),
|
||||
(None, UserRecord::Absent) => Ok(None),
|
||||
(None, UserRecord::Valid(r)) => Ok(Some(Ec2Compute {
|
||||
instance_type: r.instance_type.clone(),
|
||||
max_instances: r.max_instances,
|
||||
user_tag: r.user_tag.clone(),
|
||||
})),
|
||||
(None, UserRecord::Unusable(reason)) => Err(format!(
|
||||
"Your EC2 record can't be used ({reason}), so Triple-C can't keep your EC2 capacity \
|
||||
as it is; choose the EC2 capacity explicitly"
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
/// R3 (amended): an apply with EC2 capacity would adopt (or fail on) a
|
||||
/// per-user cluster or Auto Scaling group named `stem` that already exists.
|
||||
/// Each one found must be the caller's: its `triple-c:owner` tag (the
|
||||
/// module's default tags) is `owner_id`, or, for an untagged one only, the
|
||||
/// caller's record names the cluster. A half-built capacity of the caller's
|
||||
/// own (a failed apply that wrote no record yet) is therefore re-applied;
|
||||
/// one tagged as someone else's is always refused (a record can't vouch for
|
||||
/// it), and an untagged one is refused unless the record names it.
|
||||
pub(crate) fn ec2_collision_refusal(
|
||||
stem: &str,
|
||||
holders: &[NameHolder],
|
||||
owner_id: &str,
|
||||
recorded: Option<&UserCompute>,
|
||||
) -> Result<(), String> {
|
||||
let suffix = format!(":cluster/{stem}");
|
||||
let recorded_here = recorded.is_some_and(|r| r.cluster_arn.ends_with(&suffix));
|
||||
for h in holders {
|
||||
match h.owner.as_deref() {
|
||||
Some(o) if o == owner_id => continue,
|
||||
None if recorded_here => continue,
|
||||
_ => {}
|
||||
}
|
||||
let whose = if h.owner.is_some() {
|
||||
"belongs to another onboarding"
|
||||
} else {
|
||||
"exists but isn't tagged as any Triple-C user's"
|
||||
};
|
||||
return Err(format!(
|
||||
"An {} named {stem} already {whose}. The triple-c-user value is probably wrong: use \
|
||||
the value an admin set as your triple-c-user sign-in tag",
|
||||
h.kind
|
||||
));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Everything a self-onboarding apply needs settled before it starts: the
|
||||
/// caller's record, the capacity ([`resolve_ec2`]), the module variables
|
||||
/// and, with EC2 capacity, the name check ([`ec2_collision_refusal`]).
|
||||
/// Check-then-apply leaves a narrow race (someone else creating the same
|
||||
/// names in between); the module would then fail on create rather than
|
||||
/// adopt. Anyone may start this: there is no tier check in the app, and AWS
|
||||
/// refuses (mapped to `AccessDenied`) what the caller isn't permitted.
|
||||
pub(crate) async fn prepare_onboarding<A: OnboardApi>(
|
||||
api: &A,
|
||||
env: &str,
|
||||
region: &str,
|
||||
account: &str,
|
||||
owner_id: &str,
|
||||
choice: Option<Ec2Choice>,
|
||||
) -> Result<Value, AwsError> {
|
||||
let okey = owner_key(region, owner_id);
|
||||
let read = api.parameter(&user_record_parameter_name(env, &okey)).await?;
|
||||
let record = user_record_from(read, env, account, region);
|
||||
let compute = resolve_ec2(choice, &record).map_err(other)?;
|
||||
let vars = onboarding_vars(env, region, owner_id, compute.as_ref()).map_err(other)?;
|
||||
if let Some(c) = &compute {
|
||||
// The caller's own triple-c-user tag can't be read (session tags
|
||||
// aren't visible to GetCallerIdentity); a wrong value fails later
|
||||
// as access denied.
|
||||
let stem = user_ec2_stem(env, &c.user_tag);
|
||||
let holders = ec2_name_holders(api, &stem).await?;
|
||||
ec2_collision_refusal(&stem, &holders, owner_id, record.valid()).map_err(other)?;
|
||||
}
|
||||
Ok(vars)
|
||||
}
|
||||
|
||||
/// The bundle's version of the check, with what a workspace user can read
|
||||
/// (the cluster, via `ecs:Describe*`, and the record; not the Auto Scaling
|
||||
/// group): a warning to show, never a refusal. The admin runs the full
|
||||
/// check from the README.
|
||||
pub(crate) async fn bundle_ec2_warning<A: OnboardApi>(
|
||||
api: &A,
|
||||
env: &str,
|
||||
region: &str,
|
||||
account: &str,
|
||||
owner_id: &str,
|
||||
compute: &Ec2Compute,
|
||||
) -> Option<String> {
|
||||
let stem = user_ec2_stem(env, &compute.user_tag);
|
||||
let checked = async {
|
||||
let holder = cluster_holder(api, &stem).await?;
|
||||
let read = api
|
||||
.parameter(&user_record_parameter_name(env, &owner_key(region, owner_id)))
|
||||
.await?;
|
||||
let record = user_record_from(read, env, account, region);
|
||||
Ok::<_, AwsError>(
|
||||
ec2_collision_refusal(&stem, &holder.into_iter().collect::<Vec<_>>(), owner_id, record.valid())
|
||||
.err(),
|
||||
)
|
||||
};
|
||||
match checked.await {
|
||||
Ok(warning) => warning,
|
||||
Err(_) => Some(format!(
|
||||
"Triple-C couldn't check whether the EC2 name {stem} is already in use; the README has \
|
||||
the admin check it"
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
/// `AlreadyRunning` is told apart before it becomes an `AwsError`.
|
||||
pub(crate) fn start_error(e: StartError, label: &str) -> AwsError {
|
||||
match e {
|
||||
@@ -414,7 +552,54 @@ const README: &str = "README.txt";
|
||||
const BACKEND: &str = "backend.hcl";
|
||||
const TFVARS: &str = "terraform.tfvars.json";
|
||||
|
||||
fn bundle_readme(d: Deployment, account: &str, region: &str, bucket: &str, key: &str) -> String {
|
||||
/// The onboarding bundle's EC2 step: before applying with EC2 capacity, the
|
||||
/// admin checks that the per-user names are free or already this user's
|
||||
/// (the module can't: a name taken by someone else's onboarding would be
|
||||
/// adopted, and a collision only fails at create). Ownership is the
|
||||
/// resources' `triple-c:owner` tag, or failing that the user's record, as
|
||||
/// in [`ec2_collision_refusal`]. `user_tag` is the bundle's `ec2_user_tag`
|
||||
/// when set and valid; otherwise the commands show `<tag>` for the admin to
|
||||
/// fill in.
|
||||
fn ec2_collision_step(
|
||||
env: &str,
|
||||
owner_key: &str,
|
||||
owner_id: &str,
|
||||
region: &str,
|
||||
user_tag: Option<&str>,
|
||||
) -> String {
|
||||
let stem = user_ec2_stem(env, user_tag.unwrap_or("<tag>"));
|
||||
let record = user_record_parameter_name(env, owner_key);
|
||||
format!(
|
||||
"EC2 capacity (only if ec2_instance_type is set)
|
||||
------------------------------------------------
|
||||
ec2_user_tag must be the value of the user's triple-c-user principal tag.
|
||||
BEFORE tofu apply, check that the per-user EC2 names are not already in use
|
||||
by another onboarding. Run:
|
||||
|
||||
aws ecs describe-clusters --region {region} --clusters {stem} --include TAGS --query 'clusters[?status!=`INACTIVE`].[clusterName,tags[?key==`triple-c:owner`].value|[0]]' --output text
|
||||
aws autoscaling describe-auto-scaling-groups --region {region} --auto-scaling-group-names {stem} --query 'AutoScalingGroups[].[AutoScalingGroupName,Tags[?Key==`triple-c:owner`].Value|[0]]' --output text
|
||||
aws ssm get-parameter --region {region} --name {record} --query Parameter.Value --output text
|
||||
|
||||
If either of the first two prints {stem}, apply ONLY if the owner printed
|
||||
next to it is this user's owner_id ({owner_id}) or the third (this user's
|
||||
record) succeeds and its cluster_arn ends in cluster/{stem}; otherwise the
|
||||
name belongs to someone else's onboarding (or to nobody's): stop and
|
||||
choose the correct ec2_user_tag. (The app runs the same check before
|
||||
applying; run the check right before the apply, since nothing holds the
|
||||
name in between.)
|
||||
|
||||
"
|
||||
)
|
||||
}
|
||||
|
||||
fn bundle_readme(
|
||||
d: Deployment,
|
||||
account: &str,
|
||||
region: &str,
|
||||
bucket: &str,
|
||||
key: &str,
|
||||
vars: &Value,
|
||||
) -> String {
|
||||
let what = match d {
|
||||
Deployment::Environment(env) => format!(
|
||||
"the Triple-C environment \"{env}\" (ECS cluster, security group, KMS key, log \
|
||||
@@ -441,6 +626,16 @@ fn bundle_readme(d: Deployment, account: &str, region: &str, bucket: &str, key:
|
||||
format!(r#"{{"LocationConstraint":"{region}",{tags}}}"#)
|
||||
};
|
||||
let policy = state_bucket_policy(bucket);
|
||||
let ec2_step = match d {
|
||||
Deployment::User { env, owner_key } => {
|
||||
let tag = vars["ec2_user_tag"]
|
||||
.as_str()
|
||||
.filter(|t| validate_ec2_user_tag(t).is_ok());
|
||||
let owner_id = vars["owner_id"].as_str().unwrap_or("<owner_id>");
|
||||
ec2_collision_step(env, owner_key, owner_id, region, tag)
|
||||
}
|
||||
_ => String::new(),
|
||||
};
|
||||
let credentials = match d {
|
||||
Deployment::Boundary => format!(
|
||||
"- Credentials of an account administrator for account {account} WITHOUT
|
||||
@@ -488,7 +683,7 @@ AWS CLI v2 recent enough that create-bucket accepts Tags, e.g. 2.39):
|
||||
aws s3api put-public-access-block --bucket {bucket} --region {region} --expected-bucket-owner {account} --public-access-block-configuration BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true
|
||||
aws s3api put-bucket-policy --bucket {bucket} --region {region} --expected-bucket-owner {account} --policy '{policy}'
|
||||
|
||||
2. Deploy
|
||||
{ec2_step}2. Deploy
|
||||
---------
|
||||
From this folder:
|
||||
|
||||
@@ -528,7 +723,7 @@ fn bundle_files(
|
||||
let json = serde_json::to_string_pretty(vars)
|
||||
.map_err(|e| format!("Could not encode the module variables: {e}"))?;
|
||||
files.push((TFVARS.into(), json + "\n"));
|
||||
files.push((README.into(), bundle_readme(d, account, ®ion, &bucket, &key)));
|
||||
files.push((README.into(), bundle_readme(d, account, ®ion, &bucket, &key, vars)));
|
||||
Ok(files)
|
||||
}
|
||||
|
||||
@@ -1034,13 +1229,20 @@ pub async fn deploy_aws_environment(
|
||||
region: String,
|
||||
name: String,
|
||||
network: NetworkChoice,
|
||||
max_workspace_hours: Option<u32>,
|
||||
app: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<String, AwsError> {
|
||||
let ctx = context(&state, &connection_id, ®ion).await?;
|
||||
let found = detect(&ctx).await?;
|
||||
deploy_refusal(&found, &name).map_err(other)?;
|
||||
let vars = environment_vars(&name, &ctx.region, &network).map_err(other)?;
|
||||
let vars = environment_vars(
|
||||
&name,
|
||||
&ctx.region,
|
||||
&network,
|
||||
max_workspace_hours.unwrap_or(0),
|
||||
)
|
||||
.map_err(other)?;
|
||||
let key = DeploymentKey::Environment(name);
|
||||
opened(launch(app, &ctx, &key, &vars, TofuOp::Apply).await)
|
||||
}
|
||||
@@ -1052,6 +1254,7 @@ pub async fn update_aws_environment(
|
||||
connection_id: String,
|
||||
region: String,
|
||||
name: String,
|
||||
max_workspace_hours: Option<u32>,
|
||||
app: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<String, AwsError> {
|
||||
@@ -1063,7 +1266,9 @@ pub async fn update_aws_environment(
|
||||
.as_ref()
|
||||
.ok_or_else(|| other("The environment has no readable record"))?;
|
||||
let network = recorded_network(&ctx, info).await?;
|
||||
let vars = environment_vars(&env.name, &ctx.region, &network).map_err(other)?;
|
||||
// The recorded cap stays unless the caller changes it.
|
||||
let hours = max_workspace_hours.unwrap_or(info.max_workspace_hours);
|
||||
let vars = environment_vars(&env.name, &ctx.region, &network, hours).map_err(other)?;
|
||||
let key = DeploymentKey::Environment(env.name.clone());
|
||||
opened(launch(app, &ctx, &key, &vars, TofuOp::Apply).await)
|
||||
}
|
||||
@@ -1077,6 +1282,7 @@ pub async fn repair_aws_environment(
|
||||
region: String,
|
||||
name: String,
|
||||
network: Option<NetworkChoice>,
|
||||
max_workspace_hours: Option<u32>,
|
||||
app: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<String, AwsError> {
|
||||
@@ -1092,7 +1298,11 @@ pub async fn repair_aws_environment(
|
||||
))
|
||||
}
|
||||
};
|
||||
let vars = environment_vars(&env.name, &ctx.region, &network).map_err(other)?;
|
||||
// A valid record's cap stays unless the caller changes it.
|
||||
let hours = max_workspace_hours
|
||||
.or(env.info.as_ref().map(|i| i.max_workspace_hours))
|
||||
.unwrap_or(0);
|
||||
let vars = environment_vars(&env.name, &ctx.region, &network, hours).map_err(other)?;
|
||||
let key = DeploymentKey::Environment(env.name.clone());
|
||||
opened(launch(app, &ctx, &key, &vars, TofuOp::Apply).await)
|
||||
}
|
||||
@@ -1113,7 +1323,8 @@ pub async fn destroy_incomplete_aws_environment(
|
||||
let env = destroy_refusal(&found, &name).map_err(other)?;
|
||||
// A destroy plans the removal of everything in state whatever the
|
||||
// network variables say; they only have to be valid.
|
||||
let vars = environment_vars(&env.name, &ctx.region, &NetworkChoice::Public).map_err(other)?;
|
||||
let vars =
|
||||
environment_vars(&env.name, &ctx.region, &NetworkChoice::Public, 0).map_err(other)?;
|
||||
let key = DeploymentKey::Environment(env.name.clone());
|
||||
opened(launch(app, &ctx, &key, &vars, TofuOp::Destroy).await)
|
||||
}
|
||||
@@ -1300,12 +1511,15 @@ pub async fn cancel_aws_deployment(
|
||||
}
|
||||
|
||||
/// Onboard the caller to `environment`, as the owner their own
|
||||
/// `aws:userid` names.
|
||||
/// `aws:userid` names, with the EC2 capacity `ec2` asks for (omitted: keep
|
||||
/// what their user record holds, none without one). With EC2 capacity the
|
||||
/// per-user names must be free or already theirs (R3).
|
||||
#[tauri::command]
|
||||
pub async fn onboard_aws_user(
|
||||
connection_id: String,
|
||||
region: String,
|
||||
environment: String,
|
||||
ec2: Option<Ec2Choice>,
|
||||
app: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<String, AwsError> {
|
||||
@@ -1314,7 +1528,15 @@ pub async fn onboard_aws_user(
|
||||
let owner = validate_owner_id(&ctx.who.user_id).map_err(other)?;
|
||||
let found = detect(&ctx).await?;
|
||||
onboard_refusal(&found, &env).map_err(other)?;
|
||||
let vars = onboarding_vars(&env, &ctx.region, &owner);
|
||||
let vars = prepare_onboarding(
|
||||
&SdkOnboardApi::new(&ctx.cfg),
|
||||
&env,
|
||||
&ctx.region,
|
||||
&ctx.who.account,
|
||||
&owner,
|
||||
ec2,
|
||||
)
|
||||
.await?;
|
||||
let key = DeploymentKey::User {
|
||||
owner_key: owner_key(&ctx.region, &owner),
|
||||
env,
|
||||
@@ -1322,6 +1544,22 @@ pub async fn onboard_aws_user(
|
||||
opened(launch(app, &ctx, &key, &vars, TofuOp::Apply).await)
|
||||
}
|
||||
|
||||
/// The EC2 instance types onboarding offers (the app's built-in table) and
|
||||
/// the one it offers first.
|
||||
#[derive(Serialize, Clone, Debug, PartialEq)]
|
||||
pub struct Ec2InstanceTable {
|
||||
pub default_type: &'static str,
|
||||
pub types: Vec<Ec2InstanceType>,
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn list_ec2_instance_types() -> Ec2InstanceTable {
|
||||
Ec2InstanceTable {
|
||||
default_type: DEFAULT_EC2_INSTANCE_TYPE,
|
||||
types: ec2_instance_types(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Deploy (or re-apply) the account's permissions boundary. Refused when
|
||||
/// the boundary exists but this region's bucket has no state for it.
|
||||
#[tauri::command]
|
||||
@@ -1361,8 +1599,10 @@ async fn pick_folder(window: &tauri::Window) -> Option<PathBuf> {
|
||||
/// Write an admin bundle (D5) for `kind` into a folder the user picks:
|
||||
/// `environment` names the environment (environment and onboarding),
|
||||
/// `owner_id` the user to onboard (an `aws:userid`), `network` an
|
||||
/// environment's network (public when omitted). `None` when the dialog was
|
||||
/// dismissed; otherwise the folder written.
|
||||
/// environment's network (public when omitted), `ec2` an onboarding's EC2
|
||||
/// capacity (none when omitted; the bundle's README has the admin check
|
||||
/// its names first). `None` when the dialog was dismissed; otherwise the
|
||||
/// folder written and any warning.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
#[tauri::command]
|
||||
pub async fn save_aws_admin_bundle(
|
||||
@@ -1372,9 +1612,11 @@ pub async fn save_aws_admin_bundle(
|
||||
environment: Option<String>,
|
||||
owner_id: Option<String>,
|
||||
network: Option<NetworkChoice>,
|
||||
max_workspace_hours: Option<u32>,
|
||||
ec2: Option<Ec2Compute>,
|
||||
window: tauri::Window,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Option<String>, AwsError> {
|
||||
) -> Result<Option<SavedBundle>, AwsError> {
|
||||
let need_env = || {
|
||||
environment
|
||||
.as_deref()
|
||||
@@ -1386,8 +1628,13 @@ pub async fn save_aws_admin_bundle(
|
||||
let (key, vars) = match kind {
|
||||
ModuleKind::Environment => {
|
||||
let env = need_env()?;
|
||||
let vars = environment_vars(&env, ®ion_ok, &network.unwrap_or(NetworkChoice::Public))
|
||||
.map_err(other)?;
|
||||
let vars = environment_vars(
|
||||
&env,
|
||||
®ion_ok,
|
||||
&network.unwrap_or(NetworkChoice::Public),
|
||||
max_workspace_hours.unwrap_or(0),
|
||||
)
|
||||
.map_err(other)?;
|
||||
(DeploymentKey::Environment(env), vars)
|
||||
}
|
||||
ModuleKind::UserOnboard => {
|
||||
@@ -1397,7 +1644,7 @@ pub async fn save_aws_admin_bundle(
|
||||
.map(str::trim)
|
||||
.ok_or_else(|| other("The user's owner id (aws:userid) is required"))
|
||||
.and_then(|o| validate_owner_id(o).map_err(other))?;
|
||||
let vars = onboarding_vars(&env, ®ion_ok, &owner);
|
||||
let vars = onboarding_vars(&env, ®ion_ok, &owner, ec2.as_ref()).map_err(other)?;
|
||||
(
|
||||
DeploymentKey::User {
|
||||
owner_key: owner_key(®ion_ok, &owner),
|
||||
@@ -1409,11 +1656,29 @@ pub async fn save_aws_admin_bundle(
|
||||
ModuleKind::PermissionsBoundary => (DeploymentKey::Boundary, boundary_vars(®ion_ok)),
|
||||
};
|
||||
let ctx = context(&state, &connection_id, ®ion).await?;
|
||||
let warning = match (&key, &ec2, &owner_id) {
|
||||
(DeploymentKey::User { env, .. }, Some(c), Some(owner)) => {
|
||||
let api = SdkOnboardApi::new(&ctx.cfg);
|
||||
bundle_ec2_warning(&api, env, &ctx.region, &ctx.who.account, owner.trim(), c).await
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
let Some(dir) = pick_folder(&window).await else {
|
||||
return Ok(None);
|
||||
};
|
||||
write_bundle(&dir, key.deployment(), &ctx.who.account, &ctx.region, &vars).map_err(other)?;
|
||||
Ok(Some(dir.to_string_lossy().into_owned()))
|
||||
Ok(Some(SavedBundle {
|
||||
folder: dir.to_string_lossy().into_owned(),
|
||||
warning,
|
||||
}))
|
||||
}
|
||||
|
||||
/// A bundle written: its folder and, for an onboarding with EC2 capacity,
|
||||
/// a warning when its EC2 name looks taken ([`bundle_ec2_warning`]).
|
||||
#[derive(Serialize, Clone, Debug, PartialEq)]
|
||||
pub struct SavedBundle {
|
||||
pub folder: String,
|
||||
pub warning: Option<String>,
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
@@ -6,7 +6,7 @@ use serde_json::json;
|
||||
use super::*;
|
||||
use crate::aws::tofu::Workdir;
|
||||
use crate::aws::environments::{
|
||||
EnvironmentState, Knowable, LockInfo, OnboardingState,
|
||||
EnvironmentState, Knowable, LockInfo, NamedResource, OnboardingState, Param, UserCompute,
|
||||
};
|
||||
use crate::aws::tofu_modules::{
|
||||
environment_vars, module_files, onboarding_vars, owner_key, state_key, ModuleKind,
|
||||
@@ -32,6 +32,7 @@ fn info(name: &str, mode: &str, assign_public_ip: bool) -> EnvironmentInfo {
|
||||
log_group: format!("/triple-c/{name}"),
|
||||
network_mode: mode.into(),
|
||||
tenancy: "strict".into(),
|
||||
max_workspace_hours: 0,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -165,6 +166,7 @@ fn update_reuses_the_recorded_network() {
|
||||
"dev",
|
||||
REGION,
|
||||
&network_from_record(&existing, Some("vpc-0123456789abcdef0")).unwrap(),
|
||||
0,
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(vars["network_mode"], "existing");
|
||||
@@ -193,7 +195,7 @@ fn bundles_contain_the_module_backend_vars_and_readme() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let ok = owner_key(REGION, USER_ID);
|
||||
let d = Deployment::User { env: "dev", owner_key: &ok };
|
||||
let vars = onboarding_vars("dev", REGION, USER_ID);
|
||||
let vars = onboarding_vars("dev", REGION, USER_ID, None).unwrap();
|
||||
let written = write_bundle(dir.path(), d, ACCOUNT, REGION, &vars).unwrap();
|
||||
|
||||
for (name, text) in module_files(ModuleKind::UserOnboard) {
|
||||
@@ -251,6 +253,45 @@ fn bundles_contain_the_module_backend_vars_and_readme() {
|
||||
}
|
||||
assert!(!readme.contains("put-bucket-tagging"), "a later tag can't satisfy the create");
|
||||
|
||||
// The EC2 name-collision check (the app does it too, Task 4): the
|
||||
// exact per-user names, and this user's record to compare against.
|
||||
let record = format!("/triple-c/users/dev/{ok}");
|
||||
for needle in [
|
||||
"BEFORE tofu apply",
|
||||
&format!("aws ecs describe-clusters --region {REGION} --clusters triple-c-dev--u-<tag>"),
|
||||
&format!(
|
||||
"aws autoscaling describe-auto-scaling-groups --region {REGION} \
|
||||
--auto-scaling-group-names triple-c-dev--u-<tag>"
|
||||
),
|
||||
&format!("aws ssm get-parameter --region {REGION} --name {record}"),
|
||||
"cluster/triple-c-dev--u-<tag>",
|
||||
"--include TAGS",
|
||||
"triple-c:owner",
|
||||
&format!("owner_id ({USER_ID})"),
|
||||
] {
|
||||
assert!(readme.contains(needle), "README lacks {needle:?}:\n{readme}");
|
||||
}
|
||||
// With a tag in the variables, the commands name it.
|
||||
let mut tagged = vars.clone();
|
||||
tagged["ec2_instance_type"] = "m7i.large".into();
|
||||
tagged["ec2_user_tag"] = "alice".into();
|
||||
let other = tempfile::tempdir().unwrap();
|
||||
write_bundle(other.path(), d, ACCOUNT, REGION, &tagged).unwrap();
|
||||
let readme_tagged = fs::read_to_string(other.path().join("README.txt")).unwrap();
|
||||
assert!(readme_tagged.contains("--clusters triple-c-dev--u-alice "), "{readme_tagged}");
|
||||
assert!(readme_tagged.contains("--auto-scaling-group-names triple-c-dev--u-alice "));
|
||||
assert!(!readme_tagged.contains("<tag>"));
|
||||
// The check comes before the apply it guards.
|
||||
let check = readme.find("BEFORE tofu apply").unwrap();
|
||||
let apply = readme.find(" tofu apply").unwrap();
|
||||
assert!(check < apply, "{readme}");
|
||||
// Not in the other bundles.
|
||||
let env_dir = tempfile::tempdir().unwrap();
|
||||
let env_vars = environment_vars("dev", REGION, &NetworkChoice::Public, 0).unwrap();
|
||||
write_bundle(env_dir.path(), Deployment::Environment("dev"), ACCOUNT, REGION, &env_vars).unwrap();
|
||||
let env_readme = fs::read_to_string(env_dir.path().join("README.txt")).unwrap();
|
||||
assert!(!env_readme.contains("EC2 capacity"), "{env_readme}");
|
||||
|
||||
// Writing again over our own files is fine...
|
||||
write_bundle(dir.path(), d, ACCOUNT, REGION, &vars).unwrap();
|
||||
// ...but an unrelated file (or folder) means the wrong folder.
|
||||
@@ -266,7 +307,7 @@ fn bundles_contain_the_module_backend_vars_and_readme() {
|
||||
#[test]
|
||||
fn a_us_east_1_bundle_creates_its_bucket_without_a_location_constraint() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let vars = environment_vars("dev", "us-east-1", &NetworkChoice::Public).unwrap();
|
||||
let vars = environment_vars("dev", "us-east-1", &NetworkChoice::Public, 0).unwrap();
|
||||
write_bundle(dir.path(), Deployment::Environment("dev"), ACCOUNT, "us-east-1", &vars).unwrap();
|
||||
let readme = fs::read_to_string(dir.path().join("README.txt")).unwrap();
|
||||
assert!(readme.contains("aws s3api create-bucket"), "{readme}");
|
||||
@@ -505,12 +546,12 @@ fn destroy_is_refused_while_users_are_onboarded() {
|
||||
fn only_your_own_stale_onboarding_lock_can_be_removed() {
|
||||
use EnvironmentAction::*;
|
||||
let mut stale = env("dev", EnvironmentState::Ready, vec![Join]);
|
||||
stale.onboarding = Some(OnboardingState::Incomplete { lock: Some(lock(9000, false)) });
|
||||
stale.onboarding = Some(OnboardingState::Incomplete { lock: Some(lock(9000, false)), ec2: None });
|
||||
stale.onboarding_actions = vec![Unlock];
|
||||
let mut live = env("live", EnvironmentState::Ready, vec![Join]);
|
||||
live.onboarding = Some(OnboardingState::InProgress { lock: Some(lock(10, false)) });
|
||||
let mut none = env("none", EnvironmentState::Ready, vec![Join]);
|
||||
none.onboarding = Some(OnboardingState::Incomplete { lock: None });
|
||||
none.onboarding = Some(OnboardingState::Incomplete { lock: None, ec2: None });
|
||||
let s = scan(Knowable::Yes, vec![stale, live, none]);
|
||||
let mine = owner_key(REGION, USER_ID);
|
||||
assert!(onboarding_unlock_refusal(&s, "dev", &mine).is_ok());
|
||||
@@ -629,3 +670,319 @@ fn ending_a_launch_never_clears_a_following_slot() {
|
||||
assert_eq!(slots.begin_launch(dir).unwrap_err(), SlotBusy::Following);
|
||||
slots.end_launch(Path::new("/w/env/none")); // nothing there: no-op
|
||||
}
|
||||
|
||||
fn recorded(env: &str, tag: &str, max: u32) -> UserCompute {
|
||||
let stem = crate::aws::tofu_modules::user_ec2_stem(env, tag);
|
||||
UserCompute {
|
||||
instance_type: "m7g.xlarge".into(),
|
||||
max_instances: max,
|
||||
user_tag: tag.into(),
|
||||
cluster_arn: format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/{stem}"),
|
||||
capacity_provider: stem,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_reapply_keeps_the_recorded_compute_unless_changed() {
|
||||
let rec = UserRecord::Valid(recorded("dev", "alice", 3));
|
||||
let kept = Ec2Compute {
|
||||
instance_type: "m7g.xlarge".into(),
|
||||
max_instances: 3,
|
||||
user_tag: "alice".into(),
|
||||
};
|
||||
// Omitted: keep what the record says (or none without one).
|
||||
assert_eq!(resolve_ec2(None, &rec), Ok(Some(kept.clone())));
|
||||
assert_eq!(resolve_ec2(None, &UserRecord::Absent), Ok(None));
|
||||
// Explicitly none: the re-apply removes it.
|
||||
assert_eq!(resolve_ec2(Some(Ec2Choice::None), &rec), Ok(None));
|
||||
// A new choice wins.
|
||||
let new = Ec2Compute {
|
||||
instance_type: "m7i.large".into(),
|
||||
max_instances: 1,
|
||||
user_tag: "alice".into(),
|
||||
};
|
||||
assert_eq!(
|
||||
resolve_ec2(Some(Ec2Choice::Ec2(new.clone())), &rec),
|
||||
Ok(Some(new.clone()))
|
||||
);
|
||||
// A record that exists but can't be used is never read as "none" (that
|
||||
// would tear the capacity down); an explicit choice still goes.
|
||||
let bad = UserRecord::Unusable("schema is not 1".into());
|
||||
let e = resolve_ec2(None, &bad).unwrap_err();
|
||||
assert!(e.contains("schema is not 1") && e.contains("explicitly"), "{e}");
|
||||
assert_eq!(resolve_ec2(Some(Ec2Choice::None), &bad), Ok(None));
|
||||
assert_eq!(resolve_ec2(Some(Ec2Choice::Ec2(new.clone())), &bad), Ok(Some(new.clone())));
|
||||
// The kept values reach the module's variables unchanged.
|
||||
let vars = onboarding_vars("dev", REGION, USER_ID, resolve_ec2(None, &rec).unwrap().as_ref()).unwrap();
|
||||
assert_eq!(vars["ec2_instance_type"], "m7g.xlarge");
|
||||
assert_eq!(vars["ec2_max_instances"], 3);
|
||||
assert_eq!(vars["ec2_user_tag"], "alice");
|
||||
|
||||
// The UI's JSON for each choice.
|
||||
let none: Ec2Choice = serde_json::from_value(json!({"kind": "none"})).unwrap();
|
||||
assert_eq!(none, Ec2Choice::None);
|
||||
let ec2: Ec2Choice = serde_json::from_value(json!({
|
||||
"kind": "ec2", "instance_type": "m7i.large", "max_instances": 1, "user_tag": "alice"
|
||||
}))
|
||||
.unwrap();
|
||||
assert_eq!(ec2, Ec2Choice::Ec2(new));
|
||||
}
|
||||
|
||||
fn held(kind: &'static str, owner: Option<&str>) -> NameHolder {
|
||||
NameHolder {
|
||||
kind,
|
||||
owner: owner.map(String::from),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ec2_names_held_by_another_owner_are_refused() {
|
||||
let stem = "triple-c-dev--u-alice";
|
||||
let me = USER_ID;
|
||||
// Free names: fine, with or without a record.
|
||||
assert!(ec2_collision_refusal(stem, &[], me, None).is_ok());
|
||||
assert!(ec2_collision_refusal(stem, &[], me, Some(&recorded("dev", "bob", 1))).is_ok());
|
||||
let cluster = |o| held("ECS cluster", o);
|
||||
let group = |o| held("Auto Scaling group", o);
|
||||
// Tagged as mine: a half-built capacity (no record yet) is re-applied.
|
||||
assert!(ec2_collision_refusal(stem, &[cluster(Some(me)), group(Some(me))], me, None).is_ok());
|
||||
// Another owner's, or untagged: refused, naming the resource.
|
||||
let e = ec2_collision_refusal(stem, &[cluster(Some("AROAOTHER:bob"))], me, None).unwrap_err();
|
||||
assert!(e.contains("ECS cluster") && e.contains(stem) && e.contains("another onboarding"), "{e}");
|
||||
assert!(e.contains("triple-c-user"), "{e}");
|
||||
let e = ec2_collision_refusal(stem, &[cluster(Some(me)), group(None)], me, None).unwrap_err();
|
||||
assert!(e.contains("Auto Scaling group") && e.contains("isn't tagged"), "{e}");
|
||||
// The record naming the cluster is the fallback for an untagged one
|
||||
// only: one tagged as someone else's is refused even then.
|
||||
let mine = recorded("dev", "alice", 2);
|
||||
assert!(ec2_collision_refusal(stem, &[cluster(None), group(None)], me, Some(&mine)).is_ok());
|
||||
assert!(ec2_collision_refusal(stem, &[cluster(None), group(Some(me))], me, Some(&mine)).is_ok());
|
||||
let e = ec2_collision_refusal(stem, &[cluster(None), group(Some("x"))], me, Some(&mine)).unwrap_err();
|
||||
assert!(e.contains("Auto Scaling group") && e.contains("another onboarding"), "{e}");
|
||||
// A record naming another cluster doesn't help.
|
||||
assert!(ec2_collision_refusal(stem, &[cluster(None)], me, Some(&recorded("dev", "bob", 1))).is_err());
|
||||
// A cluster that merely ends in the same text is not the same cluster.
|
||||
let mut lookalike = recorded("dev", "alice", 1);
|
||||
lookalike.cluster_arn = format!("arn:aws:ecs:{REGION}:{ACCOUNT}:cluster/x{stem}");
|
||||
assert!(ec2_collision_refusal(stem, &[cluster(None)], me, Some(&lookalike)).is_err());
|
||||
}
|
||||
|
||||
/// An `OnboardApi` answering from fixed data, recording what it was asked.
|
||||
#[derive(Default)]
|
||||
struct FakeOnboard {
|
||||
record: Option<String>,
|
||||
record_denied: bool,
|
||||
cluster: Option<NamedResource>,
|
||||
group: Option<NamedResource>,
|
||||
group_denied: bool,
|
||||
calls: std::sync::Mutex<Vec<String>>,
|
||||
}
|
||||
|
||||
impl FakeOnboard {
|
||||
fn calls(&self) -> Vec<String> {
|
||||
self.calls.lock().unwrap().clone()
|
||||
}
|
||||
}
|
||||
|
||||
impl OnboardApi for FakeOnboard {
|
||||
async fn parameter(&self, name: &str) -> Result<Param, AwsError> {
|
||||
self.calls.lock().unwrap().push(format!("parameter {name}"));
|
||||
Ok(match (&self.record, self.record_denied) {
|
||||
(_, true) => Param::Denied,
|
||||
(Some(v), _) => Param::Value(v.clone()),
|
||||
(None, _) => Param::Missing,
|
||||
})
|
||||
}
|
||||
async fn cluster(&self, name: &str) -> Result<Option<NamedResource>, AwsError> {
|
||||
self.calls.lock().unwrap().push(format!("cluster {name}"));
|
||||
Ok(self.cluster.clone())
|
||||
}
|
||||
async fn group(&self, name: &str) -> Result<Option<NamedResource>, AwsError> {
|
||||
self.calls.lock().unwrap().push(format!("group {name}"));
|
||||
if self.group_denied {
|
||||
return Err(AwsError::AccessDenied {
|
||||
action: "autoscaling:DescribeAutoScalingGroups".into(),
|
||||
message: "denied".into(),
|
||||
});
|
||||
}
|
||||
Ok(self.group.clone())
|
||||
}
|
||||
}
|
||||
|
||||
fn named(status: Option<&str>, owner: Option<&str>) -> NamedResource {
|
||||
NamedResource {
|
||||
status: status.map(String::from),
|
||||
tags: owner
|
||||
.map(|o| vec![("triple-c:owner".to_string(), o.to_string())])
|
||||
.unwrap_or_default(),
|
||||
}
|
||||
}
|
||||
|
||||
fn record_json(env: &str, tag: &str) -> String {
|
||||
let r = recorded(env, tag, 2);
|
||||
json!({
|
||||
"schema": 1, "instance_type": r.instance_type, "cluster_arn": r.cluster_arn,
|
||||
"capacity_provider": r.capacity_provider, "user_tag": r.user_tag, "max_instances": 2,
|
||||
})
|
||||
.to_string()
|
||||
}
|
||||
|
||||
fn prepare(api: &FakeOnboard, choice: Option<Ec2Choice>) -> Result<Value, AwsError> {
|
||||
tokio::runtime::Builder::new_current_thread()
|
||||
.build()
|
||||
.unwrap()
|
||||
.block_on(prepare_onboarding(api, "dev", REGION, ACCOUNT, USER_ID, choice))
|
||||
}
|
||||
|
||||
fn alice() -> Option<Ec2Choice> {
|
||||
Some(Ec2Choice::Ec2(Ec2Compute {
|
||||
instance_type: "m7i.large".into(),
|
||||
max_instances: 1,
|
||||
user_tag: "alice".into(),
|
||||
}))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn onboarding_checks_the_ec2_names_before_it_applies() {
|
||||
let stem = "triple-c-dev--u-alice";
|
||||
// Fargate only: no name lookups at all.
|
||||
let api = FakeOnboard::default();
|
||||
let vars = prepare(&api, Some(Ec2Choice::None)).unwrap();
|
||||
assert_eq!(vars["ec2_instance_type"], "");
|
||||
assert!(api.calls().iter().all(|c| c.starts_with("parameter ")), "{:?}", api.calls());
|
||||
|
||||
// Free names: the vars come back.
|
||||
let api = FakeOnboard::default();
|
||||
let vars = prepare(&api, alice()).unwrap();
|
||||
assert_eq!(vars["ec2_user_tag"], "alice");
|
||||
assert!(api.calls().contains(&format!("cluster {stem}")));
|
||||
assert!(api.calls().contains(&format!("group {stem}")));
|
||||
|
||||
// Another owner's cluster: refused, so nothing is launched.
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some("ACTIVE"), Some("AROAOTHER:bob"))),
|
||||
..Default::default()
|
||||
};
|
||||
let e = prepare(&api, alice()).unwrap_err();
|
||||
assert!(format!("{e:?}").contains("another onboarding"), "{e:?}");
|
||||
|
||||
// My own half-built cluster and group (a failed apply, no record yet).
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some("PROVISIONING"), Some(USER_ID))),
|
||||
group: Some(named(None, Some(USER_ID))),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_ok());
|
||||
|
||||
// Untagged: refused unless my record names it.
|
||||
let untagged = || FakeOnboard {
|
||||
cluster: Some(named(Some("ACTIVE"), None)),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&untagged(), alice()).is_err());
|
||||
let api = FakeOnboard {
|
||||
record: Some(record_json("dev", "alice")),
|
||||
..untagged()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_ok());
|
||||
|
||||
// A deleted (INACTIVE) cluster doesn't hold the name; every other
|
||||
// status does.
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some("INACTIVE"), None)),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_ok());
|
||||
for status in ["ACTIVE", "PROVISIONING", "DEPROVISIONING", "FAILED"] {
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some(status), Some("AROAOTHER:bob"))),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_err(), "{status}");
|
||||
}
|
||||
|
||||
// An Auto Scaling group alone is enough to refuse.
|
||||
let api = FakeOnboard {
|
||||
group: Some(named(None, Some("AROAOTHER:bob"))),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_err());
|
||||
|
||||
// A denied group lookup is an error, never "free".
|
||||
let api = FakeOnboard {
|
||||
group_denied: true,
|
||||
..Default::default()
|
||||
};
|
||||
assert!(prepare(&api, alice()).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn capacity_kept_from_the_record_is_checked_too() {
|
||||
let stem = "triple-c-dev--u-alice";
|
||||
// Omitted choice + a record: the record's capacity, and its names are
|
||||
// checked (here another owner's group appeared under it).
|
||||
let api = FakeOnboard {
|
||||
record: Some(record_json("dev", "alice")),
|
||||
cluster: Some(named(Some("ACTIVE"), Some(USER_ID))),
|
||||
group: Some(named(None, Some(USER_ID))),
|
||||
..Default::default()
|
||||
};
|
||||
let vars = prepare(&api, None).unwrap();
|
||||
assert_eq!(vars["ec2_instance_type"], "m7g.xlarge");
|
||||
assert_eq!(vars["ec2_max_instances"], 2);
|
||||
assert!(api.calls().contains(&format!("group {stem}")));
|
||||
|
||||
// A record that can't be used (unreadable or invalid) and no choice:
|
||||
// refused before any name lookup or launch.
|
||||
for api in [
|
||||
FakeOnboard {
|
||||
record_denied: true,
|
||||
..Default::default()
|
||||
},
|
||||
FakeOnboard {
|
||||
record: Some("{\"schema\": 9}".into()),
|
||||
..Default::default()
|
||||
},
|
||||
] {
|
||||
let e = prepare(&api, None).unwrap_err();
|
||||
assert!(format!("{e:?}").contains("explicitly"), "{e:?}");
|
||||
assert!(api.calls().iter().all(|c| c.starts_with("parameter ")));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_bundle_warns_when_its_cluster_name_looks_taken() {
|
||||
let run = |api: &FakeOnboard| {
|
||||
let c = Ec2Compute {
|
||||
instance_type: "m7i.large".into(),
|
||||
max_instances: 1,
|
||||
user_tag: "alice".into(),
|
||||
};
|
||||
tokio::runtime::Builder::new_current_thread()
|
||||
.build()
|
||||
.unwrap()
|
||||
.block_on(bundle_ec2_warning(api, "dev", REGION, ACCOUNT, USER_ID, &c))
|
||||
};
|
||||
assert_eq!(run(&FakeOnboard::default()), None);
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some("ACTIVE"), Some("AROAOTHER:bob"))),
|
||||
..Default::default()
|
||||
};
|
||||
assert!(run(&api).unwrap().contains("another onboarding"));
|
||||
// Only the cluster half: a workspace user can't read Auto Scaling.
|
||||
assert!(!api.calls().iter().any(|c| c.starts_with("group ")));
|
||||
let api = FakeOnboard {
|
||||
cluster: Some(named(Some("ACTIVE"), Some(USER_ID))),
|
||||
..Default::default()
|
||||
};
|
||||
assert_eq!(run(&api), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_ui_gets_the_apps_instance_table() {
|
||||
let table = list_ec2_instance_types();
|
||||
assert_eq!(table.types, crate::models::project::ec2_instance_types());
|
||||
assert_eq!(table.types.len(), 30);
|
||||
assert_eq!(table.default_type, "m7i.large");
|
||||
assert!(table.types.iter().any(|t| t.instance_type == table.default_type));
|
||||
}
|
||||
@@ -2,15 +2,19 @@
|
||||
//! sign-in and the permission check.
|
||||
|
||||
use std::future::Future;
|
||||
use std::sync::OnceLock;
|
||||
use std::time::SystemTime;
|
||||
|
||||
use tauri::State;
|
||||
|
||||
use crate::aws::permissions::{check_permissions, PermissionReport, SdkPermissionApi};
|
||||
use crate::aws::policies::{policy_files, Tier};
|
||||
use crate::aws::pricing::{self, HourlyEstimate, RatesCache, SdkPricingApi};
|
||||
use crate::aws::{caller_identity, sdk_config, sdk_config_for_keys, AwsError, CallerIdentity};
|
||||
use crate::models::project::{ec2_instance_spec, LaunchType};
|
||||
use crate::models::{
|
||||
validate_connection_name, validate_profile_name, validate_supported_region, AppSettings, AwsAuth,
|
||||
HostConnection, HostKind,
|
||||
AwsWorkspaceConfig, HostConnection, HostKind,
|
||||
};
|
||||
use crate::storage::secure::{self, AwsKeys};
|
||||
use crate::storage::settings_store::SettingsStore;
|
||||
@@ -301,6 +305,97 @@ pub fn aws_policy_document(tier: Tier) -> Vec<PolicyFile> {
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The cost estimate's rate cache, `<data dir>/triple-c/aws-pricing/`, shared
|
||||
/// by every call (it also remembers recent failures). `None` without a data
|
||||
/// folder.
|
||||
fn pricing_cache() -> Option<&'static RatesCache> {
|
||||
static CACHE: OnceLock<Option<RatesCache>> = OnceLock::new();
|
||||
CACHE
|
||||
.get_or_init(|| pricing::default_cache_dir().map(RatesCache::new))
|
||||
.as_ref()
|
||||
}
|
||||
|
||||
/// The estimated on-demand hourly cost of `config` as a Fargate task in
|
||||
/// `region` (Q5). It takes the config rather than a project id because
|
||||
/// Project Home's Host settings ask while the user edits, and the Overview
|
||||
/// asks for the saved one; `connection_id` is the project's connection, whose
|
||||
/// credentials sign the Price List call (made in us-east-1). **Never an
|
||||
/// error:** a bad region, a missing connection, a denied or slow call (8 s
|
||||
/// bound) or an unreadable price list is `None`, shown as "Estimate
|
||||
/// unavailable". Rates are cached a day per region.
|
||||
///
|
||||
/// An EC2 project (E10) is priced as `instance_type` (the user's, from their
|
||||
/// onboarding record, which the UI already holds): its on-demand hourly
|
||||
/// price, the same cache and back-off rules. No instance type, or one not in
|
||||
/// the app's table, is `None`.
|
||||
#[tauri::command]
|
||||
pub async fn aws_cost_estimate(
|
||||
connection_id: String,
|
||||
region: String,
|
||||
config: AwsWorkspaceConfig,
|
||||
instance_type: Option<String>,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Option<HourlyEstimate>, String> {
|
||||
let Some(cache) = pricing_cache() else {
|
||||
return Ok(None);
|
||||
};
|
||||
let settings = state.settings_store.get();
|
||||
Ok(cost_estimate(
|
||||
cache,
|
||||
&connection_id,
|
||||
®ion,
|
||||
&config,
|
||||
instance_type.as_deref(),
|
||||
&settings,
|
||||
SystemTime::now(),
|
||||
)
|
||||
.await)
|
||||
}
|
||||
|
||||
async fn cost_estimate(
|
||||
cache: &RatesCache,
|
||||
connection_id: &str,
|
||||
region: &str,
|
||||
config: &AwsWorkspaceConfig,
|
||||
instance_type: Option<&str>,
|
||||
settings: &AppSettings,
|
||||
now: SystemTime,
|
||||
) -> Option<HourlyEstimate> {
|
||||
let region = validate_supported_region(region).ok()?;
|
||||
// Only now touch the connection (a keys connection reads the keychain),
|
||||
// and inside the fetch's 8 s bound: reading a profile's credentials can
|
||||
// hang as well (an SSO or process provider).
|
||||
let api = || async {
|
||||
let conn = aws_conn(connection_id, settings).ok()?;
|
||||
let cfg = sdk_config(&conn, pricing::PRICING_REGION).await.ok()?;
|
||||
Some(SdkPricingApi::new(&cfg))
|
||||
};
|
||||
if config.launch_type == LaunchType::Ec2 {
|
||||
let instance_type = instance_type.filter(|t| ec2_instance_spec(t).is_some())?;
|
||||
let instance = async {
|
||||
match cache.read_ec2(®ion, instance_type, now) {
|
||||
Some((price, true)) => Some(price),
|
||||
_ => {
|
||||
cache
|
||||
.ec2_price_with::<SdkPricingApi, _>(api(), ®ion, instance_type, now)
|
||||
.await
|
||||
}
|
||||
}
|
||||
};
|
||||
// The root volume's price is best effort: without it the estimate
|
||||
// is the instance's alone (and says so).
|
||||
let gp3 = cache.gp3_price_with::<SdkPricingApi, _>(api(), ®ion, now);
|
||||
let (price, gp3) = tokio::join!(instance, gp3);
|
||||
return Some(pricing::estimate_ec2(config, price?, gp3));
|
||||
}
|
||||
let rates = match cache.read(®ion, now) {
|
||||
Some((rates, true)) => Some(rates),
|
||||
// Without a connection, a stale cache still answers.
|
||||
_ => cache.rates_with::<SdkPricingApi, _>(api(), ®ion, now).await,
|
||||
}?;
|
||||
Some(pricing::estimate(config, &rates.for_arch(config.arch)?))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -542,7 +637,15 @@ mod tests {
|
||||
fn the_policy_document_is_every_file_of_the_tier() {
|
||||
let admin = aws_policy_document(Tier::EnvironmentAdmin);
|
||||
let names: Vec<&str> = admin.iter().map(|f| f.name.as_str()).collect();
|
||||
assert_eq!(names, ["environment-admin.json", "environment-admin-network.json"]);
|
||||
assert_eq!(
|
||||
names,
|
||||
[
|
||||
"environment-admin.json",
|
||||
"environment-admin-network.json",
|
||||
"environment-admin-compute.json",
|
||||
"environment-admin-scaling.json"
|
||||
]
|
||||
);
|
||||
for f in &admin {
|
||||
serde_json::from_str::<serde_json::Value>(&f.json).expect("policy JSON");
|
||||
}
|
||||
@@ -557,4 +660,94 @@ mod tests {
|
||||
"workspace-user.json"
|
||||
);
|
||||
}
|
||||
|
||||
fn sample_rates() -> pricing::RegionRates {
|
||||
let x86 = pricing::FargateRates {
|
||||
vcpu_hour: 0.04,
|
||||
gb_hour: 0.004,
|
||||
storage_gb_hour: 0.0001,
|
||||
};
|
||||
pricing::RegionRates {
|
||||
x86_64: Some(x86),
|
||||
arm64: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_cost_estimate_answers_from_a_fresh_cache_without_a_connection() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let cache = RatesCache::new(dir.path().to_path_buf());
|
||||
let now = SystemTime::now();
|
||||
cache.write("us-west-2", &sample_rates(), now).unwrap();
|
||||
let settings = AppSettings::default();
|
||||
let config = AwsWorkspaceConfig {
|
||||
cpu: 1024,
|
||||
memory_mib: 2048,
|
||||
ephemeral_gib: 20,
|
||||
spot: true,
|
||||
..Default::default()
|
||||
};
|
||||
let e = cost_estimate(&cache, "gone", "us-west-2", &config, None, &settings, now)
|
||||
.await
|
||||
.expect("estimate");
|
||||
assert!((e.usd_per_hour - (0.04 + 2.0 * 0.004)).abs() < 1e-9);
|
||||
assert!(e.note_spot && e.efs_billed_separately);
|
||||
// An architecture the price list lacked has no estimate.
|
||||
let arm = AwsWorkspaceConfig {
|
||||
arch: crate::models::Arch::Arm64,
|
||||
..config.clone()
|
||||
};
|
||||
assert_eq!(cost_estimate(&cache, "gone", "us-west-2", &arm, None, &settings, now).await, None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_cost_estimate_is_none_never_an_error() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let cache = RatesCache::new(dir.path().to_path_buf());
|
||||
let settings = AppSettings::default();
|
||||
let config = AwsWorkspaceConfig::default();
|
||||
let now = SystemTime::now();
|
||||
// No cache and no such connection.
|
||||
assert_eq!(cost_estimate(&cache, "gone", "us-west-2", &config, None, &settings, now).await, None);
|
||||
// A region that isn't one (it would name the cache file).
|
||||
cache.write("us-west-2", &sample_rates(), now).unwrap();
|
||||
for bad in ["../us-west-2", "", "us-west-2/x"] {
|
||||
assert_eq!(cost_estimate(&cache, "gone", bad, &config, None, &settings, now).await, None);
|
||||
}
|
||||
}
|
||||
|
||||
/// E10: an EC2 project is priced as the user's instance type, from the
|
||||
/// same cache; without a known type there is no estimate.
|
||||
#[tokio::test]
|
||||
async fn an_ec2_projects_estimate_is_its_instance_types_price() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let cache = RatesCache::new(dir.path().to_path_buf());
|
||||
let now = SystemTime::now();
|
||||
cache.write("us-west-2", &sample_rates(), now).unwrap();
|
||||
cache.write_ec2("us-west-2", "m7i.large", 0.1008, now).unwrap();
|
||||
let settings = AppSettings::default();
|
||||
let config = AwsWorkspaceConfig {
|
||||
launch_type: LaunchType::Ec2,
|
||||
cpu: 1024,
|
||||
memory_mib: 2048,
|
||||
storage: crate::models::project::StorageMode::Ephemeral,
|
||||
..Default::default()
|
||||
};
|
||||
let e = cost_estimate(&cache, "gone", "us-west-2", &config, Some("m7i.large"), &settings, now)
|
||||
.await
|
||||
.expect("estimate");
|
||||
assert!((e.usd_per_hour - 0.1008).abs() < 1e-9);
|
||||
assert!(e.ec2_instance && !e.note_spot && !e.efs_billed_separately);
|
||||
// No instance type, one not in the table, or one with no cached price
|
||||
// (and no connection to ask): no estimate — never Fargate's.
|
||||
for t in [None, Some("x9.huge"), Some("m7g.large")] {
|
||||
assert_eq!(cost_estimate(&cache, "gone", "us-west-2", &config, t, &settings, now).await, None, "{t:?}");
|
||||
}
|
||||
// A Fargate project ignores an instance type.
|
||||
let fargate = AwsWorkspaceConfig { launch_type: LaunchType::Fargate, ..config.clone() };
|
||||
let f = cost_estimate(&cache, "gone", "us-west-2", &fargate, Some("m7i.large"), &settings, now)
|
||||
.await
|
||||
.expect("fargate");
|
||||
assert!(!f.ec2_instance);
|
||||
}
|
||||
}
|
||||
@@ -641,7 +641,9 @@ pub async fn add_project(
|
||||
aws: Option<AwsWorkspaceConfig>,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Project, String> {
|
||||
let project = new_project(name, paths, host_id, aws_placement, aws, &state.settings_store.get().hosts)?;
|
||||
let settings = state.settings_store.get();
|
||||
let project = new_project(name, paths, host_id, aws_placement, aws, &settings.hosts)?;
|
||||
validate_gateway_sidecar_update(&Project::new(String::new(), Vec::new()), &project, &settings.gateway)?;
|
||||
// Nothing can have been blanked on a project that did not exist a line ago.
|
||||
store_secrets_for_project(&project, &[])?;
|
||||
state.projects_store.add(project)
|
||||
@@ -715,13 +717,14 @@ pub async fn remove_project(
|
||||
|
||||
// An AWS project's task and resources go first, and a failure keeps the
|
||||
// project: its record is the only handle on a billed task and its
|
||||
// secret. Its EFS access point goes only when asked (the files stay on the
|
||||
// secret. Its EFS access points go only when asked (the files stay on the
|
||||
// user's own file system until offboarding).
|
||||
if let Some(project) = state.projects_store.get(&project_id).filter(|p| p.is_aws()) {
|
||||
let settings = state.settings_store.get();
|
||||
if let Some(target) = ContainerTarget::for_project(&project) {
|
||||
state.exec_manager.close_sessions_for_container(target.id()).await;
|
||||
}
|
||||
crate::storage::terminal_store::clear(&project_id);
|
||||
let connection_exists = project
|
||||
.host_id
|
||||
.as_deref()
|
||||
@@ -1061,6 +1064,7 @@ fn pending_cleanup_is_stale(recorded_at: &str, now: chrono::DateTime<chrono::Utc
|
||||
#[tauri::command]
|
||||
pub async fn update_project(
|
||||
project: serde_json::Value,
|
||||
app_handle: tauri::AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Project, String> {
|
||||
// Taken as raw JSON, then deserialised, for one reason: a secret field that
|
||||
@@ -1122,7 +1126,11 @@ pub async fn update_project(
|
||||
// [`crate::models::validate_env_vars_update`].
|
||||
crate::models::validate_env_vars_update(&stored.custom_env_vars, &project.custom_env_vars)?;
|
||||
|
||||
validate_aws_update(&stored, &project, &state.settings_store.get().hosts)?;
|
||||
{
|
||||
let settings = state.settings_store.get();
|
||||
validate_aws_update(&stored, &project, &settings.hosts)?;
|
||||
validate_gateway_sidecar_update(&stored, &project, &settings.gateway)?;
|
||||
}
|
||||
|
||||
restore_store_owned_fields(&mut project, &stored);
|
||||
project.updated_at = chrono::Utc::now().to_rfc3339();
|
||||
@@ -1144,9 +1152,25 @@ pub async fn update_project(
|
||||
// lock against the record as it is *now*, so a marketplace install, a
|
||||
// status change or a container id landing since `stored` was read is kept
|
||||
// rather than written over.
|
||||
state
|
||||
let mappings_changed = stored.port_mappings != project.port_mappings;
|
||||
let left_aws = stored.is_aws() && !project.is_aws();
|
||||
let saved = state
|
||||
.projects_store
|
||||
.update_restoring(project, restore_store_owned_fields)
|
||||
.update_restoring(project, restore_store_owned_fields)?;
|
||||
|
||||
// AWS (Q6): a connected workspace's forwards follow the saved mappings
|
||||
// now — there is no container to recreate. Nothing when not connected.
|
||||
if left_aws {
|
||||
// Moved to Docker: its workspace terminals went with the task.
|
||||
crate::storage::terminal_store::clear(&saved.id);
|
||||
}
|
||||
if saved.is_aws() && mappings_changed {
|
||||
let warn = ports_warner(&app_handle, &saved.id, &saved.name);
|
||||
if let Some(detail) = crate::host::port_forwards::open_for_project(&state.projects_store, &saved.id, Some(warn)).await {
|
||||
emit_ports_warning(&app_handle, &saved.id, &saved.name, &detail);
|
||||
}
|
||||
}
|
||||
Ok(saved)
|
||||
}
|
||||
|
||||
/// Restore onto `project` the fields whose value belongs to the store rather
|
||||
@@ -1191,9 +1215,34 @@ fn restore_store_owned_fields(project: &mut Project, stored: &Project) {
|
||||
aws.task_arn = s.and_then(|a| a.task_arn.clone());
|
||||
aws.access_point_id = s.and_then(|a| a.access_point_id.clone());
|
||||
aws.task_definition_arn = s.and_then(|a| a.task_definition_arn.clone());
|
||||
aws.workspace_access_point_id = s.and_then(|a| a.workspace_access_point_id.clone());
|
||||
}
|
||||
}
|
||||
|
||||
/// The LLM gateway sidecar (Q7) needs the OpenAI-compatible backend and a
|
||||
/// model in Settings → Model Gateway. A save is refused when the sidecar is
|
||||
/// on without that backend, or is being turned on with no gateway model; a
|
||||
/// project that already runs it still saves after the models were removed
|
||||
/// from Settings (its start says what is missing).
|
||||
fn validate_gateway_sidecar_update(
|
||||
stored: &Project,
|
||||
project: &Project,
|
||||
gateway: &crate::models::gateway_settings::GatewaySettings,
|
||||
) -> Result<(), String> {
|
||||
let Some(problem) = crate::aws::workspace::gateway_sidecar_problem(project, gateway) else {
|
||||
return Ok(());
|
||||
};
|
||||
// Not on EC2 at all (bridge networking): refused whatever was stored.
|
||||
if problem == crate::aws::workspace::EC2_NO_SIDECAR {
|
||||
return Err(problem);
|
||||
}
|
||||
let was_on = stored.aws.as_ref().is_some_and(|a| a.gateway_sidecar);
|
||||
if was_on && project.backend == crate::models::project::Backend::OpenAiCompatible {
|
||||
return Ok(());
|
||||
}
|
||||
Err(problem)
|
||||
}
|
||||
|
||||
/// Checks an incoming save's host placement against what is stored and the
|
||||
/// configured connections.
|
||||
fn validate_aws_update(
|
||||
@@ -1210,6 +1259,22 @@ fn validate_aws_update(
|
||||
crate::models::validate_region(&place.region)?;
|
||||
crate::aws::tofu_modules::validate_environment_name(&place.environment)?;
|
||||
crate::models::validate_aws_workspace(cfg)?;
|
||||
// Docker access and VPN need the user's own instance (E6, E7).
|
||||
if cfg.launch_type != crate::models::LaunchType::Ec2 {
|
||||
if project.allow_docker_access {
|
||||
return Err("Docker access on AWS needs the EC2 launch type; turn it off first".into());
|
||||
}
|
||||
if project.vpn_support_enabled {
|
||||
return Err("VPN support on AWS needs the EC2 launch type; turn it off first".into());
|
||||
}
|
||||
}
|
||||
// Q6: forwarded over loopback, TCP only, never a reserved port
|
||||
// (rows the save adds or edits; everything when newly on AWS).
|
||||
crate::host::port_forwards::validate_aws_port_mappings_update(
|
||||
stored.aws.as_ref().map(|a| (stored.port_mappings.as_slice(), a.gateway_sidecar)),
|
||||
&project.port_mappings,
|
||||
cfg.gateway_sidecar,
|
||||
)?;
|
||||
}
|
||||
_ => {
|
||||
return Err(
|
||||
@@ -1226,7 +1291,10 @@ fn validate_aws_update(
|
||||
// connection's account and region; moving the project would orphan them.
|
||||
if moved
|
||||
&& stored.aws.as_ref().is_some_and(|a| {
|
||||
a.task_arn.is_some() || a.access_point_id.is_some() || a.task_definition_arn.is_some()
|
||||
a.task_arn.is_some()
|
||||
|| a.access_point_id.is_some()
|
||||
|| a.workspace_access_point_id.is_some()
|
||||
|| a.task_definition_arn.is_some()
|
||||
})
|
||||
{
|
||||
return Err(
|
||||
@@ -1459,7 +1527,7 @@ async fn start_project_container_locked(
|
||||
// id stored above is the tunnel's endpoint URL, which is what the death
|
||||
// watch reports a stopped task as.
|
||||
if project.is_aws() {
|
||||
if let Some((task_arn, access_point_id, task_definition_arn)) =
|
||||
if let Some((task_arn, access_point_id, task_definition_arn, workspace_access_point_id)) =
|
||||
crate::host::tunnels::runtime(&project_id)
|
||||
{
|
||||
state.projects_store.set_aws_runtime(
|
||||
@@ -1467,6 +1535,7 @@ async fn start_project_container_locked(
|
||||
Some(task_arn),
|
||||
access_point_id,
|
||||
Some(task_definition_arn),
|
||||
workspace_access_point_id,
|
||||
)?;
|
||||
}
|
||||
}
|
||||
@@ -1486,11 +1555,166 @@ async fn start_project_container_locked(
|
||||
.await;
|
||||
}
|
||||
|
||||
// AWS (Q6): the project's port mappings become loopback forwards into
|
||||
// the workspace; a mapping that can't open is a warning, the rest work.
|
||||
if project.is_aws() {
|
||||
let warn = ports_warner(&app_handle, &project_id, &project.name);
|
||||
if let Some(detail) = crate::host::port_forwards::open_for_project(&state.projects_store, &project_id, Some(warn)).await {
|
||||
emit_ports_warning(&app_handle, &project_id, &project.name, &detail);
|
||||
}
|
||||
}
|
||||
|
||||
// AWS, copy-at-connect (Q2): every connect copies the credentials in,
|
||||
// in the background (the clone waits for them); a failure is a warning.
|
||||
if project.is_aws() {
|
||||
let (handle, id, name) = (app_handle.clone(), project_id.clone(), project.name.clone());
|
||||
crate::host::aws_host::spawn_connect_push(&project, &settings, move |detail| {
|
||||
emit_connect_warning(&handle, &id, &name, &detail)
|
||||
});
|
||||
}
|
||||
|
||||
// AWS: the start is done (Running, lock released when this returns);
|
||||
// the background clone and setup script are followed by a background
|
||||
// task that only reports a failure (ruling R5). Never for Docker.
|
||||
if project.is_aws() {
|
||||
let (handle, id, name) = (app_handle.clone(), project_id.clone(), project.name.clone());
|
||||
crate::host::aws_host::spawn_follow(&project, move |detail| {
|
||||
emit_workspace_warning(&handle, &id, &name, &detail)
|
||||
});
|
||||
}
|
||||
|
||||
project.container_id = Some(container_id);
|
||||
project.status = ProjectStatus::Running;
|
||||
Ok(project)
|
||||
}
|
||||
|
||||
/// The follower's warning channel (phase 6, Q4/R5): a started workspace
|
||||
/// whose clone or setup script failed (or still ran after 35 minutes) is
|
||||
/// reported as a `workspace-warning` event `{project_id, message, detail}`;
|
||||
/// the frontend shows it as a warning toast.
|
||||
fn emit_workspace_warning(app_handle: &tauri::AppHandle, project_id: &str, name: &str, detail: &str) {
|
||||
let _ = app_handle.emit(
|
||||
"workspace-warning",
|
||||
serde_json::json!({
|
||||
"project_id": project_id,
|
||||
"message": format!("“{name}” started, but not everything went well"),
|
||||
"detail": detail,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
/// Copy-at-connect's warning (Q2): the credentials could not be copied into
|
||||
/// a connected workspace. Same `workspace-warning` event as the follower's,
|
||||
/// with its own `topic` so neither replaces the other's toast.
|
||||
fn emit_connect_warning(app_handle: &tauri::AppHandle, project_id: &str, name: &str, detail: &str) {
|
||||
let _ = app_handle.emit("workspace-warning", connect_warning_payload(project_id, name, detail));
|
||||
}
|
||||
|
||||
/// A start that an app restart interrupted (EC2 cold start): topic "start".
|
||||
fn emit_interrupted_warning(app_handle: &tauri::AppHandle, project_id: &str, name: &str, detail: &str) {
|
||||
let _ = app_handle.emit("workspace-warning", interrupted_warning_payload(project_id, name, detail));
|
||||
}
|
||||
|
||||
fn interrupted_warning_payload(project_id: &str, name: &str, detail: &str) -> serde_json::Value {
|
||||
serde_json::json!({
|
||||
"project_id": project_id,
|
||||
"message": format!("“{name}”: a start was interrupted"),
|
||||
"detail": detail,
|
||||
"topic": "start",
|
||||
})
|
||||
}
|
||||
|
||||
fn connect_warning_payload(project_id: &str, name: &str, detail: &str) -> serde_json::Value {
|
||||
serde_json::json!({
|
||||
"project_id": project_id,
|
||||
"message": format!("“{name}”: the credentials could not be copied into the workspace"),
|
||||
"detail": detail,
|
||||
"topic": "connect",
|
||||
})
|
||||
}
|
||||
|
||||
/// Port mappings that could not be forwarded to a connected AWS workspace
|
||||
/// (Q6): a busy host port, a host port mapped twice. Same `workspace-warning`
|
||||
/// event, with its own `topic` so it does not replace the other warnings.
|
||||
/// Where a port mapping's later notices ("nothing is listening") go: the
|
||||
/// same `ports` warning toast.
|
||||
fn ports_warner(app_handle: &tauri::AppHandle, project_id: &str, name: &str) -> crate::host::port_forwards::PortsWarn {
|
||||
let (handle, id, name) = (app_handle.clone(), project_id.to_string(), name.to_string());
|
||||
std::sync::Arc::new(move |detail: String| emit_ports_warning(&handle, &id, &name, &detail))
|
||||
}
|
||||
|
||||
fn emit_ports_warning(app_handle: &tauri::AppHandle, project_id: &str, name: &str, detail: &str) {
|
||||
let _ = app_handle.emit(
|
||||
"workspace-warning",
|
||||
serde_json::json!({
|
||||
"project_id": project_id,
|
||||
"message": if detail.contains("nothing is listening") {
|
||||
format!("“{name}”: a port mapping found nothing listening in the workspace")
|
||||
} else {
|
||||
format!("“{name}”: some port mappings could not be opened")
|
||||
},
|
||||
"detail": detail,
|
||||
"topic": "ports",
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
/// An AWS workspace's clone and setup-script status for Project Home
|
||||
/// (background exec: never activity for idle stop). `None` for a local
|
||||
/// project, a workspace with no tunnel, or an image without the reader.
|
||||
#[tauri::command]
|
||||
pub async fn aws_workspace_status(
|
||||
project_id: String,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Option<crate::host::aws_host::WorkspaceStatus>, String> {
|
||||
let project = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.ok_or_else(|| format!("Project {} not found", project_id))?;
|
||||
crate::host::aws_host::workspace_status(&project).await
|
||||
}
|
||||
|
||||
/// The lifetime cap (hours; 0 = none) of an AWS project's environment, read
|
||||
/// from its record, for Host settings. `None` for a local project or when the
|
||||
/// record can't be read; never an error.
|
||||
#[tauri::command]
|
||||
pub async fn aws_environment_max_hours(
|
||||
project_id: String,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Option<u32>, String> {
|
||||
let Some(project) = state.projects_store.get(&project_id) else {
|
||||
return Ok(None);
|
||||
};
|
||||
if !project.is_aws() {
|
||||
return Ok(None);
|
||||
}
|
||||
let settings = state.settings_store.get();
|
||||
Ok(crate::host::aws_host::environment_max_hours(&project, &settings).await)
|
||||
}
|
||||
|
||||
/// The caller's EC2 capacity in an AWS project's environment, for Host
|
||||
/// settings' launch-type control and reservation limits (phase 7). Never an
|
||||
/// error: a local project or a failed read is `unknown`.
|
||||
#[tauri::command]
|
||||
pub async fn aws_ec2_capacity(
|
||||
project_id: String,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<crate::host::aws_host::Ec2Capacity, String> {
|
||||
let Some(project) = state.projects_store.get(&project_id).filter(|p| p.is_aws()) else {
|
||||
return Ok(crate::host::aws_host::Ec2Capacity::Unknown);
|
||||
};
|
||||
let settings = state.settings_store.get();
|
||||
Ok(crate::host::aws_host::ec2_capacity(&project, &settings).await)
|
||||
}
|
||||
|
||||
/// Why `config`'s CPU/memory reservations don't fit `instance_type`, or
|
||||
/// null (`models::project::ec2_fit_problem`: the start's own rule, so Host
|
||||
/// settings never disagree with it).
|
||||
#[tauri::command]
|
||||
pub fn ec2_fit_problem(config: AwsWorkspaceConfig, instance_type: String) -> Option<String> {
|
||||
crate::models::project::ec2_fit_problem(&config, &instance_type)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn stop_project_container(
|
||||
project_id: String,
|
||||
@@ -1518,6 +1742,9 @@ pub async fn stop_project_container(
|
||||
}
|
||||
|
||||
state.projects_store.update_status(&project_id, ProjectStatus::Stopping)?;
|
||||
// AWS: the background clone/setup follower ends now (it holds no lock;
|
||||
// closing the tunnel would end it too).
|
||||
crate::host::tunnels::cancel_follow(&project_id);
|
||||
|
||||
// AWS: the terminals and the auth bridge close *before* the stop guard's
|
||||
// push, so nothing written after its snapshot is silently dropped (the
|
||||
@@ -1531,6 +1758,9 @@ pub async fn stop_project_container(
|
||||
state.auth_bridge.stop(&project_id).await;
|
||||
if let Some(container) = guard_target.as_ref() {
|
||||
state.exec_manager.close_sessions_for_container(container.id()).await;
|
||||
// Closing the tabs only detaches persistent terminals: end
|
||||
// their tmux servers too, before the push's snapshot.
|
||||
crate::host::persistent::end_all(container).await;
|
||||
}
|
||||
if wip == Some(WipChoice::Push) {
|
||||
emit_progress(&app_handle, &project_id, "Pushing unsaved work...");
|
||||
@@ -1585,9 +1815,12 @@ pub async fn stop_project_container(
|
||||
None,
|
||||
a.access_point_id.clone(),
|
||||
a.task_definition_arn.clone(),
|
||||
a.workspace_access_point_id.clone(),
|
||||
)?;
|
||||
}
|
||||
state.projects_store.set_container_id(&project_id, None)?;
|
||||
// Its terminals ended with the task.
|
||||
crate::storage::terminal_store::clear(&project_id);
|
||||
} else if let Some(container) = ContainerTarget::for_project(&project) {
|
||||
// Close exec sessions for this project
|
||||
emit_progress(&app_handle, &project_id, "Stopping container...");
|
||||
@@ -1693,24 +1926,37 @@ pub async fn remove_aws_resources(
|
||||
ProjectHost::for_project(&project)
|
||||
.remove_aws_resources(&project, &settings, discard_data)
|
||||
.await?;
|
||||
state
|
||||
.projects_store
|
||||
.set_aws_runtime(&project_id, None, access_point_after_removal(&project, discard_data), None)?;
|
||||
let (access_point_id, workspace_access_point_id) =
|
||||
access_points_after_removal(&project, discard_data);
|
||||
state.projects_store.set_aws_runtime(
|
||||
&project_id,
|
||||
None,
|
||||
access_point_id,
|
||||
None,
|
||||
workspace_access_point_id,
|
||||
)?;
|
||||
state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.ok_or_else(|| format!("Project {} not found", project_id))
|
||||
}
|
||||
|
||||
/// The access point a removal leaves stored: kept when the saved files were
|
||||
/// kept (it is still there, a later start reuses it and a later removal
|
||||
/// with `discard_data` deletes it; and while it is stored the project can't
|
||||
/// move away from it — [`validate_aws_update`]), gone when they were not.
|
||||
fn access_point_after_removal(project: &Project, discard_data: bool) -> Option<String> {
|
||||
if discard_data {
|
||||
return None;
|
||||
/// The access points (home, EFS `/workspace`) a removal leaves stored: kept
|
||||
/// when the saved files were kept (they are still there, a later start
|
||||
/// reuses them and a later removal with `discard_data` deletes them; and
|
||||
/// while one is stored the project can't move away from it —
|
||||
/// [`validate_aws_update`]), gone when they were not.
|
||||
fn access_points_after_removal(
|
||||
project: &Project,
|
||||
discard_data: bool,
|
||||
) -> (Option<String>, Option<String>) {
|
||||
match project.aws.as_ref() {
|
||||
Some(a) if !discard_data => (
|
||||
a.access_point_id.clone(),
|
||||
a.workspace_access_point_id.clone(),
|
||||
),
|
||||
_ => (None, None),
|
||||
}
|
||||
project.aws.as_ref().and_then(|a| a.access_point_id.clone())
|
||||
}
|
||||
|
||||
fn check_aws_resources_removable(project: &Project) -> Result<(), String> {
|
||||
@@ -1949,12 +2195,26 @@ pub async fn reconcile_project_statuses(
|
||||
/// How many AWS projects reconcile at once.
|
||||
const AWS_RECONCILE_CONCURRENCY: usize = 4;
|
||||
|
||||
/// Whether an AWS project's status must be checked against ECS at startup:
|
||||
/// anything but a clean Stopped — and a Stopped one that still has a task
|
||||
/// ARN (Stop clears it, so the stored ARN means a start or stop never
|
||||
/// finished and a billed task may be running).
|
||||
pub(crate) fn needs_aws_reconcile(p: &Project) -> bool {
|
||||
match p.status {
|
||||
ProjectStatus::Running | ProjectStatus::Error | ProjectStatus::Starting | ProjectStatus::Stopping => true,
|
||||
ProjectStatus::Stopped => p.aws.as_ref().is_some_and(|a| a.task_arn.is_some()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Reconcile every AWS project against ECS (the authority), independently of
|
||||
/// Docker: an app started without Docker still learns which tasks run and
|
||||
/// re-opens their tunnels. One bounded DescribeTasks per project, a few at a
|
||||
/// time; a live task's tunnel is re-opened in the background.
|
||||
#[tauri::command]
|
||||
pub async fn reconcile_aws_projects(state: State<'_, AppState>) -> Result<Vec<Project>, String> {
|
||||
pub async fn reconcile_aws_projects(
|
||||
app_handle: tauri::AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Vec<Project>, String> {
|
||||
use futures_util::StreamExt;
|
||||
|
||||
let projects: Vec<Project> = state.projects_store.list().into_iter().filter(|p| p.is_aws()).collect();
|
||||
@@ -1972,20 +2232,37 @@ pub async fn reconcile_aws_projects(state: State<'_, AppState>) -> Result<Vec<Pr
|
||||
let settings = state.settings_store.get();
|
||||
let store = state.projects_store.clone();
|
||||
futures_util::stream::iter(projects.into_iter().filter(|p| {
|
||||
matches!(
|
||||
p.status,
|
||||
ProjectStatus::Running | ProjectStatus::Error | ProjectStatus::Starting | ProjectStatus::Stopping
|
||||
) && crate::project_lock::held(&p.id).is_none()
|
||||
needs_aws_reconcile(p) && crate::project_lock::held(&p.id).is_none()
|
||||
}))
|
||||
.for_each_concurrent(AWS_RECONCILE_CONCURRENCY, |project| {
|
||||
let settings = settings.clone();
|
||||
let store = store.clone();
|
||||
let handle = app_handle.clone();
|
||||
async move {
|
||||
// The store's current copy: the id above may have changed.
|
||||
let project = store.get(&project.id).unwrap_or(project);
|
||||
let (id, name) = (project.id.clone(), project.name.clone());
|
||||
let ports_handle = handle.clone();
|
||||
let (ports_id, ports_name) = (id.clone(), name.clone());
|
||||
let on_ports_warning = move |detail: String| {
|
||||
emit_ports_warning(&ports_handle, &ports_id, &ports_name, &detail)
|
||||
};
|
||||
let (int_handle, int_id, int_name) = (handle.clone(), id.clone(), name.clone());
|
||||
let on_interrupted_warning = move |detail: String| {
|
||||
emit_interrupted_warning(&int_handle, &int_id, &int_name, &detail)
|
||||
};
|
||||
let on_connect_warning =
|
||||
move |detail: String| emit_connect_warning(&handle, &id, &name, &detail);
|
||||
if tokio::time::timeout(
|
||||
AWS_RECONCILE_TIMEOUT,
|
||||
crate::host::aws_host::reconcile(&project, &settings, store),
|
||||
crate::host::aws_host::reconcile(
|
||||
&project,
|
||||
&settings,
|
||||
store,
|
||||
on_connect_warning,
|
||||
on_ports_warning,
|
||||
on_interrupted_warning,
|
||||
),
|
||||
)
|
||||
.await
|
||||
.is_err()
|
||||
@@ -2004,8 +2281,27 @@ pub async fn reconcile_aws_projects(state: State<'_, AppState>) -> Result<Vec<Pr
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn the_connect_warning_has_its_own_toast_topic() {
|
||||
let v = super::connect_warning_payload("p1", "demo", "upload failed");
|
||||
assert_eq!(v["topic"], "connect");
|
||||
assert_eq!(v["project_id"], "p1");
|
||||
assert_eq!(v["detail"], "upload failed");
|
||||
assert!(v["message"].as_str().unwrap().contains("demo"));
|
||||
}
|
||||
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn the_interrupted_warning_has_its_own_topic_and_headline() {
|
||||
let v = interrupted_warning_payload("p1", "demo", "retry");
|
||||
assert_eq!(v["topic"], "start");
|
||||
assert_eq!(v["detail"], "retry");
|
||||
let m = v["message"].as_str().unwrap();
|
||||
assert!(m.contains("demo") && m.contains("a start was interrupted"));
|
||||
assert!(!m.contains("credentials"));
|
||||
}
|
||||
|
||||
// ── Pending-cleanup aging ────────────────────────────────────────────
|
||||
|
||||
#[test]
|
||||
@@ -2616,12 +2912,14 @@ mod tests {
|
||||
sc.task_arn = Some("arn:task".into());
|
||||
sc.access_point_id = Some("fsap-1".into());
|
||||
sc.task_definition_arn = Some("arn:td".into());
|
||||
sc.workspace_access_point_id = Some("fsap-w".into());
|
||||
stored.aws = Some(sc.clone());
|
||||
let mut pc = crate::models::AwsWorkspaceConfig::default();
|
||||
pc.cpu = 2048;
|
||||
pc.memory_mib = 8192;
|
||||
pc.task_arn = Some("evil".into());
|
||||
pc.access_point_id = None;
|
||||
pc.workspace_access_point_id = None;
|
||||
payload.aws = Some(pc);
|
||||
|
||||
restore_store_owned_fields(&mut payload, &stored);
|
||||
@@ -2630,6 +2928,7 @@ mod tests {
|
||||
assert_eq!(a.task_arn, sc.task_arn);
|
||||
assert_eq!(a.access_point_id, sc.access_point_id);
|
||||
assert_eq!(a.task_definition_arn, sc.task_definition_arn);
|
||||
assert_eq!(a.workspace_access_point_id, Some("fsap-w".into()));
|
||||
assert_eq!(a.cpu, 2048, "the edit itself goes through");
|
||||
}
|
||||
|
||||
@@ -2653,6 +2952,88 @@ mod tests {
|
||||
p
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_gateway_sidecar_needs_the_openai_backend_and_a_gateway_model() {
|
||||
use crate::models::gateway_settings::{GatewayModel, GatewaySettings};
|
||||
use crate::models::project::Backend;
|
||||
let with_models = GatewaySettings {
|
||||
models: vec![GatewayModel { name: "gpt".into(), model_id: "gpt-5".into() }],
|
||||
..Default::default()
|
||||
};
|
||||
let half = GatewaySettings {
|
||||
models: vec![GatewayModel { name: "gpt".into(), model_id: " ".into() }],
|
||||
..Default::default()
|
||||
};
|
||||
let off = aws_project();
|
||||
let mut on = off.clone();
|
||||
on.aws.as_mut().unwrap().gateway_sidecar = true;
|
||||
|
||||
// Wrong backend: always refused.
|
||||
on.backend = Backend::Anthropic;
|
||||
let e = validate_gateway_sidecar_update(&off, &on, &with_models).unwrap_err();
|
||||
assert!(e.contains("OpenAI Compatible"), "{e}");
|
||||
assert!(validate_gateway_sidecar_update(&on, &on, &with_models).is_err());
|
||||
|
||||
// Turning it on without a complete gateway model row: refused.
|
||||
on.backend = Backend::OpenAiCompatible;
|
||||
let e = validate_gateway_sidecar_update(&off, &on, &half).unwrap_err();
|
||||
assert!(e.contains("Model Gateway"), "{e}");
|
||||
assert!(validate_gateway_sidecar_update(&off, &on, &with_models).is_ok());
|
||||
// Already on: an unrelated save still goes through.
|
||||
assert!(validate_gateway_sidecar_update(&on, &on, &half).is_ok());
|
||||
// Off: nothing to check.
|
||||
assert!(validate_gateway_sidecar_update(&off, &off, &half).is_ok());
|
||||
|
||||
// EC2 (bridge networking): refused even when it was already on.
|
||||
let mut ec2 = on.clone();
|
||||
ec2.aws.as_mut().unwrap().launch_type = crate::models::LaunchType::Ec2;
|
||||
let e = validate_gateway_sidecar_update(&on, &ec2, &with_models).unwrap_err();
|
||||
assert_eq!(e, crate::aws::workspace::EC2_NO_SIDECAR);
|
||||
assert!(validate_gateway_sidecar_update(&ec2, &ec2, &with_models).is_err());
|
||||
ec2.aws.as_mut().unwrap().gateway_sidecar = false;
|
||||
assert!(validate_gateway_sidecar_update(&on, &ec2, &with_models).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn docker_and_vpn_on_aws_need_the_ec2_launch_type() {
|
||||
use crate::models::LaunchType;
|
||||
let hosts = vec![host("h1")];
|
||||
let stored = aws_project();
|
||||
for (docker, vpn) in [(true, false), (false, true)] {
|
||||
let mut p = stored.clone();
|
||||
p.allow_docker_access = docker;
|
||||
p.vpn_support_enabled = vpn;
|
||||
assert!(validate_aws_update(&stored, &p, &hosts).is_err());
|
||||
// Already stored that way on Fargate: still refused (no grandfathering).
|
||||
assert!(validate_aws_update(&p, &p, &hosts).is_err());
|
||||
// Ec2 -> Fargate with the flags still on: refused.
|
||||
let mut ec2 = p.clone();
|
||||
ec2.aws.as_mut().unwrap().launch_type = LaunchType::Ec2;
|
||||
assert!(validate_aws_update(&ec2, &ec2, &hosts).is_ok());
|
||||
assert!(validate_aws_update(&ec2, &p, &hosts).is_err());
|
||||
// Local -> AWS(Fargate) with the flags on: refused.
|
||||
let mut local = stored.clone();
|
||||
local.host_id = None;
|
||||
local.aws_placement = None;
|
||||
local.aws = None;
|
||||
local.allow_docker_access = docker;
|
||||
local.vpn_support_enabled = vpn;
|
||||
assert!(validate_aws_update(&local, &p, &hosts).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_stored_workspace_access_point_blocks_moving_the_host() {
|
||||
let hosts = vec![host("h1"), host("h2")];
|
||||
let mut stored = aws_project();
|
||||
stored.aws.as_mut().unwrap().workspace_access_point_id = Some("fsap-w".into());
|
||||
let mut moved = stored.clone();
|
||||
moved.host_id = Some("h2".into());
|
||||
assert!(validate_aws_update(&stored, &moved, &hosts).unwrap_err().contains("AWS resources"));
|
||||
stored.aws.as_mut().unwrap().workspace_access_point_id = None;
|
||||
assert!(validate_aws_update(&stored, &moved, &hosts).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn host_update_rules() {
|
||||
let hosts = vec![host("h1")];
|
||||
@@ -2691,14 +3072,14 @@ mod tests {
|
||||
let hosts = vec![host("h1")];
|
||||
let mut stored = aws_project();
|
||||
stored.aws.as_mut().unwrap().access_point_id = Some("fsap-1".into());
|
||||
assert_eq!(access_point_after_removal(&stored, false), Some("fsap-1".into()));
|
||||
assert_eq!(access_point_after_removal(&stored, true), None);
|
||||
assert_eq!(access_points_after_removal(&stored, false), (Some("fsap-1".into()), None));
|
||||
assert_eq!(access_points_after_removal(&stored, true), (None, None));
|
||||
// What the store holds after a keep-the-files removal still blocks a move.
|
||||
let mut after = stored.clone();
|
||||
let a = after.aws.as_mut().unwrap();
|
||||
a.task_arn = None;
|
||||
a.task_definition_arn = None;
|
||||
a.access_point_id = access_point_after_removal(&stored, false);
|
||||
a.access_point_id = access_points_after_removal(&stored, false).0;
|
||||
let mut local = after.clone();
|
||||
local.host_id = None;
|
||||
local.aws_placement = None;
|
||||
@@ -2706,10 +3087,33 @@ mod tests {
|
||||
let e = validate_aws_update(&after, &local, &hosts).unwrap_err();
|
||||
assert!(e.contains("access point"), "{e}");
|
||||
// After a discarding removal it can move.
|
||||
after.aws.as_mut().unwrap().access_point_id = access_point_after_removal(&stored, true);
|
||||
after.aws.as_mut().unwrap().access_point_id = access_points_after_removal(&stored, true).0;
|
||||
assert!(validate_aws_update(&after, &local, &hosts).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_removal_keeps_or_drops_both_access_points_together() {
|
||||
let hosts = vec![host("h1")];
|
||||
// EFS switched to Hybrid: the /workspace access point is still stored.
|
||||
let mut stored = aws_project();
|
||||
let a = stored.aws.as_mut().unwrap();
|
||||
a.access_point_id = Some("fsap-1".into());
|
||||
a.workspace_access_point_id = Some("fsap-w".into());
|
||||
assert_eq!(
|
||||
access_points_after_removal(&stored, false),
|
||||
(Some("fsap-1".into()), Some("fsap-w".into()))
|
||||
);
|
||||
assert_eq!(access_points_after_removal(&stored, true), (None, None));
|
||||
// Kept: the stored /workspace access point alone still blocks a move.
|
||||
let mut after = stored.clone();
|
||||
after.aws.as_mut().unwrap().access_point_id = None;
|
||||
let mut local = after.clone();
|
||||
local.host_id = None;
|
||||
local.aws_placement = None;
|
||||
local.aws = None;
|
||||
assert!(validate_aws_update(&after, &local, &hosts).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_project_with_aws_resources_cannot_be_moved_off_its_host() {
|
||||
let hosts = vec![host("h1"), host("h2")];
|
||||
@@ -2838,6 +3242,14 @@ mod tests {
|
||||
let stop = &stop[..stop.find("\n}\n").unwrap()];
|
||||
let close = stop.find("close_sessions_for_container").unwrap();
|
||||
assert!(close < stop.find("aws_guard_before_stop(").unwrap());
|
||||
// Closing a tab only detaches a persistent terminal: its tmux server
|
||||
// is ended in the same step, before the push's snapshot.
|
||||
let end_all = stop.find("persistent::end_all(container)").unwrap();
|
||||
assert!(close < end_all && end_all < stop.find("aws_guard_before_stop(").unwrap());
|
||||
let close_first = &stop[stop.find("let close_first = async").unwrap()..stop.find("let guarded").unwrap()];
|
||||
assert!(close_first.contains("persistent::end_all"), "inside the step that runs first");
|
||||
// A stopped task's terminals are gone: forgotten.
|
||||
assert!(stop.find("terminal_store::clear").unwrap() > stop.find("stop_project(&project").unwrap());
|
||||
assert!(stop.find("auth_bridge.stop").unwrap() < stop.find("aws_guard_before_stop(").unwrap());
|
||||
}
|
||||
|
||||
@@ -2880,4 +3292,118 @@ mod tests {
|
||||
local.host_id = None;
|
||||
assert!(check_aws_resources_removable(&local).is_err());
|
||||
}
|
||||
|
||||
/// The text of `fn name` in this file, up to the next top-level item.
|
||||
fn fn_body<'a>(src: &'a str, name: &str) -> &'a str {
|
||||
let start = src.find(&format!("fn {name}(")).unwrap_or_else(|| panic!("{name} missing"));
|
||||
let rest = &src[start..];
|
||||
let end = rest.find("\n}\n").unwrap();
|
||||
&rest[..end]
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_workspace_follower_is_spawned_after_the_start_succeeds_and_only_for_aws() {
|
||||
// Ruling R5: the start ends after "Connecting…" (Running, lock
|
||||
// released when the command returns); the clone/setup follow runs
|
||||
// in the background and never inside the start.
|
||||
let src = include_str!("project_commands.rs");
|
||||
let start = fn_body(src, "start_project_container_locked");
|
||||
let running = start
|
||||
.find("update_status(&project_id, ProjectStatus::Running)")
|
||||
.expect("the start sets Running");
|
||||
let spawn = start.find("aws_host::spawn_follow(").expect("the start spawns the follower");
|
||||
assert!(spawn > running, "the follower is spawned only after the project is Running");
|
||||
assert_eq!(start.matches("spawn_follow(").count(), 1);
|
||||
let guard = start[..spawn].rfind("if project.is_aws() {").expect("AWS-only");
|
||||
assert!(start[guard..spawn].lines().count() <= 4, "the spawn sits right in the AWS guard");
|
||||
assert!(!start.contains("follow_workspace_status"), "no follow inside the start");
|
||||
// Docker: `spawn_follow` itself also refuses a local project
|
||||
// (`status::tests::a_local_project_has_no_workspace_status_and_no_follower`).
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_connect_of_a_copy_at_connect_project_copies_the_credentials_in() {
|
||||
// Q2: a start (new task or attach) and the background re-attach at
|
||||
// app start both push; a failure is a `workspace-warning`.
|
||||
let src = include_str!("project_commands.rs");
|
||||
let start = fn_body(src, "start_project_container_locked");
|
||||
let running = start.find("update_status(&project_id, ProjectStatus::Running)").unwrap();
|
||||
let push = start.find("aws_host::spawn_connect_push(").expect("the start pushes");
|
||||
assert!(push > running, "only once the workspace is connected and Running");
|
||||
let guard = start[..push].rfind("if project.is_aws() {").expect("AWS-only");
|
||||
assert!(start[guard..push].lines().count() <= 4);
|
||||
assert!(start[push..].starts_with("aws_host::spawn_connect_push(&project, &settings, move |detail| {\n emit_connect_warning("));
|
||||
let reconcile = fn_body(src, "reconcile_aws_projects");
|
||||
assert!(reconcile.contains("emit_connect_warning(&handle, &id, &name, &detail)"));
|
||||
assert!(reconcile.contains("aws_host::reconcile(\n &project,\n &settings,\n store,\n on_connect_warning,"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_aws_project_refuses_new_udp_and_reserved_mappings_and_a_local_one_does_not() {
|
||||
let hosts = vec![host("h1")];
|
||||
let udp = crate::models::PortMapping {
|
||||
host_port: 5353,
|
||||
container_port: 5353,
|
||||
protocol: "udp".into(),
|
||||
};
|
||||
let stored = aws_project();
|
||||
let mut aws = aws_project();
|
||||
aws.port_mappings = vec![udp.clone()];
|
||||
let e = validate_aws_update(&stored, &aws, &hosts).unwrap_err();
|
||||
assert!(e.contains("only TCP"), "{e}");
|
||||
// A stored UDP row does not block an unrelated save (it is skipped,
|
||||
// with a warning, at connect).
|
||||
assert!(validate_aws_update(&aws, &aws, &hosts).is_ok());
|
||||
// Moving a local project with one to AWS checks everything.
|
||||
let (mut local, _) = stored_and_stale_payload();
|
||||
local.port_mappings = vec![udp.clone()];
|
||||
assert!(validate_aws_update(&local, &aws, &hosts).unwrap_err().contains("only TCP"));
|
||||
aws.port_mappings[0].container_port = crate::host::ssm::AGENT_PORT;
|
||||
aws.port_mappings[0].protocol = "tcp".into();
|
||||
assert!(validate_aws_update(&stored, &aws, &hosts).is_err());
|
||||
aws.port_mappings[0].container_port = 3000;
|
||||
assert!(validate_aws_update(&stored, &aws, &hosts).is_ok());
|
||||
|
||||
// Docker publishes UDP itself: a local project is not checked.
|
||||
assert!(validate_aws_update(&local, &local, &hosts).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_connect_of_an_aws_project_opens_its_port_mappings() {
|
||||
// Q6: the start (after Running), the background re-attach, and a save
|
||||
// of the mappings while connected; a failure is a `workspace-warning`.
|
||||
let src = include_str!("project_commands.rs");
|
||||
let start = fn_body(src, "start_project_container_locked");
|
||||
let running = start.find("update_status(&project_id, ProjectStatus::Running)").unwrap();
|
||||
let open = start
|
||||
.find("port_forwards::open_for_project(&state.projects_store, &project_id, Some(warn))")
|
||||
.expect("the start opens them");
|
||||
assert!(open > running);
|
||||
let guard = start[..open].rfind("if project.is_aws() {").expect("AWS-only");
|
||||
assert!(start[guard..open].lines().count() <= 3);
|
||||
assert!(start[guard..open].contains("let warn = ports_warner(&app_handle, &project_id, &project.name);"));
|
||||
assert!(start[open..].lines().nth(1).unwrap().contains("emit_ports_warning("));
|
||||
let update = fn_body(src, "update_project");
|
||||
assert!(update.contains("port_forwards::open_for_project(&state.projects_store, &saved.id, Some(warn))"));
|
||||
let reconcile = fn_body(src, "reconcile_aws_projects");
|
||||
assert!(reconcile.contains("on_ports_warning,"));
|
||||
assert!(reconcile.contains("emit_ports_warning(&ports_handle, &ports_id, &ports_name, &detail)"));
|
||||
let aws_host = include_str!("../host/aws_host.rs");
|
||||
let reattached = aws_host.find("Ok(true) => {").unwrap();
|
||||
let opened = aws_host.find("port_forwards::open_for_project(&store, &project.id, Some(warn.clone()))").unwrap();
|
||||
let pushed = aws_host[reattached..].find("connect::apply_connect(").unwrap() + reattached;
|
||||
assert!(reattached < opened && opened < pushed);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn stop_ends_the_follower_before_it_stops_the_task() {
|
||||
let src = include_str!("project_commands.rs");
|
||||
let stop = fn_body(src, "stop_project_container");
|
||||
let cancel = stop.find("tunnels::cancel_follow(&project_id)").expect("stop cancels the follower");
|
||||
let task = stop.find(".stop_project(&project, &settings)").expect("stop stops the task");
|
||||
assert!(cancel < task);
|
||||
// Stop's own claim never waits on the follower: it holds none
|
||||
// (`status::tests::the_follower_takes_no_project_lock`).
|
||||
}
|
||||
|
||||
}
|
||||
@@ -115,13 +115,15 @@ pub async fn forget_choice<R: WipRunner>(runner: Option<&R>, choice: Option<WipC
|
||||
}
|
||||
|
||||
/// The root command that records `marker`; the value travels as `$1`, never
|
||||
/// inside the script.
|
||||
/// inside the script. The directory stays 0711 (the entrypoint's mode): the
|
||||
/// `claude` user reads the run id and its WIP record in it by name (the
|
||||
/// marker itself is 0600).
|
||||
pub fn stop_reason_command(marker: &str) -> Vec<String> {
|
||||
vec![
|
||||
"sh".into(),
|
||||
"-c".into(),
|
||||
format!(
|
||||
"umask 077 && mkdir -p /run/triple-c && chmod 700 /run/triple-c && printf '%s\\n' \"$1\" > {STOP_REASON_FILE}"
|
||||
"umask 077 && mkdir -p /run/triple-c && chmod 711 /run/triple-c && printf '%s\\n' \"$1\" > {STOP_REASON_FILE}"
|
||||
),
|
||||
"sh".into(),
|
||||
marker.into(),
|
||||
|
||||
@@ -1,8 +1,13 @@
|
||||
use tauri::{AppHandle, Emitter, State};
|
||||
|
||||
use crate::commands::aws_commands;
|
||||
use crate::host::persistent::{self, TerminalKind};
|
||||
use crate::host::ContainerTarget;
|
||||
use crate::models::{Backend, BedrockAuthMethod, Project};
|
||||
use crate::models::{
|
||||
Backend, BedrockAuthMethod, OpenedTerminal, Project, ProjectStatus, ReattachOutcome,
|
||||
WorkspaceTerminal,
|
||||
};
|
||||
use crate::storage::terminal_store::{self, PersistedTerminal};
|
||||
use crate::AppState;
|
||||
|
||||
/// Build the command to run in the container terminal.
|
||||
@@ -145,6 +150,10 @@ fi
|
||||
]
|
||||
}
|
||||
|
||||
/// Open a terminal tab. On an AWS project whose image has tmux the command
|
||||
/// runs inside its own tmux server keyed by `session_id`
|
||||
/// (`host::persistent`), so it outlives the app; the tab is remembered so the
|
||||
/// app reopens it on its next connect.
|
||||
#[tauri::command]
|
||||
pub async fn open_terminal_session(
|
||||
project_id: String,
|
||||
@@ -154,7 +163,7 @@ pub async fn open_terminal_session(
|
||||
resume_session_id: Option<String>,
|
||||
app_handle: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<(), String> {
|
||||
) -> Result<OpenedTerminal, String> {
|
||||
let project = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
@@ -169,6 +178,7 @@ pub async fn open_terminal_session(
|
||||
crate::commands::inspect_commands::validate_session_id(id)?;
|
||||
}
|
||||
|
||||
let kind = if session_type.as_deref() == Some("bash") { TerminalKind::Bash } else { TerminalKind::Claude };
|
||||
let cmd = match session_type.as_deref() {
|
||||
Some("bash") if resume_session_id.is_some() => {
|
||||
return Err("Only a Claude session can resume a conversation".to_string());
|
||||
@@ -182,6 +192,21 @@ pub async fn open_terminal_session(
|
||||
),
|
||||
};
|
||||
|
||||
// AWS copy-at-connect: the credentials go into this terminal's own
|
||||
// environment (never the agent's). Empty for everything else.
|
||||
let env = crate::host::aws_host::terminal_env(&project, &state.settings_store.get()).await;
|
||||
|
||||
let plan = persistent::plan(
|
||||
project.is_aws(),
|
||||
&target,
|
||||
&session_id,
|
||||
kind,
|
||||
session_name.as_deref(),
|
||||
cmd,
|
||||
env,
|
||||
)
|
||||
.await?;
|
||||
|
||||
let output_event = format!("terminal-output-{}", session_id);
|
||||
let exit_event = format!("terminal-exit-{}", session_id);
|
||||
let app_handle_output = app_handle.clone();
|
||||
@@ -192,7 +217,8 @@ pub async fn open_terminal_session(
|
||||
.create_session(
|
||||
&target,
|
||||
&session_id,
|
||||
cmd,
|
||||
plan.cmd,
|
||||
plan.env,
|
||||
move |data| {
|
||||
let _ = app_handle_output.emit(&output_event, data);
|
||||
},
|
||||
@@ -200,7 +226,19 @@ pub async fn open_terminal_session(
|
||||
let _ = app_handle_exit.emit(&exit_event, ());
|
||||
}),
|
||||
)
|
||||
.await
|
||||
.await?;
|
||||
|
||||
if plan.persistent {
|
||||
let entry = PersistedTerminal {
|
||||
id: session_id.clone(),
|
||||
kind,
|
||||
name: persistent::clean_name(session_name.as_deref()),
|
||||
};
|
||||
if let Err(e) = terminal_store::add(&project_id, entry) {
|
||||
log::warn!("Could not remember terminal {session_id}: {e}");
|
||||
}
|
||||
}
|
||||
Ok(OpenedTerminal { persistent: plan.persistent, notice: plan.notice })
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
@@ -222,6 +260,8 @@ pub async fn terminal_resize(
|
||||
state.exec_manager.resize(&session_id, cols, rows).await
|
||||
}
|
||||
|
||||
/// Close a tab. A persistent AWS terminal is *ended* (its tmux server
|
||||
/// killed) and forgotten: closing a tab is the one gesture that ends one.
|
||||
#[tauri::command]
|
||||
pub async fn close_terminal_session(
|
||||
session_id: String,
|
||||
@@ -230,8 +270,254 @@ pub async fn close_terminal_session(
|
||||
// Close audio bridge if it exists
|
||||
let audio_session_id = format!("audio-{}", session_id);
|
||||
state.exec_manager.close_session(&audio_session_id).await;
|
||||
let session_target = state.exec_manager.get_target(&session_id).await.ok();
|
||||
// Close terminal session
|
||||
state.exec_manager.close_session(&session_id).await;
|
||||
|
||||
if let Some((project_id, _)) = terminal_store::find(&session_id) {
|
||||
// A reattach of this tab still in flight must not remember it again.
|
||||
mark_closed(&session_id);
|
||||
if let Err(e) = terminal_store::remove(&session_id) {
|
||||
log::warn!("Could not forget terminal {session_id}: {e}");
|
||||
}
|
||||
// The project's current tunnel first: the session's own endpoint is
|
||||
// stale after a re-attach on a new port.
|
||||
let target = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.and_then(|p| ContainerTarget::for_project(&p))
|
||||
.or(session_target);
|
||||
let ended = match target {
|
||||
Some(t) => persistent::end(&t, &session_id).await,
|
||||
None => Err("not connected".to_string()),
|
||||
};
|
||||
if let Err(e) = ended {
|
||||
// Still running in the workspace (a leftover Claude would keep
|
||||
// it up): end it at the next connect.
|
||||
log::warn!("Terminal {session_id}: could not end it now ({e}); ending it at the next connect");
|
||||
if let Err(e) = terminal_store::add_pending_end(&project_id, &session_id) {
|
||||
log::warn!("Could not remember to end terminal {session_id}: {e}");
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Session ids whose tab was closed in this run of the app.
|
||||
fn closed_ids() -> &'static std::sync::Mutex<std::collections::HashSet<String>> {
|
||||
static C: std::sync::OnceLock<std::sync::Mutex<std::collections::HashSet<String>>> =
|
||||
std::sync::OnceLock::new();
|
||||
C.get_or_init(Default::default)
|
||||
}
|
||||
|
||||
fn mark_closed(session_id: &str) {
|
||||
closed_ids().lock().unwrap_or_else(|e| e.into_inner()).insert(session_id.to_string());
|
||||
}
|
||||
|
||||
fn was_closed(session_id: &str) -> bool {
|
||||
closed_ids().lock().unwrap_or_else(|e| e.into_inner()).contains(session_id)
|
||||
}
|
||||
|
||||
/// End the project's sessions whose tabs were closed while it could not be
|
||||
/// reached; returns the ones ended (or found gone).
|
||||
async fn end_pending(project_id: &str, target: &ContainerTarget, running: &[persistent::RunningSession]) -> Vec<String> {
|
||||
let pending = terminal_store::pending_end(project_id);
|
||||
let mut done = Vec::new();
|
||||
for key in pending {
|
||||
if !running.iter().any(|r| r.key == key) {
|
||||
done.push(key);
|
||||
continue;
|
||||
}
|
||||
match persistent::end(target, &key).await {
|
||||
Ok(()) => done.push(key),
|
||||
Err(e) => log::warn!("Could not end closed terminal {key}: {e}"),
|
||||
}
|
||||
}
|
||||
if !done.is_empty() {
|
||||
if let Err(e) = terminal_store::done_pending_end(project_id, &done) {
|
||||
log::warn!("Could not update the terminals to end: {e}");
|
||||
}
|
||||
}
|
||||
done
|
||||
}
|
||||
|
||||
/// A connected AWS project's target, waiting for a re-attach in progress.
|
||||
async fn aws_target(project: &Project) -> Result<ContainerTarget, String> {
|
||||
if !project.is_aws() {
|
||||
return Err("Only AWS workspaces keep terminals".into());
|
||||
}
|
||||
if project.status != ProjectStatus::Running {
|
||||
return Err(format!("“{}” is not running", project.name));
|
||||
}
|
||||
ContainerTarget::for_project_waiting(project)
|
||||
.await
|
||||
.ok_or_else(|| "Triple-C is not connected to the workspace".to_string())
|
||||
}
|
||||
|
||||
/// The workspace's running terminals with what the app remembers of them,
|
||||
/// remembered ones first in the order they were opened. Prunes remembered
|
||||
/// entries the workspace no longer runs. Empty for a Docker project, a
|
||||
/// stopped one and an image without tmux.
|
||||
#[tauri::command]
|
||||
pub async fn list_workspace_terminals(
|
||||
project_id: String,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<Vec<WorkspaceTerminal>, String> {
|
||||
let project = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.ok_or_else(|| format!("Project {} not found", project_id))?;
|
||||
if !project.is_aws() || project.status != ProjectStatus::Running {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let target = aws_target(&project).await?;
|
||||
// An `Err` (an unanswered probe or listing) says nothing about what runs:
|
||||
// nothing is pruned or ended on it, and the caller asks again.
|
||||
let mut running = persistent::list(&target).await?;
|
||||
let ended = end_pending(&project_id, &target, &running).await;
|
||||
running.retain(|r| !ended.contains(&r.key));
|
||||
let keys = running.iter().map(|r| r.key.clone()).collect();
|
||||
if let Err(e) = terminal_store::retain(&project_id, &keys) {
|
||||
log::warn!("Could not prune remembered terminals: {e}");
|
||||
}
|
||||
Ok(merge_terminals(&terminal_store::list(&project_id), running))
|
||||
}
|
||||
|
||||
/// Remembered sessions first (in their order), then the others oldest first.
|
||||
pub(crate) fn merge_terminals(
|
||||
remembered: &[PersistedTerminal],
|
||||
mut running: Vec<persistent::RunningSession>,
|
||||
) -> Vec<WorkspaceTerminal> {
|
||||
running.sort_by_key(|r| {
|
||||
(
|
||||
remembered.iter().position(|m| m.id == r.key).unwrap_or(usize::MAX),
|
||||
r.created_unix,
|
||||
)
|
||||
});
|
||||
running
|
||||
.into_iter()
|
||||
.map(|r| {
|
||||
let mine = remembered.iter().find(|m| m.id == r.key);
|
||||
WorkspaceTerminal {
|
||||
kind: mine.map(|m| m.kind).unwrap_or(r.kind),
|
||||
name: mine.map(|m| m.name.clone()).unwrap_or(r.name),
|
||||
known: mine.is_some(),
|
||||
session_id: r.key,
|
||||
created_unix: r.created_unix,
|
||||
attached: r.attached,
|
||||
}
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Attach a tab to a terminal still running in the workspace: a tab the app
|
||||
/// reopens after a restart or a dropped connection, or one picked in Project
|
||||
/// Home → Sessions. Never starts anything: a session that is gone is
|
||||
/// `Ended` (and forgotten). With `rows` (a fresh xterm), the pane's history
|
||||
/// is replayed into the tab's output first, so its scrollback comes back.
|
||||
/// The tab's output listener must be registered before this is called.
|
||||
#[tauri::command]
|
||||
pub async fn reattach_terminal_session(
|
||||
project_id: String,
|
||||
session_id: String,
|
||||
rows: Option<u16>,
|
||||
app_handle: AppHandle,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<ReattachOutcome, String> {
|
||||
persistent::validate_key(&session_id)?;
|
||||
let project = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.ok_or_else(|| format!("Project {} not found", project_id))?;
|
||||
if was_closed(&session_id) {
|
||||
return Ok(ReattachOutcome::Ended);
|
||||
}
|
||||
let target = aws_target(&project).await?;
|
||||
// Unanswered → `Err` (the tab retries); only a real "no tmux" ends it.
|
||||
if !persistent::supported(&target).await? {
|
||||
terminal_store::remove(&session_id).ok();
|
||||
return Ok(ReattachOutcome::Ended);
|
||||
}
|
||||
if terminal_store::pending_end(&project_id).contains(&session_id) {
|
||||
return Ok(ReattachOutcome::Ended);
|
||||
}
|
||||
let running = persistent::list(&target).await?;
|
||||
let Some(found) = running.into_iter().find(|r| r.key == session_id) else {
|
||||
if let Err(e) = terminal_store::remove(&session_id) {
|
||||
log::warn!("Could not forget terminal {session_id}: {e}");
|
||||
}
|
||||
return Ok(ReattachOutcome::Ended);
|
||||
};
|
||||
let remembered = terminal_store::find(&session_id).filter(|(p, _)| *p == project_id);
|
||||
let (kind, name) = match remembered {
|
||||
Some((_, m)) => (m.kind, m.name),
|
||||
None => (found.kind, found.name),
|
||||
};
|
||||
|
||||
let output_event = format!("terminal-output-{}", session_id);
|
||||
if let Some(rows) = rows {
|
||||
// Exactly one chunk, empty when there is no history: the tab treats
|
||||
// the first chunk after asking for a replay as the replay, so live
|
||||
// output after it gets its URL/OSC/SSO handling again.
|
||||
let bytes = persistent::history(&target, &session_id)
|
||||
.await
|
||||
.map(|h| persistent::replay_bytes(&h, rows))
|
||||
.unwrap_or_default();
|
||||
let _ = app_handle.emit(&output_event, bytes);
|
||||
}
|
||||
|
||||
let exit_event = format!("terminal-exit-{}", session_id);
|
||||
let app_handle_output = app_handle.clone();
|
||||
let app_handle_exit = app_handle.clone();
|
||||
state
|
||||
.exec_manager
|
||||
.create_session(
|
||||
&target,
|
||||
&session_id,
|
||||
persistent::attach_cmd(&session_id)?,
|
||||
persistent::client_env(Vec::new()),
|
||||
move |data| {
|
||||
let _ = app_handle_output.emit(&output_event, data);
|
||||
},
|
||||
Box::new(move || {
|
||||
let _ = app_handle_exit.emit(&exit_event, ());
|
||||
}),
|
||||
)
|
||||
.await?;
|
||||
|
||||
// Closed while this attach was under way: its close already ended (or
|
||||
// queued the end of) the session; don't remember it again.
|
||||
if was_closed(&session_id) {
|
||||
state.exec_manager.close_session(&session_id).await;
|
||||
return Ok(ReattachOutcome::Ended);
|
||||
}
|
||||
let entry = PersistedTerminal { id: session_id.clone(), kind, name: name.clone() };
|
||||
if let Err(e) = terminal_store::add(&project_id, entry) {
|
||||
log::warn!("Could not remember terminal {session_id}: {e}");
|
||||
}
|
||||
Ok(ReattachOutcome::Reattached { kind, name })
|
||||
}
|
||||
|
||||
/// End a terminal running in the workspace that has no tab here (Project
|
||||
/// Home → Sessions → End). A tab's own close goes through
|
||||
/// `close_terminal_session`.
|
||||
#[tauri::command]
|
||||
pub async fn end_workspace_terminal(
|
||||
project_id: String,
|
||||
session_id: String,
|
||||
state: State<'_, AppState>,
|
||||
) -> Result<(), String> {
|
||||
persistent::validate_key(&session_id)?;
|
||||
let project = state
|
||||
.projects_store
|
||||
.get(&project_id)
|
||||
.ok_or_else(|| format!("Project {} not found", project_id))?;
|
||||
let target = aws_target(&project).await?;
|
||||
state.exec_manager.close_session(&session_id).await;
|
||||
persistent::end(&target, &session_id).await?;
|
||||
if let Err(e) = terminal_store::remove(&session_id) {
|
||||
log::warn!("Could not forget terminal {session_id}: {e}");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -566,6 +852,40 @@ mod tests {
|
||||
assert!(!cmd[2].contains(" -n "), "resume must not rename: {}", cmd[2]);
|
||||
}
|
||||
|
||||
/// The app's own tabs come first in the order they were opened, with
|
||||
/// the app's labels; sessions from elsewhere follow, oldest first, and
|
||||
/// are not "known" (so they are listed, never auto-opened).
|
||||
#[test]
|
||||
fn workspace_terminals_merge_what_the_app_remembers_with_what_runs() {
|
||||
use super::merge_terminals;
|
||||
use crate::host::persistent::{RunningSession, TerminalKind};
|
||||
use crate::storage::terminal_store::PersistedTerminal;
|
||||
let run = |key: &str, kind, created, name: Option<&str>| RunningSession {
|
||||
key: key.into(),
|
||||
kind,
|
||||
created_unix: created,
|
||||
attached: false,
|
||||
name: name.map(str::to_string),
|
||||
};
|
||||
let remembered = vec![
|
||||
PersistedTerminal { id: "b".into(), kind: TerminalKind::Claude, name: Some("second".into()) },
|
||||
PersistedTerminal { id: "a".into(), kind: TerminalKind::Bash, name: None },
|
||||
PersistedTerminal { id: "gone".into(), kind: TerminalKind::Bash, name: None },
|
||||
];
|
||||
let running = vec![
|
||||
run("x", TerminalKind::Bash, 50, Some("web terminal")),
|
||||
run("a", TerminalKind::Bash, 10, None),
|
||||
run("w", TerminalKind::Claude, 5, None),
|
||||
run("b", TerminalKind::Claude, 20, Some("tmux label")),
|
||||
];
|
||||
let got = merge_terminals(&remembered, running);
|
||||
let ids: Vec<_> = got.iter().map(|t| t.session_id.as_str()).collect();
|
||||
assert_eq!(ids, ["b", "a", "w", "x"]);
|
||||
assert!(got[0].known && got[1].known && !got[2].known && !got[3].known);
|
||||
assert_eq!(got[0].name.as_deref(), Some("second"), "the app's label wins");
|
||||
assert_eq!(got[3].name.as_deref(), Some("web terminal"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_dropped_file_keeps_the_name_the_user_dropped() {
|
||||
use crate::commands::file_commands::host_upload_name;
|
||||
|
||||
@@ -77,7 +77,7 @@ pub struct ContainerExited<'a> {
|
||||
/// Why an AWS task stopped, for the UI's toast.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub struct StopNote {
|
||||
/// `spot`, `idle`, `failed` (the project goes to Error), `user` (someone
|
||||
/// `spot`, `idle`, `lifetime`, `failed` (the project goes to Error), `user` (someone
|
||||
/// stopped it: no toast) or `exited` (on its own).
|
||||
pub kind: &'static str,
|
||||
/// ECS's stopped reason, or a fixed text.
|
||||
@@ -89,6 +89,7 @@ impl StopNote {
|
||||
let (kind, message) = match kind {
|
||||
StopKind::Spot => ("spot", Some("Spot interruption".to_string())),
|
||||
StopKind::Idle => ("idle", None),
|
||||
StopKind::LifetimeCap => ("lifetime", None),
|
||||
StopKind::FailedToStart(r) => ("failed", Some(r.clone())),
|
||||
StopKind::UserInitiated => ("user", None),
|
||||
StopKind::Exited(r) => ("exited", r.clone()),
|
||||
@@ -116,7 +117,14 @@ async fn settle(store: &ProjectsStore, container: &ContainerTarget) -> Option<Pr
|
||||
return None;
|
||||
}
|
||||
match store.mark_exited(container_id, &seen, project_busy) {
|
||||
ExitMark::Flipped(p) => return Some(*p),
|
||||
ExitMark::Flipped(p) => {
|
||||
// An AWS task that stopped by itself (idle, lifetime cap,
|
||||
// crash) took its persistent terminals with it.
|
||||
if p.is_aws() {
|
||||
crate::storage::terminal_store::clear(&p.id);
|
||||
}
|
||||
return Some(*p);
|
||||
}
|
||||
ExitMark::NotApplicable => return None,
|
||||
// The store moved while the host was answering — possibly a stop and
|
||||
// start of this very container. The inspect is stale; ask again.
|
||||
@@ -276,6 +284,7 @@ pub fn spawn(
|
||||
None,
|
||||
a.access_point_id.clone(),
|
||||
a.task_definition_arn.clone(),
|
||||
a.workspace_access_point_id.clone(),
|
||||
);
|
||||
}
|
||||
let id = p.id.clone();
|
||||
@@ -331,6 +340,7 @@ mod tests {
|
||||
let cases = [
|
||||
(StopKind::Spot, "spot", Some("Spot interruption")),
|
||||
(StopKind::Idle, "idle", None),
|
||||
(StopKind::LifetimeCap, "lifetime", None),
|
||||
(StopKind::FailedToStart("CannotPull".into()), "failed", Some("CannotPull")),
|
||||
(StopKind::UserInitiated, "user", None),
|
||||
(StopKind::Exited(Some("OOM".into())), "exited", Some("OOM")),
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -108,7 +108,8 @@ fn sha256_hex(input: &str) -> String {
|
||||
/// loops that walk the store, and leading dots are stripped so a hidden file
|
||||
/// does not stay hidden.
|
||||
///
|
||||
/// `entrypoint.sh` reimplements exactly this in a few lines of shell (it has to
|
||||
/// `entrypoint-lib.sh` (`ca_normalise_name`, sourced by `entrypoint.sh`)
|
||||
/// reimplements exactly this in a few lines of shell (it has to
|
||||
/// rename the files inside the container); the two must agree, which is what
|
||||
/// the unit tests below pin down.
|
||||
pub fn container_cert_name(file_name: &str) -> String {
|
||||
|
||||
@@ -15,16 +15,35 @@ pub fn get_docker() -> Result<Docker, String> {
|
||||
}
|
||||
|
||||
pub async fn check_docker_available() -> Result<bool, String> {
|
||||
let docker = get_docker()?;
|
||||
match docker.ping().await {
|
||||
Ok(_) => Ok(true),
|
||||
Err(_) => {
|
||||
// Connection object exists but daemon not responding — clear cache
|
||||
let mut guard = DOCKER.lock().map_err(|e| format!("Lock poisoned: {}", e))?;
|
||||
*guard = None;
|
||||
Ok(false)
|
||||
}
|
||||
}
|
||||
Ok(docker_status().await.state == super::status::DockerState::Running)
|
||||
}
|
||||
|
||||
/// Ping the daemon and, when it does not answer, say why: not installed, installed
|
||||
/// but not running, or running but refusing us. See `docker/status.rs`.
|
||||
pub async fn docker_status() -> super::status::DockerStatus {
|
||||
use super::status::{self, PingOutcome};
|
||||
let docker_host = std::env::var("DOCKER_HOST").ok();
|
||||
let os = status::current_os();
|
||||
let endpoint = status::endpoint(docker_host.as_deref());
|
||||
|
||||
let (ping, detail) = match get_docker() {
|
||||
Err(e) => (PingOutcome::Unreachable, Some(e)),
|
||||
Ok(docker) => match docker.ping().await {
|
||||
Ok(_) => (PingOutcome::Ok, None),
|
||||
Err(e) => {
|
||||
// Connection object exists but daemon not responding — clear cache
|
||||
if let Ok(mut guard) = DOCKER.lock() {
|
||||
*guard = None;
|
||||
}
|
||||
(status::ping_outcome_from_error(&e), Some(e.to_string()))
|
||||
}
|
||||
},
|
||||
};
|
||||
let installed = ping == PingOutcome::Unreachable
|
||||
&& (status::docker_installed(os, docker_host.as_deref())
|
||||
// An explicit DOCKER_HOST means the user has a daemon somewhere.
|
||||
|| docker_host.as_deref().is_some_and(|h| !h.trim().is_empty()));
|
||||
status::DockerStatus { state: status::classify(ping, installed), endpoint, detail, os }
|
||||
}
|
||||
|
||||
/// The daemon socket a project container gets bind-mounted when Docker access
|
||||
|
||||
@@ -260,6 +260,10 @@ const RESERVED_ENV_PREFIXES: &[&str] = &["ANTHROPIC_", "AWS_", "GIT_", "HOST_",
|
||||
/// value would silently outrank the keychain-held shared token and be invisible
|
||||
/// to the auth UI.
|
||||
const RESERVED_ENV_EXACT: &[&str] = &[
|
||||
// Persistent AWS terminals (`host::persistent`): either would point a
|
||||
// tab's tmux at another socket than the one the app lists and ends.
|
||||
"TMUX",
|
||||
"TMUX_TMPDIR",
|
||||
"CLAUDE_INSTRUCTIONS",
|
||||
"MCP_SERVERS_JSON",
|
||||
"CLAUDE_CODE_SETTINGS_JSON",
|
||||
@@ -1112,6 +1116,37 @@ fn vpn_host_config(enabled: bool) -> VpnHostConfigParts {
|
||||
)
|
||||
}
|
||||
|
||||
/// What a VPN client needs, as plain data, for hosts that aren't Docker (an
|
||||
/// AWS EC2 task definition): the capabilities, the devices as
|
||||
/// `(host path, container path, cgroup permissions)`, and the sysctls,
|
||||
/// sorted. Derived from [`vpn_host_config`] so the two can't drift.
|
||||
pub(crate) struct VpnRequirements {
|
||||
pub capabilities: Vec<String>,
|
||||
pub devices: Vec<(String, String, String)>,
|
||||
pub sysctls: Vec<(String, String)>,
|
||||
}
|
||||
|
||||
pub(crate) fn vpn_requirements() -> VpnRequirements {
|
||||
let (caps, devices, sysctls) = vpn_host_config(true);
|
||||
let mut sysctls: Vec<(String, String)> = sysctls.unwrap_or_default().into_iter().collect();
|
||||
sysctls.sort();
|
||||
VpnRequirements {
|
||||
capabilities: caps.unwrap_or_default(),
|
||||
devices: devices
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.map(|d| {
|
||||
(
|
||||
d.path_on_host.unwrap_or_default(),
|
||||
d.path_in_container.unwrap_or_default(),
|
||||
d.cgroup_permissions.unwrap_or_default(),
|
||||
)
|
||||
})
|
||||
.collect(),
|
||||
sysctls,
|
||||
}
|
||||
}
|
||||
|
||||
/// Turn the daemon's device-passthrough failure into an explanation.
|
||||
///
|
||||
/// **This fires on `start`, not `create`.** Verified against Docker 29.7:
|
||||
|
||||
@@ -58,10 +58,30 @@ const GATEWAY_LITELLM_VERSION: &str = "v1.106.6";
|
||||
const GATEWAY_REGISTRY_DIGEST: &str =
|
||||
"sha256:37e2dafb088a7723beb998590682957386dfc83ffea1848486f8e0e5cfac0b06";
|
||||
|
||||
fn registry_image_ref() -> String {
|
||||
/// The digest-pinned registry image. The AWS gateway sidecar runs it too
|
||||
/// (`aws::workspace`); the index covers linux/amd64 and linux/arm64.
|
||||
pub(crate) fn registry_image_ref() -> String {
|
||||
format!("{}@{}", GATEWAY_REGISTRY_REPO, GATEWAY_REGISTRY_DIGEST)
|
||||
}
|
||||
|
||||
/// The environment variables the AWS gateway sidecar gets its two keys in
|
||||
/// (from the project secret). [`sidecar_config`] names them with LiteLLM's
|
||||
/// `os.environ/<NAME>` references, so the config itself holds no key.
|
||||
pub(crate) const SIDECAR_API_KEY_ENV: &str = "TRIPLEC_GATEWAY_API_KEY";
|
||||
pub(crate) const SIDECAR_MASTER_KEY_ENV: &str = "TRIPLEC_GATEWAY_MASTER_KEY";
|
||||
|
||||
/// The LiteLLM config for the AWS gateway sidecar: [`render_config`]'s, with
|
||||
/// the provider key and master key as `os.environ/…` references (LiteLLM
|
||||
/// resolves both: `litellm_params.api_key` and `general_settings.master_key`).
|
||||
/// Holds no secret, so it can be sized and shown in errors.
|
||||
pub(crate) fn sidecar_config(settings: &GatewaySettings) -> String {
|
||||
render_config(
|
||||
settings,
|
||||
&format!("os.environ/{SIDECAR_API_KEY_ENV}"),
|
||||
&format!("os.environ/{SIDECAR_MASTER_KEY_ENV}"),
|
||||
)
|
||||
}
|
||||
|
||||
/// Local builds are tagged with the pin plus a hash of the embedded build
|
||||
/// context (`triple-c-gateway:v1.106.6-1a2b3c4d`), never a floating tag. A
|
||||
/// build made by an app version with a different pin *or* a different
|
||||
@@ -1175,6 +1195,22 @@ mod tests {
|
||||
assert!(!render_config(&s, "k", "m").contains("api_base"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sidecar_config_references_the_keys_and_holds_none() {
|
||||
let yaml = sidecar_config(&settings());
|
||||
assert!(yaml.contains("api_key: \"os.environ/TRIPLEC_GATEWAY_API_KEY\""));
|
||||
assert!(yaml.contains("master_key: \"os.environ/TRIPLEC_GATEWAY_MASTER_KEY\""));
|
||||
// Otherwise exactly what Docker's gateway gets.
|
||||
assert_eq!(
|
||||
yaml,
|
||||
render_config(
|
||||
&settings(),
|
||||
"os.environ/TRIPLEC_GATEWAY_API_KEY",
|
||||
"os.environ/TRIPLEC_GATEWAY_MASTER_KEY"
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn yaml_str_escapes_injection_attempts() {
|
||||
let hostile = "a\"\nmaster_key: \"pwned";
|
||||
|
||||
@@ -10,6 +10,12 @@ use crate::models::container_config;
|
||||
|
||||
const DOCKERFILE: &str = include_str!("../../../../container/Dockerfile");
|
||||
const ENTRYPOINT: &str = include_str!("../../../../container/entrypoint.sh");
|
||||
/// Sourced by the entrypoint and by `triple-c-apply-connect`; holds the
|
||||
/// `sync_host_ssh` block the tests below run.
|
||||
const ENTRYPOINT_LIB: &str = include_str!("../../../../container/entrypoint-lib.sh");
|
||||
const APPLY_CONNECT: &str = include_str!("../../../../container/triple-c-apply-connect");
|
||||
/// `/etc/triple-c/tmux.conf`: persistent AWS terminals (`host::persistent`).
|
||||
const TMUX_CONF: &str = include_str!("../../../../container/triple-c-tmux.conf");
|
||||
const SCHEDULER: &str = include_str!("../../../../container/triple-c-scheduler");
|
||||
const TASK_RUNNER: &str = include_str!("../../../../container/triple-c-task-runner");
|
||||
const OSC52_CLIPBOARD: &str = include_str!("../../../../container/osc52-clipboard");
|
||||
@@ -19,6 +25,7 @@ const TRIPLE_C_OPEN: &str = include_str!("../../../../container/triple-c-open");
|
||||
const PLAYWRIGHT_HEAL: &str = include_str!("../../../../container/triple-c-playwright-heal");
|
||||
const WIP_PUSH: &str = include_str!("../../../../container/triple-c-wip-push");
|
||||
const IDLE_WATCH: &str = include_str!("../../../../container/triple-c-idle-watch");
|
||||
const WORKSPACE_STATUS: &str = include_str!("../../../../container/triple-c-workspace-status");
|
||||
|
||||
static MISSION_CONTROL_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/../../container/mission-control");
|
||||
static SKILLS_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/../../container/skills");
|
||||
@@ -240,6 +247,9 @@ fn create_build_context() -> Result<Vec<u8>, std::io::Error> {
|
||||
|
||||
append_file_to_archive(&mut archive, "Dockerfile", DOCKERFILE.as_bytes(), 0o644)?;
|
||||
append_file_to_archive(&mut archive, "entrypoint.sh", ENTRYPOINT.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "entrypoint-lib.sh", ENTRYPOINT_LIB.as_bytes(), 0o644)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-apply-connect", APPLY_CONNECT.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-tmux.conf", TMUX_CONF.as_bytes(), 0o644)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-scheduler", SCHEDULER.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-task-runner", TASK_RUNNER.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "osc52-clipboard", OSC52_CLIPBOARD.as_bytes(), 0o755)?;
|
||||
@@ -249,6 +259,12 @@ fn create_build_context() -> Result<Vec<u8>, std::io::Error> {
|
||||
append_file_to_archive(&mut archive, "triple-c-playwright-heal", PLAYWRIGHT_HEAL.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-wip-push", WIP_PUSH.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(&mut archive, "triple-c-idle-watch", IDLE_WATCH.as_bytes(), 0o755)?;
|
||||
append_file_to_archive(
|
||||
&mut archive,
|
||||
"triple-c-workspace-status",
|
||||
WORKSPACE_STATUS.as_bytes(),
|
||||
0o755,
|
||||
)?;
|
||||
|
||||
append_embedded_dir(&mut archive, &MISSION_CONTROL_DIR, "mission-control")?;
|
||||
append_embedded_dir(&mut archive, &SKILLS_DIR, "skills")?;
|
||||
@@ -305,17 +321,18 @@ mod build_context_tests {
|
||||
|
||||
#[cfg(all(test, unix))]
|
||||
mod tests {
|
||||
use super::ENTRYPOINT;
|
||||
use super::ENTRYPOINT_LIB;
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
use std::process::Command;
|
||||
|
||||
/// The `sync_host_ssh` function from `entrypoint.sh`, cut out between its
|
||||
/// markers so it can be run against temp dirs instead of the real ~/.ssh.
|
||||
/// The `sync_host_ssh` function from `entrypoint-lib.sh` (which
|
||||
/// `entrypoint.sh` sources), cut out between its markers so it can be run
|
||||
/// against temp dirs instead of the real ~/.ssh.
|
||||
fn sync_fn() -> &'static str {
|
||||
let start = ENTRYPOINT.find("# >>> sync_host_ssh").expect("start marker");
|
||||
let end = ENTRYPOINT.find("# <<< sync_host_ssh").expect("end marker");
|
||||
&ENTRYPOINT[start..end]
|
||||
let start = ENTRYPOINT_LIB.find("# >>> sync_host_ssh").expect("start marker");
|
||||
let end = ENTRYPOINT_LIB.find("# <<< sync_host_ssh").expect("end marker");
|
||||
&ENTRYPOINT_LIB[start..end]
|
||||
}
|
||||
|
||||
fn sync(src: &Path, dest: &Path) -> String {
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
pub mod ca_certs;
|
||||
pub mod client;
|
||||
pub mod status;
|
||||
pub mod events;
|
||||
pub mod container;
|
||||
pub mod workspace_env;
|
||||
|
||||
@@ -0,0 +1,282 @@
|
||||
//! Why Docker is unavailable, not just whether it is.
|
||||
//!
|
||||
//! A daemon that failed to start (systemd `start-limit-hit`, Docker Desktop
|
||||
//! still booting) and a socket the user may not open both used to surface as
|
||||
//! "Docker not detected — install it", which sends people to reinstall
|
||||
//! something they already have. This module tells the cases apart from the
|
||||
//! ping's error and a few cheap filesystem probes. It never runs a process
|
||||
//! (no `systemctl`, no `docker info`).
|
||||
|
||||
use serde::Serialize;
|
||||
use std::error::Error as StdError;
|
||||
use std::io;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
/// Mirrors `DockerStatus` in `src/lib/types.ts`.
|
||||
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
|
||||
pub struct DockerStatus {
|
||||
/// `running` | `not_running` | `no_permission` | `not_installed`
|
||||
pub state: DockerState,
|
||||
/// The endpoint that was tried — `DOCKER_HOST` when set, else the default socket/pipe.
|
||||
pub endpoint: String,
|
||||
/// The connection error, for the "details" line. `None` when running.
|
||||
pub detail: Option<String>,
|
||||
/// `linux` | `macos` | `windows` | `unknown` — picks the guidance to show.
|
||||
pub os: &'static str,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, Serialize, PartialEq, Eq)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum DockerState {
|
||||
Running,
|
||||
NotRunning,
|
||||
NoPermission,
|
||||
NotInstalled,
|
||||
}
|
||||
|
||||
/// What the ping told us, reduced to what matters for the classification.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum PingOutcome {
|
||||
Ok,
|
||||
/// The socket/pipe exists but the OS refused to let us open it.
|
||||
PermissionDenied,
|
||||
/// Nothing answered: socket missing, connection refused, timeout, other.
|
||||
Unreachable,
|
||||
}
|
||||
|
||||
/// The pure decision. `installed` is true when any installed-ness probe hit.
|
||||
pub fn classify(ping: PingOutcome, installed: bool) -> DockerState {
|
||||
match ping {
|
||||
PingOutcome::Ok => DockerState::Running,
|
||||
// Getting EACCES means something is listening on a socket we can't
|
||||
// open — Docker is there; the user lacks access.
|
||||
PingOutcome::PermissionDenied => DockerState::NoPermission,
|
||||
PingOutcome::Unreachable if installed => DockerState::NotRunning,
|
||||
PingOutcome::Unreachable => DockerState::NotInstalled,
|
||||
}
|
||||
}
|
||||
|
||||
/// Walk an error's `source()` chain for an `io::Error` and map its kind.
|
||||
/// Falls back to the rendered message, since some layers (hyper-util's
|
||||
/// connect errors, named pipes) only keep the OS error as text.
|
||||
pub fn ping_outcome_from_error(err: &(dyn StdError + 'static)) -> PingOutcome {
|
||||
let mut cur: Option<&(dyn StdError + 'static)> = Some(err);
|
||||
let mut text = String::new();
|
||||
while let Some(e) = cur {
|
||||
if let Some(ioe) = e.downcast_ref::<io::Error>() {
|
||||
if ioe.kind() == io::ErrorKind::PermissionDenied {
|
||||
return PingOutcome::PermissionDenied;
|
||||
}
|
||||
}
|
||||
text.push_str(&e.to_string().to_lowercase());
|
||||
text.push('\n');
|
||||
cur = e.source();
|
||||
}
|
||||
if text.contains("permission denied") || text.contains("access is denied") || text.contains("os error 13") {
|
||||
PingOutcome::PermissionDenied
|
||||
} else {
|
||||
PingOutcome::Unreachable
|
||||
}
|
||||
}
|
||||
|
||||
/// The endpoint bollard's `connect_with_local_defaults` will use.
|
||||
pub fn endpoint(docker_host: Option<&str>) -> String {
|
||||
match docker_host.map(str::trim).filter(|h| !h.is_empty()) {
|
||||
Some(h) => h.to_string(),
|
||||
None if cfg!(windows) => "npipe:////./pipe/docker_engine".to_string(),
|
||||
None => "unix:///var/run/docker.sock".to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn current_os() -> &'static str {
|
||||
if cfg!(target_os = "linux") {
|
||||
"linux"
|
||||
} else if cfg!(target_os = "macos") {
|
||||
"macos"
|
||||
} else if cfg!(windows) {
|
||||
"windows"
|
||||
} else {
|
||||
"unknown"
|
||||
}
|
||||
}
|
||||
|
||||
/// Paths whose existence means Docker is installed on this OS. Pure so the
|
||||
/// list can be tested; `docker_installed` does the filesystem checks.
|
||||
pub fn install_markers(os: &str, home: Option<&Path>, docker_host: Option<&str>) -> Vec<PathBuf> {
|
||||
let mut v: Vec<PathBuf> = Vec::new();
|
||||
// A unix:// DOCKER_HOST whose socket file exists counts, whatever the OS.
|
||||
if let Some(p) = docker_host.and_then(|h| h.trim().strip_prefix("unix://")) {
|
||||
if !p.is_empty() {
|
||||
v.push(PathBuf::from(p));
|
||||
}
|
||||
}
|
||||
match os {
|
||||
"linux" => {
|
||||
v.extend(
|
||||
["/usr/bin/dockerd", "/usr/local/bin/dockerd", "/usr/bin/docker", "/var/run/docker.sock", "/run/docker.sock"]
|
||||
.iter()
|
||||
.map(PathBuf::from),
|
||||
);
|
||||
if let Some(h) = home {
|
||||
v.push(h.join(".docker/desktop"));
|
||||
v.push(h.join("bin/dockerd")); // rootless install script
|
||||
}
|
||||
}
|
||||
"macos" => {
|
||||
v.push(PathBuf::from("/Applications/Docker.app"));
|
||||
v.push(PathBuf::from("/var/run/docker.sock"));
|
||||
v.push(PathBuf::from("/usr/local/bin/docker"));
|
||||
if let Some(h) = home {
|
||||
v.push(h.join("Applications/Docker.app"));
|
||||
v.push(h.join(".docker/run/docker.sock"));
|
||||
}
|
||||
}
|
||||
"windows" => {
|
||||
v.push(PathBuf::from(r"C:\Program Files\Docker\Docker\Docker Desktop.exe"));
|
||||
v.push(PathBuf::from(r"C:\Program Files\Docker\Docker\resources\bin\docker.exe"));
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
v
|
||||
}
|
||||
|
||||
/// Executable names to look for on `PATH`.
|
||||
pub fn path_binaries(os: &str) -> &'static [&'static str] {
|
||||
match os {
|
||||
"windows" => &["docker.exe"],
|
||||
_ => &["docker", "dockerd"],
|
||||
}
|
||||
}
|
||||
|
||||
fn on_path(name: &str) -> bool {
|
||||
std::env::var_os("PATH")
|
||||
.map(|p| std::env::split_paths(&p).any(|dir| dir.join(name).is_file()))
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Cheap installed-ness probe: stats a handful of paths, runs nothing.
|
||||
pub fn docker_installed(os: &str, docker_host: Option<&str>) -> bool {
|
||||
let home = dirs::home_dir();
|
||||
if install_markers(os, home.as_deref(), docker_host).iter().any(|p| p.exists()) {
|
||||
return true;
|
||||
}
|
||||
if os == "linux" {
|
||||
// Rootless Docker's socket lives in the user's runtime dir.
|
||||
if let Some(rt) = std::env::var_os("XDG_RUNTIME_DIR") {
|
||||
if Path::new(&rt).join("docker.sock").exists() {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
path_binaries(os).iter().any(|b| on_path(b))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::fmt;
|
||||
|
||||
#[test]
|
||||
fn ping_ok_is_running_regardless_of_probes() {
|
||||
assert_eq!(classify(PingOutcome::Ok, false), DockerState::Running);
|
||||
assert_eq!(classify(PingOutcome::Ok, true), DockerState::Running);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unreachable_and_installed_is_not_running() {
|
||||
// The reported case: dockerd present, systemd gave up restarting it.
|
||||
assert_eq!(classify(PingOutcome::Unreachable, true), DockerState::NotRunning);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unreachable_and_nothing_found_is_not_installed() {
|
||||
assert_eq!(classify(PingOutcome::Unreachable, false), DockerState::NotInstalled);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn permission_denied_is_no_permission_even_without_probes() {
|
||||
assert_eq!(classify(PingOutcome::PermissionDenied, false), DockerState::NoPermission);
|
||||
assert_eq!(classify(PingOutcome::PermissionDenied, true), DockerState::NoPermission);
|
||||
}
|
||||
|
||||
/// An error that wraps another, the way bollard → hyper → io do.
|
||||
#[derive(Debug)]
|
||||
struct Wrap(&'static str, Option<io::Error>);
|
||||
impl fmt::Display for Wrap {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
f.write_str(self.0)
|
||||
}
|
||||
}
|
||||
impl StdError for Wrap {
|
||||
fn source(&self) -> Option<&(dyn StdError + 'static)> {
|
||||
self.1.as_ref().map(|e| e as _)
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nested_io_permission_denied_is_found() {
|
||||
let e = Wrap("error trying to connect", Some(io::Error::from(io::ErrorKind::PermissionDenied)));
|
||||
assert_eq!(ping_outcome_from_error(&e), PingOutcome::PermissionDenied);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nested_connection_refused_and_not_found_are_unreachable() {
|
||||
let refused = Wrap("error trying to connect", Some(io::Error::from(io::ErrorKind::ConnectionRefused)));
|
||||
let missing = Wrap("error trying to connect", Some(io::Error::from(io::ErrorKind::NotFound)));
|
||||
assert_eq!(ping_outcome_from_error(&refused), PingOutcome::Unreachable);
|
||||
assert_eq!(ping_outcome_from_error(&missing), PingOutcome::Unreachable);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn permission_denied_only_in_text_is_found() {
|
||||
let e = Wrap("client error (Connect): Permission denied (os error 13)", None);
|
||||
assert_eq!(ping_outcome_from_error(&e), PingOutcome::PermissionDenied);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn endpoint_respects_docker_host() {
|
||||
assert_eq!(endpoint(Some("tcp://10.0.0.5:2375")), "tcp://10.0.0.5:2375");
|
||||
assert_eq!(endpoint(Some(" ")), endpoint(None));
|
||||
let default = endpoint(None);
|
||||
assert!(default.starts_with("unix://") || default.starts_with("npipe://"), "{default}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn install_markers_cover_each_os() {
|
||||
let home = Path::new("/home/u");
|
||||
let linux = install_markers("linux", Some(home), None);
|
||||
assert!(linux.contains(&PathBuf::from("/usr/bin/dockerd")));
|
||||
assert!(linux.contains(&PathBuf::from("/var/run/docker.sock")));
|
||||
assert!(linux.contains(&home.join(".docker/desktop")));
|
||||
|
||||
let mac = install_markers("macos", Some(home), None);
|
||||
assert!(mac.contains(&PathBuf::from("/Applications/Docker.app")));
|
||||
assert!(mac.contains(&home.join(".docker/run/docker.sock")));
|
||||
|
||||
let win = install_markers("windows", None, None);
|
||||
assert!(win.contains(&PathBuf::from(r"C:\Program Files\Docker\Docker\Docker Desktop.exe")));
|
||||
assert_eq!(path_binaries("windows"), &["docker.exe"]);
|
||||
assert!(path_binaries("linux").contains(&"dockerd"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unix_docker_host_socket_is_a_marker() {
|
||||
let m = install_markers("linux", None, Some("unix:///run/user/1000/docker.sock"));
|
||||
assert_eq!(m[0], PathBuf::from("/run/user/1000/docker.sock"));
|
||||
let tcp = install_markers("linux", None, Some("tcp://host:2375"));
|
||||
assert!(!tcp.iter().any(|p| p.to_string_lossy().contains("host")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn status_serializes_with_snake_case_state() {
|
||||
let s = DockerStatus {
|
||||
state: DockerState::NotRunning,
|
||||
endpoint: "unix:///var/run/docker.sock".into(),
|
||||
detail: Some("refused".into()),
|
||||
os: "linux",
|
||||
};
|
||||
let json = serde_json::to_value(&s).unwrap();
|
||||
assert_eq!(json["state"], "not_running");
|
||||
assert_eq!(json["os"], "linux");
|
||||
}
|
||||
}
|
||||
@@ -420,6 +420,20 @@ pub(crate) fn workspace_env(
|
||||
}
|
||||
|
||||
|
||||
/// The names of the custom variables [`workspace_env`] emits for `project`
|
||||
/// (global + per-project, trimmed, reserved names skipped): the ones
|
||||
/// copy-at-connect treats as credentials.
|
||||
pub(crate) fn custom_env_keys(project: &Project, global_custom_env_vars: &[EnvVar]) -> Vec<String> {
|
||||
let mut keys: Vec<String> = merge_custom_env_vars(global_custom_env_vars, &project.custom_env_vars)
|
||||
.iter()
|
||||
.map(|e| e.key.trim().to_string())
|
||||
.filter(|k| !k.is_empty() && !is_reserved_env_key(k))
|
||||
.collect();
|
||||
keys.sort();
|
||||
keys.dedup();
|
||||
keys
|
||||
}
|
||||
|
||||
/// [`workspace_env`] with its inputs resolved from `settings` exactly as
|
||||
/// `create_container` resolves them (the CA from disk, the shared Claude
|
||||
/// token from the keychain), for a host that does not create a Docker
|
||||
@@ -428,11 +442,25 @@ pub(crate) fn workspace_env_from_settings(
|
||||
project: &Project,
|
||||
settings: &crate::models::AppSettings,
|
||||
) -> Result<crate::host::aws_host::AwsEnv, String> {
|
||||
let shared_claude = super::container::shared_claude_auth(project);
|
||||
let effective_ca_path =
|
||||
resolve_with_global(project.ca_cert_path.as_deref(), settings.ca_cert_path.as_deref());
|
||||
let resolved_ca = ca_certs::resolve(effective_ca_path)?;
|
||||
let pairs = workspace_env(
|
||||
let pairs = workspace_env_with_ca(project, settings, resolved_ca.as_ref());
|
||||
Ok((pairs, resolved_ca))
|
||||
}
|
||||
|
||||
/// [`workspace_env`] resolved from `settings` like
|
||||
/// [`workspace_env_from_settings`] but with the CA given (`None`: no CA
|
||||
/// variables) — so nothing is read from disk. The keychain is (the shared
|
||||
/// Claude token). Copy-at-connect's terminal environment uses it: the
|
||||
/// credential pairs never depend on the CA.
|
||||
pub(crate) fn workspace_env_with_ca(
|
||||
project: &Project,
|
||||
settings: &crate::models::AppSettings,
|
||||
resolved_ca: Option<&ResolvedCa>,
|
||||
) -> Vec<(String, String)> {
|
||||
let shared_claude = super::container::shared_claude_auth(project);
|
||||
workspace_env(
|
||||
project,
|
||||
&WorkspaceEnvInputs {
|
||||
global_aws: &settings.global_aws,
|
||||
@@ -445,11 +473,10 @@ pub(crate) fn workspace_env_from_settings(
|
||||
global_claude_code_settings: settings.global_claude_code_settings.as_ref(),
|
||||
default_git_user_name: settings.default_git_user_name.as_deref(),
|
||||
default_git_user_email: settings.default_git_user_email.as_deref(),
|
||||
resolved_ca: resolved_ca.as_ref(),
|
||||
resolved_ca,
|
||||
shared_claude_token: shared_claude.as_ref().map(|(token, _)| token.as_str()),
|
||||
},
|
||||
);
|
||||
Ok((pairs, resolved_ca))
|
||||
)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,299 @@
|
||||
//! Copy-at-connect (phase 6, ruling Q2): an AWS project whose credentials
|
||||
//! are "copied when you connect" keeps them out of its Secrets Manager
|
||||
//! secret (`aws::workspace`, `PayloadExtras::connect_only`) and brings them
|
||||
//! in after every connect instead — a start, an attach, the background
|
||||
//! re-attach when the app starts.
|
||||
//!
|
||||
//! The credentials are [`ConnectBundle`]: the SSH and CA files (the same
|
||||
//! [`workspace_files`](super::workspace_files) the secret would carry) and
|
||||
//! the credential environment pairs (`SECRET_ENV_KEYS` and every custom
|
||||
//! variable, `aws::workspace::credential_pairs`). [`push_connect_bundle`]
|
||||
//! uploads them through the agent, as root, into this connect's own root-only
|
||||
//! staging dir on the task's `/dev/shm` tmpfs and runs `triple-c-apply-connect
|
||||
//! <nonce>` (container), which
|
||||
//! installs the CA, merges the SSH files, writes the git credential helper
|
||||
//! and re-clones what failed. The terminals the app opens get the pairs in
|
||||
//! their own `ExecSpec.env` ([`terminal_env`]); nothing puts them into the
|
||||
//! agent's environment, so other execs, cron jobs and the scheduler never
|
||||
//! see them. **Values are never logged**: errors carry names and the
|
||||
//! script's own (value-free) output only.
|
||||
|
||||
use std::time::Duration;
|
||||
|
||||
use zeroize::Zeroizing;
|
||||
|
||||
use super::super::{tunnels, ContainerTarget};
|
||||
use crate::aws::workspace::{credential_pairs, validate_file_key};
|
||||
use crate::models::project::SecretsDelivery;
|
||||
use crate::models::{AppSettings, Project};
|
||||
|
||||
/// The in-container half (container/triple-c-apply-connect).
|
||||
pub const APPLY_CONNECT: &str = "/usr/local/bin/triple-c-apply-connect";
|
||||
/// Staging (root 0700, on the tmpfs the entrypoint made for the agent
|
||||
/// token): each connect gets `<nonce>/` with `ssh/`, `ca/` and `connect.env`.
|
||||
pub const CONNECT_STAGE: &str = "/dev/shm/triple-c/connect";
|
||||
pub const CONNECT_ENV_FILE: &str = "connect.env";
|
||||
/// Every staged file is root 0600.
|
||||
const STAGED_MODE: u32 = 0o600;
|
||||
/// The whole push (a few uploads and two execs through the tunnel).
|
||||
pub const PUSH_TIMEOUT: Duration = Duration::from_secs(120);
|
||||
/// The most of the script's output a warning carries.
|
||||
const OUTPUT_TAIL_LINES: usize = 10;
|
||||
|
||||
/// A credential value, zeroed when dropped (the settings export's
|
||||
/// precedent). It narrows, not closes, the window: the values were read from
|
||||
/// the keychain into a `Project`, and the copies an `ExecSpec` or an upload
|
||||
/// body needs are plain buffers owned by those layers.
|
||||
pub type SecretBytes = Zeroizing<Vec<u8>>;
|
||||
pub type SecretString = Zeroizing<String>;
|
||||
|
||||
/// What copy-at-connect copies in.
|
||||
#[derive(Clone, Default)]
|
||||
pub struct ConnectBundle {
|
||||
/// `ssh/<file>` / `ca/<file>`, as in the secret's `TRIPLEC_FILES`.
|
||||
pub files: Vec<(String, SecretBytes)>,
|
||||
/// The credential environment pairs.
|
||||
pub env: Vec<(String, SecretString)>,
|
||||
}
|
||||
|
||||
/// Names only: a bundle holds keys and tokens.
|
||||
impl std::fmt::Debug for ConnectBundle {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("ConnectBundle")
|
||||
.field("files", &self.files.iter().map(|(k, _)| k.as_str()).collect::<Vec<_>>())
|
||||
.field("env", &self.env.iter().map(|(k, _)| k.as_str()).collect::<Vec<_>>())
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether `project` copies its credentials in at connect.
|
||||
pub fn copies_at_connect(project: &Project) -> bool {
|
||||
project.is_aws()
|
||||
&& project
|
||||
.aws
|
||||
.as_ref()
|
||||
.is_some_and(|a| a.secrets_delivery == SecretsDelivery::CopyAtConnect)
|
||||
}
|
||||
|
||||
/// The bundle for `project`, whose keychain secrets must already be loaded
|
||||
/// (`load_secrets_for_project`): the same sources the secret would use.
|
||||
pub fn connect_credentials(project: &Project, settings: &AppSettings) -> Result<ConnectBundle, String> {
|
||||
let (_, ca) = super::aws_env(project, settings)?;
|
||||
let ssh = project
|
||||
.ssh_key_path
|
||||
.as_deref()
|
||||
.or(settings.default_ssh_key_path.as_deref());
|
||||
let files = super::workspace_files(ssh, ca.as_ref())?
|
||||
.into_iter()
|
||||
.map(|(k, v)| (k, Zeroizing::new(v)))
|
||||
.collect();
|
||||
Ok(ConnectBundle { files, env: connect_env(project, settings) })
|
||||
}
|
||||
|
||||
/// Only the credential pairs of `project` (secrets loaded): no file is read,
|
||||
/// so a missing SSH or CA file never keeps the API keys from a terminal.
|
||||
pub fn connect_env(project: &Project, settings: &AppSettings) -> Vec<(String, SecretString)> {
|
||||
let pairs = crate::docker::workspace_env::workspace_env_with_ca(project, settings, None);
|
||||
let custom =
|
||||
crate::docker::workspace_env::custom_env_keys(project, &settings.global_custom_env_vars);
|
||||
// With the gateway sidecar, the task's own ANTHROPIC_AUTH_TOKEN (the
|
||||
// sidecar's master key, kept in the secret) is the right one; the
|
||||
// OpenAI-compatible key would override it with one the sidecar refuses.
|
||||
let sidecar = project.aws.as_ref().is_some_and(|a| a.gateway_sidecar);
|
||||
credential_pairs(&pairs, &custom)
|
||||
.into_iter()
|
||||
.filter(|(k, _)| !(sidecar && k == "ANTHROPIC_AUTH_TOKEN"))
|
||||
.map(|(k, v)| (k, Zeroizing::new(v)))
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// `project` as the store holds it, with its keychain secrets read in.
|
||||
fn with_secrets(project: &Project) -> Project {
|
||||
let mut p = project.clone();
|
||||
crate::commands::project_commands::load_secrets_for_project(&mut p);
|
||||
p
|
||||
}
|
||||
|
||||
/// `connect.env`: one `KEY=<base64 of the value>` line per pair, so a value
|
||||
/// with a newline or `=` reads back whole and nothing has to be quoted.
|
||||
pub fn connect_env_file(env: &[(String, SecretString)]) -> SecretBytes {
|
||||
use base64::Engine;
|
||||
let b64 = base64::engine::general_purpose::STANDARD;
|
||||
let mut out = Zeroizing::new(String::new());
|
||||
for (k, v) in env {
|
||||
out.push_str(k);
|
||||
out.push('=');
|
||||
b64.encode_string(v.as_bytes(), &mut out);
|
||||
out.push('\n');
|
||||
}
|
||||
Zeroizing::new(out.as_bytes().to_vec())
|
||||
}
|
||||
|
||||
/// `KEY=VALUE` strings for an `ExecSpec`.
|
||||
pub fn exec_env(env: &[(String, SecretString)]) -> Vec<String> {
|
||||
env.iter().map(|(k, v)| format!("{k}={}", v.as_str())).collect()
|
||||
}
|
||||
|
||||
/// What a push needs from the container: root execs and root uploads.
|
||||
pub trait ConnectTarget: Send + Sync {
|
||||
fn exec_root(
|
||||
&self,
|
||||
cmd: Vec<String>,
|
||||
) -> impl std::future::Future<Output = Result<(String, i64), String>> + Send;
|
||||
fn upload_root(
|
||||
&self,
|
||||
dir: &str,
|
||||
name: &str,
|
||||
data: &[u8],
|
||||
mode: u32,
|
||||
) -> impl std::future::Future<Output = Result<(), String>> + Send;
|
||||
}
|
||||
|
||||
impl ConnectTarget for ContainerTarget {
|
||||
async fn exec_root(&self, cmd: Vec<String>) -> Result<(String, i64), String> {
|
||||
self.exec_oneshot_as("root", cmd, Vec::new()).await
|
||||
}
|
||||
async fn upload_root(&self, dir: &str, name: &str, data: &[u8], mode: u32) -> Result<(), String> {
|
||||
self.upload_bytes_with_ids(dir, name, data, mode, (0, 0)).await.map(|_| ())
|
||||
}
|
||||
}
|
||||
|
||||
fn tail(output: &str) -> String {
|
||||
let lines: Vec<&str> = output.lines().filter(|l| !l.trim().is_empty()).collect();
|
||||
lines[lines.len().saturating_sub(OUTPUT_TAIL_LINES)..].join("\n")
|
||||
}
|
||||
|
||||
async fn run_apply<T: ConnectTarget>(t: &T, args: &[&str]) -> Result<String, String> {
|
||||
let mut cmd = vec![APPLY_CONNECT.to_string()];
|
||||
cmd.extend(args.iter().map(|a| a.to_string()));
|
||||
let (out, code) = t.exec_root(cmd).await?;
|
||||
match code {
|
||||
0 => Ok(out),
|
||||
// `exec` of a missing file: an image from before copy-at-connect.
|
||||
126 | 127 => Err(
|
||||
"This workspace's image has no triple-c-apply-connect (it predates copying \
|
||||
credentials at connect); use a newer image, or store the credentials in AWS"
|
||||
.into(),
|
||||
),
|
||||
_ => Err(format!("triple-c-apply-connect failed ({code}):\n{}", tail(&out))),
|
||||
}
|
||||
}
|
||||
|
||||
/// `--prepare`'s answer: this connect's nonce, 16 hex digits on the last line.
|
||||
pub(crate) fn parse_nonce(out: &str) -> Result<String, String> {
|
||||
let last = out.lines().rev().map(str::trim).find(|l| !l.is_empty()).unwrap_or_default();
|
||||
if last.len() == 16 && last.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b)) {
|
||||
Ok(last.to_string())
|
||||
} else {
|
||||
Err(format!("triple-c-apply-connect --prepare gave no connect id:\n{}", tail(out)))
|
||||
}
|
||||
}
|
||||
|
||||
/// Upload `bundle` and apply it (see the module docs): `--prepare` (which
|
||||
/// names this connect's own staging dir), the files and `connect.env` (root
|
||||
/// 0600) into that dir, then the apply of exactly that dir — so two
|
||||
/// connects at once (two machines) never mix their files.
|
||||
pub async fn push_connect_bundle<T: ConnectTarget>(t: &T, bundle: &ConnectBundle) -> Result<(), String> {
|
||||
let nonce = parse_nonce(&run_apply(t, &["--prepare"]).await?)?;
|
||||
let dir = format!("{CONNECT_STAGE}/{nonce}");
|
||||
for (key, data) in &bundle.files {
|
||||
validate_file_key(key)?;
|
||||
let (kind, name) = key.split_once('/').expect("validated");
|
||||
t.upload_root(&format!("{dir}/{kind}"), name, data, STAGED_MODE)
|
||||
.await
|
||||
.map_err(|e| format!("Could not copy {key} into the workspace: {e}"))?;
|
||||
}
|
||||
t.upload_root(&dir, CONNECT_ENV_FILE, &connect_env_file(&bundle.env), STAGED_MODE)
|
||||
.await
|
||||
.map_err(|e| format!("Could not copy the credential variables into the workspace: {e}"))?;
|
||||
let out = run_apply(t, &[&nonce]).await?;
|
||||
for line in out.lines().filter(|l| l.contains("warning")) {
|
||||
log::warn!("{line}");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Copy `project`'s credentials into its connected workspace. `Ok(false)`
|
||||
/// when there is nothing to do (not copy-at-connect, or no tunnel).
|
||||
pub async fn apply_connect(project: &Project, settings: &AppSettings) -> Result<bool, String> {
|
||||
if !copies_at_connect(project) {
|
||||
return Ok(false);
|
||||
}
|
||||
let Some(ep) = tunnels::get_endpoint(&project.id) else {
|
||||
return Ok(false);
|
||||
};
|
||||
let (p, s) = (project.clone(), settings.clone());
|
||||
let bundle = tokio::task::spawn_blocking(move || connect_credentials(&with_secrets(&p), &s))
|
||||
.await
|
||||
.map_err(|e| format!("Could not gather the credentials: {e}"))??;
|
||||
let target = ContainerTarget::Agent(ep);
|
||||
tokio::time::timeout(PUSH_TIMEOUT, push_connect_bundle(&target, &bundle))
|
||||
.await
|
||||
.map_err(|_| format!("Copying the credentials took more than {} s", PUSH_TIMEOUT.as_secs()))??;
|
||||
log::info!(
|
||||
"Project {}: credentials copied into the workspace ({} file(s), {} variable(s))",
|
||||
project.id,
|
||||
bundle.files.len(),
|
||||
bundle.env.len()
|
||||
);
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
/// After a connect: [`apply_connect`] in the background, `on_warning` on a
|
||||
/// failure while the workspace is still connected (a Stop meanwhile is not
|
||||
/// worth a warning). `false` (nothing spawned) unless the project copies at
|
||||
/// connect and is connected.
|
||||
pub fn spawn_connect_push(
|
||||
project: &Project,
|
||||
settings: &AppSettings,
|
||||
on_warning: impl FnOnce(String) + Send + 'static,
|
||||
) -> bool {
|
||||
if !copies_at_connect(project) || tunnels::get_endpoint(&project.id).is_none() {
|
||||
return false;
|
||||
}
|
||||
let (project, settings) = (project.clone(), settings.clone());
|
||||
tauri::async_runtime::spawn(async move {
|
||||
if let Err(e) = apply_connect(&project, &settings).await {
|
||||
log::warn!("Project {}: could not copy the credentials in: {e}", project.id);
|
||||
if tunnels::get_endpoint(&project.id).is_some() {
|
||||
on_warning(e);
|
||||
}
|
||||
}
|
||||
});
|
||||
true
|
||||
}
|
||||
|
||||
/// The environment a terminal the app opens adds to its exec: the
|
||||
/// credential pairs for a copy-at-connect project, nothing otherwise (they
|
||||
/// are already in the task's environment). Only the pairs ([`connect_env`]:
|
||||
/// no SSH or CA file is read); the keychain is read off the async runtime.
|
||||
pub async fn terminal_env(project: &Project, settings: &AppSettings) -> Vec<String> {
|
||||
if !copies_at_connect(project) {
|
||||
return Vec::new();
|
||||
}
|
||||
let (p, s) = (project.clone(), settings.clone());
|
||||
let gathered = tokio::task::spawn_blocking(move || connect_env(&with_secrets(&p), &s))
|
||||
.await
|
||||
.map_err(|e| format!("could not gather them: {e}"));
|
||||
terminal_env_with(project, || gathered)
|
||||
}
|
||||
|
||||
/// [`terminal_env`] over a given source of the pairs.
|
||||
pub fn terminal_env_with(
|
||||
project: &Project,
|
||||
credentials: impl FnOnce() -> Result<Vec<(String, SecretString)>, String>,
|
||||
) -> Vec<String> {
|
||||
if !copies_at_connect(project) {
|
||||
return Vec::new();
|
||||
}
|
||||
match credentials() {
|
||||
Ok(env) => exec_env(&env),
|
||||
Err(e) => {
|
||||
log::warn!(
|
||||
"Project {}: the terminal opens without the project's credentials: {e}",
|
||||
project.id
|
||||
);
|
||||
Vec::new()
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,455 @@
|
||||
//! An AWS workspace's clone and setup script, as the start follows them and
|
||||
//! Project Home shows them (phase 6, Q4).
|
||||
//!
|
||||
//! The entrypoint clones in the background and then runs the setup script;
|
||||
//! `triple-c-workspace-status` (container) prints both as one JSON line,
|
||||
//! mirrored by [`WorkspaceStatus`].
|
||||
//!
|
||||
//! **The start does not wait for them** (ruling R5, amending Q4): it ends
|
||||
//! after "Connecting…" as in phase 5 — project Running, project lock
|
||||
//! released, terminals and Stop usable. [`spawn_follow`] then follows in the
|
||||
//! background: a read through the agent every [`FOLLOW_INTERVAL`] as a
|
||||
//! **background** exec (never activity for idle stop), a log line only when
|
||||
//! it changes, until the clone is done and no setup runs, [`FOLLOW_LIMIT`]
|
||||
//! passes, the agent is gone (tunnel dropped, task died, image without the
|
||||
//! script) or its token is cancelled (`tunnels::cancel_follow` on Stop and
|
||||
//! Remove; any tunnel close; app exit). Its only output is the final warning
|
||||
//! ([`follow_warning`]); Project Home's Overview card polls the status itself
|
||||
//! while the project is Running, so progress shows there.
|
||||
|
||||
use std::future::Future;
|
||||
use std::time::Duration;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tokio_util::sync::CancellationToken;
|
||||
|
||||
use super::super::{tunnels, ContainerTarget};
|
||||
use crate::models::Project;
|
||||
|
||||
/// The in-container status reader (Task 4).
|
||||
pub const STATUS_SCRIPT: &str = "/usr/local/bin/triple-c-workspace-status";
|
||||
pub const FOLLOW_INTERVAL: Duration = Duration::from_secs(2);
|
||||
/// The setup script's own timeout is 30 minutes, after the clone.
|
||||
pub const FOLLOW_LIMIT: Duration = Duration::from_secs(35 * 60);
|
||||
/// One status read through the agent.
|
||||
const READ_TIMEOUT: Duration = Duration::from_secs(20);
|
||||
/// Reads failing in a row before the follow gives up (quietly).
|
||||
const MAX_READ_FAILURES: u32 = 5;
|
||||
/// The script prints at most ~20 KB (20 tail lines of ≤ 1000 characters).
|
||||
const STATUS_OUTPUT_LIMIT: usize = 256 * 1024;
|
||||
/// A setup log line shown as progress is cut to this many characters.
|
||||
const MAX_PROGRESS_LINE: usize = 200;
|
||||
/// Setup log lines a warning carries.
|
||||
const WARNING_TAIL_LINES: usize = 10;
|
||||
|
||||
pub const PROGRESS_CLONING: &str = "Cloning repos…";
|
||||
pub const PROGRESS_SETUP: &str = "Running setup script…";
|
||||
|
||||
// ──────────────────────────────────────────────────────────────── model
|
||||
|
||||
/// `triple-c-workspace-status`'s JSON. Unknown fields are ignored and
|
||||
/// missing ones default, so an older or newer image never breaks a read.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(default)]
|
||||
pub struct WorkspaceStatus {
|
||||
pub clone: CloneStatus,
|
||||
pub setup: SetupStatus,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(default)]
|
||||
pub struct CloneStatus {
|
||||
/// Every repo has been tried.
|
||||
pub done: bool,
|
||||
/// The repos tried so far, in order.
|
||||
pub repos: Vec<RepoProgress>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(default)]
|
||||
pub struct RepoProgress {
|
||||
pub folder: String,
|
||||
/// `cloning`, `cloned`, `failed` or `exists`.
|
||||
pub state: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(default)]
|
||||
pub struct SetupStatus {
|
||||
pub state: SetupState,
|
||||
/// The script's exit code: 0 when `ok`, the code when `failed` (if known).
|
||||
pub code: Option<i64>,
|
||||
/// The setup log's last lines.
|
||||
pub tail: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "lowercase")]
|
||||
pub enum SetupState {
|
||||
/// No setup script.
|
||||
#[default]
|
||||
None,
|
||||
Running,
|
||||
Ok,
|
||||
/// Also any state this app does not know.
|
||||
#[serde(other)]
|
||||
Failed,
|
||||
}
|
||||
|
||||
impl RepoProgress {
|
||||
fn finished(&self) -> bool {
|
||||
matches!(self.state.as_str(), "cloned" | "failed" | "exists")
|
||||
}
|
||||
}
|
||||
|
||||
impl WorkspaceStatus {
|
||||
/// Nothing more will change: the clone is done and no setup is running.
|
||||
pub fn settled(&self) -> bool {
|
||||
self.clone.done && self.setup.state != SetupState::Running
|
||||
}
|
||||
|
||||
pub fn failed_repos(&self) -> Vec<&str> {
|
||||
self.clone
|
||||
.repos
|
||||
.iter()
|
||||
.filter(|r| r.state == "failed")
|
||||
.map(|r| r.folder.as_str())
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The start's progress line for this state (`None` once settled).
|
||||
/// `total` is how many repos the project configures; the status only
|
||||
/// lists the ones started so far.
|
||||
pub fn progress_line(&self, total: usize) -> Option<String> {
|
||||
if !self.clone.done {
|
||||
let n = total.max(self.clone.repos.len());
|
||||
if n == 0 {
|
||||
return Some(PROGRESS_CLONING.into());
|
||||
}
|
||||
let finished = self.clone.repos.iter().filter(|r| r.finished()).count();
|
||||
return Some(format!("{PROGRESS_CLONING} ({}/{n})", (finished + 1).min(n)));
|
||||
}
|
||||
(self.setup.state == SetupState::Running).then(|| PROGRESS_SETUP.into())
|
||||
}
|
||||
|
||||
/// The setup log's last non-blank line, cleaned for a progress line.
|
||||
fn last_log_line(&self) -> Option<String> {
|
||||
self.setup
|
||||
.tail
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|l| clean_line(l))
|
||||
.find(|l| !l.is_empty())
|
||||
}
|
||||
|
||||
/// What went wrong, for the user; `None` when nothing did.
|
||||
pub fn problems(&self) -> Option<String> {
|
||||
let mut parts = Vec::new();
|
||||
let failed = self.failed_repos();
|
||||
if !failed.is_empty() {
|
||||
parts.push(format!(
|
||||
"Cloning failed for {}: {}. The workspace started without {}.",
|
||||
if failed.len() == 1 { "a repo" } else { "some repos" },
|
||||
failed.join(", "),
|
||||
if failed.len() == 1 { "it" } else { "them" },
|
||||
));
|
||||
}
|
||||
if self.setup.state == SetupState::Failed {
|
||||
let code = self.setup.code.map(|c| format!(" (exit {c})")).unwrap_or_default();
|
||||
let mut s = format!("The setup script failed{code}.");
|
||||
let tail: Vec<&String> = self.setup.tail.iter().rev().take(WARNING_TAIL_LINES).collect();
|
||||
if !tail.is_empty() {
|
||||
s.push_str("\nLast lines:\n");
|
||||
s.push_str(
|
||||
&tail.into_iter().rev().map(String::as_str).collect::<Vec<_>>().join("\n"),
|
||||
);
|
||||
}
|
||||
parts.push(s);
|
||||
}
|
||||
(!parts.is_empty()).then(|| parts.join("\n\n"))
|
||||
}
|
||||
}
|
||||
|
||||
/// One line of the setup log as a progress message: control characters
|
||||
/// dropped, trimmed, at most [`MAX_PROGRESS_LINE`] characters.
|
||||
fn clean_line(line: &str) -> String {
|
||||
let cleaned: String = line
|
||||
.chars()
|
||||
.map(|c| if c == '\t' { ' ' } else { c })
|
||||
.filter(|c| !c.is_control())
|
||||
.collect();
|
||||
let t = cleaned.trim();
|
||||
if t.chars().count() > MAX_PROGRESS_LINE {
|
||||
let mut s: String = t.chars().take(MAX_PROGRESS_LINE - 1).collect();
|
||||
s.push('…');
|
||||
s
|
||||
} else {
|
||||
t.to_string()
|
||||
}
|
||||
}
|
||||
|
||||
/// Parse the script's output: its last non-blank line is the JSON (anything
|
||||
/// before it — a stray warning — is ignored).
|
||||
pub fn parse_status(output: &str) -> Result<WorkspaceStatus, String> {
|
||||
let line = output
|
||||
.lines()
|
||||
.rev()
|
||||
.find(|l| !l.trim().is_empty())
|
||||
.ok_or("The workspace status was empty")?;
|
||||
serde_json::from_str(line.trim()).map_err(|e| format!("The workspace status could not be read: {e}"))
|
||||
}
|
||||
|
||||
// ───────────────────────────────────────────────────────────── reading
|
||||
|
||||
/// One read of the status.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum StatusRead {
|
||||
Status(WorkspaceStatus),
|
||||
/// No agent to ask (tunnel gone), or an image without the script.
|
||||
Gone,
|
||||
/// A read that failed; may be retried.
|
||||
Failed(String),
|
||||
}
|
||||
|
||||
pub trait StatusSource: Send + Sync {
|
||||
fn read(&self) -> impl Future<Output = StatusRead> + Send;
|
||||
}
|
||||
|
||||
/// The command that runs the script; exit 127 when the image predates it.
|
||||
fn status_command() -> Vec<String> {
|
||||
vec![
|
||||
"sh".into(),
|
||||
"-c".into(),
|
||||
format!("[ -x {STATUS_SCRIPT} ] || exit 127; exec {STATUS_SCRIPT}"),
|
||||
]
|
||||
}
|
||||
|
||||
/// Read the status through `target`, as a background exec.
|
||||
pub async fn read_status(target: &ContainerTarget) -> StatusRead {
|
||||
let res = tokio::time::timeout(
|
||||
READ_TIMEOUT,
|
||||
target.exec_oneshot_background("claude", status_command(), STATUS_OUTPUT_LIMIT),
|
||||
)
|
||||
.await;
|
||||
match res {
|
||||
Err(_) => StatusRead::Failed("The workspace status read timed out".into()),
|
||||
Ok(Err(e)) => StatusRead::Failed(e),
|
||||
Ok(Ok((out, 0))) => match parse_status(&out) {
|
||||
Ok(s) => StatusRead::Status(s),
|
||||
Err(e) => StatusRead::Failed(e),
|
||||
},
|
||||
Ok(Ok((_, 126 | 127))) => StatusRead::Gone,
|
||||
Ok(Ok((_, code))) => StatusRead::Failed(format!("The workspace status exited with {code}")),
|
||||
}
|
||||
}
|
||||
|
||||
/// The project's registered tunnel, looked up on every read: a stop or a
|
||||
/// dropped tunnel unregisters it, and the follow then ends.
|
||||
struct TunnelStatusSource<'a> {
|
||||
project_id: &'a str,
|
||||
}
|
||||
|
||||
impl StatusSource for TunnelStatusSource<'_> {
|
||||
async fn read(&self) -> StatusRead {
|
||||
match tunnels::get_endpoint(self.project_id) {
|
||||
Some(ep) => read_status(&ContainerTarget::Agent(ep)).await,
|
||||
None => StatusRead::Gone,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The status of an AWS project's workspace for Project Home: `None` for a
|
||||
/// local project, one with no tunnel, or an image without the script.
|
||||
pub async fn workspace_status(project: &Project) -> Result<Option<WorkspaceStatus>, String> {
|
||||
if !project.is_aws() {
|
||||
return Ok(None);
|
||||
}
|
||||
match (TunnelStatusSource { project_id: &project.id }).read().await {
|
||||
StatusRead::Status(s) => Ok(Some(s)),
|
||||
StatusRead::Gone => Ok(None),
|
||||
StatusRead::Failed(e) => Err(e),
|
||||
}
|
||||
}
|
||||
|
||||
// ──────────────────────────────────────────────────────────── following
|
||||
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct FollowTiming {
|
||||
pub interval: Duration,
|
||||
pub limit: Duration,
|
||||
}
|
||||
|
||||
impl Default for FollowTiming {
|
||||
fn default() -> Self {
|
||||
Self { interval: FOLLOW_INTERVAL, limit: FOLLOW_LIMIT }
|
||||
}
|
||||
}
|
||||
|
||||
/// How a follow ended.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum FollowEnd {
|
||||
Settled {
|
||||
status: WorkspaceStatus,
|
||||
/// The very first read was already settled: nothing happened in
|
||||
/// this follow (an attach to a workspace that finished long ago).
|
||||
first_read: bool,
|
||||
},
|
||||
/// [`FollowTiming::limit`] passed; the last status read, if any.
|
||||
TimedOut(Option<WorkspaceStatus>),
|
||||
/// The agent went away, kept failing, or the follow was cancelled:
|
||||
/// nothing to say.
|
||||
Lost,
|
||||
}
|
||||
|
||||
/// Follow `src` until it settles, the limit passes, it is lost or `cancel`
|
||||
/// fires, calling `progress` with each new progress line and each new setup
|
||||
/// log line.
|
||||
pub async fn follow_workspace_status<S: StatusSource>(
|
||||
src: &S,
|
||||
total_repos: usize,
|
||||
timing: FollowTiming,
|
||||
cancel: &CancellationToken,
|
||||
progress: &(dyn Fn(&str) + Send + Sync),
|
||||
) -> FollowEnd {
|
||||
tokio::select! {
|
||||
biased;
|
||||
_ = cancel.cancelled() => FollowEnd::Lost,
|
||||
end = follow_inner(src, total_repos, timing, progress) => end,
|
||||
}
|
||||
}
|
||||
|
||||
async fn follow_inner<S: StatusSource>(
|
||||
src: &S,
|
||||
total_repos: usize,
|
||||
timing: FollowTiming,
|
||||
progress: &(dyn Fn(&str) + Send + Sync),
|
||||
) -> FollowEnd {
|
||||
let deadline = tokio::time::Instant::now() + timing.limit;
|
||||
let mut last_line: Option<String> = None;
|
||||
let mut last_log: Option<String> = None;
|
||||
let mut last_status: Option<WorkspaceStatus> = None;
|
||||
let mut failures = 0u32;
|
||||
let mut reads = 0u32;
|
||||
loop {
|
||||
match src.read().await {
|
||||
StatusRead::Status(s) => {
|
||||
failures = 0;
|
||||
reads += 1;
|
||||
if s.settled() {
|
||||
return FollowEnd::Settled { status: s, first_read: reads == 1 };
|
||||
}
|
||||
if let Some(line) = s.progress_line(total_repos) {
|
||||
if last_line.as_deref() != Some(line.as_str()) {
|
||||
progress(&line);
|
||||
last_line = Some(line);
|
||||
}
|
||||
}
|
||||
if s.setup.state == SetupState::Running {
|
||||
if let Some(log) = s.last_log_line() {
|
||||
if last_log.as_deref() != Some(log.as_str()) {
|
||||
progress(&log);
|
||||
last_log = Some(log);
|
||||
}
|
||||
}
|
||||
}
|
||||
last_status = Some(s);
|
||||
}
|
||||
StatusRead::Gone => return FollowEnd::Lost,
|
||||
StatusRead::Failed(e) => {
|
||||
failures += 1;
|
||||
log::debug!("Workspace status read failed ({failures}): {e}");
|
||||
if failures >= MAX_READ_FAILURES {
|
||||
log::info!("Stopped following the workspace's start: {e}");
|
||||
return FollowEnd::Lost;
|
||||
}
|
||||
}
|
||||
}
|
||||
if tokio::time::Instant::now() + timing.interval > deadline {
|
||||
return FollowEnd::TimedOut(last_status);
|
||||
}
|
||||
tokio::time::sleep(timing.interval).await;
|
||||
}
|
||||
}
|
||||
|
||||
/// What the user is told after a follow; `None` when all went well, the
|
||||
/// follow was lost, or the workspace had settled before this start —
|
||||
/// a failure is reported only when this follow saw it happen, or the
|
||||
/// task is one this start ran (`created`). Project Home still shows an old
|
||||
/// failure on demand.
|
||||
pub fn follow_warning(end: &FollowEnd, limit: Duration, created: bool) -> Option<String> {
|
||||
match end {
|
||||
FollowEnd::Settled { status, first_read } => {
|
||||
if *first_read && !created {
|
||||
None
|
||||
} else {
|
||||
status.problems()
|
||||
}
|
||||
}
|
||||
FollowEnd::TimedOut(s) => {
|
||||
let what = match s {
|
||||
Some(s) if !s.clone.done => "still cloning its repos",
|
||||
_ => "still running its setup script",
|
||||
};
|
||||
let mut msg = format!(
|
||||
"The workspace is {what} after {} minutes. It is running; Project Home shows the \
|
||||
progress.",
|
||||
limit.as_secs() / 60
|
||||
);
|
||||
if let Some(p) = s.as_ref().and_then(WorkspaceStatus::problems) {
|
||||
msg.push_str("\n\n");
|
||||
msg.push_str(&p);
|
||||
}
|
||||
Some(msg)
|
||||
}
|
||||
FollowEnd::Lost => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// The follow of one project's workspace. `follower` is its registration
|
||||
/// with the tunnel registry (`tunnels::begin_follow`), made by the caller
|
||||
/// before the follow is spawned so registrations keep the order of the starts
|
||||
/// (a quick Stop→Start can't leave the old follower registered last).
|
||||
/// `on_warning` gets the warning, if any.
|
||||
pub async fn run_follow<S: StatusSource>(
|
||||
src: &S,
|
||||
project_id: &str,
|
||||
follower: (u64, CancellationToken),
|
||||
total_repos: usize,
|
||||
created: bool,
|
||||
timing: FollowTiming,
|
||||
on_warning: impl FnOnce(String),
|
||||
) {
|
||||
let (id, cancel) = follower;
|
||||
let log_line = |m: &str| log::debug!("Project {project_id}: {m}");
|
||||
let end = follow_workspace_status(src, total_repos, timing, &cancel, &log_line).await;
|
||||
tunnels::end_follow(project_id, id);
|
||||
if let Some(w) = follow_warning(&end, timing.limit, created) {
|
||||
on_warning(w);
|
||||
}
|
||||
}
|
||||
|
||||
/// After a successful start of an AWS project: follow its clone and setup
|
||||
/// script in the background (see the module docs). `false` (nothing
|
||||
/// spawned) for a local project or one with no tunnel.
|
||||
pub fn spawn_follow(
|
||||
project: &Project,
|
||||
on_warning: impl FnOnce(String) + Send + 'static,
|
||||
) -> bool {
|
||||
if !project.is_aws() || tunnels::get_endpoint(&project.id).is_none() {
|
||||
return false;
|
||||
}
|
||||
let project_id = project.id.clone();
|
||||
let total = project.aws.as_ref().map_or(0, |a| a.repos.len());
|
||||
let created = tunnels::ran_task(&project_id);
|
||||
// Registered now, not in the spawned task: see `run_follow`.
|
||||
let follower = tunnels::begin_follow(&project_id);
|
||||
tauri::async_runtime::spawn(async move {
|
||||
let src = TunnelStatusSource { project_id: &project_id };
|
||||
run_follow(&src, &project_id, follower, total, created, FollowTiming::default(), on_warning)
|
||||
.await;
|
||||
});
|
||||
true
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
@@ -0,0 +1,285 @@
|
||||
use std::sync::Mutex;
|
||||
|
||||
use super::*;
|
||||
use crate::host::tunnels;
|
||||
|
||||
/// Returns its scripted reads in order, then repeats the last one.
|
||||
struct Scripted {
|
||||
reads: Mutex<Vec<StatusRead>>,
|
||||
count: Mutex<usize>,
|
||||
}
|
||||
|
||||
impl Scripted {
|
||||
fn new(reads: Vec<StatusRead>) -> Self {
|
||||
Self { reads: Mutex::new(reads), count: Mutex::new(0) }
|
||||
}
|
||||
fn count(&self) -> usize {
|
||||
*self.count.lock().unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
impl StatusSource for Scripted {
|
||||
async fn read(&self) -> StatusRead {
|
||||
*self.count.lock().unwrap() += 1;
|
||||
let mut r = self.reads.lock().unwrap();
|
||||
if r.len() > 1 {
|
||||
r.remove(0)
|
||||
} else {
|
||||
r[0].clone()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn st(json: &str) -> StatusRead {
|
||||
StatusRead::Status(parse_status(json).unwrap())
|
||||
}
|
||||
|
||||
async fn follow(src: &Scripted, total: usize) -> (FollowEnd, Vec<String>) {
|
||||
let lines = Mutex::new(Vec::new());
|
||||
let progress = |m: &str| lines.lock().unwrap().push(m.to_string());
|
||||
let cancel = CancellationToken::new();
|
||||
let end = follow_workspace_status(src, total, FollowTiming::default(), &cancel, &progress).await;
|
||||
(end, lines.into_inner().unwrap())
|
||||
}
|
||||
|
||||
const NOT_STARTED: &str = r#"{"clone":{"done":false,"repos":[]},"setup":{"state":"running","code":null,"tail":[]}}"#;
|
||||
const CLONING_1: &str = r#"{"clone":{"done":false,"repos":[{"folder":"a","state":"cloning"}]},"setup":{"state":"running","code":null,"tail":[]}}"#;
|
||||
const CLONING_2: &str = r#"{"clone":{"done":false,"repos":[{"folder":"a","state":"cloned"},{"folder":"b","state":"cloning"}]},"setup":{"state":"running","code":null,"tail":[]}}"#;
|
||||
const SETUP_1: &str = r#"{"clone":{"done":true,"repos":[{"folder":"a","state":"cloned"},{"folder":"b","state":"failed"}]},"setup":{"state":"running","code":null,"tail":["Reading package lists...",""," Setting up jq "]}}"#;
|
||||
const SETUP_2: &str = r#"{"clone":{"done":true,"repos":[{"folder":"a","state":"cloned"},{"folder":"b","state":"failed"}]},"setup":{"state":"running","code":null,"tail":["Setting up jq","done"]}}"#;
|
||||
const SETUP_FAILED: &str = r#"{"clone":{"done":true,"repos":[{"folder":"a","state":"cloned"},{"folder":"b","state":"failed"}]},"setup":{"state":"failed","code":2,"tail":["Setting up jq","E: oops"]}}"#;
|
||||
const ALL_OK: &str = r#"{"clone":{"done":true,"repos":[{"folder":"a","state":"cloned"}]},"setup":{"state":"none","code":null,"tail":[]}}"#;
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn follow_emits_each_change_once_and_stops_when_settled() {
|
||||
let src = Scripted::new(vec![
|
||||
st(NOT_STARTED),
|
||||
st(CLONING_1),
|
||||
st(CLONING_1),
|
||||
st(CLONING_2),
|
||||
st(SETUP_1),
|
||||
st(SETUP_1),
|
||||
st(SETUP_2),
|
||||
st(SETUP_FAILED),
|
||||
]);
|
||||
let started = tokio::time::Instant::now();
|
||||
let (end, lines) = follow(&src, 2).await;
|
||||
assert_eq!(
|
||||
lines,
|
||||
[
|
||||
"Cloning repos… (1/2)",
|
||||
"Cloning repos… (2/2)",
|
||||
"Running setup script…",
|
||||
"Setting up jq",
|
||||
"done",
|
||||
]
|
||||
);
|
||||
assert_eq!(src.count(), 8);
|
||||
// Seven waits of 2 s between eight reads.
|
||||
assert_eq!(started.elapsed(), FOLLOW_INTERVAL * 7);
|
||||
let FollowEnd::Settled { status: s, first_read: false } = &end else { panic!("{end:?}") };
|
||||
// Seen failing in this follow: reported even on an attach.
|
||||
let w = follow_warning(&end, FOLLOW_LIMIT, false).unwrap();
|
||||
assert!(w.contains("Cloning failed for a repo: b."), "{w}");
|
||||
assert!(w.contains("The setup script failed (exit 2)."), "{w}");
|
||||
assert!(w.ends_with("Last lines:\nSetting up jq\nE: oops"), "{w}");
|
||||
assert_eq!(s.failed_repos(), ["b"]);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_workspace_already_settled_ends_at_once_without_a_warning() {
|
||||
let src = Scripted::new(vec![st(ALL_OK)]);
|
||||
let started = tokio::time::Instant::now();
|
||||
let (end, lines) = follow(&src, 1).await;
|
||||
assert!(lines.is_empty());
|
||||
assert_eq!(started.elapsed(), std::time::Duration::ZERO);
|
||||
assert_eq!(follow_warning(&end, FOLLOW_LIMIT, true), None);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn an_old_failure_warns_only_for_a_task_this_start_ran() {
|
||||
let src = Scripted::new(vec![st(SETUP_FAILED)]);
|
||||
let (end, lines) = follow(&src, 2).await;
|
||||
assert!(lines.is_empty());
|
||||
assert!(matches!(end, FollowEnd::Settled { first_read: true, .. }), "{end:?}");
|
||||
// Attached to a workspace that failed long ago: no toast.
|
||||
assert_eq!(follow_warning(&end, FOLLOW_LIMIT, false), None);
|
||||
// This start ran the task and it failed before the first read.
|
||||
let w = follow_warning(&end, FOLLOW_LIMIT, true).unwrap();
|
||||
assert!(w.contains("The setup script failed (exit 2)."), "{w}");
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn follow_times_out_after_35_minutes() {
|
||||
let src = Scripted::new(vec![st(CLONING_1)]);
|
||||
let started = tokio::time::Instant::now();
|
||||
let (end, lines) = follow(&src, 3).await;
|
||||
assert_eq!(lines, ["Cloning repos… (1/3)"]);
|
||||
assert!(matches!(end, FollowEnd::TimedOut(Some(_))), "{end:?}");
|
||||
assert!(started.elapsed() <= FOLLOW_LIMIT);
|
||||
assert!(started.elapsed() > FOLLOW_LIMIT - FOLLOW_INTERVAL * 2);
|
||||
let w = follow_warning(&end, FOLLOW_LIMIT, false).unwrap();
|
||||
assert!(w.contains("still cloning its repos after 35 minutes"), "{w}");
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_timed_out_setup_says_so_and_carries_any_clone_failure() {
|
||||
let src = Scripted::new(vec![st(SETUP_2)]);
|
||||
let (end, _) = follow(&src, 2).await;
|
||||
let w = follow_warning(&end, FOLLOW_LIMIT, false).unwrap();
|
||||
assert!(w.contains("still running its setup script"), "{w}");
|
||||
assert!(w.contains("Cloning failed for a repo: b."), "{w}");
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_lost_agent_ends_the_follow_quietly() {
|
||||
let src = Scripted::new(vec![st(CLONING_1), StatusRead::Gone]);
|
||||
let (end, lines) = follow(&src, 1).await;
|
||||
assert_eq!(end, FollowEnd::Lost);
|
||||
assert_eq!(lines, ["Cloning repos… (1/1)"]);
|
||||
assert_eq!(follow_warning(&end, FOLLOW_LIMIT, false), None);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn failing_reads_are_retried_then_give_up_quietly() {
|
||||
let fail = || StatusRead::Failed("tunnel hiccup".into());
|
||||
// Four failures, then a good read: the count resets.
|
||||
let src = Scripted::new(vec![fail(), fail(), fail(), fail(), st(ALL_OK)]);
|
||||
assert!(matches!(follow(&src, 1).await.0, FollowEnd::Settled { .. }));
|
||||
let src = Scripted::new(vec![fail()]);
|
||||
let (end, _) = follow(&src, 1).await;
|
||||
assert_eq!(end, FollowEnd::Lost);
|
||||
assert_eq!(src.count(), MAX_READ_FAILURES as usize);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn status_parses_the_scripts_output_and_tolerates_drift() {
|
||||
let s = parse_status(&format!("a stray warning\n{SETUP_FAILED}\n\n")).unwrap();
|
||||
assert_eq!(s.setup.state, SetupState::Failed);
|
||||
assert_eq!(s.setup.code, Some(2));
|
||||
assert!(s.clone.done);
|
||||
// Unknown fields and states, missing fields.
|
||||
let s = parse_status(r#"{"clone":{"done":true,"extra":1},"setup":{"state":"paused"},"new":{}}"#)
|
||||
.unwrap();
|
||||
assert!(s.clone.repos.is_empty());
|
||||
assert_eq!(s.setup.state, SetupState::Failed);
|
||||
assert_eq!(parse_status("{}").unwrap(), WorkspaceStatus::default());
|
||||
assert!(parse_status("").is_err());
|
||||
assert!(parse_status("not json").is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn progress_lines_count_repos_and_clean_log_lines() {
|
||||
let s = parse_status(NOT_STARTED).unwrap();
|
||||
assert_eq!(s.progress_line(0).as_deref(), Some("Cloning repos…"));
|
||||
assert_eq!(s.progress_line(3).as_deref(), Some("Cloning repos… (1/3)"));
|
||||
let s = parse_status(ALL_OK).unwrap();
|
||||
assert!(s.settled());
|
||||
assert_eq!(s.progress_line(1), None);
|
||||
let mut s = parse_status(SETUP_2).unwrap();
|
||||
s.setup.tail = vec![format!("\x1b[31m{}\x1b[0m", "x".repeat(500))];
|
||||
let l = s.last_log_line().unwrap();
|
||||
assert_eq!(l.chars().count(), MAX_PROGRESS_LINE);
|
||||
assert!(l.starts_with("[31mxxx") && l.ends_with('…'), "{l}");
|
||||
assert!(!l.contains('\x1b'));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn status_serialises_in_the_scripts_shape() {
|
||||
let s = parse_status(SETUP_FAILED).unwrap();
|
||||
let v = serde_json::to_value(&s).unwrap();
|
||||
assert_eq!(v, serde_json::from_str::<serde_json::Value>(SETUP_FAILED).unwrap());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_status_command_reports_a_missing_script_as_127() {
|
||||
let cmd = status_command();
|
||||
assert_eq!(cmd[..2], ["sh", "-c"]);
|
||||
assert!(cmd[2].contains("|| exit 127") && cmd[2].contains(STATUS_SCRIPT));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_local_project_has_no_workspace_status_and_no_follower() {
|
||||
let p = Project::new("p".into(), vec![]);
|
||||
assert_eq!(workspace_status(&p).await, Ok(None));
|
||||
assert!(!spawn_follow(&p, |_| panic!("no warning for Docker")));
|
||||
assert!(!tunnels::is_following(&p.id));
|
||||
}
|
||||
|
||||
/// Never answers: a follow in progress until something ends it.
|
||||
struct Hang;
|
||||
impl StatusSource for Hang {
|
||||
async fn read(&self) -> StatusRead {
|
||||
std::future::pending().await
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn stop_ends_a_follow_in_progress_without_a_warning() {
|
||||
let id = "follow-stop-test";
|
||||
let task = tokio::spawn(async move {
|
||||
let warned = std::sync::Arc::new(Mutex::new(false));
|
||||
let w = warned.clone();
|
||||
let follower = tunnels::begin_follow(id);
|
||||
run_follow(&Hang, id, follower, 1, true, FollowTiming::default(), move |_| {
|
||||
*w.lock().unwrap() = true
|
||||
})
|
||||
.await;
|
||||
let v = *warned.lock().unwrap();
|
||||
v
|
||||
});
|
||||
tokio::time::sleep(FOLLOW_INTERVAL * 3).await;
|
||||
assert!(tunnels::is_following(id));
|
||||
// What Stop and Remove call (`stop_project_container`, `stop_project`,
|
||||
// `remove_resources`); closing the tunnel does the same.
|
||||
tunnels::cancel_follow(id);
|
||||
let warned = tokio::time::timeout(std::time::Duration::from_secs(1), task)
|
||||
.await
|
||||
.expect("the follow ends at once")
|
||||
.unwrap();
|
||||
assert!(!warned);
|
||||
assert!(!tunnels::is_following(id));
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn a_new_follow_replaces_the_old_one() {
|
||||
let id = "follow-replace-test";
|
||||
let follower = tunnels::begin_follow(id);
|
||||
let first = tokio::spawn(run_follow(&Hang, id, follower, 1, true, FollowTiming::default(), |_| {}));
|
||||
tokio::time::sleep(FOLLOW_INTERVAL).await;
|
||||
let (_, second) = tunnels::begin_follow(id);
|
||||
tokio::time::timeout(std::time::Duration::from_secs(1), first).await.unwrap().unwrap();
|
||||
// The old follower's end does not unregister the new one.
|
||||
assert!(tunnels::is_following(id));
|
||||
assert!(!second.is_cancelled());
|
||||
tunnels::cancel_follow(id);
|
||||
assert!(second.is_cancelled());
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn followers_registered_in_start_order_win_in_that_order_however_they_are_scheduled() {
|
||||
// A quick Stop→Start: the old start's follower is registered first, the
|
||||
// new one second, but the new one's task happens to run first.
|
||||
let id = "follow-order-test";
|
||||
let old = tunnels::begin_follow(id);
|
||||
let new = tunnels::begin_follow(id);
|
||||
let new_token = new.1.clone();
|
||||
let new_task = tokio::spawn(run_follow(&Hang, id, new, 1, true, FollowTiming::default(), |_| {}));
|
||||
tokio::time::sleep(FOLLOW_INTERVAL).await;
|
||||
let old_task = tokio::spawn(run_follow(&Hang, id, old, 1, true, FollowTiming::default(), |_| {}));
|
||||
// The old one was cancelled at registration: it ends at once and leaves
|
||||
// the new one registered and running.
|
||||
tokio::time::timeout(std::time::Duration::from_secs(1), old_task).await.unwrap().unwrap();
|
||||
assert!(tunnels::is_following(id));
|
||||
assert!(!new_token.is_cancelled());
|
||||
assert!(!new_task.is_finished());
|
||||
tunnels::cancel_follow(id);
|
||||
tokio::time::timeout(std::time::Duration::from_secs(1), new_task).await.unwrap().unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_follower_takes_no_project_lock() {
|
||||
// Stop must never wait for it (ruling R5).
|
||||
let src = include_str!("../status.rs");
|
||||
assert!(!src.contains("project_lock"));
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -132,7 +132,7 @@ impl ProjectHost {
|
||||
|
||||
/// AWS: stop the task and remove the project's resources — task
|
||||
/// definition revisions, the secret (deleted at once) and, only
|
||||
/// with `discard_data`, the EFS access point (not its files). Docker: nothing (its state
|
||||
/// with `discard_data`, the EFS access points, home and EFS-mode `/workspace` (not their files). Docker: nothing (its state
|
||||
/// goes with [`Self::discard_project_state`]).
|
||||
pub async fn remove_aws_resources(
|
||||
&self,
|
||||
|
||||
@@ -30,6 +30,8 @@
|
||||
pub mod agent;
|
||||
pub mod aws_host;
|
||||
pub mod lifecycle;
|
||||
pub mod persistent;
|
||||
pub mod port_forwards;
|
||||
pub mod sessions;
|
||||
pub mod ssm;
|
||||
pub mod tunnels;
|
||||
|
||||
@@ -0,0 +1,509 @@
|
||||
//! Persistent terminals on AWS workspaces: every terminal tab (Claude and
|
||||
//! bash) runs inside its own tmux server in the workspace, so it outlives the
|
||||
//! app closing or the SSM tunnel dropping, and the app attaches to it again on
|
||||
//! its next connect. Docker projects never come here.
|
||||
//!
|
||||
//! The rules, and why:
|
||||
//!
|
||||
//! * **One tmux server per tab**, `tmux -L triple-c-<session id>`. A server
|
||||
//! takes its environment from the client that started it, so each tab's
|
||||
//! server has exactly that tab's exec environment — the copy-at-connect
|
||||
//! credential pairs (`aws_host::terminal_env`) travel in `ExecSpec.env` as
|
||||
//! before and never on argv (`new-session -e` would put them in `ps`).
|
||||
//! * **The tab's session id is the key.** The frontend's UUID, persisted per
|
||||
//! project by `storage::terminal_store`, so a tab reopened after an app
|
||||
//! restart gets the same id (its rename, `renamed_session_names`, too).
|
||||
//! * **Opening** a tab is `new-session -A` (attach when it already exists);
|
||||
//! **reattaching** is `attach-session`, which never creates: a session that
|
||||
//! ended while the app was away must not come back as a fresh `claude`.
|
||||
//! * **Closing a tab ends the session** (`kill-server`), as today. App exit, a
|
||||
//! dropped tunnel and the agent's SIGHUP on a client that went away only
|
||||
//! **detach** — the server daemonised into its own session, so the hangup
|
||||
//! reaches the client alone.
|
||||
//! * The tmux config is `/etc/triple-c/tmux.conf` (`container/triple-c-tmux.conf`):
|
||||
//! no prefix key, no status line, output in xterm.js's own scrollback.
|
||||
//! * An image without tmux or that config runs terminals the old way, with a
|
||||
//! one-time notice per tunnel ([`plan`]).
|
||||
//!
|
||||
//! Everything in here runs through [`ContainerTarget`].
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::sync::Mutex;
|
||||
use std::time::Duration;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use super::ContainerTarget;
|
||||
|
||||
/// The tmux config baked into the image (outside the seed-only home).
|
||||
pub const TMUX_CONF: &str = "/etc/triple-c/tmux.conf";
|
||||
/// Socket name prefix (`-L`): `/tmp/tmux-<uid>/triple-c-<key>`.
|
||||
pub const SOCKET_PREFIX: &str = "triple-c-";
|
||||
/// The outer terminal the tmux client talks to: xterm.js. The agent would
|
||||
/// otherwise default a tty exec to `TERM=xterm`, and tmux would then
|
||||
/// downsample every colour to 8.
|
||||
pub const OUTER_TERM: &str = "TERM=xterm-256color";
|
||||
/// tmux user option holding the tab's label, for a session another machine
|
||||
/// opened (the app's own sessions keep theirs in the store).
|
||||
pub const NAME_OPTION: &str = "@triple_c_name";
|
||||
/// How much pane history a re-opened tab gets replayed.
|
||||
pub const HISTORY_LINES: u32 = 5000;
|
||||
/// Byte cap on that replay (escape sequences included).
|
||||
pub const HISTORY_LIMIT: usize = 4 * 1024 * 1024;
|
||||
/// Every small tmux exec (probe, list, has-session, kill).
|
||||
pub const SMALL_EXEC_TIMEOUT: Duration = Duration::from_secs(20);
|
||||
/// The notice an image without tmux gets, once per tunnel.
|
||||
pub const NO_TMUX_NOTICE: &str = "This workspace image has no tmux, so terminals end when the app \
|
||||
closes. Use an image built after persistent terminals were added (e.g. \
|
||||
ghcr.io/shadowdao/triple-c-sandbox:edge).";
|
||||
/// The longest tab label kept in tmux.
|
||||
const MAX_NAME_CHARS: usize = 80;
|
||||
|
||||
/// What a terminal runs. Also the tmux session name (`-s`), so a session the
|
||||
/// app does not know still says what it is.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum TerminalKind {
|
||||
Claude,
|
||||
Bash,
|
||||
}
|
||||
|
||||
impl TerminalKind {
|
||||
pub fn as_str(self) -> &'static str {
|
||||
match self {
|
||||
TerminalKind::Claude => "claude",
|
||||
TerminalKind::Bash => "bash",
|
||||
}
|
||||
}
|
||||
pub fn parse(s: &str) -> Option<Self> {
|
||||
match s {
|
||||
"claude" => Some(TerminalKind::Claude),
|
||||
"bash" => Some(TerminalKind::Bash),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A session key is a socket name and an argv element: UUID characters only.
|
||||
pub fn validate_key(key: &str) -> Result<(), String> {
|
||||
if key.is_empty()
|
||||
|| key.len() > 64
|
||||
|| !key.chars().all(|c| c.is_ascii_alphanumeric() || c == '-')
|
||||
{
|
||||
return Err("Invalid terminal session id".to_string());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn socket_name(key: &str) -> String {
|
||||
format!("{SOCKET_PREFIX}{key}")
|
||||
}
|
||||
|
||||
/// A tab label as tmux keeps it: no control characters (the listing is one
|
||||
/// tab-separated line per session), at most [`MAX_NAME_CHARS`], and no
|
||||
/// trailing `;` or `\` — tmux splits its argv into commands at an argument
|
||||
/// that *ends* in `;`.
|
||||
pub fn clean_name(name: Option<&str>) -> Option<String> {
|
||||
let cleaned: String = name?
|
||||
.chars()
|
||||
.filter(|c| !c.is_control())
|
||||
.take(MAX_NAME_CHARS)
|
||||
.collect();
|
||||
let cleaned = cleaned.trim().trim_end_matches([';', '\\']).trim().to_string();
|
||||
(!cleaned.is_empty()).then_some(cleaned)
|
||||
}
|
||||
|
||||
fn tmux_base(key: &str) -> Vec<String> {
|
||||
vec![
|
||||
"tmux".into(),
|
||||
"-L".into(),
|
||||
socket_name(key),
|
||||
"-f".into(),
|
||||
TMUX_CONF.into(),
|
||||
]
|
||||
}
|
||||
|
||||
/// The attached exec of a tab: `inner` (the unchanged command — the Claude
|
||||
/// launch with its update prelude, or `bash -l`) as the only window of a new
|
||||
/// tmux server, or an attach to it if it is already there. The label goes in
|
||||
/// [`NAME_OPTION`] as a second tmux command. No environment value is ever an
|
||||
/// argument here.
|
||||
pub fn new_session_cmd(
|
||||
key: &str,
|
||||
kind: TerminalKind,
|
||||
name: Option<&str>,
|
||||
inner: Vec<String>,
|
||||
) -> Result<Vec<String>, String> {
|
||||
validate_key(key)?;
|
||||
if inner.is_empty() {
|
||||
return Err("No command to run".into());
|
||||
}
|
||||
// tmux would read an argument ending in `;` as the end of a command and
|
||||
// run the rest as tmux commands. Our scripts end in a newline; refuse
|
||||
// rather than guess if that ever changes.
|
||||
if inner.iter().any(|a| a.ends_with(';')) {
|
||||
return Err("A terminal command argument may not end with ';'".into());
|
||||
}
|
||||
let mut cmd = tmux_base(key);
|
||||
cmd.extend([
|
||||
"new-session".into(),
|
||||
"-A".into(),
|
||||
"-s".into(),
|
||||
kind.as_str().into(),
|
||||
"--".into(),
|
||||
]);
|
||||
cmd.extend(inner);
|
||||
if let Some(n) = clean_name(name) {
|
||||
cmd.extend([";".into(), "set-option".into(), "-q".into(), NAME_OPTION.into(), n]);
|
||||
}
|
||||
Ok(cmd)
|
||||
}
|
||||
|
||||
/// Attach to an existing session; fails (and creates nothing) when it is gone.
|
||||
pub fn attach_cmd(key: &str) -> Result<Vec<String>, String> {
|
||||
validate_key(key)?;
|
||||
let mut cmd = tmux_base(key);
|
||||
cmd.push("attach-session".into());
|
||||
Ok(cmd)
|
||||
}
|
||||
|
||||
/// End one session: its server and everything in it (SIGHUP to the panes).
|
||||
pub fn kill_cmd(key: &str) -> Result<Vec<String>, String> {
|
||||
validate_key(key)?;
|
||||
Ok(vec!["tmux".into(), "-L".into(), socket_name(key), "kill-server".into()])
|
||||
}
|
||||
|
||||
/// The pane's history above the screen, colours kept, wrapped lines joined
|
||||
/// (xterm.js rewraps them at its own width).
|
||||
pub fn history_cmd(key: &str) -> Result<Vec<String>, String> {
|
||||
validate_key(key)?;
|
||||
Ok(vec![
|
||||
"tmux".into(),
|
||||
"-L".into(),
|
||||
socket_name(key),
|
||||
"capture-pane".into(),
|
||||
"-p".into(),
|
||||
"-e".into(),
|
||||
"-J".into(),
|
||||
"-S".into(),
|
||||
format!("-{HISTORY_LINES}"),
|
||||
"-E".into(),
|
||||
"-1".into(),
|
||||
])
|
||||
}
|
||||
|
||||
/// Exit 0 when the image can keep terminals: tmux and our config.
|
||||
pub fn probe_cmd() -> Vec<String> {
|
||||
vec![
|
||||
"sh".into(),
|
||||
"-c".into(),
|
||||
format!("command -v tmux >/dev/null 2>&1 && [ -r {TMUX_CONF} ]"),
|
||||
]
|
||||
}
|
||||
|
||||
/// The tmux socket directory of the exec's user, as tmux computes it.
|
||||
const SOCKET_DIR: &str = r#"d="${TMUX_TMPDIR:-/tmp}/tmux-$(id -u)""#;
|
||||
|
||||
/// One line per running session: `key \t kind \t created \t attached \t name`.
|
||||
/// A socket whose server is gone (tmux leaves the file) answers nothing and
|
||||
/// is skipped.
|
||||
pub fn list_cmd() -> Vec<String> {
|
||||
vec![
|
||||
"sh".into(),
|
||||
"-c".into(),
|
||||
format!(
|
||||
r#"{SOCKET_DIR}
|
||||
command -v tmux >/dev/null 2>&1 || exit 0
|
||||
for s in "$d"/{SOCKET_PREFIX}*; do
|
||||
[ -S "$s" ] || continue
|
||||
n=${{s##*/}}
|
||||
line=$(tmux -L "$n" display-message -p '#{{session_name}} #{{session_created}} #{{session_attached}} #{{{NAME_OPTION}}}' 2>/dev/null) || continue
|
||||
printf '%s\t%s\n' "${{n#{SOCKET_PREFIX}}}" "$line"
|
||||
done
|
||||
exit 0"#
|
||||
),
|
||||
]
|
||||
}
|
||||
|
||||
/// End every session (Stop, before the WIP push's snapshot), then wait —
|
||||
/// bounded, 5 s — until the panes' processes (taken before the kill) and
|
||||
/// the servers are gone, so a pane's last writes land before the snapshot.
|
||||
/// The same script is `entrypoint.sh`'s `aws_end_terminals` and the idle
|
||||
/// watcher's (a test pins them together).
|
||||
pub fn end_all_cmd() -> Vec<String> {
|
||||
vec!["sh".into(), "-c".into(), END_ALL_SCRIPT.into()]
|
||||
}
|
||||
|
||||
/// See [`end_all_cmd`].
|
||||
pub const END_ALL_SCRIPT: &str = r#"d="${TMUX_TMPDIR:-/tmp}/tmux-$(id -u)"
|
||||
command -v tmux >/dev/null 2>&1 || exit 0
|
||||
pids=""
|
||||
for s in "$d"/triple-c-*; do
|
||||
[ -S "$s" ] || continue
|
||||
pids="$pids $(tmux -L "${s##*/}" list-panes -a -F '#{pane_pid}' 2>/dev/null)"
|
||||
tmux -L "${s##*/}" kill-server 2>/dev/null
|
||||
done
|
||||
i=0
|
||||
while [ $i -lt 50 ]; do
|
||||
alive=""
|
||||
for p in $pids; do kill -0 "$p" 2>/dev/null && alive=1; done
|
||||
pgrep -u "$(id -u)" -f '^tmux -L triple-c-' >/dev/null 2>&1 && alive=1
|
||||
[ -n "$alive" ] || break
|
||||
sleep 0.1; i=$((i + 1))
|
||||
done
|
||||
exit 0"#;
|
||||
|
||||
/// A session found running in the workspace.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct RunningSession {
|
||||
pub key: String,
|
||||
pub kind: TerminalKind,
|
||||
pub created_unix: u64,
|
||||
pub attached: bool,
|
||||
pub name: Option<String>,
|
||||
}
|
||||
|
||||
/// [`list_cmd`]'s output; lines that do not parse (a session someone made by
|
||||
/// hand under our prefix) are skipped.
|
||||
pub fn parse_list(out: &str) -> Vec<RunningSession> {
|
||||
out.lines()
|
||||
.filter_map(|line| {
|
||||
let mut f = line.splitn(5, '\t');
|
||||
let key = f.next()?.to_string();
|
||||
validate_key(&key).ok()?;
|
||||
let kind = TerminalKind::parse(f.next()?)?;
|
||||
let created_unix = f.next()?.trim().parse().ok()?;
|
||||
let attached = f.next()?.trim().parse::<u32>().ok()? > 0;
|
||||
let name = clean_name(f.next());
|
||||
Some(RunningSession { key, kind, created_unix, attached, name })
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The exec environment of a tmux client: the caller's pairs (copy-at-connect
|
||||
/// credentials, which the server it starts inherits) plus [`OUTER_TERM`].
|
||||
/// `TMUX`/`TMUX_TMPDIR` are dropped (and reserved as custom variable
|
||||
/// names): either would point the client at another socket than the one the
|
||||
/// app lists and ends.
|
||||
pub fn client_env(mut env: Vec<String>) -> Vec<String> {
|
||||
env.retain(|e| {
|
||||
!e.starts_with("TERM=") && !e.starts_with("TMUX=") && !e.starts_with("TMUX_TMPDIR=")
|
||||
});
|
||||
env.push(OUTER_TERM.to_string());
|
||||
env
|
||||
}
|
||||
|
||||
// ───────────────────────────────────────────────────────────── probe cache
|
||||
|
||||
/// Per target id (an endpoint URL, new for every tunnel): does the image
|
||||
/// keep terminals, and was the "no tmux" notice given yet.
|
||||
#[derive(Debug, Clone, Copy, Default)]
|
||||
struct Probe {
|
||||
supported: bool,
|
||||
noticed: bool,
|
||||
}
|
||||
|
||||
fn probes() -> &'static Mutex<HashMap<String, Probe>> {
|
||||
static P: std::sync::OnceLock<Mutex<HashMap<String, Probe>>> = std::sync::OnceLock::new();
|
||||
P.get_or_init(Default::default)
|
||||
}
|
||||
|
||||
/// Forget what was probed through `target_id` — a new tunnel registered on
|
||||
/// it (`tunnels::register`), which may reach another task's image.
|
||||
pub fn forget_probe(target_id: &str) {
|
||||
probes().lock().unwrap_or_else(|e| e.into_inner()).remove(target_id);
|
||||
}
|
||||
|
||||
/// Whether `target`'s image has tmux and the config; asked once per tunnel.
|
||||
/// `None` when the probe could not run (asked again next time).
|
||||
pub async fn probe(target: &ContainerTarget) -> Option<bool> {
|
||||
if let Some(p) = probes().lock().unwrap_or_else(|e| e.into_inner()).get(target.id()) {
|
||||
return Some(p.supported);
|
||||
}
|
||||
let res = tokio::time::timeout(
|
||||
SMALL_EXEC_TIMEOUT,
|
||||
target.exec_oneshot_background("claude", probe_cmd(), 4096),
|
||||
)
|
||||
.await;
|
||||
let supported = match res {
|
||||
Ok(Ok((_, code))) => code == 0,
|
||||
Ok(Err(e)) => {
|
||||
log::warn!("Could not ask the workspace whether it has tmux: {e}");
|
||||
return None;
|
||||
}
|
||||
Err(_) => {
|
||||
log::warn!("Asking the workspace whether it has tmux timed out");
|
||||
return None;
|
||||
}
|
||||
};
|
||||
probes()
|
||||
.lock()
|
||||
.unwrap_or_else(|e| e.into_inner())
|
||||
.entry(target.id().to_string())
|
||||
.or_insert(Probe { supported, noticed: false });
|
||||
Some(supported)
|
||||
}
|
||||
|
||||
/// [`probe`] for callers that must not guess: an unanswered probe is an
|
||||
/// error (the caller retries), never "no tmux" — reading it as no would
|
||||
/// prune remembered sessions and end tabs whose Claude still runs.
|
||||
pub async fn supported(target: &ContainerTarget) -> Result<bool, String> {
|
||||
probe(target)
|
||||
.await
|
||||
.ok_or_else(|| "The workspace did not answer whether it can keep terminals".to_string())
|
||||
}
|
||||
|
||||
/// The "no tmux" notice, the first time it is asked for on a tunnel whose
|
||||
/// probe said no (never for a probe that could not run).
|
||||
fn take_notice(target_id: &str) -> Option<String> {
|
||||
let mut p = probes().lock().unwrap_or_else(|e| e.into_inner());
|
||||
let entry = p.get_mut(target_id)?;
|
||||
if entry.supported || entry.noticed {
|
||||
return None;
|
||||
}
|
||||
entry.noticed = true;
|
||||
Some(NO_TMUX_NOTICE.to_string())
|
||||
}
|
||||
|
||||
// ───────────────────────────────────────────────────────────────── launch
|
||||
|
||||
/// How a terminal is launched.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct LaunchPlan {
|
||||
pub cmd: Vec<String>,
|
||||
pub env: Vec<String>,
|
||||
/// Runs in tmux and outlives the app.
|
||||
pub persistent: bool,
|
||||
/// Say this once (no tmux in the image).
|
||||
pub notice: Option<String>,
|
||||
}
|
||||
|
||||
/// The pure decision: a persistent launch for an AWS project whose image
|
||||
/// keeps terminals, the old launch otherwise.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn plan_with(
|
||||
is_aws: bool,
|
||||
supported: bool,
|
||||
notice: Option<String>,
|
||||
key: &str,
|
||||
kind: TerminalKind,
|
||||
name: Option<&str>,
|
||||
inner: Vec<String>,
|
||||
env: Vec<String>,
|
||||
) -> Result<LaunchPlan, String> {
|
||||
if !is_aws {
|
||||
return Ok(LaunchPlan { cmd: inner, env, persistent: false, notice: None });
|
||||
}
|
||||
if !supported {
|
||||
return Ok(LaunchPlan { cmd: inner, env, persistent: false, notice });
|
||||
}
|
||||
Ok(LaunchPlan {
|
||||
cmd: new_session_cmd(key, kind, name, inner)?,
|
||||
env: client_env(env),
|
||||
persistent: true,
|
||||
notice: None,
|
||||
})
|
||||
}
|
||||
|
||||
/// [`plan_with`] for a real target: probes (cached per tunnel) on AWS only.
|
||||
pub async fn plan(
|
||||
is_aws: bool,
|
||||
target: &ContainerTarget,
|
||||
key: &str,
|
||||
kind: TerminalKind,
|
||||
name: Option<&str>,
|
||||
inner: Vec<String>,
|
||||
env: Vec<String>,
|
||||
) -> Result<LaunchPlan, String> {
|
||||
if !is_aws {
|
||||
return plan_with(false, false, None, key, kind, name, inner, env);
|
||||
}
|
||||
validate_key(key)?;
|
||||
let ok = supported(target).await?;
|
||||
let notice = if ok { None } else { take_notice(target.id()) };
|
||||
plan_with(true, ok, notice, key, kind, name, inner, env)
|
||||
}
|
||||
|
||||
// ─────────────────────────────────────────────────────── workspace actions
|
||||
|
||||
async fn small(target: &ContainerTarget, cmd: Vec<String>) -> Result<(String, i64), String> {
|
||||
tokio::time::timeout(SMALL_EXEC_TIMEOUT, target.exec_oneshot_background("claude", cmd, 256 * 1024))
|
||||
.await
|
||||
.map_err(|_| "The workspace did not answer in time".to_string())?
|
||||
}
|
||||
|
||||
/// The sessions running in the workspace (none on an image without tmux).
|
||||
/// An `Err` (including an unanswered probe) says nothing about what runs.
|
||||
pub async fn list(target: &ContainerTarget) -> Result<Vec<RunningSession>, String> {
|
||||
if !supported(target).await? {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let (out, code) = small(target, list_cmd()).await?;
|
||||
if code != 0 {
|
||||
return Err(format!("Listing the workspace's terminals failed (exit {code})"));
|
||||
}
|
||||
Ok(parse_list(&out))
|
||||
}
|
||||
|
||||
/// End the session `key` (closing its tab). Gone already is success.
|
||||
pub async fn end(target: &ContainerTarget, key: &str) -> Result<(), String> {
|
||||
small(target, kill_cmd(key)?).await.map(|_| ())
|
||||
}
|
||||
|
||||
/// End every session in the workspace, bounded; logged, never an error (a
|
||||
/// Stop must go on).
|
||||
pub async fn end_all(target: &ContainerTarget) {
|
||||
let res = tokio::time::timeout(
|
||||
SMALL_EXEC_TIMEOUT,
|
||||
target.exec_oneshot_as("claude", end_all_cmd(), Vec::new()),
|
||||
)
|
||||
.await;
|
||||
match res {
|
||||
Ok(Ok(_)) => {}
|
||||
Ok(Err(e)) => log::warn!("Could not end the workspace's terminals: {e}"),
|
||||
Err(_) => log::warn!("Ending the workspace's terminals timed out"),
|
||||
}
|
||||
}
|
||||
|
||||
/// The pane history of `key`, for a freshly opened tab; `None` when it can't
|
||||
/// be read (the attach still goes ahead).
|
||||
pub async fn history(target: &ContainerTarget, key: &str) -> Option<String> {
|
||||
let cmd = history_cmd(key).ok()?;
|
||||
let res = tokio::time::timeout(
|
||||
SMALL_EXEC_TIMEOUT,
|
||||
target.exec_oneshot_background("claude", cmd, HISTORY_LIMIT),
|
||||
)
|
||||
.await;
|
||||
match res {
|
||||
Ok(Ok((out, 0))) => Some(out),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// What a fresh xterm is fed before the attach: the history, one line per
|
||||
/// row, then `rows` newlines so all of it scrolls into xterm.js's scrollback
|
||||
/// before tmux clears and draws the screen (an erase does not push lines
|
||||
/// into xterm.js's scrollback).
|
||||
pub fn replay_bytes(history: &str, rows: u16) -> Vec<u8> {
|
||||
let body = history.trim_end_matches('\n');
|
||||
if body.is_empty() {
|
||||
return Vec::new();
|
||||
}
|
||||
let mut out = String::with_capacity(body.len() + rows as usize * 2 + 16);
|
||||
for line in body.split('\n') {
|
||||
out.push_str(line);
|
||||
// A captured line ends with its own SGR state; reset so colour
|
||||
// never bleeds into the padding.
|
||||
out.push_str("\x1b[0m\r\n");
|
||||
}
|
||||
for _ in 0..rows {
|
||||
out.push_str("\r\n");
|
||||
}
|
||||
out.into_bytes()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
#[cfg(test)]
|
||||
mod live_tests;
|
||||
@@ -0,0 +1,157 @@
|
||||
//! Persistent terminals end to end, through the real agent in a real
|
||||
//! container: a tab's tmux server survives its client going away (the
|
||||
//! agent's SIGHUP), is listed, keeps its own environment (and nothing secret
|
||||
//! on argv), replays its history, reattaches, and ends.
|
||||
//!
|
||||
//! Needs a Docker daemon and an image whose entrypoint starts the agent and
|
||||
//! that has tmux and `/etc/triple-c/tmux.conf`: `TRIPLEC_PERSIST_E2E_IMAGE`,
|
||||
//! default `tc-tmux-e2e:latest` (e.g. the sandbox `:edge` image plus
|
||||
//! `apt-get install tmux` and `COPY triple-c-tmux.conf /etc/triple-c/tmux.conf`).
|
||||
//!
|
||||
//! `cargo test host::persistent::live_tests -- --ignored`
|
||||
|
||||
use super::*;
|
||||
use crate::host::{AgentEndpoint, ContainerTarget, ExecSpec};
|
||||
use futures_util::StreamExt;
|
||||
use std::process::Command;
|
||||
use std::time::Duration;
|
||||
use tokio::io::AsyncWriteExt;
|
||||
|
||||
fn docker_cli(args: &[&str]) -> String {
|
||||
let out = Command::new("docker").args(args).output().expect("docker cli");
|
||||
assert!(out.status.success(), "docker {:?}: {}", args, String::from_utf8_lossy(&out.stderr));
|
||||
String::from_utf8_lossy(&out.stdout).trim().to_string()
|
||||
}
|
||||
|
||||
/// Read an attached exec's output until `needle` shows up (or time runs out).
|
||||
async fn read_until(out: &mut crate::host::ExecOutputStream, needle: &str, secs: u64) -> String {
|
||||
let mut seen = String::new();
|
||||
let deadline = tokio::time::Instant::now() + Duration::from_secs(secs);
|
||||
while !seen.contains(needle) {
|
||||
match tokio::time::timeout_at(deadline, out.next()).await {
|
||||
Ok(Some(Ok(c))) => seen.push_str(&String::from_utf8_lossy(&c.into_bytes())),
|
||||
_ => break,
|
||||
}
|
||||
}
|
||||
seen
|
||||
}
|
||||
|
||||
async fn start_agent_container(image: &str) -> (String, ContainerTarget) {
|
||||
let token = format!("{}{}", uuid::Uuid::new_v4().simple(), uuid::Uuid::new_v4().simple());
|
||||
let name = format!("tc-persist-e2e-{}", uuid::Uuid::new_v4().simple());
|
||||
docker_cli(&[
|
||||
"run", "-d", "--init", "--name", &name, "-w", "/workspace",
|
||||
"-e", &format!("TRIPLEC_AGENT_TOKEN={token}"),
|
||||
"-e", "TRIPLEC_AGENT_ADDR=0.0.0.0:47900",
|
||||
"-p", "127.0.0.1::47900",
|
||||
image,
|
||||
]);
|
||||
let mapped = docker_cli(&["port", &name, "47900/tcp"]);
|
||||
let port: u16 = mapped.lines().next().and_then(|l| l.rsplit(':').next()).and_then(|p| p.parse().ok()).unwrap();
|
||||
let ip = docker_cli(&["inspect", "-f", "{{range .NetworkSettings.Networks}}{{.IPAddress}} {{end}}", &name]);
|
||||
let mut candidates = vec![AgentEndpoint::loopback(port, token.clone())];
|
||||
for addr in ip.split_whitespace() {
|
||||
let url = url::Url::parse(&format!("http://{addr}:47900/")).unwrap();
|
||||
candidates.push(AgentEndpoint::new(url, token.clone()).unwrap());
|
||||
}
|
||||
for _ in 0..240 {
|
||||
for ep in &candidates {
|
||||
let t = ContainerTarget::Agent(ep.clone());
|
||||
if t.is_running().await.unwrap_or(false) {
|
||||
return (name, t);
|
||||
}
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(500)).await;
|
||||
}
|
||||
let logs = docker_cli(&["logs", "--tail", "40", &name]);
|
||||
let _ = Command::new("docker").args(["rm", "-f", &name]).output();
|
||||
panic!("agent never answered; logs:\n{logs}");
|
||||
}
|
||||
|
||||
async fn scenario(t: &ContainerTarget) -> Result<(), String> {
|
||||
let check = |ok: bool, what: &str| if ok { Ok(()) } else { Err(what.to_string()) };
|
||||
check(probe(t).await == Some(true), "the image has tmux and the config")?;
|
||||
|
||||
let k1 = uuid::Uuid::new_v4().to_string();
|
||||
let k2 = uuid::Uuid::new_v4().to_string();
|
||||
let inner = |marker: &str| {
|
||||
vec![
|
||||
"bash".to_string(),
|
||||
"-c".to_string(),
|
||||
format!("printf 'secret=%s\\n' \"$TC_SECRET\"; for i in $(seq 1 300); do echo hist$i; done; echo {marker}; exec bash --norc\n"),
|
||||
]
|
||||
};
|
||||
let p1 = plan_with(true, true, None, &k1, TerminalKind::Bash, Some("first"), inner("READY1"), vec!["TC_SECRET=alpha-not-real".into()])?;
|
||||
let p2 = plan_with(true, true, None, &k2, TerminalKind::Claude, None, inner("READY2"), vec!["TC_SECRET=beta-not-real".into()])?;
|
||||
|
||||
// Open both tabs.
|
||||
let mut a1 = t.attach(ExecSpec::new(p1.cmd.clone()).tty(true).env(p1.env.clone())).await?;
|
||||
let seen = read_until(&mut a1.output, "READY1", 20).await;
|
||||
check(seen.contains("secret=alpha-not-real"), &format!("tab 1 has its own env: {seen:?}"))?;
|
||||
let mut a2 = t.attach(ExecSpec::new(p2.cmd.clone()).tty(true).env(p2.env.clone())).await?;
|
||||
let seen = read_until(&mut a2.output, "READY2", 20).await;
|
||||
check(seen.contains("secret=beta-not-real"), &format!("tab 2 has its own env: {seen:?}"))?;
|
||||
|
||||
// No secret on any command line in the workspace.
|
||||
let (ps, _) = t.exec_oneshot_as("claude", vec!["ps".into(), "-eo".into(), "args".into()], vec![]).await?;
|
||||
check(!ps.contains("alpha-not-real") && !ps.contains("beta-not-real"), &format!("secret on argv: {ps}"))?;
|
||||
|
||||
// The app goes away: drop the client. The agent SIGHUPs its process group.
|
||||
drop(a1);
|
||||
tokio::time::sleep(Duration::from_secs(2)).await;
|
||||
let listed = list(t).await?;
|
||||
let s1 = listed.iter().find(|s| s.key == k1).ok_or(format!("tab 1 survived its client: {listed:?}"))?;
|
||||
check(!s1.attached && s1.kind == TerminalKind::Bash && s1.name.as_deref() == Some("first"), &format!("{s1:?}"))?;
|
||||
let s2 = listed.iter().find(|s| s.key == k2).ok_or("tab 2 listed")?;
|
||||
check(s2.attached && s2.kind == TerminalKind::Claude, &format!("{s2:?}"))?;
|
||||
|
||||
// History for a fresh tab, then reattach (never creating).
|
||||
let h = history(t, &k1).await.ok_or("history readable")?;
|
||||
check(h.contains("hist1\n") && h.contains("hist250"), &format!("history: {} bytes", h.len()))?;
|
||||
let mut r1 = t.attach(ExecSpec::new(attach_cmd(&k1)?).tty(true).env(client_env(vec![]))).await?;
|
||||
r1.input.write_all(b"echo back-$((40+2))\r").await.map_err(|e| e.to_string())?;
|
||||
let seen = read_until(&mut r1.output, "back-42", 20).await;
|
||||
check(seen.contains("back-42"), &format!("reattached and typing works: {seen:?}"))?;
|
||||
// Still the original server's environment.
|
||||
r1.input.write_all(b"echo env-$TC_SECRET\r").await.map_err(|e| e.to_string())?;
|
||||
let seen = read_until(&mut r1.output, "env-alpha-not-real", 20).await;
|
||||
check(seen.contains("env-alpha-not-real"), "the server kept its env")?;
|
||||
|
||||
// Attaching to a key that is gone fails and creates nothing.
|
||||
let ghost = uuid::Uuid::new_v4().to_string();
|
||||
let mut g = t.attach(ExecSpec::new(attach_cmd(&ghost)?).tty(true).env(client_env(vec![]))).await?;
|
||||
let _ = read_until(&mut g.output, "\u{0}", 5).await;
|
||||
check(!list(t).await?.iter().any(|s| s.key == ghost), "attach-session created nothing")?;
|
||||
|
||||
// A `claude` inside tmux is what the idle watcher sees; tmux is not.
|
||||
r1.input.write_all(b"cp /bin/sleep /tmp/claude && /tmp/claude 30 &\r").await.map_err(|e| e.to_string())?;
|
||||
tokio::time::sleep(Duration::from_secs(1)).await;
|
||||
let (pg, code) = t.exec_oneshot_as("claude", vec!["pgrep".into(), "-x".into(), "claude".into()], vec![]).await?;
|
||||
check(code == 0 && !pg.trim().is_empty(), "pgrep -x claude sees it")?;
|
||||
let (_, code) = t.exec_oneshot_as("claude", vec!["pgrep".into(), "-x".into(), "tmux".into()], vec![]).await?;
|
||||
check(code != 0, "no process is named plain `tmux` (servers are `tmux: server`)")?;
|
||||
|
||||
// Closing a tab ends it; Stop ends the rest.
|
||||
end(t, &k1).await?;
|
||||
let _ = read_until(&mut r1.output, "\u{0}", 5).await;
|
||||
check(!list(t).await?.iter().any(|s| s.key == k1), "tab 1 ended")?;
|
||||
end_all(t).await;
|
||||
check(list(t).await?.is_empty(), "every terminal ended")?;
|
||||
let (pg, _) = t.exec_oneshot_as("claude", vec!["sh".into(), "-c".into(), "pgrep -f '^tmux -L triple-c-' || true".into()], vec![]).await?;
|
||||
check(pg.trim().is_empty(), &format!("no tmux left: {pg}"))?;
|
||||
drop(a2);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[ignore = "needs a Docker daemon and an agent image with tmux (TRIPLEC_PERSIST_E2E_IMAGE)"]
|
||||
async fn a_terminal_outlives_its_client_and_reattaches_through_the_agent() {
|
||||
let image = std::env::var("TRIPLEC_PERSIST_E2E_IMAGE").unwrap_or_else(|_| "tc-tmux-e2e:latest".into());
|
||||
let (name, target) = start_agent_container(&image).await;
|
||||
let outcome = scenario(&target).await;
|
||||
let logs = docker_cli(&["logs", "--tail", "20", &name]);
|
||||
let _ = Command::new("docker").args(["rm", "-f", &name]).output();
|
||||
if let Err(e) = outcome {
|
||||
panic!("{e}\n--- container log tail ---\n{logs}");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,186 @@
|
||||
use super::*;
|
||||
|
||||
const KEY: &str = "0b9c6f7e-1d2a-4c3b-9e8f-7a6b5c4d3e2f";
|
||||
|
||||
fn claude_inner() -> Vec<String> {
|
||||
vec!["bash".into(), "-c".into(), "flock … claude update\nexec claude '-n' 'x'\n".into()]
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_new_tab_runs_its_unchanged_command_as_the_only_window_of_its_own_server() {
|
||||
let cmd = new_session_cmd(KEY, TerminalKind::Claude, Some("main"), claude_inner()).unwrap();
|
||||
assert_eq!(
|
||||
&cmd[..10],
|
||||
&[
|
||||
"tmux", "-L", &format!("triple-c-{KEY}"), "-f", "/etc/triple-c/tmux.conf",
|
||||
"new-session", "-A", "-s", "claude", "--",
|
||||
]
|
||||
.map(String::from)
|
||||
);
|
||||
// The inner command is passed through as argv, untouched.
|
||||
assert_eq!(&cmd[10..13], claude_inner().as_slice());
|
||||
assert_eq!(&cmd[13..], &[";", "set-option", "-q", "@triple_c_name", "main"].map(String::from));
|
||||
// Bash tabs say so in the session name; no label, no second command.
|
||||
let bash = new_session_cmd(KEY, TerminalKind::Bash, None, vec!["bash".into(), "-l".into()]).unwrap();
|
||||
assert_eq!(bash[8], "bash");
|
||||
assert_eq!(bash.last().unwrap(), "-l");
|
||||
assert!(!bash.contains(&";".to_string()));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn keys_are_socket_safe_and_an_argument_ending_in_a_semicolon_is_refused() {
|
||||
for bad in ["", "../x", "a b", "a;b", "x/y", &"a".repeat(65)] {
|
||||
assert!(validate_key(bad).is_err(), "{bad:?}");
|
||||
assert!(new_session_cmd(bad, TerminalKind::Bash, None, vec!["bash".into()]).is_err());
|
||||
assert!(attach_cmd(bad).is_err() && kill_cmd(bad).is_err() && history_cmd(bad).is_err());
|
||||
}
|
||||
assert!(validate_key(KEY).is_ok());
|
||||
// tmux would run what follows as tmux commands.
|
||||
let e = new_session_cmd(KEY, TerminalKind::Bash, None, vec!["sh".into(), "-c".into(), "x;".into()]);
|
||||
assert!(e.is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_label_is_cleaned_so_it_cannot_split_the_tmux_command_or_the_listing() {
|
||||
assert_eq!(clean_name(Some("Bob's tab")).as_deref(), Some("Bob's tab"));
|
||||
assert_eq!(clean_name(Some("a\tb\nc")).as_deref(), Some("abc"));
|
||||
assert_eq!(clean_name(Some("x;")).as_deref(), Some("x"));
|
||||
assert_eq!(clean_name(Some(r"x \;; ")).as_deref(), Some("x"));
|
||||
assert_eq!(clean_name(Some(" ;; ")), None);
|
||||
assert_eq!(clean_name(None), None);
|
||||
assert_eq!(clean_name(Some(&"é".repeat(200))).unwrap().chars().count(), 80);
|
||||
let cmd = new_session_cmd(KEY, TerminalKind::Claude, Some("evil;"), claude_inner()).unwrap();
|
||||
assert_eq!(cmd.last().unwrap(), "evil");
|
||||
assert!(cmd.iter().filter(|a| a.ends_with(';')).count() == 1, "only our separator: {cmd:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn secrets_travel_in_the_exec_environment_never_on_argv() {
|
||||
let env = vec!["ANTHROPIC_API_KEY=sk-test-not-real".to_string(), "TERM=xterm".to_string()];
|
||||
let plan = plan_with(true, true, None, KEY, TerminalKind::Claude, None, claude_inner(), env).unwrap();
|
||||
assert!(plan.persistent);
|
||||
assert!(plan.cmd.iter().all(|a| !a.contains("sk-test-not-real")), "{:?}", plan.cmd);
|
||||
assert!(!plan.cmd.iter().any(|a| a == "-e"), "no new-session -e");
|
||||
// The server inherits the client's environment; the outer TERM is xterm.js's.
|
||||
assert_eq!(plan.env, vec!["ANTHROPIC_API_KEY=sk-test-not-real".to_string(), OUTER_TERM.to_string()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn docker_projects_and_images_without_tmux_launch_as_before() {
|
||||
let inner = claude_inner();
|
||||
let env = vec!["A=1".to_string()];
|
||||
// Docker: untouched, whatever the key looks like.
|
||||
let docker = plan_with(false, true, None, "not a key", TerminalKind::Claude, None, inner.clone(), env.clone()).unwrap();
|
||||
assert_eq!((docker.cmd, docker.env, docker.persistent, docker.notice), (inner.clone(), env.clone(), false, None));
|
||||
// AWS without tmux: the old launch, plus the notice when it is due.
|
||||
let old = plan_with(true, false, Some(NO_TMUX_NOTICE.into()), KEY, TerminalKind::Claude, None, inner.clone(), env.clone()).unwrap();
|
||||
assert_eq!((old.cmd, old.env, old.persistent), (inner, env, false));
|
||||
assert!(old.notice.unwrap().contains("no tmux"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_no_tmux_notice_is_given_once_per_tunnel_and_never_for_an_unanswered_probe() {
|
||||
let id = format!("http://127.0.0.1:1/{}/", uuid::Uuid::new_v4());
|
||||
assert_eq!(take_notice(&id), None, "nothing probed: no notice");
|
||||
probes().lock().unwrap().insert(id.clone(), Probe { supported: false, noticed: false });
|
||||
assert!(take_notice(&id).is_some());
|
||||
assert_eq!(take_notice(&id), None, "once");
|
||||
// A new tunnel on the same port probes (and may notice) again.
|
||||
forget_probe(&id);
|
||||
assert!(probes().lock().unwrap().get(&id).is_none());
|
||||
probes().lock().unwrap().insert(id.clone(), Probe { supported: true, noticed: false });
|
||||
assert_eq!(take_notice(&id), None, "tmux present");
|
||||
forget_probe(&id);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_listing_parses_and_skips_what_is_not_ours() {
|
||||
let out = format!(
|
||||
"{KEY}\tclaude\t1794954824\t1\tmain tab\n\
|
||||
11111111-2222-3333-4444-555555555555\tbash\t1794954800\t0\t\n\
|
||||
bad key!\tbash\t1\t0\t\n\
|
||||
abc\tvim\t1\t0\t\n\
|
||||
abc\tbash\tnot-a-time\t0\t\n"
|
||||
);
|
||||
let got = parse_list(&out);
|
||||
assert_eq!(got.len(), 2);
|
||||
assert_eq!(
|
||||
got[0],
|
||||
RunningSession { key: KEY.into(), kind: TerminalKind::Claude, created_unix: 1794954824, attached: true, name: Some("main tab".into()) }
|
||||
);
|
||||
assert!(!got[1].attached && got[1].name.is_none() && got[1].kind == TerminalKind::Bash);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_workspace_scripts_only_touch_our_sockets() {
|
||||
for script in [list_cmd(), end_all_cmd()] {
|
||||
assert_eq!(&script[..2], &["sh".to_string(), "-c".to_string()]);
|
||||
assert!(script[2].contains("\"$d\"/triple-c-*"), "{}", script[2]);
|
||||
assert!(script[2].contains("${TMUX_TMPDIR:-/tmp}/tmux-$(id -u)"));
|
||||
}
|
||||
let list = &list_cmd()[2];
|
||||
assert!(list.contains("display-message -p '#{session_name}\t#{session_created}\t#{session_attached}\t#{@triple_c_name}'"), "{list}");
|
||||
let end = &end_all_cmd()[2];
|
||||
assert!(end.contains("kill-server") && end.contains("pgrep -u \"$(id -u)\" -f '^tmux -L triple-c-'"));
|
||||
assert!(end.contains("[ $i -lt 50 ]"), "bounded wait");
|
||||
assert_eq!(probe_cmd()[2], "command -v tmux >/dev/null 2>&1 && [ -r /etc/triple-c/tmux.conf ]");
|
||||
// Reattach never creates; history is the part above the screen.
|
||||
assert_eq!(attach_cmd(KEY).unwrap()[5], "attach-session");
|
||||
assert!(!attach_cmd(KEY).unwrap().contains(&"-A".to_string()));
|
||||
let h = history_cmd(KEY).unwrap();
|
||||
assert!(h.ends_with(&["-S".into(), format!("-{HISTORY_LINES}"), "-E".into(), "-1".into()]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_replay_pushes_the_whole_history_into_scrollback_before_tmux_draws() {
|
||||
assert!(replay_bytes("", 30).is_empty());
|
||||
assert!(replay_bytes("\n\n", 30).is_empty());
|
||||
let b = String::from_utf8(replay_bytes("one\n\x1b[31mtwo\n", 3)).unwrap();
|
||||
assert_eq!(b, "one\x1b[0m\r\n\x1b[31mtwo\x1b[0m\r\n\r\n\r\n\r\n");
|
||||
}
|
||||
|
||||
/// The config tmux is started with, as the image ships it.
|
||||
#[test]
|
||||
fn the_image_ships_the_config_and_tmux() {
|
||||
let conf = include_str!("../../../../../container/triple-c-tmux.conf");
|
||||
for line in [
|
||||
"set -g prefix None",
|
||||
"unbind-key C-b",
|
||||
"set -g status off",
|
||||
"set -s escape-time 0",
|
||||
"set -g mouse off",
|
||||
"set -g remain-on-exit off",
|
||||
"set -g destroy-unattached off",
|
||||
"set -g window-size latest",
|
||||
"set -g default-terminal \"tmux-256color\"",
|
||||
r#"set -as terminal-overrides ",xterm*:smcup@:rmcup@:indn@:clear=\\E[H""#,
|
||||
] {
|
||||
assert!(conf.lines().any(|l| l == line), "missing: {line}");
|
||||
}
|
||||
let df = include_str!("../../../../../container/Dockerfile");
|
||||
assert!(df.contains("COPY triple-c-tmux.conf /etc/triple-c/tmux.conf"));
|
||||
assert!(df.lines().any(|l| l.trim() == "tmux \\"), "tmux in an apt layer");
|
||||
}
|
||||
|
||||
/// An unanswered probe (a tunnel reopening) is an error, never "no tmux":
|
||||
/// read as no, the listing would prune every remembered tab and a reattach
|
||||
/// would end tabs whose Claude still runs.
|
||||
#[tokio::test]
|
||||
async fn an_unanswered_probe_is_an_error_not_a_no() {
|
||||
let port = std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port();
|
||||
let target = ContainerTarget::Agent(
|
||||
crate::host::AgentEndpoint::loopback(port, "x".repeat(64)),
|
||||
);
|
||||
assert_eq!(probe(&target).await, None);
|
||||
assert!(supported(&target).await.is_err());
|
||||
assert!(list(&target).await.is_err(), "no listing, so nothing to prune");
|
||||
let planned = plan(true, &target, KEY, TerminalKind::Claude, None, claude_inner(), vec![]).await;
|
||||
assert!(planned.is_err(), "not silently a non-persistent tab");
|
||||
assert!(probes().lock().unwrap().get(target.id()).is_none(), "asked again next time");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_client_env_drops_what_would_point_tmux_elsewhere() {
|
||||
let env = client_env(vec!["TMUX=/tmp/x,1,0".into(), "TMUX_TMPDIR=/elsewhere".into(), "A=1".into()]);
|
||||
assert_eq!(env, vec!["A=1".to_string(), OUTER_TERM.to_string()]);
|
||||
}
|
||||
@@ -0,0 +1,464 @@
|
||||
//! A project's port mappings on a host with no Docker port publishing (AWS).
|
||||
//!
|
||||
//! Docker publishes a mapping itself (`0.0.0.0:<host>` → the container's
|
||||
//! network interface). A Fargate task has no such thing, so each TCP mapping
|
||||
//! becomes a host **loopback** listener (`127.0.0.1` and `::1`, never a
|
||||
//! wildcard) carried into the task over `socat` on an attached exec — the
|
||||
//! auth bridge's [`PortForward`], which works through the agent like any
|
||||
//! other exec (constraints Q6). Nothing is published beyond this machine,
|
||||
//! and the UI says so.
|
||||
//!
|
||||
//! ## Two differences from Docker, both deliberate
|
||||
//!
|
||||
//! * **It reaches the workspace's loopback, not its network interface**
|
||||
//! (`socat` to `127.0.0.1:<port>`, or `[::1]:<port>` when only an IPv6
|
||||
//! loopback/wildcard socket listens there — see
|
||||
//! [`crate::auth_bridge::tunnel::mapping_command`]). So a mapping can
|
||||
//! reach a service that bound loopback precisely to be private — which is
|
||||
//! why the agent's port, the browser view's range and (when the project
|
||||
//! runs it) the gateway sidecar's [`GATEWAY_SIDECAR_PORT`] are refused.
|
||||
//! * **No gate** ([`PortForward::bind_mapping`]): unlike the auth bridge, a
|
||||
//! client need not speak first and an HTTP request is not checked for a
|
||||
//! cross-site origin — Docker's publishing has neither, and a
|
||||
//! server-speaks-first protocol (MySQL, SMTP) must work. What a mapping
|
||||
//! exposes is what the user chose to expose, to this machine only.
|
||||
//!
|
||||
//! The tunnel's bounds still apply: 16 concurrent connections per mapping,
|
||||
//! and a connection the workspace sends nothing on for 600 s is closed.
|
||||
//!
|
||||
//! ## Lifetime
|
||||
//!
|
||||
//! One set per project, opened after every connect (the start, and the
|
||||
//! background re-attach after an app restart) and on a save of the mappings
|
||||
//! while connected. Opens are serialised per project and re-read the stored
|
||||
//! mappings under that lock, so the last save wins; an open keeps the
|
||||
//! forwards it already has for an unchanged mapping (with their live
|
||||
//! connections) and rebinds everything when the tunnel changed. The set is
|
||||
//! closed with the project's tunnel — `tunnels::close`, `close_if_task` (the
|
||||
//! task died) and `close_all` (app exit) call [`close`] / [`close_all`] — so
|
||||
//! Stop, Remove, a task death and exit need nothing of their own.
|
||||
//!
|
||||
//! ## Idle stop
|
||||
//!
|
||||
//! An open listener costs the workspace nothing: no agent request is made
|
||||
//! until a client connects. A connection is an attach, which counts as
|
||||
//! activity while bytes flow — a client using a mapping keeps the workspace
|
||||
//! from its idle stop; one connected but silent does not.
|
||||
|
||||
use std::collections::{HashMap, HashSet};
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
use crate::auth_bridge::tunnel::PortForward;
|
||||
use crate::auth_bridge::{RESERVED_CONTAINER_PORTS, RESERVED_HOST_PORTS};
|
||||
use crate::models::PortMapping;
|
||||
use crate::storage::projects_store::ProjectsStore;
|
||||
|
||||
use super::ContainerTarget;
|
||||
|
||||
/// Where a warning about a mapping goes after the open has returned: the
|
||||
/// first connection that finds nothing listening in the workspace.
|
||||
pub type PortsWarn = Arc<dyn Fn(String) + Send + Sync>;
|
||||
|
||||
/// What the user is told when a mapping's workspace port has no listener.
|
||||
pub fn nothing_listening(host_port: u16, container_port: u16) -> String {
|
||||
format!(
|
||||
"localhost:{host_port}: nothing is listening on port {container_port} in the workspace \
|
||||
(127.0.0.1 or ::1)"
|
||||
)
|
||||
}
|
||||
|
||||
/// What became of one mapping: `error` is `None` when its forward is open.
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub struct PortForwardResult {
|
||||
pub mapping: PortMapping,
|
||||
pub error: Option<String>,
|
||||
}
|
||||
|
||||
/// The container port the gateway sidecar (Task 8, `gateway_sidecar`)
|
||||
/// listens on, on the workspace's loopback.
|
||||
pub const GATEWAY_SIDECAR_PORT: u16 = 4000;
|
||||
|
||||
/// A project's open forwards and the target (tunnel endpoint) they lead to.
|
||||
struct OpenSet {
|
||||
target_id: String,
|
||||
forwards: Vec<PortForward>,
|
||||
}
|
||||
|
||||
type Registry = HashMap<String, OpenSet>;
|
||||
|
||||
fn registry() -> &'static Mutex<Registry> {
|
||||
static R: std::sync::OnceLock<Mutex<Registry>> = std::sync::OnceLock::new();
|
||||
R.get_or_init(Default::default)
|
||||
}
|
||||
|
||||
fn lock() -> std::sync::MutexGuard<'static, Registry> {
|
||||
registry().lock().unwrap_or_else(|e| e.into_inner())
|
||||
}
|
||||
|
||||
/// The per-project lock every open and close holds, so two opens (a save on
|
||||
/// every blur, a save during a start's open) never interleave.
|
||||
fn project_lock(project_id: &str) -> Arc<tokio::sync::Mutex<()>> {
|
||||
static L: std::sync::OnceLock<Mutex<HashMap<String, Arc<tokio::sync::Mutex<()>>>>> =
|
||||
std::sync::OnceLock::new();
|
||||
L.get_or_init(Default::default)
|
||||
.lock()
|
||||
.unwrap_or_else(|e| e.into_inner())
|
||||
.entry(project_id.to_string())
|
||||
.or_default()
|
||||
.clone()
|
||||
}
|
||||
|
||||
/// Why one mapping can't be forwarded to an AWS workspace, if it can't.
|
||||
/// `None` when it is fine.
|
||||
fn mapping_problem(m: &PortMapping, gateway_sidecar: bool) -> Option<String> {
|
||||
if !m.protocol.eq_ignore_ascii_case("tcp") {
|
||||
return Some(format!(
|
||||
"{} → {} ({}): only TCP ports can be forwarded to an AWS workspace",
|
||||
m.host_port,
|
||||
m.container_port,
|
||||
m.protocol.to_ascii_uppercase()
|
||||
));
|
||||
}
|
||||
if RESERVED_CONTAINER_PORTS.contains(&m.container_port) {
|
||||
return Some(format!(
|
||||
"Container port {} is reserved for the browser view ({}–{})",
|
||||
m.container_port,
|
||||
RESERVED_CONTAINER_PORTS.start(),
|
||||
RESERVED_CONTAINER_PORTS.end()
|
||||
));
|
||||
}
|
||||
if m.container_port == super::ssm::AGENT_PORT {
|
||||
return Some(format!(
|
||||
"Container port {} is the workspace agent's own port",
|
||||
super::ssm::AGENT_PORT
|
||||
));
|
||||
}
|
||||
if gateway_sidecar && m.container_port == GATEWAY_SIDECAR_PORT {
|
||||
return Some(format!(
|
||||
"Container port {GATEWAY_SIDECAR_PORT} is the gateway sidecar's, which holds the \
|
||||
model provider's key"
|
||||
));
|
||||
}
|
||||
if RESERVED_HOST_PORTS.contains(&m.host_port) {
|
||||
return Some(format!(
|
||||
"Host port {} is reserved for the browser view ({}–{})",
|
||||
m.host_port,
|
||||
RESERVED_HOST_PORTS.start(),
|
||||
RESERVED_HOST_PORTS.end()
|
||||
));
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// A row stored without both its ports (an older editor saved a new row as
|
||||
/// 0 → 0 before anything was typed): nothing to check on save, and nothing
|
||||
/// to forward — but a connect says so ([`incomplete_warning`]), never silent.
|
||||
fn incomplete(m: &PortMapping) -> bool {
|
||||
m.host_port == 0 || m.container_port == 0
|
||||
}
|
||||
|
||||
/// The `ports` warning line for a stored row a connect skips as incomplete.
|
||||
pub fn incomplete_warning(m: &PortMapping) -> String {
|
||||
let port = |p: u16| if p == 0 { "?".to_string() } else { p.to_string() };
|
||||
format!(
|
||||
"{} → {}: incomplete, both ports are needed",
|
||||
port(m.host_port),
|
||||
port(m.container_port)
|
||||
)
|
||||
}
|
||||
|
||||
/// An AWS project's port mappings, checked in full: TCP only, no reserved
|
||||
/// port (the browser view's two ranges, the agent's port, the gateway
|
||||
/// sidecar's when it runs), and no host port twice. The first problem,
|
||||
/// worded for the user.
|
||||
pub fn validate_aws_port_mappings(mappings: &[PortMapping], gateway_sidecar: bool) -> Result<(), String> {
|
||||
validate_changed(mappings, gateway_sidecar, |_| true)
|
||||
}
|
||||
|
||||
/// [`validate_aws_port_mappings`] on a save, against what is stored:
|
||||
/// `stored` is `None` when the project was not on AWS before (everything is
|
||||
/// checked). Otherwise only rows the save adds or edits are — a stored row
|
||||
/// this check would refuse (a UDP mapping kept from before) does not block
|
||||
/// every unrelated save; it is skipped, with a warning, at each connect.
|
||||
/// Turning the gateway sidecar on checks everything again.
|
||||
pub fn validate_aws_port_mappings_update(
|
||||
stored: Option<(&[PortMapping], bool)>,
|
||||
mappings: &[PortMapping],
|
||||
gateway_sidecar: bool,
|
||||
) -> Result<(), String> {
|
||||
match stored {
|
||||
Some((old, old_gateway)) if old_gateway == gateway_sidecar => {
|
||||
validate_changed(mappings, gateway_sidecar, |m| !old.contains(m))
|
||||
}
|
||||
_ => validate_aws_port_mappings(mappings, gateway_sidecar),
|
||||
}
|
||||
}
|
||||
|
||||
fn validate_changed(
|
||||
mappings: &[PortMapping],
|
||||
gateway_sidecar: bool,
|
||||
changed: impl Fn(&PortMapping) -> bool,
|
||||
) -> Result<(), String> {
|
||||
let mut seen: HashMap<u16, bool> = HashMap::new();
|
||||
for m in mappings.iter().filter(|m| !incomplete(m)) {
|
||||
let is_changed = changed(m);
|
||||
if is_changed {
|
||||
if let Some(problem) = mapping_problem(m, gateway_sidecar) {
|
||||
return Err(problem);
|
||||
}
|
||||
}
|
||||
match seen.get(&m.host_port) {
|
||||
Some(&other_changed) if is_changed || other_changed => {
|
||||
return Err(format!("Host port {} is mapped twice", m.host_port))
|
||||
}
|
||||
Some(_) => {}
|
||||
None => {
|
||||
seen.insert(m.host_port, is_changed);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Whether `target` is still the project's connected workspace.
|
||||
fn still_connected(project_id: &str, target: &ContainerTarget) -> bool {
|
||||
match target {
|
||||
ContainerTarget::Agent(ep) => {
|
||||
super::tunnels::get_endpoint(project_id).is_some_and(|e| e.base_url == ep.base_url)
|
||||
}
|
||||
ContainerTarget::Docker { .. } => false,
|
||||
}
|
||||
}
|
||||
|
||||
/// Open `mappings` for `project_id` into `target` (its connected workspace).
|
||||
/// See [`open_latest`]; the gateway sidecar is taken as off. Test helper.
|
||||
#[cfg(test)]
|
||||
pub async fn open_for(
|
||||
project_id: &str,
|
||||
target: &ContainerTarget,
|
||||
mappings: &[PortMapping],
|
||||
) -> Vec<PortForwardResult> {
|
||||
let mappings = mappings.to_vec();
|
||||
open_latest(project_id, target, None, move || Some((mappings, false))).await
|
||||
}
|
||||
|
||||
/// Open the project's mappings into `target`, replacing the set it had.
|
||||
/// `read` gives the mappings and whether the gateway sidecar runs, and is
|
||||
/// called **under the project's lock** — so the last of several overlapping
|
||||
/// opens applies what is stored last. `None` from it closes the set.
|
||||
///
|
||||
/// One result per mapping, in order: a refused mapping, a host port mapped
|
||||
/// twice or a busy host port is an error for that mapping only, and the
|
||||
/// others still open. A mapping already open into the same target is kept,
|
||||
/// live connections and all. If the project's tunnel is no longer `target`
|
||||
/// once they are bound (a Stop or a newer connect raced this), nothing is
|
||||
/// kept.
|
||||
pub async fn open_latest(
|
||||
project_id: &str,
|
||||
target: &ContainerTarget,
|
||||
warn: Option<PortsWarn>,
|
||||
read: impl FnOnce() -> Option<(Vec<PortMapping>, bool)> + Send,
|
||||
) -> Vec<PortForwardResult> {
|
||||
let plock = project_lock(project_id);
|
||||
let _held = plock.lock().await;
|
||||
let Some((mappings, gateway_sidecar)) = read() else {
|
||||
log::info!("Project {project_id}: no longer an AWS project; closing its port forwards");
|
||||
close_unlocked(project_id).await;
|
||||
return Vec::new();
|
||||
};
|
||||
log::info!(
|
||||
"Project {project_id}: opening port mappings into {} ({} stored, {} incomplete)",
|
||||
target.id(),
|
||||
mappings.len(),
|
||||
mappings.iter().filter(|m| incomplete(m)).count()
|
||||
);
|
||||
|
||||
// What can be forwarded, in order; the first row wins a host port.
|
||||
let mut results: Vec<PortForwardResult> = Vec::new();
|
||||
let mut wanted: Vec<(usize, u16, u16)> = Vec::new();
|
||||
let mut taken = HashSet::new();
|
||||
for m in &mappings {
|
||||
let error = if incomplete(m) {
|
||||
Some(incomplete_warning(m))
|
||||
} else if let Some(problem) = mapping_problem(m, gateway_sidecar) {
|
||||
Some(problem)
|
||||
} else if !taken.insert(m.host_port) {
|
||||
Some(format!(
|
||||
"{} → {}: host port {} is already used by another mapping",
|
||||
m.host_port, m.container_port, m.host_port
|
||||
))
|
||||
} else {
|
||||
wanted.push((results.len(), m.host_port, m.container_port));
|
||||
None
|
||||
};
|
||||
results.push(PortForwardResult { mapping: m.clone(), error });
|
||||
}
|
||||
|
||||
// Keep what is already open into this target and still wanted; free
|
||||
// every other host port first, so a changed mapping can rebind it.
|
||||
let previous = lock().remove(project_id);
|
||||
let mut kept: HashMap<(u16, u16), PortForward> = HashMap::new();
|
||||
let mut dropped = Vec::new();
|
||||
if let Some(prev) = previous {
|
||||
let same_target = prev.target_id == target.id();
|
||||
for f in prev.forwards {
|
||||
let key = (f.port, f.container_port);
|
||||
if same_target && wanted.iter().any(|&(_, h, c)| (h, c) == key) {
|
||||
kept.insert(key, f);
|
||||
} else {
|
||||
dropped.push(f);
|
||||
}
|
||||
}
|
||||
}
|
||||
shutdown_all(dropped).await;
|
||||
|
||||
let mut opened = Vec::new();
|
||||
for (i, host_port, container_port) in wanted {
|
||||
if let Some(f) = kept.remove(&(host_port, container_port)) {
|
||||
opened.push(f);
|
||||
continue;
|
||||
}
|
||||
let on_refused = warn.clone().map(|w| {
|
||||
let notice: crate::auth_bridge::tunnel::RefusedNotice =
|
||||
Arc::new(move || w(nothing_listening(host_port, container_port)));
|
||||
notice
|
||||
});
|
||||
match PortForward::bind_mapping(target.clone(), host_port, container_port, on_refused).await {
|
||||
Ok(fwd) => {
|
||||
if let Some(w) = &fwd.ipv6_warning {
|
||||
log::warn!("Project {project_id}: port mapping {host_port}: {w}");
|
||||
}
|
||||
log::info!(
|
||||
"Project {project_id}: forwarding localhost:{host_port} → workspace port {container_port}"
|
||||
);
|
||||
opened.push(fwd);
|
||||
}
|
||||
Err(e) => {
|
||||
results[i].error = Some(if e.kind() == std::io::ErrorKind::AddrInUse {
|
||||
format!(
|
||||
"{host_port} → {container_port}: host port {host_port} is already in use on this machine"
|
||||
)
|
||||
} else {
|
||||
format!("{host_port} → {container_port}: could not listen on host port {host_port}: {e}")
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
lock().insert(
|
||||
project_id.to_string(),
|
||||
OpenSet { target_id: target.id().to_string(), forwards: opened },
|
||||
);
|
||||
// Checked *after* the set is registered: a tunnel close that ran before
|
||||
// this sees it gone here; one that runs after removes it itself.
|
||||
if !still_connected(project_id, target) {
|
||||
log::warn!(
|
||||
"Project {project_id}: the workspace's tunnel is no longer {} — closing the port forwards just opened",
|
||||
target.id()
|
||||
);
|
||||
close_unlocked(project_id).await;
|
||||
for r in results.iter_mut().filter(|r| r.error.is_none()) {
|
||||
r.error = Some("the workspace disconnected".into());
|
||||
}
|
||||
}
|
||||
for r in &results {
|
||||
match &r.error {
|
||||
None => log::info!(
|
||||
"Project {project_id}: port mapping localhost:{} → workspace port {} is open",
|
||||
r.mapping.host_port,
|
||||
r.mapping.container_port
|
||||
),
|
||||
Some(e) => log::warn!("Project {project_id}: port mapping not open: {e}"),
|
||||
}
|
||||
}
|
||||
results
|
||||
}
|
||||
|
||||
async fn shutdown_all(set: Vec<PortForward>) {
|
||||
futures_util::future::join_all(set.into_iter().map(|mut f| async move { f.shutdown().await }))
|
||||
.await;
|
||||
}
|
||||
|
||||
/// Close the project's forwards (its ports are free when this returns).
|
||||
/// Waits for an open in progress.
|
||||
pub async fn close(project_id: &str) {
|
||||
let plock = project_lock(project_id);
|
||||
let _held = plock.lock().await;
|
||||
close_unlocked(project_id).await;
|
||||
}
|
||||
|
||||
async fn close_unlocked(project_id: &str) {
|
||||
let set = lock().remove(project_id);
|
||||
if let Some(set) = set {
|
||||
if !set.forwards.is_empty() {
|
||||
log::info!("Project {project_id}: closing {} port forward(s)", set.forwards.len());
|
||||
}
|
||||
shutdown_all(set.forwards).await;
|
||||
}
|
||||
}
|
||||
|
||||
/// Close every project's forwards. The shutdown path's step (via
|
||||
/// `tunnels::close_all`). An open in progress finds the tunnel gone and
|
||||
/// closes its own set.
|
||||
pub async fn close_all() {
|
||||
let all: Vec<PortForward> = lock().drain().flat_map(|(_, v)| v.forwards).collect();
|
||||
shutdown_all(all).await;
|
||||
}
|
||||
|
||||
/// After a connect (or a save of the mappings while connected): open an
|
||||
/// AWS project's mappings, **as stored when the open runs**, into its
|
||||
/// connected workspace. The warning detail for the mappings that failed, if
|
||||
/// any did; `None` for a local project (Docker publishes its own), and for a
|
||||
/// workspace that is not (or no longer) connected **unless the project is
|
||||
/// Running** — mappings that should be open and aren't are never silent.
|
||||
/// `warn` receives the later "nothing is listening" notices.
|
||||
pub async fn open_for_project(
|
||||
store: &ProjectsStore,
|
||||
project_id: &str,
|
||||
warn: Option<PortsWarn>,
|
||||
) -> Option<String> {
|
||||
let project = store.get(project_id).filter(|p| p.is_aws())?;
|
||||
let wanted = project.port_mappings.iter().filter(|m| !incomplete(m)).count();
|
||||
let running = || {
|
||||
store.get(project_id).is_some_and(|p| p.status == crate::models::ProjectStatus::Running)
|
||||
};
|
||||
let Some(endpoint) = super::tunnels::get_endpoint(&project.id) else {
|
||||
log::info!("Project {project_id}: no tunnel to the workspace; {wanted} port mapping(s) not opened");
|
||||
return (wanted > 0 && running()).then(|| {
|
||||
"The workspace is not connected, so its port mappings were not opened. Start the \
|
||||
project again."
|
||||
.to_string()
|
||||
});
|
||||
};
|
||||
let target = ContainerTarget::Agent(endpoint);
|
||||
let results = open_latest(project_id, &target, warn, || {
|
||||
store.get(project_id).filter(|p| p.is_aws()).map(|p| {
|
||||
let gateway = p.aws.as_ref().is_some_and(|a| a.gateway_sidecar);
|
||||
(p.port_mappings, gateway)
|
||||
})
|
||||
})
|
||||
.await;
|
||||
if !still_connected(project_id, &target) && !running() {
|
||||
return None; // a Stop raced the open: nothing to say
|
||||
}
|
||||
failure_detail(&results)
|
||||
}
|
||||
|
||||
/// The host ports open for the project.
|
||||
#[cfg(test)]
|
||||
pub fn open_ports(project_id: &str) -> Vec<u16> {
|
||||
let mut ports: Vec<u16> =
|
||||
lock().get(project_id).map(|v| v.forwards.iter().map(|f| f.port).collect()).unwrap_or_default();
|
||||
ports.sort_unstable();
|
||||
ports
|
||||
}
|
||||
|
||||
/// The `workspace-warning` detail for the mappings that failed, if any did.
|
||||
pub fn failure_detail(results: &[PortForwardResult]) -> Option<String> {
|
||||
let lines: Vec<&str> = results.iter().filter_map(|r| r.error.as_deref()).collect();
|
||||
(!lines.is_empty()).then(|| lines.join("\n"))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "port_forwards/tests.rs"]
|
||||
mod tests;
|
||||
@@ -0,0 +1,606 @@
|
||||
//! Port mappings against real loopback sockets and a **fake** agent that
|
||||
//! answers `/v1/attach` by echoing stdin back as stdout — the socat it was
|
||||
//! asked to run is recorded, never run.
|
||||
|
||||
use super::*;
|
||||
use crate::storage::projects_store::ProjectsStore;
|
||||
use crate::host::agent::AgentEndpoint;
|
||||
use crate::host::tunnels;
|
||||
use axum::extract::ws::{Message as WsMessage, WebSocket, WebSocketUpgrade};
|
||||
use axum::extract::State;
|
||||
use axum::response::Response;
|
||||
use axum::routing::get;
|
||||
use axum::Router;
|
||||
use futures_util::SinkExt;
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Arc;
|
||||
use tokio::io::{AsyncReadExt, AsyncWriteExt};
|
||||
use tokio::net::TcpStream;
|
||||
|
||||
#[derive(Default)]
|
||||
struct Fake {
|
||||
/// Every request the agent saw, of any kind.
|
||||
requests: AtomicUsize,
|
||||
/// The command of each attach.
|
||||
cmds: std::sync::Mutex<Vec<Vec<String>>>,
|
||||
/// Answer every attach as socat finding nothing listening.
|
||||
refuse: std::sync::atomic::AtomicBool,
|
||||
}
|
||||
|
||||
async fn attach_ws(State(f): State<Arc<Fake>>, ws: WebSocketUpgrade) -> Response {
|
||||
f.requests.fetch_add(1, Ordering::SeqCst);
|
||||
ws.on_upgrade(move |socket| echo(f, socket))
|
||||
}
|
||||
|
||||
async fn echo(f: Arc<Fake>, mut ws: WebSocket) {
|
||||
let Some(Ok(WsMessage::Text(hello))) = ws.recv().await else { return };
|
||||
let hello: serde_json::Value = serde_json::from_str(hello.as_str()).unwrap();
|
||||
let cmd = hello["cmd"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.map(|v| v.as_str().unwrap().to_string())
|
||||
.collect();
|
||||
f.cmds.lock().unwrap().push(cmd);
|
||||
let _ = ws.send(WsMessage::Text(r#"{"type":"started","exec_id":"a1"}"#.into())).await;
|
||||
if f.refuse.load(Ordering::SeqCst) {
|
||||
let mut err = vec![2u8];
|
||||
err.extend_from_slice(b"socat[7] E connect(5, AF=2 127.0.0.1:8080, 16): Connection refused\n");
|
||||
let _ = ws.send(WsMessage::Binary(err.into())).await;
|
||||
let _ = ws.send(WsMessage::Text(r#"{"type":"exit","code":1}"#.into())).await;
|
||||
let _ = ws.close().await;
|
||||
return;
|
||||
}
|
||||
while let Some(Ok(msg)) = ws.recv().await {
|
||||
match msg {
|
||||
WsMessage::Binary(b) => {
|
||||
let mut out = vec![1u8];
|
||||
out.extend_from_slice(&b);
|
||||
if ws.send(WsMessage::Binary(out.into())).await.is_err() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
WsMessage::Text(t) if t.as_str().contains("close_stdin") => break,
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
let _ = ws.send(WsMessage::Text(r#"{"type":"exit","code":0}"#.into())).await;
|
||||
let _ = ws.close().await;
|
||||
}
|
||||
|
||||
async fn counted(State(f): State<Arc<Fake>>) -> &'static str {
|
||||
f.requests.fetch_add(1, Ordering::SeqCst);
|
||||
"{}"
|
||||
}
|
||||
|
||||
/// A fake agent, registered as `project_id`'s connected tunnel; its target.
|
||||
async fn connected_agent(project_id: &str) -> (ContainerTarget, Arc<Fake>, Arc<AtomicUsize>) {
|
||||
let fake = Arc::new(Fake::default());
|
||||
let app = Router::new()
|
||||
.route("/v1/attach", get(attach_ws))
|
||||
.fallback(counted)
|
||||
.with_state(fake.clone());
|
||||
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||
let port = listener.local_addr().unwrap().port();
|
||||
tokio::spawn(async move {
|
||||
axum::serve(listener, app).await.unwrap();
|
||||
});
|
||||
let closes = Arc::new(AtomicUsize::new(0));
|
||||
tunnels::register(project_id, tunnels::tests::fake_tunnel(port, closes.clone()));
|
||||
(ContainerTarget::Agent(AgentEndpoint::loopback(port, "tok")), fake, closes)
|
||||
}
|
||||
|
||||
fn pid(tag: &str) -> String {
|
||||
format!("port-forwards-test-{tag}-{}", uuid::Uuid::new_v4())
|
||||
}
|
||||
|
||||
/// A host port nothing listens on right now.
|
||||
fn free_port() -> u16 {
|
||||
std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port()
|
||||
}
|
||||
|
||||
fn tcp(host_port: u16, container_port: u16) -> PortMapping {
|
||||
PortMapping { host_port, container_port, protocol: "tcp".into() }
|
||||
}
|
||||
|
||||
async fn round_trip(port: u16, msg: &[u8]) -> Vec<u8> {
|
||||
let mut c = TcpStream::connect(("127.0.0.1", port)).await.expect("connect");
|
||||
c.write_all(msg).await.unwrap();
|
||||
let mut buf = vec![0u8; msg.len()];
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), c.read_exact(&mut buf))
|
||||
.await
|
||||
.expect("echo in time")
|
||||
.expect("echo");
|
||||
buf
|
||||
}
|
||||
|
||||
fn port_is_free(port: u16) -> bool {
|
||||
std::net::TcpListener::bind(("127.0.0.1", port)).is_ok()
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_busy_host_port_fails_its_mapping_alone_and_the_other_forwards() {
|
||||
let p = pid("busy");
|
||||
let (target, fake, _) = connected_agent(&p).await;
|
||||
let busy = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let busy_port = busy.local_addr().unwrap().port();
|
||||
let free = free_port();
|
||||
|
||||
let results = open_for(&p, &target, &[tcp(busy_port, 3000), tcp(free, 5432)]).await;
|
||||
|
||||
assert_eq!(results.len(), 2);
|
||||
let e = results[0].error.as_deref().expect("the busy port fails");
|
||||
assert!(e.contains("already in use"), "{e}");
|
||||
assert!(results[1].error.is_none(), "{:?}", results[1].error);
|
||||
assert_eq!(failure_detail(&results).as_deref(), Some(e));
|
||||
assert_eq!(open_ports(&p), vec![free]);
|
||||
|
||||
// Bytes go through the agent's attach, to the *container* port.
|
||||
assert_eq!(round_trip(free, b"ping").await, b"ping");
|
||||
assert_eq!(
|
||||
fake.cmds.lock().unwrap().as_slice(),
|
||||
[crate::auth_bridge::tunnel::mapping_command(5432)]
|
||||
);
|
||||
|
||||
// Stop / Remove / task death all close the tunnel: the mappings go too.
|
||||
tunnels::close(&p).await;
|
||||
assert!(open_ports(&p).is_empty());
|
||||
assert!(port_is_free(free));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_server_speaks_first_protocol_is_not_held_back() {
|
||||
// Unlike the auth bridge, a mapping forwards a client that has said
|
||||
// nothing yet (MySQL, SMTP): the attach opens on connect.
|
||||
let p = pid("silent");
|
||||
let (target, fake, _) = connected_agent(&p).await;
|
||||
let port = free_port();
|
||||
assert!(open_for(&p, &target, &[tcp(port, 3306)]).await[0].error.is_none());
|
||||
let _client = TcpStream::connect(("127.0.0.1", port)).await.unwrap();
|
||||
let deadline = tokio::time::Instant::now() + std::time::Duration::from_secs(3);
|
||||
while fake.cmds.lock().unwrap().is_empty() {
|
||||
assert!(tokio::time::Instant::now() < deadline, "no attach for a silent client");
|
||||
tokio::time::sleep(std::time::Duration::from_millis(20)).await;
|
||||
}
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_open_listener_with_no_connection_makes_no_agent_request() {
|
||||
// So it can never count as activity and keep a workspace from its idle stop.
|
||||
let p = pid("idle");
|
||||
let (target, fake, _) = connected_agent(&p).await;
|
||||
let port = free_port();
|
||||
assert!(open_for(&p, &target, &[tcp(port, 8080)]).await[0].error.is_none());
|
||||
tokio::time::sleep(std::time::Duration::from_millis(300)).await;
|
||||
assert_eq!(fake.requests.load(Ordering::SeqCst), 0);
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn udp_reserved_and_duplicate_mappings_are_refused_per_mapping() {
|
||||
let p = pid("refused");
|
||||
let (target, _, _) = connected_agent(&p).await;
|
||||
let ok = free_port();
|
||||
let udp = PortMapping { host_port: free_port(), container_port: 53, protocol: "udp".into() };
|
||||
let results = open_for(
|
||||
&p,
|
||||
&target,
|
||||
&[
|
||||
udp,
|
||||
tcp(ok, 8080),
|
||||
tcp(ok, 9090),
|
||||
tcp(free_port(), *RESERVED_CONTAINER_PORTS.start()),
|
||||
tcp(free_port(), crate::host::ssm::AGENT_PORT),
|
||||
tcp(*RESERVED_HOST_PORTS.start(), 8080),
|
||||
tcp(0, 0),
|
||||
],
|
||||
)
|
||||
.await;
|
||||
let errors: Vec<Option<&str>> = results.iter().map(|r| r.error.as_deref()).collect();
|
||||
assert_eq!(errors.len(), 7, "{errors:?}");
|
||||
assert_eq!(errors[6], Some("? → ?: incomplete, both ports are needed"), "skipped, not silently");
|
||||
assert!(errors[0].unwrap().contains("only TCP"), "{errors:?}");
|
||||
assert!(errors[1].is_none());
|
||||
assert!(errors[2].unwrap().contains("another mapping"), "{errors:?}");
|
||||
assert!(errors[3].unwrap().contains("browser view"), "{errors:?}");
|
||||
assert!(errors[4].unwrap().contains("agent"), "{errors:?}");
|
||||
assert!(errors[5].unwrap().contains("browser view"), "{errors:?}");
|
||||
assert_eq!(open_ports(&p), vec![ok]);
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_reconnect_replaces_the_set_on_the_same_host_ports() {
|
||||
let p = pid("replace");
|
||||
let (target, _, _) = connected_agent(&p).await;
|
||||
let port = free_port();
|
||||
assert!(open_for(&p, &target, &[tcp(port, 8080)]).await[0].error.is_none());
|
||||
// A background re-attach registers a new tunnel and opens again.
|
||||
let (target2, fake2, _) = connected_agent(&p).await;
|
||||
let again = open_for(&p, &target2, &[tcp(port, 8080)]).await;
|
||||
assert!(again[0].error.is_none(), "{:?}", again[0].error);
|
||||
assert_eq!(round_trip(port, b"hi").await, b"hi");
|
||||
assert_eq!(fake2.cmds.lock().unwrap().len(), 1, "the new set reaches the new tunnel");
|
||||
tunnels::close(&p).await;
|
||||
assert!(port_is_free(port));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn nothing_is_kept_when_the_workspace_is_no_longer_connected() {
|
||||
let p = pid("gone");
|
||||
let (target, _, _) = connected_agent(&p).await;
|
||||
tunnels::close(&p).await; // a Stop raced the connect
|
||||
let port = free_port();
|
||||
let results = open_for(&p, &target, &[tcp(port, 8080)]).await;
|
||||
assert!(results[0].error.as_deref().unwrap().contains("disconnected"));
|
||||
assert!(open_ports(&p).is_empty());
|
||||
assert!(port_is_free(port));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_task_death_closes_the_mappings_but_a_stale_report_does_not() {
|
||||
let p = pid("death");
|
||||
let (target, _, _) = connected_agent(&p).await;
|
||||
let port = free_port();
|
||||
open_for(&p, &target, &[tcp(port, 8080)]).await;
|
||||
tunnels::close_if_task(&p, "arn:some-older-task").await;
|
||||
assert_eq!(open_ports(&p), vec![port]);
|
||||
let ContainerTarget::Agent(ep) = &target else { unreachable!() };
|
||||
let (_, _, _, arn) = tunnels::task_of(ep).unwrap();
|
||||
tunnels::close_if_task(&p, &arn).await;
|
||||
assert!(open_ports(&p).is_empty());
|
||||
assert!(port_is_free(port));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_aws_project_saves_only_tcp_unreserved_unique_mappings() {
|
||||
let v = |m: &[PortMapping]| validate_aws_port_mappings(m, false);
|
||||
assert!(v(&[tcp(3000, 3000), tcp(8081, 8080), tcp(0, 0), tcp(5000, 0), tcp(4001, 4000)]).is_ok());
|
||||
let udp = PortMapping { host_port: 5353, container_port: 5353, protocol: "udp".into() };
|
||||
let e = v(&[udp]).unwrap_err();
|
||||
assert!(e.contains("only TCP") && e.contains("UDP"), "{e}");
|
||||
assert!(v(&[tcp(3000, 3000), tcp(3000, 4000)]).unwrap_err().contains("mapped twice"));
|
||||
assert!(v(&[tcp(4000, 39321)]).is_err());
|
||||
assert!(v(&[tcp(4000, 47900)]).is_err());
|
||||
assert!(v(&[tcp(47820, 4000)]).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_gateway_sidecars_port_is_refused_while_the_project_runs_it() {
|
||||
// A mapping reaches the workspace's *loopback*, where the sidecar holds
|
||||
// the provider key behind 127.0.0.1:4000.
|
||||
let m = [tcp(4001, GATEWAY_SIDECAR_PORT)];
|
||||
assert!(validate_aws_port_mappings(&m, false).is_ok());
|
||||
let e = validate_aws_port_mappings(&m, true).unwrap_err();
|
||||
assert!(e.contains("gateway sidecar"), "{e}");
|
||||
// Turning the sidecar on re-checks rows that were already stored.
|
||||
assert!(validate_aws_port_mappings_update(Some((&m, false)), &m, true).is_err());
|
||||
assert!(validate_aws_port_mappings_update(Some((&m, false)), &m, false).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_stored_row_that_would_be_refused_does_not_block_other_saves() {
|
||||
let udp = PortMapping { host_port: 5353, container_port: 5353, protocol: "udp".into() };
|
||||
let stored = vec![udp.clone(), tcp(3000, 3000)];
|
||||
// Unchanged, plus a new valid row: fine.
|
||||
let saved = vec![udp.clone(), tcp(3000, 3000), tcp(8080, 8080)];
|
||||
assert!(validate_aws_port_mappings_update(Some((&stored, false)), &saved, false).is_ok());
|
||||
// A new UDP row, or an edit to one, is refused.
|
||||
let edited = PortMapping { host_port: 5354, ..udp.clone() };
|
||||
let e = validate_aws_port_mappings_update(Some((&stored, false)), &[edited, tcp(3000, 3000)], false);
|
||||
assert!(e.unwrap_err().contains("only TCP"));
|
||||
// A new row taking a stored row's host port is refused.
|
||||
let dup = vec![udp.clone(), tcp(3000, 3000), tcp(3000, 4000)];
|
||||
assert!(validate_aws_port_mappings_update(Some((&stored, false)), &dup, false)
|
||||
.unwrap_err()
|
||||
.contains("mapped twice"));
|
||||
// Newly on AWS: everything is checked.
|
||||
assert!(validate_aws_port_mappings_update(None, &stored, false).is_err());
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn overlapping_opens_converge_on_the_last_stored_set_without_false_errors() {
|
||||
// The editor saves on every blur; each save opens. Each open re-reads
|
||||
// the stored mappings under the project's lock, so overlapping opens
|
||||
// neither fight over a host port nor leave an older save's set behind.
|
||||
let p = pid("concurrent");
|
||||
let (target, _, _) = connected_agent(&p).await;
|
||||
let (a, b, c) = (free_port(), free_port(), free_port());
|
||||
let sets = [
|
||||
vec![tcp(a, 8080), tcp(b, 8081)],
|
||||
vec![tcp(b, 8081), tcp(c, 8082)],
|
||||
vec![tcp(a, 8085), tcp(c, 8082)],
|
||||
vec![tcp(b, 8090), tcp(c, 8082)],
|
||||
];
|
||||
let stored = Arc::new(std::sync::Mutex::new(sets[0].clone()));
|
||||
let go = Arc::new(tokio::sync::Barrier::new(8));
|
||||
let mut opens = Vec::new();
|
||||
for i in 0..8 {
|
||||
let (p2, t2, s2, go2) = (p.clone(), target.clone(), stored.clone(), go.clone());
|
||||
let mine = sets[i % sets.len()].clone();
|
||||
opens.push(tokio::spawn(async move {
|
||||
go2.wait().await;
|
||||
open_latest(&p2, &t2, None, move || {
|
||||
let mut s = s2.lock().unwrap();
|
||||
*s = mine; // this save lands, then its open reads the store
|
||||
Some((s.clone(), false))
|
||||
})
|
||||
.await
|
||||
}));
|
||||
}
|
||||
for o in opens {
|
||||
let results = o.await.unwrap();
|
||||
assert!(results.iter().all(|r| r.error.is_none()), "{results:?}");
|
||||
}
|
||||
let last = stored.lock().unwrap().clone();
|
||||
let mut want: Vec<u16> = last.iter().map(|m| m.host_port).collect();
|
||||
want.sort_unstable();
|
||||
assert_eq!(open_ports(&p), want, "the registry holds the last stored set");
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_save_keeps_unchanged_forwards_and_their_live_connections() {
|
||||
let p = pid("diff");
|
||||
let (target, fake, _) = connected_agent(&p).await;
|
||||
let (a, b) = (free_port(), free_port());
|
||||
open_for(&p, &target, &[tcp(a, 8080)]).await;
|
||||
let mut client = TcpStream::connect(("127.0.0.1", a)).await.unwrap();
|
||||
client.write_all(b"one").await.unwrap();
|
||||
let mut buf = [0u8; 3];
|
||||
client.read_exact(&mut buf).await.unwrap();
|
||||
|
||||
let r = open_for(&p, &target, &[tcp(a, 8080), tcp(b, 8081)]).await;
|
||||
assert!(r.iter().all(|r| r.error.is_none()), "{r:?}");
|
||||
// The same connection still carries bytes: its forward was kept.
|
||||
client.write_all(b"two").await.unwrap();
|
||||
client.read_exact(&mut buf).await.unwrap();
|
||||
assert_eq!(&buf, b"two");
|
||||
assert_eq!(fake.cmds.lock().unwrap().len(), 1, "no new attach for the kept connection");
|
||||
|
||||
// A changed container port rebinds the same host port.
|
||||
let r = open_for(&p, &target, &[tcp(a, 9090)]).await;
|
||||
assert!(r[0].error.is_none(), "{:?}", r[0].error);
|
||||
assert_eq!(round_trip(a, b"x").await, b"x");
|
||||
assert_eq!(fake.cmds.lock().unwrap().last().unwrap(), &crate::auth_bridge::tunnel::mapping_command(9090));
|
||||
assert!(port_is_free(b));
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_stored_project_is_read_when_the_open_runs() {
|
||||
let p = pid("store");
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let mut project = crate::models::Project::new("x".into(), vec![]);
|
||||
project.id = p.clone();
|
||||
project.host_id = Some("h1".into());
|
||||
project.aws_placement =
|
||||
Some(crate::models::AwsPlacement { region: "us-west-2".into(), environment: "dev".into() });
|
||||
project.aws = Some(Default::default());
|
||||
let (port, busy) = (free_port(), std::net::TcpListener::bind("127.0.0.1:0").unwrap());
|
||||
let busy_port = busy.local_addr().unwrap().port();
|
||||
project.port_mappings = vec![tcp(port, 8080), tcp(busy_port, 8081)];
|
||||
let store = ProjectsStore::over_file_for_test(dir.path().join("projects.json"), vec![project]);
|
||||
assert_eq!(open_for_project(&store, &p, None).await, None, "not connected: nothing, no warning");
|
||||
let (_target, _, _) = connected_agent(&p).await;
|
||||
let warning = open_for_project(&store, &p, None).await.expect("the busy port is reported");
|
||||
assert!(warning.contains(&busy_port.to_string()) && warning.contains("already in use"), "{warning}");
|
||||
assert_eq!(open_ports(&p), vec![port]);
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_auth_bridges_forward_still_waits_for_a_client_to_speak() {
|
||||
// The generalised `PortForward::bind` keeps the bridge's gate: a silent
|
||||
// client costs no attach (contrast `a_server_speaks_first_protocol_…`).
|
||||
let p = pid("bridge");
|
||||
let (target, fake, _) = connected_agent(&p).await;
|
||||
let port = free_port();
|
||||
let mut fwd = PortForward::bind(target, port, port, crate::auth_bridge::proc_net::PortFamily::V4).await.unwrap();
|
||||
assert_eq!((fwd.port, fwd.container_port), (port, port));
|
||||
let _client = TcpStream::connect(("127.0.0.1", port)).await.unwrap();
|
||||
tokio::time::sleep(std::time::Duration::from_millis(300)).await;
|
||||
assert_eq!(fake.requests.load(Ordering::SeqCst), 0);
|
||||
fwd.shutdown().await;
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
fn aws_project_in_store(p: &str, status: crate::models::ProjectStatus, mappings: Vec<PortMapping>) -> (tempfile::TempDir, ProjectsStore) {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let mut project = crate::models::Project::new("x".into(), vec![]);
|
||||
project.id = p.to_string();
|
||||
project.host_id = Some("h1".into());
|
||||
project.aws_placement =
|
||||
Some(crate::models::AwsPlacement { region: "us-west-2".into(), environment: "dev".into() });
|
||||
project.aws = Some(Default::default());
|
||||
project.status = status;
|
||||
project.port_mappings = mappings;
|
||||
let store = ProjectsStore::over_file_for_test(dir.path().join("projects.json"), vec![project]);
|
||||
(dir, store)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_running_project_whose_mappings_cannot_open_is_never_silent() {
|
||||
use crate::models::ProjectStatus;
|
||||
let p = pid("silent");
|
||||
// Stopped (a save while stopped): nothing to open, nothing to say.
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Stopped, vec![tcp(free_port(), 8080)]);
|
||||
assert_eq!(open_for_project(&store, &p, None).await, None);
|
||||
// Running with no tunnel: the mappings should be open and are not.
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Running, vec![tcp(free_port(), 8080)]);
|
||||
let w = open_for_project(&store, &p, None).await.expect("a warning");
|
||||
assert!(w.contains("not connected"), "{w}");
|
||||
// Only incomplete rows: nothing to say.
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Running, vec![tcp(0, 8080)]);
|
||||
assert_eq!(open_for_project(&store, &p, None).await, None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_connect_warns_about_an_incomplete_row_and_opens_the_rest() {
|
||||
use crate::models::ProjectStatus;
|
||||
// The reported case: an older editor stored a new row as 0 → 0. The
|
||||
// connect used to skip it in silence.
|
||||
let p = pid("incomplete");
|
||||
let port = free_port();
|
||||
let (_d, store) =
|
||||
aws_project_in_store(&p, ProjectStatus::Stopped, vec![tcp(0, 0), tcp(port, 8080), tcp(9000, 0)]);
|
||||
let (_target, _fake, _) = connected_agent(&p).await;
|
||||
store.update_status(&p, ProjectStatus::Running).unwrap();
|
||||
let w = open_for_project(&store, &p, None).await.expect("a ports warning");
|
||||
assert_eq!(
|
||||
w,
|
||||
"? → ?: incomplete, both ports are needed\n9000 → ?: incomplete, both ports are needed"
|
||||
);
|
||||
assert_eq!(open_ports(&p), vec![port]);
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_start_opens_a_listener_for_a_mapping_saved_before_it() {
|
||||
use crate::models::ProjectStatus;
|
||||
// The reported case: 8080 → 8080 saved while stopped, then a start
|
||||
// registers the tunnel, sets Running and opens the mappings.
|
||||
let p = pid("start");
|
||||
let port = free_port();
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Stopped, vec![tcp(port, 8080)]);
|
||||
let (_target, fake, _) = connected_agent(&p).await;
|
||||
store.update_status(&p, ProjectStatus::Running).unwrap();
|
||||
assert_eq!(open_for_project(&store, &p, None).await, None);
|
||||
assert_eq!(open_ports(&p), vec![port]);
|
||||
assert_eq!(round_trip(port, b"ping").await, b"ping");
|
||||
// Over IPv6 loopback too (`localhost` may resolve to ::1 first).
|
||||
if let Ok(mut c) = TcpStream::connect(("::1", port)).await {
|
||||
c.write_all(b"six").await.unwrap();
|
||||
let mut buf = [0u8; 3];
|
||||
c.read_exact(&mut buf).await.unwrap();
|
||||
assert_eq!(&buf, b"six");
|
||||
}
|
||||
assert_eq!(fake.cmds.lock().unwrap()[0], crate::auth_bridge::tunnel::mapping_command(8080));
|
||||
tunnels::close(&p).await;
|
||||
assert!(port_is_free(port));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn nothing_listening_in_the_workspace_is_reported_once_per_mapping() {
|
||||
use crate::models::ProjectStatus;
|
||||
let p = pid("refused");
|
||||
let port = free_port();
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Running, vec![tcp(port, 8080)]);
|
||||
let (_target, fake, _) = connected_agent(&p).await;
|
||||
fake.refuse.store(true, Ordering::SeqCst);
|
||||
let seen = Arc::new(std::sync::Mutex::new(Vec::<String>::new()));
|
||||
let s2 = seen.clone();
|
||||
let warn: PortsWarn = Arc::new(move |d| s2.lock().unwrap().push(d));
|
||||
assert_eq!(open_for_project(&store, &p, Some(warn)).await, None);
|
||||
for _ in 0..3 {
|
||||
let mut c = TcpStream::connect(("127.0.0.1", port)).await.unwrap();
|
||||
let mut buf = Vec::new();
|
||||
let _ = tokio::time::timeout(std::time::Duration::from_secs(5), c.read_to_end(&mut buf)).await;
|
||||
}
|
||||
let seen = seen.lock().unwrap().clone();
|
||||
assert_eq!(seen, vec![nothing_listening(port, 8080)]);
|
||||
assert!(seen[0].contains("nothing is listening on port 8080 in the workspace (127.0.0.1 or ::1)"));
|
||||
tunnels::close(&p).await;
|
||||
}
|
||||
|
||||
/// The reported case end to end against a **real** agent in a real
|
||||
/// container (no SSM; the tunnel is registered by hand): a mapping saved
|
||||
/// before the start, a Python server on `0.0.0.0:8080` (the user's), one on
|
||||
/// `[::1]` only, and a port nothing listens on. Needs Docker and an image
|
||||
/// whose entrypoint starts the agent (`TRIPLEC_AGENT_E2E_IMAGE`, default
|
||||
/// `ghcr.io/shadowdao/triple-c-sandbox:edge`).
|
||||
#[tokio::test]
|
||||
#[ignore = "needs a Docker daemon and an image whose entrypoint starts triple-c-agent"]
|
||||
async fn live_a_mapping_reaches_v4_and_v6_servers_in_a_real_workspace() {
|
||||
use crate::models::ProjectStatus;
|
||||
use std::process::Command;
|
||||
use std::time::Duration;
|
||||
let docker = |args: &[&str]| -> String {
|
||||
let out = Command::new("docker").args(args).output().expect("docker cli");
|
||||
assert!(out.status.success(), "docker {args:?}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
String::from_utf8_lossy(&out.stdout).trim().to_string()
|
||||
};
|
||||
let image = std::env::var("TRIPLEC_AGENT_E2E_IMAGE")
|
||||
.unwrap_or_else(|_| "ghcr.io/shadowdao/triple-c-sandbox:edge".into());
|
||||
let token = format!("{}{}", uuid::Uuid::new_v4().simple(), uuid::Uuid::new_v4().simple());
|
||||
let name = format!("tc-ports-e2e-{}", uuid::Uuid::new_v4().simple());
|
||||
docker(&[
|
||||
"run", "-d", "--name", &name, "-w", "/workspace",
|
||||
"-e", &format!("TRIPLEC_AGENT_TOKEN={token}"),
|
||||
"-e", "TRIPLEC_AGENT_ADDR=0.0.0.0:47900",
|
||||
"-p", "127.0.0.1::47900",
|
||||
&image,
|
||||
]);
|
||||
let p = pid("live");
|
||||
let outcome = async {
|
||||
let mapped = docker(&["port", &name, "47900/tcp"]);
|
||||
let lport: u16 = mapped.lines().next().and_then(|l| l.rsplit(':').next()).and_then(|x| x.parse().ok()).unwrap();
|
||||
let ip = docker(&["inspect", "-f", "{{range .NetworkSettings.Networks}}{{.IPAddress}} {{end}}", &name]);
|
||||
let mut candidates = vec![AgentEndpoint::loopback(lport, token.clone())];
|
||||
for a in ip.split_whitespace() {
|
||||
candidates.push(AgentEndpoint::new(url::Url::parse(&format!("http://{a}:47900/")).unwrap(), token.clone()).unwrap());
|
||||
}
|
||||
let mut ep = None;
|
||||
'wait: for _ in 0..240 {
|
||||
for c in &candidates {
|
||||
if ContainerTarget::Agent(c.clone()).is_running().await.unwrap_or(false) {
|
||||
ep = Some(c.clone());
|
||||
break 'wait;
|
||||
}
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(500)).await;
|
||||
}
|
||||
let ep = ep.ok_or("agent never answered")?;
|
||||
docker(&["exec", "-d", "-u", "claude", &name, "python3", "-m", "http.server", "8080", "--bind", "0.0.0.0"]);
|
||||
docker(&["exec", "-d", "-u", "claude", &name, "python3", "-m", "http.server", "8081", "--bind", "::1"]);
|
||||
tokio::time::sleep(Duration::from_secs(2)).await;
|
||||
|
||||
let (h80, h81, h82) = (free_port(), free_port(), free_port());
|
||||
let (_d, store) = aws_project_in_store(&p, ProjectStatus::Stopped, vec![tcp(h80, 8080), tcp(h81, 8081), tcp(h82, 8082)]);
|
||||
// The start: tunnel registered, Running, then the open.
|
||||
let mut t = tunnels::tests::fake_tunnel(lport, Arc::new(AtomicUsize::new(0)));
|
||||
t.endpoint = ep;
|
||||
tunnels::register(&p, t);
|
||||
store.update_status(&p, ProjectStatus::Running).unwrap();
|
||||
let seen = Arc::new(std::sync::Mutex::new(Vec::<String>::new()));
|
||||
let s2 = seen.clone();
|
||||
let warn: PortsWarn = Arc::new(move |d| s2.lock().unwrap().push(d));
|
||||
if let Some(w) = open_for_project(&store, &p, Some(warn)).await {
|
||||
return Err(format!("open warned: {w}"));
|
||||
}
|
||||
async fn get(addr: (&str, u16)) -> Result<String, String> {
|
||||
let mut c = TcpStream::connect(addr).await.map_err(|e| format!("{addr:?}: {e}"))?;
|
||||
c.write_all(b"GET / HTTP/1.0\r\nHost: localhost\r\n\r\n").await.map_err(|e| e.to_string())?;
|
||||
let mut buf = Vec::new();
|
||||
tokio::time::timeout(Duration::from_secs(20), c.read_to_end(&mut buf)).await.map_err(|_| "timeout".to_string())?.map_err(|e| e.to_string())?;
|
||||
Ok(String::from_utf8_lossy(&buf).into_owned())
|
||||
}
|
||||
for (port, what) in [(h80, "0.0.0.0:8080"), (h81, "[::1]:8081")] {
|
||||
for host in ["127.0.0.1", "::1"] {
|
||||
let r = get((host, port)).await?;
|
||||
if !r.starts_with("HTTP/1.0 200") {
|
||||
return Err(format!("{what} via {host}:{port}: {r:?}"));
|
||||
}
|
||||
eprintln!("{what} via {host}:{port}: 200");
|
||||
}
|
||||
}
|
||||
let r = get(("127.0.0.1", h82)).await?;
|
||||
if !r.is_empty() {
|
||||
return Err(format!("nothing listens on 8082, yet: {r:?}"));
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(500)).await;
|
||||
let seen = seen.lock().unwrap().clone();
|
||||
if seen != vec![nothing_listening(h82, 8082)] {
|
||||
return Err(format!("warnings: {seen:?}"));
|
||||
}
|
||||
Ok::<(), String>(())
|
||||
}
|
||||
.await;
|
||||
tunnels::close(&p).await;
|
||||
let logs = Command::new("docker").args(["logs", "--tail", "20", &name]).output().map(|o| String::from_utf8_lossy(&o.stdout).into_owned()).unwrap_or_default();
|
||||
let _ = Command::new("docker").args(["rm", "-f", &name]).output();
|
||||
if let Err(e) = outcome {
|
||||
panic!("{e}\n--- container log tail ---\n{logs}");
|
||||
}
|
||||
}
|
||||
@@ -5,17 +5,28 @@
|
||||
|
||||
use futures_util::StreamExt;
|
||||
use std::collections::HashMap;
|
||||
use std::sync::atomic::{AtomicBool, Ordering};
|
||||
use std::sync::Arc;
|
||||
use tokio::io::AsyncWriteExt;
|
||||
use tokio::sync::{mpsc, Mutex};
|
||||
|
||||
use super::{AttachedExec, ContainerTarget};
|
||||
use super::{AttachedExec, ContainerTarget, ExecSpec};
|
||||
|
||||
/// A session's exec: as `claude` in `/workspace` (what `attach_exec` runs),
|
||||
/// with `env` added. Values in `env` are never logged.
|
||||
pub fn session_spec(cmd: Vec<String>, tty: bool, env: Vec<String>) -> ExecSpec {
|
||||
ExecSpec::new(cmd).tty(tty).env(env)
|
||||
}
|
||||
|
||||
pub struct ExecSession {
|
||||
pub exec_id: String,
|
||||
pub target: ContainerTarget,
|
||||
pub input_tx: mpsc::UnboundedSender<Vec<u8>>,
|
||||
shutdown_tx: mpsc::Sender<()>,
|
||||
/// Set when a new exec took this session id over (a persistent AWS
|
||||
/// terminal re-attached): this one then ends without its exit callback,
|
||||
/// so the tab is not told its session ended.
|
||||
superseded: Arc<AtomicBool>,
|
||||
}
|
||||
|
||||
impl ExecSession {
|
||||
@@ -46,18 +57,22 @@ impl ExecSessionManager {
|
||||
}
|
||||
}
|
||||
|
||||
/// A terminal: a tty exec of `cmd` with `env` added to the container's
|
||||
/// environment (an AWS copy-at-connect project's credentials,
|
||||
/// `aws_host::terminal_env`; empty otherwise).
|
||||
pub async fn create_session<F>(
|
||||
&self,
|
||||
target: &ContainerTarget,
|
||||
session_id: &str,
|
||||
cmd: Vec<String>,
|
||||
env: Vec<String>,
|
||||
on_output: F,
|
||||
on_exit: Box<dyn FnOnce() + Send>,
|
||||
) -> Result<(), String>
|
||||
where
|
||||
F: Fn(Vec<u8>) + Send + 'static,
|
||||
{
|
||||
self.create_session_with_tty(target, session_id, cmd, true, on_output, on_exit)
|
||||
self.create_session_spec(target, session_id, session_spec(cmd, true, env), on_output, on_exit)
|
||||
.await
|
||||
}
|
||||
|
||||
@@ -70,6 +85,21 @@ impl ExecSessionManager {
|
||||
on_output: F,
|
||||
on_exit: Box<dyn FnOnce() + Send>,
|
||||
) -> Result<(), String>
|
||||
where
|
||||
F: Fn(Vec<u8>) + Send + 'static,
|
||||
{
|
||||
self.create_session_spec(target, session_id, session_spec(cmd, tty, Vec::new()), on_output, on_exit)
|
||||
.await
|
||||
}
|
||||
|
||||
async fn create_session_spec<F>(
|
||||
&self,
|
||||
target: &ContainerTarget,
|
||||
session_id: &str,
|
||||
spec: ExecSpec,
|
||||
on_output: F,
|
||||
on_exit: Box<dyn FnOnce() + Send>,
|
||||
) -> Result<(), String>
|
||||
where
|
||||
F: Fn(Vec<u8>) + Send + 'static,
|
||||
{
|
||||
@@ -77,10 +107,12 @@ impl ExecSessionManager {
|
||||
exec_id,
|
||||
mut output,
|
||||
mut input,
|
||||
} = target.attach_exec(cmd, tty).await?;
|
||||
} = target.attach(spec).await?;
|
||||
|
||||
let (input_tx, mut input_rx) = mpsc::unbounded_channel::<Vec<u8>>();
|
||||
let (shutdown_tx, mut shutdown_rx) = mpsc::channel::<()>(1);
|
||||
let superseded = Arc::new(AtomicBool::new(false));
|
||||
let superseded_reader = superseded.clone();
|
||||
|
||||
// Output reader task
|
||||
let session_id_clone = session_id.to_string();
|
||||
@@ -109,7 +141,9 @@ impl ExecSessionManager {
|
||||
}
|
||||
}
|
||||
}
|
||||
on_exit();
|
||||
if !superseded_reader.load(Ordering::SeqCst) {
|
||||
on_exit();
|
||||
}
|
||||
let _ = shutdown_tx_clone;
|
||||
});
|
||||
|
||||
@@ -128,12 +162,18 @@ impl ExecSessionManager {
|
||||
target: target.clone(),
|
||||
input_tx,
|
||||
shutdown_tx,
|
||||
superseded,
|
||||
};
|
||||
|
||||
self.sessions
|
||||
let old = self
|
||||
.sessions
|
||||
.lock()
|
||||
.await
|
||||
.insert(session_id.to_string(), session);
|
||||
if let Some(old) = old {
|
||||
old.superseded.store(true, Ordering::SeqCst);
|
||||
old.shutdown();
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -198,27 +198,48 @@ fn sdk_error(e: &(dyn std::error::Error + 'static)) -> String {
|
||||
|
||||
// ── The plugin ───────────────────────────────────────────────────────────────
|
||||
|
||||
/// Find `session-manager-plugin`: `TRIPLEC_SSM_PLUGIN` if set, then `PATH`,
|
||||
/// then where AWS's installers put it (the GUI app on macOS does not get the
|
||||
/// shell's `PATH`, so the install locations are not optional).
|
||||
/// The plugin's file name on this platform: what the bundle holds (Tauri strips the
|
||||
/// `-<target-triple>` suffix of `bundle.externalBin` when it copies the sidecar in) and what
|
||||
/// AWS's installers put on `PATH`.
|
||||
const PLUGIN_FILE: &str =
|
||||
if cfg!(windows) { "session-manager-plugin.exe" } else { "session-manager-plugin" };
|
||||
|
||||
const PLUGIN_INSTALL_HINT: &str = "The AWS Session Manager plugin (session-manager-plugin) is \
|
||||
not installed. It is what connects to a workspace on AWS; install it from \
|
||||
https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html";
|
||||
|
||||
/// Find `session-manager-plugin`, in this order:
|
||||
///
|
||||
/// 1. `TRIPLEC_SSM_PLUGIN`, if set (an error if it names no file — an explicit choice is never
|
||||
/// silently replaced by another plugin);
|
||||
/// 2. **the copy bundled with the app** (`bundle.externalBin`), beside the app's own
|
||||
/// executable: `usr/bin` in the AppImage, `Contents/MacOS` in the macOS bundle, the install
|
||||
/// directory on Windows (and `target/<profile>` under `tauri dev`, where tauri-build copies
|
||||
/// it). A debug build's placeholder (`sidecar_placeholder`) is skipped;
|
||||
/// 3. `PATH`;
|
||||
/// 4. where AWS's installers put it (the GUI app on macOS does not get the shell's `PATH`, so
|
||||
/// the install locations are not optional).
|
||||
///
|
||||
/// 3 and 4 remain for dev builds without a fetched sidecar.
|
||||
pub fn find_plugin() -> Result<PathBuf, String> {
|
||||
if let Some(p) = std::env::var_os("TRIPLEC_SSM_PLUGIN").filter(|p| !p.is_empty()) {
|
||||
let p = PathBuf::from(p);
|
||||
return if p.is_file() {
|
||||
Ok(p)
|
||||
} else {
|
||||
Err(format!("TRIPLEC_SSM_PLUGIN names {}, which is not a file", p.display()))
|
||||
};
|
||||
}
|
||||
let name = if cfg!(windows) { "session-manager-plugin.exe" } else { "session-manager-plugin" };
|
||||
let on_path = std::env::var_os("PATH")
|
||||
.map(|paths| std::env::split_paths(&paths).map(|d| d.join(name)).collect::<Vec<_>>())
|
||||
.unwrap_or_default();
|
||||
let installed: Vec<PathBuf> = if cfg!(windows) {
|
||||
let exe_dir = std::env::current_exe()
|
||||
.ok()
|
||||
.and_then(|exe| exe.parent().map(Path::to_path_buf));
|
||||
resolve_plugin(&PluginSearch {
|
||||
override_path: std::env::var_os("TRIPLEC_SSM_PLUGIN"),
|
||||
exe_dir,
|
||||
path_var: std::env::var_os("PATH"),
|
||||
install_dirs: plugin_install_dirs(),
|
||||
})
|
||||
}
|
||||
|
||||
/// Where AWS's installers put the plugin, in the order they are tried.
|
||||
fn plugin_install_dirs() -> Vec<PathBuf> {
|
||||
if cfg!(windows) {
|
||||
["ProgramFiles", "ProgramFiles(x86)"]
|
||||
.iter()
|
||||
.filter_map(|v| std::env::var_os(v))
|
||||
.map(|d| PathBuf::from(d).join(r"Amazon\SessionManagerPlugin\bin").join(name))
|
||||
.map(|d| PathBuf::from(d).join(r"Amazon\SessionManagerPlugin\bin"))
|
||||
.collect()
|
||||
} else {
|
||||
[
|
||||
@@ -228,19 +249,54 @@ pub fn find_plugin() -> Result<PathBuf, String> {
|
||||
"/usr/bin",
|
||||
]
|
||||
.iter()
|
||||
.map(|d| Path::new(d).join(name))
|
||||
.map(PathBuf::from)
|
||||
.collect()
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// Everything [`find_plugin`] reads from the process, so the order is testable.
|
||||
struct PluginSearch {
|
||||
override_path: Option<std::ffi::OsString>,
|
||||
exe_dir: Option<PathBuf>,
|
||||
path_var: Option<std::ffi::OsString>,
|
||||
install_dirs: Vec<PathBuf>,
|
||||
}
|
||||
|
||||
fn resolve_plugin(search: &PluginSearch) -> Result<PathBuf, String> {
|
||||
if let Some(p) = search.override_path.as_ref().filter(|p| !p.is_empty()) {
|
||||
let p = PathBuf::from(p);
|
||||
return if p.is_file() {
|
||||
Ok(p)
|
||||
} else {
|
||||
Err(format!("TRIPLEC_SSM_PLUGIN names {}, which is not a file", p.display()))
|
||||
};
|
||||
}
|
||||
if let Some(bundled) = search.exe_dir.as_ref().map(|d| d.join(PLUGIN_FILE)) {
|
||||
if bundled.is_file() && !is_sidecar_placeholder(&bundled) {
|
||||
return Ok(bundled);
|
||||
}
|
||||
}
|
||||
let on_path = search
|
||||
.path_var
|
||||
.as_ref()
|
||||
.map(|paths| std::env::split_paths(paths).map(|d| d.join(PLUGIN_FILE)).collect::<Vec<_>>())
|
||||
.unwrap_or_default();
|
||||
on_path
|
||||
.into_iter()
|
||||
.chain(installed)
|
||||
.chain(search.install_dirs.iter().map(|d| d.join(PLUGIN_FILE)))
|
||||
.find(|p| p.is_file())
|
||||
.ok_or_else(|| {
|
||||
"The AWS Session Manager plugin (session-manager-plugin) is not installed. It is \
|
||||
what connects to a workspace on AWS; install it from \
|
||||
https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html"
|
||||
.to_string()
|
||||
})
|
||||
.ok_or_else(|| PLUGIN_INSTALL_HINT.to_string())
|
||||
}
|
||||
|
||||
/// Whether `path` is the stand-in a debug build bundles when no real plugin was fetched.
|
||||
/// Unreadable counts as "not a placeholder": the spawn then reports the real error.
|
||||
fn is_sidecar_placeholder(path: &Path) -> bool {
|
||||
use std::io::Read;
|
||||
let mut head = [0u8; crate::sidecar_placeholder::MARKER.len()];
|
||||
std::fs::File::open(path)
|
||||
.and_then(|mut f| f.read_exact(&mut head))
|
||||
.map(|()| crate::sidecar_placeholder::is_placeholder(&head))
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// A running plugin process with a listener on the local port.
|
||||
|
||||
@@ -400,3 +400,135 @@ async fn the_keepalive_asks_for_health_without_a_token() {
|
||||
assert!(req.starts_with("GET /v1/health HTTP/1.1\r\n"), "{req}");
|
||||
assert!(!req.to_ascii_lowercase().contains("authorization"), "{req}");
|
||||
}
|
||||
|
||||
// ── Finding the plugin ───────────────────────────────────────────────────────
|
||||
|
||||
mod plugin_resolution {
|
||||
use super::super::{resolve_plugin, PluginSearch, PLUGIN_FILE, PLUGIN_INSTALL_HINT};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
/// A directory holding a fake plugin (contents are never run).
|
||||
fn dir_with_plugin(root: &Path, name: &str) -> PathBuf {
|
||||
let d = root.join(name);
|
||||
std::fs::create_dir_all(&d).unwrap();
|
||||
std::fs::write(d.join(PLUGIN_FILE), b"\x7fELF fake plugin").unwrap();
|
||||
d
|
||||
}
|
||||
|
||||
fn search(
|
||||
override_path: Option<&Path>,
|
||||
exe_dir: Option<&Path>,
|
||||
path: &[&Path],
|
||||
install: &[&Path],
|
||||
) -> PluginSearch {
|
||||
PluginSearch {
|
||||
override_path: override_path.map(|p| p.as_os_str().to_owned()),
|
||||
exe_dir: exe_dir.map(Path::to_path_buf),
|
||||
path_var: Some(std::env::join_paths(path).unwrap()),
|
||||
install_dirs: install.iter().map(|p| p.to_path_buf()).collect(),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_override_wins_over_everything() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let chosen = t.path().join("my-plugin");
|
||||
std::fs::write(&chosen, b"x").unwrap();
|
||||
let bundled = dir_with_plugin(t.path(), "app");
|
||||
let on_path = dir_with_plugin(t.path(), "path");
|
||||
let s = search(Some(&chosen), Some(&bundled), &[&on_path], &[]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), chosen);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_override_naming_no_file_is_an_error_not_a_fallback() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let bundled = dir_with_plugin(t.path(), "app");
|
||||
let s = search(Some(&t.path().join("missing")), Some(&bundled), &[], &[]);
|
||||
let e = resolve_plugin(&s).unwrap_err();
|
||||
assert!(e.contains("TRIPLEC_SSM_PLUGIN names"), "{e}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_empty_override_is_ignored() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let bundled = dir_with_plugin(t.path(), "app");
|
||||
let mut s = search(None, Some(&bundled), &[], &[]);
|
||||
s.override_path = Some(std::ffi::OsString::new());
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), bundled.join(PLUGIN_FILE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_bundled_sidecar_wins_over_path_and_installs() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let bundled = dir_with_plugin(t.path(), "app");
|
||||
let on_path = dir_with_plugin(t.path(), "path");
|
||||
let installed = dir_with_plugin(t.path(), "installed");
|
||||
let s = search(None, Some(&bundled), &[&on_path], &[&installed]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), bundled.join(PLUGIN_FILE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn without_a_sidecar_path_comes_before_the_install_locations() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let empty_app = t.path().join("app");
|
||||
std::fs::create_dir_all(&empty_app).unwrap();
|
||||
let first = t.path().join("path-first-empty");
|
||||
std::fs::create_dir_all(&first).unwrap();
|
||||
let on_path = dir_with_plugin(t.path(), "path");
|
||||
let installed = dir_with_plugin(t.path(), "installed");
|
||||
let s = search(None, Some(&empty_app), &[&first, &on_path], &[&installed]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), on_path.join(PLUGIN_FILE));
|
||||
|
||||
let s = search(None, Some(&empty_app), &[&first], &[&installed]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), installed.join(PLUGIN_FILE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_debug_placeholder_beside_the_exe_is_skipped() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let app = t.path().join("app");
|
||||
std::fs::create_dir_all(&app).unwrap();
|
||||
std::fs::write(app.join(PLUGIN_FILE), crate::sidecar_placeholder::contents()).unwrap();
|
||||
let on_path = dir_with_plugin(t.path(), "path");
|
||||
let s = search(None, Some(&app), &[&on_path], &[]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), on_path.join(PLUGIN_FILE));
|
||||
|
||||
// And with nothing else installed, the install hint, not the placeholder.
|
||||
let s = search(None, Some(&app), &[], &[]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap_err(), PLUGIN_INSTALL_HINT);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_directory_named_like_the_plugin_is_not_a_plugin() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let app = t.path().join("app");
|
||||
std::fs::create_dir_all(app.join(PLUGIN_FILE)).unwrap();
|
||||
let installed = dir_with_plugin(t.path(), "installed");
|
||||
let s = search(None, Some(&app), &[], &[&installed]);
|
||||
assert_eq!(resolve_plugin(&s).unwrap(), installed.join(PLUGIN_FILE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nothing_anywhere_is_the_install_hint() {
|
||||
let t = tempfile::tempdir().unwrap();
|
||||
let s = search(None, None, &[t.path()], &[t.path()]);
|
||||
let e = resolve_plugin(&s).unwrap_err();
|
||||
assert!(e.contains("is not installed") && e.contains("docs.aws.amazon.com"), "{e}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_bundled_name_is_what_tauri_gives_the_sidecar() {
|
||||
// tauri-build/-bundler strip "-<target-triple>" from bundle.externalBin's
|
||||
// "binaries/session-manager-plugin"; the .exe stays on Windows.
|
||||
let conf: serde_json::Value =
|
||||
serde_json::from_str(include_str!("../../../tauri.conf.json")).unwrap();
|
||||
let bins = conf["bundle"]["externalBin"].as_array().expect("bundle.externalBin");
|
||||
let stems: Vec<&str> = bins
|
||||
.iter()
|
||||
.map(|b| b.as_str().unwrap().rsplit('/').next().unwrap())
|
||||
.collect();
|
||||
let expected = PLUGIN_FILE.trim_end_matches(".exe");
|
||||
assert!(stems.contains(&expected), "{stems:?} has no {expected}");
|
||||
}
|
||||
}
|
||||
@@ -18,6 +18,7 @@ use std::time::Duration;
|
||||
use aws_config::SdkConfig;
|
||||
use futures_util::future::BoxFuture;
|
||||
use tokio::sync::watch;
|
||||
use tokio_util::sync::CancellationToken;
|
||||
|
||||
use super::agent::AgentEndpoint;
|
||||
use crate::aws::tasks::StopKind;
|
||||
@@ -51,6 +52,11 @@ pub struct LiveTunnel {
|
||||
/// Runtime handles for the store (`set_aws_runtime`).
|
||||
pub access_point_id: Option<String>,
|
||||
pub task_definition_arn: String,
|
||||
/// EFS storage's `/workspace` access point.
|
||||
pub workspace_access_point_id: Option<String>,
|
||||
/// The start that opened this tunnel ran the task (rather than
|
||||
/// attaching to one already running, or re-attaching after a restart).
|
||||
pub created: bool,
|
||||
}
|
||||
|
||||
/// Where an endpoint's task is: `(connection, region, cluster, task ARN)`.
|
||||
@@ -68,6 +74,12 @@ struct Registry {
|
||||
/// start's own tunnel) and [`cancel_reattach`]: a background re-attach
|
||||
/// that began under an older generation must never register.
|
||||
generation: HashMap<String, u64>,
|
||||
/// The background clone/setup follower per project (`aws_host::status`),
|
||||
/// with the id [`begin_follow`] gave it. Cancelled by a new follower,
|
||||
/// [`cancel_follow`] (Stop, Remove), and whenever the tunnel is taken
|
||||
/// out or every tunnel closed.
|
||||
followers: HashMap<String, (u64, CancellationToken)>,
|
||||
next_follower: u64,
|
||||
}
|
||||
|
||||
fn registry() -> &'static Mutex<Registry> {
|
||||
@@ -113,6 +125,8 @@ pub fn register(project_id: &str, tunnel: LiveTunnel) -> Option<LiveTunnel> {
|
||||
r.stopped.remove(tunnel.endpoint.base_url.as_str());
|
||||
r.stopped.remove(&unattached_id(project_id));
|
||||
r.pending.remove(project_id);
|
||||
// A port reused by a new tunnel may reach another task's image.
|
||||
super::persistent::forget_probe(tunnel.endpoint.base_url.as_str());
|
||||
r.live.insert(project_id.to_string(), tunnel)
|
||||
};
|
||||
notify();
|
||||
@@ -123,13 +137,15 @@ pub fn get_endpoint(project_id: &str) -> Option<AgentEndpoint> {
|
||||
lock().live.get(project_id).map(|t| t.endpoint.clone())
|
||||
}
|
||||
|
||||
/// `(task ARN, access point id, task definition ARN)` of the project's tunnel.
|
||||
pub fn runtime(project_id: &str) -> Option<(String, Option<String>, String)> {
|
||||
/// `(task ARN, access point id, task definition ARN, workspace access point
|
||||
/// id)` of the project's tunnel.
|
||||
pub fn runtime(project_id: &str) -> Option<(String, Option<String>, String, Option<String>)> {
|
||||
lock().live.get(project_id).map(|t| {
|
||||
(
|
||||
t.task_arn.clone(),
|
||||
t.access_point_id.clone(),
|
||||
t.task_definition_arn.clone(),
|
||||
t.workspace_access_point_id.clone(),
|
||||
)
|
||||
})
|
||||
}
|
||||
@@ -183,6 +199,8 @@ pub fn register_if_current(
|
||||
r.stopped.remove(tunnel.endpoint.base_url.as_str());
|
||||
r.stopped.remove(&unattached_id(project_id));
|
||||
r.pending.remove(project_id);
|
||||
// A port reused by a new tunnel may reach another task's image.
|
||||
super::persistent::forget_probe(tunnel.endpoint.base_url.as_str());
|
||||
r.live.insert(project_id.to_string(), tunnel)
|
||||
};
|
||||
notify();
|
||||
@@ -200,13 +218,67 @@ pub async fn close_if_task(project_id: &str, task_arn: &str) {
|
||||
take(&mut r, project_id)
|
||||
};
|
||||
notify();
|
||||
// The project's port mappings lead into that task: they go with it.
|
||||
super::port_forwards::close(project_id).await;
|
||||
if let Some(t) = taken {
|
||||
t.forward.close().await;
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether the project's registered tunnel came from a start that ran its
|
||||
/// task (see [`LiveTunnel::created`]).
|
||||
pub fn ran_task(project_id: &str) -> bool {
|
||||
lock().live.get(project_id).is_some_and(|t| t.created)
|
||||
}
|
||||
|
||||
/// A later start found the tunnel already up: it ran no task itself.
|
||||
pub fn mark_attached(project_id: &str) {
|
||||
if let Some(t) = lock().live.get_mut(project_id) {
|
||||
t.created = false;
|
||||
}
|
||||
}
|
||||
|
||||
/// Register a background follower for `project_id`, cancelling the one
|
||||
/// before it. Returns its id (for [`end_follow`]) and its token.
|
||||
pub fn begin_follow(project_id: &str) -> (u64, CancellationToken) {
|
||||
let mut r = lock();
|
||||
r.next_follower += 1;
|
||||
let id = r.next_follower;
|
||||
let token = CancellationToken::new();
|
||||
if let Some((_, old)) = r.followers.insert(project_id.to_string(), (id, token.clone())) {
|
||||
old.cancel();
|
||||
}
|
||||
(id, token)
|
||||
}
|
||||
|
||||
/// A follower finished: forget it, unless a newer one has replaced it.
|
||||
pub fn end_follow(project_id: &str, id: u64) {
|
||||
let mut r = lock();
|
||||
if r.followers.get(project_id).is_some_and(|(i, _)| *i == id) {
|
||||
r.followers.remove(project_id);
|
||||
}
|
||||
}
|
||||
|
||||
/// End the project's follower, if one runs (Stop, Remove).
|
||||
pub fn cancel_follow(project_id: &str) {
|
||||
cancel_follow_locked(&mut lock(), project_id);
|
||||
}
|
||||
|
||||
fn cancel_follow_locked(r: &mut Registry, project_id: &str) {
|
||||
if let Some((_, t)) = r.followers.remove(project_id) {
|
||||
t.cancel();
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether a follower runs for the project.
|
||||
#[cfg(test)]
|
||||
pub fn is_following(project_id: &str) -> bool {
|
||||
lock().followers.contains_key(project_id)
|
||||
}
|
||||
|
||||
/// Under the lock: invalidate a re-attach in flight and take the tunnel out.
|
||||
fn take(r: &mut Registry, project_id: &str) -> Option<LiveTunnel> {
|
||||
cancel_follow_locked(r, project_id);
|
||||
r.pending.remove(project_id);
|
||||
*r.generation.entry(project_id.to_string()).or_default() += 1;
|
||||
let t = r.live.remove(project_id);
|
||||
@@ -239,11 +311,12 @@ pub fn end_reattach(project_id: &str, generation: u64) {
|
||||
notify();
|
||||
}
|
||||
|
||||
/// Take the project's tunnel out and close it, and invalidate a background
|
||||
/// re-attach in flight.
|
||||
/// Take the project's tunnel out and close it (and its port mappings'
|
||||
/// forwards), and invalidate a background re-attach in flight.
|
||||
pub async fn close(project_id: &str) {
|
||||
let taken = take(&mut lock(), project_id);
|
||||
notify();
|
||||
super::port_forwards::close(project_id).await;
|
||||
if let Some(t) = taken {
|
||||
t.forward.close().await;
|
||||
}
|
||||
@@ -255,12 +328,16 @@ pub async fn close_all() {
|
||||
let mut r = lock();
|
||||
r.pending.clear();
|
||||
r.stopped.clear();
|
||||
for (_, (_, t)) in r.followers.drain() {
|
||||
t.cancel();
|
||||
}
|
||||
for g in r.generation.values_mut() {
|
||||
*g += 1;
|
||||
}
|
||||
r.live.drain().map(|(_, t)| t).collect()
|
||||
};
|
||||
notify();
|
||||
super::port_forwards::close_all().await;
|
||||
futures_util::future::join_all(all.into_iter().map(|t| t.forward.close())).await;
|
||||
}
|
||||
|
||||
@@ -334,6 +411,8 @@ pub(crate) mod tests {
|
||||
endpoint: AgentEndpoint::loopback(port, "tok"),
|
||||
access_point_id: Some("fsap-1".into()),
|
||||
task_definition_arn: "arn:td:1".into(),
|
||||
workspace_access_point_id: None,
|
||||
created: true,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -359,6 +438,21 @@ pub(crate) mod tests {
|
||||
assert!(get_endpoint(&p).is_none() && task_of(&ep).is_none());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn closing_the_tunnel_ends_its_follower_and_an_attach_clears_created() {
|
||||
let closes = Arc::new(AtomicUsize::new(0));
|
||||
let p = pid("follow");
|
||||
register(&p, fake_tunnel(61009, closes.clone()));
|
||||
assert!(ran_task(&p));
|
||||
mark_attached(&p);
|
||||
assert!(!ran_task(&p));
|
||||
let (_, token) = begin_follow(&p);
|
||||
assert!(is_following(&p) && !token.is_cancelled());
|
||||
close(&p).await;
|
||||
assert!(token.is_cancelled());
|
||||
assert!(!is_following(&p));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn re_registering_hands_back_the_old_tunnel_and_clears_a_stale_stop() {
|
||||
let closes = Arc::new(AtomicUsize::new(0));
|
||||
|
||||
@@ -15,6 +15,7 @@ mod logging;
|
||||
mod marketplace;
|
||||
mod models;
|
||||
mod project_lock;
|
||||
mod sidecar_placeholder;
|
||||
mod storage;
|
||||
pub mod url_open;
|
||||
pub mod web_terminal;
|
||||
@@ -541,6 +542,7 @@ pub fn run() {
|
||||
.invoke_handler(tauri::generate_handler![
|
||||
// Docker
|
||||
commands::docker_commands::check_docker,
|
||||
commands::docker_commands::check_docker_status,
|
||||
commands::docker_commands::check_image_exists,
|
||||
commands::docker_commands::build_image,
|
||||
commands::docker_commands::get_container_info,
|
||||
@@ -553,6 +555,10 @@ pub fn run() {
|
||||
commands::project_commands::stop_project_container,
|
||||
commands::project_commands::check_unsaved_work,
|
||||
commands::project_commands::aws_task_log,
|
||||
commands::project_commands::aws_workspace_status,
|
||||
commands::project_commands::aws_environment_max_hours,
|
||||
commands::project_commands::aws_ec2_capacity,
|
||||
commands::project_commands::ec2_fit_problem,
|
||||
commands::project_commands::remove_aws_resources,
|
||||
commands::project_commands::rebuild_project_container,
|
||||
commands::project_commands::reconcile_project_statuses,
|
||||
@@ -631,6 +637,7 @@ pub fn run() {
|
||||
commands::host_commands::aws_connection_sso_login,
|
||||
commands::host_commands::check_aws_permissions,
|
||||
commands::host_commands::aws_policy_document,
|
||||
commands::host_commands::aws_cost_estimate,
|
||||
commands::environment_commands::detect_aws_environments,
|
||||
commands::environment_commands::deploy_aws_environment,
|
||||
commands::environment_commands::update_aws_environment,
|
||||
@@ -641,6 +648,7 @@ pub fn run() {
|
||||
commands::environment_commands::cancel_aws_deployment,
|
||||
commands::environment_commands::push_aws_saved_state,
|
||||
commands::environment_commands::onboard_aws_user,
|
||||
commands::environment_commands::list_ec2_instance_types,
|
||||
commands::environment_commands::deploy_aws_permissions_boundary,
|
||||
commands::environment_commands::save_aws_admin_bundle,
|
||||
commands::settings_commands::detect_host_timezone,
|
||||
@@ -653,6 +661,9 @@ pub fn run() {
|
||||
commands::terminal_commands::terminal_input,
|
||||
commands::terminal_commands::terminal_resize,
|
||||
commands::terminal_commands::close_terminal_session,
|
||||
commands::terminal_commands::list_workspace_terminals,
|
||||
commands::terminal_commands::reattach_terminal_session,
|
||||
commands::terminal_commands::end_workspace_terminal,
|
||||
commands::terminal_commands::paste_image_to_terminal,
|
||||
commands::terminal_commands::upload_host_file_to_terminal,
|
||||
commands::terminal_commands::start_audio_bridge,
|
||||
|
||||
@@ -7,6 +7,7 @@ pub mod migration;
|
||||
pub mod note;
|
||||
pub mod project;
|
||||
pub mod settings_export;
|
||||
pub mod terminal;
|
||||
pub mod update_info;
|
||||
|
||||
pub use app_settings::*;
|
||||
@@ -17,4 +18,5 @@ pub use migration::*;
|
||||
pub use note::*;
|
||||
pub use project::*;
|
||||
pub use settings_export::*;
|
||||
pub use terminal::*;
|
||||
pub use update_info::*;
|
||||
@@ -486,6 +486,19 @@ pub enum StorageMode {
|
||||
Ephemeral,
|
||||
#[default]
|
||||
Hybrid,
|
||||
/// Hybrid plus `/workspace` on EFS (a second access point).
|
||||
Efs,
|
||||
}
|
||||
|
||||
/// How an AWS project's credentials and files reach the workspace.
|
||||
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum SecretsDelivery {
|
||||
/// In the project's Secrets Manager secret.
|
||||
#[default]
|
||||
SecretsManager,
|
||||
/// Kept out of the secret; the app copies them in after each connect.
|
||||
CopyAtConnect,
|
||||
}
|
||||
|
||||
/// One git repository cloned into the workspace. `branch: None` means the
|
||||
@@ -508,8 +521,20 @@ fn default_aws_ephemeral_gib() -> u32 {
|
||||
21
|
||||
}
|
||||
|
||||
/// Where an AWS workspace's task runs.
|
||||
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum LaunchType {
|
||||
#[default]
|
||||
Fargate,
|
||||
Ec2,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||
pub struct AwsWorkspaceConfig {
|
||||
/// Fargate (default; absent in old JSON) or the user's own EC2 instances.
|
||||
#[serde(default)]
|
||||
pub launch_type: LaunchType,
|
||||
#[serde(default = "default_aws_cpu")]
|
||||
pub cpu: u32,
|
||||
#[serde(default = "default_aws_memory_mib")]
|
||||
@@ -536,11 +561,26 @@ pub struct AwsWorkspaceConfig {
|
||||
pub access_point_id: Option<String>,
|
||||
#[serde(default)]
|
||||
pub task_definition_arn: Option<String>,
|
||||
/// Store-owned like `access_point_id`: the EFS-mode `/workspace` access point.
|
||||
#[serde(default)]
|
||||
pub workspace_access_point_id: Option<String>,
|
||||
#[serde(default)]
|
||||
pub secrets_delivery: SecretsDelivery,
|
||||
/// Run after the clone, as `claude` (AWS only).
|
||||
#[serde(default)]
|
||||
pub setup_script: Option<String>,
|
||||
/// Run the LiteLLM gateway as a sidecar container.
|
||||
#[serde(default)]
|
||||
pub gateway_sidecar: bool,
|
||||
}
|
||||
|
||||
/// Largest setup script, in bytes.
|
||||
pub const MAX_SETUP_SCRIPT_BYTES: usize = 32_768;
|
||||
|
||||
impl Default for AwsWorkspaceConfig {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
launch_type: LaunchType::default(),
|
||||
cpu: default_aws_cpu(),
|
||||
memory_mib: default_aws_memory_mib(),
|
||||
arch: Arch::default(),
|
||||
@@ -553,6 +593,10 @@ impl Default for AwsWorkspaceConfig {
|
||||
task_arn: None,
|
||||
access_point_id: None,
|
||||
task_definition_arn: None,
|
||||
workspace_access_point_id: None,
|
||||
secrets_delivery: SecretsDelivery::default(),
|
||||
setup_script: None,
|
||||
gateway_sidecar: false,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -669,23 +713,179 @@ fn describe_sizes(sizes: &[u32]) -> String {
|
||||
format!("{} to {} MiB in steps of {}", first, last, sizes[1] - sizes[0])
|
||||
}
|
||||
|
||||
pub fn validate_aws_workspace(cfg: &AwsWorkspaceConfig) -> Result<(), String> {
|
||||
let sizes = fargate_memory_sizes(cfg.cpu).ok_or_else(|| {
|
||||
format!(
|
||||
"{} is not a Fargate CPU size (256, 512, 1024, 2048, 4096, 8192 or 16384)",
|
||||
cfg.cpu
|
||||
)
|
||||
})?;
|
||||
if !sizes.contains(&cfg.memory_mib) {
|
||||
return Err(format!(
|
||||
"{} MiB of memory is not valid with {} CPU units: use {}",
|
||||
cfg.memory_mib,
|
||||
cfg.cpu,
|
||||
describe_sizes(&sizes)
|
||||
));
|
||||
/// CPU units and memory (MiB) held back on an EC2 instance for the ECS agent
|
||||
/// and the OS.
|
||||
pub const EC2_RESERVED_CPU_UNITS: u32 = 128;
|
||||
pub const EC2_RESERVED_MEMORY_MIB: u32 = 256;
|
||||
|
||||
/// The instance families the built-in table knows, in the order the app
|
||||
/// lists them; a family ending in `g` is Graviton (ARM).
|
||||
const EC2_FAMILIES: [&str; 8] = ["m7i", "c7i", "r7i", "t3", "m7g", "c7g", "r7g", "t4g"];
|
||||
const EC2_SIZES: [&str; 4] = ["large", "xlarge", "2xlarge", "4xlarge"];
|
||||
|
||||
/// The instance type onboarding offers first (x86; `m7g.large` is its ARM
|
||||
/// counterpart).
|
||||
pub const DEFAULT_EC2_INSTANCE_TYPE: &str = "m7i.large";
|
||||
|
||||
/// One row of the built-in instance table, for the onboarding UI.
|
||||
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
|
||||
pub struct Ec2InstanceType {
|
||||
pub instance_type: String,
|
||||
pub arch: Arch,
|
||||
pub vcpu: u32,
|
||||
pub memory_mib: u32,
|
||||
}
|
||||
|
||||
/// Every type [`ec2_instance_spec`] knows (x86 families first), so the UI's
|
||||
/// list and the app's validation share one table.
|
||||
pub fn ec2_instance_types() -> Vec<Ec2InstanceType> {
|
||||
EC2_FAMILIES
|
||||
.iter()
|
||||
.flat_map(|family| EC2_SIZES.iter().map(move |size| format!("{family}.{size}")))
|
||||
.filter_map(|instance_type| {
|
||||
let (cpu, memory_mib) = ec2_instance_spec(&instance_type)?;
|
||||
let arch = if instance_type.split('.').next()?.ends_with('g') {
|
||||
Arch::Arm64
|
||||
} else {
|
||||
Arch::X86_64
|
||||
};
|
||||
Some(Ec2InstanceType {
|
||||
instance_type,
|
||||
arch,
|
||||
vcpu: cpu / 1024,
|
||||
memory_mib,
|
||||
})
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// `(vcpu * 1024, memory MiB)` of a common EC2 instance type, or None when the
|
||||
/// type is not in the built-in table (m7i, m7g, c7i, c7g, r7i, r7g, t3, t4g).
|
||||
pub fn ec2_instance_spec(instance_type: &str) -> Option<(u32, u32)> {
|
||||
let (family, size) = instance_type.split_once('.')?;
|
||||
let vcpu: u32 = match size {
|
||||
"large" => 2,
|
||||
"xlarge" => 4,
|
||||
"2xlarge" => 8,
|
||||
"4xlarge" => 16,
|
||||
_ => return None,
|
||||
};
|
||||
// GiB per vCPU: general purpose 4, compute 2, memory 8.
|
||||
let gib_per_vcpu: u32 = match family {
|
||||
"m7i" | "m7g" => 4,
|
||||
"c7i" | "c7g" => 2,
|
||||
"r7i" | "r7g" => 8,
|
||||
"t3" | "t4g" => {
|
||||
// Burstable families: memory is 4 GiB per vCPU at xlarge and above,
|
||||
// 8 GiB at large; AWS offers no 4xlarge in these families.
|
||||
return match size {
|
||||
"large" => Some((2048, 8192)),
|
||||
"xlarge" => Some((4096, 16384)),
|
||||
"2xlarge" => Some((8192, 32768)),
|
||||
_ => None,
|
||||
};
|
||||
}
|
||||
_ => return None,
|
||||
};
|
||||
Some((vcpu * 1024, vcpu * gib_per_vcpu * 1024))
|
||||
}
|
||||
|
||||
/// Whether an EC2 workspace's reservations fit an instance type.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(tag = "kind", rename_all = "snake_case")]
|
||||
pub enum Fit {
|
||||
Ok,
|
||||
/// The reservations exceed what the instance leaves for tasks.
|
||||
TooBig { available_cpu: u32, available_memory_mib: u32 },
|
||||
/// The type is not in the table: the caller shows a "must fit" warning.
|
||||
UnknownType,
|
||||
}
|
||||
|
||||
/// Memory (MiB) an instance of `memory_mib` nominal memory keeps from tasks
|
||||
/// in [`fits_instance`]: a tenth of it (what ECS doesn't register, with
|
||||
/// room to spare), and never less than [`EC2_RESERVED_MEMORY_MIB`].
|
||||
pub fn ec2_memory_reserve_mib(memory_mib: u32) -> u32 {
|
||||
(memory_mib / 10).max(EC2_RESERVED_MEMORY_MIB)
|
||||
}
|
||||
|
||||
/// Check an EC2 config's reservations against `instance_type`, less the agent
|
||||
/// and OS reserve. A Fargate config always fits (no instance involved).
|
||||
///
|
||||
/// Nominal sizes only, so memory keeps a margin: ECS registers less memory
|
||||
/// than the instance's nominal (the ECS-optimized AMI and kernel keep some —
|
||||
/// about 7.5 GiB of an 8 GiB type is registered), and a task asking for more
|
||||
/// than the registered amount stays PROVISIONING with nothing able to place
|
||||
/// it. The registered figure can't be read before an instance exists (scale
|
||||
/// to zero), so the reserve is [`ec2_memory_reserve_mib`]: 10 % of the
|
||||
/// nominal memory, at least [`EC2_RESERVED_MEMORY_MIB`].
|
||||
pub fn fits_instance(cfg: &AwsWorkspaceConfig, instance_type: &str) -> Fit {
|
||||
if cfg.launch_type != LaunchType::Ec2 {
|
||||
return Fit::Ok;
|
||||
}
|
||||
if !(21..=200).contains(&cfg.ephemeral_gib) {
|
||||
return Err("Ephemeral storage must be 21 to 200 GiB".into());
|
||||
let Some((available_cpu, available_memory_mib)) = ec2_available(instance_type) else {
|
||||
return Fit::UnknownType;
|
||||
};
|
||||
if cfg.cpu > available_cpu || cfg.memory_mib > available_memory_mib {
|
||||
Fit::TooBig { available_cpu, available_memory_mib }
|
||||
} else {
|
||||
Fit::Ok
|
||||
}
|
||||
}
|
||||
|
||||
/// What `instance_type` leaves for one workspace's reservations, as
|
||||
/// `(CPU units, MiB)`: [`fits_instance`]'s limits (the agent's CPU and the
|
||||
/// memory margin taken off). `None` for a type not in the table.
|
||||
pub fn ec2_available(instance_type: &str) -> Option<(u32, u32)> {
|
||||
let (cpu, mem) = ec2_instance_spec(instance_type)?;
|
||||
Some((cpu - EC2_RESERVED_CPU_UNITS, mem - ec2_memory_reserve_mib(mem)))
|
||||
}
|
||||
|
||||
/// Why `cfg`'s reservations don't fit `instance_type`, or `None` when they
|
||||
/// do (or the type is unknown, or `cfg` is Fargate). The one wording of the
|
||||
/// fit rule: the start's refusal and Host settings both use it.
|
||||
pub fn ec2_fit_problem(cfg: &AwsWorkspaceConfig, instance_type: &str) -> Option<String> {
|
||||
match fits_instance(cfg, instance_type) {
|
||||
Fit::TooBig { available_cpu, available_memory_mib } => Some(format!(
|
||||
"This project reserves {} CPU units and {} MiB of memory, more than your EC2 \
|
||||
instance type {instance_type} has for a workspace ({available_cpu} CPU units, \
|
||||
{available_memory_mib} MiB).",
|
||||
cfg.cpu, cfg.memory_mib
|
||||
)),
|
||||
Fit::Ok | Fit::UnknownType => None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn validate_aws_workspace(cfg: &AwsWorkspaceConfig) -> Result<(), String> {
|
||||
match cfg.launch_type {
|
||||
LaunchType::Fargate => {
|
||||
let sizes = fargate_memory_sizes(cfg.cpu).ok_or_else(|| {
|
||||
format!(
|
||||
"{} is not a Fargate CPU size (256, 512, 1024, 2048, 4096, 8192 or 16384)",
|
||||
cfg.cpu
|
||||
)
|
||||
})?;
|
||||
if !sizes.contains(&cfg.memory_mib) {
|
||||
return Err(format!(
|
||||
"{} MiB of memory is not valid with {} CPU units: use {}",
|
||||
cfg.memory_mib,
|
||||
cfg.cpu,
|
||||
describe_sizes(&sizes)
|
||||
));
|
||||
}
|
||||
if !(21..=200).contains(&cfg.ephemeral_gib) {
|
||||
return Err("Ephemeral storage must be 21 to 200 GiB".into());
|
||||
}
|
||||
}
|
||||
LaunchType::Ec2 => {
|
||||
// Reservations on the user's instance; the instance type is not on
|
||||
// the project, so `fits_instance` does the fit check later.
|
||||
if cfg.cpu == 0 || cfg.memory_mib == 0 {
|
||||
return Err("An EC2 workspace needs a positive CPU and memory reservation".into());
|
||||
}
|
||||
if cfg.spot {
|
||||
return Err("Spot is not available on EC2 yet".into());
|
||||
}
|
||||
}
|
||||
}
|
||||
if let Some(m) = cfg.idle_stop_minutes {
|
||||
if !(5..=1440).contains(&m) {
|
||||
@@ -706,6 +906,21 @@ pub fn validate_aws_workspace(cfg: &AwsWorkspaceConfig) -> Result<(), String> {
|
||||
return Err(format!("Repository folder \"{}\" is used twice", r.folder));
|
||||
}
|
||||
}
|
||||
if let Some(script) = &cfg.setup_script {
|
||||
if script.len() > MAX_SETUP_SCRIPT_BYTES {
|
||||
return Err(format!(
|
||||
"The setup script is {} bytes; the limit is {}",
|
||||
script.len(),
|
||||
MAX_SETUP_SCRIPT_BYTES
|
||||
));
|
||||
}
|
||||
if script.contains('\0') {
|
||||
return Err("The setup script must not contain NUL characters".into());
|
||||
}
|
||||
}
|
||||
if cfg.gateway_sidecar && (cfg.cpu < 1024 || cfg.memory_mib < 2048) {
|
||||
return Err("The LLM gateway sidecar needs at least 1 vCPU (1024) and 2 GiB (2048 MiB)".into());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -1342,6 +1557,44 @@ mod tests {
|
||||
assert!(!off.wip_push_on_stop);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn phase6_fields_default_for_old_json_and_efs_round_trips() {
|
||||
let c: AwsWorkspaceConfig = serde_json::from_str(r#"{"storage":"hybrid","cpu":512}"#).unwrap();
|
||||
assert_eq!(c.secrets_delivery, SecretsDelivery::SecretsManager);
|
||||
assert!(!c.gateway_sidecar && c.setup_script.is_none() && c.workspace_access_point_id.is_none());
|
||||
let e: AwsWorkspaceConfig = serde_json::from_str(r#"{"storage":"efs","secrets_delivery":"copy_at_connect"}"#).unwrap();
|
||||
assert_eq!(e.storage, StorageMode::Efs);
|
||||
assert_eq!(e.secrets_delivery, SecretsDelivery::CopyAtConnect);
|
||||
assert_eq!(serde_json::to_string(&StorageMode::Efs).unwrap(), "\"efs\"");
|
||||
assert_eq!(serde_json::to_string(&SecretsDelivery::CopyAtConnect).unwrap(), "\"copy_at_connect\"");
|
||||
let back: AwsWorkspaceConfig = serde_json::from_str(&serde_json::to_string(&e).unwrap()).unwrap();
|
||||
assert_eq!(back, e);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn setup_script_limits() {
|
||||
let mut c = AwsWorkspaceConfig::default();
|
||||
c.setup_script = Some("a".repeat(MAX_SETUP_SCRIPT_BYTES));
|
||||
assert!(validate_aws_workspace(&c).is_ok());
|
||||
c.setup_script = Some("a".repeat(MAX_SETUP_SCRIPT_BYTES + 1));
|
||||
assert!(validate_aws_workspace(&c).unwrap_err().contains("limit"));
|
||||
c.setup_script = Some("echo\0hi".into());
|
||||
assert!(validate_aws_workspace(&c).unwrap_err().contains("NUL"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn gateway_sidecar_needs_one_vcpu_and_two_gib() {
|
||||
let mut c = cfg(512, 2048);
|
||||
c.gateway_sidecar = true;
|
||||
assert!(validate_aws_workspace(&c).is_err());
|
||||
c = cfg(1024, 2048);
|
||||
c.gateway_sidecar = true;
|
||||
assert!(validate_aws_workspace(&c).is_ok());
|
||||
c = cfg(256, 2048);
|
||||
c.gateway_sidecar = true;
|
||||
assert!(validate_aws_workspace(&c).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn enums_serialize_snake_case_and_is_aws_follows_host_id() {
|
||||
assert_eq!(serde_json::to_string(&Arch::Arm64).unwrap(), "\"arm64\"");
|
||||
@@ -1352,6 +1605,126 @@ mod tests {
|
||||
assert!(p.is_aws());
|
||||
}
|
||||
|
||||
fn ec2(cpu: u32, mem: u32) -> AwsWorkspaceConfig {
|
||||
AwsWorkspaceConfig { launch_type: LaunchType::Ec2, cpu, memory_mib: mem, ..Default::default() }
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn old_json_is_fargate_and_ec2_round_trips() {
|
||||
let c: AwsWorkspaceConfig = serde_json::from_str("{}").unwrap();
|
||||
assert_eq!(c.launch_type, LaunchType::Fargate);
|
||||
let e: AwsWorkspaceConfig = serde_json::from_str(r#"{"launch_type":"ec2"}"#).unwrap();
|
||||
assert_eq!(e.launch_type, LaunchType::Ec2);
|
||||
assert!(serde_json::to_string(&e).unwrap().contains(r#""launch_type":"ec2""#));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ec2_validation_shape() {
|
||||
// Reservations need not be a Fargate pair.
|
||||
assert!(validate_aws_workspace(&ec2(1500, 3000)).is_ok());
|
||||
assert!(validate_aws_workspace(&ec2(0, 3000)).is_err());
|
||||
assert!(validate_aws_workspace(&ec2(1024, 0)).is_err());
|
||||
let mut s = ec2(1024, 2048);
|
||||
s.spot = true;
|
||||
assert!(validate_aws_workspace(&s).unwrap_err().contains("Spot"));
|
||||
// Ephemeral size is ignored on EC2.
|
||||
let mut e = ec2(1024, 2048);
|
||||
e.ephemeral_gib = 5;
|
||||
assert!(validate_aws_workspace(&e).is_ok());
|
||||
// Fargate still rejects the non-pair.
|
||||
assert!(validate_aws_workspace(&cfg(1500, 3000)).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_instance_type_list_is_the_table() {
|
||||
let list = ec2_instance_types();
|
||||
assert_eq!(list.len(), 30);
|
||||
for t in &list {
|
||||
assert_eq!(
|
||||
ec2_instance_spec(&t.instance_type),
|
||||
Some((t.vcpu * 1024, t.memory_mib)),
|
||||
"{}",
|
||||
t.instance_type
|
||||
);
|
||||
}
|
||||
// And the other way: every type the spec table sizes is listed (a
|
||||
// family added to one but not the other fails here).
|
||||
let families = [
|
||||
"m7i", "m7g", "m7a", "m6i", "c7i", "c7g", "c7a", "r7i", "r7g", "r7a", "t3", "t3a",
|
||||
"t4g", "p5", "g6",
|
||||
];
|
||||
for family in families {
|
||||
for size in ["medium", "large", "xlarge", "2xlarge", "4xlarge", "8xlarge", "metal"] {
|
||||
let t = format!("{family}.{size}");
|
||||
if ec2_instance_spec(&t).is_some() {
|
||||
assert!(list.iter().any(|row| row.instance_type == t), "{t} missing");
|
||||
}
|
||||
}
|
||||
}
|
||||
let arch = |name: &str| list.iter().find(|t| t.instance_type == name).unwrap().arch;
|
||||
assert_eq!(arch("m7i.large"), Arch::X86_64);
|
||||
assert_eq!(arch("t3.xlarge"), Arch::X86_64);
|
||||
assert_eq!(arch("m7g.large"), Arch::Arm64);
|
||||
assert_eq!(arch("t4g.2xlarge"), Arch::Arm64);
|
||||
assert!(list.iter().any(|t| t.instance_type == DEFAULT_EC2_INSTANCE_TYPE));
|
||||
assert_eq!(arch(DEFAULT_EC2_INSTANCE_TYPE), Arch::X86_64);
|
||||
let first = &list[0];
|
||||
assert_eq!(
|
||||
serde_json::to_value(first).unwrap(),
|
||||
serde_json::json!({"instance_type": "m7i.large", "arch": "x86_64", "vcpu": 2, "memory_mib": 8192})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn instance_table_values() {
|
||||
assert_eq!(ec2_instance_spec("m7i.large"), Some((2048, 8192)));
|
||||
assert_eq!(ec2_instance_spec("m7g.4xlarge"), Some((16384, 65536)));
|
||||
assert_eq!(ec2_instance_spec("c7i.xlarge"), Some((4096, 8192)));
|
||||
assert_eq!(ec2_instance_spec("r7g.2xlarge"), Some((8192, 65536)));
|
||||
assert_eq!(ec2_instance_spec("t3.large"), Some((2048, 8192)));
|
||||
assert_eq!(ec2_instance_spec("t4g.2xlarge"), Some((8192, 32768)));
|
||||
assert_eq!(ec2_instance_spec("t3.4xlarge"), None);
|
||||
assert_eq!(ec2_instance_spec("p5.48xlarge"), None);
|
||||
assert_eq!(ec2_instance_spec("m7i"), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fit_checks_reserve_for_the_agent() {
|
||||
// m7i.large: 2048 / 8192 less 128 CPU units and 10 % of the memory
|
||||
// (819 MiB: ECS registers less than the nominal 8 GiB).
|
||||
assert_eq!(fits_instance(&ec2(1920, 7373), "m7i.large"), Fit::Ok);
|
||||
assert_eq!(
|
||||
fits_instance(&ec2(1921, 4096), "m7i.large"),
|
||||
Fit::TooBig { available_cpu: 1920, available_memory_mib: 7373 }
|
||||
);
|
||||
assert!(matches!(fits_instance(&ec2(1024, 7374), "m7i.large"), Fit::TooBig { .. }));
|
||||
// The reserve is never under the agent's 256 MiB, and grows with
|
||||
// the instance (r7i.4xlarge: 128 GiB nominal).
|
||||
assert_eq!(ec2_memory_reserve_mib(2048), 256);
|
||||
assert_eq!(ec2_memory_reserve_mib(131072), 13107);
|
||||
assert_eq!(fits_instance(&ec2(1024, 2048), "z9.huge"), Fit::UnknownType);
|
||||
// Fargate configs have no instance to fit.
|
||||
assert_eq!(fits_instance(&cfg(16384, 122880), "m7i.large"), Fit::Ok);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_fit_problem_words_the_fit_rule_once() {
|
||||
assert_eq!(ec2_available("m7i.large"), Some((1920, 7373)));
|
||||
assert_eq!(ec2_available("t4g.large"), Some((1920, 7373)));
|
||||
assert_eq!(ec2_available("z9.huge"), None);
|
||||
assert_eq!(ec2_fit_problem(&ec2(1920, 7373), "m7i.large"), None);
|
||||
assert_eq!(
|
||||
ec2_fit_problem(&ec2(1024, 7374), "m7i.large").as_deref(),
|
||||
Some(
|
||||
"This project reserves 1024 CPU units and 7374 MiB of memory, more than your EC2 \
|
||||
instance type m7i.large has for a workspace (1920 CPU units, 7373 MiB)."
|
||||
)
|
||||
);
|
||||
// Unknown types and Fargate configs: no problem to report here.
|
||||
assert_eq!(ec2_fit_problem(&ec2(99999, 99999), "z9.huge"), None);
|
||||
assert_eq!(ec2_fit_problem(&cfg(16384, 122880), "m7i.large"), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cpu_and_memory_must_be_a_fargate_pair() {
|
||||
// Shared with the frontend's copy (`lib/awsWorkspace.test.ts`).
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
//! IPC shapes of persistent AWS terminals (`host::persistent`); mirrored in
|
||||
//! `lib/types.ts`.
|
||||
|
||||
use serde::Serialize;
|
||||
|
||||
pub use crate::host::persistent::TerminalKind;
|
||||
|
||||
/// What `open_terminal_session` tells the tab it opened.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize)]
|
||||
pub struct OpenedTerminal {
|
||||
/// Runs in tmux in the workspace and outlives the app (AWS only).
|
||||
pub persistent: bool,
|
||||
/// Something to say once (the image has no tmux).
|
||||
pub notice: Option<String>,
|
||||
}
|
||||
|
||||
/// A terminal session running in an AWS workspace.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub struct WorkspaceTerminal {
|
||||
pub session_id: String,
|
||||
pub kind: TerminalKind,
|
||||
/// The app's label for it when it opened it, else the label tmux keeps.
|
||||
pub name: Option<String>,
|
||||
pub created_unix: u64,
|
||||
/// A client (this app, another machine, the web terminal) is attached.
|
||||
pub attached: bool,
|
||||
/// This app opened it and reopens it on connect.
|
||||
pub known: bool,
|
||||
}
|
||||
|
||||
/// What `reattach_terminal_session` did.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "snake_case", tag = "outcome")]
|
||||
pub enum ReattachOutcome {
|
||||
/// Attached again; the tab keeps running.
|
||||
Reattached { kind: TerminalKind, name: Option<String> },
|
||||
/// The session is no longer running in the workspace (it ended, or the
|
||||
/// workspace was replaced); it has been forgotten.
|
||||
Ended,
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
//! The stand-in `build.rs` writes for the bundled `session-manager-plugin` sidecar in a
|
||||
//! **debug** build that has no real one, and how the app recognises it.
|
||||
//!
|
||||
//! `bundle.externalBin` makes tauri-build fail outright when the per-target file is missing,
|
||||
//! for `cargo test`, `cargo check` and `tauri dev` as much as for a release. The real binary
|
||||
//! is built from AWS's pinned source by `scripts/build-ssm-plugin.sh` (`.ps1` on Windows), with
|
||||
//! a downloaded Go toolchain; requiring that for every test run would put a Go build and the
|
||||
//! network on the path of every `cargo test`. So debug builds get this placeholder instead, a
|
||||
//! release build refuses it (`build.rs`), and `host::ssm::find_plugin` skips it and falls back to
|
||||
//! an installed plugin.
|
||||
//!
|
||||
//! Shared by `build.rs` (through `#[path]`) and the app, so the two cannot disagree.
|
||||
|
||||
/// The first bytes of a placeholder. Not an executable format on any platform.
|
||||
pub const MARKER: &[u8] = b"TRIPLE-C SSM PLUGIN PLACEHOLDER";
|
||||
|
||||
/// The whole placeholder file.
|
||||
#[allow(dead_code)] // build.rs only
|
||||
pub fn contents() -> Vec<u8> {
|
||||
let mut v = MARKER.to_vec();
|
||||
v.extend_from_slice(
|
||||
b"\nNot the AWS Session Manager plugin. Debug builds get this when \
|
||||
app/src-tauri/binaries has no real one; run scripts/build-ssm-plugin.sh \
|
||||
(scripts/build-ssm-plugin.ps1 on Windows) to build the real plugin.\n",
|
||||
);
|
||||
v
|
||||
}
|
||||
|
||||
/// Whether `bytes` (the start of a file) is a placeholder.
|
||||
pub fn is_placeholder(bytes: &[u8]) -> bool {
|
||||
bytes.starts_with(MARKER)
|
||||
}
|
||||
@@ -5,6 +5,7 @@ pub mod projects_store;
|
||||
pub mod secure;
|
||||
pub mod settings_crypto;
|
||||
pub mod settings_store;
|
||||
pub mod terminal_store;
|
||||
|
||||
#[allow(unused_imports)]
|
||||
pub use projects_store::*;
|
||||
|
||||
@@ -93,6 +93,46 @@ fn record_corrupt_load(file_path: &Path, now: &chrono::DateTime<chrono::Utc>) {
|
||||
}
|
||||
}
|
||||
|
||||
/// The load's rewrite of stale transient statuses; `true` when it changed
|
||||
/// any.
|
||||
pub(crate) fn settle_stale_statuses(projects: &mut [Project]) -> bool {
|
||||
// Reconcile stale transient statuses: on a cold app start no Docker
|
||||
// operations can be in flight, so Starting/Stopping are always stale.
|
||||
// Running/Error are left as-is and reconciled against Docker later
|
||||
// via the reconcile_project_statuses command.
|
||||
//
|
||||
// An AWS project goes to **Error**, not Stopped: an app that quit
|
||||
// mid-start (or mid-stop) may have left a billed task running, with
|
||||
// or without its ARN recorded yet. Error is what a failed start that
|
||||
// left a task already uses; `reconcile_aws_projects` then asks ECS
|
||||
// (by ARN, else by the project's tags) and settles it Running or
|
||||
// Stopped. Stopped would hide the live task.
|
||||
let mut changed = false;
|
||||
for p in projects.iter_mut() {
|
||||
match p.status {
|
||||
crate::models::ProjectStatus::Starting | crate::models::ProjectStatus::Stopping => {
|
||||
let to = if p.is_aws() {
|
||||
crate::models::ProjectStatus::Error
|
||||
} else {
|
||||
crate::models::ProjectStatus::Stopped
|
||||
};
|
||||
log::warn!(
|
||||
"Reconciling stale '{}' status for project '{}' ({}) → {:?}",
|
||||
serde_json::to_string(&p.status).unwrap_or_default().trim_matches('"'),
|
||||
p.name,
|
||||
p.id,
|
||||
to
|
||||
);
|
||||
p.status = to;
|
||||
p.updated_at = chrono::Utc::now().to_rfc3339();
|
||||
changed = true;
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
changed
|
||||
}
|
||||
|
||||
pub struct ProjectsStore {
|
||||
projects: Mutex<Vec<Project>>,
|
||||
file_path: PathBuf,
|
||||
@@ -155,28 +195,8 @@ impl ProjectsStore {
|
||||
(Vec::new(), false)
|
||||
};
|
||||
|
||||
// Reconcile stale transient statuses: on a cold app start no Docker
|
||||
// operations can be in flight, so Starting/Stopping are always stale.
|
||||
// Running/Error are left as-is and reconciled against Docker later
|
||||
// via the reconcile_project_statuses command.
|
||||
let mut projects = projects;
|
||||
let mut needs_save = needs_save;
|
||||
for p in projects.iter_mut() {
|
||||
match p.status {
|
||||
crate::models::ProjectStatus::Starting | crate::models::ProjectStatus::Stopping => {
|
||||
log::warn!(
|
||||
"Reconciling stale '{}' status for project '{}' ({}) → Stopped",
|
||||
serde_json::to_string(&p.status).unwrap_or_default().trim_matches('"'),
|
||||
p.name,
|
||||
p.id
|
||||
);
|
||||
p.status = crate::models::ProjectStatus::Stopped;
|
||||
p.updated_at = chrono::Utc::now().to_rfc3339();
|
||||
needs_save = true;
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
let needs_save = settle_stale_statuses(&mut projects) || needs_save;
|
||||
|
||||
let store = Self {
|
||||
projects: Mutex::new(projects),
|
||||
@@ -448,6 +468,7 @@ impl ProjectsStore {
|
||||
task_arn: Option<String>,
|
||||
access_point_id: Option<String>,
|
||||
task_definition_arn: Option<String>,
|
||||
workspace_access_point_id: Option<String>,
|
||||
) -> Result<(), String> {
|
||||
let mut projects = self.lock();
|
||||
let p = projects
|
||||
@@ -461,6 +482,7 @@ impl ProjectsStore {
|
||||
aws.task_arn = task_arn;
|
||||
aws.access_point_id = access_point_id;
|
||||
aws.task_definition_arn = task_definition_arn;
|
||||
aws.workspace_access_point_id = workspace_access_point_id;
|
||||
p.updated_at = chrono::Utc::now().to_rfc3339();
|
||||
self.save(&projects)?;
|
||||
Ok(())
|
||||
@@ -885,7 +907,7 @@ mod tests {
|
||||
let store = store_over(&dir, vec![aws, local]);
|
||||
|
||||
store
|
||||
.set_aws_runtime(&aid, Some("t".into()), Some("ap".into()), Some("td".into()))
|
||||
.set_aws_runtime(&aid, Some("t".into()), Some("ap".into()), Some("td".into()), Some("wap".into()))
|
||||
.unwrap();
|
||||
let a = store.get(&aid).unwrap().aws.unwrap();
|
||||
assert_eq!(
|
||||
@@ -896,10 +918,10 @@ mod tests {
|
||||
serde_json::from_str(&fs::read_to_string(dir.join("projects.json")).unwrap()).unwrap();
|
||||
assert_eq!(on_disk[0].aws.as_ref().unwrap().task_arn.as_deref(), Some("t"));
|
||||
|
||||
store.set_aws_runtime(&aid, None, None, None).unwrap();
|
||||
store.set_aws_runtime(&aid, None, None, None, None).unwrap();
|
||||
assert!(store.get(&aid).unwrap().aws.unwrap().task_arn.is_none());
|
||||
assert!(store.set_aws_runtime(&lid, None, None, None).is_err());
|
||||
assert!(store.set_aws_runtime("nope", None, None, None).is_err());
|
||||
assert!(store.set_aws_runtime(&lid, None, None, None, None).is_err());
|
||||
assert!(store.set_aws_runtime("nope", None, None, None, None).is_err());
|
||||
fs::remove_dir_all(&dir).ok();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,302 @@
|
||||
//! Which persistent AWS terminals (`host::persistent`) the app has open, per
|
||||
//! project: `<data_dir>/triple-c/terminal-sessions.json`.
|
||||
//!
|
||||
//! The session id is the tmux key, so this is what lets the app reopen a
|
||||
//! project's tabs — same ids, kinds and labels — after it was closed. It is
|
||||
//! a hint, never the truth: the workspace's own listing decides what is
|
||||
//! running, and an entry it does not list is forgotten (`retain`).
|
||||
//!
|
||||
//! Not a `Project` field, for the reason notes are not: the webview saves
|
||||
//! whole projects, and a tab opening while a Config save is in flight would
|
||||
//! lose one of the two. Same free-function shape as `notes_store`, with
|
||||
//! `_in` variants the tests drive against a temp directory. An unreadable
|
||||
//! file is treated as empty: losing it costs only the automatic reopen (the
|
||||
//! sessions still show in Project Home → Sessions).
|
||||
|
||||
use std::collections::{BTreeMap, HashSet};
|
||||
use std::fs;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::{Mutex, OnceLock};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::host::persistent::{validate_key, TerminalKind};
|
||||
|
||||
const FORMAT_VERSION: u32 = 1;
|
||||
/// More tabs than anyone keeps open: a bound on what a bug could grow.
|
||||
const MAX_PER_PROJECT: usize = 64;
|
||||
|
||||
/// One open persistent terminal.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct PersistedTerminal {
|
||||
/// The tab's session id, which is also the tmux key.
|
||||
pub id: String,
|
||||
pub kind: TerminalKind,
|
||||
/// The label the tab was opened with (a rename lives in
|
||||
/// `Project::renamed_session_names`, keyed by the same id).
|
||||
pub name: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Serialize, Deserialize)]
|
||||
struct File {
|
||||
version: u32,
|
||||
#[serde(default)]
|
||||
projects: BTreeMap<String, Vec<PersistedTerminal>>,
|
||||
/// Tabs closed while the workspace could not be reached: their tmux
|
||||
/// servers still run (a leftover Claude would keep a billed workspace
|
||||
/// up), so they are ended at the next connect.
|
||||
#[serde(default)]
|
||||
pending_end: BTreeMap<String, Vec<String>>,
|
||||
}
|
||||
|
||||
fn lock() -> &'static Mutex<()> {
|
||||
static L: OnceLock<Mutex<()>> = OnceLock::new();
|
||||
L.get_or_init(|| Mutex::new(()))
|
||||
}
|
||||
|
||||
fn data_dir() -> Result<PathBuf, String> {
|
||||
let dir = dirs::data_dir()
|
||||
.ok_or_else(|| "Could not determine data directory".to_string())?
|
||||
.join("triple-c");
|
||||
fs::create_dir_all(&dir).map_err(|e| format!("Failed to create data directory: {e}"))?;
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
fn path_in(dir: &Path) -> PathBuf {
|
||||
dir.join("terminal-sessions.json")
|
||||
}
|
||||
|
||||
fn load_file(dir: &Path) -> File {
|
||||
let path = path_in(dir);
|
||||
let Ok(data) = fs::read_to_string(&path) else {
|
||||
return File::default();
|
||||
};
|
||||
match serde_json::from_str::<File>(&data) {
|
||||
Ok(f) => f,
|
||||
Err(e) => {
|
||||
log::warn!("{} is unreadable ({e}); starting with no remembered terminals", path.display());
|
||||
File::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn save_file(dir: &Path, mut file: File) -> Result<(), String> {
|
||||
file.version = FORMAT_VERSION;
|
||||
file.projects.retain(|_, v| !v.is_empty());
|
||||
file.pending_end.retain(|_, v| !v.is_empty());
|
||||
let path = path_in(dir);
|
||||
let tmp = path.with_extension("json.tmp");
|
||||
let data = serde_json::to_string_pretty(&file).map_err(|e| e.to_string())?;
|
||||
fs::write(&tmp, data).map_err(|e| format!("Failed to write {}: {e}", tmp.display()))?;
|
||||
fs::rename(&tmp, &path).map_err(|e| format!("Failed to commit {}: {e}", path.display()))
|
||||
}
|
||||
|
||||
fn edit_in<T>(dir: &Path, f: impl FnOnce(&mut File) -> T) -> Result<T, String> {
|
||||
let _g = lock().lock().unwrap_or_else(|e| e.into_inner());
|
||||
let mut file = load_file(dir);
|
||||
let out = f(&mut file);
|
||||
save_file(dir, file)?;
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
// ── `_in` variants (tests) ────────────────────────────────────────────────
|
||||
|
||||
pub fn list_in(dir: &Path, project_id: &str) -> Vec<PersistedTerminal> {
|
||||
let _g = lock().lock().unwrap_or_else(|e| e.into_inner());
|
||||
load_file(dir).projects.remove(project_id).unwrap_or_default()
|
||||
}
|
||||
|
||||
pub fn add_in(dir: &Path, project_id: &str, t: PersistedTerminal) -> Result<(), String> {
|
||||
validate_key(&t.id)?;
|
||||
edit_in(dir, |f| {
|
||||
let list = f.projects.entry(project_id.to_string()).or_default();
|
||||
if let Some(existing) = list.iter_mut().find(|e| e.id == t.id) {
|
||||
*existing = t;
|
||||
} else if list.len() < MAX_PER_PROJECT {
|
||||
list.push(t);
|
||||
} else {
|
||||
log::warn!("Project {project_id}: too many remembered terminals; not remembering another");
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Forget `session_id`; returns the project it belonged to.
|
||||
pub fn remove_in(dir: &Path, session_id: &str) -> Result<Option<String>, String> {
|
||||
edit_in(dir, |f| {
|
||||
let mut owner = None;
|
||||
for (pid, list) in f.projects.iter_mut() {
|
||||
let before = list.len();
|
||||
list.retain(|e| e.id != session_id);
|
||||
if list.len() != before {
|
||||
owner = Some(pid.clone());
|
||||
}
|
||||
}
|
||||
owner
|
||||
})
|
||||
}
|
||||
|
||||
/// The project and record of `session_id`, if remembered.
|
||||
pub fn find_in(dir: &Path, session_id: &str) -> Option<(String, PersistedTerminal)> {
|
||||
let _g = lock().lock().unwrap_or_else(|e| e.into_inner());
|
||||
load_file(dir).projects.into_iter().find_map(|(pid, list)| {
|
||||
list.into_iter().find(|e| e.id == session_id).map(|e| (pid, e))
|
||||
})
|
||||
}
|
||||
|
||||
/// Keep only the project's entries the workspace still runs.
|
||||
pub fn retain_in(dir: &Path, project_id: &str, running: &HashSet<String>) -> Result<(), String> {
|
||||
edit_in(dir, |f| {
|
||||
if let Some(list) = f.projects.get_mut(project_id) {
|
||||
list.retain(|e| running.contains(&e.id));
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Forget all of a project's terminals (stopped, removed, moved off AWS):
|
||||
/// remembered and pending-end alike.
|
||||
pub fn clear_in(dir: &Path, project_id: &str) -> Result<(), String> {
|
||||
edit_in(dir, |f| {
|
||||
f.projects.remove(project_id);
|
||||
f.pending_end.remove(project_id);
|
||||
})
|
||||
}
|
||||
|
||||
/// Remember to end `session_id` at the project's next connect.
|
||||
pub fn add_pending_end_in(dir: &Path, project_id: &str, session_id: &str) -> Result<(), String> {
|
||||
validate_key(session_id)?;
|
||||
edit_in(dir, |f| {
|
||||
let list = f.pending_end.entry(project_id.to_string()).or_default();
|
||||
if !list.iter().any(|k| k == session_id) && list.len() < MAX_PER_PROJECT {
|
||||
list.push(session_id.to_string());
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// The project's sessions waiting to be ended.
|
||||
pub fn pending_end_in(dir: &Path, project_id: &str) -> Vec<String> {
|
||||
let _g = lock().lock().unwrap_or_else(|e| e.into_inner());
|
||||
load_file(dir).pending_end.remove(project_id).unwrap_or_default()
|
||||
}
|
||||
|
||||
/// They were ended (or are gone): stop remembering them.
|
||||
pub fn done_pending_end_in(dir: &Path, project_id: &str, ended: &[String]) -> Result<(), String> {
|
||||
edit_in(dir, |f| {
|
||||
if let Some(list) = f.pending_end.get_mut(project_id) {
|
||||
list.retain(|k| !ended.contains(k));
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// ── Public API ────────────────────────────────────────────────────────────
|
||||
|
||||
pub fn list(project_id: &str) -> Vec<PersistedTerminal> {
|
||||
data_dir().map(|d| list_in(&d, project_id)).unwrap_or_default()
|
||||
}
|
||||
|
||||
pub fn add(project_id: &str, t: PersistedTerminal) -> Result<(), String> {
|
||||
add_in(&data_dir()?, project_id, t)
|
||||
}
|
||||
|
||||
pub fn remove(session_id: &str) -> Result<Option<String>, String> {
|
||||
remove_in(&data_dir()?, session_id)
|
||||
}
|
||||
|
||||
pub fn find(session_id: &str) -> Option<(String, PersistedTerminal)> {
|
||||
data_dir().ok().and_then(|d| find_in(&d, session_id))
|
||||
}
|
||||
|
||||
pub fn retain(project_id: &str, running: &HashSet<String>) -> Result<(), String> {
|
||||
retain_in(&data_dir()?, project_id, running)
|
||||
}
|
||||
|
||||
pub fn add_pending_end(project_id: &str, session_id: &str) -> Result<(), String> {
|
||||
add_pending_end_in(&data_dir()?, project_id, session_id)
|
||||
}
|
||||
|
||||
pub fn pending_end(project_id: &str) -> Vec<String> {
|
||||
data_dir().map(|d| pending_end_in(&d, project_id)).unwrap_or_default()
|
||||
}
|
||||
|
||||
pub fn done_pending_end(project_id: &str, ended: &[String]) -> Result<(), String> {
|
||||
done_pending_end_in(&data_dir()?, project_id, ended)
|
||||
}
|
||||
|
||||
/// Best effort: a failure is logged (the next listing prunes anyway).
|
||||
pub fn clear(project_id: &str) {
|
||||
match data_dir().and_then(|d| clear_in(&d, project_id)) {
|
||||
Ok(()) => {}
|
||||
Err(e) => log::warn!("Could not forget project {project_id}'s terminals: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn dir(tag: &str) -> PathBuf {
|
||||
let d = std::env::temp_dir().join(format!("tc-term-store-{tag}-{}", uuid::Uuid::new_v4()));
|
||||
fs::create_dir_all(&d).unwrap();
|
||||
d
|
||||
}
|
||||
|
||||
fn t(id: &str, kind: TerminalKind, name: Option<&str>) -> PersistedTerminal {
|
||||
PersistedTerminal { id: id.into(), kind, name: name.map(str::to_string) }
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terminals_are_remembered_per_project_in_order_and_survive_a_reload() {
|
||||
let d = dir("order");
|
||||
add_in(&d, "p1", t("a-1", TerminalKind::Claude, Some("main"))).unwrap();
|
||||
add_in(&d, "p1", t("b-2", TerminalKind::Bash, None)).unwrap();
|
||||
add_in(&d, "p2", t("c-3", TerminalKind::Bash, None)).unwrap();
|
||||
// Re-adding replaces in place (a reattach records it again).
|
||||
add_in(&d, "p1", t("a-1", TerminalKind::Claude, Some("renamed"))).unwrap();
|
||||
let p1 = list_in(&d, "p1");
|
||||
assert_eq!(p1.iter().map(|e| e.id.as_str()).collect::<Vec<_>>(), ["a-1", "b-2"]);
|
||||
assert_eq!(p1[0].name.as_deref(), Some("renamed"));
|
||||
assert_eq!(find_in(&d, "c-3").unwrap().0, "p2");
|
||||
let raw = fs::read_to_string(path_in(&d)).unwrap();
|
||||
assert!(raw.contains("\"version\": 1") && raw.contains("\"kind\": \"claude\""), "{raw}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn closing_pruning_and_stopping_forget_entries() {
|
||||
let d = dir("forget");
|
||||
for id in ["a", "b", "c"] {
|
||||
add_in(&d, "p", t(id, TerminalKind::Bash, None)).unwrap();
|
||||
}
|
||||
assert_eq!(remove_in(&d, "b").unwrap().as_deref(), Some("p"));
|
||||
assert_eq!(remove_in(&d, "zzz").unwrap(), None);
|
||||
retain_in(&d, "p", &HashSet::from(["c".to_string()])).unwrap();
|
||||
assert_eq!(list_in(&d, "p"), vec![t("c", TerminalKind::Bash, None)]);
|
||||
clear_in(&d, "p").unwrap();
|
||||
assert!(list_in(&d, "p").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_tab_closed_while_disconnected_is_ended_at_the_next_connect() {
|
||||
let d = dir("pending");
|
||||
add_pending_end_in(&d, "p", "a-1").unwrap();
|
||||
add_pending_end_in(&d, "p", "a-1").unwrap();
|
||||
add_pending_end_in(&d, "p", "b-2").unwrap();
|
||||
add_pending_end_in(&d, "q", "c-3").unwrap();
|
||||
assert!(add_pending_end_in(&d, "p", "../x").is_err());
|
||||
assert_eq!(pending_end_in(&d, "p"), ["a-1", "b-2"]);
|
||||
done_pending_end_in(&d, "p", &["a-1".to_string()]).unwrap();
|
||||
assert_eq!(pending_end_in(&d, "p"), ["b-2"]);
|
||||
clear_in(&d, "p").unwrap();
|
||||
assert!(pending_end_in(&d, "p").is_empty());
|
||||
assert_eq!(pending_end_in(&d, "q"), ["c-3"], "per project");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_bad_key_is_refused_and_a_corrupt_file_reads_as_empty() {
|
||||
let d = dir("bad");
|
||||
assert!(add_in(&d, "p", t("../x", TerminalKind::Bash, None)).is_err());
|
||||
fs::write(path_in(&d), "{not json").unwrap();
|
||||
assert!(list_in(&d, "p").is_empty());
|
||||
// …and is replaced by the next write.
|
||||
add_in(&d, "p", t("ok", TerminalKind::Bash, None)).unwrap();
|
||||
assert_eq!(list_in(&d, "p").len(), 1);
|
||||
}
|
||||
}
|
||||
@@ -85,8 +85,9 @@ pub async fn handle_connection(socket: WebSocket, state: Arc<WebTerminalState>)
|
||||
// Channel for sending messages from session output tasks → WS writer
|
||||
let (out_tx, mut out_rx) = mpsc::unbounded_channel::<ServerMessage>();
|
||||
|
||||
// Track session IDs owned by this connection for cleanup
|
||||
let owned_sessions: Arc<tokio::sync::Mutex<Vec<String>>> =
|
||||
// Session ids owned by this connection, with whether each is a
|
||||
// persistent AWS terminal (tmux). A disconnect only detaches those.
|
||||
let owned_sessions: Arc<tokio::sync::Mutex<Vec<(String, bool)>>> =
|
||||
Arc::new(tokio::sync::Mutex::new(Vec::new()));
|
||||
|
||||
// Writer task: serializes ServerMessages and sends as WS text frames
|
||||
@@ -186,20 +187,27 @@ pub async fn handle_connection(socket: WebSocket, state: Arc<WebTerminalState>)
|
||||
}
|
||||
|
||||
ClientMessage::Close { session_id } => {
|
||||
state.exec_manager.close_session(&session_id).await;
|
||||
// Remove from owned list
|
||||
owned_sessions
|
||||
.lock()
|
||||
.await
|
||||
.retain(|id| id != &session_id);
|
||||
// Only a session this connection opened: the id is the tmux
|
||||
// key of a persistent AWS terminal, which a close ends.
|
||||
let owned = {
|
||||
let mut owned = owned_sessions.lock().await;
|
||||
let found = owned.iter().find(|(id, _)| id == &session_id).map(|(_, p)| *p);
|
||||
owned.retain(|(id, _)| id != &session_id);
|
||||
found
|
||||
};
|
||||
if let Some(persistent) = owned {
|
||||
close_owned(&state, &session_id, persistent).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Connection closed — clean up all owned sessions
|
||||
// Connection closed — clean up all owned sessions. A persistent AWS
|
||||
// terminal is only detached, like the desktop app's on exit: it keeps
|
||||
// running and Project Home → Sessions lists it.
|
||||
log::info!("Web terminal WebSocket disconnected, cleaning up sessions");
|
||||
let sessions = owned_sessions.lock().await.clone();
|
||||
for session_id in sessions {
|
||||
for (session_id, _) in sessions {
|
||||
state.exec_manager.close_session(&session_id).await;
|
||||
}
|
||||
|
||||
@@ -278,13 +286,41 @@ fi
|
||||
vec!["bash".to_string(), "-c".to_string(), script]
|
||||
}
|
||||
|
||||
/// A Close from the client: detach, and end a persistent terminal's tmux
|
||||
/// server (closing a tab is what ends one, as in the desktop app).
|
||||
async fn close_owned(state: &WebTerminalState, session_id: &str, persistent: bool) {
|
||||
let target = state.exec_manager.get_target(session_id).await.ok();
|
||||
state.exec_manager.close_session(session_id).await;
|
||||
let Some(target) = target else { return };
|
||||
let Some(key) = tmux_key_of(session_id) else { return };
|
||||
if persistent {
|
||||
if let Err(e) = crate::host::persistent::end(&target, key).await {
|
||||
log::warn!("Web terminal: could not end terminal {session_id}: {e}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The web terminal's exec ids are `web-<tmux key>`, never the bare key: the
|
||||
/// desktop app attaches to a workspace terminal under the bare key in the
|
||||
/// same `ExecSessionManager`, and sharing the id would make either front
|
||||
/// end's attach take over (or its close/disconnect end) the other's exec.
|
||||
const WEB_EXEC_PREFIX: &str = "web-";
|
||||
|
||||
fn web_exec_id(key: &str) -> String {
|
||||
format!("{WEB_EXEC_PREFIX}{key}")
|
||||
}
|
||||
|
||||
fn tmux_key_of(exec_id: &str) -> Option<&str> {
|
||||
exec_id.strip_prefix(WEB_EXEC_PREFIX)
|
||||
}
|
||||
|
||||
/// Open a new terminal session for a project.
|
||||
async fn handle_open(
|
||||
state: &WebTerminalState,
|
||||
project_id: &str,
|
||||
session_type: Option<&str>,
|
||||
out_tx: &mpsc::UnboundedSender<ServerMessage>,
|
||||
owned_sessions: &Arc<tokio::sync::Mutex<Vec<String>>>,
|
||||
owned_sessions: &Arc<tokio::sync::Mutex<Vec<(String, bool)>>>,
|
||||
) -> Result<(), String> {
|
||||
let project = state
|
||||
.projects_store
|
||||
@@ -304,9 +340,37 @@ async fn handle_open(
|
||||
_ => build_terminal_cmd(&project, &state.settings_store),
|
||||
};
|
||||
|
||||
let session_id = uuid::Uuid::new_v4().to_string();
|
||||
// AWS copy-at-connect: the credentials go into this terminal's own
|
||||
// environment (never the agent's). Empty for everything else.
|
||||
let env = crate::host::aws_host::terminal_env(&project, &state.settings_store.get()).await;
|
||||
|
||||
let key = uuid::Uuid::new_v4().to_string();
|
||||
let session_id = web_exec_id(&key);
|
||||
let project_name = project.name.clone();
|
||||
|
||||
// AWS: in its own tmux server, like the desktop app's tabs
|
||||
// (`host::persistent`), so a dropped connection only detaches it. Not
|
||||
// remembered for the desktop app to reopen: it shows in Project Home →
|
||||
// Sessions as a session running in the workspace.
|
||||
let kind = if session_type == Some("bash") {
|
||||
crate::host::persistent::TerminalKind::Bash
|
||||
} else {
|
||||
crate::host::persistent::TerminalKind::Claude
|
||||
};
|
||||
let plan = crate::host::persistent::plan(
|
||||
project.is_aws(),
|
||||
&container,
|
||||
&key,
|
||||
kind,
|
||||
Some("web terminal"),
|
||||
cmd,
|
||||
env,
|
||||
)
|
||||
.await?;
|
||||
if let Some(notice) = plan.notice.clone() {
|
||||
let _ = out_tx.send(ServerMessage::Error { message: notice });
|
||||
}
|
||||
|
||||
// Set up output routing through the WS channel
|
||||
let out_tx_output = out_tx.clone();
|
||||
let session_id_output = session_id.clone();
|
||||
@@ -331,14 +395,15 @@ async fn handle_open(
|
||||
.create_session(
|
||||
&container,
|
||||
&session_id,
|
||||
cmd,
|
||||
plan.cmd,
|
||||
plan.env,
|
||||
on_output,
|
||||
on_exit,
|
||||
)
|
||||
.await?;
|
||||
|
||||
// Track this session for cleanup on disconnect
|
||||
owned_sessions.lock().await.push(session_id.clone());
|
||||
owned_sessions.lock().await.push((session_id.clone(), plan.persistent));
|
||||
|
||||
let _ = out_tx.send(ServerMessage::Opened {
|
||||
session_id,
|
||||
@@ -352,3 +417,22 @@ async fn handle_open(
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
/// A desktop reattach (exec id = the bare key) and the web terminal's own
|
||||
/// exec of the same tmux session never share an `ExecSessionManager` id,
|
||||
/// in either direction, and the web side maps back to the right key.
|
||||
#[test]
|
||||
fn web_and_desktop_execs_of_one_terminal_never_share_an_id() {
|
||||
let key = "0b9c6f7e-1d2a-4c3b-9e8f-7a6b5c4d3e2f";
|
||||
let web = web_exec_id(key);
|
||||
assert_ne!(web, key, "a desktop reattach must not supersede the web exec");
|
||||
assert_eq!(tmux_key_of(&web), Some(key));
|
||||
// A desktop exec id is not one the web side would end or detach.
|
||||
assert_eq!(tmux_key_of(key), None);
|
||||
crate::host::persistent::validate_key(&web).unwrap();
|
||||
}
|
||||
}
|
||||
@@ -36,6 +36,12 @@
|
||||
"icons/icon.icns",
|
||||
"icons/icon.png"
|
||||
],
|
||||
"externalBin": [
|
||||
"binaries/session-manager-plugin"
|
||||
],
|
||||
"resources": {
|
||||
"THIRD_PARTY_NOTICES": "THIRD_PARTY_NOTICES"
|
||||
},
|
||||
"linux": {
|
||||
"appimage": {
|
||||
"bundleMediaFramework": true
|
||||
|
||||
+8
-2
@@ -6,6 +6,7 @@ import TopBar from "./components/layout/TopBar";
|
||||
import StatusBar from "./components/layout/StatusBar";
|
||||
import NotesDock from "./components/layout/NotesDock";
|
||||
import TerminalView from "./components/terminal/TerminalView";
|
||||
import { dockerFailLabel } from "./lib/dockerStatus";
|
||||
import DockerInstallDialog from "./components/DockerInstallDialog";
|
||||
import ProjectHome from "./components/projects/home/ProjectHome";
|
||||
import AddProjectDialog from "./components/projects/AddProjectDialog";
|
||||
@@ -23,6 +24,8 @@ import { useContainerProgress } from "./hooks/useContainerProgress";
|
||||
import { useKeyboardShortcuts } from "./hooks/useKeyboardShortcuts";
|
||||
import { useMarketplaceSyncToasts } from "./hooks/useMarketplace";
|
||||
import { useProjectStatusEvents } from "./hooks/useProjectStatusEvents";
|
||||
import { useWorkspaceWarnings } from "./hooks/useWorkspaceWarnings";
|
||||
import { usePersistentTerminals } from "./hooks/usePersistentTerminals";
|
||||
import MarketplaceView from "./components/marketplace/MarketplaceView";
|
||||
import { useAppState, isHomeTab, tabKeyId, homeTabKey, MARKETPLACE_TAB_KEY } from "./store/appState";
|
||||
import { reconcileAwsProjects, reconcileProjectStatuses } from "./lib/tauri-commands";
|
||||
@@ -77,6 +80,8 @@ export default function App() {
|
||||
useKeyboardShortcuts();
|
||||
useMarketplaceSyncToasts();
|
||||
useProjectStatusEvents();
|
||||
useWorkspaceWarnings();
|
||||
usePersistentTerminals();
|
||||
|
||||
// Initialize on mount
|
||||
useEffect(() => {
|
||||
@@ -211,9 +216,10 @@ export default function App() {
|
||||
* tracks and ends in a real button.
|
||||
*/
|
||||
function WelcomeScreen() {
|
||||
const { dockerAvailable, imageExists, projects, openProjectHome } = useAppState(
|
||||
const { dockerAvailable, dockerStatus, imageExists, projects, openProjectHome } = useAppState(
|
||||
useShallow((s) => ({
|
||||
dockerAvailable: s.dockerAvailable,
|
||||
dockerStatus: s.dockerStatus,
|
||||
imageExists: s.imageExists,
|
||||
projects: s.projects,
|
||||
openProjectHome: s.openProjectHome,
|
||||
@@ -231,7 +237,7 @@ function WelcomeScreen() {
|
||||
label: "Docker detected",
|
||||
state: dockerAvailable,
|
||||
pendingLabel: "Checking for Docker…",
|
||||
failLabel: "Docker not available",
|
||||
failLabel: dockerFailLabel(dockerStatus),
|
||||
},
|
||||
{
|
||||
label: "Container image ready",
|
||||
|
||||
@@ -0,0 +1,91 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { render, screen, act } from "@testing-library/react";
|
||||
import DockerInstallDialog from "./DockerInstallDialog";
|
||||
import { useAppState } from "../store/appState";
|
||||
import type { DockerStatus } from "../lib/types";
|
||||
|
||||
vi.mock("../lib/tauri-commands", () => ({
|
||||
getDockerStatus: vi.fn(),
|
||||
checkImageExists: vi.fn(),
|
||||
buildImage: vi.fn(),
|
||||
pullImage: vi.fn(),
|
||||
openUrlExternal: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("../hooks/useInstallHelper", () => ({
|
||||
useInstallHelper: () => ({
|
||||
options: {
|
||||
os: "linux",
|
||||
product_name: "Docker Engine",
|
||||
can_auto_install: false,
|
||||
auto_install_method: null,
|
||||
auto_install_blocker: "no pkexec",
|
||||
docs_url: "https://docs.docker.com",
|
||||
manual_steps: [],
|
||||
post_install_notes: [],
|
||||
},
|
||||
loadOptions: vi.fn(),
|
||||
runInstall: vi.fn(),
|
||||
}),
|
||||
}));
|
||||
|
||||
const status = (state: DockerStatus["state"], os: DockerStatus["os"] = "linux"): DockerStatus => ({
|
||||
state,
|
||||
endpoint: "unix:///var/run/docker.sock",
|
||||
detail: state === "running" ? null : "connection refused",
|
||||
os,
|
||||
});
|
||||
|
||||
function setStatus(s: DockerStatus) {
|
||||
act(() => useAppState.getState().setDockerStatus(s));
|
||||
}
|
||||
|
||||
describe("DockerInstallDialog", () => {
|
||||
beforeEach(() => {
|
||||
useAppState.setState({ dockerStatus: null, dockerAvailable: null });
|
||||
});
|
||||
|
||||
it("offers install guidance when Docker is not installed", () => {
|
||||
setStatus(status("not_installed"));
|
||||
render(<DockerInstallDialog onClose={vi.fn()} />);
|
||||
expect(screen.getByRole("dialog", { name: "Docker is not installed" })).toBeTruthy();
|
||||
expect(screen.getByText(/AWS projects don't need local Docker/)).toBeTruthy();
|
||||
expect(screen.getByText("unix:///var/run/docker.sock")).toBeTruthy();
|
||||
});
|
||||
|
||||
it("says installed-but-not-running with systemd steps on Linux, and offers no install", () => {
|
||||
setStatus(status("not_running"));
|
||||
render(<DockerInstallDialog onClose={vi.fn()} />);
|
||||
expect(screen.getByRole("dialog", { name: "Docker is installed but not running" })).toBeTruthy();
|
||||
expect(screen.getByText("sudo systemctl start docker")).toBeTruthy();
|
||||
expect(screen.getByText("sudo systemctl reset-failed docker")).toBeTruthy();
|
||||
expect(screen.getByText("journalctl -u docker -b")).toBeTruthy();
|
||||
expect(screen.queryByText(/Install Docker Engine/)).toBeNull();
|
||||
expect(screen.getByText(/AWS projects don't need local Docker/)).toBeTruthy();
|
||||
});
|
||||
|
||||
it("tells macOS/Windows users to start Docker Desktop", () => {
|
||||
setStatus(status("not_running", "macos"));
|
||||
render(<DockerInstallDialog onClose={vi.fn()} />);
|
||||
expect(screen.getByText("Docker Desktop")).toBeTruthy();
|
||||
expect(screen.queryByText("sudo systemctl start docker")).toBeNull();
|
||||
});
|
||||
|
||||
it("explains the docker group on permission denied", () => {
|
||||
setStatus(status("no_permission"));
|
||||
render(<DockerInstallDialog onClose={vi.fn()} />);
|
||||
expect(screen.getByRole("dialog", { name: "Docker is running but not accessible" })).toBeTruthy();
|
||||
expect(screen.getByText("sudo usermod -aG docker $USER")).toBeTruthy();
|
||||
});
|
||||
|
||||
it("updates live and closes itself when Docker becomes available", () => {
|
||||
setStatus(status("not_installed"));
|
||||
const onClose = vi.fn();
|
||||
render(<DockerInstallDialog onClose={onClose} />);
|
||||
setStatus(status("not_running"));
|
||||
expect(screen.getByRole("dialog", { name: "Docker is installed but not running" })).toBeTruthy();
|
||||
expect(onClose).not.toHaveBeenCalled();
|
||||
setStatus(status("running"));
|
||||
expect(onClose).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -1,10 +1,79 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { useInstallHelper } from "../hooks/useInstallHelper";
|
||||
import { openUrlExternal } from "../lib/tauri-commands";
|
||||
import type { DockerStatus } from "../lib/types";
|
||||
import { useDocker } from "../hooks/useDocker";
|
||||
import Modal from "./ui/Modal";
|
||||
import Button from "./ui/Button";
|
||||
|
||||
const AWS_NOTE = "AWS projects don't need local Docker and still work.";
|
||||
|
||||
function Cmd({ children }: { children: string }) {
|
||||
return (
|
||||
<code className="block font-mono text-[var(--text-primary)] bg-[var(--bg-primary)] border border-[var(--border-color)] rounded-[var(--radius-control)] px-2 py-1 my-1 select-all break-all">
|
||||
{children}
|
||||
</code>
|
||||
);
|
||||
}
|
||||
|
||||
/** Guidance for a Docker that is installed but not answering. */
|
||||
function NotRunningHelp({ status }: { status: DockerStatus }) {
|
||||
if (status.os === "linux") {
|
||||
return (
|
||||
<div className="text-xs text-[var(--text-secondary)] space-y-2">
|
||||
<p>Start the daemon:</p>
|
||||
<Cmd>sudo systemctl start docker</Cmd>
|
||||
<p>
|
||||
If systemd gave up restarting it (<span className="font-mono">start-limit-hit</span>),
|
||||
clear that first, then start it again:
|
||||
</p>
|
||||
<Cmd>sudo systemctl reset-failed docker</Cmd>
|
||||
<p>To see why it stopped:</p>
|
||||
<Cmd>systemctl status docker</Cmd>
|
||||
<Cmd>journalctl -u docker -b</Cmd>
|
||||
<p>
|
||||
To start it at every boot, use{" "}
|
||||
<span className="font-mono">sudo systemctl enable --now docker</span>. Rootless Docker
|
||||
runs as your user instead: <span className="font-mono">systemctl --user start docker</span>.
|
||||
</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
return (
|
||||
<div className="text-xs text-[var(--text-secondary)] space-y-2">
|
||||
<p>
|
||||
Start <span className="text-[var(--text-primary)]">Docker Desktop</span> and wait until it
|
||||
says the engine is running — the first start can take a minute. This dialog closes on its
|
||||
own once Docker answers.
|
||||
</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function NoPermissionHelp({ status }: { status: DockerStatus }) {
|
||||
if (status.os === "linux") {
|
||||
return (
|
||||
<div className="text-xs text-[var(--text-secondary)] space-y-2">
|
||||
<p>
|
||||
Your user is not in the <span className="font-mono">docker</span> group, so the socket
|
||||
refuses the connection. Add yourself:
|
||||
</p>
|
||||
<Cmd>sudo usermod -aG docker $USER</Cmd>
|
||||
<p>Then log out and back in (or reboot) so the new group applies, and reopen Triple-C.</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
return (
|
||||
<div className="text-xs text-[var(--text-secondary)] space-y-2">
|
||||
<p>
|
||||
The Docker endpoint refused access. Make sure Docker Desktop is running for your user
|
||||
{status.os === "windows" ? " and that your account is in the docker-users group" : ""}, then
|
||||
re-check.
|
||||
</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
interface Props {
|
||||
onClose: () => void;
|
||||
}
|
||||
@@ -13,7 +82,7 @@ type Phase = "idle" | "installing" | "done" | "error";
|
||||
|
||||
export default function DockerInstallDialog({ onClose }: Props) {
|
||||
const { options, loadOptions, runInstall } = useInstallHelper();
|
||||
const { checkDocker } = useDocker();
|
||||
const { checkDocker, dockerStatus } = useDocker();
|
||||
const [showManual, setShowManual] = useState(false);
|
||||
const [phase, setPhase] = useState<Phase>("idle");
|
||||
const [log, setLog] = useState<string[]>([]);
|
||||
@@ -23,6 +92,13 @@ export default function DockerInstallDialog({ onClose }: Props) {
|
||||
loadOptions();
|
||||
}, [loadOptions]);
|
||||
|
||||
// Docker came up while the dialog was open (polling keeps `dockerStatus`
|
||||
// current): nothing left to say. Not mid-install, whose notes still matter.
|
||||
const running = dockerStatus?.state === "running";
|
||||
useEffect(() => {
|
||||
if (running && (phase === "idle" || phase === "error")) onClose();
|
||||
}, [running, phase, onClose]);
|
||||
|
||||
const handleInstall = async () => {
|
||||
setPhase("installing");
|
||||
setLog([]);
|
||||
@@ -52,6 +128,50 @@ export default function DockerInstallDialog({ onClose }: Props) {
|
||||
if (available) onClose();
|
||||
};
|
||||
|
||||
const state = dockerStatus?.state ?? "not_installed";
|
||||
const endpointLine = dockerStatus && (
|
||||
<p className="text-[11px] text-[var(--text-secondary)] mt-3 break-all">
|
||||
Tried <span className="font-mono">{dockerStatus.endpoint}</span>
|
||||
{dockerStatus.detail ? <> — {dockerStatus.detail}</> : null}
|
||||
</p>
|
||||
);
|
||||
const awsLine = (
|
||||
<p className="text-[11px] text-[var(--text-secondary)] mt-2">{AWS_NOTE}</p>
|
||||
);
|
||||
|
||||
if (dockerStatus && (state === "not_running" || state === "no_permission")) {
|
||||
return (
|
||||
<Modal
|
||||
title={state === "not_running" ? "Docker is installed but not running" : "Docker is running but not accessible"}
|
||||
onClose={onClose}
|
||||
widthClassName="w-[34rem]"
|
||||
footer={
|
||||
<>
|
||||
<Button variant="ghost" onClick={onClose}>
|
||||
Dismiss
|
||||
</Button>
|
||||
<Button variant="primary" onClick={handleRecheck}>
|
||||
Re-check
|
||||
</Button>
|
||||
</>
|
||||
}
|
||||
>
|
||||
<p className="text-[13px] text-[var(--text-secondary)] mb-3">
|
||||
{state === "not_running"
|
||||
? "Triple-C found Docker on this machine, but the Docker daemon is not answering. There is nothing to install."
|
||||
: "The Docker daemon is up, but this user is not allowed to talk to it."}
|
||||
</p>
|
||||
{state === "not_running" ? (
|
||||
<NotRunningHelp status={dockerStatus} />
|
||||
) : (
|
||||
<NoPermissionHelp status={dockerStatus} />
|
||||
)}
|
||||
{endpointLine}
|
||||
{awsLine}
|
||||
</Modal>
|
||||
);
|
||||
}
|
||||
|
||||
if (!options) {
|
||||
return null;
|
||||
}
|
||||
@@ -61,7 +181,7 @@ export default function DockerInstallDialog({ onClose }: Props) {
|
||||
|
||||
return (
|
||||
<Modal
|
||||
title="Docker not detected"
|
||||
title="Docker is not installed"
|
||||
onClose={onClose}
|
||||
widthClassName="w-[34rem]"
|
||||
// Closing mid-install would orphan a privileged installer.
|
||||
@@ -80,6 +200,8 @@ export default function DockerInstallDialog({ onClose }: Props) {
|
||||
<span className="text-[var(--text-primary)]">{options.product_name}</span> for
|
||||
you, or you can follow the official instructions.
|
||||
</p>
|
||||
{awsLine}
|
||||
<div className="mb-4">{endpointLine}</div>
|
||||
|
||||
{phase === "idle" && (
|
||||
<div className="flex flex-col gap-2">
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { dockerFailLabel } from "../../lib/dockerStatus";
|
||||
import { useState } from "react";
|
||||
import { useShallow } from "zustand/react/shallow";
|
||||
import MainTabs from "./MainTabs";
|
||||
@@ -9,9 +10,10 @@ import HelpDialog from "./HelpDialog";
|
||||
import StatusIndicator, { type StatusTone } from "../ui/StatusIndicator";
|
||||
|
||||
export default function TopBar() {
|
||||
const { dockerAvailable, imageExists, updateInfo, imageUpdateInfo, appVersion, setUpdateInfo, setImageUpdateInfo } = useAppState(
|
||||
const { dockerAvailable, dockerStatus, imageExists, updateInfo, imageUpdateInfo, appVersion, setUpdateInfo, setImageUpdateInfo } = useAppState(
|
||||
useShallow(s => ({
|
||||
dockerAvailable: s.dockerAvailable,
|
||||
dockerStatus: s.dockerStatus,
|
||||
imageExists: s.imageExists,
|
||||
updateInfo: s.updateInfo,
|
||||
imageUpdateInfo: s.imageUpdateInfo,
|
||||
@@ -76,7 +78,7 @@ export default function TopBar() {
|
||||
<HealthDot
|
||||
state={dockerAvailable}
|
||||
okLabel="Docker"
|
||||
failLabel="Docker unavailable"
|
||||
failLabel={dockerFailLabel(dockerStatus)}
|
||||
pendingLabel="Docker — checking"
|
||||
/>
|
||||
<HealthDot
|
||||
|
||||
@@ -14,6 +14,14 @@ describe("ConfirmRemoveModal", () => {
|
||||
expect(onConfirm.mock.calls).toEqual([[{ discardData: false }], [{ discardData: true }]]);
|
||||
});
|
||||
|
||||
it("says both access points go when the workspace kept /workspace on EFS", () => {
|
||||
render(
|
||||
<ConfirmRemoveModal projectName="api" aws savedFiles workspaceFiles onConfirm={vi.fn()} onCancel={vi.fn()} />,
|
||||
);
|
||||
expect(screen.getByRole("checkbox", { name: /file-system access points/ })).toBeInTheDocument();
|
||||
expect(screen.getByText(/\/workspace/)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("offers no access-point choice for an Ephemeral AWS workspace", () => {
|
||||
const onConfirm = vi.fn();
|
||||
render(<ConfirmRemoveModal projectName="api" aws onConfirm={onConfirm} onCancel={vi.fn()} />);
|
||||
|
||||
@@ -8,6 +8,8 @@ interface Props {
|
||||
aws?: boolean;
|
||||
/** AWS: the workspace may have an EFS access point (offers removing it). */
|
||||
savedFiles?: boolean;
|
||||
/** AWS: `/workspace` may be on EFS too (EFS storage, now or before). */
|
||||
workspaceFiles?: boolean;
|
||||
onConfirm: (opts: { discardData: boolean }) => void;
|
||||
onCancel: () => void;
|
||||
}
|
||||
@@ -19,6 +21,7 @@ export default function ConfirmRemoveModal({
|
||||
projectName,
|
||||
aws = false,
|
||||
savedFiles = false,
|
||||
workspaceFiles = false,
|
||||
onConfirm,
|
||||
onCancel,
|
||||
}: Props) {
|
||||
@@ -61,11 +64,12 @@ export default function ConfirmRemoveModal({
|
||||
onChange={(e) => setDiscardData(e.target.checked)}
|
||||
/>
|
||||
<span>
|
||||
Also remove the workspace’s file-system access point
|
||||
Also remove the workspace’s file-system access points
|
||||
<span className="block text-xs text-[var(--text-secondary)]">
|
||||
The saved files themselves (Claude login, history, SSH keys) stay on your own
|
||||
EFS file system, readable only by your workspace role, until an administrator
|
||||
offboards you.
|
||||
The saved files themselves (Claude login, history, SSH keys
|
||||
{workspaceFiles ? ", and the /workspace files" : ""}) stay on your own EFS file
|
||||
system, readable only by your workspace role, until an administrator offboards
|
||||
you.
|
||||
</span>
|
||||
</span>
|
||||
</label>
|
||||
|
||||
@@ -149,4 +149,11 @@ describe("PermissionModeControl", () => {
|
||||
/Caution/i,
|
||||
);
|
||||
});
|
||||
|
||||
it("shows the sandbox OFF on an AWS project whatever the setting says", () => {
|
||||
const aws = { ...baseProject, host_id: "aws-1", sandbox_mode_enabled: true, permission_mode: "bypass" as const };
|
||||
render(<PermissionModeControl project={aws} onChange={vi.fn()} />);
|
||||
expect(screen.getByTestId("sandbox-state")).toHaveTextContent(/Sandbox OFF/);
|
||||
expect(screen.getByTestId("permission-mode-hint")).toHaveTextContent(/Caution/i);
|
||||
});
|
||||
});
|
||||
@@ -1,5 +1,6 @@
|
||||
import type { PermissionMode, Project } from "../../lib/types";
|
||||
import SegmentedControl, { type Segment } from "../ui/SegmentedControl";
|
||||
import { sandboxEffective } from "../../lib/awsWorkspace";
|
||||
|
||||
export const PERMISSION_MODES: Segment<PermissionMode>[] = [
|
||||
{ value: "plan", label: "Plan", hint: "Claude proposes a plan and makes no changes." },
|
||||
@@ -56,7 +57,7 @@ export default function PermissionModeControl({
|
||||
disabledReason,
|
||||
}: Props) {
|
||||
const mode = effectivePermissionMode(project);
|
||||
const sandboxOn = project.sandbox_mode_enabled;
|
||||
const sandboxOn = sandboxEffective(project);
|
||||
const uncontainedBypass = mode === "bypass" && !sandboxOn;
|
||||
|
||||
const segments = PERMISSION_MODES.map((segment) =>
|
||||
|
||||
@@ -0,0 +1,130 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { render, screen, fireEvent, act } from "@testing-library/react";
|
||||
import PortMappingsEditor from "./PortMappingsEditor";
|
||||
import type { PortMapping } from "../../lib/types";
|
||||
|
||||
const tcp = (host_port: number, container_port: number): PortMapping => ({
|
||||
host_port,
|
||||
container_port,
|
||||
protocol: "tcp",
|
||||
});
|
||||
|
||||
function setup(initial: PortMapping[], extra: { tcpOnly?: boolean } = {}) {
|
||||
const onSave = vi.fn().mockResolvedValue(true);
|
||||
const view = render(
|
||||
<PortMappingsEditor portMappings={initial} disabled={false} onSave={onSave} {...extra} />,
|
||||
);
|
||||
const rerender = (next: PortMapping[]) =>
|
||||
view.rerender(
|
||||
<PortMappingsEditor portMappings={next} disabled={false} onSave={onSave} {...extra} />,
|
||||
);
|
||||
return { onSave, rerender };
|
||||
}
|
||||
|
||||
const host = (n = 1) => screen.getByLabelText(`Host port ${n}`) as HTMLInputElement;
|
||||
const container = (n = 1) => screen.getByLabelText(`Container port ${n}`) as HTMLInputElement;
|
||||
|
||||
function type(el: HTMLInputElement, value: string) {
|
||||
act(() => el.focus());
|
||||
fireEvent.change(el, { target: { value } });
|
||||
}
|
||||
|
||||
describe("PortMappingsEditor", () => {
|
||||
it("keeps typed ports when the project refreshes mid-edit (the reported 0/0 save)", () => {
|
||||
// A stored half-row, as the old "+ Add" saved it, then a project refresh
|
||||
// (status event, save response, list reload) hands over a new-but-equal
|
||||
// array while the user is typing.
|
||||
const { onSave, rerender } = setup([tcp(0, 0)]);
|
||||
type(host(), "8080");
|
||||
rerender([tcp(0, 0)]);
|
||||
type(container(), "8080");
|
||||
rerender([tcp(0, 0)]);
|
||||
expect(host().value).toBe("8080");
|
||||
expect(container().value).toBe("8080");
|
||||
fireEvent.blur(container());
|
||||
expect(onSave).toHaveBeenLastCalledWith([tcp(8080, 8080)]);
|
||||
});
|
||||
|
||||
it("keeps typed ports when its own earlier save's response arrives mid-edit", () => {
|
||||
const { onSave, rerender } = setup([]);
|
||||
fireEvent.click(screen.getByRole("button", { name: /add port mapping/i }));
|
||||
type(host(), "8080");
|
||||
fireEvent.blur(host());
|
||||
type(container(), "80");
|
||||
// A stale echo of an older stored value must not replace the edit in focus.
|
||||
rerender([]);
|
||||
type(container(), "8080");
|
||||
fireEvent.blur(container());
|
||||
expect(onSave).toHaveBeenLastCalledWith([tcp(8080, 8080)]);
|
||||
expect(container().value).toBe("8080");
|
||||
});
|
||||
|
||||
it("does not save a newly added empty row", () => {
|
||||
const { onSave } = setup([]);
|
||||
fireEvent.click(screen.getByRole("button", { name: /add port mapping/i }));
|
||||
expect(onSave).not.toHaveBeenCalled();
|
||||
expect(host()).toHaveFocus();
|
||||
expect(screen.getByText(/fill in both ports/i)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("does not present an empty row as a filled-in mapping (no port-number placeholder)", () => {
|
||||
// The reported case: the empty row's "8080" placeholders read as 8080 → 8080.
|
||||
setup([]);
|
||||
fireEvent.click(screen.getByRole("button", { name: /add port mapping/i }));
|
||||
for (const el of [host(), container()]) {
|
||||
expect(el.value).toBe("");
|
||||
expect(el.placeholder).not.toMatch(/\d/);
|
||||
}
|
||||
expect(screen.getByText(/isn't saved or active/i)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("never saves a half-filled row, and saves it once both ports are in", () => {
|
||||
const { onSave } = setup([tcp(3000, 3000)]);
|
||||
fireEvent.click(screen.getByRole("button", { name: /add port mapping/i }));
|
||||
type(host(2), "8080");
|
||||
fireEvent.blur(host(2));
|
||||
expect(onSave).not.toHaveBeenCalled();
|
||||
expect(screen.getByText(/fill in both ports/i)).toBeInTheDocument();
|
||||
type(container(2), "9090");
|
||||
fireEvent.blur(container(2));
|
||||
expect(onSave).toHaveBeenLastCalledWith([tcp(3000, 3000), tcp(8080, 9090)]);
|
||||
expect(screen.queryByText(/fill in both ports/i)).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("shows a stored incomplete row as incomplete", () => {
|
||||
setup([tcp(0, 0), tcp(8080, 8080)]);
|
||||
expect(screen.getAllByText(/fill in both ports/i)).toHaveLength(1);
|
||||
expect(host(1).value).toBe("");
|
||||
});
|
||||
|
||||
it("refuses an out-of-range port without saving it", () => {
|
||||
const { onSave } = setup([]);
|
||||
fireEvent.click(screen.getByRole("button", { name: /add port mapping/i }));
|
||||
type(host(), "70000");
|
||||
type(container(), "80");
|
||||
fireEvent.blur(container());
|
||||
expect(onSave).not.toHaveBeenCalled();
|
||||
expect(screen.getByText(/1 and 65535/)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("takes a changed stored value once the editor is not being edited", () => {
|
||||
const { rerender } = setup([tcp(3000, 3000)]);
|
||||
rerender([tcp(4000, 4000)]);
|
||||
expect(host().value).toBe("4000");
|
||||
});
|
||||
|
||||
it("removing a row saves the rest; the protocol saves at once (Docker keeps UDP)", () => {
|
||||
const { onSave } = setup([tcp(3000, 3000), tcp(4000, 4000)]);
|
||||
fireEvent.change(screen.getByLabelText("Protocol 2"), { target: { value: "udp" } });
|
||||
expect(onSave).toHaveBeenLastCalledWith([tcp(3000, 3000), { ...tcp(4000, 4000), protocol: "udp" }]);
|
||||
fireEvent.click(screen.getByRole("button", { name: "Remove port mapping 1" }));
|
||||
expect(onSave).toHaveBeenLastCalledWith([{ ...tcp(4000, 4000), protocol: "udp" }]);
|
||||
});
|
||||
|
||||
it("does not save when nothing changed", () => {
|
||||
const { onSave } = setup([tcp(3000, 3000)]);
|
||||
act(() => host().focus());
|
||||
fireEvent.blur(host());
|
||||
expect(onSave).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -1,4 +1,4 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { useEffect, useRef, useState } from "react";
|
||||
import type { PortMapping } from "../../lib/types";
|
||||
import Button from "../ui/Button";
|
||||
import { monoInputClass, selectClass } from "../ui/Field";
|
||||
@@ -7,45 +7,163 @@ interface Props {
|
||||
portMappings: PortMapping[];
|
||||
disabled: boolean;
|
||||
disabledReason?: string;
|
||||
/** AWS: only TCP is forwarded (UDP is refused on save). */
|
||||
tcpOnly?: boolean;
|
||||
onSave: (mappings: PortMapping[]) => Promise<unknown>;
|
||||
}
|
||||
|
||||
/** One row as typed: ports stay text until they are valid, so a half-typed
|
||||
* row is never turned into a 0. */
|
||||
interface Row {
|
||||
key: number;
|
||||
host: string;
|
||||
container: string;
|
||||
protocol: string;
|
||||
}
|
||||
|
||||
/** Placeholders are words, not port numbers: a "8080" placeholder in an
|
||||
* empty row read as a filled-in 8080 → 8080 mapping that was never typed. */
|
||||
const placeholderClass = "placeholder:italic placeholder:text-[var(--text-disabled)]";
|
||||
|
||||
function parsePort(text: string): number | null {
|
||||
if (!/^\d+$/.test(text.trim())) return null;
|
||||
const n = Number(text.trim());
|
||||
return n >= 1 && n <= 65535 ? n : null;
|
||||
}
|
||||
|
||||
/** Why a row is not a mapping yet, or `null` when it is one. */
|
||||
export function rowProblem(row: Pick<Row, "host" | "container">): string | null {
|
||||
if (row.host.trim() === "" || row.container.trim() === "") return "Fill in both ports";
|
||||
if (parsePort(row.host) === null || parsePort(row.container) === null) {
|
||||
return "Ports must be whole numbers between 1 and 65535";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/** The rows that are complete mappings — the only ones ever saved. */
|
||||
function completeMappings(rows: Row[]): PortMapping[] {
|
||||
return rows.flatMap((r) => {
|
||||
const host_port = parsePort(r.host);
|
||||
const container_port = parsePort(r.container);
|
||||
return host_port !== null && container_port !== null && rowProblem(r) === null
|
||||
? [{ host_port, container_port, protocol: r.protocol }]
|
||||
: [];
|
||||
});
|
||||
}
|
||||
|
||||
let nextKey = 1;
|
||||
const portText = (n: number) => (n > 0 ? String(n) : "");
|
||||
function toRows(mappings: PortMapping[]): Row[] {
|
||||
return mappings.map((m) => ({
|
||||
key: nextKey++,
|
||||
host: portText(m.host_port),
|
||||
container: portText(m.container_port),
|
||||
protocol: m.protocol,
|
||||
}));
|
||||
}
|
||||
|
||||
export default function PortMappingsEditor({
|
||||
portMappings: initial,
|
||||
portMappings: stored,
|
||||
disabled,
|
||||
disabledReason,
|
||||
tcpOnly = false,
|
||||
onSave,
|
||||
}: Props) {
|
||||
const [mappings, setMappings] = useState<PortMapping[]>(initial);
|
||||
const [rows, setRowsState] = useState<Row[]>(() => toRows(stored));
|
||||
// The latest rows, for blur handlers that run before a re-render.
|
||||
const rowsRef = useRef(rows);
|
||||
const setRows = (next: Row[]) => {
|
||||
rowsRef.current = next;
|
||||
setRowsState(next);
|
||||
};
|
||||
|
||||
// What is stored, as this editor last loaded or saved it. A project refresh
|
||||
// hands over a new array on every update (status events, save responses,
|
||||
// list reloads); only a value that differs from this is a real change.
|
||||
const storedKey = JSON.stringify(stored);
|
||||
const syncedKey = useRef(storedKey);
|
||||
const wrapper = useRef<HTMLDivElement>(null);
|
||||
const [focusLeft, setFocusLeft] = useState(0);
|
||||
const focusHost = useRef<number | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
setMappings(initial);
|
||||
}, [initial]);
|
||||
if (storedKey === syncedKey.current) return;
|
||||
// Never replace what the user is typing; this runs again when focus
|
||||
// leaves the editor.
|
||||
if (wrapper.current?.contains(document.activeElement)) return;
|
||||
syncedKey.current = storedKey;
|
||||
const fresh = toRows(JSON.parse(storedKey) as PortMapping[]);
|
||||
// Rows still being filled in are not stored; keep them.
|
||||
const drafts = rowsRef.current.filter((r) => rowProblem(r) !== null);
|
||||
const freshKeys = new Set(fresh.map((r) => `${r.host}|${r.container}`));
|
||||
setRows([...fresh, ...drafts.filter((r) => !freshKeys.has(`${r.host}|${r.container}`))]);
|
||||
}, [storedKey, focusLeft]);
|
||||
|
||||
const updatePort = (
|
||||
index: number,
|
||||
field: "host_port" | "container_port",
|
||||
value: string,
|
||||
) => {
|
||||
const updated = [...mappings];
|
||||
const num = parseInt(value, 10);
|
||||
updated[index] = { ...updated[index], [field]: isNaN(num) ? 0 : num };
|
||||
setMappings(updated);
|
||||
useEffect(() => {
|
||||
if (focusHost.current === null) return;
|
||||
const el = wrapper.current?.querySelector<HTMLInputElement>(
|
||||
`[data-row="${focusHost.current}"][data-field="host"]`,
|
||||
);
|
||||
focusHost.current = null;
|
||||
el?.focus();
|
||||
}, [rows]);
|
||||
|
||||
/** Save the complete rows, if they differ from what is stored. */
|
||||
const commit = (next: Row[]) => {
|
||||
const mappings = completeMappings(next);
|
||||
const key = JSON.stringify(mappings);
|
||||
if (key === syncedKey.current) return;
|
||||
syncedKey.current = key;
|
||||
void onSave(mappings);
|
||||
};
|
||||
|
||||
const edit = (index: number, field: "host" | "container", value: string) => {
|
||||
const next = [...rowsRef.current];
|
||||
next[index] = { ...next[index], [field]: value };
|
||||
setRows(next);
|
||||
};
|
||||
|
||||
const portInput = (row: Row, i: number, field: "host" | "container") => {
|
||||
const value = row[field];
|
||||
const missing = rowProblem(row) !== null && parsePort(value) === null;
|
||||
return (
|
||||
<input
|
||||
type="text"
|
||||
inputMode="numeric"
|
||||
value={value}
|
||||
onChange={(e) => edit(i, field, e.target.value)}
|
||||
onBlur={() => commit(rowsRef.current)}
|
||||
placeholder={field === "host" ? "Host port" : "Container port"}
|
||||
aria-label={`${field === "host" ? "Host" : "Container"} port ${i + 1}`}
|
||||
aria-invalid={missing || undefined}
|
||||
aria-describedby={rowProblem(row) ? `pm-problem-${row.key}` : undefined}
|
||||
data-row={row.key}
|
||||
data-field={field}
|
||||
disabled={disabled}
|
||||
className={`w-[28%] ${monoInputClass} ${placeholderClass}`}
|
||||
/>
|
||||
);
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
<div
|
||||
ref={wrapper}
|
||||
className="space-y-2"
|
||||
onBlur={(e) => {
|
||||
if (!e.currentTarget.contains(e.relatedTarget as Node | null)) setFocusLeft((n) => n + 1);
|
||||
}}
|
||||
>
|
||||
{disabled && disabledReason && (
|
||||
<p className="px-2 py-1.5 bg-[var(--warning-muted)] border border-[var(--warning)]/30 rounded-[var(--radius-control)] text-xs text-[var(--warning)]">
|
||||
{disabledReason}
|
||||
</p>
|
||||
)}
|
||||
|
||||
{mappings.length === 0 && (
|
||||
{rows.length === 0 && (
|
||||
<p className="text-xs text-[var(--text-secondary)]">No port mappings configured.</p>
|
||||
)}
|
||||
|
||||
{mappings.length > 0 && (
|
||||
{rows.length > 0 && (
|
||||
<div className="flex gap-2 items-center text-xs text-[var(--text-secondary)] px-0.5">
|
||||
<span className="w-[28%]">Host port</span>
|
||||
<span className="w-[28%]">Container port</span>
|
||||
@@ -54,71 +172,58 @@ export default function PortMappingsEditor({
|
||||
</div>
|
||||
)}
|
||||
|
||||
{mappings.map((pm, i) => (
|
||||
<div key={i} className="flex gap-2 items-center">
|
||||
<input
|
||||
type="number"
|
||||
min="1"
|
||||
max="65535"
|
||||
value={pm.host_port || ""}
|
||||
onChange={(e) => updatePort(i, "host_port", e.target.value)}
|
||||
onBlur={() => onSave(mappings)}
|
||||
placeholder="8080"
|
||||
aria-label={`Host port ${i + 1}`}
|
||||
disabled={disabled}
|
||||
className={`w-[28%] ${monoInputClass}`}
|
||||
/>
|
||||
<input
|
||||
type="number"
|
||||
min="1"
|
||||
max="65535"
|
||||
value={pm.container_port || ""}
|
||||
onChange={(e) => updatePort(i, "container_port", e.target.value)}
|
||||
onBlur={() => onSave(mappings)}
|
||||
placeholder="8080"
|
||||
aria-label={`Container port ${i + 1}`}
|
||||
disabled={disabled}
|
||||
className={`w-[28%] ${monoInputClass}`}
|
||||
/>
|
||||
<select
|
||||
value={pm.protocol}
|
||||
aria-label={`Protocol ${i + 1}`}
|
||||
onChange={(e) => {
|
||||
const updated = [...mappings];
|
||||
updated[i] = { ...updated[i], protocol: e.target.value };
|
||||
setMappings(updated);
|
||||
onSave(updated);
|
||||
}}
|
||||
disabled={disabled}
|
||||
className={`w-[22%] ${selectClass}`}
|
||||
>
|
||||
<option value="tcp">TCP</option>
|
||||
<option value="udp">UDP</option>
|
||||
</select>
|
||||
<Button
|
||||
variant="danger"
|
||||
disabled={disabled}
|
||||
aria-label={`Remove port mapping ${i + 1}`}
|
||||
onClick={() => {
|
||||
const updated = mappings.filter((_, j) => j !== i);
|
||||
setMappings(updated);
|
||||
onSave(updated);
|
||||
}}
|
||||
>
|
||||
Remove
|
||||
</Button>
|
||||
</div>
|
||||
))}
|
||||
{rows.map((row, i) => {
|
||||
const problem = rowProblem(row);
|
||||
return (
|
||||
<div key={row.key} className="space-y-1">
|
||||
<div className="flex gap-2 items-center">
|
||||
{portInput(row, i, "host")}
|
||||
{portInput(row, i, "container")}
|
||||
<select
|
||||
value={row.protocol}
|
||||
aria-label={`Protocol ${i + 1}`}
|
||||
onChange={(e) => {
|
||||
const next = [...rowsRef.current];
|
||||
next[i] = { ...next[i], protocol: e.target.value };
|
||||
setRows(next);
|
||||
commit(next);
|
||||
}}
|
||||
disabled={disabled}
|
||||
className={`w-[22%] ${selectClass}`}
|
||||
>
|
||||
<option value="tcp">TCP</option>
|
||||
{(!tcpOnly || row.protocol === "udp") && <option value="udp">UDP</option>}
|
||||
</select>
|
||||
<Button
|
||||
variant="danger"
|
||||
disabled={disabled}
|
||||
aria-label={`Remove port mapping ${i + 1}`}
|
||||
onClick={() => {
|
||||
const next = rowsRef.current.filter((_, j) => j !== i);
|
||||
setRows(next);
|
||||
commit(next);
|
||||
}}
|
||||
>
|
||||
Remove
|
||||
</Button>
|
||||
</div>
|
||||
{problem && (
|
||||
<p id={`pm-problem-${row.key}`} className="text-xs text-[var(--warning)] px-0.5">
|
||||
⚠ {problem} — this mapping isn't saved or active.
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
|
||||
<Button
|
||||
disabled={disabled}
|
||||
onClick={() => {
|
||||
const updated = [
|
||||
...mappings,
|
||||
{ host_port: 0, container_port: 0, protocol: "tcp" },
|
||||
];
|
||||
setMappings(updated);
|
||||
onSave(updated);
|
||||
// Kept here until both ports are filled in: an empty row is never
|
||||
// saved (it used to be stored as 0 → 0 and silently skipped).
|
||||
const row: Row = { key: nextKey++, host: "", container: "", protocol: "tcp" };
|
||||
focusHost.current = row.key;
|
||||
setRows([...rowsRef.current, row]);
|
||||
}}
|
||||
>
|
||||
+ Add port mapping
|
||||
|
||||
@@ -0,0 +1,159 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
import { act, render, screen } from "@testing-library/react";
|
||||
import type { AwsWorkspaceConfig, HourlyEstimate } from "../../../lib/types";
|
||||
import { defaultAwsWorkspace } from "../../../lib/awsWorkspace";
|
||||
|
||||
const awsCostEstimate =
|
||||
vi.fn<
|
||||
(id: string, region: string, config: AwsWorkspaceConfig, instanceType: string | null) => Promise<HourlyEstimate | null>
|
||||
>();
|
||||
vi.mock("../../../lib/tauri-commands", () => ({
|
||||
awsCostEstimate: (id: string, region: string, config: AwsWorkspaceConfig, instanceType: string | null) =>
|
||||
awsCostEstimate(id, region, config, instanceType),
|
||||
}));
|
||||
|
||||
import AwsCostEstimate, { ESTIMATE_DEBOUNCE_MS, formatHourly } from "./AwsCostEstimate";
|
||||
|
||||
const config = (over: Partial<AwsWorkspaceConfig> = {}): AwsWorkspaceConfig => ({
|
||||
...defaultAwsWorkspace(),
|
||||
storage: "ephemeral",
|
||||
...over,
|
||||
});
|
||||
|
||||
async function settle() {
|
||||
await act(async () => {
|
||||
vi.advanceTimersByTime(ESTIMATE_DEBOUNCE_MS);
|
||||
});
|
||||
await act(async () => {});
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
awsCostEstimate.mockReset();
|
||||
});
|
||||
afterEach(() => vi.useRealTimers());
|
||||
|
||||
describe("AwsCostEstimate", () => {
|
||||
it("formats small and larger figures", () => {
|
||||
expect(formatHourly(0.05826)).toBe("$0.058");
|
||||
expect(formatHourly(0.2468)).toBe("$0.25");
|
||||
expect(formatHourly(2.5)).toBe("$2.50");
|
||||
});
|
||||
|
||||
it("shows the on-demand hourly figure for the connection, region and config", async () => {
|
||||
awsCostEstimate.mockResolvedValue({
|
||||
usd_per_hour: 0.05826,
|
||||
note_spot: false,
|
||||
efs_billed_separately: false,
|
||||
ec2_instance: false,
|
||||
root_volume_included: false,
|
||||
});
|
||||
const c = config();
|
||||
render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={c} />);
|
||||
expect(screen.getByText("Estimating…")).toBeInTheDocument();
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledWith("c1", "us-west-2", c, null);
|
||||
expect(screen.getByText("≈ $0.058/hour")).toBeInTheDocument();
|
||||
expect(screen.queryByText(/Spot/)).toBeNull();
|
||||
expect(screen.queryByText(/EFS/)).toBeNull();
|
||||
});
|
||||
|
||||
it("notes Spot, EFS and the gateway sidecar", async () => {
|
||||
awsCostEstimate.mockResolvedValue({
|
||||
usd_per_hour: 0.05,
|
||||
note_spot: true,
|
||||
efs_billed_separately: true,
|
||||
ec2_instance: false,
|
||||
root_volume_included: false,
|
||||
});
|
||||
render(
|
||||
<AwsCostEstimate
|
||||
connectionId="c1"
|
||||
region="us-west-2"
|
||||
config={config({ spot: true, storage: "hybrid", gateway_sidecar: true })}
|
||||
/>,
|
||||
);
|
||||
await settle();
|
||||
expect(
|
||||
screen.getByText("≈ $0.050/hour (on-demand; Spot is usually up to 70% cheaper)"),
|
||||
).toBeInTheDocument();
|
||||
expect(screen.getByText(/EFS storage is billed separately/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/gateway sidecar shares the task's CPU and memory/)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("says the estimate is unavailable for null or a failed call, never an error", async () => {
|
||||
awsCostEstimate.mockResolvedValueOnce(null);
|
||||
const { unmount } = render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config()} />);
|
||||
await settle();
|
||||
expect(screen.getByText("Estimate unavailable")).toBeInTheDocument();
|
||||
unmount();
|
||||
|
||||
awsCostEstimate.mockRejectedValueOnce("boom");
|
||||
render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config()} />);
|
||||
await settle();
|
||||
expect(screen.getByText("Estimate unavailable")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("without a connection or region it does not ask", async () => {
|
||||
render(<AwsCostEstimate connectionId={null} region="us-west-2" config={config()} />);
|
||||
await settle();
|
||||
expect(awsCostEstimate).not.toHaveBeenCalled();
|
||||
expect(screen.getByText("Estimate unavailable")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("asks once per settled change of a cost field, not for unrelated edits", async () => {
|
||||
awsCostEstimate.mockResolvedValue({ usd_per_hour: 0.1, note_spot: false, efs_billed_separately: false, ec2_instance: false, root_volume_included: false });
|
||||
const { rerender } = render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config()} />);
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledTimes(1);
|
||||
// An unrelated field: no new call.
|
||||
rerender(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config({ setup_script: "x" })} />);
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledTimes(1);
|
||||
// Two quick CPU changes: one call, with the last.
|
||||
rerender(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config({ cpu: 2048 })} />);
|
||||
rerender(
|
||||
<AwsCostEstimate connectionId="c1" region="us-west-2" config={config({ cpu: 4096, memory_mib: 8192 })} />,
|
||||
);
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledTimes(2);
|
||||
expect(awsCostEstimate.mock.calls[1][2].cpu).toBe(4096);
|
||||
});
|
||||
|
||||
it("says when an EC2 estimate lacks the root volume's price", async () => {
|
||||
awsCostEstimate.mockResolvedValue({ usd_per_hour: 0.1008, note_spot: false, efs_billed_separately: false, ec2_instance: true, root_volume_included: false });
|
||||
render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config({ launch_type: "ec2" })} instanceType="m7i.large" />);
|
||||
await settle();
|
||||
expect(screen.getByText(/Its 50 GiB gp3 root volume \(about \$4 a month\) is not included/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/public IPv4 address adds/)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("prices an EC2 project as its instance type, and says instances scale to zero", async () => {
|
||||
awsCostEstimate.mockResolvedValue({ usd_per_hour: 0.1008, note_spot: false, efs_billed_separately: true, ec2_instance: true, root_volume_included: true });
|
||||
const c = config({ launch_type: "ec2", storage: "hybrid" });
|
||||
const { rerender } = render(
|
||||
<AwsCostEstimate connectionId="c1" region="us-west-2" config={c} instanceType="m7i.large" />,
|
||||
);
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledWith("c1", "us-west-2", c, "m7i.large");
|
||||
expect(screen.getByText("≈ $0.10/hour")).toBeInTheDocument();
|
||||
expect(screen.getByText(/Instances scale to zero when no workspace is running/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/EFS storage is billed separately/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/Includes its 50 GiB gp3 root volume/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/public IPv4 address adds \$0.005\/hour/)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/While the task runs/)).toBeNull();
|
||||
// The reservations don't change an instance's price: no new call.
|
||||
rerender(
|
||||
<AwsCostEstimate connectionId="c1" region="us-west-2" config={{ ...c, cpu: 512, memory_mib: 1024 }} instanceType="m7i.large" />,
|
||||
);
|
||||
await settle();
|
||||
expect(awsCostEstimate).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does not ask for an EC2 project whose instance type is unknown", async () => {
|
||||
render(<AwsCostEstimate connectionId="c1" region="us-west-2" config={config({ launch_type: "ec2" })} instanceType={null} />);
|
||||
await settle();
|
||||
expect(awsCostEstimate).not.toHaveBeenCalled();
|
||||
expect(screen.getByText("Estimate unavailable")).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,96 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import type { AwsWorkspaceConfig, HourlyEstimate } from "../../../lib/types";
|
||||
import { awsCostEstimate } from "../../../lib/tauri-commands";
|
||||
|
||||
/** Edits settle this long before the estimate is asked for again. */
|
||||
export const ESTIMATE_DEBOUNCE_MS = 400;
|
||||
|
||||
/** "$0.058" below ten cents (two decimals would round most tasks to $0.05/$0.06), "$0.25" above. */
|
||||
export function formatHourly(usd: number): string {
|
||||
return `$${usd.toFixed(usd < 0.1 ? 3 : 2)}`;
|
||||
}
|
||||
|
||||
interface Props {
|
||||
/** The project's connection; null when it was removed. */
|
||||
connectionId: string | null;
|
||||
region: string | null | undefined;
|
||||
config: AwsWorkspaceConfig;
|
||||
/** An EC2 project's instance type (the user's); null when unknown. */
|
||||
instanceType?: string | null;
|
||||
}
|
||||
|
||||
type State = { kind: "loading" } | { kind: "done"; estimate: HourlyEstimate | null };
|
||||
|
||||
/**
|
||||
* The estimated on-demand cost per hour of an AWS project's Fargate task (Q5), from the Price
|
||||
* List API through `aws_cost_estimate` (cached a day per region). Best effort: a denied call, no
|
||||
* network or no connection reads "Estimate unavailable" — never an error toast, and nothing waits
|
||||
* on it. Re-asked only when a field that changes the price changes, after edits settle.
|
||||
*/
|
||||
export default function AwsCostEstimate({ connectionId, region, config, instanceType = null }: Props) {
|
||||
const [state, setState] = useState<State>({ kind: "loading" });
|
||||
const { launch_type, cpu, memory_mib, arch, ephemeral_gib, spot, storage } = config;
|
||||
const ec2 = launch_type === "ec2";
|
||||
// Only what the backend prices or notes; the rest of the config is sent but changes nothing.
|
||||
// An EC2 project is priced as its instance (E10): only the type and storage matter.
|
||||
const key = JSON.stringify(
|
||||
ec2
|
||||
? [connectionId, region, launch_type, instanceType, storage]
|
||||
: [connectionId, region, launch_type, cpu, memory_mib, arch, ephemeral_gib, spot, storage],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
if (!connectionId || !region || (ec2 && !instanceType)) {
|
||||
setState({ kind: "done", estimate: null });
|
||||
return;
|
||||
}
|
||||
let cancelled = false;
|
||||
setState({ kind: "loading" });
|
||||
const timer = setTimeout(() => {
|
||||
awsCostEstimate(connectionId, region, config, ec2 ? instanceType : null)
|
||||
.catch(() => null)
|
||||
.then((estimate) => {
|
||||
if (!cancelled) setState({ kind: "done", estimate });
|
||||
});
|
||||
}, ESTIMATE_DEBOUNCE_MS);
|
||||
return () => {
|
||||
cancelled = true;
|
||||
clearTimeout(timer);
|
||||
};
|
||||
// `key` covers every field of `config` the estimate depends on.
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [key]);
|
||||
|
||||
const estimate = state.kind === "done" ? state.estimate : null;
|
||||
return (
|
||||
<div className="space-y-0.5 text-xs">
|
||||
<p className="text-[var(--text-primary)]">
|
||||
{state.kind === "loading"
|
||||
? "Estimating…"
|
||||
: estimate
|
||||
? `≈ ${formatHourly(estimate.usd_per_hour)}/hour${
|
||||
estimate.note_spot ? " (on-demand; Spot is usually up to 70% cheaper)" : ""
|
||||
}`
|
||||
: "Estimate unavailable"}
|
||||
</p>
|
||||
{estimate?.ec2_instance && (
|
||||
<p className="text-[var(--text-secondary)]">
|
||||
While your instance runs. Instances scale to zero when no workspace is running.
|
||||
{estimate.root_volume_included
|
||||
? " Includes its 50 GiB gp3 root volume."
|
||||
: " Its 50 GiB gp3 root volume (about $4 a month) is not included."}
|
||||
{" In an environment with public networking, the instance's public IPv4 address adds $0.005/hour."}
|
||||
{estimate.efs_billed_separately && " EFS storage is billed separately."}
|
||||
</p>
|
||||
)}
|
||||
{estimate && !estimate.ec2_instance && (
|
||||
<p className="text-[var(--text-secondary)]">
|
||||
While the task runs; nothing while it is stopped.
|
||||
{estimate.efs_billed_separately && " EFS storage is billed separately."}
|
||||
{config.gateway_sidecar &&
|
||||
" The gateway sidecar shares the task's CPU and memory, so it adds nothing."}
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,151 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
import { act, render, screen } from "@testing-library/react";
|
||||
import type { Project, WorkspaceStatus } from "../../../lib/types";
|
||||
|
||||
const awsWorkspaceStatus = vi.fn<(id: string) => Promise<WorkspaceStatus | null>>();
|
||||
vi.mock("../../../lib/tauri-commands", () => ({
|
||||
awsWorkspaceStatus: (id: string) => awsWorkspaceStatus(id),
|
||||
}));
|
||||
|
||||
import AwsWorkspaceStatusCard, { STATUS_POLL_MS } from "./AwsWorkspaceStatusCard";
|
||||
|
||||
const project = (over: Partial<Project> = {}): Project =>
|
||||
({
|
||||
id: "p1",
|
||||
name: "demo",
|
||||
status: "running",
|
||||
host_id: "conn-1",
|
||||
container_id: "http://127.0.0.1:1",
|
||||
aws: { repos: [{}, {}, {}] },
|
||||
...over,
|
||||
}) as unknown as Project;
|
||||
|
||||
const CLONING: WorkspaceStatus = {
|
||||
clone: {
|
||||
done: false,
|
||||
repos: [
|
||||
{ folder: "api", state: "cloned" },
|
||||
{ folder: "web", state: "cloning" },
|
||||
],
|
||||
},
|
||||
setup: { state: "running", code: null, tail: [] },
|
||||
};
|
||||
|
||||
const FAILED: WorkspaceStatus = {
|
||||
clone: {
|
||||
done: true,
|
||||
repos: [
|
||||
{ folder: "api", state: "cloned" },
|
||||
{ folder: "web", state: "failed" },
|
||||
],
|
||||
},
|
||||
setup: { state: "failed", code: 2, tail: ["Setting up jq", "E: Unable to locate package nope"] },
|
||||
};
|
||||
|
||||
async function flush() {
|
||||
await act(async () => {
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
});
|
||||
}
|
||||
|
||||
describe("AwsWorkspaceStatusCard", () => {
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
awsWorkspaceStatus.mockReset();
|
||||
});
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("shows a workspace still cloning, then a failed clone and setup", async () => {
|
||||
awsWorkspaceStatus.mockResolvedValueOnce(CLONING).mockResolvedValue(FAILED);
|
||||
render(<AwsWorkspaceStatusCard project={project()} />);
|
||||
await flush();
|
||||
expect(screen.getByText("Still cloning repos (1 of 3 done)")).toBeTruthy();
|
||||
expect(screen.getByText("cloning…")).toBeTruthy();
|
||||
expect(screen.getByText("Setup script waits for the clone")).toBeTruthy();
|
||||
|
||||
await act(async () => {
|
||||
vi.advanceTimersByTime(STATUS_POLL_MS);
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(2);
|
||||
expect(screen.getByText("Clone failed for web")).toBeTruthy();
|
||||
expect(screen.getByText("Setup script failed (exit 2)")).toBeTruthy();
|
||||
expect(screen.getByText(/E: Unable to locate package nope/)).toBeTruthy();
|
||||
});
|
||||
|
||||
it("renders nothing and does not poll for a stopped project", async () => {
|
||||
awsWorkspaceStatus.mockResolvedValue(FAILED);
|
||||
const { container } = render(<AwsWorkspaceStatusCard project={project({ status: "stopped" })} />);
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).not.toHaveBeenCalled();
|
||||
expect(container.innerHTML).toBe("");
|
||||
});
|
||||
|
||||
it("renders nothing when there is nothing to say", async () => {
|
||||
awsWorkspaceStatus.mockResolvedValue({
|
||||
clone: { done: true, repos: [] },
|
||||
setup: { state: "none", code: null, tail: [] },
|
||||
});
|
||||
const { container } = render(<AwsWorkspaceStatusCard project={project()} />);
|
||||
await flush();
|
||||
expect(container.innerHTML).toBe("");
|
||||
});
|
||||
|
||||
it("pauses while the window is hidden", async () => {
|
||||
awsWorkspaceStatus.mockResolvedValue(CLONING);
|
||||
render(<AwsWorkspaceStatusCard project={project()} />);
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(1);
|
||||
const state = vi.spyOn(document, "visibilityState", "get").mockReturnValue("hidden");
|
||||
await act(async () => {
|
||||
vi.advanceTimersByTime(STATUS_POLL_MS * 3);
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(1);
|
||||
state.mockReturnValue("visible");
|
||||
await act(async () => {
|
||||
document.dispatchEvent(new Event("visibilitychange"));
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(2);
|
||||
state.mockRestore();
|
||||
});
|
||||
|
||||
it("never runs two polls at once when the window is hidden and shown mid-read", async () => {
|
||||
let resolve: (s: WorkspaceStatus) => void = () => {};
|
||||
awsWorkspaceStatus.mockImplementation(() => new Promise((r) => (resolve = r)));
|
||||
render(<AwsWorkspaceStatusCard project={project()} />);
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(1);
|
||||
// Hidden and shown again while the first read is still out.
|
||||
const state = vi.spyOn(document, "visibilityState", "get").mockReturnValue("hidden");
|
||||
await act(async () => {
|
||||
document.dispatchEvent(new Event("visibilitychange"));
|
||||
});
|
||||
state.mockReturnValue("visible");
|
||||
await act(async () => {
|
||||
document.dispatchEvent(new Event("visibilitychange"));
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(1);
|
||||
// The read ends: one chain goes on, one read per interval.
|
||||
await act(async () => resolve(CLONING));
|
||||
await flush();
|
||||
await act(async () => {
|
||||
vi.advanceTimersByTime(STATUS_POLL_MS);
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(2);
|
||||
await act(async () => resolve(CLONING));
|
||||
await flush();
|
||||
await act(async () => {
|
||||
vi.advanceTimersByTime(STATUS_POLL_MS);
|
||||
});
|
||||
await flush();
|
||||
expect(awsWorkspaceStatus).toHaveBeenCalledTimes(3);
|
||||
state.mockRestore();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,136 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import type { Project, WorkspaceStatus } from "../../../lib/types";
|
||||
import { awsWorkspaceStatus } from "../../../lib/tauri-commands";
|
||||
|
||||
/** How often the card re-reads the status while it is on screen. */
|
||||
export const STATUS_POLL_MS = 5000;
|
||||
|
||||
const REPO_STATE: Record<string, string> = {
|
||||
cloning: "cloning…",
|
||||
cloned: "cloned",
|
||||
failed: "failed",
|
||||
exists: "already there",
|
||||
};
|
||||
|
||||
/**
|
||||
* An AWS workspace's background clone and setup script (phase 6, Q4/R5):
|
||||
* the start ends at "Connecting…" and this card is where their progress
|
||||
* shows, re-read every 5 s while the project is Running and the window is
|
||||
* visible. Each read is a background exec, so the
|
||||
* card never keeps an idle workspace up. Renders nothing for a local project,
|
||||
* a workspace that cannot be asked, or one with no repos and no setup script.
|
||||
*/
|
||||
export default function AwsWorkspaceStatusCard({ project }: { project: Project }) {
|
||||
const running = project.status === "running";
|
||||
const [status, setStatus] = useState<WorkspaceStatus | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
setStatus(null);
|
||||
if (!running) return;
|
||||
let cancelled = false;
|
||||
let timer: ReturnType<typeof setTimeout> | null = null;
|
||||
// A read in progress: hiding and showing the window during it must not
|
||||
// start a second poll chain beside this one.
|
||||
let inFlight = false;
|
||||
const visible = () => document.visibilityState !== "hidden";
|
||||
const poll = async () => {
|
||||
timer = null;
|
||||
if (!visible()) return; // resumed by visibilitychange
|
||||
inFlight = true;
|
||||
try {
|
||||
const s = await awsWorkspaceStatus(project.id);
|
||||
if (!cancelled) setStatus(s);
|
||||
} catch {
|
||||
// A failed read keeps the last status; the next poll tries again.
|
||||
} finally {
|
||||
inFlight = false;
|
||||
}
|
||||
if (!cancelled) timer = setTimeout(poll, STATUS_POLL_MS);
|
||||
};
|
||||
const onVisibility = () => {
|
||||
if (visible() && timer === null && !inFlight && !cancelled) void poll();
|
||||
};
|
||||
void poll();
|
||||
document.addEventListener("visibilitychange", onVisibility);
|
||||
return () => {
|
||||
cancelled = true;
|
||||
if (timer !== null) clearTimeout(timer);
|
||||
document.removeEventListener("visibilitychange", onVisibility);
|
||||
};
|
||||
}, [project.id, running, project.container_id]);
|
||||
|
||||
if (!running || !status) return null;
|
||||
const { clone, setup } = status;
|
||||
if (clone.done && clone.repos.length === 0 && setup.state === "none") return null;
|
||||
|
||||
const failedRepos = clone.repos.filter((r) => r.state === "failed");
|
||||
const finished = clone.repos.filter((r) => r.state !== "cloning").length;
|
||||
const total = Math.max(project.aws?.repos.length ?? 0, clone.repos.length);
|
||||
const cloneLine = !clone.done
|
||||
? total > 0
|
||||
? `Still cloning repos (${finished} of ${total} done)`
|
||||
: "Still cloning repos"
|
||||
: failedRepos.length > 0
|
||||
? `Clone failed for ${failedRepos.map((r) => r.folder).join(", ")}`
|
||||
: clone.repos.length > 0
|
||||
? "Repos cloned"
|
||||
: null;
|
||||
const setupLine =
|
||||
setup.state === "running"
|
||||
? clone.done
|
||||
? "Setup script running…"
|
||||
: "Setup script waits for the clone"
|
||||
: setup.state === "ok"
|
||||
? "Setup script finished"
|
||||
: setup.state === "failed"
|
||||
? `Setup script failed${setup.code != null ? ` (exit ${setup.code})` : ""}`
|
||||
: null;
|
||||
const problem = failedRepos.length > 0 || setup.state === "failed";
|
||||
|
||||
return (
|
||||
<section
|
||||
aria-label="Workspace start-up"
|
||||
className="p-3 border rounded-[var(--radius-panel)] bg-[var(--bg-secondary)] text-xs space-y-2"
|
||||
style={{ borderColor: problem ? "var(--warning)" : "var(--border-color)" }}
|
||||
>
|
||||
<h2 className="text-[11px] font-semibold uppercase tracking-wide text-[var(--text-secondary)]">
|
||||
Workspace start-up
|
||||
</h2>
|
||||
{cloneLine && (
|
||||
<p className="text-[var(--text-primary)]">
|
||||
{failedRepos.length > 0 && (
|
||||
<span aria-hidden="true" className="mr-1 text-[var(--warning)]">
|
||||
▲
|
||||
</span>
|
||||
)}
|
||||
{cloneLine}
|
||||
</p>
|
||||
)}
|
||||
{clone.repos.length > 0 && (!clone.done || failedRepos.length > 0) && (
|
||||
<ul className="space-y-0.5 text-[var(--text-secondary)]">
|
||||
{clone.repos.map((r) => (
|
||||
<li key={r.folder}>
|
||||
<span className="font-mono text-[var(--text-primary)]">{r.folder}</span>{" "}
|
||||
{REPO_STATE[r.state] ?? r.state}
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
{setupLine && (
|
||||
<p className="text-[var(--text-primary)]">
|
||||
{setup.state === "failed" && (
|
||||
<span aria-hidden="true" className="mr-1 text-[var(--warning)]">
|
||||
▲
|
||||
</span>
|
||||
)}
|
||||
{setupLine}
|
||||
</p>
|
||||
)}
|
||||
{(setup.state === "running" || setup.state === "failed") && setup.tail.length > 0 && (
|
||||
<pre className="max-h-40 overflow-auto whitespace-pre-wrap break-all p-2 rounded-[var(--radius-control)] bg-[var(--bg-primary)] text-[var(--text-secondary)] font-mono text-[11px]">
|
||||
{(setup.state === "running" ? setup.tail.slice(-3) : setup.tail).join("\n")}
|
||||
</pre>
|
||||
)}
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -12,6 +12,10 @@ import PermissionModeControl, {
|
||||
} from "../PermissionModeControl";
|
||||
import CapabilityTiles from "./CapabilityTiles";
|
||||
import ContainerMigrationBanner from "./ContainerMigrationBanner";
|
||||
import AwsWorkspaceStatusCard from "./AwsWorkspaceStatusCard";
|
||||
import AwsCostEstimate from "./AwsCostEstimate";
|
||||
import { isAwsProject } from "../../../lib/awsWorkspace";
|
||||
import { useEc2Capacity } from "../../../lib/ec2Capacity";
|
||||
import type { ContainerMigration } from "../../../hooks/useContainerMigration";
|
||||
import SaveIndicator from "../../ui/SaveIndicator";
|
||||
import Button from "../../ui/Button";
|
||||
@@ -50,6 +54,11 @@ export default function OverviewTab({
|
||||
onOpenMigration,
|
||||
}: Props) {
|
||||
const [sessions, setSessions] = useState<ClaudeSession[]>([]);
|
||||
// An EC2 project's estimate is its instance type's price (E10).
|
||||
const ec2Capacity = useEc2Capacity(
|
||||
project,
|
||||
isAwsProject(project) && project.status === "running" && project.aws?.launch_type === "ec2",
|
||||
);
|
||||
const [tasks, setTasks] = useState<ScheduledTask[]>([]);
|
||||
const [notificationCount, setNotificationCount] = useState(0);
|
||||
const running = project.status === "running";
|
||||
@@ -132,6 +141,28 @@ export default function OverviewTab({
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* AWS: the background clone and setup script (still cloning, setup
|
||||
failed, …). Polls only while Running and visible. */}
|
||||
{isAwsProject(project) && <AwsWorkspaceStatusCard project={project} />}
|
||||
|
||||
{/* AWS, while running: what the task costs per hour (Q5). */}
|
||||
{isAwsProject(project) && project.status === "running" && project.aws && (
|
||||
<section
|
||||
aria-label="Estimated cost"
|
||||
className="p-3 border rounded-[var(--radius-panel)] bg-[var(--bg-secondary)] border-[var(--border-color)] space-y-1"
|
||||
>
|
||||
<h2 className="text-[11px] font-semibold uppercase tracking-wide text-[var(--text-secondary)]">
|
||||
Estimated cost
|
||||
</h2>
|
||||
<AwsCostEstimate
|
||||
connectionId={project.host_id}
|
||||
region={project.aws_placement?.region}
|
||||
config={project.aws}
|
||||
instanceType={ec2Capacity?.state === "ec2" ? ec2Capacity.compute.instance_type : null}
|
||||
/>
|
||||
</section>
|
||||
)}
|
||||
|
||||
{/* A container missing socat and bwrap is a capability statement, so the
|
||||
out-of-date warning sits directly above the capability inventory. */}
|
||||
<ContainerMigrationBanner
|
||||
|
||||
@@ -11,7 +11,7 @@ import Button from "../../ui/Button";
|
||||
import OverflowMenu from "../../ui/OverflowMenu";
|
||||
import ConfirmRemoveModal, { ConfirmForgetAwsModal } from "../ConfirmRemoveModal";
|
||||
import StopGuardModal from "../StopGuardModal";
|
||||
import { hasSavedFiles, isAwsProject } from "../../../lib/awsWorkspace";
|
||||
import { hasSavedFiles, hasWorkspaceFiles, isAwsProject } from "../../../lib/awsWorkspace";
|
||||
import { AWS_CONNECTION_MISSING, type RemoveProjectOptions } from "../../../lib/types";
|
||||
import ConfirmResetModal from "../ConfirmResetModal";
|
||||
import MigrateContainerModal from "../MigrateContainerModal";
|
||||
@@ -349,6 +349,7 @@ export default function ProjectHome({ projectId, active }: Props) {
|
||||
projectName={project.name}
|
||||
aws={aws}
|
||||
savedFiles={hasSavedFiles(project)}
|
||||
workspaceFiles={hasWorkspaceFiles(project)}
|
||||
onCancel={() => setConfirmRemove(false)}
|
||||
onConfirm={({ discardData }) => {
|
||||
setConfirmRemove(false);
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { render, screen, fireEvent, waitFor } from "@testing-library/react";
|
||||
import type { Project, WorkspaceTerminal } from "../../../lib/types";
|
||||
|
||||
const listWorkspaceTerminals = vi.fn();
|
||||
const endWorkspaceTerminal = vi.fn(async () => {});
|
||||
const closeTerminalSession = vi.fn(async () => {});
|
||||
vi.mock("../../../lib/tauri-commands", () => ({
|
||||
listClaudeSessions: vi.fn(async () => []),
|
||||
listWorkspaceTerminals: (id: string) => listWorkspaceTerminals(id),
|
||||
endWorkspaceTerminal: (p: string, s: string) => endWorkspaceTerminal(p, s),
|
||||
closeTerminalSession: (s: string) => closeTerminalSession(s),
|
||||
updateProject: vi.fn(),
|
||||
}));
|
||||
vi.mock("@tauri-apps/api/event", () => ({ listen: vi.fn() }));
|
||||
|
||||
import SessionsTab from "./SessionsTab";
|
||||
import { useAppState } from "../../../store/appState";
|
||||
|
||||
const actions = { resumeClaudeSession: vi.fn() } as never;
|
||||
const aws = { id: "p1", name: "api", host_id: "h1", status: "running", container_id: "http://x/" } as unknown as Project;
|
||||
const t = (id: string, over: Partial<WorkspaceTerminal> = {}): WorkspaceTerminal => ({
|
||||
session_id: id,
|
||||
kind: "claude",
|
||||
name: null,
|
||||
created_unix: Math.floor(Date.now() / 1000) - 600,
|
||||
attached: false,
|
||||
known: true,
|
||||
...over,
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
listWorkspaceTerminals.mockReset();
|
||||
endWorkspaceTerminal.mockClear();
|
||||
closeTerminalSession.mockClear();
|
||||
useAppState.setState({ projects: [aws], sessions: [], tabOrder: [], activeTabKey: null } as never);
|
||||
});
|
||||
|
||||
describe("SessionsTab — terminals in an AWS workspace", () => {
|
||||
it("lists them with their state and reattaches one in a tab", async () => {
|
||||
listWorkspaceTerminals.mockResolvedValue([
|
||||
t("open-1", { name: "main" }),
|
||||
t("det-2", { kind: "bash" }),
|
||||
t("web-3", { known: false, attached: true, name: "web terminal" }),
|
||||
]);
|
||||
useAppState.getState().addSession({ id: "open-1", projectId: "p1", projectName: "api", sessionType: "claude", sessionName: "main", persistent: true });
|
||||
render(<SessionsTab project={aws} actions={actions} />);
|
||||
|
||||
const list = await screen.findByRole("list", { name: "Terminals in the workspace" });
|
||||
expect(list.textContent).toContain("main");
|
||||
expect(list.textContent).toContain("Open here");
|
||||
expect(list.textContent).toContain("Shell · Detached");
|
||||
expect(list.textContent).toContain("Attached elsewhere");
|
||||
expect(list.textContent).toContain("opened elsewhere");
|
||||
// Open tabs have nothing to reattach.
|
||||
expect(screen.getAllByRole("button", { name: "Reattach" })).toHaveLength(2);
|
||||
|
||||
fireEvent.click(screen.getAllByRole("button", { name: "Reattach" })[0]);
|
||||
const tab = useAppState.getState().sessions.find((s) => s.id === "det-2");
|
||||
expect(tab).toMatchObject({ sessionType: "bash", persistent: true, pendingReattach: true, projectId: "p1" });
|
||||
expect(useAppState.getState().activeSessionId).toBe("det-2");
|
||||
});
|
||||
|
||||
it("ends a detached terminal in the workspace and an open one by closing its tab, after a confirm", async () => {
|
||||
listWorkspaceTerminals.mockResolvedValue([t("open-1"), t("det-2")]);
|
||||
useAppState.getState().addSession({ id: "open-1", projectId: "p1", projectName: "api", sessionType: "claude", sessionName: null, persistent: true });
|
||||
render(<SessionsTab project={aws} actions={actions} />);
|
||||
await screen.findByRole("list", { name: "Terminals in the workspace" });
|
||||
|
||||
fireEvent.click(screen.getAllByRole("button", { name: "End" })[1]);
|
||||
expect(endWorkspaceTerminal).not.toHaveBeenCalled();
|
||||
fireEvent.click(screen.getByRole("button", { name: "Confirm end" }));
|
||||
await waitFor(() => expect(endWorkspaceTerminal).toHaveBeenCalledWith("p1", "det-2"));
|
||||
|
||||
fireEvent.click(screen.getAllByRole("button", { name: "End" })[0]);
|
||||
fireEvent.click(screen.getByRole("button", { name: "Confirm end" }));
|
||||
await waitFor(() => expect(closeTerminalSession).toHaveBeenCalledWith("open-1"));
|
||||
expect(useAppState.getState().sessions.find((s) => s.id === "open-1")).toBeUndefined();
|
||||
});
|
||||
|
||||
it("is not shown for a Docker project", async () => {
|
||||
const docker = { ...aws, host_id: null } as unknown as Project;
|
||||
render(<SessionsTab project={docker} actions={actions} />);
|
||||
await screen.findByText(/No sessions recorded yet/);
|
||||
expect(screen.queryByText("Terminals in the workspace")).toBeNull();
|
||||
expect(listWorkspaceTerminals).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -1,9 +1,18 @@
|
||||
import { useCallback, useEffect, useState } from "react";
|
||||
import type { ClaudeSession, Project } from "../../../lib/types";
|
||||
import { listClaudeSessions } from "../../../lib/tauri-commands";
|
||||
import { useShallow } from "zustand/react/shallow";
|
||||
import type { ClaudeSession, Project, WorkspaceTerminal } from "../../../lib/types";
|
||||
import {
|
||||
endWorkspaceTerminal,
|
||||
listClaudeSessions,
|
||||
listWorkspaceTerminals,
|
||||
} from "../../../lib/tauri-commands";
|
||||
import type { useProjectActions } from "../../../hooks/useProjectActions";
|
||||
import { useTerminal } from "../../../hooks/useTerminal";
|
||||
import { useAppState } from "../../../store/appState";
|
||||
import { isAwsProject } from "../../../lib/awsWorkspace";
|
||||
import { reattachTab, terminalLabel } from "../../../lib/persistentTerminals";
|
||||
import Button from "../../ui/Button";
|
||||
import { formatAge, formatBytes } from "./format";
|
||||
import { formatAge, formatBytes, formatElapsed } from "./format";
|
||||
|
||||
interface Props {
|
||||
project: Project;
|
||||
@@ -38,6 +47,7 @@ export default function SessionsTab({ project, actions }: Props) {
|
||||
|
||||
return (
|
||||
<div className="p-4 max-w-4xl">
|
||||
{isAwsProject(project) && running && <WorkspaceTerminals project={project} />}
|
||||
<div className="flex items-center justify-between mb-3">
|
||||
<p className="text-xs text-[var(--text-secondary)]">
|
||||
Conversations stored on this project’s config volume. Resume opens a
|
||||
@@ -88,3 +98,117 @@ export default function SessionsTab({ project, actions }: Props) {
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* AWS: the terminals running in the workspace — the ones open here, the ones
|
||||
* this app left detached, and any another machine or the web terminal
|
||||
* opened. Reattach opens one in a tab; End stops it (and closes its tab).
|
||||
*/
|
||||
function WorkspaceTerminals({ project }: { project: Project }) {
|
||||
const [terminals, setTerminals] = useState<WorkspaceTerminal[]>([]);
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const [confirmEnd, setConfirmEnd] = useState<string | null>(null);
|
||||
const openIds = useAppState(useShallow((s) => s.sessions.map((x) => x.id)));
|
||||
const { close } = useTerminal();
|
||||
const pushToast = useAppState((s) => s.pushToast);
|
||||
|
||||
const load = useCallback(() => {
|
||||
setLoading(true);
|
||||
setError(null);
|
||||
listWorkspaceTerminals(project.id)
|
||||
.then(setTerminals)
|
||||
.catch((e) => {
|
||||
setTerminals([]);
|
||||
setError(String(e));
|
||||
})
|
||||
.finally(() => setLoading(false));
|
||||
}, [project.id]);
|
||||
|
||||
useEffect(load, [load]);
|
||||
|
||||
const isOpen = (id: string) => openIds.includes(id);
|
||||
|
||||
const reattach = (t: WorkspaceTerminal) => {
|
||||
useAppState.getState().addSession(reattachTab(project.id, project.name, t));
|
||||
};
|
||||
|
||||
const end = async (t: WorkspaceTerminal) => {
|
||||
setConfirmEnd(null);
|
||||
try {
|
||||
if (isOpen(t.session_id)) await close(t.session_id);
|
||||
else await endWorkspaceTerminal(project.id, t.session_id);
|
||||
} catch (e) {
|
||||
pushToast({ kind: "error", message: "Could not end that terminal", detail: String(e) });
|
||||
}
|
||||
load();
|
||||
};
|
||||
|
||||
return (
|
||||
<section className="mb-6" aria-labelledby="workspace-terminals-heading">
|
||||
<div className="flex items-center justify-between mb-2">
|
||||
<div>
|
||||
<h3 id="workspace-terminals-heading" className="text-[13px] font-medium text-[var(--text-primary)]">
|
||||
Terminals in the workspace
|
||||
</h3>
|
||||
<p className="text-xs text-[var(--text-secondary)]">
|
||||
Terminals keep running in the workspace when Triple-C closes or loses its
|
||||
connection. Closing a tab ends its terminal. A Claude session left running keeps
|
||||
the workspace up until it ends, you end it here, you Stop, or the lifetime cap.
|
||||
</p>
|
||||
</div>
|
||||
<Button onClick={load} disabled={loading}>
|
||||
{loading ? "Refreshing…" : "Refresh"}
|
||||
</Button>
|
||||
</div>
|
||||
{error ? (
|
||||
<p className="text-[13px] text-[var(--text-secondary)]">{error}</p>
|
||||
) : terminals.length === 0 && !loading ? (
|
||||
<p className="text-[13px] text-[var(--text-secondary)]">No terminals are running in the workspace.</p>
|
||||
) : (
|
||||
<ul className="space-y-1" aria-label="Terminals in the workspace">
|
||||
{terminals.map((t) => {
|
||||
const open = isOpen(t.session_id);
|
||||
const state = open ? "Open here" : t.attached ? "Attached elsewhere" : "Detached";
|
||||
// The cost of a Claude that outlives the app: it keeps the
|
||||
// workspace up (and billed) until it ends or is ended.
|
||||
const keepsUp = !open && !t.attached && t.kind === "claude";
|
||||
return (
|
||||
<li
|
||||
key={t.session_id}
|
||||
className="flex items-center gap-3 px-3 py-2 bg-[var(--bg-secondary)] border border-[var(--border-color)] rounded-[var(--radius-control)]"
|
||||
>
|
||||
<div className="flex-1 min-w-0">
|
||||
<div className="text-[13px] text-[var(--text-primary)] truncate">{terminalLabel(t)}</div>
|
||||
<div className="text-xs text-[var(--text-secondary)] truncate">
|
||||
{t.kind === "claude" ? "Claude Code" : "Shell"} · {state} · started{" "}
|
||||
{formatElapsed(Date.now() - t.created_unix * 1000)}
|
||||
{t.known ? "" : " · opened elsewhere"}
|
||||
</div>
|
||||
{keepsUp && (
|
||||
<div className="text-xs text-[var(--warning)]">
|
||||
Keeps the workspace running while it runs — End it if you no longer need it.
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
{!open && (
|
||||
<Button variant="primary" onClick={() => reattach(t)}>
|
||||
Reattach
|
||||
</Button>
|
||||
)}
|
||||
{confirmEnd === t.session_id ? (
|
||||
<>
|
||||
<Button variant="danger" onClick={() => void end(t)}>Confirm end</Button>
|
||||
<Button onClick={() => setConfirmEnd(null)}>Cancel</Button>
|
||||
</>
|
||||
) : (
|
||||
<Button onClick={() => setConfirmEnd(t.session_id)}>End</Button>
|
||||
)}
|
||||
</li>
|
||||
);
|
||||
})}
|
||||
</ul>
|
||||
)}
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -7,7 +7,7 @@ import Field, { ConfigGroup, inputClass } from "../../../ui/Field";
|
||||
import CaCertPathInput from "../../../settings/CaCertPathInput";
|
||||
import EnvVarsEditor from "../../EnvVarsEditor";
|
||||
import PortMappingsEditor from "../../PortMappingsEditor";
|
||||
import { NOT_ON_AWS, isAwsProject } from "../../../../lib/awsWorkspace";
|
||||
import { AWS_PORTS_LOCALHOST_ONLY, isAwsProject } from "../../../../lib/awsWorkspace";
|
||||
|
||||
interface Props {
|
||||
project: Project;
|
||||
@@ -163,21 +163,24 @@ export default function AccessSection({
|
||||
Port mappings
|
||||
</span>
|
||||
{isAwsProject(project) ? (
|
||||
<p className="mt-0.5 text-xs text-[var(--text-disabled)] leading-snug">{NOT_ON_AWS}</p>
|
||||
<p className="mt-0.5 mb-2 text-xs text-[var(--text-secondary)] leading-snug">
|
||||
Forward workspace ports to this machine while it is connected. TCP only. A
|
||||
connection carrying traffic counts as activity, so it keeps the workspace from its
|
||||
idle stop. {AWS_PORTS_LOCALHOST_ONLY}.
|
||||
</p>
|
||||
) : (
|
||||
<>
|
||||
<p className="mt-0.5 mb-2 text-xs text-[var(--text-secondary)] leading-snug">
|
||||
Expose container ports on the host so you can reach dev servers running inside
|
||||
the sandbox.
|
||||
</p>
|
||||
<PortMappingsEditor
|
||||
portMappings={project.port_mappings ?? []}
|
||||
disabled={disabled}
|
||||
disabledReason={disabledReason}
|
||||
onSave={(mappings) => save({ port_mappings: mappings })}
|
||||
/>
|
||||
</>
|
||||
<p className="mt-0.5 mb-2 text-xs text-[var(--text-secondary)] leading-snug">
|
||||
Expose container ports on the host so you can reach dev servers running inside
|
||||
the sandbox.
|
||||
</p>
|
||||
)}
|
||||
<PortMappingsEditor
|
||||
portMappings={project.port_mappings ?? []}
|
||||
disabled={disabled}
|
||||
disabledReason={disabledReason}
|
||||
tcpOnly={isAwsProject(project)}
|
||||
onSave={(mappings) => save({ port_mappings: mappings })}
|
||||
/>
|
||||
</div>
|
||||
</ConfigGroup>
|
||||
);
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { render, screen, fireEvent, waitFor, within } from "@testing-library/react";
|
||||
import { act, cleanup, render, screen, fireEvent, waitFor, within } from "@testing-library/react";
|
||||
import RuntimeSection from "./RuntimeSection";
|
||||
import AccessSection from "./AccessSection";
|
||||
import WorkspaceSection from "./WorkspaceSection";
|
||||
@@ -8,22 +8,40 @@ import HostSection from "./HostSection";
|
||||
import { awsProject, localProject } from "../../../../test/awsFixtures";
|
||||
import type { AppSettings, AuthBridgeStatus, Project } from "../../../../lib/types";
|
||||
import { useAppState } from "../../../../store/appState";
|
||||
import { clearEnvironmentMaxHoursCache } from "../../../../lib/environmentMaxHours";
|
||||
import { clearEc2CapacityCache } from "../../../../lib/ec2Capacity";
|
||||
import type { Ec2Capacity } from "../../../../lib/types";
|
||||
|
||||
const OFF_BRIDGE: AuthBridgeStatus = { enabled: false, active_ports: [], conflicts: [] };
|
||||
const removeAwsResources = vi.fn();
|
||||
const awsCostEstimate = vi.fn(async (..._args: unknown[]) => null as unknown);
|
||||
const awsEnvironmentMaxHours = vi.fn(async (_id: string) => 0 as number | null);
|
||||
const NO_EC2: Ec2Capacity = { state: "none" };
|
||||
const awsEc2Capacity = vi.fn(async (_id: string): Promise<Ec2Capacity> => NO_EC2);
|
||||
const ec2FitProblem = vi.fn(async (..._args: unknown[]) => null as string | null);
|
||||
|
||||
vi.mock("../../../../lib/tauri-commands", () => ({
|
||||
getAuthBridgeStatus: vi.fn(async () => OFF_BRIDGE),
|
||||
setAuthBridgeEnabled: vi.fn(),
|
||||
inspectCaCertPath: vi.fn(async () => null),
|
||||
removeAwsResources: (id: string, discard: boolean) => removeAwsResources(id, discard),
|
||||
awsCostEstimate: (...args: unknown[]) => awsCostEstimate(...args),
|
||||
awsEnvironmentMaxHours: (id: string) => awsEnvironmentMaxHours(id),
|
||||
awsEc2Capacity: (id: string) => awsEc2Capacity(id),
|
||||
ec2FitProblem: (...args: unknown[]) => ec2FitProblem(...args),
|
||||
}));
|
||||
vi.mock("@tauri-apps/api/event", () => ({ listen: vi.fn(async () => () => {}) }));
|
||||
vi.mock("@tauri-apps/plugin-dialog", () => ({ open: vi.fn(async () => null) }));
|
||||
|
||||
const save = vi.fn().mockResolvedValue(true);
|
||||
|
||||
beforeEach(() => vi.clearAllMocks());
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
clearEnvironmentMaxHoursCache();
|
||||
clearEc2CapacityCache();
|
||||
awsEc2Capacity.mockImplementation(async () => NO_EC2);
|
||||
ec2FitProblem.mockImplementation(async () => null);
|
||||
});
|
||||
|
||||
function toggle(name: string) {
|
||||
return screen.getByRole("switch", { name });
|
||||
@@ -40,6 +58,14 @@ describe("AWS project config", () => {
|
||||
expect(screen.getByText(/Off on AWS for now/)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("still offers UDP mappings for a local project", () => {
|
||||
const project = localProject();
|
||||
project.port_mappings = [{ host_port: 5353, container_port: 5353, protocol: "udp" }];
|
||||
render(<AccessSection project={project} save={save} disabled={false} />);
|
||||
expect(within(screen.getByLabelText("Protocol 1")).getByText("UDP")).toBeInTheDocument();
|
||||
expect(screen.queryByText(/Reachable only from this machine/)).toBeNull();
|
||||
});
|
||||
|
||||
it("leaves those options alone for a local project", () => {
|
||||
render(<RuntimeSection project={localProject()} save={save} disabled={false} />);
|
||||
expect(toggle("VPN support")).not.toBeDisabled();
|
||||
@@ -47,10 +73,16 @@ describe("AWS project config", () => {
|
||||
expect(screen.queryByText("Not available on AWS (Fargate)")).toBeNull();
|
||||
});
|
||||
|
||||
it("replaces port mappings and folders on AWS", () => {
|
||||
render(<AccessSection project={awsProject()} save={save} disabled={false} />);
|
||||
expect(screen.getByText("Not available on AWS (Fargate)")).toBeInTheDocument();
|
||||
it("offers TCP port mappings on AWS, localhost only, and replaces folders", () => {
|
||||
const project = awsProject();
|
||||
project.port_mappings = [{ host_port: 3000, container_port: 3000, protocol: "tcp" }];
|
||||
render(<AccessSection project={project} save={save} disabled={false} />);
|
||||
expect(screen.getByText(/Reachable only from this machine \(localhost\)/)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/Expose container ports/)).toBeNull();
|
||||
const protocol = screen.getByLabelText("Protocol 1");
|
||||
expect(within(protocol).queryByText("UDP")).toBeNull();
|
||||
expect(within(protocol).getByText("TCP")).toBeInTheDocument();
|
||||
cleanup();
|
||||
|
||||
render(<WorkspaceSection project={awsProject()} save={save} disabled={false} />);
|
||||
expect(screen.queryByText("Folders")).toBeNull();
|
||||
@@ -99,10 +131,154 @@ describe("AWS project config", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("LLM gateway sidecar (ModelSection)", () => {
|
||||
const SIDECAR = "Run Triple-C's LLM gateway in the workspace";
|
||||
const withModels = (models: { name: string; model_id: string }[]) =>
|
||||
useAppState.setState({
|
||||
appSettings: { gateway: { enabled: false, port: 4000, models } } as unknown as AppSettings,
|
||||
});
|
||||
const oai = (over: Partial<Project> = {}) =>
|
||||
awsProject({
|
||||
backend: "open_ai_compatible",
|
||||
openai_compatible_config: {
|
||||
base_url: "http://host.docker.internal:4000",
|
||||
api_key: null,
|
||||
model_id: "gpt",
|
||||
haiku_model_id: null,
|
||||
} as never,
|
||||
...over,
|
||||
});
|
||||
const renderModel = (p: Project) =>
|
||||
render(<ModelSection project={p} save={save} disabled={false} />);
|
||||
|
||||
it("is offered only for an AWS project on the OpenAI-compatible backend", () => {
|
||||
withModels([{ name: "gpt", model_id: "gpt-5" }]);
|
||||
renderModel(awsProject({ backend: "ollama" }));
|
||||
expect(screen.queryByRole("switch", { name: SIDECAR })).toBeNull();
|
||||
cleanup();
|
||||
render(
|
||||
<ModelSection
|
||||
project={localProjectOai()}
|
||||
save={save}
|
||||
disabled={false}
|
||||
/>,
|
||||
);
|
||||
expect(screen.queryByRole("switch", { name: SIDECAR })).toBeNull();
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
|
||||
it("turns on when Settings has a gateway model, and says why not otherwise", async () => {
|
||||
withModels([{ name: " ", model_id: "gpt-5" }]);
|
||||
renderModel(oai());
|
||||
expect(toggle(SIDECAR)).toBeDisabled();
|
||||
expect(screen.getByRole("alert")).toHaveTextContent("Settings → Model Gateway");
|
||||
cleanup();
|
||||
|
||||
withModels([{ name: "gpt", model_id: "gpt-5" }]);
|
||||
renderModel(oai());
|
||||
expect(toggle(SIDECAR)).not.toBeDisabled();
|
||||
fireEvent.click(toggle(SIDECAR));
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
expect(save.mock.calls[0][0].aws.gateway_sidecar).toBe(true);
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
|
||||
it("needs 1 vCPU and 2 GiB", () => {
|
||||
withModels([{ name: "gpt", model_id: "gpt-5" }]);
|
||||
const p = oai();
|
||||
p.aws = { ...p.aws!, cpu: 512, memory_mib: 1024 };
|
||||
renderModel(p);
|
||||
expect(toggle(SIDECAR)).toBeDisabled();
|
||||
expect(screen.getByRole("alert")).toHaveTextContent("1 vCPU and 2 GiB");
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
|
||||
it("when on, replaces the local-endpoint warning and can always be turned off", async () => {
|
||||
withModels([]);
|
||||
const p = oai();
|
||||
p.aws = { ...p.aws!, gateway_sidecar: true };
|
||||
renderModel(p);
|
||||
expect(screen.queryByText(/host.docker.internal is this machine/)).toBeNull();
|
||||
expect(screen.getByRole("note", { name: "LLM gateway sidecar" })).toHaveTextContent(
|
||||
"http://127.0.0.1:4000",
|
||||
);
|
||||
expect(toggle(SIDECAR)).toHaveAttribute("aria-checked", "true");
|
||||
expect(toggle(SIDECAR)).not.toBeDisabled();
|
||||
fireEvent.click(toggle(SIDECAR));
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
expect(save.mock.calls[0][0].aws.gateway_sidecar).toBe(false);
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
|
||||
it("is turned off with the backend it needs", async () => {
|
||||
withModels([{ name: "gpt", model_id: "gpt-5" }]);
|
||||
const p = oai();
|
||||
p.aws = { ...p.aws!, gateway_sidecar: true };
|
||||
renderModel(p);
|
||||
fireEvent.change(screen.getByLabelText("Backend"), { target: { value: "anthropic" } });
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
expect(save.mock.calls[0][0]).toMatchObject({ backend: "anthropic", aws: { gateway_sidecar: false } });
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
});
|
||||
|
||||
function localProjectOai(): Project {
|
||||
return localProject({
|
||||
backend: "open_ai_compatible",
|
||||
openai_compatible_config: {
|
||||
base_url: "http://host.docker.internal:4000",
|
||||
api_key: null,
|
||||
model_id: null,
|
||||
haiku_model_id: null,
|
||||
} as never,
|
||||
});
|
||||
}
|
||||
|
||||
describe("HostSection", () => {
|
||||
const renderHost = (p: Project = awsProject(), disabled = false) =>
|
||||
render(<HostSection project={p} save={save} disabled={disabled} />);
|
||||
|
||||
it("shows the estimated hourly cost for the project's connection and region", async () => {
|
||||
awsCostEstimate.mockResolvedValueOnce({
|
||||
usd_per_hour: 0.05,
|
||||
note_spot: true,
|
||||
efs_billed_separately: true,
|
||||
});
|
||||
useAppState.setState({
|
||||
appSettings: { hosts: [{ id: "c1", name: "lab" }] } as unknown as AppSettings,
|
||||
});
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, spot: true };
|
||||
renderHost(p);
|
||||
const card = screen.getByRole("region", { name: "Estimated cost" });
|
||||
await waitFor(() =>
|
||||
expect(within(card).getByText(/≈ \$0\.050\/hour \(on-demand; Spot is usually up to 70% cheaper\)/)).toBeInTheDocument(),
|
||||
);
|
||||
expect(awsCostEstimate).toHaveBeenCalledWith("c1", "eu-west-1", p.aws, null);
|
||||
expect(within(card).getByText(/EFS storage is billed separately/)).toBeInTheDocument();
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
|
||||
it("says the estimate is unavailable when the connection is gone", async () => {
|
||||
useAppState.setState({ appSettings: null });
|
||||
renderHost();
|
||||
const card = screen.getByRole("region", { name: "Estimated cost" });
|
||||
await waitFor(() => expect(within(card).getByText("Estimate unavailable")).toBeInTheDocument());
|
||||
expect(awsCostEstimate).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("offers no CPU below 1 vCPU while the gateway sidecar is on", () => {
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, gateway_sidecar: true };
|
||||
renderHost(p);
|
||||
const cpus = within(screen.getByLabelText("CPU"))
|
||||
.getAllByRole("option")
|
||||
.map((o) => (o as HTMLOptionElement).value);
|
||||
expect(cpus).not.toContain("256");
|
||||
expect(cpus).not.toContain("512");
|
||||
expect(cpus).toContain("1024");
|
||||
});
|
||||
|
||||
it("saves a CPU change with a memory size valid for it", async () => {
|
||||
renderHost(); // 1024 CPU / 4096 MiB
|
||||
fireEvent.change(screen.getByLabelText("CPU"), { target: { value: "256" } });
|
||||
@@ -131,7 +307,214 @@ describe("HostSection", () => {
|
||||
p.aws = { ...p.aws!, storage: "ephemeral" };
|
||||
renderHost(p);
|
||||
expect(screen.getByText(/Claude login and history are lost when the workspace stops/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/EFS .* coming later/)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/coming later/)).toBeNull();
|
||||
});
|
||||
|
||||
it("offers EFS storage with what it costs", async () => {
|
||||
const p = awsProject();
|
||||
renderHost(p);
|
||||
const efs = screen.getByRole("radio", { name: "EFS" });
|
||||
expect(efs).not.toBeDisabled();
|
||||
fireEvent.click(efs);
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
expect(save.mock.calls[0][0].aws.storage).toBe("efs");
|
||||
|
||||
p.aws = { ...p.aws!, storage: "efs" };
|
||||
renderHost(p);
|
||||
expect(
|
||||
screen.getByText("Everything in /workspace survives a stop; git and builds are slower over NFS"),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("chooses where the credentials live and warns what copy-at-connect means", async () => {
|
||||
const p = awsProject();
|
||||
renderHost(p);
|
||||
expect(screen.getByRole("radio", { name: "Stored in AWS (Secrets Manager)" })).toBeChecked();
|
||||
expect(screen.getByText(/kept in the project's Secrets Manager secret/)).toBeInTheDocument();
|
||||
fireEvent.click(screen.getByRole("radio", { name: "Copied when you connect" }));
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
expect(save.mock.calls[0][0].aws.secrets_delivery).toBe("copy_at_connect");
|
||||
cleanup();
|
||||
|
||||
p.aws = { ...p.aws!, secrets_delivery: "copy_at_connect", gateway_sidecar: false };
|
||||
renderHost(p);
|
||||
const note = screen.getByRole("note", { name: "Copied when you connect" });
|
||||
expect(note).toHaveTextContent(
|
||||
"Private repositories clone, and the setup script runs, after you connect (or after 5 minutes without).",
|
||||
);
|
||||
expect(note).toHaveTextContent(/Claude Code's self-update may fail until then/);
|
||||
expect(note).toHaveTextContent("SSH keys, a Git token or variables you remove from the project stay in a running workspace until it stops.");
|
||||
expect(note).toHaveTextContent(/not run again when a later connect re-clones/);
|
||||
expect(note).toHaveTextContent(
|
||||
"Scheduled jobs and the setup script never get the API keys or custom variables; Git and SSH work once the app has connected.",
|
||||
);
|
||||
expect(note).toHaveTextContent("~/.ssh is not kept on EFS");
|
||||
expect(note).toHaveTextContent("/mnt/triple-c-home/.ssh stay there until you remove them");
|
||||
expect(note).not.toHaveTextContent(/gateway/);
|
||||
expect(screen.getByText(/repositories and SSH keys included, starts fresh/)).toBeInTheDocument();
|
||||
cleanup();
|
||||
|
||||
// Ephemeral: nothing is kept anyway, so no SSH note.
|
||||
renderHost({ ...p, aws: { ...p.aws!, storage: "ephemeral" } });
|
||||
expect(screen.getByRole("note", { name: "Copied when you connect" })).not.toHaveTextContent("~/.ssh");
|
||||
cleanup();
|
||||
|
||||
p.aws = { ...p.aws!, gateway_sidecar: true };
|
||||
renderHost(p);
|
||||
expect(screen.getByRole("note", { name: "Copied when you connect" })).toHaveTextContent(
|
||||
"The LLM gateway's keys are still stored in AWS",
|
||||
);
|
||||
});
|
||||
|
||||
it("saves the setup script on blur, and a blank one as none", async () => {
|
||||
renderHost();
|
||||
const box = screen.getByLabelText("Setup script");
|
||||
expect(box.tagName).toBe("TEXTAREA");
|
||||
expect(box.className).toContain("font-mono");
|
||||
expect(box.className).not.toContain("focus:outline-none");
|
||||
fireEvent.change(box, { target: { value: "sudo apt-get install -y jq\n" } });
|
||||
expect(screen.getByText(/27 of 32,768 bytes/)).toBeInTheDocument();
|
||||
fireEvent.blur(box);
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(1));
|
||||
expect(save.mock.calls[0][0].aws.setup_script).toBe("sudo apt-get install -y jq\n");
|
||||
cleanup();
|
||||
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, setup_script: "echo hi" };
|
||||
renderHost(p);
|
||||
const again = screen.getByLabelText("Setup script");
|
||||
expect(again).toHaveValue("echo hi");
|
||||
fireEvent.change(again, { target: { value: " \n" } });
|
||||
fireEvent.blur(again);
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(2));
|
||||
expect(save.mock.calls[1][0].aws.setup_script).toBeNull();
|
||||
});
|
||||
|
||||
it("a toggle right after the setup script's blur keeps the script", async () => {
|
||||
// The store has not caught up with the first save when the second comes.
|
||||
const p = awsProject();
|
||||
renderHost(p);
|
||||
const box = screen.getByLabelText("Setup script");
|
||||
fireEvent.change(box, { target: { value: "make deps\n" } });
|
||||
fireEvent.blur(box);
|
||||
fireEvent.click(toggle("Spot"));
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(2));
|
||||
expect(save.mock.calls[0][0].aws.setup_script).toBe("make deps\n");
|
||||
expect(save.mock.calls[1][0].aws).toMatchObject({ setup_script: "make deps\n", spot: true });
|
||||
});
|
||||
|
||||
it("starts again from the stored config after a refused save", async () => {
|
||||
save.mockResolvedValueOnce(false);
|
||||
renderHost();
|
||||
const box = screen.getByLabelText("Setup script");
|
||||
fireEvent.change(box, { target: { value: "make deps\n" } });
|
||||
fireEvent.blur(box);
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(1));
|
||||
await act(async () => {});
|
||||
fireEvent.click(toggle("Spot"));
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(2));
|
||||
expect(save.mock.calls[1][0].aws).toMatchObject({ setup_script: null, spot: true });
|
||||
});
|
||||
|
||||
it("refuses a setup script over 32 KiB with the backend's message", () => {
|
||||
renderHost();
|
||||
const box = screen.getByLabelText("Setup script");
|
||||
// 16,385 two-byte characters: 32,770 UTF-8 bytes.
|
||||
fireEvent.change(box, { target: { value: "é".repeat(16_385) } });
|
||||
fireEvent.blur(box);
|
||||
expect(screen.getByRole("alert")).toHaveTextContent("The setup script is 32770 bytes; the limit is 32768");
|
||||
expect(box).toHaveAttribute("aria-invalid", "true");
|
||||
expect(save).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("says when and how the setup script runs", () => {
|
||||
renderHost();
|
||||
expect(screen.getByText(/Runs on every start, as claude, with bash -e/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/once the repositories are cloned/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/stopped after 30 minutes, and its output shows in the Overview/)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/never gets the API keys or custom variables/)).toBeNull();
|
||||
cleanup();
|
||||
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, secrets_delivery: "copy_at_connect" };
|
||||
renderHost(p);
|
||||
expect(
|
||||
screen.getByText(/the setup script waits for the app's first connect \(at most 5 minutes\) and never gets the API keys or custom variables/),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("shows the environment's lifetime cap when it has one", async () => {
|
||||
awsEnvironmentMaxHours.mockResolvedValueOnce(24);
|
||||
renderHost();
|
||||
expect(
|
||||
await screen.findByText("This environment stops workspaces after 24 h (advisory)."),
|
||||
).toBeInTheDocument();
|
||||
expect(awsEnvironmentMaxHours).toHaveBeenCalledWith(awsProject().id);
|
||||
cleanup();
|
||||
|
||||
for (const none of [0, null]) {
|
||||
clearEnvironmentMaxHoursCache();
|
||||
awsEnvironmentMaxHours.mockResolvedValueOnce(none);
|
||||
renderHost();
|
||||
await waitFor(() => expect(awsEnvironmentMaxHours).toHaveBeenCalled());
|
||||
await act(async () => {});
|
||||
expect(screen.queryByText(/stops workspaces after/)).toBeNull();
|
||||
cleanup();
|
||||
}
|
||||
});
|
||||
|
||||
it("reads the lifetime cap once per environment across re-mounts", async () => {
|
||||
awsEnvironmentMaxHours.mockResolvedValue(24);
|
||||
renderHost();
|
||||
await screen.findByText(/stops workspaces after 24 h/);
|
||||
cleanup();
|
||||
renderHost();
|
||||
// Shown from the cache, without asking AWS again.
|
||||
await screen.findByText(/stops workspaces after 24 h/);
|
||||
expect(awsEnvironmentMaxHours).toHaveBeenCalledTimes(1);
|
||||
cleanup();
|
||||
|
||||
// Another environment is its own read.
|
||||
renderHost(awsProject({ aws_placement: { region: "eu-west-1", environment: "prod" } }));
|
||||
await waitFor(() => expect(awsEnvironmentMaxHours).toHaveBeenCalledTimes(2));
|
||||
awsEnvironmentMaxHours.mockReset();
|
||||
});
|
||||
|
||||
it("does not let the credentials setting change while the workspace runs", () => {
|
||||
renderHost(awsProject(), true);
|
||||
expect(screen.getByRole("radio", { name: "Copied when you connect" })).toBeDisabled();
|
||||
});
|
||||
|
||||
it("says /workspace files stay on their access point after switching away from EFS", () => {
|
||||
const p = awsProject();
|
||||
p.aws = {
|
||||
...p.aws!,
|
||||
storage: "hybrid",
|
||||
workspace_access_point_id: "fsap-w",
|
||||
task_arn: null,
|
||||
task_definition_arn: null,
|
||||
access_point_id: null,
|
||||
};
|
||||
renderHost(p);
|
||||
expect(screen.getByRole("note", { name: "EFS files kept" })).toHaveTextContent(
|
||||
/\/workspace files .* stay on their access point until .*Remove AWS resources/,
|
||||
);
|
||||
// It is an AWS resource: removable, and it keeps the project in place.
|
||||
expect(screen.getByRole("button", { name: "Run on this machine instead" })).toHaveAttribute(
|
||||
"aria-disabled",
|
||||
"true",
|
||||
);
|
||||
fireEvent.click(screen.getByRole("button", { name: "Remove AWS resources…" }));
|
||||
const dialog = screen.getByRole("dialog");
|
||||
expect(within(dialog).getByRole("checkbox", { name: /access points/ })).toBeInTheDocument();
|
||||
expect(dialog).toHaveTextContent(/\/workspace/);
|
||||
});
|
||||
|
||||
it("does not show the kept-files note on EFS or without a workspace access point", () => {
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, storage: "efs", workspace_access_point_id: "fsap-w" };
|
||||
renderHost(p);
|
||||
expect(screen.queryByRole("note", { name: "EFS files kept" })).toBeNull();
|
||||
});
|
||||
|
||||
it("saves repository edits on blur", async () => {
|
||||
@@ -222,3 +605,272 @@ describe("HostSection", () => {
|
||||
expect(screen.queryByLabelText("Repository 1 URL")).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
// ---- phase 7: EC2 projects ----
|
||||
|
||||
const M7I: Ec2Capacity = {
|
||||
state: "ec2",
|
||||
compute: {
|
||||
instance_type: "m7i.large",
|
||||
max_instances: 1,
|
||||
user_tag: "alice",
|
||||
cluster_arn: "arn:aws:ecs:eu-west-1:123456789012:cluster/triple-c-dev--u-alice",
|
||||
capacity_provider: "triple-c-dev--u-alice",
|
||||
},
|
||||
available_cpu: 1920,
|
||||
available_memory_mib: 7373,
|
||||
};
|
||||
|
||||
const ec2Project = (over: Partial<Project> = {}): Project => {
|
||||
const p = awsProject(over);
|
||||
return { ...p, aws: { ...p.aws!, launch_type: "ec2", cpu: 1024, memory_mib: 4096 } };
|
||||
};
|
||||
|
||||
describe("HostSection — launch type (EC2)", () => {
|
||||
const renderHost = (p: Project = awsProject(), disabled = false) =>
|
||||
render(<HostSection project={p} save={save} disabled={disabled} />);
|
||||
const ec2Segment = () => screen.getByRole("radio", { name: /^EC2/ });
|
||||
|
||||
it("offers EC2 with the user's instance type when their onboarding has EC2 capacity", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
renderHost();
|
||||
await waitFor(() => expect(ec2Segment()).toHaveTextContent("EC2 (your instance: m7i.large)"));
|
||||
expect(ec2Segment()).toBeEnabled();
|
||||
expect(screen.queryByText(/Ask an admin/)).toBeNull();
|
||||
});
|
||||
|
||||
it("disables EC2 with the reason when the user has no EC2 capacity, or it can't be read", async () => {
|
||||
renderHost();
|
||||
await waitFor(() =>
|
||||
expect(screen.getByText(/Ask an admin to add EC2 capacity to your onboarding/)).toBeInTheDocument(),
|
||||
);
|
||||
expect(ec2Segment()).toBeDisabled();
|
||||
expect(screen.getByRole("radio", { name: "Fargate" })).toBeEnabled();
|
||||
cleanup();
|
||||
|
||||
clearEc2CapacityCache();
|
||||
awsEc2Capacity.mockImplementation(async () => ({ state: "unusable", reason: "schema is not 1" }));
|
||||
renderHost();
|
||||
await waitFor(() => expect(screen.getByText(/can't be used \(schema is not 1\)/)).toBeInTheDocument());
|
||||
expect(ec2Segment()).toBeDisabled();
|
||||
cleanup();
|
||||
|
||||
clearEc2CapacityCache();
|
||||
awsEc2Capacity.mockImplementation(async () => ({ state: "unknown" }));
|
||||
renderHost();
|
||||
await waitFor(() => expect(screen.getByText(/Could not read your EC2 capacity/)).toBeInTheDocument());
|
||||
expect(ec2Segment()).toBeDisabled();
|
||||
});
|
||||
|
||||
it("switches to EC2 through launchTypePatch: sidecar and Spot off, sizes fitted", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, cpu: 4096, memory_mib: 16384, spot: true, gateway_sidecar: true };
|
||||
renderHost(p);
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
fireEvent.click(ec2Segment());
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(1));
|
||||
expect(save.mock.calls[0][0].aws).toMatchObject({
|
||||
launch_type: "ec2",
|
||||
gateway_sidecar: false,
|
||||
spot: false,
|
||||
cpu: 1920,
|
||||
memory_mib: 7373,
|
||||
});
|
||||
expect(save.mock.calls[0][0].allow_docker_access).toBeUndefined();
|
||||
});
|
||||
|
||||
it("switches back to Fargate turning Docker access and VPN off, with a Fargate size", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
const p = ec2Project({ allow_docker_access: true, vpn_support_enabled: true });
|
||||
p.aws = { ...p.aws!, cpu: 1920, memory_mib: 7373 };
|
||||
renderHost(p);
|
||||
fireEvent.click(screen.getByRole("radio", { name: "Fargate" }));
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(1));
|
||||
const patch = save.mock.calls[0][0];
|
||||
expect(patch).toMatchObject({ allow_docker_access: false, vpn_support_enabled: false });
|
||||
expect(patch.aws).toMatchObject({ launch_type: "fargate", cpu: 1024, memory_mib: 7168 });
|
||||
});
|
||||
|
||||
it("an EC2 project keeps its launch type selectable back to Fargate even without capacity, and says why it can't start", async () => {
|
||||
renderHost(ec2Project());
|
||||
await waitFor(() => expect(screen.getByText(/can't start on EC2 now/)).toBeInTheDocument());
|
||||
expect(ec2Segment()).toHaveAttribute("aria-checked", "true");
|
||||
expect(screen.getByRole("radio", { name: "Fargate" })).toBeEnabled();
|
||||
});
|
||||
|
||||
it("on EC2: reservation inputs with the instance's limits, no ephemeral size, Spot or architecture, and the notes", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
renderHost(ec2Project());
|
||||
await waitFor(() => expect(screen.getByText(/Up to 1920 on your m7i.large/)).toBeInTheDocument());
|
||||
expect(screen.getByText(/Up to 7373 MiB on your m7i.large/)).toBeInTheDocument();
|
||||
expect(screen.getByLabelText("CPU reservation (units)")).toHaveValue("1024");
|
||||
expect(screen.getByLabelText("Memory reservation (MiB)")).toHaveValue("4096");
|
||||
expect(screen.queryByLabelText("Ephemeral storage (GiB)")).toBeNull();
|
||||
expect(screen.queryByRole("switch", { name: "Spot" })).toBeNull();
|
||||
expect(screen.queryByRole("radiogroup", { name: "Architecture" })).toBeNull();
|
||||
const notes = screen.getByRole("note", { name: "On EC2" });
|
||||
expect(notes).toHaveTextContent(/first start after idle boots an instance — about 3 minutes/);
|
||||
expect(notes).toHaveTextContent(/root on your own instance/);
|
||||
expect(notes).toHaveTextContent(/gateway sidecar is not available on EC2/);
|
||||
// Fargate shows none of this.
|
||||
cleanup();
|
||||
renderHost(awsProject());
|
||||
expect(screen.queryByRole("note", { name: "On EC2" })).toBeNull();
|
||||
expect(screen.getByLabelText("Ephemeral storage (GiB)")).toBeInTheDocument();
|
||||
expect(screen.getByRole("switch", { name: "Spot" })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("checks the reservations with the backend's fit rule before saving", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
ec2FitProblem.mockImplementation(async (config) =>
|
||||
(config as { memory_mib: number }).memory_mib === 8000
|
||||
? "This project reserves 1024 CPU units and 8000 MiB of memory, more than …"
|
||||
: null,
|
||||
);
|
||||
renderHost(ec2Project());
|
||||
await waitFor(() => expect(screen.getByText(/Up to 1920/)).toBeInTheDocument());
|
||||
// The load-time check found the stored 4096 MiB fits: no alert.
|
||||
await waitFor(() => expect(ec2FitProblem).toHaveBeenCalledTimes(1));
|
||||
expect(screen.queryByRole("alert")).toBeNull();
|
||||
const mem = screen.getByLabelText("Memory reservation (MiB)");
|
||||
fireEvent.change(mem, { target: { value: "8000" } });
|
||||
fireEvent.blur(mem);
|
||||
await waitFor(() => expect(screen.getByRole("alert")).toHaveTextContent(/more than/));
|
||||
expect(ec2FitProblem).toHaveBeenLastCalledWith(expect.objectContaining({ cpu: 1024, memory_mib: 8000 }), "m7i.large");
|
||||
expect(save).not.toHaveBeenCalled();
|
||||
|
||||
fireEvent.change(mem, { target: { value: "6000" } });
|
||||
fireEvent.blur(mem);
|
||||
await waitFor(() => expect(save).toHaveBeenCalledTimes(1));
|
||||
expect(save.mock.calls[0][0].aws).toMatchObject({ cpu: 1024, memory_mib: 6000 });
|
||||
|
||||
const cpu = screen.getByLabelText("CPU reservation (units)");
|
||||
fireEvent.change(cpu, { target: { value: "0" } });
|
||||
fireEvent.blur(cpu);
|
||||
await waitFor(() => expect(screen.getByRole("alert")).toHaveTextContent(/positive whole numbers/));
|
||||
});
|
||||
|
||||
it("warns on load when the saved reservations no longer fit the instance type, once", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
ec2FitProblem.mockImplementation(async () => "This project reserves 4096 CPU units …, more than an m7i.large");
|
||||
const p = ec2Project();
|
||||
p.aws = { ...p.aws!, cpu: 4096 };
|
||||
const { rerender } = renderHost(p);
|
||||
await waitFor(() =>
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/saved reservations no longer fit: .*more than an m7i.large/),
|
||||
);
|
||||
expect(ec2FitProblem).toHaveBeenCalledWith(expect.objectContaining({ cpu: 4096 }), "m7i.large");
|
||||
rerender(<HostSection project={{ ...p }} save={save} disabled={false} />);
|
||||
await act(async () => {});
|
||||
expect(ec2FitProblem).toHaveBeenCalledTimes(1);
|
||||
expect(save).not.toHaveBeenCalled();
|
||||
cleanup();
|
||||
|
||||
// Fargate projects, and EC2 without a known instance type, aren't checked.
|
||||
ec2FitProblem.mockClear();
|
||||
renderHost(awsProject());
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
cleanup();
|
||||
clearEc2CapacityCache();
|
||||
awsEc2Capacity.mockImplementation(async () => NO_EC2);
|
||||
renderHost(ec2Project());
|
||||
await waitFor(() => expect(screen.getByText(/can't start on EC2 now/)).toBeInTheDocument());
|
||||
expect(ec2FitProblem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("says what a launch-type switch changed besides the type", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, cpu: 4096, memory_mib: 16384, spot: true, gateway_sidecar: true };
|
||||
renderHost(p);
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
fireEvent.click(ec2Segment());
|
||||
expect(await screen.findByRole("status")).toHaveTextContent(
|
||||
"Switched to EC2: CPU 4096 → 1920 units, memory 16384 → 7373 MiB, Spot turned off, LLM gateway sidecar turned off.",
|
||||
);
|
||||
cleanup();
|
||||
|
||||
const back = ec2Project({ allow_docker_access: true, vpn_support_enabled: true });
|
||||
back.aws = { ...back.aws!, cpu: 1920, memory_mib: 7373 };
|
||||
renderHost(back);
|
||||
fireEvent.click(screen.getByRole("radio", { name: "Fargate" }));
|
||||
expect(await screen.findByRole("status")).toHaveTextContent(
|
||||
"Switched to Fargate: CPU 1920 → 1024 units, memory 7373 → 7168 MiB, Docker access turned off, VPN support turned off.",
|
||||
);
|
||||
});
|
||||
|
||||
const switchedProject = () => {
|
||||
const p = awsProject();
|
||||
p.aws = { ...p.aws!, cpu: 4096, memory_mib: 16384, spot: true, gateway_sidecar: true };
|
||||
return p;
|
||||
};
|
||||
|
||||
it("shows no switch note when the save was refused", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
renderHost(switchedProject());
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
save.mockResolvedValueOnce(false);
|
||||
fireEvent.click(ec2Segment());
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
await new Promise((r) => setTimeout(r, 0));
|
||||
expect(screen.queryByText(/Switched to/)).toBeNull();
|
||||
});
|
||||
|
||||
it("shows no switch note when the save fails", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
renderHost(switchedProject());
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
const unhandled = vi.fn();
|
||||
process.on("unhandledRejection", unhandled);
|
||||
save.mockRejectedValueOnce(new Error("boom"));
|
||||
fireEvent.click(ec2Segment());
|
||||
await waitFor(() => expect(save).toHaveBeenCalled());
|
||||
await new Promise((r) => setTimeout(r, 0));
|
||||
process.off("unhandledRejection", unhandled);
|
||||
expect(screen.queryByText(/Switched to/)).toBeNull();
|
||||
});
|
||||
|
||||
it("drops the switch note when another setting is saved afterwards", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
renderHost(switchedProject());
|
||||
await waitFor(() => expect(ec2Segment()).toBeEnabled());
|
||||
fireEvent.click(ec2Segment());
|
||||
expect(await screen.findByText(/Switched to EC2/)).toBeInTheDocument();
|
||||
fireEvent.click(screen.getByRole("radio", { name: "Fargate" }));
|
||||
await waitFor(() => expect(screen.queryByText(/Switched to EC2/)).toBeNull());
|
||||
});
|
||||
|
||||
it("prices an EC2 project as the user's instance type", async () => {
|
||||
awsEc2Capacity.mockImplementation(async () => M7I);
|
||||
useAppState.setState({
|
||||
appSettings: { hosts: [{ id: "c1", name: "lab" }] } as unknown as AppSettings,
|
||||
});
|
||||
const p = ec2Project();
|
||||
renderHost(p);
|
||||
await waitFor(() => expect(awsCostEstimate).toHaveBeenCalledWith("c1", "eu-west-1", p.aws, "m7i.large"));
|
||||
expect(screen.getByText(/price in this region of your EC2 instance \(m7i.large\)/)).toBeInTheDocument();
|
||||
useAppState.setState({ appSettings: null });
|
||||
});
|
||||
});
|
||||
|
||||
describe("RuntimeSection on EC2", () => {
|
||||
it("enables Docker access and VPN, keeps the sandbox off, and says Docker access is root on the instance", () => {
|
||||
render(<RuntimeSection project={ec2Project({ sandbox_mode_enabled: true })} save={save} disabled={false} />);
|
||||
for (const name of ["Allow container spawning", "VPN support"]) {
|
||||
expect(toggle(name)).toBeEnabled();
|
||||
}
|
||||
// E8, measured live: bubblewrap can't run in an ECS task on EC2 either.
|
||||
expect(toggle("Sandbox mode")).toBeDisabled();
|
||||
expect(toggle("Sandbox mode")).toHaveAttribute("aria-checked", "false");
|
||||
expect(screen.getByText(/root on your own instance/)).toBeInTheDocument();
|
||||
expect(screen.getByText(/Off on AWS for now/)).toBeInTheDocument();
|
||||
// The VPN hint speaks of an ECS task on the user's instance, not of
|
||||
// recreating a container or its volumes.
|
||||
const vpn = screen.getByText(/VPN client \(PIA, WireGuard, OpenVPN\)/);
|
||||
expect(vpn).toHaveTextContent(/an ECS task on your own EC2 instance/);
|
||||
expect(vpn).toHaveTextContent(/next start/);
|
||||
expect(vpn).not.toHaveTextContent(/recreates the container|volumes/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,15 +1,44 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import type { AwsWorkspaceConfig, HostConnection, Project, RepoSource } from "../../../../lib/types";
|
||||
import { useEffect, useRef, useState } from "react";
|
||||
import type {
|
||||
AwsWorkspaceConfig,
|
||||
Ec2Capacity,
|
||||
HostConnection,
|
||||
LaunchType,
|
||||
Project,
|
||||
RepoSource,
|
||||
} from "../../../../lib/types";
|
||||
import * as commands from "../../../../lib/tauri-commands";
|
||||
import { environmentMaxHours } from "../../../../lib/environmentMaxHours";
|
||||
import { useEc2Capacity } from "../../../../lib/ec2Capacity";
|
||||
import { useAppState } from "../../../../store/appState";
|
||||
import {
|
||||
COPY_AT_CONNECT_GATEWAY_NOTE,
|
||||
GATEWAY_SIDECAR_MIN_CPU,
|
||||
COPY_AT_CONNECT_HINT,
|
||||
COPY_AT_CONNECT_SSH_NOTE,
|
||||
COPY_AT_CONNECT_WARNINGS,
|
||||
SECRETS_MANAGER_HINT,
|
||||
SETUP_SCRIPT_COPY_AT_CONNECT_NOTE,
|
||||
SETUP_SCRIPT_HINT,
|
||||
MAX_SETUP_SCRIPT_BYTES,
|
||||
setupScriptProblem,
|
||||
EFS_HINT,
|
||||
EPHEMERAL_WARNING,
|
||||
EC2_DOCKER_ACCESS_NOTE,
|
||||
EC2_NO_CAPACITY,
|
||||
EC2_NO_SIDECAR,
|
||||
EC2_SCALE_TO_ZERO_NOTE,
|
||||
PERSISTENT_TERMINALS_NOTE,
|
||||
launchTypeChanges,
|
||||
launchTypePatch,
|
||||
type Ec2Limits,
|
||||
FARGATE_CPUS,
|
||||
defaultAwsWorkspace,
|
||||
formatCpu,
|
||||
formatMemory,
|
||||
memoryError,
|
||||
hasSavedFiles,
|
||||
hasWorkspaceFiles,
|
||||
memoryOptions,
|
||||
nearestMemory,
|
||||
} from "../../../../lib/awsWorkspace";
|
||||
@@ -17,8 +46,9 @@ import Button from "../../../ui/Button";
|
||||
import Modal from "../../../ui/Modal";
|
||||
import Toggle from "../../../ui/Toggle";
|
||||
import SegmentedControl from "../../../ui/SegmentedControl";
|
||||
import Field, { ConfigGroup, SwitchRow, inputClass, selectClass } from "../../../ui/Field";
|
||||
import Field, { ConfigGroup, SwitchRow, inputClass, monoInputClass, selectClass } from "../../../ui/Field";
|
||||
import RepoListEditor from "../../RepoListEditor";
|
||||
import AwsCostEstimate from "../AwsCostEstimate";
|
||||
|
||||
interface Props {
|
||||
project: Project;
|
||||
@@ -29,6 +59,21 @@ interface Props {
|
||||
const DEFAULT_IDLE_MINUTES = 60;
|
||||
const STILL_RUNNING = "The task is still running — stop it first.";
|
||||
|
||||
/** Why EC2 can't be chosen, from what the user's record says (null: it can). */
|
||||
function ec2Unavailable(capacity: Ec2Capacity | null): string | null {
|
||||
if (capacity === null) return "Checking your EC2 capacity in this environment…";
|
||||
switch (capacity.state) {
|
||||
case "ec2":
|
||||
return null;
|
||||
case "none":
|
||||
return `You have no EC2 capacity in this environment. ${EC2_NO_CAPACITY}.`;
|
||||
case "unusable":
|
||||
return `Your EC2 capacity record can't be used (${capacity.reason}). ${EC2_NO_CAPACITY}.`;
|
||||
case "unknown":
|
||||
return "Could not read your EC2 capacity in this environment; EC2 is offered once it can be read.";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Where an AWS project runs and what its Fargate task looks like. Only shown
|
||||
* for AWS projects; a local project's host is chosen when it is added.
|
||||
@@ -41,6 +86,7 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
const hosts = useAppState((s) => s.appSettings?.hosts ?? NO_HOSTS);
|
||||
const connection = hosts.find((h) => h.id === project.host_id);
|
||||
|
||||
const [cpuText, setCpuText] = useState(String(aws.cpu));
|
||||
const [memory, setMemory] = useState(String(aws.memory_mib));
|
||||
const [memoryProblem, setMemoryProblem] = useState<string | null>(null);
|
||||
const [ephemeral, setEphemeral] = useState(String(aws.ephemeral_gib));
|
||||
@@ -48,21 +94,168 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
const [idle, setIdle] = useState(String(aws.idle_stop_minutes ?? DEFAULT_IDLE_MINUTES));
|
||||
const [idleProblem, setIdleProblem] = useState<string | null>(null);
|
||||
const [confirmRemoveResources, setConfirmRemoveResources] = useState(false);
|
||||
const [setupScript, setSetupScript] = useState(aws.setup_script ?? "");
|
||||
const [setupProblem, setSetupProblem] = useState<string | null>(null);
|
||||
// The environment's advisory lifetime cap (Q8), from its record.
|
||||
const [maxHours, setMaxHours] = useState<number | null>(null);
|
||||
// What the last launch-type switch changed besides the type (M6).
|
||||
const [switchNote, setSwitchNote] = useState<string | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
setCpuText(String(aws.cpu));
|
||||
setMemory(String(aws.memory_mib));
|
||||
setEphemeral(String(aws.ephemeral_gib));
|
||||
setIdle(String(aws.idle_stop_minutes ?? DEFAULT_IDLE_MINUTES));
|
||||
}, [aws.memory_mib, aws.ephemeral_gib, aws.idle_stop_minutes]);
|
||||
}, [aws.cpu, aws.memory_mib, aws.ephemeral_gib, aws.idle_stop_minutes]);
|
||||
|
||||
const saveAws = (patch: Partial<AwsWorkspaceConfig>) => save({ aws: { ...aws, ...patch } });
|
||||
// Phase 7: the user's own EC2 capacity in this environment (their record),
|
||||
// which decides whether EC2 can be chosen and what it can reserve.
|
||||
const capacity = useEc2Capacity(project);
|
||||
const ec2 = aws.launch_type === "ec2";
|
||||
const compute = capacity?.state === "ec2" ? capacity.compute : null;
|
||||
const limits: Ec2Limits | null =
|
||||
capacity?.state === "ec2" && capacity.available_cpu !== null && capacity.available_memory_mib !== null
|
||||
? { cpu: capacity.available_cpu, memory_mib: capacity.available_memory_mib }
|
||||
: null;
|
||||
const ec2Reason = ec2Unavailable(capacity);
|
||||
|
||||
const hasResources = !!(aws.task_arn || aws.access_point_id || aws.task_definition_arn);
|
||||
// A removal that kept the saved files keeps their access point stored.
|
||||
const onlyAccessPoint = !!aws.access_point_id && !aws.task_arn && !aws.task_definition_arn;
|
||||
// Once the instance type is known, check the stored reservations against
|
||||
// it (Rust's fit rule): an instance type changed at onboarding, or a
|
||||
// record that came back after a save, can leave them too big.
|
||||
const checkedFit = useRef<string | null>(null);
|
||||
useEffect(() => {
|
||||
if (!ec2 || !compute) return;
|
||||
const key = `${project.id}:${compute.instance_type}`;
|
||||
if (checkedFit.current === key) return;
|
||||
checkedFit.current = key;
|
||||
let cancelled = false;
|
||||
commands
|
||||
.ec2FitProblem(latest.current.value, compute.instance_type)
|
||||
.then((problem) => {
|
||||
if (!cancelled && problem) setMemoryProblem(`The saved reservations no longer fit: ${problem}`);
|
||||
})
|
||||
.catch(() => {}); // The start checks again.
|
||||
return () => {
|
||||
cancelled = true;
|
||||
};
|
||||
}, [ec2, compute, project.id]);
|
||||
|
||||
useEffect(() => {
|
||||
setSetupScript(aws.setup_script ?? "");
|
||||
}, [aws.setup_script]);
|
||||
|
||||
const region = project.aws_placement?.region;
|
||||
const environment = project.aws_placement?.environment;
|
||||
useEffect(() => {
|
||||
setMaxHours(null);
|
||||
if (!project.host_id || !region || !environment) return;
|
||||
let cancelled = false;
|
||||
// Best effort: an unreadable record just shows no cap line. Cached per
|
||||
// environment, so re-opening this section doesn't ask AWS again.
|
||||
environmentMaxHours(project.id, project.host_id, region, environment)
|
||||
.then((h) => {
|
||||
if (!cancelled) setMaxHours(h);
|
||||
})
|
||||
.catch(() => {});
|
||||
return () => {
|
||||
cancelled = true;
|
||||
};
|
||||
}, [project.id, project.host_id, region, environment]);
|
||||
|
||||
// The config the next save starts from: the stored one plus every patch
|
||||
// saved since. A blur's save followed at once by a toggle's (before the
|
||||
// store has the first back) must not spread the render-time `aws` and
|
||||
// revert the first. Re-based on the prop when it changes with no save in
|
||||
// flight.
|
||||
const latest = useRef({ base: project.aws, value: aws, inFlight: 0 });
|
||||
if (latest.current.base !== project.aws && latest.current.inFlight === 0) {
|
||||
latest.current = { base: project.aws, value: aws, inFlight: 0 };
|
||||
}
|
||||
// Bumped by every save: a launch-type note only shows if no later save began.
|
||||
const saveSeq = useRef(0);
|
||||
const saveAws = async (patch: Partial<AwsWorkspaceConfig>, also: Partial<Project> = {}) => {
|
||||
saveSeq.current += 1;
|
||||
setSwitchNote(null);
|
||||
const l = latest.current;
|
||||
const next = { ...l.value, ...patch };
|
||||
l.value = next;
|
||||
l.inFlight += 1;
|
||||
// A refused save is not the config any more: start again from the store.
|
||||
const refused = () => {
|
||||
if (l.value === next) l.value = l.base ?? defaultAwsWorkspace();
|
||||
};
|
||||
try {
|
||||
const ok = await save({ ...also, aws: next });
|
||||
if (!ok) refused();
|
||||
return ok;
|
||||
} catch (e) {
|
||||
refused();
|
||||
throw e;
|
||||
} finally {
|
||||
l.inFlight -= 1;
|
||||
}
|
||||
};
|
||||
|
||||
const hasResources = !!(
|
||||
aws.task_arn ||
|
||||
aws.access_point_id ||
|
||||
aws.workspace_access_point_id ||
|
||||
aws.task_definition_arn
|
||||
);
|
||||
// A removal that kept the saved files keeps their access points stored.
|
||||
const onlyAccessPoint =
|
||||
!!(aws.access_point_id || aws.workspace_access_point_id) &&
|
||||
!aws.task_arn &&
|
||||
!aws.task_definition_arn;
|
||||
// Switched away from EFS: its /workspace files are still on their access point.
|
||||
const keptWorkspaceFiles = aws.storage !== "efs" && !!aws.workspace_access_point_id;
|
||||
// Not `disabled` (which also allows Error): on AWS, Error can mean a live task.
|
||||
const stopped = project.status === "stopped";
|
||||
|
||||
// The launch-type switch: `launchTypePatch` keeps each side to what Rust
|
||||
// accepts there (Docker/VPN, the sidecar, Spot, the sizes).
|
||||
const switchLaunchType = (launch_type: LaunchType) => {
|
||||
if (launch_type === latest.current.value.launch_type) return;
|
||||
setMemoryProblem(null);
|
||||
const before = { ...project, aws: latest.current.value };
|
||||
const patch = launchTypePatch(before, launch_type, limits);
|
||||
const note = launchTypeChanges(before, patch);
|
||||
const { aws: next, ...also } = patch;
|
||||
// Shown only once the save went through, and dropped by any later save.
|
||||
const pending = saveAws(next!, also);
|
||||
const seq = saveSeq.current;
|
||||
void pending.then((ok) => {
|
||||
if (ok && saveSeq.current === seq) setSwitchNote(note);
|
||||
});
|
||||
};
|
||||
|
||||
// EC2 reservations: positive whole numbers that fit the user's instance
|
||||
// type — checked by Rust's own fit rule (`ec2_fit_problem`), so this never
|
||||
// disagrees with the start.
|
||||
const commitEc2Sizing = async () => {
|
||||
const cpu = Number(cpuText);
|
||||
const memory_mib = Number(memory);
|
||||
const whole = (n: number) => Number.isInteger(n) && n > 0;
|
||||
if (!whole(cpu) || !whole(memory_mib)) {
|
||||
setMemoryProblem("The CPU and memory reservations must be positive whole numbers");
|
||||
return;
|
||||
}
|
||||
if (compute) {
|
||||
let problem: string | null = null;
|
||||
try {
|
||||
problem = await commands.ec2FitProblem({ ...aws, cpu, memory_mib }, compute.instance_type);
|
||||
} catch {
|
||||
problem = null; // The start checks again.
|
||||
}
|
||||
if (problem) {
|
||||
setMemoryProblem(problem);
|
||||
return;
|
||||
}
|
||||
}
|
||||
setMemoryProblem(null);
|
||||
if (cpu !== aws.cpu || memory_mib !== aws.memory_mib) void saveAws({ cpu, memory_mib });
|
||||
};
|
||||
|
||||
const commitMemory = () => {
|
||||
const value = Number(memory);
|
||||
const problem = memoryError(aws.cpu, value);
|
||||
@@ -78,6 +271,16 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
if (ok && value !== aws.ephemeral_gib) void saveAws({ ephemeral_gib: value });
|
||||
};
|
||||
|
||||
const commitSetupScript = () => {
|
||||
const problem = setupScriptProblem(setupScript);
|
||||
setSetupProblem(problem);
|
||||
if (problem) return;
|
||||
const value = setupScript.trim() === "" ? null : setupScript;
|
||||
if (value !== (aws.setup_script ?? null)) void saveAws({ setup_script: value });
|
||||
};
|
||||
|
||||
const setupBytes = new TextEncoder().encode(setupScript).length;
|
||||
|
||||
const commitIdle = () => {
|
||||
const value = Number(idle);
|
||||
const ok = Number.isInteger(value) && value >= 5 && value <= 1440;
|
||||
@@ -88,7 +291,11 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
return (
|
||||
<ConfigGroup
|
||||
title="Host"
|
||||
description="This project runs as an AWS Fargate task. Changes apply on its next start."
|
||||
description={
|
||||
ec2
|
||||
? "This project runs on your own EC2 instances, as an ECS task. Changes apply on its next start."
|
||||
: "This project runs as an AWS Fargate task. Changes apply on its next start."
|
||||
}
|
||||
>
|
||||
<dl className="grid grid-cols-[auto_1fr] gap-x-4 gap-y-1 text-[13px]">
|
||||
<dt className="text-[var(--text-secondary)]">Connection</dt>
|
||||
@@ -106,77 +313,180 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
{project.aws_placement?.environment}
|
||||
</dd>
|
||||
</dl>
|
||||
{maxHours !== null && maxHours > 0 && (
|
||||
<p className="text-xs text-[var(--text-secondary)]">
|
||||
This environment stops workspaces after {maxHours} h (advisory).
|
||||
</p>
|
||||
)}
|
||||
<p className="text-xs text-[var(--text-secondary)]">{PERSISTENT_TERMINALS_NOTE}</p>
|
||||
|
||||
<div className="flex flex-wrap gap-4">
|
||||
<Field label="CPU">
|
||||
{(id) => (
|
||||
<select
|
||||
id={id}
|
||||
value={aws.cpu}
|
||||
disabled={disabled}
|
||||
className={selectClass}
|
||||
onChange={(e) => {
|
||||
const cpu = Number(e.target.value);
|
||||
const memory_mib = memoryError(cpu, aws.memory_mib)
|
||||
? nearestMemory(cpu, aws.memory_mib)
|
||||
: aws.memory_mib;
|
||||
setMemoryProblem(null);
|
||||
void saveAws({ cpu, memory_mib });
|
||||
}}
|
||||
>
|
||||
{FARGATE_CPUS.map((c) => (
|
||||
<option key={c} value={c}>
|
||||
{formatCpu(c)}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
)}
|
||||
</Field>
|
||||
<Field
|
||||
label="Memory (MiB)"
|
||||
hint={(() => {
|
||||
const opts = memoryOptions(aws.cpu);
|
||||
return `${formatMemory(opts[0])} to ${formatMemory(opts[opts.length - 1])} with ${formatCpu(aws.cpu)}.`;
|
||||
})()}
|
||||
>
|
||||
{(id) => (
|
||||
<>
|
||||
<div>
|
||||
<span className="block text-[13px] font-medium text-[var(--text-primary)] mb-1">
|
||||
Launch type
|
||||
</span>
|
||||
<SegmentedControl
|
||||
label="Launch type"
|
||||
value={aws.launch_type}
|
||||
disabled={disabled}
|
||||
onChange={switchLaunchType}
|
||||
segments={[
|
||||
{ value: "fargate", label: "Fargate" },
|
||||
{
|
||||
value: "ec2",
|
||||
label: compute ? `EC2 (your instance: ${compute.instance_type})` : "EC2",
|
||||
disabled: !compute && !ec2,
|
||||
},
|
||||
]}
|
||||
/>
|
||||
{ec2Reason && (
|
||||
<p
|
||||
className={`mt-1 text-xs ${ec2 && capacity !== null && capacity.state !== "unknown" ? "text-[var(--warning)]" : "text-[var(--text-secondary)]"}`}
|
||||
>
|
||||
{ec2 && capacity !== null && capacity.state !== "unknown"
|
||||
? `This project can't start on EC2 now: ${ec2Reason} Or switch it to Fargate.`
|
||||
: ec2Reason}
|
||||
</p>
|
||||
)}
|
||||
{switchNote && (
|
||||
<p role="status" className="mt-1 text-xs text-[var(--text-secondary)]">
|
||||
{switchNote}
|
||||
</p>
|
||||
)}
|
||||
{ec2 && (
|
||||
<ul
|
||||
role="note"
|
||||
aria-label="On EC2"
|
||||
className="mt-2 px-2 py-1.5 text-xs text-[var(--text-secondary)] bg-[var(--bg-secondary)] border border-[var(--border-color)] rounded-[var(--radius-control)] list-disc list-inside space-y-0.5"
|
||||
>
|
||||
<li>{EC2_SCALE_TO_ZERO_NOTE}</li>
|
||||
<li>{EC2_DOCKER_ACCESS_NOTE}</li>
|
||||
<li>{EC2_NO_SIDECAR}.</li>
|
||||
</ul>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{ec2 ? (
|
||||
<div className="flex flex-wrap gap-4">
|
||||
<Field
|
||||
label="CPU reservation (units)"
|
||||
hint={
|
||||
limits && compute
|
||||
? `1024 units = 1 vCPU. Up to ${limits.cpu} on your ${compute.instance_type}.`
|
||||
: "1024 units = 1 vCPU. It must fit your instance type."
|
||||
}
|
||||
>
|
||||
{(id) => (
|
||||
<input
|
||||
id={id}
|
||||
inputMode="numeric"
|
||||
value={cpuText}
|
||||
disabled={disabled}
|
||||
aria-invalid={memoryProblem ? true : undefined}
|
||||
onChange={(e) => setCpuText(e.target.value)}
|
||||
onBlur={() => void commitEc2Sizing()}
|
||||
onKeyDown={(e) => e.key === "Enter" && void commitEc2Sizing()}
|
||||
className={`w-32 ${inputClass}`}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
<Field
|
||||
label="Memory reservation (MiB)"
|
||||
hint={
|
||||
limits && compute
|
||||
? `Up to ${limits.memory_mib} MiB on your ${compute.instance_type} (a tenth is kept for the instance).`
|
||||
: "It must fit your instance type."
|
||||
}
|
||||
>
|
||||
{(id) => (
|
||||
<input
|
||||
id={id}
|
||||
inputMode="numeric"
|
||||
value={memory}
|
||||
disabled={disabled}
|
||||
list={`${id}-options`}
|
||||
aria-invalid={memoryProblem ? true : undefined}
|
||||
onChange={(e) => setMemory(e.target.value)}
|
||||
onBlur={commitMemory}
|
||||
onKeyDown={(e) => e.key === "Enter" && commitMemory()}
|
||||
onBlur={() => void commitEc2Sizing()}
|
||||
onKeyDown={(e) => e.key === "Enter" && void commitEc2Sizing()}
|
||||
className={`w-32 ${inputClass}`}
|
||||
/>
|
||||
<datalist id={`${id}-options`}>
|
||||
{memoryOptions(aws.cpu).map((m) => (
|
||||
<option key={m} value={m} />
|
||||
))}
|
||||
</datalist>
|
||||
</>
|
||||
)}
|
||||
</Field>
|
||||
<div>
|
||||
<span className="block text-[13px] font-medium text-[var(--text-primary)] mb-1">
|
||||
Architecture
|
||||
</span>
|
||||
<SegmentedControl
|
||||
label="Architecture"
|
||||
value={aws.arch}
|
||||
disabled={disabled}
|
||||
onChange={(arch) => void saveAws({ arch })}
|
||||
segments={[
|
||||
{ value: "x86_64", label: "x86_64" },
|
||||
{ value: "arm64", label: "ARM64 (Graviton)" },
|
||||
]}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
</div>
|
||||
</div>
|
||||
) : (
|
||||
<div className="flex flex-wrap gap-4">
|
||||
<Field label="CPU">
|
||||
{(id) => (
|
||||
<select
|
||||
id={id}
|
||||
value={aws.cpu}
|
||||
disabled={disabled}
|
||||
className={selectClass}
|
||||
onChange={(e) => {
|
||||
const cpu = Number(e.target.value);
|
||||
const memory_mib = memoryError(cpu, aws.memory_mib)
|
||||
? nearestMemory(cpu, aws.memory_mib)
|
||||
: aws.memory_mib;
|
||||
setMemoryProblem(null);
|
||||
void saveAws({ cpu, memory_mib });
|
||||
}}
|
||||
>
|
||||
{FARGATE_CPUS.filter(
|
||||
// The gateway sidecar needs 1 vCPU / 2 GiB (Rust validates it too).
|
||||
(c) => !aws.gateway_sidecar || c >= GATEWAY_SIDECAR_MIN_CPU,
|
||||
).map((c) => (
|
||||
<option key={c} value={c}>
|
||||
{formatCpu(c)}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
)}
|
||||
</Field>
|
||||
<Field
|
||||
label="Memory (MiB)"
|
||||
hint={(() => {
|
||||
const opts = memoryOptions(aws.cpu);
|
||||
return `${formatMemory(opts[0])} to ${formatMemory(opts[opts.length - 1])} with ${formatCpu(aws.cpu)}.`;
|
||||
})()}
|
||||
>
|
||||
{(id) => (
|
||||
<>
|
||||
<input
|
||||
id={id}
|
||||
inputMode="numeric"
|
||||
value={memory}
|
||||
disabled={disabled}
|
||||
list={`${id}-options`}
|
||||
aria-invalid={memoryProblem ? true : undefined}
|
||||
onChange={(e) => setMemory(e.target.value)}
|
||||
onBlur={commitMemory}
|
||||
onKeyDown={(e) => e.key === "Enter" && commitMemory()}
|
||||
className={`w-32 ${inputClass}`}
|
||||
/>
|
||||
<datalist id={`${id}-options`}>
|
||||
{memoryOptions(aws.cpu).map((m) => (
|
||||
<option key={m} value={m} />
|
||||
))}
|
||||
</datalist>
|
||||
</>
|
||||
)}
|
||||
</Field>
|
||||
<div>
|
||||
<span className="block text-[13px] font-medium text-[var(--text-primary)] mb-1">
|
||||
Architecture
|
||||
</span>
|
||||
<SegmentedControl
|
||||
label="Architecture"
|
||||
value={aws.arch}
|
||||
disabled={disabled}
|
||||
onChange={(arch) => void saveAws({ arch })}
|
||||
segments={[
|
||||
{ value: "x86_64", label: "x86_64" },
|
||||
{ value: "arm64", label: "ARM64 (Graviton)" },
|
||||
]}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
{memoryProblem && (
|
||||
<p role="alert" className="text-xs text-[var(--error)]">
|
||||
{memoryProblem}
|
||||
@@ -196,11 +506,9 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
segments={[
|
||||
{ value: "ephemeral", label: "Ephemeral", caution: true },
|
||||
{ value: "hybrid", label: "Hybrid" },
|
||||
{ value: "efs", label: "EFS" },
|
||||
]}
|
||||
/>
|
||||
<span className="text-xs text-[var(--text-disabled)]">
|
||||
EFS (everything persists) — coming later
|
||||
</span>
|
||||
</div>
|
||||
{aws.storage === "ephemeral" ? (
|
||||
<p
|
||||
@@ -209,53 +517,93 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
>
|
||||
{EPHEMERAL_WARNING} Push your work to a remote before stopping.
|
||||
</p>
|
||||
) : aws.storage === "efs" ? (
|
||||
<p className="mt-1 text-xs text-[var(--text-secondary)]">
|
||||
<span>{EFS_HINT}</span>. The Claude login and history
|
||||
{aws.secrets_delivery === "copy_at_connect" ? "" : ", and SSH keys,"} are kept on EFS too.
|
||||
</p>
|
||||
) : (
|
||||
<p className="mt-1 text-xs text-[var(--text-secondary)]">
|
||||
The Claude login, history and SSH keys are kept on EFS between starts; everything
|
||||
else, repositories included, starts fresh.
|
||||
{aws.secrets_delivery === "copy_at_connect"
|
||||
? "The Claude login and history are kept on EFS between starts; everything else, repositories and SSH keys included, starts fresh."
|
||||
: "The Claude login, history and SSH keys are kept on EFS between starts; everything else, repositories included, starts fresh."}
|
||||
</p>
|
||||
)}
|
||||
{keptWorkspaceFiles && (
|
||||
<p
|
||||
role="note"
|
||||
aria-label="EFS files kept"
|
||||
className="mt-2 px-2 py-1.5 text-xs text-[var(--text-secondary)] bg-[var(--bg-secondary)] border border-[var(--border-color)] rounded-[var(--radius-control)]"
|
||||
>
|
||||
The /workspace files from when this project used EFS storage stay on their access
|
||||
point until “Remove AWS resources” removes it (with the access points
|
||||
option checked). Switching back to EFS picks them up again.
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<Field
|
||||
label="Ephemeral storage (GiB)"
|
||||
hint="The task's local disk: 21 to 200 GiB. Repositories and builds live here."
|
||||
>
|
||||
{(id) => (
|
||||
<input
|
||||
id={id}
|
||||
inputMode="numeric"
|
||||
value={ephemeral}
|
||||
disabled={disabled}
|
||||
aria-invalid={ephemeralProblem ? true : undefined}
|
||||
onChange={(e) => setEphemeral(e.target.value)}
|
||||
onBlur={commitEphemeral}
|
||||
className={`w-24 ${inputClass}`}
|
||||
{!ec2 && (
|
||||
<>
|
||||
<Field
|
||||
label="Ephemeral storage (GiB)"
|
||||
hint={
|
||||
aws.storage === "efs"
|
||||
? "The task's local disk: 21 to 200 GiB. With EFS storage, /workspace is on EFS instead."
|
||||
: "The task's local disk: 21 to 200 GiB. Repositories and builds live here."
|
||||
}
|
||||
>
|
||||
{(id) => (
|
||||
<input
|
||||
id={id}
|
||||
inputMode="numeric"
|
||||
value={ephemeral}
|
||||
disabled={disabled}
|
||||
aria-invalid={ephemeralProblem ? true : undefined}
|
||||
onChange={(e) => setEphemeral(e.target.value)}
|
||||
onBlur={commitEphemeral}
|
||||
className={`w-24 ${inputClass}`}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
{ephemeralProblem && (
|
||||
<p role="alert" className="text-xs text-[var(--error)]">
|
||||
{ephemeralProblem}
|
||||
</p>
|
||||
)}
|
||||
|
||||
<SwitchRow
|
||||
label="Spot"
|
||||
hint={
|
||||
aws.wip_push_on_stop
|
||||
? "Runs on spare capacity at up to 70% off. AWS may reclaim it with two minutes' notice; the work-in-progress push below still runs."
|
||||
: "Runs on spare capacity at up to 70% off. AWS may reclaim it with two minutes' notice, and with the work-in-progress push below off, unpushed work is lost."
|
||||
}
|
||||
control={
|
||||
<Toggle
|
||||
label="Spot"
|
||||
checked={aws.spot}
|
||||
disabled={disabled}
|
||||
onChange={(spot) => void saveAws({ spot })}
|
||||
/>
|
||||
}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
{ephemeralProblem && (
|
||||
<p role="alert" className="text-xs text-[var(--error)]">
|
||||
{ephemeralProblem}
|
||||
</p>
|
||||
</>
|
||||
)}
|
||||
|
||||
<SwitchRow
|
||||
label="Spot"
|
||||
hint={
|
||||
aws.wip_push_on_stop
|
||||
? "Runs on spare capacity at up to 70% off. AWS may reclaim it with two minutes' notice; the work-in-progress push below still runs."
|
||||
: "Runs on spare capacity at up to 70% off. AWS may reclaim it with two minutes' notice, and with the work-in-progress push below off, unpushed work is lost."
|
||||
}
|
||||
control={
|
||||
<Toggle
|
||||
label="Spot"
|
||||
checked={aws.spot}
|
||||
disabled={disabled}
|
||||
onChange={(spot) => void saveAws({ spot })}
|
||||
/>
|
||||
}
|
||||
/>
|
||||
<section aria-label="Estimated cost">
|
||||
<h3 className="text-[13px] font-medium text-[var(--text-primary)]">Estimated cost</h3>
|
||||
<p className="mt-0.5 mb-1 text-xs text-[var(--text-secondary)] leading-snug">
|
||||
{ec2
|
||||
? `The on-demand price in this region of your EC2 instance${compute ? ` (${compute.instance_type})` : ""}, whatever this project reserves of it.`
|
||||
: "The on-demand Fargate price in this region for the CPU, memory, architecture and disk above."}
|
||||
</p>
|
||||
<AwsCostEstimate
|
||||
connectionId={connection ? connection.id : null}
|
||||
region={project.aws_placement?.region}
|
||||
config={aws}
|
||||
instanceType={compute?.instance_type ?? null}
|
||||
/>
|
||||
</section>
|
||||
|
||||
<SwitchRow
|
||||
label="Stop when idle"
|
||||
@@ -310,6 +658,40 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
}
|
||||
/>
|
||||
|
||||
<div>
|
||||
<span className="block text-[13px] font-medium text-[var(--text-primary)] mb-1">
|
||||
Credentials
|
||||
</span>
|
||||
<SegmentedControl
|
||||
label="Credentials"
|
||||
value={aws.secrets_delivery}
|
||||
disabled={disabled}
|
||||
onChange={(secrets_delivery) => void saveAws({ secrets_delivery })}
|
||||
segments={[
|
||||
{ value: "secrets_manager", label: "Stored in AWS (Secrets Manager)" },
|
||||
{ value: "copy_at_connect", label: "Copied when you connect" },
|
||||
]}
|
||||
/>
|
||||
{aws.secrets_delivery === "copy_at_connect" ? (
|
||||
<>
|
||||
<p className="mt-1 text-xs text-[var(--text-secondary)]">{COPY_AT_CONNECT_HINT}</p>
|
||||
<ul
|
||||
role="note"
|
||||
aria-label="Copied when you connect"
|
||||
className="mt-2 px-2 py-1.5 text-xs text-[var(--warning)] bg-[var(--warning-muted)] border border-[var(--warning)]/30 rounded-[var(--radius-control)] list-disc list-inside"
|
||||
>
|
||||
{COPY_AT_CONNECT_WARNINGS.map((w) => (
|
||||
<li key={w}>{w}</li>
|
||||
))}
|
||||
{aws.storage !== "ephemeral" && <li>{COPY_AT_CONNECT_SSH_NOTE}</li>}
|
||||
{aws.gateway_sidecar && <li>{COPY_AT_CONNECT_GATEWAY_NOTE}</li>}
|
||||
</ul>
|
||||
</>
|
||||
) : (
|
||||
<p className="mt-1 text-xs text-[var(--text-secondary)]">{SECRETS_MANAGER_HINT}</p>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<div className="pt-2 border-t border-[var(--border-color)]">
|
||||
<span className="block text-[13px] font-medium text-[var(--text-primary)]">
|
||||
Repositories
|
||||
@@ -325,6 +707,48 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="pt-2 border-t border-[var(--border-color)]">
|
||||
<Field
|
||||
label="Setup script"
|
||||
hint={
|
||||
<>
|
||||
{SETUP_SCRIPT_HINT}
|
||||
{aws.secrets_delivery === "copy_at_connect" && <> {SETUP_SCRIPT_COPY_AT_CONNECT_NOTE}</>}
|
||||
</>
|
||||
}
|
||||
>
|
||||
{(id) => (
|
||||
<>
|
||||
<textarea
|
||||
id={id}
|
||||
value={setupScript}
|
||||
disabled={disabled}
|
||||
rows={8}
|
||||
spellCheck={false}
|
||||
placeholder={"sudo apt-get update\nsudo apt-get install -y jq"}
|
||||
aria-invalid={setupProblem ? true : undefined}
|
||||
aria-describedby={`${id}-size`}
|
||||
onChange={(e) => setSetupScript(e.target.value)}
|
||||
onBlur={commitSetupScript}
|
||||
className={`${monoInputClass} min-h-[8rem] resize-y`}
|
||||
/>
|
||||
<p
|
||||
id={`${id}-size`}
|
||||
className={`mt-1 text-xs ${setupBytes > MAX_SETUP_SCRIPT_BYTES ? "text-[var(--error)]" : "text-[var(--text-secondary)]"}`}
|
||||
>
|
||||
{setupBytes.toLocaleString("en-US")} of {MAX_SETUP_SCRIPT_BYTES.toLocaleString("en-US")} bytes
|
||||
(32 KiB, UTF-8)
|
||||
</p>
|
||||
</>
|
||||
)}
|
||||
</Field>
|
||||
{setupProblem && (
|
||||
<p role="alert" className="mt-1 text-xs text-[var(--error)]">
|
||||
{setupProblem}
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<div className="pt-2 border-t border-[var(--border-color)] flex flex-wrap items-center gap-2">
|
||||
<Button
|
||||
size="md"
|
||||
@@ -346,7 +770,7 @@ export default function HostSection({ project, save, disabled }: Props) {
|
||||
!stopped
|
||||
? STILL_RUNNING
|
||||
: onlyAccessPoint
|
||||
? "The saved files' access point is still on AWS. Remove the AWS resources with \u201cAlso remove the workspace\u2019s file-system access point\u201d first."
|
||||
? "The saved files' access point is still on AWS. Remove the AWS resources with \u201cAlso remove the workspace\u2019s file-system access points\u201d first."
|
||||
: "Remove the workspace's AWS resources first, so nothing is left running or billed."
|
||||
}
|
||||
onClick={() => void save({ host_id: null, aws_placement: null, aws: null })}
|
||||
@@ -422,8 +846,11 @@ function RemoveAwsResourcesModal({ project, onClose }: { project: Project; onClo
|
||||
onChange={(e) => setDiscardData(e.target.checked)}
|
||||
/>
|
||||
<span>
|
||||
Also remove the workspace’s file-system access point
|
||||
Also remove the workspace’s file-system access points
|
||||
<span className="block text-xs text-[var(--text-secondary)]">
|
||||
{hasWorkspaceFiles(project)
|
||||
? "Both go: the one for the saved home files and the one for /workspace. "
|
||||
: ""}
|
||||
The files stay on your own EFS file system (only your workspace role can read
|
||||
them) until an administrator offboards you. Left unchecked, the access point
|
||||
stays too: the next start here reuses it, and the project can’t move to
|
||||
|
||||
Loaded 100 of 185 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user