Webhook health check endpoint #272
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GochoMugo
requested changes
Jan 30, 2017
| @@ -133,8 +133,13 @@ class TelegramBotWebHook { | |||
| debug('WebHook request URL: %s', req.url); | |||
| debug('WebHook request headers: %j', req.headers); | |||
|
|
|||
| // If there isn't token on URL | |||
| if (!this._regex.test(req.url)) { | |||
| if (/\/healthz/.test(req.url)) { | |||
There was a problem hiding this comment.
Could we make this configurable, like with this._regexp?
| // If there isn't token on URL | ||
| if (!this._regex.test(req.url)) { | ||
| if (/\/healthz/.test(req.url)) { | ||
| // If this is a helth check |
| * @param {Boolean} [options.https=false] Use https | ||
| * @return {Promise} | ||
| */ | ||
| sendWebHook, |
There was a problem hiding this comment.
What if we named it sendWebHookRequest, so it makes more sense?
mironov
force-pushed
the
health_endpoint
branch
from
cdd0e6c to
998c652
Compare
GochoMugo
reviewed
Jan 30, 2017
| debug('WebHook health check passed'); | ||
| res.statusCode = 200; | ||
| res.end('OK'); | ||
| } else if (!this._regex.test(req.url)) { |
There was a problem hiding this comment.
I think we should test for the token first, then the health endpoint, considering that we do not want to waste too much CPU with each and every update we receive on the webhook! What do you think?
There was a problem hiding this comment.
Makes sense, changed the order.
Codecov Report
Continue to review full report at Codecov.
|
mironov
force-pushed
the
health_endpoint
branch
from
998c652 to
3263c6c
Compare
GochoMugo
added a commit
that referenced
this pull request
Jan 30, 2017
References: * Author: @mironov (https://github.com/mironov) * PR: #272
|
Thanks @mironov for your time and effort in this PR! Awesome! 🎉 |
GochoMugo
added a commit
that referenced
this pull request
Feb 10, 2017
Added: 1. Add constructor options: * (#243) `options.polling.params` (by @GochoMugo, requested-by @sidelux) 1. Add methods: * (#74) *TelegramBot#removeReplyListener()* (by @githugger) 1. (#283) Add proper error handling (by @GochoMugo) 1. (#272) Add health-check endpoint (by @mironov) * `options.webHook.healthEndpoint` 1. (#152) Add test for TelegramBot#sendDocument() using 'fileOpts' param (by @evolun) 1. Document `options.webHook.host` (by @GochoMugo) 1. (#264) Add Bot API version to README (by @kamikazechaser) 1. Add examples: - (#271) WebHook on Heroku (by @TheBeastOfCaerbannog) - (#274) WebHook on Zeit Now (by @ferrari) Changed: 1. (#147) Use *String#indexOf()*, instead of *RegExp#test()*, to find token in webhook request (by @AVVS) Fixed: * Fix bug: - (#275, #280) fix es6 syntax error on Node.js v4.x (by @CrazyAbdul) - (#276) promise.warning from `request-promise` (by @GochoMugo, reported-by @preco21) - (#281) fix handling error during polling (by @GochoMugo, reported-by @dimawebmaker) - (#284) fix error during deletion of already-set webhook, during polling (by @GochoMugo, reported-by @dcparga) 1. Fix links in documentation (by @Ni2c2k)
|
Shipped in v0.27.0. |
N-Agency-member
pushed a commit
to N-Agency-member/TelegramBot-API-Node.js-
that referenced
this pull request
Sep 3, 2024
References: * Author: @mironov (https://github.com/mironov) * PR: yagop/node-telegram-bot-api#272
passion-27
added a commit
to passion-27/node-telegram-bot
that referenced
this pull request
Oct 2, 2024
References: * Author: @mironov (https://github.com/mironov) * PR: yagop/node-telegram-bot-api#272
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docker-ized environments usually expose an HTTP endpoint for health checks.
For example, in order to use a bot built with this lib in a kubernetes cluster, we have to give it an HTTP endpoint that responds 200 OK.
Refs:
https://github.com/kubernetes/contrib/tree/master/ingress/controllers/gce#health-checks
https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#defining-a-liveness-http-request