Skip to content

Commit 5e1c6eb

Browse files
EmyrkEmyrk
committed
Merge remote-tracking branch 'origin/main' into stevenmasley/cors
2 parents 3dc00e1 + 1da27a1 commit 5e1c6eb

File tree

6,499 files changed

+174290
-63560
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

6,499 files changed

+174290
-63560
lines changed

‎.cursorrules

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Cursor Rules
2+
3+
This project is called "Coder" - an application for managing remote development environments.
4+
5+
Coder provides a platform for creating, managing, and using remote development environments (also known as Cloud Development Environments or CDEs). It leverages Terraform to define and provision these environments, which are referred to as "workspaces" within the project. The system is designed to be extensible, secure, and provide developers with a seamless remote development experience.
6+
7+
# Core Architecture
8+
9+
The heart of Coder is a control plane that orchestrates the creation and management of workspaces. This control plane interacts with separate Provisioner processes over gRPC to handle workspace builds. The Provisioners consume workspace definitions and use Terraform to create the actual infrastructure.
10+
11+
The CLI package serves dual purposes - it can be used to launch the control plane itself and also provides client functionality for users to interact with an existing control plane instance. All user-facing frontend code is developed in TypeScript using React and lives in the `site/` directory.
12+
13+
The database layer uses PostgreSQL with SQLC for generating type-safe database code. Database migrations are carefully managed to ensure both forward and backward compatibility through paired `.up.sql` and `.down.sql` files.
14+
15+
# API Design
16+
17+
Coder's API architecture combines REST and gRPC approaches. The REST API is defined in `coderd/coderd.go` and uses Chi for HTTP routing. This provides the primary interface for the frontend and external integrations.
18+
19+
Internal communication with Provisioners occurs over gRPC, with service definitions maintained in `.proto` files. This separation allows for efficient binary communication with the components responsible for infrastructure management while providing a standard REST interface for human-facing applications.
20+
21+
# Network Architecture
22+
23+
Coder implements a secure networking layer based on Tailscale's Wireguard implementation. The `tailnet` package provides connectivity between workspace agents and clients through DERP (Designated Encrypted Relay for Packets) servers when direct connections aren't possible. This creates a secure overlay network allowing access to workspaces regardless of network topology, firewalls, or NAT configurations.
24+
25+
## Tailnet and DERP System
26+
27+
The networking system has three key components:
28+
29+
1. **Tailnet**: An overlay network implemented in the `tailnet` package that provides secure, end-to-end encrypted connections between clients, the Coder server, and workspace agents.
30+
31+
2. **DERP Servers**: These relay traffic when direct connections aren't possible. Coder provides several options:
32+
- A built-in DERP server that runs on the Coder control plane
33+
- Integration with Tailscale's global DERP infrastructure
34+
- Support for custom DERP servers for lower latency or offline deployments
35+
36+
3. **Direct Connections**: When possible, the system establishes peer-to-peer connections between clients and workspaces using STUN for NAT traversal. This requires both endpoints to send UDP traffic on ephemeral ports.
37+
38+
## Workspace Proxies
39+
40+
Workspace proxies (in the Enterprise edition) provide regional relay points for browser-based connections, reducing latency for geo-distributed teams. Key characteristics:
41+
42+
- Deployed as independent servers that authenticate with the Coder control plane
43+
- Relay connections for SSH, workspace apps, port forwarding, and web terminals
44+
- Do not make direct database connections
45+
- Managed through the `coder wsproxy` commands
46+
- Implemented primarily in the `enterprise/wsproxy/` package
47+
48+
# Agent System
49+
50+
The workspace agent runs within each provisioned workspace and provides core functionality including:
51+
- SSH access to workspaces via the `agentssh` package
52+
- Port forwarding
53+
- Terminal connectivity via the `pty` package for pseudo-terminal support
54+
- Application serving
55+
- Healthcheck monitoring
56+
- Resource usage reporting
57+
58+
Agents communicate with the control plane using the tailnet system and authenticate using secure tokens.
59+
60+
# Workspace Applications
61+
62+
Workspace applications (or "apps") provide browser-based access to services running within workspaces. The system supports:
63+
64+
- HTTP(S) and WebSocket connections
65+
- Path-based or subdomain-based access URLs
66+
- Health checks to monitor application availability
67+
- Different sharing levels (owner-only, authenticated users, or public)
68+
- Custom icons and display settings
69+
70+
The implementation is primarily in the `coderd/workspaceapps/` directory with components for URL generation, proxying connections, and managing application state.
71+
72+
# Implementation Details
73+
74+
The project structure separates frontend and backend concerns. React components and pages are organized in the `site/src/` directory, with Jest used for testing. The backend is primarily written in Go, with a strong emphasis on error handling patterns and test coverage.
75+
76+
Database interactions are carefully managed through migrations in `coderd/database/migrations/` and queries in `coderd/database/queries/`. All new queries require proper database authorization (dbauthz) implementation to ensure that only users with appropriate permissions can access specific resources.
77+
78+
# Authorization System
79+
80+
The database authorization (dbauthz) system enforces fine-grained access control across all database operations. It uses role-based access control (RBAC) to validate user permissions before executing database operations. The `dbauthz` package wraps the database store and performs authorization checks before returning data. All database operations must pass through this layer to ensure security.
81+
82+
# Testing Framework
83+
84+
The codebase has a comprehensive testing approach with several key components:
85+
86+
1. **Parallel Testing**: All tests must use `t.Parallel()` to run concurrently, which improves test suite performance and helps identify race conditions.
87+
88+
2. **coderdtest Package**: This package in `coderd/coderdtest/` provides utilities for creating test instances of the Coder server, setting up test users and workspaces, and mocking external components.
89+
90+
3. **Integration Tests**: Tests often span multiple components to verify system behavior, such as template creation, workspace provisioning, and agent connectivity.
91+
92+
4. **Enterprise Testing**: Enterprise features have dedicated test utilities in the `coderdenttest` package.
93+
94+
# Open Source and Enterprise Components
95+
96+
The repository contains both open source and enterprise components:
97+
98+
- Enterprise code lives primarily in the `enterprise/` directory
99+
- Enterprise features focus on governance, scalability (high availability), and advanced deployment options like workspace proxies
100+
- The boundary between open source and enterprise is managed through a licensing system
101+
- The same core codebase supports both editions, with enterprise features conditionally enabled
102+
103+
# Development Philosophy
104+
105+
Coder emphasizes clear error handling, with specific patterns required:
106+
- Concise error messages that avoid phrases like "failed to"
107+
- Wrapping errors with `%w` to maintain error chains
108+
- Using sentinel errors with the "err" prefix (e.g., `errNotFound`)
109+
110+
All tests should run in parallel using `t.Parallel()` to ensure efficient testing and expose potential race conditions. The codebase is rigorously linted with golangci-lint to maintain consistent code quality.
111+
112+
Git contributions follow a standard format with commit messages structured as `type: <message>`, where type is one of `feat`, `fix`, or `chore`.
113+
114+
# Development Workflow
115+
116+
Development can be initiated using `scripts/develop.sh` to start the application after making changes. Database schema updates should be performed through the migration system using `create_migration.sh <name>` to generate migration files, with each `.up.sql` migration paired with a corresponding `.down.sql` that properly reverts all changes.
117+
118+
If the development database gets into a bad state, it can be completely reset by removing the PostgreSQL data directory with `rm -rf .coderv2/postgres`. This will destroy all data in the development database, requiring you to recreate any test users, templates, or workspaces after restarting the application.
119+
120+
Code generation for the database layer uses `coderd/database/generate.sh`, and developers should refer to `sqlc.yaml` for the appropriate style and patterns to follow when creating new queries or tables.
121+
122+
The focus should always be on maintaining security through proper database authorization, clean error handling, and comprehensive test coverage to ensure the platform remains robust and reliable.

