allow additionalProperties in oas object 2

Author: shults

apidef/oas/schema/3.0.json

@@ -49,7 +49,7 @@
     "^x-": {
     }
   },
-  "additionalProperties": false,
+  "additionalProperties": true,
   "definitions": {
     "Reference": {
       "type": "object",

apidef/oas/validator.go

@@ -4,22 +4,17 @@ import (
 	"embed"
 	"errors"
 	"fmt"
-	"github.com/TykTechnologies/tyk/pkg/utils"
 	"path/filepath"
-	"slices"
 	"sort"
 	"strings"
 	"sync"
 
-	"github.com/buger/jsonparser"
-	"github.com/hashicorp/go-multierror"
-	pkgver "github.com/hashicorp/go-version"
-	lru "github.com/hashicorp/golang-lru"
-
-	"github.com/TykTechnologies/tyk/common/option"
 	tykerrors "github.com/TykTechnologies/tyk/internal/errors"
 	"github.com/TykTechnologies/tyk/internal/service/gojsonschema"
 	logger "github.com/TykTechnologies/tyk/log"
+	"github.com/buger/jsonparser"
+	"github.com/hashicorp/go-multierror"
+	pkgver "github.com/hashicorp/go-version"
 )
 
 //go:embed schema/*
@@ -31,12 +26,6 @@ const (
 	keyRequired                 = "required"
 	keyAnyOf                    = "anyOf"
 	oasSchemaVersionNotFoundFmt = "Schema not found for version %q"
-
-	defaultLruCacheSize = 1 << 10
-)
-
-var (
-	errUnexpected = errors.New("unexpected: invariant broken")
 )
 
 var (
@@ -47,8 +36,6 @@ var (
 	oasJSONSchemas map[string][]byte
 
 	defaultVersion string
-
-	defaultSchemaCache = utils.Must(NewLruSchemaCache(defaultLruCacheSize))
 )
 
 func loadOASSchema() error {
@@ -148,27 +135,6 @@ func ValidateOASObject(documentBody []byte, oasVersion string) error {
 	return validateJSON(oasSchema, documentBody)
 }
 
-// ValidateOASObjectWithOptions validates an OAS documents due to schema with additional options.
-func ValidateOASObjectWithOptions(documentBody []byte, oasVersion string, opts ...option.Option[schemaModifier]) error {
-	oasSchema, err := GetOASSchema(oasVersion)
-	if err != nil {
-		return err
-	}
-
-	modifier := option.New(opts).Build(schemaModifier{
-		cache:   defaultSchemaCache,
-		version: oasVersion,
-		schema:  oasSchema,
-	})
-
-	oasSchema, err = modifier.getSchema()
-	if err != nil {
-		return err
-	}
-
-	return validateJSON(oasSchema, documentBody)
-}
-
 // ValidateOASTemplate checks a Tyk OAS API template for necessary fields,
 // acknowledging that some standard Tyk OAS API fields are optional in templates.
 func ValidateOASTemplate(documentBody []byte, oasVersion string) error {
@@ -235,20 +201,6 @@ func GetOASSchema(version string) ([]byte, error) {
 	return oasSchema, nil
 }
 
-// AllowRootFields extends list of allowed fields on fly if field is not described
-func AllowRootFields(fields ...string) option.Option[schemaModifier] {
-	return func(s *schemaModifier) {
-		s.allowedFields = fields
-	}
-}
-
-// WithCache allows pass optional cache
-func WithCache(cache SchemaCache) option.Option[schemaModifier] {
-	return func(s *schemaModifier) {
-		s.cache = cache
-	}
-}
-
 func findDefaultVersion(rawVersions []string) string {
 	versions := make([]*pkgver.Version, len(rawVersions))
 	for i, raw := range rawVersions {
@@ -280,115 +232,3 @@ func getMinorVersion(version string) (string, error) {
 	segments := v.Segments()
 	return fmt.Sprintf("%d.%d", segments[0], segments[1]), nil
 }
-
-type schemaModifier struct {
-	version       string
-	schema        []byte
-	allowedFields []string
-	cache         SchemaCache
-}
-
-func (c *schemaModifier) cacheKey() string {
-	allowedFields := slices.Clone(c.allowedFields)
-	slices.SortFunc(allowedFields, strings.Compare)
-	return c.version + ":" + strings.Join(allowedFields, ":")
-}
-
-func (c *schemaModifier) getSchema() ([]byte, error) {
-	if len(c.allowedFields) == 0 {
-		return c.schema, nil
-	}
-
-	key := c.cacheKey()
-
-	if schema, err := c.cache.Get(key, func() ([]byte, error) {
-		var schema = copyBytes(c.schema)
-
-		for _, field := range c.allowedFields {
-			_, _, _, err := jsonparser.Get(schema, keyProperties, field)
-
-			if errors.Is(err, jsonparser.KeyPathNotFoundError) {
-				if schema, err = jsonparser.Set(schema, []byte(`{}`), keyProperties, field); err != nil {
-					return nil, err
-				}
-			} else if err != nil {
-				return nil, err
-			}
-		}
-
-		return schema, nil
-	}); err != nil {
-		return nil, err
-	} else {
-		return schema, nil
-	}
-}
-
-// SchemaCache json schema cache.
-type SchemaCache interface {
-	Get(key string, create func() ([]byte, error)) ([]byte, error)
-}
-
-// interface created for acceptance tests purposes
-type extendedSchemaCache interface {
-	SchemaCache
-	Purge()
-	Len() int
-}
-
-var _ SchemaCache = (*LruSchemaCache)(nil)
-
-// LruSchemaCache schema caching object which implements LRU algorithm under the hood.
-type LruSchemaCache struct {
-	capacity int
-	cache    *lru.Cache
-}
-
-// NewLruSchemaCache create new cache instance.
-func NewLruSchemaCache(capacity int) (*LruSchemaCache, error) {
-	lruCache, err := lru.New(capacity)
-
-	if err != nil {
-		return nil, err
-	}
-
-	return &LruSchemaCache{
-		capacity: capacity,
-		cache:    lruCache,
-	}, nil
-}
-
-func (l *LruSchemaCache) Get(key string, create func() ([]byte, error)) ([]byte, error) {
-	if res, ok := l.cache.Get(key); ok {
-		bRes, okCast := res.([]byte)
-
-		if !okCast {
-			return nil, errUnexpected
-		}
-
-		return bRes, nil
-	}
-
-	newEntry, err := create()
-	if err != nil {
-		return nil, err
-	}
-
-	_ = l.cache.Add(key, newEntry)
-
-	return newEntry, nil
-}
-
-func (l *LruSchemaCache) Purge() {
-	l.cache.Purge()
-}
-
-func (l *LruSchemaCache) Len() int {
-	return l.cache.Len()
-}
-
-func copyBytes(in []byte) []byte {
-	out := make([]byte, len(in))
-	copy(out, in)
-	return out
-}

apidef/oas/validator_test.go

@@ -2,9 +2,7 @@ package oas
 
 import (
 	"embed"
-	"encoding/json"
 	"fmt"
-	jsonpatch "github.com/evanphx/json-patch"
 	"strings"
 	"testing"
 
@@ -294,62 +292,3 @@ func TestGetOASSchema(t *testing.T) {
 		assert.Equal(t, expectedErr, err)
 	})
 }
-
-func TestValidateOASObjectWithLruCache(t *testing.T) {
-	schemaCache, err := NewLruSchemaCache(10)
-	require.NoError(t, err)
-	acceptanceTestsValidateOASObjectWithOptions(t, schemaCache)
-}
-
-// acceptanceTestsValidateOASObjectWithCache acceptance tests validator + cache
-func acceptanceTestsValidateOASObjectWithOptions(t *testing.T, cache extendedSchemaCache) {
-	t.Helper()
-
-	const oasVersion = "3.0.3"
-
-	cache.Purge()
-	assert.Equal(t, 0, cache.Len())
-
-	t.Run("fails if additional field exists but not allowed", func(t *testing.T) {
-		spec := extendDefaultValidOas(t, `{"additional": true}`)
-		err := ValidateOASObjectWithOptions(spec, oasVersion, WithCache(cache))
-		assert.Error(t, err)
-		assert.Equal(t, 0, cache.Len())
-	})
-
-	t.Run("does not fail if additional field is allowed", func(t *testing.T) {
-		spec := extendDefaultValidOas(t, `{"additional": true}`)
-		err := ValidateOASObjectWithOptions(spec, oasVersion, AllowRootFields("additional"), WithCache(cache))
-		assert.NoError(t, err)
-		assert.Equal(t, 1, cache.Len(), "puts one entry into cache")
-
-		spec2 := extendDefaultValidOas(t, `{"additional": true}`)
-		err2 := ValidateOASObjectWithOptions(spec2, oasVersion, AllowRootFields("additional"), WithCache(cache))
-		assert.NoError(t, err2)
-		assert.Equal(t, 1, cache.Len(), "does not extend cache")
-	})
-
-	t.Run("does not allow to override default validation rules", func(t *testing.T) {
-		spec := extendDefaultValidOas(t, `{"paths": true}`)
-		err := ValidateOASObjectWithOptions(spec, oasVersion, AllowRootFields("paths"), WithCache(cache))
-		assert.Error(t, err)
-		assert.Equal(t, 2, cache.Len(), "extends cache once more")
-	})
-}
-
-func extendDefaultValidOas(tb testing.TB, patch string) []byte {
-	tb.Helper()
-
-	var spec openapi3.T
-	spec.OpenAPI = "3.0.3"
-	spec.Paths = openapi3.NewPaths()
-	spec.Info = &openapi3.Info{}
-
-	data, err := json.Marshal(spec)
-	require.NoError(tb, err)
-
-	data, err = jsonpatch.MergePatch(data, []byte(patch))
-	require.NoError(tb, err)
-
-	return data
-}

go.mod

@@ -99,13 +99,11 @@ require (
 	github.com/TykTechnologies/opentelemetry v0.0.22
 	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/eclipse/paho.mqtt.golang v1.4.3
-	github.com/evanphx/json-patch v4.12.0+incompatible
 	github.com/getkin/kin-openapi v0.132.0
 	github.com/go-redis/redismock/v9 v9.2.0
 	github.com/goccy/go-json v0.10.4
 	github.com/goccy/go-yaml v1.15.23
 	github.com/google/go-cmp v0.7.0
-	github.com/hashicorp/golang-lru v0.5.4
 	github.com/hashicorp/golang-lru/v2 v2.0.7
 	github.com/huandu/go-clone/generic v1.7.2
 	github.com/mccutchen/go-httpbin/v2 v2.18.2
@@ -350,6 +348,7 @@ require (
 	github.com/hashicorp/go-secure-stdlib/strutil v0.1.2 // indirect
 	github.com/hashicorp/go-sockaddr v1.0.2 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
+	github.com/hashicorp/golang-lru v0.5.4 // indirect
 	github.com/hashicorp/golang-lru/arc/v2 v2.0.7 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/hashicorp/raft v1.7.1 // indirect