The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.
fix(api-nodes): add separate retry budget for 429 rate limit responses (#12421)
Alexander Piskun4a93a62371b6
diff --git a/comfy_api_nodes/util/client.py b/comfy_api_nodes/util/client.pyindex 391748e7a..94886af7b 100644--- a/comfy_api_nodes/util/client.py+++ b/comfy_api_nodes/util/client.py@@ -57,6 +57,7 @@ class _RequestConfig:files: dict[str, Any] | list[tuple[str, Any]] | Nonemultipart_parser: Callable | Nonemax_retries: int+ max_retries_on_rate_limit: intretry_delay: floatretry_backoff: floatwait_label: str = "Waiting"@@ -65,6 +66,7 @@ class _RequestConfig:final_label_on_success: str | None = "Completed"progress_origin_ts: float | None = Noneprice_extractor: Callable[[dict[str, Any]], float | None] | None = None+ is_rate_limited: Callable[[int, Any], bool] | None = None@dataclass@@ -78,7 +80,7 @@ class _PollUIState:active_since: float | None = None # start time of current active interval (None if queued)-_RETRY_STATUS = {408, 429, 500, 502, 503, 504}+_RETRY_STATUS = {408, 500, 502, 503, 504} # status 429 is handled separatelyCOMPLETED_STATUSES = ["succeeded", "succeed", "success", "completed", "finished", "done", "complete"]FAILED_STATUSES = ["cancelled", "canceled", "canceling", "fail", "failed", "error"]QUEUED_STATUSES = ["created", "queued", "queueing", "submitted", "initializing"]@@ -103,6 +105,8 @@ async def sync_op(final_label_on_success: str | None = "Completed",progress_origin_ts: float | None = None,monitor_progress: bool = True,+ max_retries_on_rate_limit: int = 16,+ is_rate_limited: Callable[[int, Any], bool] | None = None,) -> M:raw = await sync_op_raw(cls,@@ -122,6 +126,8 @@ async def sync_op(final_label_on_success=final_label_on_success,progress_origin_ts=progress_origin_ts,monitor_progress=monitor_progress,+ max_retries_on_rate_limit=max_retries_on_rate_limit,+ is_rate_limited=is_rate_limited,)if not isinstance(raw, dict):raise Exception("Expected JSON response to validate into a Pydantic model, got non-JSON (binary or text).")@@ -194,6 +200,8 @@ async def sync_op_raw(final_label_on_success: str | None = "Completed",progress_origin_ts: float | None = None,monitor_progress: bool = True,+ max_retries_on_rate_limit: int = 16,+ is_rate_limited: Callable[[int, Any], bool] | None = None,) -> dict[str, Any] | bytes:"""Make a single network request.@@ -222,6 +230,8 @@ async def sync_op_raw(final_label_on_success=final_label_on_success,progress_origin_ts=progress_origin_ts,price_extractor=price_extractor,+ max_retries_on_rate_limit=max_retries_on_rate_limit,+ is_rate_limited=is_rate_limited,)return await _request_base(cfg, expect_binary=as_binary)@@ -506,7 +516,7 @@ def _friendly_http_message(status: int, body: Any) -> str:if status == 409:return "There is a problem with your account. Please contact [email protected]."if status == 429:- return "Rate Limit Exceeded: Please try again later."+ return "Rate Limit Exceeded: The server returned 429 after all retry attempts. Please wait and try again."try:if isinstance(body, dict):err = body.get("error")@@ -586,6 +596,8 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):start_time = cfg.progress_origin_ts if cfg.progress_origin_ts is not None else time.monotonic()attempt = 0delay = cfg.retry_delay+ rate_limit_attempts = 0+ rate_limit_delay = cfg.retry_delayoperation_succeeded: bool = Falsefinal_elapsed_seconds: int | None = Noneextracted_price: float | None = None@@ -653,17 +665,14 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):payload_headers["Content-Type"] = "application/json"payload_kw["json"] = cfg.data or {}- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- request_headers=dict(payload_headers) if payload_headers else None,- request_params=dict(params) if params else None,- request_data=request_body_log,- )- except Exception as _log_e:- logging.debug("[DEBUG] request logging failed: %s", _log_e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ request_headers=dict(payload_headers) if payload_headers else None,+ request_params=dict(params) if params else None,+ request_data=request_body_log,+ )req_coro = sess.request(method, url, params=params, **payload_kw)req_task = asyncio.create_task(req_coro)@@ -688,52 +697,61 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):body = await resp.json()except (ContentTypeError, json.JSONDecodeError):body = await resp.text()- if resp.status in _RETRY_STATUS and attempt <= cfg.max_retries:+ should_retry = False+ wait_time = 0.0+ retry_label = ""+ is_rl = resp.status == 429 or (+ cfg.is_rate_limited is not None and cfg.is_rate_limited(resp.status, body)+ )+ if is_rl and rate_limit_attempts < cfg.max_retries_on_rate_limit:+ rate_limit_attempts += 1+ wait_time = min(rate_limit_delay, 30.0)+ rate_limit_delay *= cfg.retry_backoff+ retry_label = f"rate-limit retry {rate_limit_attempts} of {cfg.max_retries_on_rate_limit}"+ should_retry = True+ elif resp.status in _RETRY_STATUS and (attempt - rate_limit_attempts) <= cfg.max_retries:+ wait_time = delay+ delay *= cfg.retry_backoff+ retry_label = f"retry {attempt - rate_limit_attempts} of {cfg.max_retries}"+ should_retry = True++ if should_retry:logging.warning(- "HTTP %s %s -> %s. Retrying in %.2fs (retry %d of %d).",+ "HTTP %s %s -> %s. Waiting %.2fs (%s).",method,url,resp.status,- delay,- attempt,- cfg.max_retries,+ wait_time,+ retry_label,+ )+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content=body,+ error_message=f"HTTP {resp.status} ({retry_label}, will retry in {wait_time:.1f}s)",)- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content=body,- error_message=_friendly_http_message(resp.status, body),- )- except Exception as _log_e:- logging.debug("[DEBUG] response logging failed: %s", _log_e)-await sleep_with_interrupt(- delay,+ wait_time,cfg.node_cls,cfg.wait_label if cfg.monitor_progress else None,start_time if cfg.monitor_progress else None,cfg.estimated_total,display_callback=_display_time_progress if cfg.monitor_progress else None,)- delay *= cfg.retry_backoffcontinuemsg = _friendly_http_message(resp.status, body)- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content=body,- error_message=msg,- )- except Exception as _log_e:- logging.debug("[DEBUG] response logging failed: %s", _log_e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content=body,+ error_message=msg,+ )raise Exception(msg)if expect_binary:@@ -753,17 +771,14 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):bytes_payload = bytes(buff)operation_succeeded = Truefinal_elapsed_seconds = int(time.monotonic() - start_time)- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content=bytes_payload,- )- except Exception as _log_e:- logging.debug("[DEBUG] response logging failed: %s", _log_e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content=bytes_payload,+ )return bytes_payloadelse:try:@@ -780,45 +795,39 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):extracted_price = cfg.price_extractor(payload) if cfg.price_extractor else Noneoperation_succeeded = Truefinal_elapsed_seconds = int(time.monotonic() - start_time)- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content=response_content_to_log,- )- except Exception as _log_e:- logging.debug("[DEBUG] response logging failed: %s", _log_e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content=response_content_to_log,+ )return payloadexcept ProcessingInterrupted:logging.debug("Polling was interrupted by user")raiseexcept (ClientError, OSError) as e:- if attempt <= cfg.max_retries:+ if (attempt - rate_limit_attempts) <= cfg.max_retries:logging.warning("Connection error calling %s %s. Retrying in %.2fs (%d/%d): %s",method,url,delay,- attempt,+ attempt - rate_limit_attempts,cfg.max_retries,str(e),)- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- request_headers=dict(payload_headers) if payload_headers else None,- request_params=dict(params) if params else None,- request_data=request_body_log,- error_message=f"{type(e).__name__}: {str(e)} (will retry)",- )- except Exception as _log_e:- logging.debug("[DEBUG] request error logging failed: %s", _log_e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ request_headers=dict(payload_headers) if payload_headers else None,+ request_params=dict(params) if params else None,+ request_data=request_body_log,+ error_message=f"{type(e).__name__}: {str(e)} (will retry)",+ )await sleep_with_interrupt(delay,cfg.node_cls,@@ -831,23 +840,6 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):continuediag = await _diagnose_connectivity()if not diag["internet_accessible"]:- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method=method,- request_url=url,- request_headers=dict(payload_headers) if payload_headers else None,- request_params=dict(params) if params else None,- request_data=request_body_log,- error_message=f"LocalNetworkError: {str(e)}",- )- except Exception as _log_e:- logging.debug("[DEBUG] final error logging failed: %s", _log_e)- raise LocalNetworkError(- "Unable to connect to the API server due to local network issues. "- "Please check your internet connection and try again."- ) from e- try:request_logger.log_request_response(operation_id=operation_id,request_method=method,@@ -855,10 +847,21 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):request_headers=dict(payload_headers) if payload_headers else None,request_params=dict(params) if params else None,request_data=request_body_log,- error_message=f"ApiServerError: {str(e)}",+ error_message=f"LocalNetworkError: {str(e)}",)- except Exception as _log_e:- logging.debug("[DEBUG] final error logging failed: %s", _log_e)+ raise LocalNetworkError(+ "Unable to connect to the API server due to local network issues. "+ "Please check your internet connection and try again."+ ) from e+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method=method,+ request_url=url,+ request_headers=dict(payload_headers) if payload_headers else None,+ request_params=dict(params) if params else None,+ request_data=request_body_log,+ error_message=f"ApiServerError: {str(e)}",+ )raise ApiServerError(f"The API server at {default_base_url()} is currently unreachable. "f"The service may be experiencing issues."diff --git a/comfy_api_nodes/util/download_helpers.py b/comfy_api_nodes/util/download_helpers.pyindex 78bcf1fa1..aa588d038 100644--- a/comfy_api_nodes/util/download_helpers.py+++ b/comfy_api_nodes/util/download_helpers.py@@ -167,27 +167,25 @@ async def download_url_to_bytesio(with contextlib.suppress(Exception):dest.seek(0)- with contextlib.suppress(Exception):- request_logger.log_request_response(- operation_id=op_id,- request_method="GET",- request_url=url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content=f"[streamed {written} bytes to dest]",- )+ request_logger.log_request_response(+ operation_id=op_id,+ request_method="GET",+ request_url=url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content=f"[streamed {written} bytes to dest]",+ )returnexcept asyncio.CancelledError:raise ProcessingInterrupted("Task cancelled") from Noneexcept (ClientError, OSError) as e:if attempt <= max_retries:- with contextlib.suppress(Exception):- request_logger.log_request_response(- operation_id=op_id,- request_method="GET",- request_url=url,- error_message=f"{type(e).__name__}: {str(e)} (will retry)",- )+ request_logger.log_request_response(+ operation_id=op_id,+ request_method="GET",+ request_url=url,+ error_message=f"{type(e).__name__}: {str(e)} (will retry)",+ )await sleep_with_interrupt(delay, cls, None, None, None)delay *= retry_backoffcontinuediff --git a/comfy_api_nodes/util/request_logger.py b/comfy_api_nodes/util/request_logger.pyindex e0cb4428d..fe0543d9b 100644--- a/comfy_api_nodes/util/request_logger.py+++ b/comfy_api_nodes/util/request_logger.py@@ -8,7 +8,6 @@ from typing import Anyimport folder_paths-# Get the logger instancelogger = logging.getLogger(__name__)@@ -91,38 +90,41 @@ def log_request_response(Filenames are sanitized and length-limited for cross-platform safety.If we still fail to write, we fall back to appending into api.log."""- log_dir = get_log_directory()- filepath = _build_log_filepath(log_dir, operation_id, request_url)-- log_content: list[str] = []- log_content.append(f"Timestamp: {datetime.datetime.now().isoformat()}")- log_content.append(f"Operation ID: {operation_id}")- log_content.append("-" * 30 + " REQUEST " + "-" * 30)- log_content.append(f"Method: {request_method}")- log_content.append(f"URL: {request_url}")- if request_headers:- log_content.append(f"Headers:\n{_format_data_for_logging(request_headers)}")- if request_params:- log_content.append(f"Params:\n{_format_data_for_logging(request_params)}")- if request_data is not None:- log_content.append(f"Data/Body:\n{_format_data_for_logging(request_data)}")-- log_content.append("\n" + "-" * 30 + " RESPONSE " + "-" * 30)- if response_status_code is not None:- log_content.append(f"Status Code: {response_status_code}")- if response_headers:- log_content.append(f"Headers:\n{_format_data_for_logging(response_headers)}")- if response_content is not None:- log_content.append(f"Content:\n{_format_data_for_logging(response_content)}")- if error_message:- log_content.append(f"Error:\n{error_message}")-try:- with open(filepath, "w", encoding="utf-8") as f:- f.write("\n".join(log_content))- logger.debug("API log saved to: %s", filepath)- except Exception as e:- logger.error("Error writing API log to %s: %s", filepath, str(e))+ log_dir = get_log_directory()+ filepath = _build_log_filepath(log_dir, operation_id, request_url)++ log_content: list[str] = []+ log_content.append(f"Timestamp: {datetime.datetime.now().isoformat()}")+ log_content.append(f"Operation ID: {operation_id}")+ log_content.append("-" * 30 + " REQUEST " + "-" * 30)+ log_content.append(f"Method: {request_method}")+ log_content.append(f"URL: {request_url}")+ if request_headers:+ log_content.append(f"Headers:\n{_format_data_for_logging(request_headers)}")+ if request_params:+ log_content.append(f"Params:\n{_format_data_for_logging(request_params)}")+ if request_data is not None:+ log_content.append(f"Data/Body:\n{_format_data_for_logging(request_data)}")++ log_content.append("\n" + "-" * 30 + " RESPONSE " + "-" * 30)+ if response_status_code is not None:+ log_content.append(f"Status Code: {response_status_code}")+ if response_headers:+ log_content.append(f"Headers:\n{_format_data_for_logging(response_headers)}")+ if response_content is not None:+ log_content.append(f"Content:\n{_format_data_for_logging(response_content)}")+ if error_message:+ log_content.append(f"Error:\n{error_message}")++ try:+ with open(filepath, "w", encoding="utf-8") as f:+ f.write("\n".join(log_content))+ logger.debug("API log saved to: %s", filepath)+ except Exception as e:+ logger.error("Error writing API log to %s: %s", filepath, str(e))+ except Exception as _log_e:+ logging.debug("[DEBUG] log_request_response failed: %s", _log_e)if __name__ == '__main__':diff --git a/comfy_api_nodes/util/upload_helpers.py b/comfy_api_nodes/util/upload_helpers.pyindex 83d936ce1..7cc565263 100644--- a/comfy_api_nodes/util/upload_helpers.py+++ b/comfy_api_nodes/util/upload_helpers.py@@ -255,17 +255,14 @@ async def upload_file(monitor_task = asyncio.create_task(_monitor())sess: aiohttp.ClientSession | None = Nonetry:- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method="PUT",- request_url=upload_url,- request_headers=headers or None,- request_params=None,- request_data=f"[File data {len(data)} bytes]",- )- except Exception as e:- logging.debug("[DEBUG] upload request logging failed: %s", e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method="PUT",+ request_url=upload_url,+ request_headers=headers or None,+ request_params=None,+ request_data=f"[File data {len(data)} bytes]",+ )sess = aiohttp.ClientSession(timeout=timeout)req = sess.put(upload_url, data=data, headers=headers, skip_auto_headers=skip_auto_headers)@@ -311,31 +308,27 @@ async def upload_file(delay *= retry_backoffcontinueraise Exception(f"Failed to upload (HTTP {resp.status}).")- try:- request_logger.log_request_response(- operation_id=operation_id,- request_method="PUT",- request_url=upload_url,- response_status_code=resp.status,- response_headers=dict(resp.headers),- response_content="File uploaded successfully.",- )- except Exception as e:- logging.debug("[DEBUG] upload response logging failed: %s", e)+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method="PUT",+ request_url=upload_url,+ response_status_code=resp.status,+ response_headers=dict(resp.headers),+ response_content="File uploaded successfully.",+ )returnexcept asyncio.CancelledError:raise ProcessingInterrupted("Task cancelled") from Noneexcept (aiohttp.ClientError, OSError) as e:if attempt <= max_retries:- with contextlib.suppress(Exception):- request_logger.log_request_response(- operation_id=operation_id,- request_method="PUT",- request_url=upload_url,- request_headers=headers or None,- request_data=f"[File data {len(data)} bytes]",- error_message=f"{type(e).__name__}: {str(e)} (will retry)",- )+ request_logger.log_request_response(+ operation_id=operation_id,+ request_method="PUT",+ request_url=upload_url,+ request_headers=headers or None,+ request_data=f"[File data {len(data)} bytes]",+ error_message=f"{type(e).__name__}: {str(e)} (will retry)",+ )await sleep_with_interrupt(delay,cls,