github.com/benchkram/bob@v0.0.0-20240314204020-b7a57f2f9be9/pkg/nix/nix.go

package nix

import (
	"bytes"
	"errors"
	"fmt"
	"os"
	"os/exec"
	"runtime"
	"strings"
	"time"

	"github.com/benchkram/bob/bob/global"
	"github.com/benchkram/bob/pkg/boblog"
	"github.com/benchkram/bob/pkg/filehash"
	"github.com/benchkram/bob/pkg/format"
	"github.com/benchkram/bob/pkg/usererror"
	"github.com/benchkram/errz"
)

type Dependency struct {
	// Name of the dependency
	Name string
	// Nixpkgs can be empty or a link to desired revision
	// ex. https://github.com/NixOS/nixpkgs/archive/eeefd01d4f630fcbab6588fe3e7fffe0690fbb20.tar.gz
	Nixpkgs string
}

// IsInstalled checks if nix is installed on the system
func IsInstalled() bool {
	_, err := exec.LookPath("nix")
	return err == nil
}

// BuildDependencies build nix dependencies and returns a <package>-<nix store path> map
//
// dependencies can be either a package name ex. php or a path to .nix file
// nixpkgs can be empty which means it will use local nixpkgs channel
// or a link to desired revision ex. https://github.com/NixOS/nixpkgs/archive/eeefd01d4f630fcbab6588fe3e7fffe0690fbb20.tar.gz
func BuildDependencies(deps []Dependency, cache *Cache) (err error) {
	defer errz.Recover(&err)

	var unsatisfiedDeps []Dependency

	for _, v := range deps {
		if cache != nil {
			key, err := GenerateKey(v)
			errz.Fatal(err)

			if _, ok := cache.Get(key); ok {
				continue
			}
			unsatisfiedDeps = append(unsatisfiedDeps, v)
		} else {
			unsatisfiedDeps = append(unsatisfiedDeps, v)
		}
	}

	if len(unsatisfiedDeps) > 0 {
		fmt.Println("Building nix dependencies. This may take a while...")
	}

	var max int
	for _, v := range unsatisfiedDeps {
		if len(v.Name) > max {
			max = len(v.Name)
		}
	}
	max += 1

	for _, v := range unsatisfiedDeps {
		var br buildResult
		padding := strings.Repeat(" ", max-len(v.Name))

		if strings.HasSuffix(v.Name, ".nix") {
			br, err = buildFile(v.Name, v.Nixpkgs, padding)
			if err != nil {
				return err
			}
		} else {
			br, err = buildPackage(v.Name, v.Nixpkgs, padding)
			if err != nil {
				return err
			}
		}

		fmt.Println()
		fmt.Printf("%s:%s%s took %s\n", v.Name, padding, br.storePath, format.DisplayDuration(br.duration))

		if cache != nil {
			key, err := GenerateKey(v)
			errz.Fatal(err)

			err = cache.Save(key, br.storePath)
			errz.Fatal(err)
		}
	}
	if len(unsatisfiedDeps) > 0 {
		fmt.Println("Succeeded building nix dependencies")
	}

	return nil
}

type buildResult struct {
	storePath string
	duration  time.Duration
}

// buildPackage builds a nix package: nix-build --no-out-link -E 'with import <nixpkgs> { }; pkg' and returns the store path
func buildPackage(pkgName string, nixpkgs, padding string) (buildResult, error) {
	nixExpression := fmt.Sprintf("with import %s { }; [%s]", source(nixpkgs), pkgName)
	args := []string{"--no-out-link", "-E"}
	args = append(args, nixExpression)
	cmd := exec.Command("nix-build", args...)
	boblog.Log.V(5).Info(fmt.Sprintf("Executing command:\n  %s", cmd.String()))

	progress := newBuildProgress(pkgName, padding)
	progress.Start(5 * time.Second)

	var stdoutBuf bytes.Buffer
	cmd.Stdout = &stdoutBuf

	err := cmd.Run()
	if err != nil {
		progress.Stop()
		return buildResult{}, usererror.Wrap(errors.New("could not build package"))
	}

	for _, v := range strings.Split(stdoutBuf.String(), "\n") {
		if strings.HasPrefix(v, "/nix/store/") {
			progress.Stop()
			return buildResult{
				storePath: v,
				duration:  progress.Duration(),
			}, nil
		}
	}

	return buildResult{}, nil
}

// buildFile builds a .nix expression file
// `nix-build --no-out-link -E 'with import <nixpkgs> { }; callPackage filepath.nix {}'`
func buildFile(filePath string, nixpkgs, padding string) (buildResult, error) {
	nixExpression := fmt.Sprintf(`with import %s { }; callPackage %s {}`, source(nixpkgs), filePath)
	args := []string{"--no-out-link"}
	args = append(args, "--expr", nixExpression)
	cmd := exec.Command("nix-build", args...)
	boblog.Log.V(5).Info(fmt.Sprintf("Executing command:\n  %s", cmd.String()))

	progress := newBuildProgress(filePath, padding)
	progress.Start(5 * time.Second)

	var stdoutBuf bytes.Buffer
	var stderrBuf bytes.Buffer
	cmd.Stdout = &stdoutBuf
	cmd.Stderr = &stderrBuf

	err := cmd.Run()
	if err != nil {
		progress.Stop()
		return buildResult{}, usererror.Wrap(fmt.Errorf("could not build file `%s`, %w\n, %s\n, %s", filePath, err, stdoutBuf.String(), stderrBuf.String()))
	}

	for _, v := range strings.Split(stdoutBuf.String(), "\n") {
		progress.Stop()
		if strings.HasPrefix(v, "/nix/store/") {
			return buildResult{
				storePath: v,
				duration:  progress.Duration(),
			}, nil
		}
	}

	return buildResult{}, nil
}

