Use less IDs in paths #117
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smklein
commented
Apr 19, 2022
Comment on lines
-579
to
-583
| if path_params.into_inner().instance_id != context.properties.name { | ||
| return Err(HttpError::for_internal_error( | ||
| "Instance name mismatch (path did not match struct)".to_string(), | ||
| )); | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This use of the hostname was somewhat odd - basically, we used the client-provided hostname here, for a path which should only be accessible to the control plane.
I get why we used it - it acted as a convenient way to get the redundant UUID - but we should probably avoid referring to the instance by hostname for internal purposes, as that's could theoretically change.
Regardless, that problem no longer exists after this PR.
Contributor
Author
There was a problem hiding this comment.
Side-note, I was definitely confused by seeing path = ... {instance_id}, when the variable is actually meant to be a string-based hostname.
Contributor
Author
|
Tested in Omicron by: oxidecomputer/omicron#950 |
pfmooney
reviewed
Apr 19, 2022
luqmana
approved these changes
Apr 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Old Behavior
For most endpoints, we'd use the format:
For many endpoints, this UUID would be redundant with values stored in
propertiesstruct, and a somewhat silly check would validate this. This path format added little value, other than requiring clients to supply a redundant value.Why is the UUID redundant? Propolis' server only supports a single instance anyway, so the server address should be a sufficient factor for distinguishing instances.
New Behavior
Don't bother supplying the instance UUID. Simplify a lot of "name -> UUID" pathways where this is no longer necessary.