Added oneof clause to all Platform* responses

cmaglie · cmaglie · commit 366f240715ab · 2024-05-16T12:18:04.000+02:00
diff --git a/commands/service_platform_download.go b/commands/service_platform_download.go
@@ -63,7 +63,13 @@ func (s *arduinoCoreServerImpl) PlatformDownload(req *rpc.PlatformDownloadReques
 		return &cmderrors.PlatformNotFoundError{Platform: ref.String(), Cause: err}
 	}
 
-	downloadCB := func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.PlatformDownloadResponse{Progress: p}) }
+	downloadCB := func(p *rpc.DownloadProgress) {
+		syncSend.Send(&rpc.PlatformDownloadResponse{
+			Message: &rpc.PlatformDownloadResponse_Progress{
+				Progress: p,
+			},
+		})
+	}
 
 	// TODO: pass context
 	// ctx := stream.Context()
@@ -78,5 +84,7 @@ func (s *arduinoCoreServerImpl) PlatformDownload(req *rpc.PlatformDownloadReques
 		}
 	}
 
-	return syncSend.Send(&rpc.PlatformDownloadResponse{})
+	return syncSend.Send(&rpc.PlatformDownloadResponse{Message: &rpc.PlatformDownloadResponse_Result_{
+		Result: &rpc.PlatformDownloadResponse_Result{},
+	}})
 }
diff --git a/commands/service_platform_install.go b/commands/service_platform_install.go
@@ -43,8 +43,20 @@ func PlatformInstallStreamResponseToCallbackFunction(ctx context.Context, downlo
 func (s *arduinoCoreServerImpl) PlatformInstall(req *rpc.PlatformInstallRequest, stream rpc.ArduinoCoreService_PlatformInstallServer) error {
 	ctx := stream.Context()
 	syncSend := NewSynchronizedSend(stream.Send)
-	taskCB := func(p *rpc.TaskProgress) { syncSend.Send(&rpc.PlatformInstallResponse{TaskProgress: p}) }
-	downloadCB := func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.PlatformInstallResponse{Progress: p}) }
+	taskCB := func(p *rpc.TaskProgress) {
+		syncSend.Send(&rpc.PlatformInstallResponse{
+			Message: &rpc.PlatformInstallResponse_TaskProgress{
+				TaskProgress: p,
+			},
+		})
+	}
+	downloadCB := func(p *rpc.DownloadProgress) {
+		syncSend.Send(&rpc.PlatformInstallResponse{
+			Message: &rpc.PlatformInstallResponse_Progress{
+				Progress: p,
+			},
+		})
+	}
 
 	install := func() error {
 		pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
@@ -102,5 +114,9 @@ func (s *arduinoCoreServerImpl) PlatformInstall(req *rpc.PlatformInstallRequest,
 		return err
 	}
 
-	return syncSend.Send(&rpc.PlatformInstallResponse{})
+	return syncSend.Send(&rpc.PlatformInstallResponse{
+		Message: &rpc.PlatformInstallResponse_Result_{
+			Result: &rpc.PlatformInstallResponse_Result{},
+		},
+	})
 }
