mirror of https://github.com/status-im/status-react.git synced 2025-01-10 02:56:07 +00:00

nix: switch status-im config to env vars, cleanup

To help with #15595 changes, refactoring is required.
In this PR we switch from config to env vars.
Doing some cleanup meanwhile.

2023-08-07 14:50:36 +02:00

4.3 KiB

Raw Blame History

Description

This document describes the layout of our Nix setup.

Folders

There are four main folders in the nix directory:

nix/scripts - Bash scripts for easier usage of Nix
nix/pkgs - Packages we add to or modify in nixpkgs
nix/deps - Project dependencies managed by Nix
nix/lib - Our tools we merge into pkgs.lib
nix/tools - Various tools used by our derivations and shells
nix/status-go - Derivations for building status-go repo

Files

There are a few main files that define the whole build environment:

nix/nix.conf - Binary cache configuration
nix/default.nix - Entry point for both shells and targets
nix/shell.nix - Definition of the default Nix shell
nix/shells.nix - Definitions of other Nix shells used in builds
nix/targets.nix - Hierarchy of main build targets
nix/pkgs.nix - Definition of a custom nixpkgs repo
nix/overlay.nix - Overrides for nixpkgs, custom packages

The default.nix and shell.nix files at th repo root are just a gateway into the nix sub folder.

Scripts

There's a few scripts in nix/scripts that make use of Nix simpler:

nix/scripts/setup.sh - Installs Nix Package manager
nix/scripts/source.sh - Sources the Nix profile or installs Nix
nix/scripts/build.sh - A wrapper around nix-build with sane defaults
nix/scripts/shell.sh - A wrapper around nix-shell for Makefile
nix/scripts/clean.sh - For cleaning Nix store after builds
nix/scripts/purge.sh - For purging everything Nix related from system

Start

The starting point for using our Nix shells and targets is the default.nix file.

It pulls in all the pkgs, targets and shells defined in nix/default.nix. The point is easy access to them via commands like nix-build or nix-shell, which you'll see next.

Shells

Normally shells are started using make shell TARGET=default, but that is essentially the same as calling:

nix-shell -A shells.default default.nix

The nix/scripts/shell.sh script is essentially a wrapper around that command to make it usable as shell for the Makefile.

Building

We will use the make jsbundle target as an example of a derivation you can build using Nix:

make jsbundle is called by developer
make calls nix/scripts/build.sh targets.mobile.jsbundle
build.sh calls nix-build --attr targets.mobile.jsbundle with extra arguments
nix-build builds the derivation from nix/mobile/jsbundle/default.nix

The same can be done for other targets like targets.mobile.android.release. Except in that case extra arguments are required which is why the scripts/release-android.sh is used in the make release-android target.

If you run make release-android you'll see the nix-build command used:

nix-build \
  --pure \
  --fallback \
  --no-out-link \
  --show-trace \
  --attr targets.mobile.android.release \
  --argstr secrets-file '/tmp/tmp-status-mobile-559a3a441/tmp.xAnrPuNtAP' \
  --option extra-sandbox-paths '/home/joe/.gradle/status-im.keystore /tmp/tmp-status-mobile-559a3a441/tmp.xAnrPuNtAP' \
  default.nix

Some of those are required which is why just calling:

nix-build --attr targets.mobile.android.release

Would fail.

Garbage Collection

The make nix-gc target calls nix-store --gc and normally would remove almost everything, but to prevent that we place symlinks to protected derivations in /nix/var/nix/gcroots subfolder. Specifically:

_NIX_GCROOTS="${_NIX_GCROOTS:-/nix/var/nix/gcroots/per-user/${USER}/status-mobile}"

Whenever nix/scripts/build.sh or nix/scripts/shell.sh are called they update symlinks named after given targets in that folder. This in combination with keep-outputs = true set in nix/nix.conf prevents garbage collection from removing too much.

4.3 KiB Raw Blame History