Mailspring/internal_packages/message-list/spec/message-list-spec.cjsx
Ben Gotow 1e8fd46342 fix(drafts): Various improvements and fixes to drafts, draft state management
Summary:
This diff contains a few major changes:

1. Scribe is no longer used for the text editor. It's just a plain contenteditable region. The toolbar items (bold, italic, underline) still work. Scribe was causing React inconcistency issues in the following scenario:
   - View thread with draft, edit draft
   - Move to another thread
   - Move back to thread with draft
   - Move to another thread. Notice that one or more messages from thread with draft are still there.

There may be a way to fix this, but I tried for hours and there are Github Issues open on it's repository asking for React compatibility, so it may be fixed soon. For now contenteditable is working great.

2. Action.saveDraft() is no longer debounced in the DraftStore. Instead, firing that action causes the save to happen immediately, and the DraftStoreProxy has a new "DraftChangeSet" class which is responsbile for batching saves as the user interacts with the ComposerView. There are a couple big wins here:

   - In the future, we may want to be able to call Action.saveDraft() in other situations and it should behave like a normal action. We may also want to expose the DraftStoreProxy as an easy way of backing interactive draft UI.

   - Previously, when you added a contact to To/CC/BCC, this happened:

     <input> -> Action.saveDraft -> (delay!!) -> Database -> DraftStore -> DraftStoreProxy -> View Updates

Increasing the delay to something reasonable like 200msec meant there was 200msec of lag before you saw the new view state.

To fix this, I created a new class called DraftChangeSet which is responsible for accumulating changes as they're made and firing Action.saveDraft. "Adding" a change to the change set also causes the Draft provided by the DraftStoreProxy to change immediately (the changes are a temporary layer on top of the database object). This means no delay while changes are being applied. There's a better explanation in the source!

This diff includes a few minor fixes as well:

1. Draft.state is gone—use Message.object = draft instead
2. String model attributes should never be null
3. Pre-send checks that can cancel draft send
4. Put the entire curl history and task queue into feedback reports
5. Cache localIds for extra speed
6. Move us up to latest React

Test Plan: No new tests - once we lock down this new design I'll write tests for the DraftChangeSet

Reviewers: evan

Reviewed By: evan

Differential Revision: https://review.inboxapp.com/D1125
2015-02-03 16:24:31 -08:00

257 lines
7.8 KiB
CoffeeScript

