From bbe2eb20dff980c55f9c480158ceb90046935c34 Mon Sep 17 00:00:00 2001
From: supakeen <39536295+supakeen@users.noreply.github.com>
Date: Sun, 4 Oct 2020 12:32:07 +0200
Subject: [PATCH] Provide a configurable progressInterval. (#15477)

---
 changelog.md                |  3 +++
 lib/pure/asyncftpclient.nim | 17 +++++++++++------
 2 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/changelog.md b/changelog.md
index 5a439285ce..e905dd941b 100644
--- a/changelog.md
+++ b/changelog.md
@@ -209,6 +209,9 @@
   is similar to procs such as `sets.toHashSet` and `tables.toTable`. Previously,
   it was necessary to create an empty IntSet and add items manually.
 
+- Added `progressInterval` argument to `asyncftpclient.newAsyncFtpClient` to control the interval
+  at which progress callbacks are called.
+
 
 ## Language changes
 
diff --git a/lib/pure/asyncftpclient.nim b/lib/pure/asyncftpclient.nim
index ba565059dd..b538e10c91 100644
--- a/lib/pure/asyncftpclient.nim
+++ b/lib/pure/asyncftpclient.nim
@@ -59,6 +59,9 @@
 ## by specifying a ``onProgressChanged`` procedure to the ``store`` or
 ## ``retrFile`` procedures.
 ##
+## Procs that take an ``onProgressChanged`` callback will call this every
+## ``progressInterval`` milliseconds.
+##
 ## .. code-block::nim
 ##    import asyncdispatch, asyncftpclient
 ##
@@ -68,7 +71,7 @@
 ##      echo("Current speed: ", speed, " kb/s")
 ##
 ##    proc main() {.async.} =
-##      var ftp = newAsyncFtpClient("example.com", user = "test", pass = "test")
+##      var ftp = newAsyncFtpClient("example.com", user = "test", pass = "test", progressInterval = 500)
 ##      await ftp.connect()
 ##      await ftp.store("file.txt", "/home/user/file.txt", onProgressChanged)
 ##      echo("File finished uploading")
@@ -85,6 +88,7 @@ type
     user*, pass*: string
     address*: string
     port*: Port
+    progressInterval: int
     jobInProgress*: bool
     job*: FtpJob
     dsockConnected*: bool
@@ -303,7 +307,7 @@ proc getFile(ftp: AsyncFtpClient, file: File, total: BiggestInt,
   assert ftp.dsockConnected
   var progress = 0
   var progressInSecond = 0
-  var countdownFut = sleepAsync(1000)
+  var countdownFut = sleepAsync(ftp.progressInterval)
   var dataFut = ftp.dsock.recv(BufferSize)
   while ftp.dsockConnected:
     await dataFut or countdownFut
@@ -311,7 +315,7 @@ proc getFile(ftp: AsyncFtpClient, file: File, total: BiggestInt,
       asyncCheck onProgressChanged(total, progress,
           progressInSecond.float)
       progressInSecond = 0
-      countdownFut = sleepAsync(1000)
+      countdownFut = sleepAsync(ftp.progressInterval)
 
     if dataFut.finished:
       let data = dataFut.read
@@ -359,7 +363,7 @@ proc doUpload(ftp: AsyncFtpClient, file: File,
   var data = newString(4000)
   var progress = 0
   var progressInSecond = 0
-  var countdownFut = sleepAsync(1000)
+  var countdownFut = sleepAsync(ftp.progressInterval)
   var sendFut: Future[void] = nil
   while ftp.dsockConnected:
     if sendFut == nil or sendFut.finished:
@@ -380,7 +384,7 @@ proc doUpload(ftp: AsyncFtpClient, file: File,
     if countdownFut.finished:
       asyncCheck onProgressChanged(total, progress, progressInSecond.float)
       progressInSecond = 0
-      countdownFut = sleepAsync(1000)
+      countdownFut = sleepAsync(ftp.progressInterval)
 
     await countdownFut or sendFut
 
@@ -415,13 +419,14 @@ proc removeDir*(ftp: AsyncFtpClient, dir: string) {.async.} =
   assertReply(await ftp.send("RMD " & dir), "250")
 
 proc newAsyncFtpClient*(address: string, port = Port(21),
-    user, pass = ""): AsyncFtpClient =
+    user, pass = "", progressInterval: int = 1000): AsyncFtpClient =
   ## Creates a new ``AsyncFtpClient`` object.
   new result
   result.user = user
   result.pass = pass
   result.address = address
   result.port = port
+  result.progressInterval = progressInterval
   result.dsockConnected = false
   result.csock = newAsyncSocket()