Inlining methods in ArduinoCoreServiceImpl (part 12: UpdateLibrariesI…

…ndex)
arduino · cmaglie · May 15, 2024 · Mar 13, 2024 · Mar 13, 2024 · Mar 13, 2024
commit a3800fa2834b64f4a6586b92072f0af1b984d794
diff --git a/commands/instances.go b/commands/instances.go
@@ -422,47 +422,78 @@ 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, func() *rpc.UpdateLibrariesIndexResponse_Result) {
+	var result *rpc.UpdateLibrariesIndexResponse_Result
+	return streamResponseToCallback(ctx, func(r *rpc.UpdateLibrariesIndexResponse) error {
+			if r.GetDownloadProgress() != nil {
+				downloadCB(r.GetDownloadProgress())
+			}
+			if r.GetResult() != nil {
+				result = r.GetResult()
+			}
+			return nil
+		}), func() *rpc.UpdateLibrariesIndexResponse_Result {
+			return result
+		}
+}
+
 // UpdateLibrariesIndex updates the library_index.json
-func UpdateLibrariesIndex(ctx context.Context, req *rpc.UpdateLibrariesIndexRequest, downloadCB rpc.DownloadProgressCB) (*rpc.UpdateLibrariesIndexResponse_Result, 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{
+			Message: &rpc.UpdateLibrariesIndexResponse_DownloadProgress{DownloadProgress: p}})
+	}
 
 	pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
 	if err != nil {
-		return nil, err
+		return err
 	}
 	indexDir := pme.IndexDir
 	release()
-
 	index := globals.LibrariesIndexResource