_ = require "underscore-plus"
moment = require "moment"
proxyquire = require "proxyquire"
CSON = require "season"
React = require "react/addons"
TestUtils = React.addons.TestUtils
{Thread,
Contact,
Actions,
Message,
Namespace,
MessageStore,
NamespaceStore,
InboxTestUtils} = require "inbox-exports"
MessageItem = proxyquire("../lib/message-item.cjsx", {
"./email-frame": React.createClass({render: -> <div></div>})
})
MessageList = proxyquire("../lib/message-list.cjsx", {
"./message-item.cjsx": MessageItem
})
MessageParticipants = require "../lib/message-participants.cjsx"
ThreadParticipants = require "../lib/thread-participants.cjsx"
me = new Namespace(
"name": "User One",
"email": "user1@inboxapp.com"
"provider": "inbox"
)
NamespaceStore._current = me
user_headers =
id: null
object: null
namespace_id: null
user_1 = _.extend _.clone(user_headers),
name: "User One"
email: "user1@inboxapp.com"
user_2 = _.extend _.clone(user_headers),
name: "User Two"
email: "user2@inboxapp.com"
user_3 = _.extend _.clone(user_headers),
name: "User Three"
email: "user3@inboxapp.com"
user_4 = _.extend _.clone(user_headers),
name: "User Four"
email: "user4@inboxapp.com"
user_5 = _.extend _.clone(user_headers),
name: "User Five"
email: "user5@inboxapp.com"
test_messages = [
(new Message).fromJSON({
"id" : "111",
"from" : [ user_1 ],
"to" : [ user_2 ],
"cc" : [ user_3, user_4 ],
"bcc" : null,
"body" : "Body One",
"date" : 1415814587,
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet one...",
"subject" : "Subject One",
"thread_id" : "thread_12345",
"namespace_id" : "nsid"
}),
(new Message).fromJSON({
"id" : "222",
"from" : [ user_2 ],
"to" : [ user_1 ],
"cc" : [ user_3, user_4 ],
"bcc" : null,
"body" : "Body Two",
"date" : 1415814587,
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Two...",
"subject" : "Subject Two",
"thread_id" : "thread_12345",
"namespace_id" : "nsid"
}),
(new Message).fromJSON({
"id" : "333",
"from" : [ user_3 ],
"to" : [ user_1 ],
"cc" : [ user_2, user_4 ],
"bcc" : [],
"body" : "Body Three",
"date" : 1415814587,
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Three...",
"subject" : "Subject Three",
"thread_id" : "thread_12345",
"namespace_id" : "nsid"
}),
(new Message).fromJSON({
"id" : "444",
"from" : [ user_4 ],
"to" : [ user_1 ],
"cc" : [],
"bcc" : [ user_5 ],
"body" : "Body Four",
"date" : 1415814587,
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Four...",
"subject" : "Subject Four",
"thread_id" : "thread_12345",
"namespace_id" : "nsid"
}),
(new Message).fromJSON({
"id" : "555",
"from" : [ user_1 ],
"to" : [ user_4 ],
"cc" : [],
"bcc" : [],
"body" : "Body Five",
"date" : 1415814587,
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Five...",
"subject" : "Subject Five",
"thread_id" : "thread_12345",
"namespace_id" : "nsid"
}),
]
test_thread = (new Thread).fromJSON({
"id" : "thread_12345"
"subject" : "Subject 12345"
})
describe "MessageList", ->
keymap_path = "internal_packages/message-list/keymaps/message-list.cson"
keymap_mappings = CSON.readFileSync(keymap_path)
_resetMessageStore = ->
MessageStore._items = []
MessageStore._threadId = null
beforeEach ->
_resetMessageStore()
@message_list = TestUtils.renderIntoDocument(<MessageList />)
@message_list_node = @message_list.getDOMNode()
# IMPORTANT: You need to manually register the keymaps with the
# KeymapManager (aliased onto atom.keymaps).
atom.keymaps.add(keymap_path, keymap_mappings)
it "renders into the document", ->
expect(TestUtils.isCompositeComponentWithType(@message_list,
MessageList)).toBe true
it "by default has zero children", ->
items = TestUtils.scryRenderedComponentsWithType(@message_list,
MessageItem)
expect(items.length).toBe 0
describe "Populated Message list", ->
beforeEach ->
MessageStore._items = test_messages
MessageStore.trigger(MessageStore)
@message_list.setState current_thread: test_thread
it "renders all the correct number of messages", ->
items = TestUtils.scryRenderedComponentsWithType(@message_list,
MessageItem)
expect(items.length).toBe 5
it "aggregates participants across all messages", ->
expect(@message_list._threadParticipants().length).toBe 4
expect(@message_list._threadParticipants()[0] instanceof Contact).toBe true
it "displays lists of participants on the page", ->
items = TestUtils.scryRenderedComponentsWithType(@message_list,
MessageParticipants)
expect(items.length).toBe 5
it "displays the thread participants on the page", ->
items = TestUtils.scryRenderedComponentsWithType(@message_list,
ThreadParticipants)
expect(items.length).toBe 1
describe "Triggering message list actions", ->
beforeEach ->
spyOn(Actions, "composeReply")
spyOn(Actions, "composeReplyAll")
spyOn(Actions, "composeForward")
spyOn(test_thread, "archive")
it "can reply with a keyboard shortcut", ->
InboxTestUtils.keyPress("r", @message_list_node)
expect(Actions.composeReply).toHaveBeenCalledWith(test_thread.id)
it "can reply all with a keyboard shortcut", ->
InboxTestUtils.keyPress("a", @message_list_node)
expect(Actions.composeReplyAll).toHaveBeenCalledWith(test_thread.id)
it "can forward with a keyboard shortcut", ->
InboxTestUtils.keyPress("f", @message_list_node)
expect(Actions.composeForward).toHaveBeenCalledWith(test_thread.id)
it "can archive with a keyboard shortcut", ->
InboxTestUtils.keyPress("e", @message_list_node)
expect(test_thread.archive).toHaveBeenCalled()
describe "Message", ->
beforeEach ->
items = TestUtils.scryRenderedComponentsWithType(@message_list,
MessageItem)
item = items.filter (message) -> message.props.message.id is "111"
@message_item = item[0]
@message_date = moment([2010, 1, 14, 15, 25, 50, 125])
@message_item.props.message.date = moment(@message_date)
it "finds the message by id", ->
expect(@message_item.props.message.id).toBe "111"
# test messsage time is 1415814587
it "displays the time from messages LONG ago", ->
spyOn(@message_item, "_today").andCallFake =>
@message_date.add(2, 'years')
expect(@message_item._timeFormat()).toBe "MMM D YYYY"
it "displays the time and date from messages a bit ago", ->
spyOn(@message_item, "_today").andCallFake =>
@message_date.add(2, 'days')
expect(@message_item._timeFormat()).toBe "MMM D, h:mm a"
it "displays the time and date messages exactly a day ago", ->
spyOn(@message_item, "_today").andCallFake =>
@message_date.add(1, 'day')
expect(@message_item._timeFormat()).toBe "MMM D, h:mm a"
it "displays the time from messages yesterday with the day, even though it's less than 24 hours ago", ->
spyOn(@message_item, "_today").andCallFake ->
moment([2010, 1, 15, 2, 25, 50, 125])
expect(@message_item._timeFormat()).toBe "MMM D, h:mm a"
it "displays the time from messages recently", ->
spyOn(@message_item, "_today").andCallFake =>
@message_date.add(2, 'hours')
expect(@message_item._timeFormat()).toBe "h:mm a"