progress: Show task error in place of progress bar #259

aaronlehmann · 2017-06-27T22:03:26Z

If a task encounters an error, the interactive "service create" and "service update" commands should show that error instead of showing a stuck progress bar.

To validate:

docker service create --detach=false --name broken --restart-condition=none --replicas 3 busybox asdf

and

docker service create --detach=false --name broken --mode global --restart-condition=none busybox asdf

Related to moby/moby#33807
Also related: moby/swarmkit#2287

cc @thaJeztah

If a task encounters an error, the interactive "service create" and "service update" commands should show that error instead of showing a stuck progress bar. To validate: docker service create --detach=false --name broken --restart-condition=none --replicas 3 busybox asdf and docker service create --detach=false --name broken --mode global --restart-condition none busybox asdf Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

dnephin

How can we test these changes?

Full integration tests of the progress bars is going to be difficult, but we should be able to unit test a bunch of the internal logic.

dnephin · 2017-06-28T20:25:07Z

cli/command/service/progress/progress.go

+			running++
+		}
+
+		if u.done || replicas > maxProgressBars || uint64(mappedSlot) > replicas {


It seems like the evaluation of replicas > maxProgressBars will never change inside this for loop (one is a constant, the other is set one above). Is that right?

I guess the purpose of this check is to not display progress bars if there are too many replicas? Couldn't this be handled at the top of the function?

I guess the purpose of this check is to not display progress bars if there are too many replicas? Couldn't this be handled at the top of the function?

We also have to count the number of running tasks, which this loop does as well.

dnephin · 2017-06-28T20:29:15Z

cli/command/service/progress/progress.go

-		if !u.done && replicas <= maxProgressBars && uint64(mappedSlot) <= replicas {
+		if !terminalState(task.DesiredState) && task.Status.State == swarm.TaskStateRunning {
+			running++
+		}


Could the body of this for loop be a separate method which returns the running count?

I think that would improve the readability of this function, and would make it easier to test this new code.

Could the body of this for loop be a separate method which returns the running count?

Wouldn't it have the side effect of outputting progress information?

Yes it would, but the current function has that side effect plus a bunch of other logic, so it's not any worse off, right? It actually moves almost all of the progress printing to that new function. With a couple other smaller changes we could probably remove all of the progress printing from update()

dnephin · 2017-06-28T20:31:04Z

cli/command/service/progress/progress.go

+				running++
+			}
+
+			if u.done || nodeCount > maxProgressBars {


same question about nodeCount > maxProgressBars not changing value within this for loop.

And also splitting this out into a new function (which should remove the need for nolint, and help testing).

aaronlehmann · 2017-06-28T20:56:35Z

Full integration tests of the progress bars is going to be difficult, but we should be able to unit test a bunch of the internal logic.

I am going to work on some tests for the internal logic. Any preferences on adding them to this PR or a separate one?

dnephin · 2017-06-28T21:06:09Z

My preference would be this PR

aaronlehmann · 2017-06-29T00:49:08Z

Added unit tests and did some light refactoring.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

codecov-io · 2017-06-29T03:16:22Z

Codecov Report

Merging #259 into master will decrease coverage by 1.78%.
The diff coverage is 77.77%.

@@            Coverage Diff            @@
##           master    #259      +/-   ##
=========================================
- Coverage   48.68%   46.9%   -1.79%     
=========================================
  Files         185     173      -12     
  Lines       12168   11942     -226     
=========================================
- Hits         5924    5601     -323     
- Misses       5877    6019     +142     
+ Partials      367     322      -45

dnephin

LGTM

Thanks for the refactor and unit tests, looks great. One nit, but it's not a blocker

dnephin · 2017-06-30T18:31:41Z

cli/command/service/progress/progress.go

+		if task.NodeID != "" {
+			if _, nodeActive := activeNodes[task.NodeID]; nodeActive {
+				tasksBySlot[task.Slot] = task
+			}


If task.NodeID is not empty but the node is not active then we skip the task.

Minor nit, but this case seems like it would be more obvious like this:

if _, nodeActive := activeNodes[task.NodeID]; !nodeActive { continue } tasksBySlot[task.Slot] = task

That way it matches the checks above and there is only one line which assigns to tasksBySlot

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

thaJeztah

LGTM 👍

GordonTheTurtle added the status/0-triage label Jun 27, 2017

aaronlehmann force-pushed the service-progress-surface-error branch from 9abe8ad to 1ef585f Compare June 27, 2017 22:12

dnephin added status/2-code-review and removed status/0-triage labels Jun 28, 2017

dnephin reviewed Jun 28, 2017

View reviewed changes

aaronlehmann force-pushed the service-progress-surface-error branch from bad435d to ce2aa0d Compare June 29, 2017 00:49

progress: Add unit tests

dd3eae8

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

aaronlehmann force-pushed the service-progress-surface-error branch 2 times, most recently from 4519d06 to 04c6299 Compare June 29, 2017 00:58

dnephin approved these changes Jun 30, 2017

View reviewed changes

progress: Light refactor

c9b92a3

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>

aaronlehmann force-pushed the service-progress-surface-error branch from 04c6299 to c9b92a3 Compare July 6, 2017 17:40

dnephin approved these changes Jul 6, 2017

View reviewed changes

thaJeztah approved these changes Jul 9, 2017

View reviewed changes

thaJeztah merged commit 7ae9bc1 into docker:master Jul 9, 2017

GordonTheTurtle added this to the 17.07.0 milestone Jul 9, 2017

aaronlehmann deleted the service-progress-surface-error branch July 10, 2017 05:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

progress: Show task error in place of progress bar #259

progress: Show task error in place of progress bar #259

aaronlehmann commented Jun 27, 2017

dnephin left a comment

dnephin Jun 28, 2017

aaronlehmann Jun 28, 2017

dnephin Jun 28, 2017

aaronlehmann Jun 28, 2017

dnephin Jun 28, 2017

dnephin Jun 28, 2017

aaronlehmann commented Jun 28, 2017

dnephin commented Jun 28, 2017

aaronlehmann commented Jun 29, 2017

codecov-io commented Jun 29, 2017 •

edited

Loading

dnephin left a comment

dnephin Jun 30, 2017

aaronlehmann Jul 6, 2017

thaJeztah left a comment

progress: Show task error in place of progress bar #259

progress: Show task error in place of progress bar #259

Conversation

aaronlehmann commented Jun 27, 2017

dnephin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronlehmann commented Jun 28, 2017

dnephin commented Jun 28, 2017

aaronlehmann commented Jun 29, 2017

codecov-io commented Jun 29, 2017 • edited Loading

Codecov Report

dnephin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thaJeztah left a comment

Choose a reason for hiding this comment

codecov-io commented Jun 29, 2017 •

edited

Loading