Merge branch 'hkm/use-cabal-3.8' into hkm/combined-derivations

# Conflicts:
#	builder/hspkg-builder.nix
#	lib/call-cabal-project-to-nix.nix

Author: hamishmack

flake.lock

@@ -1,5 +1,6 @@
 { pkgs, runCommand, cacert, index-state-hashes, haskellLib }@defaults:
 let readIfExists = src: fileName:
+      # Using origSrcSubDir bypasses any cleanSourceWith.
       let origSrcDir = src.origSrcSubDir or src;
       in
         if builtins.elem ((__readDir origSrcDir)."${fileName}" or "") ["regular" "symlink"]
@@ -65,6 +66,7 @@ in
                             # any plutus-apps input being used for a
                             # package.
 , evalPackages
+, pkgconfSelector ? (_: [])
 , supportHpack ? false      # Run hpack on package.yaml files with no .cabal file
 , ...
 }@args:
@@ -123,26 +125,38 @@ let
       type == "directory" ||
       pkgs.lib.any (i: (pkgs.lib.hasSuffix i path)) [ ".cabal" "package.yaml" ]); };
 
-  # Using origSrcSubDir bypasses any cleanSourceWith so that it will work when
-  # access to the store is restricted.  If origSrc was already in the store
-  # you can pass the project in as a string.
-  rawCabalProject =
-    if cabalProject != null
-      then cabalProject + (
-        if cabalProjectLocal != null
-          then ''
-
-            -- Added from cabalProjectLocal argument to cabalProject
-            ${cabalProjectLocal}
-          ''
-          else ""
-      )
-      else null;
-
-  cabalProjectIndexState =
-    if rawCabalProject != null
-    then pkgs.haskell-nix.haskellLib.parseIndexState rawCabalProject
-    else null;
+  # When there is no `cabal.project` file `cabal-install` behaves as if there was
+  # one containing `packages: ./*.cabal`.  Even if there is a `cabal.project.local`
+  # containing some other `packages:`, it still includes `./*.cabal`.
+  #
+  # We could write to `cabal.project.local` instead of `cabal.project` when
+  # `cabalProject == null`.  However then `cabal-install` will look in parent
+  # directories for a `cabal.project` file. That would complicate reasoning about
+  # the relative directories of packages.
+  #
+  # Instead we treat `cabalProject == null` as if it was `packages: ./*.cabal`.
+  #
+  # See: https://github.com/input-output-hk/haskell.nix/pull/1588
+  #      https://github.com/input-output-hk/haskell.nix/pull/1639
+  #
+  rawCabalProject = ''
+    ${
+      if cabalProject == null
+        then ''
+          -- Included to match the implicit project used by `cabal-install`
+          packages: ./*.cabal
+        ''
+        else cabalProject
+    }
+    ${
+      pkgs.lib.optionalString (cabalProjectLocal != null) ''
+        -- Added from `cabalProjectLocal` argument to the `cabalProject` function
+        ${cabalProjectLocal}
+      ''
+    }
+  '';
+
+  cabalProjectIndexState = pkgs.haskell-nix.haskellLib.parseIndexState rawCabalProject;
 
   index-state-found =
     if index-state != null
@@ -155,6 +169,8 @@ let
 
   index-state-pinned = index-state != null || cabalProjectIndexState != null;
 
+  pkgconfPkgs = import ./pkgconf-nixpkgs-map.nix pkgs;
+
 in
   assert (if index-state-found == null
     then throw "No index state passed and none found in ${cabalProjectFileName}" else true);
@@ -295,10 +311,7 @@ let
           );
     };
 
-  fixedProject =
-    if rawCabalProject == null
-      then { sourceRepos = []; repos = {}; extra-hackages = []; makeFixedProjectFile = ""; replaceLocations = ""; }
-      else replaceSourceRepos rawCabalProject;
+  fixedProject = replaceSourceRepos rawCabalProject;
 
   # The use of the actual GHC can cause significant problems:
   # * For hydra to assemble a list of jobs from `components.tests` it must
@@ -320,14 +333,14 @@ let
   # when `checkMaterialization` is set.
   dummy-ghc-data =
     let
-      materialized = ../materialized/dummy-ghc + "/${ghc.targetPrefix}${ghc.name}-${pkgs.stdenv.buildPlatform.system}";
+      materialized = ../materialized/dummy-ghc + "/${ghc.targetPrefix}${ghc.name}-${pkgs.stdenv.buildPlatform.system}"
+        + pkgs.lib.optionalString (builtins.compareVersions ghc.version "8.10" < 0 && ghc.targetPrefix == "" && builtins.compareVersions pkgs.lib.version "22.05" < 0) "-old";
     in pkgs.haskell-nix.materialize ({
       sha256 = null;
       sha256Arg = "sha256";
       materialized = if __pathExists materialized
         then materialized
-        else __trace ("WARNING: No materialized dummy-ghc-data for "
-            + "${ghc.targetPrefix}${ghc.name}-${pkgs.stdenv.buildPlatform.system}.")
+        else __trace "WARNING: No materialized dummy-ghc-data.  mkdir ${toString materialized}"
           null;
       reasonNotSafe = null;
     } // pkgs.lib.optionalAttrs (checkMaterialization != null) {
@@ -456,8 +469,9 @@ let
   }) (evalPackages.runCommand (nameAndSuffix "plan-to-nix-pkgs") {
     nativeBuildInputs = [
       nix-tools.exes.plan-to-nix
-      dummy-ghc dummy-ghc-pkg cabal-install evalPackages.rsync evalPackages.gitMinimal ]
+      dummy-ghc dummy-ghc-pkg cabal-install evalPackages.rsync evalPackages.gitMinimal evalPackages.pkgconfig ]
       ++ pkgs.lib.optional supportHpack nix-tools.exes.hpack;
+    buildInputs = pkgconfSelector pkgconfPkgs;
     # Needed or stack-to-nix will die on unicode inputs
     LOCALE_ARCHIVE = pkgs.lib.optionalString (evalPackages.stdenv.buildPlatform.libc == "glibc") "${evalPackages.glibcLocales}/lib/locale/locale-archive";
     LANG = "en_US.UTF-8";

lib/call-cabal-project-to-nix.nix

@@ -39,7 +39,7 @@
   if (builtins.compareVersions ghcjsVersion "8.10.0.0" >= 0)
   then pkgs.haskell-nix.tool compiler-nix-name "cabal" {
     index-state = pkgs.haskell-nix.internalHackageIndexState;
-    version = "3.6.2.0";
+    version = "3.8.1.0";
     materialized = ../materialized/ghcjs/cabal + "/${compiler-nix-name}";
   }
   else pkgs.haskell-nix.tool compiler-nix-name "cabal" {
@@ -48,7 +48,7 @@
     # Cabal 3.2.1.0 no longer supports he mix of `cabal-version`,
     # lack of `custom-setup` and `v1-install` used by ghcjs boot.
     cabalProjectLocal = ''
-      constraints: Cabal <3.2.1.0
+      constraints: Cabal <3.2.1.0, Cabal-syntax <0
     '';
     materialized = ../materialized/ghcjs/cabal + "/${compiler-nix-name}";
   }

lib/ghcjs-project.nix

@@ -83,9 +83,18 @@ let
         fi
       '')
     + (
-      let fixHint = if builtins.hasContext (toString materialized)
-          then "To fix run: ${updateMaterialized}"
-          else "To fix check you are in the right directory and run: ${generateMaterialized} ${__head (__match "/nix/store/[^/]*/(.*)" (toString materialized))}";
+      let
+        # When the materialized location is already in the store updateMaterialized
+        # will not work, but generateMaterialized will.  We can use this regex to get
+        # a good idea of what directory might be (relative to some unknown parent).
+        # In the regex `[^/]*/?` skips the name of the /nix/store sub directory.
+        matches = __match "${builtins.storeDir}/[^/]*/?(.*)" (toString materialized);
+        fixHint =
+          if matches == null
+            then "To fix run: ${updateMaterialized}" # Not in store so updateMaterialized may work
+          else if __head matches == ""
+            then "To fix run: ${generateMaterialized} <materialized files location>"
+          else "To fix check you are in the right directory and run: ${generateMaterialized} ${__head matches}";
       in if materialized != null && !__pathExists materialized
         then ''
           echo "Materialized nix used for ${name} is missing. ${fixHint}" >> $ERR

lib/materialize.nix

@@ -143,7 +143,8 @@ pkgs:
     "sctp"                               = [ pkgs."lksctp-tools" ]; # This is linux-specific, we should create a common attribute if we ever add sctp support for other systems.
     "sdl2"                               = [ pkgs."SDL2" ];
     "sndfile"                            = [ pkgs."libsndfile" ];
-    "sodium"                             = [ pkgs."libsodium" ];
+    "sodium"                             = [ pkgs."libsodium".dev ];
+    "libsodium"                          = [ pkgs."libsodium".dev ];
     "sqlite3"                            = [ pkgs."sqlite" ];
     "ssh2"                               = [ pkgs."libssh2" ];
     "statgrab"                           = [ pkgs."libstatgrab" ];