switch to protodelim package (which pbutil now calls)

Go Protobuf v1.30.0 includes the new protodelim package. github.com/matttproud/golang_protobuf_extensions/v2/pbutil is, at this point, just a wrapper around the protodelim package: matttproud/golang_protobuf_extensions@7c0096c https://matttproud.com/blog/posts/retiring-pbutil.html Therefore, this change calls protodelim directly, allowing us to get rid of one module dependency :)
prometheus · Jan 12, 2024 · a56bfc1 · a56bfc1
1 parent 21a37ca
commit a56bfc1
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 16 deletions.
diff --git a/expfmt/bench_test.go b/expfmt/bench_test.go
@@ -14,14 +14,15 @@
 package expfmt
 
 import (
+	"bufio"
 	"bytes"
 	"compress/gzip"
 	"errors"
 	"io"
 	"os"
 	"testing"
 
-	"github.com/matttproud/golang_protobuf_extensions/v2/pbutil"
+	"google.golang.org/protobuf/encoding/protodelim"
 
 	dto "github.com/prometheus/client_model/go"
 )
@@ -98,10 +99,13 @@ func BenchmarkParseProto(b *testing.B) {
 
 	for i := 0; i < b.N; i++ {
 		family := &dto.MetricFamily{}
-		in := bytes.NewReader(data)
+		in := bufio.NewReader(bytes.NewReader(data))
+		unmarshaler := protodelim.UnmarshalOptions{
+			MaxSize: -1,
+		}
 		for {
 			family.Reset()
-			if _, err := pbutil.ReadDelimited(in, family); err != nil {
+			if err := unmarshaler.UnmarshalFrom(in, family); err != nil {
 				if errors.Is(err, io.EOF) {
 					break
 				}
@@ -123,13 +127,17 @@ func BenchmarkParseProtoGzip(b *testing.B) {
 
 	for i := 0; i < b.N; i++ {
 		family := &dto.MetricFamily{}
-		in, err := gzip.NewReader(bytes.NewReader(data))
+		gz, err := gzip.NewReader(bytes.NewReader(data))
 		if err != nil {
 			b.Fatal(err)
 		}
+		in := bufio.NewReader(gz)
+		unmarshaler := protodelim.UnmarshalOptions{
+			MaxSize: -1,
+		}
 		for {
 			family.Reset()
-			if _, err := pbutil.ReadDelimited(in, family); err != nil {
+			if err := unmarshaler.UnmarshalFrom(in, family); err != nil {
 				if errors.Is(err, io.EOF) {
 					break
 				}
@@ -153,10 +161,13 @@ func BenchmarkParseProtoMap(b *testing.B) {
 
 	for i := 0; i < b.N; i++ {
 		families := map[string]*dto.MetricFamily{}
-		in := bytes.NewReader(data)
+		in := bufio.NewReader(bytes.NewReader(data))
+		unmarshaler := protodelim.UnmarshalOptions{
+			MaxSize: -1,
+		}
 		for {
 			family := &dto.MetricFamily{}
-			if _, err := pbutil.ReadDelimited(in, family); err != nil {
+			if err := unmarshaler.UnmarshalFrom(in, family); err != nil {
 				if errors.Is(err, io.EOF) {
 					break
 				}

diff --git a/expfmt/decode.go b/expfmt/decode.go
@@ -14,15 +14,15 @@
 package expfmt
 
 import (
+	"bufio"
 	"fmt"
 	"io"
 	"math"
 	"mime"
 	"net/http"
 
 	dto "github.com/prometheus/client_model/go"
-
-	"github.com/matttproud/golang_protobuf_extensions/v2/pbutil"
+	"google.golang.org/protobuf/encoding/protodelim"
 
 	"github.com/prometheus/common/model"
 )
@@ -87,8 +87,10 @@ type protoDecoder struct {
 
 // Decode implements the Decoder interface.
 func (d *protoDecoder) Decode(v *dto.MetricFamily) error {
-	_, err := pbutil.ReadDelimited(d.r, v)
-	if err != nil {
+	opts := protodelim.UnmarshalOptions{
+		MaxSize: -1,
+	}
+	if err := opts.UnmarshalFrom(bufio.NewReader(d.r), v); err != nil {
 		return err
 	}
 	if !model.IsValidMetricName(model.LabelValue(v.GetName())) {

diff --git a/expfmt/encode.go b/expfmt/encode.go
@@ -18,7 +18,7 @@ import (
 	"io"
 	"net/http"
 
-	"github.com/matttproud/golang_protobuf_extensions/v2/pbutil"
+	"google.golang.org/protobuf/encoding/protodelim"
 	"google.golang.org/protobuf/encoding/prototext"
 
 	"github.com/prometheus/common/internal/bitbucket.org/ww/goautoneg"
@@ -121,7 +121,7 @@ func NewEncoder(w io.Writer, format Format) Encoder {
 	case FmtProtoDelim:
 		return encoderCloser{
 			encode: func(v *dto.MetricFamily) error {
-				_, err := pbutil.WriteDelimited(w, v)
+				_, err := protodelim.MarshalTo(w, v)
 				return err
 			},
 			close: func() error { return nil },

diff --git a/go.mod b/go.mod
@@ -6,7 +6,6 @@ require (
 	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/go-kit/log v0.2.1
 	github.com/julienschmidt/httprouter v1.3.0
-	github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0
 	github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f
 	github.com/prometheus/client_golang v1.18.0
 	github.com/prometheus/client_model v0.5.0

diff --git a/go.sum b/go.sum
@@ -27,8 +27,6 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 h1:jWpvCLoY8Z/e3VKvlsiIGKtc+UG6U5vzxaoagmhXfyg=
-github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0/go.mod h1:QUyp042oQthUoa9bqDv0ER0wrtXnBruoNd7aNjkbP+k=
 github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f h1:KUppIJq7/+SVif2QVs3tOP0zanoHgBEVAwHxUSIzRqU=
 github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=