Merge pull request #129 from GabrielSalla/improve-syntax-error-validation-message

Improve monitor validation message for syntax error

Author: GabrielSalla

src/components/http_server/monitor_routes.py

@@ -191,7 +191,12 @@ async def monitor_validate(request: Request) -> Response:
         }
         return web.json_response(error_response, status=400)
     except SyntaxError as e:
-        error_response = {"status": "error", "error": f"'{e.args[1][3]}' {e.msg}"}
+        syntax_error_line = e.lineno
+        syntax_error_code = e.args[1][3].strip()
+        error_response = {
+            "status": "error",
+            "error": f"Syntax error at line {syntax_error_line}: {syntax_error_code}",
+        }
         return web.json_response(error_response, status=400)
     except Exception as e:
         error_response = {"status": "error", "error": str(e)}

tests/components/http_server/test_monitor_routes.py

@@ -380,19 +380,26 @@ async def test_monitor_validate_check_fail():
             }
 
 
-async def test_monitor_validate_syntax_error(mocker):
-    """The 'monitor validate' route should return an error if the provided module code has any
-    errors"""
+@pytest.mark.parametrize(
+    "monitor_code, expected_error",
+    [
+        ("print('a\n", "Syntax error at line 1: print('a"),
+        ("print('a')\n  def f(): ...", "Syntax error at line 2: def f(): ..."),
+    ],
+)
+async def test_monitor_validate_syntax_error(mocker, monitor_code, expected_error):
+    """The 'monitor validate' route should return an error if the provided module code has a syntax
+    error"""
     request_payload = {
-        "monitor_code": "print('a",
+        "monitor_code": monitor_code,
     }
 
     url = BASE_URL + "/validate"
     async with aiohttp.ClientSession() as session:
         async with session.post(url, json=request_payload) as response:
             assert await response.json() == {
                 "status": "error",
-                "error": "'print('a' unterminated string literal (detected at line 1)",
+                "error": expected_error,
             }