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(user): correctly get user by token #2654

Merged
merged 1 commit into from
Aug 30, 2024
Merged

fix(user): correctly get user by token #2654

merged 1 commit into from
Aug 30, 2024

Conversation

bodinsamuel
Copy link
Collaborator

@bodinsamuel bodinsamuel commented Aug 30, 2024

Describe your changes

  • Correctly get User by token
    The || was incorrectly returning Ok all the time + type issue

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in user retrieval by ensuring an error is returned when a user is not found.
    • Enhanced logic for checking email verification token expiration to prevent potential errors with undefined values.
  • New Features

    • Clarified the expected structure of returned data by updating type annotations in user retrieval logic.

@bodinsamuel bodinsamuel self-assigned this Aug 30, 2024
Copy link

coderabbitai bot commented Aug 30, 2024

Walkthrough

The changes to the UserService class focus on enhancing the getUserByToken method. Key updates include refining type annotations to specify DBUser, improving the logic for checking the expiration of the email verification token, and modifying the return statement to ensure consistent error handling when a user is not found.

Changes

File Path Change Summary
packages/shared/lib/services/user.service.ts Updated type annotations to DBUser, refined logic for email verification token expiration check, and modified return statement for user not found.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UserService
    participant Database

    User->>UserService: Request user by token
    UserService->>Database: Query user by token
    Database-->>UserService: Return user data
    UserService->>User: Return user or error
Loading

🐰 In the meadow, hopping around,
A change in the code, oh what a sound!
With tokens now checked, and types so clear,
Our service is stronger, let’s give a cheer!
Hooray for the updates, let’s dance and play,
For a better tomorrow, 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
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.
    • @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.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b6c2d06 and 04964cd.

Files selected for processing (1)
  • packages/shared/lib/services/user.service.ts (1 hunks)
Additional comments not posted (1)
packages/shared/lib/services/user.service.ts (1)

24-36: Refined logic and improved error handling in getUserByToken.

The changes made to the getUserByToken method enhance its robustness and clarity:

  • The use of DBUser for the database query ensures that the returned data structure is well-defined.
  • The conditional check for token expiration is crucial for avoiding errors when the expiration date is not set.
  • Explicit error handling when a user is not found is a significant improvement.

The changes are approved as they align with the PR objectives to fix the user retrieval process based on a token.

Consider adding unit tests to cover these new conditions and ensure that the method behaves as expected under various scenarios.

@bodinsamuel bodinsamuel merged commit dbd2c05 into master Aug 30, 2024
23 checks passed
@bodinsamuel bodinsamuel deleted the fix/user-get branch August 30, 2024 10:06
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