Fix Diff Editor Model Refs

[zgbpr]

Summary

Fixes a bug that caused both diff editors to display the same model.

Details

We ran into a bug with the diff editor where both the modified editor and original editor displayed the same content. When we inspected the editors in the browser, we found that they had the same data-uri value.

After tracing through the editorAppBase.ts file, we saw that the getEditorUri function accepts a boolean to determine whether to append 'Original'. But the buildModelRef function always passed false when building the model reference for both editors.

This pull request fixes the bug by passing a boolean parameter from buildModelRef to getEditorUri and ensuring that the URIs are different for both editors.

Screenshots

Here is a screenshot before the change, showing how the modified editor and original editor displayed the same content.

Here is a screenshot after the change, showing how the modified editor and original editor now display different content.

[kaisalmen]

@zgbpr thank you for spotting this and providing the fix. Can you please add a unit test? https://github.com/TypeFox/monaco-languageclient/blob/main/packages/wrapper/test/wrapper.test.ts#L114-L133 should be a good template to derive a new test from.

[zgbpr]

Thanks for the suggestion, @kaisalmen! Since that test already creates and verifies the model references, I added a few more expect statements to make sure that each model reference has a different name.

Let me know if you'd prefer to verify the names in a separate test.

[kaisalmen]

Let me know if you'd prefer to verify the names in a separate test.

No, that is fine. Thank you. LGTM

[zgbpr]

Thanks @kaisalmen! Do you happen to know when these changes might be included with a release?

[kaisalmen]

@zgbpr here you go: https://www.npmjs.com/package/@typefox/monaco-editor-react/v/4.3.1

[zgbpr]

Amazing, thank you! 🙏

[zgbpr]

Hmm, I pulled down v4.3.1 of @typefox/monaco-editor-react but it looks like the underlying version of monaco-editor-wrapper still contains the diff model ref bug.

Any chance that there needs to be a v5.3.1 release of monaco-editor-wrapper as well?

[kaisalmen]

Sorry, my fault. New versions will come soon.

[kaisalmen]

@zgbpr here you go:
https://www.npmjs.com/package/monaco-editor-wrapper/v/5.3.1
https://www.npmjs.com/package/@typefox/monaco-editor-react/v/4.3.2

[zgbpr]

Thank you for the quick updates, @kaisalmen! That's working well. 🎉