Mailspring/internal_packages/thread-list/spec/thread-list-spec.cjsx
Ben Gotow 86f7d65034 feat(thread-list): Multiple selection, bulk actions, refactoring
Summary:
This diff provides multi-selection in the thread list powered by a new ModelList component that implements selection on top of ListTabular (or soon another List component). It includes business logic for single selection, shift selection, command-click selection, etc.

This diff also improves the performance of DatabaseView by assessing whether updates are required based on specific database changes and skipping queries in many scenarios.

WIP

WIP

Move selection into modelView instead of store

WIP

Preparing to convert to ModelList mixin

Make ThreadStore => ThreadListStore

Break the DraftStore in two (new DraftListStore) to avoid keeping all drafts in all windows

Get rid of unread instance variable in favor of getter that falls through to isUnread()

Much smarter logic in DatabaseView to prevent needless queries (especially counts and full invalidation of retained range)

Squashed commit of the following:

commit 486516b540e659735675765ca8b20d8a107ee2a9
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 17:30:23 2015 -0700

    Invalidate the retained range debounced

commit 7ac80403f52d108696c555f79c4c687d969f0228
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 17:30:16 2015 -0700

    Wait until after the view updates to move focus

commit 88d66eb19a9710847ff98bea22045bb686f30cc6
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 17:28:01 2015 -0700

    Bail out early when loading data if a reload has been requested

commit a49bedc44687040f7c675ff298376917a0b5fdcb
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 16:38:58 2015 -0700

    Log query data when in a query is being logged

commit c64a9e02f9072fd30edb98c45be581d6ac00c48a
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 16:38:45 2015 -0700

    Mark thread and messages as read in parallel instead of in sequence

commit 4b227100a795e20257cda0d60b00cc75b0000b0f
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 16:38:32 2015 -0700

    Don't load tags with hardcoded IDs from the database, and load them in parallel instead of in sequence

commit aeb7f1d646786cfa1c247fe78ce5467da07c4446
Author: Ben Gotow <bengotow@gmail.com>
Date:   Tue Apr 7 16:37:54 2015 -0700

    Pass objects instead of ids to thread methods—since we always have the most current thread anyway, this makes things a bit faster

commit e70889d1d05ece81a081b8b3f27b62491429b6f9
Author: Ben Gotow <bengotow@gmail.com>
Date:   Mon Apr 6 16:41:49 2015 -0700

    [icon] Paper airplanes

Restyle account sidebar, optimize tag count queries a bit more

Fix initialization issue with webkit image mask

Can't compare dates with is/isnt

Assets for check boxes

Bug fixes

Wrap ModelList instead of providing props

Verbose mode for database view

Fix existing specs

Six new specs covering invalidateIfItemsInconsistent

Test Plan: Run 40+ new tests

Reviewers: evan

Reviewed By: evan

Differential Revision: https://review.inboxapp.com/D1410
2015-04-08 19:25:00 -07:00

439 lines
13 KiB
CoffeeScript

