-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
refactor: Rename server hooks to better fit their use #4559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I like the future -> resource rename, but I'm somewhat concerned the hydration name will cause people to use these hooks over use_resource and use_hook where it isn't needed. The hydration in the name makes me think that the hook should be used instead of the original if you are using hydration which isn't the case.
use_hook and use_server_cached do very different things. use_resource and use_server_future are fairly similar, but use_server_future always suspends
Anyone who uses the hydration hooks over the normal hooks I assume understands hydration, so I wouldn't be too concerned over them using it everywhere.
use_hookanduse_server_cacheddo very different things.
If not compiled on web or server, it is just use_hook. If on web and used outside hydration (data not available) it also is just use_hook. If used correctly, it becomes a hook whos value is supplied through hydration. Thus I think use_hydration_hook is a perfect name.
use_resourceanduse_server_futureare fairly similar, butuse_server_futurealways suspends
Yeah but "future" here implies it will act like use_future, but it is more similar to use_resource, in fact it returns a Resource (though wrapped in another suspend).
In all I'm more concerned (and have experienced this myself) that "server" causes confusion rather than "hydration" (which is it's intended use).
@jkelleyrtp as with our talk
https://discord.com/channels/899851952891002890/928812591126569000/1407446528653656245
are you wanting to get this in with 0.7? I can resolve the new conflicts if that is the case.
Uh oh!
There was an error while loading. Please reload this page.
This PR renames the server hooks to match their normal hook counterparts and better reflect their intent. By matching the normal hook counterparts it is immediately clear to users that are familiar with their counterparts what their functionality is. Additionally, the current
servernaming is very confusing to new comers. The existing names suggest the hooks will run on the server, but that is not entirely true. They may run on client as well. Their use is during hydration. As such, they should be renamed to reflect this. Thus:use_server_cached->use_hydration_hookuse_server_future->use_hydration_resource