Perform first-update automatically in gRPC Init

Author: cmaglie

commands/instances.go

@@ -240,6 +240,9 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		})
 	}
 
+	// Perform first-update of indexes if needed
+	firstUpdate(context.Background(), req.GetInstance(), downloadCallback)
+
 	// Try to extract profile if specified
 	var profile *sketch.Profile
 	if req.GetProfile() != "" {
@@ -595,3 +598,33 @@ func LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketc
 		RootFolderFiles:  rootFolderFiles,
 	}, nil
 }
+
+// firstUpdate downloads libraries and packages indexes if they don't exist.
+// This ideally is only executed the first time the CLI is run.
+func firstUpdate(ctx context.Context, instance *rpc.Instance, downloadCb func(msg *rpc.DownloadProgress)) error {
+	// Gets the data directory to verify if library_index.json and package_index.json exist
+	dataDir := configuration.DataDir(configuration.Settings)
+	libraryIndex := dataDir.Join("library_index.json")
+	packageIndex := dataDir.Join("package_index.json")
+
+	if libraryIndex.NotExist() {
+		// The library_index.json file doesn't exists, that means the CLI is run for the first time
+		// so we proceed with the first update that downloads the file
+		req := &rpc.UpdateLibrariesIndexRequest{Instance: instance}
+		if err := UpdateLibrariesIndex(ctx, req, downloadCb); err != nil {
+			return err
+		}
+	}
+
+	if packageIndex.NotExist() {
+		// The package_index.json file doesn't exists, that means the CLI is run for the first time,
+		// similarly to the library update we download that file and all the other package indexes
+		// from additional_urls
+		req := &rpc.UpdateIndexRequest{Instance: instance, IgnoreCustomPackageIndexes: true}
+		if err := UpdateIndex(ctx, req, downloadCb); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

internal/cli/core/update_index.go

@@ -40,7 +40,7 @@ func initUpdateIndexCommand() *cobra.Command {
 }
 
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
-	inst := instance.CreateInstanceAndRunFirstUpdate()
+	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli core update-index`")
 	UpdateIndex(inst)
 }

internal/cli/instance/instance.go

@@ -16,10 +16,7 @@
 package instance
 
 import (
-	"context"
-
 	"github.com/arduino/arduino-cli/commands"
-	"github.com/arduino/arduino-cli/configuration"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -71,12 +68,6 @@ func Init(instance *rpc.Instance) {
 // 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 {
-	// In case the CLI is executed for the first time
-	if err := FirstUpdate(instance); err != nil {
-		feedback.Warning(tr("Error initializing instance: %v", err))
-		return nil
-	}
-
 	downloadCallback := feedback.ProgressBar()
 	taskCallback := feedback.TaskProgress()
 
@@ -110,70 +101,3 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 
 	return profile
 }
-
-// FirstUpdate downloads libraries and packages indexes if they don't exist.
-// This ideally is only executed the first time the CLI is run.
-func FirstUpdate(instance *rpc.Instance) error {
-	// Gets the data directory to verify if library_index.json and package_index.json exist
-	dataDir := configuration.DataDir(configuration.Settings)
-
-	libraryIndex := dataDir.Join("library_index.json")
-	packageIndex := dataDir.Join("package_index.json")
-
-	if libraryIndex.Exist() && packageIndex.Exist() {
-		return nil
-	}
-
-	// The library_index.json file doesn't exists, that means the CLI is run for the first time
-	// so we proceed with the first update that downloads the file
-	if libraryIndex.NotExist() {
-		err := commands.UpdateLibrariesIndex(context.Background(),
-			&rpc.UpdateLibrariesIndexRequest{
-				Instance: instance,
-			},
-			feedback.ProgressBar(),
-		)
-		if err != nil {
-			return err
-		}
-	}
-
-	// The package_index.json file doesn't exists, that means the CLI is run for the first time,
-	// similarly to the library update we download that file and all the other package indexes
-	// from additional_urls
-	if packageIndex.NotExist() {
-		err := commands.UpdateIndex(context.Background(),
-			&rpc.UpdateIndexRequest{
-				Instance:                   instance,
-				IgnoreCustomPackageIndexes: true,
-			},
-			feedback.ProgressBar())
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// CreateInstanceAndRunFirstUpdate creates an instance and runs `FirstUpdate`.
-// It is mandatory for all `update-index` commands to call this
-func CreateInstanceAndRunFirstUpdate() *rpc.Instance {
-	// We don't initialize any CoreInstance when updating indexes since we don't need to.
-	// Also meaningless errors might be returned when calling this command with --additional-urls
-	// since the CLI would be searching for a corresponding file for the additional urls set
-	// as argument but none would be obviously found.
-	inst, status := Create()
-	if status != nil {
-		feedback.Fatal(tr("Error creating instance: %v", status), feedback.ErrGeneric)
-	}
-
-	// In case this is the first time the CLI is run we need to update indexes
-	// to make it work correctly, we must do this explicitly in this command since
-	// we must use instance.Create instead of instance.CreateAndInit for the
-	// reason stated above.
-	if err := FirstUpdate(inst); err != nil {
-		feedback.Fatal(tr("Error updating indexes: %v", err), feedback.ErrGeneric)
-	}
-	return inst
-}

internal/cli/lib/update_index.go

@@ -40,7 +40,7 @@ func initUpdateIndexCommand() *cobra.Command {
 }
 
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
-	inst := instance.CreateInstanceAndRunFirstUpdate()
+	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli lib update-index`")
 	UpdateIndex(inst)
 }

internal/cli/update/update.go

@@ -47,7 +47,7 @@ func NewCommand() *cobra.Command {
 }
 
 func runUpdateCommand(showOutdated bool) {
-	inst := instance.CreateInstanceAndRunFirstUpdate()
+	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli update`")
 	lib.UpdateIndex(inst)
 	core.UpdateIndex(inst)

internal/integrationtest/daemon/daemon_test.go

@@ -111,9 +111,6 @@ func createEnvForDaemon(t *testing.T) (*integrationtest.Environment, *integratio
 		UseSharedStagingFolder: true,
 	})
 
-	_, _, err := cli.Run("core", "update-index")
-	require.NoError(t, err)
-
 	_ = cli.StartDaemon(false)
 	return env, cli
 }