feat(cli): Platform option parity across Python and Node CLIs (MEM-5893) (#6696)

2026-08-03 17:10:44 +05:30
parent 50bdaaea0c
commit c90bdbdce0
29 changed files with 2030 additions and 541 deletions
@@ -252,12 +252,13 @@ class TestAddCommand:
            )
        mock_backend.add.assert_called_once()

-    def test_add_categories_csv(self, mock_backend):
+    def test_add_categories_rejected(self, mock_backend):
        console, _buf = _make_console()
-        err_console, _err_buf = _make_err_console()
+        err_console, err_buf = _make_err_console()
        with (
            patch("mem0_cli.commands.memory.console", console),
            patch("mem0_cli.commands.memory.err_console", err_console),
+            pytest.raises((SystemExit, TyperExit)),
        ):
            cmd_add(
                mock_backend,
@@ -275,7 +276,93 @@ class TestAddCommand:
                categories="health,prefs",
                output="text",
            )
-        mock_backend.add.assert_called_once()
+        assert "--custom-categories" in err_buf.getvalue()
+        mock_backend.add.assert_not_called()
+
+    def test_add_invalid_custom_categories_json(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+            pytest.raises((SystemExit, TyperExit)),
+        ):
+            cmd_add(
+                mock_backend,
+                "test",
+                user_id="alice",
+                agent_id=None,
+                app_id=None,
+                run_id=None,
+                messages=None,
+                file=None,
+                metadata=None,
+                immutable=False,
+                no_infer=False,
+                expires=None,
+                categories=None,
+                custom_categories="not-json",
+                output="text",
+            )
+        assert "--custom-categories" in err_buf.getvalue()
+        mock_backend.add.assert_not_called()
+
+    def test_add_invalid_structured_data_schema_json(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+            pytest.raises((SystemExit, TyperExit)),
+        ):
+            cmd_add(
+                mock_backend,
+                "test",
+                user_id="alice",
+                agent_id=None,
+                app_id=None,
+                run_id=None,
+                messages=None,
+                file=None,
+                metadata=None,
+                immutable=False,
+                no_infer=False,
+                expires=None,
+                categories=None,
+                structured_data_schema="not-json",
+                output="text",
+            )
+        assert "--structured-data-schema" in err_buf.getvalue()
+        mock_backend.add.assert_not_called()
+
+    def test_add_regression_metadata_expiration_custom_categories_together(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, _err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+        ):
+            cmd_add(
+                mock_backend,
+                "test",
+                user_id="alice",
+                agent_id=None,
+                app_id=None,
+                run_id=None,
+                messages=None,
+                file=None,
+                metadata='{"source": "test"}',
+                immutable=False,
+                no_infer=False,
+                expires="2099-01-01",
+                categories=None,
+                custom_categories='[{"prefs": "user preferences"}]',
+                output="text",
+            )
+        call_kwargs = mock_backend.add.call_args.kwargs
+        assert call_kwargs["metadata"] == {"source": "test"}
+        assert call_kwargs["expires"] == "2099-01-01"
+        assert call_kwargs["custom_categories"] == [{"prefs": "user preferences"}]


 class TestAddDeduplicatesPending:
@@ -464,6 +551,36 @@ class TestSearchCommand:
            )
        mock_backend.search.assert_called_once()

+    def test_search_new_flags_reach_backend(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, _err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+        ):
+            cmd_search(
+                mock_backend,
+                "preferences",
+                user_id="alice",
+                agent_id=None,
+                app_id=None,
+                run_id=None,
+                top_k=10,
+                threshold=0.3,
+                rerank=False,
+                keyword=False,
+                filter_json=None,
+                fields=None,
+                show_expired=True,
+                reference_date="2024-01-01",
+                latest_only=True,
+                output="text",
+            )
+        call_kwargs = mock_backend.search.call_args.kwargs
+        assert call_kwargs["show_expired"] is True
+        assert call_kwargs["reference_date"] == "2024-01-01"
+        assert call_kwargs["latest_only"] is True
+

 class TestGetCommand:
    def test_get_text(self, mock_backend):
@@ -561,6 +678,32 @@ class TestListCommand:
        output = buf.getvalue()
        assert "No memories found" in output

