ProfileLibAdd and ProfileLibRemove can now cleanup unneeded dependencies

Author: cmaglie

commands/service_profile_lib_add.go

@@ -18,6 +18,7 @@ package commands
 import (
 	"context"
 	"net/url"
+	"slices"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
@@ -86,27 +87,35 @@ func (s *arduinoCoreServerImpl) ProfileLibAdd(ctx context.Context, req *rpc.Prof
 			return nil, err
 		}
 
-		add := func(libReleaseToAdd *librariesindex.Release) {
+		add := func(libReleaseToAdd *librariesindex.Release, isDep bool) {
 			libRefToAdd := &sketch.ProfileLibraryReference{
-				Library: libReleaseToAdd.GetName(),
-				Version: libReleaseToAdd.GetVersion(),
+				Library:      libReleaseToAdd.GetName(),
+				Version:      libReleaseToAdd.GetVersion(),
+				IsDependency: isDep,
 			}
 			existingLibRef, _ := profile.GetLibrary(libReleaseToAdd.GetName())
 			if existingLibRef == nil {
 				profile.Libraries = append(profile.Libraries, libRefToAdd)
 				addedLibs = append(addedLibs, libRefToAdd)
 				return
 			}
-			// If the same version of the library has been already added to the profile, skip it
-			if existingLibRef.Version.Equal(libReleaseToAdd.GetVersion()) {
-				skippedLibs = append(skippedLibs, libRefToAdd)
-				return
+
+			// The library is already present in the profile.
+
+			// If the existing library was a dependency, and we are adding a non-dependency,
+			// update the flag to indicate that it's not a dependency anymore.
+			if !isDep && existingLibRef.IsDependency {
+				existingLibRef.IsDependency = false
 			}
-			// If the library has been already added to the profile, just update the version
-			if req.GetNoOverwrite() {
+
+			// If no-overwrite is specified, skip updating the library version.
+			// If the same version of the library has been already added to the profile, skip it.
+			if req.GetNoOverwrite() || existingLibRef.Version.Equal(libReleaseToAdd.GetVersion()) {
 				skippedLibs = append(skippedLibs, libRefToAdd)
 				return
 			}
+
+			// otherwise update the version of the library
 			existingLibRef.Version = libReleaseToAdd.GetVersion()
 			addedLibs = append(addedLibs, existingLibRef)
 		}
@@ -117,11 +126,14 @@ func (s *arduinoCoreServerImpl) ProfileLibAdd(ctx context.Context, req *rpc.Prof
 			if err != nil {
 				return nil, err
 			}
+			// sort to make the output order deterministic
+			slices.SortFunc(libWithDeps, librariesindex.ReleaseCompare)
 			for _, lib := range libWithDeps {
-				add(lib)
+				isDep := libRelease.GetName() != lib.GetName()
+				add(lib, isDep)
 			}
 		} else {
-			add(libRelease)
+			add(libRelease, false)
 		}
 	} else {
 		return nil, &cmderrors.InvalidArgumentError{Message: "library must be specified"}

commands/service_profile_lib_remove.go

@@ -17,8 +17,11 @@ package commands
 
 import (
 	"context"
+	"slices"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
+	"github.com/arduino/arduino-cli/commands/internal/instances"
+	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
@@ -47,19 +50,79 @@ func (s *arduinoCoreServerImpl) ProfileLibRemove(ctx context.Context, req *rpc.P
 		return nil, err
 	}
 
+	var removedLibraries []*rpc.ProfileLibraryReference
+	remove := func(libraryToRemove *sketch.ProfileLibraryReference) error {
+		removedLibrary, err := profile.RemoveLibrary(libraryToRemove)
+		if err != nil {
+			return &cmderrors.InvalidArgumentError{Cause: err}
+		}
+		removedLibraries = append(removedLibraries, removedLibrary.ToRpc())
+		return nil
+	}
+
 	libToRemove, err := sketch.FromRpcProfileLibraryReference(req.GetLibrary())
 	if err != nil {
 		return nil, &cmderrors.InvalidArgumentError{Message: "invalid library reference", Cause: err}
 	}
-	removedLib, err := profile.RemoveLibrary(libToRemove)
-	if err != nil {
-		return nil, &cmderrors.InvalidArgumentError{Cause: err}
+	if err := remove(libToRemove); err != nil {
+		return nil, err
+	}
+
+	// Get the dependencies of the libraries to see if any of them could be removed as well
+	if req.GetRemoveDependencies() {
+		if req.GetLibrary().GetIndexLibrary() == nil {
+			// No dependencies to remove
+			return nil, &cmderrors.InvalidArgumentError{Message: "automatic dependency removal is supported only for IndexLibraries"}
+		}
+		// Obtain the library index from the manager
+		li, err := instances.GetLibrariesIndex(req.GetInstance())
+		if err != nil {
+			return nil, err
+		}
+
+		// Get all the dependencies required by the profile excluding the removed library
+		requiredDeps := map[string]bool{}
+		requiredDeps[libToRemove.String()] = true
+		for _, profLib := range profile.Libraries {
+			if profLib.IsDependency {
+				continue
+			}
+			if profLib.Library == "" {
+				continue
+			}
+			deps, err := libraryResolveDependencies(li, profLib.Library, profLib.Version.String(), nil)
+			if err != nil {
+				return nil, &cmderrors.InvalidArgumentError{Cause: err, Message: "cannot resolve dependencies for installed libraries"}
+			}
+			for _, dep := range deps {
+				requiredDeps[dep.String()] = true
+			}
+		}
+
+		depsOfLibToRemove, err := libraryResolveDependencies(li, libToRemove.Library, libToRemove.Version.String(), nil)
+		if err != nil {
+			return nil, err
+		}
+		// sort to make the output order deterministic
+		slices.SortFunc(depsOfLibToRemove, librariesindex.ReleaseCompare)
+		// deps contains the main library as well, so we skip it when removing dependencies
+		for _, depToRemove := range depsOfLibToRemove {
+			if requiredDeps[depToRemove.String()] {
+				continue
+			}
+			if err := remove(&sketch.ProfileLibraryReference{Library: depToRemove.Library.Name, Version: depToRemove.Version}); err != nil {
+				return nil, err
+			}
+		}
 	}
 
 	err = projectFilePath.WriteFile([]byte(sk.Project.AsYaml()))
 	if err != nil {
 		return nil, err
 	}
 
-	return &rpc.ProfileLibRemoveResponse{Library: removedLib.ToRpc(), ProfileName: profileName}, nil
+	return &rpc.ProfileLibRemoveResponse{
+		RemovedLibraries: removedLibraries,
+		ProfileName:      profileName,
+	}, nil
 }

internal/arduino/libraries/librariesindex/index.go

@@ -17,6 +17,7 @@ package librariesindex
 
 import (
 	"sort"
+	"strings"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries"
@@ -90,6 +91,14 @@ func (r *Release) GetDependencies() []*Dependency {
 	return r.Dependencies
 }
 
+// ReleaseCompare compares two library releases by name, or by version if the names are equal.
+func ReleaseCompare(r1, r2 *Release) int {
+	if cmp := strings.Compare(r1.GetName(), r2.GetName()); cmp != 0 {
+		return cmp
+	}
+	return r1.GetVersion().CompareTo(r2.GetVersion())
+}
+
 // Dependency is a library dependency
 type Dependency struct {
 	Name              string

internal/integrationtest/arduino-cli.go

@@ -741,3 +741,69 @@ func (inst *ArduinoCLIInstance) NewSketch(ctx context.Context, sketchName, sketc
 	logCallf(">>> NewSketch(%+v)\n", req)
 	return inst.cli.daemonClient.NewSketch(ctx, req)
 }
+
+func (inst *ArduinoCLIInstance) ProfileCreate(
+	ctx context.Context,
+	profileName, sketchPath string,
+	fqbn string,
+	defaultProfile bool,
+) (*commands.ProfileCreateResponse, error) {
+	req := &commands.ProfileCreateRequest{
+		Instance:       inst.instance,
+		SketchPath:     sketchPath,
+		ProfileName:    profileName,
+		Fqbn:           fqbn,
+		DefaultProfile: defaultProfile,
+	}
+	logCallf(">>> ProfileCreate(%+v)\n", req)
+	resp, err := inst.cli.daemonClient.ProfileCreate(ctx, req)
+	return resp, err
+}
+
+func (inst *ArduinoCLIInstance) ProfileLibList(ctx context.Context, sketchPath, profileName string) (*commands.ProfileLibListResponse, error) {
+	req := &commands.ProfileLibListRequest{
+		SketchPath:  sketchPath,
+		ProfileName: profileName,
+	}
+	logCallf(">>> ProfileListLib(%+v)\n", req)
+	resp, err := inst.cli.daemonClient.ProfileLibList(ctx, req)
+	return resp, err
+}
+
+func (inst *ArduinoCLIInstance) ProfileLibAdd(
+	ctx context.Context,
+	sketchPath, profileName string,
+	library *commands.ProfileLibraryReference,
+	addDependencies, noOverwrite bool,
+) (*commands.ProfileLibAddResponse, error) {
+	req := &commands.ProfileLibAddRequest{
+		Instance:        inst.instance,
+		SketchPath:      sketchPath,
+		ProfileName:     profileName,
+		Library:         library,
+		AddDependencies: &addDependencies,
+		NoOverwrite:     &noOverwrite,
+	}
+	logCallf(">>> ProfileLibAdd(%+v)\n", req)
+	resp, err := inst.cli.daemonClient.ProfileLibAdd(ctx, req)
+	return resp, err
+}
+
+func (inst *ArduinoCLIInstance) ProfileLibRemove(
+	ctx context.Context,
+	sketchPath,
+	profileName string,
+	library *commands.ProfileLibraryReference,
+	removeDependencies bool,
+) (*commands.ProfileLibRemoveResponse, error) {
+	req := &commands.ProfileLibRemoveRequest{
+		Instance:           inst.instance,
+		SketchPath:         sketchPath,
+		ProfileName:        profileName,
+		Library:            library,
+		RemoveDependencies: &removeDependencies,
+	}
+	logCallf(">>> ProfileLibRemove(%+v)\n", req)
+	resp, err := inst.cli.daemonClient.ProfileLibRemove(ctx, req)
+	return resp, err
+}