-
Notifications
You must be signed in to change notification settings - Fork 178
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
Add additional client-side restrictions on robot names to protect against robot-side bugs #10214
Comments
@SyntaxColoring
Also, we disallow a user to use space for the first letter. |
Noted, thanks. I think this ticket still stands. Anything not ASCII A-Z 0-9 [edit: and lowercase a-z] is at risk of not being handled correctly. |
@SyntaxColoring Are lowercase letters acceptable? |
|
@mikecardarelli I got confirmation from Max. The lowercase letters are acceptable. |
Overview
Currently, the Opentrons App validates robot names according to
these rulesrules similar to these:And in theory, the OT-2 can have a display name that's mostly arbitrary Unicode.
In practice, robot renaming has several bugs:
POST /server/name
with input that Avahi doesn't like #9960POST /server/name
can corrupt/etc/machine-info
#10197POST/server/name
returns HTTP 500 if input is not valid JSON #10198Since the OT-2 persists its display name across boots, hitting some of these bugs can have lasting effects. So, out of conservatism, in the initial release of the robot rename feature, we should limit input to names that are unlikely to trigger any of these bugs.
When these bugs have been resolved and we've had more time to vet our back-end code, we can lift these restrictions, and go back to the app's current restrictions of:
Acceptance criteria
# TODO
comment pointing back to this ticket for traceability.The text was updated successfully, but these errors were encountered: