Skip to content

Commit ae6932f

Browse files
authored
[RunScript] Add ctx parameter (#1118)
## Summary Now that the implementation of `RunScript` is using `context.Background()`, I think it's better to pass the context.Context from `cmd.Context()`. ## How was it tested? None
1 parent 1cc79b0 commit ae6932f

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

devbox.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ type Devbox interface {
4141
// the devbox environment.
4242
Remove(ctx context.Context, pkgs ...string) error
4343
RestartServices(ctx context.Context, services ...string) error
44-
RunScript(scriptName string, scriptArgs []string) error
44+
RunScript(ctx context.Context, scriptName string, scriptArgs []string) error
4545
Services() (services.Services, error)
4646
// Shell generates the devbox environment and launches nix-shell as a child process.
4747
Shell(ctx context.Context) error

internal/boxcli/run.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
8080
return redact.Errorf("error reading devbox.json: %w", err)
8181
}
8282

83-
if err := box.RunScript(script, scriptArgs); err != nil {
83+
if err := box.RunScript(cmd.Context(), script, scriptArgs); err != nil {
8484
return redact.Errorf("error running command in Devbox: %w", err)
8585
}
8686
return nil

internal/impl/devbox.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ func (d *Devbox) Shell(ctx context.Context) error {
216216
return shell.Run()
217217
}
218218

219-
func (d *Devbox) RunScript(cmdName string, cmdArgs []string) error {
220-
ctx, task := trace.NewTask(context.Background(), "devboxRun")
219+
func (d *Devbox) RunScript(ctx context.Context, cmdName string, cmdArgs []string) error {
220+
ctx, task := trace.NewTask(ctx, "devboxRun")
221221
defer task.End()
222222

223223
if err := d.ensurePackagesAreInstalled(ctx, ensure); err != nil {
@@ -478,7 +478,7 @@ func (d *Devbox) Services() (services.Services, error) {
478478

479479
func (d *Devbox) StartServices(ctx context.Context, serviceNames ...string) error {
480480
if !d.IsEnvEnabled() {
481-
return d.RunScript("devbox", append([]string{"services", "start"}, serviceNames...))
481+
return d.RunScript(ctx, "devbox", append([]string{"services", "start"}, serviceNames...))
482482
}
483483

484484
if !services.ProcessManagerIsRunning(d.projectDir) {
@@ -520,7 +520,7 @@ func (d *Devbox) StopServices(ctx context.Context, allProjects bool, serviceName
520520
if allProjects {
521521
args = append(args, "--all-projects")
522522
}
523-
return d.RunScript("devbox", args)
523+
return d.RunScript(ctx, "devbox", args)
524524
}
525525

526526
if allProjects {
@@ -554,7 +554,7 @@ func (d *Devbox) StopServices(ctx context.Context, allProjects bool, serviceName
554554

555555
func (d *Devbox) ListServices(ctx context.Context) error {
556556
if !d.IsEnvEnabled() {
557-
return d.RunScript("devbox", []string{"services", "ls"})
557+
return d.RunScript(ctx, "devbox", []string{"services", "ls"})
558558
}
559559

560560
svcSet, err := d.Services()
@@ -592,7 +592,7 @@ func (d *Devbox) ListServices(ctx context.Context) error {
592592

593593
func (d *Devbox) RestartServices(ctx context.Context, serviceNames ...string) error {
594594
if !d.IsEnvEnabled() {
595-
return d.RunScript("devbox", append([]string{"services", "restart"}, serviceNames...))
595+
return d.RunScript(ctx, "devbox", append([]string{"services", "restart"}, serviceNames...))
596596
}
597597

598598
if !services.ProcessManagerIsRunning(d.projectDir) {
@@ -666,7 +666,7 @@ func (d *Devbox) StartProcessManager(
666666
if background {
667667
args = append(args, "--background")
668668
}
669-
return d.RunScript("devbox", args)
669+
return d.RunScript(ctx, "devbox", args)
670670
}
671671

672672
// Start the process manager

0 commit comments

Comments
 (0)