Function packageInstallErrorHandler

internal/devpkg/package.go:794–840

packageInstallErrorHandler checks for two kinds of errors to print custom messages for so that Devbox users can work around them: 1. Packages that cannot be installed on the current system, but may be installable on other systems.packageInstallErrorHandler 2. Packages marked insecure by nix

(err error, pkg *Package, installableOrEmpty string)

// 1. Packages that cannot be installed on the current system, but may be installable on other systems.packageInstallErrorHandler
// 2. Packages marked insecure by nix
func packageInstallErrorHandler(err error, pkg *Package, installableOrEmpty string) error {
	if err == nil {
		return nil
	}

	// Check if the user is installing a package that cannot be installed on their platform.
	// For example, glibcLocales on MacOS will give the following error:
	// flake output attribute 'legacyPackages.x86_64-darwin.glibcLocales' is not a derivation or path
	// This is because glibcLocales is only available on Linux.
	// The user should try `devbox add` again with `--exclude-platform`
	errMessage := strings.TrimSpace(err.Error())

	// Sample error from `devbox add glibcLocales` on a mac:
	// error: flake output attribute 'legacyPackages.x86_64-darwin.glibcLocales' is not a derivation or path
	maybePackageSystemCompatibilityErrorType1 := strings.Contains(errMessage, "error: flake output attribute") &&
		strings.Contains(errMessage, "is not a derivation or path")
	// Sample error from `devbox add sublime4` on a mac:
	// error: Package ‘sublimetext4-4169’ in /nix/store/nlbjx0mp83p2qzf1rkmzbgvq1wxfir81-source/pkgs/applications/editors/sublime/4/common.nix:168 is not available on the requested hostPlatform:
	//     hostPlatform.config = "x86_64-apple-darwin"
	//     package.meta.platforms = [
	//       "aarch64-linux"
	//       "x86_64-linux"
	//    ]
	maybePackageSystemCompatibilityErrorType2 := strings.Contains(errMessage, "is not available on the requested hostPlatform")

	if maybePackageSystemCompatibilityErrorType1 || maybePackageSystemCompatibilityErrorType2 {
		platform := nix.System()
		return usererr.WithUserMessage(
			err,
			"package %s cannot be installed on your platform %s.\n"+
				"If you know this package is incompatible with %[2]s, then "+
				"you could run `devbox add %[1]s --exclude-platform %[2]s` and re-try.\n"+
				"If you think this package should be compatible with %[2]s, then "+
				"it's possible this particular version is not available yet from the nix registry. "+
				"You could try `devbox add` with a different version for this package.\n\n"+
				"Underlying Error from nix is:",
			pkg.Versioned(),
			platform,
		)
	}

	if isInsecureErr, userErr := nix.IsExitErrorInsecurePackage(err, pkg.Versioned(), installableOrEmpty); isInsecureErr {
		return userErr
	}

	return usererr.WithUserMessage(err, "error installing package %s", pkg.Raw)
}

func (p *Package) ResolvedVersion() (string, error) {
	if err := p.resolve(); err != nil {