search

sartography / spiff-arena

SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams
https://www.spiffworkflow.org/
GNU Lesser General Public License v2.1
44 stars 34 forks source link

Fix process data get subprocess #1493

Closed jasquat closed 2 weeks ago

jasquat commented 2 weeks ago

Fixes #1485:

This updates the process-data api call to use the database directly to get data objects instead of using the processor. This also simplifies the api since it no longer needs the bpmn identifier since the guid is even better. It also adds a test to ensure this is working now.

coderabbitai[bot] commented 2 weeks ago
Walkthrough ## Walkthrough The recent updates involve deprecating the use of `process_identifier` in favor of `bpmn_process_guid` in the API documentation, enhancing model imports and data handling in the backend routes, and expanding integration tests to cover new functionalities. These changes streamline process management and testing within the SpiffWorkflow backend framework. ## Changes | Files | Change Summary | |-------|----------------| | `.../api.yml` | Deprecated `process_identifier` in favor of `bpmn_process_guid`. | | `.../routes/process_api_blueprint.py` | Enhanced data handling by importing `BpmnProcessModel` and `JsonDataModel`. Updated logic to handle `bpmn_process_data`. | | `.../integration/test_process_api.py` | Expanded testing with new imports and test methods focusing on subprocess data handling and assertions. |
Recent Review Details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 52bbd10f9cc6609889b815abcc115b9ade3aa881 and d4b4b011855a5e0da2a8499b3f3dc78ff1cc16e2.
Files selected for processing (3) * spiffworkflow-backend/src/spiffworkflow_backend/api.yml (1 hunks) * spiffworkflow-backend/src/spiffworkflow_backend/routes/process_api_blueprint.py (3 hunks) * spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_process_api.py (2 hunks)
Files skipped from review due to trivial changes (1) * spiffworkflow-backend/src/spiffworkflow_backend/api.yml
Additional comments not posted (6)
spiffworkflow-backend/src/spiffworkflow_backend/routes/process_api_blueprint.py (3)
`32-32`: Ensure that the newly imported `BpmnProcessModel` is utilized appropriately in the file. --- `36-36`: Ensure that the newly imported `JsonDataModel` is utilized appropriately in the file. --- `139-167`: Review the updated logic for fetching BPMN process data. Ensure that the error handling and data retrieval are correctly implemented and that the new parameters (`bpmn_process_guid` and `process_identifier`) are used effectively.
spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_process_api.py (3)
`16-16`: New import of `BpmnProcessModel` added. --- `17-17`: New import of `BpmnProcessDefinitionModel` added. --- `3329-3377`: New test method `test_process_data_show_with_sub_process` added to verify subprocess data retrieval.
--- 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.