Skip to content

vdk-core: Fix error in user code classified as Platform Error #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
doks5 merged 2 commits into from
Nov 29, 2021
Merged

vdk-core: Fix error in user code classified as Platform Error #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
515763b
vdk-core: Fix error in user code classified as Platform Error
doks5 Nov 29, 2021
b10a5ee
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions projects/vdk-core/src/vdk/internal/builtin_plugins/run/data_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from vdk.internal.builtin_plugins.run.file_based_step import TYPE_PYTHON
from vdk.internal.builtin_plugins.run.file_based_step import TYPE_SQL
from vdk.internal.builtin_plugins.run.job_context import JobContext
from vdk.internal.builtin_plugins.run.job_input_error_classifier import whom_to_blame
from vdk.internal.builtin_plugins.run.run_status import ExecutionStatus
from vdk.internal.builtin_plugins.run.step import Step
from vdk.internal.core import errors
Expand Down Expand Up @@ -75,10 +76,10 @@ def run_step(context: JobContext, step: Step) -> StepResult:
if step_executed
else ExecutionStatus.NOT_RUNNABLE
)
except BaseException as e:
except Exception as e:
status = ExecutionStatus.ERROR
details = errors.MSG_WHY_FROM_EXCEPTION(e)
blamee = errors.find_whom_to_blame_from_exception(e)
blamee = whom_to_blame(e, __file__)
exception = e
errors.log_exception(
blamee,
Expand Down
8 changes: 5 additions & 3 deletions projects/vdk-core/src/vdk/internal/builtin_plugins/run/job_input_error_classifier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def whom_to_blame(exception, executor_module):


def _is_exception_from_vdk_code(exception, executor_module):
exception_in_vdk = False
executor_module = os.path.abspath(executor_module)
vdk_code_directory = os.path.dirname(executor_module)
call_list = traceback.format_tb(exception.__traceback__)
Expand All @@ -42,12 +43,13 @@ def _is_exception_from_vdk_code(exception, executor_module):
for call in call_list:
caller_module = call.split('"')[1] # Extract module path from stacktrace call.
if vdk_code_directory in caller_module and caller_module != executor_module:
return True
exception_in_vdk = True
elif (
caller_module == executor_module
): # User code starts from this module always.
break
return False
return False

return exception_in_vdk


def is_user_error(received_exception: Exception) -> bool:
Expand Down
23 changes: 13 additions & 10 deletions projects/vdk-core/tests/vdk/internal/builtin_plugins/run/job_input_error_classifier_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ class ErrorClassifierTest(unittest.TestCase):
),
]

GENERIC_USER_ERROR_STACKTRACE = [
f""""{EXECUTOR_MODULE}", line 71, in run_step
step_executed = step.runner_func(step, context.job_input)""",
f"""File "{EXECUTOR_MODULE_DIR}/file_based_step.py", line 83, in run_python_step
StepFuncFactory.invoke_run_function(func, job_input)""",
f"""File "{EXECUTOR_MODULE_DIR}/file_based_step.py", line 117, in invoke_run_function
func(**actual_arguments)""",
"""File "/example_project/my-second-job/20_python_step.py", line 24, in run
raise Exception("Some test exception from user code") Exception: Some test exception from user code""",
]

PLATFORM_ERROR_STACKTRACE = [
"""File "{exec_module}", line 133, in _run_step
step_executed = runner_func(file_path)""".format(
Expand Down Expand Up @@ -87,18 +98,10 @@ def test_unknown_generic_error(self, mock_is_user_error, mock_traceback_format_t
errors.ResolvableBy.USER_ERROR,
)

# Generic error thrown by job_input that is not specifically recognised by VDK should be VAC error.
@patch(f"{traceback.format_tb.__module__}.{traceback.format_tb.__name__}")
@patch(f"{is_user_error.__module__}.{is_user_error.__name__}")
def test_job_input_generic_error(
self, mock_is_user_error, mock_traceback_format_tb
):
exception = Exception("!")
mock_is_user_error.return_value = False
mock_traceback_format_tb.return_value = self.PLATFORM_ERROR_STACKTRACE

@antoniivanov antoniivanov Nov 29, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why delete this? Where is the test covering PLATFORM_ERROR_STACKTRACE ? It correctly test that "PLATFORM_ERROR_STACKTRACE" is a platform error.

mock_traceback_format_tb.return_value = self.GENERIC_USER_ERROR_STACKTRACE
self.assertEqual(
whom_to_blame(exception, self.EXECUTOR_MODULE),
errors.ResolvableBy.PLATFORM_ERROR,
errors.ResolvableBy.USER_ERROR,
)


Expand Down