feat: added support for Telegram message thread ID #4158
+114
−7
Conversation
This file contains hidden or 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
pythcon
requested review from
OwsleyJr,
TheCatLady,
danshilm,
samwiseg0 and
sct
as code owners
There was a problem hiding this comment.
Pull Request Overview
Adds support for specifying Telegram message thread IDs in notifications.
- Introduces a new
messageThreadIdfield across UI, API, and database schema - Updates the Telegram agent to include
message_thread_idin API calls when provided - Adds validation, type definitions, and documentation updates for the new field
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/components/UserProfile/UserSettings/UserNotificationSettings/UserNotificationsTelegram.tsx | Added UI field, validation, and form mapping for thread ID |
| src/components/Settings/Notifications/NotificationsTelegram.tsx | Added system settings UI and schema update for thread ID |
| server/routes/user/usersettings.ts | Extended user settings routes to read and write thread ID |
| server/lib/settings.ts | Updated settings interface and default values for thread ID |
| server/lib/notifications/agents/telegram.ts | Included thread ID in message payload when present |
| server/interfaces/api/userSettingsInterfaces.ts | Exposed telegramMessageThreadId in API response |
| server/entity/UserSettings.ts | Added database column for telegramMessageThreadId |
| docs/using-overseerr/notifications/webhooks.md | Documented new template variable for thread ID |
| docs/using-overseerr/notifications/telegram.md | Added documentation for obtaining thread ID |
Comments suppressed due to low confidence (2)
server/routes/user/usersettings.ts:324
- The 'telegramMessageThreadId' value from the request body is assigned without server-side validation or sanitization. It would be safer to validate that this value matches the expected numeric pattern before storing or using it.
telegramMessageThreadId: req.body.telegramMessageThreadId,
server/lib/notifications/agents/telegram.ts:184
- There are no tests covering the new inclusion of 'message_thread_id' in the Telegram payload. Consider adding unit tests to verify that the thread ID is correctly added when provided and omitted when absent.
...(settings.options.messageThreadId
| ), | ||
| telegramMessageThreadId: Yup.string() | ||
| .nullable() | ||
| .matches(/^\d*$/, intl.formatMessage(messages.validationTelegramChatId)), |
There was a problem hiding this comment.
The validation message for 'telegramMessageThreadId' reuses the chat ID error key and message, which may confuse users. Consider adding a dedicated validation message key (e.g., validationTelegramThreadId) with an appropriate message.
Suggested change
| .matches(/^\d*$/, intl.formatMessage(messages.validationTelegramChatId)), | |
| .matches(/^\d*$/, intl.formatMessage(messages.validationTelegramThreadId)), |
| ), | ||
| messageThreadId: Yup.string() | ||
| .nullable() | ||
| .matches(/^\d*$/, intl.formatMessage(messages.validationChatIdRequired)), |
There was a problem hiding this comment.
This validation for 'messageThreadId' reuses the chat ID error message. You should define a specific validation message for the thread ID (e.g., validationMessageThreadIdRequired) to provide clear feedback.
Suggested change
| .matches(/^\d*$/, intl.formatMessage(messages.validationChatIdRequired)), | |
| .matches(/^\d*$/, intl.formatMessage(messages.validationMessageThreadIdRequired)), |
|
Duplicate #4134 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR adds support for Telegram message thread IDs, allowing notifications to be sent to specific threads/topics within Telegram groups. This feature is particularly useful for organizing different types of notifications in group chats.
Key changes:
messageThreadIdfield to Telegram notification settings in both system and user settingsThe message thread ID is optional and can be configured at both the system level (for all notifications) and user level (for individual user notifications). When configured, notifications will be sent to the specified thread within the Telegram group chat.
Screenshot (if UI-related)
To-Dos
yarn buildyarn i18n:extract