‎.devcontainer/devcontainer.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,10 @@
99
}
1010
},
1111
// SYS_PTRACE to enable go debugging
12-
"runArgs": ["--cap-add=SYS_PTRACE"]
12+
"runArgs": ["--cap-add=SYS_PTRACE"],
13+
"customizations": {
14+
"vscode": {
15+
"extensions": ["biomejs.biome"]
16+
}
17+
}
1318
}

‎.dockerignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Generated files
2+
agent/agentcontainers/acmock/acmock.go linguist-generated=true
3+
agent/agentcontainers/dcspec/dcspec_gen.go linguist-generated=true
4+
agent/agentcontainers/testdata/devcontainercli/*/*.log linguist-generated=true
25
coderd/apidoc/docs.go linguist-generated=true
36
docs/reference/api/*.md linguist-generated=true
47
docs/reference/cli/*.md linguist-generated=true

‎.github/.linkspector.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,11 @@ ignorePatterns:
1818
- pattern: "i.imgur.com"
1919
- pattern: "code.visualstudio.com"
2020
- pattern: "www.emacswiki.org"
21+
- pattern: "linux.die.net/man"
22+
- pattern: "www.gnu.org"
23+
- pattern: "wiki.ubuntu.com"
24+
- pattern: "mutagen.io"
25+
- pattern: "docs.github.com"
26+
- pattern: "claude.ai"
2127
aliveStatusCodes:
2228
- 200

‎.github/ISSUE_TEMPLATE/1-bug.yaml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: "🐞 Bug"
2+
description: "File a bug report."
3+
title: "bug: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: checkboxes
7+
id: existing_issues
8+
attributes:
9+
label: "Is there an existing issue for this?"
10+
description: "Please search to see if an issue already exists for the bug you encountered."
11+
options:
12+
- label: "I have searched the existing issues"
13+
required: true
14+
15+
- type: textarea
16+
id: issue
17+
attributes:
18+
label: "Current Behavior"
19+
description: "A concise description of what you're experiencing."
20+
placeholder: "Tell us what you see!"
21+
validations:
22+
required: false
23+
24+
- type: textarea
25+
id: logs
26+
attributes:
27+
label: "Relevant Log Output"
28+
description: "Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks."
29+
render: shell
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: "Expected Behavior"
35+
description: "A concise description of what you expected to happen."
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: steps_to_reproduce
41+
attributes:
42+
label: "Steps to Reproduce"
43+
description: "Provide step-by-step instructions to reproduce the issue."
44+
placeholder: |
45+
1. First step
46+
2. Second step
47+
3. Another step
48+
4. Issue occurs
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: environment
54+
attributes:
55+
label: "Environment"
56+
description: |
57+
Provide details about your environment:
58+
- **Host OS**: (e.g., Ubuntu 24.04, Debian 12)
59+
- **Coder Version**: (e.g., v2.18.4)
60+
placeholder: |
61+
Run `coder version` to get Coder version
62+
value: |
63+
- Host OS:
64+
- Coder version:
65+
validations:
66+
required: false
67+
68+
- type: dropdown
69+
id: additional_info
70+
attributes:
71+
label: "Additional Context"
72+
description: "Select any applicable options:"
73+
multiple: true
74+
options:
75+
- "The issue occurs consistently"
76+
- "The issue is new (previously worked fine)"
77+
- "The issue happens on multiple deployments"
78+
- "I have tested this on the latest version"

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: Questions, suggestion or feature requests?
3+
url: https://github.com/coder/coder/discussions/new/choose
4+
about: Our preferred starting point if you have any questions or suggestions about configuration, features or unexpected behavior.
5+
- name: Coder Docs
6+
url: https://coder.com/docs
7+
about: Check our docs.
8+
- name: Coder Discord Community
9+
url: https://discord.gg/coder
10+
about: Get in touch with the Coder developers and community for support.

‎.github/actions/install-cosign/action.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: "Install cosign"
2+
description: |
3+
Cosign Github Action.
4+
runs:
5+
using: "composite"
6+
steps:
7+
- name: Install cosign
8+
uses: sigstore/cosign-installer@d7d6bc7722e3daa8354c50bcb52f4837da5e9b6a # v3.8.1
9+
with:
10+
cosign-release: "v2.4.3"

‎.github/actions/install-syft/action.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: "Install syft"
2+
description: |
3+
Downloads Syft to the Action tool cache and provides a reference.
4+
runs:
5+
using: "composite"
6+
steps:
7+
- name: Install syft
8+
uses: anchore/sbom-action/download-syft@f325610c9f50a54015d37c8d16cb3b0e2c8f4de0 # v0.18.0
9+
with:
10+
syft-version: "v1.20.0"

‎.github/actions/setup-go-tools/action.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Setup Go tools"
2+
description: |
3+
Set up tools for `make gen`, `offlinedocs` and Schmoder CI.
4+
runs:
5+
using: "composite"
6+
steps:
7+
- name: go install tools
8+
shell: bash
9+
run: |
10+
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.30
11+
go install storj.io/drpc/cmd/protoc-gen-go-drpc@v0.0.34
12+
go install golang.org/x/tools/cmd/goimports@v0.31.0
13+
go install github.com/mikefarah/yq/v4@v4.44.3
14+
go install go.uber.org/mock/mockgen@v0.5.0

0 commit comments

Comments
 (0)