Address issue #202

This required the use of the RevisionFS to fully solve this properly.

Author: daveshanley

cmd/engine.go

@@ -9,12 +9,12 @@ import (
 
 	"github.com/pb33f/doctor/changerator"
 	drModel "github.com/pb33f/doctor/model"
+	v3 "github.com/pb33f/doctor/model/high/v3"
 	whatChangedModel "github.com/pb33f/libopenapi/what-changed/model"
 	"github.com/pb33f/openapi-changes/internal/breakingrules"
 	"github.com/pb33f/openapi-changes/model"
 )
 
-
 // changeratorResult owns the doctor-side resources created for a single comparison.
 //
 // Callers must call Release() exactly once when they are done reading Changerator,
@@ -82,6 +82,7 @@ func runChangerator(commit *model.Commit, breakingConfig *whatChangedModel.Break
 		leftDrDoc.Release()
 		return nil, nil
 	}
+	rewriteOutputLocations(ctr, docChanges, commit.DocumentRewriters)
 
 	return &changeratorResult{
 		Changerator: ctr,
@@ -91,6 +92,94 @@ func runChangerator(commit *model.Commit, breakingConfig *whatChangedModel.Break
 	}, nil
 }
 
+func rewriteOutputLocations(ctr *changerator.Changerator, docChanges *whatChangedModel.DocumentChanges, rewriters []model.DocumentPathRewriter) {
+	if len(rewriters) == 0 {
+		return
+	}
+	rewriteDocumentChangeLocations(docChanges, rewriters)
+	if ctr != nil {
+		rewriteChangedNodeLocations(ctr.ChangedNodes, rewriters)
+	}
+}
+
+func rewriteDocumentChangeLocations(docChanges *whatChangedModel.DocumentChanges, rewriters []model.DocumentPathRewriter) {
+	if docChanges == nil {
+		return
+	}
+	for _, change := range docChanges.GetAllChanges() {
+		if change == nil || change.Context == nil || change.Context.DocumentLocation == "" {
+			continue
+		}
+		change.Context.DocumentLocation = rewriteDocumentLocation(change.Context.DocumentLocation, rewriters)
+	}
+}
+
+func rewriteChangedNodeLocations(nodes []*v3.Node, rewriters []model.DocumentPathRewriter) {
+	if len(nodes) == 0 {
+		return
+	}
+	seen := make(map[*v3.Node]struct{}, len(nodes))
+	var walk func(*v3.Node)
+	walk = func(node *v3.Node) {
+		if node == nil {
+			return
+		}
+		if _, ok := seen[node]; ok {
+			return
+		}
+		seen[node] = struct{}{}
+
+		if node.Origin != nil {
+			node.Origin.AbsoluteLocation = rewriteDocumentLocation(node.Origin.AbsoluteLocation, rewriters)
+			node.Origin.AbsoluteLocationValue = rewriteDocumentLocation(node.Origin.AbsoluteLocationValue, rewriters)
+		}
+		node.OriginLocation = rewriteDocumentLocation(node.OriginLocation, rewriters)
+		for _, changed := range node.GetChanges() {
+			for _, change := range changed.GetAllChanges() {
+				if change == nil || change.Context == nil {
+					continue
+				}
+				change.Context.DocumentLocation = rewriteDocumentLocation(change.Context.DocumentLocation, rewriters)
+			}
+		}
+		for _, change := range node.RenderedChanges {
+			if change == nil || change.Context == nil {
+				continue
+			}
+			change.Context.DocumentLocation = rewriteDocumentLocation(change.Context.DocumentLocation, rewriters)
+		}
+		for _, change := range node.CleanedChanged {
+			if change == nil || change.Context == nil {
+				continue
+			}
+			change.Context.DocumentLocation = rewriteDocumentLocation(change.Context.DocumentLocation, rewriters)
+		}
+
+		for _, child := range node.Children {
+			walk(child)
+		}
+	}
+	for _, node := range nodes {
+		walk(node)
+	}
+}
+
+func rewriteDocumentLocation(raw string, rewriters []model.DocumentPathRewriter) string {
+	if raw == "" {
+		return raw
+	}
+	for _, rewrite := range rewriters {
+		if rewrite == nil {
+			continue
+		}
+		rewritten := rewrite(raw)
+		if rewritten != raw {
+			return rewritten
+		}
+	}
+	return raw
+}
+
 func emitCommitWarning(commitHash string, err error) {
 	fmt.Fprintf(os.Stderr, "warning: commit %s: %s\n", commitHash, err)
 }

cmd/engine_test.go

