Skip to content

fix: validation bypass when updating block #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

IkbelTalebHssan
Copy link
Collaborator

@IkbelTalebHssan IkbelTalebHssan commented Apr 24, 2025

Motivation

This PR introduces a validation error message when required fields are missing in the block editing form.

Fixes #933

Type of change:

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features
    • Added a user-facing error message when required fields are missing in forms, now available in both English and French.
  • Enhancements
    • Improved tab panel behavior for smoother visibility transitions using CSS, enhancing the user experience.
    • Form error handling now displays a toast notification if required fields are not filled.

Copy link

coderabbitai bot commented Apr 24, 2025

Walkthrough

The changes introduce a new error message key, missing_fields_error, to both English and French translation files. The TabPanel component was updated to always render its children inside a nested Grid container while controlling visibility via the hidden attribute. In the BlockEditForm component, a new error handling callback was added to display a localized toast notification when required fields are missing during form submission. No changes to component signatures or public APIs are present.

Changes

File(s) Change Summary
frontend/public/locales/en/translation.json, frontend/public/locales/fr/translation.json Added missing_fields_error key to the "message" section with appropriate English and French translations.
frontend/src/app-components/tabs/TabPanel.tsx Updated to always render children inside a nested Grid container; visibility controlled by hidden attribute.
frontend/src/components/visual-editor/BlockEditForm.tsx Added error handling callback to show a toast with a localized error message on form validation failure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BlockEditForm
    participant Toast
    participant i18n

    User->>BlockEditForm: Submit form
    alt Validation passes
        BlockEditForm->>BlockEditForm: Process submission
    else Validation fails
        BlockEditForm->>i18n: Get "missing_fields_error" message
        i18n-->>BlockEditForm: Localized error string
        BlockEditForm->>Toast: Show error notification
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent front-end validation bypass when updating a Block (#933)

Poem

A bunny hopped into the code today,
To help with forms that go astray.
Now missing fields will show a toast,
In French or English, as you boast!
Tabs now hide with CSS flair,
Bugs are gone—validation’s fair.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e30f5ea and 70eb1f1.

📒 Files selected for processing (1)
  • frontend/src/app-components/tabs/TabPanel.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/src/app-components/tabs/TabPanel.tsx
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Frontend Tests
  • GitHub Check: API-Tests
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (actions)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@IkbelTalebHssan IkbelTalebHssan force-pushed the fix/validation-by-pass-when-updating-block branch from acdb746 to e30f5ea Compare April 25, 2025 07:24
@IkbelTalebHssan IkbelTalebHssan marked this pull request as ready for review April 25, 2025 07:25
id={`vertical-tabpanel-${index}`}
aria-labelledby={`vertical-tab-${index}`}
sx={{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is causing settings to become cropped in UI rendering.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes @MohamedAliBouhaouala true I'll fix this 🙏

Copy link
Contributor

@MohamedAliBouhaouala MohamedAliBouhaouala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screencast.from.2025-04-28.17-45-57.webm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [BUG] - Validation by pass when updating Block
4 participants