Mailspring/internal_packages/message-list/spec/message-list-spec.cjsx
Ben Gotow b4434f6617 fix(focus): Remove focusedField in favor of imperative focus, break apart ComposerView
Summary:
- Removes controlled focus in the composer!
  - No React components ever perfom focus in lifecycle methods. Never again.
  - A new `Utils.schedule({action, after, timeout})` helper makes it easy to say "setState or load draft, etc. and then focus"
  - The DraftStore issues a focusDraft action after creating a draft, which causes the MessageList to focus and scroll to the desired composer, which itself decides which field to focus.
  - The MessageList never focuses anything automatically.
- Refactors ComposerView apart — ComposerHeader handles all top fields, DraftSessionContainer handles draft session initialization and exposes props to ComposerView
  - ComposerHeader now uses a KeyCommandRegion (with focusIn and focusOut) to do the expanding and collapsing of the participants fields. May rename that container very soon.
- Removes all CommandRegistry handling of tab and shift-tab. Unless you preventDefault, the browser does it's thing.
- Removes all tabIndexes greater than 1. This is an anti-pattern—assigning everything a tabIndex of 0 tells the browser to move between them based on their order in the DOM, and is almost always what you want.
- Adds "TabGroupRegion" which allows you to create a tab/shift-tabbing group, (so tabbing does not leave the active composer). Can't believe this isn't a browser feature.

Todos:
- Occasionally, clicking out of the composer contenteditable requires two clicks. This is because atomicEdit is restoring selection within the contenteditable and breaking blur.
- Because the ComposerView does not render until it has a draft, we're back to it being white in popout composers for a brief moment. We will fix this another way - all the "return unless draft" statements were untenable.
- Clicking a row in the thread list no longer shifts focus to the message list and focuses the last draft. This will be restored soon.

Test Plan: Broken

Reviewers: juan, evan

Reviewed By: juan, evan

Differential Revision: https://phab.nylas.com/D2814
2016-04-04 15:22:01 -07:00

408 lines
12 KiB
CoffeeScript

