[skip-changelog] Renamed gRPC field to match JSON output (#2398)

* Renamed gRPC field to match JSON output * Better comment for custom_configs field * Renamed variable
arduino · Nov 2, 2023 · 71b0d1a · 71b0d1a
1 parent 830e800
commit 71b0d1a
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 56 deletions.
diff --git a/commands/debug/debug_info.go b/commands/debug/debug_info.go
@@ -184,22 +184,22 @@ func getDebugProperties(req *rpc.GetDebugConfigRequest, pme *packagemanager.Expl
 		}
 	}
 
-	cortexDebugCustomJson := map[string]string{}
+	customConfigs := map[string]string{}
 	if cortexDebugProps := debugProperties.SubTree("cortex-debug.custom"); cortexDebugProps.Size() > 0 {
-		cortexDebugCustomJson["cortex-debug"] = convertToJsonMap(cortexDebugProps)
+		customConfigs["cortex-debug"] = convertToJsonMap(cortexDebugProps)
 	}
 	return &rpc.GetDebugConfigResponse{
-		Executable:               debugProperties.Get("executable"),
-		Server:                   server,
-		ServerPath:               debugProperties.Get("server." + server + ".path"),
-		ServerConfiguration:      &serverConfiguration,
-		SvdFile:                  debugProperties.Get("svd_file"),
-		Toolchain:                toolchain,
-		ToolchainPath:            debugProperties.Get("toolchain.path"),
-		ToolchainPrefix:          debugProperties.Get("toolchain.prefix"),
-		ToolchainConfiguration:   &toolchainConfiguration,
-		CustomConfigurationsJson: cortexDebugCustomJson,
-		Programmer:               req.GetProgrammer(),
+		Executable:             debugProperties.Get("executable"),
+		Server:                 server,
+		ServerPath:             debugProperties.Get("server." + server + ".path"),
+		ServerConfiguration:    &serverConfiguration,
+		SvdFile:                debugProperties.Get("svd_file"),
+		Toolchain:              toolchain,
+		ToolchainPath:          debugProperties.Get("toolchain.path"),
+		ToolchainPrefix:        debugProperties.Get("toolchain.prefix"),
+		ToolchainConfiguration: &toolchainConfiguration,
+		CustomConfigs:          customConfigs,
+		Programmer:             req.GetProgrammer(),
 	}, nil
 }
 

diff --git a/internal/cli/debug/debug.go b/internal/cli/debug/debug.go
@@ -151,7 +151,7 @@ func newDebugInfoResult(info *rpc.GetDebugConfigResponse) *debugInfoResult {
 		}
 	}
 	customConfigs := map[string]any{}
-	for id, configJson := range info.GetCustomConfigurationsJson() {
+	for id, configJson := range info.GetCustomConfigs() {
 		var config any
 		if err := json.Unmarshal([]byte(configJson), &config); err == nil {
 			customConfigs[id] = config

diff --git a/rpc/cc/arduino/cli/commands/v1/debug.pb.go b/rpc/cc/arduino/cli/commands/v1/debug.pb.go
diff --git a/rpc/cc/arduino/cli/commands/v1/debug.proto b/rpc/cc/arduino/cli/commands/v1/debug.proto
@@ -92,8 +92,10 @@ message GetDebugConfigResponse {
   // Extra configuration parameters wrt GDB server
   google.protobuf.Any server_configuration = 8;
   // Custom debugger configurations (not handled directly by Arduino CLI but
-  // provided for 3rd party plugins/debuggers)
-  map<string, string> custom_configurations_json = 9;
+  // provided for 3rd party plugins/debuggers). The map keys identifies which
+  // 3rd party plugin/debugger is referred, the map string values contains a
+  // JSON configuration for it.
+  map<string, string> custom_configs = 9;
   // the SVD file to use
   string svd_file = 10;
   // The programmer specified in the request