Avoid opam source command, fetching with --depth 1

- Fixes #5061
ocaml · Apr 2, 2024 · ee893f1 · ee893f1
1 parent 14a457b
commit ee893f1
Show file tree

Hide file tree

Showing 14 changed files with 60 additions and 29 deletions.
diff --git a/master_changes.md b/master_changes.md
@@ -55,6 +55,7 @@ users)
 ## Exec
 
 ## Source
+  * Avoid fetching with `--depth 1` for `opam source` command [#5888 @moyodiallo - fix #5061]
 
 ## Lint
 
@@ -154,6 +155,7 @@ users)
   * `OpamArg.apply_global_options`: load MSYS2 Cygwin binary path too [#5843 @rjbou]
 
 ## opam-repository
+  * `OpamRepositoryBackend.pull_url`, `OpamVCS.fetch`: add `full_fetch` optional argument to pull full history if url is a `VCS` [#5888 @moyodiallo - fix #5061]
 
 ## opam-state
   * `OpamEnv.env_expansion`: Fix detection of out-of-date environment variables, a filter predicate was inverted [#5837 @dra27]

diff --git a/src/client/opamCommands.ml b/src/client/opamCommands.ml
@@ -3696,6 +3696,7 @@ let source cli =
            match
              OpamProcess.Job.run
                (OpamRepository.pull_tree
+                  ~full_fetch:true
                   ~cache_dir:(OpamRepositoryPath.download_cache
                                 OpamStateConfig.(!r.root_dir))
                   ?subpath

diff --git a/src/repository/opamDarcs.ml b/src/repository/opamDarcs.ml
@@ -48,7 +48,7 @@ module VCS = struct
   (* Marks the current state, in the form of a reversing patch on top of the
      fetched state *)
 
-  let fetch ?cache_dir:_ ?subpath:_ repo_root repo_url =
+  let fetch ?full_fetch:_ ?cache_dir:_ ?subpath:_ repo_root repo_url =
     (* Just do a fresh pull into a temp directory, and replace _darcs/
        There is no easy way to diff or make sure darcs forgets about local
        patches otherwise. *)

diff --git a/src/repository/opamGit.ml b/src/repository/opamGit.ml
@@ -16,6 +16,7 @@ open OpamProcess.Job.Op
 
 module VCS : OpamVCS.VCS = struct
 
+
   let name = `git
 
   let exists repo_root =
@@ -62,7 +63,8 @@ module VCS : OpamVCS.VCS = struct
     | Some h -> "refs/remotes/opam-ref-"^h
     | None -> "refs/remotes/opam-ref"
 
-  let fetch ?cache_dir ?subpath repo_root repo_url =
+let fetch ?(full_fetch = false) ?cache_dir ?subpath repo_root repo_url =
+  (* let fetch ?cache_dir ?subpath repo_root repo_url = *)
     (match subpath with
      | Some sp ->
        git repo_root [ "config"; "--local"; "core.sparseCheckout"; "true" ]
@@ -95,7 +97,10 @@ module VCS : OpamVCS.VCS = struct
           OpamFilename.write alternates
             (OpamFilename.Dir.to_string (cache / "objects")))
       global_cache;
-    git repo_root [ "fetch" ; "-q"; origin; "--update-shallow"; "--depth=1"; refspec ]
+    (if full_fetch then
+      git repo_root [ "fetch" ; "-q"; origin; "--update-shallow"; refspec ]
+    else
+        git repo_root [ "fetch" ; "-q"; origin; "--update-shallow"; "--depth=1"; refspec ])
     @@> fun r ->
     if OpamProcess.check_success_and_cleanup r then
       let refspec =

diff --git a/src/repository/opamHTTP.ml b/src/repository/opamHTTP.ml
@@ -68,7 +68,7 @@ module B = struct
 
   let repo_update_complete _ _ = Done ()
 
-  let pull_url ?cache_dir:_ ?subpath:_ dirname checksum remote_url =
+  let pull_url ?full_fetch:_ ?cache_dir:_ ?subpath:_ dirname checksum remote_url =
     log "pull-file into %a: %a"
       (slog OpamFilename.Dir.to_string) dirname
       (slog OpamUrl.to_string) remote_url;

diff --git a/src/repository/opamHg.ml b/src/repository/opamHg.ml
@@ -37,7 +37,7 @@ module VCS = struct
     | None -> mark_prefix
     | Some fragment -> mark_prefix ^ "-" ^ fragment
 
-  let fetch ?cache_dir:_ ?subpath:_ repo_root repo_url =
+  let fetch ?full_fetch:_ ?cache_dir:_ ?subpath:_ repo_root repo_url =
     let src = OpamUrl.base_url repo_url in
     let rev = OpamStd.Option.default "default" repo_url.OpamUrl.hash in
     let mark = mark_from_url repo_url in

diff --git a/src/repository/opamLocal.ml b/src/repository/opamLocal.ml
@@ -190,7 +190,7 @@ module B = struct
 
   let repo_update_complete _ _ = Done ()
 
-  let pull_url ?cache_dir:_ ?subpath local_dirname _checksum remote_url =
+  let pull_url ?full_fetch:_ ?cache_dir:_ ?subpath local_dirname _checksum remote_url =
     let local_dirname = OpamFilename.SubPath.(local_dirname /? subpath) in
     OpamFilename.mkdir local_dirname;
     let dir = OpamFilename.Dir.to_string local_dirname in

diff --git a/src/repository/opamRepository.ml b/src/repository/opamRepository.ml
@@ -164,7 +164,7 @@ let validate_and_add_to_cache label url cache_dir file checksums =
 
 (* [cache_dir] used to add to cache only *)
 let pull_from_upstream
-    label ?(working_dir=false) ?subpath cache_dir destdir checksums url =
+    label ?full_fetch ?(working_dir=false) ?subpath cache_dir destdir checksums url =
   let module B = (val url_backend url: OpamRepositoryBackend.S) in
   let cksum = match checksums with [] -> None | c::_ -> Some c in
   let text =
@@ -206,7 +206,7 @@ let pull_from_upstream
        )
      else url, B.pull_url
    in
-   pull ?cache_dir ?subpath destdir cksum url
+   pull ?full_fetch ?cache_dir ?subpath destdir cksum url
   )
   @@| function
   | (Result (Some file) | Up_to_date (Some file)) as ret ->
@@ -219,14 +219,14 @@ let pull_from_upstream
   | (Result None | Up_to_date None) as ret -> ret
   | Not_available _ as na -> na
 
-let pull_from_mirrors label ?working_dir ?subpath cache_dir destdir checksums urls =
+let pull_from_mirrors label ?full_fetch ?working_dir ?subpath cache_dir destdir checksums urls =
   let rec aux = function
     | [] -> invalid_arg "pull_from_mirrors: empty mirror list"
     | [url] ->
-      pull_from_upstream label ?working_dir ?subpath cache_dir destdir checksums url
+      pull_from_upstream label ?full_fetch ?working_dir ?subpath cache_dir destdir checksums url
       @@| fun r -> url, r
     | url::mirrors ->
-      pull_from_upstream label ?working_dir ?subpath cache_dir destdir checksums url
+      pull_from_upstream label ?full_fetch ?working_dir ?subpath cache_dir destdir checksums url
       @@+ function
       | Not_available (_,s) ->
         OpamConsole.warning "%s: download of %s failed (%s), trying mirror"
@@ -246,7 +246,7 @@ let pull_from_mirrors label ?working_dir ?subpath cache_dir destdir checksums ur
 
 (* handle subpathes *)
 let pull_tree_t
-    ?cache_dir ?(cache_urls=[]) ?working_dir
+    ?full_fetch ?cache_dir ?(cache_urls=[]) ?working_dir
     dirnames checksums remote_urls =
   let extract_archive =
     let fallback success = function
@@ -342,13 +342,13 @@ let pull_tree_t
       let pull label checksums remote_urls =
         match dirnames with
         | [ label, local_dirname, subpath ] ->
-          pull_from_mirrors label ?working_dir ?subpath cache_dir local_dirname
+          pull_from_mirrors label ?full_fetch ?working_dir ?subpath cache_dir local_dirname
             checksums remote_urls
           @@| fun (url, res) ->
           (OpamUrl.to_string_w_subpath subpath url),
           res
         | _ ->
-          pull_from_mirrors label ?working_dir cache_dir tmpdir
+          pull_from_mirrors label ?full_fetch ?working_dir cache_dir tmpdir
             checksums remote_urls
           @@| fun (url, res) -> OpamUrl.to_string url, res
       in
@@ -361,9 +361,9 @@ let pull_tree_t
       | _, (Not_available _ as na) -> Done na
 
 
-let pull_tree label ?cache_dir ?(cache_urls=[]) ?working_dir ?subpath
+let pull_tree label ?full_fetch ?cache_dir ?(cache_urls=[]) ?working_dir ?subpath
     local_dirname  =
-  pull_tree_t ?cache_dir ~cache_urls ?working_dir
+  pull_tree_t ?full_fetch ?cache_dir ~cache_urls ?working_dir
   [label, local_dirname, subpath]
 
 let pull_shared_tree ?cache_dir ?(cache_urls=[]) dirnames checksums remote_urls =

diff --git a/src/repository/opamRepository.mli b/src/repository/opamRepository.mli
@@ -44,7 +44,7 @@ val pull_shared_tree:
 
 (* Same as [pull_shared_tree], but for a unique label/dirname. *)
 val pull_tree:
-  string -> ?cache_dir:dirname -> ?cache_urls:url list -> ?working_dir:bool ->
+  string -> ?full_fetch:bool -> ?cache_dir:dirname -> ?cache_urls:url list -> ?working_dir:bool ->
   ?subpath:subpath -> dirname -> OpamHash.t list -> url list ->
   string download OpamProcess.job
 

diff --git a/src/repository/opamRepositoryBackend.ml b/src/repository/opamRepositoryBackend.ml
@@ -22,6 +22,7 @@ type update =
 module type S = sig
   val name: OpamUrl.backend
   val pull_url:
+    ?full_fetch:bool ->
     ?cache_dir:dirname -> ?subpath:subpath -> dirname -> OpamHash.t option -> url ->
     filename option download OpamProcess.job
   val fetch_repo_update:

diff --git a/src/repository/opamRepositoryBackend.mli b/src/repository/opamRepositoryBackend.mli
@@ -45,6 +45,7 @@ module type S = sig
       [checksum] can be used for retrieval but is NOT checked by this
       function. *)
   val pull_url:
+    ?full_fetch:bool ->
     ?cache_dir:dirname -> ?subpath:subpath -> dirname -> OpamHash.t option ->
     url -> filename option download OpamProcess.job
 

diff --git a/src/repository/opamVCS.ml b/src/repository/opamVCS.ml
@@ -18,7 +18,7 @@ module type VCS = sig
   val exists: dirname -> bool
   val init: dirname -> url -> unit OpamProcess.job
   val fetch:
-    ?cache_dir:dirname -> ?subpath:subpath -> dirname -> url ->
+    ?full_fetch:bool -> ?cache_dir:dirname -> ?subpath:subpath -> dirname -> url ->
     unit OpamProcess.job
   val reset_tree: dirname -> url -> unit OpamProcess.job
   val patch_applied: dirname -> url -> unit OpamProcess.job
@@ -75,7 +75,7 @@ module Make (VCS: VCS) = struct
     VCS.patch_applied dirname url @@+ fun () ->
     Done ()
 
-  let pull_url ?cache_dir ?subpath dirname checksum url =
+  let pull_url ?full_fetch ?cache_dir ?subpath dirname checksum url =
     if checksum <> None then invalid_arg "VC pull_url doesn't allow checksums";
     OpamProcess.Job.catch
       (fun e ->
@@ -87,7 +87,7 @@ module Make (VCS: VCS) = struct
     @@ fun () ->
     if VCS.exists dirname then
       VCS.clean dirname @@+ fun () ->
-      VCS.fetch ?cache_dir ?subpath dirname url @@+ fun () ->
+      VCS.fetch ?full_fetch ?cache_dir ?subpath dirname url @@+ fun () ->
       VCS.is_up_to_date ?subpath dirname url @@+ function
       | true -> Done (Up_to_date None)
       | false ->
@@ -96,7 +96,7 @@ module Make (VCS: VCS) = struct
     else
       (OpamFilename.mkdir dirname;
        VCS.init dirname url @@+ fun () ->
-       VCS.fetch ?cache_dir ?subpath dirname url @@+ fun () ->
+       VCS.fetch ?full_fetch ?cache_dir ?subpath dirname url @@+ fun () ->
        VCS.reset_tree dirname url @@+ fun () ->
        Done (Result None))
 

diff --git a/src/repository/opamVCS.mli b/src/repository/opamVCS.mli
@@ -29,7 +29,7 @@ module type VCS = sig
       Be aware that the remote URL might have been changed, so make sure
       to update accordingly. *)
   val fetch:
-    ?cache_dir:dirname -> ?subpath:subpath -> dirname -> url ->
+    ?full_fetch:bool -> ?cache_dir:dirname -> ?subpath:subpath -> dirname -> url ->
     unit OpamProcess.job
 
   (** Reset the master branch of the repository to match the remote repository

diff --git a/tests/reftests/source.test b/tests/reftests/source.test
@@ -8,9 +8,6 @@ print_endline "i'm root"
 ### git -C ./pandev config core.autocrlf false
 ### git -C ./pandev add -A
 ### git -C ./pandev commit -qm "init"
-### git -C ./pandev commit --allow-empty -m "second empty commit" --quiet
-### git -C ./pandev rev-list --all --count
-2
 ### <pkg:pandore.3>
 opam-version: "2.0"
 ### <mkurl.sh>
@@ -53,8 +50,6 @@ pandore2/src/src.ml
 ### rm -rf pandore.3
 ### opam source pandore --dev
 Successfully fetched pandore development repo to ${BASEDIR}/pandore
-### git -C pandore rev-list --all --count
-1
 ### find pandore | grep -v '.git/' | unordered
 pandore
 pandore/.git
@@ -63,8 +58,6 @@ pandore/src
 pandore/src/src.ml
 ### opam source pandore --dev --dir pandore4
 Successfully fetched pandore development repo to ${BASEDIR}/pandore4
-### git -C pandore4 rev-list --all --count
-1
 ### find pandore4 | grep -v '.git/' | unordered
 pandore4
 pandore4/.git
@@ -116,3 +109,31 @@ pandore.3/src/src.ml
 Switch phantom and all its packages will be wiped. Are you sure? [y/n] y
 ### opam source pandore
 Successfully extracted to ${BASEDIR}/pandore.3
+### : Full retrieval of git history when --dev is given :
+### git -C ./pandev commit --allow-empty -m "second empty commit" --quiet
+### git -C ./pandev rev-list --all --count
+2
+### <pkg:pandore.4>
+opam-version: "2.0"
+### <mkurl.sh>
+p=pandore.4
+file="REPO/packages/${p%.*}/$p/opam"
+basedir=`echo $BASEDIR | sed "s/\\\\\\\\/\\\\\\\\\\\\\\\\/g"`
+echo "url {" >> $file
+echo "git: \"$basedir/pandev\"" >> $file
+echo "}" >> $file
+echo "dev-repo: \"git+file://${basedir}/pandev\"" >> $file
+### sh mkurl.sh
+### opam update
+
+<><> Updating package repositories ><><><><><><><><><><><><><><><><><><><><><><>
+[default] synchronised from file://${BASEDIR}/REPO
+Now run 'opam upgrade' to apply any package updates.
+### opam source pandore.4 --dir pandore5
+Successfully extracted to ${BASEDIR}/pandore5
+### git -C pandore5 rev-list --all --count
+1
+### opam source pandore.4 --dev --dir pandore6
+Successfully fetched pandore development repo to ${BASEDIR}/pandore6
+### git -C pandore6 rev-list --all --count
+2