Mailspring/spec-nylas/tasks/change-folder-task-spec.coffee
Ben Gotow 1e6e857f28 perf(*): Add indexes, optimize "shouldAcceptModel", optimize Tasks
Summary:
Consolidate the smarts from ChangeFolderTask into a generic ChangeMailTask

ChangeMailTask:
   - only makes requests for threads / messages that actually changed
   - handles incrementing / decrementing locks
   - writes changes to the database in a single pass, and only writes modified models
   - encapsulates the undo state that was built into ChangeFolderTask

This change means that ChangeLabelsTask enjoys the same "smarts" as ChangeFolderTask. Label changes resulting in no-ops do not create web requests, you can undo label changes and they go back to the correct previous state.

Replace "UpdateThreadsTask" and "UpdateNylasObjectsTask" with subclasses based on the same code used for folder/labels

This means that the naming and parameter sets are consistent for all thread/message changing tasks. It also means that starring/marking as use the same (tested) business logic and starring 999 already-starred threads doesn't create 999 requests.
Go away DraftCountStore - nobody wants you in secondary windows

Add "Debug query plans" option which prints out the steps the database is taking. Look for "SCAN" to now you're having a bad time.

Make "version" field queryable, when we receive deltas/API response, find all versions of existing models in a single query without loading or parsing the objects

Contact: Add index for lookup by email

Label: add index for lookup by name

Message: Add index for message body join table

Test Plan: Run tests

Reviewers: evan

Reviewed By: evan

Differential Revision: https://phab.nylas.com/D1840
2015-08-05 15:53:08 -07:00

158 lines
6.3 KiB
CoffeeScript

