Merge pull request #2354 from murgatroid99/grpc-js_typescript_update_1.6.x

grpc-js: Update to newest typescript compiler (1.6.x)

packages/grpc-js/package.json

@@ -17,14 +17,14 @@
   "devDependencies": {
     "@types/gulp": "^4.0.6",
     "@types/gulp-mocha": "0.0.32",
-    "@types/lodash": "^4.14.108",
+    "@types/lodash": "^4.14.186",
     "@types/mocha": "^5.2.6",
     "@types/ncp": "^2.0.1",
     "@types/pify": "^3.0.2",
     "@types/semver": "^7.3.9",
     "clang-format": "^1.0.55",
     "execa": "^2.0.3",
-    "gts": "^2.0.0",
+    "gts": "^3.1.1",
     "gulp": "^4.0.2",
     "gulp-mocha": "^6.0.0",
     "lodash": "^4.17.4",
@@ -35,7 +35,7 @@
     "rimraf": "^3.0.2",
     "semver": "^7.3.5",
     "ts-node": "^8.3.0",
-    "typescript": "^3.7.2"
+    "typescript": "^4.8.4"
   },
   "contributors": [
     {

packages/grpc-js/src/call-credentials-filter.ts

@@ -22,6 +22,7 @@ import { Metadata } from './metadata';
 import { Status } from './constants';
 import { splitHostPort } from './uri-parser';
 import { ServiceError } from './call';
+import { getErrorMessage } from './error';
 
 export class CallCredentialsFilter extends BaseFilter implements Filter {
   private serviceUrl: string;
@@ -57,7 +58,7 @@ export class CallCredentialsFilter extends BaseFilter implements Filter {
     } catch (error) {
       this.stream.cancelWithStatus(
         Status.UNAUTHENTICATED,
-        `Failed to retrieve auth metadata with error: ${error.message}`
+        `Failed to retrieve auth metadata with error: ${getErrorMessage(error)}`
       );
       return Promise.reject<Metadata>('Failed to retrieve auth metadata');
     }

packages/grpc-js/src/call-credentials.ts

@@ -115,6 +115,10 @@ export abstract class CallCredentials {
                 reject(err);
                 return;
               }
+              if (!headers) {
+                reject(new Error('Headers not set by metadata plugin'));
+                return;
+              }
               resolve(headers);
             }
           );

packages/grpc-js/src/call-stream.ts

@@ -29,6 +29,7 @@ import { SubchannelCallStatsTracker, Subchannel } from './subchannel';
 import * as logging from './logging';
 import { LogVerbosity } from './constants';
 import { ServerSurfaceCall } from './server-call';
+import { getErrorMessage } from './error';
 
 const TRACER_NAME = 'call_stream';
 
@@ -565,7 +566,7 @@ export class Http2CallStream implements Call {
           } catch (error) {
             this.endCall({
               code: Status.UNKNOWN,
-              details: error.message,
+              details: getErrorMessage(error),
               metadata: new Metadata(),
             });
             return;
@@ -576,7 +577,7 @@ export class Http2CallStream implements Call {
           } catch (error) {
             this.endCall({
               code: Status.UNKNOWN,
-              details: error.message,
+              details: getErrorMessage(error),
               metadata: new Metadata(),
             });
           }
@@ -716,7 +717,7 @@ export class Http2CallStream implements Call {
         } catch (error) {
           this.endCall({
             code: Status.UNAVAILABLE,
-            details: `Write failed with error ${error.message}`,
+            details: `Write failed with error ${getErrorMessage(error)}`,
             metadata: new Metadata()
           });
         }
@@ -878,7 +879,7 @@ export class Http2CallStream implements Call {
         }  catch (error) {
           this.endCall({
             code: Status.UNAVAILABLE,
-            details: `Write failed with error ${error.message}`,
+            details: `Write failed with error ${getErrorMessage(error)}`,
             metadata: new Metadata()
           });
         }

packages/grpc-js/src/client-interceptors.ts

@@ -34,6 +34,7 @@ import { Channel } from './channel';
 import { CallOptions } from './client';
 import { CallCredentials } from './call-credentials';
 import { ClientMethodDefinition } from './make-client';
+import { getErrorMessage } from './error';
 
 /**
  * Error class associated with passing both interceptors and interceptor
@@ -382,7 +383,7 @@ class BaseInterceptingCall implements InterceptingCallInterface {
     } catch (e) {
       this.call.cancelWithStatus(
         Status.INTERNAL,
-        `Request message serialization failure: ${e.message}`
+        `Request message serialization failure: ${getErrorMessage(e)}`
       );
       return;
     }
@@ -409,7 +410,7 @@ class BaseInterceptingCall implements InterceptingCallInterface {
         } catch (e) {
           readError = {
             code: Status.INTERNAL,
-            details: `Response message parsing error: ${e.message}`,
+            details: `Response message parsing error: ${getErrorMessage(e)}`,
             metadata: new Metadata(),
           };
           this.call.cancelWithStatus(readError.code, readError.details);

packages/grpc-js/src/error.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2022 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.
+ *
+ */
+
+export function getErrorMessage(error: unknown): string {
+  if (error instanceof Error) {
+    return error.message;
+  } else {
+    return String(error);
+  }
+}
+
+export function getErrorCode(error: unknown): number | null {
+  if (
+    typeof error === 'object' &&
+    error !== null &&
+    'code' in error &&
+    typeof (error as Record<string, unknown>).code === 'number'
+  ) {
+    return (error as Record<string, number>).code;
+  } else {
+    return null;
+  }
+}

packages/grpc-js/src/metadata.ts

@@ -18,6 +18,7 @@
 import * as http2 from 'http2';
 import { log } from './logging';
 import { LogVerbosity } from './constants';
+import { getErrorMessage } from './error';
 const LEGAL_KEY_REGEX = /^[0-9a-z_.-]+$/;
 const LEGAL_NON_BINARY_VALUE_REGEX = /^[ -~]*$/;
 
@@ -294,7 +295,7 @@ export class Metadata {
           }
         }
       } catch (error) {
-        const message = `Failed to add metadata entry ${key}: ${values}. ${error.message}. For more information see https://github.com/grpc/grpc-node/issues/1173`;
+        const message = `Failed to add metadata entry ${key}: ${values}. ${getErrorMessage(error)}. For more information see https://github.com/grpc/grpc-node/issues/1173`;
         log(LogVerbosity.ERROR, message);
       }
     });

