Add support for Nix flakes and haskell.nix #1570

jwiegley · 2022-12-01T03:09:48Z

This PR adds a flake.nix that uses haskell.nix to Nixify the chainweb-node package using the Haskell dependency versions from the cabal.project.freeze file. This PR retains the old Nix infrastructure but it's planned to be removed in a subsequent PR.

imalsogreg · 2022-12-06T00:26:56Z

Suddenly I'm getting this error. Fresh checkout of chainweb-node, running on nixos:

$ nix develop .

Error: cabal: Could not resolve dependencies:
[__0] trying: chainweb-2.17.1 (user goal)
[__1] trying: servant-client-core-0.19 (dependency of chainweb)
[__2] next goal: free (dependency of servant-client-core)
[__2] rejecting: free-5.1.9, free-5.1.8, free-5.1.7, free-5.1.6, free-5.1.5,
free-5.1.4, free-5.1.3, free-5.1.2, free-5.1.1, free-5.1, free-5.0.2,
free-5.0.1, free-4.12.4, free-4.12.3, free-4.12.2, free-4.12.1, free-4.12,
free-4.11, free-4.10.0.1, free-4.9, free-4.8.0.1, free-4.8, free-4.7.1,
free-4.7, free-4.6.1, free-4.6, free-4.5, free-4.4, free-4.2, free-4.1,
free-4.0, free-3.4.2, free-3.4.1, free-3.4, free-3.3.1, free-3.3.0.2,
free-3.3.0.1, free-3.3, free-3.2, free-3.1.1, free-3.1, free-3.0, free-2.2,
free-2.1.1.1, free-2.1.1, free-2.1, free-2.0.3, free-2.0.2, free-2.0.1.1,
free-2.0.1, free-2.0, free-1.8.0.4, free-1.8.0.3, free-1.8.0.1, free-1.8.0,
free-0.2.3, free-0.2.2, free-0.2.1, free-0.2.0, free-0.1.1, free-0.1.0, free-5
(constraint from project config /build/tmp.NlxaRfGeTi/cabal.project.freeze
requires ==5.1.10)
[__2] fail (backjumping, conflict set: free, servant-client-core)
After searching the rest of the dependency tree exhaustively, these were the
goals I've had most trouble fulfilling: free, servant-client-core, chainweb

jwiegley · 2023-04-17T20:05:41Z

@enobayram I'm seeing this error when I run nix develop:

Vulcan ~/kadena/work/nix-flake/chainweb-node $ nix develop
error: builder for '/nix/store/7gkpi57ig92nf4l54j0cb5g3vs60jg5d-http2-lib-http2-4.0.0-haddock.drv' failed with exit code 1;
       last 10 log lines:
       >     StreamingChunk (Network/HTTP2/Arch/Types.hs:197)
       >     fillBuilderBodyGetNext (Network/HTTP2/Arch/Sender.hs:320)
       >     fillFileBodyGetNext (Network/HTTP2/Arch/Sender.hs:326)
       >     fillStreamBodyGetNext (Network/HTTP2/Arch/Sender.hs:333)
       >
       > Network/HTTP2/Server/Types.hs:33:5: error: parse error on input ‘}’
       >    |
       > 33 |     }
       >    |     ^
       >
       For full logs, run 'nix log /nix/store/7gkpi57ig92nf4l54j0cb5g3vs60jg5d-http2-lib-http2-4.0.0-haddock.drv'.
error: 1 dependencies of derivation '/nix/store/8bnhs552wrpi8cqpr6sgxs92hf791cl0-hoogle-with-packages.drv' failed to build
error: 1 dependencies of derivation '/nix/store/5nbkhnspr7pz6f1bjklsxglxdwigadcc-ghc-shell-for-packages-ghc-8.10.7-env.drv' failed to build
error (ignored): error: cannot unlink '/private/tmp/nix-build-Cabal-lib-Cabal-3.2.1.0.drv-0/Cabal-3.2.1.0': Directory not empty
error: 1 dependencies of derivation '/nix/store/3m2y0ppzw30z9bzrclxzbs2gh7lxxpnf-ghc-shell-for-packages-env.drv' failed to build

enobayram · 2023-04-18T12:56:46Z

@jwiegley Ugh, that's ugly. Luckily, I'm getting the same error on Linux, so I should be able to fix it soon.

chessai · 2023-04-21T21:04:19Z

