Merge pull request #128 from ripienaar/optional_validation

Make validation optional, and null by default

README.md

@@ -1,10 +1,10 @@
 ## Overview
 
-This is a library for managing and interacting with JetStream.
+This is a library for managing and interacting with the JetStream API and various other NATS APIs and event sources.
 
-This library provides API access to all the JetStream related abilities of the `nats` CLI utility.
-
-**NOTE** For general access to JetStream no special libraries are needed, the standard language specific NATS client can be used. These are optional helpers.
+This library provides API accesses to all the JetStream related abilities of the `nats` CLI utility. To support API access
+it provides a rich set of functions related to validation, documenting and detecting event types using a set of JSON 
+Schema documents. 
 
 ## Stability
 

api/gen.go

@@ -58,8 +58,12 @@ var schemaTypes = map[string]func() interface{}{
 {{- range . }}
 {{- if .ShouldAddValidator }}
 // Validate performs a JSON Schema validation of the configuration
-func (t {{ .St }}) Validate() (valid bool, errors []string) {
-	return ValidateStruct(t, t.SchemaType())
+func (t {{ .St }}) Validate(v ...StructValidator) (valid bool, errors []string) {
+	if len(v) == 0 || v[0] == nil {
+		return true, nil
+	}
+
+	return v[0].ValidateStruct(t, t.SchemaType())
 }
 
 // SchemaType is the NATS schema type {{ .T }}

api/schemas.go

@@ -10,8 +10,6 @@ import (
 	"strings"
 	"text/template"
 	"time"
-
-	"github.com/xeipuuv/gojsonschema"
 )
 
 // SchemasRepo is the repository holding NATS Schemas
@@ -30,6 +28,11 @@ type Event interface {
 	EventTemplate(kind string) (*template.Template, error)
 }
 
+// StructValidator is used to validate API structures
+type StructValidator interface {
+	ValidateStruct(data interface{}, schemaType string) (ok bool, errs []string)
+}
+
 // RenderFormat indicates the format to render templates in
 type RenderFormat string
 
@@ -155,33 +158,6 @@ func NewMessage(schemaType string) (interface{}, bool) {
 	return gf(), ok
 }
 
-// ValidateStruct validates data matches schemaType like io.nats.jetstream.advisory.v1.api_audit
-func ValidateStruct(data interface{}, schemaType string) (ok bool, errs []string) {
-	// other more basic types can be validated directly against their schemaType
-	s, err := Schema(schemaType)
-	if err != nil {
-		return false, []string{"unknown schema type %s", schemaType}
-	}
-
-	ls := gojsonschema.NewBytesLoader(s)
-	ld := gojsonschema.NewGoLoader(data)
-	result, err := gojsonschema.Validate(ls, ld)
-	if err != nil {
-		return false, []string{fmt.Sprintf("validation failed: %s", err)}
-	}
-
-	if result.Valid() {
-		return true, nil
-	}
-
-	errors := make([]string, len(result.Errors()))
-	for i, verr := range result.Errors() {
-		errors[i] = verr.String()
-	}
-
-	return false, errors
-}
-
 // ParseMessage parses a typed message m and returns event as for example *api.ConsumerAckMetric, all unknown
 // event schemas will be of type *UnknownMessage
 func ParseMessage(m []byte) (schemaType string, msg interface{}, err error) {