dependabot-nuget 0.316.0 → 0.317.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42ebbf0a6556e3766516b2b59eec508929837779a8f9ca2042a4d4f7d629626
-  data.tar.gz: abb2a60e86d368d9d4a0f09c6311fd7b73f2ac708c1ec73c05d92d1b9409b27d
+  metadata.gz: 4f345f9ee257e7f76d38a1895964aaf6f6356182d190037a19df23107f62c18b
+  data.tar.gz: 47c6ec4d4a5157c2a644856532129923aa9a65d6710d01a40bf18c59f8483971
 SHA512:
-  metadata.gz: 5b266cf823214164397b8e9ed67e5f238364ab95074f33f5cacec47adac5a6cecf147a39ccdb11701e29d0de0ca675b3dabd4a330d75d8ff81dbf7b660c26807
-  data.tar.gz: fa309cdd55f81b5507329def15d7a7e6c50b7668e8f1f886cc7c0e1498ac8209aab577d6ba617dbe7ecffda79f93be8d696908b692a07415b78c677905bb9fdb
+  metadata.gz: 453d1742deef75f810dab148d9d9344a79f39ce893d1dfec90020d7bec36b6018b1acddf0d02c5e109e9957a94f7e3b1d09a4808b2f35e3e9b1e20f5b8bc1e15
+  data.tar.gz: 25bf0a85529e9fa9af427d5fa860b4208c7df6cd763d4059ce66fe8c1f6ee04596322f75cf20d5c4cfb6132d0157edb92f63a956191fa67f0c95d43f99444a29

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/ApiModel/Job.cs

@@ -231,7 +231,6 @@ public class NullAsEmptyStringArrayConverter : JsonConverter<ImmutableArray<stri
 
     public override void Write(Utf8JsonWriter writer, ImmutableArray<string> value, JsonSerializerOptions options)
     {
-        writer.WriteStartArray();
-        writer.WriteEndArray();
+        JsonSerializer.Serialize(writer, value, options);
     }
 }

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/PullRequestTextGenerator.cs

@@ -97,7 +97,12 @@ public class PullRequestTextGenerator
         var fromText = dependencySet.Versions.Length == 1 && dependencySet.Versions[0].OldVersion is not null
             ? $"from {dependencySet.Versions[0].OldVersion} "
             : string.Empty;
-        return $"Bump{bumpSuffix} {dependencySet.Name} {fromText}to {string.Join(", ", dependencySet.Versions.Select(v => v.NewVersion.ToString()))}";
+        var newVersions = dependencySet.Versions
+            .Select(v => v.NewVersion)
+            .Distinct()
+            .OrderBy(v => v)
+            .ToArray();
+        return $"Bump{bumpSuffix} {dependencySet.Name} {fromText}to {string.Join(", ", newVersions.Select(v => v.ToString()))}";
     }
 
     private static DependencySet[] GetDependencySets(ImmutableArray<UpdateOperationBase> updateOperationsPerformed)

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/UpdateHandlers/GroupUpdateAllVersionsHandler.cs

