Use downloader.SetDefaultConfig() to set user-agent for the arduino-cli

This change allows to not pass-trough the downloader configuration from
function to function everywhere (and sometime we forget to pass it for
example in the "core update-index" command).

Author: cmaglie

arduino/cores/packagemanager/download.go

@@ -17,7 +17,6 @@ package packagemanager
 
 import (
 	"fmt"
-	"net/http"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"go.bug.st/downloader"
@@ -101,16 +100,16 @@ 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, downloaderHeaders http.Header) (*downloader.Downloader, error) {
+func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease) (*downloader.Downloader, error) {
 	resource := tool.GetCompatibleFlavour()
 	if resource == nil {
 		return nil, fmt.Errorf("tool not available for your OS")
 	}
-	return resource.Download(pm.DownloadDir, downloaderHeaders)
+	return resource.Download(pm.DownloadDir)
 }
 
 // DownloadPlatformRelease downloads a PlatformRelease. If the platform is already downloaded a
 // nil Downloader is returned.
-func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease, downloaderHeaders http.Header) (*downloader.Downloader, error) {
-	return platform.Resource.Download(pm.DownloadDir, downloaderHeaders)
+func (pm *PackageManager) DownloadPlatformRelease(platform *cores.PlatformRelease) (*downloader.Downloader, error) {
+	return platform.Resource.Download(pm.DownloadDir)
 }

arduino/resources/helpers.go

@@ -17,7 +17,6 @@ package resources
 
 import (
 	"fmt"
-	"net/http"
 	"os"
 
 	"github.com/arduino/go-paths-helper"
@@ -44,7 +43,7 @@ func (r *DownloadResource) IsCached(downloadDir *paths.Path) (bool, error) {
 }
 
 // Download a DownloadResource.
-func (r *DownloadResource) Download(downloadDir *paths.Path, downloaderHeaders http.Header) (*downloader.Downloader, error) {
+func (r *DownloadResource) Download(downloadDir *paths.Path) (*downloader.Downloader, error) {
 	cached, err := r.TestLocalArchiveIntegrity(downloadDir)
 	if err != nil {
 		return nil, fmt.Errorf("testing local archive integrity: %s", err)
@@ -72,7 +71,5 @@ func (r *DownloadResource) Download(downloadDir *paths.Path, downloaderHeaders h
 		return nil, fmt.Errorf("getting archive file info: %s", err)
 	}
 
-	downloadConfig := downloader.Config{
-		RequestHeaders: downloaderHeaders}
-	return downloader.DownloadWithConfig(path.String(), r.URL, downloadConfig)
+	return downloader.Download(path.String(), r.URL)
 }

arduino/resources/helpers_test.go

@@ -25,6 +25,7 @@ import (
 
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
+	"go.bug.st/downloader"
 )
 
 type EchoHandler struct{}
@@ -52,7 +53,10 @@ func TestDownloadApplyUserAgentHeaderUsingConfig(t *testing.T) {
 		URL:             srv.URL,
 	}
 
-	d, err := r.Download(tmp, http.Header{"User-Agent": []string{goldUserAgentValue}})
+	prev := downloader.GetDefaultConfig()
+	downloader.SetDefaultConfig(downloader.Config{RequestHeaders: http.Header{"User-Agent": []string{goldUserAgentValue}}})
+	d, err := r.Download(tmp)
+	downloader.SetDefaultConfig(prev)
 	require.NoError(t, err)
 	err = d.Run()
 	require.NoError(t, err)

arduino/resources/resources_test.go

@@ -18,7 +18,6 @@ package resources
 import (
 	"crypto"
 	"encoding/hex"
-	"net/http"
 	"testing"
 
 	"github.com/arduino/go-paths-helper"
@@ -42,7 +41,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	require.NoError(t, err)
 
 	downloadAndTestChecksum := func() {
-		d, err := r.Download(tmp, http.Header{})
+		d, err := r.Download(tmp)
 		require.NoError(t, err)
 		err = d.Run()
 		require.NoError(t, err)
@@ -58,7 +57,7 @@ func TestDownloadAndChecksums(t *testing.T) {
 	downloadAndTestChecksum()
 
 	// Download with cached file
-	d, err := r.Download(tmp, http.Header{})
+	d, err := r.Download(tmp)
 	require.NoError(t, err)
 	require.Nil(t, d)
 

cli/cli.go

@@ -18,6 +18,7 @@ package cli
 import (
 	"fmt"
 	"io/ioutil"
+	"net/url"
 	"os"
 	"path/filepath"
 	"strings"
@@ -45,6 +46,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	"go.bug.st/downloader"
 )
 
 var (
@@ -254,4 +256,12 @@ func preRun(cmd *cobra.Command, args []string) {
 			os.Exit(errorcodes.ErrBadCall)
 		})
 	}
+
+	//
+	// Configure network
+	//
+	netConf := downloader.Config{
+		RequestHeaders: globals.NewHTTPClientHeader(),
+	}
+	downloader.SetDefaultConfig(netConf)
 }

cli/core/download.go

@@ -66,8 +66,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 			Architecture:    platformRef.Architecture,
 			Version:         platformRef.Version,
 		}
-		_, err := core.PlatformDownload(context.Background(), platformDownloadreq, output.ProgressBar(),
-			globals.NewHTTPClientHeader())
+		_, err := core.PlatformDownload(context.Background(), platformDownloadreq, output.ProgressBar())
 		if err != nil {
 			feedback.Errorf("Error downloading %s: %v", args[i], err)
 			os.Exit(errorcodes.ErrNetwork)

cli/core/install.go

@@ -67,8 +67,7 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 			Architecture:    platformRef.Architecture,
 			Version:         platformRef.Version,
 		}
-		_, err := core.PlatformInstall(context.Background(), plattformInstallReq, output.ProgressBar(),
-			output.TaskProgress(), globals.NewHTTPClientHeader())
+		_, err := core.PlatformInstall(context.Background(), plattformInstallReq, output.ProgressBar(), output.TaskProgress())
 		if err != nil {
 			feedback.Errorf("Error during install: %v", err)
 			os.Exit(errorcodes.ErrGeneric)

cli/core/upgrade.go

@@ -93,7 +93,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
 			Architecture:    platformRef.Architecture,
 		}
 
-		_, err := core.PlatformUpgrade(context.Background(), r, output.ProgressBar(), output.TaskProgress(), globals.NewHTTPClientHeader())
+		_, err := core.PlatformUpgrade(context.Background(), r, output.ProgressBar(), output.TaskProgress())
 		if err == core.ErrAlreadyLatest {
 			feedback.Printf("Platform %s is already at the latest version", platformRef)
 		} else if err != nil {

cli/daemon/daemon.go

@@ -21,7 +21,6 @@ import (
 	"io"
 	"io/ioutil"
 	"net"
-	"net/http"
 	"os"
 	"runtime"
 	"syscall"
@@ -39,6 +38,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	"go.bug.st/downloader"
 	"google.golang.org/grpc"
 )
 
@@ -71,22 +71,19 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
 	port := viper.GetString("daemon.port")
 	s := grpc.NewServer()
 
-	// Compose user agent header
-	headers := http.Header{
-		"User-Agent": []string{
-			fmt.Sprintf("%s/%s daemon (%s; %s; %s) Commit:%s",
-				globals.VersionInfo.Application,
-				globals.VersionInfo.VersionString,
-				runtime.GOARCH,
-				runtime.GOOS,
-				runtime.Version(),
-				globals.VersionInfo.Commit),
-		},
-	}
-	// Register the commands service
+	// Set specific user-agent for the daemon
+	netConf := downloader.GetDefaultConfig()
+	netConf.RequestHeaders.Set("User-Agent",
+		fmt.Sprintf("%s/%s daemon (%s; %s; %s) Commit:%s",
+			globals.VersionInfo.Application,
+			globals.VersionInfo.VersionString,
+			runtime.GOARCH, runtime.GOOS,
+			runtime.Version(), globals.VersionInfo.Commit))
+	downloader.SetDefaultConfig(netConf)
+
+	// register the commands service
 	srv_commands.RegisterArduinoCoreServer(s, &daemon.ArduinoCoreServerImpl{
-		DownloaderHeaders: headers,
-		VersionString:     globals.VersionInfo.VersionString,
+		VersionString: globals.VersionInfo.VersionString,
 	})
 
 	// Register the monitors service

cli/instance/instance.go

@@ -18,7 +18,6 @@ package instance
 import (
 	"context"
 
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
@@ -45,8 +44,7 @@ func CreateInstance() (*rpc.Instance, error) {
 
 func getInitResponse() (*rpc.InitResp, error) {
 	// invoke Init()
-	resp, err := commands.Init(context.Background(), &rpc.InitReq{},
-		output.ProgressBar(), output.TaskProgress(), globals.NewHTTPClientHeader())
+	resp, err := commands.Init(context.Background(), &rpc.InitReq{}, output.ProgressBar(), output.TaskProgress())
 
 	// Init() failed
 	if err != nil {