Add endpoint to download artifact data #3507

schustmi · 2025-04-08T13:38:21Z

Describe changes

This PR adds an endpoint to download artifact data.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2025-04-08T13:39:02Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

src/zenml/zen_server/routers/artifact_version_endpoints.py

src/zenml/artifacts/utils.py

schustmi · 2025-04-11T09:40:49Z

@htahir1 @stefannica Should we limit this to artifacts of a certain size? This will download all the artifact data on the server pod, which will cause issues for larger artifacts.

htahir1 · 2025-04-11T10:28:08Z

@schustmi Great idea! Lets make that even a configurable env variable for the server. WDYT? And have the default be 2 GB even? I think up to that should be fine

…point

htahir1

love this with the jwt stuff too! im not sure if it needs a docs page though? with ENV_ZENML_SERVER_FILE_DOWNLOAD_SIZE_LIMIT documented?

src/zenml/artifacts/utils.py

stefannica · 2025-04-14T14:10:56Z

src/zenml/artifacts/utils.py

+    max_download_size = handle_int_env_var(
+        ENV_ZENML_SERVER_FILE_DOWNLOAD_SIZE_LIMIT,
+        DEFAULT_ZENML_SERVER_FILE_DOWNLOAD_SIZE_LIMIT,
+    )


You should use a ServerConfiguration setting for this.

…ure download limit

github-actions · 2025-04-14T14:27:19Z

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/artifact-data-download)

zenml stack list: Command failed on run 1 (exit code: 1)
zenml pipeline list: Command failed on run 1 (exit code: 1)
zenml model list: Command failed on run 1 (exit code: 1)

🚨 New Failures Introduced

The following commands fail on your branch but worked on the target branch:

zenml stack list
zenml pipeline list
zenml model list

Performance Comparison

Command	develop Time (s)	feature/artifact-data-download Time (s)	Difference	Status
`zenml --help`	1.940373 ± 0.052469	1.986569 ± 0.020469	+0.046s	✓ No significant change
`zenml model list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml pipeline list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml stack --help`	1.916566 ± 0.027459	1.925865 ± 0.040125	+0.009s	✓ No significant change
`zenml stack list`	Not tested	Failed	N/A	❌ Broken in current branch

Summary

Total commands analyzed: 5
Commands compared for timing: 2
Commands improved: 0 (0.0% of compared)
Commands degraded: 0 (0.0% of compared)
Commands unchanged: 2 (100.0% of compared)
Failed commands: 3 (NEW FAILURES INTRODUCED)
Timed out commands: 0
Slow commands: 0

Environment Info

Target branch: Linux 6.8.0-1021-azure
Current branch: Linux 6.8.0-1021-azure
Test timestamp: 2025-04-14T14:26:35Z
Timeout: 60 seconds
Slow threshold: 5 seconds

schustmi added 2 commits April 8, 2025 14:37

Add endpoint to download artifact data

0d734c9

Cleanup imports

9a7784e

schustmi requested review from stefannica and bcdurak April 8, 2025 13:40

Handle single-file artifacts

b9a45ea

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Apr 8, 2025

htahir1 reviewed Apr 8, 2025

View reviewed changes

src/zenml/zen_server/routers/artifact_version_endpoints.py Show resolved Hide resolved

src/zenml/artifacts/utils.py Outdated Show resolved Hide resolved

htahir1 approved these changes Apr 10, 2025

View reviewed changes

schustmi added 2 commits April 11, 2025 11:32

Merge branch 'develop' into feature/artifact-data-download

5309dd3

Add temp file cleanup

c097ab0

schustmi added 8 commits April 11, 2025 15:05

Rework download

cfeef1a

Rework download again

7cec377

Linting

212bed3

Use two separate endpoints to allow download without csrf token

eb1c9c8

Scope to artifact and move to util functions

110e648

Rename url param

f2cde4d

Add checks to verify whether artifact is downloadable to download end…

c973f26

…point

Add comment for explanation

fd5939f

schustmi requested a review from htahir1 April 14, 2025 10:39

htahir1 approved these changes Apr 14, 2025

View reviewed changes

stefannica requested changes Apr 14, 2025

View reviewed changes

schustmi added 2 commits April 14, 2025 16:13

Move util functions to server util file, user server config to config…

648981b

…ure download limit

Improve error message

11e8ad2

schustmi requested a review from stefannica April 14, 2025 14:14

schustmi removed the request for review from bcdurak April 14, 2025 14:34

schustmi added the run-slow-ci label Apr 14, 2025

stefannica approved these changes Apr 14, 2025

View reviewed changes

schustmi merged commit 1dfe079 into develop Apr 14, 2025
81 of 84 checks passed

schustmi deleted the feature/artifact-data-download branch April 14, 2025 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add endpoint to download artifact data #3507

Add endpoint to download artifact data #3507

Uh oh!

schustmi commented Apr 8, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 8, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

schustmi commented Apr 11, 2025

Uh oh!

htahir1 commented Apr 11, 2025

Uh oh!

htahir1 left a comment

Uh oh!

Uh oh!

stefannica Apr 14, 2025

Uh oh!

schustmi Apr 14, 2025

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

Add endpoint to download artifact data #3507

Add endpoint to download artifact data #3507

Uh oh!

Conversation

schustmi commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented Apr 8, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

schustmi commented Apr 11, 2025

Uh oh!

htahir1 commented Apr 11, 2025

Uh oh!

htahir1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stefannica Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 14, 2025

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/artifact-data-download)

🚨 New Failures Introduced

Performance Comparison

Summary

Environment Info

Uh oh!

Uh oh!

Uh oh!

schustmi commented Apr 8, 2025 •

edited

Loading