Grpc-node: [grpc-health-check] Documentation & problem with published package

[mousavian]

Problem description

There is no documentation around how grpc-health-check library should be used.
I have tried to use it based on existing test cases, but there is major issue with latest published version 1.6.6:
The "main" file defined in package.json file is src/node/index.js [here] while there is no such file.
Hence, we can't have require('grpc-health-check') because it will throw Cannot find module 'grpc-health-check' error.
It should be used like require('grpc-health-check/health').

But it can be resolved easily by fixing that line to point to health.js and publish it as 1.6.7 or something.

Reproduction steps

mkdir /tmp/test && cd /tmp/test
npm init
npm i [email protected]
node -e "require('grpc-health-check')"

Environment

• Any node version / but i've tested on 8.8.1
  clang 3.8.0-2ubuntu4]
• [email protected]

Additional context

I'd be happy to raise PRs to fix that and also add documentation if this is not deprecated or sth.
Also wondering why link to repository in npmjs.com is pointing to https://github.com/grpc/grpc/ 🤔

[cjihrig]

@mousavian, I'm not sure how actively maintained grpc-health-check is, but fixing thepackage.json main entry seems like a simple but worthwhile PR to submit.

[alexandervain]

@cjihrig Some of the describe issues seems to be fixed on master (for a while actually - by this commit - https://github.com/grpc/grpc-node/commit/16ad6e14aaacce88145db0a31ad182799d2ba6c8).
Any chance for releasing a new version of grpc-health-check containing those changes?

[cjihrig]

@alexandervain I don't have any permissions on any grpc repos. You'd have to ask @murgatroid99 and company.

[alexandervain]

@murgatroid99 is it possible to release a new version of grpc-health-check? (master contains fixes for this issue)

[iangeckeler]

@murgatroid99 has this issue been resolved?

[murgatroid99]

It looks like this fell off our radar. We have now published a new version of grpc-health-check, version 1.7.0.

[cymarechal]

@murgatroid99 Great news! Do you know if there is any documentation or examples available?

[nareddyt]

I made a PR with the documentation. Would appreciate any feedback :)