perf: ⚡ share a validator instance across packages

internal/agent/ui/fyneUI/fyneUI.go

@@ -27,16 +27,15 @@ import (
 	"fyne.io/fyne/v2/driver/desktop"
 	"fyne.io/fyne/v2/layout"
 	"fyne.io/fyne/v2/widget"
-	"github.com/go-playground/validator/v10"
+
+	agentvalidator "github.com/joshuar/go-hass-agent/internal/validation"
 
 	"github.com/joshuar/go-hass-agent/internal/agent/ui"
 	"github.com/joshuar/go-hass-agent/internal/hass"
 	"github.com/joshuar/go-hass-agent/internal/logging"
 	"github.com/joshuar/go-hass-agent/internal/preferences"
 )
 
-var validate *validator.Validate
-
 var (
 	//nolint:stylecheck
 	//lint:ignore ST1005 these are not standard error messages
@@ -59,10 +58,6 @@ type FyneUI struct {
 	logger *slog.Logger
 }
 
-func init() {
-	validate = validator.New(validator.WithRequiredStructEnabled())
-}
-
 // New FyneUI sets up the UI for the agent.
 func NewFyneUI(ctx context.Context) *FyneUI {
 	appUI := &FyneUI{
@@ -546,10 +541,8 @@ func longestString(stringList []string) string {
 // httpValidator is a custom fyne validator that will validate a string is a
 // valid http/https URL.
 func httpValidator() fyne.StringValidator {
-	v := validator.New()
-
 	return func(text string) error {
-		if v.Var(text, "http_url") != nil {
+		if agentvalidator.Validate.Var(text, "http_url") != nil {
 			return ErrInvalidURL
 		}
 
@@ -565,7 +558,7 @@ func httpValidator() fyne.StringValidator {
 // valid http/https URL.
 func uriValidator() fyne.StringValidator {
 	return func(text string) error {
-		if validate.Var(text, "uri") != nil {
+		if agentvalidator.Validate.Var(text, "uri") != nil {
 			return ErrInvalidURI
 		}
 
@@ -590,10 +583,8 @@ func hostPortValidator(msg string) fyne.StringValidator {
 		errMsg = ErrInvalidHostPort
 	}
 
-	v := validator.New()
-
 	return func(text string) error {
-		if v.Var(text, "hostname_port") != nil {
+		if agentvalidator.Validate.Var(text, "hostname_port") != nil {
 			return errMsg
 		}
 		// if _, err := url.Parse(text); err != nil {

internal/hass/event/event.go

@@ -4,7 +4,11 @@
 //revive:disable:unused-receiver
 package event
 
-import "fmt"
+import (
+	"fmt"
+
+	"github.com/joshuar/go-hass-agent/internal/validation"
+)
 
 const (
 	requestTypeEvent = "fire_event"
@@ -16,9 +20,9 @@ type Event struct {
 }
 
 func (e *Event) Validate() error {
-	err := validate.Struct(e)
+	err := validation.Validate.Struct(e)
 	if err != nil {
-		return fmt.Errorf("event is invalid: %s", parseValidationErrors(err))
+		return fmt.Errorf("event is invalid: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil

internal/hass/sensor/entities.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 
 	"github.com/joshuar/go-hass-agent/internal/hass/sensor/types"
+	"github.com/joshuar/go-hass-agent/internal/validation"
 )
 
 const (
@@ -33,9 +34,9 @@ type State struct {
 }
 
 func (s *State) Validate() error {
-	err := validate.Struct(s)
+	err := validation.Validate.Struct(s)
 	if err != nil {
-		return fmt.Errorf("sensor state is invalid: %s", parseValidationErrors(err))
+		return fmt.Errorf("sensor state is invalid: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil
@@ -75,9 +76,9 @@ type Entity struct {
 }
 
 func (e *Entity) Validate() error {
-	err := validate.Struct(e)
+	err := validation.Validate.Struct(e)
 	if err != nil {
-		return fmt.Errorf("sensor is invalid: %s", parseValidationErrors(err))
+		return fmt.Errorf("sensor is invalid: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil
@@ -132,9 +133,9 @@ type Location struct {
 }
 
 func (l *Location) Validate() error {
-	err := validate.Struct(l)
+	err := validation.Validate.Struct(l)
 	if err != nil {
-		return fmt.Errorf("location is invalid: %s", parseValidationErrors(err))
+		return fmt.Errorf("location is invalid: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil

internal/preferences/prefs.go

@@ -14,6 +14,8 @@ import (
 
 	"github.com/adrg/xdg"
 	"github.com/pelletier/go-toml/v2"
+
+	"github.com/joshuar/go-hass-agent/internal/validation"
 )
 
 const (
@@ -122,9 +124,9 @@ func DefaultPreferences(file string) *Preferences {
 }
 
 func (p *Preferences) Validate() error {
-	err := validate.Struct(p)
+	err := validation.Validate.Struct(p)
 	if err != nil {
-		return fmt.Errorf("%w: %s", ErrValidationFailed, parseValidationErrors(err))
+		return fmt.Errorf("validation failed: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil

internal/preferences/registration.go

@@ -7,6 +7,8 @@ package preferences
 
 import (
 	"fmt"
+
+	"github.com/joshuar/go-hass-agent/internal/validation"
 )
 
 type Registration struct {
@@ -23,9 +25,9 @@ func DefaultRegistrationPreferences() *Registration {
 }
 
 func (p *Registration) Validate() error {
-	err := validate.Struct(p)
+	err := validation.Validate.Struct(p)
 	if err != nil {
-		return fmt.Errorf("%w: %s", ErrValidationFailed, parseValidationErrors(err))
+		return fmt.Errorf("validation failed: %s", validation.ParseValidationErrors(err))
 	}
 
 	return nil

internal/hass/event/validation.go → internal/validation/validation.go

@@ -1,23 +1,23 @@
 // Copyright 2024 Joshua Rich <[email protected]>.
 // SPDX-License-Identifier: MIT
 
-package event
+package validation
 
 import (
 	"strings"
 
 	"github.com/go-playground/validator/v10"
 )
 
-var validate *validator.Validate
+var Validate *validator.Validate
 
 func init() {
-	validate = validator.New(validator.WithRequiredStructEnabled())
+	Validate = validator.New(validator.WithRequiredStructEnabled())
 }
 
 //nolint:errorlint
 //revive:disable:unhandled-error
-func parseValidationErrors(validation error) string {
+func ParseValidationErrors(validation error) string {
 	validationErrs, ok := validation.(validator.ValidationErrors)
 	if !ok {
 		return "internal validation error"