Upgrading SQLModel to the latest version

[bcdurak]

Describe changes

I upgraded the version of the SQLModel package that we are using from 0.0.8 to 0.0.16.

The most critical factor in this upgrade stems from this PR right here. With this change, they have changed the way that they handle Enum values.

For instance, if you are familiar with our component schema (which we defined through SQLModel), we added a field called type which was a StackComponentType:

# the schema of the stack component
class StackComponentSchema(...):
    ...
    type: StackComponentType
    ...
    
# and the stack component type looked like this:
class StackComponentType(StrEnum):
    ...
    ARTIFACT_STORE = "artifact_store"
    ...

With this setup, when we registered, for instance, a new artifact store, we created an entry in the components table of our DB where the column type had the string artifact_store stored in it as a value. However, with the new changes, SQLModel now gives higher priority to Enum fields and saves the value ARTIFACT_STORE instead. While this is alright if you are starting from scratch, if you have any entry in a table with an Enum field zenml will fail after the upgrade. Instead of taking the migration route, we decided to adjust our schemas to use str fields instead and updated the corresponding to_model, update and from_request methods.

@avishniakov every enum field is using a similar approach to the one that you took with the TagSchemas and their color field.

Additionally, I have removed fastapi_utils as a dependency as it was completely unused and tweaked the code a bit to work with the new SQLModel version.

Pre-requisites

Please ensure you have done the following:

• [X] I have read the CONTRIBUTING.md document.
• [X] If my change requires a change to docs, I have updated the documentation accordingly.
• [ ] I have added tests to cover my changes.
• [X] 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.
• [X] If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

• [ ] Bug fix (non-breaking change which fixes an issue)
• [X] 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[bot]]

[!IMPORTANT]

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

Walkthrough

The updates revolve around dependency version upgrades, the removal of fastapi_utils, and schema modifications across various files. These changes include transitioning from specific enums to string types for attributes in schemas and adjusting methods to accommodate these type changes. Additionally, there are improvements in SQL handling and the removal of unnecessary enum types, streamlining the codebase and reducing dependencies.

Changes

File(s)	Summary
pyproject.toml	Updated sqlalchemy_utils and sqlmodel versions; removed fastapi_utils.
src/zenml/.../local/local_provider.py	Removed fastapi_utils import in check_local_server_dependencies.
src/zenml/.../schemas/artifact_schemas.py src/zenml/.../schemas/artifact_visualization_schemas.py src/zenml/.../schemas/component_schemas.py src/zenml/.../schemas/device_schemas.py src/zenml/.../schemas/flavor_schemas.py src/zenml/.../schemas/pipeline_run_schemas.py src/zenml/.../schemas/run_metadata_schemas.py src/zenml/.../schemas/secret_schemas.py src/zenml/.../schemas/step_run_schemas.py	Changed attribute types from enums to str and adjusted methods for handling these types.
src/zenml/.../schemas/tag_schemas.py	Added conditional check in update method for "color" field.
src/zenml/.../sql_zen_store.py	Simplified SQL handling in filter_and_paginate and migrate_database functions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[strickvl]

@coderabbitai review

[github-actions[bot]]

Quickstart template updates in examples/quickstart have been pushed.

[github-actions[bot]]

NLP template updates in examples/e2e_nlp have been pushed.

[david101-hunter]

Hi, after I upgrade sqlmodel version, I encounter issue zenml 0.56.3 requires sqlmodel==0.0.8, but you have sqlmodel 0.0.16 which is incompatible.

I want to intergate feast (0.36.0), however:

zenml 0.56.3 requires pydantic<1.11,>=1.9.0 feast 0.36.0 requires pydantic>=2.0.0, but you have pydantic 1.10.15 which is incompatible

How I can fix that.