1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
// Copyright 2020 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package task
import (
"context"
"encoding/json"
"fmt"
"strings"
"github.com/pingcap/tiup/pkg/cluster/ctxt"
logprinter "github.com/pingcap/tiup/pkg/logger/printer"
"github.com/pingcap/tiup/pkg/tui/progress"
)
// StepDisplay is a task that will display a progress bar for inner task.
type StepDisplay struct {
hidden bool
inner Task
prefix string
children map[Task]struct{}
Logger *logprinter.Logger
progressBar progress.Bar
}
func addChildren(m map[Task]struct{}, task Task) {
if _, exists := m[task]; exists {
return
}
m[task] = struct{}{}
if t, ok := task.(*Serial); ok {
t.hideDetailDisplay = true
for _, tx := range t.inner {
if _, exists := m[tx]; !exists {
addChildren(m, tx)
}
}
} else if t, ok := task.(*Parallel); ok {
t.hideDetailDisplay = true
for _, tx := range t.inner {
if _, exists := m[tx]; !exists {
addChildren(m, tx)
}
}
}
}
func newStepDisplay(prefix string, inner Task, logger *logprinter.Logger) *StepDisplay {
children := make(map[Task]struct{})
addChildren(children, inner)
return &StepDisplay{
inner: inner,
prefix: prefix,
children: children,
Logger: logger,
progressBar: progress.NewSingleBar(prefix),
}
}
// SetHidden set step hidden or not.
func (s *StepDisplay) SetHidden(h bool) *StepDisplay {
s.hidden = h
return s
}
// SetLogger set the logger of step
func (s *StepDisplay) SetLogger(logger *logprinter.Logger) *StepDisplay {
s.Logger = logger
return s
}
func (s *StepDisplay) resetAsMultiBarItem(b *progress.MultiBar) {
s.progressBar = b.AddBar(s.prefix)
}
// Execute implements the Task interface
func (s *StepDisplay) Execute(ctx context.Context) error {
if s.hidden {
ctxt.GetInner(ctx).Ev.Subscribe(ctxt.EventTaskBegin, s.handleTaskBegin)
ctxt.GetInner(ctx).Ev.Subscribe(ctxt.EventTaskProgress, s.handleTaskProgress)
err := s.inner.Execute(ctx)
ctxt.GetInner(ctx).Ev.Unsubscribe(ctxt.EventTaskProgress, s.handleTaskProgress)
ctxt.GetInner(ctx).Ev.Unsubscribe(ctxt.EventTaskBegin, s.handleTaskBegin)
return err
}
switch s.Logger.GetDisplayMode() {
case logprinter.DisplayModeJSON,
logprinter.DisplayModePlain:
// do nothing
default:
if singleBar, ok := s.progressBar.(*progress.SingleBar); ok {
singleBar.StartRenderLoop()
defer singleBar.StopRenderLoop()
}
}
ctxt.GetInner(ctx).Ev.Subscribe(ctxt.EventTaskBegin, s.handleTaskBegin)
ctxt.GetInner(ctx).Ev.Subscribe(ctxt.EventTaskProgress, s.handleTaskProgress)
err := s.inner.Execute(ctx)
ctxt.GetInner(ctx).Ev.Unsubscribe(ctxt.EventTaskProgress, s.handleTaskProgress)
ctxt.GetInner(ctx).Ev.Unsubscribe(ctxt.EventTaskBegin, s.handleTaskBegin)
var dp *progress.DisplayProps
if err != nil {
dp = &progress.DisplayProps{
Prefix: s.prefix,
Mode: progress.ModeError,
}
} else {
dp = &progress.DisplayProps{
Prefix: s.prefix,
Mode: progress.ModeDone,
}
}
switch s.Logger.GetDisplayMode() {
case logprinter.DisplayModeJSON:
_ = printDpJSON(dp)
case logprinter.DisplayModePlain:
printDpPlain(s.Logger, dp)
default:
s.progressBar.UpdateDisplay(dp)
}
return err
}
// Rollback implements the Task interface
func (s *StepDisplay) Rollback(ctx context.Context) error {
return s.inner.Rollback(ctx)
}
// String implements the fmt.Stringer interface
func (s *StepDisplay) String() string {
return s.inner.String()
}
func (s *StepDisplay) handleTaskBegin(task Task) {
if _, ok := s.children[task]; !ok {
return
}
dp := &progress.DisplayProps{
Prefix: s.prefix,
Suffix: strings.Split(task.String(), "\n")[0],
}
switch s.Logger.GetDisplayMode() {
case logprinter.DisplayModeJSON:
_ = printDpJSON(dp)
case logprinter.DisplayModePlain:
printDpPlain(s.Logger, dp)
default:
s.progressBar.UpdateDisplay(dp)
}
}
func (s *StepDisplay) handleTaskProgress(task Task, p string) {
if _, ok := s.children[task]; !ok {
return
}
dp := &progress.DisplayProps{
Prefix: s.prefix,
Suffix: strings.Split(p, "\n")[0],
}
switch s.Logger.GetDisplayMode() {
case logprinter.DisplayModeJSON:
_ = printDpJSON(dp)
case logprinter.DisplayModePlain:
printDpPlain(s.Logger, dp)
default:
s.progressBar.UpdateDisplay(dp)
}
}
// ParallelStepDisplay is a task that will display multiple progress bars in parallel for inner tasks.
// Inner tasks will be executed in parallel.
type ParallelStepDisplay struct {
inner *Parallel
prefix string
Logger *logprinter.Logger
progressBar *progress.MultiBar
}
func newParallelStepDisplay(prefix string, ignoreError bool, sdTasks ...*StepDisplay) *ParallelStepDisplay {
bar := progress.NewMultiBar(prefix)
tasks := make([]Task, 0, len(sdTasks))
for _, t := range sdTasks {
if !t.hidden {
t.resetAsMultiBarItem(bar)
}
tasks = append(tasks, t)
}
return &ParallelStepDisplay{
inner: &Parallel{inner: tasks, ignoreError: ignoreError},
prefix: prefix,
progressBar: bar,
}
}
// SetLogger set the logger of step
func (ps *ParallelStepDisplay) SetLogger(logger *logprinter.Logger) *ParallelStepDisplay {
ps.Logger = logger
return ps
}
// Execute implements the Task interface
func (ps *ParallelStepDisplay) Execute(ctx context.Context) error {
switch ps.Logger.GetDisplayMode() {
case logprinter.DisplayModeJSON,
logprinter.DisplayModePlain:
// do nothing
default:
ps.progressBar.StartRenderLoop()
defer ps.progressBar.StopRenderLoop()
}
err := ps.inner.Execute(ctx)
return err
}
// Rollback implements the Task interface
func (ps *ParallelStepDisplay) Rollback(ctx context.Context) error {
return ps.inner.Rollback(ctx)
}
// String implements the fmt.Stringer interface
func (ps *ParallelStepDisplay) String() string {
return ps.inner.String()
}
func printDpJSON(dp *progress.DisplayProps) error {
output, err := json.Marshal(dp)
if err != nil {
return err
}
fmt.Println(string(output))
return nil
}
func printDpPlain(logger *logprinter.Logger, dp *progress.DisplayProps) {
switch dp.Mode {
case progress.ModeError:
logger.Errorf("progress: %s", dp)
default:
logger.Infof("progress: %s", dp)
}
}
|