feat: add support for localizations in sitemap generator

[ctkc]

What?

Following up with this suggestion I went ahead and implemented the proposal for the Next.js team to merge it if they agree.

Things to keep in mind:

• Google has three different ways to do this. The three of them are equivalent
• Google seems to be the only search engine supporting this approach. The rest of them should ignore it

Why?

This is supported by Google to better understand the site when the same page is available in multiple languages.

How?

• I added a new key to the MetadataRoute.Sitemap type called alternates which accepts just one sub key languages similar to the current one in the Metadata object
• I updated the resolveSitemap method to process the new key and generate the expected sitemap
• I updated the related tests and documentation to reflect the new syntax

[janpaepke]

I was about to make a PR for this. Good thing I searched first. The code looks good to me!

How can we push this to get merged?

[xSyki]

A very desired feature, can we expect it to be introduced in the near future?

[miguelvictor]

This feature is a deal breaker for us. Please merge soon. Thanks!

[ctkc]

I just rebased the branch to fix some conflicts and keep this up to date.

[PxlSyl]

Hello, is there any other way to manage sitemap and languages? I'm struggling with this rn lol

[ootkin]

Same here, this is a very desired feature.

Right now we are using a cronjob that generates a sitemap and put it into an s3 bucket.

It would be awesome if we could generate the sitemap inside our nextjs app repo to centralize the logic and use the alternates links.

[zakton5]

@ctkc Would you mind updating this PR to fix the conflicts?

I'd love to see this get merged soon as I also need to support multiple languages 👍

[bitstein]

Is this something we can expect to see merged soon?

[KasperiP]

Does anyone know of any suitable workarounds for this issue that could be implemented prior to its integration?

[miguelvictor]

I just copied the code from this PR and called it in my API route. Should yield the same results 😅

[fabiolnm]

Indeed it's a must-have feature! Any plans to be updated and merged?

[kalysti]

Any updates for merge / review? Required by us as well :/

[thomaslenaour]

+1 I'm waiting for this feature too

[ijjk]

Failing test suites

Commit: 2336c177504b2172b0cc6fe5adb8c86da819c335

pnpm test-dev test/e2e/app-dir/navigation/navigation.test.ts

• app dir - navigation > navigating to dynamic params & changing the casing > should load the page correctly

Expand output

● app dir - navigation › navigating to dynamic params & changing the casing › should load the page correctly

page.waitForSelector: Timeout 60000ms exceeded.
Call log:
  - waiting for locator('[href=\'/dynamic-param-casing-change/paramA/noParam\']')

  421 |     return this.chain(() => {
  422 |       return page
> 423 |         .waitForSelector(selector, { timeout, state: 'attached' })
      |          ^
  424 |         .then(async (el) => {
  425 |           // it seems selenium waits longer and tests rely on this behavior
  426 |           // so we wait for the load event fire before returning

  at waitForSelector (lib/browsers/playwright.ts:423:10)

Read more about building and testing Next.js in contributing.md.

[ijjk]

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
buildDuration	13.9s	14s	⚠️ +102ms
buildDurationCached	7.5s	6.4s	N/A
nodeModulesSize	198 MB	198 MB	⚠️ +5.45 kB
nextStartRea..uration (ms)	436ms	439ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
2453-HASH.js gzip	30.8 kB	30.8 kB	N/A
3304.HASH.js gzip	181 B	181 B	✓
3f784ff6-HASH.js gzip	53.7 kB	53.7 kB	✓
8299-HASH.js gzip	5.04 kB	5.04 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	242 B	242 B	✓
main-HASH.js gzip	32.2 kB	32.2 kB	N/A
webpack-HASH.js gzip	1.68 kB	1.68 kB	N/A
Overall change	99.3 kB	99.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
_app-HASH.js gzip	196 B	197 B	N/A
_error-HASH.js gzip	184 B	184 B	✓
amp-HASH.js gzip	505 B	505 B	✓
css-HASH.js gzip	324 B	325 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	258 B	258 B	✓
head-HASH.js gzip	352 B	352 B	✓
hooks-HASH.js gzip	370 B	371 B	N/A
image-HASH.js gzip	4.21 kB	4.21 kB	✓
index-HASH.js gzip	259 B	259 B	✓
link-HASH.js gzip	2.67 kB	2.67 kB	N/A
routerDirect..HASH.js gzip	314 B	312 B	N/A
script-HASH.js gzip	386 B	386 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	6.57 kB	6.57 kB	✓

Client Build Manifests

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
_buildManifest.js gzip	481 B	484 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
index.html gzip	529 B	528 B	N/A
link.html gzip	541 B	540 B	N/A
withRouter.html gzip	524 B	522 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
edge-ssr.js gzip	95.3 kB	95.3 kB	N/A
page.js gzip	3.04 kB	3.04 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
middleware-b..fest.js gzip	625 B	624 B	N/A
middleware-r..fest.js gzip	151 B	151 B	✓
middleware.js gzip	25.5 kB	25.5 kB	N/A
edge-runtime..pack.js gzip	839 B	839 B	✓
Overall change	990 B	990 B	✓

Next Runtimes

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
app-page-exp...dev.js gzip	170 kB	170 kB	✓
app-page-exp..prod.js gzip	96.9 kB	96.9 kB	✓
app-page-tur..prod.js gzip	98.6 kB	98.6 kB	✓
app-page-tur..prod.js gzip	93.1 kB	93.1 kB	✓
app-page.run...dev.js gzip	144 kB	144 kB	✓
app-page.run..prod.js gzip	91.5 kB	91.5 kB	✓
app-route-ex...dev.js gzip	21.4 kB	21.4 kB	✓
app-route-ex..prod.js gzip	15.1 kB	15.1 kB	✓
app-route-tu..prod.js gzip	15.1 kB	15.1 kB	✓
app-route-tu..prod.js gzip	14.8 kB	14.8 kB	✓
app-route.ru...dev.js gzip	21 kB	21 kB	✓
app-route.ru..prod.js gzip	14.8 kB	14.8 kB	✓
pages-api-tu..prod.js gzip	9.54 kB	9.54 kB	✓
pages-api.ru...dev.js gzip	9.81 kB	9.81 kB	✓
pages-api.ru..prod.js gzip	9.54 kB	9.54 kB	✓
pages-turbo...prod.js gzip	22.4 kB	22.4 kB	✓
pages.runtim...dev.js gzip	23.1 kB	23.1 kB	✓
pages.runtim..prod.js gzip	22.4 kB	22.4 kB	✓
server.runti..prod.js gzip	50.9 kB	50.9 kB	✓
Overall change	945 kB	945 kB	✓

build cache

	vercel/next.js canary	ctkc/next.js ctkc/sitemap-generator-localizations	Change
0.pack gzip	1.57 MB	1.56 MB	N/A
index.pack gzip	106 kB	105 kB	N/A
Overall change	0 B	0 B	✓

Diff details

Diff for middleware.js

Diff too large to display

Commit: 2336c177504b2172b0cc6fe5adb8c86da819c335

[muzamilabbas]

Happy to see this update coming. Anyone knows when it will be available ?