improve plugin log viewer

- move start server to dedicated function within `webapp.py` - get log stream via new function - update logs on a 5 second interval - add switch to disable auto update of logs
LizardByte · Feb 24, 2023 · a089782 · a089782
1 parent 1d28959
commit a089782
Show file tree

Hide file tree

Showing 9 changed files with 155 additions and 56 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -97,6 +97,7 @@ jobs:
             !**/Plugger.bundle/Dockerfile
             !**/Plugger.bundle/docs
             !**/Plugger.bundle/scripts
+            !**/Plugger.bundle/tests
 
       - name: Package Release
         shell: bash
@@ -113,6 +114,7 @@ jobs:
             "-xr!Plugger.bundle/Dockerfile" \
             "-xr!Plugger.bundle/docs" \
             "-xr!Plugger.bundle/scripts" \
+            "-xr!Plugger.bundle/tests" \
             a "./Plugger.bundle.zip" "Plugger.bundle"
 
           mkdir artifacts

diff --git a/Contents/Code/__init__.py b/Contents/Code/__init__.py
@@ -1,9 +1,5 @@
 # -*- coding: utf-8 -*-
 
-# standard imports
-import sys
-from threading import Thread
-
 # plex debugging
 try:
     import plexhints  # noqa: F401
@@ -21,7 +17,7 @@
 
 # local imports
 from default_prefs import default_prefs
-from webapp import app
+from webapp import start_server
 
 
 def ValidatePrefs():
@@ -46,7 +42,6 @@ def ValidatePrefs():
     >>> ValidatePrefs()
     ...
     """
-    # todo - validate username and password
     error_message = ''  # start with a blank error message
 
     for key in default_prefs:
@@ -108,22 +103,9 @@ def Start():
     if prefs_valid.header == 'Error':
         Log.Warn('plug-in preferences are not valid.')
 
+    start_server()  # start the web server if it is not running
     Log.Debug('plug-in started.')
 
-    # use threading to start the flask app... or else web server seems to be killed after a couple of minutes
-    flask_thread = Thread(
-        target=app.run,
-        kwargs=dict(
-            host=Prefs['str_http_host'],
-            port=Prefs['int_http_port'],
-            debug=False,
-            use_reloader=False  # reloader doesn't work when running in a separate thread
-        )
-    )
-
-    # start flask application
-    flask_thread.start()
-
 
 @handler(prefix='/applications/plugger', name='Plugger', thumb='attribution.png')
 def main():

diff --git a/Contents/Code/webapp.py b/Contents/Code/webapp.py
@@ -1,6 +1,7 @@
 # standard imports
 import logging
 import os
+from threading import Thread
 
 # plex debugging
 try:
@@ -14,8 +15,8 @@
 
 # lib imports
 import flask
-from flask import Flask
-from flask import render_template, send_from_directory
+from flask import Flask, Response
+from flask import render_template, request, send_from_directory
 from flask_babel import Babel
 
 # local imports
@@ -60,18 +61,24 @@
 # test message
 app.logger.info('flask app logger test message')
 
-if Prefs['bool_log_werkzeug_messages']:
-    # get the werkzeug logger
-    werkzeug_logger = logging.getLogger('werkzeug')
+try:
+    Prefs['bool_log_werkzeug_messages']
+except KeyError:
+    # this fails when building docs
+    pass
+else:
+    if Prefs['bool_log_werkzeug_messages']:
+        # get the werkzeug logger
+        werkzeug_logger = logging.getLogger('werkzeug')
 
-    # replace the werkzeug logger handlers with the plugin logger handlers
-    werkzeug_logger.handlers = plugin_logger.handlers
+        # replace the werkzeug logger handlers with the plugin logger handlers
+        werkzeug_logger.handlers = plugin_logger.handlers
 
-    # use the same log level as the plugin logger
-    werkzeug_logger.setLevel(plugin_logger.level)
+        # use the same log level as the plugin logger
+        werkzeug_logger.setLevel(plugin_logger.level)
 
-    # test message
-    werkzeug_logger.info('werkzeug logger test message')
+        # test message
+        werkzeug_logger.info('werkzeug logger test message')
 
 
 @babel.localeselector
@@ -99,6 +106,28 @@ def get_locale():
     return Prefs['enum_locale']
 
 
+def start_server():
+    # use threading to start the flask app... or else web server seems to be killed after a couple of minutes
+    flask_thread = Thread(
+        target=app.run,
+        kwargs=dict(
+            host=Prefs['str_http_host'],
+            port=Prefs['int_http_port'],
+            debug=False,
+            use_reloader=False  # reloader doesn't work when running in a separate thread
+        )
+    )
+
+    # start flask application
+    flask_thread.start()
+
+
+def stop_server():
+    # stop flask server
+    # todo - this doesn't work
+    request.environ.get('werkzeug.server.shutdown')
+
+
 @app.route('/')
 @app.route('/home')
 def home():
@@ -117,8 +146,8 @@ def home():
     -----
     The following routes trigger this function.
 
-        `/`
-        `/home`
+        - `/`
+        - `/home`
 
     Examples
     --------
@@ -144,7 +173,7 @@ def favicon():
     -----
     The following routes trigger this function.
 
-        `/favicon.ico`
+        - `/favicon.ico`
 
     Examples
     --------
@@ -177,14 +206,46 @@ def logs(plugin):
     -----
     The following routes trigger this function.
 
-        `/logs/`
-        `/logs/<plugin name>`
+        - `/logs/`
+        - `/logs/<plugin name>`
 
     Examples
     --------
     >>> logs(plugin='dev.lizardbyte.plugger')
     """
