From 58d840fb656face1c9f9e6d82883c2d8e865eba5 Mon Sep 17 00:00:00 2001
From: Ljubisa <ljubisa.rs@gmail.com>
Date: Thu, 19 Oct 2023 12:08:18 +0200
Subject: [PATCH] refactor(setup-cluster): improve code and add comments

---
 cmd/beekeeper/cmd/cluster.go | 57 +++++++++++++++++++++---------------
 1 file changed, 34 insertions(+), 23 deletions(-)

diff --git a/cmd/beekeeper/cmd/cluster.go b/cmd/beekeeper/cmd/cluster.go
index aab5ed892..c9e8116b4 100644
--- a/cmd/beekeeper/cmd/cluster.go
+++ b/cmd/beekeeper/cmd/cluster.go
@@ -134,38 +134,50 @@ func (c *command) setupCluster(ctx context.Context, clusterName string, cfg *con
 	}
 
 	fundOpts := clusterConfig.Funding.Export()
-	clusterOpts := clusterConfig.Export()
-	clusterOpts.K8SClient = c.k8sClient
-	clusterOpts.SwapClient = c.swapClient
 
-	cluster = orchestrationK8S.NewCluster(clusterConfig.GetName(), clusterOpts, c.log)
+	cluster = configureCluster(clusterConfig, c, cluster)
 
 	nodeResultChan := make(chan nodeResult)
 	defer close(nodeResultChan)
 
+	// setup bootnode node group
 	fundAddresses, bootnodes, err := setupNodes(ctx, clusterConfig, cfg, true, cluster, startCluster, "", nodeResultChan)
 	if err != nil {
 		return nil, fmt.Errorf("setup node group bootnode: %w", err)
 	}
 
-	err = fund(ctx, startCluster, err, fundAddresses, chainNodeEndpoint, walletKey, fundOpts)
-	if err != nil {
-		return nil, fmt.Errorf("funding node group bootnode: %w", err)
+	// fund bootnode node group if cluster is started
+	if startCluster {
+		err = fund(ctx, fundAddresses, chainNodeEndpoint, walletKey, fundOpts)
+		if err != nil {
+			return nil, fmt.Errorf("funding node group bootnode: %w", err)
+		}
 	}
 
+	// setup other node groups
 	fundAddresses, _, err = setupNodes(ctx, clusterConfig, cfg, false, cluster, startCluster, bootnodes, nodeResultChan)
 	if err != nil {
 		return nil, fmt.Errorf("setup other node groups: %w", err)
 	}
 
-	err = fund(ctx, startCluster, err, fundAddresses, chainNodeEndpoint, walletKey, fundOpts)
-	if err != nil {
-		return nil, fmt.Errorf("fund other node groups: %w", err)
+	// fund other node groups if cluster is started
+	if startCluster {
+		err = fund(ctx, fundAddresses, chainNodeEndpoint, walletKey, fundOpts)
+		if err != nil {
+			return nil, fmt.Errorf("fund other node groups: %w", err)
+		}
 	}
 
 	return
 }
 
+func configureCluster(clusterConfig config.Cluster, c *command, cluster orchestration.Cluster) orchestration.Cluster {
+	clusterOpts := clusterConfig.Export()
+	clusterOpts.K8SClient = c.k8sClient
+	clusterOpts.SwapClient = c.swapClient
+	return orchestrationK8S.NewCluster(clusterConfig.GetName(), clusterOpts, c.log)
+}
+
 func setupNodes(ctx context.Context, clusterConfig config.Cluster, cfg *config.Config, bootnode bool, cluster orchestration.Cluster, startCluster bool, bootnodesIn string, nodeResultCh chan nodeResult) (fundAddresses []string, bootnodesOut string, err error) {
 	var nodeCount uint32
 	fundOpts := clusterConfig.Funding.Export()
@@ -232,6 +244,8 @@ func setupNodes(ctx context.Context, clusterConfig config.Cluster, cfg *config.C
 		}
 	}
 
+	// wait for nodes to be setup and get their eth addresses
+	// or wait for nodes to be added and check for errors
 	for i := uint32(0); i < nodeCount; i++ {
 		nodeResult := <-nodeResultCh
 		if nodeResult.err != nil {
@@ -279,17 +293,14 @@ func setupNodeOptions(node config.ClusterNode, bConfig *orchestration.Config) or
 	return nOptions
 }
 
-func fund(ctx context.Context, startCluster bool, err error, fundAddresses []string, chainNodeEndpoint string, walletKey string, fundOpts orchestration.FundingOptions) error {
-	if startCluster {
-		return funder.Fund(ctx, funder.Config{
-			Addresses:         fundAddresses,
-			ChainNodeEndpoint: chainNodeEndpoint,
-			WalletKey:         walletKey,
-			MinAmounts: funder.MinAmounts{
-				NativeCoin: fundOpts.Eth,
-				SwarmToken: fundOpts.Bzz,
-			},
-		}, nil, nil)
-	}
-	return nil
+func fund(ctx context.Context, fundAddresses []string, chainNodeEndpoint string, walletKey string, fundOpts orchestration.FundingOptions) error {
+	return funder.Fund(ctx, funder.Config{
+		Addresses:         fundAddresses,
+		ChainNodeEndpoint: chainNodeEndpoint,
+		WalletKey:         walletKey,
+		MinAmounts: funder.MinAmounts{
+			NativeCoin: fundOpts.Eth,
+			SwarmToken: fundOpts.Bzz,
+		},
+	}, nil, nil)
 }