Make debugging work better in VS Code / Codespaces

[callumbwhyte]

requireExactSource needs to be disabled in order to properly attach to process and debug Umbraco source in VS Code / Codespaces.

Found during my Hacktoberfest stream that Codespaces wouldn't allow me to attach a breakpoint in a library other than the executing library unless this flag was set to false.

Hopefully this makes the contribution experience a little easier!

[umbrabot]

Hi there @callumbwhyte, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

• It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
• The automated tests all pass (see "Checks" tab on this PR)
• The level of security for this contribution is the same or improved
• The level of performance for this contribution is the same or improved
• Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
• If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
• The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

[OwainWilliams]

Thanks @callumbwhyte - I was trying to find some information about this settings to see what, if any, impact it would have by being set to true in the first place.
Couldn't find anything useful and most articles I did find were setting it to false for the same reason you have created the PR for.

Do you have any other info?

[callumbwhyte]

@OwainWilliams Other than the VSCode / CodeSpaces IDE telling me I needed this set I have no idea what it does...!

The only docs I can find for it are here.

An optional flag that tells the Visual Studio Windows Debugger to require current source code to match the pdb.

I can't quite think of a reason why you wouldn't want the PDB file (which stores the debug information for a DLL) to match the source code, so not sure why setting this to false resolves the issue...

I can only assume that the PDB files in the executing directory src/Umbraco.Web.UI/bin aren't kept up to date when running the debugger or dotnet watch run and that's what causes this?

[umbrabot]

Hi there @callumbwhyte,

First of all: A big #H5YR for making an Umbraco related contribution during Hacktoberfest! We are very thankful for the huge amount of PRs submitted, and all the amazing work you've been doing 🥇

Due to the amazing work you and others in the community have been doing, we've had a bit of a hard time keeping up. 😅 While all of the PRs for Hacktoberfest might not have been merged yet, you still qualify for receiving some Umbraco swag, congratulations! 🎉

In the spirit of Hacktoberfest we've prepared some exclusive Umbraco swag for all our contributors - including you!

As an alternative choice this year, you can opt-out of receiving anything and ask us to help improve the planet instead by planting a tree on your behalf. 🌳

Receive your swag or plant a tree! 👈 Please follow this link to fill out and submit the form, before December 31st, 2021.

Following this date we'll be sending out all the swag, but please note that it might not reach your doorstep for a few months, so please bear with us and be patient 🙏

We have blogged about this year's hacktoberfest in a recap post, have a read about at all the achievements for this year!

The only thing left to say is thank you so much for participating in Hacktoberfest! We really appreciate the help!

Kind regards,
The various Umbraco Teams