/* * Copyright 2019 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. * */ import { EventEmitter } from 'events'; import { Duplex, Readable, Writable } from 'stream'; import { StatusObject, MessageContext } from './call-stream'; import { Status } from './constants'; import { EmitterAugmentation1 } from './events'; import { Metadata } from './metadata'; import { ObjectReadable, ObjectWritable, WriteCallback } from './object-stream'; import { InterceptingCallInterface } from './client-interceptors'; /** * A type extending the built-in Error object with additional fields. */ export type ServiceError = StatusObject & Error; /** * A base type for all user-facing values returned by client-side method calls. */ export type SurfaceCall = { call?: InterceptingCallInterface; cancel(): void; getPeer(): string; } & EmitterAugmentation1<'metadata', Metadata> & EmitterAugmentation1<'status', StatusObject> & EventEmitter; /** * A type representing the return value of a unary method call. */ export type ClientUnaryCall = SurfaceCall; /** * A type representing the return value of a server stream method call. */ export type ClientReadableStream = { deserialize: (chunk: Buffer) => ResponseType; } & SurfaceCall & ObjectReadable; /** * A type representing the return value of a client stream method call. */ export type ClientWritableStream = { serialize: (value: RequestType) => Buffer; } & SurfaceCall & ObjectWritable; /** * A type representing the return value of a bidirectional stream method call. */ export type ClientDuplexStream< RequestType, ResponseType > = ClientWritableStream & ClientReadableStream; /** * Construct a ServiceError from a StatusObject. This function exists primarily * as an attempt to make the error stack trace clearly communicate that the * error is not necessarily a problem in gRPC itself. * @param status */ export function callErrorFromStatus(status: StatusObject, callerStack: string): ServiceError { const message = `${status.code} ${Status[status.code]}: ${status.details}`; const error = new Error(message); const stack = `${error.stack}\nfor call at\n${callerStack}`; return Object.assign(new Error(message), status, {stack}); } export class ClientUnaryCallImpl extends EventEmitter implements ClientUnaryCall { public call?: InterceptingCallInterface; constructor() { super(); } cancel(): void { this.call?.cancelWithStatus(Status.CANCELLED, 'Cancelled on client'); } getPeer(): string { return this.call?.getPeer() ?? 'unknown'; } } export class ClientReadableStreamImpl extends Readable implements ClientReadableStream { public call?: InterceptingCallInterface; constructor(readonly deserialize: (chunk: Buffer) => ResponseType) { super({ objectMode: true }); } cancel(): void { this.call?.cancelWithStatus(Status.CANCELLED, 'Cancelled on client'); } getPeer(): string { return this.call?.getPeer() ?? 'unknown'; } _read(_size: number): void { this.call?.startRead(); } } export class ClientWritableStreamImpl extends Writable implements ClientWritableStream { public call?: InterceptingCallInterface; constructor(readonly serialize: (value: RequestType) => Buffer) { super({ objectMode: true }); } cancel(): void { this.call?.cancelWithStatus(Status.CANCELLED, 'Cancelled on client'); } getPeer(): string { return this.call?.getPeer() ?? 'unknown'; } _write(chunk: RequestType, encoding: string, cb: WriteCallback) { const context: MessageContext = { callback: cb, }; const flags = Number(encoding); if (!Number.isNaN(flags)) { context.flags = flags; } this.call?.sendMessageWithContext(context, chunk); } _final(cb: Function) { this.call?.halfClose(); cb(); } } export class ClientDuplexStreamImpl extends Duplex implements ClientDuplexStream { public call?: InterceptingCallInterface; constructor( readonly serialize: (value: RequestType) => Buffer, readonly deserialize: (chunk: Buffer) => ResponseType ) { super({ objectMode: true }); } cancel(): void { this.call?.cancelWithStatus(Status.CANCELLED, 'Cancelled on client'); } getPeer(): string { return this.call?.getPeer() ?? 'unknown'; } _read(_size: number): void { this.call?.startRead(); } _write(chunk: RequestType, encoding: string, cb: WriteCallback) { const context: MessageContext = { callback: cb, }; const flags = Number(encoding); if (!Number.isNaN(flags)) { context.flags = flags; } this.call?.sendMessageWithContext(context, chunk); } _final(cb: Function) { this.call?.halfClose(); cb(); } }