-
Notifications
You must be signed in to change notification settings - Fork 82
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Drop dependencies not compatible with gogo/protobuf #67
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6da07ec
cleanup deps: go mod tidy
fgiudici 821f76c
Import a local copy of google.golang.org/grpc/status
fgiudici 9a92c79
grpc/status: reference imported code
fgiudici c061ce2
googleapis: import code from gogo/googleapis
fgiudici d399b17
grpc/status: import ptypes from gogo/protobuf
fgiudici daf7271
update go.mod
fgiudici File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
/* | ||
* | ||
* Copyright 2020 gRPC authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
* | ||
*/ | ||
|
||
// Package status implements errors returned by gRPC. These errors are | ||
// serialized and transmitted on the wire between server and client, and allow | ||
// for additional data to be transmitted via the Details field in the status | ||
// proto. gRPC service handlers should return an error created by this | ||
// package, and gRPC clients should expect a corresponding error to be | ||
// returned from the RPC call. | ||
// | ||
// This package upholds the invariants that a non-nil error may not | ||
// contain an OK code, and an OK code must result in a nil error. | ||
package status | ||
|
||
import ( | ||
"errors" | ||
"fmt" | ||
|
||
spb "github.com/gogo/googleapis/google/rpc" | ||
ptypes "github.com/gogo/protobuf/types" | ||
"github.com/golang/protobuf/proto" | ||
"google.golang.org/grpc/codes" | ||
) | ||
|
||
// Status represents an RPC status code, message, and details. It is immutable | ||
// and should be created with New, Newf, or FromProto. | ||
type Status struct { | ||
s *spb.Status | ||
} | ||
|
||
// New returns a Status representing c and msg. | ||
func New(c codes.Code, msg string) *Status { | ||
return &Status{s: &spb.Status{Code: int32(c), Message: msg}} | ||
} | ||
|
||
// Newf returns New(c, fmt.Sprintf(format, a...)). | ||
func Newf(c codes.Code, format string, a ...interface{}) *Status { | ||
return New(c, fmt.Sprintf(format, a...)) | ||
} | ||
|
||
// FromProto returns a Status representing s. | ||
func FromProto(s *spb.Status) *Status { | ||
return &Status{s: proto.Clone(s).(*spb.Status)} | ||
} | ||
|
||
// Err returns an error representing c and msg. If c is OK, returns nil. | ||
func Err(c codes.Code, msg string) error { | ||
return New(c, msg).Err() | ||
} | ||
|
||
// Errorf returns Error(c, fmt.Sprintf(format, a...)). | ||
func Errorf(c codes.Code, format string, a ...interface{}) error { | ||
return Err(c, fmt.Sprintf(format, a...)) | ||
} | ||
|
||
// Code returns the status code contained in s. | ||
func (s *Status) Code() codes.Code { | ||
if s == nil || s.s == nil { | ||
return codes.OK | ||
} | ||
return codes.Code(s.s.Code) | ||
} | ||
|
||
// Message returns the message contained in s. | ||
func (s *Status) Message() string { | ||
if s == nil || s.s == nil { | ||
return "" | ||
} | ||
return s.s.Message | ||
} | ||
|
||
// Proto returns s's status as an spb.Status proto message. | ||
func (s *Status) Proto() *spb.Status { | ||
if s == nil { | ||
return nil | ||
} | ||
return proto.Clone(s.s).(*spb.Status) | ||
} | ||
|
||
// Err returns an immutable error representing s; returns nil if s.Code() is OK. | ||
func (s *Status) Err() error { | ||
if s.Code() == codes.OK { | ||
return nil | ||
} | ||
return &Error{e: s.Proto()} | ||
} | ||
|
||
// WithDetails returns a new status with the provided details messages appended to the status. | ||
// If any errors are encountered, it returns nil and the first error encountered. | ||
func (s *Status) WithDetails(details ...proto.Message) (*Status, error) { | ||
if s.Code() == codes.OK { | ||
return nil, errors.New("no error details for status with code OK") | ||
} | ||
// s.Code() != OK implies that s.Proto() != nil. | ||
p := s.Proto() | ||
for _, detail := range details { | ||
any, err := ptypes.MarshalAny(detail) | ||
if err != nil { | ||
return nil, err | ||
} | ||
p.Details = append(p.Details, any) | ||
} | ||
return &Status{s: p}, nil | ||
} | ||
|
||
// Details returns a slice of details messages attached to the status. | ||
// If a detail cannot be decoded, the error is returned in place of the detail. | ||
func (s *Status) Details() []interface{} { | ||
if s == nil || s.s == nil { | ||
return nil | ||
} | ||
details := make([]interface{}, 0, len(s.s.Details)) | ||
for _, any := range s.s.Details { | ||
detail := &ptypes.DynamicAny{} | ||
if err := ptypes.UnmarshalAny(any, detail); err != nil { | ||
details = append(details, err) | ||
continue | ||
} | ||
details = append(details, detail.Message) | ||
} | ||
return details | ||
} | ||
|
||
// Error wraps a pointer of a status proto. It implements error and Status, | ||
// and a nil *Error should never be returned by this package. | ||
type Error struct { | ||
e *spb.Status | ||
} | ||
|
||
func (e *Error) Error() string { | ||
return fmt.Sprintf("rpc error: code = %s desc = %s", codes.Code(e.e.GetCode()), e.e.GetMessage()) | ||
} | ||
|
||
// GRPCStatus returns the Status represented by se. | ||
func (e *Error) GRPCStatus() *Status { | ||
return FromProto(e.e) | ||
} | ||
|
||
// Is implements future error.Is functionality. | ||
// A Error is equivalent if the code and message are identical. | ||
func (e *Error) Is(target error) bool { | ||
tse, ok := target.(*Error) | ||
if !ok { | ||
return false | ||
} | ||
return proto.Equal(e.e, tse.e) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please prepend the following header to make CI happy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Akihiro,
I copied the code from the google grpc original code, so I wanted to keep the original "Copyright 2020 gRPC authors" line. I will leave the original licence header and add the new one on top. Thanks for the advice!