tooltip fix for hover and code completion on VS code

[jordi1215]

Make the tooltip show the full tagHelperTypeName instead of the reduced name in LSP factory. This method is used in both hover service and code completion service.
Fixes #9638

Summary of the changes

• To make the TryCreateTooltip method in DefaultLSPTagHelperTooltipFactory return the tag helper’s full type name with its namespace, I added the namespace to the descriptionBuilder variable. (see picture below for visualization)
• I also changed the corresponding unit tests in DefaultLSPTagHelperTooltipFactoryTest.cs and HoverInfoServiceTest.cs to test for the now desired behavior with the full namespace shown in tag helper with the type name in bold.
• This change only affects the VS code user experience and does not affect that of Visual Studio.

Fixes:

• This fixes GitHub issue In VSCode hovering over a component tag should show the full component type name #9638 where hovering on a razor element tag on VS code shows the reduced element name and not the full name with the name space included.
• Since the method is also used in code completion in VS code, it also shows the full name in the description box that pops out when the user previews a code completion option that happens to be a razor element.

Testing:

• Visual Studio Code version: 1.85.2
• I checked that the increased length does not pose an issue on the hover display in VS code as the tag name wraps around nicely for up to 1000 characters.
• I also checked the code completion display where the tag name gets truncated at about 100 characters. But that shouldn't be too much of an issue for users since namespace is not usually that long.

Before

After

[DustinCampbell]

I'm interested to know, what makes ReduceTypeName(...) return a different value on VS Code vs. VS? It feels like the answer to that question would lead to the best fix. Since there are existing unit tests that verify the current behavior, I suspect that changing the user experience isn't the best fix.

[jordi1215]

I'm interested to know, what makes ReduceTypeName(...) return a different value on VS Code vs. VS? It feels like the answer to that question would lead to the best fix. Since there are existing unit tests that verify the current behavior, I suspect that changing the user experience isn't the best fix.

Thank you for your comment @DustinCampbell. Thanks to @davidwengier who pointed out in issue #9638, there are "two different code paths for generating hovers". We can re-produce the reduced TypeName behavior in Visual Studio by "forcing the isVSClient variable to be false in the HoverInfoService".

I think the difference exists because VS Code takes markdown text as an input to display hover information to the user whereas in Visual Studio it accepts ContainerElement for hover and ClassifiedTextElement for code completion. This allows the users to see highlighted text and icon pictures when they hover on Razor elements. The code does that by reducing the TypeName, classify it, and then re-appending it to the full namespace. That part of the code remains untouched by this pull request.

I think the end goal is for VS Code users to have the same amount of information on the UI side as the Visual Studio users. An immediate future step is to investigate how we can also "classify" the text in hover description for VS code.

[DustinCampbell]

I think the end goal is for VS Code users to have the same amount of information on the UI side as the Visual Studio users.

I'm definitely on board with that. I just want to make sure that this PR only changes the VS Code user experience and doesn't actually change VS experience. Is that the case?

[jordi1215]

I think the end goal is for VS Code users to have the same amount of information on the UI side as the Visual Studio users.

I'm definitely on board with that. I just want to make sure that this PR only changes the VS Code user experience and doesn't actually change VS experience. Is that the case?

As far as I understand that is correct. The tooltip for Visual Studio is being handled in DefaultVSLSPTagHelperTooltipFactory.cs (note "VS") where as the tooltip for VS Code is handled in DefaultLSPTagHelperTooltipFactory.cs (note no "VS").