Fix Bundler Compose Mode Breaking with Non Filename Dots

Author: califlower

bundler/composer_functions.go

@@ -156,33 +156,38 @@ func remapIndex(idx *index.SpecIndex, processedNodes *orderedmap.Map[string, *pr
 
 func renameRef(idx *index.SpecIndex, def string, processedNodes *orderedmap.Map[string, *processRef]) string {
 	if strings.Contains(def, "#/") {
-
 		defSplit := strings.Split(def, "#/")
 		if len(defSplit) != 2 {
 			return def
 		}
-		split := strings.Split(defSplit[1], "/")
-		if ref := processedNodes.GetOrZero(def); ref != nil {
-			return fmt.Sprintf("#/%s/%s", strings.Join(split[:len(split)-1], "/"), ref.name)
+		ptr := defSplit[1] // e.g. components/schemas/Foo
+		segs := strings.Split(ptr, "/")
+		if len(segs) < 2 {
+			return def
 		}
-		if ref, ok := idx.GetMappedReferences()[def]; ok {
-			ext := filepath.Ext(ref.Name)
-			name := ref.Name
-			if ext != "" {
-				name = strings.Replace(ref.Name, ext, "", 1)
+		prefix := strings.Join(segs[:len(segs)-1], "/")
+
+		// reference already renamed during composition
+		if pr := processedNodes.GetOrZero(def); pr != nil {
+			return fmt.Sprintf("#/%s/%s", prefix, pr.name)
+		}
+
+		if idx != nil {
+			if ref, ok := idx.GetMappedReferences()[def]; ok && ref != nil {
+				return fmt.Sprintf("#/%s/%s", prefix, ref.Name)
 			}
-			return fmt.Sprintf("#/%s/%s", strings.Join(split[:len(split)-1], "/"), name)
 		}
+
+		// fallback – keep last segment
+		return fmt.Sprintf("#/%s/%s", prefix, segs[len(segs)-1])
 	}
 
-	// handle root file imports.
-	name := ""
-	if pn := processedNodes.GetOrZero(def); pn != nil {
-		if len(pn.location) > 0 {
-			name = fmt.Sprintf("#/%s", strings.Join(pn.location, "/"))
-		}
+	// root-file import lifted into components
+	if pn := processedNodes.GetOrZero(def); pn != nil && len(pn.location) > 0 {
+		return "#/" + strings.Join(pn.location, "/")
 	}
-	return name
+
+	return def
 }
 
 func rewireRef(idx *index.SpecIndex, ref *index.Reference, fullDef string, processedNodes *orderedmap.Map[string, *processRef]) {

bundler/composer_functions_test.go

@@ -4,6 +4,8 @@
 package bundler
 
 import (
+	"errors"
+	"github.com/pb33f/libopenapi/orderedmap"
 	"testing"
 
 	"github.com/pb33f/libopenapi"
@@ -95,3 +97,80 @@ func TestProcessRef_UnknownLocation_ThreeStep(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Len(t, config.inlineRequired, 1)
 }
+
+// ---- RenameRef Tests ----
+
+// A component key that contains a dot (“asdf.zxcv”) must *not* be shortened to
+// “asdf” when we re-wire references.
+func TestRenameRef_KeepsDotInComponentName(t *testing.T) {
+	spec := []byte(`
+openapi: 3.1.0
+info:
+  title: Test
+  version: 0.0.0
+components:
+  schemas:
+    "asdf.zxcv":
+      type: object
+    Foo:
+      allOf:
+        - $ref: '#/components/schemas/asdf.zxcv'
+`)
+
+	doc, err := libopenapi.NewDocument(spec)
+	assert.NoError(t, err)
+
+	v3doc, errs := doc.BuildV3Model()
+	assert.NoError(t, errors.Join(errs...))
+
+	idx := v3doc.Model.Index
+
+	processed := orderedmap.New[string, *processRef]()
+
+	got := renameRef(idx, "#/components/schemas/asdf.zxcv", processed)
+
+	assert.Equal(t,
+		"#/components/schemas/asdf.zxcv",
+		got,
+		"renameRef must not strip the .zxcv part from the component key")
+}
+
+// A reference that really *is* a filename + JSON-pointer must still have the
+// extension stripped
+func TestRenameRef_FilePointer_Extensions(t *testing.T) {
+	exts := []string{".yaml", ".yml", ".json"}
+
+	for _, ext := range exts {
+		def := "schemas/pet" + ext + "#/components/schemas/Pet"
+		got := renameRef(nil, def, orderedmap.New[string, *processRef]())
+		assert.Equal(t, "#/components/schemas/Pet", got,
+			"extension %s should not affect the pointer rewrite", ext)
+	}
+}
+
+// If a component name has already been changed during composition,
+// renameRef must return that new name.
+func TestRenameRef_RespectsAlreadyRenamedComponent(t *testing.T) {
+	ps := orderedmap.New[string, *processRef]()
+	ps.Set("#/components/schemas/asdf.zxcv",
+		&processRef{name: "asdf__1", location: []string{}})
+
+	got := renameRef(nil,
+		"#/components/schemas/asdf.zxcv",
+		ps)
+
+	assert.Equal(t,
+		"#/components/schemas/asdf__1",
+		got,
+		"renameRef should use the name stored in processedNodes")
+}
+
+func TestRenameRef_RootFileImport(t *testing.T) {
+	processed := orderedmap.New[string, *processRef]()
+	processed.Set("schemas/pet.yaml",
+		&processRef{location: []string{"components", "schemas", "Pet"}})
+
+	got := renameRef(nil, "schemas/pet.yaml", processed)
+
+	assert.Equal(t, "#/components/schemas/Pet", got)
+}