Merge pull request #3050 from kira0204/error-script

Handling user script's exceptions, fix #2839

mitmproxy/addons/script.py

@@ -25,6 +25,7 @@ def load_script(path: str) -> types.ModuleType:
     sys.modules.pop(fullname, None)
     oldpath = sys.path
     sys.path.insert(0, os.path.dirname(path))
+    m = None
     try:
         loader = importlib.machinery.SourceFileLoader(fullname, path)
         spec = importlib.util.spec_from_loader(fullname, loader=loader)
@@ -32,9 +33,11 @@ def load_script(path: str) -> types.ModuleType:
         loader.exec_module(m)
         if not getattr(m, "name", None):
             m.name = path  # type: ignore
-        return m
+    except Exception as e:
+        script_error_handler(path, e, msg=str(e))
     finally:
         sys.path[:] = oldpath
+        return m
 
 
 def script_error_handler(path, exc, msg="", tb=False):
@@ -48,11 +51,11 @@ def script_error_handler(path, exc, msg="", tb=False):
     lineno = ""
     if hasattr(exc, "lineno"):
         lineno = str(exc.lineno)
-    log_msg = "in Script {}:{} {}".format(path, lineno, exception)
+    log_msg = "in script {}:{} {}".format(path, lineno, exception)
     if tb:
         etype, value, tback = sys.exc_info()
         tback = addonmanager.cut_traceback(tback, "invoke_addon")
-        log_msg = log_msg.join(["\n"] + traceback.format_exception(etype, value, tback))
+        log_msg = log_msg + "\n" + "".join(traceback.format_exception(etype, value, tback))
     ctx.log.error(log_msg)
 
 

test/mitmproxy/addons/test_script.py

@@ -12,7 +12,9 @@ from mitmproxy.test import tflow
 from mitmproxy.test import tutils
 
 
-def test_load_script():
+@pytest.mark.asyncio
+async def test_load_script():
+    with taddons.context() as tctx:
         ns = script.load_script(
             tutils.test_data.path(
                 "mitmproxy/data/addonscripts/recorder/recorder.py"
@@ -20,10 +22,17 @@ def test_load_script():
         )
         assert ns.addons
 
-    with pytest.raises(FileNotFoundError):
         script.load_script(
             "nonexistent"
         )
+        assert await tctx.master.await_log("No such file or directory")
+
+        script.load_script(
+            tutils.test_data.path(
+                "mitmproxy/data/addonscripts/recorder/error.py"
+            )
+        )
+        assert await tctx.master.await_log("invalid syntax")
 
 
 def test_load_fullname():

test/mitmproxy/data/addonscripts/recorder/error.py

@@ -0,0 +1,7 @@
+"""
+This file is intended to have syntax errors for test purposes
+"""
+
+impotr recorder # Intended Syntax Error
+
+addons = [recorder.Recorder("e")]