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

Added max length validation in user registration, company name and password which solve unhandled error in backend #495

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ArafatHossain403
Copy link

@ArafatHossain403 ArafatHossain403 commented Dec 21, 2024

What kind of change does this PR introduce?

Bug Fix: Resolves issues with excessive input lengths for password and company name during user registration.
Use 64 characters for passwords and 128 characters for company names. This strikes a balance between practicality, security, and efficiency.

Screenshot from 2024-12-22 00-10-38

Why was this change needed?

Related Issues:
#493
#494

Both issues stemmed from the absence of well-defined input length restrictions for the password and company fields during the user registration process.

Other information:

Enforced a maximum character limit for password and company fields:
Password: Max 64 characters.
Company Name: Max 128 characters.
Future plans: Extend similar validation rules to other input fields across the application.

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • [ X] I have read the CONTRIBUTING guide.
  • [X ] I checked that there were not similar issues or PRs already open for this.
  • [ X] This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • New Features

    • Added maximum length validation for password (64 characters) and company name (128 characters) fields in the user creation process.
  • Style

    • Improved formatting of validation decorators for consistency.

Copy link

vercel bot commented Dec 21, 2024

@ArafatHossain403 is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Dec 21, 2024

Walkthrough

The pull request introduces additional validation constraints to the CreateOrgUserDto class in the authentication data transfer object. Specifically, maximum length decorators are added to the password and company fields to enforce stricter input validation. The changes aim to improve data integrity by limiting the maximum length of these fields to 64 and 128 characters respectively, ensuring more controlled user input during organization user creation.

Changes

File Change Summary
libraries/nestjs-libraries/src/dtos/auth/create.org.user.dto.ts Added @MaxLength(64) decorator to password field and @MaxLength(128) decorator to company field

Poem

🐰 Validation's dance, a rabbit's delight,
Constraints now bound with limits so tight
Passwords trimmed, companies constrained
In sixty-four and twenty-eight, order gained
A dto's journey, secure and bright! 🔒

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

@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

🧹 Nitpick comments (1)
libraries/nestjs-libraries/src/dtos/auth/create.org.user.dto.ts (1)

5-10: Password validation looks good, consider additional security measures

The 64-character limit is reasonable and aligns with common security practices. However, consider adding additional password complexity requirements.

Consider adding these validators for stronger password security:

 @IsString()
 @MinLength(3)
 @MaxLength(64)
+@Matches(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\W]{3,}$/, {
+  message: 'Password must contain uppercase, lowercase, and numbers'
+})
 @IsDefined()
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e0d4661 and 7e06037.

📒 Files selected for processing (1)
  • libraries/nestjs-libraries/src/dtos/auth/create.org.user.dto.ts (1 hunks)
🔇 Additional comments (3)
libraries/nestjs-libraries/src/dtos/auth/create.org.user.dto.ts (3)

1-1: LGTM! Import statement correctly includes MaxLength validator

The import statement properly includes the new MaxLength validator while maintaining other necessary imports.


26-30: LGTM! Company name validation is well-structured

The 128-character limit for company names is reasonable and the validation chain is complete with appropriate minimum and maximum length constraints.


16-19: Verify provider token length requirements

Consider adding MaxLength validation for providerToken based on the maximum token length of supported providers.

Comment on lines +21 to +24
@IsEmail()
@IsDefined()
@ValidateIf((o) => !o.providerToken)
email: string;
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding MaxLength validation for email field

While email validation is present, consider adding a MaxLength validator to prevent excessive input lengths, similar to other fields.

 @IsEmail()
 @IsDefined()
 @ValidateIf((o) => !o.providerToken)
+@MaxLength(254)  // RFC 5321 maximum length
 email: string;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@IsEmail()
@IsDefined()
@ValidateIf((o) => !o.providerToken)
email: string;
@IsEmail()
@IsDefined()
@ValidateIf((o) => !o.providerToken)
@MaxLength(254) // RFC 5321 maximum length
email: string;

Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

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

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

Successfully merging this pull request may close these issues.

2 participants