refactor plugin loading

InvenTree/InvenTree/settings.py

@@ -262,7 +262,7 @@ INSTALLED_APPS = [
     'report.apps.ReportConfig',
     'stock.apps.StockConfig',
     'users.apps.UsersConfig',
-    'plugin.apps.PluginConfig',
+    'plugin.apps.PluginAppConfig',
     'InvenTree.apps.InvenTreeConfig',       # InvenTree app runs last
 
     # Third part add-ons

InvenTree/plugin/apps.py

@@ -20,13 +20,98 @@ from plugin.integration import IntegrationPluginBase
 logger = logging.getLogger('inventree')
 
 
-class PluginConfig(AppConfig):
+class PluginAppConfig(AppConfig):
     name = 'plugin'
 
     def ready(self):
+        self.collect_plugins()
+
+        try:
+            # we are using the db from here - so for migrations etc we need to try this block
+            self.init_plugins()
+            self.activate_plugins()
+        except (OperationalError, ProgrammingError):
+            # Exception if the database has not been migrated yet
+            pass
+
+    def activate_plugins(self):
+        """fullfill integrations for all activated plugins"""
         from common.models import InvenTreeSetting
+
+        # activate integrations
+        plugins = settings.INTEGRATION_PLUGINS.items()
+        logger.info(f'Found {len(plugins)} active plugins')
+
+            # if plugin settings are enabled enhance the settings
+        if settings.TESTING or InvenTreeSetting.get_setting('ENABLE_PLUGINS_SETTING'):
+            logger.info('Registering IntegrationPlugin settings')
+            for slug, plugin in plugins:
+                if plugin.mixin_enabled('settings'):
+                    plugin_setting = plugin.settingspatterns
+                    settings.INTEGRATION_PLUGIN_SETTING[slug] = plugin_setting
+
+                        # Add to settings dir
+                    InvenTreeSetting.GLOBAL_SETTINGS.update(plugin_setting)
+
+            # if plugin apps are enabled
+        if settings.TESTING or ((not settings.INTEGRATION_APPS_LOADED) and InvenTreeSetting.get_setting('ENABLE_PLUGINS_APP')):
+            logger.info('Registering IntegrationPlugin apps')
+            settings.INTEGRATION_APPS_LOADED = True  # ensure this section will not run again
+            apps_changed = False
+
+                # add them to the INSTALLED_APPS
+            for slug, plugin in plugins:
+                if plugin.mixin_enabled('app'):
+                    try:
+                            # for local path plugins
+                        plugin_path = '.'.join(pathlib.Path(plugin.path).relative_to(settings.BASE_DIR).parts)
+                    except ValueError:
+                            # plugin is shipped as package
+                        plugin_path = plugin.PLUGIN_NAME
+                    if plugin_path not in settings.INSTALLED_APPS:
+                        settings.INSTALLED_APPS += [plugin_path]
+                        apps_changed = True
+
+                # if apps were changed reload
+                # TODO this is a bit jankey to be honest
+            if apps_changed:
+                apps.app_configs = OrderedDict()
+                apps.apps_ready = apps.models_ready = apps.loading = apps.ready = False
+                apps.clear_cache()
+                apps.populate(settings.INSTALLED_APPS)
+
+    def init_plugins(self):
+        """initialise all found plugins"""
         from plugin.models import PluginConfig
 
+        logger.info('Starting plugin initialisation')
+            # Initialize integration plugins
+        for plugin in inventree_plugins.load_integration_plugins():
+                # check if package
+            was_packaged = getattr(plugin, 'is_package', False)
+
+                # check if activated
+                # these checks only use attributes - never use plugin supplied functions -> that would lead to arbitrary code execution!!
+            plug_name = plugin.PLUGIN_NAME
+            plug_key = plugin.PLUGIN_SLUG if getattr(plugin, 'PLUGIN_SLUG', None) else plug_name
+            plugin_db_setting, _ = PluginConfig.objects.get_or_create(key=plug_key, name=plug_name)
+
+            if plugin_db_setting.active:
+                    # init package
+                    # now we can be sure that an admin has activated the plugin -> as of Nov 2021 there are not many checks in place
+                    # but we could enhance those to check signatures, run the plugin against a whitelist etc.
+                logger.info(f'Loading integration plugin {plugin.PLUGIN_NAME}')
+                plugin = plugin()
+                logger.info(f'Loaded integration plugin {plugin.slug}')
+                plugin.is_package = was_packaged
+                    # safe reference
+                settings.INTEGRATION_PLUGINS[plugin.slug] = plugin
+            else:
+                    # save for later reference
+                settings.INTEGRATION_PLUGINS_INACTIVE[plug_key] = plugin_db_setting
+
+    def collect_plugins(self):
+        """collect integration plugins from all possible ways of loading"""
         # Collect plugins from paths
         for plugin in settings.PLUGIN_DIRS:
             modules = inventree_plugins.get_plugins(importlib.import_module(plugin), IntegrationPluginBase, True)
@@ -42,75 +127,3 @@ class PluginConfig(AppConfig):
         # Log found plugins
         logger.info(f'Found {len(settings.PLUGINS)} plugins!')
         logger.info(", ".join([a.__module__ for a in settings.PLUGINS]))
-
-        try:
-            logger.info('Starting plugin initialisation')
-            # Initialize integration plugins
-            for plugin in inventree_plugins.load_integration_plugins():
-                # check if package
-                was_packaged = getattr(plugin, 'is_package', False)
-
-                # check if activated
-                # these checks only use attributes - never use plugin supplied functions -> that would lead to arbitrary code execution!!
-                plug_name = plugin.PLUGIN_NAME
-                plug_key = plugin.PLUGIN_SLUG if getattr(plugin, 'PLUGIN_SLUG', None) else plug_name
-                plugin_db_setting, _ = PluginConfig.objects.get_or_create(key=plug_key, name=plug_name)
-
-                if plugin_db_setting.active:
-                    # init package
-                    # now we can be sure that an admin has activated the plugin -> as of Nov 2021 there are not many checks in place
-                    # but we could enhance those to check signatures, run the plugin against a whitelist etc.
-                    logger.info(f'Loading integration plugin {plugin.PLUGIN_NAME}')
-                    plugin = plugin()
-                    logger.info(f'Loaded integration plugin {plugin.slug}')
-                    plugin.is_package = was_packaged
-                    # safe reference
-                    settings.INTEGRATION_PLUGINS[plugin.slug] = plugin
-                else:
-                    # save for later reference
-                    settings.INTEGRATION_PLUGINS_INACTIVE[plug_key] = plugin_db_setting
-
-            # activate integrations
-            plugins = settings.INTEGRATION_PLUGINS.items()
-            logger.info(f'Found {len(plugins)} active plugins')
-
-            # if plugin settings are enabled enhance the settings
-            if settings.TESTING or InvenTreeSetting.get_setting('ENABLE_PLUGINS_SETTING'):
-                logger.info('Registering IntegrationPlugin settings')
-                for slug, plugin in plugins:
-                    if plugin.mixin_enabled('settings'):
-                        plugin_setting = plugin.settingspatterns
-                        settings.INTEGRATION_PLUGIN_SETTING[slug] = plugin_setting
-
-                        # Add to settings dir
-                        InvenTreeSetting.GLOBAL_SETTINGS.update(plugin_setting)
-
-            # if plugin apps are enabled
-            if settings.TESTING or ((not settings.INTEGRATION_APPS_LOADED) and InvenTreeSetting.get_setting('ENABLE_PLUGINS_APP')):
-                logger.info('Registering IntegrationPlugin apps')
-                settings.INTEGRATION_APPS_LOADED = True  # ensure this section will not run again
-                apps_changed = False
-
-                # add them to the INSTALLED_APPS
-                for slug, plugin in plugins:
-                    if plugin.mixin_enabled('app'):
-                        try:
-                            # for local path plugins
-                            plugin_path = '.'.join(pathlib.Path(plugin.path).relative_to(settings.BASE_DIR).parts)
-                        except ValueError:
-                            # plugin is shipped as package
-                            plugin_path = plugin.PLUGIN_NAME
-                        if plugin_path not in settings.INSTALLED_APPS:
-                            settings.INSTALLED_APPS += [plugin_path]
-                            apps_changed = True
-
-                # if apps were changed reload
-                # TODO this is a bit jankey to be honest
-                if apps_changed:
-                    apps.app_configs = OrderedDict()
-                    apps.apps_ready = apps.models_ready = apps.loading = apps.ready = False
-                    apps.clear_cache()
-                    apps.populate(settings.INSTALLED_APPS)
-        except (OperationalError, ProgrammingError):
-            # Exception if the database has not been migrated yet
-            pass