Reset active project after deleting local database

[schustmi]

Describe changes

This fixes the following case:

• Use ZenML with a local SQLite DB
• Delete the DB
• Run a pipeline without running any other previous command

The ID of the previously active project will still be stored in the global config, but won't exist anymore in the newly created database. This lead to an error that the project can not be found.

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]

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[stefannica]

This looks harmless, but my spider senses tell me it is dangerous because it disturbs the very delicate choreography of instantiation for Client, GlobalConfig and *ZenStore.

Whatever the error is, is it not fixable from the logic that validates the configuration (see _sanitize_config) ?

[schustmi]

@stefannica I couldn't find a different solution, but you're welcome to try 😄

I think this is harmless though, if you look at the code:

• self.get_active_project_id(): This is either in the config file, which means it will return straight away. If it isn't, it initializes the ZenStore anyway which means my solution would not mess anything up.
• self._active_project can never be set without an initialized ZenStore, because where would the model be coming from.
• The next line already initializes self.zen_store anyway. This will also sanitize the config, which means after this line returns, the active project ID will be changed to the correct one. But the one passed to self.zen_store.get_project(...) is wrong.

I could of course change it to

if self._active_project is not None:
  return self._active_project

_ = self.zen_store  # This would happen in the next line anyway
project = self.zen_store.get_project(
  project_name_or_id=self.get_active_project_id(),
)
return self.set_active_project(project)

if this feels safer to you. The only thing that would do though IMO would be an extra call of GET project, because in my solution self._active_project is already set correctly.

[stefannica]

I still am not convinced this is necessary, but I probably don't know how to reproduce it properly:

[schustmi]

@stefannica You can use this to reproduce:

from zenml import pipeline, step
from zenml.materializers.built_in_materializer import BuiltInMaterializer

class CustomMaterializer(BuiltInMaterializer):
    ASSOCIATED_TYPES = (int,)


@step(output_materializers=CustomMaterializer)
def my_step() -> int:
    return 1

@pipeline(enable_cache=True)
def my_pipeline():
    my_step()

if __name__ == "__main__":
    my_pipeline()