Mailspring/spec-inbox/component-registry-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

93 lines
3.7 KiB
CoffeeScript

React = require 'react'
ComponentRegistry = require '../src/component-registry'
dummy_component = new ComponentRegistry.Component
name: 'dummy-component'
view: ->
role: 'button'
describe 'a Component', ->
it 'should not construct if a name or view is unspecified', ->
expect(-> ComponentRegistry.Component()).toThrow()
it 'should construct if there is both a name and a view', ->
i = ComponentRegistry.Component
name: 'reply-button'
view: ->
expect(i).toBeDefined()
describe 'ComponentRegistry', ->
beforeEach ->
ComponentRegistry._clear()
describe '.register()', ->
it 'throws an exception if passed a non-component', ->
expect(-> ComponentRegistry.register(null)).toThrow()
expect(-> ComponentRegistry.register("cheese")).toThrow()
it 'returns itself', ->
expect(ComponentRegistry.register dummy_component).toBe(ComponentRegistry)
it 'does not allow a component to be registered twice', ->
ComponentRegistry.register dummy_component
expect(-> ComponentRegistry.register dummy_component).toThrow()
describe '.getByName()', ->
it 'should return a component', ->
ComponentRegistry.register dummy_component
expect(ComponentRegistry.getByName dummy_component.name).toEqual dummy_component
it 'should throw an exception if a component is undefined', ->
expect(-> ComponentRegistry.getByName "not actually a name").toThrow()
describe '.findByName()', ->
it 'should return a component', ->
ComponentRegistry.register dummy_component
expect(ComponentRegistry.findByName dummy_component.name).toEqual dummy_component
it 'should return undefined if there is no component', ->
expect(ComponentRegistry.findByName "not actually a name").toBeUndefined()
it 'should return an alternate if there is no component, and an alt', ->
alt = "alt"
expect(ComponentRegistry.findByName "not actually a name", alt).toBe alt
describe '.findViewByName()', ->
it 'should return a component view', ->
ComponentRegistry.register dummy_component
expect(ComponentRegistry.findViewByName dummy_component.name).toEqual dummy_component.view
it 'should return undefined if there is no component', ->
expect(ComponentRegistry.findViewByName "not actually a name").toBeUndefined()
it 'should return an alternate if there is no component, and an alt', ->
alt = "alt"
expect(ComponentRegistry.findViewByName "not actually a name", alt).toBe alt
describe '.findAllByRole()', ->
it 'should return a list of matching components', ->
ComponentRegistry.register dummy_component
expect(ComponentRegistry.findAllByRole 'button').toEqual [dummy_component]
it 'should return an empty list for non-matching components', ->
expect(ComponentRegistry.findAllByRole 'dummy').toEqual []
describe '.findAllViewsByRole()', ->
it 'should return a list of matching components', ->
ComponentRegistry.register dummy_component
expect(ComponentRegistry.findAllViewsByRole 'button').toEqual [dummy_component.view]
it 'should return an empty list for non-matching components', ->
expect(ComponentRegistry.findAllViewsByRole 'dummy').toEqual []
describe '.unregister()', ->
it 'unregisters the component if it exists', ->
ComponentRegistry.register dummy_component
ComponentRegistry.unregister dummy_component.name
expect(ComponentRegistry.findByName dummy_component.name).toBeUndefined()
it 'notifies of an error if an invalid component is unregistered', ->
ComponentRegistry.register dummy_component
unregistered = ComponentRegistry.unregister "something-else"
expect(ComponentRegistry.findByName dummy_component.name).toEqual dummy_component