treewide: use writableTmpDirAsHomeHook

[drupol]

Reference to #370869

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[GaetanLepage]

LGTM, thanks for this !

[jian-lin]

I find that this pattern does not work for go packages. The writableTmpDirAsHome bash function is never called and $HOME remains to be HOME=/homeless-shelter. Any ideas? cc @ShamrockLee

[GaetanLepage]

Have you tried recently ?
The hook was initially broken but got fixed afterwards.

[jian-lin]

My test is on the master branch 8b564bb.

[GaetanLepage]

Is this the right commit ?

[jian-lin]

It works if I do one of these things:

• also add writableTmpDirAsHomeHook to checkInputs
• disable strictDeps: nix-repl> :b apx.overrideAttrs { strictDeps = false; }

[drupol]

To be honest, I have no clue who to contact. Can you ping the relevant nicknames here perhaps?

[ShamrockLee]

@NixOS/stdenv @NixOS/golang @infinisil @roberth Sorry for bothering, but does anyone know why setup hooks using addEnvHooks "$targetOffset" don't take effect when passing to buildGoModule?

[jian-lin]

@NickCao told me how setup hooks work and why this issue happens only for go packages here. Thank you, @NickCao .

The following patch fixes it:

-addEnvHooks "$targetOffset" writableTmpDirAsHome
+addEnvHooks "$hostOffset" writableTmpDirAsHome

Here is the explanation. Assume writableTmpDirAsHomeHook is added to nativeBuildInputs (or nativeCheckInputs). If hostOffset is used, the bash function writableTmpDirAsHome is run against each dependency in depsBuildBuild depsBuildHost(nativeBuildInputs) depsBuildTarget. If targetOffset is used, it is run against each dependency in depsHostHost depsHostTarget(buildInputs). Go packages usually have no dependencies in depsHostHost depsHostTarget(buildInputs), so the bash function writableTmpDirAsHome is never run and we observe this issue. Since we assume writableTmpDirAsHomeHook is added to nativeBuildInputs, there is at least one dependency (the hook itself) in depsBuildBuild depsBuildHost(nativeBuildInputs) depsBuildTarget. As a result, the bash function writableTmpDirAsHome will always run when hostOffset is used.

The implementation of addEnvHooks may be helpful.

[drupol]

Fixed in: #378927

[drupol]

Thank you for making the investigation, very interesting !!!