Added flag to control http poke endpoint:

Author: Mark Gibbs

demo/demo/plotly_apps.py

@@ -303,7 +303,7 @@ def callback_show_timeseries(internal_state_string, state_uid, **kwargs):
     traces = [go.Scatter(y=df[colour],
                          x=df['index'],
                          name=colour,
-                         line=dict(color=colors.get(colour,'#000000')),
+                         line=dict(color=colors.get(colour, '#000000')),
                         ) for colour in colour_series]
 
     return {'data':traces,

demo/demo/settings.py

@@ -125,6 +125,8 @@
     "ws_route" : "ws/channel",
 
     "insert_demo_migrations" : True,  # Insert model instances used by the demo
+
+    "http_poke_enabled" : True, # Flag controlling availability of direct-to-messaging http endpoint
     }
 
 # Static files (CSS, JavaScript, Images)

django_plotly_dash/routing.py

@@ -29,11 +29,19 @@
 from django.conf.urls import url
 
 from .consumers import MessageConsumer, PokePipeConsumer
-from .util import pipe_ws_endpoint_name, http_endpoint
+from .util import pipe_ws_endpoint_name, http_endpoint, http_poke_endpoint_enabled
 
 # TODO document this and discuss embedding with other routes
+
+http_routes = [
+    ]
+
+if http_poke_endpoint_enabled():
+    http_routes.append(url(http_endpoint("poke"), PokePipeConsumer))
+
+http_routes.append(url("^", AsgiHandler)) # AsgiHandler is 'the normal Django view handlers'
+
 application = ProtocolTypeRouter({
     'websocket': AuthMiddlewareStack(URLRouter([url(pipe_ws_endpoint_name(), MessageConsumer),])),
-    'http': AuthMiddlewareStack(URLRouter([url(http_endpoint("poke"), PokePipeConsumer),
-                                           url("^", AsgiHandler),])), # AsgiHandler is 'the normal Django view handlers'
+    'http': AuthMiddlewareStack(URLRouter(http_routes)),
     })

django_plotly_dash/util.py

@@ -49,3 +49,7 @@ def insert_demo_migrations():
     'Check settings and report if objects for demo purposes should be inserted during migration'
 
     return _get_settings().get('insert_demo_migrations', False)
+
+def http_poke_endpoint_enabled():
+    'Return true if the http endpoint is enabled through the settings'
+    return _get_settings().get('http_poke_enabled', True)

django_plotly_dash/views.py

@@ -108,14 +108,15 @@ def component_suites(request, resource=None, component=None, **kwargs):
     return HttpResponseRedirect(redirect_to=redone_url)
 
 
+# pylint: disable=wrong-import-position, wrong-import-order
 from django.template.response import TemplateResponse
 
 def add_to_session(request, template_name="index.html", **kwargs):
     'Add some info to a session in a place that django-plotly-dash can pass to a callback'
 
     django_plotly_dash = request.session.get("django_plotly_dash", dict())
 
-    session_add_count = django_plotly_dash.get('add_counter',0)
+    session_add_count = django_plotly_dash.get('add_counter', 0)
     django_plotly_dash['add_counter'] = session_add_count + 1
     request.session['django_plotly_dash'] = django_plotly_dash
 

docs/configuration.rst

@@ -16,6 +16,9 @@ below.
       # Route used for direct http insertion of pipe messages
       "http_route" : "dpd/views",
 
+      # Flag controlling existince of http poke endpoint
+      "http_poke_enabled" : True,
+
       # Insert data for the demo when migrating
       "insert_demo_migrations" : False,
   }

docs/updating.rst

@@ -71,8 +71,9 @@ introduces another indeterminacy.
 HTTP Endpoint
 -------------
 
-There is an HTTP endpoint, configured with
-the ``http_route`` option, that allows direct insertion of messages into a message channel. It is a
+There is an HTTP endpoint, :ref:`configured <configuration>` with
+the ``http_route`` option, that allows direct insertion of messages into a message
+channel. It is a
 direct equivalent of calling the ``send_to_pipe_channel`` function, and
 expects the ``channel_name``, ``label`` and ``value`` arguments to be provided in a JSON-encoded
 dictionary.
@@ -94,6 +95,9 @@ other hand, if this endpoint is restricted so that it is only available from tru
 itself, it does provide a mechanism for Django code running outside of the ASGI server, such as in a WSGI process or
 Celery worker, to push a message out to running applications.
 
+The ``http_poke_enabled`` flag controls the availability of the endpoint. If false, then it is not registered at all and
+all requests will receive a 404 HTTP error code.
+
 Deployment
 ----------