return
moment = require "moment"
_ = require 'underscore-plus'
CSON = require 'season'
React = require "react/addons"
ReactTestUtils = React.addons.TestUtils
ReactTestUtils = _.extend ReactTestUtils, require "jasmine-react-helpers"
{Thread,
Actions,
Namespace,
DatabaseStore,
WorkspaceStore,
InboxTestUtils,
NamespaceStore,
ComponentRegistry} = require "inbox-exports"
{ListTabular} = require 'ui-components'
ThreadStore = require "../lib/thread-store"
ThreadList = require "../lib/thread-list"
ParticipantsItem = React.createClass
render: -> <div></div>
me = new Namespace(
"name": "User One",
"email": "user1@inboxapp.com"
"provider": "inbox"
)
NamespaceStore._current = me
test_threads = -> [
(new Thread).fromJSON({
"id": "111",
"object": "thread",
"created_at": null,
"updated_at": null,
"namespace_id": "nsid",
"snippet": "snippet 111",
"subject": "Subject 111",
"tags": [
{
"id": "unseen",
"created_at": null,
"updated_at": null,
"name": "unseen"
},
{
"id": "all",
"created_at": null,
"updated_at": null,
"name": "all"
},
{
"id": "inbox",
"created_at": null,
"updated_at": null,
"name": "inbox"
},
{
"id": "unread",
"created_at": null,
"updated_at": null,
"name": "unread"
},
{
"id": "attachment",
"created_at": null,
"updated_at": null,
"name": "attachment"
}
],
"participants": [
{
"created_at": null,
"updated_at": null,
"name": "User One",
"email": "user1@inboxapp.com"
},
{
"created_at": null,
"updated_at": null,
"name": "User Two",
"email": "user2@inboxapp.com"
}
],
"last_message_timestamp": 1415742036
}),
(new Thread).fromJSON({
"id": "222",
"object": "thread",
"created_at": null,
"updated_at": null,
"namespace_id": "nsid",
"snippet": "snippet 222",
"subject": "Subject 222",
"tags": [
{
"id": "unread",
"created_at": null,
"updated_at": null,
"name": "unread"
},
{
"id": "all",
"created_at": null,
"updated_at": null,
"name": "all"
},
{
"id": "unseen",
"created_at": null,
"updated_at": null,
"name": "unseen"
},
{
"id": "inbox",
"created_at": null,
"updated_at": null,
"name": "inbox"
}
],
"participants": [
{
"created_at": null,
"updated_at": null,
"name": "User One",
"email": "user1@inboxapp.com"
},
{
"created_at": null,
"updated_at": null,
"name": "User Three",
"email": "user3@inboxapp.com"
}
],
"last_message_timestamp": 1415741913
}),
(new Thread).fromJSON({
"id": "333",
"object": "thread",
"created_at": null,
"updated_at": null,
"namespace_id": "nsid",
"snippet": "snippet 333",
"subject": "Subject 333",
"tags": [
{
"id": "inbox",
"created_at": null,
"updated_at": null,
"name": "inbox"
},
{
"id": "all",
"created_at": null,
"updated_at": null,
"name": "all"
},
{
"id": "unseen",
"created_at": null,
"updated_at": null,
"name": "unseen"
}
],
"participants": [
{
"created_at": null,
"updated_at": null,
"name": "User One",
"email": "user1@inboxapp.com"
},
{
"created_at": null,
"updated_at": null,
"name": "User Four",
"email": "user4@inboxapp.com"
}
],
"last_message_timestamp": 1415741837
})
]
cjsxSubjectResolver = (thread) ->
<div>
<span>Subject {thread.id}</span>
<span className="snippet">Snippet</span>
</div>
describe "ThreadList", ->
Foo = React.createClass({render: -> <div>{@props.children}</div>})
c1 = new ListTabular.Column
name: "Name"
flex: 1
resolver: (thread) -> "#{thread.id} Test Name"
c2 = new ListTabular.Column
name: "Subject"
flex: 3
resolver: cjsxSubjectResolver
c3 = new ListTabular.Column
name: "Date"
resolver: (thread) -> <Foo>{thread.id}</Foo>
columns = [c1,c2,c3]
beforeEach ->
InboxTestUtils.loadKeymap("internal_packages/thread-list/keymaps/thread-list.cson")
spyOn(ThreadStore, "_onNamespaceChanged")
spyOn(DatabaseStore, "findAll").andCallFake ->
new Promise (resolve, reject) -> resolve(test_threads())
spyOn(Actions, "archiveCurrentThread")
spyOn(Actions, "archiveAndNext")
spyOn(Actions, "archiveAndPrevious")
ReactTestUtils.spyOnClass(ThreadList, "_prepareColumns").andCallFake ->
@_columns = columns
ThreadStore._resetInstanceVars()
ComponentRegistry.register
name: 'Participants'
view: ParticipantsItem
@thread_list = ReactTestUtils.renderIntoDocument(
<ThreadList />
)
it "renders into the document", ->
expect(ReactTestUtils.isCompositeComponentWithType(@thread_list,
ThreadList)).toBe true
it "has the expected columns", ->
expect(@thread_list._columns).toEqual columns
it "by default has zero children", ->
items = ReactTestUtils.scryRenderedComponentsWithType(@thread_list, ListTabular.Item)
expect(items.length).toBe 0
describe "when the workspace is in list mode", ->
beforeEach ->
spyOn(WorkspaceStore, "selectedLayoutMode").andReturn "list"
@thread_list.setState focusedId: "t111"
it "allows reply only when the sheet type is 'Thread'", ->
spyOn(WorkspaceStore, "sheet").andCallFake -> {type: "Thread"}
spyOn(Actions, "composeReply")
@thread_list._onReply()
expect(Actions.composeReply).toHaveBeenCalled()
expect(@thread_list._actionInVisualScope()).toBe true
it "doesn't reply only when the sheet type isnt 'Thread'", ->
spyOn(WorkspaceStore, "sheet").andCallFake -> {type: "Root"}
spyOn(Actions, "composeReply")
@thread_list._onReply()
expect(Actions.composeReply).not.toHaveBeenCalled()
expect(@thread_list._actionInVisualScope()).toBe false
describe "when the workspace is in split mode", ->
beforeEach ->
spyOn(WorkspaceStore, "selectedLayoutMode").andReturn "split"
@thread_list.setState focusedId: "t111"
it "allows reply and reply-all regardless of sheet type", ->
spyOn(WorkspaceStore, "sheet").andCallFake -> {type: "anything"}
spyOn(Actions, "composeReply")
@thread_list._onReply()
expect(Actions.composeReply).toHaveBeenCalled()
expect(@thread_list._actionInVisualScope()).toBe true
describe "Populated thread list", ->
beforeEach ->
view =
loaded: -> true
get: (i) -> test_threads()[i]
count: -> test_threads().length
setRetainedRange: ->
ThreadStore._view = view
ThreadStore._focusedId = null
ThreadStore.trigger(ThreadStore)
@thread_list_node = @thread_list.getDOMNode()
spyOn(@thread_list, "setState").andCallThrough()
it "renders all of the thread list items", ->
advanceClock(100)
items = ReactTestUtils.scryRenderedComponentsWithType(@thread_list, ListTabular.Item)
expect(items.length).toBe(test_threads().length)
# describe "ThreadListNarrow", ->
# beforeEach ->
# InboxTestUtils.loadKeymap("internal_packages/thread-list/keymaps/thread-list.cson")
# spyOn(ThreadStore, "_onNamespaceChanged")
# spyOn(DatabaseStore, "findAll").andCallFake ->
# new Promise (resolve, reject) -> resolve(test_threads())
# ThreadStore._resetInstanceVars()
# ComponentRegistry.register
# name: 'Participants'
# view: ParticipantsItem
# @thread_list = ReactTestUtils.renderIntoDocument(
# <ThreadListNarrow />
# )
# it "renders into the document", ->
# expect(ReactTestUtils.isCompositeComponentWithType(@thread_list,
# ThreadListNarrow)).toBe true
# it "by default has zero children", ->
# items = ReactTestUtils.scryRenderedComponentsWithType(@thread_list,
# ThreadListNarrowItem)
# expect(items.length).toBe 0
# describe "Populated thread list", ->
# beforeEach ->
# ThreadStore._items = test_threads()
# ThreadStore._focusedId = null
# ThreadStore.trigger()
# @thread_list_node = @thread_list.getDOMNode()
# it "renders all of the thread list items", ->
# items = ReactTestUtils.scryRenderedComponentsWithType(@thread_list,
# ThreadListNarrowItem)
# expect(items.length).toBe 3
# describe "Shifting selected index", ->
# beforeEach ->
# spyOn(@thread_list, "_onShiftSelectedIndex")
# spyOn(Actions, "selectThreadId")
# it "can move selection up", ->
# atom.commands.dispatch(document.body, "core:previous-item")
# expect(@thread_list._onShiftSelectedIndex).toHaveBeenCalledWith(-1)
# it "can move selection down", ->
# atom.commands.dispatch(document.body, "core:next-item")
# expect(@thread_list._onShiftSelectedIndex).toHaveBeenCalledWith(1)
# describe "Triggering message list commands", ->
# beforeEach ->
# spyOn(Actions, "composeReply")
# spyOn(Actions, "composeReplyAll")
# spyOn(Actions, "composeForward")
# ThreadStore._onSelectThreadId("111")
# @thread = ThreadStore.selectedThread()
# spyOn(@thread, "archive")
# spyOn(@thread_list, "_onShiftSelectedIndex")
# spyOn(Actions, "selectThreadId")
# it "can reply to the currently selected thread", ->
# atom.commands.dispatch(document.body, "application:reply")
# expect(Actions.composeReply).toHaveBeenCalledWith(threadId: @thread.id)
# it "can reply all to the currently selected thread", ->
# atom.commands.dispatch(document.body, "application:reply-all")
# expect(Actions.composeReplyAll).toHaveBeenCalledWith(threadId: @thread.id)
# it "can forward the currently selected thread", ->
# atom.commands.dispatch(document.body, "application:forward")
# expect(Actions.composeForward).toHaveBeenCalledWith(threadId: @thread.id)
# it "can archive the currently selected thread", ->
# atom.commands.dispatch(document.body, "application:remove-item")
# expect(@thread.archive).toHaveBeenCalled()
# it "can archive the currently selected thread and navigate up", ->
# atom.commands.dispatch(document.body, "application:remove-and-previous")
# expect(@thread.archive).toHaveBeenCalled()
# expect(@thread_list._onShiftSelectedIndex).toHaveBeenCalledWith(-1)
# it "does nothing when no thread is selected", ->
# ThreadStore._focusedId = null
# atom.commands.dispatch(document.body, "application:reply")
# expect(Actions.composeReply.calls.length).toEqual(0)
# describe "ThreadListNarrowItem", ->
# beforeEach ->
# items = ReactTestUtils.scryRenderedComponentsWithType(@thread_list,
# ThreadListNarrowItem)
# item = items.filter (tli) -> tli.props.thread.id is "111"
# @thread_list_item = item[0]
# @thread_date = moment(@thread_list_item.props.thread.lastMessageTimestamp)
# it "finds the thread list item by id", ->
# expect(@thread_list_item.props.thread.id).toBe "111"
# it "fires the appropriate Action on click", ->
# spyOn(Actions, "selectThreadId")
# ReactTestUtils.Simulate.click @thread_list_item.getDOMNode()
# expect(Actions.focusThreadId).toHaveBeenCalledWith("111")
# it "sets the selected state on the thread item", ->
# ThreadStore._onSelectThreadId("111")
# items = ReactTestUtils.scryRenderedDOMComponentsWithClass(@thread_list, "selected")
# expect(items.length).toBe 1
# expect(items[0].props.id).toBe "111"
# it "renders de-selection when invalid id is emitted", ->
# ThreadStore._onSelectThreadId('abc')
# items = ReactTestUtils.scryRenderedDOMComponentsWithClass(@thread_list, "selected")
# expect(items.length).toBe 0
# # test "last_message_timestamp": 1415742036
# it "displays the time from threads LONG ago", ->
# spyOn(@thread_list_item, "_today").andCallFake =>
# @thread_date.add(2, 'years')
# expect(@thread_list_item._timeFormat()).toBe "MMM D YYYY"
# it "displays the time from threads a bit ago", ->
# spyOn(@thread_list_item, "_today").andCallFake =>
# @thread_date.add(2, 'days')
# expect(@thread_list_item._timeFormat()).toBe "MMM D"
# it "displays the time from threads exactly a day ago", ->
# spyOn(@thread_list_item, "_today").andCallFake =>
# @thread_date.add(1, 'day')
# expect(@thread_list_item._timeFormat()).toBe "h:mm a"
# it "displays the time from threads recently", ->
# spyOn(@thread_list_item, "_today").andCallFake =>
# @thread_date.add(2, 'hours')
# expect(@thread_list_item._timeFormat()).toBe "h:mm a"