wb | obtain all dependencies from the same, maybe custom, haskell.nix project

Author: fmaste

nix/pkgs.nix

@@ -6,9 +6,12 @@ let
   inherit (final) pkgs;
   inherit (prev.pkgs) lib;
   inherit (prev) customConfig;
-  # Workbench development environment entrypoint parametrized with current pkgs.
+  # Parametrized helper entrypoint for the workbench development environment.
   workbench = import ./workbench
-    {inherit pkgs lib; inherit (final) cardanoNodePackages cardanoNodeProject;};
+    { inherit pkgs lib;
+      haskellProject = final.cardanoNodeProject;
+    }
+  ;
 
 in with final;
 {

nix/workbench/backend/nomad.nix

@@ -1,5 +1,6 @@
 { pkgs
 , lib
+, haskellProject
 , stateDir
 , subBackendName
 , ...
@@ -145,29 +146,33 @@ let
       # the one used to enter the shell.
       cardano-node = rec {
         # Local reference only used if not "cloud".
-        # Avoid rebuilding on every commit because of `set-git-rev`.
-        nix-store-path = pkgs.cardanoNodePackages.cardano-node.passthru.noGitRev;
+        nix-store-path = haskellProject.exes.cardano-node;
         flake-reference = "github:intersectmbo/cardano-node";
+        # Where to fetch the binary from during "cloud" runs.
+        # Avoid nix cache misses on every commit because of `set-git-rev`.
         flake-output = "cardanoNodePackages.cardano-node.passthru.noGitRev"
         ;
       };
       cardano-cli = rec {
         # Local reference only used if not "cloud".
-        # Avoid rebuilding on every commit because of `set-git-rev`.
-        nix-store-path = pkgs.cardanoNodePackages.cardano-cli.passthru.noGitRev;
+        nix-store-path = (haskellProject.getPackage "cardano-cli").components.exes.cardano-cli;
         flake-reference = "github:input-output-hk/cardano-cli";
+        # Where to fetch the binary from during "cloud" runs.
+        # Avoid nix cache misses on every commit because of `set-git-rev`.
         flake-output = "cardanoNodePackages.cardano-cli.passthru.noGitRev";
       };
       cardano-tracer = rec {
         # Local reference only used if not "cloud".
-        nix-store-path = pkgs.cardanoNodePackages.cardano-tracer;
+        nix-store-path = haskellProject.exes.cardano-tracer;
         flake-reference = "github:intersectmbo/cardano-node";
         flake-output = "cardanoNodePackages.cardano-tracer";
       };
       tx-generator = rec {
         # Local reference only used if not "cloud".
-        nix-store-path = pkgs.cardanoNodePackages.tx-generator.passthru.noGitRev;
+        nix-store-path = haskellProject.exes.tx-generator;
         flake-reference = "github:intersectmbo/cardano-node";
+        # Where to fetch the binary from during "cloud" runs.
+        # Avoid nix cache misses on every commit because of `set-git-rev`.
         flake-output = "cardanoNodePackages.tx-generator.passthru.noGitRev";
       };
     }

nix/workbench/backend/nomad/cloud.nix

@@ -1,5 +1,6 @@
 { pkgs
 , lib
+, haskellProject
 , stateDir
 , basePort     # ignored, just passed to the runner (unlike `supervisor.nix`).
 ## `useCabalRun` overridden parameter (unlike `supervisor.nix`).
@@ -39,7 +40,9 @@ let
   # Build a Nomad Job specification for this Nomad "sub-backend".
   materialise-profile =
     let params = {
-      inherit pkgs lib stateDir;
+      inherit pkgs lib;
+      inherit haskellProject;
+      inherit stateDir;
       subBackendName = "cloud";
     };
     in (import ../nomad.nix params).materialise-profile

nix/workbench/backend/nomad/exec.nix

@@ -1,5 +1,6 @@
 { pkgs
 , lib
+, haskellProject
 , stateDir
 , basePort     # ignored, just passed to the runner (unlike `supervisor.nix`).
 ## `useCabalRun` overridden parameter (unlike `supervisor.nix`).
@@ -37,7 +38,9 @@ let
   # Build a Nomad Job specification for this Nomad "sub-backend".
   materialise-profile =
     let params = {
-      inherit pkgs lib stateDir;
+      inherit pkgs lib;
+      inherit haskellProject;
+      inherit stateDir;
       subBackendName = "exec";
     };
     in (import ../nomad.nix params).materialise-profile

nix/workbench/backend/runner.nix

@@ -1,7 +1,6 @@
 { pkgs, lib
 ## The binaries/scripts to use when calling the workbench.
-, cardanoNodeProject
-, cardanoNodePackages
+, haskellProject
 , workbench # The derivation.
 ## Profile dependent parameters.
 , profile
@@ -33,9 +32,9 @@ let
   cacheDir = "${__getEnv "HOME"}/.cache/cardano-workbench";
 
   # recover CHaP location from cardano's project
-  chap = cardanoNodeProject.args.inputMap."https://chap.intersectmbo.org/";
+  chap = haskellProject.args.inputMap."https://chap.intersectmbo.org/";
   # build plan as computed by nix
-  nixPlanJson = cardanoNodeProject.plan-nix + "/plan.json";
+  nixPlanJson = haskellProject.plan-nix + "/plan.json";
 
   # Optimize cache hits setting gitrev using bash once inside the shell.
   workbench-envars =
@@ -122,12 +121,9 @@ let
       ]
     )
     ++
-    (with cardanoNodePackages;
-      [
-        cardano-cli
-        locli
-      ]
-    )
+    [ haskellProject.exes.locli
+      haskellProject.hsPkgs.cardano-cli.components.exes.cardano-cli
+    ]
   ;
 
   workbench-profile-run =
@@ -200,7 +196,7 @@ let
           --genesis-cache-entry ${genesisFiles}
           --batch-name          smoke-test
           --base-port           ${toString basePort}
-          --node-source         ${pkgs.cardanoNodeProject.args.src}
+          --node-source         ${haskellProject.args.src}
           --node-rev            ${cardano-node-rev}
           --cache-dir           ./cache
          ${__concatStringsSep " " workbenchStartArgs}

nix/workbench/backend/supervisor.nix

@@ -1,5 +1,6 @@
 { pkgs
 , lib
+, haskellProject
 , stateDir
 , basePort
 , useCabalRun

nix/workbench/default.nix

@@ -1,6 +1,17 @@
+# The workbench entrypoint,
 { pkgs, lib
-, cardanoNodeProject
-, cardanoNodePackages
+  # This provided project attrset will be used all over the workbench instead
+  # of the flake's `pkgs` or `cardanoNodePackages`. This allows to easily
+  # parametrize the whole build at any point, be it only for the workbench in
+  # "nix/pkgs.nix" or when entering a workbench shell in
+  # "nix/workbench/shell.nix".
+  # Also, by using a haskell.nix project instead of `cardanoNodePackages` or
+  # `pkgs` to fetch it's project related dependencies we are sure they are not
+  # tagged with the git commit because if we use the `set-git-rev` versions of
+  # `cardano-node` and/or `tx-generator` then on every distinct commit ID all
+  # the scripts generated by the workbench (start.sh files) will be re-generated
+  # instead of obtained from the cache in the nix store.
+, haskellProject
 }:
 
 with lib;
@@ -51,7 +62,7 @@ let
             )
             # Include only the extensions defined above.
             (lib.any id
-              (attrValues (mapAttrs
+              (lib.attrValues (mapAttrs
                 (dirName: suffixes:
                      (lib.hasPrefix (dirName + "/") relativePath)
                   &&
@@ -90,7 +101,7 @@ let
 
   profile-names-json = pkgs.runCommand "profile-names.json" {}
     ''
-    ${cardanoNodePackages.cardano-profile}/bin/cardano-profile "names" > $out
+    ${haskellProject.exes.cardano-profile}/bin/cardano-profile "names" > $out
     ''
   ;
 
@@ -99,8 +110,8 @@ let
 
 in pkgs.lib.fix (self: {
 
-  inherit cardanoNodePackages;
   inherit workbench;
+  inherit haskellProject;
   inherit profile-names-json profile-names;
 
   # Return a profile attr with a `materialise-profile` function.
@@ -132,7 +143,9 @@ in pkgs.lib.fix (self: {
      , profiling
      }:
       (backendRegistry."${backendName}")
-        { inherit pkgs lib stateDir basePort;
+        { inherit pkgs lib;
+          inherit haskellProject;
+          inherit stateDir basePort;
           # The `useCabalRun` and `profiling` flags are set in the backend to
           # allow the backend to override its values. The runner must use the
           # value of these two flags from the backend to prevent having a runner
@@ -175,7 +188,7 @@ in pkgs.lib.fix (self: {
     in import ./backend/runner.nix
       {
           inherit pkgs lib;
-          inherit cardanoNodeProject cardanoNodePackages;
+          inherit haskellProject;
           inherit workbench;
           inherit profile backend;
           inherit batchName workbenchStartArgs;

nix/workbench/profile/profile.nix

@@ -1,5 +1,5 @@
 { pkgs, lib
-# The workbench development environment as it was parametrized.
+# The workbench attrset as it was parametrized.
 , workbenchNix
 , profileName
 }:
@@ -19,8 +19,8 @@ let
               moreutils # sponge
               jq
               graphviz
-              workbenchNix.cardanoNodePackages.cardano-profile
-              workbenchNix.cardanoNodePackages.cardano-topology
+              workbenchNix.haskellProject.exes.cardano-profile
+              workbenchNix.haskellProject.exes.cardano-topology
             ];
           }
           ''
@@ -56,12 +56,13 @@ let
       profile = __fromJSON (__readFile profileJsonPath);
       nodeSpecs = __fromJSON (__readFile nodeSpecsJsonPath);
       inherit
-        (pkgs.callPackage
+        (import
           ../service/nodes.nix
-          { inherit backend profile nodeSpecs;
+          { inherit pkgs;
+            inherit workbenchNix;
+            inherit backend profile nodeSpecs;
             inherit (backend) profiling;
             inherit profileJsonPath topologyJsonPath;
-            inherit workbenchNix;
             ## This ports the (very minimal) config of the deprecated iohk-nix
             ## testnet environment to workbench, removing the dependency on it.
             baseNodeConfig =
@@ -72,16 +73,18 @@ let
                 LastKnownBlockVersion-Alt   = 0;
               }
               //
-              workbenchNix.cardanoNodePackages.cardanoLib.defaultLogConfig
+              workbenchNix.haskellProject.pkgs.cardanoLib.defaultLogConfig
             ;
           }
         )
         node-services
       ;
       inherit
-        (pkgs.callPackage
+        (import
           ../service/generator.nix
-          { inherit backend profile nodeSpecs;
+          { inherit pkgs;
+            inherit (workbenchNix) haskellProject;
+            inherit backend profile nodeSpecs;
             inherit node-services;
           }
         )
@@ -93,7 +96,10 @@ let
           start =
             ''
             ${import ../workload/${name}.nix
-              {inherit pkgs profile nodeSpecs workload;}
+              { inherit pkgs;
+                inherit (workbenchNix) haskellProject;
+                inherit profile nodeSpecs workload;
+              }
             }
             ${workload.entrypoints.producers}
             ''
@@ -102,16 +108,22 @@ let
         profile.workloads
       ;
       inherit
-        (pkgs.callPackage
+        (import
           ../service/tracer.nix
-          {inherit backend profile nodeSpecs;}
+          { inherit pkgs;
+            inherit (workbenchNix) haskellProject;
+            inherit backend profile nodeSpecs;
+          }
         )
         tracer-service
       ;
       healthcheck-service =
-        (pkgs.callPackage
+        (import
           ../service/healthcheck.nix
-          {inherit backend profile nodeSpecs;}
+          { inherit pkgs;
+            inherit (workbenchNix) haskellProject;
+            inherit backend profile nodeSpecs;
+          }
         )
       ;
     in {
@@ -146,7 +158,7 @@ let
         inherit topologyJsonPath topologyDotPath;
         inherit nodeSpecsJsonPath;
         nodeServices = __toJSON
-          (lib.mapAttrs
+          (pkgs.lib.mapAttrs
             (name: node-service:
               { inherit name;
                 inherit (node-service) start config;

nix/workbench/service/generator.nix

@@ -1,5 +1,5 @@
 { pkgs
-
+, haskellProject
 , backend
 , profile
 , nodeSpecs
@@ -57,11 +57,13 @@ let
         ;
       } // optionalAttrs profile.node.tracer {
         tracerSocketPath = "../tracer/tracer.socket";
+      # Decide where the executable comes from:
+      #########################################
       } // optionalAttrs (!backend.useCabalRun) {
-        # Use to `noGitRev` to avoid rebuilding on every commit.
-        executable     = "${pkgs.cardanoNodePackages.tx-generator.passthru.noGitRev}/bin/tx-generator";
-      } // optionalAttrs backend.useCabalRun {
+        executable     = "${haskellProject.exes.tx-generator}/bin/tx-generator";
+      } // optionalAttrs   backend.useCabalRun  {
         executable     = "tx-generator";
+      #########################################
       });
 
   ##

nix/workbench/service/healthcheck.nix

@@ -1,4 +1,5 @@
 { pkgs
+, haskellProject
 , backend
 , profile
 , nodeSpecs
@@ -12,17 +13,19 @@ let
   supervisor      = pkgs.supervisor;
   grep            = pkgs.gnugrep;
   jq              = pkgs.jq;
-  # Avoid rebuilding the script on every commit.
-  # `noGitRev` does not have `set-git-rev` that is set on every commit.
-  cardano-node = with pkgs;
+  # Decide where the executables come from:
+  #########################################
+  cardano-node =
     if backend.useCabalRun
     then "cardano-node"
-    else cardanoNodePackages.cardano-node.passthru.noGitRev + "/bin/cardano-node"
+    else haskellProject.exes.cardano-node + "/bin/cardano-node"
   ;
-  cardano-cli  = with pkgs;
+  cardano-cli  =
     if backend.useCabalRun
     then "cardano-cli"
-    else cardanoNodePackages.cardano-cli.passthru.noGitRev + "/bin/cardano-cli";
+    else haskellProject.hsPkgs.cardano-cli.components.exes.cardano-cli + "/bin/cardano-cli"
+  ;
+  #########################################
 in {
   start =
     # Assumptions: