Closes #16886: Dynamic event types (#16938)

* Initial work on #16886 * Restore GraphQL filter * Remove namespace * Add Event documentation * Use MultipleChoiceField for event_types * Fix event_types field class on EventRuleImportForm * Fix tests * Simplify event queue handling logic * Misc cleanup
netbox-community · Jul 22, 2024 · 44a9350 · 44a9350
1 parent 4a53a96
commit 44a9350
Show file tree

Hide file tree

Showing 22 changed files with 269 additions and 268 deletions.
diff --git a/docs/plugins/development/events.md b/docs/plugins/development/events.md
@@ -0,0 +1,16 @@
+# Events
+
+Plugins can register their own custom event types for use with NetBox [event rules](../../models/extras/eventrule.md). This is accomplished by calling the `register()` method on an instance of the `Event` class. This can be done anywhere within the plugin. An example is provided below.
+
+```python
+from django.utils.translation import gettext_lazy as _
+from netbox.events import Event, EVENT_TYPE_SUCCESS
+
+Event(
+    name='ticket_opened',
+    text=_('Ticket opened'),
+    type=EVENT_TYPE_SUCCESS
+).register()
+```
+
+::: netbox.events.Event
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -142,6 +142,7 @@ nav:
             - Forms: 'plugins/development/forms.md'
             - Filters & Filter Sets: 'plugins/development/filtersets.md'
             - Search: 'plugins/development/search.md'
+            - Events: 'plugins/development/events.md'
             - Data Backends: 'plugins/development/data-backends.md'
             - REST API: 'plugins/development/rest-api.md'
             - GraphQL API: 'plugins/development/graphql-api.md'

diff --git a/netbox/core/events.py b/netbox/core/events.py
@@ -1,6 +1,6 @@
 from django.utils.translation import gettext as _
 
