Rename Interaction<T> to InteractionReference<T>, add Id property and DebuggerDisplayAttribute

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>

Author: Copilot

playground/Stress/Stress.AppHost/InteractionCommands.cs

@@ -592,7 +592,7 @@ public static IResourceBuilder<T> AddInteractionCommands<T>(this IResourceBuilde
         return resource;
     }
 
-    private static void RunInteractionWithDismissValues<T>(string title, Func<bool?, string, Interaction<T>> action)
+    private static void RunInteractionWithDismissValues<T>(string title, Func<bool?, string, InteractionReference<T>> action)
     {
         // Don't wait for interactions to complete, i.e. await tasks.
         _ = action(null, $"{title} - ShowDismiss = null");

src/Aspire.Hosting/IInteractionService.cs

@@ -32,9 +32,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the message box interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user confirmed, <c>false</c> otherwise.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user confirmed, <c>false</c> otherwise.
     /// </returns>
-    Interaction<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Prompts the user with a message box dialog.
@@ -44,9 +44,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the message box interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user accepted, <c>false</c> otherwise.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user accepted, <c>false</c> otherwise.
     /// </returns>
-    Interaction<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Prompts the user for a single text input.
@@ -58,9 +58,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the input dialog interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's input.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's input.
     /// </returns>
-    Interaction<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Prompts the user for a single input using a specified <see cref="InteractionInput"/>.
@@ -71,9 +71,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the input dialog interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's input.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's input.
     /// </returns>
-    Interaction<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Prompts the user for multiple inputs.
@@ -84,9 +84,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the input dialog interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's inputs as an <see cref="InteractionInputCollection"/>.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing the user's inputs as an <see cref="InteractionInputCollection"/>.
     /// </returns>
-    Interaction<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Prompts the user with a notification.
@@ -96,9 +96,9 @@ public interface IInteractionService
     /// <param name="options">Optional configuration for the notification interaction.</param>
     /// <param name="cancellationToken">A token to cancel the operation.</param>
     /// <returns>
-    /// An <see cref="Interaction{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user accepted, <c>false</c> otherwise.
+    /// An <see cref="InteractionReference{TResult}"/> that can be awaited to get an <see cref="InteractionResult{T}"/> containing <c>true</c> if the user accepted, <c>false</c> otherwise.
     /// </returns>
-    Interaction<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default);
+    InteractionReference<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default);
 }
 
 internal record QueueLoadOptions(
@@ -700,22 +700,30 @@ internal InteractionResult(T? data, bool canceled)
 /// </summary>
 /// <typeparam name="TResult">The type of the result returned by the interaction.</typeparam>
 [Experimental(InteractionService.DiagnosticId, UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
-public sealed class Interaction<TResult>
+[DebuggerDisplay("Id = {Id}, IsCompleted = {IsCompleted}")]
+public sealed class InteractionReference<TResult>
 {
+    private static int s_nextId;
     private readonly Task<InteractionResult<TResult>> _resultTask;
     private readonly CancellationTokenSource _cancellationTokenSource;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="Interaction{TResult}"/> class.
+    /// Initializes a new instance of the <see cref="InteractionReference{TResult}"/> class.
     /// </summary>
     /// <param name="resultTask">The task that represents the asynchronous operation.</param>
     /// <param name="cancellationTokenSource">The cancellation token source for the interaction.</param>
-    public Interaction(Task<InteractionResult<TResult>> resultTask, CancellationTokenSource cancellationTokenSource)
+    public InteractionReference(Task<InteractionResult<TResult>> resultTask, CancellationTokenSource cancellationTokenSource)
     {
+        Id = Interlocked.Increment(ref s_nextId);
         _resultTask = resultTask;
         _cancellationTokenSource = cancellationTokenSource;
     }
 
+    /// <summary>
+    /// Gets the unique identifier for this interaction.
+    /// </summary>
+    public int Id { get; }
+
     /// <summary>
     /// Gets a value indicating whether the interaction has completed.
     /// </summary>

src/Aspire.Hosting/InteractionService.cs

@@ -55,7 +55,7 @@ public bool IsAvailable
         }
     }
 
-    public Interaction<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         options ??= MessageBoxInteractionOptions.CreateDefault();
         options.Intent = MessageIntent.Confirmation;
@@ -65,7 +65,7 @@ public Interaction<bool> PromptConfirmationAsync(string title, string message, M
         return PromptMessageBoxCore(title, message, options, cancellationToken);
     }
 
-    public Interaction<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         options ??= MessageBoxInteractionOptions.CreateDefault();
         options.ShowSecondaryButton ??= false;
@@ -74,7 +74,7 @@ public Interaction<bool> PromptMessageBoxAsync(string title, string message, Mes
         return PromptMessageBoxCore(title, message, options, cancellationToken);
     }
 
-    private Interaction<bool> PromptMessageBoxCore(string title, string message, MessageBoxInteractionOptions options, CancellationToken cancellationToken)
+    private InteractionReference<bool> PromptMessageBoxCore(string title, string message, MessageBoxInteractionOptions options, CancellationToken cancellationToken)
     {
         EnsureServiceAvailable();
 
@@ -105,10 +105,10 @@ private Interaction<bool> PromptMessageBoxCore(string title, string message, Mes
             }
         }, interactionCts.Token);
 
-        return new Interaction<bool>(resultTask, interactionCts);
+        return new InteractionReference<bool>(resultTask, interactionCts);
     }
 
