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.

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-notebook: set summary file path as configuration #2709

Merged
merged 1 commit into from
Sep 28, 2023

Conversation

antoniivanov
Copy link
Collaborator

Previously, the summary file path was hard-coded to the job directory, posing issues for certain deployments where writing to the job directory was restricted. This led to failures in some deployments.

The second problem. This design introduced a hidden and unsafe dependency between the vdk-notebook and vdk-jupyter plugins. The vdk-notebook plugin was responsible for writing the summary information, while vdk-jupyter read from the same hard-coded location, although both plugins operated independently.

This commit migrates the summary file path logic to a more appropriate location.The functionality to output summary of the job in a way that differnet consumers (plugins or tools) can read and understand is rather generic and core functionality regardless if vdk-notebook is installed or not.

After merging this would change vdk-jupyter to work with this and remove the obsolete code in vdk-noteboook

Copy link
Contributor

@DeltaMichael DeltaMichael left a comment

Choose a reason for hiding this comment

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

Looks ok, please fix the Codacy warnings.

@antoniivanov antoniivanov force-pushed the person/aivanov/notebook branch 3 times, most recently from 563b85d to 994b21f Compare September 28, 2023 15:10
Previously, the summary file path was hard-coded to the job directory,
posing issues for certain deployments where writing to the job directory
was restricted. This led to failures in some deployments.

The second problem. This design introduced a hidden and unsafe
dependency between the vdk-notebook and vdk-jupyter plugins. The
vdk-notebook plugin was responsible for writing the summary information,
while vdk-jupyter read from the same hard-coded location, although both
plugins operated independently.

This commit migrates the summary file path logic to a more appropriate
location.The functionality to output summary of the job in a way that
differnet consumers (plugins or tools) can read and understand is rather
generic and core functionality regardless if vdk-notebook is installed
or not.

After merging this would change vdk-jupyter to work with this and remove
the obsolete code in vdk-noteboook
@antoniivanov antoniivanov force-pushed the person/aivanov/notebook branch from 994b21f to 4021ac5 Compare September 28, 2023 15:26
@antoniivanov antoniivanov merged commit adfd7ac into main Sep 28, 2023
@antoniivanov antoniivanov deleted the person/aivanov/notebook branch September 28, 2023 15:55
antoniivanov added a commit that referenced this pull request Sep 29, 2023
This is no longer used superseded by vdk-core change in
#2709
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants