WIP: expose flake directory to nix fmt as FLAKE_DIR env var

This was discussed in NixOS#8034. I
personally like `FLAKE_DIR`, which hopefully avoids some ambiguity around
with subflakes.

I only implemented this for `nix fmt` because it doesn't let you point
at a flake not on your filesystem.

This is in a bit of a rough state. I left conflict markers (`<<<`) anywhere I
did something in need of cleanup.

Author: jfly

src/libstore/unix/build/derivation-builder.cc

@@ -7,6 +7,7 @@
 #include "nix/store/builtins.hh"
 #include "nix/store/builtins/buildenv.hh"
 #include "nix/store/path-references.hh"
+#include "nix/util/environment-variables.hh"
 #include "nix/util/finally.hh"
 #include "nix/util/util.hh"
 #include "nix/util/archive.hh"
@@ -187,7 +188,6 @@ class DerivationBuilderImpl : public DerivationBuilder, DerivationBuilderParams
     typedef std::map<Path, ChrootPath> PathsInChroot; // maps target path to source path
     PathsInChroot pathsInChroot;
 
-    typedef std::map<std::string, std::string> Environment;
     Environment env;
 
     /**

src/libutil/environment-variables.cc

@@ -21,9 +21,9 @@ std::optional<std::string> getEnvNonEmpty(const std::string & key)
     return value;
 }
 
-std::map<std::string, std::string> getEnv()
+Environment getEnv()
 {
-    std::map<std::string, std::string> env;
+    Environment env;
     for (size_t i = 0; environ[i]; ++i) {
         auto s = environ[i];
         auto eq = strchr(s, '=');
@@ -41,7 +41,7 @@ void clearEnv()
         unsetenv(name.first.c_str());
 }
 
-void replaceEnv(const std::map<std::string, std::string> & newEnv)
+void replaceEnv(const Environment & newEnv)
 {
     clearEnv();
     for (auto & newEnvVar : newEnv)

src/libutil/include/nix/util/environment-variables.hh

@@ -15,6 +15,8 @@ namespace nix {
 
 static constexpr auto environmentVariablesCategory = "Options that change environment variables";
 
+typedef std::map<std::string, std::string> Environment;
+
 /**
  * @return an environment variable.
  */
@@ -34,7 +36,7 @@ std::optional<std::string> getEnvNonEmpty(const std::string & key);
 /**
  * Get the entire environment.
  */
-std::map<std::string, std::string> getEnv();
+Environment getEnv();
 
 #ifdef _WIN32
 /**
@@ -64,6 +66,6 @@ void clearEnv();
 /**
  * Replace the entire environment with the given one.
  */
-void replaceEnv(const std::map<std::string, std::string> & newEnv);
+void replaceEnv(const Environment & newEnv);
 
 }

src/nix/formatter-run.md

@@ -8,6 +8,9 @@ Flags can be forwarded to the formatter by using `--` followed by the flags.
 
 Any arguments will be forwarded to the formatter. Typically these are the files to format.
 
+The environment variable `NIX_FLAKE_DIR` will be set to the absolute path to the
+directory containing the flake's `flake.nix`.
+
 
 # Example
 

src/nix/formatter.cc

@@ -3,6 +3,7 @@
 #include "nix/expr/eval.hh"
 #include "nix/store/local-fs-store.hh"
 #include "nix/cmd/installable-derived-path.hh"
+#include "nix/util/environment-variables.hh"
 #include "run.hh"
 
 using namespace nix;
@@ -72,6 +73,11 @@ struct CmdFormatterRun : MixFormatter, MixJSON
         auto evalState = getEvalState();
         auto evalStore = getEvalStore();
 
+        auto flakeRef = parseFlakeRef(fetchSettings, ".", std::filesystem::current_path().string());
+        auto maybeFlakeDir = flakeRef.input.getSourcePath();
+        assert(maybeFlakeDir.has_value());
+        auto flakeDir = maybeFlakeDir.value();
+
         auto installable_ = parseInstallable(store, ".");
         auto & installable = InstallableValue::require(*installable_);
         auto app = installable.toApp(*evalState).resolve(evalStore, store);
@@ -87,7 +93,18 @@ struct CmdFormatterRun : MixFormatter, MixJSON
         // we are about to exec out of this process without running C++ destructors.
         evalState->evalCaches.clear();
 
-        execProgramInStore(store, UseLookupPath::DontUse, app.program, programArgs);
+        // Add the path to the flake as an environment variable. This enables formatters to format the entire flake even
+        // if run from a subdirectory.
+        Environment env = getEnv();
+        env["NIX_FLAKE_DIR"] = flakeDir;
+
+        execProgramInStore(
+            store,
+            UseLookupPath::DontUse,
+            app.program,
+            programArgs,
+            "", // <<< is there a cleaner way of passing the default value?
+            env);
     };
 };
 

