[WEB-2336] Fix: spreadsheet flicker issue

[gakshita]

Summary
Fixed the flicker issue in spreadsheet layout when the subissue is viewed.

[WEB-2336]

Summary by CodeRabbit

• New Features

  • Enhanced rendering logic for issue rows, allowing dynamic display based on issue status.
  • Introduced an optional property for default rendering behavior of issues.

• Bug Fixes

  • Improved consistency in rendering nested sub-issues.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the SpreadsheetIssueRow component within the issue-row.tsx file. A new hook, useIssues, is introduced to access the issueMap, enabling the determination of whether an issue is new. The Props interface is updated to include an optional shouldRenderByDefault property, affecting the rendering logic of the component and its child instances. State management is also adjusted to utilize the new issueMap, ensuring dynamic behavior based on issue status.

Changes

File Path	Change Summary
web/core/components/issues/issue-layouts/spreadsheet/issue-row.tsx	- Introduced useIssues hook to access issueMap. - Updated Props interface to include shouldRenderByDefault. - Adjusted state management for dynamic rendering based on issue status. - Passed shouldRenderByDefault to child instances for consistent behavior.

Possibly related PRs

• [WEB-1936] fix: flicker issue in issues list layout #5412: Introduces a new optional property, shouldRenderByDefault, to the Props type in the IssueBlockRoot component, related to the same prop in SpreadsheetIssueRow.
• [WEB-2537 ] fix: issue quick action #5692: Updates event handling functions in the RelationIssueListItem component, relevant to the interaction model enhanced in SpreadsheetIssueRow.

Suggested labels

🐛bug, 🌐frontend, ⚡performance

Suggested reviewers

• sriramveeraghanta
• rahulramesha

🐇 In the rows where issues play,
A new hook leads the way.
With props that guide and render bright,
Our spreadsheet's now a joyful sight!
So hop along, let issues flow,
In this code, our changes glow! ✨

---

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

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

web/core/components/issues/issue-layouts/spreadsheet/issue-row.tsx (2)

70-71: LGTM: Enhanced rendering logic with new issue detection

The changes to the component's logic improve its flexibility and consistency:

1. Using issueMap from the useIssues hook allows access to the current state of issues.
2. The RenderIfVisible component now determines default visibility based on whether the issue is new or if shouldRenderByDefault is provided.
3. Passing shouldRenderByDefault to child instances ensures consistent behavior for nested issues.

These changes align well with the PR objectives and the AI summary.

Consider adding a comment explaining the logic behind shouldRenderByDefault || isIssueNew(issueMap[issueId]) for better code maintainability.

Also applies to: 96-96, 133-133

---

Line range hint 1-383: Overall assessment: Changes improve component flexibility and consistency

The modifications to the SpreadsheetIssueRow component and its related code effectively address the PR objectives:

1. The new useIssues hook and isIssueNew utility function enable better handling of issue states.
2. The addition of the shouldRenderByDefault prop provides more control over rendering behavior.
3. The updated logic in RenderIfVisible and prop passing to child components ensures consistent behavior for nested issues.

These changes should contribute to resolving the spreadsheet flicker issue mentioned in the PR objectives. The code is well-structured and the changes are implemented consistently throughout the file.

To further improve the component:

1. Consider adding unit tests to verify the new rendering logic, especially for edge cases involving new issues and nested sub-issues.
2. If this component is used extensively, consider creating a custom hook to encapsulate the issue rendering logic, which could simplify the main component and improve reusability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 39eabc2 and 817c203.

📒 Files selected for processing (1)

• web/core/components/issues/issue-layouts/spreadsheet/issue-row.tsx (5 hunks)

🧰 Additional context used

🔇 Additional comments (4)

web/core/components/issues/issue-layouts/spreadsheet/issue-row.tsx (4)

21-21: LGTM: New hook import for issue data access

The addition of the useIssues hook import is appropriate for accessing the issueMap as mentioned in the AI summary. This change aligns with the new functionality being introduced in the component.

---

29-29: LGTM: Utility function import for new issue detection

The import of the isIssueNew utility function is appropriate for determining if an issue is newly created. This addition supports the new functionality described in the AI summary.

---

46-46: LGTM: New optional prop for default rendering control

The addition of the shouldRenderByDefault optional prop to the Props interface provides more flexibility in controlling the initial rendering of the component. This change is consistent with the updates mentioned in the AI summary.

---

64-64: LGTM: New prop destructured in component

The addition of shouldRenderByDefault to the destructured props in the SpreadsheetIssueRow component is consistent with the update to the Props interface. This change allows the component to utilize the new property for controlling default rendering behavior.