feat: added test for build-rss.js

[vishvamsinh28]

This PR adds test for build-rss.js script

Summary by CodeRabbit

• New Features

  • Enhanced error handling for RSS feed generation, ensuring more robust performance.
  • Added comprehensive unit tests for the RSS feed functionality, covering various scenarios and edge cases.
  • Introduced mock data structures for testing RSS feed generation.
  • Asynchronous processing of RSS feed generation to improve performance and reliability.
  • Prioritized featured posts in the generated RSS feed.

• Bug Fixes

  • Improved handling of missing fields and date attributes in posts, preventing errors during RSS feed generation.
  • Ensured that posts without dates are filtered out before sorting.

[netlify[bot]]

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	08c88aead14372584f93823b20a95a7962f25443
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/672f06f6edbe58000863f592
😎 Deploy Preview	https://deploy-preview-3101--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle 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]

⚡️ Lighthouse report for the changes in this PR:

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

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

[anshgoyalevil]

@vishvamsinh28 Statement and branch coverage aren't 100% for this file.

[vishvamsinh28]

@anshgoyalevil updated the test, now it has 98.33% coverage. I will push another change to make it 100%

[anshgoyalevil]

There's still room for improvement, @vishvamsinh28

[vishvamsinh28]

@anshgoyalevil Updated the tests

[vishvamsinh28]

@akshatnema @anshgoyalevil Updated the test

[vishvamsinh28]

@anshgoyalevil Any review for this PR ?

[coderabbitai[bot]]

Walkthrough

The changes enhance the rssFeed function in scripts/build-rss.js by converting it to an asynchronous function that utilizes Promises for file operations. The function now includes improved error handling, checks for required fields in post data, and filters out posts without dates. Additionally, a comprehensive test suite in tests/build-rss.test.js is introduced to validate the functionality of rssFeed through various scenarios, ensuring thorough coverage of expected behaviors and edge cases.

Changes

File	Change Summary
scripts/build-rss.js	Updated rssFeed function to be asynchronous, added error handling for missing fields, filtered out posts without dates, prioritized featured posts, and encapsulated RSS object initialization and file writing within the Promise.
tests/build-rss.test.js	Introduced a comprehensive unit test suite for rssFeed, covering scenarios such as feed generation, post prioritization, sorting, handling empty posts, and error handling for missing required fields.
tests/fixtures/rssData.js	Added functions createMockPost and createMockData for generating mock blog post data for testing, allowing for controlled testing scenarios without relying on actual file contents.
package.json	Added new dependency "fast-xml-parser": "^4.5.0" to enhance XML parsing functionality.

Possibly related PRs

• #3344: The changes in this PR introduce tests for the build-dashboard.js script, which is relevant as it also involves asynchronous file operations similar to the updates made to the rssFeed function in the main PR.

Suggested labels

ready-to-merge

Suggested reviewers

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

Poem

In the meadow where the data flows,
A rabbit hops where the RSS grows.
With promises wrapped in a cozy embrace,
Errors caught, we quicken the pace.
Mocking the posts, we test with delight,
A feed full of wonders, all shining bright! 🐇✨

---

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.

[akshatnema]

@coderabbitai full review

[coderabbitai[bot]]

:white_check_mark: Actions performed

Full review triggered.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.77%. Comparing base (79b2491) to head (08c88ae). Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3101      +/-   ##
==========================================
+ Coverage   59.01%   67.77%   +8.75%     
==========================================
  Files          21       21              
  Lines         649      664      +15     
==========================================
+ Hits          383      450      +67     
+ Misses        266      214      -52     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[akshatnema]

@vishvamsinh28 Can we apply above suggestions of reject and resolves for rssFeed function?

[vishvamsinh28]

@akshatnema test updated

[akshatnema]

@coderabbitai resolve

[coderabbitai[bot]]

:white_check_mark: Actions performed

Comments resolved.

[akshatnema]

@coderabbitai full review

[coderabbitai[bot]]

:white_check_mark: Actions performed

Full review triggered.

[akshatnema]

@coderabbitai review

[coderabbitai[bot]]

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[akshatnema]

/rtm