Inlining methods in ArduinoCoreServiceImpl (part 12: UpdateLibrariesIndex)

Author: cmaglie

Diff for: commands/instances.go

@@ -420,9 +420,22 @@ func (s *arduinoCoreServerImpl) Destroy(ctx context.Context, req *rpc.DestroyReq
 	return &rpc.DestroyResponse{}, nil
 }
 
+// UpdateLibrariesIndexStreamResponseToCallbackFunction returns a gRPC stream to be used in UpdateLibrariesIndex that sends
+// all responses to the callback function.
+func UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx context.Context, downloadCB rpc.DownloadProgressCB) rpc.ArduinoCoreService_UpdateLibrariesIndexServer {
+	return streamResponseToCallback(ctx, func(r *rpc.UpdateLibrariesIndexResponse) error {
+		if r.GetDownloadProgress() != nil {
+			downloadCB(r.GetDownloadProgress())
+		}
+		return nil
+	})
+}
+
 // UpdateLibrariesIndex updates the library_index.json
-func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexRequest, downloadCB rpc.DownloadProgressCB) error {
-	logrus.Info("Updating libraries index")
+func (s *arduinoCoreServerImpl) UpdateLibrariesIndex(req *rpc.UpdateLibrariesIndexRequest, stream rpc.ArduinoCoreService_UpdateLibrariesIndexServer) error {
+	syncSend := NewSynchronizedSend(stream.Send)
+	downloadCB := func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.UpdateLibrariesIndexResponse{DownloadProgress: p}) }
+
 	pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
 	if err != nil {
 		return err
@@ -434,6 +447,8 @@ func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexRequ
 		return &cmderrors.PermissionDeniedError{Message: tr("Could not create index directory"), Cause: err}
 	}
 
+	// TODO: pass context
+	// ctx := stream.Context()
 	if err := globals.LibrariesIndexResource.Download(indexDir, downloadCB); err != nil {
 		return err
 	}
@@ -523,7 +538,8 @@ func firstUpdate(ctx context.Context, srv rpc.ArduinoCoreServiceServer, instance
 		// 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 {
+		stream := UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx, downloadCb)
+		if err := srv.UpdateLibrariesIndex(req, stream); err != nil {
 			return err
 		}
 	}

Diff for: commands/service.go

@@ -35,14 +35,6 @@ type arduinoCoreServerImpl struct {
 	versionString string
 }
 
-// UpdateLibrariesIndex FIXMEDOC
-func (s *arduinoCoreServerImpl) UpdateLibrariesIndex(req *rpc.UpdateLibrariesIndexRequest, stream rpc.ArduinoCoreService_UpdateLibrariesIndexServer) error {
-	syncSend := NewSynchronizedSend(stream.Send)
-	return UpdateLibrariesIndex(stream.Context(), req,
-		func(p *rpc.DownloadProgress) { syncSend.Send(&rpc.UpdateLibrariesIndexResponse{DownloadProgress: p}) },
-	)
-}
-
 // Version FIXMEDOC
 func (s *arduinoCoreServerImpl) Version(ctx context.Context, req *rpc.VersionRequest) (*rpc.VersionResponse, error) {
 	return &rpc.VersionResponse{Version: s.versionString}, nil

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

@@ -110,11 +110,9 @@ func runSearchCommand(srv rpc.ArduinoCoreServiceServer, args []string, namesOnly
 	logrus.Info("Executing `arduino-cli lib search`")
 
 	if indexNeedsUpdating(indexUpdateInterval) {
-		if err := commands.UpdateLibrariesIndex(
-			context.Background(),
-			&rpc.UpdateLibrariesIndexRequest{Instance: inst},
-			feedback.ProgressBar(),
-		); err != nil {
+		req := &rpc.UpdateLibrariesIndexRequest{Instance: inst}
+		stream := commands.UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+		if err := srv.UpdateLibrariesIndex(req, stream); err != nil {
 			feedback.Fatal(tr("Error updating library index: %v", err), feedback.ErrGeneric)
 		}
 		instance.Init(ctx, srv, inst)

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

@@ -46,15 +46,14 @@ func runUpdateIndexCommand(srv rpc.ArduinoCoreServiceServer) {
 	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli lib update-index`")
-	UpdateIndex(inst)
+	UpdateIndex(ctx, srv, inst)
 }
 
 // UpdateIndex updates the index of libraries.
-func UpdateIndex(inst *rpc.Instance) {
-	err := commands.UpdateLibrariesIndex(context.Background(), &rpc.UpdateLibrariesIndexRequest{
-		Instance: inst,
-	}, feedback.ProgressBar())
-	if err != nil {
+func UpdateIndex(ctx context.Context, srv rpc.ArduinoCoreServiceServer, inst *rpc.Instance) {
+	req := &rpc.UpdateLibrariesIndexRequest{Instance: inst}
+	stream := commands.UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+	if err := srv.UpdateLibrariesIndex(req, stream); err != nil {
 		feedback.Fatal(tr("Error updating library index: %v", err), feedback.ErrGeneric)
 	}
 }

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

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