Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better handle internal VS exceptions relating to .csproj files #453

Merged

Conversation

mrlacey
Copy link
Contributor

@mrlacey mrlacey commented Dec 22, 2023

Description: Stop internal VS exceptions causing the extension to break or report errors.

It seems that as of ~17.8, there are possible exceptions getting the ActiveDocument when it is an open .csproj file or querying whether it is read-only.
This PR adds exception trapping & suppressing for these possible (& now likely) scenarios.

Over many years of working with different file and project types within Visual Studio extensions, I've learned to be very wary of trusting that calls to properties of documents will always be available or returned without throwing an error. I'm surprised this project has gone so long without encountering such an issue before. (Although maybe #278 is an indication that it hasn't.)

These changes have been made in the shared Windows code, but I've only tested in VS2022.
I can't foresee any issues with them affecting the other VS (2019) build, though.

This change is Visual Studio-specific and will not affect the Rider build.

Fixes #448 (issue)

Checklist:

  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested my changes by running the extension in VS2017
  • I have tested my changes by running the extension in VS2019
  • I have tested my changes by running the extension in VS2022
  • If changes to the documentation are needed, I have noted this in the description above

I have tested with VS 17.8.2 and 17.9.0 Preview 1.1 - The two specific issues I have added exception handling for were happening separately on each of the versions.

Copy link
Contributor

@grochocki grochocki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, thanks! Tested in 2019 as well with no issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants