Isolate provider init (#69)

Author: dispensable

frontend/src/components/HSider.vue

@@ -44,7 +44,8 @@ export default {
       openKeys: [],
       SelectedKeys: [],
       rootSubmenuKeys: [],
-      searchText: ''
+      searchText: '',
+      actionLoadNotifyKey: 'actionTreeLoadErrorNofify'
     }
   },
   computed: {
@@ -69,6 +70,7 @@ export default {
           for (let i = 0; i < definition.length; i++) {
             this.rootSubmenuKeys.push(definition[i].key)
           }
+          this.checkActionTreeError(definition)
           this.$store.dispatch('updateActionTree', definition)
           let actionName = this.$route.params.name
           // looking for selected item with actionName
@@ -84,6 +86,25 @@ export default {
         }
       )
     },
+    checkActionTreeError(definition) {
+      // check action 
+      var loadErrorAction = []  
+      for (let i = 0; i < definition.length; i++) {
+        if (definition[i].children && definition[i].children.length == 0) {
+          loadErrorAction.push(definition[i].name)
+        }
+      }
+
+      if (loadErrorAction.length > 0) {
+        this.$notification.open({
+          message: "Action tree load error",
+          description: loadErrorAction.join(",") + " pack load error",
+          duration: 0,
+          icon: <a-icon type="warning" style="color: red" />,
+          key: this.actionLoadNotifyKey
+        })
+      }
+    },
     onOpenChange (openKeys) {
       const latestOpenKey = openKeys.find(key => this.openKeys.indexOf(key) === -1)
       if (this.rootSubmenuKeys.indexOf(latestOpenKey) === -1) {

helpdesk/models/action_tree.py

@@ -6,6 +6,8 @@
 from helpdesk.models.action import Action
 from helpdesk.models.provider import get_provider
 from helpdesk.config import ACTION_TREE_CONFIG
+from helpdesk.models.provider.errors import ResolvePackageError, InitProviderError
+from helpdesk.libs.sentry import report
 
 logger = logging.getLogger(__name__)
 
@@ -42,17 +44,6 @@ def build_from_config(self, config):
         else:
             # leaf
             provider_object = config[-1]
-
-            # # dedup
-            # system_provider = get_provider(PROVIDER)
-            # default_pack = system_provider.get_default_pack() + '.'
-            # if not provider_object.endswith('.'):
-            #     if provider_object.startswith(default_pack):
-            #         provider_object = provider_object[len(default_pack):]
-            # if provider_object in objs:
-            #     return
-            # objs[provider_object] = True
-
             if provider_object.endswith('.'):
                 # pack
                 pack_sub_tree_config = self.resolve_pack(*config)
@@ -69,8 +60,18 @@ def resolve_pack(self, *config):
         pack = provider_object[:-1]
 
         sub_actions = []
-        system_provider = get_provider(provider_type)
-        actions = system_provider.get_actions(pack=pack)
+        actions = []
+
+        try:
+            system_provider = get_provider(provider_type)
+            actions = system_provider.get_actions(pack=pack)
+        except (InitProviderError, ResolvePackageError) as e:
+            logger.error(f"Resolve pack {name} error:\n{e.tb}")
+            # insert a empty children to failed action tree
+            # so we can tolerant provider partially failed
+            # and frontend can check children empty to notify user
+            report()
+
         for a in actions:
             obj = '.'.join([a.get('pack'), a.get('name')])
             desc = a.get('description')

helpdesk/models/provider/__init__.py

@@ -1,8 +1,9 @@
 # coding: utf-8
 
-from helpdesk.libs.decorators import timed_cache
-
+import traceback
 
+from helpdesk.libs.decorators import timed_cache
+from helpdesk.models.provider.errors import InitProviderError, ResolvePackageError
 from .st2 import ST2Provider
 from .airflow import AirflowProvider
 from .spincycle import SpinCycleProvider
@@ -16,4 +17,7 @@
 
 @timed_cache(minutes=15)
 def get_provider(provider, **kw):
-    return _providers[provider](**kw)
+    try:
+        return _providers[provider](**kw)
+    except Exception as e:
+        raise InitProviderError(error=e, tb=traceback.format_exc(), description=f"Init provider error: {str(e)}")

helpdesk/models/provider/airflow.py

@@ -11,6 +11,7 @@
     AIRFLOW_DEFAULT_DAG_TAG,
 )
 from helpdesk.libs.airflow import AirflowClient
+from helpdesk.models.provider.errors import ResolvePackageError
 
 from .base import BaseProvider
 
@@ -88,8 +89,13 @@ def get_actions(self, pack=None):
         <Action name=view_organizations,pack=trello,enabled=True,runner_type=python-script>
         to dict
         """
-        dags = self.airflow_client.get_dags(tags=(self.default_tag if not pack else pack,))
-        return self._build_action_from_dag(dags, pack=pack)
+        try:
+            dags = self.airflow_client.get_dags(tags=(self.default_tag if not pack else pack,))
+            return self._build_action_from_dag(dags, pack=pack)
+        except Exception as e:
+            if pack:
+                raise ResolvePackageError(e, traceback.format_exc(), f"Resolve pack {pack} error")
+            raise e
 
     def get_action(self, ref):
         """

helpdesk/models/provider/errors.py

@@ -0,0 +1,24 @@
+class ProviderError(Exception):
+    def __init__(self, error, tb="", description="provider error"):
+        self.description = description
+        self.error = error
+        self.tb = tb
+
+    def __str__(self):
+        return '[{message}] {description}'.format(**self.to_dict())
+
+    __repr__ = __str__
+
+    def to_dict(self):
+        return {
+            'description': self.description,
+            'message': str(self.error)
+        }
+
+
+class ResolvePackageError(ProviderError):
+    pass
+
+
+class InitProviderError(ProviderError):
+    pass

helpdesk/models/provider/st2.py

@@ -2,6 +2,7 @@
 
 import logging
 import requests
+import traceback
 
 from helpdesk.config import (
     ST2_DEFAULT_PACK,
@@ -14,6 +15,7 @@
 )
 from helpdesk.libs.sentry import report
 from helpdesk.libs.st2 import get_client, get_api_client, Execution, Token
+from helpdesk.models.provider.errors import ResolvePackageError
 
 from .base import BaseProvider
 
@@ -61,7 +63,10 @@ def get_actions(self, pack=None):
         to dict
         '''
         if pack:
-            actions = self.st2.actions.query(pack=pack)
+            try:
+                actions = self.st2.actions.query(pack=pack)
+            except Exception as e:
+                raise ResolvePackageError(e, traceback.format_exc(), f"Resolve pack {pack} error")
         else:
             actions = self.st2.actions.get_all()
         return [action.to_dict() for action in actions]