Method ensureStateIsUpToDateAndComputeEnv

internal/devbox/devbox.go:837–879

ensureStateIsUpToDateAndComputeEnv will return a map of the env-vars for the Devbox Environment while ensuring these reflect the current (up to date) state of the project.

(
	ctx context.Context,
	envOpts devopt.EnvOptions,
)

// ensureStateIsUpToDateAndComputeEnv will return a map of the env-vars for the Devbox Environment
// while ensuring these reflect the current (up to date) state of the project.
func (d *Devbox) ensureStateIsUpToDateAndComputeEnv(
	ctx context.Context,
	envOpts devopt.EnvOptions,
) (map[string]string, error) {
	defer debug.FunctionTimer().End()

	upToDate, err := d.lockfile.IsUpToDateAndInstalled(isFishShell())
	if err != nil {
		return nil, err
	}
	if !upToDate {
		if envOpts.Hooks.OnStaleState != nil {
			envOpts.Hooks.OnStaleState()
		}
	}

	if !envOpts.SkipRecompute {
		// When ensureStateIsUpToDate is called with ensure=true, it always
		// returns early if the lockfile is up to date. So we don't need to check here
		if err := d.ensureStateIsUpToDate(ctx, ensure); isConnectionError(err) {
			if !fileutil.Exists(d.nixPrintDevEnvCachePath()) {
				ux.Ferrorf(
					d.stderr,
					"Error connecting to the internet and no cached environment found. Aborting.\n",
				)
				return nil, err
			}
			ux.Fwarningf(
				d.stderr,
				"Error connecting to the internet. Will attempt to use cached environment.\n",
			)
		} else if err != nil {
			// Some other non connection error, just return it.
			return nil, err
		}
	}

	// Since ensureStateIsUpToDate calls computeEnv when not up do date,
	// it's ok to use usePrintDevEnvCache=true here always. This does end up
	// doing some non-nix work twice if lockfile is not up to date.
	// TODO: Improve this to avoid extra work.
	return d.computeEnv(ctx, true /*usePrintDevEnvCache*/, envOpts)
}

func (d *Devbox) nixPrintDevEnvCachePath() string {
	return filepath.Join(d.projectDir, ".devbox/.nix-print-dev-env-cache")