packages/grpc-js/src/server-call.ts

@@ -33,6 +33,7 @@ import { StreamDecoder } from './stream-decoder';
 import { ObjectReadable, ObjectWritable } from './object-stream';
 import { ChannelOptions } from './channel-options';
 import * as logging from './logging';
+import { getErrorCode, getErrorMessage } from './error';
 
 const TRACER_NAME = 'server_call';
 
@@ -216,8 +217,10 @@ export class ServerWritableStreamImpl<RequestType, ResponseType>
         return;
       }
     } catch (err) {
-      err.code = Status.INTERNAL;
+      this.emit('error', {
-      this.emit('error', err);
+        details: getErrorMessage(err),
+        code: Status.INTERNAL
+      });
     }
 
     callback();
@@ -444,7 +447,7 @@ export class Http2ServerCallStream<
   private getDecompressedMessage(message: Buffer, encoding: string) {
     switch (encoding) {
       case 'deflate': {
-        return new Promise<Buffer | undefined>((resolve, reject) => {
+        return new Promise<Buffer | void>((resolve, reject) => {
           zlib.inflate(message.slice(5), (err, output) => {
             if (err) {
               this.sendError({
@@ -460,7 +463,7 @@ export class Http2ServerCallStream<
       }
   
       case 'gzip': {
-        return new Promise<Buffer | undefined>((resolve, reject) => {
+        return new Promise<Buffer | void>((resolve, reject) => {
           zlib.unzip(message.slice(5), (err, output) => {
             if (err) {
               this.sendError({
@@ -539,7 +542,7 @@ export class Http2ServerCallStream<
     return metadata;
   }
 
-  receiveUnaryMessage(encoding: string): Promise<RequestType> {
+  receiveUnaryMessage(encoding: string): Promise<RequestType | void> {
     return new Promise((resolve, reject) => {
       const stream = this.stream;
       const chunks: Buffer[] = [];
@@ -579,8 +582,10 @@ export class Http2ServerCallStream<
             resolve(this.deserializeMessage(decompressedMessage));
           }
         } catch (err) {
-          err.code = Status.INTERNAL;
+          this.sendError({
-          this.sendError(err);
+            code: Status.INTERNAL,
+            details: getErrorMessage(err)
+          });
           resolve();
         }
       });
@@ -630,8 +635,10 @@ export class Http2ServerCallStream<
       this.write(response);
       this.sendStatus({ code: Status.OK, details: 'OK', metadata });
     } catch (err) {
-      err.code = Status.INTERNAL;
+      this.sendError({
-      this.sendError(err);
+        details: getErrorMessage(err),
+        code: Status.INTERNAL
+      });
     }
   }
 
@@ -856,21 +863,15 @@ export class Http2ServerCallStream<
     } catch (error) {
       // Ignore any remaining messages when errors occur.
       this.bufferedMessages.length = 0;
-
+      let code = getErrorCode(error);
-      if (
+      if (code === null || code < Status.OK || code > Status.UNAUTHENTICATED) {
-        !(
+        code = Status.INTERNAL
-          'code' in error &&
-          typeof error.code === 'number' &&
-          Number.isInteger(error.code) &&
-          error.code >= Status.OK &&
-          error.code <= Status.UNAUTHENTICATED
-        )
-      ) {
-        // The error code is not a valid gRPC code so its being overwritten.
-        error.code = Status.INTERNAL;
       }
 
-      readable.emit('error', error);
+      readable.emit('error', {
+        details: getErrorMessage(error),
+        code: code
+      });
     }
 
     this.isPushPending = false;

packages/grpc-js/src/server.ts

@@ -61,6 +61,7 @@ import {
 import { parseUri } from './uri-parser';
 import { ChannelzCallTracker, ChannelzChildrenTracker, ChannelzTrace, registerChannelzServer, registerChannelzSocket, ServerInfo, ServerRef, SocketInfo, SocketRef, TlsInfo, unregisterChannelzRef } from './channelz';
 import { CipherNameAndProtocol, TLSSocket } from 'tls';
+import { getErrorCode, getErrorMessage } from './error';
 
 const TRACER_NAME = 'server';
 
@@ -859,11 +860,10 @@ export class Server {
             }
           }
 
-          if (err.code === undefined) {
+          call.sendError({
-            err.code = Status.INTERNAL;
+            code: getErrorCode(err) ?? Status.INTERNAL,
-          }
+            details: getErrorMessage(err)
-
+          });
-          call.sendError(err);
         }
       }
     );