Rename workspace to project #3407

stefannica · 2025-03-13T13:36:48Z

Describe changes

This PR is the final phase in implementing ZenML projects: the big rename from workspace to project and introducing "cute names for projects".

Renaming changes:

renames the workspace DB table to project
renames all workspace_id foreign key relationships to project_id in the DB
also renames unique DB constraints
implements a big DB migration script for all these changes
renames workspace to project everywhere else: the domain models, the Zen stores, the Client, the CLI and the REST API endpoints
keeps the workspace endpoints to preserve backwards-compatibility for the dashboard

"Cute names" for projects:

add "display name" to projects and populate it with the current "name" values
add additional validation rules for the "name" field to allow it to be used as a short ID (slug)

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-13T13:36:56Z

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 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.

schustmi · 2025-03-13T16:35:10Z

src/zenml/zen_stores/migrations/versions/cbc6acd71f92_add_workspace_display_name.py

+            workspace_table.c.id,
+            workspace_table.c.name,
+        )
+    ):


Should we also ensure that existing workspace names are lowercase and have no special characters?

This has a near-zero chance of happening. I already blocked the DB upgrade in the previous PR if there is more than one workspace present. And it's very improbable that someone would actually use a weird name for their default workspace, given that it wasn't possible to manage them with the CLI and dashboard before.

schustmi · 2025-03-13T16:41:49Z

src/zenml/zen_stores/migrations/versions/12eff0206201_rename_workspace_to_project.py

+        )
+        batch_op.drop_column("workspace_id")
+
+    with op.batch_alter_table("user", schema=None) as batch_op:


We drop this but don't seem to add a default_project_id as replacement?

You're right. I don't really need this anymore. It was meant as a temporary measure for a quicker PoC, but now we decided to go with a fully updated dashboard which supports creating/switching between workspaces, so I dropped it.

I thought we maybe wanted to even have that as an option for the user to configure in the dashboard, to essentially select which project will be active by default each time they access a workspace. But I guess when we get to that point we can always implement that

schustmi · 2025-03-13T16:43:06Z

src/zenml/models/v2/core/project.py

+        display_name = data.get("display_name")
+
+        if not name and not display_name:
+            return data


This will trigger a validation error which i guess is intended?

Yes 😄 , I just pass it to Pydantic here.

src/zenml/models/v2/core/project.py

stefannica added the breaking-change label Mar 13, 2025

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

stefannica added the run-slow-ci label Mar 13, 2025

stefannica force-pushed the feature/projects-final-phase branch from 327b723 to e15d612 Compare March 13, 2025 15:43

stefannica requested review from bcdurak and schustmi March 13, 2025 16:28

schustmi requested changes Mar 13, 2025

View reviewed changes

stefannica added 10 commits March 13, 2025 17:57

Add workspace display name

26bd53f

Renamed workspace to project in schemas, models and zen stores

6a61277

Rename workspace to project in Client

6013d0a

Rename workspace to project in CLI

d539cf4

Renamed workspace to project in everything but endpoints

d6157bb

Rename workspace to project in endpoints with backwards compatibility

39a4728

Fix DB migration

0b5ab3b

Renamed workspace to project in tests

e691fc6

Rename remaining relevant occurrences of workspace to project

e144a9d

Code review suggestions

e052bd9

stefannica force-pushed the feature/projects-final-phase branch from fb226ec to e052bd9 Compare March 13, 2025 16:57

schustmi approved these changes Mar 13, 2025

View reviewed changes

Fix remaining failing test cases

7bf0238

stefannica merged commit fba4b1a into develop Mar 13, 2025
69 of 70 checks passed

stefannica deleted the feature/projects-final-phase branch March 13, 2025 20:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Rename workspace to project #3407

Rename workspace to project #3407

Uh oh!

stefannica commented Mar 13, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 13, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

schustmi Mar 13, 2025

Uh oh!

stefannica Mar 13, 2025

Uh oh!

schustmi Mar 13, 2025

Uh oh!

stefannica Mar 13, 2025

Uh oh!

schustmi Mar 13, 2025

Uh oh!

schustmi Mar 13, 2025

Uh oh!

stefannica Mar 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rename workspace to project #3407

Rename workspace to project #3407

Uh oh!

Conversation

stefannica commented Mar 13, 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 13, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

schustmi Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefannica commented Mar 13, 2025 •

edited

Loading