♻️ ref: refactor notification building utils to prevent circular dependencies #88030
+72
−36
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
github-actions
bot
added
the
Scope: Backend
iamrajjoshi
commented
Mar 26, 2025
| @@ -173,7 +173,7 @@ def build_attachment_text(group: Group, event: Event | GroupEvent | None = None) | |||
|
|
|||
|
|
|||
| def build_attachment_replay_link( | |||
| group: Group, event: Event | GroupEvent | None = None, url_format: str = SLACK_URL_FORMAT | |||
| group: Group, url_format: str, event: Event | GroupEvent | None = None | |||
There was a problem hiding this comment.
enforcing u pass a url_format
iamrajjoshi
commented
Mar 26, 2025
| @@ -210,9 +210,6 @@ def build_footer( | |||
| text = rules[0].label if rules[0].label else "Test Alert" | |||
| footer += f" via {url_format.format(text=text, url=rule_url)}" | |||
|
|
|||
| if url_format == SLACK_URL_FORMAT: | |||
There was a problem hiding this comment.
slack is clearly doing its own thing, so lets give it its own specific method instead of having this 1 tiny function do all the heavy lifting
iamrajjoshi
commented
Mar 26, 2025
| @@ -0,0 +1,11 @@ | |||
| # Attachment colors used for issues with no actions take. | |||
|
|
|||
| LEVEL_TO_COLOR = { | |||
There was a problem hiding this comment.
this is generic, so lets not keep it with Slack
iamrajjoshi
commented
Mar 26, 2025
| @@ -7,17 +7,6 @@ | |||
| SlackBlock = dict[str, Any] | |||
| SlackBody = Union[SlackAttachment, SlackBlock] | |||
|
|
|||
| # Attachment colors used for issues with no actions take. | |||
There was a problem hiding this comment.
moved outside of slack since its generic
Codecov ReportAttention: Patch coverage is ✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## master #88030 +/- ##
=======================================
Coverage 87.74% 87.74%
=======================================
Files 9925 9927 +2
Lines 563835 563850 +15
Branches 22205 22205
=======================================
+ Hits 494714 494733 +19
+ Misses 68719 68715 -4
Partials 402 402 |
iamrajjoshi
commented
Mar 26, 2025
| from sentry.models.rule import Rule | ||
|
|
||
|
|
||
| def build_slack_footer( |
There was a problem hiding this comment.
slack gets its own method thats specific to it since it styles things differently
iamrajjoshi
commented
Mar 26, 2025
| @@ -140,7 +140,7 @@ def test_basic(self, mock_record): | |||
| notification_uuid=notification_uuid, | |||
| ), | |||
| "color": LEVEL_TO_COLOR["error"], | |||
| "footer": {"text": build_footer(self.event.group, self.event.project, None, "{text}")}, | |||
There was a problem hiding this comment.
reorder required because of optional args
GabeVillalobos
approved these changes
Mar 27, 2025
Comment on lines
+16
to
+25
|
|
||
| if rules: | ||
| rule_url = build_rule_url(rules[0], group, project) | ||
| # If this notification is triggered via the "Send Test Notification" | ||
| # button then the label is not defined, but the url works. | ||
| text = rules[0].label if rules[0].label else "Test Alert" | ||
| footer = SLACK_URL_FORMAT.format(text=text, url=rule_url) | ||
|
|
||
| if len(rules) > 1: | ||
| footer += f" (+{len(rules) - 1} other)" |
There was a problem hiding this comment.
A new unit test on this util would be appreciated.
iamrajjoshi
deleted the
raj/ref-messaging-building-to-prevent-circular-dependency
branch
andrewshie-sentry
pushed a commit
that referenced
this pull request
Mar 27, 2025
…ndencies (#88030) making my aci life easier i am running into a lot of circular dependency issues around these methods since we are importing slack specific utils and methods in a generic `messaging` class.
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
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.
making my aci life easier
i am running into a lot of circular dependency issues around these methods since we are importing slack specific utils and methods in a generic
messagingclass.