This also moves us away from haskell4nix (nixpkgs' haskell infrastructure) and over to haskell.nix, so two-in-one. I don't have a problem with that, but I was not expecting that based on the PR title.

jwiegley · 2023-04-24T06:16:28Z

Title updated. It didn't make sense to move to flakes without haskell.nix.

jwiegley · 2023-04-24T18:19:56Z

@enobayram Everything looks good on my end.

default.nix

chessai · 2023-04-24T22:18:01Z

default.nix

+, ...
+}:
+let chainweb-node = pkgs.haskell-nix.project' {
+	    src = ./.;


Looks like this gets rid of nix-gitignore.

Flake input:

nix-gitignore.url = github:hercules-ci/gitignore.nix";

Arguably we would want a shared src attribute between both appearances in default.nix, so they have consistent ignores.

Thanks for pointing out this issue @chessai! I think using hercules-ci/gitignore.nix is a good suggestion, but AFAIK, that only filters out the files that are ignored by git, but it will accept new files that are neither ignored nor tracked by git. I think it's a reasonable thing that it does, but unfortunately that behavior is not the same as how Nix flakes behave. A Nix flake will first be copied to the Nix store and it will get built there. While the Nix flake gets copied, only files that are tracked by git will be copied, but if there are any changes they will be copied with those changes.

Instead of going forward with hercules-ci/gitignore.nix, I've decided to keep default.nix compatible with flake.nix by using src = self.outPath. Here's a demonstration of how this makes default.nix equivalent to flake.nix:

$ nix build --print-out-paths /nix/store/8q1h87dpbv595ik2r5sw6rz29v836qq0-chainweb-exe-chainweb-node-2.18.1 $ nix-build /nix/store/8q1h87dpbv595ik2r5sw6rz29v836qq0-chainweb-exe-chainweb-node-2.18.1 $ touch somenewfile $ nix-build /nix/store/8q1h87dpbv595ik2r5sw6rz29v836qq0-chainweb-exe-chainweb-node-2.18.1 $ nix build --print-out-paths /nix/store/8q1h87dpbv595ik2r5sw6rz29v836qq0-chainweb-exe-chainweb-node-2.18.1 $ echo changing tracked file >> README.md $ nix build --print-out-paths warning: Git tree '.../chainweb-node' is dirty /nix/store/rlxyjmwqalljkzg088dzwy0kd8bbaqnl-chainweb-exe-chainweb-node-2.18.1 $ nix-build warning: Git tree '.../chainweb-node' is dirty /nix/store/rlxyjmwqalljkzg088dzwy0kd8bbaqnl-chainweb-exe-chainweb-node-2.18.1

Arguably we would want a shared src attribute between both appearances in default.nix, so they have consistent ignores.

Seems like this comment isn't applicable anymore with my latest changes.

chessai · 2023-04-24T22:39:42Z

This currently runs into input-output-hk/haskell.nix#1367.

There are workarounds described there.

enobayram · 2023-04-25T08:30:58Z

I will close and reopen the PR for debugging the new github action

larskuhtz · 2023-04-26T17:25:42Z

Are we sure that anybody is using the current docker.nix? I guess that nobody used that in a long time.

This reverts commit 0dad325.

enobayram · 2023-04-26T22:06:47Z

Upon John's advice, I've just pushed a few commits that rename the new default.nix to default-flake.nix and restore the old default.nix. So docker.nix should work as before. So I think this PR is ready to merge as it is, but I'd like to leave to the chainweb team the decision to enable the Mac builds in the CI and unleash the 10-hour first-time builds on the Mac runners.

jwiegley · 2023-04-27T00:21:39Z

Are we good to go here?

larskuhtz

Does this PR replace the previous nix infrastructure? If that's the case, would it be possible to delete the old files?

If the old files are still required, would it be possible to bundle those in a single subdirectory. I don't know which files are actually needed and which ones are just left overs from old setups. In particular, I am not aware that anybody ever used a nix generated docker file for chain web-node -- but I may just not be know about it.

