rust: Don't expose websocket service IDs #242
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
bryfox
approved these changes
Feb 26, 2025
| /// Removes a service by name. | ||
| pub fn remove_by_name(&mut self, name: impl AsRef<str>) -> Option<Arc<Service>> { | ||
| if let Some(id) = self.name.remove(name.as_ref()) { | ||
| self.id.remove(&id) |
There was a problem hiding this comment.
This don't need locking to coordinate with inserts because IDs are never re-used?
There was a problem hiding this comment.
Regarding the locking, this is rust's classic mutable-xor-shared. Because we hold a &mut self, we know there are no concurrent &self. For the websocket server, that guarantee is provided by an RwLock.
To your other comment, it is true that IDs are not reused. But ServiceId is only 32-bit, so we technically need to worry about overflow. Currently we don't handle that case, we just panic.
There was a problem hiding this comment.
Ah, thanks for the explanation.
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.
Websocket service IDs are an implementation detail to accommodate
ws-protocol. It's not something that our users need to be aware of. Service names need to be unique, and so that should be the handle by which a service is identified or removed. I realized this as I was trying to implement the python plumbing forremove_services.Now we need two maps for indexing services: one by name, one by ID. They need to be synchronized, so I introduced a new
ServiceMapstruct.