Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

6.9 KB
Raw Blame
package errors

import (
	"errors"
	"fmt"
	"strings"
	"time"
	"unicode"
)

// Base error types
var (
	ErrNotFound         = errors.New("not found")
	ErrUnauthorized     = errors.New("unauthorized")
	ErrForbidden        = errors.New("forbidden")
	ErrTimeout          = errors.New("timeout")
	ErrInvalidInput     = errors.New("invalid input")
	ErrConnectionFailed = errors.New("connection failed")
)

// ErrorType represents the category of error
type ErrorType string

const (
	ErrorTypeConnection ErrorType = "connection"
	ErrorTypeAuth       ErrorType = "auth"
	ErrorTypeValidation ErrorType = "validation"
	ErrorTypeNotFound   ErrorType = "not_found"
	ErrorTypeInternal   ErrorType = "internal"
	ErrorTypeAPI        ErrorType = "api"
	ErrorTypeTimeout    ErrorType = "timeout"
)

const (
	maxErrorContextLength = 128
	maxErrorMessageLength = 512
	maxAuthMatchLength    = 2048
)

// MonitorError is a structured error for monitoring operations
type MonitorError struct {
	Type       ErrorType
	Op         string // Operation that failed (e.g., "poll_nodes", "get_vms")
	Instance   string // Instance name where error occurred
	Node       string // Node name if applicable
	Err        error  // Underlying error
	StatusCode int    // HTTP status code if applicable
	Timestamp  time.Time
	Retryable  bool
}

func (e *MonitorError) Error() string {
	if e == nil {
		return "<nil>"
	}

	instance := sanitizeErrorText(e.Instance, maxErrorContextLength)
	node := sanitizeErrorText(e.Node, maxErrorContextLength)
	errMsg := "<nil>"
	if e.Err != nil {
		errMsg = sanitizeErrorText(e.Err.Error(), maxErrorMessageLength)
		if errMsg == "" {
			errMsg = "unknown error"
		}
	}

	op := sanitizeErrorText(e.Op, maxErrorContextLength)

	if node != "" {
		return fmt.Sprintf("%s failed on %s/%s: %s", op, instance, node, errMsg)
	}
	if instance != "" {
		return fmt.Sprintf("%s failed on %s: %s", op, instance, errMsg)
	}

	return fmt.Sprintf("%s failed: %s", op, errMsg)
}

func (e *MonitorError) Unwrap() error {
	if e == nil {
		return nil
	}
	return e.Err
}

// Is implements errors.Is interface
func (e *MonitorError) Is(target error) bool {
	if e == nil || target == nil {
		return false
	}

	// Check base error types
	switch target {
	case ErrNotFound:
		return e.Type == ErrorTypeNotFound
	case ErrUnauthorized, ErrForbidden:
		return e.Type == ErrorTypeAuth
	case ErrTimeout:
		return e.Type == ErrorTypeTimeout
	case ErrConnectionFailed:
		return e.Type == ErrorTypeConnection
	}

	// Check wrapped error
	return errors.Is(e.Err, target)
}

// NewMonitorError creates a new MonitorError
func NewMonitorError(errorType ErrorType, op, instance string, err error) *MonitorError {
	return &MonitorError{
		Type:      errorType,
		Op:        sanitizeErrorText(op, maxErrorContextLength),
		Instance:  sanitizeErrorText(instance, maxErrorContextLength),
		Err:       err,
		Timestamp: time.Now(),
		Retryable: isRetryable(errorType, err),
	}
}

// WithNode adds node information to the error
func (e *MonitorError) WithNode(node string) *MonitorError {
	if e == nil {
		return nil
	}
	e.Node = sanitizeErrorText(node, maxErrorContextLength)
	return e
}

// WithStatusCode adds HTTP status code to the error
func (e *MonitorError) WithStatusCode(code int) *MonitorError {
	if e == nil {
		return nil
	}
	e.StatusCode = code
	// Update retryable based on status code
	if code >= 500 || code == 429 || code == 408 {
		e.Retryable = true
	} else if code >= 400 && code < 500 {
		e.Retryable = false
	}
	return e
}

