#65 Increased upload/download buffersize (#68)

* #65 Increased default buffer size used for upload/download to 64KB * Ensure ReportProgressChunkSize is lower than BufferSize. Improved ProgressionStream to send 100% event only once Added associated UTs * Throw proper assert if MEGAAPICLIENT_PASSWORD env variable is not set * Fixed other UTs
gpailler · Sep 1, 2017 · 4070ba7 · 4070ba7
1 parent 67be4e7
commit 4070ba7
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 13 deletions.
diff --git a/MegaApiClient.Tests/Context/AuthenticatedTestContext.cs b/MegaApiClient.Tests/Context/AuthenticatedTestContext.cs
@@ -10,8 +10,9 @@ public class AuthenticatedLoginTestsCollection : ICollectionFixture<Authenticate
 
   public class AuthenticatedTestContext : TestContext, IDisposable
   {
+    private const string MegaApiClientPasswordEnvironment = "MEGAAPICLIENT_PASSWORD";
     internal const string Username = "[email protected]";
-    internal static readonly string Password = Environment.GetEnvironmentVariable("MEGAAPICLIENT_PASSWORD");
+    internal static readonly string Password = Environment.GetEnvironmentVariable(MegaApiClientPasswordEnvironment);
 
     internal const string FileLink = "https://mega.nz/#!bkwkHC7D!AWJuto8_fhleAI2WG0RvACtKkL_s9tAtvBXXDUp2bQk";
     internal const string FolderLink = "https://mega.nz/#F!e1ogxQ7T!ee4Q_ocD1bSLmNeg9B6kBw";
@@ -84,7 +85,7 @@ public virtual void Dispose()
 
     protected override void ConnectClient(IMegaApiClient client)
     {
-      Assert.NotEmpty(Password);
+      Assert.False(string.IsNullOrEmpty(Password), $"Environment variable {MegaApiClientPasswordEnvironment} not set.");
       client.Login(Username, Password);
     }
 

diff --git a/MegaApiClient.Tests/DownloadUploadAuthenticatedAsync.cs b/MegaApiClient.Tests/DownloadUploadAuthenticatedAsync.cs
@@ -26,8 +26,10 @@ public override void Dispose()
     }
 
     [Theory]
-    [InlineData(null, 10L)]
-    [InlineData(10L, 65L)]
+    [InlineData(null, 8)]
+    [InlineData(1024 * 64, 8)]
+    [InlineData(100000, 4)]
+    [InlineData(200000, 2)]
     public void DownloadFileAsync_FromNode_Succeeds(long? reportProgressChunkSize, long expectedResult)
     {
       // Arrange
@@ -69,15 +71,16 @@ public void DownloadFileAsync_FromLink_Succeeds()
 
       // Assert
       Assert.True(result);
-      Assert.Equal(10, eventTester.Calls);
+      Assert.Equal(8, eventTester.Calls);
       this.AreFileEquivalent(this.GetAbsoluteFilePath(expectedResultFile), outputFile);
     }
 
-    [Fact]
-    public void UploadStreamAsync_DownloadLink_Succeeds()
+    [Theory]
+    [InlineData(123456, 2)]
+    public void UploadStreamAsync_DownloadLink_Succeeds(int dataSize, int expectedProgressionCalls)
     {
       //Arrange
-      byte[] data = new byte[123456];
+      byte[] data = new byte[dataSize];
       this.random.NextBytes(data);
 
       INode parent = this.GetNode(NodeType.Root);
@@ -105,7 +108,7 @@ public void UploadStreamAsync_DownloadLink_Succeeds()
         // Assert
         Assert.True(result);
         Assert.NotNull(task.Result);
-        Assert.Equal(3, eventTester.Calls);
+        Assert.Equal(expectedProgressionCalls, eventTester.Calls);
 
         Uri uri = this.context.Client.GetDownloadLink(task.Result);
         stream.Position = 0;

diff --git a/MegaApiClient.Tests/Options_Tests.cs b/MegaApiClient.Tests/Options_Tests.cs
@@ -0,0 +1,27 @@
+namespace CG.Web.MegaApiClient.Tests
+{
+  using System;
+  using CG.Web.MegaApiClient.Tests.Context;
+  using Xunit;
+  using Xunit.Abstractions;
+
+  [Collection("NotLoggedTests")]
+  public class Options_Tests : TestsBase, IDisposable
+  {
+    public Options_Tests(NotLoggedTestContext context, ITestOutputHelper testOutputHelper)
+      : base(context, testOutputHelper)
+    {
+    }
+
+    public void Dispose()
+    {
+    }
+
+    [Fact]
+    public void ReportProgressChunkSize_LowerThan_BufferSize_Throws()
+    {
+      var bufferSize = new Options().BufferSize;
+      Assert.Throws<ArgumentException>("reportProgressChunkSize", () => new Options(reportProgressChunkSize: bufferSize - 1));
+    }
+  }
+}
diff --git a/MegaApiClient/Options.cs b/MegaApiClient/Options.cs
@@ -1,5 +1,7 @@
 namespace CG.Web.MegaApiClient
 {
+  using System;
+
   public class Options
   {
     public const string DefaultApplicationKey = "axhQiYyQ";
@@ -9,11 +11,11 @@ public class Options
     public const int DefaultApiRequestDelay = 500;
     public const float DefaultApiRequestDelayExponentialFactor = 1.5f;
 
-    public const int DefaultBufferSize = 8192;
+    public const int DefaultBufferSize = 1024 * 64;
     public const int DefaultChunksPackSize = 1024 * 1024;
 
 #if ASYNC
-    public const long DefaultReportProgressChunkSize = 1024 * 50;
+    public const long DefaultReportProgressChunkSize = DefaultBufferSize;
 #endif
 
     public Options(
@@ -41,6 +43,12 @@ public Options(
       this.ChunksPackSize = chunksPackSize;
 
 #if ASYNC
+      if (reportProgressChunkSize < this.BufferSize)
+      {
+        throw new ArgumentException(
+          $"ReportProgressChunkSize ({reportProgressChunkSize}) cannot have a value lower than BufferSize ({bufferSize})",
+          nameof(reportProgressChunkSize));
+      }
       this.ReportProgressChunkSize = reportProgressChunkSize;
 #endif
     }
@@ -76,4 +84,4 @@ public Options(
     public long ReportProgressChunkSize { get; internal set;}
 #endif
   }
-}
+}
diff --git a/MegaApiClient/Stream/ProgressionStream.cs b/MegaApiClient/Stream/ProgressionStream.cs
@@ -35,7 +35,12 @@ public override void Write(byte[] buffer, int offset, int count)
     protected override void Dispose(bool disposing)
     {
       base.Dispose(disposing);
-      this.progress.Report(100);
+
+      // Report 100% progress only if it was not already sent
+      if (this.chunkSize != 0)
+      {
+        this.progress.Report(100);
+      }
     }
 
     #region Forwards