fix(internal/godocfx): better support for v2 modules (#12797)

codyoss · web-flow · commit 4bc878597a5e · 2025-09-02T11:03:33.000-05:00
Added sorting to package processing so v1 module sort before v2,
avoids a panic that was filtering away all results.

Also added one more module to skiplist.
diff --git a/internal/godocfx/main.go b/internal/godocfx/main.go
@@ -174,6 +174,7 @@ func process(mod indexEntry, workingDir, outDir string, namer *friendlyAPINamer,
 		"cloud.google.com/go/gsuiteaddons",
 
 		"google.golang.org/appengine/v2/cmd",
+		"cloud.google.com/go/spanner/benchmarks",
 	}
 	if hasPrefix(mod.Path, filter) {
 		log.Printf("%q filtered out, nothing to do: here is the filter: %q", mod.Path, filter)
diff --git a/internal/godocfx/pkgload/load.go b/internal/godocfx/pkgload/load.go
@@ -57,6 +57,10 @@ func Load(glob, workingDir string, filter []string) ([]Info, error) {
 		return nil, fmt.Errorf("pattern %q matched 0 packages", glob)
 	}
 
+	// To sort v1 modules before v2+
+	sort.Slice(allPkgs, func(i, j int) bool {
+		return allPkgs[i].PkgPath < allPkgs[j].PkgPath
+	})
 	module := allPkgs[0].Module
 	skippedModules := map[string]struct{}{}
 

Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,7 @@ func process(mod indexEntry, workingDir, outDir string, namer *friendlyAPINamer,`
`174`	`174`	`"cloud.google.com/go/gsuiteaddons",`
`175`	`175`
`176`	`176`	`"google.golang.org/appengine/v2/cmd",`
	`177`	`+ "cloud.google.com/go/spanner/benchmarks",`
`177`	`178`	`}`
`178`	`179`	`if hasPrefix(mod.Path, filter) {`
`179`	`180`	`log.Printf("%q filtered out, nothing to do: here is the filter: %q", mod.Path, filter)`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,10 @@ func Load(glob, workingDir string, filter []string) ([]Info, error) {`
`57`	`57`	`return nil, fmt.Errorf("pattern %q matched 0 packages", glob)`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ // To sort v1 modules before v2+`
	`61`	`+ sort.Slice(allPkgs, func(i, j int) bool {`
	`62`	`+ return allPkgs[i].PkgPath < allPkgs[j].PkgPath`
	`63`	`+ })`
`60`	`64`	`module := allPkgs[0].Module`
`61`	`65`	`skippedModules := map[string]struct{}{}`
`62`	`66`