Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: optimize Banner Performance with Lazy Loading #3351

Closed

Conversation

Manancode
Copy link

@Manancode Manancode commented Oct 30, 2024

Optimizes banner rendering performance to improve the Lighthouse score by implementing lazy loading for inactive banners. Only renders the active banner and immediate neighbors instead of all banners at once.

Before:

  • All banners were rendered simultaneously

After:

  • Only active banner and neighbors are rendered

Changes:

  • Modified banner rendering logic in AnnouncementHero.tsx to conditionally render only necessary banners

solves this issue

Summary by CodeRabbit

  • New Features

    • Enhanced banner display logic to show only the active banner and its immediate neighbors, improving performance and user experience.
  • Bug Fixes

    • Optimized rendering process to ensure only relevant banners are displayed, reducing clutter.

Copy link

coderabbitai bot commented Oct 30, 2024

Walkthrough

The AnnouncementHero component in components/campaigns/AnnouncementHero.tsx has been updated to optimize banner rendering. The new implementation restricts the display to only the active banner and its immediate neighbors, improving performance by reducing the number of rendered elements. This is achieved through a visibility check based on the active index. The component's overall structure, props, and state management remain unchanged, while user interaction features continue to function as before.

Changes

File Change Summary
components/campaigns/AnnouncementHero.tsx Modified rendering logic to display only the active banner and its immediate neighbors based on visibility conditions. Updated mapping of visibleBanners to include visibility checks.

Possibly related issues

Possibly related PRs

Suggested labels

ready-to-merge, bounty

Suggested reviewers

  • derberg
  • magicmatatjahu
  • sambhavgupta0705
  • anshgoyalevil
  • Mayaleeeee
  • asyncapi-bot-eve

Poem

🐇 In the land of banners bright,
Only the best now take flight.
Neighbors close, the rest in shade,
A swift display, no time to fade.
With every click, the joy we find,
A hopping good time, perfectly aligned! 🌟


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

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 04bc9a0
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67320e29768063000838979a
😎 Deploy Preview https://deploy-preview-3351--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 30, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 45
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3351--asyncapi-website.netlify.app/

@Manancode Manancode changed the title feat : optimize Banner Performance with Lazy Loading feat: optimize Banner Performance with Lazy Loading Oct 30, 2024
Copy link

@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: 2

🧹 Outside diff range and nitpick comments (1)
components/campaigns/AnnouncementHero.tsx (1)

Line range hint 65-84: Consider additional performance optimizations

While the lazy loading implementation reduces DOM nodes, the Lighthouse score indicates room for improvement. Consider these additional optimizations:

  1. Implement virtual scrolling or windowing using a library like react-window
  2. Add will-change CSS property to optimize animations
  3. Use CSS transform instead of DOM manipulation for transitions

Would you like me to provide example implementations for any of these suggestions?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2148afb and 89a3ea7.

📒 Files selected for processing (1)
  • components/campaigns/AnnouncementHero.tsx (2 hunks)
🧰 Additional context used
🪛 eslint
components/campaigns/AnnouncementHero.tsx

[error] 84-84: Insert ····

(prettier/prettier)

🔇 Additional comments (1)
components/campaigns/AnnouncementHero.tsx (1)

Line range hint 65-84: Verify performance impact with React DevTools

The current implementation might still cause unnecessary re-renders of hidden banners.

Let's analyze the component's render behavior:

Consider wrapping the Banner component with React.memo to prevent unnecessary re-renders:

const MemoizedBanner = React.memo(Banner);

components/campaigns/AnnouncementHero.tsx Outdated Show resolved Hide resolved
Comment on lines 66 to 68
// Only render active banner and immediate neighbors
const isVisible = Math.abs(index - (activeIndex % numberOfVisibleBanners)) <= 1;
if (!isVisible) return null;
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve code readability with a dedicated visibility check function

The visibility calculation logic could be more maintainable and self-documenting.

Consider extracting the visibility logic:

+ const isBannerVisible = (index: number, activeIndex: number, total: number) => {
+   const normalizedIndex = activeIndex % total;
+   return Math.abs(index - normalizedIndex) <= 1;
+ };

  {visibleBanners.map((banner, index) => {
-   const isVisible = Math.abs(index - (activeIndex % numberOfVisibleBanners)) <= 1;
+   const isVisible = isBannerVisible(index, activeIndex, numberOfVisibleBanners);
    if (!isVisible) return null;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Only render active banner and immediate neighbors
const isVisible = Math.abs(index - (activeIndex % numberOfVisibleBanners)) <= 1;
if (!isVisible) return null;
const isBannerVisible = (index: number, activeIndex: number, total: number) => {
const normalizedIndex = activeIndex % total;
return Math.abs(index - normalizedIndex) <= 1;
};
// Only render active banner and immediate neighbors
const isVisible = isBannerVisible(index, activeIndex, numberOfVisibleBanners);
if (!isVisible) return null;

@Manancode Manancode force-pushed the optimize-banner-performance branch from 89a3ea7 to 98e6c72 Compare October 30, 2024 23:12
Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (9291da3) to head (04bc9a0).
Report is 39 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3351   +/-   ##
=======================================
  Coverage   67.77%   67.77%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          450      450           
  Misses        214      214           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@anshgoyalevil
Copy link
Member

The banner isn't visible altogether. Check out the netlify deploy above.

@sambhavgupta0705
Copy link
Member

closing this as no update from the contributor

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.

4 participants