@@ -0,0 +1,89 @@
+// Copyright 2023-2026 Princess Beef Heavy Industries, LLC / Dave Shanley
+// SPDX-License-Identifier: Apache-2.0
+
+package cmd
+
+import (
+	"path/filepath"
+	"strings"
+	"testing"
+
+	v3 "github.com/pb33f/doctor/model/high/v3"
+	"github.com/pb33f/openapi-changes/model"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestRunChangerator_RewritesChangedNodeOriginsToRepoRelativePaths(t *testing.T) {
+	repoDir, fileName := createMovedRefGitSpecRepo(t)
+
+	commits, err := loadGitHistoryCommits(repoDir, fileName, summaryOpts{base: repoDir, noColor: true, limitTime: -1}, nil)
+	require.NoError(t, err)
+	require.NotEmpty(t, commits)
+
+	target := firstComparableCommit(commits)
+	require.NotNil(t, target)
+
+	result, err := runChangerator(target, nil)
+	require.NoError(t, err)
+	require.NotNil(t, result)
+	defer result.Release()
+
+	origins := collectChangedNodeOrigins(result.Changerator.ChangedNodes)
+	require.NotEmpty(t, origins)
+
+	hasRepoRelativeOrigin := false
+	for _, origin := range origins {
+		assert.NotContains(t, origin, repoDir)
+		assert.False(t, filepath.IsAbs(filepath.FromSlash(origin)), "origin should be repo-relative: %s", origin)
+		if origin == "spec.yaml" || strings.HasPrefix(origin, "common") {
+			hasRepoRelativeOrigin = true
+		}
+	}
+	assert.True(t, hasRepoRelativeOrigin, "expected at least one repo-relative origin, got %v", origins)
+}
+
+func firstComparableCommit(commits []*model.Commit) *model.Commit {
+	for _, commit := range commits {
+		if commit != nil && commit.Document != nil && commit.OldDocument != nil {
+			return commit
+		}
+	}
+	return nil
+}
+
+func collectChangedNodeOrigins(nodes []*v3.Node) []string {
+	seen := make(map[*v3.Node]struct{}, len(nodes))
+	var origins []string
+
+	var walk func(*v3.Node)
+	walk = func(node *v3.Node) {
+		if node == nil {
+			return
+		}
+		if _, ok := seen[node]; ok {
+			return
+		}
+		seen[node] = struct{}{}
+
+		if node.Origin != nil {
+			if node.Origin.AbsoluteLocation != "" {
+				origins = append(origins, node.Origin.AbsoluteLocation)
+			}
+			if node.Origin.AbsoluteLocationValue != "" {
+				origins = append(origins, node.Origin.AbsoluteLocationValue)
+			}
+		}
+		if node.OriginLocation != "" {
+			origins = append(origins, node.OriginLocation)
+		}
+		for _, child := range node.Children {
+			walk(child)
+		}
+	}
+
+	for _, node := range nodes {
+		walk(node)
+	}
+	return origins
+}

cmd/html_report_test.go

@@ -78,6 +78,24 @@ func TestGenerateHTMLReport_LeftRightPreservesGitRefPaths(t *testing.T) {
 	assert.Contains(t, content, `"modifiedPath":"HEAD:openapi.yaml"`)
 }
 
+func TestGenerateHTMLReport_GitHistoryBasePathUsesRevisionScopedSiblingRefs(t *testing.T) {
+	repoDir, fileName := createMovedRefGitSpecRepo(t)
+
+	commits, err := loadGitHistoryCommits(repoDir, fileName, summaryOpts{base: repoDir, noColor: true, limitTime: -1}, nil)
+	require.NoError(t, err)
+	require.NotEmpty(t, commits)
+
+	report, err := generateHTMLReport(commits, nil, true, repoDir, fileName)
+	require.NoError(t, err)
+	require.NotNil(t, report)
+
+	content := string(report)
+	assert.Contains(t, content, "<!DOCTYPE html")
+	assert.Contains(t, content, `"property":"$ref"`)
+	assert.Contains(t, content, `"path":"$.paths['/thing'].get.responses['200'].content['application/json'].schema"`)
+	assert.NotContains(t, content, `"origin":"`+repoDir)
+}
+
 func TestGenerateHTMLReport_LeftRightSanitizesURLPaths(t *testing.T) {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.URL.Path == "/left.yaml" {
@@ -274,6 +292,35 @@ func TestBuildHTMLReportItems_SplitsStandardAndChangeExplorerGraphs(t *testing.T
 	assert.Contains(t, explorerNodeWithChildChanges, "childChanges", "change explorer nodes render change summaries")
 }
 
+func TestBuildHTMLReportItems_GitHistoryRewritesGraphOriginsToRepoRelativePaths(t *testing.T) {
+	repoDir, fileName := createMovedRefGitSpecRepo(t)
+
+	commits, err := loadGitHistoryCommits(repoDir, fileName, summaryOpts{base: repoDir, noColor: true, limitTime: -1}, nil)
+	require.NoError(t, err)
+	require.NotEmpty(t, commits)
+
+	items, err := buildHTMLReportItems(commits, nil)
+	require.NoError(t, err)
+	require.Len(t, items, 1)
+
+	var graphNodes []map[string]any
+	require.NoError(t, json.Unmarshal(items[0].Graph.Nodes, &graphNodes))
+
+	var origins []string
+	for _, node := range graphNodes {
+		origin, _ := node["origin"].(string)
+		if origin != "" {
+			origins = append(origins, origin)
+		}
+	}
+
+	require.NotEmpty(t, origins)
+	for _, origin := range origins {
+		assert.NotContains(t, origin, repoDir)
+		assert.False(t, filepath.IsAbs(filepath.FromSlash(origin)), "origin should be repo-relative: %s", origin)
+	}
+}
+
 func TestBuildHTMLReportItems_ComposedSchemaTitleRemovalPreservesPropertyLabel(t *testing.T) {
 	leftPath, rightPath := createComposedSchemaTitleRemovalSpecPair(t, "allOf")