Support Organization relationships (query without source ID)

Author: florijanstamenkovic

labelbox/orm/db_object.py

@@ -103,6 +103,7 @@ def __init__(self, source, relationship):
         self.relationship = relationship
         self.supports_filtering = True
         self.supports_sorting = True
+        self.filter_on_id = True
 
     def __call__(self, *args, **kwargs ):
         """ Forwards the call to either `_to_many` or `_to_one` methods,
@@ -135,10 +136,12 @@ def _to_many(self, where=None, order_by=None):
             not_deleted = rel.destination_type.deleted == False
             where = not_deleted if where is None else where & not_deleted
 
-        query_string, params = query.relationship(self.source, rel, where, order_by)
+        query_string, params = query.relationship(
+            self.source if self.filter_on_id else type(self.source),
+            rel, where, order_by)
         return PaginatedCollection(
             self.source.client, query_string, params,
-            [utils.camel_case(type(self.source).type_name()),
+            [utils.camel_case(self.source.type_name()),
              rel.graphql_name],
             rel.destination_type)
 

labelbox/orm/query.py

@@ -260,7 +260,10 @@ def relationship(source, relationship, where, order_by):
     pagination parameters.
 
     Args:
-        source (DbObject): A database object whose related objects are sought.
+        source (DbObject or type): If a `DbObject` then the source of the
+            relationship (the query originates from that particular object).
+            If `type`, then the source of the relationship is implicit, even
+            without the ID. Used for expanding from Organization.
         relationship (Relationship): The relationship.
         where (Comparison, LogicalExpression or None): The `where` clause
             for filtering.
@@ -274,11 +277,11 @@ def relationship(source, relationship, where, order_by):
     to_many = relationship.relationship_type == Relationship.Type.ToMany
     subquery = Query(relationship.graphql_name, relationship.destination_type,
                      where, to_many, order_by)
-    source_type_name = type(source).type_name()
-    query = Query(utils.camel_case(source_type_name), subquery,
-                  type(source).uid == source.uid)
+    query_where = type(source).uid == source.uid if isinstance(source, Entity) \
+        else None
+    query = Query(utils.camel_case(source.type_name()), subquery, query_where)
     return query.format_top(
-        "Get" + source_type_name + utils.title_case(relationship.graphql_name))
+        "Get" + source.type_name() + utils.title_case(relationship.graphql_name))
 
 
 def create(entity, data):

labelbox/schema.py

@@ -387,6 +387,15 @@ class User(DbObject):
 
 
 class Organization(DbObject):
+
+    # RelationshipManagers in Organization use the type in Query (and
+    # not the source object) because the server-side does not support
+    # filtering on ID in the query for getting a single organization.
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        for relationship in self.relationships():
+            getattr(self, relationship.name).filter_on_id = False
+
     updated_at = Field.DateTime("updated_at")
     created_at = Field.DateTime("created_at")
     name = Field.String("name")

tests/integration/test_user_and_org.py

@@ -13,19 +13,19 @@ def test_user(client):
 def test_organization(client):
     organization = client.get_organization()
     assert organization.uid is not None
-
-    # TODO make organization fetchable on ID
-    with pytest.raises(InvalidQueryError):
-        list(organization.users())
-        list(organization.projects())
+    assert client.get_user() in set(organization.users())
 
 
 def test_user_and_org_projects(client, rand_gen):
     user = client.get_user()
-    projects = set(user.projects())
+    org = client.get_organization()
+    user_projects = set(user.projects())
+    org_projects = set(org.projects())
 
     project = client.create_project(name=rand_gen(Project.name))
     assert project.created_by() == user
-    assert set(user.projects()) == projects.union({project})
+    assert project.organization() == org
+    assert set(user.projects()) == user_projects.union({project})
+    assert set(org.projects()) == org_projects.union({project})
 
     project.delete()

tests/integration/test_webhook.py

@@ -18,6 +18,7 @@ def test_webhook_create_update(client, rand_gen):
     assert webhook.topics == topics
     assert webhook.status == Webhook.ACTIVE
     assert list(project.webhooks()) == [webhook]
+    assert webhook in set(client.get_organization().webhooks())
 
     webhook.update(status=Webhook.REVOKED, topics=[Webhook.LABEL_UPDATED])
     assert webhook.topics == [Webhook.LABEL_UPDATED]