@byndyusoft/grpc-timeouts
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    grpc-timeouts

    npm version npm downloads dependencies dev dependencies Build Status

    Table of contents

    About

    grpc-timeouts is a small library that makes it easy to add customizable timeouts to your services. The library implements a circuit breaker pattern, which means that if the request exceeds the deadline, no further requests will be sent. If the deadline for a received request has expired, the request will not be processed and service instantly answers with code 4 (Deadline exceeded).

    Release New version

    For new version use https://github.com/semantic-release/semantic-release description. We must set commit message fix(pencil): New feature in release

    Installation

    npm i @byndyusoft/grpc-timeouts

    Usage

    ⚠️ Make sure that CircuitBreaker interceptors is the last added interceptor, because it will interrupt further processing of the request!

    const grpc = require("grpc")
    const { CircuitBreaker } = require("@byndyusoft/grpc-timeouts");
    const circuitBreaker = new CircuitBreaker();
    
    /*...*/
    
    // Client interceptor:
    const client = new grpc.Client(address, credentials, {
      interceptors: [circuitBreaker.clientInterceptor]
    });
    
    // Server interceptor: (with grpc-host-builder)
    const server = new GrpcHostBuilder()
      .addInterceptor(circuitBreaker.serverInterceptor)
      .addService(myService)
      .bind(grpcBind)
      .build()

    API

    CircuitBreaker

    constructor([options: ICircuitBreakerOptions])

    Options is an optional object with timeouts for methods (default timeout is 10 seconds).

    serverInterceptor

    IServerInterceptor

    Server interceptor function.

    clientInterceptor

    IClientInterceptor

    Client interceptor function.

    Type Definitions

    ICircuitBreakerOptions

    An object with following keys:

    • [timeouts: ITimeouts] - The longest time for the methods to respond
    • [minResponseTimeouts: ITimeouts] - The shortest time to wait for a response from the services
    {
      timeouts: {
        createOrder: 3000,
        updateOrder: 500,
        deleteOrder: 500,
        getOrder: 300,
        default: 5000 //default was 10000
      },
      minResponseTimeouts: {
        createOrder: 280,
        default: 50 //default was 0
      }
    }

    ITimeouts

    An object which keys is camelCased method names and values is milliseconds.
    This object also have default field that can be reassigned.

    IServerInterceptor

    (call: Object, methodDefinition: Object, next: Function) => Promise<Object>
    A function that can be used as server interceptor.

    IClientInterceptor

    (options: Object, next: Function) => grpc.InterceptingCall
    A function that can be used as client interceptor.

    Related

    grpc-host-builder

    Maintainers

    @Byndyusoft/owners: https://github.com/orgs/Byndyusoft/teams/owners, github.maintain@byndyusoft.com

    Install

    npm i @byndyusoft/grpc-timeouts

    DownloadsWeekly Downloads

    4

    Version

    1.0.2

    License

    ISC

    Unpacked Size

    39 kB

    Total Files

    15

    Last publish

    Collaborators

    • alexanderbyndyu
    • sadcitizen
    • dmitriy.litichevskiy
    • razonrus