Function write_breadcrumb

ci/util/download_breadcrumb.py:60–94

Write breadcrumb data to a JSON file with file locking. Automatically adds/updates timestamp if not present in data. Thread-safe: Uses file locking with 5-second timeout and stale lock recovery. Args: breadcrumb_path: Path to the breadcrumb file data: Dictionary wi

(breadcrumb_path: Path, data: dict[str, Any])

def write_breadcrumb(breadcrumb_path: Path, data: dict[str, Any]) -> bool:
    """
    Write breadcrumb data to a JSON file with file locking.

    Automatically adds/updates timestamp if not present in data.
    Thread-safe: Uses file locking with 5-second timeout and stale lock recovery.

    Args:
        breadcrumb_path: Path to the breadcrumb file
        data: Dictionary with breadcrumb data to write

    Returns:
        True if write succeeded, False otherwise
    """
    try:
        # Ensure parent directory exists
        breadcrumb_path.parent.mkdir(parents=True, exist_ok=True)

        # Add timestamp if not present
        if "timestamp" not in data:
            data["timestamp"] = datetime.now().isoformat()

        # Use file locking with 5-second timeout to prevent concurrent write corruption
        with write_lock(breadcrumb_path, timeout=5.0, operation="breadcrumb_write"):
            with open(breadcrumb_path, "w") as f:
                json.dump(data, f, indent=2)

        return True

    except TimeoutError as e:
        logger.error(f"Lock timeout writing breadcrumb {breadcrumb_path}: {e}")
        return False
    except OSError as e:
        logger.warning(f"Failed to write breadcrumb {breadcrumb_path}: {e}")
        return False


def is_download_complete(breadcrumb_path: Path) -> bool: