Add configurable base plugin support in buf.plugin.yaml (#3513)

Author: mfridman

private/bufpkg/bufremoteplugin/bufremoteplugin.go

@@ -133,6 +133,9 @@ func PluginRegistryToProtoRegistryConfig(pluginRegistry *bufremotepluginconfig.R
 	case pluginRegistry.Go != nil:
 		goConfig := &registryv1alpha1.GoConfig{}
 		goConfig.MinimumVersion = pluginRegistry.Go.MinVersion
+		if pluginRegistry.Go.BasePlugin != nil {
+			goConfig.BasePlugin = pluginRegistry.Go.BasePlugin.IdentityString()
+		}
 		if pluginRegistry.Go.Deps != nil {
 			goConfig.RuntimeLibraries = make([]*registryv1alpha1.GoConfig_RuntimeLibrary, 0, len(pluginRegistry.Go.Deps))
 			for _, dependency := range pluginRegistry.Go.Deps {
@@ -249,6 +252,13 @@ func ProtoRegistryConfigToPluginRegistry(config *registryv1alpha1.RegistryConfig
 	case config.GetGoConfig() != nil:
 		goConfig := &bufremotepluginconfig.GoRegistryConfig{}
 		goConfig.MinVersion = config.GetGoConfig().GetMinimumVersion()
+		if config.GetGoConfig().GetBasePlugin() != "" {
+			basePluginIdentity, err := bufremotepluginref.PluginIdentityForString(config.GetGoConfig().GetBasePlugin())
+			if err != nil {
+				return nil, err
+			}
+			goConfig.BasePlugin = basePluginIdentity
+		}
 		runtimeLibraries := config.GetGoConfig().GetRuntimeLibraries()
 		if runtimeLibraries != nil {
 			goConfig.Deps = make([]*bufremotepluginconfig.GoRegistryDependencyConfig, 0, len(runtimeLibraries))

private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig.go

@@ -120,6 +120,7 @@ type RegistryConfig struct {
 type GoRegistryConfig struct {
 	MinVersion string
 	Deps       []*GoRegistryDependencyConfig
+	BasePlugin bufremotepluginref.PluginIdentity
 }
 
 // GoRegistryDependencyConfig is the go registry dependency configuration.
@@ -440,6 +441,7 @@ type ExternalGoRegistryConfig struct {
 		Module  string `json:"module,omitempty" yaml:"module,omitempty"`
 		Version string `json:"version,omitempty" yaml:"version,omitempty"`
 	} `json:"deps,omitempty" yaml:"deps,omitempty"`
+	BasePlugin string `json:"base_plugin,omitempty" yaml:"base_plugin,omitempty"`
 }
 
 // ExternalNPMRegistryConfig is the external registry configuration for a JavaScript NPM plugin.

private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig_test.go

@@ -40,6 +40,8 @@ func TestGetConfigForBucket(t *testing.T) {
 	require.NoError(t, err)
 	pluginDependency, err := bufremotepluginref.PluginReferenceForString("buf.build/library/go:v1.28.0", 1)
 	require.NoError(t, err)
+	basePluginIdentity, err := bufremotepluginref.PluginIdentityForString("buf.build/library/go")
+	require.NoError(t, err)
 	require.Equal(
 		t,
 		&Config{
@@ -54,6 +56,7 @@ func TestGetConfigForBucket(t *testing.T) {
 			Registry: &RegistryConfig{
 				Go: &GoRegistryConfig{
 					MinVersion: "1.18",
+					BasePlugin: basePluginIdentity,
 					Deps: []*GoRegistryDependencyConfig{
 						{
 							Module:  "google.golang.org/grpc",
@@ -82,6 +85,8 @@ func TestParsePluginConfigGoYAML(t *testing.T) {
 	require.NoError(t, err)
 	pluginDependency, err := bufremotepluginref.PluginReferenceForString("buf.build/library/go:v1.28.0", 1)
 	require.NoError(t, err)
+	basePluginIdentity, err := bufremotepluginref.PluginIdentityForString("buf.build/library/go")
+	require.NoError(t, err)
 	require.Equal(
 		t,
 		&Config{
@@ -96,6 +101,7 @@ func TestParsePluginConfigGoYAML(t *testing.T) {
 			Registry: &RegistryConfig{
 				Go: &GoRegistryConfig{
 					MinVersion: "1.18",
+					BasePlugin: basePluginIdentity,
 					Deps: []*GoRegistryDependencyConfig{
 						{
 							Module:  "google.golang.org/grpc",

private/bufpkg/bufremoteplugin/bufremotepluginconfig/config.go

@@ -17,6 +17,7 @@ package bufremotepluginconfig
 import (
 	"errors"
 	"fmt"
+	"slices"
 	"strings"
 
 	"buf.build/go/spdx"
@@ -60,7 +61,7 @@ func newConfig(externalConfig ExternalConfig, options []ConfigOption) (*Config,
 			dependencies = append(dependencies, reference)
 		}
 	}
-	registryConfig, err := newRegistryConfig(externalConfig.Registry)
+	registryConfig, err := newRegistryConfig(externalConfig.Registry, dependencies, opts.overrideRemote)
 	if err != nil {
 		return nil, err
 	}
@@ -87,7 +88,11 @@ func newConfig(externalConfig ExternalConfig, options []ConfigOption) (*Config,
 	}, nil
 }
 
-func newRegistryConfig(externalRegistryConfig ExternalRegistryConfig) (*RegistryConfig, error) {
+func newRegistryConfig(
+	externalRegistryConfig ExternalRegistryConfig,
+	pluginDependencies []bufremotepluginref.PluginReference,
+	overrideRemote string,
+) (*RegistryConfig, error) {
 	var (
 		isGoEmpty     = externalRegistryConfig.Go == nil
 		isNPMEmpty    = externalRegistryConfig.NPM == nil
@@ -125,7 +130,7 @@ func newRegistryConfig(externalRegistryConfig ExternalRegistryConfig) (*Registry
 	options := OptionsSliceToPluginOptions(externalRegistryConfig.Opts)
 	switch {
 	case !isGoEmpty:
-		goRegistryConfig, err := newGoRegistryConfig(externalRegistryConfig.Go)
+		goRegistryConfig, err := newGoRegistryConfig(externalRegistryConfig.Go, pluginDependencies, overrideRemote)
 		if err != nil {
 			return nil, err
 		}
@@ -242,14 +247,18 @@ func newNPMRegistryConfig(externalNPMRegistryConfig *ExternalNPMRegistryConfig)
 	}, nil
 }
 
-func newGoRegistryConfig(externalGoRegistryConfig *ExternalGoRegistryConfig) (*GoRegistryConfig, error) {
+func newGoRegistryConfig(
+	externalGoRegistryConfig *ExternalGoRegistryConfig,
+	pluginDependencies []bufremotepluginref.PluginReference,
+	overrideRemote string,
+) (*GoRegistryConfig, error) {
 	if externalGoRegistryConfig == nil {
 		return nil, nil
 	}
 	if externalGoRegistryConfig.MinVersion != "" && !modfile.GoVersionRE.MatchString(externalGoRegistryConfig.MinVersion) {
 		return nil, fmt.Errorf("the go minimum version %q must be a valid semantic version in the form of <major>.<minor>", externalGoRegistryConfig.MinVersion)
 	}
-	var dependencies []*GoRegistryDependencyConfig
+	var runtimeDependencies []*GoRegistryDependencyConfig
 	for _, dep := range externalGoRegistryConfig.Deps {
 		if dep.Module == "" {
 			return nil, errors.New("go runtime dependency requires a non-empty module name")
@@ -260,17 +269,37 @@ func newGoRegistryConfig(externalGoRegistryConfig *ExternalGoRegistryConfig) (*G
 		if !semver.IsValid(dep.Version) {
 			return nil, fmt.Errorf("go runtime dependency %s:%s does not have a valid semantic version", dep.Module, dep.Version)
 		}
-		dependencies = append(
-			dependencies,
+		runtimeDependencies = append(
+			runtimeDependencies,
 			&GoRegistryDependencyConfig{
 				Module:  dep.Module,
 				Version: dep.Version,
 			},
 		)
 	}
+	var basePlugin bufremotepluginref.PluginIdentity
+	if externalGoRegistryConfig.BasePlugin != "" {
+		var err error
+		basePlugin, err = pluginIdentityForStringWithOverrideRemote(externalGoRegistryConfig.BasePlugin, overrideRemote)
+		if err != nil {
+			return nil, fmt.Errorf("failed to parse base plugin: %w", err)
+		}
+		// Validate the base plugin is included as one of the plugin dependencies when both are
+		// specified. This ensures there's exactly one base type and it has a known dependency to
+		// generate imports correctly and build a correct Go mod file.
+		if len(pluginDependencies) > 0 {
+			ok := slices.ContainsFunc(pluginDependencies, func(ref bufremotepluginref.PluginReference) bool {
+				return ref.IdentityString() == basePlugin.IdentityString()
+			})
+			if !ok {
+				return nil, fmt.Errorf("base plugin %q not found in plugin dependencies", externalGoRegistryConfig.BasePlugin)
+			}
+		}
+	}
 	return &GoRegistryConfig{
 		MinVersion: externalGoRegistryConfig.MinVersion,
-		Deps:       dependencies,
+		Deps:       runtimeDependencies,
+		BasePlugin: basePlugin,
 	}, nil
 }
 

private/bufpkg/bufremoteplugin/bufremotepluginconfig/testdata/success/go/buf.plugin.yaml

@@ -9,6 +9,7 @@ deps:
 output_languages: [go]
 registry:
   go:
+    base_plugin: buf.build/library/go
     min_version: 1.18
     deps:
       - module: google.golang.org/grpc