Skip to content

Commit 43a82a4

Browse files
collateral-damagercollateral-damager
committed
Merge remote-tracking branch 'upstream/main' into iter-err
2 parents 8bde958 + 5f936ab commit 43a82a4

28 files changed

Lines changed: 551 additions & 220 deletions

‎.github/workflows/bench.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Benchmark
2+
3+
on:
4+
pull_request:
5+
branches: [ "main" ]
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
go-bench:
12+
strategy:
13+
matrix:
14+
go-version: [ '1.20', 'stable' ]
15+
runs-on: ubuntu-latest
16+
timeout-minutes: 15
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v3
20+
with:
21+
fetch-depth: 0 # to be able to retrieve the last commit in main
22+
23+
- name: Set up Go
24+
uses: actions/setup-go@v5
25+
with:
26+
go-version: ${{ matrix.go-version }}
27+
28+
- name: Run benchmark and store the output to a file
29+
run: |
30+
set -o pipefail
31+
make bench | tee ${{ github.sha }}_bench_output.txt
32+
33+
- name: Get CPU information
34+
uses: kenchan0130/actions-system-info@v1.2.1
35+
id: system-info
36+
37+
- name: Get Main branch SHA
38+
id: get-main-branch-sha
39+
run: |
40+
SHA=$(git rev-parse origin/main)
41+
echo "sha=$SHA" >> $GITHUB_OUTPUT
42+
43+
- name: Get benchmark JSON from main branch
44+
id: cache
45+
uses: actions/cache/restore@v3
46+
with:
47+
path: ./cache/benchmark-data.json
48+
key: ${{ steps.get-main-branch-sha.outputs.sha }}-${{ runner.os }}-${{ steps.system-info.outputs.cpu-model }}-go-benchmark
49+
50+
- name: Compare benchmarks with Main
51+
uses: benchmark-action/github-action-benchmark@v1
52+
if: steps.cache.outputs.cache-hit == 'true'
53+
with:
54+
# What benchmark tool the output.txt came from
55+
tool: 'go'
56+
# Where the output from the benchmark tool is stored
57+
output-file-path: ${{ github.sha }}_bench_output.txt
58+
# Where the benchmarks in main are (to compare)
59+
external-data-json-path: ./cache/benchmark-data.json
60+
# Do not save the data
61+
save-data-file: false
62+
# Workflow will fail when an alert happens
63+
fail-on-alert: true
64+
github-token: ${{ secrets.GITHUB_TOKEN }}
65+
# Enable Job Summary for PRs
66+
summary-always: true
67+
68+
- name: Run benchmarks but don't compare to Main branch
69+
uses: benchmark-action/github-action-benchmark@v1
70+
if: steps.cache.outputs.cache-hit != 'true'
71+
with:
72+
# What benchmark tool the output.txt came from
73+
tool: 'go'
74+
# Where the output from the benchmark tool is stored
75+
output-file-path: ${{ github.sha }}_bench_output.txt
76+
# Write benchmarks to this file, do not publish to GitHub Pages
77+
save-data-file: false
78+
external-data-json-path: ./cache/benchmark-data.json
79+
# Enable Job Summary for PRs
80+
summary-always: true

‎.github/workflows/go.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
build:
1515
strategy:
1616
matrix:
17-
go-version: ['1.19', 'stable']
17+
go-version: ['1.20', 'stable']
1818
runs-on: ubuntu-latest
1919
steps:
2020
- uses: actions/checkout@v3

‎.github/workflows/main.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Main
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
go-bench:
12+
strategy:
13+
matrix:
14+
go-version: [ '1.20', 'stable' ]
15+
runs-on: ubuntu-latest
16+
timeout-minutes: 15
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
- uses: actions/setup-go@v5
21+
with:
22+
go-version: ${{ matrix.go-version }}
23+
24+
- name: Run benchmark and store the output to a file
25+
run: |
26+
set -o pipefail
27+
make bench | tee bench_output.txt
28+
29+
- name: Get benchmark as JSON
30+
uses: benchmark-action/github-action-benchmark@v1
31+
with:
32+
# What benchmark tool the output.txt came from
33+
tool: 'go'
34+
# Where the output from the benchmark tool is stored
35+
output-file-path: bench_output.txt
36+
# Write benchmarks to this file
37+
external-data-json-path: ./cache/benchmark-data.json
38+
# Workflow will fail when an alert happens
39+
fail-on-alert: true
40+
github-token: ${{ secrets.GITHUB_TOKEN }}
41+
42+
- name: Get CPU information
43+
uses: kenchan0130/actions-system-info@v1.2.1
44+
id: system-info
45+
46+
- name: Save benchmark JSON to cache
47+
uses: actions/cache/save@v3
48+
with:
49+
path: ./cache/benchmark-data.json
50+
# Save with commit hash to avoid "cache already exists"
51+
# Save with OS & CPU info to prevent comparing against results from different CPUs
52+
key: ${{ github.sha }}-${{ runner.os }}-${{ steps.system-info.outputs.cpu-model }}-go-benchmark

