nicklayb

nicklayb

Building an Elixir app with Nix and git dependencies

Hello friends,

I’m desperately trying to have a nix build for one my app. I think I’m on the right track but I have a git dependency on the way that just doesn’t seem to be fetchable.

Please note that this is my first actual Nix build, I’ve been running NixOS for a few months now and only been using Nix shells using flakes, but no actual build.

The dependency is a public one: GitHub - nicklayb/box_ex: My Elixir toolbox · GitHub but the project I’m trying to build is currently private. I tried to follow a few blog posts/forum posts/documentation, but here’s how my flake looks at the moment

Relevant files

flake.nix

{
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    flake-utils.url = "github:numtide/flake-utils";
  };
  outputs =
    {
      self,
      nixpkgs,
      flake-utils,
    }:
    flake-utils.lib.eachDefaultSystem (
      system:
      let
        pkgs = nixpkgs.legacyPackages.${system};
        erl = pkgs.beam.interpreters.erlang_27;
        erlangPackages = pkgs.beam.packagesWith erl;
        elixir = erlangPackages.elixir;
      in
      {
        devShells.default = pkgs.mkShell {
          buildInputs = with pkgs; [
            elixir
            erlang_26
            direnv
            inotify-tools
            just
            gphoto2
            v4l-utils
            jq
            ffmpeg
          ];

          shellHook = ''
            eval "$(direnv hook bash)"
            direnv allow
            mix deps.get
          '';
        };
        packages = let
          version = "0.1.0";
          src = ./.;
          mixFodDeps = erlangPackages.fetchMixDeps {
            inherit version src;
            pname = "photo-boite-deps";
            sha256 = "sha256-njEjczedx4mRDZrIzqXXtwr7OoDroOG7hcqzU4WXu6U=";
          };
          translatedPlatform = {
            aarch64-darwin = "macos-arm64";
            aarch64-linux = "linux-arm64";
            armv7l-linux = "linux-armv7";
            x86_64-darwin = "macos-x64";
            x86_64-linux = "linux-x64";
          }
          .${system};
        in rec {
          default = erlangPackages.mixRelease {
            inherit version src mixFodDeps;
            pname = "photo-boite-web";
            postBuild = ''
              mix do deps.loadpaths --no-deps-check, phx.digest
            '';
            preInstall = ''
              ln -s ${pkgs.tailwindcss}/bin/tailwindcss _build/tailwind-${translatedPlatform}
              ln -s ${pkgs.esbuild}/bin/esbuild _build/esbuild-${translatedPlatform}

              ${elixir}/bin/mix assets.deploy
              ${elixir}/bin/mix phx.gen.release
            '';
          };
        };
      }
    );
}

mix.exs

defmodule PhotoBoite.MixProject do
  use Mix.Project

  def project do
    [
      app: :photo_boite,
      version: "0.1.0",
      elixir: "~> 1.14",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      aliases: aliases(),
      deps: deps()
    ]
  end

  def application do
    [
      mod: {PhotoBoite.Application, []},
      extra_applications: [:logger, :runtime_tools]
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(:dev), do: ["lib", "test/support"]
  defp elixirc_paths(_), do: ["lib"]

  defp deps do
    [
      {:bandit, "~> 1.5"},
      # here's my git dep
      {:box, git: "https://github.com/nicklayb/box_ex.git", tag: "0.14.0"},
      {:credo, "~> 1.7.11", runtime: false, only: ~w(dev test)a},
      {:ecto_sql, "~> 3.10"},
      {:esbuild, "~> 0.8", runtime: Mix.env() == :dev},
      {:gettext, "~> 0.26"},
      {:jason, "~> 1.2"},
      {:postgrex, ">= 0.0.0"},
      {:phoenix, "~> 1.7.19"},
      {:phoenix_ecto, "~> 4.5"},
      {:phoenix_live_view, "~> 1.0.4"},
      {:tailwind, "~> 0.2", runtime: Mix.env() == :dev},
      {:tz, "~> 0.28"},
      {:qr_code, "~> 3.2.0"}
    ]
  end

  defp aliases do
    [
      setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
      "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
      "ecto.reset": ["ecto.drop", "ecto.setup"],
      test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"],
      "assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"],
      "assets.build": ["tailwind photo_boite", "esbuild photo_boite"],
      "assets.deploy": [
        "tailwind photo_boite --minify",
        "esbuild photo_boite --minify",
        "phx.digest"
      ],
      gettext: [
        "gettext.extract",
        "gettext.merge priv/gettext"
      ]
    ]
  end
