Tweaked webhooks and Redis settings

netbox/extras/__init__.py

@@ -5,7 +5,7 @@ from django.core.exceptions import ImproperlyConfigured
 default_app_config = 'extras.apps.ExtrasConfig'
 
 # check that django-rq is installed and we can connect to redis
-if settings.WEBHOOK_BACKEND_ENABLED:
+if settings.WEBHOOKS_ENABLED:
     try:
         import django_rq
     except ImportError:

netbox/extras/apps.py

@@ -1,8 +1,6 @@
 from __future__ import unicode_literals
 
 from django.apps import AppConfig
-from django.core.cache import caches
-from django.db.utils import ProgrammingError
 from django.core.exceptions import ImproperlyConfigured
 from django.conf import settings
 
@@ -13,17 +11,25 @@ class ExtrasConfig(AppConfig):
     def ready(self):
         import extras.signals
 
-        # check that we can connect to redis
-        if settings.WEBHOOK_BACKEND_ENABLED:
+        # Check that we can connect to the configured Redis database if webhooks are enabled.
+        if settings.WEBHOOKS_ENABLED:
             try:
                 import redis
-                rs = redis.Redis(settings.REDIS_HOST,
-                                 settings.REDIS_PORT,
-                                 settings.REDIS_DB,
-                                 settings.REDIS_PASSWORD or None)
+            except ImportError:
+                raise ImproperlyConfigured(
+                    "WEBHOOKS_ENABLED is True but the redis Python package is not installed. (Try 'pip install "
+                    "redis'.)"
+                )
+            try:
+                rs = redis.Redis(
+                    host=settings.REDIS_HOST,
+                    port=settings.REDIS_PORT,
+                    db=settings.REDIS_DATABASE,
+                    password=settings.REDIS_PASSWORD or None,
+                )
                 rs.ping()
             except redis.exceptions.ConnectionError:
                 raise ImproperlyConfigured(
-                    "Unable to connect to the redis database. You must provide "
-                    "connection settings to redis per the documentation."
+                    "Unable to connect to the Redis database. Check that the Redis configuration has been defined in "
+                    "configuration.py."
                 )

netbox/extras/webhooks.py

@@ -64,7 +64,7 @@ def post_save_receiver(sender, instance, created, **kwargs):
     Receives post_save signals from registered models. If the webhook
     backend is enabled, queue any webhooks that apply to the event.
     """
-    if settings.WEBHOOK_BACKEND_ENABLED:
+    if settings.WEBHOOKS_ENABLED:
         signal_received_timestamp = time.time()
         webhook_cache = get_or_set_webhook_cache()
         # look for any webhooks that match this event
@@ -88,7 +88,7 @@ def post_delete_receiver(sender, instance, **kwargs):
     Receives post_delete signals from registered models. If the webhook
     backend is enabled, queue any webhooks that apply to the event.
     """
-    if settings.WEBHOOK_BACKEND_ENABLED:
+    if settings.WEBHOOKS_ENABLED:
         signal_received_timestamp = time.time()
         webhook_cache = get_or_set_webhook_cache()
         obj_type = ContentType.objects.get_for_model(sender)
@@ -103,7 +103,7 @@ def bulk_operation_receiver(sender, **kwargs):
     Receives bulk_operation_signal signals from registered models. If the webhook
     backend is enabled, queue any webhooks that apply to the event.
     """
-    if settings.WEBHOOK_BACKEND_ENABLED:
+    if settings.WEBHOOKS_ENABLED:
         signal_received_timestamp = time.time()
         event = kwargs['event']
         webhook_cache = get_or_set_webhook_cache()
@@ -132,7 +132,7 @@ def register_signals(senders):
     Take a list of senders (Models) and register them to the post_save
     and post_delete signal receivers.
     """
-    if settings.WEBHOOK_BACKEND_ENABLED:
+    if settings.WEBHOOKS_ENABLED:
         # only register signals if the backend is enabled
         # this reduces load by not firing signals if the
         # webhook backend feature is disabled