mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-09 09:38:07 +08:00
45bb16561f
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
70 lines
2.5 KiB
CoffeeScript
70 lines
2.5 KiB
CoffeeScript
NylasAPI = require '../../src/flux/nylas-api'
|
|
Actions = require '../../src/flux/actions'
|
|
{APIError} = require '../../src/flux/errors'
|
|
MarkMessageReadTask = require '../../src/flux/tasks/mark-message-read'
|
|
DatabaseStore = require '../../src/flux/stores/database-store'
|
|
Message = require '../../src/flux/models/message'
|
|
_ = require 'underscore'
|
|
|
|
describe "MarkMessageReadTask", ->
|
|
beforeEach ->
|
|
@message = new Message
|
|
id: '1233123AEDF1'
|
|
namespaceId: 'A12ADE'
|
|
subject: 'New Message'
|
|
unread: true
|
|
to:
|
|
name: 'Dummy'
|
|
email: 'dummy@nylas.com'
|
|
@task = new MarkMessageReadTask(@message)
|
|
|
|
describe "performLocal", ->
|
|
it "should mark the message as read", ->
|
|
@task.performLocal()
|
|
expect(@message.unread).toBe(false)
|
|
|
|
it "should trigger an action to persist the change", ->
|
|
spyOn(DatabaseStore, 'persistModel').andCallFake -> Promise.resolve()
|
|
@task.performLocal()
|
|
expect(DatabaseStore.persistModel).toHaveBeenCalled()
|
|
|
|
describe "performRemote", ->
|
|
it "should make the PUT request to the message endpoint", ->
|
|
spyOn(NylasAPI, 'makeRequest').andCallFake => new Promise (resolve,reject) ->
|
|
@task.performRemote()
|
|
options = NylasAPI.makeRequest.mostRecentCall.args[0]
|
|
expect(options.path).toBe("/n/#{@message.namespaceId}/messages/#{@message.id}")
|
|
expect(options.method).toBe('PUT')
|
|
expect(options.body.unread).toBe(false)
|
|
|
|
describe "when the remote API request fails", ->
|
|
beforeEach ->
|
|
spyOn(DatabaseStore, 'persistModel').andCallFake -> Promise.resolve()
|
|
spyOn(NylasAPI, 'makeRequest').andCallFake -> Promise.reject(new APIError(body: '', statusCode: 400))
|
|
|
|
it "should not mark the message as unread if it was not unread initially", ->
|
|
message = new Message
|
|
id: '1233123AEDF1'
|
|
namespaceId: 'A12ADE'
|
|
subject: 'New Message'
|
|
unread: false
|
|
to:
|
|
name: 'Dummy'
|
|
email: 'dummy@nylas.com'
|
|
@task = new MarkMessageReadTask(message)
|
|
@task.performLocal()
|
|
@task.performRemote()
|
|
advanceClock()
|
|
expect(message.unread).toBe(false)
|
|
|
|
it "should mark the message as unread", ->
|
|
@task.performLocal()
|
|
@task.performRemote()
|
|
advanceClock()
|
|
expect(@message.unread).toBe(true)
|
|
|
|
it "should trigger an action to persist the change", ->
|
|
@task.performLocal()
|
|
@task.performRemote()
|
|
advanceClock()
|
|
expect(DatabaseStore.persistModel).toHaveBeenCalled()
|