_ = require 'underscore'
Folder = require '../../src/flux/models/folder'
Thread = require '../../src/flux/models/thread'
Message = require '../../src/flux/models/message'
Actions = require '../../src/flux/actions'
NylasAPI = require '../../src/flux/nylas-api'
Query = require '../../src/flux/models/query'
DatabaseStore = require '../../src/flux/stores/database-store'
ChangeFolderTask = require '../../src/flux/tasks/change-folder-task'
{APIError} = require '../../src/flux/errors'
{Utils} = require '../../src/flux/models/utils'
testFolders = {}
testThreads = {}
testMessages = {}
describe "ChangeFolderTask", ->
beforeEach ->
# IMPORTANT: These specs do not run the performLocal logic of their superclass!
# Tests for that logic are in change-mail-task-spec.
spyOn(ChangeFolderTask.__super__, 'performLocal').andCallFake =>
Promise.resolve()
spyOn(DatabaseStore, 'modelify').andCallFake (klass, items) =>
Promise.resolve items.map (item) =>
return testFolders[item] if testFolders[item]
return testThreads[item] if testThreads[item]
return testMessages[item] if testMessages[item]
item
testFolders = @testFolders =
"f1": new Folder({name: 'inbox', id: 'f1', displayName: "INBOX"}),
"f2": new Folder({name: 'drafts', id: 'f2', displayName: "MyDrafts"})
"f3": new Folder({name: null, id: 'f3', displayName: "My Folder"})
testThreads = @testThreads =
't1': new Thread(id: 't1', folders: [@testFolders['f1']])
't2': new Thread(id: 't2', folders: _.values(@testFolders))
't3': new Thread(id: 't3', folders: [@testFolders['f2'], @testFolders['f3']])
testMessages = @testMessages =
'm1': new Message(id: 'm1', folder: @testFolders['f1'])
'm2': new Message(id: 'm2', folder: @testFolders['f2'])
'm3': new Message(id: 'm3', folder: @testFolders['f3'])
describe "description", ->
it "should include the folder name if folder is a folder", ->
taskWithFolderId = new ChangeFolderTask
folder: 'f2'
messages: ['m1']
expect(taskWithFolderId.description()).toEqual("Moved 1 message")
taskWithFolder = new ChangeFolderTask
folder: @testFolders['f2']
messages: ['m1']
expect(taskWithFolder.description()).toEqual("Moved 1 message to MyDrafts")
it "should correctly mention threads and messages", ->
taskWithFolderId = new ChangeFolderTask
folder: 'f2'
threads: ['t1']
expect(taskWithFolderId.description()).toEqual("Moved 1 thread")
taskWithFolder = new ChangeFolderTask
folder: @testFolders['f2']
messages: ['m1']
expect(taskWithFolder.description()).toEqual("Moved 1 message to MyDrafts")
describe "performLocal", ->
it "should check that a single folder is provided, and that we have threads or messages", ->
badTasks = [
new ChangeFolderTask(),
new ChangeFolderTask(threads: [123]),
new ChangeFolderTask(threads: [123], messages: ["foo"]),
new ChangeFolderTask(threads: "Thread"),
]
goodTasks = [
new ChangeFolderTask(
folder: 'f2'
threads: ['t1', 't2']
)
new ChangeFolderTask(
folder: @testFolders['f2']
messages: ['m1']
)
]
caught = []
succeeded = []
runs ->
[].concat(badTasks, goodTasks).forEach (task) ->
task.performLocal()
.then -> succeeded.push(task)
.catch (err) -> caught.push(task)
waitsFor ->
succeeded.length + caught.length == 6
runs ->
expect(caught.length).toEqual(badTasks.length)
expect(succeeded.length).toEqual(goodTasks.length)
it 'calls through to super performLocal', ->
task = new ChangeFolderTask
folder: "f1"
threads: ['t1']
waitsForPromise =>
task.performLocal().then =>
expect(task.constructor.__super__.performLocal).toHaveBeenCalled()
describe "when object IDs are provided", ->
beforeEach ->
@task = new ChangeFolderTask(folder: "f1", threads: ['t1'])
it 'resolves the objects before calling super', ->
waitsForPromise =>
@task.performLocal().then =>
expect(@task.folder).toEqual(testFolders['f1'])
expect(@task.threads).toEqual([testThreads['t1']])
describe "when objects are provided", ->
beforeEach ->
@task = new ChangeFolderTask(folder: testFolders['f1'], threads: [testThreads['t1'], testThreads['t2']])
it 'still has the objects when calling super', ->
waitsForPromise =>
@task.performLocal().then =>
expect(@task.folder).toEqual(testFolders['f1'])
expect(@task.threads).toEqual([testThreads['t1'],testThreads['t2']])
describe "change methods", ->
beforeEach ->
@message = testMessages['m1']
@thread = testThreads['t1']
@task = new ChangeFolderTask(folder: testFolders['f1'], threads: [testThreads['t1'], testThreads['t2']])
describe "_changesToModel", ->
describe "if the model is a Thread", ->
it "returns an object with a folders key, and an array with the folder", ->
expect(@task._changesToModel(@thread)).toEqual({folders: [testFolders['f1']]})
describe "if the model is a Message", ->
it "returns an object with a folder key, and the folder", ->
expect(@task._changesToModel(@message)).toEqual({folder: testFolders['f1']})
describe "_requestBodyForModel", ->
describe "if the model is a Thread", ->
it "returns folder: <id>, using the first available folder", ->
@thread.folders = []
expect(@task._requestBodyForModel(@thread)).toEqual(folder: null)
@thread.folders = [testFolders['f1']]
expect(@task._requestBodyForModel(@thread)).toEqual(folder: 'f1')
@thread.folders = [testFolders['f2'], testFolders['f1']]
expect(@task._requestBodyForModel(@thread)).toEqual(folder: 'f2')
describe "if the model is a Message", ->
it "returns folder: <id>, using the message folder", ->
@message.folder = null
expect(@task._requestBodyForModel(@message)).toEqual(folder: null)
@message.folder = testFolders['f1']
expect(@task._requestBodyForModel(@message)).toEqual(folder: 'f1')