NuGet vulnerability warnings: Warn in non-Release mode, Error in non-Release mode

[emmagarland]

Initial adjustment of the projects with package vulnerabilities that errored due to GHSA-qj66-m88j-hmgj 09/10/24.

Changed to ignore the four specific NuGet vulnerability warnings in Debug mode (but not Release) as per Microsoft docs (NU1901,NU1902,NU1903,NU1904)

Relates to #17235.

Also updated some formatting errors in tests.

Prerequisites

• [x ] I have added steps to test this contribution in the description below

Description

• In non-Release mode (e.g. Debug), the following NuGet vulnerability warnings should warn: NU1901,NU1902,NU1903,NU1904
• In Release mode, they should error

Next steps

If this approach is confirmed to work, I will add the configuration to all projects in case they get any future vulnerabilities.

[github-actions]

Hi there @emmagarland, 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 🤖 🙂

[ronaldbarendse]

I've slightly changed the way the WarningsNotAsErrors are set and can confirm that debug builds only emit a warning for vulnerable NuGet dependencies, but release builds error out.

Testing was as easy as downgrading one on the package versions, for example:

<PackageVersion Include="System.Runtime.Caching" Version="9.0.0-rc.1.24431.7" />

And running dotnet build -c Release to see the error 👌🏻

We might want to change the condition to only emit the error when building a public version (without the --preview version prefix) though, as regular PR builds will do release builds and we don't really want to fail all PR builds/checks when a vulnerability is reported on any dependency. I'll have to see check how we can do this though!

[ronaldbarendse]

We might want to change the condition to only emit the error when building a public version (without the --preview version prefix) though, as regular PR builds will do release builds and we don't really want to fail all PR builds/checks when a vulnerability is reported on any dependency. I'll have to see check how we can do this though!

I had a quick look into this and although Nerdbank.GitVersioning does set the PublicRelease MSBuild property, the NuGet vulnerability audit is not really part of the build (as it is also done when running a dotnet restore for example).

Maybe a better solution is to simply disable the auditing (using <NuGetAudit>false</NuGetAudit> in Directory.Build.props, as documented) and update the Azure Pipelines build to enable this again for public release builds by adding it to the dotnet commands (e.g. dotnet restore -p:NuGetAudit=true). We could also opt for changing the audit level, so PRs still fail if they have high or critical advisories, but release builds also fail on low advisories (using NuGetAuditLevel).

[emmagarland]

Ah ok, so if that works for the build process that's a cool idea.

I'm happy to go with you and the HQ team's preferences on that! It's definitely a good shout to have more urgent behaviour for the more severe warnings.

[emmagarland]

@ronaldbarendse is there anything else needed for this or can we progress it to be merged? Would that be HQ or Core Collage?

Just aware that I didn't want it to get out of date with all the pushes and then have the same issue for everyone again.

[umbrabot]

Hi there @emmagarland!

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!
This year's swag is a custom designed notebook and custom Umbraco Hacktoberfest sticker:

As an alternative choice, 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 25nd, 2024, 23:59:00 UTC.

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

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.

[emmagarland]

Hi @ronaldbarendse ,

I got round to merging main into this branch and looks like most things have been covered now!

All that remains really are a few typos/wording tweaks.

Happy to either close this, or just progress with the slight wording changes.

Thanks

Emma

[emmagarland]

(update, I've added a couple more updates to reduce more warnings while I'm here)

[Copilot]

Pull Request Overview

This pull request addresses NuGet vulnerability warnings by configuring projects to treat specific vulnerability warnings (NU1901-NU1904) as warnings in non-Release mode but as errors in Release mode. The PR also includes various formatting fixes and code cleanup across test files.

• Standardizes warning handling for NuGet vulnerabilities across multiple project files
• Fixes method formatting and field naming conventions in test files
• Removes obsolete warning suppressions and cleans up project file formatting

Reviewed Changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/Umbraco.Tests.Common/Builders/MediaTypeEditingBuilder.cs	Formats method parameters across multiple lines
tests/Umbraco.Tests.Common/Builders/Extensions/BuilderExtensions.cs	Formats method parameters across multiple lines
tests/Umbraco.Tests.Benchmarks/Umbraco.Tests.Benchmarks.csproj	Removes obsolete warning suppressions and adds BOM
tests/Umbraco.TestData/Umbraco.TestData.csproj	Removes obsolete warning suppressions
tests/Umbraco.TestData/LoadTestController.cs	Refactors static field naming from s_ to _ prefix and modernizes substring usage
src/Umbraco.Web.Website/Umbraco.Web.Website.csproj	Updates comment formatting
src/Umbraco.Web.Common/Umbraco.Web.Common.csproj	Removes extra whitespace
src/Umbraco.Examine.Lucene/Umbraco.Examine.Lucene.csproj	Removes duplicate comment
src/Umbraco.Core/Umbraco.Core.csproj	Updates comment formatting
src/Umbraco.Cms.Targets/Umbraco.Cms.Targets.csproj	Removes extra whitespace
src/Umbraco.Cms.Persistence.Sqlite/Umbraco.Cms.Persistence.Sqlite.csproj	Removes extra whitespace
src/Umbraco.Cms.Persistence.SqlServer/Umbraco.Cms.Persistence.SqlServer.csproj	Fixes typo in comment
src/Umbraco.Cms.Api.Delivery/Umbraco.Cms.Api.Delivery.csproj	Adds BOM and removes extra whitespace

[JasonElkin]

Thanks @emmagarland 🚀