Generate sitemap for dynamic deploy url

[bhatia2akshit]

All Submissions:

• Have you followed the guidelines stated in CONTRIBUTING.md file?
• Have you checked to ensure there aren't any other open Pull Requests for the desired changed?

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

New Feature Submission:

• Does your submission pass the tests?
• Have you linted your code locally prior to submission?

Changes To Core Features:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your core changes, as applicable?
• Have you successfully ran tests with your changes locally?

After these steps, you're ready to open a pull request.

a. Give a descriptive title to your PR.

b. Describe your changes.

c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

[masenf]

This is pretty cool, a couple of suggestions,

• the implementation should be outside of app.py and imported from there
• consider generating the sitemap.xml during compile time and place the resulting file in the frontend assets to avoid having to generate xml for each request, when the content is unlikely to have changed.

[benedikt-bartscher]

• consider generating the sitemap.xml during compile time and place the resulting file in the frontend assets to avoid having to generate xml for each request, when the content is unlikely to have changed.

There is a plan to introduce dynamic sitemaps, f.e. for a blog. This would require to implement 2 different approaches, one for static sitemap and one for dynamic sitemap. We could f.e. try to auto-detect if dynamic features are used or add a config option for that.

[bhatia2akshit]

@masenf running it before compile time would mean that backend must replace deploy url if its different from the ones in sitemap. I would think the better approach would be to run the sitemap generation when the app is deployed for the first time on the server. This would allow the same image to be deployed in different servers with unique sitemaps.

@benedikt-bartscher for dynamic routing thing, what i am thinking for the moment is that for each endpoint that accepts dynamic route, the sitemap generation for that route must be called.
With masenf's recommendation to have sitemap stored in an xml file, the sitemap for the dynamic route will be appended to this xml. the only problem with this approach is that the sitemap for a particular dynamic route is only available if the page was requested by the user.

what do you say?

[bhatia2akshit]

@masenf I have made changes as per your suggestions

1. shifted sitemap generating methods into a separate file.
2. added sitemap generation when the app is deployed on the server based on the deploy url. When a user request sitemaps, it checks if the sitemap exist in the static folder under .web directory. If not, new sitemaps are generated otherwise existing is served.

[codspeed-hq]

CodSpeed Performance Report

Merging #4923 will not alter performance

_{Comparing bhatia2akshit:generate-sitemap-new (72fbe26) with main (5c8104f)}

Summary

✅ 12 untouched benchmarks