awesome-emacs/doomemacs
1
0
Fork 0
mirror of https://github.com/doomemacs/doomemacs synced 2025-09-24 16:30:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: retry straight operations if they fail

Browse Source 
Prior to this, we had some rudimentary retry logic for failed git clones
resulting in an empty repo, but it didn't respond to other legit
errors (like connection errors or legit remote failures). This one does,
retrying in more contexts.

Close: #8523
Co-authored-by: NightMachinery <NightMachinery@users.noreply.github.com>
This commit is contained in:
Henrik Lissner
2025-09-21 17:20:04 -04:00
parent 230f8999ab
commit 4de162108e
2 changed files with 73 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
lisp/doom-straight.el
View File

@@ -296,5 +296,71 @@ However, in batch mode, print to stdout instead of stderr."
(error "Package was not properly cloned due to a connection failure, please try again later")
(signal (car e) (cdr e))))))
;; HACK: Straight can sometimes fail to clone/update a repo, leaving behind an
;; empty directory which, in future invocations, it will assume indicates a
;; successful clone (causing load errors later).
(defvar +doom-straight-retries 3
"How many times to retry VC operations.")
(defvar +doom-straight-retry-methods
'(clone
normalize
fetch-from-remote
fetch-from-upstream
merge-from-remote
merge-from-upstream)
"Which `straight-vc' methods to retry, if they fail.")
(defadvice! doom-straight--retry-a (fn method type &rest args)
:around #'straight-vc
(if (or (not noninteractive)
(memq type '(nil built-in))
(not (memq method +doom-straight-retry-methods)))
(apply fn method type args)
(let ((n +doom-straight-retries)
res)
(while (> n 0)
(condition-case err
(setq res (apply fn method type args)
n 0)
(error
(cl-decf n)
(when (= n 0)
(signal (car err) (cdr err)))
(print! (warn "Failed %S %S operation, retrying (attempt %d/%d)...")
type method (- (1+ +doom-straight-retries) n)
+doom-straight-retries)
(sleep-for 1))))
res)))
;; HACK: In some edge cases, either Straight or git silently fails to clone a
;; package without triggering an catchable error (and thus evading the
;; auto-retry logic in `doom-straight--retry-a') and leaves behind an empty
;; directory. This detects this an forces straight to emit a catchable error.
(defadvice! doom-straight--clone-emit-error-a (fn recipe)
:around #'straight-vc-clone
(prog1 (funcall fn recipe)
(when noninteractive
(straight--with-plist recipe (package type local-repo)
(let* ((local-repo (or local-repo package))
(repo-dir (straight--repos-dir local-repo))
(build-dir (straight--build-dir local-repo)))
(when (file-in-directory-p repo-dir straight-base-dir)
(unless (or (file-directory-p (doom-path repo-dir ".git"))
(file-exists-p (doom-path repo-dir ".straight-commit")))
(delete-directory repo-dir t)
(delete-directory build-dir t)
(error "Failed to clone %S..." package))))))))
;; HACK: Line encoding issues can plague repos with dirty worktree prompts when
;; updating packages or "Local variables entry is missing the suffix" errors
;; when installing them (see #2637), so have git handle conversion by force.
(when doom--system-windows-p
(add-hook! 'straight-vc-git-post-clone-hook
(lambda! (&key repo-dir)
(let ((default-directory repo-dir))
(straight--process-run "git" "config" "core.autocrlf" "true")))))
(provide 'doom-straight)
;;; doom-packages.el ends here

38
lisp/lib/packages.el
View File

@@ -997,37 +997,13 @@ Must be run from a magit diff buffer."
(condition-case-unless-debug e
(let ((straight-vc-git-post-clone-hook
(cons (lambda! (&key commit)
(if-let* ((pin (cdr (assoc package pinned))))
(print! (item "%s: pinned to %s") package pin)
(when commit
(print! (item "%s: checked out %s") package commit))))
(print-group!
(if-let* ((pin (cdr (assoc package pinned))))
(print! (item "%s: pinned to %s") package pin)
(when commit
(print! (item "%s: checked out %s") package commit)))))
straight-vc-git-post-clone-hook)))
(straight-use-package (intern package))
(when (file-in-directory-p repo-dir straight-base-dir)
;; HACK: Straight can sometimes fail to clone a
;; repo, leaving behind an empty directory which,
;; in future invocations, it will assume
;; indicates a successful clone (causing load
;; errors later).
(let ((try 0))
(while (not (or (file-directory-p (doom-path repo-dir ".git"))
(file-exists-p (doom-path repo-dir ".straight-commit"))))
(when (= try 3)
(error "Failed to clone package"))
(print! (warn "Failed to clone %S, trying again (attempt #%d)...") package (1+ try))
(delete-directory repo-dir t)
(delete-directory build-dir t)
(straight-use-package (intern package))
(cl-incf try)))
;; HACK: Line encoding issues can plague repos with
;; dirty worktree prompts when updating packages
;; or "Local variables entry is missing the
;; suffix" errors when installing them (see
;; #2637), so have git handle conversion by
;; force.
(when doom--system-windows-p
(let ((default-directory repo-dir))
(straight--process-run "git" "config" "core.autocrlf" "true")))))
(straight-use-package (intern package)))
(error
(signal 'doom-package-error (list package e))))))))
(progn
@@ -1108,7 +1084,7 @@ Must be run from a magit diff buffer."
((file-exists-p ".straight-commit")
(print! (start "\r(%d/%d) Downloading %s...%s") i total package esc)
(delete-directory default-directory t)
(straight-vc-git-clone recipe target-ref)
(straight-vc 'clone 'git recipe target-ref)
(doom-packages--same-commit-p target-ref (straight-vc-get-commit type local-repo)))
((if (straight-vc-commit-present-p recipe target-ref)