feat(rules): Send a notification on create and edit #66285

ceorourke · 2024-03-05T01:54:13Z

Send a Slack notification when a rule with a Slack action is created or edited that confirms the rule was created or edited. In the future we'll add this for MSTeams and Discord.

I'm keeping the notification simple for now, but in the future we also may expand what's shown (e.g. adding the alert rule details to show the filters, conditions, and actions).

Closes #66237

src/sentry/api/endpoints/project_rules.py

src/sentry/integrations/slack/actions/notification.py

src/sentry/integrations/slack/message_builder/notifications/rule_save_edit.py

codecov · 2024-03-05T02:24:59Z

Codecov Report

Attention: Patch coverage is 92.59259% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 84.30%. Comparing base (69b3e84) to head (24d0a1b).
Report is 34 commits behind head on master.

❗ Current head 24d0a1b differs from pull request most recent head 76e7f5b. Consider uploading reports for the commit 76e7f5b to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #66285   +/-   ##
=======================================
  Coverage   84.30%   84.30%           
=======================================
  Files        5311     5312    +1     
  Lines      237258   237329   +71     
  Branches    41035    41041    +6     
=======================================
+ Hits       200014   200083   +69     
- Misses      37025    37027    +2     
  Partials      219      219

Files	Coverage Δ
src/sentry/api/endpoints/project_rule_details.py	`91.24% <100.00%> (+0.12%)`	⬆️
src/sentry/api/endpoints/project_rules.py	`95.92% <100.00%> (+0.15%)`	⬆️
src/sentry/conf/server.py	`90.15% <ø> (ø)`
src/sentry/features/__init__.py	`100.00% <100.00%> (ø)`
...ck/message_builder/notifications/rule_save_edit.py	`100.00% <100.00%> (ø)`
src/sentry/rules/processor.py	`92.98% <100.00%> (+1.50%)`	⬆️
.../sentry/integrations/slack/actions/notification.py	`86.95% <93.33%> (+1.24%)`	⬆️
src/sentry/rules/actions/base.py	`80.00% <64.28%> (-20.00%)`	⬇️

... and 6 files with indirect coverage changes

src/sentry/api/endpoints/project_rules.py

wedamija

This approach looks good to me 👍

ceorourke · 2024-03-06T19:54:43Z

src/sentry/integrations/slack/message_builder/notifications/rule_save_edit.py

+        else:
+            rule_text = f"{rule_url} in the *{project}* project was updated."
+
+        # TODO add short summary of the trigger & filter conditions


This is a "maybe" TODO, discussing in Slack whether we want to add stuff to it or keep it simple. Simple is fine for this PR.

ceorourke · 2024-03-06T19:55:17Z

src/sentry/rules/processor.py

-            if not isinstance(action_inst, EventAction):
-                self.logger.warning("Unregistered action %r", action["id"])
-                continue
+            action_inst = instantiate_action(rule, action)


This I just moved into a shared function so I can use it with my new logic.

…ssor

nhsiehgit

I think mostly looks good?
some non-blocking nits

nhsiehgit · 2024-03-07T18:50:45Z

src/sentry/integrations/slack/message_builder/notifications/rule_save_edit.py

+        rule: Rule,
+        new: bool,
+    ) -> None:
+        super().__init__()


any other kwargs to pass through to super init?

Doesn't seem like it

nhsiehgit · 2024-03-07T18:55:16Z

src/sentry/rules/actions/base.py

 from sentry.rules.base import CallbackFuture, EventState, RuleBase

 logger = logging.getLogger("sentry.rules")


+def instantiate_action(rule: Rule, action):


did we decide we watned this here in the base.py file? Or create a separate helpers/utils file?

I think we were only discussing moving it around because of circular imports and ended up not needing to address that.

nhsiehgit · 2024-03-07T18:56:45Z

src/sentry/rules/actions/base.py

 from sentry.rules.base import CallbackFuture, EventState, RuleBase

 logger = logging.getLogger("sentry.rules")


+def instantiate_action(rule: Rule, action):
+    from sentry.rules import rules


moving to separate helper file should avoid circular imports right?

Follow up to #66285 to add details about what changed happened when a rule was edited to the notification. <img width="748" alt="Screenshot 2024-03-12 at 4 40 24 PM" src="https://github.com/getsentry/sentry/assets/29959063/e0d7c5ca-35e5-4a66-bc67-e53c8d27dcce"> Note that I've made a couple follow up tickets to address poor rendering of issue type enums and frequency: getsentry/team-core-product-foundations#158 and getsentry/team-core-product-foundations#157 --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

sentry-io · 2024-03-18T22:27:51Z

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

‼️ RpcRemoteException: app.find_alertable_services: Invalid service request sentry.tasks.post_process.post_process_group View Issue

_{Did you find this useful? React with a 👍 or 👎}

github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Mar 5, 2024

ceorourke commented Mar 5, 2024

