ProfileRemoveLibrary now accepts a full ProfileLibraryReference object

Author: cmaglie

commands/service_profile_lib_add.go

@@ -72,7 +72,7 @@ func (s *arduinoCoreServerImpl) ProfileLibAdd(ctx context.Context, req *rpc.Prof
 			return nil, err
 		}
 		// If the library has been already added to the profile, just update the version
-		if lib, _ := profile.GetLibrary(reqIndexLib.GetName(), false); lib != nil {
+		if lib, _ := profile.GetLibrary(reqIndexLib.GetName()); lib != nil {
 			lib.Version = libRelease.GetVersion()
 			addedLib = lib
 		} else {

commands/service_profile_lib_remove.go

@@ -47,15 +47,19 @@ func (s *arduinoCoreServerImpl) ProfileLibRemove(ctx context.Context, req *rpc.P
 		return nil, err
 	}
 
-	lib, err := profile.GetLibrary(req.LibName, true)
+	libToRemove, err := sketch.FromRpcProfileLibraryReference(req.GetLibrary())
 	if err != nil {
-		return nil, err
+		return nil, &cmderrors.InvalidArgumentError{Message: "invalid library reference", Cause: err}
+	}
+	removedLib, err := profile.RemoveLibrary(libToRemove)
+	if err != nil {
+		return nil, &cmderrors.InvalidArgumentError{Message: "failed to remove library", Cause: err}
 	}
 
 	err = projectFilePath.WriteFile([]byte(sk.Project.AsYaml()))
 	if err != nil {
 		return nil, err
 	}
 
-	return &rpc.ProfileLibRemoveResponse{LibName: lib.Library, LibVersion: lib.Version.String(), ProfileName: profileName}, nil
+	return &rpc.ProfileLibRemoveResponse{Library: removedLib.ToRpc(), ProfileName: profileName}, nil
 }

internal/arduino/sketch/profiles.go

@@ -127,19 +127,25 @@ func (p *Profile) RequireSystemInstalledPlatform() bool {
 	return p.Platforms[0].RequireSystemInstalledPlatform()
 }
 
-// GetLibrary returns the requested library or an error if not found
-func (p *Profile) GetLibrary(libraryName string, toDelete bool) (*ProfileLibraryReference, error) {
-	for i, l := range p.Libraries {
+func (p *Profile) GetLibrary(libraryName string) (*ProfileLibraryReference, error) {
+	for _, l := range p.Libraries {
 		if l.Library == libraryName {
-			if toDelete {
-				p.Libraries = slices.Delete(p.Libraries, i, i+1)
-			}
 			return l, nil
 		}
 	}
 	return nil, &cmderrors.LibraryNotFoundError{Library: libraryName}
 }
 
+func (p *Profile) RemoveLibrary(library *ProfileLibraryReference) (*ProfileLibraryReference, error) {
+	for i, l := range p.Libraries {
+		if l.Match(library) {
+			p.Libraries = slices.Delete(p.Libraries, i, i+1)
+			return l, nil
+		}
+	}
+	return nil, &cmderrors.LibraryNotFoundError{Library: library.String()}
+}
+
 // ToRpc converts this Profile to an rpc.SketchProfile
 func (p *Profile) ToRpc() *rpc.SketchProfile {
 	var portConfig *rpc.MonitorPortConfiguration
@@ -392,6 +398,25 @@ func (l *ProfileLibraryReference) String() string {
 	return fmt.Sprintf("%s@%s", l.Library, l.Version)
 }
 
+// Match checks if this library reference matches another one.
+// If one reference has the version not set, it matches any version of the other reference.
+func (l *ProfileLibraryReference) Match(other *ProfileLibraryReference) bool {
+	if l.InstallDir != nil {
+		return other.InstallDir != nil && l.InstallDir.EqualsTo(other.InstallDir)
+	}
+	if other.InstallDir != nil {
+		return false
+	}
+	if l.Library != other.Library {
+		return false
+	}
+	if l.Version == nil || other.Version == nil {
+		return true
+	}
+	return l.Version.Equal(other.Version)
+}
+
+// ToRpc converts this ProfileLibraryReference to an rpc.ProfileLibraryReference
 func (l *ProfileLibraryReference) ToRpc() *rpc.ProfileLibraryReference {
 	if l.InstallDir != nil {
 		return &rpc.ProfileLibraryReference{
@@ -412,6 +437,29 @@ func (l *ProfileLibraryReference) ToRpc() *rpc.ProfileLibraryReference {
 	}
 }
 
+// FromRpcProfileLibraryReference converts an rpc.ProfileLibraryReference to a ProfileLibraryReference
+func FromRpcProfileLibraryReference(l *rpc.ProfileLibraryReference) (*ProfileLibraryReference, error) {
+	if localLib := l.GetLocalLibrary(); localLib != nil {
+		path := paths.New(localLib.GetPath())
+		if path == nil {
+			return nil, &cmderrors.InvalidArgumentError{Message: "invalid library path"}
+		}
+		return &ProfileLibraryReference{InstallDir: path}, nil
+	}
+	if indexLib := l.GetIndexLibrary(); indexLib != nil {
+		var version *semver.Version
+		if indexLib.GetVersion() != "" {
+			v, err := semver.Parse(indexLib.GetVersion())
+			if err != nil {
+				return nil, &cmderrors.InvalidVersionError{Cause: err}
+			}
+			version = v
+		}
+		return &ProfileLibraryReference{Library: indexLib.GetName(), Version: version}, nil
+	}
+	return nil, &cmderrors.InvalidArgumentError{Message: "library not specified"}
+}
+
 // InternalUniqueIdentifier returns the unique identifier for this object
 func (l *ProfileLibraryReference) InternalUniqueIdentifier() string {
 	f.Assert(l.InstallDir == nil,

internal/cli/profile/lib.go

@@ -139,12 +139,21 @@ func runLibRemoveCommand(ctx context.Context, args []string, srv rpc.ArduinoCore
 		resp, err := srv.ProfileLibRemove(ctx, &rpc.ProfileLibRemoveRequest{
 			SketchPath:  sketchPath.String(),
 			ProfileName: profileArg.Get(),
-			LibName:     lib.Name,
+			Library: &rpc.ProfileLibraryReference{
+				Library: &rpc.ProfileLibraryReference_IndexLibrary_{
+					IndexLibrary: &rpc.ProfileLibraryReference_IndexLibrary{
+						Name:    lib.Name,
+						Version: lib.Version,
+					},
+				},
+			},
 		})
 		if err != nil {
 			feedback.Fatal(i18n.Tr("Error removing %s from the profile %s: %v", lib.Name, profileArg.Get(), err), feedback.ErrGeneric)
 		}
-		feedback.PrintResult(libRemoveResult{LibName: resp.GetLibName(), LibVersion: resp.GetLibVersion(), ProfileName: resp.ProfileName})
+		feedback.PrintResult(libRemoveResult{
+			Library:     result.NewProfileLibraryReference_IndexLibraryResult(resp.GetLibrary().GetIndexLibrary()),
+			ProfileName: resp.ProfileName})
 	}
 }
 
@@ -162,15 +171,16 @@ func (lr libAddResult) String() string {
 }
 
 type libRemoveResult struct {
-	LibName     string `json:"library_name"`
-	LibVersion  string `json:"library_version"`
-	ProfileName string `json:"profile_name"`
+	Library     *result.ProfileLibraryReference_IndexLibraryResult `json:"library"`
+	ProfileName string                                             `json:"profile_name"`
 }
 
 func (lr libRemoveResult) Data() interface{} {
 	return lr
 }
 
 func (lr libRemoveResult) String() string {
-	return i18n.Tr("Profile %s: %s@%s removed successfully", lr.ProfileName, lr.LibName, lr.LibVersion)
+	res := fmt.Sprintln(i18n.Tr("The following libraries were removed from the profile %s:", lr.ProfileName))
+	res += fmt.Sprintf("  - %s@%s\n", lr.Library.Name, lr.Library.Version)
+	return res
 }