Mailspring/spec-inbox/models/model-spec.coffee
Ben Gotow 1e8fd46342 fix(drafts): Various improvements and fixes to drafts, draft state management
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
2015-02-03 16:24:31 -08:00

113 lines
3.6 KiB
CoffeeScript

Model = require '../../src/flux/models/model'
{isTempId} = require '../../src/flux/models/utils'
describe "Model", ->
describe "constructor", ->
it "should accept a hash of attributes and assign them to the new Model", ->
attrs =
id: "A",
namespaceId: "B"
m = new Model(attrs)
expect(m.id).toBe(attrs.id)
expect(m.namespaceId).toBe(attrs.namespaceId)
it "should assign a local- ID to the model if no ID is provided", ->
m = new Model
expect(isTempId(m.id)).toBe(true)
describe "attributes", ->
it "should return the attributes of the class", ->
m = new Model()
expect(m.attributes()).toBe(m.constructor.attributes)
describe "isEqual", ->
it "should return true iff the classes and IDs match", ->
class Submodel extends Model
constructor: -> super
a = new Model({id: "A"})
b = new Model({id: "B"})
aSub = new Submodel({id: "A"})
aEqualSub = new Submodel({id: "A"})
expect(a.isEqual(b)).toBe(false)
expect(a.isEqual(aSub)).toBe(false)
expect(aSub.isEqual(aEqualSub)).toBe(true)
describe "isSaved", ->
it "should return false if the object has a temp ID", ->
a = new Model()
expect(a.isSaved()).toBe(false)
b = new Model({id: "b"})
expect(b.isSaved()).toBe(true)
describe "fromJSON", ->
beforeEach ->
@json =
'id': '1234'
'daysOld': 4
'namespace_id': 'bla'
@m = new Model
it "should assign attribute values by calling through to attribute fromJSON functions", ->
spyOn(Model.attributes.namespaceId, 'fromJSON').andCallFake (json) ->
'inflated value!'
@m.fromJSON(@json)
expect(Model.attributes.namespaceId.fromJSON.callCount).toBe 1
expect(@m.namespaceId).toBe('inflated value!')
it "should not touch attributes that are missing in the json", ->
@m.fromJSON(@json)
expect(@m.object).toBe(undefined)
@m.object = 'abc'
@m.fromJSON(@json)
expect(@m.object).toBe('abc')
it "should not do anything with extra JSON keys", ->
@m.fromJSON(@json)
expect(@m.daysOld).toBe(undefined)
describe "toJSON", ->
beforeEach ->
@model = new Model
id: "1234",
namespaceId: "ACD"
it "should return a JSON object and call attribute toJSON functions to map values", ->
spyOn(Model.attributes.namespaceId, 'toJSON').andCallFake (json) ->
'inflated value!'
json = @model.toJSON()
expect(json instanceof Object).toBe(true)
expect(json.id).toBe('1234')
expect(json.namespace_id).toBe('inflated value!')
it "should surface any exception one of the attribute toJSON functions raises", ->
spyOn(Model.attributes.namespaceId, 'toJSON').andCallFake (json) ->
throw "Can't convert value into JSON format"
expect(-> @model.toJSON()).toThrow()
describe "matches", ->
beforeEach ->
@model = new Model
id: "1234",
namespaceId: "ACD"
@truthyMatcher =
evaluate: (model) -> true
@falsyMatcher =
evaluate: (model) -> false
it "should run the matchers and return true iff all matchers pass", ->
expect(@model.matches([@truthyMatcher, @truthyMatcher])).toBe(true)
expect(@model.matches([@truthyMatcher, @falsyMatcher])).toBe(false)
expect(@model.matches([@falsyMatcher, @truthyMatcher])).toBe(false)
it "should pass itself as an argument to the matchers", ->
spyOn(@truthyMatcher, 'evaluate').andCallFake (param) =>
expect(param).toBe(@model)
@model.matches([@truthyMatcher])