Plugin update command

Author: emcfarlane

private/buf/bufcli/cache.go

@@ -103,6 +103,10 @@ var (
 	//
 	// Normalized.
 	v3CacheModuleLockRelDirPath = normalpath.Join("v3", "modulelocks")
+	// v3CachePluginRelDirPath is the relative path to the files cache directory in its newest iteration.
+	//
+	// Normalized.
+	v3CachePluginRelDirPath = normalpath.Join("v3", "plugins")
 	// v3CacheWasmRuntimeRelDirPath is the relative path to the Wasm runtime cache directory in its newest iteration.
 	// This directory is used to store the Wasm runtime cache. This is an implementation specific cache and opaque outside of the runtime.
 	//

private/buf/bufcli/plugin_key_provider.go

@@ -0,0 +1,36 @@
+// Copyright 2020-2024 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bufcli
+
+import (
+	"github.com/bufbuild/buf/private/bufpkg/bufplugin"
+	"github.com/bufbuild/buf/private/bufpkg/bufplugin/bufpluginapi"
+	"github.com/bufbuild/buf/private/bufpkg/bufregistryapi/bufregistryapiplugin"
+	"github.com/bufbuild/buf/private/pkg/app/appext"
+)
+
+// NewPluginKeyProvider returns a new PluginKeyProvider.
+func NewPluginKeyProvider(container appext.Container) (bufplugin.PluginKeyProvider, error) {
+	clientConfig, err := NewConnectClientConfig(container)
+	if err != nil {
+		return nil, err
+	}
+	return bufpluginapi.NewPluginKeyProvider(
+		container.Logger(),
+		bufregistryapiplugin.NewClientProvider(
+			clientConfig,
+		),
+	), nil
+}

private/buf/bufmigrate/migrator.go

@@ -400,6 +400,7 @@ func (m *migrator) buildBufYAMLAndBufLockFiles(
 			bufLock, err = bufconfig.NewBufLockFile(
 				bufconfig.FileVersionV2,
 				resolvedLockEntries,
+				nil,
 			)
 			if err != nil {
 				return nil, nil, err
@@ -444,6 +445,7 @@ func (m *migrator) buildBufYAMLAndBufLockFiles(
 		bufLock, err = bufconfig.NewBufLockFile(
 			bufconfig.FileVersionV2,
 			resolvedDepModuleKeys,
+			nil, // Plugins are not supported in v1.
 		)
 		if err != nil {
 			return nil, nil, err

private/buf/bufworkspace/workspace_dep_manager.go

@@ -18,10 +18,13 @@ import (
 	"context"
 	"errors"
 	"io/fs"
+	"sort"
 
 	"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/bufpkg/bufplugin"
+	"github.com/bufbuild/buf/private/pkg/slicesext"
 	"github.com/bufbuild/buf/private/pkg/storage"
 	"github.com/bufbuild/buf/private/pkg/syserror"
 )
@@ -39,11 +42,13 @@ type WorkspaceDepManager interface {
 	BufLockFileDigestType() bufmodule.DigestType
 	// ExisingBufLockFileDepModuleKeys returns the ModuleKeys from the buf.lock file.
 	ExistingBufLockFileDepModuleKeys(ctx context.Context) ([]bufmodule.ModuleKey, error)
+	// ExistingBufLockFileRemotePluginKeys returns the PluginKeys from the buf.lock file.
+	ExistingBufLockFileRemotePluginKeys(ctx context.Context) ([]bufplugin.PluginKey, error)
 	// UpdateBufLockFile updates the lock file that backs the Workspace to contain exactly
-	// the given ModuleKeys.
+	// the given ModuleKeys and PluginKeys.
 	//
 	// If a buf.lock does not exist, one will be created.
-	UpdateBufLockFile(ctx context.Context, depModuleKeys []bufmodule.ModuleKey) error
+	UpdateBufLockFile(ctx context.Context, depModuleKeys []bufmodule.ModuleKey, remotePluginKeys []bufplugin.PluginKey) error
 	// ConfiguredDepModuleRefs returns the configured dependencies of the Workspace as ModuleRefs.
 	//
 	// These come from buf.yaml files.
@@ -56,6 +61,16 @@ type WorkspaceDepManager interface {
 	//
 	// Sorted.
 	ConfiguredDepModuleRefs(ctx context.Context) ([]bufparse.Ref, error)
+	// ConfiguredRemotePluginRefs returns the configured remote plugins of the Workspace as PluginRefs.
+	//
+	// These come from buf.yaml files.
+	//
+	// The PluginRefs in this list will be unique by FullName. If there are two PluginRefs
+	// in the buf.yaml with the same FullName but different Refs, an error will be given
+	// at workspace constructions.
+	//
+	// Sorted.
+	ConfiguredRemotePluginRefs(ctx context.Context) ([]bufparse.Ref, error)
 
 	isWorkspaceDepManager()
 }
@@ -110,14 +125,58 @@ func (w *workspaceDepManager) ConfiguredDepModuleRefs(ctx context.Context) ([]bu
 		}
 	case bufconfig.FileVersionV2:
 		if !w.isV2 {
-			return nil, syserror.Newf("buf.yaml at %q did had version %v but expected v12", w.targetSubDirPath, fileVersion)
+			return nil, syserror.Newf("buf.yaml at %q did had version %v but expected v2", w.targetSubDirPath, fileVersion)
 		}
 	default:
 		return nil, syserror.Newf("unknown FileVersion: %v", fileVersion)
 	}
 	return bufYAMLFile.ConfiguredDepModuleRefs(), nil
 }
 
+func (w *workspaceDepManager) ConfiguredRemotePluginRefs(ctx context.Context) ([]bufparse.Ref, error) {
+	bufYAMLFile, err := bufconfig.GetBufYAMLFileForPrefix(ctx, w.bucket, w.targetSubDirPath)
+	if err != nil {
+		if !errors.Is(err, fs.ErrNotExist) {
+			return nil, err
+		}
+	}
+	if bufYAMLFile == nil {
+		return nil, nil
+	}
+	switch fileVersion := bufYAMLFile.FileVersion(); fileVersion {
+	case bufconfig.FileVersionV1Beta1, bufconfig.FileVersionV1:
+		if w.isV2 {
+			return nil, syserror.Newf("buf.yaml at %q did had version %v but expected v1beta1, v1", w.targetSubDirPath, fileVersion)
+		}
+		// Plugins are not supported in versions less than v2.
+		return nil, nil
+	case bufconfig.FileVersionV2:
+		if !w.isV2 {
+			return nil, syserror.Newf("buf.yaml at %q did had version %v but expected v2", w.targetSubDirPath, fileVersion)
+		}
+	default:
+		return nil, syserror.Newf("unknown FileVersion: %v", fileVersion)
+	}
+	pluginRefs := slicesext.Filter(
+		slicesext.Map(
+			bufYAMLFile.PluginConfigs(),
+			func(value bufconfig.PluginConfig) bufparse.Ref {
+				return value.PluginRef()
+			},
+		),
+		func(value bufparse.Ref) bool {
+			return value != nil
+		},
+	)
+	sort.Slice(
+		pluginRefs,
+		func(i int, j int) bool {
+			return pluginRefs[i].FullName().String() < pluginRefs[j].FullName().String()
+		},
+	)
+	return pluginRefs, nil
+}
+
 func (w *workspaceDepManager) BufLockFileDigestType() bufmodule.DigestType {
 	if w.isV2 {
 		return bufmodule.DigestTypeB5
@@ -136,11 +195,22 @@ func (w *workspaceDepManager) ExistingBufLockFileDepModuleKeys(ctx context.Conte
 	return bufLockFile.DepModuleKeys(), nil
 }
 
-func (w *workspaceDepManager) UpdateBufLockFile(ctx context.Context, depModuleKeys []bufmodule.ModuleKey) error {
+func (w *workspaceDepManager) ExistingBufLockFileRemotePluginKeys(ctx context.Context) ([]bufplugin.PluginKey, error) {
+	bufLockFile, err := bufconfig.GetBufLockFileForPrefix(ctx, w.bucket, w.targetSubDirPath)
+	if err != nil {
+		if errors.Is(err, fs.ErrNotExist) {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return bufLockFile.RemotePluginKeys(), nil
+}
+
+func (w *workspaceDepManager) UpdateBufLockFile(ctx context.Context, depModuleKeys []bufmodule.ModuleKey, remotePluginKeys []bufplugin.PluginKey) error {
 	var bufLockFile bufconfig.BufLockFile
 	var err error
 	if w.isV2 {
-		bufLockFile, err = bufconfig.NewBufLockFile(bufconfig.FileVersionV2, depModuleKeys)
+		bufLockFile, err = bufconfig.NewBufLockFile(bufconfig.FileVersionV2, depModuleKeys, remotePluginKeys)
 		if err != nil {
 			return err
 		}
@@ -154,7 +224,10 @@ func (w *workspaceDepManager) UpdateBufLockFile(ctx context.Context, depModuleKe
 		} else {
 			fileVersion = existingBufYAMLFile.FileVersion()
 		}
-		bufLockFile, err = bufconfig.NewBufLockFile(fileVersion, depModuleKeys)
+		if len(remotePluginKeys) > 0 {
+			return syserror.Newf("remote plugins are not supported for v1 buf.yaml files")
+		}
+		bufLockFile, err = bufconfig.NewBufLockFile(fileVersion, depModuleKeys, nil)
 		if err != nil {
 			return err
 		}

private/buf/cmd/buf/buf.go

@@ -63,6 +63,7 @@ import (
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/mod/modlslintrules"
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/mod/modopen"
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/plugin/pluginpush"
+	"github.com/bufbuild/buf/private/buf/cmd/buf/command/plugin/pluginupdate"
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/push"
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/registry/module/modulecommit/modulecommitaddlabel"
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/registry/module/modulecommit/modulecommitinfo"
@@ -177,6 +178,7 @@ func NewRootCommand(name string) *appcmd.Command {
 				Short: "Work with plugins",
 				SubCommands: []*appcmd.Command{
 					pluginpush.NewCommand("push", builder),
+					pluginupdate.NewCommand("update", builder),
 				},
 			},
 			{

private/buf/cmd/buf/command/dep/depupdate/depupdate.go

@@ -45,8 +45,8 @@ func NewCommand(
 	flags := newFlags()
 	return &appcmd.Command{
 		Use:   name + " <directory>",
-		Short: "Update pinned dependencies in a buf.lock",
-		Long: `Fetch the latest digests for the specified references in buf.yaml,
+		Short: "Update pinned module dependencies in a buf.lock",
+		Long: `Fetch the latest digests for the specified module references in buf.yaml,
 and write them and their transitive dependencies to buf.lock.
 
 The first argument is the directory of the local module to update.
@@ -139,6 +139,10 @@ func run(
 		logger.Warn(fmt.Sprintf("No configured dependencies were found to update in %q.", dirPath))
 		return nil
 	}
+	existingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)
+	if err != nil {
+		return err
+	}
 
 	// We're about to edit the buf.lock file on disk. If we have a subsequent error,
 	// attempt to revert the buf.lock file.
@@ -148,11 +152,11 @@ func run(
 	// overlay the new buf.lock file in a union bucket.
 	defer func() {
 		if retErr != nil {
-			retErr = errors.Join(retErr, workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys))
+			retErr = errors.Join(retErr, workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, existingRemotePluginKeys))
 		}
 	}()
 	// Edit the buf.lock file with the unpruned dependencies.
-	if err := workspaceDepManager.UpdateBufLockFile(ctx, configuredDepModuleKeys); err != nil {
+	if err := workspaceDepManager.UpdateBufLockFile(ctx, configuredDepModuleKeys, existingRemotePluginKeys); err != nil {
 		return err
 	}
 	workspace, err := controller.GetWorkspace(ctx, dirPath, bufctl.WithIgnoreAndDisallowV1BufWorkYAMLs())

private/buf/cmd/buf/command/dep/internal/internal.go

@@ -106,7 +106,11 @@ func Prune(
 	if err := validateModuleKeysContains(bufYAMLBasedDepModuleKeys, depModuleKeys); err != nil {
 		return err
 	}
-	return workspaceDepManager.UpdateBufLockFile(ctx, depModuleKeys)
+	existingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)
+	if err != nil {
+		return err
+	}
+	return workspaceDepManager.UpdateBufLockFile(ctx, depModuleKeys, existingRemotePluginKeys)
 }
 
 // LogUnusedConfiugredDepsForWorkspace takes a workspace and logs the unused configured