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

365 replace he package and hedecodeuserpicture #454

Merged
merged 6 commits into from
Jan 2, 2025

Conversation

DeboraSerra
Copy link
Contributor

@DeboraSerra DeboraSerra commented Jan 2, 2025

Describe your changes

Briefly describe the changes you made and their purpose.

Issue number

Mention the issue number(s) this PR addresses (e.g., #123).

Please ensure all items are checked off before requesting a review:

  • I deployed the code locally.
  • I have performed a self-review of my code.
  • I have included the issue # in the PR.
  • I have labelled the PR correctly.
  • The issue I am working on is assigned to me.
  • I didn't use any hardcoded values (otherwise it will not scale, and will make it difficult to maintain consistency across the application).
  • I made sure font sizes, color choices etc are all referenced from the theme.
  • My PR is granular and targeted to one specific feature.
  • I took a screenshot or a video and attached to this PR if there is a UI change.

Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

This pull request involves the removal of the he library from the backend project and the introduction of a custom decode function. Changes are made across multiple files, including package.json, auth.controller.js, user.controller.js, and auth.helper.js. The modifications include standardizing string delimiters to single quotes and updating the validation logic for the picture field to utilize the new decoding function.

Changes

File Change Summary
backend/package.json Removed he dependency (version ^1.2.0)
backend/src/controllers/auth.controller.js Standardized string delimiters to single quotes
backend/src/controllers/user.controller.js Replaced he.decode() with custom decode() function; updated validation logic for picture field
backend/src/utils/auth.helper.js Added new decode() function; updated string quotes in validation messages
backend/src/test/e2e/user.test.mjs Activated test for PUT /api/users/update; updated error message for invalid picture input

Sequence Diagram

sequenceDiagram
    participant Controller as User Controller
    participant Helper as Auth Helper
    participant Input as User Input

    Input->>Controller: Provide encoded string
    Controller->>Helper: Call decode function
    Helper-->>Controller: Return decoded string
    Controller->>Input: Process decoded value
Loading

Possibly Related PRs

Suggested Reviewers

  • gorkem-bwl
  • swoopertr

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 603e66a and a829f39.

📒 Files selected for processing (2)
  • backend/src/controllers/user.controller.js (6 hunks)
  • backend/src/test/e2e/user.test.mjs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • backend/src/test/e2e/user.test.mjs
  • backend/src/controllers/user.controller.js

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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
Contributor

@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 (4)
backend/src/utils/auth.helper.js (4)

8-12: Likewise, broaden surname to accept accented letters
Similar to “name,” enabling accented letters in “surname” can enhance usability for non-English or French-based names.


14-18: Consider clarifying password guidelines
Your rules look good, but you might consider specifying uppercase letters or digits if desired, depending on security requirements.


26-26: Reconfirm mandatory email
You may want to add a .notEmpty() check and a friendly error message for missing emails in the forget password flow.


29-34: Fix grammatical inconsistency in error message
"atleast" should be "at least."

- .withMessage('Must be atleast 8 characters')
+ .withMessage('Must be at least 8 characters')
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 407e5db and f6e34fe.

⛔ Files ignored due to path filters (1)
  • backend/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • backend/package.json (0 hunks)
  • backend/src/controllers/auth.controller.js (7 hunks)
  • backend/src/controllers/user.controller.js (2 hunks)
  • backend/src/utils/auth.helper.js (1 hunks)
💤 Files with no reviewable changes (1)
  • backend/package.json
✅ Files skipped from review due to trivial changes (1)
  • backend/src/controllers/auth.controller.js
🔇 Additional comments (5)
backend/src/utils/auth.helper.js (3)

22-23: Email validation is clear
These rules for logging in appear suitable.


37-44: Validate safe decoding
While this conditional check is helpful, consider whether base64 inputs could contain unexpected content. Promptly verify whether further sanitizing is required to avoid security pitfalls.


51-51: Exporting decode
No issues found here; the export structure is well-organised.

backend/src/controllers/user.controller.js (2)

5-5: Confirm import path correctness
The import path appears logically consistent, referencing the correct folder structure.


52-52: Guard against invalid or null inputs
Consider adding defensive checks or exception handling, especially if user input may not always be valid strings capable of being decoded without error.

backend/src/utils/auth.helper.js Show resolved Hide resolved
@DeboraSerra DeboraSerra linked an issue Jan 2, 2025 that may be closed by this pull request
@erenfn erenfn merged commit c53949c into develop Jan 2, 2025
2 checks passed
erenfn added a commit that referenced this pull request Jan 2, 2025
…-hedecodeuserpicture

365 replace he package and hedecodeuserpicture
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.

Replace he package and he.decode(user.picture)
2 participants