Refactor Nix Code (remove iogx) #6795

zeme-wana · 2025-01-16T19:21:58Z

iogx was created as a top-level abstraction layer for Haskell projects at IOG. It wraps haskell.nix, simplifying the process of setting up a working Flake. It makes several assumptions and provides additional features like a more powerful development shell, Read the Docs integration, and pre-configured pre-commit hooks.

Since its integration into Plutus, some of these features have become obsolete (e.g., Read the Docs), and we’ve realized we can rely more directly on haskell.nix for the rest.

Unisay · 2025-01-31T09:16:13Z

flake.nix

    nixpkgs-2405.follows = "haskell-nix/nixpkgs-2405";

+    nixpkgs.follows = "haskell-nix/nixpkgs";


Used to follow nixpkgs-unstable, switched to nixpkgs now. Why?

If I recall correctly, we used to follow nixpkgs-unstable in order to access some packages not available in nixpkgs.
But in general we want to follow a stable nixpkgs if possible.

Unisay · 2025-01-31T09:17:28Z

flake.nix

@@ -2,18 +2,10 @@
  description = "Plutus Core";

  inputs = {
-
-    iogx = {


By the way, this PR has no explanation, and I am not clear on the following:

what is the problem with using iogx ?

why is it used in the first place? What value does it add?

Good point. I added a comment, and a follow up here:
I wanted to explore what the code would look like without iogx and whether the shell would be lighter as a result (it is).
At this point, iogx doesn’t seem to provide enough value to justify its (future) maintenance cost. Removing it also makes the codebase more accessible to future maintainers.

Unisay · 2025-01-31T09:19:32Z

flake.nix

+  outputs = inputs: inputs.flake-utils.lib.eachDefaultSystem (system:
+    import ./nix/outputs.nix { inherit inputs system; }
+  );


What I understand here is that instead of using iogx to create flake outputs we're creating outputs ourselves.

Yes iogx worked some magic and included some outputs in addition to the one explicitly defined by the user.

Unisay · 2025-01-31T09:21:45Z

flake.nix

    };

+    flake-utils.url = "github:numtide/flake-utils";
+
+    pre-commit-hooks.url = "github:cachix/git-hooks.nix";


IIUC, before this output was added by iogx.lib.mkFlake, right? Are there any other outputs that were added by iogx and are not present now?

Yes this input was added by iogx. There are no other hidden inputs.

Unisay · 2025-01-31T09:23:30Z

nix/agda-with-stdlib.nix

@@ -1,6 +1,6 @@
-{ repoRoot, inputs, pkgs, system, lib }:


I don't get what exactly do these changes in the agda-related file have to do with iogx removal?

iogx expected each nix file to be a function from { repoRoot, inputs, pkgs, system, lib }:.
This is no longer the case.

Unisay · 2025-01-31T09:24:09Z

nix/build-latex.nix

@@ -1,12 +1,14 @@
-{ repoRoot, inputs, pkgs, system, lib }:


Same here: not clear how these changes are related to the iogx removal.

Same as above

Unisay · 2025-01-31T09:28:04Z

nix/outputs.nix

+in
+
+{
+  inherit __internal;


Why is this __internal indirection needed? Can't you inherit what's int the __internal directly?

I don't want to pollute the top-level flake namespace with a bunch of things.
This is only used for debugging.
The top-level should only have packages, devShells, etc...

Unisay · 2025-01-31T09:29:11Z

nix/outputs.nix

+
+  flattened-ci-jobs = utils.flattenDerivationTree ":" nested-ci-jobs;
+
+  ciJobs = utils.flattenDerivationTree ":" nested-ci-jobs.${system};


Can you refer to the flattened-ci-jobs above?

I wish, but no, we'll have to live with a little repetition

Unisay · 2025-01-31T09:33:19Z

nix/project.nix

@@ -1,6 +1,5 @@
 # editorconfig-checker-disable-file
-
-{ repoRoot, inputs, pkgs, system, lib }:
+{ inputs, pkgs, lib, agda-with-stdlib, r-with-packages }:


YaY! this way the dependencies are more explicit, liking it!

Unisay · 2025-01-31T09:34:36Z

nix/project.nix

@@ -12,18 +11,9 @@ let

    src = ../.;

-    shell = {


Why is this shell getting removed?

It has been moved to nix/shell.nix:project.shellFor which is now the only source of truth for all shell things

Unisay · 2025-01-31T09:36:58Z

nix/r-with-packages.nix

@@ -1,4 +1,4 @@
-{ repoRoot, inputs, pkgs, system, lib }:
+{ pkgs }:


its only the rPackages that's used, I suggest declaring it as a parameter directly, avoiding passing in all the unnecessary pkgs.

I'd rather draw the line at pkgs and let consumers pull from it.
Also it's both rPackages and rWrapper

Unisay · 2025-01-31T09:56:51Z

nix/utils.nix

@@ -0,0 +1,16 @@
+{ lib }:
+{
+  flattenDerivationTree = separator: set:


This function is only used in the outputs.nix, I'd simply keep it there.

True but I prefer it here. One day it could be used elsewhere, or nix/utils.nix could have more functions.

zeme-wana temporarily deployed to github-pages January 16, 2025 19:22 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages January 16, 2025 19:24 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages January 16, 2025 19:27 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages January 16, 2025 19:48 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages January 17, 2025 07:14 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages January 18, 2025 23:56 — with GitHub Actions Inactive

zeme-wana marked this pull request as ready for review January 28, 2025 14:50

zeme-wana force-pushed the no-iogx branch from 6fd0f79 to 1b887ea Compare January 29, 2025 14:36

zeme-wana had a problem deploying to github-pages January 29, 2025 14:36 — with GitHub Actions Error

zeme-wana added the No Changelog Required Add this to skip the Changelog Check label Jan 29, 2025

zeme-wana temporarily deployed to github-pages January 29, 2025 17:44 — with GitHub Actions Inactive

zeme-wana force-pushed the no-iogx branch from 8085a3d to 914825d Compare January 29, 2025 17:44

zeme-wana temporarily deployed to github-pages January 29, 2025 17:44 — with GitHub Actions Inactive

zeme-wana force-pushed the no-iogx branch from 914825d to b121bb5 Compare January 29, 2025 17:53

zeme-wana temporarily deployed to github-pages January 29, 2025 17:54 — with GitHub Actions Inactive

zeme-wana added 14 commits January 30, 2025 15:30

wip

fbfab90

wip

538dc94

wip

333f997

wip

4b93200

done

80c0ea3

wip

c7bff8c

wip

b7b6f0e

wip

e20dd86

wip

07882e5

wip

660e6e7

wip

e30f250

Done

4ca269a

wip

40aee8c

wip

e118605

zeme-wana force-pushed the no-iogx branch from b121bb5 to e118605 Compare January 30, 2025 14:30

zeme-wana temporarily deployed to github-pages January 30, 2025 14:30 — with GitHub Actions Inactive

zeme-wana requested a review from Unisay January 30, 2025 14:33

Unisay reviewed Jan 31, 2025

View reviewed changes

Unisay approved these changes Jan 31, 2025

View reviewed changes

Merge branch 'master' into no-iogx

89a5799

zeme-wana temporarily deployed to github-pages February 4, 2025 08:42 — with GitHub Actions Inactive

zeme-wana enabled auto-merge (squash) February 4, 2025 08:43

zeme-wana disabled auto-merge February 4, 2025 10:19

zeme-wana merged commit bb1ff54 into master Feb 4, 2025
4 of 7 checks passed

zeme-wana deleted the no-iogx branch February 4, 2025 10:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Nix Code (remove iogx) #6795

Refactor Nix Code (remove iogx) #6795

zeme-wana commented Jan 16, 2025 •

edited

Loading

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025 •

edited

Loading

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

Unisay Jan 31, 2025

zeme-wana Feb 3, 2025

		nixpkgs-2405.follows = "haskell-nix/nixpkgs-2405";

		nixpkgs.follows = "haskell-nix/nixpkgs";


		flattened-ci-jobs = utils.flattenDerivationTree ":" nested-ci-jobs;

		ciJobs = utils.flattenDerivationTree ":" nested-ci-jobs.${system};

		@@ -1,4 +1,4 @@
		{ repoRoot, inputs, pkgs, system, lib }:
		{ pkgs }:

Refactor Nix Code (remove iogx) #6795

Refactor Nix Code (remove iogx) #6795

Conversation

zeme-wana commented Jan 16, 2025 • 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

Unisay Jan 31, 2025 • 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

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

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

zeme-wana commented Jan 16, 2025 •

edited

Loading

Unisay Jan 31, 2025 •

edited

Loading