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 rendering performance to improve Lighthouse score fixes 3335 #3519

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

IITI-tushar
Copy link

@IITI-tushar IITI-tushar commented Dec 28, 2024

Description
updated AnnouncementHero.tsx based on code-rabbit suggestions in comment #3312 (comment)

**Related issue(s)**Resolves #3335

Summary by CodeRabbit

  • Performance Improvements
    • Optimized banner rendering in the AnnouncementHero component
    • Reduced the number of simultaneously rendered banners
    • Improved rendering efficiency by displaying only active and adjacent banners

Copy link

coderabbitai bot commented Dec 28, 2024

Walkthrough

The pull request focuses on optimizing the AnnouncementHero component's rendering performance. The key change involves modifying the banner rendering logic to only display the active banner and its immediate neighboring banners. This approach reduces the number of components rendered simultaneously, potentially improving the component's performance.

Changes

File Change Summary
components/campaigns/AnnouncementHero.tsx Implemented selective banner rendering based on active index, limiting display to active banner and immediate neighbors

Assessment against linked issues

Objective Addressed Explanation
Optimize banner rendering performance [#3335]

Suggested Labels

ready-to-merge

Suggested Reviewers

  • derberg
  • magicmatatjahu
  • devilkiller-ag
  • akshatnema
  • sambhavgupta0705
  • Mayaleeeee

Poem

🐰 Banners dance, but not all at once,
Performance leaps with each smart bounce!
Active hero takes the stage,
Neighbors peek from render's cage.
Lighthouse smiles, the code's now bright! 🚀


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e7a052 and 7f075ec.

📒 Files selected for processing (1)
  • components/campaigns/AnnouncementHero.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/campaigns/AnnouncementHero.tsx

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

netlify bot commented Dec 28, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 63b154c
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/676f935e1fda160008898bed
😎 Deploy Preview https://deploy-preview-3519--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 Dec 28, 2024

⚡️ Lighthouse report for the changes in this PR:

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

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

Copy link

netlify bot commented Dec 28, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7f075ec
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/676f9a21e72e3e000804a514
😎 Deploy Preview https://deploy-preview-3519--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.

@IITI-tushar IITI-tushar changed the title updated AnnouncementHero.tsx feat: Optimize banner rendering performance to improve Lighthouse score Dec 28, 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: 0

🧹 Nitpick comments (2)
components/campaigns/AnnouncementHero.tsx (2)

67-68: Address linting requirement for spacing
ESLint flags these lines for missing blank lines after variable declarations. Consider adding a blank line after declaring isVisible.

const isVisible =
  Math.abs(index - (activeIndex % numberOfVisibleBanners)) <= 1;

+ // Add a blank line here
if (!isVisible) return null;
🧰 Tools
🪛 eslint

[error] 67-68: Expected blank line after variable declarations.

(newline-after-var)


[error] 67-68: Delete ⏎···············

(prettier/prettier)


92-94: Minor lint / formatting suggestion
ESLint highlights spacing issues around the ternary expression. Consider removing unnecessary newlines or bracket spacing for consistency.

className={`mx-1 size-2 cursor-pointer rounded-full ${
-  activeIndex % numberOfVisibleBanners === index
-    ? 'bg-primary-500'
-    : 'bg-gray-300'
+  (activeIndex % numberOfVisibleBanners === index
+    ? 'bg-primary-500'
+    : 'bg-gray-300')
}`}
🧰 Tools
🪛 eslint

[error] 92-94: Replace ⏎····················?·'bg-primary-500'⏎··················· with ·?·'bg-primary-500'

(prettier/prettier)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 160a462 and 7e7a052.

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

[error] 67-68: Expected blank line after variable declarations.

(newline-after-var)


[error] 67-68: Delete ⏎···············

(prettier/prettier)


[error] 69-69: Expected blank line before this statement.

(padding-line-between-statements)


[error] 70-84: Expected blank line before this statement.

(padding-line-between-statements)


[error] 92-94: Replace ⏎····················?·'bg-primary-500'⏎··················· with ·?·'bg-primary-500'

(prettier/prettier)

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

65-69: Good approach for reducing render overhead by limiting displayed banners
Only rendering the active banner and its immediate neighbors is an efficient way to reduce unnecessary render operations and improve performance, especially when there are many banners.

🧰 Tools
🪛 eslint

[error] 67-68: Expected blank line after variable declarations.

(newline-after-var)


[error] 67-68: Delete ⏎···············

(prettier/prettier)


[error] 69-69: Expected blank line before this statement.

(padding-line-between-statements)


70-84: Banner rendering structure
The conditional return for invisible banners is clear, but ensure that the banner’s parent container handles layout gracefully if no items are rendered concurrently in certain edge cases (e.g., when numberOfVisibleBanners is 2 or fewer).

🧰 Tools
🪛 eslint

[error] 70-84: Expected blank line before this statement.

(padding-line-between-statements)

@IITI-tushar IITI-tushar changed the title feat: Optimize banner rendering performance to improve Lighthouse score feat: optimize banner rendering performance to improve Lighthouse score fixes 3335 Dec 28, 2024
Copy link

codecov bot commented Dec 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (160a462) to head (7f075ec).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3519   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines          668       668           
=========================================
  Hits           668       668           

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

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.

Optimize banner rendering performance to improve Lighthouse score
2 participants