✨ New info warning type & warn about fw dev builds

Author: foosel

octoprint_firmware_check/__init__.py

@@ -16,6 +16,7 @@
 
 from .checks import Severity
 from .checks.firmware_broken import FirmwareBrokenChecks
+from .checks.firmware_development import FirmwareDevelopmentChecks
 from .checks.firmware_unsafe import FirmwareUnsafeChecks
 
 TERMINAL_WARNING = """
@@ -27,9 +28,19 @@
 
 """
 
+TERMINAL_INFO = """
+---------------------------------------------------------------------------
+{message}
+
+Learn more at {url}
+---------------------------------------------------------------------------
+
+"""
+
 FIRMWARE_CHECKS = {
     "firmware-unsafe": FirmwareUnsafeChecks.as_dict(),
     "firmware-broken": FirmwareBrokenChecks.as_dict(),
+    "firmware-development": FirmwareDevelopmentChecks.as_dict(),
 }
 
 
@@ -38,6 +49,7 @@ class FirmwareCheckPlugin(
     octoprint.plugin.EventHandlerPlugin,
     octoprint.plugin.SimpleApiPlugin,
     octoprint.plugin.TemplatePlugin,
+    octoprint.plugin.SettingsPlugin,
 ):
 
     # noinspection PyMissingConstructor
@@ -55,7 +67,19 @@ def get_template_configs(self):
                 data_bind="visible: printerState.isOperational() && loginState.isAdmin() && warnings().length > 0",
                 icon="exclamation-triangle",
                 styles_wrapper=["display: none"],
-            )
+                template="firmware_check_sidebar_warning.jinja2",
+                suffix="_warning",
+            ),
+            dict(
+                type="sidebar",
+                name=gettext("Info"),
+                data_bind="visible: printerState.isOperational() && loginState.isAdmin() && infos().length > 0",
+                icon="info-circle",
+                styles_wrapper=["display: none"],
+                template="firmware_check_sidebar_info.jinja2",
+                suffix="_info",
+            ),
+            dict(type="settings", name=gettext("Firmware Check"), custom_bindings=False),
         ]
 
     ##~~ AssetPlugin API
@@ -83,6 +107,11 @@ def on_api_get(self, request):
             return flask.make_response("Insufficient rights", 403)
         return flask.jsonify(self._warnings)
 
+    ##~~ SettingsPlugin API
+
+    def get_settings_defaults(self):
+        return {"ignore_infos": False}
+
     ##~~ GCODE received hook handler
 
     def on_gcode_received(self, comm_instance, line, *args, **kwargs):
@@ -220,15 +249,25 @@ def _run_checks(self, check_type, *args, **kwargs):
             self._ping_clients()
 
     def _register_warning(self, warning_type, message, severity, url):
+        output = TERMINAL_WARNING
+        if severity == Severity.INFO:
+            output = TERMINAL_INFO
+
         self._log_to_terminal(
-            TERMINAL_WARNING.format(
+            output.format(
                 message="\n".join(textwrap.wrap(message, 75)),
                 warning_type=warning_type,
                 url=url,
             )
         )
         self._warnings[warning_type] = dict(message=message, severity=severity, url=url)
 
+        logline = "{}. More information at {}".format(message, url)
+        if severity == Severity.INFO:
+            self._logger.info(logline)
+        else:
+            self._logger.warning(logline)
+
     def _reset_warnings(self):
         self._warnings.clear()
         self._ping_clients()

octoprint_firmware_check/checks/__init__.py

@@ -150,4 +150,5 @@ def received(self, line):
 
 class Severity(object):
     INFO = "info"
+    WARNING = "warning"
     CRITICAL = "critical"

octoprint_firmware_check/checks/firmware_broken.py

@@ -19,7 +19,7 @@ def as_dict(cls):
                 "communication protocol. This may cause print failures or other annoyances. "
                 "You'll need to take additional steps for OctoPrint to fully work with it."
             ),
-            severity=Severity.INFO,
+            severity=Severity.WARNING,
         )
 
 

octoprint_firmware_check/checks/firmware_development.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+__license__ = "GNU Affero General Public License http://www.gnu.org/licenses/agpl.html"
+__copyright__ = "Copyright (C) 2019 The OctoPrint Project - Released under terms of the AGPLv3 License"
+
+from flask_babel import gettext
+
+from . import Check, Severity
+
+
+class FirmwareDevelopmentChecks(object):
+    @classmethod
+    def as_dict(cls):
+        return dict(
+            checks=(MarlinBugfixCheck(),),
+            message=gettext(
+                "Your printer's firmware is a development build. It might be more unstable "
+                "than a release version and should be updated regularly."
+            ),
+            severity=Severity.INFO,
+        )
+
+
+class MarlinBugfixCheck(Check):
+    """
+    Marlin bugfix builds.
+
+    Identified by firmware name that contains "Marlin bugfix-"
+    """
+
+    name = "marlin_bugfix"
+
+    def m115(self, name, data):
+        self._triggered = name and "marlin bugfix-" in name.lower()
+        self._active = False

