PubSub Client: list_subscriptions returns all subscriptions, not just for that topic #4426

Activity

1. anorth2

   changed the title [-]PubSub Client: List Subscriptions returns all subscriptions, not just for that topic[/-] [+]PubSub Client: list_subscriptions returns all subscriptions, not just for that topic[/+] on Nov 20, 2017
2. dhermes

   added

   api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.

   status: investigatingThe issue is under investigation, which is determined to be non-trivial.The issue is under investigation, which is determined to be non-trivial.

   on Nov 20, 2017
3. gylu commented on Nov 20, 2017

   

   gylu

   on Nov 20, 2017

   Last edited by gylu

   More actions

   +1
   I'm seeing this also, on google-cloud-pubsub:0.29.0, google-cloud:0.30.0
   If the topic_path doesn't adhere to the form projects/project/topics/topic, then an exception is caught, but if it's projects/project/topics/some-topic-name-that-doesnt-exist, then all subscriptions for all topics are listed.
4. dhermes commented on Dec 15, 2017

   

   dhermes

   on Dec 15, 2017

   Contributor

   More actions

   So this is an issue, but not really as reported. The problem is that subscriber.list_subscriptions() is meant to be for the entire project:

   In [1]: import google.auth
   
   In [2]: from google.cloud import pubsub_v1
   
   In [3]: _, project = google.auth.default()
   
   In [4]: publisher = pubsub_v1.PublisherClient()
   E1215 14:50:02.433979430   11896 ev_epollex_linux.cc:1482]   Skipping epollex becuase GRPC_LINUX_EPOLL is not defined.
   E1215 14:50:02.434013514   11896 ev_epoll1_linux.cc:1261]    Skipping epoll1 becuase GRPC_LINUX_EPOLL is not defined.
   E1215 14:50:02.434020956   11896 ev_epollsig_linux.cc:1761]  Skipping epollsig becuase GRPC_LINUX_EPOLL is not defined.
   
   In [5]: subscriber = pubsub_v1.SubscriberClient()
   
   In [6]: subscriber.list_subscriptions?
   Signature: subscriber.list_subscriptions(project, ...)
   Docstring:
   Lists matching subscriptions.
   
   ...
   
   Args:
       project (str): The name of the cloud project that subscriptions belong to.
           Format is ``projects/{project}``.
   ...
   
   In [7]: project_path = subscriber.project_path(project)
   
   In [8]: LS = list(subscriber.list_subscriptions(project_path))
   
   In [9]: len(LS)
   Out[9]: 6

   The method you want is publisher.list_topic_subscriptions:

   In [10]: topic_path = publisher.topic_path(project, 'abcdef2')
   
   In [11]: LTS = list(publisher.list_topic_subscriptions(topic_path))
   
   In [12]: len(LTS)
   Out[12]: 3
   
   In [13]: publisher.list_topic_subscriptions?
   Signature: publisher.list_topic_subscriptions(topic, ...)
   Docstring:
   Lists the name of the subscriptions for this topic.
   
   ...
   
   Args:
       topic (str): The name of the topic that subscriptions are attached to.
           Format is ``projects/{project}/topics/{topic}``.

   The actual issue is that subscriber.list_subscriptions doesn't reject requests with the topic path (likely because the topic path starts with the project path):

   In [14]: topic_path.startswith(project_path)
   Out[14]: True
   
   In [15]: LS_ALSO = list(subscriber.list_subscriptions(topic_path))
   
   In [16]: LS_ALSO == LS
   Out[16]: True

   I think an issue could be filed with the backend to reject those requests with the topic_path where a project_path should be.

   /cc @kir-titievsky
5. dhermes

   closed this as completedon Dec 15, 2017
6. dhermes commented on Dec 15, 2017

   

   dhermes

   on Dec 15, 2017

   Contributor

   More actions

   I filed https://issuetracker.google.com/issues/70727179 with the backend team.
7. anorth2 commented on Jan 8, 2018

   

   anorth2

   on Jan 8, 2018

   Last edited by dhermes

   Author

   More actions

   @dhermes If this is indeed the issue, then this needs to be updated: https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/pubsub/cloud-client/subscriber.py#L30

   The docs state that my method was the way to retrieve by topic.
   https://cloud.google.com/pubsub/docs/admin#pubsub-list-subscriptions-python
8. dhermes commented on Jan 8, 2018

   

   dhermes

   on Jan 8, 2018

   Contributor

   More actions

   Thanks for finding that @anorth2 (I'm only loosely aware of what's in python-docs-samples). I filed GoogleCloudPlatform/python-docs-samples#1305 against that repo.
9. JustinBeckwith

   assigned

   dhermes

   on Feb 1, 2021
10. parthea

    added a commit that references this issue on Oct 21, 2023

    chore(deps): update dependency google-cloud-translate to v2.0.2 [(#4426…

    ...

    b16ef7c