[Sources] Add optional progress bar to git clone (#240)

Author: giordano

Manifest.toml

@@ -22,6 +22,10 @@ version = "0.7.0"
 deps = ["Printf"]
 uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
 
+[[deps.Distributed]]
+deps = ["Random", "Serialization", "Sockets"]
+uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+
 [[deps.Downloads]]
 deps = ["ArgTools", "LibCURL", "NetworkOptions"]
 uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
@@ -115,6 +119,12 @@ version = "1.2.5"
 deps = ["Unicode"]
 uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 
+[[deps.ProgressMeter]]
+deps = ["Distributed", "Printf"]
+git-tree-sha1 = "d7a7aef8f8f2d537104f170139553b14dfe39fe9"
+uuid = "92933f4c-e287-5a05-a399-4b506db050ca"
+version = "1.7.2"
+
 [[deps.REPL]]
 deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
 uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

Project.toml

@@ -1,7 +1,7 @@
 name = "BinaryBuilderBase"
 uuid = "7f725544-6523-48cd-82d1-3fa08ff4056e"
 authors = ["Elliot Saba <staticfloat@gmail.com>"]
-version = "1.9.0"
+version = "1.10.0"
 
 [deps]
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
@@ -15,6 +15,7 @@ Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 OutputCollectors = "6c11c7d4-943b-4e2b-80de-f2cfc2930a8c"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 Scratch = "6c6a2e73-6563-6170-7368-637461726353"
@@ -30,6 +31,7 @@ CodecZlib = "0.5, 0.6, 0.7"
 JSON = "0.21"
 OrderedCollections = "1.4.1"
 OutputCollectors = "0.1"
+ProgressMeter = "1"
 Scratch = "1.0"
 SimpleBufferStream = "1"
 Tar = "1.7"

src/Sources.jl

@@ -1,4 +1,6 @@
 using LibGit2
+using ProgressMeter
+const update! = ProgressMeter.update!
 
 export ArchiveSource, FileSource, GitSource, DirectorySource
 
@@ -142,10 +144,34 @@ function download_source(source::T; verbose::Bool = false, downloads_dir = stora
     return SetupSource{T}(src_path, source.hash, gettarget(source))
 end
 
+struct GitTransferProgress
+    total_objects::Cuint
+    indexed_objects::Cuint
+    received_objects::Cuint
+    local_objects::Cuint
+    total_deltas::Cuint
+    indexed_deltas::Cuint
+    received_bytes::Csize_t
+end
+
+function transfer_progress(progress::Ptr{GitTransferProgress}, p::Any)
+    progress = unsafe_load(progress)
+    p.n = progress.total_objects
+    if progress.total_deltas != 0
+        p.desc = "Resolving Deltas: "
+        p.n = progress.total_deltas
+        update!(p, Int(max(1, progress.indexed_deltas)))
+    else
+        update!(p, Int(max(1, progress.received_objects)))
+    end
+    return Cint(0)
+end
+
 function cached_git_clone(url::String;
                           hash_to_check::Union{Nothing, String} = nothing,
                           downloads_dir::String = storage_dir("downloads"),
                           verbose::Bool = false,
+                          progressbar::Bool = false,
                           )
     repo_path = joinpath(downloads_dir, "clones", string(basename(url), "-", bytes2hex(sha256(url))))
     if isdir(repo_path)
@@ -163,11 +189,29 @@ function cached_git_clone(url::String;
             end
         end
     else
+        # If there is no repo_path yet, clone it down into a bare repository
         if verbose
             @info("Cloning git repository", url, repo_path)
         end
-        # If there is no repo_path yet, clone it down into a bare repository
-        LibGit2.clone(url, repo_path; isbare=true)
+        if progressbar
+            # Clone with a progress bar
+            p = Progress(0, 1, "Cloning: ")
+            GC.@preserve p begin
+                callbacks = LibGit2.RemoteCallbacks(
+                    transfer_progress=@cfunction(
+                        transfer_progress,
+                        Cint,
+                        (Ptr{GitTransferProgress}, Any)
+                    ),
+                    payload = p
+                )
+                fetch_opts = LibGit2.FetchOptions(; callbacks)
+                clone_opts = LibGit2.CloneOptions(; fetch_opts, bare = Cint(true))
+                LibGit2.clone(url, repo_path, clone_opts)
+            end
+        else
+            LibGit2.clone(url, repo_path; isbare=true)
+        end
     end
     return repo_path
 end