_ = require "underscore"
moment = require "moment"
proxyquire = require("proxyquire").noPreserveCache()
CSON = require "season"
React = require "react"
ReactDOM = require "react-dom"
ReactTestUtils = require 'react-addons-test-utils'
{Thread,
Contact,
Actions,
Message,
Account,
DraftStore,
MessageStore,
AccountStore,
NylasTestUtils,
ComponentRegistry} = require "nylas-exports"
MessageParticipants = require "../lib/message-participants"
MessageItemContainer = require "../lib/message-item-container"
MessageList = require '../lib/message-list'
# User_1 needs to be "me" so that when we calculate who we should reply
# to, it properly matches the AccountStore
user_1 = new Contact
name: TEST_ACCOUNT_NAME
email: TEST_ACCOUNT_EMAIL
user_2 = new Contact
name: "User Two"
email: "user2@nylas.com"
user_3 = new Contact
name: "User Three"
email: "user3@nylas.com"
user_4 = new Contact
name: "User Four"
email: "user4@nylas.com"
user_5 = new Contact
name: "User Five"
email: "user5@nylas.com"
m1 = (new Message).fromJSON({
"id" : "111",
"from" : [ user_1 ],
"to" : [ user_2 ],
"cc" : [ user_3, user_4 ],
"bcc" : null,
"body" : "Body One",
"date" : 1415814587,
"draft" : false
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet one...",
"subject" : "Subject One",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
})
m2 = (new Message).fromJSON({
"id" : "222",
"from" : [ user_2 ],
"to" : [ user_1 ],
"cc" : [ user_3, user_4 ],
"bcc" : null,
"body" : "Body Two",
"date" : 1415814587,
"draft" : false
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Two...",
"subject" : "Subject Two",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
})
m3 = (new Message).fromJSON({
"id" : "333",
"from" : [ user_3 ],
"to" : [ user_1 ],
"cc" : [ user_2, user_4 ],
"bcc" : [],
"body" : "Body Three",
"date" : 1415814587,
"draft" : false
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Three...",
"subject" : "Subject Three",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
})
m4 = (new Message).fromJSON({
"id" : "444",
"from" : [ user_4 ],
"to" : [ user_1 ],
"cc" : [],
"bcc" : [ user_5 ],
"body" : "Body Four",
"date" : 1415814587,
"draft" : false
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Four...",
"subject" : "Subject Four",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
})
m5 = (new Message).fromJSON({
"id" : "555",
"from" : [ user_1 ],
"to" : [ user_4 ],
"cc" : [],
"bcc" : [],
"body" : "Body Five",
"date" : 1415814587,
"draft" : false
"files" : [],
"unread" : false,
"object" : "message",
"snippet" : "snippet Five...",
"subject" : "Subject Five",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
})
testMessages = [m1, m2, m3, m4, m5]
draftMessages = [
(new Message).fromJSON({
"id" : "666",
"from" : [ user_1 ],
"to" : [ ],
"cc" : [ ],
"bcc" : null,
"body" : "Body One",
"date" : 1415814587,
"draft" : true
"files" : [],
"unread" : false,
"object" : "draft",
"snippet" : "draft snippet one...",
"subject" : "Draft One",
"thread_id" : "thread_12345",
"account_id" : TEST_ACCOUNT_ID
}),
]
test_thread = (new Thread).fromJSON({
"id": "12345"
"id" : "thread_12345"
"subject" : "Subject 12345",
"account_id" : TEST_ACCOUNT_ID
})
describe "MessageList", ->
beforeEach ->
MessageStore._items = []
MessageStore._threadId = null
spyOn(MessageStore, "itemsLoading").andCallFake ->
false
@messageList = ReactTestUtils.renderIntoDocument(<MessageList />)
@messageList_node = ReactDOM.findDOMNode(@messageList)
it "renders into the document", ->
expect(ReactTestUtils.isCompositeComponentWithType(@messageList,
MessageList)).toBe true
it "by default has zero children", ->
items = ReactTestUtils.scryRenderedComponentsWithType(@messageList,
MessageItemContainer)
expect(items.length).toBe 0
describe "Populated Message list", ->
beforeEach ->
MessageStore._items = testMessages
MessageStore._expandItemsToDefault()
MessageStore.trigger(MessageStore)
@messageList.setState(currentThread: test_thread)
NylasTestUtils.loadKeymap("keymaps/base")
it "renders all the correct number of messages", ->
items = ReactTestUtils.scryRenderedComponentsWithType(@messageList,
MessageItemContainer)
expect(items.length).toBe 5
it "renders the correct number of expanded messages", ->
msgs = ReactTestUtils.scryRenderedDOMComponentsWithClass(@messageList, "collapsed message-item-wrap")
expect(msgs.length).toBe 4
it "displays lists of participants on the page", ->
items = ReactTestUtils.scryRenderedComponentsWithType(@messageList,
MessageParticipants)
expect(items.length).toBe 2
it "includes drafts as message item containers", ->
msgs = @messageList.state.messages
@messageList.setState
messages: msgs.concat(draftMessages)
items = ReactTestUtils.scryRenderedComponentsWithType(@messageList,
MessageItemContainer)
expect(items.length).toBe 6
describe "reply type", ->
it "prompts for a reply when there's only one participant", ->
MessageStore._items = [m3, m5]
MessageStore._thread = test_thread
MessageStore.trigger()
expect(@messageList._replyType()).toBe "reply"
cs = ReactTestUtils.scryRenderedDOMComponentsWithClass(@messageList, "footer-reply-area")
expect(cs.length).toBe 1
it "prompts for a reply-all when there's more than one participant and the default is reply-all", ->
spyOn(NylasEnv.config, "get").andReturn "reply-all"
MessageStore._items = [m5, m3]
MessageStore._thread = test_thread
MessageStore.trigger()
expect(@messageList._replyType()).toBe "reply-all"
cs = ReactTestUtils.scryRenderedDOMComponentsWithClass(@messageList, "footer-reply-area")
expect(cs.length).toBe 1
it "prompts for a reply-all when there's more than one participant and the default is reply", ->
spyOn(NylasEnv.config, "get").andReturn "reply"
MessageStore._items = [m5, m3]
MessageStore._thread = test_thread
MessageStore.trigger()
expect(@messageList._replyType()).toBe "reply"
cs = ReactTestUtils.scryRenderedDOMComponentsWithClass(@messageList, "footer-reply-area")
expect(cs.length).toBe 1
it "hides the reply type if the last message is a draft", ->
MessageStore._items = [m5, m3, draftMessages[0]]
MessageStore._thread = test_thread
MessageStore.trigger()
cs = ReactTestUtils.scryRenderedDOMComponentsWithClass(@messageList, "footer-reply-area")
expect(cs.length).toBe 0
describe "Message minification", ->
beforeEach ->
@messageList.MINIFY_THRESHOLD = 3
@messageList.setState minified: true
@messages = [
{id: 'a'}, {id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}, {id: 'f'}, {id: 'g'}
]
it "ignores the first message if it's collapsed", ->
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: false, f: false, g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}]
},
{id: 'f'},
{id: 'g'}
]
it "ignores the first message if it's expanded", ->
@messageList.setState messagesExpandedState:
a: "default", b: false, c: false, d: false, e: false, f: false, g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}]
},
{id: 'f'},
{id: 'g'}
]
it "doesn't minify the last collapsed message", ->
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: false, f: "default", g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}]
},
{id: 'e'},
{id: 'f'},
{id: 'g'}
]
it "allows explicitly expanded messages", ->
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: false, f: "explicit", g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}]
},
{id: 'f'},
{id: 'g'}
]
it "doesn't minify if the threshold isn't reached", ->
@messageList.setState messagesExpandedState:
a: false, b: "default", c: false, d: "default", e: false, f: "default", g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{id: 'b'},
{id: 'c'},
{id: 'd'},
{id: 'e'},
{id: 'f'},
{id: 'g'}
]
it "doesn't minify if the threshold isn't reached due to the rule about not minifying the last collapsed messages", ->
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: "default", f: "default", g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{id: 'b'},
{id: 'c'},
{id: 'd'},
{id: 'e'},
{id: 'f'},
{id: 'g'}
]
it "minifies at the threshold if the message is explicitly expanded", ->
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: "explicit", f: "default", g: "default"
out = @messageList._messagesWithMinification(@messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}]
},
{id: 'e'},
{id: 'f'},
{id: 'g'}
]
it "can have multiple minification blocks", ->
messages = [
{id: 'a'}, {id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}, {id: 'f'},
{id: 'g'}, {id: 'h'}, {id: 'i'}, {id: 'j'}, {id: 'k'}, {id: 'l'}
]
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: false, f: "default",
g: false, h: false, i: false, j: false, k: false, l: "default"
out = @messageList._messagesWithMinification(messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}]
},
{id: 'e'},
{id: 'f'},
{
type: "minifiedBundle"
messages: [{id: 'g'}, {id: 'h'}, {id: 'i'}, {id: 'j'}]
},
{id: 'k'},
{id: 'l'}
]
it "can have multiple minification blocks next to explicitly expanded messages", ->
messages = [
{id: 'a'}, {id: 'b'}, {id: 'c'}, {id: 'd'}, {id: 'e'}, {id: 'f'},
{id: 'g'}, {id: 'h'}, {id: 'i'}, {id: 'j'}, {id: 'k'}, {id: 'l'}
]
@messageList.setState messagesExpandedState:
a: false, b: false, c: false, d: false, e: "explicit", f: "default",
g: false, h: false, i: false, j: false, k: "explicit", l: "default"
out = @messageList._messagesWithMinification(messages)
expect(out).toEqual [
{id: 'a'},
{
type: "minifiedBundle"
messages: [{id: 'b'}, {id: 'c'}, {id: 'd'}]
},
{id: 'e'},
{id: 'f'},
{
type: "minifiedBundle"
messages: [{id: 'g'}, {id: 'h'}, {id: 'i'}, {id: 'j'}]
},
{id: 'k'},
{id: 'l'}
]