Skip to content
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

fix(web): show url validation error for each value on multiple field #1336

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

caichi-t
Copy link
Contributor

@caichi-t caichi-t commented Dec 5, 2024

Overview

This PR fixes to show URL validation error for each value on multiple field.

Memo

I removed showCount and maxLength attributes from URL field.

Summary by CodeRabbit

  • New Features

    • Enhanced URL validation in the URLField component for improved error handling.
    • Introduced a utility function to validate URLs and return error indexes.
  • Bug Fixes

    • Streamlined validation logic to reduce complexity and improve reliability.
  • Documentation

    • Updated validation messages to utilize translation functions for better localization.

@caichi-t caichi-t requested a review from nourbalaha as a code owner December 5, 2024 03:05
Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in this pull request focus on enhancing the URLField component's functionality and error handling in the React application. Modifications include the introduction of a new utility function for URL validation, updates to the validation logic using memoization, and improved state management for error indexes. Additionally, adjustments were made to the rendering of components to better reflect validation states. These changes streamline the validation process and enhance user feedback regarding URL input errors.

Changes

File Change Summary
web/src/components/molecules/Content/Form/fields/FieldComponents/URLField.tsx Updated imports, added errorIndexes state, modified validation logic to use urlErrorIndexesGet, and adjusted Form.Item validation feedback.
web/src/components/molecules/Content/Form/fields/utils.ts Introduced urlErrorIndexesGet utility function for validating URLs and updated import statements.
web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/URLField/index.tsx Updated imports, added errorIndexes state, modified validation to use urlErrorIndexesGet, and adjusted rendering logic for error handling.

Possibly related PRs

Suggested reviewers

  • nourbalaha

Poem

🐇 In the garden of code, we hop and play,
With URLs checked, come what may.
Errors now caught, in a neat little set,
Our fields are so smart, you won't forget!
So let’s raise a cheer, for the changes we see,
A hop, skip, and jump, to validation glee! 🎉


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

@github-actions github-actions bot added the web label Dec 5, 2024
Copy link

netlify bot commented Dec 5, 2024

Deploy Preview for reearth-cms ready!

Name Link
🔨 Latest commit de41083
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/675bcb1cb506d8000898e22e
😎 Deploy Preview https://deploy-preview-1336--reearth-cms.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/URLField/index.tsx (1)

15-15: Optimize error state updates with useMemo

Consider memoizing the error indexes calculation to prevent unnecessary re-renders.

Here's a suggested implementation:

- const [errorIndexes, setErrorIndexes] = useState(new Set<number>());
+ const [errorIndexes, setErrorIndexes] = useState<Set<number>>(new Set());
+ const validateValue = useMemo(
+   () => async (_: any, value: string | string[]) => {
+     const indexes = urlErrorIndexesGet(value);
+     setErrorIndexes(new Set(indexes));
+     if (indexes.length) return Promise.reject();
+     return Promise.resolve();
+   },
+   []
+ );

// In rules array:
-          validator: async (_, value) => {
-            const indexes = urlErrorIndexesGet(value);
-            setErrorIndexes(new Set(indexes));
-            if (indexes.length) {
-              return Promise.reject();
-            }
-            return Promise.resolve();
-          },
+          validator: validateValue,

Also applies to: 27-32

web/src/components/molecules/Content/Form/fields/FieldComponents/URLField.tsx (2)

22-43: Extract URL validation logic into a custom hook

There's duplicate validation logic between both URLField components. Consider creating a shared hook to improve maintainability and reduce code duplication.

Create a new hook like this:

// hooks/useURLValidation.ts
export const useURLValidation = (t: (key: string) => string) => {
  const [errorIndexes, setErrorIndexes] = useState<Set<number>>(new Set());
  
  const validateURL = useMemo(
    () => async (_: any, value: string | string[]) => {
      const indexes = urlErrorIndexesGet(value);
      setErrorIndexes(new Set(indexes));
      if (indexes.length) return Promise.reject();
      return Promise.resolve();
    },
    []
  );

  const validationRule = {
    message: t("URL is not valid"),
    validator: validateURL,
  };

  return { errorIndexes, validationRule };
};

This would simplify both URLField components and ensure consistent validation behavior.


54-55: Consider adding aria-invalid attribute for accessibility

While the visual error state is handled, adding aria-invalid would improve accessibility for screen readers.

Update the components like this:

 <MultiValueField
   FieldInput={Input}
   onBlur={onMetaUpdate}
   disabled={disabled}
   required={required}
   errorIndexes={errorIndexes}
+  aria-invalid={errorIndexes.size > 0}
 />

 <Input
   onBlur={onMetaUpdate}
   disabled={disabled}
   required={required}
   isError={errorIndexes.has(0)}
+  aria-invalid={errorIndexes.has(0)}
 />

Also applies to: 61-62

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4204334 and 34d1760.

📒 Files selected for processing (3)
  • web/src/components/molecules/Content/Form/fields/FieldComponents/URLField.tsx (2 hunks)
  • web/src/components/molecules/Content/Form/fields/utils.ts (2 hunks)
  • web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/URLField/index.tsx (1 hunks)

@caichi-t caichi-t enabled auto-merge (squash) December 13, 2024 05:50
@caichi-t caichi-t merged commit 6a3fd08 into main Dec 13, 2024
19 checks passed
@caichi-t caichi-t deleted the fix-web/url-validator-enhancement branch December 13, 2024 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants