Exceptions from navigation contributor always should be logged

[Jun Omae]

Exception's message from navigation contributor is not logged. I cannot investigate issues from the contributors caused by this behavior.

trac/web/chrome.py

@@ -810 +810 @@
             except Exception, e:
                 name = contributor.__class__.__name__
                 if isinstance(e, TracError):
-                    self.log.warning("Error with navigation contributor %s",
-                                     name)
+                    self.log.warning("Error with navigation contributor %s: "
+                                     "%s", name, exception_to_unicode(e))
                 else:
                     self.log.error("Error with navigation contributor %s: %s",
-                                   name, exception_to_unicode(e))
+                                   name,
+                                   exception_to_unicode(e, traceback=True))
                 add_warning(req, _("Error with navigation contributor "
                                    '"%(name)s"', name=name))
 

For now, patch like this is applied to all contributors in my environment to catch the same issue:

diff --git a/foobar/foobar/web_ui.py b/foobar/foobar/web_ui.py
index ade158b8..44b94eb9 100644
--- a/foobar/foobar/web_ui.py
+++ b/foobar/foobar/web_ui.py
@@ -1022,6 +1022,14 @@
         return None

     def get_navigation_items(self, req):
+        try:
+            return self._get_navigation_items(req)
+        except:
+            self.log.error('Exception caught in %s', self.__class__.__name__,
+                           exc_info=True)
+            return []
+
+    def _get_navigation_items(self, req):
         ...

[Ryan J Ollos]

Sounds good. Looks like a duplicate of #12428.

[Ryan J Ollos]

#12428 closed as a duplicate.

[Jun Omae]

Thanks. I'm going to push it to 1.0-stable.

[Jun Omae]

Committed in [15791] and merged in [15792-15793].

After the changes, the following would be logged.

2017-04-17 15:26:08,669 Trac[chrome] WARNING: Error with navigation contributor AboutModule: TracError: xxx

2017-04-17 15:26:36,242 Trac[chrome] ERROR: Error with navigation contributor AboutModule:
Traceback (most recent call last):
  File "/src/tracdev/svn/branches/1.0-stable/trac/web/chrome.py", line 786, in prepare_request
    contributor.get_navigation_items(req) or []:
  File "/src/tracdev/svn/branches/1.0-stable/trac/about.py", line 47, in get_navigation_items
    raise ValueError('xxx')
ValueError: xxx