Change to action + condition based rules

Author: dcramer

src/sentry/rules.py

@@ -32,7 +32,6 @@
 
 from django import forms
 from django.utils.html import escape
-from django.utils.datastructures import SortedDict
 from django.utils.safestring import mark_safe
 
 from sentry.models import Rule as RuleModel
@@ -43,19 +42,21 @@
 NOTIFY_ON_RATE_CHANGE = 3
 
 
-class RuleBase(type):
+class RuleDescriptor(type):
     def __new__(cls, *args, **kwargs):
-        new_cls = super(RuleBase, cls).__new__(cls, *args, **kwargs)
+        new_cls = super(RuleDescriptor, cls).__new__(cls, *args, **kwargs)
         new_cls.id = '%s.%s' % (new_cls.__module__, new_cls.__name__)
         return new_cls
 
 
-class Rule(object):
-    __metaclass__ = RuleBase
-
+class RuleBase(object):
+    label = None
     form_cls = None
-    action_label = None
-    trigger_label = None
+
+    __metaclass__ = RuleDescriptor
+
+    def __init__(self, instance):
+        self.instance = instance
 
     @classmethod
     def from_params(cls, project, data=None):
@@ -65,23 +66,12 @@ def from_params(cls, project, data=None):
         )
         return cls(rule)
 
-    def __init__(self, instance):
-        self.instance = instance
-
-    def before(self, event):
-        # should this pass event or the data?
-        return event
-
-    def after(self, event, is_new, is_regression, **kwargs):
-        pass
-
     def render_label(self):
-        return ('%s %s' % (self.action_label, self.trigger_label)).format(
-            **self.instance.data)
+        return self.label.format(**self.instance.data)
 
     def render_form(self, form_data):
         if not self.form_cls:
-            return self.trigger_label
+            return self.label
 
         form = self.form_cls(
             form_data,
@@ -93,26 +83,51 @@ def replace_field(match):
             field = match.group(1)
             return unicode(form[field])
 
-        return mark_safe(re.sub(r'{([^}]+)}', replace_field, escape(self.trigger_label)))
+        return mark_safe(re.sub(r'{([^}]+)}', replace_field, escape(self.label)))
 
-    def save(self, form_data):
-        instance = self.instance
 
-        if self.form_cls:
-            form = self.form_cls(
-                form_data,
-                initial=self.instance.data,
-                prefix=self.id,
-            )
-            assert form.is_valid(), 'Form was not valid: %r' % (form.errors,)
-            instance.data = form.cleaned_data
+# class Rule(RuleMixin):
+#     __metaclass__ = RuleBase
 
-        instance.rule_id = self.id
-        instance.save()
+#     def before(self, event):
+#         # should this pass event or the data?
+#         return event
+
+#     def after(self, event, is_new, is_regression, **kwargs):
+#         pass
+
+#     def save(self, form_data):
+#         instance = self.instance
+
+#         if self.form_cls:
+#             form = self.form_cls(
+#                 form_data,
+#                 initial=self.instance.data,
+#                 prefix=self.id,
+#             )
+#             assert form.is_valid(), 'Form was not valid: %r' % (form.errors,)
+#             instance.data = form.cleaned_data
+
+#         instance.rule_id = self.id
+#         instance.save()
+
+
+class EventAction(RuleBase):
+    def before(self, event):
+        # should this pass event or the data?
+        return event
+
+    def after(self, event, is_new, is_regression, **kwargs):
+        pass
+
+
+class EventCondition(RuleBase):
+    def passes(self, event, is_new, is_regression, **kwargs):
+        raise NotImplementedError
 
 
-class NotifyRule(Rule):
-    action_label = 'Send a notification'
+class NotifyEventAction(EventAction):
+    label = 'Send a notification'
 
     def notify(self, event):
         # TODO: fire off plugin notifications
@@ -122,40 +137,45 @@ def after(self, event, **kwargs):
         if self.should_notify(event):
             self.notify(event)
 
-    def should_notify(self, event):
+    def passes(self, event, **kwargs):
         raise NotImplementedError
 
 
-class NotifyOnFirstSeenRule(NotifyRule):
-    trigger_label = 'An event is first seen'
+class FirstSeenEventCondition(EventCondition):
+    label = 'An event is first seen'
 
-    def should_notify(self, event, is_new, **kwargs):
+    def passes(self, event, is_new, **kwargs):
         return is_new
 
 
-class NotifyOnRegressionRule(NotifyRule):
-    trigger_label = 'An event changes state from resolved to unresolved'
+class RegressionEventCondition(EventCondition):
+    label = 'An event changes state from resolved to unresolved'
 
-    def should_notify(self, event, is_regression, **kwargs):
+    def passes(self, event, is_regression, **kwargs):
         return is_regression
 
 
-class NotifyOnTimesSeenForm(forms.Form):
+class TimesSeenEventForm(forms.Form):
     num = forms.IntegerField(widget=forms.TextInput(attrs={'type': 'number'}))
 
 
-class NotifyOnTimesSeenRule(NotifyRule):
-    form_cls = NotifyOnTimesSeenForm
-    trigger_label = 'An event is seen more than {num} times'
+class TimesSeenEventCondition(EventCondition):
+    form_cls = TimesSeenEventForm
+    label = 'An event is seen more than {num} times'
 
-    def should_notify(self, event):
+    def passes(self, event):
         return event.times_seen == self.get_option('num')
 
 
-RULES = SortedDict(
-    (k.id, k) for k in [
-        NotifyOnFirstSeenRule,
-        NotifyOnRegressionRule,
-        NotifyOnTimesSeenRule,
-    ]
-)
+RULES = {
+    'events': {
+        'actions': [
+            NotifyEventAction,
+        ],
+        'conditions': [
+            FirstSeenEventCondition,
+            RegressionEventCondition,
+            TimesSeenEventCondition,
+        ],
+    }
+}

src/sentry/static/sentry/scripts/app.js

@@ -625,67 +625,82 @@
         initialize: function(data){
             BasePage.prototype.initialize.apply(this, arguments);
 
-            _.bindAll(this, 'populateTriggers', 'addRule');
+            _.bindAll(this, 'addAction', 'addCondition');
 
-            this.rules_by_action = {}
-            this.triggers_by_id = {}
+            this.actions_by_id = {};
+            this.conditions_by_id = {};
             this.el = $(data.el);
             this.action_sel = this.el.find('select[name="action"]');
-            this.trigger_sel = this.el.find('select[name="trigger"]');
-            this.trigger_table = this.el.find('table.trigger-list');
-            this.trigger_table_body = this.trigger_table.find('tbody');
+            this.action_table = this.el.find('table.action-list');
+            this.action_table_body = this.action_table.find('tbody');
+            this.condition_sel = this.el.find('select[name="condition"]');
+            this.condition_table = this.el.find('table.condition-list');
+            this.condition_table_body = this.condition_table.find('tbody');
 
             this.action_sel.empty();
-            $.each(data.rules, _.bind(function(_, action) {
+            this.action_sel.append($('<option></option>'));
+            $.each(data.actions, _.bind(function(_, action) {
                 var opt = $('<option></option>');
                 opt.attr({
-                    value: action.label,
+                    value: action.id,
                 });
                 opt.text(action.label);
                 opt.appendTo(this.action_sel);
 
-                this.rules_by_action[action.label] = action;
+                this.actions_by_id[action.id] = action;
             }, this));
 
-            this.action_sel.change(this.populateTriggers).change();
-            this.trigger_sel.change(this.addRule);
-        },
-
-        populateTriggers: function(){
-            var rule = this.rules_by_action[this.action_sel.val()];
-
-            this.trigger_table.hide();
-            this.trigger_table_body.empty();
-
-            this.trigger_sel.empty();
-            this.trigger_sel.append($('<option></option>'));
-            $.each(rule.triggers, _.bind(function(_, trigger) {
-                this.triggers_by_id[trigger.id] = trigger;
+            this.condition_sel.empty();
+            this.condition_sel.append($('<option></option>'));
+            $.each(data.conditions, _.bind(function(_, condition) {
                 var opt = $('<option></option>');
                 opt.attr({
-                    value: trigger.id,
+                    value: condition.id,
                 });
-                opt.text(trigger.label);
-                opt.appendTo(this.trigger_sel);
+                opt.text(condition.label);
+                opt.appendTo(this.condition_sel);
+
+                this.conditions_by_id[condition.id] = condition;
             }, this));
+
+            this.action_sel.change(this.addAction);
+            this.condition_sel.change(this.addCondition);
+        },
+
+        addCondition: function() {
+            var condition = this.conditions_by_id[this.condition_sel.val()];
+            var row = $('<tr></tr>');
+            var remove_btn = $('<button class="btn btn-small">Remove</button>');
+
+            row.append($('<td>' + condition.html + '</td>'));
+            row.append($('<td></td>').append(remove_btn));
+            row.appendTo(this.condition_table_body);
+
+            remove_btn.click(function(){
+                row.remove();
+                return false;
+            });
+
+            this.condition_sel.data("select2").clear();
+            this.condition_table.show();
         },
 
-        addRule: function() {
-            var trigger = this.triggers_by_id[this.trigger_sel.val()];
+        addAction: function() {
+            var action = this.actions_by_id[this.action_sel.val()];
             var row = $('<tr></tr>');
-            var remove_btn = $('<button class="btn btn-small" data-action="remove-rule">Remove</button>');
+            var remove_btn = $('<button class="btn btn-small">Remove</button>');
 
-            row.append($('<td>' + trigger.html + '</td>'));
+            row.append($('<td>' + action.html + '</td>'));
             row.append($('<td></td>').append(remove_btn));
-            row.appendTo(this.trigger_table_body);
+            row.appendTo(this.action_table_body);
 
             remove_btn.click(function(){
                 row.remove();
                 return false;
             });
 
-            this.trigger_sel.data("select2").clear();
-            this.trigger_table.show();
+            this.action_sel.data("select2").clear();
+            this.action_table.show();
         }
 
     });

src/sentry/static/sentry/scripts/global.min.js

@@ -7,9 +7,10 @@
         <a href="{% url 'sentry-new-project-rule' project.team.slug project.slug %}" class="btn pull-right btn-primary">{% trans "New Rule" %}</a>
         <h2>{% trans "Rules" %}</h2>
     </div>
+    <p>Below you'll find each available action along with the triggers specified for it. Each action can have any number of triggers.</p>
+    <h4>Send a notification</h4>
     <ul>
-        {% for rule, label in rule_list %}
-            <li>{{ label }}</li>
-        {% endfor %}
+    	<li>When an event is first seen</li>
+    	<li>When an event changes from resolved to unresolved</li>
     </ul>
 {% endblock %}

src/sentry/templates/sentry/projects/rules/list.html

@@ -17,23 +17,36 @@ <h2>{% trans "New Rule" %}</h2>
         </fieldset>
 
         <fieldset>
-            <div><legend>Action</legend></div>
+            <div><legend>Conditions</legend></div>
+            <p>When <select name="match" style="width:100px" class="select2-small">
+                <option value="all">all of</option>
+                <option value="any">any of</option>
+                <option value="none">none of</option>
+            </select> these conditions are met:</p>
+            <table class="condition-list table table-striped">
+                <colgroup>
+                    <col>
+                    <col style="width:50px">
+                </colgroup>
+                <tbody></tbody>
+            </table>
             <div class="controls">
-                <select name="action" class="span6" placeholder="select an action"></select>
+                <select name="condition" class="span6" placeholder="add a condition"></select>
             </div>
         </fieldset>
 
         <fieldset>
-            <div><legend>Triggers</legend></div>
-            <table class="trigger-list table table-striped">
+            <div><legend>Actions</legend></div>
+            <p>Take these actions every time this rules matches:</p>
+            <table class="action-list table table-striped">
                 <colgroup>
                     <col>
                     <col style="width:50px">
                 </colgroup>
                 <tbody></tbody>
             </table>
             <div class="controls">
-                <select name="trigger" class="span6" placeholder="add a trigger"></select>
+                <select name="action" class="span6" placeholder="add an action"></select>
             </div>
         </fieldset>
 
@@ -45,7 +58,8 @@ <h2>{% trans "New Rule" %}</h2>
     <script>
     new app.NewProjectRulePage({
         el: '#new-rule-form',
-        rules: {{ rules_by_action|safe }}
+        actions: {{ action_list|safe }},
+        conditions: {{ condition_list|safe }}
     });
     </script>
 {% endblock %}