src/nix/run.cc

@@ -10,6 +10,7 @@
 #include "nix/util/finally.hh"
 #include "nix/util/source-accessor.hh"
 #include "nix/expr/eval.hh"
+#include "nix/util/util.hh"
 #include <filesystem>
 
 #ifdef __linux__
@@ -27,14 +28,39 @@ std::string chrootHelperName = "__run_in_chroot";
 
 namespace nix {
 
+//<<< code copied (and modified) from src/libstore/unix/build/derivation-builder.cc
+Strings toEnvp(Environment env)
+{
+    /* Convert `env` to a list of strings suitable for `execve`'s `envp` argument. */
+    Strings envStrs;
+    for (auto & i : env) {
+        envStrs.push_back(i.first + "=" + i.second);
+    }
+
+    return envStrs;
+}
+//<<<
+
 void execProgramInStore(ref<Store> store,
     UseLookupPath useLookupPath,
     const std::string & program,
     const Strings & args,
-    std::optional<std::string_view> system)
+    std::optional<std::string_view> system,
+    std::optional<Environment> env)
 {
     logger->stop();
 
+    char **envp;
+    Strings envStrs;
+    std::vector<char *> envCharPtrs;
+    if (env.has_value()) {
+        envStrs = toEnvp(env.value());
+        envCharPtrs = stringsToCharPtrs(envStrs);
+        envp = envCharPtrs.data();
+    } else {
+        envp = environ;
+    }
+
     restoreProcessContext();
 
     /* If this is a diverted store (i.e. its "logical" location
@@ -54,7 +80,7 @@ void execProgramInStore(ref<Store> store,
         Strings helperArgs = { chrootHelperName, store->storeDir, store2->getRealStoreDir(), std::string(system.value_or("")), program };
         for (auto & arg : args) helperArgs.push_back(arg);
 
-        execv(getSelfExe().value_or("nix").c_str(), stringsToCharPtrs(helperArgs).data());
+        execve(getSelfExe().value_or("nix").c_str(), stringsToCharPtrs(helperArgs).data(), envp);
 
         throw SysError("could not execute chroot helper");
     }
@@ -65,9 +91,9 @@ void execProgramInStore(ref<Store> store,
 #endif
 
     if (useLookupPath == UseLookupPath::Use)
-        execvp(program.c_str(), stringsToCharPtrs(args).data());
+        execvpe(program.c_str(), stringsToCharPtrs(args).data(), envp);
     else
-        execv(program.c_str(), stringsToCharPtrs(args).data());
+        execve(program.c_str(), stringsToCharPtrs(args).data(), envp);
 
     throw SysError("unable to execute '%s'", program);
 }

src/nix/run.hh

@@ -14,6 +14,7 @@ void execProgramInStore(ref<Store> store,
     UseLookupPath useLookupPath,
     const std::string & program,
     const Strings & args,
-    std::optional<std::string_view> system = std::nullopt);
+    std::optional<std::string_view> system = std::nullopt,
+    std::optional<Environment> env = std::nullopt);
 
 }

tests/functional/formatter.sh

@@ -35,12 +35,12 @@ cat << EOF > flake.nix
 EOF
 
 # No arguments check
-[[ "$(nix fmt)" = "Formatting(0):" ]]
-[[ "$(nix formatter run)" = "Formatting(0):" ]]
+[[ "$(nix fmt)" = "NIX_FLAKE_DIR=$TEST_HOME Formatting(0):" ]]
+[[ "$(nix formatter run)" = "NIX_FLAKE_DIR=$TEST_HOME Formatting(0):" ]]
 
 # Argument forwarding check
-nix fmt ./file ./folder | grep 'Formatting(2): ./file ./folder'
-nix formatter run ./file ./folder | grep 'Formatting(2): ./file ./folder'
+nix fmt ./file ./folder | grep "NIX_FLAKE_DIR=$TEST_HOME Formatting(2): ./file ./folder"
+nix formatter run ./file ./folder | grep "NIX_FLAKE_DIR=$TEST_HOME Formatting(2): ./file ./folder"
 
 # Build checks
 ## Defaults to a ./result.

tests/functional/formatter.simple.sh

@@ -1,2 +1,2 @@
 #!/usr/bin/env bash
-echo "Formatting(${#}):" "${@}"
+echo "NIX_FLAKE_DIR=$NIX_FLAKE_DIR Formatting(${#}):" "${@}"