Add bufplugin package (#3431)

This adds a new package bufplugin which implements types and functions for operating on Buf plugins.

Author: emcfarlane

private/buf/bufcli/errors.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 
 	"connectrpc.com/connect"
-	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 )
 
 var (
@@ -72,14 +72,14 @@ func NewModuleNotFoundError(name string) error {
 	return fmt.Errorf(`a module named %q does not exist, use "buf registry module create" to create one`, name)
 }
 
-// NewModuleRefNotFoundError informs the user that a ModuleRef does not exist.
-func NewModuleRefNotFoundError(moduleRef bufmodule.ModuleRef) error {
-	return fmt.Errorf("%q does not exist", moduleRef)
+// NewRefNotFoundError informs the user that a Ref does not exist.
+func NewRefNotFoundError(ref bufparse.Ref) error {
+	return fmt.Errorf("%q does not exist", ref)
 }
 
-// NewLabelNotFoundError informs the user that a ModuleRef does not exist as a label.
-func NewLabelNotFoundError(moduleRef bufmodule.ModuleRef) error {
-	return fmt.Errorf("label %q does not exist", moduleRef)
+// NewLabelNotFoundError informs the user that a Ref does not exist as a label.
+func NewLabelNotFoundError(ref bufparse.Ref) error {
+	return fmt.Errorf("label %q does not exist", ref)
 }
 
 // NewTokenNotFoundError informs the user that a token with

private/buf/bufctl/controller.go

@@ -33,6 +33,7 @@ import (
 	"github.com/bufbuild/buf/private/bufpkg/bufimage"
 	"github.com/bufbuild/buf/private/bufpkg/bufimage/bufimageutil"
 	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/bufpkg/bufreflect"
 	"github.com/bufbuild/buf/private/gen/data/datawkt"
 	imagev1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/image/v1"
@@ -1085,39 +1086,39 @@ func (c *controller) warnUnconfiguredTransitiveImports(
 	if slicesext.Count(workspace.Modules(), bufmodule.Module.IsLocal) == 0 {
 		return nil
 	}
-	// Construct a struct map of all the ModuleFullName strings of the configured buf.yaml
+	// Construct a struct map of all the FullName strings of the configured buf.yaml
 	// Module dependencies, and the local Modules. These are considered OK to depend on
 	// for non-imports in the Image.
-	configuredModuleFullNameStrings, err := slicesext.MapError(
+	configuredFullNameStrings, err := slicesext.MapError(
 		workspace.ConfiguredDepModuleRefs(),
-		func(moduleRef bufmodule.ModuleRef) (string, error) {
-			moduleFullName := moduleRef.ModuleFullName()
+		func(moduleRef bufparse.Ref) (string, error) {
+			moduleFullName := moduleRef.FullName()
 			if moduleFullName == nil {
-				return "", syserror.New("ModuleFullName nil on ModuleRef")
+				return "", syserror.New("FullName nil on ModuleRef")
 			}
 			return moduleFullName.String(), nil
 		},
 	)
 	if err != nil {
 		return err
 	}
-	configuredModuleFullNameStringMap := slicesext.ToStructMap(configuredModuleFullNameStrings)
+	configuredFullNameStringMap := slicesext.ToStructMap(configuredFullNameStrings)
 	for _, localModule := range bufmodule.ModuleSetLocalModules(workspace) {
-		if moduleFullName := localModule.ModuleFullName(); moduleFullName != nil {
-			configuredModuleFullNameStringMap[moduleFullName.String()] = struct{}{}
+		if moduleFullName := localModule.FullName(); moduleFullName != nil {
+			configuredFullNameStringMap[moduleFullName.String()] = struct{}{}
 		}
 	}
 
-	// Construct a map from Image file path -> ModuleFullName string.
+	// Construct a map from Image file path -> FullName string.
 	//
-	// If a given file in the Image did not have a ModuleFullName, it came from a local unnamed Module
+	// If a given file in the Image did not have a FullName, it came from a local unnamed Module
 	// in the Workspace, and we're safe to ignore it with respect to calculating the undeclared
 	// transitive imports.
-	pathToModuleFullNameString := make(map[string]string)
+	pathToFullNameString := make(map[string]string)
 	for _, imageFile := range image.Files() {
 		// If nil, this came from a local unnamed Module in the Workspace, and we're safe to ignore.
-		if moduleFullName := imageFile.ModuleFullName(); moduleFullName != nil {
-			pathToModuleFullNameString[imageFile.Path()] = moduleFullName.String()
+		if moduleFullName := imageFile.FullName(); moduleFullName != nil {
+			pathToFullNameString[imageFile.Path()] = moduleFullName.String()
 		}
 	}
 
@@ -1127,12 +1128,12 @@ func (c *controller) warnUnconfiguredTransitiveImports(
 			continue
 		}
 		for _, importPath := range imageFile.FileDescriptorProto().GetDependency() {
-			moduleFullNameString, ok := pathToModuleFullNameString[importPath]
+			moduleFullNameString, ok := pathToFullNameString[importPath]
 			if !ok {
 				// The import was from a local unnamed Module in the Workspace.
 				continue
 			}
-			if _, ok := configuredModuleFullNameStringMap[moduleFullNameString]; !ok {
+			if _, ok := configuredFullNameStringMap[moduleFullNameString]; !ok {
 				c.logger.Warn(fmt.Sprintf(
 					`File %q imports %q, which is not in your workspace or in the dependencies declared in your buf.yaml, but is found in transitive dependency %q.
 Declare %q in the deps key in your buf.yaml.`,

private/buf/buffetch/internal/internal.go

@@ -25,6 +25,7 @@ import (
 	"github.com/bufbuild/buf/private/buf/buftarget"
 	"github.com/bufbuild/buf/private/bufpkg/bufconfig"
 	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/app"
 	"github.com/bufbuild/buf/private/pkg/git"
 	"github.com/bufbuild/buf/private/pkg/httpauth"
@@ -223,7 +224,7 @@ func NewGitRef(
 // ModuleRef is a module reference.
 type ModuleRef interface {
 	Ref
-	ModuleRef() bufmodule.ModuleRef
+	ModuleRef() bufparse.Ref
 	moduleRef()
 }
 
@@ -375,7 +376,7 @@ type ParsedModuleRef interface {
 // This should only be used for testing.
 func NewDirectParsedModuleRef(
 	format string,
-	moduleRef bufmodule.ModuleRef,
+	moduleRef bufparse.Ref,
 ) ParsedModuleRef {
 	return newDirectModuleRef(
 		format,

private/buf/buffetch/internal/module_ref.go

@@ -17,7 +17,7 @@ package internal
 import (
 	"strings"
 
-	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/app"
 )
 
@@ -27,7 +27,7 @@ var (
 
 type moduleRef struct {
 	format     string
-	iModuleRef bufmodule.ModuleRef
+	iModuleRef bufparse.Ref
 }
 
 func newModuleRef(
@@ -46,15 +46,15 @@ func newModuleRef(
 	if strings.Contains(path, "://") {
 		return nil, NewInvalidPathError(format, path)
 	}
-	moduleRef, err := bufmodule.ParseModuleRef(path)
+	moduleRef, err := bufparse.ParseRef(path)
 	if err != nil {
 		// TODO: this is dumb
 		return nil, NewInvalidPathError(format, path)
 	}
 	return newDirectModuleRef(format, moduleRef), nil
 }
 
-func newDirectModuleRef(format string, iModuleRef bufmodule.ModuleRef) *moduleRef {
+func newDirectModuleRef(format string, iModuleRef bufparse.Ref) *moduleRef {
 	return &moduleRef{
 		format:     format,
 		iModuleRef: iModuleRef,
@@ -65,7 +65,7 @@ func (r *moduleRef) Format() string {
 	return r.format
 }
 
-func (r *moduleRef) ModuleRef() bufmodule.ModuleRef {
+func (r *moduleRef) ModuleRef() bufparse.Ref {
 	return r.iModuleRef
 }
 

private/buf/buffetch/internal/reader.go

@@ -28,6 +28,7 @@ import (
 
 	"github.com/bufbuild/buf/private/buf/buftarget"
 	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/app"
 	"github.com/bufbuild/buf/private/pkg/git"
 	"github.com/bufbuild/buf/private/pkg/httpauth"
@@ -397,7 +398,7 @@ func (r *reader) getModuleKey(
 	}
 	moduleKeys, err := r.moduleKeyProvider.GetModuleKeysForModuleRefs(
 		ctx,
-		[]bufmodule.ModuleRef{moduleRef.ModuleRef()},
+		[]bufparse.Ref{moduleRef.ModuleRef()},
 		bufmodule.DigestTypeB5,
 	)
 	if err != nil {

private/buf/buffetch/ref_parser.go

@@ -25,7 +25,7 @@ import (
 
 	"github.com/bufbuild/buf/private/buf/buffetch/internal"
 	"github.com/bufbuild/buf/private/bufpkg/bufconfig"
-	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/app"
 	"github.com/bufbuild/buf/private/pkg/syserror"
 )
@@ -837,7 +837,7 @@ func assumeModuleOrDir(path string) (string, error) {
 	if path == "" {
 		return "", errors.New("assumeModuleOrDir: no path given")
 	}
-	if _, err := bufmodule.ParseModuleRef(path); err == nil {
+	if _, err := bufparse.ParseRef(path); err == nil {
 		// this is possible to be a module, check if it is a directory though
 		// OK to use os.Stat instead of os.Lstat here
 		fileInfo, err := os.Stat(path)

private/buf/buffetch/ref_parser_test.go

@@ -21,7 +21,7 @@ import (
 	"testing"
 
 	"github.com/bufbuild/buf/private/buf/buffetch/internal"
-	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/app"
 	"github.com/bufbuild/buf/private/pkg/git"
 	"github.com/bufbuild/buf/private/pkg/normalpath"
@@ -1442,8 +1442,8 @@ func testNewModuleRef(
 	owner string,
 	name string,
 	ref string,
-) bufmodule.ModuleRef {
-	moduleRef, err := bufmodule.NewModuleRef(registry, owner, name, ref)
+) bufparse.Ref {
+	moduleRef, err := bufparse.NewRef(registry, owner, name, ref)
 	require.NoError(t, err)
 	return moduleRef
 }

private/buf/buflsp/file.go

@@ -575,7 +575,7 @@ func (f *file) RunLints(ctx context.Context) bool {
 		return false
 	}
 
-	f.lsp.logger.Debug(fmt.Sprintf("running lint for %q in %v", f.uri, module.ModuleFullName()))
+	f.lsp.logger.Debug(fmt.Sprintf("running lint for %q in %v", f.uri, module.FullName()))
 
 	lintConfig := workspace.GetLintConfigForOpaqueID(module.OpaqueID())
 	err := f.lsp.checkClient.Lint(

private/buf/buflsp/symbol.go

@@ -471,7 +471,7 @@ func (s *symbol) FormatDocs(ctx context.Context) string {
 		if def.file.IsWKT() {
 			bsrHost = "buf.build/protocolbuffers/wellknowntypes"
 		} else if fileInfo, ok := def.file.objectInfo.(bufmodule.FileInfo); ok {
-			bsrHost = fileInfo.Module().ModuleFullName().String()
+			bsrHost = fileInfo.Module().FullName().String()
 		}
 		if hasAnchor {
 			bsrTooltip = pkg + "." + strings.Join(path, ".")

private/buf/bufmigrate/migrate_builder.go

@@ -23,6 +23,7 @@ import (
 
 	"github.com/bufbuild/buf/private/bufpkg/bufconfig"
 	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
+	"github.com/bufbuild/buf/private/bufpkg/bufparse"
 	"github.com/bufbuild/buf/private/pkg/normalpath"
 	"github.com/bufbuild/buf/private/pkg/slicesext"
 	"github.com/bufbuild/buf/private/pkg/storage"
@@ -42,7 +43,7 @@ type migrateBuilder struct {
 	addedModuleDirPaths      map[string]struct{}
 
 	moduleConfigs                    []bufconfig.ModuleConfig
-	configuredDepModuleRefs          []bufmodule.ModuleRef
+	configuredDepModuleRefs          []bufparse.Ref
 	hasSeenBufLockFile               bool
 	depModuleKeys                    []bufmodule.ModuleKey
 	pathToMigratedBufGenYAMLFile     map[string]bufconfig.BufGenYAMLFile
@@ -239,7 +240,7 @@ func (m *migrateBuilder) addModule(ctx context.Context, moduleDirPath string) (r
 			return syserror.Newf("expect exactly 1 module config from buf yaml, got %d", len(bufYAMLFile.ModuleConfigs()))
 		}
 		moduleConfig := bufYAMLFile.ModuleConfigs()[0]
-		moduleFullName := moduleConfig.ModuleFullName()
+		moduleFullName := moduleConfig.FullName()
 		// If a buf.yaml v1beta1 has a non-empty name and multiple roots, the
 		// resulting buf.yaml v2 should have these roots as module directories,
 		// but they should not share the same module name. Instead we just give
@@ -309,7 +310,7 @@ func (m *migrateBuilder) addModule(ctx context.Context, moduleDirPath string) (r
 		}
 		moduleConfig, err = bufconfig.NewModuleConfig(
 			moduleRootRelativeToDestination,
-			moduleConfig.ModuleFullName(),
+			moduleConfig.FullName(),
 			// We do not need to handle paths in rootToIncludes, rootToExcludes, lint or breaking config specially,
 			// because the paths are transformed correctly by readBufYAMLFile and writeBufYAMLFile.
 			moduleConfig.RootToIncludes(),
@@ -382,12 +383,12 @@ func (m *migrateBuilder) addModule(ctx context.Context, moduleDirPath string) (r
 
 func (m *migrateBuilder) appendModuleConfig(moduleConfig bufconfig.ModuleConfig, parentPath string) error {
 	m.moduleConfigs = append(m.moduleConfigs, moduleConfig)
-	if moduleConfig.ModuleFullName() == nil {
+	if moduleConfig.FullName() == nil {
 		return nil
 	}
-	if file, ok := m.moduleFullNameStringToParentPath[moduleConfig.ModuleFullName().String()]; ok {
-		return fmt.Errorf("module %s is found in both %s and %s", moduleConfig.ModuleFullName(), file, parentPath)
+	if file, ok := m.moduleFullNameStringToParentPath[moduleConfig.FullName().String()]; ok {
+		return fmt.Errorf("module %s is found in both %s and %s", moduleConfig.FullName(), file, parentPath)
 	}
-	m.moduleFullNameStringToParentPath[moduleConfig.ModuleFullName().String()] = parentPath
+	m.moduleFullNameStringToParentPath[moduleConfig.FullName().String()] = parentPath
 	return nil
 }