Add admin functionality to register new apps (#197)

* Add check of status and a button to load known local instances

* Update model

* Added missing demo pages

* Add test of app insertion view'

Author: delsim

django_plotly_dash/dash_wrapper.py

@@ -60,6 +60,11 @@ def all_apps():
     'Return a dictionary of all locally registered apps with the slug name as key'
     return usable_apps
 
+def get_local_stateless_list():
+    """Return a list of all locally registered stateless apps
+    """
+    return list(usable_apps)
+
 def get_local_stateless_by_name(name):
     '''
     Locate a registered dash app by name, and return a DjangoDash instance encapsulating the app.

django_plotly_dash/models.py

@@ -23,18 +23,24 @@
 '''
 
 import json
+import logging
 
 from django.db import models
 from django.contrib import admin
 from django.utils.text import slugify
 from django.shortcuts import get_object_or_404
 
-from .dash_wrapper import get_local_stateless_by_name
+from .dash_wrapper import get_local_stateless_by_name, get_local_stateless_list
+
+
+logger = logging.getLogger(__name__)
+
 
 def get_stateless_by_name(name):
     'Locate stateless app instance given its name'
     return get_local_stateless_by_name(name)
 
+
 class StatelessApp(models.Model):
     '''
     A stateless Dash app. An instance of this model represents a dash app without any specific state
@@ -78,11 +84,34 @@ def find_stateless_by_name(name):
     dsa_app.save()
     return dash_app
 
+
+def check_stateless_loaded():
+    for ua in get_local_stateless_list():
+        try:
+            find_stateless_by_name(ua)
+        except:
+            logger.warning("django-plotly-dash: Unable to create stateless instance: "+str(ua))
+
+
 class StatelessAppAdmin(admin.ModelAdmin):
     'Admin for StatelessApp ORM model instances'
     list_display = ['app_name', 'slug',]
     list_filter = ['app_name', 'slug',]
 
+    def check_registered(modeladmin, request, queryset):
+        # Check all existing apps, keep if OK
+        for sa in queryset.all():
+            try:
+                q = sa.as_dash_app()
+            except:
+                logger.warnng("django-plotly-dash: Unable to load stateless app: "+str(sa))
+
+
+    check_registered.short_description = "Check stateless apps"
+
+    actions = [check_registered,]
+
+
 class DashApp(models.Model):
     '''
     An instance of this model represents a dash application and its internal state

django_plotly_dash/templates/admin/django_plotly_dash/statelessapp/change_list.html

@@ -0,0 +1,17 @@
+{% extends "admin/change_list.html" %}
+{% load i18n admin_urls %}
+
+{% block object-tools-items %}
+  <li>
+    <a href="{% url 'the_django_plotly_dash:add_stateless_apps' %}" class="addlink">
+      {% blocktrans with cl.opts.verbose_name as name %}Find Apps{% endblocktrans %}
+    </a>
+  </li>
+  <li>
+    {% url cl.opts|admin_urlname:'add' as add_url %}
+    <a href="{% add_preserved_filters add_url is_popup to_field %}" class="addlink">
+      {% blocktrans with cl.opts.verbose_name as name %}Add {{ name }}{% endblocktrans %}
+    </a>
+  </li>
+  {% endblock %}
+  

django_plotly_dash/tests.py

@@ -346,3 +346,22 @@ def test_finders():
     assert dcf is not None
     assert dadf is not None
     assert daf is not None
+
+@pytest.mark.django_db
+def test_app_loading(client):
+
+    from django_plotly_dash.models import check_stateless_loaded
+    from django.urls import reverse
+
+    # Function should run wthout raising errors
+    check_stateless_loaded()
+    assert True
+
+    url = reverse('the_django_plotly_dash:add_stateless_apps')
+
+    response = client.post(url)
+
+    # This view redirects to the main admin
+    assert response.status_code == 302
+
+

django_plotly_dash/urls.py

@@ -28,12 +28,15 @@
 from django.views.decorators.csrf import csrf_exempt
 
 from .views import routes, layout, dependencies, update, main_view, component_suites, component_component_suites, asset_redirection
+from .views import add_stateless_apps
 
 from .app_name import app_name, main_view_label
 
 from .access import process_view_function
 
-urlpatterns = []
+urlpatterns = [
+    path('add_stateless_apps',add_stateless_apps,name='add_stateless_apps'),
+    ]
 
 for base_type, args, name_prefix, url_ending, name_suffix in [('instance', {}, '', '', '', ),
                                                               ('app', {'stateless':True}, 'app-', '', '', ),

django_plotly_dash/views.py

@@ -37,7 +37,7 @@ def check_fingerprint(resource):
         return resource, None
 
 
-from .models import DashApp
+from .models import DashApp, check_stateless_loaded
 from .util import get_initial_arguments, static_path
 
 def routes(*args, **kwargs):
@@ -172,3 +172,8 @@ def asset_redirection(request, path, ident=None, stateless=False, **kwargs):
 
     return redirect(static_path)
 
+def add_stateless_apps(request, **kwargs):
+    """Check all registered stateless apps and create ORM entries that are missing"""
+    check_stateless_loaded()
+    return redirect('admin:django_plotly_dash_statelessapp_changelist')
+

docs/demo_notes.rst

@@ -14,6 +14,8 @@ source repository.
 #. Simple html injection
 #. Bootstrap components
 #. Session state storage
+#. Local serving of assets
+#. Multiple callback values
 
 The templates that drive each of these can be found in
 the `github repository <https://github.com/GibbsConsulting/django-plotly-dash/tree/master/demo/demo/templates>`_.

docs/models_and_state.rst

@@ -34,6 +34,11 @@ The main role of a ``StatelessApp`` instance is to manage access to the associat
 exposed through the ``as_dash_app`` member
 function.
 
+In the Django admin, an action is provided to check all of the known stateless instances. Those that cannot be instantiated
+are logged; this is a useful quick check to see what apps are avalilable. Also, in the same admin an additional button
+is provided to create ``StatelessApp`` instances for any known instance that does not have an ORM entry.
+
+
 The ``DashApp`` model
 ---------------------