useCallback() invalidates too often in practice
gaearon opened this issue · comments
This is related to #14092, #14066, reactjs/rfcs#83, and some other issues.
The problem is that we often want to avoid invalidating a callback (e.g. to preserve shallow equality below or to avoid re-subscriptions in the effects). But if it depends on props or state, it's likely it'll invalidate too often. See #14092 (comment) for current workarounds.
useReducer doesn't suffer from this because the reducer is evaluated directly in the render phase. @sebmarkbage had an idea about giving useCallback similar semantics but it'll likely require complex implementation work. Seems like we'd have to do something like this though.
I'm filing this just to acknowledge the issue exists, and to track further work on this.
@gaearon thank you for your answer in reactjs/rfcs#83. I've look at sources of useReducer. But I can't understand how it is related to useCallback. What issues has "mutation of ref during rendering"? Can you explain me in brief?
I've look at sources of useReducer. But I can't understand how it is related to useCallback
useCallback lets you memoize the callback to avoid a different function being passed down every time. But you have to specify everything it depends on in the second array argument. If it's something from props or state, your callback might get invalidated too often.
useReducer doesn't suffer from this issue. The dispatch function it gives you will stay the same between re-renders even if the reducer itself closes over props and state. This works because the reducer runs during the next render (and thus has natural ability to read props and state). It would be nice if useCallback could also do something like this but it's not clear how.
What issues has "mutation of ref during rendering"? Can you explain me in brief?
In concurrent mode (not yet released), it would "remember" the last rendered version, which isn't great if we render different work-in-progress priorities. So it's not "async safe".
Would be nice if second argument of useCallback was injected as dependencies to callback function.
function useCallback(cb, deps) => {
lastDeps = deps; // save current deps and cb deep in somewhere
lastCb = cb;
if (!cached) {
cached = (...args) => lastCb(...lastDeps)(...args); // memoize that forevere
}
return cached; // never invalidates
}
const myCallback = useCallback(
(state, props) => (a, b) => a + b + state + props,
[state, props]
);
myCallback(1, 2)
const useCallback = (fn, args) => {
const callback = useMemo(() => {
if (__DEV__) {
if (fn.length !== args.length) warning(...);
}
const callback = () => fn(...callback.args);
return callback;
});
useEffect(() => callback.args = args, [args]);
return callback;
}Drawbacks:
It's easy to forget the arguments list, which would result in hard to find bugs. In dev mode it would make sense to check fn.length for the correct length.
It's still possible to forget arguments in the dependencies array, but this applies to other hooks too.
Yes, that's the approach from reactjs/rfcs#83 and https://reactjs.org/docs/hooks-faq.html#how-to-read-an-often-changing-value-from-usecallback. We don't want it to be default because it's easier to introduce bugs in concurrent mode this way.
@sokra An alternate would be:
function useEventCallback(fn) {
let ref = useRef();
useLayoutEffect(() => {
ref.current = fn;
});
return useCallback(() => (0, ref.current)(), []);
}This doesn't require the args like yours has. But again, you can't call this in the render phase and the use of mutation is dicey for concurrent.
@sophiebits That's clever and would have none of the problems with args, etc. It even doesn't require a dependencies list.
One nitpick: return useCallback((...args) => (0, ref.current)(...args), []); to pass along i. e. event argument.
@sokra With this you will not be able to access to state and props updates inside a callback.
const [state, setState] = useState(0);
const handleClick = useCallback((event) => {
console.log(state); // always 0
setState(s => s + 1);
});
return <button onClick={handleClick} />So dependencies are required.
function useCallback(fn, deps) {
const fnRef = useRef(fn);
const depsRef = useRef(deps);
useLayoutEffect(() => {
fnRef.current = fn;
depsRef.current = deps;
});
return useCallback((...args) => (0, ref.current)(...depsRef.current)(...args), []);
}cons handleClick = useCallback(
(state) => event => console.log(state), // up-to-date
[state]
);@sokra With this you will not be able to access to state and props updates inside a callback.
I think with @sophiebits' approach this will work. The latest function is always copied into the ref and only a trampoline function is returned. This will make sure that the latest function is called, which has the latest state in context.
I recently made a duplicate issue and was asked to check this one. What I proposed there was very similar to @sophiebits' approach, but still looks a bit simpler to me:
function useStatic(cb) {
const callback = useRef(cb)
callback.current = cb
const mem = useRef((...args) => callback.current(...args))
return mem.current
// We could, of course still, use the useCallback hook instead of a second reference.
// return useCallback((...args) => callback.current(...args), [])
// Although I think that the one above is better since it avoids the need to compare anything at all.
}This way it is guaranteed to update where the hook is called since it does not directly use any side effect and instead it only updates a reference. It seems to me that it should be callable during the render phase and should not be dicey with concurrent mode (unless references don't meet these two conditions). Wouldn't this approach be a little better or am I missing something?
@muqg In concurrent mode, last render doesn't necessarily mean "latest committed state". So a low-priority render with new props or state would overwrite a reference used by current event handler.
If I understand the problem correctly...
What if useCallback will return a special callable object with two different states of an our callback function? The first is a current callback, that will changes on each render. The second is a commited callback, that changes within a commit phase.
By default call to that object will trigger the current value, so it can be used in render phase.
But internally, React will pass the commited value to the dom, which prevents the callback from being modified until the next commit.
function Callback(cb) {
function callback(...args) {
return callback.current(...args);
}
callback.commited = cb;
callback.current = cb;
callback.SPECIAL_MARKER_FOR_REACT = true;
return callback;
}
function useCallback(cb) {
const callback = useMemo(() => new Callback(cb), []);
callback.current = cb;
useLayoutEffect(() => {
callback.commited = cb;
});
return callback;
}function Component(counter) {
const handler = useCallback(() => {
console.log(counter);
});
handler(); // call to handler.current
// pass handler.commited to the dom
return <button onClick={handler} />
}
I don't think there is a point in saving the "current", if you want to call it during rendering, just save it in advance out of the hook:
const handler = () => {/* do something*/};
const callback = useCallback(handler);
// I can call the current:
handler();
I personally don't see any benefits of the current useCallback implementation over the proposed useEventCallback, will it become the new implementation?
Also, can it warn when the callback is called during render in development mode?
Concurrent mode can produce two different representations of a component (the first one is that commited to the dom and the second one is that in memory). This representations should behaves accordingly with their props and state.
useEventCallback by @sophiebits mutates ref.current after all dom mutations is completed, so the current (in-memory) component can't use the newest callback until the commit is done.
@muqg proposal mutate the callback on each render, so the commited component will lose the reference to the old callback.
The point of my proposal in the passing a separated callback reference, that will changes in commit phase, to the dom, while the in-memory (not commited) representation of a component can use the latest version of that callback.
const handler = () => {/* do something*/};
const callback = useCallback(handler);In this case, you wont pass down the handler to other components because it always changes. You will pass the callback, but will face again the concurrent mode problem.
Hi.
According to @sophiebits useEventCallback implementation why is it
function uses useLayoutEffect and not useEffect for ref updating?
And is it normal due to current limitations use useEventCallback for all internal regular functions with some logic (which wants be memoized for
using in expensive pure components tree or/and has closured variables from outer hook function) inside custom hook?
How/why is it that variables are dereferenced within useEffect?
Whether or not the effect is called again based on changes to state/reducer/etc (useEffect's second param), shouldn't have any implication on those variable's references within useEffect, right?
This behavior seems unexpected and having to leverage "escape hatches" just feels broken to me.
I have a problem with converting this kind of thing to use functional components and the useCallback hook...
export class TestForm extends React.Component {
onChangeField = (name,value) => {
this.setState({ [name]: value });
};
render () {
const state = this.state;
return (
<>
<PickField name="gender" value={state.gender} onChangeField={this.onChangeField} />
<TextField name="firstName" value={state.firstName} onChangeField={this.onChangeField} />
<TextField name="lastName" value={state.lastName} onChangeField={this.onChangeField} />
<DateField name="dateOfBirth" value={state.dateOfBirth} onChangeField={this.onChangeField} />
</>
);
}
The PickField, TextField and DateField components can be implemented with React.PureComponent or React.memo(...). Basically they just display an input field and a label - they have their own onChange handler which calls the onChangeField prop passed in. They only redraw if their specific value changes
onChangeField as above works just fine - but if I try this using a functional component for TestForm and useCallback for onChangeField I just can't get it to 'not' redraw everything on a single field change
@Bazzer588 Are you using React.memo on your functional component? What do your attempts using hooks/functional look like? Your problem may or may not be related to this issue; it's hard to tell without seeing your code.
Here's the full code - just drop a <TestForm/> or a <HookTestForm/> somewhere on a page
Using a React.Component, only the field being editted does a full render
import React from 'react';
import TextField from "./TextField";
export default class TestForm extends React.Component {
onChangeField = (name,value) => {
this.setState({ [name]: value });
};
render () {
const state = this.state || {};
return (
<>
<TextField name="gender" value={state.gender} onChangeField={this.onChangeField} />
<TextField name="firstName" value={state.firstName} onChangeField={this.onChangeField} />
<TextField name="lastName" value={state.lastName} onChangeField={this.onChangeField} />
<TextField name="dateOfBirth" value={state.dateOfBirth} onChangeField={this.onChangeField} />
</>
);
}
}
Using Hooks, all the child elements are re-rendered every time - presumably as onChangeField changes every time the state data changes. Is there some way I can implement onChangeField so it behaves like the above example?
import React, {useState, useCallback} from 'react';
import TextField from "./TextField";
export default React.memo( () => {
const [data, changeData] = useState({});
const onChangeField = useCallback((name,value) => {
changeData({ ...data, [name]: value });
}, [data] );
return (
<>
<TextField name="gender" value={data.gender} onChangeField={onChangeField} />
<TextField name="firstName" value={data.firstName} onChangeField={onChangeField} />
<TextField name="lastName" value={data.lastName} onChangeField={onChangeField} />
<TextField name="dateOfBirth" value={data.dateOfBirth} onChangeField={onChangeField} />
</>
);
});
This is my <TextField> component - you can see when it does a full render from the console or with the React dev tools
import React from 'react';
export default React.memo( ({ name, value, onChangeField }) => {
console.log('RENDER TEXT FIELD',name,value);
return (
<div className="form-field">
<label htmlFor={name}>{name}</label>
<input
type="text"
onChange={ (ev) => onChangeField( name, ev.target.value ) }
value={value || ''}
/>
</div>
);
});
@Bazzer588 I think its due to the object value kept in state under the variable name of data. I don't know why but objects in state always invalidate memoization and thus your callback onChangeField is a new on on each render thus breaking the memoization of the components you're passing it to.
I've had a similar issue like you and noticed this as being its cause. I have no idea why the object in state does not keep its reference when it has not been explicitly set to a new object.
Yes my problem is that the in first example (using React.Component) I can create a onChangeField callback which is bound to this, and never changes during renders
Using the new hook methods I can't seem to replicate the way the existing functionality works,
On the project I'm working on we often do this to have a hierachy of components and state:
onChangeField = (fieldName,fieldValue) => {
const newValue = { ...this.props.value, [fieldName]: fieldValue };
this.props.onChangeField( this.props.name, newValue );
};
So it passes props down the tree (ie value {})
And uses the callback to send new values up the tree
Using the new hook methods I can't seem to replicate the way the existing functionality works,
Use useReducer.
@Bazzer588 The data var your passing to the second parameter of useCallback is going to invalidate every time. useCallback doesn't do a deep comparison. You need to pass in a flat array for it to properly memoize.
Yes I've tried similar with useReducer and passing dispatch down to the child components - this does seem to work as you get the same dispatch method so it doesn't force a re-render
If there's no way to make callback functions work as they did before I guess that's the way we'll have to go
@Bazzer588 The general recommendation is to useReducer.
That said, your particular example can be solved like this but it is pretty unusual to not depend on any props so this doesn't always work:
const onChangeField = useCallback((name, value) => {
changeData(oldData => ({ ...oldData, [name]: value }));
}, []);Thanks @sebmarkbage - didn't realise you could pass a function to changeData
(As in const [data, changeData] = useState({}); )
However now I'm worried - in what case would this doesn't always work ?
@gaearon, is this issue going to be solved before hooks release?
Workarounds above (especially relying more on useReducer) seem sufficient for most cases. There are cases when they’re not, but we’ll likely revisit this again in a few months.
It's very, very different behaviour
With a ES6 class I can pass onChange={this.handleChange} to the child component and it does not redraw every time (because it sends the same handleChange method every time)
It's frustrating that dispatch works independent of state (I mean the dispatch method does not change even if the underlying state does) but useCallback does not (if your callback needs to do something with state that is)
I see a lot of code where the whole form redraws when the use types into a field
A lot of devs don't understand this until users complain 'it's slow'
@Bazzer588 The general recommendation is to
useReducer.That said, your particular example can be solved like this but it is pretty unusual to not depend on any props so this doesn't always work:
const onChangeField = useCallback((name, value) => { changeData(oldData => ({ ...oldData, [name]: value })); }, []);
@sebmarkbage I tried the approach above of using the oldData argument, but it didn't help me to avoid re-renders of the children components (that's why I was using useCallback)
So I tried using useReducer and use dispatch inside the useCallback but all the children are still re-rendering.
Moreover, I'm passing the state to a callback after changing it, and it is always the previous state (off by one).
Can someone take a look and let me know what the recommended approach is?
Thanks in advance!
Workarounds above (especially relying more on
useReducer) seem sufficient for most cases. There are cases when they’re not, but we’ll likely revisit this again in a few months.
@gaearon then do you plan to release useCallback with the first release of the hooks? After all it is confusing (current issue) and it is not a primitive hook (is equivalent to useMemo(() => fn, inputs))
@carlosagsmendes you can probably use the workaround useEventCallback from above. You can see your example with it here
I put the useEventCallback (with couple changes) here again:
function useEventCallback(fn) {
let ref = useRef();
useLayoutEffect(() => {
ref.current = fn;
});
return useMemo(() => (...args) => (0, ref.current)(...args), []);
}
I worked around this issue, by creating the following hook:
Code:
import { useRef, useEffect } from 'react'
/**
* This hook reduces the amount of rebindings.
* Use it when your props or state change a lot
* or when you have nested handlers.
*
* @param {DomRef} targetRef The reference to the dom node
* @param {String} eventName The eventName you want to bind
* @param {Function} handler The actual event handler
*/
function useCachedRefHandler (targetRef, eventName, handler) {
const savedHandler = useRef()
useEffect(() => {
savedHandler.current = handler
}, [handler])
useEffect(() => {
const internalHandler = (...args) => {
if (savedHandler.current) {
savedHandler.current(...args)
}
}
targetRef.current.addEventListener(eventName, internalHandler)
return () => targetRef.current.removeEventListener(eventName, internalHandler)
}, [])
}
export default useCachedRefHandlerThis code allows me to omit useCallback completely and therefore use state and props without diffing.
Usage Example:
import React, { useRef } from 'react'
import useCachedRefHandler from './hooks/useCachedRefHandler'
function Webview({ onSomeingA, onSomethingB, onSomethingC }) {
const ref = useRef()
useCachedRefHandler(ref, 'ipc-message', (event) => {
switch (event.channel) {
case 'someingA':
onSomeingA (event.data)
return
case 'someingB':
onSomeingB (event.data)
return
case 'someingC':
onSomeingB (event.data)
return
}
})
return (
<webview ref={ref} />
)
}
export default Webview
Had a use case for @sophiebits proposed useEventCallback (#14099 (comment)). The problem with useLayoutEffect is that it issues warnings when server side rendering. You can trick React by switching to useEffect based on the environment (typeof window) but this won't work if the SSR API is called in the browser (with-apollo).
Wouldn't useImperativeHandle work as well?
Edit: WARNING This means that the callback cannot be called safely in the effect cleanup phase. When unmounting the ref will be nulled before the cleanup phase.
function useEventCallback(fn) {
let ref = useRef();
- useLayoutEffect(() => {
+ useImperativeHandle(ref, () => {
- ref.current = fn;
+ return fn;
});
return useCallback(() => (0, ref.current)(), []);
}
I found myself doing this often:
function Foo({ someProp, otherProp }) {
const somePropRef = useRef(someProp);
useLayoutEffect(() => { // or useEffect
somePropRef.current = someProp;
}, [someProp]);
const otherPropRef = useRef(otherProp);
useLayoutEffect(() => { // or useEffect
otherPropRef.current = otherProp;
}, [otherProp]);
const onSomething = useCallback(() => {
handleSomething(somePropRef.current, otherPropRef.current);
}, []);
return <Bar onSomething={onSomething} />;
// or...
//
// // This ref value never changes, so can use .current in render.
// // WARNING: Safe to close over refs and outer scope consts only.
// const onSomethingRef = useRef(() => {
// handleSomething(somePropRef.current, otherPropRef.current);
// });
//
// return <Bar onSomething={onSomethingRef.current} />;
}Does that have any drawbacks besides unnecessary effects?
I found myself doing this often:
function Foo({ someProp, otherProp }) { const somePropRef = useRef(someProp); useLayoutEffect(() => { // or useEffect somePropRef.current = someProp; }, [someProp]); const otherPropRef = useRef(otherProp); useLayoutEffect(() => { // or useEffect otherPropRef.current = otherProp; }, [otherProp]); const onSomething = useCallback(() => { handleSomething(somePropRef.current, otherPropRef.current); }, []); return <Bar onSomething={onSomething} />; // or... // // // This ref value never changes, so can use .current in render. // // WARNING: Safe to close over refs and outer scope consts only. // const onSomethingRef = useRef(() => { // handleSomething(somePropRef.current, otherPropRef.current); // }); // // return <Bar onSomething={onSomethingRef.current} />; }Does that have any drawbacks besides unnecessary effects?
@sompylasar I wanna know as well. we are doing the same thing using this hook
useController<T extends IPropsAndState>(propsAndState:T):T{
const controllerRef = useRef({});
Object.assign(controllerRef.current, propsAndState);
return controllerRef.current;
}
....
....
we badly need it since we have a websocket rjxs subscription and we need an updated context for the callback functions inside filter pipes and the actual subscription.
i cant use a useeffect that contains dependencies in my case because i dont want to constantly disconnect/reconnect to our socket server
@arnotes Looks like you are updating your ref during the render phase, i.e. before it has been commited, rather than in a useEffect call. To quote @gaearon :
In concurrent mode, last render doesn't necessarily mean "latest committed state". So a low-priority render with new props or state would overwrite a reference used by current event handler.
Afaik the drawback with updating the ref in a useEffect is mainly that you then can't use it during the render.
Does that have any drawbacks besides unnecessary effects?
Late to the party here, but after scanning the above thread- there is another potential problem in the useEventCallback example and other example uses of useLayoutEffect above:
function Example({ callback }) {
const stableCallback = useEventCallback(callback);
return <Child callback={stableCallback} />;
}
function Child({ callback }) {
useLayoutEffect(() => {
// Callback has not yet been updated!
// This is because child effects are run before parent effects,
// So the callback ref has not yet been updated (and still points to the old value).
callback();
}, [callback]);
}
What issues has "mutation of ref during rendering"? Can you explain me in brief?
In concurrent mode (not yet released), it would "remember" the last rendered version, which isn't great if we render different work-in-progress priorities. So it's not "async safe".
Aren't class components also exposed to this? Seems React does the same thing to Class Components (mutating props in render phase)
react/packages/react-reconciler/src/ReactFiberClassComponent.js
Lines 1042 to 1045 in 4c56984
also seems the committed and work-in-progress fibers share the same class instance
If React assigns pending props to instance.props in the render phase but the render work is interrupted for some reason, this.props will reflect the props of the WIP (outside of render phase) since both share the same instance. If an event handler fires in between and accesses this.props it'll see the WIP props while it should rather seethe committed props.
I assume the solution is to switch this.props between phases, maybe this is already done but I couldn't trace it in the sources so just wanted to make sure this is handled.
The solution by @sophiebits does the same without a need for stating any deps at all. The callback from ref.current always has a fresh closure. So the usage looks like this
const handleClick= useEventCallback(() => {
// do anything with props, state, or any other local variables
})
missed it altogether and deleted my comment. thanks
I personally don't see any benefits of the current
useCallbackimplementation over the proposeduseEventCallback
Current useCallback is quite helpful with render props pattern. One example is List from react-virtualized. It's a PureComponent, so you can pass a memoized rowRenderer function to prevent rerenders. But if your rowRenderer doesn't invalidate when its deps change (e.g. if it's an instance property on a class component), you have to pass all those deps as List props to trigger rerenders when they're actually needed.
Example on codesandbox: https://codesandbox.io/embed/staging-snow-sgh7v
Note how I have to pass an extra value property to List to fix the class example while useCallback works as is because it invalidates whenever it would produce a different output.
@muqg @strayiker BTW this is why there's no much sense in trying to make useEventCallback work in the render phase: If a child uses your callback to render something, you most likely want it to invalidate as often as its deps change. Also, this is why useEventCallback is a really good name. Basically, it says "only use me for event handlers".
Lets imagen, we have react-redux in our App. So, in any component, where we are going to dispatch something we will code something like this:
const Comp = React.memo((props) => {
// This is from react-redux
const dispatch = useDispatch();
const handler = useCallback(() => {
// actionCreator is created in our project and it is static function
dispatch(actionCreator(props));
}, [props]);
return <Button onClick={handler}></Button>
})Button component will receive new handler every time, than props are changed. As I understand, this is the main theme of the issue)
What if we will create our own custom hook useHandler, which will look like:
// actionCreator won't be changed, just static function in our case
const useHandler = (actionCreator, params) => {
// This is from react-redux. Dispatch won't be changed.
const dispatch = useDispatch();
const paramsRef = useRef(params);
// This is useless for the first time, but we need it later
// This code can be moved or we can add a condition that paramsRef.current !== params.
paramsRef.current = params;
// callback will be created only on the first call of useHandler, cause of []
// But it will dispatch action with new params on next calls
const callback = useCallback(() => {
dispatch(actionCreator(paramsRef.current));
}, []);
return callback;
}So, if we have static actionCreator, static dispatch from useDispatch — is it safe to use that approach in concurrent mode?
By the way, how can we understand, what is safe to use in concurrent mode, and what will break our app?
This line in your above example could cause problems:
paramsRef.current = params;Since you're mutating the ref during render- and renders can be async- you can end up mutating it prematurely (so that a previously-rendered thing calls the callback and gets a not-yet-rendered params value.
To avoid this, you would want to update the ref in a layout effect (useLayoutEffect) although this has its own drawbacks (see this comment).
Edit for clarity.
@bvaughn but in that case it is possible to have a bug like in your example here #14099 (comment)
useEffect will be preferable. What do you think?
Yup! Still has potential for bugs. Mutating during during render seems worse to me though.
As I understand, we can use safely a value from useRef in any hook, but we can not change it safely. Only React itself can do it. For example, if we use useRef to have a ref on dom-node — it is ok, cause React change current value.
It's not about current issue only. It's a general conclusion about useRef and concurrent mode.
That doesn't sound right. Our docs list examples of using the ref for non-React values. The key is when to update the .current property. React updates this property during the "commit phase" (when effects are run) and we suggest you do the same1 to avoid problems like the one I mentioned above.
1 The one exception to this is using a ref to lazily initialize a value. This is only safe because it's idempotent.
@bvaughn
Ok, thanks. Now it's much more clear for me) useEffect/useLayoutEffect is not a silver bullet, but a compromise for useHandler in case, when fn for callback is just static function and only params are changing.
So, will wait for new hook, which is based on useReducer or something like this.
@sophiebits Why is the comma expression needed here?
useEventCallback(fn) { ... return useCallback(() => (0, ref.current)(), []); }
It ensures that the receiver (this value) of the function isn’t ref.
The useImperativeHandle() solution looks good, but it turns out that ref.current will not be set when the callback is called in useLayoutEffect() placed in a child component.
(Original "callback is outdated" issue is here: #14099 (comment) )
https://codesandbox.io/s/react-useeventcallback-test-eirgj
This PoC code shows that ref.current is always not set at callback call.
App: rendering text="abc"
Child: calling layout callback
Callback called: ab
Child: calling imperative callback
!!! imperative callback: ref.current == null
layout callback: ref.current = fn
The useImperativeHandle() solution still does not call outdated func at least. So it can be used where you are confident that the callback will not be called from useLayoutEffect().
Tbh this is making me super skeptical of concurrent mode, given that function memoization is the number one tedious thing I deal with daily in React since hooks were introduced (everything else about hooks being fantastic) and concurrent mode wouldn't benefit me personally right now AFAIK, yet sounds quite dangerous to use.
I came across this problem when I tried to call one callback from another one, and observed strange effects. A very simplified example:
const MyComponent = props => {
const [value, setValue] = useState();
const [copy, setCopy] = useState();
const createCopy = useCallback(() => {
setCopy(value);
}, [value]);
const callback = useCallback(() => {
createCopy();
}, []);
return (
<div>
<input onChange={e => setValue(e.target.value)} />
<button onClick={callback}>Copy</button>
<span>{copy}</span>
</div>
);
};This is obviously a simplified and therefore contrived example. It does not behave how I would expect it to.
According to the documentation it is safe to use setCopy from within a callback (or effect) without adding it to the dependency list. But it appears it's not safe to call another callback created with useCallback without adding it to the dependency list. There is probably a good reason for it, but it seems weird to me and clearly several other people in this thread.
So in the above example calling callback() will not update copy, since it calls an old version of createCopy which holds an old version of value.
@mariusGundersen setCopy is guaranteed to remain the same through component's lifetime, while createCopy changes each time when value does
Yes, that's clearly how it behaves. But it also means that callback needs to change too. It would be useful and consistent if useCallback behaved like useState.
@mariusGundersen If you want callback change too, it need setCopy as its dependency.
In this way it is guarantee that no side effects happened
I found that you can use useReducer to mitigate this effectively. the bit that was hard to swallow is when i needed side effects to happen in the callback.
Side effects cant happen in the reducer as it is being called with past actions a lot, on re renders, for some reason. so the reducer must be pure (state, action) => resultState, with no side effects.
The solution was to use useEffect that listen to changes in the reduced state (resultState), to initiate side effects, which suddenly seemed obvious. 😅
for example, this code:
const [counter, setCounter] = useState(0);
const handleClick = useCallback(() => {
console.log(`child clicked ${counter + 1} times`);
setCounter((c) => c + 1);
}, [counter]);
which will create a very problematic callback, could be perfectly replaced with:
const [counter, handleClick] = useReducer((c) => c + 1, 0);
useEffect(() => {
counter && console.log(`child clicked ${counter} times`);
}, [counter]);
which will have the same effect but with handler that will persist through the entire lifetime of the component.
i think this is the most complete solution to the useCallback problem.
@gaearon can you confirm?
@liorJuice I wonder if in some cases people would need side effects to happen synchronously, right away when something is clicked though?
@liorJuice how would you use props in side effects with this approach?
@Hypnosphi like other effect dependencies. remember that if if you only use them for calculations - you can safely move them to the reducer.
@liorJuice
like other effect dependencies
then the effect will trigger whenever the prop changes which is probably not what you want.
I'm talking about cases like that:
const handleClick = useCallback(() => {
console.log(props.name);
}, [props.name]);
How would you apply your approach to this case?
You wouldn't need to pass props used in side effects as dependencies -- the new values for those props would be part of the new closure when the effect fires because the counter dependency changed.
useEffect(() => {
counter && console.log(`${props.name}: child clicked ${counter} times`);
}, [counter]);
Though I assume it may be possible for the props to change between the click that incremented the counter and the render that triggers the effect?
@Hypnosphi the problem you describe is a general useEffect problem (how to write effects with dependencies that don't need to trigger the effect),
it is not specific to the the useCallback solution i described.
there are number of approaches you can take to solve prop dependencies in effects.
i suggest taking a look here:
https://overreacted.io/a-complete-guide-to-useeffect/#why-usereducer-is-the-cheat-mode-of-hooks
there is also a custom hook named "usePrevious", you can use it to check if a specific dependency changed on useEffect. im not sure how much of a best practice it is.
here is one solution:
const [{logReport}, handleClick] = useReducer((state) => ({
counter: state.counter + 1,
logReport: `${props.name}: child clicked ${state.counter + 1} times`
}), {counter: 0, logReport: ''});
useEffect(() => {
logReport && console.log(logReport);
}, [logReport]);
you can use props inside reducers if you put the reducer function inside the component (which you shouldn't do by default, but you can).
note that logReport does not change when props.name changes, but only when the user clicks.
I was inspired by @liorJuice's thoughts on useReducer -> useEffect above to create a custom hook as an experiment, use-effect-callbacks. It transforms an object of callbacks into stable methods that can then be passed down. It works by caching the callbacks through a useReducer and executing them in the next useEffect. Could be used as such:
import { useEffectCallbacks } from 'use-effect-callbacks';
// ...
// Within parent component
const [state, setState] = useState({ foo: 'bar' });
const { getState } = useEffectCallbacks({
getState: () => state,
});
// ...
// Within memoized child component
const handleClick = async () => {
setState({ foo: 'baz' });
const latestState = await getState();
console.log(latestState); // -> { foo: 'baz' }
};Pros:
- It should be concurrent safe.
- The methods are stable as long as the callback names are stable.
- It is quite straightforward and simple to use.
- You don't need to manually keep track of a lot of different properties in your state to trigger various effects. (Compared to the more manual approach proposed by @liorJuice.)
Cons:
- It's a bit wasteful.
- Calling a method will trigger the owner component to re-render. (Not a problem if you expect it to re-render anyway, e.g. due to a setState call)
- If a method is called in a
useEffect, I believe it will still trigger a full render-cycle and only execute in the nextuseEffect.
- The methods are not suitable as event listeners since they execute later, and any react event would have been recycled. (They can however very well be called from event listeners)
- While the methods can "safely" be called during renders, there's not much point in doing so since they return promises.
Conclusion:
To be perfectly honest I'm still not quite sure what to think of this approach. It seems handy for occasionally getting the next state, but most other use-cases I can think of seem like a bit of a stretch.
FYI: My snippet of useImperativeHandle solution #14099 (comment) is like this (it is TypeScript, remove type annotations for JS):
// Better useCallback() which always returns the same (wrapped) function reference and does not require deps array.
// Use this when the callback requires to be same ref across rendering (for performance) but parent could pass a callback without useCallback().
// useEventCallback(): https://github.com/facebook/react/issues/14099#issuecomment-499781277
// WARNING: Returned callback should not be called from useLayoutEffect(). https://github.com/facebook/react/issues/14099#issuecomment-569044797
export function useStableCallback<T extends (...args: any[]) => any>(fn: T): T {
const ref = useRef<T>()
useImperativeHandle(ref, () => fn) // Assign fn to ref.current (currentFunc) in async-safe way
return useRef(((...args: any[]) => {
const currentFunc = ref.current
if (!currentFunc) {
throw new Error('Callback retrieved from useStableCallback() cannot be called from useLayoutEffect().')
}
return currentFunc(...args)
}) as T).current
}
my workaround try to be KISS by abuse self reference from JS context.
But it always point to latest, not sure what could it break in various mode and lifecycle in react.
At least it work in my case.
export default function useStableCallback<T extends (...args: any[]) => unknown>(callback: T): T {
const ref = useRef({
stableProxy: (...args: any) => {
return ref.current.targetFunc(...args);
},
targetFunc: callback,
});
ref.current.targetFunc = callback;
return ref.current.stableProxy as T;
}
I got problem with invalidated callback when try to call it after some state mutation.
Very simplified example:
const onClick = (value) => {
setValue(value);
navigateToNextPage();
}Here navigateToNextPage uses old state in its closure and leads to a wrong screen.
I had to create useNextUpdateCallback hook to make it work on the next render:
const navigateOnNextUpdate = useNextUpdateCallback(navigateToNextPage);
const onClick = () => {
setValue(value);
navigateOnNextUpdate();
}Implementation:
const forceUpdateReducer = (x) => x + 1;
export const useForceUpdate = () => {
const [, forceUpdate] = useReducer(forceUpdateReducer, 0);
return forceUpdate;
};
export const useNextUpdateCallback = (callback) => {
// eslint-disable-next-line no-unused-vars
const forceUpdate = useForceUpdate();
const shouldCallRef = useRef(false); // ref is used not to rerender after callback is called
useEffect(() => {
if (!shouldCallRef.current) return;
callback();
shouldCallRef.current = false;
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [shouldCallRef.current]);
return useCallback(() => {
shouldCallRef.current = true;
forceUpdate();
}, [forceUpdate]);
};Problems:
- Navigation happens not immediately, this feels a little slower.
- It is a hack.
Does anyone know a better workaround?
PS. The more I use React and hooks, the more i understand how complex they are. Too complex.
@gentlee I ran into a different problem but the workaround should help in your case as well.
Let's assume navigateToNextPage depends on state currentPage in the closure. You could modify navigateToNextPage to read currentPage from an argument rather than the state in the closure.
const onClick = () => { setValue(value); setCurrentPage((currentPage)=>{ navigateToNextPage(currentPage) return currentPage }); }
Caution: It does not work in all cases, eg: if this setState call causes parent component to re-render.
Hoping there will be some solution to this in React 18.
What if we had some kind of ref hook that safely keeps track of the last commited value on any given render thread?
function useEventCallback(fn) {
let ref = React.useConcurrentRef(fn);
// value could be updated like:
// ref.setCurrent(fn);
return useCallback((...args) => (0, ref.getCurrent)(...args), []);
}Maybe it could have a current property with getters/setters just like useRef; I just used setCurrent/getCurrent in my example to illustrate that magic would be happening under the hood.
I smell useRef here. Either you want to manage the update or not.
Might this approach work fine when combined with useConcurrentModeSafeRef()?
Might this approach work fine when combined with useConcurrentModeSafeRef()?
useConcurrentModeSafeRef looks pretty cool at a first glance, but I'd want to know a bit more about this core line before using it in production:
Promise.resolve().then(()=> raw.isRendering = false)- Do renders always complete during the same microtask? Including all child components?
- Can we count on this to remain true for concurrent renderering?
- At exactly what point does the promise resolve? Before or after (layout) effects?
useConcurrentModeSafeRef looks pretty cool at a first glance, but I'd want to know a bit more about this core line before using it in production:
Please check this comment at the end of the article, where João Paulo expresses similar thoughts and proposes to change that part to:
raw.isRendering = true;
raw.currentValue = raw.comittedValue;
useLayoutEffect(() => {
raw.isRendering = false;
raw.comittedValue = raw.currentValue;
});
The full implementation for useConcurrentModeSafeRef() would be like so, I guess (including a fix for the "committedValue" typo):
type Raw<T> = {
isRendering: boolean;
committedValue: T;
currentValue: T;
ref: { current: T };
};
export const useConcurrentModeSafeRef = <T>(initialValue: T) => {
const rawRef = useRef<Raw<T>>();
const raw: Raw<T> = rawRef.current ?? (
rawRef.current ={
isRendering: true,
committedValue: initialValue,
currentValue: initialValue,
ref: {
get current() {
if (raw.isRendering) {
return raw.currentValue;
} else {
return raw.committedValue;
}
},
set current(v) {
if (!raw.isRendering) {
raw.committedValue= v;
}
raw.currentValue = v;
}
}
}
);
raw.isRendering = true;
raw.currentValue = raw.committedValue;
useLayoutEffect(() => {
raw.isRendering = false;
raw.committedValue= raw.currentValue;
});
return raw.ref;
};So...
function useStatic(cb) {
const callback = useRef(cb)
callback.current = cb
const mem = useConcurrentModeSafeRef((...args) => callback.current(...args))
return mem.current
}This looks promising to me, but I'm not familiar enough about the lifecycle details (especially if the useLayoutEffect() callback fires before or after rendering children). Also, it's unclear to me if this covers all edge cases.
Probably only someone from the core team, like @gaearon, might be able to answer this.
BTW, also have a look at useMenoizedFn() (source), which is a implementation like useStatic() above (ignoring the concurrent mode problem, IMHO, but avoiding some problem when devtools is open).
This looks promising to me, but I'm not familiar enough about the lifecycle details (especially if the useLayoutEffect() callback fires before or after rendering children). Also, it's unclear to me if this covers all edge cases.
Effects only run once a component is committed (a separate step to update the DOM after a component has been successfully rendered). But due to concurrent features such as suspense, there is no guarantee that a component that has started rendering will finish rendering, much less be committed.
In other words, useLayoutEffect is not a reliable way to tell whether it is still rendering. Afaik the component will eventually re-render and be committed once it's no longer held up, but in the meantime the hook will think that it is still rendering even though it isn't.
Effects only run once a component is committed (a separate step to update the DOM after a component has been successfully rendered). But due to concurrent features such as suspense, there is no guarantee that a component that has started rendering will finish rendering, much less be committed.
I was aware of that. I actually meant "before or after committing children". Sorry for the confusion.
In other words, useLayoutEffect is not a reliable way to tell whether it is still rendering.
Agree.
Another solution, that would work better, I think:
function useConcurrentModeSafeRef(initialValue) {
const isRendering = () =>
!!React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner.current;
const rawRef = useRef();
const raw = rawRef.current ? rawRef.current : (
rawRef.current = {
comittedValue: initialValue,
currentValue: initialValue,
ref: {
get current() {
if (isRendering()) {
return raw.currentValue;
} else {
return raw.comittedValue;
}
},
set current(v) {
if (!isRendering()) {
raw.comittedValue = v;
}
raw.currentValue = v;
}
}
}
);
raw.currentValue = raw.comittedValue;
useLayoutEffect(() => {
raw.comittedValue = raw.currentValue;
});
return raw.ref;
}
function useStatic(cb) {
const callback = useRef(cb)
callback.current = cb
const mem = useConcurrentModeSafeRef((...args) => callback.current(...args))
return mem.current
}Of course, that's bad because it's using unsafe API (React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED). Perhaps something like useConcurrentModeSafeRef() could be added to React itself.
We've submitted a proposal to solve this. Would appreciate your input!
Adding more React specific concepts like useEvent seem troublesome on a first glance considering it's more of Reactisms that kinda fight with the underlaying JS language principles. That being said, I don't see a better solution for this specific issue at the moment, RFC seems very well thought through.
I wrote a hook that achieves exactly the same some time ago.
Would you please have a look, @gaearon? It might be every so slightly more efficient than yours, as it uses two hooks rather than three.
If you're interested, I also tried to start a discussion here.
/**
* Returns a memoized version of your function that maintains a stable reference, but
* also can read the latest scope (props and state) of the component in which it is used.
*/
function useStableCallback<Args extends any[], T>(
callback: (...args: Args[]) => T
) {
const callbackContainer = useRef(callback)
callbackContainer.current = callback
return useCallback(
(...args: Args) => callbackContainer.current(...args),
[callbackContainer]
)
}const callbackContainer = useRef(callback)
callbackContainer.current = callback
@mariusbrataas Updating a ref during render is an unsafe side effect.
The useEvent proposal definitely goes in the right direction, as the misuse of useCallback is something we've all seen countless times across teams and organizations.
I do want to express some strong concerns around the naming as useEvent could potentially be very confusing for less experienced engineers or those who are coming to React from other frameworks.
The dangerous naming correlation to DOM events makes it quite misleading at first glance and seems to hide its true purpose.
I much prefer useStableCallback as someone else suggested, or useHandler as I feel it makes it easier to document and explain its usage moving forward.
There is a situation we shouldn't use useEvent:
We need to spread value handlers to a list of components that track their own data collection position.
const handleChangeValueByIndex = useCallback(
(index) => (indexValue) => {
onChange(listValue.map((v, i) => i === index ? indexValue : v))
},
[onChange, value]
)
return (
<>
{value.map((v, i) => (
<Item key={value.id} onChange={handleChangeValueByIndex(i)} value={v} />
))}
</>
)
useEvent keeps the reference of the raw value instead of the latest value.
useCallback handles the higher-order function well.
Can we have some doc elaborate on this?
Definitely agree with @floroz regarding the naming and would prefer something like useStableCallback.
@zheeeng I'm not sure what's the benefit of even using useCallback in your case. handleChangeValueByIndex(i) will always return a new function even though the handleChangeValueByIndex itself is memoized.
Having said that, there definitely are cases where useCallback should still be used even after introducing useEvent. One example is memoized components that use render props:
const renderItem = useCallback(i => <Item data={items[i]} />, [items])
return <List renderItem={renderItem} count={items.length} />
Here, if List is memoized, renderItem reference has to change along with items, otherwise the changes to items won't be reflected on screen
Hi, @Hypnosphi, I update this case here, the old style I use useCallback like this below. After switching to useEvent causes buggy behavior.
const handleChangeValueByIndex = useCallback(
(index) => (indexValue) => {
onChange(listValue.map((v, i) => i === index ? indexValue : v))
},
[onChange, value]
)
return (
<>
{value.map((v, i) => (
<Item key={value.id} onChangeByIndex={handleChangeValueByIndex} index={i} value={v} />
))}
</>
)
const Item = React.memo(({ onChangeByIndex, index, value }) => {
const handleChange = useMemo(() => onChangeByIndex(index), [onChangeByIndex, index]);
return (
<Input value={value} onChange={handleChange} />
)
})
This way we get benefits for memoizing the handleChangeValueByIndex which passe to Item. The parent component rerender won't affect the child Item.
In this case the “event” is the inner curried part. In general I would not recommend currying React event handlers. It’s a pretty confusing pattern to read and deal with.
The
useEventproposal definitely goes in the right direction, as the misuse ofuseCallbackis something we've all seen countless times across teams and organizations.I do want to express some strong concerns around the naming as
useEventcould potentially be very confusing for less experienced engineers or those who are coming to React from other frameworks. The dangerous naming correlation to DOM events makes it quite misleading at first glance and seems to hide its true purpose.I much prefer
useStableCallbackas someone else suggested, oruseHandleras I feel it makes it easier to document and explain its usage moving forward.
As a long time user of react, I also agree. useEvent makes me assume we are using an emitter and i would avoid handler for the same reason as it implies action in response to an emitted event. I like your suggestion of useStableCallback over useEvent
In this case the “event” is the inner curried part. In general I would not recommend currying React event handlers. It’s a pretty confusing pattern to read and deal with.
Can we have documented rules or principles to note this recommendation? Users can't avoid getting trapped by using useEvent in ways out of the When useEvent should not be used chapter listed.
In this case the “event” is the inner curried part. In general I would not recommend currying React event handlers. It’s a pretty confusing pattern to read and deal with.
Can we have documented rules or principles to note this recommendation? Users can't avoid getting trapped by using
useEventin ways out of theWhen useEvent should not be usedchapter listed.
The RFC states that the event function created by useEvent will throw if called during render, which is what you did with your curried handler.
One more argument against the "useEvent" naming. The following statement derived from the RFC doesn't make sense in English:
[The RFC states that] the event created by useEvent will throw if called
How can an event throw? How can an event be called? An event is something that happens. Sometimes we say "an event" as a shorthand to "an event object" that not only mentions what happened, but also describes the details about what happened.
But it feels unintuitive to use "an event" as a shorthand for "an event handler function" that processes what happened during an event.
While writing the above, I think I understood one way of thinking where these can be equivalent: if we treat an event as something not instantaneous that has duration (which is not how events are usually treated in software engineering), and then treat the side effects as an unseparable part of an event, then the function that processes the event is the part of the event, hence "using an event" makes some sense.
How can an event throw? How can an event be called?
@sompylasar I think that was just me accidentally leaving out "function" from "event function". Sorry about that.
@nikparo Nothing to be sorry for, I think that's important and that proves my point. We use programming languages and naming conventions to communicate, but this particular (useEvent) naming introduces a lot of space for ambiguity. By the way, "event function" also doesn't make a lot of sense in the context of "an event" as a marker for a point in time when something happened instantaneously.
EDIT: "An event handler function" (or, more grammatically correct "an event-handling function") from my point of view makes more sense than "an event function" because the main keyword here is "handler"/"handling", a function that that "handles" the event. English doesn't make this easy because whether a word is a noun or an adjective depends on its position in a sequence of words.
the rfc sounds nice. In almost any react app, I end up using a useLatest hook to ref-ify non-reactive values I only need in response to some event. I wonder if all usages of useLatest are related to event handling and hence covered by the proposed hook for creating event handlers.
On a different note, the name useEvent confused me in the beginning and I see many people are also talking about it.
🟢 useState => returns state (and setter)
🟢 useRef => returns ref
🟢 useCallback => returns callback
🟢 useMemo => returns memorized value
🔴 useEvent => returns event handler
I get that having a short name is nice, but confusing "event" and "event handler" is a much more considerable drawback IMO.
I think useEventHandler or useHandler (if having a short name is deemed very important) are better choices.
yeah, it's implemented in https://www.npmjs.com/package/react-use-handler
would be nice to have it in react.
In this case the “event” is the inner curried part. In general I would not recommend currying React event handlers. It’s a pretty confusing pattern to read and deal with.
Can we have documented rules or principles to note this recommendation? Users can't avoid getting trapped by using
useEventin ways out of theWhen useEvent should not be usedchapter listed.The RFC states that the event function created by
useEventwill throw if called during render, which is what you did with your curried handler.
useEvent shouldn't be used in render-props, a common react pattern. it's explainable but it is hard to realize intuitively. Should we list more cases in RFC?
Gentlemen: useGranularCallback from npm i granular-hooks
BTW, I use their useGranularEffect() a lot because I don't want useEffect style triggering when only certain vars should trigger updates. It takes two lists of arguments, primary and secondary deps as arrays. primary deps trigger calling the hook or changing the callback, secondaries don't.
@BirdTho this line modifies ref during render which is not safe in concurrent mode
https://github.com/gfox1984/granular-hooks/blob/main/src/hooks/useGranularHook.ts#L17
@BirdTho I checked the code of granular-hooks. The whole library is just a roundabout way of calling hooks while leaving out some dependencies. The secondary dependency array does nothing at all - it doesn't matter whether you include it or not. It does not protect you against stale values!
If you want a hook that doesn't nag at you about exhaustive-deps, then you are better off with export const useGranularCallback = useCallback;.
@Hypnosphi So basically, if I'm not going to use concurrent mode, this is fine then?