pkg/reference: SplitObject: zero allocations

thaJeztah · thaJeztah · commit 74a6156ac2fa · 2024-06-27T12:05:10.000+02:00
Before / After:

    BenchmarkSplitObject-10        2785656    428.1 ns/op     416 B/op    13 allocs/op
    BenchmarkSplitObjectNew-10    13510520     88.2 ns/op       0 B/op     0 allocs/op

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/pkg/reference/reference.go b/pkg/reference/reference.go
@@ -157,9 +157,9 @@ func (r Spec) String() string {
 // Either may be empty and it is the callers job to validate them
 // appropriately.
 func SplitObject(obj string) (tag string, dgst digest.Digest) {
-	parts := strings.SplitAfterN(obj, "@", 2)
-	if len(parts) < 2 {
-		return parts[0], ""
+	if i := strings.Index(obj, "@"); i >= 0 {
+		// Offset by one so preserve the "@" in the tag returned.
+		return obj[:i+1], digest.Digest(obj[i+1:])
 	}
-	return parts[0], digest.Digest(parts[1])
+	return obj, ""
 }
diff --git a/pkg/reference/reference_test.go b/pkg/reference/reference_test.go
@@ -192,3 +192,33 @@ func TestReferenceParser(t *testing.T) {
 		})
 	}
 }
+
+func BenchmarkSplitObject(b *testing.B) {
+	inputs := []string{
+		"",
+		"@",
+		"docker.io@",
+		"@digest",
+		"docker.io/library/redis:foo?fooo=asdf",
+		"docker.io/library/redis:foo@sha256:abcdef?fooo=asdf",
+		"docker.io/library/redis@sha256:abcdef?fooo=asdf",
+		"docker.io/library/redis:obj@abcdef?fooo=asdf",
+		"localhost:5000/library/redis:obj@abcdef?fooo=asdf",
+		"/docker.io/library/redis:obj@abcdef?fooo=asdf",
+		"docker.io/library/redis?fooo=asdf",
+		"sub-dom1.foo.com/bar/baz/quux:latest",
+		"sub-dom1.foo.com/bar/baz/quux:some-long-tag",
+		"b.gcr.io/test.example.com/my-app:test.example.com",
+		"xn--n3h.com/myimage:xn--n3h.com", // ☃.com in punycode
+		"xn--7o8h.com/myimage:xn--7o8h.com@sha512:fffffff",
+		"http://xn--7o8h.com/myimage:xn--7o8h.com@sha512:fffffff",
+	}
+
+	b.ReportAllocs()
+
+	for i := 0; i < b.N; i++ {
+		for _, input := range inputs {
+			_, _ = SplitObject(input)
+		}
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -157,9 +157,9 @@ func (r Spec) String() string {`
`157`	`157`	`// Either may be empty and it is the callers job to validate them`
`158`	`158`	`// appropriately.`
`159`	`159`	`func SplitObject(obj string) (tag string, dgst digest.Digest) {`
`160`		`- parts := strings.SplitAfterN(obj, "@", 2)`
`161`		`- if len(parts) < 2 {`
`162`		`- return parts[0], ""`
	`160`	`+ if i := strings.Index(obj, "@"); i >= 0 {`
	`161`	`+ // Offset by one so preserve the "@" in the tag returned.`
	`162`	`+ return obj[:i+1], digest.Digest(obj[i+1:])`
`163`	`163`	`}`
`164`		`- return parts[0], digest.Digest(parts[1])`
	`164`	`+ return obj, ""`
`165`	`165`	`}`