fix: allow empty headers for btql routing (#1072)

Author: daniel-sanche

google/cloud/bigtable_v2/services/bigtable/async_client.py

@@ -1496,7 +1496,8 @@ def execute_query(
         if regex_match and regex_match.group("name"):
             header_params["name"] = regex_match.group("name")
 
-        if request.app_profile_id:
+        if request.app_profile_id is not None:
+            # execute_query currently requires empty header support. TODO: remove after support is added
             header_params["app_profile_id"] = request.app_profile_id
 
         if header_params:

google/cloud/bigtable_v2/services/bigtable/client.py

@@ -1893,7 +1893,8 @@ def execute_query(
         if regex_match and regex_match.group("name"):
             header_params["name"] = regex_match.group("name")
 
-        if request.app_profile_id:
+        if request.app_profile_id is not None:
+            # execute_query currently requires empty header support. TODO: remove after support is adde
             header_params["app_profile_id"] = request.app_profile_id
 
         if header_params:

tests/system/data/test_system_async.py

@@ -1014,3 +1014,16 @@ async def test_literal_value_filter(
         assert len(row_list) == bool(
             expect_match
         ), f"row {type(cell_value)}({cell_value}) not found with {type(filter_input)}({filter_input}) filter"
+
+    @CrossSync.pytest
+    @pytest.mark.usefixtures("client")
+    @CrossSync.Retry(
+        predicate=retry.if_exception_type(ClientError), initial=1, maximum=5
+    )
+    async def test_execute_query_simple(self, client, table_id, instance_id):
+        result = await client.execute_query("SELECT 1 AS a, 'foo' AS b", instance_id)
+        rows = [r async for r in result]
+        assert len(rows) == 1
+        row = rows[0]
+        assert row["a"] == 1
+        assert row["b"] == "foo"

tests/system/data/test_system_autogen.py

@@ -826,3 +826,15 @@ def test_literal_value_filter(
         assert len(row_list) == bool(
             expect_match
         ), f"row {type(cell_value)}({cell_value}) not found with {type(filter_input)}({filter_input}) filter"
+
+    @pytest.mark.usefixtures("client")
+    @CrossSync._Sync_Impl.Retry(
+        predicate=retry.if_exception_type(ClientError), initial=1, maximum=5
+    )
+    def test_execute_query_simple(self, client, table_id, instance_id):
+        result = client.execute_query("SELECT 1 AS a, 'foo' AS b", instance_id)
+        rows = [r for r in result]
+        assert len(rows) == 1
+        row = rows[0]
+        assert row["a"] == 1
+        assert row["b"] == "foo"

tests/unit/gapic/bigtable_v2/test_bigtable.py

@@ -6868,7 +6868,11 @@ def test_execute_query_routing_parameters_request_1_grpc():
 
         assert args[0] == request_msg
 
-        expected_headers = {"name": "projects/sample1/instances/sample2"}
+        # expect app_profile_id while temporary patch is in place: https://github.com/googleapis/python-bigtable/pull/1072
+        expected_headers = {
+            "name": "projects/sample1/instances/sample2",
+            "app_profile_id": "",
+        }
         assert (
             gapic_v1.routing_header.to_grpc_metadata(expected_headers) in kw["metadata"]
         )
@@ -7894,7 +7898,11 @@ async def test_execute_query_routing_parameters_request_1_grpc_asyncio():
 
         assert args[0] == request_msg
 
-        expected_headers = {"name": "projects/sample1/instances/sample2"}
+        # expect app_profile_id while temporary patch is in place: https://github.com/googleapis/python-bigtable/pull/1072
+        expected_headers = {
+            "name": "projects/sample1/instances/sample2",
+            "app_profile_id": "",
+        }
         assert (
             gapic_v1.routing_header.to_grpc_metadata(expected_headers) in kw["metadata"]
         )
@@ -9915,7 +9923,11 @@ def test_execute_query_routing_parameters_request_1_rest():
 
         assert args[0] == request_msg
 
-        expected_headers = {"name": "projects/sample1/instances/sample2"}
+        # expect app_profile_id while temporary patch is in place: https://github.com/googleapis/python-bigtable/pull/1072
+        expected_headers = {
+            "name": "projects/sample1/instances/sample2",
+            "app_profile_id": "",
+        }
         assert (
             gapic_v1.routing_header.to_grpc_metadata(expected_headers) in kw["metadata"]
         )