[backend] xtm-hub: add configuration to disable connectivity email notifications (#12988) #12990
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
aHenryJard
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12990 +/- ##
==========================================
+ Coverage 16.17% 16.19% +0.01%
==========================================
Files 2841 2841
Lines 411583 411800 +217
Branches 11359 11417 +58
==========================================
+ Hits 66563 66673 +110
- Misses 345020 345127 +107
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| context: AuthContext, | ||
| user: AuthUser, | ||
| ): Promise<{ | ||
| status: XtmHubRegistrationStatus; |
There was a problem hiding this comment.
why all these formatting changes ? do you have a different formatter ? It makes it difficult to read the PR and see the changes
There was a problem hiding this comment.
sorry I don't know what happened. It's fixed
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.
Proposed changes
xtmhub_connectivity_email_enabledto control Hub connectivity lost email notificationscheckXTMHubConnectivity()to check configuration before sending emailsRelated issues
Checklist
Further comments
Context:
On demo instances that are reset daily, the Hub connectivity check fails regularly because the registration state becomes invalid after each reset. This triggers automated emails to administrators every 24 hours, causing email spam.
Solution:
This PR adds a new environment variable
OPENCTI__XTM__XTMHUB_CONNECTIVITY_EMAIL_ENABLED(default:true) to control email notifications while keeping all other functionality intact:✅ What continues to work:
hub_registration_manager)❌ What can be disabled:
Usage for demo instances:
Set environment variable:
OPENCTI__XTM__XTMHUB_CONNECTIVITY_EMAIL_ENABLED=falseFiles changed:
config/default.json- Added configuration with default valuetruesrc/domain/xtm-hub.ts- Added configuration check before sending emailstests/01-unit/domain/xtm-hub-test.ts- Added test case for disabled emails scenarioBackward compatibility:
The default value is
true, preserving the current behavior for all existing instances. Only instances that explicitly set the variable tofalsewill have emails disabled.Testing:
Added unit test
should not send connectivity email when email sending is disabled via configurationthat verifies:false