fix: add provider input validation & type safety

[theedigerati]

Closes #1327

📑 Description

Validation for provider inputs using zod schema on the frontend and pydantic on the backend

• [x] zod schema for all provider inputs
• [x] custom validation logic for urls(with/without protocol), port, tld, file
• [x] built-in & custom pydantic fields types for inputs on all providers with such fields
• [x] type safety for provider form component
• [x] e2e tests

✅ Checks

• [x] My pull request adheres to the code style of this project
• [ ] My code requires changes to the documentation
• [ ] I have updated the documentation as required
• [x] All the tests have passed

ℹ Additional Information

Validation logic runs on input and on submit now. https://www.loom.com/share/98575f364f9d421b84cfb8aa3f6961e6?sid=f001cfd1-6a1a-4604-93e3-0c08d76b8555

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a comprehensive URL validation module using zod, enhancing URL input validation across various components.
  • Added new types and validation for provider authentication configurations, ensuring stricter adherence to expected URL formats.
  • Implemented a new end-to-end test for validating provider fields, ensuring proper error handling for invalid inputs.

• Bug Fixes

  • Improved error handling and logging mechanisms across various provider configurations to enhance user feedback.

• Documentation

  • Updated metadata descriptions for various fields to improve clarity and consistency in naming conventions.

• Refactor

  • Streamlined component logic and prop management in several provider forms to enhance maintainability and readability.

• Chores

  • Added new dependencies for enhanced validation capabilities.

[vercel[bot]]

@theedigerati is attempting to deploy a commit to the KeepHQ Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

All committers have signed the CLA.

[theedigerati]

Hello @Matvey-Kuk, I'd really appreciate your review and feedback on this contribution. Thank you.

[Kiryous]

@coderabbitai review

[coderabbitai[bot]]

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai[bot]]

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request introduce a comprehensive validation framework across various provider configurations, primarily focusing on URL and port validation using Pydantic types. New types such as HttpsUrl, NoSchemeUrl, and UrlPort are implemented to enforce stricter validation rules. Additionally, several components have been refactored to streamline prop management and enhance error handling. A new end-to-end test has been added to validate provider inputs, ensuring that the application correctly handles various input scenarios.

Changes

File Path	Change Summary
keep-ui/app/providers/form-validation.ts	Introduced URL validation module with types and functions for URL validation and error handling.
keep-ui/app/providers/provider-form-scopes.tsx	Removed installedProvidersMode and updated onRevalidate prop for clarity.
keep-ui/app/providers/provider-form.tsx	Refactored ProviderForm for better state management and validation using new utility functions.
keep-ui/app/providers/providers-tiles.tsx	Simplified state management by removing formValues and formErrors.
keep-ui/app/providers/providers.tsx	Enhanced ProviderAuthConfig with new validation types and properties.
keep-ui/app/workflows/workflow-tile.tsx	Removed form state management from WorkflowTile and WorkflowTileOld.
keep-ui/package.json	Added dependency for zod library.
keep/parser/parser.py	Adjusted method signatures and improved logging in provider parsing methods.
keep/providers/*.py	Updated various provider configurations to utilize new validation types for URLs and ports.
keep/validation/fields.py	Introduced custom URL classes extending Pydantic for enhanced validation.
tests/e2e_tests/test_end_to_end.py	Added new test function for validating provider inputs and error messages.

Assessment against linked issues

Objective	Addressed	Explanation
Cross-all-providers accepted schemas for provider inputs (URLs, ports, etc.) (#1327)	✅
Enforce validation on both frontend and backend (#1327)	✅
Ensure correct handling of URLs with/without trailing slashes (#1327)	✅
Validate various URL formats (http, https, localhost, etc.) (#1327)	✅
Distinguish between host and URL in validation (#1327)	✅

🐰 In the meadow, where the URLs play,
A rabbit hops, validating all day.
With types so strict, and checks so keen,
No invalid input shall be seen!
From ports to hosts, all will comply,
In our garden of code, we reach for the sky! 🌼

---

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

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Kiryous]

@theedigerati hey! thank you for the contribution! I'll pick it up from Matvey and review the changes.

In the meantime, could you please check the coderabbit comments? Feel free to resolve not important ones, but I also pretty important ones — I tagged you.

[theedigerati]

@Kiryous Alright. Thank you very much. I'll get on it.

[talboren]

@theedigerati @Kiryous any updates on this one? 🙏🏼

[theedigerati]

Hello @talboren, I've been working on this. It is all good now. I'll resolve the conversations.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
keep	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 3, 2024 11:59am