// DownloadURl give nix download URL based on OS
func DownloadURl() string {
	url := "https://nixos.org/download.html"

	switch runtime.GOOS {
	case "windows":
		url = "https://nixos.org/download.html#nix-install-windows"
	case "darwin":
		url = "https://nixos.org/download.html#nix-install-macos"
	case "linux":
		url = "https://nixos.org/download.html#nix-install-linux"
	}

	return url
}

// AddDir add the dir path to .nix files specified in dependencies
func AddDir(dir string, dependencies []string) []string {
	for k, v := range dependencies {
		if strings.HasSuffix(v, ".nix") {
			dependencies[k] = dir + "/" + v
		}
	}
	return dependencies
}

// Source of nixpkgs from where dependencies are built. If empty will use local <nixpkgs>
// or a specific tarball can be used ex. https://github.com/NixOS/nixpkgs/archive/eeefd01d4f630fcbab6588fe3e7fffe0690fbb20.tar.gz
func source(nixpkgs string) string {
	if nixpkgs != "" {
		return fmt.Sprintf("(fetchTarball \"%s\")", nixpkgs)
	}
	return "<nixpkgs>"
}

// BuildEnvironment is running nix-shell for a list of dependencies and fetch its whole environment
//
// nix-shell --pure --keep NIX_SSL_CERT_FILE --keep SSL_CERT_FILE -p --command 'env' -E nixExpressionFromDeps
//
// nix shell can be started with empty list of packages so this method works with empty deps as well
func BuildEnvironment(deps []Dependency, nixpkgs string, cache *Cache, shellCache *ShellCache) (_ []string, err error) {
	defer errz.Recover(&err)

	// building dependencies with nix-build to display store paths to output
	err = BuildDependencies(deps, cache)
	errz.Fatal(err)

	expression := nixExpression(deps, nixpkgs)

	var arguments []string
	for _, envKey := range global.EnvWhitelist {
		if _, exists := os.LookupEnv(envKey); exists {
			arguments = append(arguments, []string{"--keep", envKey}...)
		}
	}
	arguments = append(arguments, []string{"--command", "env"}...)
	arguments = append(arguments, []string{"--expr", expression}...)

	cmd := exec.Command("nix-shell", "--pure")
	cmd.Args = append(cmd.Args, arguments...)

	var out bytes.Buffer
	var errBuf bytes.Buffer
	cmd.Stdout = &out
	cmd.Stderr = &errBuf

	if shellCache != nil {
		key, err := shellCache.GenerateKey(deps, cmd.String())
		errz.Fatal(err)

		if dat, ok := shellCache.Get(key); ok {
			out.Write(dat)
		} else {
			err = cmd.Run()
			if err != nil {
				return nil, prepareRunError(err, cmd.String(), errBuf)
			}

			err = shellCache.Save(key, out.Bytes())
			errz.Fatal(err)
		}
	} else {
		err = cmd.Run()
		if err != nil {
			return nil, prepareRunError(err, cmd.String(), errBuf)
		}
	}

	env := strings.Split(out.String(), "\n")

	// if NIX_SSL_CERT_FILE && SSL_CERT_FILE are set to /no-cert-file.crt unset them
	var clearedEnv []string
	for _, e := range env {
		pair := strings.SplitN(e, "=", 2)
		if pair[0] == "NIX_SSL_CERT_FILE" && pair[1] == "/no-cert-file.crt" {
			continue
		}
		if pair[0] == "SSL_CERT_FILE" && pair[1] == "/no-cert-file.crt" {
			continue
		}
		clearedEnv = append(clearedEnv, e)
	}

	return clearedEnv, nil
}

func prepareRunError(err error, cmd string, stderrBuf bytes.Buffer) error {
	return usererror.Wrap(fmt.Errorf("could not run nix-shell command:\n %s\n%w\n%s", cmd, err, stderrBuf.String()))
}

// nixExpression computes the Nix expression which is passed to nix-shell via -E flag
// Example of a Nix expression containing go_1_18 and a custom oapicodegen_v1.6.0.nix file:
// { pkgs ? import <nixpkgs> {} }:
//
//	pkgs.mkShell {
//	 buildInputs = [
//	    pkgs.go_1_18
//	    (pkgs.callPackage ./oapicodegen_v1.6.0.nix { } )
//	 ];
//	}
func nixExpression(deps []Dependency, nixpkgs string) string {
	var buildInputs []string
	for _, v := range deps {
		if strings.HasSuffix(v.Name, ".nix") {
			buildInputs = append(buildInputs, fmt.Sprintf("(pkgs.callPackage %s{ } )", v.Name))
		} else {
			buildInputs = append(buildInputs, "pkgs."+v.Name)
		}
	}

	exp := `
{ pkgs ? import %s {} }:
pkgs.mkShell {
  buildInputs = [
	 %s
  ];
}
`
	return fmt.Sprintf(exp, source(nixpkgs), strings.Join(buildInputs, "\n"))
}

func HashDependencies(deps []Dependency) (_ string, err error) {
	defer errz.Recover(&err)

	h := filehash.New()
	for _, dependency := range deps {
		if strings.HasSuffix(dependency.Name, ".nix") {
			err = h.AddBytes(bytes.NewBufferString(dependency.Nixpkgs))
			errz.Fatal(err)

			err = h.AddFile(dependency.Name)
			errz.Fatal(err)
		} else {
			toHash := fmt.Sprintf("%s:%s", dependency.Name, dependency.Nixpkgs)
			err = h.AddBytes(bytes.NewBufferString(toHash))
			errz.Fatal(err)
		}
	}
	return string(h.Sum()), nil
}