Implement Abort() API call #1122

eu-siemann · 2019-03-01T15:53:21Z

The main idea of this PR is to provide an ability to abort ongoing downloads and reset the queue to an empty state. It also removes Shutdown() call, which was bringing an Aktualizr object to an unusable state and fixes the issue with a possible race condition between Pause()/Resume() calls.
The PR still lacks tests for the Abort() functionality and more proper handling of an abort event in fetcher and uptane client.
At least it doesn't seem to break existing functionality and I feel that it's already getting quite big,
so it would be great if you could have a look at it next week.

codecov-io · 2019-03-01T16:27:58Z

Codecov Report

Merging #1122 into master will decrease coverage by 0.06%.
The diff coverage is 92.25%.

@@            Coverage Diff             @@
##           master    #1122      +/-   ##
==========================================
- Coverage   77.82%   77.75%   -0.07%     
==========================================
  Files         167      169       +2     
  Lines       10001    10004       +3     
==========================================
- Hits         7783     7779       -4     
- Misses       2218     2225       +7

Impacted Files	Coverage Δ
src/libaktualizr/primary/aktualizr.h	`100% <ø> (ø)`	⬆️
src/libaktualizr/package_manager/ostreemanager.h	`100% <ø> (ø)`	⬆️
src/libaktualizr/primary/sotauptaneclient.h	`100% <ø> (ø)`	⬆️
src/libaktualizr/http/httpclient.h	`100% <ø> (ø)`	⬆️
src/hmi_stub/main.cc	`0% <0%> (ø)`	⬆️
src/libaktualizr/utilities/apiqueue.h	`100% <100%> (ø)`
src/libaktualizr/http/httpinterface.h	`100% <100%> (ø)`	⬆️
src/libaktualizr/uptane/fetcher.h	`77.77% <100%> (-6.23%)`	⬇️
src/libaktualizr/http/httpclient.cc	`91.92% <100%> (+0.2%)`	⬆️
src/sota_tools/request_pool.cc	`91.48% <100%> (+0.09%)`	⬆️
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6202e4...61d2f9b. Read the comment docs.

pattivacek

I got interrupted, will continue reviewing tomorrow.

tests/sota_tools/treehub_server.py

tests/sota_tools/repo/refs/heads/master

pattivacek

Did a more thorough review today. Mostly looks fine. So the point of the token is to have one object to represent the API state, right? For some reason it took me a minute to make sense out of that, but it seems fine to me now. I still haven't played around with this, but the easiest way to do that is with hmi_stub, which is lacking the Abort function. Once that is there, I'd like to try it out and make sure it behaves as expected.

src/libaktualizr/utilities/apiqueue.cc

src/libaktualizr/primary/aktualizr.h

pattivacek · 2019-03-07T14:16:37Z

src/libaktualizr/primary/aktualizr.h

+   * but the Aktualizr will remain in the paused state. To continue execution
+   * at some later point one needs to call Resume().
+   */
+  void Abort();


Is it worth mentioning that the only command that can be interrupted while in progress is downloading?

I'm not so sure if it's worth mentioning here. It's unlikely, but what if we decide to abort e.g. CheckForUpdates at some later point?

It's not strictly necessary, but when I read "Requests the currently running command to abort", that leads me to assume that all commands can be aborted while in progress, and that isn't true. If it later becomes true, or even if just one more command is abortable, we can change the doc here again to reflect that as necessary.

Agreed, sounds confusing. I'll rephrase it.

src/hmi_stub/main.cc

eu-siemann · 2019-03-11T12:43:54Z

Thanks for the review, @patrickvacek! I'll fix the mentioned issues soon.
The idea of the token is to make pause/cancellation more generic, so we can reuse it in other tasks if we want to, and, more important, to control the execution flow from one place, so we avoid race conditions.

pattivacek · 2019-03-11T12:46:48Z

The idea of the token is to make pause/cancellation more generic, so we can reuse it in other tasks if we want to, and, more important, to control the execution flow from one place, so we avoid race conditions.

Great, that was my understanding. That is perfect. The abstraction was confusing to me at first, but it is obviously superior to me now that I understand it better.

Squashed based on commit: 9076faf advancedtelematic#1122 Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

lbonn

Cool!

pattivacek

Lot of awesome work here!

pattivacek · 2019-03-22T11:14:06Z

tests/sota_tools/treehub_server.py

+            self.send_response_only(200)
+        else:
+            self.send_response_only(404)
+        self.end_headers()


do_HEAD looks to be duplicated.

