Add products.xml to sitemap of Boilerplate (#9742)

[msynk]

closes #9742

Summary by CodeRabbit

• New Features

  • Updated sitemap configuration to support a sitemap index
  • Added support for generating a products XML sitemap
  • Enhanced service worker to handle product XML requests

• Improvements

  • Expanded middleware to serve multiple sitemap resources
  • Improved web crawler discoverability of site content

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces enhancements to the sitemap configuration in a boilerplate web application. The changes involve updating the robots.txt file to reference a new sitemap_index.xml, modifying the service worker to handle /products.xml requests, and expanding the server-side middleware to generate a comprehensive sitemap that includes both the main sitemap and a new products-specific sitemap.

Changes

File	Change Summary
src/Templates/Boilerplate/.../robots.txt	Updated sitemap URL from sitemap.xml to sitemap_index.xml
src/Templates/Boilerplate/.../service-worker.published.js	Added regex pattern to handle /products.xml requests
src/Templates/Boilerplate/.../Program.Middlewares.cs	Added endpoints for sitemap_index.xml and products.xml, implemented sitemap generation logic

Assessment against linked issues

Objective	Addressed	Explanation
Add products.xml to sitemap [#9742]	✅

Poem

🐰 A rabbit's tale of sitemaps so bright,
XML paths now gleaming with delight!
Products and pages, indexed with care,
Crawlers will dance without a single scare! 🕷️
Boilerplate magic, code hopping free! 🌟

---

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

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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9627d92 and fff55bf.

📒 Files selected for processing (3)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/robots.txt (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/robots.txt

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (3)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js (1)

55-55: LGTM! Verify server-side handling.

The addition of /products.xml pattern to serverHandledUrls is correct and aligns with the PR objective. This ensures that requests to products.xml are handled by the server rather than the service worker cache.

Let's verify that the server-side handling for /products.xml is properly implemented:

✅ Verification successful

Server-side handling for products.xml is properly implemented

The endpoint is correctly configured with:

• Integration in sitemap_index.xml
• Proper XML generation for product URLs
• Efficient 7-day caching policy
• Correct content type headers

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if server-side handling for products.xml is implemented
# Expected: Find middleware or endpoint handling for products.xml

# Search for products.xml handling in Program.cs, Startup.cs, or middleware files
rg -l "products\.xml" --type cs

# Search for any route mappings or middleware configurations
ast-grep --pattern 'app.Map("/products.xml", $_)'
ast-grep --pattern 'app.UseMiddleware<$_>("products.xml")'

Length of output: 477

---

Script:

#!/bin/bash
# Examine the middleware implementation
rg -A 10 -B 10 "products\.xml" "src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs"

Length of output: 2216

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs (2)

12-12: LGTM!

The new using directive is correctly placed and necessary for the Products controller integration.

---

179-243: Verify sitemap structure and accessibility.

Let's verify the sitemap implementation and ensure all URLs are accessible.