(Ideally, all nix files would go into a ./nix subdirectory, to make it easier to identify which files belong to it. But not sure if that's possible.)

larskuhtz · 2023-04-27T03:53:57Z

cabal.project

@@ -55,26 +55,31 @@ source-repository-package
    type: git
    location: https://github.com/kadena-io/pact.git
    tag: 842fbc4256b3cbbde337dbeaa393b649a26f1574
+    --sha256: sha256-jD4Y2NOSYT0EQHs5BRSVvu8asfvRwt5XLDuZwbcG4mk=


How are those pins determined when updating the source tag for a package? Is that somewhere documented?

In the past we would just wait for the zeus nix build to fail and copy and paste from the failure message? That wasn't ideal (because of the extra CI roundtrip) but worked. Will that method still work?

Is there any mechanism that guarantees that the source version represented by the --sha value matches the sources of the source tag?

In the past (with the old nix infra) we ran into issues where nix pins didn't exactly match the sources of the respective Hackage version and there was no easy way to detected that.

The command to determine the sha locally is:

nix-prefetch-git --url https://github.com/kadena-io/pact.git --rev <SHA>

Could you add that as a comment to the cabal.project file? So when people update that file they find that info?

Could we include an action in the CI workflow that runs that command to double checks that the nix --sha actually matches the source tag?

(You may take a look at cabal CI workflows; there are examples for actions that check that the git tree is still clean after performing some action or test.)

@larskuhtz Earlier today, I've added a step to check the hashes during the github action build, but then later I realized that the check was redundant, because it doesn't seem to be possible to start the build with a wrong sha256 anyway. I've tried multiple ways to fool it, like changing the source-repository-package commit hash without updating the sha256, but the nix build step always failed quickly, telling the correct sha256. As an example, check out this run: https://github.com/kadena-io/chainweb-node/actions/runs/4831581150/jobs/8609217888

The build took 2 minutes to fail and the error message tells you how you need to update the hash:

error: hash mismatch in fixed-output derivation '/nix/store/h9wwd3i3g0shagpc50i5kkms0mbbm5lc-pact-baac04e.drv': specified: sha256-jD4Y2NOSYT0EQHs5BRSVvu8asfvRwt5XLDuZwbcG4mk= got: sha256-PmvS1kNvnOErMpfQPhGp4oOxuZLa34MEXt/Q1p09EKI=

In the past (with the old nix infra) we ran into issues where nix pins didn't exactly match the sources of the respective Hackage version and there was no easy way to detected that.

I can imagine how the old nix infra running on Zeus could perform misleading builds, picking the old source folder from the nix store due to the outdated hash, but I don't think that kind of inconsistency is possible with this new setup.

That's why I've removed the separate cabal.project checks.

Admittedly, the error message you get from the Nix build is not ideal because it doesn't tell you what exactly you need to do. So if somebody encounters this message out of the blue, it could be frustrating to try to debug it.

We could add a hint about how to read this error to the comment that describes how to compute the sha.

default-flake.nix

jwiegley · 2023-04-27T04:51:01Z

@larskuhtz This is intended to replace the previous infrastructure, yes. I'd like to remove the old files soon, but I will do that after giving this new stuff some time to settle in and get plugged into CI.

Because that's what nix-prefetch-git produces

Otherwise the check happens too late.

To avoid downloading the devShell if the environment hasn't changed

So that we can build it without evaluating the flake first.

This reverts commit eb31863.

This reverts commit e170492.

This reverts commit 2666565.

This reverts commit 9a2cd1c.

jwiegley added 5 commits November 30, 2022 14:02

Initial version of flake.nix

a3a8d73

Further work on flake.nix

b87fe81

Update flake.nix and cabal.project

ea46017

Add old Nix files back, they don't conflict

3bd2bdc

Merge branch 'master' into johnw/nix-flake

c8089b0

jwiegley marked this pull request as ready for review December 5, 2022 21:08

jwiegley requested review from edmundnoble and imalsogreg December 5, 2022 21:08

jwiegley and others added 5 commits December 6, 2022 11:56

Merge branch 'master' into johnw/nix-flake

7292803

Merge branch 'master' into johnw/nix-flake

5d9695e

Update the cabal.project hashes

5161f61

Align default.nix with flake.nix

75030b2

Merge branch 'master' into johnw/nix-flake

3d154e6

Avoid the haddock error from http2

bb5b8ab

jwiegley changed the title ~~Add support for Nix flakes~~ Add support for Nix flakes and haskell.nix Apr 24, 2023

Merge branch 'master' into johnw/nix-flake

0720e79

chessai reviewed Apr 24, 2023

View reviewed changes

default.nix Outdated Show resolved Hide resolved

chessai reviewed Apr 24, 2023

View reviewed changes

enobayram added 3 commits April 25, 2023 10:07

Pin explicit commit of nixpkgs

1dd99bd

Add a GitHub action for cached nix builds

024569f

Point "on push" branch to master

86855e2

enobayram closed this Apr 25, 2023

enobayram added 3 commits April 26, 2023 23:57

Revert "Clean up Nix files"

54961bb

This reverts commit 0dad325.

Rename default.nix to default-flake.nix

f681a83

Restore the old default.nix

6d6d927

larskuhtz reviewed Apr 27, 2023

View reviewed changes

Add note to cabal.project on how to determine the sha values

fbdbb33

larskuhtz approved these changes Apr 27, 2023

View reviewed changes

jwiegley assigned jwiegley and enobayram Apr 27, 2023

enobayram added 16 commits April 28, 2023 14:46

Convert cabal.project sha256s to base32

e170492

Because that's what nix-prefetch-git produces

Check the cabal.project hashes during nix build

1a00b59

Move the cabal.project check outside of build

4712fde

Otherwise the check happens too late.

Separate the executable and devShell checks

eca7552

To avoid downloading the devShell if the environment hasn't changed

Add jq to check-cabal-project PATH

4281ac9

Move check-cabal-project to default-flake.nix

8f5d288

So that we can build it without evaluating the flake first.

Fake commit to test cabal.project check

eb31863

Revert "Fake commit to test cabal.project check"

c5d4d12

This reverts commit eb31863.

Expose the haskell source folder derivation

ef7e468

Remove the cabal.project check

043c25a

Revert "Convert cabal.project sha256s to base32"

6e124e4

This reverts commit e170492.

Fake commit to test outdated sha256

2666565

Revert "Fake commit to test outdated sha256"

1921ca2

This reverts commit 2666565.

Fix and improve the source filtering

ae32d93

Fake commit to test source filtering

9a2cd1c

Revert "Fake commit to test source filtering"

d9634a6

This reverts commit 9a2cd1c.

enobayram merged commit 4443f71 into master Apr 28, 2023

larskuhtz deleted the johnw/nix-flake branch April 28, 2023 16:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Nix flakes and haskell.nix #1570

Add support for Nix flakes and haskell.nix #1570

jwiegley commented Dec 1, 2022 •

edited by enobayram

Loading

imalsogreg commented Dec 6, 2022 •

edited

Loading

jwiegley commented Apr 17, 2023

enobayram commented Apr 18, 2023

chessai commented Apr 21, 2023

jwiegley commented Apr 24, 2023

jwiegley commented Apr 24, 2023

chessai Apr 24, 2023

chessai Apr 24, 2023

enobayram Apr 25, 2023

enobayram Apr 25, 2023

chessai commented Apr 24, 2023

enobayram commented Apr 25, 2023

larskuhtz commented Apr 26, 2023

enobayram commented Apr 26, 2023 •

edited

Loading

jwiegley commented Apr 27, 2023

larskuhtz left a comment •

edited

Loading

larskuhtz Apr 27, 2023

larskuhtz Apr 27, 2023

jwiegley Apr 27, 2023

larskuhtz Apr 27, 2023

larskuhtz Apr 27, 2023

enobayram Apr 28, 2023 •

edited

Loading

enobayram Apr 28, 2023

larskuhtz Apr 28, 2023

jwiegley commented Apr 27, 2023

Add support for Nix flakes and haskell.nix #1570

Add support for Nix flakes and haskell.nix #1570

Conversation

jwiegley commented Dec 1, 2022 • edited by enobayram Loading

imalsogreg commented Dec 6, 2022 • edited Loading

jwiegley commented Apr 17, 2023

enobayram commented Apr 18, 2023

chessai commented Apr 21, 2023

jwiegley commented Apr 24, 2023

jwiegley commented Apr 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chessai commented Apr 24, 2023

enobayram commented Apr 25, 2023

larskuhtz commented Apr 26, 2023

enobayram commented Apr 26, 2023 • edited Loading

jwiegley commented Apr 27, 2023

larskuhtz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enobayram Apr 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jwiegley commented Apr 27, 2023

jwiegley commented Dec 1, 2022 •

edited by enobayram

Loading

imalsogreg commented Dec 6, 2022 •

edited

Loading

enobayram commented Apr 26, 2023 •

edited

Loading

larskuhtz left a comment •

edited

Loading

enobayram Apr 28, 2023 •

edited

Loading