fix "IsReference/GetReference" for all types in components

Author: vkd

datamodel/low/base/example.go

@@ -72,10 +72,13 @@ func (ex *Example) Hash() [32]byte {
 // Build extracts extensions and example value
 func (ex *Example) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
 	ex.KeyNode = keyNode
+	ex.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		ex.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	ex.RootNode = root
 	utils.CheckForMergeNodes(root)
-	ex.Reference = new(low.Reference)
 	ex.Nodes = low.ExtractNodes(ctx, root)
 	ex.Extensions = low.ExtractExtensions(root)
 	ex.context = ctx

datamodel/low/base/example_test.go

@@ -195,3 +195,22 @@ x-burger: nice`
 	assert.Equal(t, lDoc.Hash(), rDoc.Hash())
 	assert.Equal(t, 1, orderedmap.Len(lDoc.GetExtensions()))
 }
+
+func TestExample_Build_Success_Ref(t *testing.T) {
+	yml := `$ref: "#/responses/abc"`
+
+	var idxNode yaml.Node
+	mErr := yaml.Unmarshal([]byte(yml), &idxNode)
+	assert.NoError(t, mErr)
+	idx := index.NewSpecIndexWithConfig(&idxNode, index.CreateClosedAPIIndexConfig())
+
+	var n Example
+	err := low.BuildModel(idxNode.Content[0], &n)
+	assert.NoError(t, err)
+
+	err = n.Build(context.Background(), nil, idxNode.Content[0], idx)
+	assert.NoError(t, err)
+
+	assert.True(t, n.IsReference())
+	assert.Equal(t, "#/responses/abc", n.GetReference())
+}

datamodel/low/v3/callback.go

@@ -67,10 +67,13 @@ func (cb *Callback) FindExpression(exp string) *low.ValueReference[*PathItem] {
 // Build will extract extensions, expressions and PathItem objects for Callback
 func (cb *Callback) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
 	cb.KeyNode = keyNode
+	cb.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		cb.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	cb.RootNode = root
 	utils.CheckForMergeNodes(root)
-	cb.Reference = new(low.Reference)
 	cb.Nodes = low.ExtractNodes(ctx, root)
 	cb.Extensions = low.ExtractExtensions(root)
 	cb.context = ctx

datamodel/low/v3/components.go

@@ -310,23 +310,9 @@ func extractComponentValues[T low.Buildable[N], N any](ctx context.Context, labe
 		currentLabel := value.currentLabel
 		node := value.node
 
-		// if this is a reference, extract it (although components with references is an antipattern)
-		// If you're building components as references... pls... stop, this code should not need to be here.
-		// TODO: check circular crazy on this. It may explode
-		var err error
-		nCtx := ctx
-		fIdx := idx
-		if h, rv, _ := utils.IsNodeRefValue(node); h && label != SchemasLabel {
-			node, fIdx, err, nCtx = low.LocateRefNodeWithContext(ctx, node, idx)
-			nCtx = context.WithValue(nCtx, "reference", rv)
-		}
-		if err != nil {
-			return componentBuildResult[T]{}, err
-		}
-
 		// build.
 		_ = low.BuildModel(node, n)
-		err = n.Build(nCtx, currentLabel, node, fIdx)
+		err := n.Build(ctx, currentLabel, node, idx)
 		if err != nil {
 			return componentBuildResult[T]{}, err
 		}

datamodel/low/v3/components_test.go

@@ -262,3 +262,101 @@ func TestComponents_Build_HashEmpty(t *testing.T) {
 	assert.Equal(t, "e45605d7361dbc9d4b9723257701bef1d283f8fe9566b9edda127fc66a6b8fdd",
 		low.GenerateHashString(&n))
 }
+
+func TestComponents_IsReference(t *testing.T) {
+	var yml = `
+schemas:
+    one:
+        description: one of many
+    two:
+        $ref: "#/schemas/one"
+responses:
+    three:
+        description: three of many
+    four:
+        $ref: "#/responses/three"
+parameters:
+    five:
+        description: five of many
+    six:
+        $ref: "#/parameters/five"
+examples:
+    seven:
+        description: seven of many
+    eight:
+        $ref: "#/examples/seven"
+requestBodies:
+    nine:
+        description: nine of many
+    ten:
+        $ref: "#/requestBodies/nine"
+headers:
+    eleven:
+        description: eleven of many
+    twelve:
+        $ref: "#/headers/eleven"
+securitySchemes:
+    thirteen:
+        description: thirteen of many
+    fourteen:
+        $ref: "#/securitySchemes/thirteen"
+links:
+    fifteen:
+        description: fifteen of many
+    sixteen:
+        $ref: "#/links/fifteen"
+callbacks:
+    seventeen:
+        '{reference}':
+            post:
+            description: seventeen of many
+    eighteen:
+        $ref: "#/callbacks/seventeen"
+`
+
+	var idxNode yaml.Node
+	mErr := yaml.Unmarshal([]byte(yml), &idxNode)
+	assert.NoError(t, mErr)
+	idx := index.NewSpecIndex(&idxNode)
+
+	var n Components
+	err := low.BuildModel(idxNode.Content[0], &n)
+	assert.NoError(t, err)
+
+	err = n.Build(context.Background(), idxNode.Content[0], idx)
+	assert.NoError(t, err)
+
+	assert.Equal(t, "#/schemas/one", n.FindSchema("two").Value.GetReference())
+	assert.Equal(t, "#/responses/three", n.FindResponse("four").Value.GetReference())
+	assert.Equal(t, "#/parameters/five", n.FindParameter("six").Value.GetReference())
+	assert.Equal(t, "#/examples/seven", n.FindExample("eight").Value.GetReference())
+	assert.Equal(t, "#/requestBodies/nine", n.FindRequestBody("ten").Value.GetReference())
+	assert.Equal(t, "#/headers/eleven", n.FindHeader("twelve").Value.GetReference())
+	assert.Equal(t, "#/securitySchemes/thirteen", n.FindSecurityScheme("fourteen").Value.GetReference())
+	assert.Equal(t, "#/links/fifteen", n.FindLink("sixteen").Value.GetReference())
+	assert.Equal(t, "#/callbacks/seventeen", n.FindCallback("eighteen").Value.GetReference())
+}
+
+func TestComponents_IsReference_OutOfSpecification_PathItem(t *testing.T) {
+	var yml = `
+pathItems:
+    one:
+        description: one of many
+    two:
+        $ref: "#/pathItems/one"
+`
+
+	var idxNode yaml.Node
+	mErr := yaml.Unmarshal([]byte(yml), &idxNode)
+	assert.NoError(t, mErr)
+	idx := index.NewSpecIndex(&idxNode)
+
+	var n Components
+	err := low.BuildModel(idxNode.Content[0], &n)
+	assert.NoError(t, err)
+
+	err = n.Build(context.Background(), idxNode.Content[0], idx)
+	assert.NoError(t, err)
+
+	assert.Equal(t, "#/pathItems/one", n.FindPathItem("two").Value.GetReference())
+}

datamodel/low/v3/create_document_test.go

@@ -753,7 +753,7 @@ components:
 	info, _ := datamodel.ExtractSpecInfo([]byte(yml))
 	var err error
 	_, err = CreateDocumentFromConfig(info, &datamodel.DocumentConfiguration{})
-	assert.Equal(t, "reference at line 5, column 7 is empty, it cannot be resolved", err.Error())
+	assert.Equal(t, "schema build failed: reference '[empty]' cannot be found at line 5, col 12", err.Error())
 }
 
 func TestCreateDocument_Paths_Errors(t *testing.T) {

datamodel/low/v3/header.go

@@ -113,10 +113,13 @@ func (h *Header) Hash() [32]byte {
 // Build will extract extensions, examples, schema and content/media types from node.
 func (h *Header) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
 	h.KeyNode = keyNode
+	h.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		h.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	h.RootNode = root
 	utils.CheckForMergeNodes(root)
-	h.Reference = new(low.Reference)
 	h.Nodes = low.ExtractNodes(ctx, root)
 	h.Extensions = low.ExtractExtensions(root)
 	h.context = ctx

datamodel/low/v3/link.go

@@ -81,10 +81,13 @@ func (l *Link) GetKeyNode() *yaml.Node {
 // Build will extract extensions and servers from the node.
 func (l *Link) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
 	l.KeyNode = keyNode
+	l.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		l.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	l.RootNode = root
 	utils.CheckForMergeNodes(root)
-	l.Reference = new(low.Reference)
 	l.Nodes = low.ExtractNodes(ctx, root)
 	l.Extensions = low.ExtractExtensions(root)
 	l.index = idx

datamodel/low/v3/parameter.go

@@ -87,11 +87,14 @@ func (p *Parameter) GetExtensions() *orderedmap.Map[low.KeyReference[string], lo
 
 // Build will extract examples, extensions and content/media types.
 func (p *Parameter) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
+	p.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		p.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	p.KeyNode = keyNode
 	p.RootNode = root
 	utils.CheckForMergeNodes(root)
-	p.Reference = new(low.Reference)
 	p.Nodes = low.ExtractNodes(ctx, root)
 	p.Extensions = low.ExtractExtensions(root)
 	p.index = idx

datamodel/low/v3/path_item.go

@@ -129,11 +129,14 @@ func (p *PathItem) GetExtensions() *orderedmap.Map[low.KeyReference[string], low
 // Build extracts extensions, parameters, servers and each http method defined.
 // everything is extracted asynchronously for speed.
 func (p *PathItem) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
+	p.Reference = new(low.Reference)
+	if ok, _, ref := utils.IsNodeRefValue(root); ok {
+		p.SetReference(ref, root)
+	}
 	root = utils.NodeAlias(root)
 	p.KeyNode = keyNode
 	p.RootNode = root
 	utils.CheckForMergeNodes(root)
-	p.Reference = new(low.Reference)
 	p.Nodes = low.ExtractNodes(ctx, root)
 	p.Extensions = low.ExtractExtensions(root)
 	p.index = idx