@@ -57,6 +57,13 @@ internal class GroupUpdateAllVersionsHandler : IUpdateHandler
     {
         foreach (var group in job.DependencyGroups)
         {
+            var existingGroupPr = job.ExistingGroupPullRequests.FirstOrDefault(pr => pr.DependencyGroupName == group.Name);
+            if (existingGroupPr is not null)
+            {
+                logger.Info($"Existing pull request found for group {group.Name}.  Skipping pull request creation.");
+                continue;
+            }
+
             logger.Info($"Starting update for group {group.Name}");
             var groupMatcher = group.GetGroupMatcher();
             var updateOperationsPerformed = new List<UpdateOperationBase>();

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/UpdateHandlers/RefreshGroupUpdatePullRequestHandler.cs

@@ -145,7 +145,9 @@ internal class RefreshGroupUpdatePullRequestHandler : IUpdateHandler
             var rawDependencies = updatedDependencies.Select(d => new Dependency(d.Name, d.Version, DependencyType.Unknown)).ToArray();
             if (rawDependencies.Length == 0)
             {
-                await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
+                var close = ClosePullRequest.WithUpdateNoLongerPossible(job);
+                logger.Info(close.GetReport());
+                await apiHandler.ClosePullRequest(close);
                 continue;
             }
 

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/UpdateHandlers/RefreshSecurityUpdatePullRequestHandler.cs

@@ -35,6 +35,7 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
             logger.ReportDiscovery(discoveryResult);
             if (discoveryResult.Error is not null)
             {
+                logger.Error($"Reporting error: {discoveryResult.Error.GetReport()}");
                 await apiHandler.RecordUpdateJobError(discoveryResult.Error);
                 return;
             }
@@ -55,7 +56,9 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
 
             if (groupedUpdateOperationsToPerform.Count == 0)
             {
-                await apiHandler.ClosePullRequest(ClosePullRequest.WithDependenciesRemoved(job));
+                var close = ClosePullRequest.WithDependenciesRemoved(job);
+                logger.Info(close.GetReport());
+                await apiHandler.ClosePullRequest(close);
                 continue;
             }
 
@@ -65,7 +68,9 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
                 .ToImmutableArray();
             if (missingDependencies.Length > 0)
             {
-                await apiHandler.ClosePullRequest(ClosePullRequest.WithDependencyRemoved(job));
+                var close = ClosePullRequest.WithDependencyRemoved(job);
+                logger.Info(close.GetReport());
+                await apiHandler.ClosePullRequest(close);
                 continue;
             }
 
@@ -82,7 +87,9 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
 
                 if (vulnerableDependenciesToUpdate.Length < dependencyGroupToUpdate.Value.Length)
                 {
-                    await apiHandler.ClosePullRequest(ClosePullRequest.WithUpToDate(job));
+                    var close = ClosePullRequest.WithUpToDate(job);
+                    logger.Info(close.GetReport());
+                    await apiHandler.ClosePullRequest(close);
                     return;
                 }
 
@@ -99,8 +106,7 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
                     if (!analysisResult.CanUpdate)
                     {
                         logger.Info($"No updatable version found for {dependency.Name} in {projectPath}.");
-                        await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
-                        return;
+                        continue;
                     }
 
                     logger.Info($"Attempting update of {dependency.Name} from {dependency.Version} to {analysisResult.UpdatedVersion} for {projectPath}.");
@@ -115,13 +121,8 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
 
                     if (updaterResult.UpdateOperations.Length == 0)
                     {
-                        // nothing was done, but we may have already handled it
-                        var alreadyHandled = updatedDependencies.Where(updated => updated.Name == dependencyName && updated.Version == analysisResult.UpdatedVersion).Any();
-                        if (!alreadyHandled)
-                        {
-                            await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
-                            return;
-                        }
+                        logger.Info($"No update operations performed for {dependency.Name}/{dependency.Version} in project {projectPath}.");
+                        continue;
                     }
 
                     var patchedUpdateOperations = RunWorker.PatchInOldVersions(updaterResult.UpdateOperations, projectDiscovery);
@@ -138,6 +139,21 @@ internal class RefreshSecurityUpdatePullRequestHandler : IUpdateHandler
                 }
             }
 
+            // ensure we did something
+            var updatesNotPerformed = jobDependencies
+                .Except(updatedDependencies.Select(d => d.Name), StringComparer.OrdinalIgnoreCase)
+                .Distinct()
+                .OrderBy(d => d, StringComparer.OrdinalIgnoreCase)
+                .ToArray();
+
+            if (updatesNotPerformed.Length > 0)
+            {
+                logger.Info($"No updates performed for: {string.Join(", ", updatesNotPerformed)}");
+                await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
+                continue;
+            }
+
+            // update or create
             var updatedDependencyFiles = await tracker.StopTrackingAsync();
             var rawDependencies = updatedDependencies.Select(d => new Dependency(d.Name, d.Version, DependencyType.Unknown)).ToArray();
             if (rawDependencies.Length > 0)

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/UpdateHandlers/RefreshVersionUpdatePullRequestHandler.cs

