Feat/custom validate func

egordidenko commented 1 month ago

Description

Checklist

[ ] Tests (if applicable)
[ ] Documentation (if applicable)
[ ] Changelog stub (or use conventional commit messages)

Summary by CodeRabbit

New Features
- Introduced a new ValidationManager to handle file and collection validation, improving the validation process.
- Added support for custom file and collection validators in the configuration settings.
Bug Fixes
- Enhanced error handling for file and collection uploads, ensuring more accurate error messages.
Documentation
- Updated example HTML files to demonstrate new validation functionalities.
Refactor
- Streamlined validation logic by consolidating it into the ValidationManager, removing redundant code.
Style
- Improved code readability and maintainability by cleaning up imports and removing unused functions.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a centralized ValidationManager for handling file and collection validations within the uploader block. This refactor simplifies the code by removing multiple individual validator functions and replacing them with a unified validation system. Configuration settings are updated to support the new validators, and type definitions are enhanced to reflect these changes. Additionally, demo files are updated to showcase the new validation functionality.

Changes

Files / Groups	Change Summary
`abstract/UploaderBlock.js`	Removed old validators, added `ValidationManager`, updated logic to use the new manager.
`abstract/ValidationManager.js`	Introduced `ValidationManager` class for handling file and collection validations.
`blocks/Config/Config.js`	Added `fileValidators` and `collectionValidators` to `complexConfigKeys`.
`blocks/Config/initialConfig.js`	Added `fileValidators` and `collectionValidators` properties to `initialConfig`.
`blocks/Config/normalizeConfigValue.js`	Introduced `asArray` function and updated `mapping` object for new validators.
`demo/raw-regular.html`	Added a script tag to reference `index.js` as a module.
`abstract/CTX.js`	Updated type annotation for `collectionErrors` to use types from `ValidationManager`.
`abstract/buildOutputCollectionState.js`	Updated return type annotation for errors function.
`types/exported.d.ts`	Added `FileValidator` and `CollectionValidator` types.
`utils/validators/collection/index.js`	Exported `validateCollectionUploadError` and `validateMultiple` functions.
`utils/validators/collection/validateCollectionUploadError.js`	Introduced `validateCollectionUploadError` function.
`utils/validators/collection/validateMultiple.js`	Introduced `validateMultiple` function.
`utils/validators/file/index.js`	Exported `validateIsImage`, `validateFileType`, `validateMaxSizeLimit`, and `validateUploadError` functions.
`utils/validators/file/validateFileType.js`	Introduced `validateFileType` function.
`utils/validators/file/validateIsImage.js`	Introduced `validateIsImage` function.
`utils/validators/file/validateMaxSizeLimit.js`	Introduced `validateMaxSizeLimit` function.
`utils/validators/file/validateUploadError.js`	Introduced `validateUploadError` function.
`demo/validators.html`	Added new validation functions and updated configuration in demo HTML.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UploaderBlock
    participant ValidationManager
    participant FileValidator
    participant CollectionValidator

    User->>UploaderBlock: Upload File/Collection
    UploaderBlock->>ValidationManager: Run Validators
    ValidationManager->>FileValidator: Validate File
    FileValidator-->>ValidationManager: Return Validation Result
    ValidationManager->>CollectionValidator: Validate Collection
    CollectionValidator-->>ValidationManager: Return Validation Result
    ValidationManager-->>UploaderBlock: Return Validation Results
    UploaderBlock-->>User: Display Validation Results

Poem

In the code, a change so grand,
Validators now take a stand.
With a manager to guide the way,
Errors and files kept at bay.
Configuration set just right,
Uploads now a smoother flight.
🎉✨

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.` - `@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 as 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. 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.

nd0ut commented 1 month ago

[x] Do not pass internal entry to the file validator
[x] Also I think it's better to rename block argument to the ctx or or (like lr-upload-ctx-provider)
[x] Do not pass internal collection to the collection validator, use outputCollectionEntry instead.
[x] Validate custom validator's returned value
[x] Wrap each validator into the try/catch and skip it on fall with the console warning
[x] Set default type for custom validation errors, I think it could be easily done with wrapping around the original validator like this:

(this._blockInstance.cfg.fileValidators ?? []).map(fn => (...args) => ({...fn(...args), type: 'CUSTOM_TYPE'}))

uploadcare / blocks