Merge pull request #1566 from Sefaria/fix-pytest-error-log

fix(pytest): fix broken pytest after changing index error to log

helm-chart/sefaria-project/templates/configmap/local-settings-file.yaml

@@ -15,6 +15,7 @@ data:
         structlog = None
     import sefaria.system.logging as sefaria_logging
     import os
+    import sys
     import re
     import json
 
@@ -328,3 +329,10 @@ data:
         wrapper_class=structlog.stdlib.BoundLogger,
         cache_logger_on_first_use=True,
     )
+
+
+    # Fail gracefully when decorator conditional_graceful_exception on function. This should be set to True on production
+    # Example: If a text or ref cannot be properly loaded, fail gracefully and let the server continue to run
+    FAIL_GRACEFULLY = True
+    if "pytest" in sys.modules:
+        FAIL_GRACEFULLY = False

sefaria/local_settings_example.py

@@ -1,6 +1,7 @@
 # An example of settings needed in a local_settings.py file.
 # copy this file to sefaria/local_settings.py and provide local info to run.
 from datetime import timedelta
+import sys
 import structlog
 import sefaria.system.logging as sefaria_logging
 import os
@@ -308,4 +309,10 @@
 )
 
 SENTRY_DSN = None
-CLIENT_SENTRY_DSN = None
+CLIENT_SENTRY_DSN = None
+
+# Fail gracefully when decorator conditional_graceful_exception on function. This should be set to True on production
+# Example: If a text or ref cannot be properly loaded, fail gracefully and let the server continue to run
+FAIL_GRACEFULLY = False
+if "pytest" in sys.modules:
+    FAIL_GRACEFULLY = False

sefaria/model/schema.py

@@ -5,6 +5,10 @@
 
 import structlog
 from functools import reduce
+
+from sefaria.system.decorators import conditional_graceful_exception
+
+
 logger = structlog.get_logger(__name__)
 
 try:
@@ -210,6 +214,7 @@ def _load_title_group(self):
 
         self._process_terms()
 
+    @conditional_graceful_exception()
     def _process_terms(self):
         # To be called after raw data load
         from sefaria.model import library
@@ -219,7 +224,7 @@ def _process_terms(self):
             try:
                 self.title_group = term.title_group
             except AttributeError:
-                logger.error(f"Term {self.sharedTitle} has no title_group")
+                raise IndexError("Failed to load term named {}.".format(self.sharedTitle))
 
     def add_shared_term(self, term):
         self.sharedTitle = term

sefaria/system/decorators.py

@@ -1,4 +1,5 @@
 from functools import wraps, partial
+from typing import Any
 
 from django.http import HttpResponse, Http404
 from django.template import RequestContext
@@ -13,6 +14,8 @@
 import structlog
 logger = structlog.get_logger(__name__)
 
+from sefaria.settings import FAIL_GRACEFULLY
+
 
 # TODO: we really need to fix the way we are using json responses. Django 1.7 introduced a baked in JsonResponse.
 def json_response_decorator(func):
@@ -95,6 +98,33 @@ def wrapper(request, *args, **kwargs):
     return wrapper
 
 
+def conditional_graceful_exception(logLevel: str = "exception", exception_type: Exception = Exception) -> Any:
+    """
+    Decorator that catches exceptions and logs them if FAIL_GRACEFULLY is True.
+    For instance, when loading the server on prod, we want to fail gracefully if a text or ref cannot be properly loaded.
+    However, when running text creation functions, we want to fail loudly so that we can fix the problem.
+
+    :param logLevel: "exception" or "warning"
+    :param return_value: function return value if exception is caught
+    :param exception_type: type of exception to catch
+    :return: return_value no error, if FAIL_GRACEFULLY is True log the error, otherwise raise exception
+
+    """
+    def argumented_decorator(func):
+        @wraps(func)
+        def decorated_function(*args, **kwargs):
+            try:
+                return func(*args, **kwargs)
+            except exception_type as e:
+                if FAIL_GRACEFULLY:
+                    if logger:
+                        logger.exception(str(e)) if logLevel == "exception" else logger.warning(str(e))
+                else:
+                    raise e
+        return decorated_function
+    return argumented_decorator
+
+
 class memoized(object):
     """Decorator. Caches a function's return value each time it is called.
     If called later with the same arguments, the cached value is returned