@@ -53,7 +53,9 @@ internal class RefreshVersionUpdatePullRequestHandler : IUpdateHandler
 
             if (relevantUpdateOperationsToPerform.Count == 0)
             {
-                await apiHandler.ClosePullRequest(ClosePullRequest.WithDependenciesRemoved(job));
+                var close = ClosePullRequest.WithDependenciesRemoved(job);
+                logger.Info(close.GetReport());
+                await apiHandler.ClosePullRequest(close);
                 continue;
             }
 
@@ -63,7 +65,9 @@ internal class RefreshVersionUpdatePullRequestHandler : IUpdateHandler
                 .ToImmutableArray();
             if (missingDependencies.Length > 0)
             {
-                await apiHandler.ClosePullRequest(ClosePullRequest.WithDependencyRemoved(job));
+                var close = ClosePullRequest.WithDependencyRemoved(job);
+                logger.Info(close.GetReport());
+                await apiHandler.ClosePullRequest(close);
                 continue;
             }
 
@@ -92,8 +96,7 @@ internal class RefreshVersionUpdatePullRequestHandler : IUpdateHandler
                     if (!analysisResult.CanUpdate)
                     {
                         logger.Info($"No updatable version found for {dependency.Name} in {projectPath}.");
-                        await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
-                        return;
+                        continue;
                     }
 
                     logger.Info($"Attempting update of {dependency.Name} from {dependency.Version} to {analysisResult.UpdatedVersion} for {projectPath}.");
@@ -108,8 +111,8 @@ internal class RefreshVersionUpdatePullRequestHandler : IUpdateHandler
 
                     if (updaterResult.UpdateOperations.Length == 0)
                     {
-                        await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
-                        return;
+                        logger.Info($"No update operations performed for {dependency.Name}/{dependency.Version} in project {projectPath}.");
+                        continue;
                     }
 
                     var patchedUpdateOperations = RunWorker.PatchInOldVersions(updaterResult.UpdateOperations, projectDiscovery);
@@ -126,6 +129,21 @@ internal class RefreshVersionUpdatePullRequestHandler : IUpdateHandler
                 }
             }
 
+            // ensure we did something
+            var updatesNotPerformed = jobDependencies
+                .Except(updatedDependencies.Select(d => d.Name), StringComparer.OrdinalIgnoreCase)
+                .Distinct()
+                .OrderBy(d => d, StringComparer.OrdinalIgnoreCase)
+                .ToArray();
+
+            if (updatesNotPerformed.Length > 0)
+            {
+                logger.Info($"No updates performed for: {string.Join(", ", updatesNotPerformed)}");
+                await apiHandler.ClosePullRequest(ClosePullRequest.WithUpdateNoLongerPossible(job));
+                continue;
+            }
+
+            // update or create
             var updatedDependencyFiles = await tracker.StopTrackingAsync();
             var rawDependencies = updatedDependencies.Select(d => new Dependency(d.Name, d.Version, DependencyType.Unknown)).ToArray();
             if (rawDependencies.Length > 0)

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Updater/SpecialImportsConditionPatcher.cs

@@ -2,6 +2,8 @@ using System.Collections.Immutable;
 
 using Microsoft.Language.Xml;
 
