Modifying State of a Component Directly

Evan Hicks

The Problem

The state of a component is managed internally by React. Updating the state of a component directly can have unintended consequences that can be difficult to debug.

class Counter extends Component {
    constructor(props) {
        super(props)
        this.state = {
            counter: 0,
        }
    }

    increment() {
        this.state.counter = this.state.counter + this.props.increment
    }
}
Click to Copy

If the state is updated directly as in the example above, the component will not rerender since the state is compared shallowly. Additionally, the update may be lost if there are other state changes queued asynchronously using setState.

Another common problem is using the current state/props to update the new state.

class Counter extends Component {
    constructor(props) {
        super(props)
        this.state = {
            counter: 0,
        }
    }

    increment() {
        this.setState({
            counter: this.state.counter + this.props.increment
        })
    }
}
Click to Copy

This will potentially cause issues due to a potential race condition between other state/prop changes and this particular state update. What happens if the props and/or state change before this state update happens?

The Solution

The solution for the first example is to always use the setState function to ensure state changes are properly queued. For the second problem, React provides a different version of setState that takes a function instead of an object.

class Counter extends Component {
    constructor(props) {
        super(props)
        this.state = {
            counter: 0,
        }
    }

    increment() {
        this.setState((prevState, props) => ({
            counter: prevState.counter + props.increment
        })
    }
}
Click to Copy

This will ensure that the state change happens with the correct version of the previous state and props.

Further Reading

If you’re looking to get a deeper understanding of how JavaScript error reporting works, take a look at the following articles:

• Debug front end errors by giving Sentry more clues
• See how Aumni keeps errors out of userland
• Getting started with the React SDK (docs)