Refactor apiviewgo type definition hoisting (#8668)

Author: chlowell

src/go/cmd/api_view.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"path/filepath"
 	"slices"
-	"sort"
 	"strings"
 )
 
@@ -28,77 +27,11 @@ func CreateAPIView(pkgDir, outputDir string) error {
 }
 
 func createReview(pkgDir string) (PackageReview, error) {
-	m, err := NewModule(pkgDir)
+	r, err := NewReview(pkgDir)
 	if err != nil {
 		return PackageReview{}, err
 	}
-	tokenList := &[]Token{}
-	nav := []Navigation{}
-	diagnostics := []Diagnostic{}
-	packageNames := []string{}
-	for name, p := range m.packages {
-		// we use a prefixed path separator so that we can handle the "internal" module.
-		//  internal/dig
-		//  internal/errorinfo
-		//  etc.
-		// for other modules, we skip /internal subdirectories
-		//  azcore/internal/...
-		if strings.Contains(p.relName, "/internal") || p.c.isEmpty() {
-			continue
-		}
-		packageNames = append(packageNames, name)
-	}
-	sort.Strings(packageNames)
-	for _, name := range packageNames {
-		p := m.packages[name]
-		n := p.relName
-		makeToken(nil, nil, "package", TokenTypeMemberName, tokenList)
-		makeToken(nil, nil, " ", TokenTypeWhitespace, tokenList)
-		makeToken(&n, nil, n, TokenTypeTypeName, tokenList)
-		makeToken(nil, nil, "", TokenTypeNewline, tokenList)
-		makeToken(nil, nil, "", TokenTypeNewline, tokenList)
-		// TODO: reordering these calls reorders APIView output and can omit content
-		p.c.parseInterface(tokenList)
-		p.c.parseStruct(tokenList)
-		p.c.parseSimpleType(tokenList)
-		p.c.parseVar(tokenList)
-		p.c.parseConst(tokenList)
-		p.c.parseFunc(tokenList)
-		navItems := p.c.generateNavChildItems()
-		nav = append(nav, Navigation{
-			Text:         n,
-			NavigationId: n,
-			ChildItems:   navItems,
-			Tags: &map[string]string{
-				"TypeKind": "namespace",
-			},
-		})
-		diagnostics = append(diagnostics, p.diagnostics...)
-	}
-
-	slices.SortFunc(diagnostics, func(a Diagnostic, b Diagnostic) int {
-		targetCmp := strings.Compare(a.TargetID, b.TargetID)
-		if targetCmp != 0 {
-			return targetCmp
-		}
-		// if the target IDs are the same then fall back to the text.
-		// this accounts for cases where there are multiple diagnostics
-		// for the same target ID.
-		return strings.Compare(a.Text, b.Text)
-	})
-
-	for _, n := range nav {
-		recursiveSortNavigation(n)
-	}
-
-	return PackageReview{
-		Diagnostics: diagnostics,
-		Language:    "Go",
-		Name:        m.Name,
-		Navigation:  nav,
-		Tokens:      *tokenList,
-		PackageName: m.PackageName,
-	}, nil
+	return r.Review()
 }
 
 func recursiveSortNavigation(n Navigation) {

src/go/cmd/api_view_test.go

@@ -163,10 +163,6 @@ func TestDiagnostics(t *testing.T) {
 }
 
 func TestAliasDefinitions(t *testing.T) {
-	priorValue := sdkDirName
-	sdkDirName = "testdata"
-	defer func() { sdkDirName = priorValue }()
-
 	for _, test := range []struct {
 		name, path, sourceName string
 		diagLevel              DiagnosticLevel
@@ -175,7 +171,7 @@ func TestAliasDefinitions(t *testing.T) {
 			diagLevel:  DiagnosticLevelWarning,
 			name:       "service_group",
 			path:       "testdata/test_service_group/group/test_alias_export",
-			sourceName: "github.com/Azure/azure-sdk-for-go/sdk/test_service_group/group/internal.Foo",
+			sourceName: "github.com/Azure/azure-sdk-tools/src/go/cmd/testdata/test_service_group/group/internal.Foo",
 		},
 		{
 			diagLevel:  DiagnosticLevelInfo,
@@ -187,11 +183,13 @@ func TestAliasDefinitions(t *testing.T) {
 			diagLevel:  DiagnosticLevelWarning,
 			name:       "external_package",
 			path:       "testdata/test_external_alias_exporter",
-			sourceName: "github.com/Azure/azure-sdk-for-go/sdk/test_external_alias_source.Foo",
+			sourceName: "github.com/Azure/azure-sdk-tools/src/go/cmd/testdata/test_external_alias_source.Foo",
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			review, err := createReview(filepath.Clean(test.path))
+			p, err := filepath.Abs(test.path)
+			require.NoError(t, err)
+			review, err := createReview(p)
 			require.NoError(t, err)
 			require.Equal(t, "Go", review.Language)
 			require.Equal(t, 1, len(review.Diagnostics))
@@ -210,10 +208,6 @@ func TestAliasDefinitions(t *testing.T) {
 }
 
 func TestRecursiveAliasDefinitions(t *testing.T) {
-	priorValue := sdkDirName
-	sdkDirName = "testdata"
-	defer func() { sdkDirName = priorValue }()
-
 	for _, test := range []struct {
 		name, path, sourceName string
 		diagLevel              DiagnosticLevel