mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-30 01:39:13 +00:00
fix(update): address review of the index.lock fix
- The automatic update's status check now sets GIT_OPTIONAL_LOCKS=0 whichever runner it is given, not only the default one. - Update Code no longer runs `git rebase --abort` on any rebase dir: a rebase in progress (detached HEAD) holds the user's conflict work and blocks the update; an abandoned one is dropped with `rebase --quit`, as the automatic update does, and a failure to clear it stops the update. - run_git waits out the lock-freshness window after stopping a timed-out git, so a lock created just before the timeout is not left behind. - Mark the Popen/subprocess use with the repo's nosec comments. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Sonnet 5.5
parent
e506c1b576
commit
67b373fca0
@@ -303,11 +303,11 @@ def local_changes(project_dir, run=None, timeout=30):
|
||||
``run`` raises (e.g. ``subprocess.TimeoutExpired``).
|
||||
"""
|
||||
# A status that times out must not leave index.lock: don't refresh the index.
|
||||
extra = {} if run else {'env': git_index_lock.read_only_env()}
|
||||
run = run or git_index_lock.run_git
|
||||
result = run(['git', '-c', 'core.fileMode=false', 'status', '--porcelain',
|
||||
'--untracked-files=no', '-z'],
|
||||
cwd=str(project_dir), capture_output=True, text=True, timeout=timeout, **extra)
|
||||
cwd=str(project_dir), capture_output=True, text=True, timeout=timeout,
|
||||
env=git_index_lock.read_only_env())
|
||||
if result.returncode != 0:
|
||||
return None
|
||||
changed = []
|
||||
|
||||
@@ -346,12 +346,26 @@ def _perform_core_update_locked(stash_local_changes=True):
|
||||
'try again in a minute.'}
|
||||
|
||||
# A pull killed mid-rebase leaves .git/rebase-merge behind, and every
|
||||
# later `pull --rebase` then fails. Nothing is running (checked above).
|
||||
# later `pull --rebase` then fails. Same rule as the automatic update's
|
||||
# preflight: a rebase really in progress leaves HEAD detached and holds
|
||||
# the user's conflict work, so leave it; with HEAD back on a branch it was
|
||||
# abandoned, and `--quit` drops its state without touching the tree.
|
||||
git_dir = Path(project_dir) / '.git'
|
||||
if any((git_dir / name).exists() for name in ('rebase-merge', 'rebase-apply')):
|
||||
logger.warning("aborting a rebase left by an interrupted update")
|
||||
git_index_lock.run_git(['git', 'rebase', '--abort'], capture_output=True, text=True,
|
||||
timeout=60, cwd=project_dir)
|
||||
rebase_dirs = [git_dir / name for name in ('rebase-merge', 'rebase-apply') if (git_dir / name).exists()]
|
||||
if rebase_dirs:
|
||||
def _git(*args):
|
||||
return git_index_lock.run_git(['git', *args], capture_output=True, text=True,
|
||||
timeout=60, cwd=project_dir)
|
||||
if _git('symbolic-ref', '-q', 'HEAD').returncode != 0:
|
||||
return {'status': 'error', 'restart_required': False, 'dependency_failures': [],
|
||||
'message': 'A git rebase is in progress in the LEDMatrix folder. '
|
||||
'Finish or abort it (git rebase --continue / --abort), then update again.'}
|
||||
cleared = _git('rebase', '--quit')
|
||||
if cleared.returncode != 0 or any(path.exists() for path in rebase_dirs):
|
||||
return {'status': 'error', 'restart_required': False, 'dependency_failures': [],
|
||||
'message': 'An abandoned git rebase in the LEDMatrix folder could not be cleared: '
|
||||
f'{(cleared.stderr or "").strip() or "unknown error"}.'}
|
||||
logger.warning("Cleared an abandoned git rebase from %s", ', '.join(str(p) for p in rebase_dirs))
|
||||
|
||||
# Which code to move to: the newest release (stable) or main (beta).
|
||||
# See web_interface/update_channel.py; it never picks an older commit.
|
||||
|
||||
@@ -19,7 +19,7 @@ the file alone. Standard library only.
|
||||
import logging
|
||||
import os
|
||||
import signal
|
||||
import subprocess
|
||||
import subprocess # nosec B404 - list-form argv only, no shell # nosemgrep
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
@@ -166,6 +166,20 @@ def _stop_group(proc):
|
||||
pass
|
||||
|
||||
|
||||
def _clear_after_stop(project_dir):
|
||||
"""Remove the lock a stopped git left, waiting out the freshness window.
|
||||
|
||||
A lock created within ``MIN_STALE_AGE_SECONDS`` of the stop reads as IN_USE
|
||||
on age alone; with no git process left it only needs to age, so wait for
|
||||
that rather than leave it to block the next attempt.
|
||||
"""
|
||||
deadline = time.monotonic() + MIN_STALE_AGE_SECONDS + 1
|
||||
while clear_stale_index_lock(project_dir) == IN_USE and git_running_in(project_dir) is False:
|
||||
if time.monotonic() >= deadline:
|
||||
break
|
||||
time.sleep(0.5)
|
||||
|
||||
|
||||
def run_git(cmd, *, cwd=None, timeout=None, capture_output=True, text=True, **kwargs):
|
||||
"""``subprocess.run`` for git, without leaving ``.git/index.lock`` behind.
|
||||
|
||||
@@ -177,14 +191,14 @@ def run_git(cmd, *, cwd=None, timeout=None, capture_output=True, text=True, **kw
|
||||
"""
|
||||
if capture_output:
|
||||
kwargs['stdout'] = kwargs['stderr'] = subprocess.PIPE
|
||||
with subprocess.Popen(cmd, cwd=cwd, text=text, start_new_session=True, **kwargs) as proc:
|
||||
with subprocess.Popen(cmd, cwd=cwd, text=text, start_new_session=True, **kwargs) as proc: # nosec B603 - list-form argv # nosemgrep
|
||||
try:
|
||||
stdout, stderr = proc.communicate(timeout=timeout)
|
||||
except subprocess.TimeoutExpired as exc:
|
||||
_stop_group(proc)
|
||||
exc.stdout, exc.stderr = proc.communicate()
|
||||
if cwd is not None:
|
||||
clear_stale_index_lock(cwd)
|
||||
_clear_after_stop(cwd)
|
||||
raise
|
||||
except BaseException:
|
||||
_stop_group(proc)
|
||||
|
||||
Reference in New Issue
Block a user