6.0 Feedback: Blank page shown for robots with a number sign (#) in their name

[SyntaxColoring]

Overview

As noticed by @mcous in #10559 (review):

Hashes in robot names break the UI quite badly

• Even with renaming, the app treats names as robot identifiers
• These identifiers go in URLs, because the app is a web UI
• Hashes mean something specific in URLs, so robot names with hashes are mangled when routes are parsed, and you will not be able to navigate to the robot in question to fix the name

Steps To Reproduce

Rename a robot to have # somewhere in its name.

The Opentrons App's Rename button will currently disallow # characters for reasons that I believe are unrelated to this bug. So, to do this, you'll need to manually issue an HTTP request:

POST /server/name

{"name": "Foo # Bar"}

Current Behavior

When a robot has a # in its name, it appears properly on the Devices page.

But when you select it, you get this blank page. Note how the name in the breadcrumbs is wrong, too.

Expected Behavior

The app should be able to handle arbitrary Unicode robot names, including URL-unsafe characters.

(By "handle," I mean the robot's name shouldn't affect functionality. It's certainly fine to have display limitations that require stuff like sanitizing weird characters out of the name, or truncating the name to a maximum length.)

Operating system

macOS.

Robot setup or anything else?

No response

[SyntaxColoring]

The # character in particular is meaningful because it's what Avahi normally uses to deconflict when multiple devices on the network have the same name. For example, MyRobot would become MyRobot #2.

As discussed in #10559, for the 6.0 release, we're going to work around this by taking care on the server side to avoid exposing names with # characters. But we'll need to fix this in the app eventually in our quest to enable arbitrary Unicode names.

[SyntaxColoring]

Migrated to RSS-488.