优化微信同步超时兜底并下沉头像缓存预热
- 为 Msg/Sync 增加超时异常与主循环重试保护，避免启动阶段超时直接退出\n- 新增联系人头像缓存系统定时任务，启动时不再主动批量下载头像\n- 保留头像按需补下载能力，并补充详细中文注释
This commit is contained in:
@@ -43,6 +43,14 @@ def get_system_job_definitions(robot) -> List[Dict[str, Any]]:
|
||||
"trigger_config": {"seconds": 300},
|
||||
"handler": _build_process_pending_images_handler(robot),
|
||||
},
|
||||
{
|
||||
"job_key": "sync_contact_avatar_cache",
|
||||
"name": "联系人头像缓存同步",
|
||||
"description": "每 30 分钟增量同步一次联系人头像缓存，避免启动时集中下载",
|
||||
"trigger_type": "every_seconds",
|
||||
"trigger_config": {"seconds": 1800},
|
||||
"handler": robot.sync_contact_avatar_cache,
|
||||
},
|
||||
]
|
||||
|
||||
def _build_process_pending_images_handler(robot) -> Callable[[], Awaitable[None]]:
|
||||
|
||||
@@ -33,9 +33,6 @@ class ContactManager:
|
||||
_avatar_cache_dir: Optional[Path] = None
|
||||
_avatar_manifest_path: Optional[Path] = None
|
||||
_avatar_manifest: Dict[str, Dict[str, str]] = {}
|
||||
_avatar_sync_state_lock = threading.Lock()
|
||||
_avatar_sync_running = False
|
||||
_avatar_sync_pending = False
|
||||
# 定义公共好友列表
|
||||
_PUBLIC_FRIENDS = {
|
||||
'fmessage': '朋友推荐消息',
|
||||
@@ -95,54 +92,14 @@ class ContactManager:
|
||||
self._friends = friends
|
||||
self._head_images = head_imgs
|
||||
self._group_members = chatroom_members
|
||||
# 头像缓存同步改成后台异步触发：
|
||||
# 1. set_contacts 常出现在“刷新通讯录”主链路里，若同步下载头像会明显阻塞系统；
|
||||
# 2. 这里改成只提交后台任务，主线程先把联系人数据更新完立即返回；
|
||||
# 3. 后台线程会基于当前最新 head_images 做增量同步，不会丢掉头像更新。
|
||||
self._schedule_avatar_cache_sync(reason="set_contacts")
|
||||
# 这里不再在刷新通讯录时主动触发头像下载：
|
||||
# 1. 用户当前明确希望“启动时只加载联系人元数据，不要顺手拉整批头像”；
|
||||
# 2. 头像缓存改由独立定时任务统一批处理，降低启动期的网络和磁盘压力；
|
||||
# 3. 若后台页面或统计图提前访问头像，仍可走 `ensure_head_image_cached()` 按需补下载。
|
||||
self._logger.info(f"联系人信息已更新，共 {len(contacts)} 个联系人")
|
||||
# 分类联系人
|
||||
self._classify_contacts()
|
||||
|
||||
def _schedule_avatar_cache_sync(self, reason: str = "unknown") -> None:
|
||||
"""提交头像缓存后台同步任务，避免在主链路里同步下载头像。"""
|
||||
with self._avatar_sync_state_lock:
|
||||
self._avatar_sync_pending = True
|
||||
if self._avatar_sync_running:
|
||||
self._logger.debug(f"头像缓存后台同步已在执行，合并本次请求 reason={reason}")
|
||||
return
|
||||
self._avatar_sync_running = True
|
||||
worker = threading.Thread(
|
||||
target=self._avatar_sync_worker,
|
||||
args=(reason,),
|
||||
daemon=True,
|
||||
name="contact-avatar-sync",
|
||||
)
|
||||
worker.start()
|
||||
self._logger.debug(f"头像缓存后台同步已提交 reason={reason}")
|
||||
|
||||
def _avatar_sync_worker(self, initial_reason: str) -> None:
|
||||
"""串行消费头像缓存同步请求，确保高频更新时只跑最新一轮。"""
|
||||
trigger_reason = initial_reason
|
||||
while True:
|
||||
with self._avatar_sync_state_lock:
|
||||
self._avatar_sync_pending = False
|
||||
try:
|
||||
self._logger.debug(f"头像缓存后台同步开始 reason={trigger_reason}")
|
||||
self._sync_avatar_cache()
|
||||
except Exception as exc:
|
||||
self._logger.error(f"头像缓存后台同步失败 reason={trigger_reason}: {exc}")
|
||||
|
||||
with self._avatar_sync_state_lock:
|
||||
# 如果在本轮执行期间又收到了新的同步请求，就立刻再跑一轮，
|
||||
# 这样可以把多次 set_contacts/update_head_image 合并成少量批处理。
|
||||
if self._avatar_sync_pending:
|
||||
trigger_reason = "pending_update"
|
||||
continue
|
||||
self._avatar_sync_running = False
|
||||
self._logger.debug("头像缓存后台同步结束")
|
||||
break
|
||||
|
||||
def _init_avatar_cache(self) -> None:
|
||||
"""初始化头像缓存目录和 manifest。"""
|
||||
cache_dir = Path(__file__).resolve().parents[2] / "temp" / "contact_avatars"
|
||||
@@ -288,12 +245,30 @@ class ContactManager:
|
||||
response.close()
|
||||
return str(target_path)
|
||||
|
||||
def _sync_avatar_cache(self) -> None:
|
||||
"""按当前头像 URL 增量同步本地缓存。"""
|
||||
def sync_avatar_cache(self, reason: str = "manual") -> Dict[str, int]:
|
||||
"""按当前头像 URL 增量同步本地缓存。
|
||||
|
||||
Args:
|
||||
reason: 本次同步的触发来源，方便从日志区分是定时任务、人工触发还是别的入口。
|
||||
|
||||
Returns:
|
||||
Dict[str, int]: 本轮同步统计信息，便于调用方记录日志或观察执行效果。
|
||||
"""
|
||||
with self._avatar_cache_lock:
|
||||
head_images_snapshot = dict(self._head_images)
|
||||
if not head_images_snapshot:
|
||||
return
|
||||
self._logger.debug(f"头像缓存同步跳过 reason={reason} because no head images loaded")
|
||||
return {
|
||||
"total_head_images": 0,
|
||||
"manifest_entries": len(self._avatar_manifest),
|
||||
"reuse": 0,
|
||||
"downloaded": 0,
|
||||
"replaced": 0,
|
||||
"removed_contacts": 0,
|
||||
"removed_files": 0,
|
||||
"orphan_deleted": 0,
|
||||
"tmp_deleted": 0,
|
||||
}
|
||||
|
||||
manifest_changed = False
|
||||
# 统计字段用于打 debug 汇总日志，方便观察“初始化第一批头像”时到底发生了什么：
|
||||
@@ -357,18 +332,31 @@ class ContactManager:
|
||||
# 无论本轮 manifest 是否有变化，都顺手做一次目录对账，
|
||||
# 保证历史异常中断留下的孤儿文件也能逐步被回收。
|
||||
cleanup_stats = self._cleanup_avatar_cache_files()
|
||||
stats = {
|
||||
"total_head_images": len(active_wxids),
|
||||
"manifest_entries": len(self._avatar_manifest),
|
||||
"reuse": reuse_count,
|
||||
"downloaded": download_count,
|
||||
"replaced": replaced_count,
|
||||
"removed_contacts": removed_contact_count,
|
||||
"removed_files": removed_file_count,
|
||||
"orphan_deleted": cleanup_stats.get("orphan_deleted", 0),
|
||||
"tmp_deleted": cleanup_stats.get("tmp_deleted", 0),
|
||||
}
|
||||
self._logger.debug(
|
||||
"头像缓存同步完成 "
|
||||
f"total_head_images={len(active_wxids)} "
|
||||
f"manifest_entries={len(self._avatar_manifest)} "
|
||||
f"reuse={reuse_count} "
|
||||
f"downloaded={download_count} "
|
||||
f"replaced={replaced_count} "
|
||||
f"removed_contacts={removed_contact_count} "
|
||||
f"removed_files={removed_file_count} "
|
||||
f"orphan_deleted={cleanup_stats.get('orphan_deleted', 0)} "
|
||||
f"tmp_deleted={cleanup_stats.get('tmp_deleted', 0)}"
|
||||
f"reason={reason} "
|
||||
f"total_head_images={stats['total_head_images']} "
|
||||
f"manifest_entries={stats['manifest_entries']} "
|
||||
f"reuse={stats['reuse']} "
|
||||
f"downloaded={stats['downloaded']} "
|
||||
f"replaced={stats['replaced']} "
|
||||
f"removed_contacts={stats['removed_contacts']} "
|
||||
f"removed_files={stats['removed_files']} "
|
||||
f"orphan_deleted={stats['orphan_deleted']} "
|
||||
f"tmp_deleted={stats['tmp_deleted']}"
|
||||
)
|
||||
return stats
|
||||
|
||||
def get_cached_head_image_path(self, wxid: str) -> str:
|
||||
"""返回头像缓存本地路径，若缓存不存在则返回空字符串。"""
|
||||
@@ -553,11 +541,10 @@ class ContactManager:
|
||||
"""
|
||||
with self._avatar_cache_lock:
|
||||
self._head_images.update({wxid: head_image})
|
||||
# 单头像更新也改成后台异步：
|
||||
# 1. 入群欢迎、成员变更等实时链路不能被头像下载阻塞；
|
||||
# 2. 这里只更新最新远端 URL，并触发后台增量同步；
|
||||
# 3. 若页面提前访问该头像，/api/avatar 仍会按需补下载，不影响可用性。
|
||||
self._schedule_avatar_cache_sync(reason=f"update_head_image:{wxid}")
|
||||
# 单头像更新现在只更新内存里的最新远端 URL：
|
||||
# 1. 实时消息链路不再顺手触发下载，避免把头像同步重新带回主链路；
|
||||
# 2. 批量预热交给定时任务统一处理，减少碎片化下载；
|
||||
# 3. 若某个页面立刻需要这张头像，访问链路仍会按需补下载，不影响功能可用性。
|
||||
return True
|
||||
|
||||
def get_group_name(self, roomid: str, wxid: str) -> str:
|
||||
|
||||
Reference in New Issue
Block a user