Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(internal): Add mechanism to allow prompts for processes #1702

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from
Draft

feat(internal): Add mechanism to allow prompts for processes #1702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fb0005
feat(internal): Expose method to hide process output for prompting
craciunoiuc May 27, 2024
9cd123f
feat(internal): Add method to run code before/after prompts
craciunoiuc Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions internal/cli/kraft/build/builder_kraftfile_unikraft.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ func (build *builderKraftfileUnikraft) pull(ctx context.Context, opts *BuildOpti
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(template),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return templatePack.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -296,7 +296,7 @@ func (build *builderKraftfileUnikraft) pull(ctx context.Context, opts *BuildOpti
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(p),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return p.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -472,7 +472,7 @@ func (build *builderKraftfileUnikraft) Build(ctx context.Context, opts *BuildOpt
configure := true

if opts.project.IsConfigured(*opts.Target) {
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:")
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:", func() {})
if err != nil {
return err
}
Expand All @@ -481,7 +481,7 @@ func (build *builderKraftfileUnikraft) Build(ctx context.Context, opts *BuildOpt
if configure {
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("configuring %s (%s)", (*opts.Target).Name(), target.TargetPlatArchName(*opts.Target)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return opts.project.Configure(
ctx,
*opts.Target, // Target-specific options
Expand All @@ -504,7 +504,7 @@ func (build *builderKraftfileUnikraft) Build(ctx context.Context, opts *BuildOpt

processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("building %s (%s)", (*opts.Target).Name(), target.TargetPlatArchName(*opts.Target)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
err := opts.project.Build(
ctx,
*opts.Target, // Target-specific options
Expand Down Expand Up @@ -551,7 +551,7 @@ func (build *builderKraftfileUnikraft) Statistics(ctx context.Context, opts *Bui

processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("statistics %s (%s)", (*opts.Target).Name(), target.TargetPlatArchName(*opts.Target)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
lines, err := linesOfCode(ctx, opts)
if lines > 1 {
opts.statistics["lines of code"] = fmt.Sprintf("%d", lines)
Expand Down
4 changes: 2 additions & 2 deletions internal/cli/kraft/cloud/volume/import/import.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ func importVolumeData(ctx context.Context, opts *ImportOptions) (retErr error) {
var copyCPIOErr error

paraprogress, err := paraProgress(ctx, fmt.Sprintf("Importing data (%s)", humanize.IBytes(uint64(cpioSize))),
func(ctx context.Context, callback func(float64)) (retErr error) {
func(ctx context.Context, prompt func(), callback func(float64)) (retErr error) {
instAddr := instFQDN + ":" + strconv.FormatUint(uint64(volimportPort), 10)
conn, err := tls.Dial("tcp4", instAddr, nil)
if err != nil {
Expand Down Expand Up @@ -228,7 +228,7 @@ func processTree(ctx context.Context, txt string, fn processtree.SpinnerProcess)
}

// paraProgress returns a TUI ParaProgress configured to run the given function.
func paraProgress(ctx context.Context, txt string, fn func(context.Context, func(float64)) error) (*paraprogress.ParaProgress, error) {
func paraProgress(ctx context.Context, txt string, fn func(context.Context, func(), func(float64)) error) (*paraprogress.ParaProgress, error) {
return paraprogress.NewParaProgress(ctx, []*paraprogress.Process{
paraprogress.NewProcess(txt, fn),
})
Expand Down
10 changes: 5 additions & 5 deletions internal/cli/kraft/fetch/fetch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func (opts *FetchOptions) pull(ctx context.Context, project app.Application, wor
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(pullPack),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return pullPack.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -346,7 +346,7 @@ func (opts *FetchOptions) pull(ctx context.Context, project app.Application, wor
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(p),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return p.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -424,7 +424,7 @@ func (opts *FetchOptions) Run(ctx context.Context, _ []string) error {
configure := true

if opts.project.IsConfigured(targ) {
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:")
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:", func() {})
if err != nil {
return err
}
Expand All @@ -433,7 +433,7 @@ func (opts *FetchOptions) Run(ctx context.Context, _ []string) error {
if configure {
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("configuring %s (%s)", targ.Name(), target.TargetPlatArchName(targ)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return opts.project.Configure(
ctx,
targ, // Target-specific options
Expand All @@ -456,7 +456,7 @@ func (opts *FetchOptions) Run(ctx context.Context, _ []string) error {

processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("fetching %s (%s)", targ.Name(), target.TargetPlatArchName(targ)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
err := opts.project.Fetch(
ctx,
targ, // Target-specific options
Expand Down
4 changes: 2 additions & 2 deletions internal/cli/kraft/lib/create/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func (opts *CreateOptions) Run(ctx context.Context, args []string) error {

if !config.G[config.KraftKit](ctx).NoPrompt {
if !opts.GitInit {
opts.GitInit, err = confirm.NewConfirm("Do you want to intialise library with git:")
opts.GitInit, err = confirm.NewConfirm("Do you want to intialise library with git:", func() {})
if err != nil {
return err
}
Expand Down Expand Up @@ -124,7 +124,7 @@ func (opts *CreateOptions) Run(ctx context.Context, args []string) error {
}

if !opts.UpdateRefs {
opts.UpdateRefs, err = confirm.NewConfirm("Do you want to package it:")
opts.UpdateRefs, err = confirm.NewConfirm("Do you want to package it:", func() {})
if err != nil {
return err
}
Expand Down
8 changes: 4 additions & 4 deletions internal/cli/kraft/menu/menu.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ func (opts *MenuOptions) pull(ctx context.Context, project app.Application, work
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(pullPack),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return pullPack.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -337,7 +337,7 @@ func (opts *MenuOptions) pull(ctx context.Context, project app.Application, work
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(p),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return p.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -426,7 +426,7 @@ func (opts *MenuOptions) Run(ctx context.Context, _ []string) error {
configure := true

if opts.project.IsConfigured(targ) {
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:")
configure, err = confirm.NewConfirm("project already configured, are you sure you want to rerun the configure step:", func() {})
if err != nil {
return err
}
Expand All @@ -435,7 +435,7 @@ func (opts *MenuOptions) Run(ctx context.Context, _ []string) error {
if configure {
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("configuring %s (%s)", targ.Name(), target.TargetPlatArchName(targ)),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return opts.project.Configure(
ctx,
targ, // Target-specific options
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/kraft/pkg/packager_kraftfile_runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ func (p *packagerKraftfileRuntime) Pack(ctx context.Context, opts *PkgOptions, a
ctx,
[]*paraprogress.Process{paraprogress.NewProcess(
fmt.Sprintf("pulling %s", runtime.String()),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
popts := []pack.PullOption{}
if log.LoggerTypeFromString(config.G[config.KraftKit](ctx).Log.Type) == log.FANCY {
popts = append(popts, pack.WithPullProgressFunc(w))
Expand Down
4 changes: 2 additions & 2 deletions internal/cli/kraft/pkg/pull/pull.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ func (opts *PullOptions) Run(ctx context.Context, args []string) error {
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(pullPack),
),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return pullPack.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down Expand Up @@ -457,7 +457,7 @@ func (opts *PullOptions) Run(ctx context.Context, args []string) error {
p := p
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("pulling %s", p.String()),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return p.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/kraft/run/runner_kraftfile_runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ func (runner *runnerKraftfileRuntime) Prepare(ctx context.Context, opts *RunOpti
ctx,
[]*paraprogress.Process{paraprogress.NewProcess(
fmt.Sprintf("pulling %s", found.String()),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
popts := []pack.PullOption{}
if log.LoggerTypeFromString(config.G[config.KraftKit](ctx).Log.Type) == log.FANCY {
popts = append(popts, pack.WithPullProgressFunc(w))
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/kraft/run/runner_linuxu.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ func (runner *runnerLinuxu) Prepare(ctx context.Context, opts *RunOptions, machi
ctx,
[]*paraprogress.Process{paraprogress.NewProcess(
fmt.Sprintf("pulling %s", loader.Name()),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
popts := []pack.PullOption{
pack.WithPullWorkdir(dir),
}
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/kraft/run/runner_package.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ func (runner *runnerPackage) Prepare(ctx context.Context, opts *RunOptions, mach
ctx,
[]*paraprogress.Process{paraprogress.NewProcess(
fmt.Sprintf("pulling %s", runner.packName),
func(ctx context.Context, w func(progress float64)) error {
func(ctx context.Context, prompt func(), w func(progress float64)) error {
return selected.Pull(
ctx,
pack.WithPullProgressFunc(w),
Expand Down
5 changes: 4 additions & 1 deletion tui/confirm/confirm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

// NewConfirm is a utility method used in a CLI context to prompt the user with
// a yes/no question.
func NewConfirm(question string) (bool, error) {
func NewConfirm(question string, beforeAfter func()) (bool, error) {
input := confirmation.New(
tui.TextWhiteBgBlue("[?]")+" "+
question,
Expand All @@ -24,5 +24,8 @@ func NewConfirm(question string) (bool, error) {
input.KeyMap.SelectYes = append(input.KeyMap.SelectYes, "+")
input.KeyMap.SelectNo = append(input.KeyMap.SelectNo, "-")

beforeAfter()
defer beforeAfter()

return input.RunPrompt()
}
17 changes: 13 additions & 4 deletions tui/paraprogress/process.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ type ProgressMsg struct {
type Process struct {
id int
percent float64
processFunc func(context.Context, func(float64)) error
processFunc func(context.Context, func(), func(float64)) error
progress progress.Model
prompting bool
spinner spinner.Model
timer stopwatch.Model
timerWidth int
Expand All @@ -85,7 +86,7 @@ type Process struct {
Status ProcessStatus
}

func NewProcess(name string, processFunc func(context.Context, func(float64)) error) *Process {
func NewProcess(name string, processFunc func(context.Context, func(), func(float64)) error) *Process {
d := &Process{
id: nextID(),
Name: name,
Expand Down Expand Up @@ -131,7 +132,7 @@ func (p *Process) Start() tea.Cmd {
log.G(p.ctx).Info(p.Name)
}

err := p.processFunc(p.ctx, p.onProgress)
err := p.processFunc(p.ctx, p.TogglePrompting, p.onProgress)
p.Status = StatusSuccess
if err != nil {
p.Status = StatusFailed
Expand Down Expand Up @@ -241,7 +242,11 @@ func (d *Process) Update(msg tea.Msg) (*Process, tea.Cmd) {
return d, tea.Batch(cmds...)
}

func (p Process) View() string {
func (p *Process) TogglePrompting() {
p.prompting = !p.prompting
}

func (p *Process) View() string {
left := ""

switch p.Status {
Expand Down Expand Up @@ -304,5 +309,9 @@ func (p Process) View() string {
}
}

if p.prompting {
return ""
}

return s
}
Loading