Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
fix(sdk): omit null/empty request fields so older instances accept them (#2834)
t0saki3d456ff44214
diff --git a/sdk/python/openviking_sdk/client.py b/sdk/python/openviking_sdk/client.pyindex b4419be71..f5f983877 100644--- a/sdk/python/openviking_sdk/client.py+++ b/sdk/python/openviking_sdk/client.py@@ -286,6 +286,30 @@ class AsyncHTTPClient:return VikingURI.normalize(target_uri)return target_uri+ @staticmethod+ def _compact_request_body(body: Dict[str, Any]) -> Dict[str, Any]:+ """Drop None-valued keys (and an empty ``args`` object) from a request body.++ Older, stricter servers use ``model_config = ConfigDict(extra="forbid")`` and+ reject any field they do not yet define, so unconditionally attaching optional+ fields (even as ``null``/``{}``) breaks against instances that predate that+ field — e.g. ``body.tags`` against a pre-#2706 ``find`` route, or ``body.args``+ against a pre-#2549 ``resources`` route. Omitting them is safe for read/create+ routes where a missing optional field and an explicit ``null`` are equivalent.+ Do NOT use this for update/PATCH bodies where ``null`` may mean "clear this+ field". Mirrors the CLI's ``compact_request_body`` (see PR #2799).+ """+ compacted: Dict[str, Any] = {}+ for key, value in body.items():+ if value is None:+ continue+ # `args` is always attached by callers but absent from pre-#2549 models;+ # only forward it when arguments were actually provided.+ if key == "args" and isinstance(value, dict) and not value:+ continue+ compacted[key] = value+ return compacted+def _handle_response_data(self, response: httpx.Response) -> Dict[str, Any]:try:data = response.json()@@ -438,6 +462,7 @@ class AsyncHTTPClient:else:request_data["path"] = path+ request_data = self._compact_request_body(request_data)response = await self._http.post("/api/v1/resources", json=request_data)return self._handle_response_data(response).get("result", {})@@ -867,6 +892,7 @@ class AsyncHTTPClient:"tags": tags,"telemetry": telemetry,}+ payload = self._compact_request_body(payload)response = await self._http.post("/api/v1/search/find", json=payload)return self._handle_response_data(response).get("result", {})@@ -897,6 +923,7 @@ class AsyncHTTPClient:"tags": tags,"telemetry": telemetry,}+ payload = self._compact_request_body(payload)response = await self._http.post("/api/v1/search/search", json=payload)return self._handle_response_data(response).get("result", {})diff --git a/tests/client/test_http_client_compact.py b/tests/client/test_http_client_compact.pynew file mode 100644index 000000000..cdedaa4da--- /dev/null+++ b/tests/client/test_http_client_compact.py@@ -0,0 +1,116 @@+"""Unit tests for request-body compaction on find/search/add_resource.++Older OpenViking instances use ``model_config = ConfigDict(extra="forbid")`` and+reject any field they do not yet define. The SDK must not attach optional fields+as ``null``/``{}`` when the caller never set them, otherwise the whole request+fails with ``body.<field>: Extra inputs are not permitted`` (see PR #2799 for the+equivalent CLI fix).+"""++from typing import Any, Dict, List++from openviking_cli.client.http import AsyncHTTPClient+++class _FakeHTTPClient:+ """Records the last request and returns a canned response."""++ def __init__(self):+ self.calls: List[Dict[str, Any]] = []+ self.next_response: Any = object()++ async def post(self, path, *, json=None, headers=None):+ self.calls.append({"method": "POST", "path": path, "json": json, "headers": headers})+ return self.next_response+++def _client_with_fake() -> tuple[AsyncHTTPClient, _FakeHTTPClient]:+ client = AsyncHTTPClient(url="http://localhost:1933")+ fake = _FakeHTTPClient()+ client._http = fake+ client._handle_response_data = lambda response: {"result": {}}+ return client, fake+++def test_compact_request_body_drops_null_and_empty_args():+ body = {+ "query": "hi",+ "score_threshold": None,+ "tags": None,+ "args": {},+ "wait": False,+ "create_parent": True,+ "filter": {"k": "v"},+ }+ compacted = AsyncHTTPClient._compact_request_body(body)+ # Non-null values are kept, including `False` and non-empty objects.+ assert compacted["query"] == "hi"+ assert compacted["wait"] is False+ assert compacted["create_parent"] is True+ assert compacted["filter"] == {"k": "v"}+ # Null fields and an empty `args` are dropped so pre-field servers accept it.+ assert "score_threshold" not in compacted+ assert "tags" not in compacted+ assert "args" not in compacted+++def test_compact_request_body_keeps_non_empty_args():+ body = {"path": "x", "args": {"feishu_access_token": "u-x"}}+ compacted = AsyncHTTPClient._compact_request_body(body)+ assert compacted["args"] == {"feishu_access_token": "u-x"}+++async def test_find_omits_unset_optional_fields():+ client, fake = _client_with_fake()++ await client.find("hello")++ payload = fake.calls[-1]["json"]+ assert payload["query"] == "hello"+ assert payload["limit"] == 10+ # `tags` is the field that breaks `find` against pre-#2706 strict instances.+ for dropped in ("score_threshold", "filter", "context_type", "tags"):+ assert dropped not in payload+++async def test_find_keeps_explicit_tags():+ client, fake = _client_with_fake()++ await client.find("hello", tags=["a", "b"])++ payload = fake.calls[-1]["json"]+ assert payload["tags"] == ["a", "b"]+++async def test_search_omits_unset_optional_fields():+ client, fake = _client_with_fake()++ await client.search("hello")++ payload = fake.calls[-1]["json"]+ assert payload["query"] == "hello"+ for dropped in ("session_id", "score_threshold", "filter", "context_type", "tags"):+ assert dropped not in payload+++async def test_add_resource_omits_empty_args_and_null_fields():+ client, fake = _client_with_fake()++ # A non-existent path is sent as a plain `path` body (no temp-file upload).+ await client.add_resource("https://example.com/doc")++ payload = fake.calls[-1]["json"]+ assert payload["path"] == "https://example.com/doc"+ # `args` is the field that breaks `add-resource` against pre-#2549 instances.+ assert "args" not in payload+ for dropped in ("to", "parent", "timeout", "ignore_dirs", "include", "exclude"):+ assert dropped not in payload+++async def test_add_resource_keeps_explicit_args():+ client, fake = _client_with_fake()++ await client.add_resource("https://example.com/doc", args={"feishu_access_token": "u-x"})++ payload = fake.calls[-1]["json"]+ assert payload["args"] == {"feishu_access_token": "u-x"}