Truncate titles (#371)

* Fixes #370

* Rename helper function

Author: IEvangelist

actions/sequester/Quest2GitHub.Tests/GetIterationTests.cs

@@ -57,7 +57,6 @@ public static void ValidIterationReturnsCorrectIteration()
         var actual = IssueExtensions.ProjectIteration("Feb", 2024, _allIterations);
         Assert.Equal("""Content\Germanium\FY24Q3\02 Feb""", actual?.Path);
     }
-
 }
 
 

actions/sequester/Quest2GitHub.Tests/QuestWorkItemTests.cs

@@ -0,0 +1,29 @@
+using Quest2GitHub.Models;
+
+namespace Quest2GitHub.Tests;
+
+public class QuestWorkItemTests
+{
+    [Theory]
+    [InlineData("short title")]
+    [InlineData("A really long title, in fact, it's so long that we know it will exceed the max length of 255 characters imposed by the Azure DevOps API, thus proving our point, and being truncated in the object's .ctor. Isn't programming fun?! Wow, this title is really long...I hope we're done typing soon.")]
+    public void QuestItemConstructorEnsuresTitleIsTruncated(string title)
+    {
+        var sut = new QuestWorkItem
+        {
+            Id = 777,
+            ParentWorkItemId = 100,
+            ParentRelationIndex = 1,
+            Title = title, // Truncated on init
+            State = "Wisconsin 🧀",
+            Description = "Test description",
+            AreaPath = "Test/Area",
+            IterationPath = "Test/Path",
+            AssignedToId = Guid.NewGuid(),
+            StoryPoints = 1,
+            Tags = []
+        };
+
+        Assert.True(sut.Title.Length < 256);
+    }
+}

actions/sequester/Quest2GitHub/Models/QuestWorkItem.cs

@@ -10,6 +10,8 @@ public class QuestWorkItem
     // fails, stop sending invalid requests.
     private static bool? s_linkedGitHubRepo;
 
+    private string _title = "";
+
     /// <summary>
     /// The Work item ID
     /// </summary>
@@ -21,7 +23,11 @@ public class QuestWorkItem
     /// <remarks>
     /// This is retrieved as /fields/System.Title
     /// </remarks>
-    public required string Title { get; init; }
+    public required string Title
+    {
+        get => _title;
+        init => _title = TruncateTitleWhenLongerThanMax(value);
+    }
 
     // /fields/System.Description
     public required string Description { get; init; }
@@ -139,7 +145,7 @@ public static async Task<QuestWorkItem> CreateWorkItemAsync(QuestIssueOrPullRequ
                 Operation = Op.Add,
                 Path = "/fields/System.Title",
                 From = default,
-                Value = issue.Title
+                Value = TruncateTitleWhenLongerThanMax(issue.Title)
             },
             new() {
                 Operation = Op.Add,
@@ -278,6 +284,19 @@ public static async Task<QuestWorkItem> CreateWorkItemAsync(QuestIssueOrPullRequ
         return newItem;
     }
 
+    private static string TruncateTitleWhenLongerThanMax(string title)
+    {
+        // https://learn.microsoft.com/azure/devops/boards/work-items/about-work-items?view=azure-devops&tabs=agile-process#common-work-tracking-fields
+        const int MaxTitleLength = 255;
+
+        if (title is { Length: > MaxTitleLength })
+        {
+            return title[0..MaxTitleLength];
+        }
+
+        return title;
+    }
+
     public static string BuildDescriptionFromIssue(QuestIssueOrPullRequest issue, string? requestLabelNodeId)
     {
         var body = new StringBuilder($"<p>Imported from: {issue.LinkText}</p>");