chore(internal/protoveneer): support Duration (#10293)

Automatically convert the durationpb.Duration protobuf into a time.Duration.
googleapis · May 31, 2024 · 5ccd88c · 5ccd88c
1 parent 7b073ca
commit 5ccd88c
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/internal/protoveneer/cmd/protoveneer/protoveneer.go b/internal/protoveneer/cmd/protoveneer/protoveneer.go
@@ -849,6 +849,13 @@ var externalTypes = []*externalType{
 		convertTo:     "timestamppb.New",
 		convertFrom:   "support.TimeFromProto",
 	},
+	{
+		qualifiedName: "time.Duration",
+		replaces:      "*durationpb.Duration",
+		importPaths:   []string{"time", "google.golang.org/protobuf/types/known/durationpb"},
+		convertTo:     "durationpb.New",
+		convertFrom:   "support.DurationFromProto",
+	},
 	{
 		qualifiedName: "*apierror.APIError",
 		replaces:      "*status.Status",

diff --git a/internal/protoveneer/cmd/protoveneer/testdata/basic/basic.pb.go b/internal/protoveneer/cmd/protoveneer/testdata/basic/basic.pb.go
@@ -19,6 +19,7 @@ import (
 	status "google.golang.org/genproto/googleapis/rpc/status"
 	date "google.golang.org/genproto/googleapis/type/date"
 	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+	durationpb "google.golang.org/protobuf/types/known/durationpb"
 	"google.golang.org/protobuf/types/known/structpb"
 	timestamppb "google.golang.org/protobuf/types/known/timestamppb"
 )
@@ -135,8 +136,10 @@ type Pop struct {
 	Y unexported
 }
 
-// Status converts to itself.
+// status.Status converts to apierror.APIError.
+// durationpb.Duration converts to time.Duration.
 
 type File struct {
 	Error *status.Status
+	Dur   *durationpb.Duration
 }
diff --git a/internal/protoveneer/cmd/protoveneer/testdata/basic/golden b/internal/protoveneer/cmd/protoveneer/testdata/basic/golden
@@ -9,6 +9,7 @@ import (
 	pb "example.com/basic"
 	"example.com/protoveneer/support"
 	"github.com/googleapis/gax-go/v2/apierror"
+	"google.golang.org/protobuf/types/known/durationpb"
 	"google.golang.org/protobuf/types/known/timestamppb"
 	"time"
 )
@@ -106,6 +107,7 @@ func (CitationMetadata) fromProto(p *pb.CitationMetadata) *CitationMetadata {
 
 type File struct {
 	Error *apierror.APIError
+	Dur   time.Duration
 }
 
 func (v *File) toProto() *pb.File {
@@ -114,6 +116,7 @@ func (v *File) toProto() *pb.File {
 	}
 	return &pb.File{
 		Error: support.APIErrorToProto(v.Error),
+		Dur:   durationpb.New(v.Dur),
 	}
 }
 
@@ -123,6 +126,7 @@ func (File) fromProto(p *pb.File) *File {
 	}
 	return &File{
 		Error: support.APIErrorFromProto(p.Error),
+		Dur:   support.DurationFromProto(p.Dur),
 	}
 }
 

diff --git a/internal/protoveneer/support/support.go b/internal/protoveneer/support/support.go
@@ -24,6 +24,7 @@ import (
 	spb "google.golang.org/genproto/googleapis/rpc/status"
 	"google.golang.org/genproto/googleapis/type/date"
 	gstatus "google.golang.org/grpc/status"
+	"google.golang.org/protobuf/types/known/durationpb"
 	"google.golang.org/protobuf/types/known/structpb"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
@@ -141,3 +142,11 @@ func APIErrorFromProto(s *spb.Status) *apierror.APIError {
 	}
 	return aerr
 }
+
+// DurationFromProto converts a Duration proto to a time.Duration.
+func DurationFromProto(d *durationpb.Duration) time.Duration {
+	if d == nil {
+		return 0
+	}
+	return d.AsDuration()
+}