|
| 1 | +export interface FetchSitemapParams { |
| 2 | + type?: string | null; |
| 3 | + page?: string | number | null; |
| 4 | +} |
| 5 | + |
| 6 | +export interface HandleSitemapRouteOptions { |
| 7 | + getSitemapIndex: () => Promise<string>; |
| 8 | + fetchSitemapResponse: (params: FetchSitemapParams) => Promise<Response>; |
| 9 | +} |
| 10 | + |
| 11 | +export interface SitemapClientOptions { |
| 12 | + storeHash: string; |
| 13 | + getChannelId: () => Promise<string> | string; |
| 14 | + graphqlApiDomain?: string; // default: mybigcommerce.com |
| 15 | + trustedProxySecret?: string; |
| 16 | + userAgent?: string; |
| 17 | +} |
| 18 | + |
| 19 | +export function createSitemapClient(options: SitemapClientOptions) { |
| 20 | + const graphqlDomain = options.graphqlApiDomain ?? 'mybigcommerce.com'; |
| 21 | + |
| 22 | + async function getCanonicalUrl() { |
| 23 | + const channelId = await options.getChannelId(); |
| 24 | + |
| 25 | + return `https://store-${options.storeHash}-${channelId}.${graphqlDomain}`; |
| 26 | + } |
| 27 | + |
| 28 | + return { |
| 29 | + async fetchSitemapIndex(): Promise<string> { |
| 30 | + const base = await getCanonicalUrl(); |
| 31 | + const url = `${base}/xmlsitemap.php`; |
| 32 | + const headers = new Headers(); |
| 33 | + |
| 34 | + headers.set('Accept', 'application/xml'); |
| 35 | + headers.set('Content-Type', 'application/xml'); |
| 36 | + if (options.userAgent) headers.set('User-Agent', options.userAgent); |
| 37 | + if (options.trustedProxySecret) |
| 38 | + headers.set('X-BC-Trusted-Proxy-Secret', options.trustedProxySecret); |
| 39 | + |
| 40 | + const response = await fetch(url, { method: 'GET', headers }); |
| 41 | + |
| 42 | + if (!response.ok) { |
| 43 | + throw new Error(`Unable to get Sitemap Index: ${response.statusText}`); |
| 44 | + } |
| 45 | + |
| 46 | + return response.text(); |
| 47 | + }, |
| 48 | + |
| 49 | + async fetchSitemapResponse(params: FetchSitemapParams): Promise<Response> { |
| 50 | + const base = await getCanonicalUrl(); |
| 51 | + const url = new URL(`${base}/xmlsitemap.php`); |
| 52 | + |
| 53 | + if (params.type) url.searchParams.set('type', String(params.type)); |
| 54 | + if (params.page !== undefined && params.page !== null) |
| 55 | + url.searchParams.set('page', String(params.page)); |
| 56 | + |
| 57 | + const headers = new Headers(); |
| 58 | + |
| 59 | + headers.set('Accept', 'application/xml'); |
| 60 | + headers.set('Content-Type', 'application/xml'); |
| 61 | + if (options.userAgent) headers.set('User-Agent', options.userAgent); |
| 62 | + if (options.trustedProxySecret) |
| 63 | + headers.set('X-BC-Trusted-Proxy-Secret', options.trustedProxySecret); |
| 64 | + |
| 65 | + const response = await fetch(url.toString(), { method: 'GET', headers }); |
| 66 | + |
| 67 | + return response; |
| 68 | + }, |
| 69 | + } as const; |
| 70 | +} |
| 71 | + |
| 72 | +/** |
| 73 | + * Handles GET /sitemap.xml with two behaviors: |
| 74 | + * - Without query params: returns the sitemap index with <loc> links rewritten to the incoming host and |
| 75 | + * normalized to /sitemap.xml, only when both type and page exist on the original link. |
| 76 | + * - With query params: requires both type and page, proxies upstream response as-is (status/body), |
| 77 | + * ignoring any other params. |
| 78 | + */ |
| 79 | +/** |
| 80 | + * Handles the Catalyst sitemap route. |
| 81 | + * |
| 82 | + * @param {Request} request Incoming Next.js Request for `/sitemap.xml`. |
| 83 | + * @param {any} options Helpers to fetch the upstream sitemap resources. |
| 84 | + * @returns {Promise<Response>} Response suitable for returning from the route handler. |
| 85 | + */ |
| 86 | +export async function handleSitemapRoute( |
| 87 | + request: Request, |
| 88 | + options: HandleSitemapRouteOptions, |
| 89 | +): Promise<Response> { |
| 90 | + const { getSitemapIndex, fetchSitemapResponse } = options; |
| 91 | + const requestUrl = new URL(request.url); |
| 92 | + const incomingHost: string = request.headers.get('host') ?? requestUrl.host; |
| 93 | + const incomingProtoHeader = request.headers.get('x-forwarded-proto'); |
| 94 | + const incomingProtocol: string = incomingProtoHeader ?? requestUrl.protocol.replace(':', ''); |
| 95 | + |
| 96 | + const typeParam = requestUrl.searchParams.get('type'); |
| 97 | + const pageParam = requestUrl.searchParams.get('page'); |
| 98 | + |
| 99 | + // If any sitemap page is requested, require both well-known params |
| 100 | + if (typeParam !== null || pageParam !== null) { |
| 101 | + if (!typeParam || !pageParam) { |
| 102 | + return new Response('Both "type" and "page" query params are required', { |
| 103 | + status: 400, |
| 104 | + headers: { 'Content-Type': 'text/plain; charset=utf-8' }, |
| 105 | + }); |
| 106 | + } |
| 107 | + |
| 108 | + const upstream = await fetchSitemapResponse({ type: typeParam, page: pageParam }); |
| 109 | + const body = await upstream.text(); |
| 110 | + |
| 111 | + return new Response(body, { |
| 112 | + status: upstream.status, |
| 113 | + statusText: upstream.statusText, |
| 114 | + headers: { 'Content-Type': 'application/xml' }, |
| 115 | + }); |
| 116 | + } |
| 117 | + |
| 118 | + const sitemapIndexXml = await getSitemapIndex(); |
| 119 | + |
| 120 | + // Rewrite <loc> links to use incoming host and normalized path, only when both type & page exist |
| 121 | + const rewrittenXml = sitemapIndexXml.replace( |
| 122 | + /<loc>([^<]+)<\/loc>/g, |
| 123 | + (match: string, locUrlStr: string) => { |
| 124 | + try { |
| 125 | + const decoded: string = locUrlStr.replace(/&/g, '&'); |
| 126 | + const original = new URL(decoded); |
| 127 | + |
| 128 | + if (!original.pathname.endsWith('/xmlsitemap.php')) { |
| 129 | + return match; |
| 130 | + } |
| 131 | + |
| 132 | + const normalized = new URL(`${incomingProtocol}://${incomingHost}/sitemap.xml`); |
| 133 | + |
| 134 | + const t = original.searchParams.get('type'); |
| 135 | + const p = original.searchParams.get('page'); |
| 136 | + |
| 137 | + if (!t || !p) { |
| 138 | + return match; |
| 139 | + } |
| 140 | + |
| 141 | + normalized.searchParams.set('type', t); |
| 142 | + normalized.searchParams.set('page', p); |
| 143 | + |
| 144 | + const normalizedXml: string = normalized.toString().replace(/&/g, '&'); |
| 145 | + |
| 146 | + return `<loc>${normalizedXml}</loc>`; |
| 147 | + } catch { |
| 148 | + return match; |
| 149 | + } |
| 150 | + }, |
| 151 | + ); |
| 152 | + |
| 153 | + return new Response(rewrittenXml, { |
| 154 | + headers: { |
| 155 | + 'Content-Type': 'application/xml', |
| 156 | + }, |
| 157 | + }); |
| 158 | +} |
| 159 | + |
| 160 | + |
0 commit comments