errors: migrate from gogo/protobuf to google.golang.org/protobuf

github.com/gogo/protobuf, along with the related github.com/gogo/status
and github.com/gogo/googleapis, is deprecated and unmaintained. This
migrates the whole module to the standard, maintained protobuf stack it
already depended on: google.golang.org/protobuf (+ anypb),
google.golang.org/grpc/status, and
google.golang.org/genproto/googleapis/rpc/status.

The .proto files are regenerated with the standard protoc-gen-go and
protoc-gen-go-grpc, dropping the custom protoc-gen-gogoroach plugin and
all gogoproto options, and the hand-written code is adapted to the v2
runtime:

- errbase packs and unpacks error detail payloads with anypb.New and
  (*anypb.Any).UnmarshalNew, resolving types through the standard
  protoregistry instead of gogo's registry.
- The previously non-nullable embedded fields (Details, Cause,
  ErrorTypeMark) are now pointers, read through the generated nil-safe
  getters. DecodeError takes *EncodedError and GetTypeMark returns
  *errorspb.ErrorTypeMark accordingly.
- extgrpc and grpc/middleware use google.golang.org/grpc/status. Because
  the standard Any can hold standard protobufs directly, the former
  gogo/standard status split collapses into a single path, and
  google.rpc.Status now comes from genproto with the same type URL.
- go.mod drops all three gogo modules.

Wire compatibility is preserved: no proto package/message name or field
number changes, and google.protobuf.Any type URLs are unchanged, so
errors serialized by the previous gogo-based version still decode here
and vice versa.

This is a breaking API change (major version): the encoder/decoder
registration interfaces now reference the v2 proto.Message, so consumers
that register custom error types must supply standard-protobuf payloads.
Errors originally produced as github.com/gogo/status types decode to an
opaque error (message and safe details preserved) rather than being
reconstructed as a gRPC status.

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>

Author: liran-funaro

Makefile.update-protos

@@ -1,32 +1,18 @@
-# This makefile can be used to-regenerate the protobuf files.
+# This makefile can be used to regenerate the protobuf files.
 #
 # Prerequisites:
-#   "protoc" from https://github.com/protocolbuffers/protobuf
-#   go get github.com/cockroachdb/protoc-gen-gogoroach
-#   go get github.com/gogo/protobuf/types
-#   go get github.com/gogo/protobuf/protoc-gen-gogo
+#   protoc               https://github.com/protocolbuffers/protobuf
+#   protoc-gen-go        go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+#   protoc-gen-go-grpc   go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 #
-# Note: as of 2021-04-13, we like to use a custom protoc-gen-gogo
-# with additional options, to stabilize the marshalled
-# encoding of objects (so that they are deterministic
-# across marshal/unmarshal cycles) and reduce the memory footprint
-# of objects:
+# Run: make -f Makefile.update-protos
 #
