devops: run lhci on bot and user landings

[gaboesquivel]

Summary by CodeRabbit

• New Features
  • Expanded Lighthouse checks to include additional URLs for comprehensive performance analysis.
• Refactor
  • Improved the Lighthouse report script for detailed performance insights on multiple pages.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
masterbots	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2024 7:49am

[github-actions]

Running Lighthouse audit...

[coderabbitai]

Walkthrough

This update enhances the Lighthouse CI workflow by expanding its scope to include additional URLs for performance review. It introduces a smarter approach to handling the analysis of multiple pages, where the script now iterates over each page, gathering performance metrics to create a comprehensive, page-specific report. This change ensures a more detailed and insightful overview of the site's performance, aiding in pinpointing areas for improvement.

Changes

File Path	Change Summary
.github/workflows/.../lighthouse.yml	Added more URLs for Lighthouse checks; refactored to iterate over pages and generate detailed comments per page based on performance scores.

🐇✨
In the digital garden, where the web does bloom,
A rabbit hopped in, with a task to groom.
"Let's check these pages," it said with a cheer,
"For performance and speed, to make things clear."
With a hop and a skip, it went through the site,
Leaving reports in its wake, shining so bright.
"Now all can see, where improvements can be made,"
The rabbit concluded, as the sunlight started to fade.
🌟📄

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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/coderabbit-overrides.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: 2

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 15179c2 and 22ee038.

Files selected for processing (1)

• .github/workflows/lighthouse.yml (2 hunks)

[coderabbitai]

Consider parameterizing the URL paths to enhance maintainability.

-            "https://${{ steps.vercel_preview_url.outputs.preview_url }}/b/moneybot"
-            "https://${{ steps.vercel_preview_url.outputs.preview_url }}/u/slug-1"
-            "https://${{ steps.vercel_preview_url.outputs.preview_url }}/p"
+            ${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'b/moneybot') }}
+            ${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'u/slug-1') }}
+            ${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'p') }}

Parameterizing the paths can simplify future updates to the URLs and make the workflow file cleaner and more readable.

---

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.

Suggested change

	"https://${{ steps.vercel_preview_url.outputs.preview_url }}/b/moneybot"
	"https://${{ steps.vercel_preview_url.outputs.preview_url }}/u/slug-1"
	"https://${{ steps.vercel_preview_url.outputs.preview_url }}/p"
	${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'b/moneybot') }}
	${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'u/slug-1') }}
	${{ format('https://{{ steps.vercel_preview_url.outputs.preview_url }}/{0}', 'p') }}

[coderabbitai]

Ensure error handling for the Lighthouse audit results.

+            if (!manifest || Object.keys(manifest).length === 0) {
+              core.setFailed('Lighthouse audit did not generate any results.');
+              return;
+            }

Adding error handling ensures that the workflow fails gracefully if the Lighthouse audit does not generate any results, providing clearer feedback to the developers.

---

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.

Suggested change

	const manifest = ${{ toJSON(steps.lighthouse_audit.outputs.manifest) }};
	const links = ${{ toJSON(steps.lighthouse_audit.outputs.links) }};
	const formatResult = (res) => Math.round((res * 100))
	Object.keys(result).forEach(key => result[key] = formatResult(result[key]))
	const formatResult = (res) => Math.round((res * 100));
	const score = (res) => (res >= 90 ? '🟢' : res >= 50 ? '🟠' : '🔴');
	const score = res => res >= 90 ? '🟢' : res >= 50 ? '🟠' : '🔴'
	let comment = `⚡️ [Lighthouse report](${Object.values(links)[0]}) for the changes in this PR:\n`;
	comment += '| Category | Score |\n';
	comment += '| --- | --- |\n';
	const comment = [
	`⚡️ [Lighthouse report](${Object.values(links)[0]}) for the changes in this PR:`,
	'| Category | Score |',
	'| --- | --- |',
	`| ${score(result.performance)} Performance | ${result.performance} |`,
	`| ${score(result.accessibility)} Accessibility | ${result.accessibility} |`,
	`| ${score(result['best-practices'])} Best practices | ${result['best-practices']} |`,
	`| ${score(result.seo)} SEO | ${result.seo} |`,
	`| ${score(result.pwa)} PWA | ${result.pwa} |`,
	' ',
	`*Lighthouse ran on [${Object.keys(links)[0]}](${Object.keys(links)[0]})*`
	].join('\n')
	Object.keys(manifest).forEach((page) => {
	const result = manifest[page].summary;
	const pageLink = manifest[page].url;
	Object.keys(result).forEach((key) => {
	const formattedScore = formatResult(result[key]);
	comment += `| ${score(result[key])} ${key} | ${formattedScore} |\n`;
	});
	comment += `*Lighthouse ran on [${pageLink}](${pageLink})*\n\n`;
	});
	core.setOutput("comment", comment);
	core.setOutput('comment', comment);
	const manifest = ${{ toJSON(steps.lighthouse_audit.outputs.manifest) }};
	const links = ${{ toJSON(steps.lighthouse_audit.outputs.links) }};
	if (!manifest || Object.keys(manifest).length === 0) {
	core.setFailed('Lighthouse audit did not generate any results.');
	return;
	}
	const formatResult = (res) => Math.round((res * 100));
	const score = (res) => (res >= 90 ? '🟢' : res >= 50 ? '🟠' : '🔴');
	let comment = `⚡️ [Lighthouse report](${Object.values(links)[0]}) for the changes in this PR:\n`;
	comment += '| Category | Score |\n';
	comment += '| --- | --- |\n';
	Object.keys(manifest).forEach((page) => {
	const result = manifest[page].summary;
	const pageLink = manifest[page].url;
	Object.keys(result).forEach((key) => {
	const formattedScore = formatResult(result[key]);
	comment += `| ${score(result[key])} ${key} | ${formattedScore} |\n`;
	});
	comment += `*Lighthouse ran on [${pageLink}](${pageLink})*\n\n`;
	});
	core.setOutput('comment', comment);