Spaces:
Running
Running
File size: 32,131 Bytes
af9e60e 0f21014 af9e60e 0f21014 af9e60e ad8f514 0f21014 87bcb42 af9e60e 0f21014 af9e60e 0f21014 af9e60e ed5527c af9e60e 08c12cf db85721 87bcb42 0f21014 db85721 cfcca86 ad8f514 cfcca86 0f21014 ad8f514 0f21014 ad8f514 14fd0fa 0f21014 363994a 0f21014 915aa9e 7bba7b2 cfcca86 2159e0f ed5527c cfcca86 be6d947 0f21014 d439036 0f21014 14fd0fa ed5527c af9e60e 0f21014 af9e60e ad8f514 d439036 be6d947 14fd0fa be6d947 d439036 cfcca86 cd9637b 14fd0fa cfcca86 be6d947 14fd0fa 2159e0f cfcca86 cd9637b be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa 0f21014 cd9637b db85721 cfcca86 d439036 de4ed0d d439036 db85721 d439036 db85721 d439036 0f21014 db85721 0f21014 cd9637b 0f21014 aef59f1 0f21014 db85721 0f21014 fe9380c 0f21014 fe9380c db85721 0f21014 db85721 0f21014 af9e60e 0f21014 af9e60e 0f21014 915aa9e ad8f514 ed5527c 0f21014 ed5527c 0f21014 ed5527c 0f21014 915aa9e 0f21014 af9e60e 0f21014 ed5527c 0f21014 915aa9e 0f21014 ed5527c 0f21014 915aa9e 0f21014 ed5527c 0f21014 ed5527c 0f21014 af9e60e 0f21014 af9e60e 0f21014 af9e60e ad8f514 0f21014 ed5527c 0f21014 ed5527c 2ffeaa2 0f21014 2ffeaa2 0f21014 f1b6f7f 0f21014 915aa9e 0e6fb59 0f21014 2159e0f 0f21014 2159e0f ad8f514 ed5527c ad8f514 0f21014 2159e0f ad8f514 c68251f be6d947 c68251f be6d947 c68251f be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa be6d947 14fd0fa be6d947 c68251f ad8f514 14fd0fa ad8f514 c68251f ad8f514 14fd0fa c68251f ad8f514 0f21014 2159e0f ad8f514 0f21014 db85721 0f21014 2159e0f 0f21014 db85721 af9e60e ad8f514 cd9637b ad8f514 14fd0fa 21cbde1 0f21014 ad8f514 0f21014 14fd0fa ad8f514 0f21014 db85721 ad8f514 14fd0fa b04f245 14fd0fa ad8f514 0f21014 ad8f514 c68251f 14fd0fa b04f245 0f21014 411ffb9 0f21014 af9e60e 0f21014 2ffeaa2 0f21014 db85721 0f21014 ad8f514 0f21014 af9e60e 0f21014 af9e60e 0f21014 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 | #!/usr/bin/env python3
"""
HuggingClaw workspace/state backup via huggingface_hub.
This keeps OpenClaw workspace data, app state, and optional WhatsApp
credentials inside a private HF dataset without embedding HF tokens in git
remotes or requiring a manual HF_USERNAME secret.
"""
import fcntl
import hashlib
import json
import logging
import os
import shutil
import signal
import sys
import tempfile
import threading
import time
from typing import TypeAlias
from pathlib import Path
os.environ.setdefault("HF_HUB_DISABLE_PROGRESS_BARS", "1")
# huggingface_hub reads HF_HUB_VERBOSITY at import time and overrides any
# logging.getLogger().setLevel() we apply afterwards. Set it before import
# to silence the "No files have been modified..." spam from
# upload_large_folder workers (logger.warning level).
os.environ.setdefault("HF_HUB_VERBOSITY", "error")
from huggingface_hub import HfApi, snapshot_download, upload_folder
from huggingface_hub.errors import HfHubHTTPError, RepositoryNotFoundError
# Belt-and-suspenders: also raise the level after import in case the env var
# wasn't honored (older hub versions, or message logged via a sub-logger).
logging.getLogger("huggingface_hub").setLevel(logging.ERROR)
OPENCLAW_HOME = Path("/home/node/.openclaw")
OPENCLAW_CONFIG_FILE = OPENCLAW_HOME / "openclaw.json"
WORKSPACE = OPENCLAW_HOME / "workspace"
STATUS_FILE = Path("/tmp/sync-status.json")
SYNC_LOCK_FILE = Path("/tmp/huggingclaw-sync.lock")
INTERVAL = int(os.environ.get("SYNC_INTERVAL", "180"))
INITIAL_DELAY = int(os.environ.get("SYNC_START_DELAY", "10"))
CONFIG_WATCH_INTERVAL = max(
0.5,
float(os.environ.get("OPENCLAW_CONFIG_WATCH_INTERVAL", "1")),
)
CONFIG_SETTLE_SECONDS = max(
0.0,
float(os.environ.get("OPENCLAW_CONFIG_SETTLE_SECONDS", "3")),
)
SESSIONS_MIN_SYNC_GAP = int(os.environ.get("SESSIONS_MIN_SYNC_GAP", "30"))
HF_TOKEN = os.environ.get("HF_TOKEN", "").strip()
HF_USERNAME = os.environ.get("HF_USERNAME", "").strip()
SPACE_AUTHOR_NAME = os.environ.get("SPACE_AUTHOR_NAME", "").strip()
BACKUP_DATASET_NAME = os.environ.get("BACKUP_DATASET_NAME", "").strip() or os.environ.get("BACKUP_DATASET", "").strip() or "huggingclaw-backup"
def is_true(value):
return str(value).strip().lower() in {"1", "true", "yes", "on"}
WHATSAPP_ENABLED = is_true(os.environ.get("WHATSAPP_ENABLED", ""))
EXCLUDED_SYNC_DIRS = {
"node_modules", ".git", "__pycache__", ".venv", "venv",
".npm", ".cache", ".yarn", "dist", "build", ".next", ".nuxt",
".turbo", ".parcel-cache", "target", ".gradle", ".mvn",
}
MAX_FILE_SIZE_BYTES = int(os.environ.get("SYNC_MAX_FILE_BYTES", str(50 * 1024 * 1024)))
STATE_DIR = WORKSPACE / "huggingclaw-state"
OPENCLAW_STATE_BACKUP_DIR = STATE_DIR / "openclaw"
EXCLUDED_STATE_NAMES = {
"workspace",
"openclaw-app",
"gateway.log",
"browser",
"npm",
}
SESSIONS_ROOT = OPENCLAW_HOME / "agents"
WHATSAPP_CREDS_DIR = OPENCLAW_HOME / "credentials" / "whatsapp" / "default"
WHATSAPP_BACKUP_DIR = STATE_DIR / "credentials" / "whatsapp" / "default"
RESET_MARKER = WORKSPACE / ".reset_credentials"
HF_API = HfApi(token=HF_TOKEN) if HF_TOKEN else None
STOP_EVENT = threading.Event()
_REPO_ID_CACHE: str | None = None
_SESSIONS_FILE_DIGEST_CACHE: dict[str, tuple[int, int, int, str]] = {}
WorkspaceMarker: TypeAlias = tuple[int, int, int, str]
def write_status(status: str, message: str) -> None:
payload = {
"status": status,
"message": message,
"timestamp": time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()),
}
tmp_path = STATUS_FILE.with_suffix(".tmp")
tmp_path.write_text(json.dumps(payload), encoding="utf-8")
tmp_path.replace(STATUS_FILE)
def read_status() -> dict[str, str]:
try:
return json.loads(STATUS_FILE.read_text(encoding="utf-8"))
except Exception:
return {}
def count_files(path: Path) -> int:
if not path.exists():
return 0
return sum(1 for child in path.rglob("*") if child.is_file())
def copy_state_entry_with_retry(source_path: Path, backup_path: Path, attempts: int = 3) -> None:
"""Copy one top-level .openclaw entry with short retries for hot files/dirs."""
last_exc: Exception | None = None
for attempt in range(1, attempts + 1):
try:
if backup_path.exists():
if backup_path.is_dir():
shutil.rmtree(backup_path, ignore_errors=True)
else:
backup_path.unlink(missing_ok=True)
if source_path.is_dir():
shutil.copytree(source_path, backup_path)
return
if source_path.is_file():
shutil.copy2(source_path, backup_path)
return
return
except Exception as exc:
last_exc = exc
if attempt < attempts:
time.sleep(0.2 * attempt)
if backup_path.exists():
if backup_path.is_dir():
shutil.rmtree(backup_path, ignore_errors=True)
else:
backup_path.unlink(missing_ok=True)
continue
raise last_exc
def snapshot_state_into_workspace() -> None:
try:
STATE_DIR.mkdir(parents=True, exist_ok=True)
# Atomic snapshot: copy to a staging dir first, then rename.
# This prevents a half-written (or empty) backup if we crash mid-copy,
# which would otherwise be uploaded and overwrite the real HF backup.
staging_dir = STATE_DIR / ".openclaw-staging"
if staging_dir.exists():
shutil.rmtree(staging_dir, ignore_errors=True)
if OPENCLAW_STATE_BACKUP_DIR.exists():
shutil.copytree(OPENCLAW_STATE_BACKUP_DIR, staging_dir)
else:
staging_dir.mkdir(parents=True, exist_ok=True)
skipped_entries: list[tuple[str, Exception]] = []
copied_entry_names: set[str] = set()
for source_path in OPENCLAW_HOME.iterdir():
if source_path.name in EXCLUDED_STATE_NAMES:
continue
backup_path = staging_dir / source_path.name
try:
copy_state_entry_with_retry(source_path, backup_path)
copied_entry_names.add(source_path.name)
except Exception as entry_exc:
skipped_entries.append((source_path.name, entry_exc))
# If staging was seeded from a previous backup, remove entries that no
# longer exist in OPENCLAW_HOME so the backup remains a true mirror of
# current state (except entries intentionally excluded from sync).
for staged_path in list(staging_dir.iterdir()):
if staged_path.name in EXCLUDED_STATE_NAMES:
continue
if staged_path.name in copied_entry_names:
continue
if staged_path.exists():
if staged_path.is_dir():
shutil.rmtree(staged_path, ignore_errors=True)
else:
staged_path.unlink(missing_ok=True)
# If any top-level state entries could not be copied, keep the last
# known-good version for only those entries (staging was seeded from
# previous backup). This preserves forward progress for the rest.
if skipped_entries:
for name, entry_exc in skipped_entries:
print(f"Warning: keeping previous state entry {name}: {entry_exc}")
print(
"Warning: OpenClaw state snapshot had copy failures; updated remaining state entries."
)
# Atomically swap staging → real backup dir
if OPENCLAW_STATE_BACKUP_DIR.exists():
shutil.rmtree(OPENCLAW_STATE_BACKUP_DIR, ignore_errors=True)
staging_dir.rename(OPENCLAW_STATE_BACKUP_DIR)
except Exception as exc:
# Clean up staging on failure so it doesn't interfere next time
staging_dir = STATE_DIR / ".openclaw-staging"
if staging_dir.exists():
shutil.rmtree(staging_dir, ignore_errors=True)
print(f"Warning: could not snapshot OpenClaw state: {exc}")
try:
if not WHATSAPP_ENABLED:
return
STATE_DIR.mkdir(parents=True, exist_ok=True)
if RESET_MARKER.exists():
if WHATSAPP_BACKUP_DIR.exists():
shutil.rmtree(WHATSAPP_BACKUP_DIR, ignore_errors=True)
print("Removed backed-up WhatsApp credentials after reset request.")
RESET_MARKER.unlink(missing_ok=True)
return
if not WHATSAPP_CREDS_DIR.exists():
return
file_count = count_files(WHATSAPP_CREDS_DIR)
if file_count < 2:
if file_count > 0:
print(f"WhatsApp backup skipped: credentials incomplete ({file_count} files).")
return
WHATSAPP_BACKUP_DIR.parent.mkdir(parents=True, exist_ok=True)
if WHATSAPP_BACKUP_DIR.exists():
shutil.rmtree(WHATSAPP_BACKUP_DIR, ignore_errors=True)
shutil.copytree(WHATSAPP_CREDS_DIR, WHATSAPP_BACKUP_DIR)
except Exception as exc:
print(f"Warning: could not snapshot WhatsApp state: {exc}")
def restore_embedded_state() -> None:
state_backup_root = STATE_DIR / "openclaw"
# Migration fix: old backups stored state in ".huggingclaw-state/openclaw"
# (hidden dir). If new path doesn't exist but old hidden path does, use it
# and migrate it to the new path so future syncs write to the right place.
if not state_backup_root.is_dir():
legacy_state = WORKSPACE / ".huggingclaw-state" / "openclaw"
if legacy_state.is_dir():
print("Found legacy state backup at .huggingclaw-state/; migrating to huggingclaw-state/...")
try:
STATE_DIR.mkdir(parents=True, exist_ok=True)
shutil.copytree(legacy_state, state_backup_root)
legacy_root = WORKSPACE / ".huggingclaw-state"
shutil.rmtree(legacy_root, ignore_errors=True)
print("Legacy state migrated and .huggingclaw-state/ removed.")
except Exception as exc:
print(f"Warning: could not migrate legacy state: {exc}")
if state_backup_root.is_dir():
for source_path in state_backup_root.iterdir():
name = source_path.name
if name in EXCLUDED_STATE_NAMES:
if source_path.is_dir():
shutil.rmtree(source_path, ignore_errors=True)
else:
source_path.unlink(missing_ok=True)
continue
target_path = OPENCLAW_HOME / name
shutil.rmtree(target_path, ignore_errors=True)
if target_path.is_file():
target_path.unlink(missing_ok=True)
target_path.parent.mkdir(parents=True, exist_ok=True)
if source_path.is_dir():
shutil.copytree(source_path, target_path)
else:
shutil.copy2(source_path, target_path)
print("OpenClaw state restored.")
if WHATSAPP_ENABLED and WHATSAPP_BACKUP_DIR.is_dir():
file_count = count_files(WHATSAPP_BACKUP_DIR)
if file_count >= 2:
shutil.rmtree(WHATSAPP_CREDS_DIR, ignore_errors=True)
WHATSAPP_CREDS_DIR.parent.mkdir(parents=True, exist_ok=True)
shutil.copytree(WHATSAPP_BACKUP_DIR, WHATSAPP_CREDS_DIR)
# Lock down dir tree: 0700 on directories, 0600 on every file
# so the WhatsApp session secrets can't be read by other users.
os.chmod(OPENCLAW_HOME / "credentials", 0o700)
for path in WHATSAPP_CREDS_DIR.rglob("*"):
try:
if path.is_dir():
os.chmod(path, 0o700)
elif path.is_file():
os.chmod(path, 0o600)
except OSError:
pass
print("WhatsApp credentials restored.")
else:
print(f"Warning: saved WhatsApp credentials incomplete ({file_count} files), skipping restore.")
def resolve_backup_namespace() -> str:
global _REPO_ID_CACHE
if _REPO_ID_CACHE:
return _REPO_ID_CACHE
namespace = HF_USERNAME or SPACE_AUTHOR_NAME
if not namespace and HF_API is not None:
whoami = HF_API.whoami()
namespace = whoami.get("name") or whoami.get("user") or ""
namespace = str(namespace).strip()
if not namespace:
raise RuntimeError(
"Could not determine the Hugging Face username for backups. "
"Set HF_USERNAME or use a token tied to your account."
)
_REPO_ID_CACHE = f"{namespace}/{BACKUP_DATASET_NAME}"
return _REPO_ID_CACHE
def ensure_repo_exists() -> str:
repo_id = resolve_backup_namespace()
try:
HF_API.repo_info(repo_id=repo_id, repo_type="dataset")
except RepositoryNotFoundError:
HF_API.create_repo(repo_id=repo_id, repo_type="dataset", private=True)
return repo_id
def _should_exclude(rel_posix: str, path: Path) -> bool:
parts = Path(rel_posix).parts
if any(part in EXCLUDED_SYNC_DIRS for part in parts):
return True
if path.is_file():
try:
if path.stat().st_size > MAX_FILE_SIZE_BYTES:
return True
except OSError:
pass
return False
def file_marker(path: Path) -> tuple[int, int, int]:
try:
stat = path.stat()
except OSError:
return (0, 0, 0)
if not path.is_file():
return (0, 0, 0)
return (1, int(stat.st_size), int(stat.st_mtime_ns))
def metadata_marker(root: Path) -> WorkspaceMarker:
if not root.exists():
return (0, 0, 0, "")
file_count = 0
total_size = 0
newest_mtime = 0
metadata_hasher = hashlib.sha256()
for path in sorted(root.rglob("*")):
if not path.is_file():
continue
rel = path.relative_to(root).as_posix()
if _should_exclude(rel, path):
continue
try:
stat = path.stat()
except OSError:
continue
file_count += 1
size = int(stat.st_size)
mtime_ns = int(stat.st_mtime_ns)
total_size += size
newest_mtime = max(newest_mtime, mtime_ns)
metadata_hasher.update(rel.encode("utf-8"))
metadata_hasher.update(b"\0")
metadata_hasher.update(str(size).encode("ascii"))
metadata_hasher.update(b"\0")
metadata_hasher.update(str(mtime_ns).encode("ascii"))
metadata_hasher.update(b"\0")
return (file_count, total_size, newest_mtime, metadata_hasher.hexdigest())
def fingerprint_dir(root: Path) -> str:
hasher = hashlib.sha256()
if not root.exists():
return hasher.hexdigest()
for path in sorted(p for p in root.rglob("*") if p.is_file()):
rel = path.relative_to(root).as_posix()
if _should_exclude(rel, path):
continue
hasher.update(rel.encode("utf-8"))
try:
with path.open("rb") as handle:
for chunk in iter(lambda: handle.read(1024 * 1024), b""):
hasher.update(chunk)
except (FileNotFoundError, IsADirectoryError, NotADirectoryError):
# Fingerprint must represent a complete view of the workspace.
# Retry next sync pass instead of silently hashing a partial tree.
raise RuntimeError(
f"Workspace changed while hashing {rel}; retrying next sync pass."
)
return hasher.hexdigest()
def create_snapshot_dir(source_root: Path) -> Path:
staging_root = Path(tempfile.mkdtemp(prefix="huggingclaw-sync-"))
for path in sorted(source_root.rglob("*")):
rel = path.relative_to(source_root)
rel_posix = rel.as_posix()
if _should_exclude(rel_posix, path):
continue
target = staging_root / rel
if path.is_dir():
target.mkdir(parents=True, exist_ok=True)
continue
target.parent.mkdir(parents=True, exist_ok=True)
try:
shutil.copy2(path, target)
except (FileNotFoundError, IsADirectoryError, NotADirectoryError):
# Do not upload a partial snapshot; let caller retry on next loop.
raise RuntimeError(
f"Snapshot changed while copying {rel_posix}; retrying next sync pass."
)
return staging_root
def prune_remote_deleted_files(repo_id: str, snapshot_dir: Path) -> None:
if HF_API is None:
return
local_files = {
path.relative_to(snapshot_dir).as_posix()
for path in snapshot_dir.rglob("*")
if path.is_file()
}
remote_files = HF_API.list_repo_files(repo_id=repo_id, repo_type="dataset")
stale_files = [
path for path in remote_files
if path not in local_files and path not in {".gitattributes"}
]
if stale_files:
HF_API.delete_files(
delete_patterns=stale_files,
repo_id=repo_id,
repo_type="dataset",
commit_message="Prune stale files after workspace sync",
)
def restore_workspace() -> bool:
if not HF_TOKEN:
write_status("disabled", "HF_TOKEN is not configured.")
return False
repo_id = resolve_backup_namespace()
write_status("restoring", f"Restoring workspace from {repo_id}")
try:
with tempfile.TemporaryDirectory() as tmpdir:
snapshot_download(
repo_id=repo_id,
repo_type="dataset",
token=HF_TOKEN,
local_dir=tmpdir,
)
tmp_path = Path(tmpdir)
if not any(tmp_path.iterdir()):
write_status("fresh", "Backup dataset is empty. Starting fresh.")
return True
WORKSPACE.mkdir(parents=True, exist_ok=True)
for child in list(WORKSPACE.iterdir()):
if child.name == ".git":
continue
if child.is_dir():
shutil.rmtree(child, ignore_errors=True)
else:
child.unlink(missing_ok=True)
for child in tmp_path.iterdir():
if child.name == ".git":
continue
destination = WORKSPACE / child.name
if child.is_dir():
shutil.copytree(child, destination)
else:
shutil.copy2(child, destination)
restore_embedded_state()
write_status("restored", f"Restored workspace from {repo_id}")
return True
except RepositoryNotFoundError:
write_status("fresh", f"Backup dataset {repo_id} does not exist yet.")
return True
except HfHubHTTPError as exc:
if exc.response is not None and exc.response.status_code == 404:
write_status("fresh", f"Backup dataset {repo_id} does not exist yet.")
return True
write_status("error", f"Restore failed: {exc}")
print(f"Restore failed: {exc}", file=sys.stderr)
return False
except Exception as exc:
write_status("error", f"Restore failed: {exc}")
print(f"Restore failed: {exc}", file=sys.stderr)
return False
def _sync_once_unlocked(
last_fingerprint: str | None = None,
last_marker: WorkspaceMarker | None = None,
) -> tuple[str, WorkspaceMarker]:
if not HF_TOKEN:
write_status("disabled", "HF_TOKEN is not configured.")
return (last_fingerprint or "", last_marker or (0, 0, 0, ""))
snapshot_state_into_workspace()
repo_id = ensure_repo_exists()
current_marker = metadata_marker(WORKSPACE)
if last_marker is not None and current_marker == last_marker:
write_status("synced", "No workspace changes detected.")
return (last_fingerprint or "", current_marker)
current_fingerprint = fingerprint_dir(WORKSPACE)
if last_fingerprint is not None and current_fingerprint == last_fingerprint:
write_status("synced", "No workspace changes detected.")
return (last_fingerprint, current_marker)
write_status("syncing", f"Uploading workspace to {repo_id}")
snapshot_dir = create_snapshot_dir(WORKSPACE)
try:
try:
HF_API.upload_large_folder(
repo_id=repo_id,
repo_type="dataset",
folder_path=str(snapshot_dir),
num_workers=2,
print_report=False,
)
except AttributeError:
upload_folder(
folder_path=str(snapshot_dir),
repo_id=repo_id,
repo_type="dataset",
token=HF_TOKEN,
commit_message=f"HuggingClaw sync {time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime())}",
ignore_patterns=[".git/*", ".git"],
)
try:
prune_remote_deleted_files(repo_id, snapshot_dir)
except Exception as prune_exc:
print(f"Warning: could not prune stale remote files: {prune_exc}")
finally:
shutil.rmtree(snapshot_dir, ignore_errors=True)
write_status("success", f"Uploaded workspace to {repo_id}")
return (current_fingerprint, current_marker)
def sync_once(
last_fingerprint: str | None = None,
last_marker: WorkspaceMarker | None = None,
) -> tuple[str, WorkspaceMarker]:
SYNC_LOCK_FILE.parent.mkdir(parents=True, exist_ok=True)
with SYNC_LOCK_FILE.open("w", encoding="utf-8") as lock_handle:
fcntl.flock(lock_handle, fcntl.LOCK_EX)
try:
return _sync_once_unlocked(last_fingerprint, last_marker)
finally:
fcntl.flock(lock_handle, fcntl.LOCK_UN)
def handle_signal(_sig, _frame) -> None:
STOP_EVENT.set()
def is_valid_json_file(path: Path) -> bool:
if not path.exists():
return True
try:
json.loads(path.read_text(encoding="utf-8"))
return True
except Exception:
return False
def sessions_marker() -> tuple[int, int, int, str]:
"""Return a lightweight marker for all agent session directories.
OpenClaw can use agent profiles beyond "main". Watch every
*/sessions path under .openclaw/agents so session changes always trigger
syncs regardless of profile name.
"""
if not SESSIONS_ROOT.exists():
return (0, 0, 0, "")
file_count = 0
total_size = 0
newest_mtime = 0
metadata_hasher = hashlib.sha256()
global _SESSIONS_FILE_DIGEST_CACHE
next_cache: dict[str, tuple[int, int, int, str]] = {}
for profile_dir in sorted(SESSIONS_ROOT.iterdir()):
if not profile_dir.is_dir():
continue
sessions_dir = profile_dir / "sessions"
if not sessions_dir.exists():
continue
# Use content fingerprinting for sessions so we detect changes even
# when file size + mtime metadata appear unchanged across quick writes.
# (Some tooling can rewrite files in-place with preserved timestamps.)
marker = metadata_marker(sessions_dir)
digest = hashlib.sha256()
for path in sorted(p for p in sessions_dir.rglob("*") if p.is_file()):
rel = path.relative_to(sessions_dir).as_posix()
try:
stat = path.stat()
except OSError:
continue
size = int(stat.st_size)
mtime_ns = int(stat.st_mtime_ns)
ctime_ns = int(stat.st_ctime_ns)
cache_key = f"{profile_dir.name}\0{rel}"
digest.update(rel.encode("utf-8"))
digest.update(b"\0")
digest.update(str(size).encode("ascii"))
digest.update(b"\0")
digest.update(str(mtime_ns).encode("ascii"))
digest.update(b"\0")
digest.update(str(ctime_ns).encode("ascii"))
digest.update(b"\0")
cached = _SESSIONS_FILE_DIGEST_CACHE.get(cache_key)
if (
cached is not None
and cached[0] == size
and cached[1] == mtime_ns
and cached[2] == ctime_ns
):
file_digest = cached[3]
else:
file_hasher = hashlib.sha256()
try:
with path.open("rb") as handle:
for chunk in iter(lambda: handle.read(1024 * 1024), b""):
file_hasher.update(chunk)
except (FileNotFoundError, IsADirectoryError, NotADirectoryError):
continue
file_digest = file_hasher.hexdigest()
next_cache[cache_key] = (size, mtime_ns, ctime_ns, file_digest)
digest.update(file_digest.encode("ascii"))
digest.update(b"\0")
file_count += marker[0]
total_size += marker[1]
newest_mtime = max(newest_mtime, marker[2])
metadata_hasher.update(profile_dir.name.encode("utf-8"))
metadata_hasher.update(b"\0")
metadata_hasher.update(digest.hexdigest().encode("ascii"))
metadata_hasher.update(b"\0")
_SESSIONS_FILE_DIGEST_CACHE = next_cache
return (file_count, total_size, newest_mtime, metadata_hasher.hexdigest())
def wait_for_config_settle(config_marker: tuple[int, int, int]) -> tuple[str, tuple[int, int, int]]:
stable_since = time.monotonic()
current_marker = config_marker
while not STOP_EVENT.is_set():
latest_marker = file_marker(OPENCLAW_CONFIG_FILE)
if latest_marker != current_marker:
current_marker = latest_marker
stable_since = time.monotonic()
if (
time.monotonic() - stable_since >= CONFIG_SETTLE_SECONDS
and is_valid_json_file(OPENCLAW_CONFIG_FILE)
):
return ("settled", current_marker)
if STOP_EVENT.wait(CONFIG_WATCH_INTERVAL):
return ("stopped", current_marker)
return ("stopped", current_marker)
def wait_for_sync_trigger(
config_marker: tuple[int, int, int],
last_sessions_sync_time: float = 0.0,
) -> tuple[str, tuple[int, int, int]]:
deadline = time.monotonic() + max(0, INTERVAL)
# BUG FIX: also watch sessions directory so new/updated sessions
# trigger an immediate sync instead of waiting the full interval.
# Without this, sessions created between 180-second intervals were
# lost when the container restarted (e.g. HF Space going to sleep).
last_sessions_marker = sessions_marker()
while not STOP_EVENT.is_set():
current_config_marker = file_marker(OPENCLAW_CONFIG_FILE)
if current_config_marker != config_marker:
return wait_for_config_settle(current_config_marker)
sessions_gap_elapsed = (
time.monotonic() - last_sessions_sync_time >= SESSIONS_MIN_SYNC_GAP
)
if sessions_gap_elapsed:
# Sessions changed -> trigger sync immediately (no settle needed;
# session files are written atomically by OpenClaw).
current_sessions_marker = sessions_marker()
if current_sessions_marker != last_sessions_marker:
return ("sessions", current_config_marker)
remaining = deadline - time.monotonic()
if remaining <= 0:
return ("interval", current_config_marker)
wait_seconds = min(CONFIG_WATCH_INTERVAL, remaining)
if STOP_EVENT.wait(wait_seconds):
return ("stopped", current_config_marker)
return ("stopped", config_marker)
def loop() -> int:
signal.signal(signal.SIGTERM, handle_signal)
signal.signal(signal.SIGINT, handle_signal)
previous_status = read_status().get("status", "")
try:
repo_id = resolve_backup_namespace()
write_status("configured", f"Backup loop active for {repo_id} with {INTERVAL}s interval.")
except Exception as exc:
write_status("error", str(exc))
print(f"Workspace sync error: {exc}")
return 1
time.sleep(INITIAL_DELAY)
print(f"Workspace sync started: every {INTERVAL}s -> {repo_id}")
# Capture the restored dataset state before refreshing the embedded
# /home/node/.openclaw backup. Startup may have patched openclaw.json
# after restore (token/model/logging/channel toggles), and that patch only
# becomes part of the dataset once snapshot_state_into_workspace() copies it
# into workspace/huggingclaw-state/openclaw/. If the snapshot changes the
# workspace, seed the first sync with the pre-snapshot fingerprint so the
# updated openclaw.json is uploaded instead of being treated as the baseline.
pre_snapshot_fingerprint = fingerprint_dir(WORKSPACE)
pre_snapshot_marker = metadata_marker(WORKSPACE)
snapshot_state_into_workspace()
last_fingerprint = fingerprint_dir(WORKSPACE)
last_marker = metadata_marker(WORKSPACE)
if last_fingerprint != pre_snapshot_fingerprint:
if previous_status == "error":
print(
"Initial state snapshot changed, but restore previously failed; "
"keeping current state as baseline to avoid overwriting the remote backup."
)
else:
last_fingerprint = pre_snapshot_fingerprint
last_marker = pre_snapshot_marker
print("Initial state snapshot changed; first sync will upload refreshed OpenClaw state.")
else:
print("Initial workspace fingerprint captured.")
config_marker = file_marker(OPENCLAW_CONFIG_FILE)
last_sessions_sync_time = 0.0
sync_trigger = "startup"
while not STOP_EVENT.is_set():
try:
sync_started_config_marker = file_marker(OPENCLAW_CONFIG_FILE)
last_fingerprint, last_marker = sync_once(last_fingerprint, last_marker)
if sync_trigger == "sessions":
last_sessions_sync_time = time.monotonic()
config_marker = file_marker(OPENCLAW_CONFIG_FILE)
if config_marker != sync_started_config_marker:
trigger, config_marker = wait_for_config_settle(config_marker)
if trigger == "stopped":
break
print("OpenClaw config changed during sync; syncing again after it settled.")
continue
except Exception as exc:
write_status("error", f"Sync failed: {exc}")
print(f"Workspace sync failed: {exc}")
config_marker = file_marker(OPENCLAW_CONFIG_FILE)
STOP_EVENT.wait(min(30, SESSIONS_MIN_SYNC_GAP))
trigger, config_marker = wait_for_sync_trigger(
config_marker,
last_sessions_sync_time=last_sessions_sync_time,
)
if trigger == "stopped":
break
if trigger == "settled":
print("OpenClaw config changed and settled; syncing immediately.")
if trigger == "sessions":
print("Session files changed; syncing immediately.")
sync_trigger = trigger
return 0
def main() -> int:
WORKSPACE.mkdir(parents=True, exist_ok=True)
if len(sys.argv) < 2:
return loop()
command = sys.argv[1]
if command == "restore":
return 0 if restore_workspace() else 1
if command == "sync-once":
try:
sync_once()
return 0
except Exception as exc:
write_status("error", f"Shutdown sync failed: {exc}")
print(f"Workspace sync: shutdown sync failed: {exc}")
return 1
if command == "sync-once-settled":
try:
trigger, _ = wait_for_config_settle(file_marker(OPENCLAW_CONFIG_FILE))
if trigger == "stopped":
return 1
sync_once()
return 0
except Exception as exc:
write_status("error", f"Settled sync failed: {exc}")
print(f"Workspace sync: settled sync failed: {exc}")
return 1
if command == "loop":
return loop()
print(f"Unknown command: {command}", file=sys.stderr)
return 1
if __name__ == "__main__":
raise SystemExit(main())
|