Fix sanitize_params to correctly resolve nested columns (#222)

* Add test for sanitize_params in utils

* Remove dot character from sanitize_params util

* Add tests for filter queries that include special characters in column name

* Add missing test for equals operator

Author: guillego

postgrest/utils.py

@@ -13,7 +13,7 @@ def aclose(self) -> None:
 
 def sanitize_param(param: Any) -> str:
     param_str = str(param)
-    reserved_chars = ".,:()"
+    reserved_chars = ",:()"
     if any(char in param_str for char in reserved_chars):
         return f'"{param_str}"'
     return param_str

tests/_async/test_filter_request_builder.py

@@ -36,6 +36,21 @@ def test_filter(filter_request_builder):
     assert builder.params['":col.name"'] == "eq.val"
 
 
+@pytest.mark.parametrize(
+    "col_name, expected_query_prefix",
+    [
+        ("col:name", "%22col%3Aname%22"),
+        ("col.name", "col.name"),
+    ],
+)
+def test_filter_special_characters(
+    filter_request_builder, col_name, expected_query_prefix
+):
+    builder = filter_request_builder.filter(col_name, "eq", "val")
+
+    assert str(builder.params) == expected_query_prefix + "=eq.val"
+
+
 def test_multivalued_param(filter_request_builder):
     builder = filter_request_builder.lte("x", "a").gte("x", "b")
 
@@ -47,6 +62,12 @@ def test_match(filter_request_builder):
     assert str(builder.params) == "id=eq.1&done=eq.false"
 
 
+def test_equals(filter_request_builder):
+    builder = filter_request_builder.eq("x", "a")
+
+    assert str(builder.params) == "x=eq.a"
+
+
 def test_contains(filter_request_builder):
     builder = filter_request_builder.contains("x", "a")
 

tests/_sync/test_filter_request_builder.py

@@ -36,6 +36,21 @@ def test_filter(filter_request_builder):
     assert builder.params['":col.name"'] == "eq.val"
 
 
+@pytest.mark.parametrize(
+    "col_name, expected_query_prefix",
+    [
+        ("col:name", "%22col%3Aname%22"),
+        ("col.name", "col.name"),
+    ],
+)
+def test_filter_special_characters(
+    filter_request_builder, col_name, expected_query_prefix
+):
+    builder = filter_request_builder.filter(col_name, "eq", "val")
+
+    assert str(builder.params) == expected_query_prefix + "=eq.val"
+
+
 def test_multivalued_param(filter_request_builder):
     builder = filter_request_builder.lte("x", "a").gte("x", "b")
 
@@ -47,6 +62,12 @@ def test_match(filter_request_builder):
     assert str(builder.params) == "id=eq.1&done=eq.false"
 
 
+def test_equals(filter_request_builder):
+    builder = filter_request_builder.eq("x", "a")
+
+    assert str(builder.params) == "x=eq.a"
+
+
 def test_contains(filter_request_builder):
     builder = filter_request_builder.contains("x", "a")
 

tests/test_utils.py

@@ -0,0 +1,19 @@
+import pytest
+
+from postgrest.utils import sanitize_param
+
+
+@pytest.mark.parametrize(
+    "value, expected",
+    [
+        ("param,name", '"param,name"'),
+        ("param:name", '"param:name"'),
+        ("param(name", '"param(name"'),
+        ("param)name", '"param)name"'),
+        ("param,name", '"param,name"'),
+        ("table.column", "table.column"),
+        ("table_column", "table_column"),
+    ],
+)
+def test_sanitize_params(value, expected):
+    assert sanitize_param(value) == expected