‎Makefile‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.DEFAULT_GOAL := help
2+
3+
GO_BIN ?= $(shell go env GOPATH)/bin
4+
5+
.PHONY: help
6+
help:
7+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
8+
9+
$(GO_BIN)/golangci-lint:
10+
@echo "==> Installing golangci-lint within "${GO_BIN}""
11+
@go install -v github.com/golangci/golangci-lint/cmd/golangci-lint@latest
12+
13+
.PHONY: lint
14+
lint: $(GO_BIN)/golangci-lint ## Run linting on Go files
15+
@echo "==> Linting Go source files"
16+
@golangci-lint run -v --fix -c .golangci.yml ./...
17+
18+
.PHONY: test
19+
test: ## Run tests
20+
go test -race -v ./... -coverprofile ./coverage.txt
21+
22+
.PHONY: bench
23+
bench: ## Run benchmarks. See https://pkg.go.dev/cmd/go#hdr-Testing_flags
24+
go test ./... -bench . -benchtime 5s -timeout 0 -run=XXX -cpu 1 -benchmem

‎go.mod‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
module github.com/sourcegraph/conc
22

3-
go 1.19
3+
go 1.20
44

5-
require (
6-
github.com/stretchr/testify v1.8.1
7-
go.uber.org/multierr v1.9.0
8-
)
5+
require github.com/stretchr/testify v1.8.1
96

107
require (
118
github.com/davecgh/go-spew v1.1.1 // indirect
129
github.com/kr/pretty v0.3.0 // indirect
1310
github.com/pmezard/go-difflib v1.0.0 // indirect
1411
github.com/rogpeppe/go-internal v1.9.0 // indirect
15-
go.uber.org/atomic v1.7.0 // indirect
1612
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
1713
gopkg.in/yaml.v3 v3.0.1 // indirect
1814
)

‎go.sum‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,10 @@ github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/f
1717
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
1818
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
1919
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
20-
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
2120
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
2221
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
2322
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
2423
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
25-
go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
26-
go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
27-
go.uber.org/multierr v1.9.0 h1:7fIwc/ZtS0q++VgcfqFDxSBZVv/Xo49/SYnDFupUwlI=
28-
go.uber.org/multierr v1.9.0/go.mod h1:X2jQV1h+kxSjClGpnseKVIxpmcjrj7MNnI0bnlfKTVQ=
2924
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
3025
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
3126
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=

‎internal/multierror/multierror_go119.go‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎internal/multierror/multierror_go120.go‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎iter/export_test.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package iter
2+
3+
var DefaultMaxGoroutines = defaultMaxGoroutines

‎iter/iter_test.go‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package iter
1+
package iter_test
22