+    def test_list_new_flags_reach_backend(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, _err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+        ):
+            cmd_list(
+                mock_backend,
+                user_id="alice",
+                agent_id=None,
+                app_id=None,
+                run_id=None,
+                page=1,
+                page_size=100,
+                category=None,
+                after=None,
+                before=None,
+                show_expired=True,
+                latest_only=True,
+                output="table",
+            )
+        call_kwargs = mock_backend.list_memories.call_args.kwargs
+        assert call_kwargs["show_expired"] is True
+        assert call_kwargs["latest_only"] is True
+

 class TestUpdateCommand:
    def test_update(self, mock_backend):
@@ -585,6 +728,26 @@ class TestUpdateCommand:
        output = buf.getvalue()
        assert '"memory"' in output

+    def test_update_new_fields_reach_backend(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, _err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+        ):
+            cmd_update(
+                mock_backend,
+                "abc-123",
+                "New text",
+                metadata=None,
+                expires="2099-01-01",
+                timestamp=1700000000,
+                output="text",
+            )
+        call_kwargs = mock_backend.update.call_args.kwargs
+        assert call_kwargs["expiration_date"] == "2099-01-01"
+        assert call_kwargs["timestamp"] == 1700000000
+

 class TestDeleteCommand:
    def test_delete_single(self, mock_backend):
@@ -610,6 +773,17 @@ class TestDeleteCommand:
        assert "dry run" in output.lower()
        mock_backend.delete.assert_not_called()

+    def test_delete_linked_reaches_backend(self, mock_backend):
+        console, _buf = _make_console()
+        err_console, _err_buf = _make_err_console()
+        with (
+            patch("mem0_cli.commands.memory.console", console),
+            patch("mem0_cli.commands.memory.err_console", err_console),
+        ):
+            cmd_delete(mock_backend, "abc-123", delete_linked=True, output="text")
+        call_kwargs = mock_backend.delete.call_args.kwargs
+        assert call_kwargs["delete_linked"] is True
+

 class TestDeleteAllCommand:
    def test_delete_all_force(self, mock_backend):
