Inlining methods in ArduinoCoreServiceImpl (part 7: UpdateIndex)

Added helpers to get download progress.

Author: cmaglie

Diff for: commands/instances.go

@@ -182,7 +182,8 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 			allPackageIndexUrls = append(allPackageIndexUrls, URL)
 		}
 	}
-	if err := firstUpdate(context.Background(), req.GetInstance(), downloadCallback, allPackageIndexUrls); err != nil {
+
+	if err := firstUpdate(context.Background(), s, req.GetInstance(), downloadCallback, allPackageIndexUrls); err != nil {
 		e := &cmderrors.InitFailedError{
 			Code:   codes.InvalidArgument,
 			Cause:  err,
@@ -440,12 +441,27 @@ func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexRequ
 	return nil
 }
 
+// UpdateIndexStreamResponseToCallbackFunction returns a gRPC stream to be used in UpdateIndex that sends
+// all responses to the callback function.
+func UpdateIndexStreamResponseToCallbackFunction(ctx context.Context, downloadCB rpc.DownloadProgressCB) rpc.ArduinoCoreService_UpdateIndexServer {
+	return streamResponseToCallback(ctx, func(r *rpc.UpdateIndexResponse) error {
+		if r.GetDownloadProgress() != nil {
+			downloadCB(r.GetDownloadProgress())
+		}
+		return nil
+	})
+}
+
 // UpdateIndex FIXMEDOC
-func UpdateIndex(ctx context.Context, req *rpc.UpdateIndexRequest, downloadCB rpc.DownloadProgressCB) error {
+func (s *arduinoCoreServerImpl) UpdateIndex(req *rpc.UpdateIndexRequest, stream rpc.ArduinoCoreService_UpdateIndexServer) error {
 	if !instances.IsValid(req.GetInstance()) {
 		return &cmderrors.InvalidInstanceError{}
 	}
 
+	syncSend := NewSynchronizedSend(stream.Send)
+	var downloadCB rpc.DownloadProgressCB = func(p *rpc.DownloadProgress) {
+		syncSend.Send(&rpc.UpdateIndexResponse{DownloadProgress: p})
+	}
 	indexpath := configuration.DataDir(configuration.Settings)
 
 	urls := []string{globals.DefaultIndexURL}
@@ -498,7 +514,7 @@ func UpdateIndex(ctx context.Context, req *rpc.UpdateIndexRequest, downloadCB rp
 
 // 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), externalPackageIndexes []*url.URL) error {
+func firstUpdate(ctx context.Context, srv rpc.ArduinoCoreServiceServer, instance *rpc.Instance, downloadCb func(msg *rpc.DownloadProgress), externalPackageIndexes []*url.URL) 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")
@@ -529,7 +545,8 @@ func firstUpdate(ctx context.Context, instance *rpc.Instance, downloadCb func(ms
 			// library update we download that file and all the other package indexes from
 			// additional_urls
 			req := &rpc.UpdateIndexRequest{Instance: instance}
-			if err := UpdateIndex(ctx, req, downloadCb); err != nil {
+			stream := UpdateIndexStreamResponseToCallbackFunction(ctx, downloadCb)
+			if err := srv.UpdateIndex(req, stream); err != nil {
 				return err
 			}
 			break

Diff for: commands/service.go

@@ -40,14 +40,6 @@ type arduinoCoreServerImpl struct {
 	versionString string
 }
 
-// UpdateIndex FIXMEDOC
-func (s *arduinoCoreServerImpl) UpdateIndex(req *rpc.UpdateIndexRequest, stream rpc.ArduinoCoreService_UpdateIndexServer) error {
-	syncSend := NewSynchronizedSend(stream.Send)
-	return UpdateIndex(stream.Context(), req,
-		func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.UpdateIndexResponse{DownloadProgress: p}) },
-	)
-}
-
 // UpdateLibrariesIndex FIXMEDOC
 func (s *arduinoCoreServerImpl) UpdateLibrariesIndex(req *rpc.UpdateLibrariesIndexRequest, stream rpc.ArduinoCoreService_UpdateLibrariesIndexServer) error {
 	syncSend := NewSynchronizedSend(stream.Send)

Diff for: internal/cli/core/search.go

@@ -61,7 +61,8 @@ func runSearchCommand(srv rpc.ArduinoCoreServiceServer, args []string, allVersio
 	inst := instance.CreateAndInit(ctx, srv)
 
 	if indexesNeedUpdating(indexUpdateInterval) {
-		err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{Instance: inst}, feedback.ProgressBar())
+		stream := commands.UpdateIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+		err := srv.UpdateIndex(&rpc.UpdateIndexRequest{Instance: inst}, stream)
 		if err != nil {
 			feedback.FatalError(err, feedback.ErrGeneric)
 		}

Diff for: internal/cli/core/update_index.go

@@ -46,12 +46,13 @@ func runUpdateIndexCommand(srv rpc.ArduinoCoreServiceServer) {
 	ctx := context.Background()
 	inst := instance.CreateAndInit(ctx, srv)
 
-	UpdateIndex(inst)
+	UpdateIndex(ctx, srv, inst)
 }
 
 // UpdateIndex updates the index of platforms.
-func UpdateIndex(inst *rpc.Instance) {
-	err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{Instance: inst}, feedback.ProgressBar())
+func UpdateIndex(ctx context.Context, srv rpc.ArduinoCoreServiceServer, inst *rpc.Instance) {
+	stream := commands.UpdateIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+	err := srv.UpdateIndex(&rpc.UpdateIndexRequest{Instance: inst}, stream)
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}

Diff for: internal/cli/update/update.go

@@ -54,7 +54,7 @@ func runUpdateCommand(srv rpc.ArduinoCoreServiceServer, showOutdated bool) {
 	inst := instance.CreateAndInit(ctx, srv)
 
 	lib.UpdateIndex(inst)
-	core.UpdateIndex(inst)
+	core.UpdateIndex(ctx, srv, inst)
 	instance.Init(ctx, srv, inst)
 	if showOutdated {
 		outdated.Outdated(inst)