-	result := func(status rpc.IndexUpdateReport_Status) *rpc.UpdateLibrariesIndexResponse_Result {
-		return &rpc.UpdateLibrariesIndexResponse_Result{
-			LibrariesIndex: &rpc.IndexUpdateReport{
-				IndexUrl: globals.LibrariesIndexResource.URL.String(),
-				Status:   status,
+
+	resultCB := func(status rpc.IndexUpdateReport_Status) {
+		syncSend.Send(&rpc.UpdateLibrariesIndexResponse{
+			Message: &rpc.UpdateLibrariesIndexResponse_Result_{
+				Result: &rpc.UpdateLibrariesIndexResponse_Result{
+					LibrariesIndex: &rpc.IndexUpdateReport{
+						IndexUrl: index.URL.String(),
+						Status:   status,
+					},
+				},
 			},
-		}
+		})
 	}
 
 	// Create the index directory if it doesn't exist
 	if err := indexDir.MkdirAll(); err != nil {
-		return result(rpc.IndexUpdateReport_STATUS_FAILED), &cmderrors.PermissionDeniedError{Message: tr("Could not create index directory"), Cause: err}
+		resultCB(rpc.IndexUpdateReport_STATUS_FAILED)
+		return &cmderrors.PermissionDeniedError{Message: tr("Could not create index directory"), Cause: err}
 	}
 
 	// Check if the index file is already up-to-date
 	indexFileName, _ := index.IndexFileName()
 	if info, err := indexDir.Join(indexFileName).Stat(); err == nil {
 		ageSecs := int64(time.Since(info.ModTime()).Seconds())
 		if ageSecs < req.GetUpdateIfOlderThanSecs() {
-			return result(rpc.IndexUpdateReport_STATUS_ALREADY_UP_TO_DATE), nil
+			resultCB(rpc.IndexUpdateReport_STATUS_ALREADY_UP_TO_DATE)
+			return nil
 		}
 	}
 
 	// Perform index update
+	// TODO: pass context
+	// ctx := stream.Context()
 	if err := globals.LibrariesIndexResource.Download(indexDir, downloadCB); err != nil {
-		return nil, err
+		resultCB(rpc.IndexUpdateReport_STATUS_FAILED)
+		return err
 	}
 
-	return result(rpc.IndexUpdateReport_STATUS_UPDATED), nil
+	resultCB(rpc.IndexUpdateReport_STATUS_UPDATED)
+	return nil
 }
 
 // UpdateIndexStreamResponseToCallbackFunction returns a gRPC stream to be used in UpdateIndex that sends
@@ -593,7 +624,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 --git a/commands/service.go b/commands/service.go
@@ -37,24 +37,6 @@ type arduinoCoreServerImpl struct {
 	versionString string
 }
 
-// UpdateLibrariesIndex FIXMEDOC
-func (s *arduinoCoreServerImpl) UpdateLibrariesIndex(req *rpc.UpdateLibrariesIndexRequest, stream rpc.ArduinoCoreService_UpdateLibrariesIndexServer) error {
-	syncSend := NewSynchronizedSend(stream.Send)
-	res, err := UpdateLibrariesIndex(stream.Context(), req,
-		func(p *rpc.DownloadProgress) {
-			syncSend.Send(&rpc.UpdateLibrariesIndexResponse{
-				Message: &rpc.UpdateLibrariesIndexResponse_DownloadProgress{DownloadProgress: p},
-			})
-		},
-	)
-	if res != nil {
-		syncSend.Send(&rpc.UpdateLibrariesIndexResponse{
-			Message: &rpc.UpdateLibrariesIndexResponse_Result_{Result: res},
-		})
-	}
-	return err
-}
-
    // Version FIXMEDOC
 func (s *arduinoCoreServerImpl) Version(ctx context.Context, req *rpc.VersionRequest) (*rpc.VersionResponse, error) {
 	return &rpc.VersionResponse{Version: s.versionString}, nil

diff --git a/internal/cli/lib/search.go b/internal/cli/lib/search.go
@@ -107,15 +107,12 @@ func runSearchCommand(srv rpc.ArduinoCoreServiceServer, args []string, namesOnly
 
 	logrus.Info("Executing `arduino-cli lib search`")
 
-	res, err := commands.UpdateLibrariesIndex(
-		context.Background(),
-		&rpc.UpdateLibrariesIndexRequest{Instance: inst, UpdateIfOlderThanSecs: int64(indexUpdateInterval.Seconds())},
-		feedback.ProgressBar(),
-	)
-	if err != nil {
+	stream, res := commands.UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+	req := &rpc.UpdateLibrariesIndexRequest{Instance: inst, UpdateIfOlderThanSecs: int64(indexUpdateInterval.Seconds())}
+	if err := srv.UpdateLibrariesIndex(req, stream); err != nil {
 		feedback.Fatal(tr("Error updating library index: %v", err), feedback.ErrGeneric)
 	}
-	if res.GetLibrariesIndex().GetStatus() == rpc.IndexUpdateReport_STATUS_UPDATED {
+	if res().GetLibrariesIndex().GetStatus() == rpc.IndexUpdateReport_STATUS_UPDATED {
 		instance.Init(ctx, srv, inst)
 	}
 

diff --git a/internal/cli/lib/update_index.go b/internal/cli/lib/update_index.go
@@ -47,19 +47,18 @@ func runUpdateIndexCommand(srv rpc.ArduinoCoreServiceServer) {
 	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli lib update-index`")
-	resp := UpdateIndex(inst)
+	resp := UpdateIndex(ctx, srv, inst)
 	feedback.PrintResult(&libUpdateIndexResult{result.NewUpdateLibrariesIndexResponse_ResultResult(resp)})
 }
 
 // UpdateIndex updates the index of libraries.
-func UpdateIndex(inst *rpc.Instance) *rpc.UpdateLibrariesIndexResponse_Result {
-	resp, 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) *rpc.UpdateLibrariesIndexResponse_Result {
+	req := &rpc.UpdateLibrariesIndexRequest{Instance: inst}
+	stream, resp := commands.UpdateLibrariesIndexStreamResponseToCallbackFunction(ctx, feedback.ProgressBar())
+	if err := srv.UpdateLibrariesIndex(req, stream); err != nil {
 		feedback.Fatal(tr("Error updating library index: %v", err), feedback.ErrGeneric)
 	}
-	return resp
+	return resp()
 }
 
 type libUpdateIndexResult struct {

diff --git a/internal/cli/update/update.go b/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 {