+    return render_template('logs.html', title='Logs', plugin_identifier=plugin)
 
+
+@app.route('/log_stream/', defaults={'plugin': bundle_identifier})
+@app.route("/log_stream/<path:plugin>", methods=["GET"])
+def log_stream(plugin):
+    # type: (str) -> Response
+    """
+    Serve the plugin logs in plain text.
+
+    Collect and format the logs for the specified plugin.
+
+    Parameters
+    ----------
+    plugin : str
+        The reverse domain name of the plugin, e.g. `dev.lizardbyte.plugger`.
+
+    Returns
+    -------
+    Response
+        The text of the log files.
+
+    Notes
+    -----
+    The following routes trigger this function.
+
+        - `/log_stream/`
+        - `/log_stream/<plugin name>`
+
+    Examples
+    --------
+    >>> log_stream(plugin='dev.lizardbyte.plugger')
+    """
     base_log_file = '%s.log' % plugin
     combined_log = ''
 
@@ -202,7 +263,7 @@ def logs(plugin):
             combined_log += str(Core.storage.load(filename=log_file, binary=False))
         count += -1
 
-    return render_template('logs.html', title='Logs', logs=combined_log)
+    return Response(combined_log, mimetype="text/plain", content_type="text/event-stream")
 
 
 @app.route('/status')

diff --git a/Contents/Resources/web/templates/base.html b/Contents/Resources/web/templates/base.html
@@ -42,6 +42,7 @@
             <!-- The page template -->
             {% block content %}{% endblock %}
         </main>
+        {% block scripts %}{% endblock %}
     </body>
 
 </html>
diff --git a/Contents/Resources/web/templates/logs.html b/Contents/Resources/web/templates/logs.html
@@ -1,15 +1,68 @@
 {% extends 'base.html' %}
 {% block content %}
     <div class="container">
