This creates a new table called process_caller_relationship to replace process_caller_cache. The purpose of this is so that we can create foreign keys to the process ids and turn this table into a many-to-many relationship table. This should help speed up query times since one of the columns we were querying on in process_caller_cache was unindexed and took 10 seconds to query when there were 2 million rows on dev.app.
Changes:
adds migration to create process_caller_relationship table
the process_caller_cache will be left in place for now in case we need to rollback - we should delete that table at some point
the process_caller_relationship now has foreign keys to reference_cache. this means items cannot be added to this table before the reference cache is created.
this seems better overall since items shouldn't be there if they do not reference anything valid but it does make mass upload of bpmn files more difficult since the order of operations matter.
Summary by CodeRabbit
New Features
Introduce exceptions CalledProcessNotFoundError and CallingProcessNotFoundError for improved error handling.
Added ProcessCallerRelationshipModel class to manage relationships between processes.
Refactor
Modified functionality in monitoring_service.py to focus on process models instead of tasks for better data handling.
Updated task submission and task data retrieval mechanisms in monitoring_service.py.
Documentation
Clarified code purpose by removing outdated docstrings and comments.
Walkthrough
## Walkthrough
The recent updates across the Spiffworkflow backend focus on enhancing error handling, improving code readability, and refining the management of process models and references. Changes include modifications to environment variable settings, error messages, and method functionalities. Additionally, adjustments were made in file handling in process model operations and updates to how relationships between processes are managed and queried.
## Changes
| File Path | Change Summary |
|-----------|----------------|
| `.../boot_server_in_docker`, `.../local_development_environment_setup` | Modified and added environment variable settings. |
| `.../save_all_bpmn.py`, `.../add_test_users_to_keycloak` | Improved error handling, removed docstrings, and refined script functionalities. |
| `.../load_database_models.py`, `.../models/...`, `.../reference_cache.py` | Added new classes, relationships, and improved import statements. |
| `.../routes/process_api_blueprint.py`, `.../services/process_caller_service.py`, `.../services/monitoring_service.py` | Updated imports, method functionalities, and added new methods for process model management. Modified task submission and retrieval functions to focus on process models. |
| `.../routes/process_models_controller.py`, `.../services/data_setup_service.py` | Changed file handling operations in process model functions, added new functionalities for handling references. |
Recent Review Details
**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**
Commits
Files that changed from the base of the PR and between a6f8437d1ea6a753baa503e1ac102f51efe5acf1 and 924d6b8387ceeda35412bf802fdb7c27bab6aa01.
Files ignored due to path filters (1)
* `spiffworkflow-backend/migrations/versions/d4b900e71852_.py` is excluded by `!spiffworkflow-backend/migrations/**`
Files selected for processing (2)
* spiffworkflow-backend/src/spiffworkflow_backend/models/process_caller_relationship.py (1 hunks)
* spiffworkflow-backend/src/spiffworkflow_backend/services/monitoring_service.py (1 hunks)
Files skipped from review as they are similar to previous changes (2)
* spiffworkflow-backend/src/spiffworkflow_backend/models/process_caller_relationship.py
* spiffworkflow-backend/src/spiffworkflow_backend/services/monitoring_service.py
---
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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips
### Chat
There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai):
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- `I pushed a fix in commit .`
- `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 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 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.`
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.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- 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/schema.v2.json`
### Documentation and Community
- Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Supports #1461
This creates a new table called
process_caller_relationship
to replaceprocess_caller_cache
. The purpose of this is so that we can create foreign keys to the process ids and turn this table into a many-to-many relationship table. This should help speed up query times since one of the columns we were querying on inprocess_caller_cache
was unindexed and took 10 seconds to query when there were 2 million rows on dev.app.Changes:
process_caller_relationship
tableprocess_caller_cache
will be left in place for now in case we need to rollback - we should delete that table at some pointprocess_caller_relationship
now has foreign keys toreference_cache
. this means items cannot be added to this table before the reference cache is created.Summary by CodeRabbit
New Features
CalledProcessNotFoundError
andCallingProcessNotFoundError
for improved error handling.ProcessCallerRelationshipModel
class to manage relationships between processes.Refactor
monitoring_service.py
to focus on process models instead of tasks for better data handling.monitoring_service.py
.Documentation