Skip to content
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

vdk-jupyter: print summary output to temp dir #2715

Merged
merged 1 commit into from
Sep 29, 2023
+36 −34
Merged

vdk-jupyter: print summary output to temp dir #2715

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
70 changes: 36 additions & 34 deletions projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/vdk_jupyterlab_extension/vdk_ui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import tempfile
from pathlib import Path

from vdk.internal.builtin_plugins.run.summary_output import JobSummaryParser
from vdk.internal.control.command_groups.job.create import JobCreate
from vdk.internal.control.command_groups.job.delete import JobDelete
from vdk.internal.control.command_groups.job.deploy_cli_impl import JobDeploy
Expand Down Expand Up @@ -61,42 +62,43 @@ def run_job(path, arguments=None):
if len(script_files) == 0:
return {"message": f"No steps were found in {path}!"}
with open("vdk_run.log", "w+") as log_file:
path = shlex.quote(str(path))
cmd: list[str] = ["vdk", "run", f"{path}"]
if arguments:
arguments = shlex.quote(arguments)
cmd.append("--arguments")
cmd.append(f"{arguments}")
cmd = VdkUI.__prepare_vdk_run_command(arguments, path)
with tempfile.NamedTemporaryFile(
prefix="jupyter-run-summary-", mode="w+"
) as summary_output_file:
environ_copy = os.environ.copy()
environ_copy["JOB_RUN_SUMMARY_FILE_PATH"] = summary_output_file.name
# We add the PYTHONUNBUFFERED env variable to ensure print statements inside user jobs are correctly
# interspersed in between the rest of the job logs instead of being placed at the end
environ_copy["PYTHONUNBUFFERED"] = "x"

# We add the PYTHONUNBUFFERED env variable to ensure print statements inside user jobs are correctly
# interspersed in between the rest of the job logs instead of being placed at the end
env = os.environ.copy()
env["PYTHONUNBUFFERED"] = "x"
try:
process = subprocess.Popen(
cmd,
stdout=log_file,
stderr=log_file,
env=environ_copy,
shell=False,
)
process.wait()
if process.returncode != 0:
content = pathlib.Path(summary_output_file.name).read_text()
job_summary = JobSummaryParser.from_json(content)
return {"message": job_summary.details}
else:
return {"message": process.returncode}
except Exception as e:
return {"message": f"Unhandled exception: {e}"}

process = subprocess.Popen(
cmd,
stdout=log_file,
stderr=log_file,
env=env,
shell=False,
)
process.wait()
if process.returncode != 0:
job_name = (
os.path.basename(path[:-1])
if path.endswith("/")
else os.path.basename(path)
)
error_file = os.path.join(
os.path.dirname(path), f".{job_name}_error.json"
)
if os.path.exists(error_file):
with open(error_file) as file:
# the json is generated in vdk-notebook plugin
# you can see /vdk-notebook/src/vdk/notebook-plugin.py
error = json.load(file)
return {"message": error["details"]}
return {"message": process.returncode}
@staticmethod
def __prepare_vdk_run_command(arguments, path):
path = shlex.quote(str(path))
cmd: list[str] = ["vdk", "run", f"{path}"]
if arguments:
arguments = shlex.quote(arguments)
cmd.append("--arguments")
cmd.append(f"{arguments}")
return cmd

@staticmethod
def delete_job(name: str, team: str) -> str:
Expand Down