fix: omit nulls in agent controls response

Author: lan17

server/src/agent_control_server/endpoints/agents.py

@@ -1367,6 +1367,7 @@ async def remove_agent_control(
 @router.get(
     "/{agent_name}/controls",
     response_model=AgentControlsResponse,
+    response_model_exclude_none=True,
     summary="List agent's active controls",
     response_description="List of controls from agent policy and direct associations",
 )

server/tests/test_control_compatibility.py

@@ -144,6 +144,78 @@ def test_list_agent_controls_returns_canonical_shape_for_legacy_stored_payload(
     assert control["condition"]["evaluator"]["name"] == "regex"
 
 
+def test_list_agent_controls_omits_null_condition_fields_in_response(
+    client: TestClient,
+) -> None:
+    # Given: an agent assigned a policy whose control uses a composite condition tree
+    agent_name = _init_agent(client)
+    policy_id = _create_policy(client)
+
+    composite_payload = deepcopy(VALID_CONTROL_PAYLOAD)
+    composite_payload["condition"] = {
+        "and": [
+            {
+                "not": {
+                    "selector": {"path": "context.channel.scope"},
+                    "evaluator": {
+                        "name": "list",
+                        "config": {
+                            "values": ["slack:direct:U123"],
+                            "logic": "any",
+                            "match_on": "match",
+                        },
+                    },
+                }
+            },
+            {
+                "or": [
+                    {
+                        "selector": {"path": "name"},
+                        "evaluator": {
+                            "name": "regex",
+                            "config": {"pattern": r"(^|\.)(read|memory_search|memory_get)$"},
+                        },
+                    }
+                ]
+            },
+        ]
+    }
+
+    control_resp = client.put(
+        "/api/v1/controls",
+        json={"name": f"control-{uuid.uuid4()}", "data": composite_payload},
+    )
+    assert control_resp.status_code == 200
+    control_id = control_resp.json()["control_id"]
+
+    assoc = client.post(f"/api/v1/policies/{policy_id}/controls/{control_id}")
+    assert assoc.status_code == 200
+    assign = client.post(f"/api/v1/agents/{agent_name}/policy/{policy_id}")
+    assert assign.status_code == 200
+
+    # When: listing active controls for the agent
+    resp = client.get(f"/api/v1/agents/{agent_name}/controls")
+
+    # Then: composite nodes omit synthetic null siblings in the response payload
+    assert resp.status_code == 200
+    control = resp.json()["controls"][0]["control"]
+    condition = control["condition"]
+
+    assert set(condition.keys()) == {"and"}
+    assert len(condition["and"]) == 2
+
+    first_child = condition["and"][0]
+    assert set(first_child.keys()) == {"not"}
+    assert first_child["not"]["selector"]["path"] == "context.channel.scope"
+    assert first_child["not"]["evaluator"]["name"] == "list"
+
+    second_child = condition["and"][1]
+    assert set(second_child.keys()) == {"or"}
+    assert len(second_child["or"]) == 1
+    assert second_child["or"][0]["selector"]["path"] == "name"
+    assert second_child["or"][0]["evaluator"]["name"] == "regex"
+
+
 def test_get_control_data_rejects_partial_legacy_stored_payload(
     client: TestClient,
 ) -> None:

ui/src/core/page-components/agent-detail/modals/edit-control/edit-control-content.tsx

@@ -42,7 +42,7 @@ import type {
   EditControlMode,
 } from './types';
 import { useEvaluatorConfigState } from './use-evaluator-config-state';
-import { applyApiErrorsToForms, stringifyJsonWithoutNulls } from './utils';
+import { applyApiErrorsToForms } from './utils';
 
 const EVALUATOR_CONFIG_HEIGHT = 450;
 const JSON_EDITOR_HEIGHT = 520;
@@ -340,7 +340,7 @@ export const EditControlContent = ({
           return;
         }
 
-        setDefinitionJsonText(stringifyJsonWithoutNulls(definition));
+        setDefinitionJsonText(JSON.stringify(definition, null, 2));
         setDefinitionJsonError(null);
         setDefinitionValidationError(null);
         setDefinitionValidationStatus('idle');
@@ -394,7 +394,7 @@ export const EditControlContent = ({
     setEditorMode(initialEditorMode);
     setDefinitionJsonText(
       initialEditorMode === 'json'
-        ? stringifyJsonWithoutNulls(control.control)
+        ? JSON.stringify(control.control, null, 2)
         : ''
     );
     setDefinitionJsonError(null);

ui/src/core/page-components/agent-detail/modals/edit-control/utils.ts

@@ -155,18 +155,3 @@ export function sanitizeControlNamePart(s: string): string {
     .replace(/^[-_]+/, '');
   return sanitized || 'control';
 }
-
-/**
- * Stringify JSON for editor display while omitting object properties whose
- * values are null. This keeps the editor aligned with persisted control data.
- */
-export function stringifyJsonWithoutNulls(value: unknown): string {
-  return (
-    JSON.stringify(
-      value,
-      (_key: string, currentValue: unknown) =>
-        currentValue === null ? undefined : currentValue,
-      2
-    ) ?? ''
-  );
-}

ui/tests/agent-detail.spec.ts

@@ -763,109 +763,6 @@ test.describe('Agent Detail Page', () => {
     });
   });
 
-  test('full JSON editor omits null condition fields from display', async ({
-    mockedPage,
-  }) => {
-    const noisyCompositeControl: Control = {
-      id: 88,
-      name: 'Public Slack Mode',
-      control: {
-        description: 'Composite control with nullable transport fields',
-        enabled: true,
-        execution: 'server',
-        scope: { step_types: ['tool'], stages: ['pre'] },
-        condition: {
-          selector: null,
-          evaluator: null,
-          and: [
-            {
-              selector: null,
-              evaluator: null,
-              and: null,
-              or: null,
-              not: {
-                selector: { path: 'context.channel.scope' },
-                evaluator: {
-                  name: 'list',
-                  config: {
-                    values: ['slack:direct:U123'],
-                    logic: 'any',
-                    match_on: 'match',
-                  },
-                },
-                and: null,
-                or: null,
-                not: null,
-              },
-            },
-            {
-              selector: null,
-              evaluator: null,
-              and: null,
-              or: [
-                {
-                  selector: null,
-                  evaluator: null,
-                  and: null,
-                  or: null,
-                  not: {
-                    selector: { path: 'name' },
-                    evaluator: {
-                      name: 'regex',
-                      config: {
-                        pattern: '(^|\\.)(read|memory_search|memory_get)$',
-                      },
-                    },
-                    and: null,
-                    or: null,
-                    not: null,
-                  },
-                },
-              ],
-              not: null,
-            },
-          ],
-          or: null,
-          not: null,
-        },
-        action: { decision: 'deny' },
-        tags: ['slack', 'public'],
-      },
-    };
-    const noisyControls: AgentControlsResponse = {
-      controls: [noisyCompositeControl],
-    };
-
-    await mockRoutes.agent(mockedPage, {
-      controls: { data: noisyControls },
-    });
-    await mockedPage.route('**/api/v1/controls/88/data', async (route) => {
-      await route.fulfill({
-        status: 200,
-        contentType: 'application/json',
-        body: JSON.stringify({ data: noisyCompositeControl.control }),
-      });
-    });
-
-    await mockedPage.goto(
-      getAgentControlsUrl({ modal: 'edit', controlId: 88 })
-    );
-
-    const modal = mockedPage.getByRole('dialog', { name: 'Edit Control' });
-    await expect(modal).toBeVisible();
-    await modal.getByText('Full JSON', { exact: true }).click();
-
-    await expect(modal).not.toContainText('"selector": null');
-    await expect(modal).not.toContainText('"evaluator": null');
-    await expect(modal).not.toContainText('"and": null');
-    await expect(modal).not.toContainText('"or": null');
-    await expect(modal).not.toContainText('"not": null');
-    await expect(modal).toContainText('"context.channel.scope"');
-    await expect(modal).toContainText(
-      '"(^|\\\\.)(read|memory_search|memory_get)$"'
-    );
-  });
-
   test('disables Form switch when JSON is invalid', async ({ mockedPage }) => {
     await mockedPage.goto(agentUrl);