mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-30 20:07:48 +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
252 lines
9 KiB
CoffeeScript
252 lines
9 KiB
CoffeeScript
temp = require 'temp'
|
|
fstream = require 'fstream'
|
|
Project = require '../src/project'
|
|
_ = require 'underscore-plus'
|
|
fs = require 'fs-plus'
|
|
path = require 'path'
|
|
BufferedProcess = require '../src/buffered-process'
|
|
|
|
describe "Project", ->
|
|
beforeEach ->
|
|
atom.project.setPaths([atom.project.getDirectories()[0]?.resolve('dir')])
|
|
|
|
describe "serialization", ->
|
|
deserializedProject = null
|
|
|
|
afterEach ->
|
|
deserializedProject?.destroy()
|
|
|
|
it "does not include unretained buffers in the serialized state", ->
|
|
waitsForPromise ->
|
|
atom.project.bufferForPath('a')
|
|
|
|
runs ->
|
|
expect(atom.project.getBuffers().length).toBe 1
|
|
deserializedProject = atom.project.testSerialization()
|
|
expect(deserializedProject.getBuffers().length).toBe 0
|
|
|
|
it "listens for destroyed events on deserialized buffers and removes them when they are destroyed", ->
|
|
waitsForPromise ->
|
|
atom.project.open('a')
|
|
|
|
runs ->
|
|
expect(atom.project.getBuffers().length).toBe 1
|
|
deserializedProject = atom.project.testSerialization()
|
|
|
|
expect(deserializedProject.getBuffers().length).toBe 1
|
|
deserializedProject.getBuffers()[0].destroy()
|
|
expect(deserializedProject.getBuffers().length).toBe 0
|
|
|
|
|
|
it "does not deserialize buffers when their path is a directory that exists", ->
|
|
pathToOpen = path.join(temp.mkdirSync(), 'file.txt')
|
|
|
|
waitsForPromise ->
|
|
atom.project.open(pathToOpen)
|
|
|
|
runs ->
|
|
expect(atom.project.getBuffers().length).toBe 1
|
|
fs.mkdirSync(pathToOpen)
|
|
deserializedProject = atom.project.testSerialization()
|
|
expect(deserializedProject.getBuffers().length).toBe 0
|
|
|
|
it "does not deserialize buffers when their path is inaccessible", ->
|
|
pathToOpen = path.join(temp.mkdirSync(), 'file.txt')
|
|
fs.writeFileSync(pathToOpen, '')
|
|
|
|
waitsForPromise ->
|
|
atom.project.open(pathToOpen)
|
|
|
|
runs ->
|
|
expect(atom.project.getBuffers().length).toBe 1
|
|
fs.chmodSync(pathToOpen, '000')
|
|
deserializedProject = atom.project.testSerialization()
|
|
expect(deserializedProject.getBuffers().length).toBe 0
|
|
|
|
describe "when an editor is saved and the project has no path", ->
|
|
it "sets the project's path to the saved file's parent directory", ->
|
|
tempFile = temp.openSync().path
|
|
atom.project.setPaths([])
|
|
expect(atom.project.getPaths()[0]).toBeUndefined()
|
|
editor = null
|
|
|
|
waitsForPromise ->
|
|
atom.project.open().then (o) -> editor = o
|
|
|
|
runs ->
|
|
editor.saveAs(tempFile)
|
|
expect(atom.project.getPaths()[0]).toBe path.dirname(tempFile)
|
|
|
|
describe "when a watch error is thrown from the TextBuffer", ->
|
|
editor = null
|
|
beforeEach ->
|
|
waitsForPromise ->
|
|
atom.project.open(require.resolve('./fixtures/dir/a')).then (o) -> editor = o
|
|
|
|
it "creates a warning notification", ->
|
|
atom.notifications.onDidAddNotification noteSpy = jasmine.createSpy()
|
|
|
|
error = new Error('SomeError')
|
|
error.eventType = 'resurrect'
|
|
editor.buffer.emitter.emit 'will-throw-watch-error',
|
|
handle: jasmine.createSpy()
|
|
error: error
|
|
|
|
expect(noteSpy).toHaveBeenCalled()
|
|
|
|
notification = noteSpy.mostRecentCall.args[0]
|
|
expect(notification.getType()).toBe 'warning'
|
|
expect(notification.getDetail()).toBe 'SomeError'
|
|
expect(notification.getMessage()).toContain '`resurrect`'
|
|
expect(notification.getMessage()).toContain 'fixtures/dir/a'
|
|
|
|
describe ".open(path)", ->
|
|
[absolutePath, newBufferHandler] = []
|
|
|
|
beforeEach ->
|
|
absolutePath = require.resolve('./fixtures/dir/a')
|
|
newBufferHandler = jasmine.createSpy('newBufferHandler')
|
|
atom.project.on 'buffer-created', newBufferHandler
|
|
|
|
describe "when given an absolute path that isn't currently open", ->
|
|
it "returns a new edit session for the given path and emits 'buffer-created'", ->
|
|
editor = null
|
|
waitsForPromise ->
|
|
atom.project.open(absolutePath).then (o) -> editor = o
|
|
|
|
runs ->
|
|
expect(editor.buffer.getPath()).toBe absolutePath
|
|
expect(newBufferHandler).toHaveBeenCalledWith editor.buffer
|
|
|
|
describe "when given a relative path that isn't currently opened", ->
|
|
it "returns a new edit session for the given path (relative to the project root) and emits 'buffer-created'", ->
|
|
editor = null
|
|
waitsForPromise ->
|
|
atom.project.open(absolutePath).then (o) -> editor = o
|
|
|
|
runs ->
|
|
expect(editor.buffer.getPath()).toBe absolutePath
|
|
expect(newBufferHandler).toHaveBeenCalledWith editor.buffer
|
|
|
|
describe "when passed the path to a buffer that is currently opened", ->
|
|
it "returns a new edit session containing currently opened buffer", ->
|
|
editor = null
|
|
|
|
waitsForPromise ->
|
|
atom.project.open(absolutePath).then (o) -> editor = o
|
|
|
|
runs ->
|
|
newBufferHandler.reset()
|
|
|
|
waitsForPromise ->
|
|
atom.project.open(absolutePath).then ({buffer}) ->
|
|
expect(buffer).toBe editor.buffer
|
|
|
|
waitsForPromise ->
|
|
atom.project.open('a').then ({buffer}) ->
|
|
expect(buffer).toBe editor.buffer
|
|
expect(newBufferHandler).not.toHaveBeenCalled()
|
|
|
|
describe "when not passed a path", ->
|
|
it "returns a new edit session and emits 'buffer-created'", ->
|
|
editor = null
|
|
waitsForPromise ->
|
|
atom.project.open().then (o) -> editor = o
|
|
|
|
runs ->
|
|
expect(editor.buffer.getPath()).toBeUndefined()
|
|
expect(newBufferHandler).toHaveBeenCalledWith(editor.buffer)
|
|
|
|
it "returns number of read bytes as progress indicator", ->
|
|
filePath = atom.project.getDirectories()[0]?.resolve 'a'
|
|
totalBytes = 0
|
|
promise = atom.project.open(filePath)
|
|
promise.progress (bytesRead) -> totalBytes = bytesRead
|
|
|
|
waitsForPromise ->
|
|
promise
|
|
|
|
runs ->
|
|
expect(totalBytes).toBe fs.statSync(filePath).size
|
|
|
|
describe ".bufferForPath(path)", ->
|
|
[buffer] = []
|
|
beforeEach ->
|
|
waitsForPromise ->
|
|
atom.project.bufferForPath("a").then (o) ->
|
|
buffer = o
|
|
buffer.retain()
|
|
|
|
afterEach ->
|
|
buffer.release()
|
|
|
|
describe "when opening a previously opened path", ->
|
|
it "does not create a new buffer", ->
|
|
waitsForPromise ->
|
|
atom.project.bufferForPath("a").then (anotherBuffer) ->
|
|
expect(anotherBuffer).toBe buffer
|
|
|
|
waitsForPromise ->
|
|
atom.project.bufferForPath("b").then (anotherBuffer) ->
|
|
expect(anotherBuffer).not.toBe buffer
|
|
|
|
it "creates a new buffer if the previous buffer was destroyed", ->
|
|
buffer.release()
|
|
|
|
waitsForPromise ->
|
|
atom.project.bufferForPath("b").then (anotherBuffer) ->
|
|
expect(anotherBuffer).not.toBe buffer
|
|
|
|
describe ".setPaths(path)", ->
|
|
describe "when path is a file", ->
|
|
it "sets its path to the files parent directory and updates the root directory", ->
|
|
atom.project.setPaths([require.resolve('./fixtures/dir/a')])
|
|
expect(atom.project.getPaths()[0]).toEqual path.dirname(require.resolve('./fixtures/dir/a'))
|
|
expect(atom.project.getDirectories()[0].path).toEqual path.dirname(require.resolve('./fixtures/dir/a'))
|
|
|
|
describe "when path is a directory", ->
|
|
it "sets its path to the directory and updates the root directory", ->
|
|
directory = fs.absolute(path.join(__dirname, 'fixtures', 'dir', 'a-dir'))
|
|
atom.project.setPaths([directory])
|
|
expect(atom.project.getPaths()[0]).toEqual directory
|
|
expect(atom.project.getDirectories()[0].path).toEqual directory
|
|
|
|
describe "when path is null", ->
|
|
it "sets its path and root directory to null", ->
|
|
atom.project.setPaths([])
|
|
expect(atom.project.getPaths()[0]?).toBeFalsy()
|
|
expect(atom.project.getDirectories()[0]?).toBeFalsy()
|
|
|
|
it "normalizes the path to remove consecutive slashes, ., and .. segments", ->
|
|
atom.project.setPaths(["#{require.resolve('./fixtures/dir/a')}#{path.sep}b#{path.sep}#{path.sep}.."])
|
|
expect(atom.project.getPaths()[0]).toEqual path.dirname(require.resolve('./fixtures/dir/a'))
|
|
expect(atom.project.getDirectories()[0].path).toEqual path.dirname(require.resolve('./fixtures/dir/a'))
|
|
|
|
describe ".eachBuffer(callback)", ->
|
|
beforeEach ->
|
|
atom.project.bufferForPathSync('a')
|
|
|
|
it "invokes the callback for existing buffer", ->
|
|
count = 0
|
|
count = 0
|
|
callbackBuffer = null
|
|
callback = (buffer) ->
|
|
callbackBuffer = buffer
|
|
count++
|
|
atom.project.eachBuffer(callback)
|
|
expect(count).toBe 1
|
|
expect(callbackBuffer).toBe atom.project.getBuffers()[0]
|
|
|
|
it "invokes the callback for new buffers", ->
|
|
count = 0
|
|
callbackBuffer = null
|
|
callback = (buffer) ->
|
|
callbackBuffer = buffer
|
|
count++
|
|
|
|
atom.project.eachBuffer(callback)
|
|
count = 0
|
|
callbackBuffer = null
|
|
atom.project.bufferForPathSync(require.resolve('./fixtures/sample.txt'))
|
|
expect(count).toBe 1
|
|
expect(callbackBuffer).toBe atom.project.getBuffers()[1]
|