fix(nuxt): safe-guard `extraPageMetaExtractionKeys` #32510

s1gr1d · 2025-06-30T09:50:18Z

🔗 Linked issue

This issue came up while checking the canary tests in Sentry Nuxt: getsentry/sentry-javascript#16762

Building the application resulted in this error: nuxt.options.experimental.extraPageMetaExtractionKeys is not iterable

📚 Description

This PR creates a safeguard (Array.isArray()) before spreading the experimental value.

bolt-new-by-stackblitz · 2025-06-30T09:50:22Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-30T09:51:36Z

Walkthrough

The changes update the handling of the extraPageMetaExtractionKeys option from nuxt.options.experimental by assigning it to a local variable with a fallback to an empty array if undefined. This local variable is then spread into the extractedKeys and extraExtractionKeys arrays in the module and utility files, respectively. The explicit inclusion of the string 'middleware' in the extraction keys is removed. These modifications improve safety and clarity by avoiding direct access without fallback and isolating the extraction keys into dedicated variables. No public or exported entities are altered.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d39f540 and edbd813.

📒 Files selected for processing (2)

packages/nuxt/src/pages/module.ts (1 hunks)
packages/nuxt/src/pages/utils.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

packages/nuxt/src/pages/utils.ts
packages/nuxt/src/pages/module.ts

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: build
GitHub Check: codeql (javascript-typescript)
GitHub Check: code

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in a Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-06-30T10:22:34Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32510

nuxt

npm i https://pkg.pr.new/nuxt@32510

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32510

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32510

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32510

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32510

commit: edbd813

packages/nuxt/src/pages/module.ts

codspeed-hq · 2025-06-30T10:33:09Z

CodSpeed Performance Report

Merging #32510 will not alter performance

_{Comparing s1gr1d:fix-options-error (edbd813) with main (50f9b53)}

Summary

✅ 10 untouched benchmarks

xjccc · 2025-07-01T01:52:39Z

packages/nuxt/src/pages/module.ts

+    const extraPageMetaExtractionKeys = nuxt.options.experimental.extraPageMetaExtractionKeys
+    const extractedKeys = [
+      ...defaultExtractionKeys,
+      'middleware',


emmm.. middleware is also in defaultExtractionKeys, does it need to remove this line?

True, does it make sense to use defaultExtractionKeys here as well?
It only contains 'middleware'
https://github.com/nuxt/nuxt/pull/32510/files#diff-c2594c96f1f7e8279fb8940560db036a9efa49e39522509ee02193dbac213092R77

Does it seem that it maybe could also be deleted? But it doesn't matter with this.

nuxt/packages/nuxt/src/pages/utils.ts

Line 241 in d39f540

const extractionKeys = new Set<keyof NuxtPage>([...defaultExtractionKeys, ...extraExtractionKeys as Set<keyof NuxtPage>])

danielroe · 2025-07-01T11:02:26Z

This is a nice check, but also highlights an issue with the wrong version of @nuxt/schema being hoisted into projects (e.g. #32494).

I have plans to fix/improve that (but for a start, @nuxt/schema should not be directly depended upon by libraries - this case, two core nuxt modules.)

s1gr1d · 2025-07-01T12:28:51Z

packages/nuxt/src/pages/utils.ts

  const augmentCtx = {
-    extraExtractionKeys: new Set(['middleware', ...nuxt.options.experimental.extraPageMetaExtractionKeys]),
+    extraExtractionKeys: new Set([
+      'middleware',


@danielroe maybe you know if defaultExtractionKeys can be used here instead of just adding 'middleware'? Came up here.

No, it can't - we treat them slightly separately in terms of whether we remove them from the route metadata that's accessible at runtime from route.meta.

gabrielduete

Awesome!!

danielroe · 2025-07-02T08:22:56Z

packages/nuxt/src/pages/module.ts

@@ -489,7 +489,12 @@ export default defineNuxtModule({
    }

    // Extract macros from pages
-    const extractedKeys = [...defaultExtractionKeys, 'middleware', ...nuxt.options.experimental.extraPageMetaExtractionKeys]
+    const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys


I think we could probably just do:

Suggested change

const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys

const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys || []

... as the issue is presumably that it's not defined, rather than set to a string or something like that

danielroe · 2025-07-02T11:38:29Z

thank you ❤️

fix(nuxt): Safeguard extraPageMetaExtractionKeys

9f25ace

s1gr1d requested a review from danielroe as a code owner June 30, 2025 09:50

github-actions bot added 4.x bug labels Jun 30, 2025

s1gr1d changed the title ~~fix(nuxt): Safeguard extraPageMetaExtractionKeys~~ fix(nuxt): safe-guard extraPageMetaExtractionKeys Jun 30, 2025

Mini-ghost reviewed Jun 30, 2025

View reviewed changes

packages/nuxt/src/pages/module.ts Outdated Show resolved Hide resolved

s1gr1d mentioned this pull request Jun 30, 2025

nuxt-4 (canary) Test Failed getsentry/sentry-javascript#16762

Closed

adding optional chain

d39f540

xjccc reviewed Jul 1, 2025

View reviewed changes

s1gr1d mentioned this pull request Jul 1, 2025

meta(changelog): Update changelog for 9.34.0 getsentry/sentry-javascript#16779

Merged

s1gr1d commented Jul 1, 2025

View reviewed changes

gabrielduete approved these changes Jul 2, 2025

View reviewed changes

danielroe reviewed Jul 2, 2025

View reviewed changes

review suggestions

edbd813

s1gr1d requested review from danielroe and xjccc July 2, 2025 11:24

xjccc approved these changes Jul 2, 2025

View reviewed changes

danielroe approved these changes Jul 2, 2025

View reviewed changes

danielroe merged commit 6cf4f10 into nuxt:main Jul 2, 2025
46 checks passed

github-actions bot mentioned this pull request Jul 2, 2025

v4.0.0 #27716

Merged

s1gr1d mentioned this pull request Jul 2, 2025

nuxt-3 (canary) Test Failed getsentry/sentry-javascript#16761

Closed

danielroe pushed a commit that referenced this pull request Jul 3, 2025

fix(nuxt): safe-guard extraPageMetaExtractionKeys (#32510)

213112a

github-actions bot mentioned this pull request Jul 3, 2025

v3.17.7 #32521

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): safe-guard `extraPageMetaExtractionKeys` #32510

fix(nuxt): safe-guard `extraPageMetaExtractionKeys` #32510

Uh oh!

Uh oh!

Uh oh!

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys
	const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys \|\| []

Uh oh!

fix(nuxt): safe-guard extraPageMetaExtractionKeys #32510

fix(nuxt): safe-guard extraPageMetaExtractionKeys #32510

Uh oh!

Conversation

🔗 Linked issue

📚 Description

Uh oh!

Uh oh!

Uh oh!

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CodSpeed Performance Report

Merging #32510 will not alter performance

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): safe-guard `extraPageMetaExtractionKeys` #32510

fix(nuxt): safe-guard `extraPageMetaExtractionKeys` #32510

CodeRabbit Configuration File (`.coderabbit.yaml`)