data-testid attribute for E2E tests - Portfolio cards & Fix for position footer

[juan-langa]

data-testid attribute for E2E tests - Portfolio cards & Fix for position footer

Summary by CodeRabbit

• New Features

  • Added a prop withMobilePanel to the SidebarSection component for enhanced flexibility in rendering.
  • Updated button visibility logic in SidebarSectionFooter to improve user experience based on wallet connection status.

• Bug Fixes

  • Enhanced testability of components by adding data-testid attributes to various elements.

• Refactor

  • Simplified the props structure for SidebarSectionFooter and improved the logic for determining which primary button to display.

[coderabbitai]

Walkthrough

The pull request introduces modifications to three components: PortfolioPositionBlockDetail, SidebarSection, and SidebarSectionFooter. The PortfolioPositionBlockDetail component receives a data-testid attribute for improved testability. The SidebarSection component gains a new prop, withMobilePanel, to control rendering within a mobile panel, while the data-testid attribute is removed from SidebarSectionFooter. Additionally, the logic for determining the primary button in SidebarSectionFooter is refined based on connection status and chain ID.

Changes

File Path	Change Summary
components/portfolio/positions/PortfolioPositionBlockDetail.tsx	Added data-testid="portfolio-position-details" to the Flex component for enhanced testability.
components/sidebar/SidebarSection.tsx	Added withMobilePanel prop (default true) to control rendering in a MobileSidePanel. Removed data-testid from SidebarSectionFooter props.
components/sidebar/SidebarSectionFooter.tsx	Added data-testid to Grid component. Updated useResolvePrimaryButton logic for primary button display based on connection status and chain ID.

Possibly related PRs

• Adding data-testid property to sidebar footer #4032: The addition of a data-testid property to the SidebarSection component is related to the main PR's enhancement of testability through the addition of a data-testid attribute in the PortfolioPositionBlockDetail component.

Suggested reviewers

• marcinciarka
• piekczyk
• piotrwitek

Poem

In the portfolio's nook, where details reside,
A data-testid now helps us abide.
The sidebar's new prop, for mobile it sways,
Making testing much easier in countless ways.
With buttons that change, as connections align,
Our components now sparkle, oh how they shine! 🐇✨

---

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)

components/sidebar/SidebarSectionFooter.tsx (2)

Line range hint 66-93: LGTM: Improved useResolvePrimaryButton function

The changes to the useResolvePrimaryButton function are well-implemented:

1. The added type annotations enhance type safety and readability.
2. The new return structure (resolvedPrimaryButton and blockOthers) provides more context about the button state.
3. The refined logic correctly handles different scenarios based on wallet connection and chain ID.

These improvements contribute to better maintainability and robustness of the component.

Consider adding error handling for unexpected scenarios, such as when requiredChainHexId is undefined but a wallet is connected. This could be done by adding a default case to the conditional logic:

return {
  resolvedPrimaryButton: primaryButton,
  blockOthers: false,
}

---

Line range hint 95-137: LGTM: Improved SidebarSectionFooter component

The changes to the SidebarSectionFooter component are well-implemented:

1. The component now correctly uses the updated useResolvePrimaryButton function.
2. The visibility conditions for buttons and status have been refined, ensuring appropriate display of UI elements.

These improvements enhance the component's logic and contribute to a better user experience.

Consider extracting the visibility condition checks into a separate function to improve readability:

const getVisibilityFlags = (
  primaryButton,
  secondaryButton,
  textButton,
  status,
  blockOthers
) => ({
  isPrimaryButtonVisible: !primaryButton.hidden,
  isSecondaryButtonVisible: secondaryButton !== undefined && !secondaryButton.hidden && !blockOthers,
  isTextButtonVisible: textButton !== undefined && !textButton.hidden && !blockOthers,
  isStatusVisible: status !== undefined && status.length > 0,
});

const {
  isPrimaryButtonVisible,
  isSecondaryButtonVisible,
  isTextButtonVisible,
  isStatusVisible
} = getVisibilityFlags(primaryButton, secondaryButton, textButton, status, blockOthers);

const isFooterVisible =
  isPrimaryButtonVisible || isSecondaryButtonVisible || isTextButtonVisible || isStatusVisible;

This would make the component more modular and easier to maintain.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6df6c2e and 416de22.

📒 Files selected for processing (3)

• components/portfolio/positions/PortfolioPositionBlockDetail.tsx (1 hunks)
• components/sidebar/SidebarSection.tsx (0 hunks)
• components/sidebar/SidebarSectionFooter.tsx (1 hunks)

💤 Files with no reviewable changes (1)

• components/sidebar/SidebarSection.tsx

🧰 Additional context used

🔇 Additional comments (2)

components/portfolio/positions/PortfolioPositionBlockDetail.tsx (1)

35-38: Excellent addition of the data-testid attribute for E2E testing.

The addition of the data-testid attribute to the Flex component enhances the testability of the PortfolioPositionBlockDetail component. This change aligns perfectly with the PR objective of facilitating E2E testing for portfolio cards.

The attribute name "portfolio-position-details" is descriptive and follows a consistent naming convention, which will make it easier for testers to identify and interact with this component in automated tests.

This modification is a best practice for implementing E2E tests and does not affect the component's functionality or rendering.

components/sidebar/SidebarSectionFooter.tsx (1)

128-128: LGTM: Added data-testid attribute for E2E testing

The addition of the data-testid="sidebar-footer" attribute to the Grid component aligns well with the PR objective of introducing data-testid attributes for E2E testing. This change will enhance the testability of the sidebar footer component in automated tests.