Factored all progress reports callback definitions in the rpc package

cmaglie · cmaglie · commit af91a95c0db1 · 2022-03-28T12:39:48.000+02:00
diff --git a/arduino/cores/packagemanager/download.go b/arduino/cores/packagemanager/download.go
@@ -19,7 +19,7 @@ import (
 	"fmt"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
-	"github.com/arduino/arduino-cli/arduino/httpclient"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"go.bug.st/downloader/v2"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -118,7 +118,7 @@ func (pm *PackageManager) FindPlatformReleaseDependencies(item *PlatformReferenc
 
 // DownloadToolRelease downloads a ToolRelease. If the tool is already downloaded a nil Downloader
 // is returned.
-func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, label string, progressCB httpclient.DownloadProgressCB) error {
+func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, label string, progressCB rpc.DownloadProgressCB) error {
 	resource := tool.GetCompatibleFlavour()
 	if resource == nil {
 		return fmt.Errorf(tr("tool not available for your OS"))
@@ -128,6 +128,6 @@ func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *d
 
 // DownloadPlatformRelease downloads a PlatformRelease. If the platform is already downloaded a
 // nil Downloader is returned.
-func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease, config *downloader.Config, label string, progressCB httpclient.DownloadProgressCB) error {
+func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease, config *downloader.Config, label string, progressCB rpc.DownloadProgressCB) error {
 	return platform.Resource.Download(pm.DownloadDir, config, label, progressCB)
 }
diff --git a/arduino/httpclient/httpclient.go b/arduino/httpclient/httpclient.go
@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/configuration"
 	"github.com/arduino/arduino-cli/i18n"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
 )
@@ -31,7 +32,7 @@ var tr = i18n.Tr
 
 // DownloadFile downloads a file from a URL into the specified path. An optional config and options may be passed (or nil to use the defaults).
 // A DownloadProgressCB callback function must be passed to monitor download progress.
-func DownloadFile(path *paths.Path, URL string, label string, downloadCB DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) error {
+func DownloadFile(path *paths.Path, URL string, label string, downloadCB rpc.DownloadProgressCB, config *downloader.Config, options ...downloader.DownloadOptions) error {
 	if config == nil {
 		c, err := GetDownloaderConfig()
 		if err != nil {
@@ -44,14 +45,14 @@ func DownloadFile(path *paths.Path, URL string, label string, downloadCB Downloa
 	if err != nil {
 		return err
 	}
-	downloadCB(&DownloadProgress{
+	downloadCB(&rpc.DownloadProgress{
 		File:      label,
-		URL:       d.URL,
+		Url:       d.URL,
 		TotalSize: d.Size(),
 	})
 
 	err = d.RunAndPoll(func(downloaded int64) {
-		downloadCB(&DownloadProgress{Downloaded: downloaded})
+		downloadCB(&rpc.DownloadProgress{Downloaded: downloaded})
 	}, 250*time.Millisecond)
 	if err != nil {
 		return err
@@ -62,7 +63,7 @@ func DownloadFile(path *paths.Path, URL string, label string, downloadCB Downloa
 		return &arduino.FailedDownloadError{Message: tr("Server responded with: %s", d.Resp.Status)}
 	}
 
-	downloadCB(&DownloadProgress{Completed: true})
+	downloadCB(&rpc.DownloadProgress{Completed: true})
 	return nil
 }
 
@@ -94,24 +95,6 @@ func NewWithConfig(config *Config) *http.Client {
 	}
 }
 
-// DownloadProgress is a report of the download progress, not all fields may be
-// filled and multiple reports may be sent during a download.
-type DownloadProgress struct {
-	// URL of the download.
-	URL string
-	// The file being downloaded.
-	File string
-	// TotalSize is the total size of the file being downloaded.
-	TotalSize int64
-	// Downloaded is the size of the downloaded portion of the file.
-	Downloaded int64
-	// Completed reports whether the download is complete.
-	Completed bool
-}
-
-// DownloadProgressCB is a callback function to report download progress
-type DownloadProgressCB func(progress *DownloadProgress)
-
 // GetDownloaderConfig returns the downloader configuration based on current settings.
 func GetDownloaderConfig() (*downloader.Config, error) {
 	httpClient, err := New()
diff --git a/arduino/resources/download.go b/arduino/resources/download.go
@@ -20,13 +20,14 @@ import (
 	"os"
 
 	"github.com/arduino/arduino-cli/arduino/httpclient"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
 )
 
 // Download performs a download loop using the provided downloader.Downloader.
 // Messages are passed back to the DownloadProgressCB using label as text for the File field.
-func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.Config, label string, downloadCB httpclient.DownloadProgressCB) error {
+func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.Config, label string, downloadCB rpc.DownloadProgressCB) error {
 	path, err := r.ArchivePath(downloadDir)
 	if err != nil {
 		return fmt.Errorf(tr("getting archive path: %s"), err)
@@ -45,7 +46,7 @@ func (r *DownloadResource) Download(downloadDir *paths.Path, config *downloader.
 			// File is cached, nothing to do here
 
 			// This signal means that the file is already downloaded
-			downloadCB(&httpclient.DownloadProgress{
+			downloadCB(&rpc.DownloadProgress{
 				File:      label,
 				Completed: true,
 			})
diff --git a/arduino/resources/helpers_test.go b/arduino/resources/helpers_test.go
@@ -23,6 +23,7 @@ import (
 	"testing"
 
 	"github.com/arduino/arduino-cli/arduino/httpclient"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
 	"go.bug.st/downloader/v2"
@@ -55,7 +56,7 @@ func TestDownloadApplyUserAgentHeaderUsingConfig(t *testing.T) {
 
 	httpClient := httpclient.NewWithConfig(&httpclient.Config{UserAgent: goldUserAgentValue})
 
-	err = r.Download(tmp, &downloader.Config{HttpClient: *httpClient}, "", func(progress *httpclient.DownloadProgress) {})
+	err = r.Download(tmp, &downloader.Config{HttpClient: *httpClient}, "", func(progress *rpc.DownloadProgress) {})
 	require.NoError(t, err)
 
 	// leverage the download helper to download the echo for the request made by the downloader itself
diff --git a/arduino/resources/index.go b/arduino/resources/index.go
@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/httpclient"
 	"github.com/arduino/arduino-cli/arduino/security"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"go.bug.st/downloader/v2"
 )
@@ -35,7 +36,7 @@ type IndexResource struct {
 
 // Download will download the index and possibly check the signature using the Arduino's public key.
 // If the file is in .gz format it will be unpacked first.
-func (res *IndexResource) Download(destDir *paths.Path, downloadCB httpclient.DownloadProgressCB) error {
+func (res *IndexResource) Download(destDir *paths.Path, downloadCB rpc.DownloadProgressCB) error {
 	// Create destination directory
 	if err := destDir.MkdirAll(); err != nil {
 		return &arduino.PermissionDeniedError{Message: tr("Can't create data directory %s", destDir), Cause: err}
diff --git a/arduino/resources/resources_test.go b/arduino/resources/resources_test.go
@@ -20,7 +20,7 @@ import (
 	"encoding/hex"
 	"testing"
 
-	"github.com/arduino/arduino-cli/arduino/httpclient"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
 	"go.bug.st/downloader/v2"
@@ -45,7 +45,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	require.NoError(t, err)
 
 	downloadAndTestChecksum := func() {
-		err := r.Download(tmp, &downloader.Config{}, "", func(*httpclient.DownloadProgress) {})
+		err := r.Download(tmp, &downloader.Config{}, "", func(*rpc.DownloadProgress) {})
 		require.NoError(t, err)
 
 		data, err := testFile.ReadFile()
@@ -59,7 +59,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	downloadAndTestChecksum()
 
 	// Download with cached file
-	err = r.Download(tmp, &downloader.Config{}, "", func(*httpclient.DownloadProgress) {})
+	err = r.Download(tmp, &downloader.Config{}, "", func(*rpc.DownloadProgress) {})
 	require.NoError(t, err)
 
 	// Download if cached file has data in excess (redownload)
diff --git a/cli/output/rpc_progress.go b/cli/output/rpc_progress.go
@@ -18,7 +18,6 @@ package output
 import (
 	"fmt"
 
-	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/cmaglie/pb"
@@ -32,7 +31,7 @@ var (
 
 // ProgressBar returns a DownloadProgressCB that prints a progress bar.
 // If JSON output format has been selected, the callback outputs nothing.
-func ProgressBar() commands.DownloadProgressCB {
+func ProgressBar() rpc.DownloadProgressCB {
 	if OutputFormat != "json" {
 		return NewDownloadProgressBarCB()
 	}
@@ -43,7 +42,7 @@ func ProgressBar() commands.DownloadProgressCB {
 
 // TaskProgress returns a TaskProgressCB that prints the task progress.
 // If JSON output format has been selected, the callback outputs nothing.
-func TaskProgress() commands.TaskProgressCB {
+func TaskProgress() rpc.TaskProgressCB {
 	if OutputFormat != "json" {
 		return NewTaskProgressCB()
 	}
diff --git a/commands/board/attach.go b/commands/board/attach.go
@@ -36,7 +36,7 @@ import (
 var tr = i18n.Tr
 
 // Attach FIXMEDOC
-func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResponse, error) {
+func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB rpc.TaskProgressCB) (*rpc.BoardAttachResponse, error) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
 		return nil, &arduino.InvalidInstanceError{}
diff --git a/commands/bundled_tools.go b/commands/bundled_tools.go
@@ -24,16 +24,16 @@ import (
 )
 
 // DownloadToolRelease downloads a ToolRelease
-func DownloadToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, downloadCB DownloadProgressCB) error {
+func DownloadToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, downloadCB rpc.DownloadProgressCB) error {
 	config, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return err
 	}
-	return pm.DownloadToolRelease(toolRelease, config, toolRelease.String(), downloadCB.FromRPC())
+	return pm.DownloadToolRelease(toolRelease, config, toolRelease.String(), downloadCB)
 }
 
 // InstallToolRelease installs a ToolRelease
-func InstallToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, taskCB TaskProgressCB) error {
+func InstallToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error {
 	log := pm.Log.WithField("Tool", toolRelease)
 
 	if toolRelease.IsInstalled() {
diff --git a/commands/compile/compile.go b/commands/compile/compile.go
@@ -45,7 +45,7 @@ import (
 var tr = i18n.Tr
 
 // Compile FIXMEDOC
-func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream io.Writer, progressCB commands.TaskProgressCB, debug bool) (r *rpc.CompileResponse, e error) {
+func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream io.Writer, progressCB rpc.TaskProgressCB, debug bool) (r *rpc.CompileResponse, e error) {
 
 	// There is a binding between the export binaries setting and the CLI flag to explicitly set it,
 	// since we want this binding to work also for the gRPC interface we must read it here in this
diff --git a/commands/core/download.go b/commands/core/download.go
@@ -31,7 +31,7 @@ import (
 var tr = i18n.Tr
 
 // PlatformDownload FIXMEDOC
-func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadRequest, downloadCB commands.DownloadProgressCB) (*rpc.PlatformDownloadResponse, error) {
+func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadRequest, downloadCB rpc.DownloadProgressCB) (*rpc.PlatformDownloadResponse, error) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
 		return nil, &arduino.InvalidInstanceError{}
@@ -65,16 +65,16 @@ func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadRequest, dow
 	return &rpc.PlatformDownloadResponse{}, nil
 }
 
-func downloadPlatform(pm *packagemanager.PackageManager, platformRelease *cores.PlatformRelease, downloadCB commands.DownloadProgressCB) error {
+func downloadPlatform(pm *packagemanager.PackageManager, platformRelease *cores.PlatformRelease, downloadCB rpc.DownloadProgressCB) error {
 	// Download platform
 	config, err := httpclient.GetDownloaderConfig()
 	if err != nil {
 		return &arduino.FailedDownloadError{Message: tr("Error downloading platform %s", platformRelease), Cause: err}
 	}
-	return pm.DownloadPlatformRelease(platformRelease, config, platformRelease.String(), downloadCB.FromRPC())
+	return pm.DownloadPlatformRelease(platformRelease, config, platformRelease.String(), downloadCB)
 }
 
-func downloadTool(pm *packagemanager.PackageManager, tool *cores.ToolRelease, downloadCB commands.DownloadProgressCB) error {
+func downloadTool(pm *packagemanager.PackageManager, tool *cores.ToolRelease, downloadCB rpc.DownloadProgressCB) error {
 	// Check if tool has a flavor available for the current OS
 	if tool.GetCompatibleFlavour() == nil {
 		return &arduino.FailedDownloadError{
diff --git a/commands/core/install.go b/commands/core/install.go
@@ -27,7 +27,7 @@ import (
 
 // PlatformInstall FIXMEDOC
 func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallRequest,
-	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB) (*rpc.PlatformInstallResponse, error) {
+	downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*rpc.PlatformInstallResponse, error) {
 
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
@@ -63,7 +63,7 @@ func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallRequest,
 
 func installPlatform(pm *packagemanager.PackageManager,
 	platformRelease *cores.PlatformRelease, requiredTools []*cores.ToolRelease,
-	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB,
+	downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB,
 	skipPostInstall bool) error {
 	log := pm.Log.WithField("platform", platformRelease)
 
diff --git a/commands/core/uninstall.go b/commands/core/uninstall.go
@@ -26,7 +26,7 @@ import (
 )
 
 // PlatformUninstall FIXMEDOC
-func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallRequest, taskCB commands.TaskProgressCB) (*rpc.PlatformUninstallResponse, error) {
+func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallRequest, taskCB rpc.TaskProgressCB) (*rpc.PlatformUninstallResponse, error) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
 		return nil, &arduino.InvalidInstanceError{}
@@ -70,7 +70,7 @@ func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallRequest, t
 	return &rpc.PlatformUninstallResponse{}, nil
 }
 
-func uninstallPlatformRelease(pm *packagemanager.PackageManager, platformRelease *cores.PlatformRelease, taskCB commands.TaskProgressCB) error {
+func uninstallPlatformRelease(pm *packagemanager.PackageManager, platformRelease *cores.PlatformRelease, taskCB rpc.TaskProgressCB) error {
 	log := pm.Log.WithField("platform", platformRelease)
 
 	log.Info("Uninstalling platform")
@@ -86,7 +86,7 @@ func uninstallPlatformRelease(pm *packagemanager.PackageManager, platformRelease
 	return nil
 }
 
-func uninstallToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, taskCB commands.TaskProgressCB) error {
+func uninstallToolRelease(pm *packagemanager.PackageManager, toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error {
 	log := pm.Log.WithField("Tool", toolRelease)
 
 	log.Info("Uninstalling tool")
diff --git a/commands/core/upgrade.go b/commands/core/upgrade.go
@@ -26,7 +26,7 @@ import (
 
 // PlatformUpgrade FIXMEDOC
 func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeRequest,
-	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB) (*rpc.PlatformUpgradeResponse, error) {
+	downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*rpc.PlatformUpgradeResponse, error) {
 
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
@@ -50,7 +50,7 @@ func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeRequest,
 }
 
 func upgradePlatform(pm *packagemanager.PackageManager, platformRef *packagemanager.PlatformReference,
-	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB, skipPostInstall bool) error {
+	downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB, skipPostInstall bool) error {
 	if platformRef.PlatformVersion != nil {
 		return &arduino.InvalidArgumentError{Message: tr("Upgrade doesn't accept parameters with version")}
 	}
diff --git a/commands/instances.go b/commands/instances.go
diff --git a/commands/lib/download.go b/commands/lib/download.go
diff --git a/commands/lib/install.go b/commands/lib/install.go
diff --git a/commands/lib/uninstall.go b/commands/lib/uninstall.go
diff --git a/commands/lib/upgrade.go b/commands/lib/upgrade.go
diff --git a/legacy/builder/types/context.go b/legacy/builder/types/context.go
diff --git a/rpc/cc/arduino/cli/commands/v1/common.go b/rpc/cc/arduino/cli/commands/v1/common.go

Original file line number	Diff line number	Diff line change
`@@ -24,16 +24,16 @@ import (`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// DownloadToolRelease downloads a ToolRelease`
`27`		`-func DownloadToolRelease(pm packagemanager.PackageManager, toolRelease cores.ToolRelease, downloadCB DownloadProgressCB) error {`
	`27`	`+func DownloadToolRelease(pm packagemanager.PackageManager, toolRelease cores.ToolRelease, downloadCB rpc.DownloadProgressCB) error {`
`28`	`28`	`config, err := httpclient.GetDownloaderConfig()`
`29`	`29`	`if err != nil {`
`30`	`30`	`return err`
`31`	`31`	`}`
`32`		`- return pm.DownloadToolRelease(toolRelease, config, toolRelease.String(), downloadCB.FromRPC())`
	`32`	`+ return pm.DownloadToolRelease(toolRelease, config, toolRelease.String(), downloadCB)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`// InstallToolRelease installs a ToolRelease`
`36`		`-func InstallToolRelease(pm packagemanager.PackageManager, toolRelease cores.ToolRelease, taskCB TaskProgressCB) error {`
	`36`	`+func InstallToolRelease(pm packagemanager.PackageManager, toolRelease cores.ToolRelease, taskCB rpc.TaskProgressCB) error {`
`37`	`37`	`log := pm.Log.WithField("Tool", toolRelease)`
`38`	`38`
`39`	`39`	`if toolRelease.IsInstalled() {`