@@ -0,0 +1,78 @@
+"""Drift test: every documented v3 add/search/list param must be reachable from the Python CLI."""
+
+import json
+from pathlib import Path
+
+import typer.main
+
+from mem0_cli.app import app
+
+REPO_ROOT = Path(__file__).resolve().parents[3]
+OPENAPI_PATH = REPO_ROOT / "docs" / "openapi.json"
+
+KNOWN_UNSURFACED: dict[tuple[str, str], str] = {}
+
+ADD_MAPPING: dict[str, list[str]] = {
+    "messages": ["messages", "file", "text"],
+    "user_id": ["user_id"],
+    "agent_id": ["agent_id"],
+    "run_id": ["run_id"],
+    "metadata": ["metadata"],
+    "expiration_date": ["expires"],
+    "custom_instructions": ["custom_instructions"],
+    "custom_categories": ["custom_categories"],
+    "infer": ["no_infer"],
+}
+
+SEARCH_MAPPING: dict[str, list[str]] = {
+    "query": ["query"],
+    "filters": ["filter_json", "user_id", "agent_id", "run_id"],
+    "show_expired": ["show_expired"],
+    "top_k": ["top_k"],
+    "threshold": ["threshold"],
+    "rerank": ["rerank"],
+    "reference_date": ["reference_date"],
+}
+
+LIST_MAPPING: dict[str, list[str]] = {
+    "filters": ["user_id", "agent_id", "run_id", "category", "after", "before"],
+    "show_expired": ["show_expired"],
+}
+
+
+def _documented_fields(endpoint: str) -> set[str]:
+    spec = json.loads(OPENAPI_PATH.read_text())
+    schema = spec["paths"][endpoint]["post"]["requestBody"]["content"]["application/json"]["schema"]
+    return set(schema["properties"])
+
+
+def _cli_param_names(command_name: str) -> set[str]:
+    click_app = typer.main.get_command(app)
+    command = click_app.commands[command_name]
+    return {param.name for param in command.params}
+
+
+def _assert_all_reachable(endpoint: str, mapping: dict[str, list[str]], command_name: str) -> None:
+    documented = _documented_fields(endpoint)
+    reachable = _cli_param_names(command_name)
+    for field in documented:
+        if (endpoint, field) in KNOWN_UNSURFACED:
+            continue
+        candidates = mapping.get(field)
+        assert candidates, (
+            f"{endpoint}: documented field {field!r} has no mapping entry for command {command_name!r}"
+        )
+        assert any(candidate in reachable for candidate in candidates), (
+            f"{endpoint}: documented field {field!r} not reachable via any of {candidates} on command {command_name!r}"
+        )
+
+
+class TestOptionParity:
+    def test_add_covers_documented_fields(self):
+        _assert_all_reachable("/v3/memories/add/", ADD_MAPPING, "add")
+
+    def test_search_covers_documented_fields(self):
+        _assert_all_reachable("/v3/memories/search/", SEARCH_MAPPING, "search")
+
+    def test_list_covers_documented_fields(self):
+        _assert_all_reachable("/v3/memories/", LIST_MAPPING, "list")
@@ -0,0 +1,109 @@
+"""Tests that the MEM-5893 option-parity flags reach the correct request payload/params."""
+
+from __future__ import annotations
+
+from unittest.mock import patch
+
+from mem0_cli.backend.platform import PlatformBackend
+from mem0_cli.config import PlatformConfig
+
+
+def _make_backend() -> PlatformBackend:
+    return PlatformBackend(PlatformConfig(api_key="test-key", base_url="https://api.mem0.ai"))
+
+
+class TestAddOptions:
+    def test_new_fields_and_existing_fields_land_in_payload_together(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value={"results": []}) as mock_request:
+            backend.add(
+                content="hello",
+                user_id="alice",
+                metadata={"source": "test"},
+                expires="2099-01-01",
+                custom_instructions="Extract only preferences.",
+                custom_categories=[{"prefs": "user preferences"}],
+                structured_data_schema={"type": "object"},
+                timestamp=1700000000,
+            )
+        payload = mock_request.call_args.kwargs["json"]
+        assert payload["custom_instructions"] == "Extract only preferences."
+        assert payload["custom_categories"] == [{"prefs": "user preferences"}]
+        assert payload["structured_data_schema"] == {"type": "object"}
+        assert payload["timestamp"] == 1700000000
+        assert payload["metadata"] == {"source": "test"}
+        assert payload["expiration_date"] == "2099-01-01"
+
+    def test_omitted_fields_are_absent_from_payload(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value={"results": []}) as mock_request:
+            backend.add(content="hello", user_id="alice")
+        payload = mock_request.call_args.kwargs["json"]
+        assert "custom_instructions" not in payload
+        assert "custom_categories" not in payload
+        assert "structured_data_schema" not in payload
+        assert "timestamp" not in payload
+
+
+class TestSearchOptions:
+    def test_show_expired_reference_date_latest_only_reach_payload(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value=[]) as mock_request:
+            backend.search(
+                "query",
+                show_expired=True,
+                reference_date="2024-01-01",
+                latest_only=True,
+            )
+        payload = mock_request.call_args.kwargs["json"]
+        assert payload["show_expired"] is True
+        assert payload["reference_date"] == "2024-01-01"
+        assert payload["latest_only"] is True
+
+    def test_keyword_and_fields_reach_payload(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value=[]) as mock_request:
+            backend.search("query", keyword=True, fields=["memory", "score"])
+        payload = mock_request.call_args.kwargs["json"]
+        assert payload["keyword_search"] is True
+        assert payload["fields"] == ["memory", "score"]
+
+    def test_keyword_and_fields_omitted_are_absent_from_payload(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value=[]) as mock_request:
+            backend.search("query")
+        payload = mock_request.call_args.kwargs["json"]
+        assert "keyword_search" not in payload
+        assert "fields" not in payload
+
+
+class TestListOptions:
+    def test_show_expired_and_latest_only_are_top_level_not_in_filters(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value=[]) as mock_request:
+            backend.list_memories(user_id="alice", show_expired=True, latest_only=True)
+        payload = mock_request.call_args.kwargs["json"]
+        assert payload["show_expired"] is True
+        assert payload["latest_only"] is True
+        assert "show_expired" not in payload.get("filters", {})
+        assert "latest_only" not in payload.get("filters", {})
+
+
+class TestUpdateOptions:
+    def test_expires_and_timestamp_reach_payload(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value={}) as mock_request:
+            backend.update("mem-123", expiration_date="2099-01-01", timestamp=1700000000)
+        payload = mock_request.call_args.kwargs["json"]
+        assert payload["expiration_date"] == "2099-01-01"
+        assert payload["timestamp"] == 1700000000
+
+
+class TestDeleteOptions:
+    def test_delete_linked_is_a_query_param_not_json_body(self):
+        backend = _make_backend()
+        with patch.object(backend, "_request", return_value={}) as mock_request:
+            backend.delete(memory_id="mem-123", delete_linked=True)
+        call = mock_request.call_args
+        assert call.kwargs["params"]["delete_linked"] == "true"
+        assert "json" not in call.kwargs