feat(web): add sitemap

Author: abraham

packages/web/astro.config.ts

@@ -1,3 +1,4 @@
+import sitemap from '@astrojs/sitemap';
 import lit from '@awesome.me/astro-lit';
 import { defineConfig } from 'astro/config';
 import { env } from 'node:process';
@@ -12,6 +13,7 @@ import { site } from './build/vite-plugin-site';
 const config = resolveConfig();
 
 export default defineConfig({
+  site: config.site.url,
   output: 'static',
   // Matches `trailingSlash: false` in firebase.json: `/speakers/abc` is `speakers/abc.html`.
   trailingSlash: 'never',
@@ -32,6 +34,7 @@ export default defineConfig({
       },
     },
     routes(config.site.features),
+    sitemap({ filter: (page) => !page.endsWith('/offline') }),
     // Before the service worker, which precaches the pages it changes. Deploys build with
     // FIRESTORE_TARGET=production, and every other build may run on the emulators.
     csp(config.site as CspSite, { emulators: env['FIRESTORE_TARGET'] !== 'production' }),

packages/web/build/build.smoke.test.ts

@@ -112,6 +112,17 @@ describe('a production build of a minimal site', () => {
     });
   });
 
+  it('lists the home page in the sitemap, and links to it from robots.txt', () => {
+    const locs = (file: string) =>
+      [...build.read(file).matchAll(/<loc>([^<]*)<\/loc>/g)].map(([, loc]) => loc);
+
+    expect(locs('sitemap-index.xml')).toEqual(['https://minimal-site.web.app/sitemap-0.xml']);
+    expect(locs('sitemap-0.xml')).toEqual(['https://minimal-site.web.app/']);
+    expect(build.read('robots.txt')).toContain(
+      'Sitemap: https://minimal-site.web.app/sitemap-index.xml',
+    );
+  });
+
   it('precaches the scripts and the home and offline pages', () => {
     const worker = build.read('service-worker.js');
     const precached = [...worker.matchAll(/url:"([^"]+)"/g)].map((match) => match[1] ?? '');

packages/web/package-lock.json

@@ -39,6 +39,7 @@
   "devDependencies": {
     "@astrojs/check": "^0.9.10",
     "@astrojs/rss": "^4.0.19",
+    "@astrojs/sitemap": "^3.7.4",
     "@awesome.me/astro-lit": "^5.0.4",
     "@babel/core": "^8.0.6",
     "@babel/plugin-proposal-decorators": "^8.0.2",

packages/web/package.json

@@ -0,0 +1,10 @@
+import type { APIRoute } from 'astro';
+import { site } from 'virtual:hoverboard/site';
+
+export const GET: APIRoute = () =>
+  new Response(
+    `User-agent: *\nAllow: /\n\nSitemap: ${new URL('sitemap-index.xml', site.url).href}\n`,
+    {
+      headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+    },
+  );