Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
package utils
import (
"context"
"regexp"
"strings"
"time"
activitytypes "github.com/getarcaneapp/arcane/types/v2/activity"
)
type appLifecycleContextKey struct{}
type (
activityBatchIDContextKey struct{}
updateInitiatorContextKeyInternal struct{}
)
// WithUpdateInitiator carries manager-authenticated attribution through an
// agent request without changing the authenticated agent identity.
func WithUpdateInitiator(ctx context.Context, initiator activitytypes.StartedBy) context.Context {
initiator.UserID = strings.TrimSpace(initiator.UserID)
initiator.Username = strings.TrimSpace(initiator.Username)
if initiator.UserID == "" || initiator.Username == "" {
return ctx
}
return context.WithValue(ctx, updateInitiatorContextKeyInternal{}, initiator)
}
// UpdateInitiatorFromContext returns trusted proxied update attribution.
func UpdateInitiatorFromContext(ctx context.Context) (activitytypes.StartedBy, bool) {
initiator, ok := ctx.Value(updateInitiatorContextKeyInternal{}).(activitytypes.StartedBy)
return initiator, ok
}
var activityBatchIDPattern = regexp.MustCompile(`^[A-Za-z0-9_-]{1,64}$`)
// ValidActivityBatchID reports whether id is safe to persist as a batch ID.
func ValidActivityBatchID(id string) bool {
return activityBatchIDPattern.MatchString(id)
}
// WithActivityBatchID attaches a client-supplied batch ID that groups the
// activities spawned by one logical user action (e.g. a bulk container
// update). Invalid IDs are ignored.
func WithActivityBatchID(ctx context.Context, batchID string) context.Context {
if ctx == nil {
ctx = context.Background() //nolint:forbidigo // Fallback preserves the existing nil-context contract when no parent is available.
}
if !ValidActivityBatchID(batchID) {
return ctx
}
return context.WithValue(ctx, activityBatchIDContextKey{}, batchID)
}
// ActivityBatchIDFromContext returns the batch ID attached by
// WithActivityBatchID, or "" when none is set.
func ActivityBatchIDFromContext(ctx context.Context) string {
if ctx == nil {
return ""
}
batchID, _ := ctx.Value(activityBatchIDContextKey{}).(string)
return batchID
}
type activityRuntimeContext struct {
valueCtx context.Context
lifecycleCtx context.Context
}
// WithAppLifecycleContext marks ctx as the application lifecycle context.
func WithAppLifecycleContext(ctx context.Context) context.Context {
if ctx == nil {
ctx = context.Background() //nolint:forbidigo // Fallback preserves the existing nil-context contract when no parent is available.
}
return context.WithValue(ctx, appLifecycleContextKey{}, true)
}
// IsAppLifecycleContext reports whether ctx is tied to the application lifecycle.
func IsAppLifecycleContext(ctx context.Context) bool {
isLifecycle, _ := ctx.Value(appLifecycleContextKey{}).(bool)
return isLifecycle
}
// ActivityRuntimeContext returns a context suitable for activity-backed work.
func ActivityRuntimeContext(requestCtx, appCtx context.Context) context.Context {
if appCtx != nil {
if requestCtx == nil || requestCtx == appCtx {
return appCtx
}
return activityRuntimeContext{
valueCtx: requestCtx,
lifecycleCtx: appCtx,
}
}
if IsAppLifecycleContext(requestCtx) {
return requestCtx
}
if requestCtx != nil {
return context.WithoutCancel(requestCtx)
}
return context.Background() //nolint:forbidigo // Fallback preserves the existing nil-context contract when no parent is available.
}
func (c activityRuntimeContext) Deadline() (time.Time, bool) {
return c.lifecycleCtx.Deadline()
}
func (c activityRuntimeContext) Done() <-chan struct{} {
return c.lifecycleCtx.Done()
}
func (c activityRuntimeContext) Err() error {
return c.lifecycleCtx.Err()
}
func (c activityRuntimeContext) Value(key any) any {
if _, ok := key.(appLifecycleContextKey); ok {
if value := c.lifecycleCtx.Value(key); value != nil {
return value
}
}
if c.valueCtx != nil {
if value := c.valueCtx.Value(key); value != nil {
return value
}
}
return c.lifecycleCtx.Value(key)
}