facebookarchive/draft-js

Why is createEntity mutable?

Open

#1256 opened on Jun 21, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (22,554 stars) (2,646 forks)batch import
documentationhelp wanted

Description

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

What is the current behavior? Calling contentState.createEntity actually modifies contentState object instead of just returning a new one. Here is a simple fiddle: https://jsfiddle.net/FredyCr/32vo35tk/2/

What is the expected behavior? I guess it's not a big deal, it's just little bit confusing given that almost every other operation is immutable.

Which versions of Draft.js, and which browser / OS are affected by this issue? Did this work in previous versions of Draft.js? Working with the latest 0.10.1, not sure about previous versions.

Contributor guide

Tech stack
javascriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptReactDraft.js basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the createEntity method in Draft.js's ContentState module to understand why it modifies the existing object. The issue reports that contentState.createEntity mutates the original object instead of returning a new one. Look for existing tests or discussions about immutability in the codebase, then implement a fix that returns a new ContentState with the entity added, ensuring backward compatibility.