Skip to content

Conversation

indraniBan
Copy link
Contributor

@indraniBan indraniBan commented Mar 12, 2025

πŸ“‹ Description

JIRA ID:

Please provide a summary of the change and the motivation behind it. Include relevant context and details.


βœ… Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • πŸ”₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ›  Refactor (change that is neither a fix nor a new feature)
  • βš™οΈ Config change (configuration file or build script updates)
  • πŸ“š Documentation (updates to docs or readme)
  • πŸ§ͺ Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • πŸš€ Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of authentication-related cookies to prevent errors when no cookies are present.
    • Updated the token cookie process to enhance null safety during cookie retrieval.
    • Disabled the automatic addition of the JWT token cookie to the response, altering the behavior of cookie handling.

Copy link
Contributor

coderabbitai bot commented Mar 12, 2025

Walkthrough

This PR updates the cookie handling logic within the CookieUtil class. The addJwtTokenToCookie method no longer adds the cookie to the response as the addition line has been commented out. Additionally, the getJwtTokenFromCookie method now checks if the request's cookies are null and returns null immediately, preventing potential NullPointerExceptions.

Changes

File Change Summary
src/main/java/com/iemr/common/utils/CookieUtil.java - In addJwtTokenToCookie: Commented out the call to response.addCookie(cookie) so the cookie is no longer added to the response.
- In getJwtTokenFromCookie: Added a null check for request.getCookies() to safely handle null scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Server
    participant CookieUtil
    participant Response

    Server->>CookieUtil: addJwtTokenToCookie(response, jwtToken)
    CookieUtil->>Response: Prepare cookie
    Note over CookieUtil: response.addCookie(cookie) is commented out
    CookieUtil-->>Server: Cookie not added
Loading
sequenceDiagram
    participant Client
    participant Request
    participant CookieUtil
    participant CookieArray

    Client->>Request: Sends request
    Request->>CookieUtil: getJwtTokenFromCookie(request)
    CookieUtil->>Request: call getCookies()
    alt Cookies are null
        CookieUtil-->>Client: returns null
    else Cookies exist
        CookieUtil->>CookieArray: iterate to find JWT cookie
        CookieArray-->>CookieUtil: returns matching cookie?
        CookieUtil-->>Client: returns JWT token
    end
Loading

Possibly related PRs

  • Cors issue resolvedΒ #162: Modifies the addJwtTokenToCookie method by adding cookie attribute enhancements, which is closely related to the cookie handling changes in this PR.

Suggested reviewers

  • devikasuresh20
  • helenKaryamsetty

Poem

In the code field I hop with glee,
Cookies altered as plain as can be.
The token’s journey now takes a twist,
Nulls handled without a mist.
ASCII hops through each line I see,
Celebrating changes from a rabbit β€” that’s me!
πŸ‡πŸŒŸ


πŸ“œ 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 016f2a2 and 74c35d9.

πŸ“’ Files selected for processing (1)
  • src/main/java/com/iemr/common/utils/CookieUtil.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/iemr/common/utils/CookieUtil.java
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Package-test
  • GitHub Check: Build
  • GitHub Check: Analyze (java)

πŸͺ§ 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 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
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: 0

🧹 Nitpick comments (1)
src/main/java/com/iemr/common/utils/CookieUtil.java (1)

44-44: The standard cookie addition has been disabled.

The standard method response.addCookie(cookie) has been commented out, leaving only the manual Set-Cookie header approach active. According to retrieved learnings, both approaches were previously confirmed to work as required. Consider whether disabling the standard method was intentional, as it may affect cookie handling.

Given that the manual header is still added at line 60, this change likely removes duplication, but confirm that all environments and browsers still handle the cookie correctly with only the manual approach. The manual approach gives more control over attributes like SameSite.

πŸ“œ Review details

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

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 770be02 and 016f2a2.

πŸ“’ Files selected for processing (1)
  • src/main/java/com/iemr/common/utils/CookieUtil.java (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
src/main/java/com/iemr/common/utils/CookieUtil.java (1)
Learnt from: sandipkarmakar3
PR: PSMRI/Common-API#162
File: src/main/java/com/iemr/common/utils/CookieUtil.java:52-66
Timestamp: 2025-02-21T07:43:03.828Z
Learning: In the Common-API project's CookieUtil class, the current implementation of addJwtTokenToCookie using both response.addCookie() and manual Set-Cookie header has been tested and confirmed to work as required for their use case. URL encoding of the JWT token is not necessary.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: style-check / checkstyle
  • GitHub Check: Analyze (java)
  • GitHub Check: Build
  • GitHub Check: Package-test
πŸ”‡ Additional comments (1)
src/main/java/com/iemr/common/utils/CookieUtil.java (1)

64-66: Good defensive programming approach.

Adding this null check for request cookies prevents potential NullPointerExceptions when iterating through cookies that don't exist. This is a positive change that improves code robustness.

Copy link

@drtechie drtechie merged commit 2f8d8a7 into PSMRI:develop Mar 12, 2025
7 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Mar 12, 2025
10 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 23, 2025
10 tasks
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