oops, thanks!

tests/sota_tools/test-garage-deploy-dry-run

pattivacek · 2019-03-22T11:20:14Z

tests/sota_tools/treehub_server.py

 try:
-    httpd.serve_forever()
-except KeyboardInterrupt as k:
+    with ExitStack() as stack:


What benefit does the ExitStack and sig_handler provide? Just curious, not doubting. :)

sys.exit(0) in signal handler will raise a SystemExit exception, which will unwind the ExitStack cleaning up the tmp directory

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

eu-siemann requested review from lbonn, pattivacek and mike-sul March 1, 2019 15:53

doanac mentioned this pull request Mar 5, 2019

Feature Proposal: Docker "packages" #1118

Closed

pattivacek reviewed Mar 6, 2019

View reviewed changes

tests/sota_tools/treehub_server.py Outdated Show resolved Hide resolved

tests/sota_tools/repo/refs/heads/master Outdated Show resolved Hide resolved

pattivacek reviewed Mar 7, 2019

View reviewed changes

doanac mentioned this pull request Mar 12, 2019

RFC: Remove circular dependency between fetcher(uptane) and packagemanager #1135

Closed

eu-siemann force-pushed the feat/abort branch from 2b32552 to eb00171 Compare March 14, 2019 14:59

eu-siemann added the not-ready label Mar 14, 2019

eu-siemann force-pushed the feat/abort branch 4 times, most recently from 23a7b00 to a0be831 Compare March 20, 2019 15:25

doanac pushed a commit to doanac/aktualizr that referenced this pull request Mar 20, 2019

[FIO fromlist]: PR advancedtelematic#1122 Implement Abort() API call

1b2a61e

Squashed based on commit: 9076faf advancedtelematic#1122 Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

eu-siemann force-pushed the feat/abort branch 6 times, most recently from 9715ed2 to 402be5d Compare March 21, 2019 16:47

eu-siemann added ready and removed not-ready labels Mar 21, 2019

eu-siemann force-pushed the feat/abort branch from 402be5d to bcf8d3c Compare March 22, 2019 09:53

lbonn approved these changes Mar 22, 2019

View reviewed changes

eu-siemann force-pushed the feat/abort branch from bcf8d3c to 2923075 Compare March 22, 2019 11:07

pattivacek reviewed Mar 22, 2019

View reviewed changes

fetcher_test: pause OSTree based on the progress

311a6c0

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

Eugene Smirnov added 2 commits March 22, 2019 13:52

Request pool: fix debug print

3d8d199

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

OSTree manager: use GCancellable with pull

1d938d5

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

pattivacek approved these changes Mar 22, 2019

View reviewed changes

Eugene Smirnov added 5 commits March 22, 2019 13:55

Fetcher: abort download from the progress callback

dcb9784

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

Fetcher: make download cancellable

c113f99

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

Separate API command queue implementation

0936feb

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

Implement Abort() API call

0b97df7

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

tests/ostree_http_repo: count connections for all objects

61d2f9b

Signed-off-by: Eugene Smirnov <evgenii.smirnov@here.com>

eu-siemann force-pushed the feat/abort branch from 2923075 to 61d2f9b Compare March 22, 2019 13:00

eu-siemann merged commit 6254e96 into master Mar 22, 2019

eu-siemann deleted the feat/abort branch March 26, 2019 10:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Abort() API call #1122

Implement Abort() API call #1122

eu-siemann commented Mar 1, 2019

codecov-io commented Mar 1, 2019 •

edited

Loading

pattivacek left a comment

pattivacek left a comment

pattivacek Mar 7, 2019

eu-siemann Mar 11, 2019

pattivacek Mar 11, 2019

eu-siemann Mar 11, 2019

eu-siemann commented Mar 11, 2019

pattivacek commented Mar 11, 2019

lbonn left a comment

pattivacek left a comment

pattivacek Mar 22, 2019

eu-siemann Mar 22, 2019

pattivacek Mar 22, 2019

eu-siemann Mar 22, 2019

Implement Abort() API call #1122

Implement Abort() API call #1122

Conversation

eu-siemann commented Mar 1, 2019

codecov-io commented Mar 1, 2019 • edited Loading

Codecov Report

pattivacek left a comment

Choose a reason for hiding this comment

pattivacek 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

eu-siemann commented Mar 11, 2019

pattivacek commented Mar 11, 2019

lbonn left a comment

Choose a reason for hiding this comment

pattivacek 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

codecov-io commented Mar 1, 2019 •

edited

Loading