Release: go-algorand 3.7.0-beta Release PR

.circleci/config.yml

@@ -198,7 +198,7 @@ commands:
           shell: bash.exe
           command: |
             choco install -y msys2 pacman make wget --force
-            choco install -y golang --version=1.16.15 --force
+            choco install -y golang --version=1.17.9 --force
             choco install -y python3 --version=3.7.3 --force
             export msys2='cmd //C RefreshEnv.cmd '
             export msys2+='& set MSYS=winsymlinks:nativestrict '

.codecov.yml

@@ -0,0 +1,18 @@
+codecov:
+  require_ci_to_pass: yes
+
+ignore:
+  - "**/*_gen.go"
+  - "**/*_gen_test.go"
+  - "**/generated"
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        informational: true
+    patch:
+      default:
+        target: auto
+        informational: true

.github/workflows/README.md

@@ -0,0 +1,26 @@
+# Github Actions Workflows
+
+## Benchmarking Performance Tests
+`benchmarks.yml` contains a workflow to check for any performance regressions or
+improvements in benchmark tests. 
+
+It uses
+[github-action-benchmark](https://github.com/benchmark-action/github-action-benchmark)
+to check performance diffs between a PR and the `master` branch, comments if it
+there is a regression past a certain threshold (default: `200%`), and generates
+a performance diff JSON between consecutive commits in the `master` branch in
+the `gh-pages` branch (the JSON is visualized into a graph that can be seen at:
+https://algorand.github.io/go-algorand/dev/bench/).
+
+### Adding benchmark tests
+Add run steps or extend existing benchmark invocations in the `Run benchmark`
+step. Additional benchmarks can be run using the `-bench` flag. Since there's
+few benchmarks run by the workflow, there are _no_ formal groupings and/or
+naming conventions.
+
+### CI Variance
+There may be some variance between runs because github actions might spin up a
+different machine each time (e.g. Intel Xeon 8370C vs 8171M; the latter might
+run benchmarks slightly slower). Empirically, the variance seems to be 10~30%
+for the most part. Due to this environment variance, the workflow is most
+suitable for finding _large_ performance degradations.

.github/workflows/benchmarks.yml

@@ -0,0 +1,51 @@
+name: "Benchmark workflow"
+on:
+  # Push and update benchmarks when a commit is merged into master.
+  push:
+    branches:
+      - master
+  # Trigger benchmark test on this PR's commit against master.
+  pull_request:
+    branches:
+      - master
+permissions:
+  # Push benchmark performance graph to gh-pages branch.
+  contents: write
+  deployments: write
+jobs:
+  benchmark:
+    name: Performance regression check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version-file: 'go.mod'
+      - run: go version
+      - name: Build go-algorand
+        run: scripts/travis/build.sh
+      # BenchmarkUintMath - Serves as a proxy for AVM `eval` performance.
+      # Performance degradations suggest either or both:  (1) op code
+      # degradation, (2) `eval` degradation.  (2) suggests a broader performance
+      # issue. 
+      - name: Run benchmark
+        run: go test ./data/transactions/logic -bench 'BenchmarkUintMath' | tee benchmark_output.txt
+      - name: Push benchmark result to gh-pages branch
+        if: github.event_name == 'push'
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Go Benchmark
+          tool: 'go'
+          output-file-path: benchmark_output.txt
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+      - name: Evaluate benchmark on PR branch
+        if: github.event.pull_request
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Go Benchmark
+          tool: 'go'
+          output-file-path: benchmark_output.txt
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          alert-threshold: '200%'
+          comment-on-alert: true

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install golang
         uses: actions/setup-go@v2
         with:
-          go-version: '1.16.15'
+          go-version: '1.17.9'
       - name: Build Test
         run: |
           export ALGORAND_DEADLOCK=enable

.github/workflows/reviewdog.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Install specific golang
         uses: actions/setup-go@v2
         with:
-          go-version: '1.16.15'
+          go-version: '1.17.9'
       - name: Create folders for golangci-lint
         run: mkdir -p cicdtmp/golangci-lint
       - name: Check if custom golangci-lint is already built

Makefile

@@ -36,6 +36,13 @@ else
 export GOTESTCOMMAND=gotestsum --format pkgname --jsonfile testresults.json --
 endif
 
+# M1 Mac--homebrew install location in /opt/homebrew
+ifeq ($(OS_TYPE), darwin)
+ifeq ($(ARCH), arm64)
+export CPATH=/opt/homebrew/include
+export LIBRARY_PATH=/opt/homebrew/lib
+endif
+endif
 ifeq ($(UNAME), Linux)
 EXTLDFLAGS := -static-libstdc++ -static-libgcc
 ifeq ($(ARCH), amd64)

agreement/fuzzer/bandwidthFilter_test.go

@@ -167,7 +167,7 @@ func (n *BandwidthFilter) Tick(newClockTime int) bool {
 	n.downstreamMutex.Lock()
 	if n.downstreamDataSize < 0 && n.downstreamQueue.Len() == 0 {
 		if n.debugMessageLevel >= 1 {
-			fmt.Printf("node: %d, tick: %d, reseting queued downstream capacity %d -> 0\n", n.nodeID, n.currentTick, n.upstreamDataSize)
+			fmt.Printf("node: %d, tick: %d, resetting queued downstream capacity %d -> 0\n", n.nodeID, n.currentTick, n.upstreamDataSize)
 		}
 		n.downstreamDataSize = 0
 	}
@@ -179,7 +179,7 @@ func (n *BandwidthFilter) Tick(newClockTime int) bool {
 	// adjust the upstream size.
 	if n.upstreamDataSize < 0 && n.upstreamQueue.Len() == 0 {
 		if n.debugMessageLevel >= 1 {
-			fmt.Printf("node: %d, tick: %d, reseting queued upstream capacity %d -> 0\n", n.nodeID, n.currentTick, n.upstreamDataSize)
+			fmt.Printf("node: %d, tick: %d, resetting queued upstream capacity %d -> 0\n", n.nodeID, n.currentTick, n.upstreamDataSize)
 		}
 		n.upstreamDataSize = 0
 	}

agreement/gossip/network.go

@@ -32,9 +32,11 @@ import (
 )
 
 var messagesHandledTotal = metrics.MakeCounter(metrics.AgreementMessagesHandled)
-var messagesHandledByType = metrics.NewTagCounter("algod_agreement_handled_{TAG}", "Number of agreement messages handled per type")
+var messagesHandledByType = metrics.NewTagCounter("algod_agreement_handled_{TAG}", "Number of agreement {TAG} messages handled",
+	agreementVoteMessageType, agreementProposalMessageType, agreementBundleMessageType)
 var messagesDroppedTotal = metrics.MakeCounter(metrics.AgreementMessagesDropped)
-var messagesDroppedByType = metrics.NewTagCounter("algod_agreement_dropped_{TAG}", "Number of agreement messages handled per type")
+var messagesDroppedByType = metrics.NewTagCounter("algod_agreement_dropped_{TAG}", "Number of agreement {TAG} messages dropped",
+	agreementVoteMessageType, agreementProposalMessageType, agreementBundleMessageType)
 
 const (
 	agreementVoteMessageType     = "vote"