[Bug] getHangingProtocolModule Name or Id ?

[salimkanoun]

Describe the Bug

It seems to be a discordance between documentation and code

in the documentation : https://docs.ohif.org/platform/services/data/hangingprotocolservice/#protocol-definition
Hanging protocol should be registered by Id

But in the code they are registered by name property :

Viewers/extensions/default/src/getHangingProtocolModule.js

Line 101 in c73a403

function getHangingProtocolModule() {

Also the url param to set a HP is hangingProtocolId so I guess there is a error in the code (should use id instead of name, and will led to breaking change)

Steps to Reproduce

None

The current behavior

registering of HP use name

The expected behavior

should use id property

OS

linux

Node version

20

Browser

Chrome 100+

[sedghi]

I think id makes more sense, you are saying URL is based on name?

[salimkanoun]

The weird thing is that getHangingProtocolModule is mapping the id of the hanging protocol to a "name" property

The HP object has itself a "name" and an "id" property, so I guess getHangingProtocolModule could simply return array of protocols. If needed to add a differentiating key then I guess it would be better to expose "id" instead of "name" in this getHangingProtocolModule

[sedghi]

I hate this, maybe next next version we can fix it

[sedghi]

I took a closer look at this issue. The problem lies in the following code:

{
      name: defaultProtocol.id,
      protocol: defaultProtocol,
    },

This is causing the protocol module registration to hang. Our modules, such as the viewport module and panelModule, are identified by their name. However, what really makes a Hanging Protocol (HP) unique is its id. So, when you use a query parameter like ?hangingProtocolId=[HP id], it should be referencing the HP by its id.

I'm making a PR to just make the id case insensitive, maybe that helps a bit

[salimkanoun]

humm didn't understand so much but will look at the PR ^^

[sedghi]

What I mean is that all modules register with a unique name. For example, you can see this in the documentation for data source modules at https://docs.ohif.org/platform/extensions/modules/data-source/ and panel modules at https://docs.ohif.org/platform/extensions/modules/panel/. Here, we have both an id and a name for HP, which is pretty similar to having a name for internal use and a readableName for UI purposes. It's really not a big deal, we can just treat the id as the actual name and the name as the readable name.