spanner.Client().list_instances method filter_ parameter not working

[Charles546]

Thanks for stopping by to let us know something could be better!

PLEASE READ: If you have a support contract with Google, please create an issue in the support console instead of filing on GitHub. This will ensure a timely response.

Please run down the following list and make sure you've tried the usual "quick fixes":

• Search the issues already opened: https://github.com/googleapis/python-spanner/issues
• Search StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-platform+python

If you are still having issues, please be sure to include as much information as possible:

Environment details

• OS type and version: Alpine, MacOS,...
• Python version: 3.8.2
• pip version: 20.1.1
• google-cloud-spanner version: Version: 1.17.1

Steps to reproduce

1. Initialize a client
2. Run client.list_instances(filter_="name:something")

Code example

# example

from google.cloud import spanner

c = spanner.Client(project="my-project")
print([ i.instsance_id for i in c.list_instances(filter_="name:something") ])
print([ i.instsance_id for i in c.list_instances(filter_="labels.env:temp") ])

Stack trace

# example

The code doesn't throw exceptions or errors, but it gives the list of all instances ignoring the filter_ parameter.

Making sure to follow these steps will guarantee the quickest resolution possible.

Thanks!

[Charles546]

From the source shown here https://googleapis.dev/python/spanner/latest/_modules/google/cloud/spanner_v1/client.html#Client.list_instances

Looks like the filter_ parameter is not used at all.

[c24t]

Looks like it was a23b1ff that broke this.

InstanceAdminClient.list_instances still takes this arg, the fix may be as easy as:

diff --git a/google/cloud/spanner_v1/client.py b/google/cloud/spanner_v1/client.py
index 0759fcf..fac2fe5 100644
--- a/google/cloud/spanner_v1/client.py
+++ b/google/cloud/spanner_v1/client.py
@@ -406,7 +406,7 @@ class Client(ClientWithProject):
         metadata = _metadata_with_prefix(self.project_name)
         path = "projects/%s" % (self.project,)
         page_iter = self.instance_admin_api.list_instances(
-            path, page_size=page_size, metadata=metadata
+            path, page_size=page_size, filter_=filter_, metadata=metadata
         )
         page_iter.item_to_value = self._item_to_instance
         page_iter.next_page_token = page_token

[wyardley]

Thanks @c24t
also created support case #24587528 on the support side

https://googleapis.dev/python/spanner/latest/gapic/v1/admin_instance_api.html documents that it's supposed to work

[crwilcox]

That is an old commit! I believe we are going to be updating the generated portion of this library rather considerably in the near future, and can likely be sure this works in that release.

Is this blocking you or do you have a satisfactory workaround for the time?

[wyardley]

I'll defer to @Charles546 but don't think it's a blocker or time-sensitive
But might be good if a unit test could be added for this so that there isn't another regression?

[Charles546]

This is not a blocker for me, but it would be nice to have this fixed. We use this API to monitor the existence and ages of some temp spanner instances, the filter will help us focus on the instance of interest and ignore the instance that suppose to be running.

[skuruppu]

CC @larkee who is currently working on the code migration.

[larkee]

I'm currently working on the migration but due to the amount of handwritten code, it's hard to say how long it will take. Given how simple the fix is, I'll write a PR and merge it for the release this week 👍