+using NuGetUpdater.Core.Utilities;
+
 namespace NuGetUpdater.Core.Updater
 {
     internal class SpecialImportsConditionPatcher : IDisposable
@@ -24,9 +26,20 @@ namespace NuGetUpdater.Core.Updater
 
         public SpecialImportsConditionPatcher(string projectFilePath)
         {
+            var hasBOM = false;
             _processor = new XmlFilePreAndPostProcessor(
-                getContent: () => File.ReadAllText(projectFilePath),
-                setContent: s => File.WriteAllText(projectFilePath, s),
+                getContent: () =>
+                {
+                    var content = File.ReadAllText(projectFilePath);
+                    var rawContent = File.ReadAllBytes(projectFilePath);
+                    hasBOM = rawContent.HasBOM();
+                    return content;
+                },
+                setContent: content =>
+                {
+                    var rawContent = content.SetBOM(hasBOM);
+                    File.WriteAllBytes(projectFilePath, rawContent);
+                },
                 nodeFinder: doc => doc.Descendants()
                     .Where(e => e.Name == "Import")
                     .Where(e =>

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/PullRequestTextTests.cs

@@ -402,6 +402,45 @@ public class PullRequestTextTests
             - Updated Package.B from 4.0.0 to 4.5.6 in a.txt
             """
         ];
+
+        // multiple updates to the same dependency
+        yield return
+        [
+            // job
+            FromCommitOptions(null),
+            // updateOperationsPerformed
+            new UpdateOperationBase[]
+            {
+                new DirectUpdate()
+                {
+                    DependencyName = "Some.Package",
+                    OldVersion = NuGetVersion.Parse("1.0.0"),
+                    NewVersion = NuGetVersion.Parse("1.2.3"),
+                    UpdatedFiles = ["a.txt"]
+                },
+                new DirectUpdate()
+                {
+                    DependencyName = "Some.Package",
+                    OldVersion = NuGetVersion.Parse("1.0.0"),
+                    NewVersion = NuGetVersion.Parse("1.2.3"),
+                    UpdatedFiles = ["b.txt"]
+                }
+            },
+            // dependencyGroupName
+            null,
+            // expectedTitle
+            "Bump Some.Package to 1.2.3",
+            // expectedCommitMessage
+            """
+            Bump Some.Package to 1.2.3
+            """,
+            // expectedBody
+            """
+            Performed the following updates:
+            - Updated Some.Package from 1.0.0 to 1.2.3 in a.txt
+            - Updated Some.Package from 1.0.0 to 1.2.3 in b.txt
+            """
+        ];
     }
 
     private static Job FromCommitOptions(CommitOptions? commitOptions)

data/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/UpdateHandlers/GroupUpdateAllVersionsHandlerTests.cs

@@ -633,4 +633,166 @@ public class GroupUpdateAllVersionsHandlerTests : UpdateHandlersTestsBase
             ]
         );
     }
+
+    [Fact]
+    public async Task GeneratesCreatePullRequest_Grouped_ExistingPrSkipped()
+    {
+        // two groups specified, but one has existing PR and is skipped
+        await TestAsync(
+            job: new Job()
+            {
+                Source = CreateJobSource("/src"),
+                DependencyGroups = [
+                    new()
+                    {
+                        Name = "test-group-1",
+                        Rules = new()
+                        {
+                            ["patterns"] = new[] { "Package.For.Group.One" },
+                        },
+                    },
+                    new()
+                    {
+                        Name = "test-group-2", // this group has an existing PR and will be skipped
+                        Rules = new()
+                        {
+                            ["patterns"] = new[] { "Package.For.Group.Two" },
+                        },
+                    },
+                ],
+                ExistingGroupPullRequests = [
+                    new()
+                    {
+                        DependencyGroupName = "test-group-2",
+                        Dependencies = [
+                            new()
+                            {
+                                DependencyName = "Package.For.Group.Two",
+                                DependencyVersion = NuGetVersion.Parse("2.0.1"),
+                            }
+                        ]
+                    }
+                ]
+            },
+            files: [
+                ("src/project.csproj", "initial contents"),
+            ],
+            discoveryWorker: TestDiscoveryWorker.FromResults(
+                ("/src", new WorkspaceDiscoveryResult()
+                {
+                    Path = "/src",
+                    Projects = [
+                        new()
+                        {
+                            FilePath = "project.csproj",
+                            Dependencies = [
+                                new("Package.For.Group.One", "1.0.0", DependencyType.PackageReference, TargetFrameworks: ["net9.0"]),
+                                new("Package.For.Group.Two", "2.0.0", DependencyType.PackageReference, TargetFrameworks: ["net9.0"]),
+                            ],
+                            ImportedFiles = [],
+                            AdditionalFiles = [],
+                        }
+                    ],
+                })
+            ),
+            analyzeWorker: new TestAnalyzeWorker(input =>
+            {
+                var repoRoot = input.Item1;
+                var discovery = input.Item2;
+                var dependencyInfo = input.Item3;
+                var newVersion = dependencyInfo.Name switch
+                {
+                    "Package.For.Group.One" => "1.0.1",
+                    "Package.For.Group.Two" => "2.0.1",
+                    _ => throw new NotImplementedException($"Test didn't expect to update dependency {dependencyInfo.Name}"),
+                };
+                return Task.FromResult(new AnalysisResult()
+                {
+                    CanUpdate = true,
+                    UpdatedVersion = newVersion,
+                    UpdatedDependencies = [],
+                });
+            }),
+            updaterWorker: new TestUpdaterWorker(async input =>
+            {
+                var repoRoot = input.Item1;
+                var workspacePath = input.Item2;
+                var dependencyName = input.Item3;
+                var previousVersion = input.Item4;
+                var newVersion = input.Item5;
+                var isTransitive = input.Item6;
+
+                await File.WriteAllTextAsync(Path.Join(repoRoot, workspacePath), $"updated contents for {dependencyName}/{newVersion}");
+
+                return new UpdateOperationResult()
+                {
+                    UpdateOperations = [new DirectUpdate() { DependencyName = dependencyName, NewVersion = NuGetVersion.Parse(newVersion), UpdatedFiles = [workspacePath] }],
+                };
+            }),
+            expectedUpdateHandler: GroupUpdateAllVersionsHandler.Instance,
+            expectedApiMessages: [
+                new IncrementMetric()
+                {
+                    Metric = "updater.started",
+                    Tags = new()
+                    {
+                        ["operation"] = "group_update_all_versions",
+                    }
+                },
+                new UpdatedDependencyList()
+                {
+                    Dependencies = [
+                        new()
+                        {
+                            Name = "Package.For.Group.One",
+                            Version = "1.0.0",
+                            Requirements = [
+                                new() { Requirement = "1.0.0", File = "/src/project.csproj", Groups = ["dependencies"] },
+                            ],
+                        },
+                        new()
+                        {
+                            Name = "Package.For.Group.Two",
+                            Version = "2.0.0",
+                            Requirements = [
+                                new() { Requirement = "2.0.0", File = "/src/project.csproj", Groups = ["dependencies"] },
+                            ],
+                        },
+                    ],
+                    DependencyFiles = ["/src/project.csproj"],
+                },
+                new CreatePullRequest()
+                {
+                    Dependencies = [
+                        new()
+                        {
+                            Name = "Package.For.Group.One",
+                            Version = "1.0.1",
+                            Requirements = [
+                                new() { Requirement = "1.0.1", File = "/src/project.csproj", Groups = ["dependencies"], Source = new() { SourceUrl = null } },
+                            ],
+                            PreviousVersion = "1.0.0",
+                            PreviousRequirements = [
+                                new() { Requirement = "1.0.0", File = "/src/project.csproj", Groups = ["dependencies"] },
+                            ],
+                        },
+                    ],
+                    UpdatedDependencyFiles = [
+                        new()
+                        {
+                            Directory = "/src",
+                            Name = "project.csproj",
+                            Content = "updated contents for Package.For.Group.One/1.0.1",
+                        },
+                    ],
+                    BaseCommitSha = "TEST-COMMIT-SHA",
+                    CommitMessage = RunWorkerTests.TestPullRequestCommitMessage,
+                    PrTitle = RunWorkerTests.TestPullRequestTitle,
+                    PrBody = RunWorkerTests.TestPullRequestBody,
+                    DependencyGroup = "test-group-1",
+                },
+                new MarkAsProcessed("TEST-COMMIT-SHA"),
+            ]
+        );
+    }
 }