-#	vanity.TurnOnStable_MarshalerAll,
-#	vanity.TurnOffGoUnrecognizedAll,
-#	vanity.TurnOffGoUnkeyedAll,
-#	vanity.TurnOffGoSizecacheAll,
-#
-# Until this is resolved, the "go get" commands above are not
-# adequate; instead:
-#
-# 1. set the PATH env var to point to CockroachDB's `bin`
-#    sub-directory (after a successful CockroachDB build), where a
-#    suitable version of protoc-gen-gogoroach is provided.
-#
-# 2. run `make -f Makefile.update-protos` with this PATH active.
-
-export SHELL := env PWD=$(CURDIR) bash
+# Note: the standard protoc-gen-go runtime always embeds state/sizeCache/
+# unknownFields per message and has no equivalent of the old gogo vanity
+# options. These messages have no map fields, so proto.Marshal output is
+# already byte-stable across marshal/unmarshal cycles (add
+# proto.MarshalOptions{Deterministic: true} if a map field is ever added).
+# The gogo memory-footprint trimming has no standard equivalent.
 
 PROTOS := $(wildcard \
 	errbase/internal/*.proto \
@@ -38,25 +24,9 @@ PROTOS := $(wildcard \
 )
 GO_SOURCES = $(PROTOS:.proto=.pb.go)
 
-SED = sed
-SED_INPLACE := $(shell $(SED) --version 2>&1 | grep -q GNU && echo -i || echo "-i ''")
-
-all: $(PROTOS)
-	set -e; for dir in $(sort $(dir $(PROTOS))); do \
-		protoc \
-			-I. \
-			-I$$GOPATH/src/ \
-			-I$$GOPATH/src/github.com \
-			-I$$GOPATH/src/github.com/cockroachdb/errors \
-			-I$$GOPATH/src/github.com/gogo/protobuf \
-			-I$$GOPATH/src/github.com/gogo/protobuf/protobuf \
-			--gogoroach_out=Mgoogle/protobuf/any.proto=github.com/gogo/protobuf/types,plugins=grpc,import_prefix=:. \
-			$$dir/*.proto; \
-	done
-	$(SED) $(SED_INPLACE) -E \
-		-e '/import _ /d' \
-		-e 's!import (fmt|math) "github.com/(fmt|math)"! !g' \
-		-e 's!github.com/((bytes|encoding/binary|errors|fmt|io|math|github\.com|(google\.)?golang\.org)([^a-z]|$$))!\1!g' \
-		-e 's!golang.org/x/net/context!context!g' \
-		$(GO_SOURCES)
+all:
+	protoc -I. \
+		--go_out=. --go_opt=paths=source_relative \
+		--go-grpc_out=. --go-grpc_opt=paths=source_relative \
+		$(PROTOS)
 	gofmt -s -w $(GO_SOURCES)

assert/assert.go

@@ -21,7 +21,7 @@ import (
 	"github.com/cockroachdb/errors/errbase"
 	"github.com/cockroachdb/errors/markers"
 	"github.com/cockroachdb/errors/stdstrings"
-	"github.com/gogo/protobuf/proto"
+	"google.golang.org/protobuf/proto"
 )
 
 // WithAssertionFailure decorates the error with an assertion failure marker.

assert/assert_test.go

@@ -45,7 +45,7 @@ func TestAssert(t *testing.T) {
 	tt.CheckEqual(err.Error(), "hello: world")
 
 	enc := errbase.EncodeError(context.Background(), err)
-	newErr := errbase.DecodeError(context.Background(), enc)
+	newErr := errbase.DecodeError(context.Background(), &enc)
 
 	tt.Check(markers.Is(newErr, baseErr))
 

barriers/barriers.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/cockroachdb/errors/errbase"
 	"github.com/cockroachdb/redact"
-	"github.com/gogo/protobuf/proto"
+	"google.golang.org/protobuf/proto"
 )
 
 // Handled swallows the provided error and hides it from the
@@ -123,13 +123,13 @@ func encodeBarrier(
 // A barrier error is decoded exactly.
 func decodeBarrier(ctx context.Context, msg string, _ []string, payload proto.Message) error {
 	enc := payload.(*errbase.EncodedError)
-	return &barrierErr{smsg: redact.RedactableString(msg), maskedErr: errbase.DecodeError(ctx, *enc)}
+	return &barrierErr{smsg: redact.RedactableString(msg), maskedErr: errbase.DecodeError(ctx, enc)}
 }
 
 // Previous versions of barrier errors.
 func decodeBarrierPrev(ctx context.Context, msg string, _ []string, payload proto.Message) error {
 	enc := payload.(*errbase.EncodedError)
-	return &barrierErr{smsg: redact.Sprint(msg), maskedErr: errbase.DecodeError(ctx, *enc)}
+	return &barrierErr{smsg: redact.Sprint(msg), maskedErr: errbase.DecodeError(ctx, enc)}
 }
 
 // barrierError is the "old" type name of barrierErr. We use a new

barriers/barriers_test.go

@@ -75,7 +75,7 @@ func TestBarrierMaskedDetails(t *testing.T) {
 
 	// Simulate a network traversal.
 	enc := errbase.EncodeError(context.Background(), b)
-	newB := errbase.DecodeError(context.Background(), enc)
+	newB := errbase.DecodeError(context.Background(), &enc)
 
 	// The friends message is hidden.
 	tt.Check(!strings.Contains(b.Error(), "friends"))

contexttags/contexttags_test.go

@@ -83,7 +83,7 @@ func TestWithContext(t *testing.T) {
 	tt.Run("local", func(tt testutils.T) { theTest(tt, decoratedErr) })
 
 	enc := errbase.EncodeError(context.Background(), decoratedErr)
-	newErr := errbase.DecodeError(context.Background(), enc)
+	newErr := errbase.DecodeError(context.Background(), &enc)
 
 	tt.Run("remote", func(tt testutils.T) { theTest(tt, newErr) })
 }
@@ -137,7 +137,7 @@ func TestTagRedactionInSafeDetails(t *testing.T) {
 	tt.Run("local", func(tt testutils.T) { theTest(tt, decoratedErr) })
 
 	enc := errbase.EncodeError(context.Background(), decoratedErr)
-	newErr := errbase.DecodeError(context.Background(), enc)
+	newErr := errbase.DecodeError(context.Background(), &enc)
 
 	tt.Run("remote", func(tt testutils.T) { theTest(tt, newErr) })
 

contexttags/with_context.go

@@ -22,7 +22,7 @@ import (
 	"github.com/cockroachdb/errors/errorspb"
 	"github.com/cockroachdb/logtags"
 	"github.com/cockroachdb/redact"
-	"github.com/gogo/protobuf/proto"
+	"google.golang.org/protobuf/proto"
 )
 
 type withContext struct {
@@ -79,7 +79,7 @@ func encodeWithContext(_ context.Context, err error) (string, []string, proto.Me
 	w := err.(*withContext)
 	p := &errorspb.TagsPayload{}
 	for _, t := range w.tags.Get() {
-		p.Tags = append(p.Tags, errorspb.TagPayload{Tag: t.Key(), Value: t.ValueStr()})
+		p.Tags = append(p.Tags, &errorspb.TagPayload{Tag: t.Key(), Value: t.ValueStr()})
 	}
 	return "", w.SafeDetails(), p
 }

domains/with_domain.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/cockroachdb/errors/errbase"
 	"github.com/cockroachdb/redact"
-	"github.com/gogo/protobuf/proto"
+	"google.golang.org/protobuf/proto"
 )
 
 // withDomain is a wrapper type that adds a domain annotation to an

errbase/adapters.go

@@ -21,8 +21,8 @@ import (
 	"os"
 
 	"github.com/cockroachdb/errors/errorspb"
-	"github.com/gogo/protobuf/proto"
 	pkgErr "github.com/pkg/errors"
+	"google.golang.org/protobuf/proto"
 )
 
 // This file provides the library the ability to encode/decode

errbase/adapters_errno.go

@@ -12,6 +12,7 @@
 // implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+//go:build !plan9
 // +build !plan9
 
 package errbase
@@ -23,7 +24,7 @@ import (
 	"syscall"
 
 	"github.com/cockroachdb/errors/errorspb"
-	"github.com/gogo/protobuf/proto"
+	"google.golang.org/protobuf/proto"
 )
 
 const thisArch = runtime.GOOS + ":" + runtime.GOARCH