[editor] Widget manager should compare widget keys with deep equals instead of string equal

[kittaakos]

Bug Description:

When opening editors, the opener options is used to generate an identity key for the widget. This is clear and works as expected. However, the property order of the opener options also matters when trying to find an already opened widget.

The following code causes unexpected behavior:

const uri = 'file:///path/to/an/existing/resource.txt';
const options = {
    counter: 0,
    mode: 'reveal',
    preview: false
} as EditorOpenerOptions;
await this.editorManager.open(uri, options);

const sameOptions = {
    ...options,
    preview: options.preview,
    mode: options.mode // change the property order
};
await this.editorManager.open(widget.editor.uri, sameOptions);

My code is here: master...kittaakos:opener-options
Steps to reproduce:

• Open an editor,
• Wait 2 sec

See in action:

duplicate.mp4

Do I misuse the APIs? if not, I think Theia should compare keys with deepEqual and try to find the existing widget instead doing Map.get by the JSON options.

Steps to Reproduce:

Additional Information

• Operating System: macOS 12.3.1
• Theia Version: 462376a

[colin-grant-work]

Alternatively, something like this library might solve the problem of key-order dependent stringification - it's even already in our node_modules.