feat: map http status code to grpc status code (#1135)

src/googleError.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import {Status} from './status';
+import {Status, rpcCodeFromHttpStatusCode} from './status';
 import * as protobuf from 'protobufjs';
 import {Metadata} from './grpc';
 
@@ -63,6 +63,11 @@ export class GoogleError extends Error {
       new GoogleError(json['error']['message']),
       json.error
     );
+    // Map Http Status Code to gRPC Status Code
+    if (json['error']['code']) {
+      error.code = rpcCodeFromHttpStatusCode(json['error']['code']);
+    }
+
     // Keep consistency with gRPC statusDetails fields. gRPC details has been occupied before.
     // Rename "detials" to "statusDetails".
     error.statusDetails = json['error']['details'];

src/status.ts

@@ -38,3 +38,38 @@ export enum Status {
   DATA_LOSS,
   UNAUTHENTICATED,
 }
+
+export const HttpCodeToRpcCodeMap = new Map([
+  [400, Status.INVALID_ARGUMENT],
+  [401, Status.UNAUTHENTICATED],
+  [403, Status.PERMISSION_DENIED],
+  [404, Status.NOT_FOUND],
+  [409, Status.ABORTED],
+  [416, Status.OUT_OF_RANGE],
+  [429, Status.RESOURCE_EXHAUSTED],
+  [499, Status.CANCELLED],
+  [501, Status.UNIMPLEMENTED],
+  [503, Status.UNAVAILABLE],
+  [504, Status.DEADLINE_EXCEEDED],
+]);
+
+// Maps HTTP status codes to gRPC status codes above.
+export function rpcCodeFromHttpStatusCode(httpStatusCode: number): number {
+  if (HttpCodeToRpcCodeMap.has(httpStatusCode)) {
+    return HttpCodeToRpcCodeMap.get(httpStatusCode)!;
+  }
+  // All 2xx
+  if (httpStatusCode >= 200 && httpStatusCode < 300) {
+    return Status.OK;
+  }
+  // All other 4xx
+  if (httpStatusCode >= 400 && httpStatusCode < 500) {
+    return Status.FAILED_PRECONDITION;
+  }
+  // All other 5xx
+  if (httpStatusCode >= 500 && httpStatusCode < 600) {
+    return Status.INTERNAL;
+  }
+  // Everything else
+  return Status.UNKNOWN;
+}

test/unit/googleError.ts

@@ -22,6 +22,7 @@ import * as protobuf from 'protobufjs';
 import * as path from 'path';
 import {GoogleError, GoogleErrorDecoder} from '../../src/googleError';
 import {Metadata} from '@grpc/grpc-js';
+import {rpcCodeFromHttpStatusCode} from '../../src/status';
 
 interface MyObj {
   type: string;
@@ -273,3 +274,30 @@ describe('parse grpc status details with ErrorInfo from grpc metadata', () => {
     assert.strictEqual(decodedError, grpcError);
   });
 });
+
+describe('map http status code to gRPC status code', () => {
+  it('error with http status code', () => {
+    const json = {
+      error: {
+        code: 403,
+        message:
+          'Cloud Translation API has not been used in project 123 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/translate.googleapis.com/overview?project=455411330361 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.',
+        status: 'PERMISSION_DENIED',
+      },
+    };
+    const error = GoogleError.parseHttpError(json);
+    assert.deepStrictEqual(error.code, rpcCodeFromHttpStatusCode(403));
+  });
+
+  it('error without http status code', () => {
+    const json = {
+      error: {
+        message:
+          'Cloud Translation API has not been used in project 123 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/translate.googleapis.com/overview?project=455411330361 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.',
+        status: 'PERMISSION_DENIED',
+      },
+    };
+    const error = GoogleError.parseHttpError(json);
+    assert.deepStrictEqual(error.code, undefined);
+  });
+});

test/unit/grpc-fallback.ts

@@ -379,7 +379,7 @@ describe('grpc-fallback', () => {
           JSON.stringify(err.statusDetails),
           JSON.stringify(serverError['error']['details'])
         );
-        assert.strictEqual(err.code, serverError['error']['code']);
+        assert.strictEqual(err.code, 7);
         assert.strictEqual(err.message, serverError['error']['message']);
         assert.strictEqual(err.reason, errorInfo.reason);
         assert.strictEqual(err.domain, errorInfo.domain);

test/unit/status.ts

@@ -0,0 +1,68 @@
+/**
+ * Copyright 2021 Google LLC
+ *
+ * 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 * as assert from 'assert';
+import {describe, it} from 'mocha';
+import {rpcCodeFromHttpStatusCode, Status} from '../../src/status';
+
+describe('status.ts', () => {
+  it('rpcCodeFromHttpStatusCode', () => {
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(200), Status.OK);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(206), Status.OK);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(300), Status.UNKNOWN);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(307), Status.UNKNOWN);
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(400),
+      Status.INVALID_ARGUMENT
+    );
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(401),
+      Status.UNAUTHENTICATED
+    );
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(403),
+      Status.PERMISSION_DENIED
+    );
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(404), Status.NOT_FOUND);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(409), Status.ABORTED);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(416), Status.OUT_OF_RANGE);
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(429),
+      Status.RESOURCE_EXHAUSTED
+    );
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(499), Status.CANCELLED);
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(451),
+      Status.FAILED_PRECONDITION
+    );
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(411),
+      Status.FAILED_PRECONDITION
+    );
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(501),
+      Status.UNIMPLEMENTED
+    );
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(503), Status.UNAVAILABLE);
+    assert.deepStrictEqual(
+      rpcCodeFromHttpStatusCode(504),
+      Status.DEADLINE_EXCEEDED
+    );
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(505), Status.INTERNAL);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(510), Status.INTERNAL);
+    assert.deepStrictEqual(rpcCodeFromHttpStatusCode(100), Status.UNKNOWN);
+  });
+});