Benchmarks

Author: leg100

readme.md

@@ -117,3 +117,32 @@ https://example.com/a/b/c?expiry=3xx1vi&foo=bar&signature=-mwCtMLTBgDkShZTbBcHjR
 ## Notes
 
 * Any change in the order of the query parameters in a signed URL renders it invalid, unless `SkipQuery` is specified.
+
+## Benchmarks
+
+```bash
+> go test -run=XXX -bench=.
+goos: linux
+goarch: amd64
+pkg: github.com/leg100/surl
+cpu: AMD Ryzen 7 3800X 8-Core Processor
+BenchmarkSigner/by_path/decimal/no_opts-16                514827              2451 ns/op
+BenchmarkSigner/by_path/decimal/with_prefix-16            362757              3174 ns/op
+BenchmarkSigner/by_path/decimal/skip_query-16             470324              2399 ns/op
+BenchmarkSigner/by_path/decimal/skip_query_and_with_prefix-16             365589              3052 ns/op
+BenchmarkSigner/by_path/base58/no_opts-16                                 481573              2339 ns/op
+BenchmarkSigner/by_path/base58/with_prefix-16                             466501              2809 ns/op
+BenchmarkSigner/by_path/base58/skip_query-16                              546319              2304 ns/op
+BenchmarkSigner/by_path/base58/skip_query_and_with_prefix-16              453450              2799 ns/op
+BenchmarkSigner/by_query/decimal/no_opts-16                               197506              6483 ns/op
+BenchmarkSigner/by_query/decimal/with_prefix-16                           165560              6662 ns/op
+BenchmarkSigner/by_query/decimal/skip_query-16                            157486              7489 ns/op
+BenchmarkSigner/by_query/decimal/skip_query_and_with_prefix-16            150454              7837 ns/op
+BenchmarkSigner/by_query/base58/no_opts-16                                206263              6256 ns/op
+BenchmarkSigner/by_query/base58/with_prefix-16                            161008              6787 ns/op
+BenchmarkSigner/by_query/base58/skip_query-16                             159558              7374 ns/op
+BenchmarkSigner/by_query/base58/skip_query_and_with_prefix-16             151778              7578 ns/op
+PASS
+ok      github.com/leg100/surl  19.906s
+```
+

signer_test.go

@@ -1,6 +1,7 @@
 package surl
 
 import (
+	"crypto/rand"
 	"net/url"
 	"path"
 	"testing"
@@ -10,8 +11,8 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestSigner(t *testing.T) {
-	formatters := []struct {
+var (
+	formatters = []struct {
 		name      string
 		formatter Option
 	}{
@@ -25,7 +26,7 @@ func TestSigner(t *testing.T) {
 		},
 	}
 
-	encoders := []struct {
+	encoders = []struct {
 		name    string
 		encoder Option
 	}{
@@ -39,7 +40,7 @@ func TestSigner(t *testing.T) {
 		},
 	}
 
-	opts := []struct {
+	opts = []struct {
 		name    string
 		options []Option
 	}{
@@ -59,7 +60,9 @@ func TestSigner(t *testing.T) {
 			options: []Option{SkipQuery(), PrefixPath("/signed")},
 		},
 	}
+)
 
+func TestSigner(t *testing.T) {
 	inputs := []struct {
 		name     string
 		unsigned string
@@ -90,7 +93,7 @@ func TestSigner(t *testing.T) {
 					options := append(opt.options, f.formatter, enc.encoder)
 					signer := New([]byte("abc123"), options...)
 
-					t.Run(path.Join(tt.name, f.name, opt.name), func(t *testing.T) {
+					t.Run(path.Join(tt.name, f.name, enc.name, opt.name), func(t *testing.T) {
 						signed, err := signer.Sign(tt.unsigned, time.Second*10)
 						require.NoError(t, err)
 
@@ -210,3 +213,33 @@ func TestSigner_Errors(t *testing.T) {
 		assert.Error(t, err)
 	})
 }
+
+var bu string
+
+func BenchmarkSigner(b *testing.B) {
+	secret := make([]byte, 64)
+	_, err := rand.Read(secret)
+	require.NoError(b, err)
+
+	// invoke bench for each combination of formatter, encoder, and set of
+	// options
+	for _, f := range formatters {
+		for _, enc := range encoders {
+			for _, opt := range opts {
+				options := append(opt.options, f.formatter, enc.encoder)
+
+				b.Run(path.Join(f.name, enc.name, opt.name), func(b *testing.B) {
+					signer := New(secret, options...)
+
+					var u string
+					for n := 0; n < b.N; n++ {
+						// store result to prevent compiler eliminating func call
+						u, _ = signer.Sign("https://example.com/a/b/c?x=1&y=2&z=3", time.Hour)
+					}
+					// store result in pkg var to to prevent compiler eliminating benchmark
+					bu = u
+				})
+			}
+		}
+	}
+}