end

The error I’m getting is (only in nix build, works fine locally in a shell):

       last 25 log lines:
       > Generated bandit app
       > ==> websock_adapter
       > Compiling 4 files (.ex)
       > Generated websock_adapter app
       > ==> phoenix
       > Compiling 71 files (.ex)
       > Generated phoenix app
       > ==> phoenix_live_view
       > Compiling 39 files (.ex)
       > Generated phoenix_live_view app
       > ==> box
       > Compiling 37 files (.ex)
       > Generated box app
       > ==> phoenix_ecto
       > Compiling 7 files (.ex)
       > Generated phoenix_ecto app
       > Running phase: buildPhase
       > Compiling 20 files (.ex)
       > Generated photo_boite app
       > Running phase: installPhase
       > Unchecked dependencies for environment prod:
       > * box (https://github.com/nicklayb/box_ex.git - 0.14.0)
       >   lock mismatch: the dependency is out of date. To fetch locked version run "mix deps.get"
       > ** (Mix) Can't continue due to errors on dependencies

Where I am right now:

  • I see mentions of mix2nix (instead of erlangPackages.fetchMixDeps), I don’t fully understand the difference, but mix2nix explicitly says
    • Currently, only public packages from Hex.pm are supported. If you have any dependencies from git, private repositories, or local sources, you will need to manually specify those.

    • I tried to see how to add it manually, but box_ex has its own dependency, do I need to generate a deps.nix on the git dependency too?
  • I saw people saying that there might be build artifact in the nix env so making sure that _build as well deps is gitignore, that’s the case.
  • I noticed that the deps SHA has influence, I had tried to update all my deps and they all had the lock mismatch error, once I updated the SHA, I went back to having only box_ex causing error.

I’m a little lost right now, I love the principle of Nix but the documentation isn’t quite optimal, neither is the tooling.

Any help would be appreciated. Thank you all!

Marked As Solved

nicklayb

nicklayb

I did managed to build using deps-nix. I can now run the binary without any problem. Just gotta add the systemd unit at this point but overall seems fine.

What did it to me was:

  • Use deps-nix to generate a deps.nix file, unlike mix2nix, this one does work with git deps
  • Make sure all my mix calls were doing mix do deps.loadpaths --no-check-deps, [the command]

Thanks @munksgaard for pointing me to flakify which then pointed to deps-nix!

Also Liked

munksgaard

munksgaard

I’ve built a library for this exact purpose: flakify. It requires you to install igniter first, and then you probably need to remove your own flake.nix and flake.lock for it to work, it’ll generate new ones for you.

munksgaard

munksgaard

I apologize for my terseness in the previous response, I was on the train. I’ve corrected the link.

To be clear, this “library”, is actually just a tool that writes a flake.nix file and alters a few things in the default Phoenix setup to make it work. It uses deps.nix to handle dependencies, so (contrary to mix2nix) it works just fine with github dependencies. You could even run flakify in a different test Phoenix repo and just copy the changes over manually.

I have plans to extend the functionality of the script so that it also can produce a NixOS module, systemd service and perhaps a deploy-script, but that’s not done yet.

nicklayb

nicklayb

The link doesn’t seem to work, it doesn’t point to anything.

However, I would likely understand what I am doing, and not rely on something that “dumps” file for me, if you can guide me through what the tool does to make git deps work, I’d be more interested in that

Where Next?

Popular in Questions Top

skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
LegitStack
I’m trying to make a websocket server in Phoenix or raw Elixir. I heard about gun, I think I could use cowboy, but since I’m not that sma...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 53690 245
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
johnnyicon
Hi all, I’ve just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I’m trying to use Postgres...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39297 209
New
saif
Hello everyone, Long time lurker first time poster here. I’ve recently begun working on Elixir full-time again! :raised_hands: It’s been...
New
marick
I had some trouble figuring out how to make many-to-many associations work. Once I got it working, I wrote a blog post. Because I’m a nov...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New

We're in Beta

About us Mission Statement