Merge pull request #40 from iamareebjamal/patch-1

feat: Allow fetching multiple relationships from same included resource

Author: mahenzon

flask_combo_jsonapi/schema.py

@@ -21,7 +21,7 @@ def compute_schema(schema_cls, default_kwargs, qs, include):
     """
     # manage include_data parameter of the schema
     schema_kwargs = default_kwargs
-    schema_kwargs['include_data'] = tuple()
+    schema_kwargs['include_data'] = schema_kwargs.get('include_data', tuple())
 
     # collect sub-related_includes
     related_includes = {}
@@ -72,6 +72,7 @@ def compute_schema(schema_cls, default_kwargs, qs, include):
                 related_schema_kwargs['context'] = default_kwargs['context']
             if isinstance(related_schema_cls, SchemaABC):
                 related_schema_kwargs['many'] = related_schema_cls.many
+                related_schema_kwargs['include_data'] = related_schema_cls.__dict__.get('include_data')
                 related_schema_cls = related_schema_cls.__class__
             if isinstance(related_schema_cls, str):
                 related_schema_cls = class_registry.get_class(related_schema_cls)

tests/test_sqlalchemy_data_layer.py

@@ -119,6 +119,7 @@ class Person(base):
         )
 
         computers_owned = relationship("Computer")
+        address = relationship("Address", backref="person", uselist=False)
 
     yield Person
 
@@ -136,17 +137,35 @@ class Computer(base):
     yield Computer
 
 
+@pytest.fixture(scope="module")
+def address_model(base):
+    class Address(base):
+
+        __tablename__ = "address"
+
+        id = Column(Integer, primary_key=True)
+        street = Column(String)
+        city = Column(String)
+        state = Column(String)
+        zip = Column(String)
+        person_id = Column(Integer, ForeignKey("person.person_id"))
+
+    yield Address
+
+
 @pytest.fixture(scope="module")
 def engine(
         person_tag_model, person_single_tag_model, person_model,
-        computer_model, string_json_attribute_person_model
+        computer_model, string_json_attribute_person_model,
+        address_model
     ):
     engine = create_engine("sqlite:///:memory:")
     person_tag_model.metadata.create_all(engine)
     person_single_tag_model.metadata.create_all(engine)
     person_model.metadata.create_all(engine)
     computer_model.metadata.create_all(engine)
     string_json_attribute_person_model.metadata.create_all(engine)
+    address_model.metadata.create_all(engine)
     return engine
 
 
@@ -189,6 +208,17 @@ def computer(session, computer_model):
     session_.commit()
 
 
+@pytest.fixture()
+def address(session, address_model):
+    address_ = address_model(state='NYC')
+    session_ = session
+    session_.add(address_)
+    session_.commit()
+    yield address_
+    session_.delete(address_)
+    session_.commit()
+
+
 @pytest.fixture(scope="module")
 def dummy_decorator():
     def deco(f):
@@ -237,6 +267,29 @@ class AddressSchema(MarshmallowSchema):
     yield AddressSchema
 
 
+@pytest.fixture(scope="module")
+def person_address_schema():
+    class PersonAddressSchema(Schema):
+        class Meta:
+            type_ = "address"
+
+        id = fields.Str(dump_only=True)
+        street = fields.String()
+        city = fields.String()
+        state = fields.String()
+        zip = fields.String()
+
+        person = Relationship(
+            related_view="api.person_detail",
+            related_view_kwargs={"person_id": "<person.person_id>"},
+            schema="PersonSchema",
+            id_field="person_id",
+            type_="person",
+        )
+
+    yield PersonAddressSchema
+
+
 @pytest.fixture(scope="module")
 def string_json_attribute_person_schema(address_schema):
     class StringJsonAttributePersonSchema(Schema):
@@ -255,7 +308,7 @@ class Meta:
 
 
 @pytest.fixture(scope="module")
-def person_schema(person_tag_schema, person_single_tag_schema):
+def person_schema(person_tag_schema, person_single_tag_schema, person_address_schema):
     class PersonSchema(Schema):
         class Meta:
             type_ = "person"
@@ -284,6 +337,11 @@ class Meta:
             many=True,
         )
 
+        address = Relationship(
+            schema="PersonAddressSchema",
+            type_="address",
+        )
+
     yield PersonSchema
 
 
@@ -920,6 +978,22 @@ def test_get_relationship_single_empty(session, client, register_routes, compute
         assert response.status_code == 200
 
 
+def test_get_include_multiple(session, client, register_routes, computer, person, address):
+    session_ = session
+    person.address = address
+    computer.person = person
+    session_.commit()
+
+    with client:
+        response = client.get(
+            "/computers/" + str(computer.id) + "?include=owner.computers,owner.address", content_type="application/vnd.api+json"
+        )
+        included = json.loads(response.data)['included']
+        types = {item['type'] for item in included}
+        assert {'person', 'computer', 'address'} == types
+        assert response.status_code == 200
+
+
 def test_issue_49(session, client, register_routes, person, person_2):
     with client:
         for p in [person, person_2]: