Skip to content

Ensure postgres consistency #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 31, 2023
Merged

Ensure postgres consistency #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c5c652
Ensure postgres consistency
quaxsze Aug 25, 2023
88636ea
Ensure postgres consistency
quaxsze Aug 25, 2023
7c0e7da
fix lint
quaxsze Aug 25, 2023
437112c
enhancement
quaxsze Aug 31, 2023
7b72cb8
fix tests
quaxsze Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions api_tabular/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ def build_sql_query_string(
request_arg: list, page_size: int = None, offset: int = 0
) -> str:
sql_query = []
sorted = False
for arg in request_arg:
argument, value = arg.split("=")
if "__" in argument:
column, comparator = argument.split("__")
normalized_comparator = comparator.lower()

if normalized_comparator == "sort":
if value == "asc":
sql_query.append(f"order={column}.asc")
sql_query.append(f"order={column}.asc,__id.asc")
elif value == "desc":
sql_query.append(f"order={column}.desc")
sql_query.append(f"order={column}.desc,__id.asc")
sorted = True
elif normalized_comparator == "exact":
sql_query.append(f"{column}=eq.{value}")
elif normalized_comparator == "contains":
Expand All @@ -27,6 +30,8 @@ def build_sql_query_string(
sql_query.append(f"limit={page_size}")
if offset >= 1:
sql_query.append(f"offset={offset}")
if not sorted:
sql_query.append("order=__id.asc")
return "&".join(sql_query)


Expand Down
36 changes: 18 additions & 18 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ async def test_api_resource_profile_not_found(client, mock_get_resource_empty):


async def test_api_resource_data(client, rmock):
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?limit=20",
f"{PG_RST_URL}/xxx?limit=20&order=__id.asc",
payload={"such": "data"},
headers={"Content-Range": "0-10/10"},
)
Expand All @@ -75,9 +75,9 @@ async def test_api_resource_data(client, rmock):

async def test_api_resource_data_with_args(client, rmock):
args = "page=1"
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?limit=20",
f"{PG_RST_URL}/xxx?limit=20&order=__id.asc",
payload={"such": "data"},
headers={"Content-Range": "0-10/10"},
)
Expand All @@ -97,9 +97,9 @@ async def test_api_resource_data_with_args(client, rmock):

async def test_api_resource_data_with_args_case(client, rmock):
args = "COLUM_NAME__EXACT=BIDULE&page=1"
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?COLUM_NAME=eq.BIDULE&limit=20",
f"{PG_RST_URL}/xxx?COLUM_NAME=eq.BIDULE&limit=20&order=__id.asc",
payload={"such": "data"},
headers={"Content-Range": "0-10/10"},
)
Expand All @@ -119,7 +119,7 @@ async def test_api_resource_data_with_args_case(client, rmock):

