Feat/Cron job for sitemap generating on FE

[kkatusic]

• Create Sitemap for Better SEO giveth-dapps-v2#915

Summary by CodeRabbit

• New Features

  • Added a scheduled cron job to automatically generate a sitemap for the frontend every Sunday at midnight
  • Implemented secure sitemap generation with environment-based authentication

• Chores

  • Enhanced backend infrastructure to support automated sitemap updates

[coderabbitai]

Walkthrough

A new cron job functionality has been implemented to generate sitemaps on the frontend. The changes involve adding a new service in the generateSitemapOnFrontend.ts file that schedules a sitemap generation job to run every Sunday at midnight. The job sends a GET request to the frontend's sitemap generation API endpoint, using an environment-based secret for authorization. The bootstrap process has been updated to integrate this new cron job into the existing job initialization framework.

Changes

File	Change Summary
src/server/bootstrap.ts	Added import and integration of runGenerateSitemapOnFrontend function into cron job initialization
src/services/cronJobs/generateSitemapOnFrontend.ts	Created new cron job service to generate sitemap on frontend every Sunday at 00:00

Sequence Diagram

sequenceDiagram
    participant Bootstrap as Server Bootstrap
    participant CronJob as Sitemap Cron Job
    participant Frontend as Frontend API

    Bootstrap->>CronJob: Initialize runGenerateSitemapOnFrontend
    CronJob->>Frontend: GET /api/generate-sitemap
    Frontend-->>CronJob: Response
    CronJob->>CronJob: Log job completion

Loading

Poem

🐰 Hop, hop, sitemap's on the way!
Every Sunday, without delay
A rabbit's code, precise and neat
Generating links, a digital treat
Crawlers rejoice, the web's complete! 🌐

---

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

🧹 Nitpick comments (1)

src/server/bootstrap.ts (1)

425-427: Environment variable fallback

While this conditional check is helpful, consider verifying process.env.FRONTEND_URL as well, to prevent possible runtime failures if that variable is missing or invalid.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b930c80 and 829f973.

📒 Files selected for processing (2)

• src/server/bootstrap.ts (2 hunks)
• src/services/cronJobs/generateSitemapOnFrontend.ts (1 hunks)

🔇 Additional comments (2)

src/services/cronJobs/generateSitemapOnFrontend.ts (1)

1-9: Good documentation and scheduling strategy

It's clear from the comment block that this cron job is designed to run every Sunday at 00:00 for generating a sitemap on the frontend. This documentation is helpful for future maintainers.

src/server/bootstrap.ts (1)

73-73: Import is consistent with your new module

Importing runGenerateSitemapOnFrontend here makes sense for integrating the feature.

[CarlosQ96]

Approved!