SW-1027-release-0-10-1-hotfix-1 (mrbeam#1429)

* SW-974
- Disable netconnectd debug log (mrbeam#1428)
* SW-974
-
* SW-1046
- Modify the "userData" sent to design store by sanitizing the mr beam plugin verison (mrbeam#1432)
* SW-1048
- Modify the version comparative methods in the mr beam plugin (mrbeam#1433)
- Add semantic versioning comparison library https://www.npmjs.com/package/compare-versions

Co-authored-by: Josef-MrBeam <[email protected]>
Co-authored-by: khaledsherkawi <[email protected]>

Author: 3 people

octoprint_mrbeam/__init__.py

@@ -610,6 +610,7 @@ def get_assets(self):
         # core UI here.
         assets = dict(
             js=[
+                "js/lib/compare-versions.js",
                 "js/helpers/quick_shape_helper.js",
                 "js/helpers/element_helper.js",
                 "js/helpers/debug_rendering_helper.js",

octoprint_mrbeam/__version.py

@@ -1,4 +1,4 @@
 """
 Version of Mr beam plugin
 """
-__version__ = "0.10.2"
+__version__ = "0.10.3"

octoprint_mrbeam/migrate.py

@@ -1,7 +1,6 @@
-import sys
+import json
 from collections import Iterable, Sized, Mapping
 import os
-import platform
 import re
 import shutil
 from datetime import datetime
@@ -11,11 +10,16 @@
 from octoprint_mrbeam.software_update_information import BEAMOS_LEGACY_DATE
 from octoprint_mrbeam.mrb_logger import mrb_logger
 from octoprint_mrbeam.util.cmd_exec import exec_cmd, exec_cmd_output
-from octoprint_mrbeam.util import logExceptions, dict_get
+from octoprint_mrbeam.util import logExceptions
 from octoprint_mrbeam.printing.profile import laserCutterProfileManager
 from octoprint_mrbeam.printing.comm_acc2 import MachineCom
 from octoprint_mrbeam.__version import __version__
 from octoprint_mrbeam.materials import materials
+from octoprint_mrbeam.migration import (
+    MIGRATION_STATE,
+    MigrationBaseClass,
+    list_of_migrations,
+)
 
 
 def migrate(plugin):
@@ -70,6 +74,7 @@ def __init__(self, plugin):
             self.plugin._settings.get(["dev", "suppress_migrations"]) or IS_X86
         )
         beamos_tier, self.beamos_date = self.plugin._device_info.get_beamos_version()
+        self.beamos_version = self.plugin._device_info.get_beamos_version_number()
 
     def run(self):
         try:
@@ -249,6 +254,7 @@ def run(self):
                     equal_ok=False,
                 ):
                     self.fix_octoprint_prerelease_setting()
+
                 # migrations end
 
                 self._logger.info(
@@ -262,14 +268,86 @@ def run(self):
                     "No migration done because 'suppress_migrations' is set to true in settings."
                 )
             else:
-                self._logger.debug("No migration required.")
+                self._logger.info("old migration - No migration required.")
 
+            self._run_migration()
             self.save_current_version()
         except MigrationException as e:
             self._logger.exception("Error while migration: {}".format(e))
         except Exception as e:
             self._logger.exception("Unhandled exception during migration: {}".format(e))
 
+    def _run_migration(self):
+        """
+        run the new migrations
+        @return:
+        """
+        self._logger.debug("beamos_version: {}".format(self.beamos_version))
+
+        list_of_migrations_obj_available_to_run = [
+            MigrationBaseClass.return_obj(migration, self.plugin)
+            for migration in list_of_migrations
+            if migration.shouldrun(migration, self.beamos_version)
+        ]
+        self._logger.debug(list_of_migrations_obj_available_to_run)
+
+        if not len(list_of_migrations_obj_available_to_run):
+            self._logger.info("new migration - no migration needed")
+            return
+
+        migrations_json_file_path = os.path.join(
+            self.plugin._settings.getBaseFolder("base"), "migrations.json"
+        )
+
+        # if file is not there create it
+        if not os.path.exists(migrations_json_file_path):
+            self._logger.info("create " + migrations_json_file_path + " file")
+            with open(migrations_json_file_path, "w") as f:
+                json.dump({}, f)
+
+        try:
+            with open(migrations_json_file_path, "r") as f:
+                try:
+                    migration_executed = json.load(f)
+                except ValueError:
+                    raise MigrationException(
+                        "couldn't read migrations json file content filepath:"
+                        + migrations_json_file_path
+                    )
+
+                list_of_migrations_to_run = list(
+                    list_of_migrations_obj_available_to_run
+                )
+                for migration in list_of_migrations_obj_available_to_run:
+                    if migration.id in migration_executed:
+                        if migration_executed[migration.id]:
+                            list_of_migrations_to_run.remove(migration)
+                        else:
+                            # migration failed, should stay in execution queue and the following too
+                            break
+
+                if not len(list_of_migrations_to_run):
+                    self._logger.info("new migration - all migrations already done")
+                    return
+
+                for migration in list_of_migrations_to_run:
+                    migration.run()
+
+                    # if migration sucessfull append to executed successfull
+                    if migration.state == MIGRATION_STATE.migration_done:
+                        migration_executed[migration.id] = True
+                    else:
+                        # mark migration as failed and skipp the following ones
+                        migration_executed[migration.id] = False
+                        break
+
+            with open(migrations_json_file_path, "w") as f:
+                f.write(json.dumps(migration_executed))
+        except IOError:
+            self._logger.error("migration execution file IO error")
+        except MigrationException as e:
+            self._logger.exception("error during migration {}".format(e))
+
     def is_migration_required(self):
         self._logger.debug(
             "beomosdate %s version %s",

octoprint_mrbeam/migration/Mig001.py

@@ -0,0 +1,63 @@
+from octoprint_mrbeam.migration.migration_base import (
+    MigrationBaseClass,
+)
+
+
+class Mig001NetconnectdDisableLogDebugLevel(MigrationBaseClass):
+    """
+    Migration for beamos versions 0.18.0 up to 0.18.1 to disable the the netconnectd debug mode
+    """
+
+    BEAMOS_VERSION_LOW = "0.18.0"
+    BEAMOS_VERSION_HIGH = "0.18.1"
+
+    def __init__(self, plugin):
+        """
+        initalization of the migration 001
+
+        Args:
+            plugin: Mr Beam Plugin
+        """
+        super(Mig001NetconnectdDisableLogDebugLevel, self).__init__(plugin)
+
+    @property
+    def id(self):
+        """
+        return the id of the migration
+
+        Returns:
+            string: id of the migration
+        """
+        return "001"
+
+    def _run(self):
+        """
+        migration steps executet during migration
+
+        Returns:
+            None
+        """
+        self._logger.debug("stop netconnectd service")
+        self.exec_cmd("sudo service netconnectd stop")
+
+        self._logger.debug("disable debug mode of netconnect")
+        self.exec_cmd("sudo truncate -s 0 /etc/default/netconnectd")
+
+        self._logger.debug("purge content of netconnectd.log")
+        self.exec_cmd("sudo truncate -s 0 /var/log/netconnectd.log")
+
+        self._logger.debug("restart netconnectd service")
+        self.exec_cmd("sudo service netconnectd restart")
+
+        super(Mig001NetconnectdDisableLogDebugLevel, self)._run()
+
+    def _rollback(self):
+        """
+        rollback steps executet during rollback
+
+        Returns:
+            None
+        """
+        self._logger.debug("restart netconnectd service")
+        self.exec_cmd("sudo service netconnectd restart")
+        super(Mig001NetconnectdDisableLogDebugLevel, self)._rollback()

octoprint_mrbeam/migration/__init__.py

@@ -0,0 +1,26 @@
+"""
+This package contains all the migrations that are needed for the beamOS
+To add a new migration create a child class of the MigrationBaseClass and extend the run and rollback method with
+the steps needed for the new migration and the beamOS versions it should run for
+
+How to use:
+    - import list_of_migrations
+    - iterate over the list items and run the shouldrun(<migrationclass>, <beamos_version>)
+    - compare the result list with the already executed list and call the run() of the result list
+"""
+# these imports are for external use
+from octoprint_mrbeam.migration.migration_base import MIGRATION_STATE as MIGRATION_STATE
+from octoprint_mrbeam.migration.migration_base import (
+    MigrationBaseClass as MigrationBaseClass,
+)
+from octoprint_mrbeam.migration.migration_base import (
+    MigrationException as MigrationException,
+)
+
+# this is for internal use
+from octoprint_mrbeam.migration.Mig001 import Mig001NetconnectdDisableLogDebugLevel
+
+# To add migrations they have to be added to this list till we automate it
+list_of_migrations = [
+    Mig001NetconnectdDisableLogDebugLevel,
+]