[breaking] Removed Profile protoc message in favor of `SketchProfil…

…e` (#2507)
arduino · Jan 18, 2024 · 47645e9 · 47645e9
1 parent 96b411f
commit 47645e9
Show file tree

Hide file tree

Showing 10 changed files with 547 additions and 616 deletions.
diff --git a/commands/instances.go b/commands/instances.go
@@ -145,11 +145,7 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		profile = p
 		responseCallback(&rpc.InitResponse{
 			Message: &rpc.InitResponse_Profile{
-				Profile: &rpc.Profile{
-					Name: req.GetProfile(),
-					Fqbn: profile.FQBN,
-					// TODO: Other profile infos may be provided here...
-				},
+				Profile: profile.ToRpc(),
 			},
 		})
 	}

diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md
@@ -4,6 +4,21 @@ Here you can find a list of migration guides to handle breaking changes between
 
 ## 0.36.0
 
+### The gRPC `cc.arduino.cli.commands.v1.Profile` message has been removed in favor of `SketchProfile`
+
+The message `Profile` has been replaced with `SketchProfile` in the `InitResponse.profile` field:
+
+```proto
+message InitResponse {
+  oneof message {
+    Progress init_progress = 1;
+    google.rpc.Status error = 2;
+    // Selected profile information
+    SketchProfile profile = 3;
+  }
+}
+```
+
 ### The gRPC `cc.arduino.cli.commands.v1.LoadSketchResponse` message has been changed.
 
 Previously the `LoadSketchResponse` containted all the information about the sketch:

diff --git a/internal/cli/compile/compile.go b/internal/cli/compile/compile.go
@@ -166,7 +166,7 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 	feedback.WarnAboutDeprecatedFiles(sk)
 
 	var inst *rpc.Instance
-	var profile *rpc.Profile
+	var profile *rpc.SketchProfile
 
 	if profileArg.Get() == "" {
 		inst, profile = instance.CreateAndInitWithProfile(sk.GetDefaultProfile().GetName(), sketchPath)

diff --git a/internal/cli/instance/instance.go b/internal/cli/instance/instance.go
@@ -37,7 +37,7 @@ func CreateAndInit() *rpc.Instance {
 // CreateAndInitWithProfile returns a new initialized instance using the given profile of the given sketch.
 // If Create fails the CLI prints an error and exits since to execute further operations a valid Instance is mandatory.
 // If Init returns errors they're printed only.
-func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.Instance, *rpc.Profile) {
+func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.Instance, *rpc.SketchProfile) {
 	instance, err := create()
 	if err != nil {
 		feedback.Fatal(tr("Error creating instance: %v", err), feedback.ErrGeneric)
@@ -67,7 +67,7 @@ func Init(instance *rpc.Instance) {
 // InitWithProfile initializes instance by loading libraries and platforms specified in the given profile of the given sketch.
 // In case of loading failures return a list of errors for each platform or library that we failed to load.
 // Required Package and library indexes files are automatically downloaded.
-func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.Profile {
+func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.SketchProfile {
 	downloadCallback := feedback.ProgressBar()
 	taskCallback := feedback.TaskProgress()
 
@@ -76,7 +76,7 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 		initReq.SketchPath = sketchPath.String()
 		initReq.Profile = profileName
 	}
-	var profile *rpc.Profile
+	var profile *rpc.SketchProfile
 	err := commands.Init(initReq, func(res *rpc.InitResponse) {
 		if st := res.GetError(); st != nil {
 			feedback.Warning(tr("Error initializing instance: %v", st.GetMessage()))

diff --git a/internal/cli/monitor/monitor.go b/internal/cli/monitor/monitor.go
@@ -93,7 +93,7 @@ func runMonitorCmd(
 
 	var (
 		inst                         *rpc.Instance
-		profile                      *rpc.Profile
+		profile                      *rpc.SketchProfile
 		fqbn                         string
 		defaultPort, defaultProtocol string
 	)

diff --git a/internal/cli/upload/upload.go b/internal/cli/upload/upload.go
@@ -100,7 +100,7 @@ func runUploadCommand(args []string, uploadFieldsArgs map[string]string) {
 	}
 
 	var inst *rpc.Instance
-	var profile *rpc.Profile
+	var profile *rpc.SketchProfile
 
 	if profileArg.Get() == "" {
 		inst, profile = instance.CreateAndInitWithProfile(sketch.GetDefaultProfile().GetName(), sketchPath)

diff --git a/rpc/cc/arduino/cli/commands/v1/commands.pb.go b/rpc/cc/arduino/cli/commands/v1/commands.pb.go
diff --git a/rpc/cc/arduino/cli/commands/v1/commands.proto b/rpc/cc/arduino/cli/commands/v1/commands.proto
@@ -237,7 +237,7 @@ message InitResponse {
     Progress init_progress = 1;
     google.rpc.Status error = 2;
     // Selected profile information
-    Profile profile = 3;
+    SketchProfile profile = 3;
   }
 }
 

diff --git a/rpc/cc/arduino/cli/commands/v1/common.pb.go b/rpc/cc/arduino/cli/commands/v1/common.pb.go
diff --git a/rpc/cc/arduino/cli/commands/v1/common.proto b/rpc/cc/arduino/cli/commands/v1/common.proto
@@ -173,13 +173,6 @@ message Board {
   string fqbn = 2;
 }
 
-message Profile {
-  // Name used to identify the profile within the sketch.
-  string name = 1;
-  // FQBN specified in the profile.
-  string fqbn = 2;
-}
-
 message HelpResources {
   // A URL provided by the author of the platform's package, intended to point
   // to their online help service.