- Notifications
You must be signed in to change notification settings - Fork1k
chore(site): refactor deployment values service to react-query#9669
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
exportconstdeploymentConfig=()=>{ | ||
return{ | ||
queryKey:["deployment","config"], |
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Could the query keys be declaredas const
? That would not only make sure that they're kept immutable, but also give more precise type information when accessing elements of the key at specific indices
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't know if this would cause the compiler to flag anything, though. I'd mainly be worried about type mismatches betweenreadonly
arrays with normal arrays
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think they could be but I don't see to much value on doing that honestly, what use case you are thinking of?
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yeah, I'm looking at the code again, and I think it has limited value here, just because all the values are strings. I think I generally default to this approach, but it's most useful when you have a key array that mixes different types.
constkey1=["workspaces",23,{running:true}];constkey2=["workspaces",23,{running:true}]asconst;// Inferred as type (string | number | { running: boolean }), because array is arbitrary-lengthconstuserId1=key1[1];// Inferred as type number, because key2 is a fixed-length, immutable tupleconstuserId2=key2[1];
It's more friendly to thenoUncheckedIndexedAccess
compiler setting, too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I see, but I don't see we using something similar like this - accessing the keys directly - so I think we could wait until it becomes an issue or provide more value. Wdyt? But if you feel strong about that, we can do it for all the query keys, I just would do in a diff PR (since it is going to change non related queries as well).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
No, I'm okay with keeping things as-is. There have been cases where I've passed the query key into the function to construct which API endpoint and which parameters to use, and theas const
declarations would help with that, but if there hasn't been a need for that pattern, then I agree with you – it's going to have limited use
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think all of this makes sense. My comments mainly deal with clarifying questions for myself.
exportconstdeploymentConfig=()=>{ | ||
return{ | ||
queryKey:["deployment","config"], |
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't know if this would cause the compiler to flag anything, though. I'd mainly be worried about type mismatches betweenreadonly
arrays with normal arrays
}; | ||
exportconstDeploySettingsLayout:FC=()=>{ | ||
const[state]=useMachine(deploymentConfigMachine); |
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Still need to learn XState, but I'm guessing that this line was meant to expose the machine as a read-only value?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
it is to instantiate a machine
ParkreinerSep 14, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Okay, so it creates the new machine instance, but it's bound as local state for that given component, right? it's not quite a Redux setup where there's only ever one store, and the components selectively subscribe to it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yes, it is bound to the component, in this case to the DashboardLayout
site/src/components/DeploySettingsLayout/DeploySettingsLayout.tsx OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
…r-deployment-values-service
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Looks really good!
Uh oh!
There was an error while loading.Please reload this page.
exportconstdeploymentConfig=()=>{ | ||
return{ | ||
queryKey:["deployment","config"], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
No, I'm okay with keeping things as-is. There have been cases where I've passed the query key into the function to construct which API endpoint and which parameters to use, and theas const
declarations would help with that, but if there hasn't been a need for that pattern, then I agree with you – it's going to have limited use
Related to#9598 |
No description provided.