Add the ability to store a default project for a user #3457

schustmi · 2025-03-24T16:05:48Z

Describe changes

This PR adds a user setting for a default_project_id. This default project will be automatically activated when connecting to a server.

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-03-24T16:05:57Z

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.

stefannica

Looks good for the most part

src/zenml/zen_stores/schemas/user_schemas.py

stefannica · 2025-03-25T09:09:28Z

src/zenml/config/global_config.py

    version: Optional[str] = None
    store: Optional[SerializeAsAny[StoreConfiguration]] = None
    active_stack_id: Optional[uuid.UUID] = None
+    active_project_id: Optional[uuid.UUID] = None


I don't see this being used anywhere. Why do you need it ?

It is used below as an argument to validate_active_config. If we were to keep using the name, we would keep a project with the same name when connecting to a different server, and therefore ignore the default project configured for the user.

Would you then be okay with replacing active_project_name with active_project_id ? this is in fact how it's done on the client/repo (i.e. zenml init) configuration side of things.

Yep, I was wondering whether we should keep it in there for backwards compatibility somehow, but I'm happy to remove it entirely!

schustmi · 2025-03-25T11:10:34Z

src/zenml/zen_stores/base_zen_store.py

+                        f"to '{active_project.name}'."
+                    )
+
        if active_project is None:


@stefannica After talking with @htahir1, I reworked this a little:

If the user does not have a default project set, we try to list all projects

If there is a single project, we set that as active. This should also cover the OSS case where there should only be a single default project.

If there are no or multiple projects, we don't set any project active. I guess for the multiple ones, I could still check if there is a project called default and use that instead, to have an even better fallback for the OSS case?

github-actions · 2025-03-25T14:55:17Z

Documentation Link Check Results

✅ Absolute links check passed
✅ Relative links check passed
_{Last checked: 2025-03-25 15:35:24 UTC}

Add the ability to store a default project for a user

479f598

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

schustmi requested a review from stefannica March 24, 2025 16:37

stefannica requested changes Mar 25, 2025

View reviewed changes

schustmi added 4 commits March 25, 2025 11:11

Add DB migration

4b27009

Switch to active project ID

a33b50f

Move password change rate limiter outside if condition

d97f5f0

Rework project activation

c85ed69

schustmi commented Mar 25, 2025

View reviewed changes

schustmi added 3 commits March 25, 2025 13:04

Unify log messages

a425fc0

Merge branch 'develop' into feature/user-default-projects

9912d97

Docs

872d5d7

schustmi marked this pull request as ready for review March 25, 2025 12:13

schustmi requested a review from stefannica March 25, 2025 13:58

stefannica approved these changes Mar 25, 2025

View reviewed changes

Add missing filter model

e0f7673

Merge branch 'develop' into feature/user-default-projects

46101a8

schustmi added the run-slow-ci Tag that is used to trigger the slow-ci label Mar 25, 2025

Fix wrong security warning

5b2265c

schustmi merged commit e37b5af into develop Mar 26, 2025
72 checks passed

schustmi deleted the feature/user-default-projects branch March 26, 2025 06:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add the ability to store a default project for a user #3457

Add the ability to store a default project for a user #3457

Uh oh!

schustmi commented Mar 24, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

stefannica left a comment

Uh oh!

Uh oh!

stefannica Mar 25, 2025

Uh oh!

schustmi Mar 25, 2025

Uh oh!

stefannica Mar 25, 2025

Uh oh!

schustmi Mar 25, 2025

Uh oh!

schustmi Mar 25, 2025

Uh oh!

github-actions bot commented Mar 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add the ability to store a default project for a user #3457

Add the ability to store a default project for a user #3457

Uh oh!

Conversation

schustmi commented Mar 24, 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 Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

stefannica left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stefannica Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

schustmi commented Mar 24, 2025 •

edited

Loading

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

github-actions bot commented Mar 25, 2025 •

edited

Loading