// isRetryable determines if an error should be retried
func isRetryable(errorType ErrorType, err error) bool {
	switch errorType {
	case ErrorTypeConnection, ErrorTypeTimeout:
		return true
	case ErrorTypeAuth, ErrorTypeValidation, ErrorTypeNotFound:
		return false
	default: // ErrorTypeInternal, ErrorTypeAPI
		// Check the underlying error
		if err != nil {
			return !errors.Is(err, ErrInvalidInput) && !errors.Is(err, ErrForbidden)
		}
		return true
	}
}

// Helper functions

// WrapConnectionError wraps a connection error with context
func WrapConnectionError(op, instance string, err error) error {
	return NewMonitorError(ErrorTypeConnection, op, instance, err)
}

// WrapAPIError wraps an API error with context
func WrapAPIError(op, instance string, err error, statusCode int) error {
	return NewMonitorError(ErrorTypeAPI, op, instance, err).WithStatusCode(statusCode)
}

// IsRetryableError checks if an error should be retried
func IsRetryableError(err error) bool {
	var monErr *MonitorError
	if errors.As(err, &monErr) {
		if monErr == nil {
			return false
		}
		return monErr.Retryable
	}

	// Check for wrapped standard errors
	return errors.Is(err, ErrTimeout) || errors.Is(err, ErrConnectionFailed)
}

// IsAuthError checks if an error is an authentication error
func IsAuthError(err error) bool {
	if err == nil {
		return false
	}

	var monErr *MonitorError
	if errors.As(err, &monErr) {
		if monErr != nil {
			// Check type
			if monErr.Type == ErrorTypeAuth {
				return true
			}
			// Check status code for 401/403
			if monErr.StatusCode == 401 || monErr.StatusCode == 403 {
				return true
			}
		}
	}

	// Check for wrapped standard errors
	if errors.Is(err, ErrUnauthorized) || errors.Is(err, ErrForbidden) {
		return true
	}

	// Check error message for authentication indicators using a bounded prefix to
	// avoid large memory amplification from oversized upstream error bodies.
	errMsg := normalizeForAuthMatch(err.Error())
	return strings.Contains(errMsg, "authentication error") ||
		strings.Contains(errMsg, "authentication failed") ||
		containsStandaloneCode(errMsg, "401") ||
		containsStandaloneCode(errMsg, "403") ||
		strings.Contains(errMsg, "unauthorized") ||
		strings.Contains(errMsg, "forbidden")
}

func normalizeForAuthMatch(msg string) string {
	if msg == "" {
		return ""
	}

	if len(msg) > maxAuthMatchLength {
		msg = msg[:maxAuthMatchLength]
	}

	return strings.ToLower(sanitizeErrorText(msg, maxAuthMatchLength))
}

func sanitizeErrorText(input string, maxLen int) string {
	if input == "" || maxLen <= 0 {
		return ""
	}
	if len(input) > maxLen {
		input = input[:maxLen]
	}

	var b strings.Builder
	b.Grow(len(input))
	spacePending := false
	for _, r := range input {
		if r < 0x20 || r == 0x7f || unicode.IsSpace(r) {
			spacePending = true
			continue
		}
		if spacePending && b.Len() > 0 {
			b.WriteByte(' ')
		}
		b.WriteRune(r)
		spacePending = false
	}

	return strings.TrimSpace(b.String())
}

func containsStandaloneCode(msg, code string) bool {
	if msg == "" || code == "" {
		return false
	}

	start := 0
	for {
		idx := strings.Index(msg[start:], code)
		if idx == -1 {
			return false
		}

		pos := start + idx
		end := pos + len(code)
		leftOk := pos == 0 || !isASCIIAlphaNumeric(msg[pos-1])
		rightOk := end == len(msg) || !isASCIIAlphaNumeric(msg[end])
		if leftOk && rightOk {
			return true
		}

		start = pos + 1
		if start >= len(msg) {
			return false
		}
	}
}

func isASCIIAlphaNumeric(ch byte) bool {
	return (ch >= 'a' && ch <= 'z') ||
		(ch >= 'A' && ch <= 'Z') ||
		(ch >= '0' && ch <= '9')
}