nix-files/flake.nix

# docs:
# - <https://nixos.wiki/wiki/Flakes>
# - <https://serokell.io/blog/practical-nix-flakes>

{
  inputs = {
    nixpkgs-stable.url = "nixpkgs/nixos-22.11";
    nixpkgs-unpatched.url = "nixpkgs/nixos-unstable";
    nixpkgs = {
      url = "path:nixpatches";
      inputs.nixpkgs.follows = "nixpkgs-unpatched";
    };
    mobile-nixos = {
      url = "github:nixos/mobile-nixos";
      flake = false;
    };
    home-manager = {
      url = "github:nix-community/home-manager/release-22.05";
      inputs.nixpkgs.follows = "nixpkgs";
    };
    sops-nix = {
      url = "github:Mic92/sops-nix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
    uninsane-dot-org = {
      url = "git+https://git.uninsane.org/colin/uninsane";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = {
    self,
    nixpkgs,
    nixpkgs-stable,
    nixpkgs-unpatched,
    mobile-nixos,
    home-manager,
    sops-nix,
    uninsane-dot-org
  }:
    let
      nixpkgsCompiledBy = local: nixpkgs.legacyPackages."${local}";

      decl-host = { name, local, target }:
        let
          # XXX: we'd prefer to use `nixosSystem = (nixpkgsCompiledBy local).nixos`
          # but it doesn't propagate config to the underlying pkgs, meaning it doesn't let you use
          # non-free packages even after setting nixpkgs.allowUnfree.
          nixosSystem = import ((nixpkgsCompiledBy local).path + "/nixos/lib/eval-config.nix");
        in
          (nixosSystem {
            # we use pkgs built for and *by* the target, i.e. emulation, by default.
            # cross compilation only happens on explicit access to `pkgs.cross`
            system = target;
            modules = [
              self.nixosModules.default
              self.nixosModules.passthru
              (import ./hosts/instantiate.nix name)
              {
                nixpkgs.overlays = [
                  self.overlays.default
                  self.overlays.passthru
                  (next: prev: {
                    # for local != target we by default just emulate the target while building.
                    # provide a `pkgs.cross.<pkg>` alias that consumers can use instead of `pkgs.<foo>`
                    # to explicitly opt into non-emulated cross compilation for any specific package.
                    # this is most beneficial for large packages with few pre-requisites -- like Linux.
                    cross = next.crossFrom."${local}";
                  })
                ];
              }
            ];
          });

      decl-bootable-host = { name, local, target }: rec {
        nixosConfiguration = decl-host { inherit name local target; };
        # this produces a EFI-bootable .img file (GPT with a /boot partition and a system (/ or /nix) partition).
        # after building this:
        #   - flash it to a bootable medium (SD card, flash drive, HDD)
        #   - resize the root partition (use cfdisk)
        #   - mount the part
        #      - chown root:nixbld <part>/nix/store
        #      - chown root:root -R <part>/nix/store/*
        #      - chown root:root -R <part>/persist  # if using impermanence
        #      - populate any important things (persist/, home/colin/.ssh, etc)
        #   - boot
        #   - if fs wasn't resized automatically, then `sudo btrfs filesystem resize max /`
        #   - checkout this flake into /etc/nixos AND UPDATE THE FS UUIDS.
        #   - `nixos-rebuild --flake './#<host>' switch`
        img = nixosConfiguration.config.system.build.img;
      };
      hosts = {
        servo = decl-bootable-host { name = "servo"; local = "x86_64-linux"; target = "x86_64-linux"; };
        desko = decl-bootable-host { name = "desko"; local = "x86_64-linux"; target = "x86_64-linux"; };
        lappy = decl-bootable-host { name = "lappy"; local = "x86_64-linux"; target = "x86_64-linux"; };
        moby = decl-bootable-host { name = "moby"; local = "aarch64-linux"; target = "aarch64-linux"; };
        # special cross-compiled variant, to speed up deploys from an x86 box to the arm target
        # note that these *do* produce different store paths, because the closure for the tools used to cross compile
        # v.s. emulate differ.
        # so deploying foo-cross and then foo incurs some rebuilding.
        moby-cross = decl-bootable-host { name = "moby"; local = "x86_64-linux"; target = "aarch64-linux"; };
        rescue = decl-bootable-host { name = "rescue"; local = "x86_64-linux"; target = "x86_64-linux"; };
      };
    in {
      nixosConfigurations = builtins.mapAttrs (name: value: value.nixosConfiguration) hosts;
      imgs = builtins.mapAttrs (name: value: value.img) hosts;

      overlays = rec {
        default = pkgs;
        pkgs = import ./pkgs/overlay.nix;
        passthru = next: prev:
          let
            stable = nixpkgs-stable.legacyPackages."${prev.stdenv.hostPlatform}";
            cross = (next: prev: {
              # non-emulated packages build *from* local *for* target.
              # for large packages like the linux kernel which are expensive to build under emulation,
              # the config can explicitly pull such packages from `pkgs.cross` to do more efficient cross-compilation.
              crossFrom."x86_64-linux" = (prev.forceSystem "x86_64-linux" null).appendOverlays next.overlays;
              crossFrom."aarch64-linux" = (prev.forceSystem "aarch64-linux" null).appendOverlays next.overlays;
            });
            mobile = (import "${mobile-nixos}/overlay/overlay.nix");
            uninsane = uninsane-dot-org.overlay;
          in
            uninsane next (mobile next (cross next (stable next prev)));
      };

      nixosModules = rec {
        default = sane;
        sane = import ./modules;
        passthru = { ... }: {
          imports = [
            home-manager.nixosModule
            sops-nix.nixosModules.sops
          ];
        };
      };

      packages =
        let
          allPkgsFor = sys:
            let
              pkgsBase = nixpkgsCompiledBy sys;
              pkgsFull = pkgsBase.appendOverlays [
                self.overlays.passthru self.overlays.pkgs
              ];
            in pkgsFull.sane // {
              inherit (pkgsFull) sane uninsane-dot-org;
              nixpkgs = pkgsBase;
            };
        in {
          x86_64-linux = allPkgsFor "x86_64-linux";
          aarch64-linux = allPkgsFor "aarch64-linux";
        };

      templates = {
        python-data = {
          # initialize with:
          # - `nix flake init -t '/home/colin/dev/nixos/#python-data'`
          # then enter with:
          # - `nix develop`
          path = ./templates/python-data;
          description = "python environment for data processing";
        };
      };
    };
}