Utilities.cs

Go to the documentation of this file.

using System;
using System.IO;
using System.Text;
 
using AnalyzeRe.APITypes;
 
namespace AnalyzeRe.LargeDataUpload
{
    public static class Utilities
    {
        internal const int DEFAULT_BUFFER_SIZE = 4096; // 4K bytes
 
        public static bool EnableDebugLogging
        {
            get => _enableDebugLogging;
            set
            {
                _enableDebugLogging = value;
#if !DEBUG
                throw new InvalidOperationException("Currently, this feature cannot be used " +
                    "as it makes use of Debug.WriteLine, which is compiled out in Release mode. " +
                    "To make use of this you will need to reference the Debug version of " +
                    "this library, which should be available on MyGet at: " +
                    "https://www.myget.org/feed/analyzere/package/nuget/AnalyzeRe.Client");
#endif
            }
        }
        private static bool _enableDebugLogging;
 
#region Public Methods
        public static MemoryStream GetStringStream(string input)
        {
            return new MemoryStream(Encoding.UTF8.GetBytes(input));
        }
 
        public static StatusResponse PollUntilDataProcessed(
            LargeDataSubResource dataEndpoint,
            Parameters parameters = null)
        {
            return PollUntilDataProcessed(dataEndpoint,
                parameters == null ? new AsyncParameters() : new AsyncParameters(parameters));
        }
 
        public static StatusResponse PollUntilDataProcessed(
            LargeDataSubResource dataEndpoint,
            AsyncParameters parameters)
        {
            if(dataEndpoint.Owner is IAPIResource asResource)
                API.ValidateExistingResource(asResource);
            int polling_timeout = parameters.commit_polling_options.MaxPollTotalTime;
            try
            {
                DateTime startTime = DateTime.UtcNow;
                return API.PollUntil(
                    () => dataEndpoint.status.Get(timeout: polling_timeout -
                        (int)(DateTime.UtcNow - startTime).TotalMilliseconds),
                    status =>
                    {
                        parameters.OnProgressUpdate?.Invoke(status);
                        return !status.status.IsBusy();
                    }, parameters.commit_polling_options);
            }
            // Catch NotWaitingException and re-raise as a timeout exception.
            catch (NotWaitingException ex)
            {
                throw new RequestTimeoutException("The server took too long to commit the data, " +
                    $"the timeout was exceeded. ({polling_timeout / (1000d * 60d)} minutes)", ex,
                    ex.RestResponse);
            }
        }
#endregion Public Methods
 
#region Internal Helper Methods
        internal static void CheckForCancellation(AsyncParameters parameters)
        {
            if (parameters.commit_polling_options?.CancellationToken?.IsCancellationRequested ?? false)
                throw new OperationCanceledException(
                    "The upload process has been cancelled by the user.");
        }
 
        internal static FileStream OpenReadOnlyFileStream(string filePath)
        {
            return new FileStream(filePath, FileMode.Open, FileAccess.Read,
                FileShare.ReadWrite, DEFAULT_BUFFER_SIZE);
        }
#endregion Internal Helper Methods
    }
}