feat: add sitemap generator

app/controllers/content_distribution_controller.ts

@@ -0,0 +1,13 @@
+import { inject } from '@adonisjs/core'
+import { HttpContext } from '@adonisjs/core/http'
+
+import { SitemapGenerator } from '#services/sitemap_generator'
+
+export default class ContentDistributionController {
+  @inject()
+  async getSitemap({ response }: HttpContext, sitemapGenerator: SitemapGenerator) {
+    response.header('Content-Type', 'application/xml')
+
+    return await sitemapGenerator.generate()
+  }
+}

app/services/sitemap_generator.ts

@@ -0,0 +1,27 @@
+import cache from '@adonisjs/cache/services/main'
+import { SitemapStream, streamToPromise } from 'sitemap'
+
+import type { PackageInfo } from '#types/main'
+
+export class SitemapGenerator {
+  constructor(protected packages: PackageInfo[]) {}
+
+  async #generateSitemap() {
+    const sitemap = new SitemapStream({ hostname: 'https://packages.adonisjs.com' })
+
+    sitemap.write({ url: '/', changefreq: 'daily', priority: 1 })
+
+    this.packages.forEach((pkg) =>
+      sitemap.write({ url: `/packages/${pkg.slug}`, changefreq: 'weekly', priority: 0.7 }),
+    )
+
+    sitemap.end()
+
+    const buffer = await streamToPromise(sitemap)
+    return buffer.toString()
+  }
+
+  async generate() {
+    return cache.getOrSet('sitemap', () => this.#generateSitemap(), { ttl: '1d' })
+  }
+}

package.json

@@ -66,6 +66,7 @@
     "sanitize-html": "^2.11.0",
     "satori": "^0.10.11",
     "satori-html": "^0.3.2",
+    "sitemap": "^7.1.1",
     "sqlite3": "^5.1.7",
     "vue": "^3.4.7"
   },

providers/app_provider.ts

@@ -7,6 +7,7 @@ import type { ApplicationService } from '@adonisjs/core/types'
 
 import { PackageFetcher } from '#services/package_fetcher'
 import { PackagesFetcher } from '#services/packages_fetcher'
+import { SitemapGenerator } from '#services/sitemap_generator'
 import { PackagesDataRefresher } from '#services/packages_data_refresher'
 
 export default class AppProvider {
@@ -32,6 +33,8 @@ export default class AppProvider {
       return new PackagesFetcher(await resolver.make(PackageFetcher), packagesFile)
     })
 
+    this.app.container.bind(SitemapGenerator, async () => new SitemapGenerator(packagesFile))
+
     /**
      * Helper for removing double slashes from urls
      */

start/routes.ts

@@ -11,9 +11,11 @@ import router from '@adonisjs/core/services/router'
 
 const PackagesController = () => import('#controllers/packages_controller')
 const OgImagesController = () => import('#controllers/og_images_controller')
+const ContentDistributionController = () => import('#controllers/content_distribution_controller')
 
 router.get('/', [PackagesController, 'getHome'])
 router.get('/packages/:name', [PackagesController, 'getPackage'])
 router.get('/packages/:name/og.png', [OgImagesController]).as('og_image')
+router.get('/sitemap.xml', [ContentDistributionController, 'getSitemap'])
 
 router.get('/healthcheck', ({ response }) => response.noContent())