dimagi / open-chat-studio

A web based platform for building Chatbots backed by Large Language Models
BSD 3-Clause "New" or "Revised" License
16 stars 7 forks source link

Node input validation #821

Closed SmittieC closed 1 week ago

SmittieC commented 2 weeks ago

Description

  1. Added help text to some fields. These are pulled from the field descriptions.
  2. Input validation for nodes. Validation happens on the BE and is propegated to the UI on save or load

User Impact

Users will see when their input is wrong, but will not be prevented from saving the pipeline.

Demo

demo

Docs

N/A

codecov-commenter commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 82.22222% with 8 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
apps/pipelines/nodes/utils.py 20.00% 8 Missing :warning:
Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!

SmittieC commented 2 weeks ago

@coderabbitai full review

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces several enhancements across multiple files, primarily focusing on data validation and error handling within the pipeline framework. In `nodes.py`, various classes have updated field definitions to include regex patterns and validation rules, ensuring better data integrity. New mixins have been added to validate structured data schemas, and existing classes like `SendEmail` now enforce valid email formats in their recipient lists. In the `utils.py` file, the `InputParam` class gains a `help_text` attribute for improved metadata. The front-end components, such as `PipelineNode` and `GetInputWidget`, have been updated to incorporate error states and contextual help, enhancing user feedback on input errors. The `Pipeline` class in `models.py` now includes a validation method that captures errors during node instantiation. Additionally, the `Flow` class has a new `errors` attribute for tracking errors, while the Zustand store has been modified to manage these errors effectively. Overall, the changes enhance the robustness and usability of the pipeline system. ## Possibly related PRs - **#827**: The changes in the main PR involve enhancements to data validation and field definitions in the `nodes.py` file, which aligns with the modifications in the `OpenAiAssistantForm` class in PR #827, where the handling of custom actions has been restructured to include validation for individual action operations. ## Suggested reviewers - snopoke

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 , please review it.` - `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 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 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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
SmittieC commented 2 weeks ago

@coderabbitai please do a full review

coderabbitai[bot] commented 2 weeks ago

@SmittieC: Understood. I will perform a full review of the pull request, focusing on the general approach and providing feedback on TypeScript/React optimizations and refactoring.

:white_check_mark: Actions performed Full review triggered.
SmittieC commented 2 weeks ago

@coderabbitai please do a full review

coderabbitai[bot] commented 2 weeks ago

@SmittieC: Understood. I will perform a full review of the pull request, focusing on your general approach and providing feedback on TypeScript/React optimizations and refactoring, as you've requested.

:white_check_mark: Actions performed Full review triggered.
SmittieC commented 1 week ago

@coderabbitai review please

coderabbitai[bot] commented 1 week ago

@SmittieC: Understood. I will perform a full review of the pull request as you've requested.

:white_check_mark: Actions performed Full review triggered.
SmittieC commented 1 week ago

Ima create a new PR. Clean slate