Fix: Ensure unique keys for comments in ResourceCommentSection

[Prayag-09]

Proposed Changes

Fixed the unique key prop issue in ResourceCommentSection.tsx

• Fixes Markdown Parsing Error & Error Boundary Failure During Rendering #11121

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

• Add specs that demonstrate bug / test a new feature.
• Update product documentation.
• Ensure that UI text is kept in I18n files.
• Prep screenshot or demo video for changelog entry, and attach it to issue.
• Request for Peer Reviews
• Completion of QA in Mobile Devices
• Completion of QA in Desktop Devices

Summary by CodeRabbit

• Bug Fixes

  • Enhanced the comment display to provide more reliable and consistent rendering, reducing potential display issues.

• Style

  • Refined formatting for improved clarity and maintainability.

[coderabbitai]

Walkthrough

This pull request updates the ResourceCommentSection component. The key for each comment is now determined by using comment.id with a fallback to the comment’s index if the ID is unavailable. In addition, the code formatting has been improved by placing the .reverse() and .map() calls on separate lines for enhanced readability. No changes have been made to the exported or public API.

Changes

File	Change Summary
src/components/Resource/ResourceCommentSection.tsx	Updated the list key assignment to use comment.id with a fallback to index; improved formatting by separating the .reverse() and .map() calls for clarity.

Possibly related PRs

• Show new line in comments #10004: Involved similar updates to the CommentSection component pertaining to how comments are rendered.
• Enhance Comment Section UI with Redesigned User Icon and Styling #10458: Addressed changes in the rendering and UI of the comment components, aligning closely with the key assignment modifications.

Suggested labels

needs review, tested

Suggested reviewers

• Jacobjeevan
• rithviknishad

Poem

I'm a little rabbit, hopping by your side,
Scanning lines of code where secrets reside.
A new key mechanism makes comments feel right,
With indexes to guide them, gleaming in the light.
Celebrate this change, let the bugs take a flight! 🐇
Happy code hopping under the moonlit byte!

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

[netlify]

✅ Deploy Preview for care-ohc ready!

Name	Link
🔨 Latest commit	83aedab
🔍 Latest deploy log	https://app.netlify.com/sites/care-ohc/deploys/67cb33ea5464410008fa42a0
😎 Deploy Preview	https://deploy-preview-11125.preview.ohc.network
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/components/Resource/ResourceCommentSection.tsx (1)

97-103: Improved key management in the comment list.

The change to use comment.id || index as a key is a good fix that ensures each item in the list has a unique identifier, even when a comment might not have an ID. This addresses potential React reconciliation issues and follows best practices for rendering lists.

The code formatting improvements (breaking the method chain into separate lines) also enhance readability.

Consider adding a warning log when comment.id is undefined, as this might indicate an upstream data issue that should be addressed:

 {resourceComments?.results
   ? [...resourceComments.results]
       .reverse()
       .map((comment, index) => (
-        <li key={comment.id || index} className="w-full">
+        <li key={comment.id || index} className="w-full">
+          {!comment.id && console.warn('Comment missing ID, using index as fallback key', comment)}
           <Comment {...comment} />
         </li>
       ))
   : null}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad7ca8 and 83aedab.

📒 Files selected for processing (1)

• src/components/Resource/ResourceCommentSection.tsx (1 hunks)

[Jacobjeevan]

🤔 What exactly is this addressing? It shouldn't be causing issues since comments will always have a unique Id.

[Prayag-09]

This ensures that if at any point comment.id is null or undefined it will fallback to another unique key called index rather than using undefined, which could cause rendering issues in React.