ExtensionMethods.IStoredAPIResource_WithStatus.cs

Go to the documentation of this file.

using System.Diagnostics;
 
using AnalyzeRe.APITypes;
using AnalyzeRe.Rest;
using AnalyzeRe.Utilities;
 
namespace AnalyzeRe
{
    public static partial class ExtensionMethods
    {
        private struct StatusStruct
        {
            public TaskStatus status { get; set; }
            public string status_message { get; set; }
        }
 
        private static readonly string[] PollFields =
        {
            nameof(IStoredAPIResource_WithStatus.status),
            nameof(IStoredAPIResource_WithStatus.status_message)
        };
 
        public static T PollUntilReady<T>(this T resource, PollingOptions pollingOptions = null)
            where T : IStoredAPIResource_WithStatus
        {
            API.ValidateExistingResource(resource);
            if (resource.status.IsProcessingComplete())
                Debug.WriteLine($"{resource.GetType().NiceTypeName()} {resource.id} already " +
                    $"has a finalized status of \"{resource.status}\"!");
            else
            {
                StatusStruct lastStatus = new StatusStruct
                {
                    status = resource.status,
                    status_message = resource.status_message
                };
                try
                {
                    RequestParameters requestParams = API.Parameters.Fields(PollFields);
                    lastStatus = API.PollUntil(
                        () => lastStatus = resource.Get_AsType<StatusStruct>(requestParams),
                        status => !status.status.IsBusy(),
                        pollingOptions);
                }
                // Intercept the NotWaitingException and re-raise with a more meaningful message.
                catch (NotWaitingException ex)
                {
                    throw new NotWaitingException(
                        $"The {resource.GetType().NiceTypeName()} {resource.id} is still " +
                        $"{(lastStatus.status == TaskStatus.Queued ? "queued for " : "")}processing " +
                        $"after {ex.TimeWaited} seconds, which exceeds the timeout of {ex.MaxWaitTime}ms.",
                        ex.TimeWaited, ex.QueuePosition, ex.RetryTime, ex.MaxWaitTime, ex, ex.RestResponse);
                }
                finally
                {
                    // Update the original resource with the last available status and status_message
                    resource.status = lastStatus.status;
                    resource.status_message = lastStatus.status_message;
                }
            }
 
            if (resource.status == TaskStatus.Success)
                return resource;
 
            string errorMessage = $"The {resource.GetType().NiceTypeName()} {resource.id} " +
                (resource.status.IsError() ? "failed processing." :
                    $"is no longer processing, but the returned status of {resource.status} is not expected.") +
                (resource.status_message == null ? " No message was provided." :
                    $" The following message was provided: {resource.status_message}");
            throw new APIRequestException(errorMessage);
        }
    }
}