implements #7362

Author: pcrespov

packages/common-library/src/common_library/error_codes.py

@@ -1,4 +1,4 @@
-""" osparc ERROR CODES (OEC)
+"""osparc ERROR CODES (OEC)
   Unique identifier of an exception instance
   Intended to report a user about unexpected errors.
     Unexpected exceptions can be traced by matching the
@@ -7,13 +7,15 @@
 SEE test_error_codes for some use cases
 """
 
+import hashlib
 import re
+import traceback
 from typing import TYPE_CHECKING, Annotated
 
 from pydantic import StringConstraints, TypeAdapter
 
 _LABEL = "OEC:{}"
-_PATTERN = r"OEC:\d+"
+_PATTERN = r"OEC:[a-zA-Z0-9]+"
 
 if TYPE_CHECKING:
     ErrorCodeStr = str
@@ -22,9 +24,24 @@
         str, StringConstraints(strip_whitespace=True, pattern=_PATTERN)
     ]
 
+_LEN = 12  # chars (~48 bits)
+
+
+def _generate_error_fingerprint(exc: BaseException) -> str:
+    """
+    Unique error fingerprint for deduplication purposes
+    """
+    tb = traceback.extract_tb(exc.__traceback__)
+    frame_sigs = [f"{frame.name}:{frame.lineno}" for frame in tb]
+    fingerprint = f"{type(exc).__name__}|" + "|".join(frame_sigs)
+    # E.g. ZeroDivisionError|foo:23|main:10
+    return hashlib.sha256(fingerprint.encode()).hexdigest()[:_LEN]
+
 
 def create_error_code(exception: BaseException) -> ErrorCodeStr:
-    return TypeAdapter(ErrorCodeStr).validate_python(_LABEL.format(id(exception)))
+    return TypeAdapter(ErrorCodeStr).validate_python(
+        _LABEL.format(_generate_error_fingerprint(exception))
+    )
 
 
 def parse_error_code(obj) -> set[ErrorCodeStr]:

packages/common-library/tests/test_error_codes.py

@@ -11,10 +11,43 @@
 logger = logging.getLogger(__name__)
 
 
-def test_error_code_use_case(caplog: pytest.LogCaptureFixture):
-    """use case for error-codes"""
+def _level_three(v):
+    msg = f"An error occurred in level three with {v}"
+    raise RuntimeError(msg)
+
+
+def _level_two(v):
+    _level_three(v)
+
+
+def _level_one(v=None):
+    _level_two(v)
+
+
+def test_exception_fingerprint_consistency():
+    error_codes = []
+
+    for v in range(2):
+        # emulates different runs of the same function (e.g. different sessions)
+        try:
+            _level_one(v)  # same even if different value!
+        except Exception as err:
+            error_code = create_error_code(err)
+            error_codes.append(error_code)
+
+    assert error_codes == [error_codes[0]] * len(error_codes)
+
+    try:
+        # Same function but different location
+        _level_one(0)
+    except Exception as e2:
+        error_code_2 = create_error_code(e2)
+        assert error_code_2 != error_code[0]
+
+
+def test_create_log_and_parse_error_code(caplog: pytest.LogCaptureFixture):
     with pytest.raises(RuntimeError) as exc_info:
-        raise RuntimeError("Something unexpected went wrong")
+        _level_one()
 
     # 1. Unexpected ERROR
     err = exc_info.value