use lifecycle hook

jetify-com · Nov 1, 2024 · cd09583 · cd09583
1 parent 3b0a9c9
commit cd09583
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 24 deletions.
diff --git a/internal/boxcli/run.go b/internal/boxcli/run.go
@@ -17,6 +17,7 @@ import (
 	"go.jetpack.io/devbox/internal/devbox"
 	"go.jetpack.io/devbox/internal/devbox/devopt"
 	"go.jetpack.io/devbox/internal/redact"
+	"go.jetpack.io/devbox/internal/ux"
 )
 
 type runCmdFlags struct {
@@ -122,13 +123,22 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
 		return redact.Errorf("error reading devbox.json: %w", err)
 	}
 
+	onStaleState := func() {
+		ux.FHidableWarning(
+			ctx,
+			cmd.ErrOrStderr(),
+			devbox.StateOutOfDateMessage,
+			"with --recompute=true",
+		)
+	}
+
 	envOpts := devopt.EnvOptions{
-		OmitNixEnv: flags.omitNixEnv,
-		Pure:       flags.pure,
-		RecomputeEnv: &devopt.RecomputeEnvOpts{
-			Disabled:              !flags.recomputeEnv,
-			StateOutOfDateMessage: fmt.Sprintf(devbox.StateOutOfDateMessage, "with --recompute=true"),
+		Hooks: devopt.EnvLifecycleHooks{
+			OnStaleStateWithSkipRecompute: onStaleState,
 		},
+		OmitNixEnv:    flags.omitNixEnv,
+		Pure:          flags.pure,
+		SkipRecompute: !flags.recomputeEnv,
 	}
 	if err := box.RunScript(ctx, envOpts, script, scriptArgs); err != nil {
 		return redact.Errorf("error running script %q in Devbox: %w", script, err)

diff --git a/internal/boxcli/shell.go b/internal/boxcli/shell.go
@@ -13,6 +13,7 @@ import (
 	"go.jetpack.io/devbox/internal/devbox"
 	"go.jetpack.io/devbox/internal/devbox/devopt"
 	"go.jetpack.io/devbox/internal/envir"
+	"go.jetpack.io/devbox/internal/ux"
 )
 
 type shellCmdFlags struct {
@@ -95,13 +96,22 @@ func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
 		return shellInceptionErrorMsg("devbox shell")
 	}
 
+	onStaleState := func() {
+		ux.FHidableWarning(
+			ctx,
+			cmd.ErrOrStderr(),
+			devbox.StateOutOfDateMessage,
+			"with --recompute=true",
+		)
+	}
+
 	return box.Shell(ctx, devopt.EnvOptions{
-		OmitNixEnv: flags.omitNixEnv,
-		Pure:       flags.pure,
-		RecomputeEnv: &devopt.RecomputeEnvOpts{
-			Disabled:              !flags.recomputeEnv,
-			StateOutOfDateMessage: fmt.Sprintf(devbox.StateOutOfDateMessage, "with --recompute=true"),
+		Hooks: devopt.EnvLifecycleHooks{
+			OnStaleStateWithSkipRecompute: onStaleState,
 		},
+		OmitNixEnv:    flags.omitNixEnv,
+		Pure:          flags.pure,
+		SkipRecompute: !flags.recomputeEnv,
 	})
 }
 

diff --git a/internal/boxcli/shellenv.go b/internal/boxcli/shellenv.go
@@ -115,15 +115,24 @@ func shellEnvFunc(
 		}
 	}
 
+	onStaleState := func() {
+		ux.FHidableWarning(
+			ctx,
+			cmd.ErrOrStderr(),
+			devbox.StateOutOfDateMessage,
+			box.RefreshAliasOrCommand(),
+		)
+	}
+
 	envStr, err := box.EnvExports(ctx, devopt.EnvExportsOpts{
 		EnvOptions: devopt.EnvOptions{
+			Hooks: devopt.EnvLifecycleHooks{
+				OnStaleStateWithSkipRecompute: onStaleState,
+			},
 			OmitNixEnv:        flags.omitNixEnv,
 			PreservePathStack: flags.preservePathStack,
 			Pure:              flags.pure,
-			RecomputeEnv: &devopt.RecomputeEnvOpts{
-				Disabled:              !flags.recomputeEnv,
-				StateOutOfDateMessage: fmt.Sprintf(devbox.StateOutOfDateMessage, box.RefreshAliasOrCommand()),
-			},
+			SkipRecompute:     !flags.recomputeEnv,
 		},
 		NoRefreshAlias: flags.noRefreshAlias,
 		RunHooks:       flags.runInitHook,

diff --git a/internal/devbox/devbox.go b/internal/devbox/devbox.go
@@ -804,14 +804,12 @@ func (d *Devbox) ensureStateIsUpToDateAndComputeEnv(
 ) (map[string]string, error) {
 	defer debug.FunctionTimer().End()
 
-	if envOpts.RecomputeEnv.Disabled {
+	if envOpts.SkipRecompute {
 		upToDate, _ := d.lockfile.IsUpToDateAndInstalled(isFishShell())
 		if !upToDate {
-			ux.FHidableWarning(
-				ctx,
-				d.stderr,
-				envOpts.RecomputeEnv.StateOutOfDateMessage, //nolint:govet
-			)
+			if envOpts.Hooks.OnStaleStateWithSkipRecompute != nil {
+				envOpts.Hooks.OnStaleStateWithSkipRecompute()
+			}
 		}
 	} else {
 		// When ensureStateIsUpToDate is called with ensure=true, it always

diff --git a/internal/devbox/devopt/devboxopts.go b/internal/devbox/devopt/devboxopts.go
@@ -72,13 +72,14 @@ type EnvExportsOpts struct {
 // like `shellenv`, `shell` and `run`.
 // - The struct is designed for the "common case" to be zero-initialized as `EnvOptions{}`.
 type EnvOptions struct {
+	Hooks             EnvLifecycleHooks
 	OmitNixEnv        bool
 	PreservePathStack bool
 	Pure              bool
-	RecomputeEnv      *RecomputeEnvOpts
+	SkipRecompute     bool
 }
 
-type RecomputeEnvOpts struct {
-	Disabled              bool // Disabled instead of Enabled, because zero-value is false
-	StateOutOfDateMessage string
+type EnvLifecycleHooks struct {
+	// OnStaleStateWithSkipRecompute is called when the Devbox state is out of date, AND it is not being recomputed.
+	OnStaleStateWithSkipRecompute func()
 }