feat: add ValidObjectIdPipe

[joshunrau]

Summary by CodeRabbit

• New Features

  • Introduced enhanced input validation for identifier values, ensuring that only properly formatted IDs are accepted and providing clearer error feedback.

• Tests

  • Added test cases to verify the behavior for both valid and invalid identifier inputs, improving overall reliability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new pipe for validating MongoDB ObjectId strings. A new file defines the ValidObjectIdPipe class with a transform method that checks if a given value is a valid ObjectId, throwing a BadRequestException when invalid. A corresponding test file using Vitest validates both successful and failure scenarios. Additionally, the export statement in the module’s index file has been updated to include the newly implemented pipe.

Changes

File(s)	Change Summary
src/index.ts	Added export statement for ValidObjectIdPipe to enable external access from the module.
src/pipes/valid-object-id.pipe.ts src/pipes/__tests__/valid-object-id.pipe.test.ts	Added new ValidObjectIdPipe implementation that validates MongoDB ObjectIds and created tests to verify correct behavior for valid and invalid inputs.

Poem

I’m a rabbit with a coding spree,
Hopping through changes merrily.
ObjectIds stand validated and true,
With tests and exports joining the crew.
In fields of code, I cheer with delight,
As new features make every byte bright!

---

📜 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 b786959 and 3e756eb.

📒 Files selected for processing (3)

• src/index.ts (1 hunks)
• src/pipes/__tests__/valid-object-id.pipe.test.ts (1 hunks)
• src/pipes/valid-object-id.pipe.ts (1 hunks)

✨ 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

• 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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]

🎉 This PR is included in version 4.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