# All files / remote rpc_error.ts

72.73% Statements 72/99
63.64% Branches 56/88
100% Functions 6/6
75% Lines 72/96

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273

    2x
    2x
    2x

    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x

    2x
    134x

    28x

    106x

    2x

    7x
    7x

    7x

    2x
    143x

    143x

    2x

    2x

    2x

    10x

    2x

    62x

    2x

    3x

    8x

    2x

    38x

    2x

    2x

    2x

    2x

    2x

    2x
    610x
    470x

    140x

    2x

    2x

    2x

    14x

    2x

    62x

    2x

    2x

    2x

    2x

    38x

    2x

    2x

    2x

    2x

    2x

    2x

    36x

    24x

    12x

     /**
     * Copyright 2017 Google Inc.
     *
     * 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.
     */

    import { fail } from '../util/assert';
    import { Code } from '../util/error';
    import * as log from '../util/log';

    /**
     * Error Codes describing the different ways GRPC can fail. These are copied
     * directly from GRPC's sources here:
     *
     * https://github.com/grpc/grpc/blob/bceec94ea4fc5f0085d81235d8e1c06798dc341a/include/grpc%2B%2B/impl/codegen/status_code_enum.h
     *
     * Important! The names of these identifiers matter because the string forms
     * are used for reverse lookups from the webchannel stream. Do NOT change the
     * names of these identifiers.
     */
    enum RpcCode {
      OK = 0,
      CANCELLED = 1,
      UNKNOWN = 2,
      INVALID_ARGUMENT = 3,
      DEADLINE_EXCEEDED = 4,
      NOT_FOUND = 5,
      ALREADY_EXISTS = 6,
      PERMISSION_DENIED = 7,
      UNAUTHENTICATED = 16,
      RESOURCE_EXHAUSTED = 8,
      FAILED_PRECONDITION = 9,
      ABORTED = 10,
      OUT_OF_RANGE = 11,
      UNIMPLEMENTED = 12,
      INTERNAL = 13,
      UNAVAILABLE = 14,
      DATA_LOSS = 15
    }

    export function isPermanentError(code: Code): boolean {
      switch (code) {
        case Code.OK:
          return fail('Treated status OK as error');
        case Code.CANCELLED:
        case Code.UNKNOWN:
        case Code.DEADLINE_EXCEEDED:
        case Code.RESOURCE_EXHAUSTED:
        case Code.INTERNAL:
        case Code.UNAVAILABLE:
        // Unauthenticated means something went wrong with our token and we need
        // to retry with new credentials which will happen automatically.
        // TODO(b/37325376): Give up after second unauthenticated error.
        case Code.UNAUTHENTICATED:
          return false;
        case Code.INVALID_ARGUMENT:
        case Code.NOT_FOUND:
        case Code.ALREADY_EXISTS:
        case Code.PERMISSION_DENIED:
        case Code.FAILED_PRECONDITION:
        // Aborted might be retried in some scenarios, but that is dependant on
        // the context and should handled individually by the calling code.
        // See https://cloud.google.com/apis/design/errors.
        case Code.ABORTED:
        case Code.OUT_OF_RANGE:
        case Code.UNIMPLEMENTED:
        case Code.DATA_LOSS:
          return true;
        default:
          return fail('Unknown status code: ' + code);
      }
    }

    /**
     * Maps an error Code from a GRPC status identifier like 'NOT_FOUND'.
     *
     * @returns The Code equivalent to the given status string or undefined if
     *     there is no match.
     */
    export function mapCodeFromRpcStatus(status: string): Code | undefined {
      // tslint:disable-next-line:no-any lookup by string
      const code: RpcCode = RpcCode[status as any] as any;
      Iif (code === undefined) {
        return undefined;
      }

      return mapCodeFromRpcCode(code);
    }

    /**
     * Maps an error Code from GRPC status code number, like 0, 1, or 14. These
     * are not the same as HTTP status codes.
     *
     * @returns The Code equivalent to the given GRPC status code. Fails if there
     *     is no match.
     */
    export function mapCodeFromRpcCode(code: number | undefined): Code {
      Iif (code === undefined) {
        // This shouldn't normally happen, but in certain error cases (like trying
        // to send invalid proto messages) we may get an error with no GRPC code.
        log.error('GRPC error has no .code');
        return Code.UNKNOWN;
      }

      switch (code) {
        case RpcCode.OK:
          return Code.OK;
        case RpcCode.CANCELLED:
          return Code.CANCELLED;
        case RpcCode.UNKNOWN:
          return Code.UNKNOWN;
        case RpcCode.DEADLINE_EXCEEDED:
          return Code.DEADLINE_EXCEEDED;
        case RpcCode.RESOURCE_EXHAUSTED:
          return Code.RESOURCE_EXHAUSTED;
        case RpcCode.INTERNAL:
          return Code.INTERNAL;
        case RpcCode.UNAVAILABLE:
          return Code.UNAVAILABLE;
        case RpcCode.UNAUTHENTICATED:
          return Code.UNAUTHENTICATED;
        case RpcCode.INVALID_ARGUMENT:
          return Code.INVALID_ARGUMENT;
        case RpcCode.NOT_FOUND:
          return Code.NOT_FOUND;
        case RpcCode.ALREADY_EXISTS:
          return Code.ALREADY_EXISTS;
        case RpcCode.PERMISSION_DENIED:
          return Code.PERMISSION_DENIED;
        case RpcCode.FAILED_PRECONDITION:
          return Code.FAILED_PRECONDITION;
        case RpcCode.ABORTED:
          return Code.ABORTED;
        case RpcCode.OUT_OF_RANGE:
          return Code.OUT_OF_RANGE;
        case RpcCode.UNIMPLEMENTED:
          return Code.UNIMPLEMENTED;
        case RpcCode.DATA_LOSS:
          return Code.DATA_LOSS;
        default:
          return fail('Unknown status code: ' + code);
      }
    }

    /**
     * Maps an RPC code from a Code. This is the reverse operation from
     * mapCodeFromRpcCode and should really only be used in tests.
     */
    export function mapRpcCodeFromCode(code: Code | undefined): number {
      if (code === undefined) {
        return RpcCode.OK;
      }

      switch (code) {
        case Code.OK:
          return RpcCode.OK;
        case Code.CANCELLED:
          return RpcCode.CANCELLED;
        case Code.UNKNOWN:
          return RpcCode.UNKNOWN;
        case Code.DEADLINE_EXCEEDED:
          return RpcCode.DEADLINE_EXCEEDED;
        case Code.RESOURCE_EXHAUSTED:
          return RpcCode.RESOURCE_EXHAUSTED;
        case Code.INTERNAL:
          return RpcCode.INTERNAL;
        case Code.UNAVAILABLE:
          return RpcCode.UNAVAILABLE;
        case Code.UNAUTHENTICATED:
          return RpcCode.UNAUTHENTICATED;
        case Code.INVALID_ARGUMENT:
          return RpcCode.INVALID_ARGUMENT;
        case Code.NOT_FOUND:
          return RpcCode.NOT_FOUND;
        case Code.ALREADY_EXISTS:
          return RpcCode.ALREADY_EXISTS;
        case Code.PERMISSION_DENIED:
          return RpcCode.PERMISSION_DENIED;
        case Code.FAILED_PRECONDITION:
          return RpcCode.FAILED_PRECONDITION;
        case Code.ABORTED:
          return RpcCode.ABORTED;
        case Code.OUT_OF_RANGE:
          return RpcCode.OUT_OF_RANGE;
        case Code.UNIMPLEMENTED:
          return RpcCode.UNIMPLEMENTED;
        case Code.DATA_LOSS:
          return RpcCode.DATA_LOSS;
        default:
          return fail('Unknown status code: ' + code);
      }
    }

    /**
     * Converts an HTTP Status Code to the equivalent error code.
     *
     * @param status An HTTP Status Code, like 200, 404, 503, etc.
     * @returns The equivalent Code. Unknown status codes are mapped to
     *     Code.UNKNOWN.
     */
    export function mapCodeFromHttpStatus(status: number): Code {
      // The canonical error codes for Google APIs [1] specify mapping onto HTTP
      // status codes but the mapping is not bijective. In each case of ambiguity
      // this function chooses a primary error.
      //
      // [1]
      // https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
      switch (status) {
        case 200: // OK
          return Code.OK;

        case 400: // Bad Request
          return Code.INVALID_ARGUMENT;
        // Other possibilities based on the forward mapping
        // return Code.FAILED_PRECONDITION;
        // return Code.OUT_OF_RANGE;

        case 401: // Unauthorized
          return Code.UNAUTHENTICATED;

        case 403: // Forbidden
          return Code.PERMISSION_DENIED;

        case 404: // Not Found
          return Code.NOT_FOUND;

        case 409: // Conflict
          return Code.ABORTED;
        // Other possibilities:
        // return Code.ALREADY_EXISTS;

        case 416: // Range Not Satisfiable
          return Code.OUT_OF_RANGE;

        case 429: // Too Many Requests
          return Code.RESOURCE_EXHAUSTED;

        case 499: // Client Closed Request
          return Code.CANCELLED;

        case 500: // Internal Server Error
          return Code.UNKNOWN;
        // Other possibilities:
        // return Code.INTERNAL;
        // return Code.DATA_LOSS;

        case 501: // Unimplemented
          return Code.UNIMPLEMENTED;

        case 503: // Service Unavailable
          return Code.UNAVAILABLE;

        case 504: // Gateway Timeout
          return Code.DEADLINE_EXCEEDED;

        default:
          if (status >= 200 && status < 300) return Code.OK;
          if (status >= 400 && status < 500) return Code.FAILED_PRECONDITION;
          if (status >= 500 && status < 600) return Code.INTERNAL;
          return Code.UNKNOWN;
      }
    }