-    public Interaction<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         var interaction = PromptInputsAsync(title, message, [new InteractionInput { Name = InteractionHelpers.LabelToName(inputLabel), InputType = InputType.Text, Label = inputLabel, Required = true, Placeholder = placeHolder }], options, cancellationToken);
 
@@ -125,10 +125,10 @@ public Interaction<InteractionInput> PromptInputAsync(string title, string? mess
         }, cancellationToken);
 
         // Use the same CTS from the inputs interaction
-        return new Interaction<InteractionInput>(resultTask, interaction.GetCancellationTokenSource());
+        return new InteractionReference<InteractionInput>(resultTask, interaction.GetCancellationTokenSource());
     }
 
-    public Interaction<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         var interaction = PromptInputsAsync(title, message, [input], options, cancellationToken);
 
@@ -145,10 +145,10 @@ public Interaction<InteractionInput> PromptInputAsync(string title, string? mess
         }, cancellationToken);
 
         // Use the same CTS from the inputs interaction
-        return new Interaction<InteractionInput>(resultTask, interaction.GetCancellationTokenSource());
+        return new InteractionReference<InteractionInput>(resultTask, interaction.GetCancellationTokenSource());
     }
 
-    public Interaction<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         EnsureServiceAvailable();
 
@@ -247,10 +247,10 @@ public Interaction<InteractionInputCollection> PromptInputsAsync(string title, s
             }
         }, interactionCts.Token);
 
-        return new Interaction<InteractionInputCollection>(resultTask, interactionCts);
+        return new InteractionReference<InteractionInputCollection>(resultTask, interactionCts);
     }
 
-    public Interaction<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default)
+    public InteractionReference<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default)
     {
         EnsureServiceAvailable();
 
@@ -280,7 +280,7 @@ public Interaction<bool> PromptNotificationAsync(string title, string message, N
             }
         }, interactionCts.Token);
 
-        return new Interaction<bool>(resultTask, interactionCts);
+        return new InteractionReference<bool>(resultTask, interactionCts);
     }
 
     // For testing.

src/Shared/RequiredCommandValidator.cs

@@ -26,7 +26,7 @@ internal abstract class RequiredCommandValidator(IInteractionService interaction
     private readonly IInteractionService _interactionService = interactionService;
     private readonly ILogger _logger = logger;
 
-    private Interaction<bool>? _notificationTask;
+    private InteractionReference<bool>? _notificationTask;
     private string? _notificationMessage;
     private bool _throwOnFailure = true;
 

tests/Aspire.Hosting.DevTunnels.Tests/DevTunnelCliInstallationManagerTests.cs

@@ -48,32 +48,32 @@ private sealed class TestInteractionService : IInteractionService
     {
         public bool IsAvailable => true;
 
-        public Interaction<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<bool> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }
 
-        public Interaction<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }
 
-        public Interaction<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<InteractionInput> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }
 
-        public Interaction<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<InteractionInputCollection> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }
 
-        public Interaction<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<bool> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }
 
-        public Interaction<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        public InteractionReference<bool> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default)
         {
             throw new NotImplementedException();
         }

tests/Shared/AsyncTestHelpers.cs

@@ -125,7 +125,7 @@ public static Task<T> DefaultTimeout<T>(this ValueTask<T> task, TimeSpan timeout
 
 #pragma warning disable ASPIREINTERACTION001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
-    public static Task<Aspire.Hosting.InteractionResult<T>> DefaultTimeout<T>(this Aspire.Hosting.Interaction<T> interaction, int milliseconds = -1, [CallerFilePath] string? filePath = null, [CallerLineNumber] int lineNumber = default)
+    public static Task<Aspire.Hosting.InteractionResult<T>> DefaultTimeout<T>(this Aspire.Hosting.InteractionReference<T> interaction, int milliseconds = -1, [CallerFilePath] string? filePath = null, [CallerLineNumber] int lineNumber = default)
     {
         if (milliseconds == -1)
         {
@@ -135,7 +135,7 @@ public static Task<T> DefaultTimeout<T>(this ValueTask<T> task, TimeSpan timeout
         return interaction.GetResultAsync().TimeoutAfter(TimeSpan.FromMilliseconds(milliseconds), filePath, lineNumber);
     }
 
-    public static Task<Aspire.Hosting.InteractionResult<T>> DefaultTimeout<T>(this Aspire.Hosting.Interaction<T> interaction, TimeSpan timeout, [CallerFilePath] string? filePath = null, [CallerLineNumber] int lineNumber = default)
+    public static Task<Aspire.Hosting.InteractionResult<T>> DefaultTimeout<T>(this Aspire.Hosting.InteractionReference<T> interaction, TimeSpan timeout, [CallerFilePath] string? filePath = null, [CallerLineNumber] int lineNumber = default)
     {
         return interaction.GetResultAsync().TimeoutAfter(timeout, filePath, lineNumber);
     }