Merge pull request #13363 from dependabot/dev/brettfo/nuget-job-file-shape

allow new format for existing pull requests

Author: brettfo

nuget/helpers/lib/NuGetUpdater/NuGetUpdater.Core.Test/Run/SerializationTests.cs

@@ -407,7 +407,7 @@ public void DeserializeDependencyGroups()
     }
 
     [Fact]
-    public void DeserializeExistingPullRequests()
+    public void DeserializeExistingPullRequestsOldFormat()
     {
         var jsonWrapperJson = """
             {
@@ -429,6 +429,41 @@ public void DeserializeExistingPullRequests()
             """;
         var jobWrapper = RunWorker.Deserialize(jsonWrapperJson)!;
         Assert.Single(jobWrapper.Job.ExistingPullRequests);
+        Assert.Null(jobWrapper.Job.ExistingPullRequests[0].PrNumber);
+        Assert.Single(jobWrapper.Job.ExistingPullRequests[0].Dependencies);
+        Assert.Equal("Some.Package", jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].DependencyName);
+        Assert.Equal(NuGetVersion.Parse("1.2.3"), jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].DependencyVersion);
+        Assert.False(jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].DependencyRemoved);
+        Assert.Null(jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].Directory);
+    }
+
+    [Fact]
+    public void DeserializeExistingPullRequestsNewFormat()
+    {
+        var jsonWrapperJson = """
+            {
+                "job": {
+                    "source": {
+                        "provider": "github",
+                        "repo": "some/repo"
+                    },
+                    "existing-pull-requests": [
+                        {
+                            "pr-number": 123,
+                            "dependencies": [
+                                {
+                                    "dependency-name": "Some.Package",
+                                    "dependency-version": "1.2.3"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            }
+            """;
+        var jobWrapper = RunWorker.Deserialize(jsonWrapperJson)!;
+        Assert.Single(jobWrapper.Job.ExistingPullRequests);
+        Assert.Equal(123, jobWrapper.Job.ExistingPullRequests[0].PrNumber);
         Assert.Single(jobWrapper.Job.ExistingPullRequests[0].Dependencies);
         Assert.Equal("Some.Package", jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].DependencyName);
         Assert.Equal(NuGetVersion.Parse("1.2.3"), jobWrapper.Job.ExistingPullRequests[0].Dependencies[0].DependencyVersion);

nuget/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/ApiModel/PullRequest.cs

@@ -1,8 +1,12 @@
 using System.Collections.Immutable;
+using System.Text.Json.Serialization;
 
 namespace NuGetUpdater.Core.Run.ApiModel;
 
 public record PullRequest
 {
+    [JsonPropertyName("pr-number")]
+    public int? PrNumber { get; init; } = null;
+    [JsonPropertyName("dependencies")]
     public ImmutableArray<PullRequestDependency> Dependencies { get; init; } = [];
 }

nuget/helpers/lib/NuGetUpdater/NuGetUpdater.Core/Run/PullRequestConverter.cs

@@ -1,4 +1,4 @@
-using System.Collections.Immutable;
+using System.Collections.Immutable;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
@@ -10,16 +10,36 @@ public class PullRequestConverter : JsonConverter<PullRequest>
 {
     public override PullRequest? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        if (reader.TokenType != JsonTokenType.StartArray)
+        PullRequest? result;
+        switch (reader.TokenType)
         {
-            throw new JsonException("expected array of pull request dependencies");
+            case JsonTokenType.StartArray:
+                // old format, array of arrays of dependencies
+                var dependencies = JsonSerializer.Deserialize<ImmutableArray<PullRequestDependency>>(ref reader, options);
+                result = new PullRequest()
+                {
+                    Dependencies = dependencies
+                };
+                break;
+            case JsonTokenType.StartObject:
+                // new format, direct object
+                // use the same deserializer options but exclude this special converter
+                var optionsWithoutThisCustomConverter = new JsonSerializerOptions(options);
+                for (int i = optionsWithoutThisCustomConverter.Converters.Count - 1; i >= 0; i--)
+                {
+                    if (optionsWithoutThisCustomConverter.Converters[i].GetType() == typeof(PullRequestConverter))
+                    {
+                        optionsWithoutThisCustomConverter.Converters.RemoveAt(i);
+                    }
+                }
+
+                result = JsonSerializer.Deserialize<PullRequest>(ref reader, optionsWithoutThisCustomConverter);
+                break;
+            default:
+                throw new JsonException("expected pull request object or array of pull request dependencies");
         }
 
-        var dependencies = JsonSerializer.Deserialize<ImmutableArray<PullRequestDependency>>(ref reader, options);
-        return new PullRequest()
-        {
-            Dependencies = dependencies
-        };
+        return result;
     }
 
     public override void Write(Utf8JsonWriter writer, PullRequest value, JsonSerializerOptions options)