added context to FindComponent

this allows for tracking of a root index when performing deeply nested reference end seeking using `seefRefEnd` in the utilities

Resolves #402

Author: daveshanley

bundler/bundler.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 	"sync"
 
+	"context"
 	"github.com/pb33f/libopenapi"
 	"github.com/pb33f/libopenapi/datamodel"
 	v3 "github.com/pb33f/libopenapi/datamodel/high/v3"
@@ -181,7 +182,7 @@ func bundle(model *v3.Document) ([]byte, error) {
 					for _, i := range indexes {
 						if i.GetSpecAbsolutePath() == refExp[0] {
 							if mappedReference != nil && !mappedReference.Circular {
-								mr := i.FindComponent(sequenced.Definition)
+								mr := i.FindComponent(context.Background(), sequenced.Definition)
 								if mr != nil {
 									// found the component; this is the one we want to use.
 									mappedReference = mr

bundler/bundler_composer.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"sync"
 
+	"context"
 	v3 "github.com/pb33f/libopenapi/datamodel/high/v3"
 	v3low "github.com/pb33f/libopenapi/datamodel/low/v3"
 	"github.com/pb33f/libopenapi/index"
@@ -57,7 +58,7 @@ func handleIndex(c *handleIndexConfig) {
 					if !strings.Contains(lookup, "#/") {
 						lookup = sequenced.FullDefinition
 					}
-					mr := i.FindComponent(lookup)
+					mr := i.FindComponent(context.Background(), lookup)
 					if mr != nil {
 						// found the component; this is the one we want to use.
 						mappedReference = mr

bundler/bundler_composer_test.go

@@ -116,3 +116,33 @@ func TestBuildSchema(t *testing.T) {
 	_, err := buildSchema(nil, nil)
 	assert.Error(t, err)
 }
+
+func TestBundlerComposed_StrangeRefs(t *testing.T) {
+	specBytes, err := os.ReadFile("../test_specs/first.yaml")
+
+	doc, err := libopenapi.NewDocumentWithConfiguration(specBytes, &datamodel.DocumentConfiguration{
+		BasePath:                "../test_specs/",
+		ExtractRefsSequentially: true,
+		Logger:                  slog.Default(),
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	v3Doc, errs := doc.BuildV3Model()
+	if len(errs) > 0 {
+		panic(errs)
+	}
+
+	var bytes []byte
+
+	bytes, err = BundleDocumentComposed(&v3Doc.Model, &BundleCompositionConfig{Delimiter: "__"})
+	if err != nil {
+		panic(err)
+	}
+
+	// windows needs a different byte count
+	if runtime.GOOS != "windows" {
+		assert.Len(t, bytes, 3075)
+	}
+}

index/extract_refs.go

@@ -12,6 +12,7 @@ import (
 	"slices"
 	"strings"
 
+	"context"
 	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
@@ -668,7 +669,7 @@ func (index *SpecIndex) ExtractComponentsFromRefs(refs []*Reference) []*Referenc
 			if unsafeAsync {
 				index.refLock.Lock()
 			}
-			located := index.FindComponent(ref.FullDefinition)
+			located := index.FindComponent(context.Background(), ref.FullDefinition)
 			if unsafeAsync {
 				index.refLock.Unlock()
 			}

index/find_component.go

@@ -11,6 +11,7 @@ import (
 
 	jsonpathconfig "github.com/speakeasy-api/jsonpath/pkg/jsonpath/config"
 
+	"context"
 	"github.com/pb33f/libopenapi/utils"
 	"github.com/speakeasy-api/jsonpath/pkg/jsonpath"
 	"gopkg.in/yaml.v3"
@@ -19,7 +20,7 @@ import (
 // FindComponent will locate a component by its reference, returns nil if nothing is found.
 // This method will recurse through remote, local and file references. For each new external reference
 // a new index will be created. These indexes can then be traversed recursively.
-func (index *SpecIndex) FindComponent(componentId string) *Reference {
+func (index *SpecIndex) FindComponent(ctx context.Context, componentId string) *Reference {
 	if index.root == nil {
 		return nil
 	}
@@ -40,6 +41,20 @@ func (index *SpecIndex) FindComponent(componentId string) *Reference {
 		// does it contain a file extension?
 		fileExt := filepath.Ext(componentId)
 		if fileExt != "" {
+
+			// check if the context has a root index set, if so this is a deep search that has moved through multiple
+			// indexes and we need to adjust the URI to reflect the location of the root index.
+			if ctx.Value(RootIndexKey) != nil {
+				rootIndex := ctx.Value(RootIndexKey).(*SpecIndex)
+				if rootIndex != nil && rootIndex.specAbsolutePath != "" {
+					dir := filepath.Dir(rootIndex.specAbsolutePath)
+					// create an absolute path to the file.
+					absoluteFilePath := filepath.Join(dir, componentId)
+					// split into a URI.
+					uri = []string{absoluteFilePath}
+				}
+			}
+
 			return index.lookupRolodex(uri)
 		}
 

index/search_index.go

@@ -16,6 +16,7 @@ type ContextKey string
 const (
 	CurrentPathKey ContextKey = "currentPath"
 	FoundIndexKey  ContextKey = "foundIndex"
+	RootIndexKey   ContextKey = "currentIndex"
 )
 
 func (index *SpecIndex) SearchIndexForReferenceByReference(fullRef *Reference) (*Reference, *SpecIndex) {
@@ -225,7 +226,7 @@ func (index *SpecIndex) SearchIndexForReferenceByReferenceWithContext(ctx contex
 						found = FindComponent(node, compId, exp[0], idx)
 					}
 					if found == nil {
-						found = idx.FindComponent(ref)
+						found = idx.FindComponent(ctx, ref)
 					}
 
 					if found != nil {

index/spec_index.go

@@ -1045,6 +1045,7 @@ func (index *SpecIndex) GetOperationCount() int {
 			// is the path a ref?
 			if isRef, _, ref := utils.IsNodeRefValue(method); isRef {
 				ctx := context.WithValue(context.Background(), CurrentPathKey, index.specAbsolutePath)
+				ctx = context.WithValue(ctx, RootIndexKey, index)
 				pNode := seekRefEnd(ctx, index, ref)
 				if pNode != nil {
 					method = pNode.Node
@@ -1121,6 +1122,7 @@ func (index *SpecIndex) GetOperationsParameterCount() int {
 			// is the path a ref?
 			if isRef, _, ref := utils.IsNodeRefValue(pathPropertyNode); isRef {
 				ctx := context.WithValue(context.Background(), CurrentPathKey, index.specAbsolutePath)
+				ctx = context.WithValue(ctx, RootIndexKey, index)
 				pNode := seekRefEnd(ctx, index, ref)
 				if pNode != nil {
 					pathPropertyNode = pNode.Node

index/spec_index_test.go

@@ -19,6 +19,7 @@ import (
 	"testing"
 	"time"
 
+	"context"
 	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"gopkg.in/yaml.v3"
@@ -785,7 +786,7 @@ func TestSpecIndex_NoRoot(t *testing.T) {
 	docs := index.ExtractExternalDocuments(nil)
 	assert.Nil(t, docs)
 	assert.Nil(t, refs)
-	assert.Nil(t, index.FindComponent("nothing"))
+	assert.Nil(t, index.FindComponent(context.Background(), "nothing"))
 	assert.Equal(t, -1, index.GetOperationCount())
 	assert.Equal(t, -1, index.GetPathCount())
 	assert.Equal(t, -1, index.GetGlobalTagsCount())
@@ -1037,10 +1038,10 @@ func TestSpecIndex_FindComponent_WithACrazyAssPath(t *testing.T) {
 
 	index := NewSpecIndexWithConfig(&rootNode, CreateOpenAPIIndexConfig())
 	assert.Equal(t, "#/paths/~1crazy~1ass~1references/get/parameters/0",
-		index.FindComponent("#/paths/~1crazy~1ass~1references/get/responses/404/content/application~1xml;%20charset=utf-8/schema").Node.Content[1].Value)
+		index.FindComponent(context.Background(), "#/paths/~1crazy~1ass~1references/get/responses/404/content/application~1xml;%20charset=utf-8/schema").Node.Content[1].Value)
 
 	assert.Equal(t, "a param",
-		index.FindComponent("#/paths/~1crazy~1ass~1references/get/parameters/0").Node.Content[1].Value)
+		index.FindComponent(context.Background(), "#/paths/~1crazy~1ass~1references/get/parameters/0").Node.Content[1].Value)
 }
 
 func TestSpecIndex_FindComponent(t *testing.T) {
@@ -1057,7 +1058,7 @@ func TestSpecIndex_FindComponent(t *testing.T) {
 	_ = yaml.Unmarshal([]byte(yml), &rootNode)
 
 	index := NewSpecIndexWithConfig(&rootNode, CreateOpenAPIIndexConfig())
-	assert.Nil(t, index.FindComponent("I-do-not-exist"))
+	assert.Nil(t, index.FindComponent(context.Background(), "I-do-not-exist"))
 }
 
 func TestSpecIndex_TestPathsNodeAsArray(t *testing.T) {

index/utility_methods.go

@@ -425,7 +425,7 @@ func (index *SpecIndex) scanOperationParams(params []*yaml.Node, keyNode, pathIt
 				// could be in the rolodex
 				searchInIndex := findIndex(index, param.Content[1])
 				ctx := context.WithValue(context.Background(), CurrentPathKey, searchInIndex.specAbsolutePath)
-
+				ctx = context.WithValue(ctx, RootIndexKey, searchInIndex)
 				ref := seekRefEnd(ctx, searchInIndex, paramRefName)
 				if ref != nil {
 					paramRef = ref