octoprint_firmware_check/static/css/firmware_check.css

@@ -5,8 +5,12 @@ $(function () {
         self.loginState = parameters[0];
         self.printerState = parameters[1];
         self.access = parameters[2];
+        self.settings = parameters[3];
 
         self.warnings = ko.observableArray([]);
+        self.infos = ko.observableArray([]);
+
+        self.disablingInfos = ko.observable(false);
 
         self.requestData = function () {
             if (
@@ -28,22 +32,47 @@ $(function () {
 
         self.fromResponse = function (data) {
             var warnings = [];
+            var infos = [];
             _.each(data, function (data, warning_type) {
-                warnings.push({
+                var item = {
                     type: warning_type,
                     message: gettext(data.message),
                     severity: data.severity,
                     url: data.url
-                });
+                };
+                if (data.severity === "info") {
+                    if (!self.settings.settings.plugins.firmware_check.ignore_infos()) {
+                        infos.push(item);
+                    }
+                } else {
+                    warnings.push(item);
+                }
             });
             self.warnings(warnings);
+            self.infos(infos);
         };
 
         self.onStartup = function () {
             self.requestData();
         };
 
-        self.onUserPermissionsChanged = self.onUserLoggedIn = self.onUserLoggedOut = function () {
+        var subbed = false;
+        self.onStartup = self.onUserPermissionsChanged = self.onUserLoggedIn = self.onUserLoggedOut = function () {
+            if (
+                self.settings &&
+                self.settings.settings &&
+                self.settings.settings.plugins &&
+                self.settings.settings.plugins.firmware_check &&
+                !subbed
+            ) {
+                subbed = true;
+                self.settings.settings.plugins.firmware_check.ignore_infos.subscribe(
+                    function () {
+                        self.requestData();
+                    }
+                );
+            }
+
             self.requestData();
         };
 
@@ -70,17 +99,40 @@ $(function () {
                     return gettext("Critical Warning: Firmware Unsafe");
                 case "firmware-broken":
                     return gettext("Warning: Firmware Broken");
+                case "firmware-development":
+                    return gettext("Info: Firmware Development Build");
                 default:
                     return data.severity === "critical"
                         ? gettext("Critical Warning")
-                        : gettext("Warning");
+                        : data.severity === "warning"
+                        ? gettext("Warning")
+                        : gettext("Info");
+            }
+        };
+
+        self.disableInfos = function () {
+            if (self.loginState.hasPermission(self.access.permissions.SETTINGS)) {
+                self.disablingInfos(true);
+                OctoPrint.settings
+                    .savePluginSettings("firmware_check", {ignore_infos: true})
+                    .always(function () {
+                        self.disablingInfos(false);
+                    });
             }
         };
     }
 
     OCTOPRINT_VIEWMODELS.push({
         construct: FirmwareCheckViewModel,
-        dependencies: ["loginStateViewModel", "printerStateViewModel", "accessViewModel"],
-        elements: ["#sidebar_plugin_firmware_check_wrapper"]
+        dependencies: [
+            "loginStateViewModel",
+            "printerStateViewModel",
+            "accessViewModel",
+            "settingsViewModel"
+        ],
+        elements: [
+            "#sidebar_plugin_firmware_check_warning_wrapper",
+            "#sidebar_plugin_firmware_check_info_wrapper"
+        ]
     });
 });

octoprint_firmware_check/static/js/firmware_check.js

@@ -1,4 +1,4 @@
-#sidebar_plugin_firmware_check_wrapper {
+#sidebar_plugin_firmware_check_warning_wrapper {
   border: 1px solid #b94a48;
 
   .accordion-heading {

octoprint_firmware_check/static/less/firmware_check.less

@@ -0,0 +1,12 @@
+<h3>{{ _('Firmware Check') }}</h3>
+
+<form class="form-horizontal" onsubmit="return false;">
+    <div class="control-group">
+        <div class="controls">
+            <label class="checkbox">
+                <input type="checkbox" data-bind="checked: settings.plugins.firmware_check.ignore_infos"> {{ _('Disable warnings of severity "info"') }}
+            </label>
+            <span class="help-block">{{ _('Check this to disable warnings from firmware checks that are only of informational "heads-up" nature, like running a firmware development build.') }}</span>
+        </div>
+    </div>
+</form>

octoprint_firmware_check/templates/firmware_check_settings.jinja2

@@ -0,0 +1,11 @@
+<!-- ko foreach: infos -->
+<p><strong data-bind="text: $root.warningText($data)"></strong></p>
+<p class="firmware_check_info" data-bind="class: $root.cssClass($data)">
+    <span data-bind="text: message"></span><br>
+    <a target="_blank" rel="noreferrer noopener" data-bind="attr: {href: url}">{{ _('Learn more...') }}</a>
+</p>
+<!-- /ko -->
+
+<small>
+    <a href="javascript:void(0)" data-bind="click: disableInfos">{{ _('Disable firmware checks of severity "Info"') }}</a> <i class="fa fa-spinner fa-spin" data-bind="visible: disablingInfos"></i>
+</small>