Merge 0.13.6 into latest

Author: Lagoja

.github/workflows/debug.yaml

@@ -9,7 +9,7 @@ on:
         default: "ubuntu-latest"
         type: choice
         options:
-          - macos-12
+          - macos-latest
           - ubuntu-latest
 
 permissions:

docs/app/docs/cli_reference/devbox_completion_zsh.md

@@ -2,8 +2,15 @@
 
 Generate the autocompletion script for the zsh shell.
 
-If shell completion is not already enabled in your environment you will need
-to enable it.  You can execute the following once:
+If you are using Oh My Zsh, just run the following:
+
+```bash
+mkdir -p ~/.oh-my-zsh/completions
+devbox completion zsh > ~/.oh-my-zsh/completions/_devbox
+```
+
+If you are not using Oh My Zsh and shell completion is not already enabled in your environment you will need
+to enable it. You can execute the following once:
 
 ```bash
 echo "autoload -U compinit; compinit" >> ~/.zshrc

docs/app/docs/configuration.md

@@ -182,11 +182,11 @@ Currently, you can only set values using string literals, `$PWD`, and `$PATH`. A
 
 ### Env From
 
-Env from takes a string or list of strings for loading environment variables into your shells and scripts. Currently it supports loading from two sources: .env files, and Jetify Secrsts.
+Env from takes a string for loading environment variables into your shells and scripts. Currently it supports loading from two sources: .env files, and Jetify Secrets.
 
 #### .env Files
 
-You can load environment variables from a `.env` file by adding the path to the file in the `env_from` field. This is useful for loading secrets or other sensitive information that you don't want to store in your `devbox.json`.
+You can load environment variables from a `.env` file by adding the path to the file in the `env_from` field (the file must end with `.env`). This is useful for loading secrets or other sensitive information that you don't want to store in your `devbox.json`.
 
 ```json
 {
@@ -198,15 +198,15 @@ This will load the environment variables from the `.env` file into your shell wh
 
 #### Jetify Secrets
 
-You can securely load secrets from Jetify Secrets by running `devbox secrets init` and creating a project in Jetify Cloud. This will add the `jetpack-cloud` field to `env_from` in your project.
+You can securely load secrets from Jetify Secrets by running `devbox secrets init` and creating a project in Jetify Cloud. This will add the `jetify-cloud` field to `env_from` in your project.
 
 ```json
 {
-    "env_from": "jetpack-cloud"
+    "env_from": "jetify-cloud"
 }
 ```
 
-Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide.
+Note that setting secrets securely with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide.
 
 ### Shell
 

docs/app/docs/guides/creating_plugins.md

@@ -219,7 +219,7 @@ The plugin.json below installs MongoDB + the Mongo shell, and sets the environme
   "version": "0.0.1",
   "description": "Plugin for the [`mongodb`](https://www.nixhub.io/packages/mongodb) package. This plugin configures MonogoDB to use a local config file and data directory for this project, and configures a mongodb service.",
   "packages": [
-    "mongodb@latest"
+    "mongodb@latest",
     "mongosh@latest"
   ],
   "env": {

docs/app/docs/guides/secrets.md

@@ -28,9 +28,7 @@ For environment variables that you want to keep out of your `devbox.json` file,
 {
   "packages": {},
   "shell": {},
-  "env_from": [
-    "path/to/.env"
-  ]
+  "env_from": "path/to/.env"
 }
 ```
 

docs/app/docs/quickstart.mdx

@@ -21,7 +21,7 @@ Follow the instruction from [the installation guide](./installing_devbox.mdx).
 :::note
 If you want to try Devbox before installing it, you can open a cloud shell on your browser using the link below
 
-[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://www.jetify.com/devbox/templates/tutorial)
+[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/tutorial)
 :::
 
 ## Create a Development Environment

docs/app/docusaurus.config.js

@@ -66,7 +66,7 @@ const config = {
         routeBasePath: "cloud",
         sidebarPath: require.resolve("./cloud_sidebars.js"),
       },
-    ],[
+    ], [
       "@docusaurus/plugin-content-docs",
       {
         id: "nixhub",

flake.lock

@@ -11,7 +11,7 @@
       let
         pkgs = nixpkgs.legacyPackages.${system};
 
-        lastTag = "0.13.5";
+        lastTag = "0.13.6";
 
         revision =
           if (self ? shortRev)

flake.nix

@@ -42,7 +42,7 @@ require (
 	github.com/zealic/go2node v0.1.0
 	go.jetify.com/typeid v1.2.0
 	go.jetpack.io/envsec v0.0.16-0.20240604163020-540ad12af899
-	go.jetpack.io/pkg v0.0.0-20240815004735-7649b4283d51
+	go.jetpack.io/pkg v0.0.0-20241025195518-152e59e26d5d
 	golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8
 	golang.org/x/mod v0.18.0
 	golang.org/x/oauth2 v0.21.0

go.mod

@@ -4,7 +4,10 @@
 package build
 
 import (
+	"fmt"
+	"log/slog"
 	"os"
+	"path/filepath"
 	"runtime"
 	"strconv"
 	"sync"
@@ -98,3 +101,33 @@ func DashboardHostname() string {
 	}
 	return "https://cloud.jetify.com"
 }
+
+// SourceDir searches for the source code directory that built the current
+// binary.
+func SourceDir() (string, error) {
+	_, file, _, ok := runtime.Caller(0)
+	if !ok || file == "" {
+		return "", fmt.Errorf("build.SourceDir: binary is missing path info")
+	}
+	slog.Debug("trying to determine path to devbox source using runtime.Caller", "path", file)
+
+	dir := filepath.Dir(file)
+	if _, err := os.Stat(dir); err != nil {
+		if filepath.IsAbs(file) {
+			return "", fmt.Errorf("build.SourceDir: path to binary source doesn't exist: %v", err)
+		}
+		return "", fmt.Errorf("build.SourceDir: binary was built with -trimpath")
+	}
+
+	for {
+		_, err := os.Stat(filepath.Join(dir, "go.mod"))
+		if err == nil {
+			slog.Debug("found devbox source directory", "path", dir)
+			return dir, nil
+		}
+		if dir == "/" || dir == "." {
+			return "", fmt.Errorf("build.SourceDir: can't find go.mod in any parent directories of %s", file)
+		}
+		dir = filepath.Dir(dir)
+	}
+}

go.sum

@@ -32,6 +32,7 @@ import (
 	"go.jetpack.io/devbox/internal/devbox/envpath"
 	"go.jetpack.io/devbox/internal/devbox/generate"
 	"go.jetpack.io/devbox/internal/devconfig"
+	"go.jetpack.io/devbox/internal/devconfig/configfile"
 	"go.jetpack.io/devbox/internal/devpkg"
 	"go.jetpack.io/devbox/internal/devpkg/pkgtype"
 	"go.jetpack.io/devbox/internal/envir"
@@ -373,7 +374,7 @@ func (d *Devbox) EnvExports(ctx context.Context, opts devopt.EnvExportsOpts) (st
 	envStr := exportify(envs)
 
 	if opts.RunHooks {
-		hooksStr := ". " + shellgen.ScriptPath(d.ProjectDir(), shellgen.HooksFilename)
+		hooksStr := ". \"" + shellgen.ScriptPath(d.ProjectDir(), shellgen.HooksFilename) + "\""
 		envStr = fmt.Sprintf("%s\n%s;\n", envStr, hooksStr)
 	}
 
@@ -1009,9 +1010,9 @@ func (d *Devbox) configEnvs(
 		}
 	} else if d.cfg.Root.EnvFrom != "" {
 		return nil, usererr.New(
-			"unknown from_env value: %s. Supported value is: %q.",
+			"unknown env_from value: %s. Supported values are: \"%q\" or a path to a file ending in \".env\"",
 			d.cfg.Root.EnvFrom,
-			"jetpack-cloud",
+			configfile.JetifyCloudEnvFromValue,
 		)
 	}
 	for k, v := range d.cfg.Env() {

internal/build/build.go

@@ -8,9 +8,11 @@ import (
 	"github.com/hashicorp/go-envparse"
 )
 
+var JetifyCloudEnvFromValue = "jetify-cloud"
+
 func (c *ConfigFile) IsEnvsecEnabled() bool {
 	// envsec for legacy. jetpack-cloud for legacy
-	return c.EnvFrom == "envsec" || c.EnvFrom == "jetpack-cloud" || c.EnvFrom == "jetify-cloud"
+	return c.EnvFrom == "envsec" || c.EnvFrom == "jetpack-cloud" || c.EnvFrom == JetifyCloudEnvFromValue
 }
 
 func (c *ConfigFile) IsdotEnvEnabled() bool {
@@ -25,10 +27,13 @@ func (c *ConfigFile) ParseEnvsFromDotEnv() (map[string]string, error) {
 	if !c.IsdotEnvEnabled() {
 		return nil, fmt.Errorf("env file does not have a .env extension")
 	}
-
-	file, err := os.Open(c.EnvFrom)
+	envFileAbsPath := c.EnvFrom
+	if !filepath.IsAbs(c.EnvFrom) {
+		envFileAbsPath = filepath.Join(filepath.Dir(c.AbsRootPath), c.EnvFrom)
+	}
+	file, err := os.Open(envFileAbsPath)
 	if err != nil {
-		return nil, fmt.Errorf("failed to open file: %s", c.EnvFrom)
+		return nil, fmt.Errorf("failed to open file: %s", envFileAbsPath)
 	}
 	defer file.Close()
 

internal/devbox/devbox.go

@@ -10,6 +10,7 @@ import (
 	"slices"
 	"strings"
 
+	"go.jetpack.io/devbox/internal/build"
 	"go.jetpack.io/devbox/internal/devpkg"
 	"go.jetpack.io/devbox/internal/nix"
 	"go.jetpack.io/devbox/internal/patchpkg"
@@ -73,9 +74,11 @@ func (f *flakePlan) needsGlibcPatch() bool {
 }
 
 type glibcPatchFlake struct {
-	// DevboxExecutable is the absolute path to the Devbox binary to use as
-	// the flake's builder. It must not be the wrapper script.
-	DevboxExecutable string
+	// DevboxFlake provides the devbox binary that will act as the patch
+	// flake's builder. By default it's set to "github:jetify-com/devbox/" +
+	// [build.Version]. For dev builds, it's set to the local path to the
+	// Devbox source code (this Go module) if it's available.
+	DevboxFlake flake.Ref
 
 	// NixpkgsGlibcFlakeRef is a flake reference to the nixpkgs flake
 	// containing the new glibc package.
@@ -100,43 +103,57 @@ type glibcPatchFlake struct {
 }
 
 func newGlibcPatchFlake(nixpkgsGlibcRev string, packages []*devpkg.Package) (glibcPatchFlake, error) {
-	// Get the path to the actual devbox binary (not the /usr/bin/devbox
-	// wrapper) so the flake build can use it.
-	exe, err := os.Executable()
-	if err != nil {
-		return glibcPatchFlake{}, err
-	}
-	exe, err = filepath.EvalSymlinks(exe)
-	if err != nil {
-		return glibcPatchFlake{}, err
+	patchFlake := glibcPatchFlake{
+		DevboxFlake: flake.Ref{
+			Type:  flake.TypeGitHub,
+			Owner: "jetify-com",
+			Repo:  "devbox",
+			Ref:   build.Version,
+		},
+		NixpkgsGlibcFlakeRef: "flake:nixpkgs/" + nixpkgsGlibcRev,
 	}
 
-	flake := glibcPatchFlake{
-		DevboxExecutable:     exe,
-		NixpkgsGlibcFlakeRef: "flake:nixpkgs/" + nixpkgsGlibcRev,
+	// In dev builds, use the local Devbox flake for patching packages
+	// instead of the one on GitHub. Using build.IsDev doesn't work because
+	// DEVBOX_PROD=1 will attempt to download 0.0.0-dev from GitHub.
+	if strings.HasPrefix(build.Version, "0.0.0") {
+		src, err := build.SourceDir()
+		if err != nil {
+			slog.Error("can't find the local devbox flake for patching, falling back to the latest github release", "err", err)
+			patchFlake.DevboxFlake = flake.Ref{
+				Type:  flake.TypeGitHub,
+				Owner: "jetify-com",
+				Repo:  "devbox",
+			}
+		} else {
+			patchFlake.DevboxFlake = flake.Ref{Type: flake.TypePath, Path: src}
+		}
 	}
+
 	for _, pkg := range packages {
 		// Check to see if this is a CUDA package. If so, we need to add
 		// it to the flake dependencies so that we can patch other
 		// packages to reference it (like Python).
-		relAttrPath, err := flake.systemRelativeAttrPath(pkg)
+		relAttrPath, err := patchFlake.systemRelativeAttrPath(pkg)
 		if err != nil {
 			return glibcPatchFlake{}, err
 		}
 		if strings.HasPrefix(relAttrPath, "cudaPackages") {
-			if err := flake.addDependency(pkg); err != nil {
+			if err := patchFlake.addDependency(pkg); err != nil {
 				return glibcPatchFlake{}, err
 			}
 		}
 
 		if !pkg.Patch {
 			continue
 		}
-		if err := flake.addOutput(pkg); err != nil {
+		if err := patchFlake.addOutput(pkg); err != nil {
 			return glibcPatchFlake{}, err
 		}
 	}
-	return flake, nil
+
+	slog.Debug("creating new patch flake", "flake", &patchFlake)
+	return patchFlake, nil
 }
 
 // addInput adds a flake input that provides pkg.
@@ -301,5 +318,34 @@ func (g *glibcPatchFlake) writeTo(dir string) error {
 			slog.Debug("error copying system libcuda.so to flake", "dir", dir)
 		}
 	}
-	return writeFromTemplate(dir, g, "glibc-patch.nix", "flake.nix")
+	changed, err := writeFromTemplate(dir, g, "glibc-patch.nix", "flake.nix")
+	if err != nil {
+		return err
+	}
+	if changed {
+		_ = os.Remove(filepath.Join(dir, "flake.lock"))
+	}
+	return nil
+}
+
+func (g *glibcPatchFlake) LogValue() slog.Value {
+	inputs := make([]slog.Attr, 0, 2+len(g.Inputs))
+	inputs = append(inputs,
+		slog.String("devbox", g.DevboxFlake.String()),
+		slog.String("nixpkgs-glibc", g.NixpkgsGlibcFlakeRef),
+	)
+	for k, v := range g.Inputs {
+		inputs = append(inputs, slog.String(k, v))
+	}
+
+	var outputs []string
+	for _, pkg := range g.Outputs.Packages {
+		for attrPath := range pkg {
+			outputs = append(outputs, attrPath)
+		}
+	}
+	return slog.GroupValue(
+		slog.Attr{Key: "inputs", Value: slog.GroupValue(inputs...)},
+		slog.Attr{Key: "outputs", Value: slog.AnyValue(outputs)},
+	)
 }