Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nix: make internal/nix.cmd public #2473

Merged
merged 1 commit into from
Jan 6, 2025
Merged

nix: make internal/nix.cmd public #2473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/nix/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func Build(ctx context.Context, args *BuildArgs, installables ...string) error {
FixInstallableArgs(installables)

// --impure is required for allowUnfreeEnv/allowInsecureEnv to work.
cmd := command("build", "--impure")
cmd := Command("build", "--impure")
cmd.Args = appendArgs(cmd.Args, args.Flags)
cmd.Args = appendArgs(cmd.Args, installables)
// Adding extra substituters only here to be conservative, but this could also
Expand Down
2 changes: 1 addition & 1 deletion internal/nix/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func CopyInstallableToCache(
env []string,
) error {
fmt.Fprintf(out, "Copying %s to %s\n", installable, to)
cmd := command(
cmd := Command(
"copy", "--to", to,
// --impure makes NIXPKGS_ALLOW_* environment variables work.
"--impure",
Expand Down
323 changes: 5 additions & 318 deletions internal/nix/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,332 +1,19 @@
package nix

import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log/slog"
"os"
"os/exec"
"slices"
"strconv"
"strings"
"syscall"
"time"
)

type cmd struct {
Args cmdArgs
Env []string

Stdin io.Reader
Stdout io.Writer
Stderr io.Writer

execCmd *exec.Cmd
err error
dur time.Duration
logger *slog.Logger
}

func command(args ...any) *cmd {
cmd := &cmd{
Args: append(cmdArgs{
"nix",
"--extra-experimental-features", "ca-derivations",
"--option", "experimental-features", "nix-command flakes fetch-closure",
}, args...),
logger: slog.Default(),
}
return cmd
}

func (c *cmd) CombinedOutput(ctx context.Context) ([]byte, error) {
cmd := c.initExecCommand(ctx)
c.logger.DebugContext(ctx, "nix command starting", "cmd", c)

start := time.Now()
out, err := cmd.CombinedOutput()
c.dur = time.Since(start)

c.err = c.error(ctx, err)
c.logger.DebugContext(ctx, "nix command exited", "cmd", c)
return out, c.err
}

func (c *cmd) Output(ctx context.Context) ([]byte, error) {
cmd := c.initExecCommand(ctx)
c.logger.DebugContext(ctx, "nix command starting", "cmd", c)

start := time.Now()
out, err := cmd.Output()
c.dur = time.Since(start)

c.err = c.error(ctx, err)
c.logger.DebugContext(ctx, "nix command exited", "cmd", c)
return out, c.err
}

func (c *cmd) Run(ctx context.Context) error {
cmd := c.initExecCommand(ctx)
c.logger.DebugContext(ctx, "nix command starting", "cmd", c)

start := time.Now()
err := cmd.Run()
c.dur = time.Since(start)

c.err = c.error(ctx, err)
c.logger.DebugContext(ctx, "nix command exited", "cmd", c)
return c.err
}

func (c *cmd) LogValue() slog.Value {
attrs := []slog.Attr{
slog.Any("args", c.Args),
}
if c.execCmd == nil {
return slog.GroupValue(attrs...)
}
attrs = append(attrs, slog.String("path", c.execCmd.Path))

var exitErr *exec.ExitError
if errors.As(c.err, &exitErr) {
stderr := c.stderrExcerpt(exitErr.Stderr)
if len(stderr) != 0 {
attrs = append(attrs, slog.String("stderr", stderr))
}
}
if proc := c.execCmd.Process; proc != nil {
attrs = append(attrs, slog.Int("pid", proc.Pid))
}
if procState := c.execCmd.ProcessState; procState != nil {
if procState.Exited() {
attrs = append(attrs, slog.Int("code", procState.ExitCode()))
}
if status, ok := procState.Sys().(syscall.WaitStatus); ok && status.Signaled() {
if status.Signaled() {
attrs = append(attrs, slog.String("signal", status.Signal().String()))
}
}
}
if c.dur != 0 {
attrs = append(attrs, slog.Duration("dur", c.dur))
}
return slog.GroupValue(attrs...)
}

func (c *cmd) String() string {
return c.Args.String()
}

func (c *cmd) initExecCommand(ctx context.Context) *exec.Cmd {
if c.execCmd != nil {
return c.execCmd
}

args := c.Args.StringSlice()
c.execCmd = exec.CommandContext(ctx, args[0], args[1:]...)
c.execCmd.Env = c.Env
c.execCmd.Stdin = c.Stdin
c.execCmd.Stdout = c.Stdout
c.execCmd.Stderr = c.Stderr

c.execCmd.Cancel = func() error {
// Try to let Nix exit gracefully by sending an interrupt
// instead of the default behavior of killing it.
c.logger.DebugContext(ctx, "sending interrupt to nix process", slog.Group("cmd",
"args", c.Args,
"path", c.execCmd.Path,
"pid", c.execCmd.Process.Pid,
))
err := c.execCmd.Process.Signal(os.Interrupt)
if errors.Is(err, os.ErrProcessDone) {
// Nix already exited; execCmd.Wait will use the exit
// code.
return err
}
if err != nil {
// We failed to send SIGINT, so kill the process
// instead.
//
// - If Nix already exited, Kill will return
// os.ErrProcessDone and execCmd.Wait will use
// the exit code.
// - Otherwise, execCmd.Wait will always return an
// error.
c.logger.ErrorContext(ctx, "error interrupting nix process, attempting to kill",
"err", err, slog.Group("cmd",
"args", c.Args,
"path", c.execCmd.Path,
"pid", c.execCmd.Process.Pid,
))
return c.execCmd.Process.Kill()
}

// We sent the SIGINT successfully. It's still possible for Nix
// to exit successfully, so return os.ErrProcessDone so that
// execCmd.Wait uses the exit code instead of ctx.Err.
return os.ErrProcessDone
}
// Kill Nix if it doesn't exit within 15 seconds of Devbox sending an
// interrupt.
c.execCmd.WaitDelay = 15 * time.Second
return c.execCmd
}

func (c *cmd) error(ctx context.Context, err error) error {
if err == nil {
return nil
}

cmdErr := &cmdError{err: err}
if errors.Is(err, exec.ErrNotFound) {
cmdErr.msg = fmt.Sprintf("nix: %s not found in $PATH", c.Args[0])
func init() {
Default.ExtraArgs = Args{
"--extra-experimental-features", "ca-derivations",
"--option", "experimental-features", "nix-command flakes fetch-closure",
gcurtis marked this conversation as resolved.
Show resolved Hide resolved
}

switch {
case errors.Is(ctx.Err(), context.Canceled):
cmdErr.msg = "nix: command canceled"
case errors.Is(ctx.Err(), context.DeadlineExceeded):
cmdErr.msg = "nix: command timed out"
default:
cmdErr.msg = "nix: command error"
}
cmdErr.msg += ": " + c.String()

var exitErr *exec.ExitError
if errors.As(err, &exitErr) {
if stderr := c.stderrExcerpt(exitErr.Stderr); len(stderr) != 0 {
cmdErr.msg += ": " + stderr
}
if exitErr.Exited() {
cmdErr.msg += fmt.Sprintf(": exit code %d", exitErr.ExitCode())
return cmdErr
}
if stat, ok := exitErr.Sys().(syscall.WaitStatus); ok && stat.Signaled() {
cmdErr.msg += fmt.Sprintf(": exit due to signal %d (%[1]s)", stat.Signal())
return cmdErr
}
}

if !errors.Is(err, ctx.Err()) {
cmdErr.msg += ": " + err.Error()
}
return cmdErr
}

func (*cmd) stderrExcerpt(stderr []byte) string {
stderr = bytes.TrimSpace(stderr)
if len(stderr) == 0 {
return ""
}

lines := bytes.Split(stderr, []byte("\n"))
slices.Reverse(lines)
for _, line := range lines {
line = bytes.TrimSpace(line)
after, found := bytes.CutPrefix(line, []byte("error: "))
if !found {
continue
}
after = bytes.TrimSpace(after)
if len(after) == 0 {
continue
}
stderr = after
break

}

excerpt := string(stderr)
if !strconv.CanBackquote(excerpt) {
quoted := strconv.Quote(excerpt)
excerpt = quoted[1 : len(quoted)-1]
}
return excerpt
}

type cmdArgs []any

func appendArgs[E any](args cmdArgs, new []E) cmdArgs {
func appendArgs[E any](args Args, new []E) Args {
for _, elem := range new {
args = append(args, elem)
}
return args
}

func (c cmdArgs) StringSlice() []string {
s := make([]string, len(c))
for i := range c {
s[i] = fmt.Sprint(c[i])
}
return s
}

func (c cmdArgs) String() string {
if len(c) == 0 {
return ""
}

sb := &strings.Builder{}
c.writeQuoted(sb, fmt.Sprint(c[0]))
if len(c) == 1 {
return sb.String()
}

for _, arg := range c[1:] {
sb.WriteByte(' ')
c.writeQuoted(sb, fmt.Sprint(arg))
}
return sb.String()
}

func (cmdArgs) writeQuoted(dst *strings.Builder, str string) {
needsQuote := strings.ContainsAny(str, ";\"'()$|&><` \t\r\n\\#{~*?[=")
if !needsQuote {
dst.WriteString(str)
return
}

canSingleQuote := !strings.Contains(str, "'")
if canSingleQuote {
dst.WriteByte('\'')
dst.WriteString(str)
dst.WriteByte('\'')
return
}

dst.WriteByte('"')
for _, r := range str {
switch r {
// Special characters inside double quotes:
// https://pubs.opengroup.org/onlinepubs/009604499/utilities/xcu_chap02.html#tag_02_02_03
case '$', '`', '"', '\\':
dst.WriteRune('\\')
}
dst.WriteRune(r)
}
dst.WriteByte('"')
}

type cmdError struct {
msg string
err error
}

func (c *cmdError) Redact() string {
return c.Error()
}

func (c *cmdError) Error() string {
return c.msg
}

func (c *cmdError) Unwrap() error {
return c.err
}

func allowUnfreeEnv(curEnv []string) []string {
return append(curEnv, "NIXPKGS_ALLOW_UNFREE=1")
}
Expand Down
2 changes: 1 addition & 1 deletion internal/nix/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type ConfigField[T any] struct {
func CurrentConfig(ctx context.Context) (Config, error) {
// `nix show-config` is deprecated in favor of `nix config show`, but we
// want to remain compatible with older Nix versions.
cmd := command("show-config", "--json")
cmd := Command("show-config", "--json")
out, err := cmd.Output(ctx)
var exitErr *exec.ExitError
if errors.As(err, &exitErr) && len(exitErr.Stderr) != 0 {
Expand Down
Loading
Loading