fix: fixed validation errors duplicates

[chesterkmr]

User description

Description

• Added uniqBy to validator output to avoid error duplicates.

Checklist

• [] I have read the contribution guidelines of this project
• [] I have read the style guidelines of this project
• [] 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
• [] My changes generate no new warnings and errors
• [] New and existing tests pass locally with my changes

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error message filtering to remove duplicates in validation processes.

---

PR Type

Bug fix

---

Description

• Enhanced the JSON Schema Rule Engine to filter out duplicate error messages using lodash's uniqBy function.
• This change ensures that each error message is unique, improving the clarity and usefulness of validation error outputs.

---

Changes walkthrough 📝

	Relevant files
Enhancement	json-schema.rule-engine.ts Implement Unique Error Message Filtering in JSON Schema Rule Engine apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts Imported uniqBy from lodash to ensure unique error messages. Modified the error filtering logic to use uniqBy based on the 'message' property. +5/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[changeset-bot]

⚠️ No Changeset found

Latest commit: 11bdca4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The JsonSchemaRuleEngine class has been updated to enhance its functionality. A new import (uniqBy from lodash) has been added to help in filtering out duplicate error messages during the validation process. This ensures that the output from the validation method is more concise and user-friendly by eliminating redundant information.

Changes

File Path	Change Summary
.../DynamicUI/rule-engines/json-schema.rule-engine.ts	Added uniqBy import from lodash and updated the validate method to remove duplicate error messages using uniqBy.

🐇💻
Oh hoppity hop, code's been refined,
No more repeats, that we will find.
With uniqBy our errors stand,
Unique and clear, across the land.
Cheers to clean results, so grand!

---

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

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 full the 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 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 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]

PR Description updated to latest commit (b4ef6cc)

[github-actions]

PR Description updated to latest commit (b4ef6cc)

[github-actions]

PR Description updated to latest commit (b4ef6cc)

[github-actions]

PR Review 🔍

(Review updated until commit b4ef6cc)

⏱️ Estimated effort to review [1-5]	2, because the changes are concise and focused on a specific functionality (removing duplicates in error messages), but require understanding of the existing validation logic and the use of lodash's uniqBy function.
🧪 Relevant tests	No
⚡ Possible issues	Possible Bug: If result is null or undefined, the call to result.flat() will throw a TypeError. This needs to be handled to prevent runtime errors.
🔒 Security concerns	No

Code feedback:

---

relevant file	apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts
suggestion	Consider adding a null check for result before calling result.flat() to prevent potential runtime errors. [important]
relevant line	result?.flat()?.filter(result => Boolean(result.message)),

---

[github-actions]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the PR involves a straightforward addition of a utility function from a well-known library (lodash) and a minor logic change in the error handling process. The changes are localized and do not seem to involve complex logic alterations.
🧪 Relevant tests	No
⚡ Possible issues	Possible Bug: If result is null or undefined, the call to result.flat() will throw a TypeError. This needs to be handled to prevent runtime errors.
🔒 Security concerns	No

Code feedback:

---

relevant file	apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts
suggestion	Consider adding a null check for result before calling result.flat() to prevent potential runtime errors. [important]
relevant line	result?.flat()?.filter(result => Boolean(result.message)),

---

[github-actions]

Persistent review updated to latest commit b4ef6cc

[github-actions]

PR Code Suggestions ✨

Category

Suggestions

Enhancement

Replace lodash's uniqBy with native TypeScript array methods to filter unique error messages. Consider using TypeScript's built-in array methods to ensure type safety and avoid adding unnecessary dependencies like lodash for operations that can be performed natively. Here, you can replace uniqBy with a combination of map and reduce to filter unique error messages. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [78-80] -return uniqBy( - result?.flat()?.filter(result => Boolean(result.message)), - 'message', -); +return result?.flat()?.filter(result => Boolean(result.message)) + .reduce((acc, current) => { + const x = acc.find(item => item.message === current.message); + if (!x) { + return acc.concat([current]); + } else { + return acc; + } + }, []);

[github-actions]

PR Code Suggestions ✨

Category

Suggestions

Possible issue

Add a null check for result before manipulating it to prevent runtime errors. Consider checking if result is not null or undefined before calling flat() and filter() methods to avoid potential runtime errors. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [78-80] -return uniqBy( - result?.flat()?.filter(result => Boolean(result.message)), - 'message', -); +if (result) { + return uniqBy( + result.flat().filter(result => Boolean(result.message)), + 'message', + ); +} +return [];

[github-actions]

PR Code Suggestions ✨

Category	Suggestions
Best practice	Improve type safety and readability by using TypeScript's type guards. Consider using TypeScript's built-in utility types for better type safety and readability instead of using Boolean for type coercion. You can use Boolean as a type guard directly in the filter method. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [79] -result?.flat()?.filter(result => Boolean(result.message)) +result?.flat()?.filter((result): result is { message: string } => Boolean(result.message))
	Enhance type safety by explicitly defining the type in the uniqBy function. To ensure that the uniqBy function from lodash is used effectively, consider explicitly defining the type of the array elements to enhance type safety and prevent runtime errors. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [78-80] -return uniqBy( +return uniqBy<ErrorObject>( result?.flat()?.filter(result => Boolean(result.message)), - 'message', + 'message' );
Possible issue	Add a null check for result to prevent potential runtime errors. Since the result array is being flattened and filtered, consider checking if result is not null or undefined before proceeding with these operations to avoid potential runtime errors. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [78-80] +if (!result) return []; return uniqBy( - result?.flat()?.filter(result => Boolean(result.message)), + result.flat().filter(result => Boolean(result.message)), 'message', );
Performance	Optimize performance by reducing the number of array operations. To improve performance, consider reducing the number of operations by combining flat and filter into a single reduce operation. This avoids creating intermediate arrays and can lead to better performance especially for large datasets. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [79] -result?.flat()?.filter(result => Boolean(result.message)) +result?.reduce((acc, val) => acc.concat(val.message ? [val] : []), [])
Maintainability	Verify the necessity of the new uniqBy import to maintain clean code. To avoid potential issues with duplicate imports and to maintain clean and maintainable code, ensure that the newly added uniqBy import from lodash is used elsewhere in the file or consider removing it if it's not necessary. apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts [10] +// Ensure usage or remove if not necessary import uniqBy from 'lodash/uniqBy';

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0388faa and b4ef6cc.

Files selected for processing (1)

• apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts (2 hunks)

Files not reviewed due to errors (1)

• apps/kyb-app/src/components/organisms/DynamicUI/rule-engines/json-schema.rule-engine.ts (no review received)

[Omri-Levy]

Isn't a message connected to a field? It seems the real issue is that more than one of the same message is being pushed to the same field.

[chesterkmr]

Duplicate messages are coming from ajv, the way we parsing errors and converting them to field errors didnt handled this case. So uniqBy should be fine.

[Omri-Levy]

If 3 fields have the same message, would only the first field have the message post this change?

[alonp99]

Why in the first place we get couple of messages on a single input field? @chesterkmr