Fix JoinableTaskContext.serializedTasks leak

The collection of joinable tasks for which an ID is requested grew forever. The code that should purge completed tasks from the collection was never executing because the `TaskId` property is programmed to return `null` for completed tasks, and we query the property directly *after* setting the task as completed. The fix then is simple: fetch the TaskId value *first* and *then* set the `JoinableTask` as completed.
microsoft · Aug 13, 2024 · a47707d · a47707d
1 parent 2f9e9df
commit a47707d
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs
@@ -927,10 +927,14 @@ internal void Complete(Task wrappedTask)
             {
                 if (!this.IsCompleteRequested)
                 {
+                    // This must be done *before* setting IsCompleteRequested so that the TaskId property will still return the value we need.
+                    ulong? taskId = this.token?.TaskId;
+
                     this.IsCompleteRequested = true;
-                    if (this.token?.TaskId is ulong taskId)
+
+                    if (taskId.HasValue)
                     {
-                        this.JoinableTaskContext.RemoveSerializableIdentifier(taskId);
+                        this.JoinableTaskContext.RemoveSerializableIdentifier(taskId.Value);
                     }
 
                     if (this.mainThreadQueue is object)