-from netbox.events import *
+from netbox.events import Event, EVENT_TYPE_DANGER, EVENT_TYPE_SUCCESS, EVENT_TYPE_WARNING
 
 __all__ = (
     'JOB_COMPLETED',
@@ -24,10 +24,10 @@
 JOB_ERRORED = 'job_errored'
 
 # Register core events
-Event(name=OBJECT_CREATED, text=_('Object created')).register()
-Event(name=OBJECT_UPDATED, text=_('Object updated')).register()
-Event(name=OBJECT_DELETED, text=_('Object deleted')).register()
-Event(name=JOB_STARTED, text=_('Job started')).register()
-Event(name=JOB_COMPLETED, text=_('Job completed'), type=EVENT_TYPE_SUCCESS).register()
-Event(name=JOB_FAILED, text=_('Job failed'), type=EVENT_TYPE_WARNING).register()
-Event(name=JOB_ERRORED, text=_('Job errored'), type=EVENT_TYPE_DANGER).register()
+Event(OBJECT_CREATED, _('Object created')).register()
+Event(OBJECT_UPDATED, _('Object updated')).register()
+Event(OBJECT_DELETED, _('Object deleted')).register()
+Event(JOB_STARTED, _('Job started')).register()
+Event(JOB_COMPLETED, _('Job completed'), type=EVENT_TYPE_SUCCESS).register()
+Event(JOB_FAILED, _('Job failed'), type=EVENT_TYPE_WARNING).register()
+Event(JOB_ERRORED, _('Job errored'), type=EVENT_TYPE_DANGER).register()
diff --git a/netbox/extras/api/serializers_/events.py b/netbox/extras/api/serializers_/events.py
@@ -34,9 +34,9 @@ class EventRuleSerializer(NetBoxModelSerializer):
     class Meta:
         model = EventRule
         fields = [
-            'id', 'url', 'display_url', 'display', 'object_types', 'name', 'type_create', 'type_update', 'type_delete',
-            'type_job_start', 'type_job_end', 'enabled', 'conditions', 'action_type', 'action_object_type',
-            'action_object_id', 'action_object', 'description', 'custom_fields', 'tags', 'created', 'last_updated',
+            'id', 'url', 'display_url', 'display', 'object_types', 'name', 'enabled', 'event_types', 'conditions',
+            'action_type', 'action_object_type', 'action_object_id', 'action_object', 'description', 'custom_fields',
+            'tags', 'created', 'last_updated',
         ]
         brief_fields = ('id', 'url', 'display', 'name', 'description')
 

diff --git a/netbox/extras/events.py b/netbox/extras/events.py
@@ -1,3 +1,4 @@
+from collections import defaultdict
 import logging
 
 from django.conf import settings
@@ -152,35 +153,20 @@ def process_event_queue(events):
     """
     Flush a list of object representation to RQ for EventRule processing.
     """
-    events_cache = {
-        'type_create': {},
-        'type_update': {},
-        'type_delete': {},
-    }
-    event_actions = {
-        # TODO: Add EventRule support for dynamically registered event types
-        OBJECT_CREATED: 'type_create',
-        OBJECT_UPDATED: 'type_update',
-        OBJECT_DELETED: 'type_delete',
-        JOB_STARTED: 'type_job_start',
-        JOB_COMPLETED: 'type_job_end',
-        # Map failed & errored jobs to type_job_end
-        JOB_FAILED: 'type_job_end',
-        JOB_ERRORED: 'type_job_end',
-    }
+    events_cache = defaultdict(dict)
 
     for event in events:
-        action_flag = event_actions[event['event_type']]
+        event_type = event['event_type']
         object_type = event['object_type']
 
         # Cache applicable Event Rules
-        if object_type not in events_cache[action_flag]:
-            events_cache[action_flag][object_type] = EventRule.objects.filter(
-                **{action_flag: True},
+        if object_type not in events_cache[event_type]:
+            events_cache[event_type][object_type] = EventRule.objects.filter(
+                event_types__contains=[event['event_type']],
                 object_types=object_type,
                 enabled=True
             )
-        event_rules = events_cache[action_flag][object_type]
+        event_rules = events_cache[event_type][object_type]
 
         process_event_rules(
             event_rules=event_rules,

diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py
@@ -99,6 +99,9 @@ class EventRuleFilterSet(NetBoxModelFilterSet):
     object_type = ContentTypeFilter(
         field_name='object_types'
     )
+    event_type = MultiValueCharFilter(
+        method='filter_event_type'
+    )
     action_type = django_filters.MultipleChoiceFilter(
         choices=EventRuleActionChoices
     )
@@ -108,8 +111,7 @@ class EventRuleFilterSet(NetBoxModelFilterSet):
     class Meta:
         model = EventRule
         fields = (
-            'id', 'name', 'type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end', 'enabled',
-            'action_type', 'description',
+            'id', 'name', 'enabled', 'action_type', 'description',
         )
 
     def search(self, queryset, name, value):
@@ -121,6 +123,9 @@ def search(self, queryset, name, value):
             Q(comments__icontains=value)
         )
 
+    def filter_event_type(self, queryset, name, value):
+        return queryset.filter(event_types__overlap=value)
+
 
 class CustomFieldFilterSet(ChangeLoggedModelFilterSet):
     q = django_filters.CharFilter(

diff --git a/netbox/extras/forms/bulk_edit.py b/netbox/extras/forms/bulk_edit.py
@@ -3,6 +3,7 @@
 
 from extras.choices import *
 from extras.models import *
+from netbox.events import get_event_type_choices
 from netbox.forms import NetBoxModelBulkEditForm
 from utilities.forms import BulkEditForm, add_blank_choice
 from utilities.forms.fields import ColorField, CommentField, DynamicModelChoiceField
@@ -248,33 +249,18 @@ class EventRuleBulkEditForm(NetBoxModelBulkEditForm):
         required=False,
         widget=BulkEditNullBooleanSelect()
     )
-    type_create = forms.NullBooleanField(
-        label=_('On create'),
+    event_types = forms.MultipleChoiceField(
+        choices=get_event_type_choices(),
         required=False,
-        widget=BulkEditNullBooleanSelect()
-    )
-    type_update = forms.NullBooleanField(
-        label=_('On update'),
-        required=False,
-        widget=BulkEditNullBooleanSelect()
-    )
-    type_delete = forms.NullBooleanField(
-        label=_('On delete'),
-        required=False,
-        widget=BulkEditNullBooleanSelect()
-    )
-    type_job_start = forms.NullBooleanField(
-        label=_('On job start'),
-        required=False,
-        widget=BulkEditNullBooleanSelect()
+        label=_('Event types')
     )
-    type_job_end = forms.NullBooleanField(
-        label=_('On job end'),
-        required=False,
-        widget=BulkEditNullBooleanSelect()
+    description = forms.CharField(
+        label=_('Description'),
+        max_length=200,
+        required=False
     )
 
-    nullable_fields = ('description', 'conditions',)
+    nullable_fields = ('description', 'conditions')
 
 
 class TagBulkEditForm(BulkEditForm):

diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py
@@ -8,12 +8,13 @@
 from core.models import ObjectType
 from extras.choices import *
 from extras.models import *
+from netbox.events import get_event_type_choices
 from netbox.forms import NetBoxModelImportForm
 from users.models import Group, User
 from utilities.forms import CSVModelForm
 from utilities.forms.fields import (
-    CSVChoiceField, CSVContentTypeField, CSVModelChoiceField, CSVModelMultipleChoiceField, CSVMultipleContentTypeField,
-    SlugField,
+    CSVChoiceField, CSVContentTypeField, CSVModelChoiceField, CSVModelMultipleChoiceField, CSVMultipleChoiceField,
+    CSVMultipleContentTypeField, SlugField,
 )
 
 __all__ = (
@@ -187,6 +188,11 @@ class EventRuleImportForm(NetBoxModelImportForm):
         queryset=ObjectType.objects.with_feature('event_rules'),
         help_text=_("One or more assigned object types")
     )
+    event_types = CSVMultipleChoiceField(
+        choices=get_event_type_choices(),
+        label=_('Event types'),
+        help_text=_('The event type(s) which will trigger this rule')
+    )
     action_object = forms.CharField(
         label=_('Action object'),
         required=True,
@@ -196,8 +202,8 @@ class EventRuleImportForm(NetBoxModelImportForm):
     class Meta:
         model = EventRule
         fields = (
-            'name', 'description', 'enabled', 'conditions', 'object_types', 'type_create', 'type_update',
-            'type_delete', 'type_job_start', 'type_job_end', 'action_type', 'action_object', 'comments', 'tags'
+            'name', 'description', 'enabled', 'conditions', 'object_types', 'event_types', 'action_type',
+            'action_object', 'comments', 'tags'
         )
 
     def clean(self):

diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py
@@ -6,6 +6,7 @@
 from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup
 from extras.choices import *
 from extras.models import *
+from netbox.events import get_event_type_choices
 from netbox.forms.base import NetBoxModelFilterSetForm
 from netbox.forms.mixins import SavedFiltersMixin
 from tenancy.models import Tenant, TenantGroup
@@ -274,14 +275,18 @@ class EventRuleFilterForm(NetBoxModelFilterSetForm):
 
     fieldsets = (
         FieldSet('q', 'filter_id', 'tag'),
-        FieldSet('object_type_id', 'action_type', 'enabled', name=_('Attributes')),
-        FieldSet('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end', name=_('Events')),
+        FieldSet('object_type_id', 'event_type', 'action_type', 'enabled', name=_('Attributes')),
     )
     object_type_id = ContentTypeMultipleChoiceField(
         queryset=ObjectType.objects.with_feature('event_rules'),
         required=False,
         label=_('Object type')
     )
+    event_type = forms.MultipleChoiceField(
+        choices=get_event_type_choices,
+        required=False,
+        label=_('Event type')
+    )
     action_type = forms.ChoiceField(
         choices=add_blank_choice(EventRuleActionChoices),
         required=False,
@@ -294,41 +299,6 @@ class EventRuleFilterForm(NetBoxModelFilterSetForm):
             choices=BOOLEAN_WITH_BLANK_CHOICES
         )
     )
-    type_create = forms.NullBooleanField(
-        required=False,
-        widget=forms.Select(
-            choices=BOOLEAN_WITH_BLANK_CHOICES
-        ),
-        label=_('Object creations')
-    )
-    type_update = forms.NullBooleanField(
-        required=False,
-        widget=forms.Select(
-            choices=BOOLEAN_WITH_BLANK_CHOICES
-        ),
-        label=_('Object updates')
-    )
-    type_delete = forms.NullBooleanField(
-        required=False,
-        widget=forms.Select(
-            choices=BOOLEAN_WITH_BLANK_CHOICES
-        ),
-        label=_('Object deletions')
-    )
-    type_job_start = forms.NullBooleanField(
-        required=False,
-        widget=forms.Select(
-            choices=BOOLEAN_WITH_BLANK_CHOICES
-        ),
-        label=_('Job starts')
-    )
-    type_job_end = forms.NullBooleanField(
-        required=False,
-        widget=forms.Select(
-            choices=BOOLEAN_WITH_BLANK_CHOICES
-        ),
-        label=_('Job terminations')
-    )
 
 
 class TagFilterForm(SavedFiltersMixin, FilterForm):

diff --git a/netbox/extras/forms/model_forms.py b/netbox/extras/forms/model_forms.py
@@ -10,6 +10,7 @@
 from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup
 from extras.choices import *
 from extras.models import *
+from netbox.events import get_event_type_choices
 from netbox.forms import NetBoxModelForm
 from tenancy.models import Tenant, TenantGroup
 from users.models import Group, User
@@ -303,6 +304,10 @@ class EventRuleForm(NetBoxModelForm):
         label=_('Object types'),
         queryset=ObjectType.objects.with_feature('event_rules'),
     )
+    event_types = forms.MultipleChoiceField(
+        choices=get_event_type_choices(),
+        label=_('Event types')
+    )
     action_choice = forms.ChoiceField(
         label=_('Action choice'),
         choices=[]
@@ -319,25 +324,16 @@ class EventRuleForm(NetBoxModelForm):
 
     fieldsets = (
         FieldSet('name', 'description', 'object_types', 'enabled', 'tags', name=_('Event Rule')),
-        FieldSet('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end', name=_('Events')),
-        FieldSet('conditions', name=_('Conditions')),
+        FieldSet('event_types', 'conditions', name=_('Triggers')),
         FieldSet('action_type', 'action_choice', 'action_data', name=_('Action')),
     )
 
     class Meta:
         model = EventRule
         fields = (
-            'object_types', 'name', 'description', 'type_create', 'type_update', 'type_delete', 'type_job_start',
-            'type_job_end', 'enabled', 'conditions', 'action_type', 'action_object_type', 'action_object_id',
-            'action_data', 'comments', 'tags'
+            'object_types', 'name', 'description', 'enabled', 'event_types', 'conditions', 'action_type',
+            'action_object_type', 'action_object_id', 'action_data', 'comments', 'tags'
         )
-        labels = {
-            'type_create': _('Creations'),
-            'type_update': _('Updates'),
-            'type_delete': _('Deletions'),
-            'type_job_start': _('Job executions'),
-            'type_job_end': _('Job terminations'),
-        }
         widgets = {
             'conditions': forms.Textarea(attrs={'class': 'font-monospace'}),
             'action_type': HTMXSelect(),