async def test_api_resource_data_with_args_error(client, rmock):
args = "TESTCOLUM_NAME__EXACT=BIDULEpage=1"
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
res = await client.get(f"/api/resources/{RESOURCE_ID}/data/?{args}")
assert res.status == 400
assert await res.json() == {
Expand All @@ -135,7 +135,7 @@ async def test_api_resource_data_with_args_error(client, rmock):

async def test_api_resource_data_with_page_size_error(client, rmock):
args = "page=1&page_size=100"
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
res = await client.get(f"/api/resources/{RESOURCE_ID}/data/?{args}")
assert res.status == 400
assert await res.json() == {
Expand All @@ -155,8 +155,8 @@ async def test_api_resource_data_not_found(client, mock_get_resource_empty):


async def test_api_resource_data_table_error(client, rmock):
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(f"{PG_RST_URL}/xxx?limit=20", status=502, payload={"such": "error"})
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(f"{PG_RST_URL}/xxx?limit=20&order=__id.asc", status=502, payload={"such": "error"})
res = await client.get(f"/api/resources/{RESOURCE_ID}/data/")
assert res.status == 502
assert await res.json() == {
Expand All @@ -167,9 +167,9 @@ async def test_api_resource_data_table_error(client, rmock):


async def test_api_percent_encoding_arabic(client, rmock):
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?%D9%85%D9%88%D8%A7%D8%B1%D8%AF=eq.%D9%85%D9%88%D8%A7%D8%B1%D8%AF&limit=20",
f"{PG_RST_URL}/xxx?%D9%85%D9%88%D8%A7%D8%B1%D8%AF=eq.%D9%85%D9%88%D8%A7%D8%B1%D8%AF&limit=20&order=__id.asc",
status=200,
payload={"such": "data"},
headers={"Content-Range": "0-10/10"},
Expand All @@ -191,9 +191,9 @@ async def test_api_percent_encoding_arabic(client, rmock):


async def test_api_with_unsupported_args(client, rmock):
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?limit=20",
f"{PG_RST_URL}/xxx?limit=20&order=__id.asc",
status=200,
payload={"such": "data"},
headers={"Content-Range": "0-10/10"},
Expand All @@ -213,9 +213,9 @@ async def test_api_with_unsupported_args(client, rmock):


async def test_api_pagination(client, rmock):
rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?limit=1",
f"{PG_RST_URL}/xxx?limit=1&order=__id.asc",
status=200,
payload=[{"such": "data"}],
headers={"Content-Range": "0-2/2"},
Expand All @@ -234,9 +234,9 @@ async def test_api_pagination(client, rmock):
}
assert await res.json() == body

rmock.get(TABLES_INDEX_PATTERN, payload=[{"id": "test-id", "parsing_table": "xxx"}])
rmock.get(TABLES_INDEX_PATTERN, payload=[{"__id": 1, "id": "test-id", "parsing_table": "xxx"}])
rmock.get(
f"{PG_RST_URL}/xxx?limit=1&offset=1",
f"{PG_RST_URL}/xxx?limit=1&offset=1&order=__id.asc",
status=200,
payload=[{"such": "data"}],
headers={"Content-Range": "0-2/2"},
Expand Down
24 changes: 12 additions & 12 deletions tests/test_query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@
def test_query_build_limit():
query_str = []
result = build_sql_query_string(query_str, 12)
assert result == "limit=12"
assert result == "limit=12&order=__id.asc"


def test_query_build_offset():
query_str = []
result = build_sql_query_string(query_str, 12, 12)
assert result == "limit=12&offset=12"
assert result == "limit=12&offset=12&order=__id.asc"


def test_query_build_sort_asc():
query_str = ["column_name__sort=asc"]
result = build_sql_query_string(query_str, 50)
assert result == "order=column_name.asc&limit=50"
assert result == "order=column_name.asc,__id.asc&limit=50"


def test_query_build_sort_asc_without_limit():
query_str = ["column_name__sort=asc"]
result = build_sql_query_string(query_str)
assert result == "order=column_name.asc"
assert result == "order=column_name.asc,__id.asc"


def test_query_build_sort_asc_with_page_in_query():
Expand All @@ -32,37 +32,37 @@ def test_query_build_sort_asc_with_page_in_query():
"page_size=20",
]
result = build_sql_query_string(query_str)
assert result == "order=column_name.asc"
assert result == "order=column_name.asc,__id.asc"


def test_query_build_sort_desc():
query_str = ["column_name__sort=desc"]
result = build_sql_query_string(query_str, 50)
assert result == "order=column_name.desc&limit=50"
assert result == "order=column_name.desc,__id.asc&limit=50"


def test_query_build_exact():
query_str = ["column_name__exact=BIDULE"]
result = build_sql_query_string(query_str, 50)
assert result == "column_name=eq.BIDULE&limit=50"
assert result == "column_name=eq.BIDULE&limit=50&order=__id.asc"


def test_query_build_contains():
query_str = ["column_name__contains=BIDULE"]
result = build_sql_query_string(query_str, 50)
assert result == "column_name=ilike.*BIDULE*&limit=50"
assert result == "column_name=ilike.*BIDULE*&limit=50&order=__id.asc"


def test_query_build_less():
query_str = ["column_name__less=12"]
result = build_sql_query_string(query_str, 50, 12)
assert result == "column_name=lte.12&limit=50&offset=12"
assert result == "column_name=lte.12&limit=50&offset=12&order=__id.asc"


def test_query_build_greater():
query_str = ["column_name__greater=12"]
result = build_sql_query_string(query_str, 50)
assert result == "column_name=gte.12&limit=50"
assert result == "column_name=gte.12&limit=50&order=__id.asc"


def test_query_build_multiple():
Expand All @@ -74,11 +74,11 @@ def test_query_build_multiple():
result = build_sql_query_string(query_str, 50)
assert (
result
== "column_name=eq.BIDULE&column_name=gte.12&column_name=eq.BIDULE&limit=50"
== "column_name=eq.BIDULE&column_name=gte.12&column_name=eq.BIDULE&limit=50&order=__id.asc"
)


def test_query_build_multiple_with_unknown():
query_str = ["select=numnum"]
result = build_sql_query_string(query_str, 50)
assert result == "limit=50"
assert result == "limit=50&order=__id.asc"