flakes: bare minimum fix the error message for untracked flake.nix #9398
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
getFlake currently calls lstat (via isLink via canonPath) before it performs the sanity check that a flake.nix exists in the first place. This commit moves the check to before path canonicalization, so that failed symlink check operations don't throw before the check does.
roberth
approved these changes
Nov 23, 2023
thufschmitt
approved these changes
Nov 24, 2023
fricklerhandwerk
added
the
error-messages
tebowy
pushed a commit
to tebowy/nix
that referenced
this pull request
Jul 11, 2024
flakes: bare minimum fix the error message for untracked flake.nix (cherry picked from commit 7f626db) Change-Id: I470ac56a670a8c11e4164c6b059184a02344d491
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tl;dr
Before:
After:
Motivation
error: getting status of /nix/store/path/flake.nix: No such file or directoryis an extremely confusing error message, with multiple related open issues (#6642, #7107), Discourse threads, Reddit threads, and even blog posts about it.This problem warrants far more helpful diagnostics than this PR adds, however the current UX is so poor and the fix so trivial I felt it warranted a separate, bare minimum PR before I work on more complex diagnostics.
Context
Since
canonPath(resolveSymlinks = true)callslstat()on its argument, I'm pretty sure it's impossible for apathExists()check after it to return false. Because of that I moved the check entirely to before thecanonPath()calls, instead of duplicating them.Priorities
Add 👍 to pull requests you find important.