papajuanito/grpc-node-server-reflection

gRPC Node Reflection Service Implementation.

grpc-node-server-reflection's Issues

Typo in exported function

Good day,

I have picked up a typo in the exported function name wrapServerWithRefelection see

grpc-node-server-reflection/src/index.ts

Line 188 in bb150e3

export default wrapServerWithRefelection;

It probably should be wrapServerWithReflection

Included an unresolvable reference to "google.protobuf.Struct"

I'm trying to use the well-known google types such as google.protobuf.Struct and it appears that grpcurl is failing with the following error.

$ grpcurl -plaintext localhost:50051 describe com.example.api.v1.ExampleAPI
Failed to resolve symbol "com.example.api.v1.ExampleAPI": file "com_example_api_v1.proto" included an unresolvable reference to "google.protobuf.Struct"

I'm guessing this happens because reflection API is not resolving the google.protobuf.* types.

It does appear to work if you provide the -proto ./proto/example_api.proto argument but this kind of defeats the point of implementing the reflection API because I don't want to ship the .proto file with the client.

$ grpcurl -plaintext -proto src/proto/example_api.proto localhost:50051 describe com.example.api.v1.ExampleAPI
com.example.api.v1.ExampleAPI is a service:
service ExampleAPI {
  rpc Exec ( .com.example.api.v1.Request ) returns ( .com.example.api.v1.Response );
}

.proto file

// ./proto/example_api.proto
syntax = "proto3";

package com.example.api.v1;

import "google/protobuf/struct.proto";

message Request {
  google.protobuf.Struct body = 2;
}

message Response {
  google.protobuf.Struct body = 2;
}

service ExampleAPI {
  rpc Exec(Request) returns (Response);
}

Server code

// ./server.js
const path = require('path');
const grpc = require('grpc');
const protoLoader = require('@grpc/proto-loader');
const { default: wrapServerWithReflection } = require('grpc-node-server-reflection');

const server = wrapServerWithReflection(new grpc.Server());
const protoPath = path.join(__dirname, 'proto', 'example_api.proto');
const packageDefinition = protoLoader.loadSync(protoPath);
const serviceDescriptor = grpc.loadPackageDefinition(packageDefinition);
server.addService(
    serviceDescriptor.com.example.api.v1.ExampleAPI.service, {
        Exec: (call, callback) => {
            console.log(call.request);
            callback(null, {});
        }
    }
);
server.bind('0.0.0.0:50051', grpc.ServerCredentials.createInsecure());
server.start();