proxy

Documentation

Overview

Package proxy provides a local reverse proxy for forwarding traffic from a stable listen port to a worktree's dynamically allocated port. Supports optional TLS termination via mkcert or self-signed certificates.

Index

• Constants
• func BuildRouterURL(port int, project, branch, domain string, routerPort int, ...) string
• func BuildTunnelURL(project, branch, tunnelDomain string) string
• func CACertExpiry() (time.Time, error)
• func CACertPath() string
• func EnsureCA() (string, error)
• func IsCAInstalled() bool
• func RouteKey(project, branch string) string
• func Run(opts Options) error
• func TrustCA(caCertFile string) error
• func UntrustCA() error
• type AliasSource
• type BackendState
• type CertManager
  • func NewCertManager() (*CertManager, error)
  • func (cm *CertManager) GetCertificate(hello *tls.ClientHelloInfo) (*tls.Certificate, error)
• type Options
• type PortProbe
• type Router
  • func NewRouter(listenPort int, reg *registry.Registry) *Router
  • func (r *Router) Refresh()
  • func (r *Router) Routes() map[string]int
  • func (r *Router) Run() error
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Router) WithAliases(src AliasSource) *Router
  • func (r *Router) WithBaseDomain(domain string) *Router
  • func (r *Router) WithTLS() *Router
• type SupervisorProbe

Constants

const HealthEndpoint = "/_treeline/health"

HealthEndpoint is the path the doctor probes to confirm the running router is responsive (not just bound to a port).

Functions

func BuildRouterURL

func BuildRouterURL(port int, project, branch, domain string, routerPort int, svcRunning, pfConfigured bool) string

BuildRouterURL returns the HTTPS router URL for a given project/branch when the router is active, or falls back to a plain localhost URL. Pass svcRunning and pfConfigured from service.IsRunning() and service.IsPortForwardConfigured() to keep this function testable.

func BuildTunnelURL

func BuildTunnelURL(project, branch, tunnelDomain string) string

BuildTunnelURL returns the tunnel URL for a given project/branch when a tunnel domain is configured, or an empty string if not applicable.

func CACertExpiry

func CACertExpiry() (time.Time, error)

CACertExpiry returns the CA certificate's NotAfter time, or an error if the cert can't be read/parsed. Used by gtl doctor for cert health.

func CACertPath

func CACertPath() string

CACertPath returns the path to the CA certificate (for display to the user).

func EnsureCA

func EnsureCA() (string, error)

EnsureCA generates a local CA if one doesn't exist or is expiring within 7 days. Returns the path to the CA certificate (for trusting).

func IsCAInstalled

func IsCAInstalled() bool

IsCAInstalled checks whether the local CA has been generated.

func RouteKey

func RouteKey(project, branch string) string

RouteKey derives a DNS-safe route key from a project name and branch. Exported so gtl setup can display the router URL.

func Run

func Run(opts Options) error

Run starts a reverse proxy on ListenPort forwarding all traffic to TargetPort. It blocks until interrupted by SIGINT/SIGTERM and then performs a graceful shutdown.

func TrustCA

func TrustCA(caCertFile string) error

TrustCA adds the local CA certificate to the system trust store. Requires sudo on macOS and Linux.

func UntrustCA

func UntrustCA() error

UntrustCA removes the local CA from the system trust store.

Types

type AliasSource

type AliasSource func() map[string]int

AliasSource returns static alias routes to merge into the route table. Registry routes take priority over aliases.

type BackendState

type BackendState int

BackendState classifies why a proxied request couldn't reach the upstream dev server. The router uses this to pick a status page so users can tell "still starting" apart from "actually broken".

const (
	BackendUnknown     BackendState = iota
	BackendStarting                 // supervisor + child both up, port not yet listening
	BackendNotStarted               // allocation exists, supervisor not running
	BackendStopped                  // supervisor running, no live child (stopped or crashed)
	BackendUnreachable              // supervisor responded with something unexpected
)

type CertManager

type CertManager struct {
	// contains filtered or unexported fields
}

CertManager generates per-hostname TLS certificates on demand, signed by the local CA. This avoids wildcard certs (*.localhost) which Safari and Chromium reject for the .localhost TLD.

func NewCertManager

func NewCertManager() (*CertManager, error)

NewCertManager loads the local CA and returns a manager that generates per-hostname certs via GetCertificate. Returns an error if the CA hasn't been created yet (user needs to run 'gtl serve install').

func (*CertManager) GetCertificate

func (cm *CertManager) GetCertificate(hello *tls.ClientHelloInfo) (*tls.Certificate, error)

GetCertificate is a tls.Config callback that returns a cert with an exact SAN for the requested hostname. The cache is capped to prevent unbounded growth from garbage hostnames.

type Options

type Options struct {
	ListenPort int
	TargetPort int
	TLS        bool
}

Options configures the reverse proxy.

type PortProbe

type PortProbe func(port int, timeout time.Duration) bool

PortProbe attempts a TCP connection to localhost:port within the given timeout and returns true if the port is accepting connections.

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router is a subdomain-based reverse proxy that routes {project}-{branch}.localhost requests to the correct worktree port by reading allocations from the git-treeline registry.

func NewRouter

func NewRouter(listenPort int, reg *registry.Registry) *Router

func (*Router) Refresh

func (r *Router) Refresh()

Refresh forces an immediate route table rebuild. Useful after calling builder methods (WithAliases, WithBaseDomain) to populate routes before Run() starts the periodic refresh ticker.

func (*Router) Routes

func (r *Router) Routes() map[string]int

Routes returns a snapshot of the current route table.

func (*Router) Run

func (r *Router) Run() error

Run starts the router HTTP/HTTPS server and blocks until SIGINT/SIGTERM. Routes are refreshed from the registry every 5 seconds.

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Router) WithAliases

func (r *Router) WithAliases(src AliasSource) *Router

WithAliases adds an alias source that is merged on each route refresh. Call Refresh() after all builders to populate the route table immediately.

func (*Router) WithBaseDomain

func (r *Router) WithBaseDomain(domain string) *Router

WithBaseDomain sets the local TLD used for subdomain extraction.

func (*Router) WithTLS

func (r *Router) WithTLS() *Router

WithTLS enables HTTPS using the local CA cert generated by gtl serve install.

type SupervisorProbe

type SupervisorProbe func(socketPath string) (string, error)

SupervisorProbe asks the supervisor at socketPath for its status. Returns "running", "stopped", or an empty string if the supervisor can't be reached. Pulled out so tests can inject a fake.