-        <div class="row">
-            <div class="col-12">
-                <div class="row">
-                  <h2>Logging will appear here:</h2>
-                    <div class="logging_window">
-                        <pre id="logs">{{ logs }}</pre>
-                    </div>
-                </div>
+        <div class="row text-white">
+            {# Auto refresh toggle #}
+            <div class="form-check form-switch">
+                <input class="form-check-input" type="checkbox" role="switch" id="switch_auto_refresh" checked>
+                <label class="form-check-label" for="switch_auto_refresh">{{ _('Auto refresh') }}</label>
+            </div>
+            <h2>{{ _('Plugin Logs:') }}</h2>
+            <div id="logging_window">
+                <pre id="logs"></pre>
+                <button id="copy-btn" type="button" class="btn btn-outline-light rounded-0 position-absolute top-0 end-0 mt-2 me-2" data-clipboard-target="#logs">
+                    <i class="fa-solid fa-fw fa-copy"></i>
+                </button>
             </div>
         </div>
     </div>
 {% endblock content %}
+
+{% block scripts %}
+    <script type="text/javascript" src="{{ url_for('static', filename='node_modules/clipboard/dist/clipboard.min.js') }}"></script>
+    <script>
+        new ClipboardJS('#copy-btn');
+    </script>
+
+    <script>
+        // this will run every 5 seconds to update the logs
+        updateLogs = () => {
+            $.ajax({
+                url: "/log_stream/{{ plugin_identifier }}",
+                type: "GET",
+                success: function (data) {
+                    let log_container = document.getElementById("logs")
+                    log_container.innerHTML = data
+                }
+            })
+        }
+
+        // update the logs immediately
+        updateLogs()
+
+        // then setup update timer to update every 5 seconds
+        const updateIntervalPeriod = 5000
+        var updateInterval
+        // setInterval(updateLogs, updateIntervalPeriod)
+
+        // add event listeners to the auto-refresh toggle switch
+        const switchAutoRefresh = document.getElementById("switch_auto_refresh");
+        switchAutoRefresh.addEventListener("change", () => {
+            toggleAutoRefresh()
+        })
+
+        // function to toggle the auto-refresh switch
+        toggleAutoRefresh = () => {
+            if (switchAutoRefresh.checked) {
+                // turn on auto-refresh
+                updateInterval = setInterval(updateLogs, updateIntervalPeriod)
+            } else {
+                // turn off auto-refresh
+                clearInterval(updateInterval);
+            }
+        }
+
+        // run the toggle function to set the initial state
+        toggleAutoRefresh()
+    </script>
+{% endblock scripts %}
diff --git a/Contents/Strings/plugger.po b/Contents/Strings/plugger.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Plugger v0\n"
 "Report-Msgid-Bugs-To: github.com/plugger\n"
-"POT-Creation-Date: 2023-02-24 11:35-0500\n"
+"POT-Creation-Date: 2023-02-24 14:43-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,6 +17,14 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Generated-By: Babel 2.9.1\n"
 
+#: Contents/Resources/web/templates/logs.html:8
+msgid "Auto refresh"
+msgstr ""
+
+#: Contents/Resources/web/templates/logs.html:10
+msgid "Plugin Logs:"
+msgstr ""
+
 #: Contents/Resources/web/templates/navbar.html:25
 msgid "Donate"
 msgstr ""

diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst
@@ -9,12 +9,6 @@ Minimal setup is required to use Plugger. In addition to the installation, a cou
    #. Select the gear cog when hovering over the Plugger plugin tile.
    #. Set the values of the preferences and save.
 
-.. Note:: If a movie's metadata was refreshed and no theme song was added, it is most likely that the movie is not in
-   the database. Please see :ref:`contributing/database <contributing/database:database>` for information on how to
-   contribute.
-
-.. Attention:: It may take several minutes after completing a metadata refresh for a theme song to be available.
-
 Preferences
 -----------
 

diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
     "@fontsource/open-sans": "4.5.13",
     "@fortawesome/fontawesome-free": "6.2.0",
     "bootstrap": "5.2.2",
-    "jquery": "3.6.1"
+    "clipboard": "2.0.11",
+    "jquery": "3.6.3"
   }
 }
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -2,9 +2,6 @@
 import os
 import sys
 
-# lib imports
-import pytest
-
 # add Contents directory to the system path
 if os.path.isdir('Contents'):
     sys.path.append('Contents')