Mailspring/internal_packages
Evan Morikawa 531118ac5c fix(tasks): don't continue if dependent task fails
Summary:
Fixes T4291

If I made a final edit to a pre-existing draft and sent, we'd queue a
`SyncbackDraftTask` before a `SendDraftTask`. This is important because
since we have a valid draft `server_id`, the `SendDraftTask` will send by
server_id, not by POSTing the whole body.

If the `SyncbackDraftTask` fails, then we had a very serious issue whereby
the `SendDraftTask` would keep on sending. Unfortunately the server never
got the latest changes and sent the wrong version of the draft. This
incorrect version would show up later when the `/send` endpoint returned
the message that got actually sent.

The solution was to make any queued `SendDraftTask` fail if a dependent
`SyncbackDraftTask` failed.

This meant we needed to make the requirements for `shouldWaitForTask`
stricter, and block if tasks failed.

Unfortunatley there was no infrastructure in place to do this.

The first change was to change `shouldWaitForTask` to `isDependentTask`.
If we're going to fail when a dependent task fails, I wanted the method
name to reflect this.

Now, if a dependent task fails, we recursively check the dependency tree
(and check for cycles) and `dequeue` anything that needed that to succeed.

I chose `dequeue` as the default action because it seemed as though all
current uses of `shouldWaitForTask` really should bail if their
dependencies fail. It's possible you don't want your task dequeued in this
dependency case. You can return the special `Task.DO_NOT_DEQUEUE_ME`
constant from the `onDependentTaskError` method.

When a task gets dequeued because of the reason above, the
`onDependentTaskError` callback gets fired. This gives tasks like the
`SendDraftTask` a chance to notify the user that it bailed. Not all tasks
need to notify.

The next big issue was a better way to determine if a task truely errored
to the point that we need to dequeue dependencies. In the Developer Status
area we were showing tasks that had errored as "Green" because we caught
the error and resolved with `Task.Status.Finished`. This used to be fine
since nothing life-or-death cared if a task errored or not. Now that it
might cause abortions down the line, we needed a more robust method then
this.

For one I changed `Task.Status.Finished` to a variety of finish types
including `Task.Status.Success`. The way you "error" out is to `throw` or
`Promise.reject` an `Error` object from the `performRemote` method. This
allows us to propagate API errors up, and acts as a safety net that can
catch any malformed code or unexpected responses.

The developer bar now shows a much richer set of statuses instead of a
binary one, which was REALLY helpful in debugging this. We also record
when a Task got dequeued because of the conditions introduced here.

Once all this was working we still had an issue of sending old drafts.

If after a `SyncbackDraftTask` failed, now we'd block the send and notify
the users as such. However, if we tried to send again, there was a
separate issue whereby we wouldn't queue another `SyncbackDraftTask` to
update the server with the latest information. Since our changes were
persisted to the DB, we thought we had no changes, and therefore didn't
need to queue a `SyncbackDraftTask`.

The fix to this is to always force the creation of a `SyncbackDraftTask`
before send regardless of the state of the `DraftStoreProxy`.

Test Plan: new tests. Lots of manual testing

Reviewers: bengotow

Reviewed By: bengotow

Subscribers: mg

Maniphest Tasks: T4291

Differential Revision: https://phab.nylas.com/D2156
2015-10-21 10:33:43 -07:00
..
account-sidebar Fix scrollability in expanded activity sidebar 2015-10-09 09:31:37 -07:00
attachments
category-picker switch(env): Move N1 to Nylas production API 2015-10-02 15:01:31 -07:00
composer fix(tasks): don't continue if dependent task fails 2015-10-21 10:33:43 -07:00
composer-signature
composer-spellcheck
events disable(events): Turn off the events package until it can be polished 2015-10-04 16:57:43 -07:00
feedback fix(feedback): Make button slightly smaller, less obtrusive 2015-10-12 11:04:27 -07:00
inbox-contact-elements
message-list fix(styles): padding fixes 2015-10-05 00:38:48 -07:00
mode-switch
notification-mailto fix(docs): Replace docs references to Edgehill with N1 2015-09-29 09:45:02 -07:00
notification-update-available rename(Nylas Mail): Replace Nylas Mail > N1 2015-09-29 09:44:30 -07:00
notifications fix(sidebar): Prevent white top border in all scenarios 2015-10-12 11:14:44 -07:00
onboarding fix(auth): Resize the auth window after an update to the token status 2015-10-06 17:58:07 -07:00
plugins actually no more gh-pages 2015-10-05 05:08:53 -07:00
preferences fix(config): new mail sounds on by default, change config keypath 2015-10-14 17:11:36 -07:00
search-bar
sidebar-fullcontact fix(message-sidebar): New ContactCard injectable role, updated FocusedContactStore 2015-09-24 18:58:53 -07:00
thread-list fix(thread-list): stop thread-icons from shrinking, justify participants explicitly 2015-10-14 18:05:29 -07:00
tooltip
ui-dark fix(theme): more consistent styles for dark-mode theme 2015-10-09 16:05:26 -07:00
ui-light fix(fonts): update fonts and styles 2015-10-01 17:55:11 -07:00
undo-redo
unread-notifications fix(config): new mail sounds on by default, change config keypath 2015-10-14 17:11:36 -07:00
worker-sync fix(specs): ContactStore spec fixes for new contact ranking support 2015-10-09 13:42:24 -07:00
worker-ui fix(tasks): don't continue if dependent task fails 2015-10-21 10:33:43 -07:00