chore: add serde events (#6954)

This commit is contained in:
William FH
2026-02-26 17:20:42 -08:00
committed by GitHub
parent adb953ddd4
commit 901ab6b3f8
10 changed files with 120 additions and 7 deletions
+1 -1
View File
@@ -259,7 +259,7 @@ wheels = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "../checkpoint" }
dependencies = [
{ name = "langchain-core" },
+1 -1
View File
@@ -268,7 +268,7 @@ wheels = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "../checkpoint" }
dependencies = [
{ name = "langchain-core" },
@@ -0,0 +1,52 @@
from __future__ import annotations
import logging
from collections.abc import Callable
from threading import Lock
from typing import TypedDict
from typing_extensions import NotRequired
logger = logging.getLogger(__name__)
class SerdeEvent(TypedDict):
kind: str
module: str
name: str
method: NotRequired[str]
SerdeEventListener = Callable[[SerdeEvent], None]
_listeners: list[SerdeEventListener] = []
_listeners_lock = Lock()
def register_serde_event_listener(listener: SerdeEventListener) -> Callable[[], None]:
"""Register a listener for serde allowlist events."""
with _listeners_lock:
_listeners.append(listener)
def unregister() -> None:
with _listeners_lock:
try:
_listeners.remove(listener)
except ValueError:
pass
return unregister
def emit_serde_event(event: SerdeEvent) -> None:
"""Emit a serde event to all listeners.
Listener failures are isolated and logged.
"""
with _listeners_lock:
listeners = tuple(_listeners)
for listener in listeners:
try:
listener(event)
except Exception:
logger.warning("Serde listener failed", exc_info=True)
@@ -32,6 +32,7 @@ from langchain_core.load.load import Reviver
from langgraph.checkpoint.serde import _msgpack as _lg_msgpack
from langgraph.checkpoint.serde.base import SerializerProtocol
from langgraph.checkpoint.serde.event_hooks import emit_serde_event
from langgraph.checkpoint.serde.types import SendProtocol
from langgraph.store.base import Item
@@ -519,6 +520,13 @@ def _create_msgpack_ext_hook(
if allowed_modules is True:
# default is to warn but allow unregistered types
emit_serde_event(
{
"kind": "msgpack_unregistered_allowed",
"module": module,
"name": name,
}
)
logger.warning(
"Deserializing unregistered type %s.%s from checkpoint. "
"This will be blocked in a future version. "
@@ -533,6 +541,13 @@ def _create_msgpack_ext_hook(
if key in allowed_modules:
return True
# strict mode blocks unregistered types
emit_serde_event(
{
"kind": "msgpack_blocked",
"module": module,
"name": name,
}
)
logger.warning(
"Blocked deserialization of %s.%s - not in allowed_msgpack_modules. "
"Add to allowed_msgpack_modules to allow: [(%r, %r)]",
@@ -548,6 +563,14 @@ def _create_msgpack_ext_hook(
key = (module, name, method)
if key in _lg_msgpack.SAFE_MSGPACK_METHODS:
return True
emit_serde_event(
{
"kind": "msgpack_method_blocked",
"module": module,
"name": name,
"method": method,
}
)
logger.warning(
"Blocked deserialization of method call %s.%s.%s - "
"not in allowed methods set.",
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
description = "Library with base interfaces for LangGraph checkpoint savers."
authors = []
requires-python = ">=3.10"
+38
View File
@@ -25,6 +25,10 @@ from pydantic.v1 import SecretStr as SecretStrV1
from langgraph.checkpoint.serde import _msgpack as _lg_msgpack
from langgraph.checkpoint.serde._msgpack import AllowedMsgpackModules
from langgraph.checkpoint.serde.event_hooks import (
SerdeEvent,
register_serde_event_listener,
)
from langgraph.checkpoint.serde.jsonplus import (
EXT_METHOD_SINGLE_ARG,
InvalidModuleError,
@@ -670,6 +674,40 @@ def test_msgpack_allowlist_blocks_non_listed(
assert result == expected
def test_msgpack_blocked_emits_event() -> None:
events: list[SerdeEvent] = []
unregister = register_serde_event_listener(events.append)
try:
serde = JsonPlusSerializer(allowed_msgpack_modules=None)
obj = AnotherPydantic(foo="nope")
serde.loads_typed(serde.dumps_typed(obj))
finally:
unregister()
assert {
"kind": "msgpack_blocked",
"module": "tests.test_jsonplus",
"name": "AnotherPydantic",
} in events
def test_msgpack_unregistered_allowed_emits_event() -> None:
events: list[SerdeEvent] = []
unregister = register_serde_event_listener(events.append)
try:
serde = JsonPlusSerializer(allowed_msgpack_modules=True)
obj = AnotherPydantic(foo="ok")
serde.loads_typed(serde.dumps_typed(obj))
finally:
unregister()
assert {
"kind": "msgpack_unregistered_allowed",
"module": "tests.test_jsonplus",
"name": "AnotherPydantic",
} in events
def test_msgpack_strict_allows_safe_types(
caplog: pytest.LogCaptureFixture,
) -> None:
+1 -1
View File
@@ -286,7 +286,7 @@ wheels = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "." }
dependencies = [
{ name = "langchain-core" },
+1 -1
View File
@@ -1548,7 +1548,7 @@ wheels = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "../checkpoint" }
dependencies = [
{ name = "langchain-core" },
+1 -1
View File
@@ -352,7 +352,7 @@ test = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "../checkpoint" }
dependencies = [
{ name = "langchain-core" },
+1 -1
View File
@@ -349,7 +349,7 @@ test = [
[[package]]
name = "langgraph-checkpoint"
version = "4.0.1rc3"
version = "4.0.1rc4"
source = { editable = "../checkpoint" }
dependencies = [
{ name = "langchain-core" },