Mailspring/spec-nylas
Ben Gotow 45bb16561f feat(offline-mode, undo-redo): Tasks handle network errors better and retry, undo/redo based on tasks
Summary:
This diff does a couple things:

- Undo redo with a new undo/redo store that maintains it's own queue of undo/redo tasks. This queue is separate from the TaskQueue because not all tasks should be considered for undo history! Right now just the AddRemoveTagsTask is undoable.

- NylasAPI.makeRequest now returns a promise which resolves with the result or rejects with an error. For things that still need them, there's still `success` and `error` callbacks. I also added `started:(req) ->` which allows you to get the underlying request.

- Aborting a NylasAPI request now makes it call it's error callback / promise reject.

- You can now run code after perform local has completed using this syntax:

```
    task = new AddRemoveTagsTask(focused, ['archive'], ['inbox'])
    task.waitForPerformLocal().then ->
      Actions.setFocus(collection: 'thread', item: nextFocus)
      Actions.setCursorPosition(collection: 'thread', item: nextKeyboard)
    Actions.queueTask(task)
```

- In specs, you can now use `advanceClock` to get through a Promise.then/catch/finally. Turns out it was using something low level and not using setTimeout(0).

- The TaskQueue uses promises better and defers a lot of the complexity around queueState for performLocal/performRemote to a task subclass called APITask. APITask implements "perform" and breaks it into "performLocal" and "performRemote".

- All tasks either resolve or reject. They're always removed from the queue, unless they resolve with Task.Status.Retry, which means they internally did a .catch (err) => Promise.resolve(Task.Status.Retry) and they want to be run again later.

- API tasks retry until they succeed or receive a NylasAPI.PermanentErrorCode (400,404,500), in which case they revert and finish.

- The AddRemoveTags Task can now take more than one thread! This is super cool because you can undo/redo a bulk action and also because we'll probably have a bulk tag modification API endpoint soon.

Getting undo / redo working revealed that the thread versioning system we built isn't working because the server was incrementing things by more than 1 at a time. Now we count the number of unresolved "optimistic" changes we've made to a given model, and only accept the server's version of it once the number of optimistic changes is back at zero.

Known Issues:

- AddRemoveTagsTasks aren't dependent on each other, so if you (undo/redo x lots) and then come back online, all the tasks try to add / remove all the tags at the same time. To fix this we can either allow the tasks to be merged together into a minimal set or make them block on each other.

- When Offline, you still get errors in the console for GET requests. Need to catch these and display an offline status bar.

- The metadata tasks haven't been updated yet to the new API. Wanted to get it reviewed first!

Test Plan: All the tests still pass!

Reviewers: evan

Reviewed By: evan

Differential Revision: https://phab.nylas.com/D1694
2015-07-07 13:38:53 -04:00
..
components fix(thread-list): Narrow mode, and new selection rules for three-pane 2015-06-11 18:00:40 -07:00
fixtures refactor(DB): promisify database 2015-06-26 07:42:41 -07:00
models refactor(utils): switch to regular underscore 2015-05-19 16:06:59 -07:00
stores feat(offline-mode, undo-redo): Tasks handle network errors better and retry, undo/redo based on tasks 2015-07-07 13:38:53 -04:00
tasks feat(offline-mode, undo-redo): Tasks handle network errors better and retry, undo/redo based on tasks 2015-07-07 13:38:53 -04:00
action-bridge-spec.coffee feat(logging): Developer bar, verbose logging to logstash, Electron 0.26.0 2015-05-19 17:02:46 -07:00
auto-update-manager-spec.coffee updater(*): Send current platform in update check, publish to S3 in /darwin/ folder 2015-06-30 11:03:24 -07:00
buffered-process-spec.coffee fix(tests): remove unnecessary failing test 2015-06-16 09:53:27 -07:00
clipboard-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
component-registry-spec.coffee feat(*): draft icon, misc fixes, and WorkspaceStore / custom toolbar in secondary windows 2015-06-03 16:02:19 -07:00
database-view-spec.coffee perf(thread-list): Tailored SQLite indexes, ListTabular / ScrollRegion optimizations galore 2015-06-17 20:12:48 -07:00
menu-manager-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
model-view-selection-spec.coffee fix(selection): Fix issue where selecting offscreen thread (null) could break selection 2015-06-01 18:29:39 -07:00
model-view-spec.coffee refactor(utils): switch to regular underscore 2015-05-19 16:06:59 -07:00
module-cache-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
nylas-protocol-handler-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
nylas-sync-worker-spec.coffee fix(specs): silence noisy specs and fix warnings 2015-06-15 18:29:59 -07:00
package-manager-spec.coffee fix(test): remove bad nondeterministic package spec 2015-06-17 20:49:06 -07:00
package-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
style-manager-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
styles-element-spec.coffee add(specs): +101 specs and 403 assertions from Atom 2015-06-02 19:51:00 -07:00
task-spec.coffee fix(build): Temporarily disable 'Task' tests Jenkins can't run, and avoid empty ui-variables files 2015-06-03 12:04:43 -07:00
test_utils.coffee fix(asar): Support ASAR, and running of specs in prod builds 2015-05-21 14:41:30 -07:00
theme-manager-spec.coffee fix(specs): silence noisy specs and fix warnings 2015-06-15 18:29:59 -07:00
undo-manager-spec.coffee fix(composer): polish composer edge cases 2015-05-19 16:12:39 -07:00
utils-spec.coffee refactor(utils): switch to regular underscore 2015-05-19 16:06:59 -07:00