multi-proto-grpc-server

grpc-server

---

grpc-server is a wrapper around official grpc package. It handles multiple proto files for various grpc clients. Sometimes multiple clients communicate with the core server. So there are many proto files on the server. This package helps to achieve this functionality quickly and easily.

PREREQUISITES

• node: This requires node to be installed, version 8.0 or above.

• Note: If you installed node via a package manager and the version is still less than 4.0, try directly installing it from nodejs.org.

HOW TO RUN?

npm run build
npm start

INSTALLATION

npm install multi-proto-grpc-server

Example

notification.proto

syntax = "proto3";

package notification;

service Notification {
  rpc send(Request_Notification) returns (Response_Notification) {}
}

message Request_Notification {
  required string notificationType = 1;
  required string payload = 2;
}

message Response_Notification {
  string response = 1;
}

notification.proto

syntax = "proto3";

package notification1;

service Notification1 {
  rpc send1(Request_Notification) returns (Response_Notification) {}
}

message Request_Notification {
  required string notificationType = 1;
  required string payload = 2;
}

message Response_Notification {
  string response = 1;
}

index.js

const { GRPC, ServiceMap } = require('multi-proto-grpc-server');

const serviceContainer = {
  send: (call, callback) => {
  // - - - <code> - - -
    callback(null, 'some result');
  }
}

const serviceContainer1 = {
  send1: (call, callback) => {
    // - - - <code> - - -
    callback(null, 'some result');
  }
}

const notificationServiceMap = new ServiceMap('notification', serviceContainer);
const notificationServiceMap1 = new ServiceMap('notification', serviceContainer1);

new GRPC([
  { packageName: 'notification', serviceName: 'Notification', PROTO_PATH: './notification.proto', serviceMap: notificationServiceMap.map },
  { packageName: 'notification1', serviceName: 'Notification', PROTO_PATH: './notification1.proto', serviceMap: notificationServiceMap1.map }
]).run('0.0.0.0:50051');

Docs

ServiceMap(package-name, service-container)

package-name: It is same name of the package as in proto file service-container: It is the key value pair of user defined function. Key is the name of the rpc functions.

GRPC([Array of objects])

Array of objects contains three fields: serviceName, PROTO_PATH, serviceMap. serviceName is the name of the service as in thr proto file.> PROTO_PATH is the path of the proto file serviceMap is the map object of the ServiceMap Class

Upcoming Features

• Authentication
• grpc-client (sdk for client)

Contributors

Looking for developers who can contribute to this open source project. Contact me to enroll yourself as a contributors.