feat: normalize filter values to array format for Grist API

The Grist API requires all filter values to be arrays. This change adds
automatic normalization of filter values in get_records, wrapping single
values in lists before sending to the API.

This fixes 400 errors when filtering on Ref columns with single integer IDs.

Changes:
- Add filters.py module with normalize_filter function
- Update get_records to normalize filters before API call
- Add Orders table with Ref column to mock Grist server
- Add filter validation to mock server (rejects non-array values)
- Fix shell script shebangs for portability (#!/usr/bin/env bash)
This commit is contained in:
2026-01-14 17:56:18 -05:00
parent c868e8a7fa
commit a97930848b
8 changed files with 244 additions and 5 deletions

View File

@@ -35,6 +35,18 @@ MOCK_TABLES = {
{"id": 2, "fields": {"Title": "Deploy", "Done": False}},
],
},
"Orders": {
"columns": [
{"id": "OrderNum", "fields": {"type": "Int"}},
{"id": "Customer", "fields": {"type": "Ref:People"}},
{"id": "Amount", "fields": {"type": "Numeric"}},
],
"records": [
{"id": 1, "fields": {"OrderNum": 1001, "Customer": 1, "Amount": 100.0}},
{"id": 2, "fields": {"OrderNum": 1002, "Customer": 2, "Amount": 200.0}},
{"id": 3, "fields": {"OrderNum": 1003, "Customer": 1, "Amount": 150.0}},
],
},
}
# Track requests for test assertions
@@ -93,12 +105,40 @@ async def get_records(request):
"""GET /api/docs/{doc_id}/tables/{table_id}/records"""
doc_id = request.path_params["doc_id"]
table_id = request.path_params["table_id"]
log_request("GET", f"/api/docs/{doc_id}/tables/{table_id}/records")
filter_param = request.query_params.get("filter")
log_request("GET", f"/api/docs/{doc_id}/tables/{table_id}/records?filter={filter_param}")
if table_id not in MOCK_TABLES:
return JSONResponse({"error": "Table not found"}, status_code=404)
return JSONResponse({"records": MOCK_TABLES[table_id]["records"]})
records = MOCK_TABLES[table_id]["records"]
# Apply filtering if provided
if filter_param:
try:
filters = json.loads(filter_param)
# Validate filter format: all values must be arrays (Grist API requirement)
for key, values in filters.items():
if not isinstance(values, list):
return JSONResponse(
{"error": f"Filter values must be arrays, got {type(values).__name__} for '{key}'"},
status_code=400
)
# Apply filters: record matches if field value is in the filter list
filtered_records = []
for record in records:
match = True
for key, allowed_values in filters.items():
if record["fields"].get(key) not in allowed_values:
match = False
break
if match:
filtered_records.append(record)
records = filtered_records
except json.JSONDecodeError:
return JSONResponse({"error": "Invalid filter JSON"}, status_code=400)
return JSONResponse({"records": records})
async def add_records(request):

View File

@@ -90,6 +90,36 @@ async def test_all_tools(services_ready):
log = get_mock_request_log()
assert any("/records" in entry["path"] and entry["method"] == "GET" for entry in log)
# Test get_records with Ref column filter
# This tests that single values are normalized to arrays for the Grist API
clear_mock_request_log()
result = await client.call_tool(
"get_records",
{"document": "test-doc", "table": "Orders", "filter": {"Customer": 1}}
)
data = json.loads(result.content[0].text)
assert "records" in data
# Should return only orders for Customer 1 (orders 1 and 3)
assert len(data["records"]) == 2
for record in data["records"]:
assert record["Customer"] == 1
log = get_mock_request_log()
# Verify the filter was sent as array format
filter_requests = [e for e in log if "/records" in e["path"] and "filter=" in e["path"]]
assert len(filter_requests) >= 1
# The filter value should be [1] not 1
assert "[1]" in filter_requests[0]["path"]
# Test get_records with multiple filter values
clear_mock_request_log()
result = await client.call_tool(
"get_records",
{"document": "test-doc", "table": "Orders", "filter": {"Customer": [1, 2]}}
)
data = json.loads(result.content[0].text)
assert "records" in data
assert len(data["records"]) == 3 # All 3 orders (customers 1 and 2)
# Test sql_query
clear_mock_request_log()
result = await client.call_tool(