33
import (
44
"errors"
@@ -8,12 +8,14 @@ import (
88
"sync/atomic"
99
"testing"
1010

11+
"github.com/sourcegraph/conc/iter"
12+
1113
"github.com/stretchr/testify/require"
1214
)
1315

1416
func ExampleIterator() {
1517
input := []int{1, 2, 3, 4}
16-
iterator := Iterator[int]{
18+
iterator := iter.Iterator[int]{
1719
MaxGoroutines: len(input) / 2,
1820
}
1921

@@ -34,7 +36,7 @@ func TestIterator(t *testing.T) {
3436
t.Run("safe for reuse", func(t *testing.T) {
3537
t.Parallel()
3638

37-
iterator := Iterator[int]{MaxGoroutines: 999}
39+
iterator := iter.Iterator[int]{MaxGoroutines: 999}
3840

3941
// iter.Concurrency > numInput case that updates iter.Concurrency
4042
iterator.ForEachIdx([]int{1, 2, 3}, func(i int, t *int) {})
@@ -45,12 +47,12 @@ func TestIterator(t *testing.T) {
4547
t.Run("allows more than defaultMaxGoroutines() concurrent tasks", func(t *testing.T) {
4648
t.Parallel()
4749

48-
wantConcurrency := 2 * defaultMaxGoroutines()
50+
wantConcurrency := 2 * iter.DefaultMaxGoroutines()
4951

5052
maxConcurrencyHit := make(chan struct{})
5153

5254
tasks := make([]int, wantConcurrency)
53-
iterator := Iterator[int]{MaxGoroutines: wantConcurrency}
55+
iterator := iter.Iterator[int]{MaxGoroutines: wantConcurrency}
5456

5557
var concurrentTasks atomic.Int64
5658
iterator.ForEach(tasks, func(t *int) {
@@ -79,7 +81,7 @@ func TestForEachIdx(t *testing.T) {
7981
t.Parallel()
8082
f := func() {
8183
ints := []int{}
82-
ForEachIdx(ints, func(i int, val *int) {
84+
iter.ForEachIdx(ints, func(i int, val *int) {
8385
panic("this should never be called")
8486
})
8587
}
@@ -90,7 +92,7 @@ func TestForEachIdx(t *testing.T) {
9092
t.Parallel()
9193
f := func() {
9294
ints := []int{1}
93-
ForEachIdx(ints, func(i int, val *int) {
95+
iter.ForEachIdx(ints, func(i int, val *int) {
9496
panic("super bad thing happened")
9597
})
9698
}
@@ -100,7 +102,7 @@ func TestForEachIdx(t *testing.T) {
100102
t.Run("mutating inputs is fine", func(t *testing.T) {
101103
t.Parallel()
102104
ints := []int{1, 2, 3, 4, 5}
103-
ForEachIdx(ints, func(i int, val *int) {
105+
iter.ForEachIdx(ints, func(i int, val *int) {
104106
*val += 1
105107
})
106108
require.Equal(t, []int{2, 3, 4, 5, 6}, ints)
@@ -109,7 +111,7 @@ func TestForEachIdx(t *testing.T) {
109111
t.Run("huge inputs", func(t *testing.T) {
110112
t.Parallel()
111113
ints := make([]int, 10000)
112-
ForEachIdx(ints, func(i int, val *int) {
114+
iter.ForEachIdx(ints, func(i int, val *int) {
113115
*val = i
114116
})
115117
expected := make([]int, 10000)
@@ -127,7 +129,7 @@ func TestForEach(t *testing.T) {
127129
t.Parallel()
128130
f := func() {
129131
ints := []int{}
130-
ForEach(ints, func(val *int) {
132+
iter.ForEach(ints, func(val *int) {
131133
panic("this should never be called")
132134
})
133135
}
@@ -138,7 +140,7 @@ func TestForEach(t *testing.T) {
138140
t.Parallel()
139141
f := func() {
140142
ints := []int{1}
141-
ForEach(ints, func(val *int) {
143+
iter.ForEach(ints, func(val *int) {
142144
panic("super bad thing happened")
143145
})
144146
}
@@ -148,7 +150,7 @@ func TestForEach(t *testing.T) {
148150
t.Run("mutating inputs is fine", func(t *testing.T) {
149151
t.Parallel()
150152
ints := []int{1, 2, 3, 4, 5}
151-
ForEach(ints, func(val *int) {
153+
iter.ForEach(ints, func(val *int) {
152154
*val += 1
153155
})
154156
require.Equal(t, []int{2, 3, 4, 5, 6}, ints)
@@ -157,7 +159,7 @@ func TestForEach(t *testing.T) {
157159
t.Run("huge inputs", func(t *testing.T) {
158160
t.Parallel()
159161
ints := make([]int, 10000)
160-
ForEach(ints, func(val *int) {
162+
iter.ForEach(ints, func(val *int) {
161163
*val = 1
162164
})
163165
expected := make([]int, 10000)
@@ -479,7 +481,7 @@ func BenchmarkForEach(b *testing.B) {
479481
b.Run(strconv.Itoa(count), func(b *testing.B) {
480482
ints := make([]int, count)
481483
for i := 0; i < b.N; i++ {
482-
ForEach(ints, func(i *int) {
484+
iter.ForEach(ints, func(i *int) {
483485
*i = 0
484486
})
485487
}

0 commit comments

Comments
 (0)