Skip to content

refactor(nuxt): hoist purgeCachedData check for tree-shaking #31785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 14, 2025

Conversation

Mini-ghost
Copy link
Member

@Mini-ghost Mini-ghost commented Apr 13, 2025

🔗 Linked issue

📚 Description

Move purgeCachedData condition outside the loop to enable better tree-shaking in production builds when experimental.purgeCachedData is false.

Before

const staticKeysToRemove = /* @__PURE__ */ new Set();
useRouter().beforeResolve(async (to, from) => {
  if (to.path === from.path) {
    return;
  }
  const payload = await loadPayload(to.path);
  if (!payload) {
    return;
  }
  for (const key of staticKeysToRemove) {
  }
  for (const key in payload.data) {
    if (!(key in nuxtApp.static.data)) {
      staticKeysToRemove.add(key);
    }
    nuxtApp.static.data[key] = payload.data[key];
  }
});

After

useRouter().beforeResolve(async (to, from) => {
  if (to.path === from.path) {
    return;
  }
  const payload = await loadPayload(to.path);
  if (!payload) {
    return;
  }
  for (const key in payload.data) {
    nuxtApp.static.data[key] = payload.data[key];
  }
});

@Mini-ghost Mini-ghost requested a review from danielroe as a code owner April 13, 2025 10:32
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

coderabbitai bot commented Apr 13, 2025

Walkthrough

The changes adjust the control flow within the beforeResolve function of a Nuxt plugin. The check for the purgeCachedData flag has been moved to occur before the loop that iterates over the staticKeysToRemove. Previously, the loop was encapsulated within the condition checking purgeCachedData, whereas the new structure first evaluates the condition and then proceeds to iterate over the keys to delete them from nuxtApp.static.data if the condition is true. This update does not alter the overall logic or functionality. Moreover, there are no modifications to the declarations of exported or public entities.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 8965bfa and c6c6e00.

📒 Files selected for processing (1)
  • packages/nuxt/src/app/plugins/payload.client.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/app/plugins/payload.client.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: code

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link

pkg-pr-new bot commented Apr 13, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: c6c6e00

@Mini-ghost Mini-ghost changed the title refactor(nuxt): move purgeCachedData check outside loop for better tree-shaking refactor(nuxt): hoist purgeCachedData check for tree-shaking Apr 13, 2025
Copy link

codspeed-hq bot commented Apr 13, 2025

CodSpeed Performance Report

Merging #31785 will not alter performance

Comparing Mini-ghost:refactor/payload-client-tree-shaking (c6c6e00) with main (7bbeedf)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 0c3c064 into nuxt:main Apr 14, 2025
48 checks passed
@github-actions github-actions bot mentioned this pull request Apr 14, 2025
@github-actions github-actions bot mentioned this pull request Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy