feat(errorx): add Request Timeout http error handling (#245)

Some Influx clients do not send the request in time. We need this
error code to be able to have the right status for the client and also
to be able to update the correct metric.

Signed-off-by: György Krajcsovits <[email protected]>

pkg/errorx/errors.go

@@ -64,6 +64,8 @@ func FromGRPCStatus(s *grpcStatus.Status) error { //nolint:gocyclo
 				return TooManyRequests{Msg: msg}
 			case errorxpb.ErrorxType_UNSUPPORTED_MEDIA_TYPE:
 				return UnsupportedMediaType{Msg: msg}
+			case errorxpb.ErrorxType_REQUEST_TIMEOUT:
+				return RequestTimeout{Msg: msg}
 			default:
 				return Internal{Msg: "invalid errorx type specifier. " + msg}
 			}
@@ -405,6 +407,42 @@ func (e TooManyRequests) GRPCStatusDetails() []protov1.Message {
 	}}
 }
 
+var _ Error = RequestTimeout{}
+
+type RequestTimeout struct {
+	Msg string
+	Err error
+}
+
+func (e RequestTimeout) Error() string {
+	if e.Err != nil {
+		return fmt.Sprintf("%s: %s", e.Msg, e.Err)
+	}
+	return e.Msg
+}
+
+func (e RequestTimeout) Message() string {
+	return e.Msg
+}
+
+func (e RequestTimeout) Unwrap() error {
+	return e.Err
+}
+
+func (e RequestTimeout) HTTPStatusCode() int {
+	return http.StatusRequestTimeout
+}
+
+func (e RequestTimeout) GRPCStatus() *grpcStatus.Status {
+	return WithErrorxTypeDetail(grpcStatus.New(codes.DeadlineExceeded, e.Error()), e.GRPCStatusDetails()...)
+}
+
+func (e RequestTimeout) GRPCStatusDetails() []protov1.Message {
+	return []protov1.Message{&errorxpb.ErrorDetails{
+		Type: errorxpb.ErrorxType_REQUEST_TIMEOUT,
+	}}
+}
+
 func TryUnwrap(err error) error {
 	if wrapped, ok := err.(interface{ Unwrap() error }); ok {
 		return wrapped.Unwrap()

pkg/errorx/errors_test.go

@@ -68,6 +68,11 @@ func TestGRPCStatusRoundTrip(t *testing.T) {
 			err:     TooManyRequests{Msg: "too much!"},
 			wantErr: TooManyRequests{Msg: "grpc ResourceExhausted: too much!"},
 		},
+		{
+			name:    "RequestTimeout",
+			err:     RequestTimeout{Msg: "client timeout"},
+			wantErr: RequestTimeout{Msg: "grpc DeadlineExceeded: client timeout"},
+		},
 	}
 
 	for _, tc := range tests {

pkg/errorx/http_translator_test.go

@@ -63,6 +63,10 @@ func TestLogAndSetHttpError(t *testing.T) {
 			expectedCode:    http.StatusInternalServerError,
 			expectedMessage: "unknown error",
 		},
+		"request timeout": {
+			err:          RequestTimeout{},
+			expectedCode: http.StatusRequestTimeout,
+		},
 	} {
 		logger := log.NewNopLogger()
 		recorder := httptest.NewRecorder()

protos/errorx/v1/errors.proto

@@ -27,4 +27,5 @@ enum ErrorxType {
   CONFLICT = 8;
   TOO_MANY_REQUESTS = 9;
   UNSUPPORTED_MEDIA_TYPE = 10;
+  REQUEST_TIMEOUT = 11;
 }