Notes:
The permanent fix introduces backwards-incompatible changes, which
require a major version bump. Until we release v1,
environment variable `${NTBA_FIX_319}` can be used to apply
the fix.
References:
* BR: https://github.com/yagop/node-telegram-bot-api/issues/319
Feature:
This is the opposite action to `TelegramBot#onText()`.
It allows removing any previously-registered listeners.
It is similar to `TelegramBot#removeReplyListener()`.
Bug:
During polling, deleting the already-set webhook, caused
the `TelegramBotPolling#_getUpdates()` return an unexpected
value.
We expect the method to return an array (in the `.then()` clause).
However, deleting the webhook returns its value, which is an object,
from the method `_getUpdates()`.
Fix:
Simply retry the polling request and return the promise.
Notes:
Should we use recursion? I do not think so.
Why? The chances of getting the error (having a webhook set) AGAIN
is quite rare. And if it happens, there must be some problem with
different instances invoking polling and webhook simultaneously.
In that case, we wont struggle to recover from such a scenario.
User is on their own! Isht!
References:
* Bug report: https://github.com/yagop/node-telegram-bot-api/issues/284
* Reported by: @dcparga
Bug:
Array#findIndex() is unavailable in Node.js v0.x.
Since we are deprecating Node.js v0.x already, we
can use a shim in the mean time.
Once we stop supporting that version range, we can
drop the shim entirely.
tags: deprecate/node-v0.x
Bug:
On certain errors, during polling, cause the following error to be
thrown:
TypeError: Cannot read property 'statusCode' of undefined
This is caused when we try to access the 'response' property on
the error object in the error handler (`catch(error)`). It goes
missing when the error was fatal, for example, network error, thus
no server response available.
References:
* Issue #281: https://github.com/yagop/node-telegram-bot-api/issues/281
* Reported-by: @dimawebmaker
Feature:
To be more RFC compliant, particularly when sending
files, we are going to default to using POST requests.
We have been using GET requests (even when uploading files).
PS: This causes major problems with PWRTelegram API
Feature:
Polling and WebHook are mutually exclusive. Therefore, return an
error whenever the user tries to start polling, and the instance has
an open webhook, or user tries to open a webhook, and the instance
is already polling.
Feature:
The constructor option, 'filepath', allows us to remove
the TelegramBot's behaviour of allowing users to pass in
file-paths as arguments, as it involves some operations
that might be (are) strongly against what a programmer wishes
to achieve with the library.
Expect this to be documented better in the near future.
Implementation:
* Backwards compatible: The default behavior is not changed!
Bug:
The method TelegramBot#_formatSendData() throws an error
if the Buffer file type is NOT supported. We need to handle
it, by returning a Promise that is reject with the originally
thrown exception.
References:
* PR trying to achieve the same: https://github.com/yagop/node-telegram-bot-api/pull/66
Feature:
The different mechanisms of fetching updates, i.e. polling
and webhook, have had their implementations improved:
* the TelegramBot instance needs to create the polling and
webhook instances once, and when necessary
* returning promises from TelegramBot#openWebHook() and
TelegramBot#startPolling() allows more precise control
Also,
* TelegramBot#initPolling() is being deprecated in favor of
TelegramBot#startPolling() to ensure consistency (as the
opposite action of TelegramBot#stopPolling())
Bug:
The confusion between using 'options' (passed by caller)
and 'this.options' (cached on the object), we were making
the assumption 'options.https' is unchanged!
It's references is changed already as we had earlier assigned
'this.options' to point to 'options', thus same object.
Feature:
We shall allow passing more options to the HTTP server,
in `https.createServer()`.
We are using a new property, `https`, to avoid any namespace
collisions with our own options.
`options.key`, `options.cert` and `options.pfx` are convenient
options, in that they allow the user to provide paths to the
corresponding files, which are read automatically,
though synchronously!
Implementation:
* completely backwards-compatible
* all changes are being tested, except `options.pfx`
References:
* Pass `ca` prop to https.createServer(): https://github.com/yagop/node-telegram-bot-api/pull/17
Bug:
The library assumes signatures of methods to be, somewhat:
methodName(requiredParam1, requiredParam2, form = {})
where 'requiredParam1' ('requiredParam2', ..., 'requiredParamN')
are parameters that MUST be provided, and
'form' is an optional object allowing supplying any additional,
optional parameters that the Bot API allows.
This allows any new parameters added by Telegram to be
readily-supported by our library.
Also, the following have been included:
* Corresponding tests
* Documentation on the old, deprecated signatures
* Console-logging the deprecation notices
Feature:
We are exposing TelegramBot#processUpdate() to allow instances
to be used, with mechanisms of fetching updates, other than
those provided by the library.
References:
* Example use case: https://github.com/GochoMugo/tgfancy/pull/7
Mohammed Sohail
CapacitorSet
GochoMugo
Misha
Savely Krasovsky
kucherenkovova
Fabio Zuber
Anton Mironov