Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove HTTP mappings from status.h

Browse Source 
The mappings are a combination of useless, inaccurate, and harmful.
Leave them out until they are helpful and correct.

Fundamental issues:
 - If in need of mappings, a user would need HTTP -> gRPC code mappings.
   But the docs don't provide that since the mappings are not 1:1.
 - There _is no_ gRPC -> HTTP code mapping taking place in gRPC. This
   may change in the future, but until then the docs are misleading.

But even given those were resolved, there are additional issues. Two
obvious examples:
 - 501 Not Implemented is refering to HTTP methods such as GET and POST
   not being implement. That should not be used for gRPC methods not
   found (UNIMPLEMENTED).
 - 404 Not Found is for when the resource is not found. In gRPC, the
   resource is the gRPC method, not the parameters (NOT_FOUND). If there
   is a REST conversion layer on top of gRPC, then 404 would be
   appropriate, but that just shows that the mapping can not be
   canonical.
pull/911/head
Eric Anderson 10 years ago
parent 7a89026886
commit 5b53e35ba4
3 changed files with 51 additions and 168 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 73
      include/grpc++/status_code_enum.h
  2. 73
      include/grpc/status.h
  3. 73
      src/csharp/Grpc.Core/StatusCode.cs

73
include/grpc++/status_code_enum.h
Unescape View File

