Files
archie/internal/app/archieui/options.go
T

136 lines
5.1 KiB
Go

// Package archieui composes the standalone dashboard service, talking to the
// Gateway and State Store over their contracts.
package archieui
import (
"time"
"github.com/samcharles93/archie-core/internal/config"
"github.com/samcharles93/archie-core/internal/infrastructure/configuration"
"github.com/samcharles93/archie-core/internal/infrastructure/rpctls"
)
// Process defaults. Listen matches the dashboard's historical bind
// (internal/infrastructure/configuration/defaults.go) so an operator moving
// the dashboard into its own process keeps the same URL.
const (
defaultListen = "127.0.0.1:8484"
defaultDependencyTimeout = 5 * time.Second
defaultReadHeaderTimeout = 5 * time.Second
defaultShutdownTimeout = 5 * time.Second
)
// ServiceTarget is one remote contract's endpoint.
type ServiceTarget struct {
Target string
}
// Options is the UI-owned input DTO. It carries process-local settings and
// endpoint references only -- there is deliberately no config.Config,
// config.Holder, forge credential, model catalog or workflow routing field
// for daemon configuration to arrive through.
type Options struct {
// Config and Overlay name the configuration source the process reads a
// narrow projection of. Both are optional: a deployment may pass every
// setting as a flag.
Config string
Overlay string
// Listen is the dashboard HTTP bind address.
Listen string
// OidcIssuer and OidcAudience configure the identity provider. Local accounts remain available;
// an issuer without an audience is refused.
OidcIssuer string
OidcAudience string
// OidcClientID and OidcClientSecretEnv register the browser sign-in; the
// secret is read from the named env var. No client ID disables sign-in.
OidcClientID string
OidcClientSecretEnv string
// OidcRedirectURL is the callback the provider returns the browser to. Its
// path must be /oauth2/callback, which is the route this process serves.
OidcRedirectURL string
// TrustForwardedHeaders is tri-state so an explicit false on the command
// line can override a configuration file that enables it. Nil means the
// operator did not say, and the file (else false) decides.
TrustForwardedHeaders *bool
// Capture configures the webhook capture receiver. Zero fields use
// configuration.DefaultCapture.
Capture CaptureOptions
// Gateway and State are the two remote contracts the dashboard consumes.
Gateway ServiceTarget
State ServiceTarget
Messaging ServiceTarget
Daemon ServiceTarget
// DependencyTimeout bounds each readiness probe's call to a dependency.
DependencyTimeout time.Duration
// EventPollInterval bounds how stale the dashboard's activity feed can be.
// Live activity is a poll of the State Store's event cursor.
EventPollInterval time.Duration
// ReadHeaderTimeout and ShutdownTimeout bound the HTTP lifecycle.
ReadHeaderTimeout time.Duration
ShutdownTimeout time.Duration
// identity is this process's certificate, loaded by Resolve from
// [tls]; nil is plaintext, loopback only.
identity *rpctls.Identity
// instance is the deployment name, from the configuration source or
// ARCHIE_INSTANCE.
instance string
// logging is the [log] and [telemetry] configuration, read only by Run.
logging config.Config
}
// CaptureOptions carries the [capture] settings the capture receiver needs.
// Every field is an endpoint-adjacent process setting: the receiver runs in
// this process, so the operator's capture tuning must reach it directly
// rather than through the daemon's configuration.
type CaptureOptions struct {
// Retention is how long a captured event is kept before prune-on-write
// deletes it. Zero means configuration.DefaultCapture's value.
Retention time.Duration
// MaxEvents caps the capture table at this many newest rows. Zero means
// the default.
MaxEvents int
// MaxBodyBytes rejects (413) a body larger than this before it is read.
// Zero means the default.
MaxBodyBytes int
// RatePerSecond and RateBurst configure the per-remote-address token
// bucket applied before a request body is read. Zero means the defaults.
RatePerSecond float64
RateBurst int
}
// withDefaults resolves zero fields to configuration.DefaultCapture, the
// same "zero means default" semantics config.CaptureConfig documents. A
// resolved config never carries zeros (its decoder applies the defaults),
// so this only fires for a flags-only deployment or a direct compose call.
func (c CaptureOptions) withDefaults() CaptureOptions {
d := configuration.DefaultCapture()
if c.Retention <= 0 {
c.Retention = d.Retention.Std()
}
if c.MaxEvents <= 0 {
c.MaxEvents = d.MaxEvents
}
if c.MaxBodyBytes <= 0 {
c.MaxBodyBytes = d.MaxBodyBytes
}
if c.RatePerSecond <= 0 {
c.RatePerSecond = d.RatePerSecond
}
if c.RateBurst <= 0 {
c.RateBurst = d.RateBurst
}
return c
}
// trustForwardedHeaders reports the resolved value, treating "not specified"
// as off: trusting forwarded headers unconditionally lets an untrusted client
// spoof the Origin scheme check.
func (o Options) trustForwardedHeaders() bool {
return o.TrustForwardedHeaders != nil && *o.TrustForwardedHeaders
}