Add buf plugin prune command

CHANGELOG.md

@@ -8,6 +8,8 @@
   determinisitic.
 - Add `buf plugin push` command to push a plugin to the Buf Schema Registry. 
   Only WebAssembly check plugins are supported at this time.
+- Add `buf plugin update` and `buf plugin prune` command to manage plugins in the `buf.lock`
+  file. Only WebAssembly check plugins are supported at this time.
 - Add `buf registry plugin commit {add-label,info,list,resolve}` to manage BSR plugin commits.
 - Add `buf registry plugin label {archive,info,list,unarchive}` to manage BSR plugin commits.
 

private/buf/cmd/buf/buf.go

@@ -62,6 +62,7 @@ import (
 	"github.com/bufbuild/buf/private/buf/cmd/buf/command/mod/modlsbreakingrules"
 	"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/pluginprune"
 	"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"
@@ -191,6 +192,7 @@ func NewRootCommand(name string) *appcmd.Command {
 				SubCommands: []*appcmd.Command{
 					pluginpush.NewCommand("push", builder),
 					pluginupdate.NewCommand("update", builder),
+					pluginprune.NewCommand("prune", builder),
 				},
 			},
 			{

private/buf/cmd/buf/command/plugin/pluginprune/pluginprune.go

@@ -0,0 +1,117 @@
+// 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 pluginprune
+
+import (
+	"context"
+
+	"github.com/bufbuild/buf/private/buf/bufcli"
+	"github.com/bufbuild/buf/private/buf/bufworkspace"
+	"github.com/bufbuild/buf/private/bufpkg/bufplugin"
+	"github.com/bufbuild/buf/private/pkg/app/appcmd"
+	"github.com/bufbuild/buf/private/pkg/app/appext"
+	"github.com/bufbuild/buf/private/pkg/slicesext"
+)
+
+// NewCommand returns a new Command.
+func NewCommand(
+	name string,
+	builder appext.SubCommandBuilder,
+) *appcmd.Command {
+	return &appcmd.Command{
+		Use:   name + " <directory>",
+		Short: "Prune unused plugins from buf.lock",
+		Long: `Plugins that are no longer configured in buf.yaml are removed from the buf.lock file.
+
+The first argument is the directory of your buf.yaml configuration file.
+Defaults to "." if no argument is specified.`,
+		Args: appcmd.MaximumNArgs(1),
+		Run: builder.NewRunFunc(
+			func(ctx context.Context, container appext.Container) error {
+				return run(ctx, container)
+			},
+		),
+	}
+}
+
+func run(
+	ctx context.Context,
+	container appext.Container,
+) error {
+	dirPath := "."
+	if container.NumArgs() > 0 {
+		dirPath = container.Arg(0)
+	}
+	controller, err := bufcli.NewController(container)
+	if err != nil {
+		return err
+	}
+	workspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)
+	if err != nil {
+		return err
+	}
+	configuredRemotePluginRefs, err := workspaceDepManager.ConfiguredRemotePluginRefs(ctx)
+	if err != nil {
+		return err
+	}
+	pluginKeyProvider, err := bufcli.NewPluginKeyProvider(container)
+	if err != nil {
+		return err
+	}
+	configuredRemotePluginKeys, err := pluginKeyProvider.GetPluginKeysForPluginRefs(
+		ctx,
+		configuredRemotePluginRefs,
+		bufplugin.DigestTypeP1,
+	)
+	if err != nil {
+		return err
+	}
+	return prune(
+		ctx,
+		slicesext.Map(
+			configuredRemotePluginKeys,
+			func(pluginKey bufplugin.PluginKey) string {
+				return pluginKey.String()
+			},
+		),
+		workspaceDepManager,
+	)
+}
+
+func prune(
+	ctx context.Context,
+	bufYAMLBasedRemotePluginKeys []string,
+	workspaceDepManager bufworkspace.WorkspaceDepManager,
+) error {
+	bufYAMLPluginKeys := slicesext.ToStructMap(bufYAMLBasedRemotePluginKeys)
+	existingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)
+	if err != nil {
+		return err
+	}
+	var updatedBufLockPluginKeys []bufplugin.PluginKey
+	for _, existingRemotePluginKey := range existingRemotePluginKeys {
+		// Check if an existing plugin key from the buf.lock is confiugred in the buf.yaml.
+		if _, ok := bufYAMLPluginKeys[existingRemotePluginKey.String()]; ok {
+			// If yes, then we keep it for the updated buf.lock.
+			updatedBufLockPluginKeys = append(updatedBufLockPluginKeys, existingRemotePluginKey)
+		}
+	}
+	// We keep the existing dep module keys as-is.
+	existingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)
+	if err != nil {
+		return err
+	}
+	return workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, updatedBufLockPluginKeys)
+}

private/buf/cmd/buf/command/plugin/pluginupdate/pluginupdate.go

@@ -18,11 +18,13 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"sort"
 
 	"github.com/bufbuild/buf/private/buf/bufcli"
 	"github.com/bufbuild/buf/private/bufpkg/bufplugin"
 	"github.com/bufbuild/buf/private/pkg/app/appcmd"
 	"github.com/bufbuild/buf/private/pkg/app/appext"
+	"github.com/bufbuild/buf/private/pkg/slicesext"
 	"github.com/bufbuild/buf/private/pkg/syserror"
 	"github.com/spf13/pflag"
 )
@@ -131,6 +133,31 @@ func run(
 	if err != nil {
 		return err
 	}
+	// We do not prune the buf.lock during update, we only add update existing plugin keys
+	// or add new plugin keys.
+	configuredRemotePluginKeyNameToPluginKey := map[string]bufplugin.PluginKey{}
+	for _, configuredRemotePluginKey := range configuredRemotePluginKeys {
+		configuredRemotePluginKeyNameToPluginKey[configuredRemotePluginKey.FullName().String()] = configuredRemotePluginKey
+	}
+	var updatedRemotePluginKeys []bufplugin.PluginKey
+	for _, existingRemotePluginKey := range existingRemotePluginKeys {
+		if updatedRemotePluginKey, ok := configuredRemotePluginKeyNameToPluginKey[existingRemotePluginKey.FullName().String()]; ok {
+			updatedRemotePluginKeys = append(updatedRemotePluginKeys, updatedRemotePluginKey)
+			// This was found and updated, so we can delete from the map
+			delete(configuredRemotePluginKeyNameToPluginKey, existingRemotePluginKey.FullName().String())
+		} else {
+			// Otherwise, keep the existing remote plugin key from buf.lock
+			updatedRemotePluginKeys = append(updatedRemotePluginKeys, existingRemotePluginKey)
+		}
+	}
+	// Add any new configured remote plugin keys
+	updatedRemotePluginKeys = append(updatedRemotePluginKeys, slicesext.MapValuesToSlice(configuredRemotePluginKeyNameToPluginKey)...)
+	sort.Slice(
+		updatedRemotePluginKeys,
+		func(i int, j int) bool {
+			return updatedRemotePluginKeys[i].FullName().String() < updatedRemotePluginKeys[j].FullName().String()
+		},
+	)
 
 	// We're about to edit the buf.lock file on disk. If we have a subsequent error,
 	// attempt to revert the buf.lock file.
@@ -144,7 +171,7 @@ func run(
 		}
 	}()
 	// Edit the buf.lock file with the updated remote plugins.
-	if err := workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, configuredRemotePluginKeys); err != nil {
+	if err := workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, updatedRemotePluginKeys); err != nil {
 		return err
 	}
 	return nil