fix(node-api): hardened CustomValidator validation

[abi87]

For each validation function, we better use strict type enforcement that corresponds with the usage of the request data.

Summary by CodeRabbit

• New Features

  • Enhanced validation methods for validator IDs and roots, improving type safety and error handling.
  • Introduced structured validation using public key formats instead of regular expressions.

• Refactor

  • Removed reliance on regex for critical validation tasks, streamlining the validation logic.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 23.44%. Comparing base (aec2501) to head (b053357).
Report is 16 commits behind head on main.

Files with missing lines	Patch %	Lines
mod/node-api/engines/echo/vaildator.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2093      +/-   ##
==========================================
+ Coverage   23.41%   23.44%   +0.02%     
==========================================
  Files         356      356              
  Lines       16008    15994      -14     
  Branches       12       12              
==========================================
  Hits         3749     3749              
+ Misses      12094    12080      -14     
  Partials      165      165              

Files with missing lines	Coverage Δ
mod/node-api/engines/echo/vaildator.go	0.00% <0.00%> (ø)

[coderabbitai]

Walkthrough

The changes involve a refactor of the validator.go file in the echo package, shifting validation methods from regular expressions to structured type-based validations. The ValidateValidatorID function now uses the crypto.BLSPubkey type for public key validation, while the ValidateRoot function employs common.NewRootFromHex for root validation. This update enhances type safety and clarity in validation logic. Additionally, the validateRegex function has been removed, and relevant import statements have been updated to include necessary packages.

Changes

File Path	Change Summary
mod/node-api/engines/echo/validator.go	- Updated ValidateValidatorID and ValidateRoot methods to remove regex validation. - Added new methods: UnmarshalText in crypto and NewRootFromHex in common. - Removed validateRegex function. - Updated import statements for common and crypto.

Suggested reviewers

• itsdevbear

🐇 In the code, a change we see,
No more regex, just clarity!
With keys and roots, we validate,
A safer path, we celebrate!
Hopping through code, we cheer and play,
For better checks, hip-hip-hooray! 🎉

---

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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between a659c95 and 9ced281.

📒 Files selected for processing (1)

• mod/node-api/engines/echo/vaildator.go (3 hunks)

🧰 Additional context used

🔇 Additional comments (3)

mod/node-api/engines/echo/vaildator.go (3)

30-31: Approved: Added necessary imports for type-based validation

The added imports for common and crypto packages are necessary for the new type-based validation logic.

---

134-136: Approved: Enhanced ValidateValidatorID with type-based validation

The function now utilizes crypto.BLSPubkey for validation, improving type safety and eliminating reliance on regular expressions.

---

148-149: Approved: Updated ValidateRoot to use structured parsing

Using common.NewRootFromHex enhances validation accuracy by relying on structured parsing instead of regular expressions.

[coderabbitai]

🧹 Nitpick (assertive)

Consider updating the TODO comment to reflect recent changes

The recent updates to ValidateValidatorID and ValidateRoot begin to address the concerns mentioned in the TODO comment regarding strong typing and avoidance of repeated .Field().String() calls. Please update or remove the TODO comment if it's no longer applicable.

Would you like assistance in updating the TODO comment to reflect the remaining tasks?