mirror of
https://github.com/Foundry376/Mailspring.git
synced 2024-11-14 21:57:55 +08:00
1e8fd46342
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
105 lines
4 KiB
CoffeeScript
105 lines
4 KiB
CoffeeScript
{Message, Actions, DatabaseStore} = require 'inbox-exports'
|
|
TemplateStore = require '../lib/template-store'
|
|
fs = require 'fs-plus'
|
|
shell = require 'shell'
|
|
|
|
stubTemplatesDir = TemplateStore.templatesDirectory()
|
|
|
|
stubTemplateFiles = {
|
|
'template1.html': '<p>bla1</p>',
|
|
'template2.html': '<p>bla2</p>'
|
|
}
|
|
|
|
stubTemplates = [
|
|
{id: 'template1.html', name: 'template1', path: "#{stubTemplatesDir}/template1.html"},
|
|
{id: 'template2.html', name: 'template2', path: "#{stubTemplatesDir}/template2.html"},
|
|
]
|
|
|
|
describe "TemplateStore", ->
|
|
beforeEach ->
|
|
spyOn(fs, 'mkdir')
|
|
spyOn(fs, 'readFile').andCallFake (path, callback) ->
|
|
filename = path.split('/').pop()
|
|
callback(null, stubTemplateFiles[filename])
|
|
|
|
it "should create the templates folder if it does not exist", ->
|
|
spyOn(fs, 'exists').andCallFake (path, callback) -> callback(false)
|
|
TemplateStore.init()
|
|
expect(fs.mkdir).toHaveBeenCalled()
|
|
|
|
it "should expose templates in the templates directory", ->
|
|
spyOn(fs, 'exists').andCallFake (path, callback) -> callback(true)
|
|
spyOn(fs, 'readdir').andCallFake (path, callback) -> callback(null, Object.keys(stubTemplateFiles))
|
|
TemplateStore.init()
|
|
expect(TemplateStore.items()).toEqual(stubTemplates)
|
|
|
|
it "should watch the templates directory and reflect changes", ->
|
|
watchCallback = null
|
|
watchFired = false
|
|
|
|
spyOn(fs, 'exists').andCallFake (path, callback) -> callback(true)
|
|
spyOn(fs, 'watch').andCallFake (path, callback) -> watchCallback = callback
|
|
spyOn(fs, 'readdir').andCallFake (path, callback) ->
|
|
if watchFired
|
|
callback(null, Object.keys(stubTemplateFiles))
|
|
else
|
|
callback(null, [])
|
|
|
|
TemplateStore.init()
|
|
expect(TemplateStore.items()).toEqual([])
|
|
|
|
watchFired = true
|
|
watchCallback()
|
|
expect(TemplateStore.items()).toEqual(stubTemplates)
|
|
|
|
describe "insertTemplateId", ->
|
|
it "should insert the template with the given id into the draft with the given id", ->
|
|
spyOn(Actions, 'saveDraft')
|
|
TemplateStore._onInsertTemplateId
|
|
templateId: 'template1.html',
|
|
draftLocalId: 'localid-draft'
|
|
|
|
expect(Actions.saveDraft).toHaveBeenCalledWith
|
|
body: stubTemplateFiles['template1.html'],
|
|
localId: 'localid-draft'
|
|
|
|
describe "onCreateTemplate", ->
|
|
beforeEach ->
|
|
spyOn(fs, 'readdir').andCallFake (path, callback) -> callback(null, [])
|
|
spyOn(fs, 'writeFile').andCallFake (path, contents, callback) -> callback(null)
|
|
TemplateStore.init()
|
|
|
|
it "should create a template with the given name and contents", ->
|
|
TemplateStore._onCreateTemplate({name: '123', contents: 'bla'})
|
|
item = TemplateStore.items()?[0]
|
|
expect(item.id).toBe "123.html"
|
|
expect(item.name).toBe "123"
|
|
expect(item.path.split("/").pop()).toBe "123.html"
|
|
|
|
it "should throw an exception if no name is provided", ->
|
|
expect( -> TemplateStore._onCreateTemplate({contents: 'bla'})).toThrow()
|
|
|
|
it "should throw an exception if no content is provided", ->
|
|
expect( -> TemplateStore._onCreateTemplate({name: 'bla'})).toThrow()
|
|
|
|
it "should save the template file to the templates folder", ->
|
|
TemplateStore._onCreateTemplate({name: '123', contents: 'bla'})
|
|
path = "#{stubTemplatesDir}/123.html"
|
|
expect(fs.writeFile).toHaveBeenCalled()
|
|
expect(fs.writeFile.mostRecentCall.args[0]).toEqual(path)
|
|
expect(fs.writeFile.mostRecentCall.args[1]).toEqual('bla')
|
|
|
|
describe "when given a draft id", ->
|
|
it "should create a template from the name and contents of the given draft", ->
|
|
draft = new Message
|
|
subject: 'Subject'
|
|
body: '<p>Body</p>'
|
|
spyOn(DatabaseStore, 'findByLocalId').andReturn(Promise.resolve(draft))
|
|
TemplateStore._onCreateTemplate({draftLocalId: 'localid-b'})
|
|
expect(TemplateStore.items()).toEqual([])
|
|
|
|
describe "onShowTemplates", ->
|
|
it "should open the templates folder in the Finder", ->
|
|
spyOn(shell, 'showItemInFolder')
|
|
TemplateStore._onShowTemplates()
|
|
expect(shell.showItemInFolder).toHaveBeenCalled()
|