feat: WebhookConfig

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ on:
 
 jobs:
   ci:
-    uses: xmidt-org/shared-go/.github/workflows/ci.yml@5bc4b83f25ff4c944cd6253ba189e50d1997ab3c # v4.1.0
+    uses: xmidt-org/shared-go/.github/workflows/ci.yml@9e191cedb6f62d364dc8706c07107c8ef612c346 # v4.2.2
     with:
       release-type: library
     secrets: inherit

.gitignore

@@ -29,3 +29,4 @@ report.json
 # VSCode
 *.code-workspace
 .vscode/*
+.dev/*

go.mod

@@ -4,7 +4,7 @@ go 1.20
 
 require (
 	github.com/stretchr/testify v1.8.4
-	github.com/xmidt-org/urlegit v0.1.0
+	github.com/xmidt-org/urlegit v0.1.1
 )
 
 require (

go.sum

@@ -4,8 +4,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/xmidt-org/urlegit v0.1.0 h1:WZLlWo0e5JNZabLEi7/1+sK/np9qrH9XnoB+ZdsHieM=
-github.com/xmidt-org/urlegit v0.1.0/go.mod h1:ih/VtgW3xfpV7FNIrHUpNdP0GapcfLOND8y0JwH51vA=
+github.com/xmidt-org/urlegit v0.1.1 h1:sjFlckD7Okql7gQACX5hpicqiqD/kIs1hhG7a623dJQ=
+github.com/xmidt-org/urlegit v0.1.1/go.mod h1:ih/VtgW3xfpV7FNIrHUpNdP0GapcfLOND8y0JwH51vA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

options.go

@@ -5,7 +5,6 @@ package webhook
 
 import (
 	"fmt"
-	"regexp"
 	"time"
 
 	"github.com/xmidt-org/urlegit"
@@ -20,7 +19,7 @@ type errorOption struct {
 	err error
 }
 
-func (e errorOption) Validate(*Registration) error {
+func (e errorOption) Validate(any) error {
 	return error(e.err)
 }
 
@@ -31,6 +30,20 @@ func (e errorOption) String() string {
 	return "Error('" + e.err.Error() + "')"
 }
 
+func AlwaysValid() Option {
+	return AlwaysValidOption{}
+}
+
+type AlwaysValidOption struct{}
+
+func (a AlwaysValidOption) Validate(any) error {
+	return nil
+}
+
+func (a AlwaysValidOption) String() string {
+	return "alwaysValidOption"
+}
+
 // AtLeastOneEvent makes sure there is at least one value in Events and ensures
 // that all values should parse into regex.
 func AtLeastOneEvent() Option {
@@ -39,12 +52,15 @@ func AtLeastOneEvent() Option {
 
 type atLeastOneEventOption struct{}
 
-func (atLeastOneEventOption) Validate(r *Registration) error {
-	if len(r.Events) == 0 {
-		return fmt.Errorf("%w: cannot have zero events", ErrInvalidInput)
+func (atLeastOneEventOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateOneEvent()
+	case *RegistrationV2:
+		return fmt.Errorf("%w: RegistrationV2 does not have an events field to validate", ErrInvalidType)
+	default:
+		return ErrUknownType
 	}
-
-	return nil
 }
 
 func (atLeastOneEventOption) String() string {
@@ -58,14 +74,15 @@ func EventRegexMustCompile() Option {
 
 type eventRegexMustCompileOption struct{}
 
-func (eventRegexMustCompileOption) Validate(r *Registration) error {
-	for _, e := range r.Events {
-		_, err := regexp.Compile(e)
-		if err != nil {
-			return fmt.Errorf("%w: unable to compile matching", ErrInvalidInput)
-		}
+func (eventRegexMustCompileOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateEventRegex()
+	case *RegistrationV2:
+		return r.ValidateEventRegex()
+	default:
+		return ErrUknownType
 	}
-	return nil
 }
 
 func (eventRegexMustCompileOption) String() string {
@@ -80,14 +97,15 @@ func DeviceIDRegexMustCompile() Option {
 
 type deviceIDRegexMustCompileOption struct{}
 
-func (deviceIDRegexMustCompileOption) Validate(r *Registration) error {
-	for _, e := range r.Matcher.DeviceID {
-		_, err := regexp.Compile(e)
-		if err != nil {
-			return fmt.Errorf("%w: unable to compile matching", ErrInvalidInput)
-		}
+func (deviceIDRegexMustCompileOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateDeviceId()
+	case *RegistrationV2:
+		return fmt.Errorf("%w: RegistrationV2 does not use DeviceID directly, use `FieldRegex` instead", ErrInvalidType)
+	default:
+		return ErrUknownType
 	}
-	return nil
 }
 
 func (deviceIDRegexMustCompileOption) String() string {
@@ -107,40 +125,15 @@ type validateRegistrationDurationOption struct {
 	ttl time.Duration
 }
 
-func (v validateRegistrationDurationOption) Validate(r *Registration) error {
-	if v.ttl <= 0 {
-		v.ttl = time.Duration(0)
-	}
-
-	if v.ttl != 0 && v.ttl < time.Duration(r.Duration) {
-		return fmt.Errorf("%w: the registration is for too long", ErrInvalidInput)
-	}
-
-	if r.Until.IsZero() && r.Duration == 0 {
-		return fmt.Errorf("%w: either Duration or Until must be set", ErrInvalidInput)
-	}
-
-	if !r.Until.IsZero() && r.Duration != 0 {
-		return fmt.Errorf("%w: only one of Duration or Until may be set", ErrInvalidInput)
-	}
-
-	if !r.Until.IsZero() {
-		nowFunc := time.Now
-		if r.nowFunc != nil {
-			nowFunc = r.nowFunc
-		}
-
-		now := nowFunc()
-		if v.ttl != 0 && r.Until.After(now.Add(v.ttl)) {
-			return fmt.Errorf("%w: the registration is for too long", ErrInvalidInput)
-		}
-
-		if r.Until.Before(now) {
-			return fmt.Errorf("%w: the registration has already expired", ErrInvalidInput)
-		}
+func (v validateRegistrationDurationOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateDuration(v.ttl)
+	case *RegistrationV2:
+		return r.ValidateDuration()
+	default:
+		return ErrUknownType
 	}
-
-	return nil
 }
 
 func (v validateRegistrationDurationOption) String() string {
@@ -157,8 +150,12 @@ type provideTimeNowFuncOption struct {
 	nowFunc func() time.Time
 }
 
-func (p provideTimeNowFuncOption) Validate(r *Registration) error {
-	r.nowFunc = p.nowFunc
+func (p provideTimeNowFuncOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		r.SetNowFunc(p.nowFunc)
+	}
+
 	return nil
 }
 
@@ -179,13 +176,24 @@ type provideFailureURLValidatorOption struct {
 	checker *urlegit.Checker
 }
 
-func (p provideFailureURLValidatorOption) Validate(r *Registration) error {
+func (p provideFailureURLValidatorOption) Validate(i any) error {
+	var failureURL string
+	//TODO: do we want to move this check to be inside each case statement?
 	if p.checker == nil {
 		return nil
 	}
 
-	if r.FailureURL != "" {
-		if err := p.checker.Text(r.FailureURL); err != nil {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		failureURL = r.FailureURL
+	case *RegistrationV2:
+		failureURL = r.FailureURL
+	default:
+		return ErrUknownType
+	}
+
+	if failureURL != "" {
+		if err := p.checker.Text(failureURL); err != nil {
 			return fmt.Errorf("%w: failure url is invalid", ErrInvalidInput)
 		}
 	}
@@ -209,17 +217,19 @@ type provideReceiverURLValidatorOption struct {
 	checker *urlegit.Checker
 }
 
-func (p provideReceiverURLValidatorOption) Validate(r *Registration) error {
+func (p provideReceiverURLValidatorOption) Validate(i any) error {
 	if p.checker == nil {
 		return nil
 	}
 
-	if r.Config.ReceiverURL != "" {
-		if err := p.checker.Text(r.Config.ReceiverURL); err != nil {
-			return fmt.Errorf("%w: failure url is invalid", ErrInvalidInput)
-		}
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateReceiverURL(p.checker)
+	case *RegistrationV2:
+		return r.ValidateReceiverURL(p.checker)
+	default:
+		return ErrUknownType
 	}
-	return nil
 }
 
 func (p provideReceiverURLValidatorOption) String() string {
@@ -239,17 +249,19 @@ type provideAlternativeURLValidatorOption struct {
 	checker *urlegit.Checker
 }
 
-func (p provideAlternativeURLValidatorOption) Validate(r *Registration) error {
+func (p provideAlternativeURLValidatorOption) Validate(i any) error {
 	if p.checker == nil {
 		return nil
 	}
 
-	for _, url := range r.Config.AlternativeURLs {
-		if err := p.checker.Text(url); err != nil {
-			return fmt.Errorf("%w: failure url is invalid", ErrInvalidInput)
-		}
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateAltURL(p.checker)
+	case *RegistrationV2:
+		return fmt.Errorf("%w: RegistrationV2 does not have an alternative urls field. Use ProvideReceiverURLValidator() to validate all non-failure urls", ErrInvalidType)
+	default:
+		return ErrUknownType
 	}
-	return nil
 }
 
 func (p provideAlternativeURLValidatorOption) String() string {
@@ -266,13 +278,46 @@ func NoUntil() Option {
 
 type noUntilOption struct{}
 
-func (noUntilOption) Validate(r *Registration) error {
-	if !r.Until.IsZero() {
-		return fmt.Errorf("%w: Until is not allowed", ErrInvalidInput)
+func (noUntilOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.ValidateNoUntil()
+	case *RegistrationV2:
+		return fmt.Errorf("%w: RegistrationV2 does not use an Until field", ErrInvalidType)
+	default:
+		return ErrUknownType
 	}
-	return nil
 }
 
 func (noUntilOption) String() string {
 	return "NoUntil()"
 }
+
+func Until(now func() time.Time, jitter, max time.Duration) Option {
+	return untilOption{
+		now:    now,
+		jitter: jitter,
+		max:    max,
+	}
+}
+
+type untilOption struct {
+	now    func() time.Time
+	jitter time.Duration
+	max    time.Duration
+}
+
+func (u untilOption) Validate(i any) error {
+	switch r := i.(type) {
+	case *RegistrationV1:
+		return r.CheckUntil(u.now, u.jitter, u.max)
+	case *RegistrationV2:
+		return fmt.Errorf("%w: RegistrationV2 does not use an Until field", ErrInvalidType)
+	default:
+		return ErrUknownType
+	}
+}
+
+func (u untilOption) String() string {
+	return fmt.Sprintf("untilOption(%v, %v, %v)", u.jitter.String(), u.max.String(), u.now().String())
+}