diff --git a/commands/service_platform_uninstall.go b/commands/service_platform_uninstall.go
@@ -39,14 +39,24 @@ func PlatformUninstallStreamResponseToCallbackFunction(ctx context.Context, task
 func (s *arduinoCoreServerImpl) PlatformUninstall(req *rpc.PlatformUninstallRequest, stream rpc.ArduinoCoreService_PlatformUninstallServer) error {
 	syncSend := NewSynchronizedSend(stream.Send)
 	ctx := stream.Context()
-	taskCB := func(p *rpc.TaskProgress) { syncSend.Send(&rpc.PlatformUninstallResponse{TaskProgress: p}) }
+	taskCB := func(p *rpc.TaskProgress) {
+		syncSend.Send(&rpc.PlatformUninstallResponse{
+			Message: &rpc.PlatformUninstallResponse_TaskProgress{
+				TaskProgress: p,
+			},
+		})
+	}
 	if err := platformUninstall(ctx, req, taskCB); err != nil {
 		return err
 	}
 	if err := s.Init(&rpc.InitRequest{Instance: req.GetInstance()}, InitStreamResponseToCallbackFunction(ctx, nil)); err != nil {
 		return err
 	}
-	return syncSend.Send(&rpc.PlatformUninstallResponse{})
+	return syncSend.Send(&rpc.PlatformUninstallResponse{
+		Message: &rpc.PlatformUninstallResponse_Result_{
+			Result: &rpc.PlatformUninstallResponse_Result{},
+		},
+	})
 }
 
 // platformUninstall is the implementation of platform unistaller
diff --git a/commands/service_platform_upgrade.go b/commands/service_platform_upgrade.go
@@ -26,21 +26,20 @@ import (
 
 // PlatformUpgradeStreamResponseToCallbackFunction returns a gRPC stream to be used in PlatformUpgrade that sends
 // all responses to the callback function.
-func PlatformUpgradeStreamResponseToCallbackFunction(ctx context.Context, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (rpc.ArduinoCoreService_PlatformUpgradeServer, func() *rpc.Platform) {
-	var resp *rpc.Platform
+func PlatformUpgradeStreamResponseToCallbackFunction(ctx context.Context, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (rpc.ArduinoCoreService_PlatformUpgradeServer, func() *rpc.PlatformUpgradeResponse_Result) {
+	var resp *rpc.PlatformUpgradeResponse_Result
 	return streamResponseToCallback(ctx, func(r *rpc.PlatformUpgradeResponse) error {
-			// TODO: use oneof in protoc files?
 			if r.GetProgress() != nil {
 				downloadCB(r.GetProgress())
 			}
 			if r.GetTaskProgress() != nil {
 				taskCB(r.GetTaskProgress())
 			}
-			if r.GetPlatform() != nil {
-				resp = r.GetPlatform()
+			if r.GetResult() != nil {
+				resp = r.GetResult()
 			}
 			return nil
-		}), func() *rpc.Platform {
+		}), func() *rpc.PlatformUpgradeResponse_Result {
 			return resp
 		}
 }
@@ -49,8 +48,20 @@ func PlatformUpgradeStreamResponseToCallbackFunction(ctx context.Context, downlo
 func (s *arduinoCoreServerImpl) PlatformUpgrade(req *rpc.PlatformUpgradeRequest, stream rpc.ArduinoCoreService_PlatformUpgradeServer) error {
 	syncSend := NewSynchronizedSend(stream.Send)
 	ctx := stream.Context()
-	downloadCB := func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.PlatformUpgradeResponse{Progress: p}) }
-	taskCB := func(p *rpc.TaskProgress) { syncSend.Send(&rpc.PlatformUpgradeResponse{TaskProgress: p}) }
+	downloadCB := func(p *rpc.DownloadProgress) {
+		syncSend.Send(&rpc.PlatformUpgradeResponse{
+			Message: &rpc.PlatformUpgradeResponse_Progress{
+				Progress: p,
+			},
+		})
+	}
+	taskCB := func(p *rpc.TaskProgress) {
+		syncSend.Send(&rpc.PlatformUpgradeResponse{
+			Message: &rpc.PlatformUpgradeResponse_TaskProgress{
+				TaskProgress: p,
+			},
+		})
+	}
 
 	upgrade := func() (*cores.PlatformRelease, error) {
 		pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
@@ -75,9 +86,13 @@ func (s *arduinoCoreServerImpl) PlatformUpgrade(req *rpc.PlatformUpgradeRequest,
 	platformRelease, err := upgrade()
 	if platformRelease != nil {
 		syncSend.Send(&rpc.PlatformUpgradeResponse{
-			Platform: &rpc.Platform{
-				Metadata: platformToRPCPlatformMetadata(platformRelease.Platform),
-				Release:  platformReleaseToRPC(platformRelease),
+			Message: &rpc.PlatformUpgradeResponse_Result_{
+				Result: &rpc.PlatformUpgradeResponse_Result{
+					Platform: &rpc.Platform{
+						Metadata: platformToRPCPlatformMetadata(platformRelease.Platform),
+						Release:  platformReleaseToRPC(platformRelease),
+					},
+				},
 			},
 		})
 	}
diff --git a/internal/cli/core/upgrade.go b/internal/cli/core/upgrade.go
@@ -124,7 +124,7 @@ func Upgrade(ctx context.Context, srv rpc.ArduinoCoreServiceServer, inst *rpc.In
 		}
 		stream, respCB := commands.PlatformUpgradeStreamResponseToCallbackFunction(ctx, feedback.ProgressBar(), feedback.TaskProgress())
 		err := srv.PlatformUpgrade(r, stream)
-		warningMissingIndex(respCB())
+		warningMissingIndex(respCB().GetPlatform())
 		if err != nil {
 			var alreadyAtLatestVersionErr *cmderrors.PlatformAlreadyAtTheLatestVersionError
 			if errors.As(err, &alreadyAtLatestVersionErr) {
diff --git a/internal/integrationtest/daemon/daemon_test.go b/internal/integrationtest/daemon/daemon_test.go
@@ -559,8 +559,8 @@ func analyzePlatformUpgradeClient(cl commands.ArduinoCoreService_PlatformUpgrade
 		if errors.Is(err, io.EOF) {
 			break
 		}
-		if msg.GetPlatform() != nil {
-			platform = msg.GetPlatform()
+		if res := msg.GetResult(); res != nil {
+			platform = res.GetPlatform()
 		}
 		if err != nil {
 			upgradeError = err
diff --git a/rpc/cc/arduino/cli/commands/v1/core.pb.go b/rpc/cc/arduino/cli/commands/v1/core.pb.go
diff --git a/rpc/cc/arduino/cli/commands/v1/core.proto b/rpc/cc/arduino/cli/commands/v1/core.proto

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,13 @@ func (s arduinoCoreServerImpl) PlatformDownload(req rpc.PlatformDownloadReques`
`63`	`63`	`return &cmderrors.PlatformNotFoundError{Platform: ref.String(), Cause: err}`
`64`	`64`	`}`
`65`	`65`
`66`		`- downloadCB := func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.PlatformDownloadResponse{Progress: p}) }`
	`66`	`+ downloadCB := func(p *rpc.DownloadProgress) {`
	`67`	`+ syncSend.Send(&rpc.PlatformDownloadResponse{`
	`68`	`+ Message: &rpc.PlatformDownloadResponse_Progress{`
	`69`	`+ Progress: p,`
	`70`	`+ },`
	`71`	`+ })`
	`72`	`+ }`
`67`	`73`
`68`	`74`	`// TODO: pass context`
`69`	`75`	`// ctx := stream.Context()`
`@@ -78,5 +84,7 @@ func (s arduinoCoreServerImpl) PlatformDownload(req rpc.PlatformDownloadReques`
`78`	`84`	`}`
`79`	`85`	`}`
`80`	`86`
`81`		`- return syncSend.Send(&rpc.PlatformDownloadResponse{})`
	`87`	`+ return syncSend.Send(&rpc.PlatformDownloadResponse{Message: &rpc.PlatformDownloadResponse_Result_{`
	`88`	`+ Result: &rpc.PlatformDownloadResponse_Result{},`
	`89`	`+ }})`
`82`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func Upgrade(ctx context.Context, srv rpc.ArduinoCoreServiceServer, inst *rpc.In`
`124`	`124`	`}`
`125`	`125`	`stream, respCB := commands.PlatformUpgradeStreamResponseToCallbackFunction(ctx, feedback.ProgressBar(), feedback.TaskProgress())`
`126`	`126`	`err := srv.PlatformUpgrade(r, stream)`
`127`		`- warningMissingIndex(respCB())`
	`127`	`+ warningMissingIndex(respCB().GetPlatform())`
`128`	`128`	`if err != nil {`
`129`	`129`	`var alreadyAtLatestVersionErr *cmderrors.PlatformAlreadyAtTheLatestVersionError`
`130`	`130`	`if errors.As(err, &alreadyAtLatestVersionErr) {`
Original file line number	Diff line number	Diff line change
`@@ -559,8 +559,8 @@ func analyzePlatformUpgradeClient(cl commands.ArduinoCoreService_PlatformUpgrade`
`559`	`559`	`if errors.Is(err, io.EOF) {`
`560`	`560`	`break`
`561`	`561`	`}`
`562`		`- if msg.GetPlatform() != nil {`
`563`		`- platform = msg.GetPlatform()`
	`562`	`+ if res := msg.GetResult(); res != nil {`
	`563`	`+ platform = res.GetPlatform()`
`564`	`564`	`}`
`565`	`565`	`if err != nil {`
`566`	`566`	`upgradeError = err`