Myriad of bugs when decorators do not wrap the decorated text

[lukebarnard1]

Do you want to request a feature or report a bug?
bug

What is the current behavior?
Doing character insertion or deletion at the edge of an entity causes the immutable entity to become text.

https://jsfiddle.net/hpeobuvz/2/

This feels highly related to #627 and #1200. I've observed that we only experience issues when the sum length of the text nodes contained in the decorator does not equal the length of the decorated range. Otherwise, the decorated Entity behaves exactly as expected, even when the decoration contains images.

What is the expected behavior?

Inserting a character after an immutable entity does not destroy the entity.

Which versions of Draft.js, and which browser / OS are affected by this issue? Did this work in previous versions of Draft.js?

Seemingly all setups. This has always affected draft.js but in this instance we're using 0.11.0-alpha.

[flarnie]

It seems like Draft expects the decorator component to pass through this.props.children - that fixed the issue for #1200, and probably would also fix the other issue you referenced.

I think a good first step would be to add a warning for this case, but that's not super easy to do. It would also be great to add support, but right now that's a supported use of decorators. Also we could update the docs to make it clear that you should pass through this.props.children. Currently we say "Note that props.children is passed through to the rendered output. This is done to ensure that the text is rendered within the decorated span." but we should mention that selection behavior depends on this.