@ -37,51 +37,37 @@
namespace grpc { namespace grpc {
enum StatusCode { enum StatusCode {
/* Not an error; returned on success /* Not an error; returned on success */
HTTP Mapping: 200 OK */
OK = 0, OK = 0,
/* The operation was cancelled (typically by the caller). /* The operation was cancelled (typically by the caller). */
HTTP Mapping: 499 Client Closed Request */
CANCELLED = 1, CANCELLED = 1,
/* Unknown error. An example of where this error may be returned is /* Unknown error. An example of where this error may be returned is
if a Status value received from another address space belongs to if a Status value received from another address space belongs to
an error-space that is not known in this address space. Also an error-space that is not known in this address space. Also
errors raised by APIs that do not return enough error information errors raised by APIs that do not return enough error information
may be converted to this error. may be converted to this error. */
HTTP Mapping: 500 Internal Server Error */
UNKNOWN = 2, UNKNOWN = 2,
/* Client specified an invalid argument. Note that this differs /* Client specified an invalid argument. Note that this differs
from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
that are problematic regardless of the state of the system that are problematic regardless of the state of the system
(e.g., a malformed file name). (e.g., a malformed file name). */
HTTP Mapping: 400 Bad Request */
INVALID_ARGUMENT = 3, INVALID_ARGUMENT = 3,
/* Deadline expired before operation could complete. For operations /* Deadline expired before operation could complete. For operations
that change the state of the system, this error may be returned that change the state of the system, this error may be returned
even if the operation has completed successfully. For example, a even if the operation has completed successfully. For example, a
successful response from a server could have been delayed long successful response from a server could have been delayed long
enough for the deadline to expire. enough for the deadline to expire. */
HTTP Mapping: 504 Gateway Timeout */
DEADLINE_EXCEEDED = 4, DEADLINE_EXCEEDED = 4,
/* Some requested entity (e.g., file or directory) was not found. /* Some requested entity (e.g., file or directory) was not found. */
HTTP Mapping: 404 Not Found */
NOT_FOUND = 5, NOT_FOUND = 5,
/* Some entity that we attempted to create (e.g., file or directory) /* Some entity that we attempted to create (e.g., file or directory)
already exists. already exists. */
HTTP Mapping: 409 Conflict */
ALREADY_EXISTS = 6, ALREADY_EXISTS = 6,
/* The caller does not have permission to execute the specified /* The caller does not have permission to execute the specified
@ -89,21 +75,15 @@ enum StatusCode {
caused by exhausting some resource (use RESOURCE_EXHAUSTED caused by exhausting some resource (use RESOURCE_EXHAUSTED
instead for those errors). PERMISSION_DENIED must not be instead for those errors). PERMISSION_DENIED must not be
used if the caller can not be identified (use UNAUTHENTICATED used if the caller can not be identified (use UNAUTHENTICATED
instead for those errors). instead for those errors). */
HTTP Mapping: 403 Forbidden */
PERMISSION_DENIED = 7, PERMISSION_DENIED = 7,
/* The request does not have valid authentication credentials for the /* The request does not have valid authentication credentials for the
operation. operation. */
HTTP Mapping: 401 Unauthorized */
UNAUTHENTICATED = 16, UNAUTHENTICATED = 16,
/* Some resource has been exhausted, perhaps a per-user quota, or /* Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space. perhaps the entire file system is out of space. */
HTTP Mapping: 429 Too Many Requests */
RESOURCE_EXHAUSTED = 8, RESOURCE_EXHAUSTED = 8,
/* Operation was rejected because the system is not in a state /* Operation was rejected because the system is not in a state
@ -124,23 +104,14 @@ enum StatusCode {
(d) Use FAILED_PRECONDITION if the client performs conditional (d) Use FAILED_PRECONDITION if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting server does not match the condition. E.g., conflicting
read-modify-write on the same resource. read-modify-write on the same resource. */
HTTP Mapping: 400 Bad Request
NOTE: HTTP spec says 412 Precondition Failed should only be used if
the request contains Etag related headers. So if the server does see
Etag related headers in the request, it may choose to return 412
instead of 400 for this error code. */
FAILED_PRECONDITION = 9, FAILED_PRECONDITION = 9,
/* The operation was aborted, typically due to a concurrency issue /* The operation was aborted, typically due to a concurrency issue
like sequencer check failures, transaction aborts, etc. like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 409 Conflict */
ABORTED = 10, ABORTED = 10,
/* Operation was attempted past the valid range. E.g., seeking or /* Operation was attempted past the valid range. E.g., seeking or
@ -157,21 +128,15 @@ enum StatusCode {
OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
error) when it applies so that callers who are iterating through error) when it applies so that callers who are iterating through
a space can easily look for an OUT_OF_RANGE error to detect when a space can easily look for an OUT_OF_RANGE error to detect when
they are done. they are done. */
HTTP Mapping: 400 Bad Request */
OUT_OF_RANGE = 11, OUT_OF_RANGE = 11,
/* Operation is not implemented or not supported/enabled in this service. /* Operation is not implemented or not supported/enabled in this service. */
HTTP Mapping: 501 Not Implemented */
UNIMPLEMENTED = 12, UNIMPLEMENTED = 12,
/* Internal errors. Means some invariants expected by underlying /* Internal errors. Means some invariants expected by underlying
system has been broken. If you see one of these errors, system has been broken. If you see one of these errors,
something is very broken. something is very broken. */
HTTP Mapping: 500 Internal Server Error */
INTERNAL = 13, INTERNAL = 13,
/* The service is currently unavailable. This is a most likely a /* The service is currently unavailable. This is a most likely a
@ -179,14 +144,10 @@ enum StatusCode {
a backoff. a backoff.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 503 Service Unavailable */
UNAVAILABLE = 14, UNAVAILABLE = 14,
/* Unrecoverable data loss or corruption. /* Unrecoverable data loss or corruption. */
HTTP Mapping: 500 Internal Server Error */
DATA_LOSS = 15, DATA_LOSS = 15,
/* Force users to include a default branch: */ /* Force users to include a default branch: */

73
include/grpc/status.h
Unescape View File

@ -39,51 +39,37 @@ extern "C" {
#endif #endif
typedef enum { typedef enum {
/* Not an error; returned on success /* Not an error; returned on success */
HTTP Mapping: 200 OK */
GRPC_STATUS_OK = 0, GRPC_STATUS_OK = 0,
/* The operation was cancelled (typically by the caller). /* The operation was cancelled (typically by the caller). */
HTTP Mapping: 499 Client Closed Request */
GRPC_STATUS_CANCELLED = 1, GRPC_STATUS_CANCELLED = 1,
/* Unknown error. An example of where this error may be returned is /* Unknown error. An example of where this error may be returned is
if a Status value received from another address space belongs to if a Status value received from another address space belongs to
an error-space that is not known in this address space. Also an error-space that is not known in this address space. Also
errors raised by APIs that do not return enough error information errors raised by APIs that do not return enough error information
may be converted to this error. may be converted to this error. */
HTTP Mapping: 500 Internal Server Error */
GRPC_STATUS_UNKNOWN = 2, GRPC_STATUS_UNKNOWN = 2,
/* Client specified an invalid argument. Note that this differs /* Client specified an invalid argument. Note that this differs
from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
that are problematic regardless of the state of the system that are problematic regardless of the state of the system
(e.g., a malformed file name). (e.g., a malformed file name). */
HTTP Mapping: 400 Bad Request */
GRPC_STATUS_INVALID_ARGUMENT = 3, GRPC_STATUS_INVALID_ARGUMENT = 3,
/* Deadline expired before operation could complete. For operations /* Deadline expired before operation could complete. For operations
that change the state of the system, this error may be returned that change the state of the system, this error may be returned
even if the operation has completed successfully. For example, a even if the operation has completed successfully. For example, a
successful response from a server could have been delayed long successful response from a server could have been delayed long
enough for the deadline to expire. enough for the deadline to expire. */
HTTP Mapping: 504 Gateway Timeout */
GRPC_STATUS_DEADLINE_EXCEEDED = 4, GRPC_STATUS_DEADLINE_EXCEEDED = 4,
/* Some requested entity (e.g., file or directory) was not found. /* Some requested entity (e.g., file or directory) was not found. */
HTTP Mapping: 404 Not Found */
GRPC_STATUS_NOT_FOUND = 5, GRPC_STATUS_NOT_FOUND = 5,
/* Some entity that we attempted to create (e.g., file or directory) /* Some entity that we attempted to create (e.g., file or directory)
already exists. already exists. */
HTTP Mapping: 409 Conflict */
GRPC_STATUS_ALREADY_EXISTS = 6, GRPC_STATUS_ALREADY_EXISTS = 6,
/* The caller does not have permission to execute the specified /* The caller does not have permission to execute the specified
@ -91,21 +77,15 @@ typedef enum {
caused by exhausting some resource (use RESOURCE_EXHAUSTED caused by exhausting some resource (use RESOURCE_EXHAUSTED
instead for those errors). PERMISSION_DENIED must not be instead for those errors). PERMISSION_DENIED must not be
used if the caller can not be identified (use UNAUTHENTICATED used if the caller can not be identified (use UNAUTHENTICATED
instead for those errors). instead for those errors). */
HTTP Mapping: 403 Forbidden */
GRPC_STATUS_PERMISSION_DENIED = 7, GRPC_STATUS_PERMISSION_DENIED = 7,
/* The request does not have valid authentication credentials for the /* The request does not have valid authentication credentials for the
operation. operation. */
HTTP Mapping: 401 Unauthorized */
GRPC_STATUS_UNAUTHENTICATED = 16, GRPC_STATUS_UNAUTHENTICATED = 16,
/* Some resource has been exhausted, perhaps a per-user quota, or /* Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space. perhaps the entire file system is out of space. */
HTTP Mapping: 429 Too Many Requests */
GRPC_STATUS_RESOURCE_EXHAUSTED = 8, GRPC_STATUS_RESOURCE_EXHAUSTED = 8,
/* Operation was rejected because the system is not in a state /* Operation was rejected because the system is not in a state
@ -126,23 +106,14 @@ typedef enum {
(d) Use FAILED_PRECONDITION if the client performs conditional (d) Use FAILED_PRECONDITION if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting server does not match the condition. E.g., conflicting
read-modify-write on the same resource. read-modify-write on the same resource. */
HTTP Mapping: 400 Bad Request
NOTE: HTTP spec says 412 Precondition Failed should only be used if
the request contains Etag related headers. So if the server does see
Etag related headers in the request, it may choose to return 412
instead of 400 for this error code. */
GRPC_STATUS_FAILED_PRECONDITION = 9, GRPC_STATUS_FAILED_PRECONDITION = 9,
/* The operation was aborted, typically due to a concurrency issue /* The operation was aborted, typically due to a concurrency issue
like sequencer check failures, transaction aborts, etc. like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 409 Conflict */
GRPC_STATUS_ABORTED = 10, GRPC_STATUS_ABORTED = 10,
/* Operation was attempted past the valid range. E.g., seeking or /* Operation was attempted past the valid range. E.g., seeking or
@ -159,21 +130,15 @@ typedef enum {
OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
error) when it applies so that callers who are iterating through error) when it applies so that callers who are iterating through
a space can easily look for an OUT_OF_RANGE error to detect when a space can easily look for an OUT_OF_RANGE error to detect when
they are done. they are done. */
HTTP Mapping: 400 Bad Request */
GRPC_STATUS_OUT_OF_RANGE = 11, GRPC_STATUS_OUT_OF_RANGE = 11,
/* Operation is not implemented or not supported/enabled in this service. /* Operation is not implemented or not supported/enabled in this service. */
HTTP Mapping: 501 Not Implemented */
GRPC_STATUS_UNIMPLEMENTED = 12, GRPC_STATUS_UNIMPLEMENTED = 12,
/* Internal errors. Means some invariants expected by underlying /* Internal errors. Means some invariants expected by underlying
system has been broken. If you see one of these errors, system has been broken. If you see one of these errors,
something is very broken. something is very broken. */
HTTP Mapping: 500 Internal Server Error */
GRPC_STATUS_INTERNAL = 13, GRPC_STATUS_INTERNAL = 13,
/* The service is currently unavailable. This is a most likely a /* The service is currently unavailable. This is a most likely a
@ -181,14 +146,10 @@ typedef enum {
a backoff. a backoff.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 503 Service Unavailable */
GRPC_STATUS_UNAVAILABLE = 14, GRPC_STATUS_UNAVAILABLE = 14,
/* Unrecoverable data loss or corruption. /* Unrecoverable data loss or corruption. */
HTTP Mapping: 500 Internal Server Error */
GRPC_STATUS_DATA_LOSS = 15, GRPC_STATUS_DATA_LOSS = 15,
/* Force users to include a default branch: */ /* Force users to include a default branch: */

73
src/csharp/Grpc.Core/StatusCode.cs
Unescape View File

@ -41,64 +41,44 @@ namespace Grpc.Core
/// </summary> /// </summary>
public enum StatusCode public enum StatusCode
{ {
/* Not an error; returned on success /* Not an error; returned on success */
HTTP Mapping: 200 OK */
OK = 0, OK = 0,
/* The operation was cancelled (typically by the caller). /* The operation was cancelled (typically by the caller). */
HTTP Mapping: 499 Client Closed Request */
Cancelled = 1, Cancelled = 1,
/* Unknown error. An example of where this error may be returned is /* Unknown error. An example of where this error may be returned is
if a Status value received from another address space belongs to if a Status value received from another address space belongs to
an error-space that is not known in this address space. Also an error-space that is not known in this address space. Also
errors raised by APIs that do not return enough error information errors raised by APIs that do not return enough error information
may be converted to this error. may be converted to this error. */
HTTP Mapping: 500 Internal Server Error */
Unknown = 2, Unknown = 2,
/* Client specified an invalid argument. Note that this differs /* Client specified an invalid argument. Note that this differs
from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
that are problematic regardless of the state of the system that are problematic regardless of the state of the system
(e.g., a malformed file name). (e.g., a malformed file name). */
HTTP Mapping: 400 Bad Request */
InvalidArgument = 3, InvalidArgument = 3,
/* Deadline expired before operation could complete. For operations /* Deadline expired before operation could complete. For operations
that change the state of the system, this error may be returned that change the state of the system, this error may be returned
even if the operation has completed successfully. For example, a even if the operation has completed successfully. For example, a
successful response from a server could have been delayed long successful response from a server could have been delayed long
enough for the deadline to expire. enough for the deadline to expire. */
HTTP Mapping: 504 Gateway Timeout */
DeadlineExceeded = 4, DeadlineExceeded = 4,
/* Some requested entity (e.g., file or directory) was not found. /* Some requested entity (e.g., file or directory) was not found. */
HTTP Mapping: 404 Not Found */
NotFound = 5, NotFound = 5,
/* Some entity that we attempted to create (e.g., file or directory) /* Some entity that we attempted to create (e.g., file or directory)
already exists. already exists. */
HTTP Mapping: 409 Conflict */
AlreadyExists = 6, AlreadyExists = 6,
/* The caller does not have permission to execute the specified /* The caller does not have permission to execute the specified
operation. PERMISSION_DENIED must not be used for rejections operation. PERMISSION_DENIED must not be used for rejections
caused by exhausting some resource (use RESOURCE_EXHAUSTED caused by exhausting some resource (use RESOURCE_EXHAUSTED
instead for those errors). PERMISSION_DENIED must not be instead for those errors). PERMISSION_DENIED must not be
used if the caller can not be identified (use UNAUTHENTICATED used if the caller can not be identified (use UNAUTHENTICATED
instead for those errors). instead for those errors). */
HTTP Mapping: 403 Forbidden */
PermissionDenied = 7, PermissionDenied = 7,
/* The request does not have valid authentication credentials for the /* The request does not have valid authentication credentials for the
operation. operation. */
HTTP Mapping: 401 Unauthorized */
Unauthenticated = 16, Unauthenticated = 16,
/* Some resource has been exhausted, perhaps a per-user quota, or /* Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space. perhaps the entire file system is out of space. */
HTTP Mapping: 429 Too Many Requests */
ResourceExhausted = 8, ResourceExhausted = 8,
/* Operation was rejected because the system is not in a state /* Operation was rejected because the system is not in a state
required for the operation's execution. For example, directory required for the operation's execution. For example, directory
@ -118,22 +98,13 @@ namespace Grpc.Core
(d) Use FAILED_PRECONDITION if the client performs conditional (d) Use FAILED_PRECONDITION if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting server does not match the condition. E.g., conflicting
read-modify-write on the same resource. read-modify-write on the same resource. */
HTTP Mapping: 400 Bad Request
NOTE: HTTP spec says 412 Precondition Failed should only be used if
the request contains Etag related headers. So if the server does see
Etag related headers in the request, it may choose to return 412
instead of 400 for this error code. */
FailedPrecondition = 9, FailedPrecondition = 9,
/* The operation was aborted, typically due to a concurrency issue /* The operation was aborted, typically due to a concurrency issue
like sequencer check failures, transaction aborts, etc. like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 409 Conflict */
Aborted = 10, Aborted = 10,
/* Operation was attempted past the valid range. E.g., seeking or /* Operation was attempted past the valid range. E.g., seeking or
reading past end of file. reading past end of file.
@ -149,32 +120,22 @@ namespace Grpc.Core
OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
error) when it applies so that callers who are iterating through error) when it applies so that callers who are iterating through
a space can easily look for an OUT_OF_RANGE error to detect when a space can easily look for an OUT_OF_RANGE error to detect when
they are done. they are done. */
HTTP Mapping: 400 Bad Request */
OutOfRange = 11, OutOfRange = 11,
/* Operation is not implemented or not supported/enabled in this service. /* Operation is not implemented or not supported/enabled in this service. */
HTTP Mapping: 501 Not Implemented */
Unimplemented = 12, Unimplemented = 12,
/* Internal errors. Means some invariants expected by underlying /* Internal errors. Means some invariants expected by underlying
system has been broken. If you see one of these errors, system has been broken. If you see one of these errors,
something is very broken. something is very broken. */
HTTP Mapping: 500 Internal Server Error */
Internal = 13, Internal = 13,
/* The service is currently unavailable. This is a most likely a /* The service is currently unavailable. This is a most likely a
transient condition and may be corrected by retrying with transient condition and may be corrected by retrying with
a backoff. a backoff.
See litmus test above for deciding between FAILED_PRECONDITION, See litmus test above for deciding between FAILED_PRECONDITION,
ABORTED, and UNAVAILABLE. ABORTED, and UNAVAILABLE. */
HTTP Mapping: 503 Service Unavailable */
Unavailable = 14, Unavailable = 14,
/* Unrecoverable data loss or corruption. /* Unrecoverable data loss or corruption. */
HTTP Mapping: 500 Internal Server Error */
DataLoss = 15 DataLoss = 15
} }
} }

Write Preview
Loading…
Cancel
Save