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

make sure ProcessGroup init params are in include list #1467

Closed burnettk closed 2 weeks ago

burnettk commented 2 weeks ago

avoids runtime errors when process_group.json files have unexpected keys.

mitigates https://github.com/sartography/gsa-process-models/issues/1

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
Walkthrough ## Walkthrough The recent updates focus on enhancing data handling and validation within the SpiffWorkflow backend. A new class method in the `ProcessGroup` ensures only valid properties are retrievable, while a utility function in `process_model_service` filters dictionary entries against allowed keys. Additionally, a test JSON file has been modified to include an invalid field, likely for testing the robustness of the new filtering method. ## Changes | File Path | Change Summary | |----------------------------------------------------|----------------| | .../models/process_group.py | Added `get_valid_properties` class method to list valid properties for `ProcessGroup`. | | .../services/process_model_service.py | Introduced `restrict_dict` method to filter dictionary entries based on allowed keys. | | .../tests/.../expected-to-fail/process_group.json | Added a `garbage` field set to `true` to test new data handling capabilities. |
Recent Review Details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 0d7a114c982ace9329650643c7845de3402d22b6 and b800e7d03fa727cb0aea6ceae583f4e2ed794c5c.
Files selected for processing (3) * spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py (1 hunks) * spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py (3 hunks) * spiffworkflow-backend/tests/data/bpmn_unit_test_process_models/expected-to-fail/process_group.json (1 hunks)
Additional comments not posted (3)
spiffworkflow-backend/tests/data/bpmn_unit_test_process_models/expected-to-fail/process_group.json (1)
`3-3`: The addition of the `garbage` field is appropriate for testing the new validation mechanisms.
spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py (1)
`59-62`: The implementation of `get_valid_properties` method is efficient and maintainable, leveraging dataclass fields to dynamically list valid properties.
spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py (1)
`563-566`: The implementation of `restrict_dict` method correctly utilizes `get_valid_properties` to filter dictionary keys, enhancing data integrity.
--- 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.