Skip to content

fix(nuxt): sort hash sources and files #32048

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 1 commit into from
May 9, 2025
Merged

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #32047

📚 Description

this sorts hash sources as a potential solution to #32047

@Copilot Copilot AI review requested due to automatic review settings May 8, 2025 19:56
Copy link

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

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR resolves the issue of inconsistent ordering in Nuxt’s build hash computation by adding explicit sorting to both file hashes and hash source arrays.

  • Sort file entries by name right after mapping their properties
  • Sort hash sources before generating the final build hash

@@ -117,7 +117,7 @@ async function getHashes (nuxt: Nuxt, options: GetHashOptions): Promise<Hashes>
name: f.name,
size: f.attrs?.size,
data: hash(f.data),
}))
})).sort((a, b) => a.name.localeCompare(b.name))
Copy link
Preview

Copilot AI May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider extracting the sorting logic into a helper function to avoid duplication and improve consistency if similar sorts are needed elsewhere.

Copilot uses AI. Check for mistakes.

@@ -152,6 +152,8 @@ async function getHashes (nuxt: Nuxt, options: GetHashOptions): Promise<Hashes>
})
}

hashSources.sort((a, b) => a.name.localeCompare(b.name))
Copy link
Preview

Copilot AI May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Using an inline sort here ensures stable ordering, but abstracting the sorting logic into a dedicated helper could improve overall maintainability and consistency across the codebase.

Suggested change
hashSources.sort((a, b) => a.name.localeCompare(b.name))
sortByName(hashSources);

Copilot uses AI. Check for mistakes.

Copy link

coderabbitai bot commented May 8, 2025

Walkthrough

The update introduces sorting by file name using localeCompare to two arrays within the getHashes function in the cache module. The array produced by normaliseFiles is now sorted by its name property before being added to hashSources. Additionally, the entire hashSources array is sorted by name before the final hash is calculated and cached on the nuxt instance. These changes ensure a deterministic order of file entries and hash sources, directly influencing the consistency of the hash calculation. No changes have been made to the declarations of exported or public entities.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 dcd50b7 and 84a1578.

📒 Files selected for processing (1)
  • packages/nuxt/src/core/cache.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (2)
packages/nuxt/src/core/cache.ts (2)

120-120: Good improvement for consistency

Adding sorting to the normalized files array ensures that the file entries have a consistent order regardless of how the file system returns them. This is important for deterministic hash calculation, which directly addresses the issue mentioned in the PR objectives.


155-156: Excellent addition for deterministic hashing

Sorting the entire hashSources array before computing the final hash is a critical improvement. This ensures that the resulting hash will be consistent across different environments and builds, even if the layers are processed in a different order. This change, combined with the sorting in the normalizeFiles function, provides a complete solution for deterministic hash generation.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • 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.

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 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.

Copy link

pkg-pr-new bot commented May 8, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 84a1578

Copy link

codspeed-hq bot commented May 8, 2025

CodSpeed Performance Report

Merging #32048 will not alter performance

Comparing fix/sort-hash-sources (84a1578) with main (dcd50b7)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit ebff42f into main May 9, 2025
83 of 84 checks passed
@danielroe danielroe deleted the fix/sort-hash-sources branch May 9, 2025 08:04
@github-actions github-actions bot mentioned this pull request May 9, 2025
@github-actions github-actions bot mentioned this pull request May 9, 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.

buildCache generates different hash on every build even when no code changes
1 participant
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