Merge pull request #523 from onflow/feature/deploy-update-smarter

Feature/deploy update smarter

Author: devbugging

docs/deploy-project-contracts.md

@@ -180,9 +180,8 @@ in the `admin-account` account in `accounts` field of the configuration, the res
 - Valid inputs: `true`, `false`
 - Default: `false`
 
-Indicate whether to overwrite and upgrade existing contracts.
-
-⚠️ _Warning: contract upgrades are a dangerous experimental feature._
+Indicate whether to overwrite and upgrade existing contracts. Only contracts with difference with existing contracts
+will be overwritten.
 
 ### Host
 

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/getsentry/sentry-go v0.13.0
 	github.com/go-git/go-git/v5 v5.4.2
 	github.com/gosuri/uilive v0.0.4
+	github.com/hexops/gotextdiff v1.0.3
 	github.com/joho/godotenv v1.4.0
 	github.com/manifoldco/promptui v0.9.0
 	github.com/onflow/cadence v0.24.3

go.sum

@@ -656,6 +656,8 @@ github.com/hashicorp/memberlist v0.3.0/go.mod h1:MS2lj3INKhZjWNqd3N0m3J+Jxf3DAOn
 github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc=
 github.com/hashicorp/serf v0.9.5/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk=
 github.com/hashicorp/serf v0.9.6/go.mod h1:TXZNMjZQijwlDvp+r0b63xZ45H7JmCmgg4gpTwn9UV4=
+github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
+github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/hudl/fargo v1.3.0/go.mod h1:y3CKSmjA+wD2gak7sUSXTAoopbhU08POFhmITJgmKTg=
 github.com/huin/goupnp v0.0.0-20161224104101-679507af18f3/go.mod h1:MZ2ZmwcBpvOoJ22IJsc7va19ZwoheaBk43rKg12SKag=

pkg/flowkit/contracts/contracts.go

@@ -83,6 +83,10 @@ func (c *Contract) Name() string {
 	return c.name
 }
 
+func (c *Contract) Source() string {
+	return c.source
+}
+
 func (c *Contract) Code() string {
 	return c.code
 }

pkg/flowkit/services/project.go

@@ -19,6 +19,7 @@
 package services
 
 import (
+	"bytes"
 	"fmt"
 	"strings"
 
@@ -155,6 +156,7 @@ func (p *Project) Deploy(network string, update bool) ([]*contracts.Contract, er
 	defer p.logger.StopProgress()
 
 	deployErr := false
+	numOfUpdates := 0
 	for _, contract := range orderedContracts {
 		block, err := p.gateway.GetLatestBlock()
 		if err != nil {
@@ -184,7 +186,9 @@ func (p *Project) Deploy(network string, update bool) ([]*contracts.Contract, er
 			return nil, err
 		}
 		// check if contract exists on account
-		_, exists := targetAccountInfo.Contracts[contract.Name()]
+		existingContract, exists := targetAccountInfo.Contracts[contract.Name()]
+		noDiffInContract := bytes.Equal([]byte(contract.Code()), existingContract)
+
 		if exists && !update {
 			p.logger.Error(fmt.Sprintf(
 				"contract %s is already deployed to this account. Use the --update flag to force update",
@@ -200,10 +204,19 @@ func (p *Project) Deploy(network string, update bool) ([]*contracts.Contract, er
 			deployErr = true
 			continue
 		} else if exists {
+			//only update contract if there is diff
+			if noDiffInContract {
+				p.logger.Info(fmt.Sprintf(
+					"no diff found in %s, skipping update",
+					contract.Name(),
+				))
+				continue
+			}
 			tx, err = flowkit.NewUpdateAccountContractTransaction(targetAccount, contract.Name(), contract.TranspiledCode())
 			if err != nil {
 				return nil, err
 			}
+			numOfUpdates++
 		}
 
 		tx.SetBlockReference(block)
@@ -246,25 +259,41 @@ func (p *Project) Deploy(network string, update bool) ([]*contracts.Contract, er
 		if result.Error != nil {
 			deployErr = true
 			p.logger.StopProgress()
-			p.logger.Error(fmt.Sprintf(
-				"Error deploying %s: (%s)\n",
-				output.Red(contract.Name()),
-				result.Error.Error(),
-			))
+			if exists && update {
+				p.logger.Error(fmt.Sprintf(
+					"Error updating %s: (%s)\n",
+					output.Red(contract.Name()),
+					result.Error.Error(),
+				))
+			} else {
+				p.logger.Error(fmt.Sprintf(
+					"Error deploying %s: (%s)\n",
+					output.Red(contract.Name()),
+					result.Error.Error(),
+				))
+			}
 		}
 
 		if result.Error == nil && !deployErr {
+			changeStatus := ""
+			if exists && update {
+				changeStatus = "(update)"
+			}
 			p.logger.StopProgress()
 			p.logger.Info(fmt.Sprintf(
-				"%s -> 0x%s (%s)\n",
+				"%s -> 0x%s (%s) %s\n",
 				output.Green(contract.Name()),
 				contract.Target(),
 				sentTx.ID().String(),
+				changeStatus,
 			))
 		}
 	}
 
 	if !deployErr {
+		if update && numOfUpdates > 0 {
+			p.logger.Info(fmt.Sprintf("%d contracts updated successfully", numOfUpdates))
+		}
 		p.logger.Info(fmt.Sprintf("\n%s All contracts deployed successfully", output.SuccessEmoji()))
 	} else {
 		err = fmt.Errorf("failed to deploy all contracts")