Skip to content

Fix: Duplicate React Keys in Bulk Unsubscribe Component and Hydration Errors#430

Merged
elie222 merged 2 commits intoelie222:mainfrom
Swastik19Nit:fix/ui-rendering-hydration-errors
May 11, 2025
Merged

Fix: Duplicate React Keys in Bulk Unsubscribe Component and Hydration Errors#430
elie222 merged 2 commits intoelie222:mainfrom
Swastik19Nit:fix/ui-rendering-hydration-errors

Conversation

@Swastik19Nit
Copy link
Contributor

@Swastik19Nit Swastik19Nit commented May 10, 2025

✅ Solutions (Fixes #429 )

💡 Implementation

1. Robust Key Generation

To resolve the key duplication issue:

- const unsortedTableRows = rows?.map((item) => {
+ const unsortedTableRows = rows?.map((item, index) => {
    // ...
-   const row = <RowComponent key={item.name} ... />
+   const uniqueKey = `${item.name}-${item.value}-${item.inboxEmails}-${item.readEmails}-${index}`;
+   const row = <RowComponent key={uniqueKey} ... />

2. Fixed Nested Paragraph Structure

Removed the outer paragraph element that was causing invalid nesting:

extraDescription={
  <div className="mt-4 text-left">
-   <p>
    <SectionDescription>We label your emails with:</SectionDescription>
-   </p>
    <SectionDescription>
      <Badge color="green">{NEEDS_REPLY_LABEL_NAME}</Badge> - emails you
      need to reply to.
    </SectionDescription>
    // ...
  </div>
}

3. Proper Table Structure

Replaced div with appropriate table elements:

<LoadingContent loading={isLoading} error={error}>
  {data && (
-   <div>
-     {data.messages.map((message) => {
-       return (
+   <Table>
+     <TableBody>
+       {data.messages.map((message) => (
          <TestRulesContentRow
            key={message.id}
            message={message}
            userEmail={userEmail}
          />
-       );
-     })}
-   </div>
+       ))}
+     </TableBody>
+   </Table>
  )}
</LoadingContent>

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Improved uniqueness of row keys in the bulk unsubscribe section for more reliable rendering.
    • Updated message display in the cold email blocker test rules to use a semantic table structure for better accessibility and markup consistency.
    • Simplified the layout in the reply tracker enablement section by removing unnecessary wrapper elements.

@vercel
Copy link

vercel bot commented May 10, 2025

@Swastik19Nit is attempting to deploy a commit to the Inbox Zero Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented May 10, 2025

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 10, 2025

Walkthrough

The changes update UI components in three files. The BulkUnsubscribeSection now uses a composite key for row components to ensure uniqueness. The TestRules component replaces a generic div with semantic table elements for better structure. The EnableReplyTracker component removes an unnecessary paragraph wrapper, simplifying the JSX markup.

Changes

File(s) Change Summary
.../bulk-unsubscribe/BulkUnsubscribeSection.tsx Changed row key from item.name to a composite key using multiple item properties and index.
.../cold-email-blocker/TestRules.tsx Replaced a div wrapper with semantic <Table> and <TableBody> components for message rows.
.../reply-zero/EnableReplyTracker.tsx Removed an unnecessary <p> wrapper around the <SectionDescription> component.

Assessment against linked issues

Objective Addressed Explanation
Fix duplicate React keys in Bulk Unsubscribe component to prevent rendering issues (#429)
Remove nested <p> tags in EnableReplyTracker to avoid hydration errors (#429)
Correct invalid table structure in Cold Email Blocker by wrapping rows in <TableBody> (#429)

Poem

A bunny hopped through lines of code,
With keys unique, the rows now glowed.
Tables set for messages neat,
Extra wrappers faced defeat.
Hopping on, the JSX is clean—
The tidiest UI you’ve ever seen!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/app/(app)/[emailAccountId]/bulk-unsubscribe/BulkUnsubscribeSection.tsx

Oops! Something went wrong! :(

ESLint: 9.24.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 de31362 and a62e25c.

📒 Files selected for processing (1)
  • apps/web/app/(app)/[emailAccountId]/bulk-unsubscribe/BulkUnsubscribeSection.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/web/app/(app)/[emailAccountId]/bulk-unsubscribe/BulkUnsubscribeSection.tsx
✨ 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
🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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
Owner

Choose a reason for hiding this comment

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

might as well just use index if we're doing this, no?

also, why isn't item.name unique here? when does it happen that we have the same item.name twice?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the second part that why isn't item.name unique? When does it happen that we have duplicate names, the item.name represents the email sender (e.g., "noreply@google.com"). It's not unique because many services send different types of newsletters from the same email address and services like Google can send various types of emails (notifications, security alerts, promotions) all from "noreply@google.com".

For the first part we can use index but while using just index as the key would technically solve the duplicate key issue, it's not the best practice for React keys. In the official documentation it is written that "You might be tempted to use an item’s index in the array as its key. In fact, that’s what React will use if you don’t specify a key at all. But the order in which you render items will change over time if an item is inserted, deleted, or if the array gets reordered. Index as a key often leads to subtle and confusing bugs".

But we can change the key to just use the index if that's preferred. I will do that if you want to!!! @elie222 .

@elie222
Copy link
Owner

elie222 commented May 11, 2025

happy to accept the pr other than the index issue

@Swastik19Nit
Copy link
Contributor Author

happy to accept the pr other than the index issue

Sir if needed I can revert back to the original indexing code). But I guess it still needs some changes too. @elie222

@Swastik19Nit
Copy link
Contributor Author

happy to accept the pr other than the index issue

@elie222 Hi Sir,
Thanks! I've undone the changes in the index!! Kindly look sir. Thanks

@elie222 elie222 merged commit 600264b into elie222:main May 11, 2025
2 of 3 checks passed
@elie222
Copy link
Owner

elie222 commented May 11, 2025

Thanks!

@elie222
Copy link
Owner

elie222 commented May 11, 2025

happy to accept the pr other than the index issue

Sir if needed I can revert back to the original indexing code). But I guess it still needs some changes too. @elie222

you can probably just do key={index}. im not sure there was any benefit to the complex key you had which anyway included index.

For the second part that why isn't item.name unique? When does it happen that we have duplicate names, the item.name represents the email sender (e.g., "noreply@google.com"). It's not unique because many services send different types of newsletters from the same email address and services like Google can send various types of emails (notifications, security alerts, promotions) all from "noreply@google.com".

can you send a screenshot of what you're seeing. because these should be grouped on the bulk unsubscribe page. since it's the same sender (we used to care about sender name, but now it should just be based on email address)

@Swastik19Nit
Copy link
Contributor Author

Swastik19Nit commented May 12, 2025

happy to accept the pr other than the index issue

Sir if needed I can revert back to the original indexing code). But I guess it still needs some changes too. @elie222

you can probably just do key={index}. im not sure there was any benefit to the complex key you had which anyway included index.

For the second part that why isn't item.name unique? When does it happen that we have duplicate names, the item.name represents the email sender (e.g., "noreply@google.com"). It's not unique because many services send different types of newsletters from the same email address and services like Google can send various types of emails (notifications, security alerts, promotions) all from "noreply@google.com".

can you send a screenshot of what you're seeing. because these should be grouped on the bulk unsubscribe page. since it's the same sender (we used to care about sender name, but now it should just be based on email address)

I saw this error
Image
@elie222

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.

Duplicate React Keys in Bulk Unsubscribe Component and Hydration Errors

3 participants

Comments