// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
 
#nullable disable
 
using System.Threading.Tasks;
using Roslyn.Utilities;
using System.Threading;
 
namespace Microsoft.VisualStudio.LanguageServices.Implementation.Library.ObjectBrowser;
 
internal static class ObjectBrowserTaskExtensions
{
    /// <summary>
    /// Does a <see cref="Roslyn.Utilities.TaskExtensions.WaitAndGetResult{T}"/> for ObjectBrowser.
    /// </summary>
    /// <remarks>
    /// This function is the exact same as <see cref="Roslyn.Utilities.TaskExtensions.WaitAndGetResult{T}"/>, except it opts out
    /// of enforcement that it can be called on non-UI threads. ObjectBrowser, since it must implement a highly blocking API,
    /// has no choice but to use WaitAndGetResult in a bunch of places. But that's not a good reason to require the tests
    /// to have thread affinity, since the tests have no specific threading requirements. Thus, it's acceptable for ObjectBrowser
    /// to call the _CanCallOnBackground variant. We hope to audit _CanCallOnBackground periodically, and so rather than
    /// having to understand that each of those uses are ObjectBrowser and thus get a special pass.</remarks>
    public static T WaitAndGetResult_ObjectBrowser<T>(this Task<T> task, CancellationToken cancellationToken)
        => task.WaitAndGetResult_CanCallOnBackground(cancellationToken);
}