View reviewed changes

src/sentry/api/endpoints/project_rules.py Outdated Show resolved Hide resolved

ceorourke commented Mar 5, 2024

View reviewed changes

src/sentry/integrations/slack/actions/notification.py Outdated Show resolved Hide resolved

ceorourke commented Mar 5, 2024

View reviewed changes

src/sentry/integrations/slack/message_builder/notifications/rule_save_edit.py Outdated Show resolved Hide resolved

vercel bot deployed to Preview March 5, 2024 20:48 View deployment

wedamija reviewed Mar 5, 2024

View reviewed changes

src/sentry/api/endpoints/project_rules.py Outdated Show resolved Hide resolved

src/sentry/api/endpoints/project_rules.py Outdated Show resolved Hide resolved

src/sentry/api/endpoints/project_rules.py Outdated Show resolved Hide resolved

vercel bot deployed to Preview March 5, 2024 22:16 View deployment

vercel bot deployed to Preview March 6, 2024 00:12 View deployment

wedamija reviewed Mar 6, 2024

View reviewed changes

vercel bot deployed to Preview March 6, 2024 19:45 View deployment

vercel bot deployed to Preview March 6, 2024 19:51 View deployment

ceorourke commented Mar 6, 2024

View reviewed changes

ceorourke changed the title ~~feat(rules): Send a notification on save and edit~~ feat(rules): Send a notification on create and edit Mar 6, 2024

vercel bot deployed to Preview March 6, 2024 20:01 View deployment

ceorourke marked this pull request as ready for review March 6, 2024 20:02

ceorourke requested review from a team as code owners March 6, 2024 20:02

vercel bot deployed to Preview March 6, 2024 20:21 View deployment

vercel bot deployed to Preview March 6, 2024 21:03 View deployment

vercel bot deployed to Preview March 6, 2024 23:49 View deployment

ceorourke requested a review from a team as a code owner March 7, 2024 00:14

ceorourke added 7 commits March 6, 2024 16:15

feat(rules): Send a notification on save and edit

f506e74

create send_confirmation_notification rather than using the ruleproce…

6af87c9

…ssor

use rule registry, move repeated code to a shared function

ff85a00

add notification settings link to context block

4fc3097

add tests

6c78ef0

put behind feature flag

a3bc3b0

better flag name

e3d0f86

ceorourke added 4 commits March 6, 2024 16:15

#notmyprysident

b73b934

continue

3f823a1

pass rules to fn cause it was getting overwritten in a test

d201ff2

fix mock in test, don't need to pass rules

24d0a1b

vercel bot deployed to Preview March 7, 2024 00:16 View deployment

ceorourke force-pushed the ceorourke/rule-save-edit-notification branch from cdba74c to 24d0a1b Compare March 7, 2024 00:16

vercel bot deployed to Preview March 7, 2024 00:18 View deployment

change to remote flag

76e7f5b

vercel bot deployed to Preview March 7, 2024 18:50 View deployment

nhsiehgit approved these changes Mar 7, 2024

View reviewed changes

ceorourke merged commit 81530c4 into master Mar 7, 2024

ceorourke deleted the ceorourke/rule-save-edit-notification branch March 7, 2024 19:28

ceorourke mentioned this pull request Mar 13, 2024

ref(rules): Add changes to rule edit confirmation notification #66847

Merged

github-actions bot locked and limited conversation to collaborators Apr 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(rules): Send a notification on create and edit #66285

feat(rules): Send a notification on create and edit #66285

Uh oh!

ceorourke commented Mar 5, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Mar 5, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wedamija left a comment

Uh oh!

ceorourke Mar 6, 2024

Uh oh!

ceorourke Mar 6, 2024

Uh oh!

nhsiehgit left a comment

Uh oh!

nhsiehgit Mar 7, 2024

Uh oh!

ceorourke Mar 7, 2024

Uh oh!

nhsiehgit Mar 7, 2024

Uh oh!

ceorourke Mar 7, 2024

Uh oh!

nhsiehgit Mar 7, 2024

Uh oh!

sentry-io bot commented Mar 18, 2024

Uh oh!

Uh oh!

Uh oh!

feat(rules): Send a notification on create and edit #66285

feat(rules): Send a notification on create and edit #66285

Uh oh!

Conversation

ceorourke commented Mar 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Mar 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wedamija left a comment

Choose a reason for hiding this comment

Uh oh!

ceorourke Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

ceorourke Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

nhsiehgit left a comment

Choose a reason for hiding this comment

Uh oh!

nhsiehgit Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

ceorourke Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

nhsiehgit Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

ceorourke Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

nhsiehgit Mar 7, 2024

Choose a reason for hiding this comment

Uh oh!

sentry-io bot commented Mar 18, 2024

Suspect Issues

Uh oh!

Uh oh!

ceorourke commented Mar 5, 2024 •

edited

Loading

codecov bot commented Mar 5, 2024 •

edited

Loading