Rename all_pb_names to all_product_block_names and refactor related logic (#968)

* Rename all_pb_names to all_product_block_names and refactor related logic for clarity

* Update unit test for nested product blocks

* Expand recursive product block test case

---------

Co-authored-by: Karel van Klink <[email protected]>

Author: saket-geant

orchestrator/graphql/schemas/product.py

@@ -52,21 +52,20 @@ async def subscriptions(
         return await resolve_subscriptions(info, filter_by_with_related_subscriptions, sort_by, first, after)
 
     @strawberry.field(description="Returns list of all nested productblock names")  # type: ignore
-    async def all_pb_names(self) -> list[str]:
-
+    async def all_product_block_names(self) -> list[str]:
         model = get_original_model(self, ProductTable)
 
-        def get_all_pb_names(product_blocks: list[ProductBlockTable]) -> Iterable[str]:
+        def get_names(product_blocks: list[ProductBlockTable], visited: set) -> Iterable[str]:
             for product_block in product_blocks:
+                if product_block.product_block_id in visited:
+                    continue
+                visited.add(product_block.product_block_id)
                 yield product_block.name
-
                 if product_block.depends_on:
-                    yield from get_all_pb_names(product_block.depends_on)
-
-        names: list[str] = list(get_all_pb_names(model.product_blocks))
-        names.sort()
+                    yield from get_names(product_block.depends_on, visited)
 
-        return names
+        names = set(get_names(model.product_blocks, set()))
+        return sorted(names)
 
     @strawberry.field(description="Return product blocks")  # type: ignore
     async def product_blocks(self) -> list[Annotated["ProductBlock", strawberry.lazy(".product_block")]]:

test/unit_tests/fixtures/products/product_blocks/product_block_one_nested.py

@@ -48,6 +48,7 @@ def test_product_block_one_nested_db_in_use_by_block(resource_type_list, resourc
         name="ProductBlockOneNestedForTest", description="Test Block Parent", tag="TEST", status="active"
     )
     in_use_by_block.resource_types = [resource_type_int]
+    in_use_by_block.in_use_by = [in_use_by_block]
 
     db.session.add(in_use_by_block)
     db.session.commit()

test/unit_tests/fixtures/products/product_types/product_type_one_nested.py

@@ -36,16 +36,17 @@ class ProductTypeOneNestedForTest(
 
 
 @pytest.fixture
-def test_product_one_nested(test_product_block_one_nested_db_in_use_by_block):
+def test_product_one_nested(test_product_block_one_nested_db_in_use_by_block, generic_product_block_chain):
     product = ProductTable(
         name="TestProductOneNested", description="Test ProductTable", product_type="Test", tag="TEST", status="active"
     )
 
     fixed_input = FixedInputTable(name="test_fixed_input", value="False")
 
-    product_block = test_product_block_one_nested_db_in_use_by_block
+    pb_1 = test_product_block_one_nested_db_in_use_by_block
+    pb_2, pb_3 = generic_product_block_chain
     product.fixed_inputs = [fixed_input]
-    product.product_blocks = [product_block]
+    product.product_blocks = [pb_1, pb_2, pb_3]
 
     db.session.add(product)
     db.session.commit()

test/unit_tests/graphql/test_product.py

@@ -85,7 +85,7 @@ def get_all_product_names_query(
 query ProductQuery($filterBy: [GraphqlFilter!]) {
   products(filterBy: $filterBy) {
     page {
-      allPbNames
+      allProductBlockNames
     }
     pageInfo {
       endCursor
@@ -226,18 +226,18 @@ def test_product_query(
     }
 
 
-def test_all_product_block_names(test_client, generic_product_4):
-    filter_by = {"filter_by": {"field": "name", "value": "Product 4"}}
+def test_all_product_block_names(test_client, test_product_one_nested):
+    filter_by = {"filter_by": {"field": "name", "value": "TestProductOneNested"}}
     data = get_all_product_names_query(**filter_by)
     response: Response = test_client.post("/api/graphql", content=data, headers={"Content-Type": "application/json"})
 
     assert HTTPStatus.OK == response.status_code
     result = response.json()
     products_data = result["data"]["products"]
     products = products_data["page"]
-    names = products[0]["allPbNames"]
+    names = products[0]["allProductBlockNames"]
 
-    assert len(names) == 2
+    assert names == ["PB_Chained_1", "PB_Chained_2", "ProductBlockOneNestedForTest"]
 
 
 def test_product_has_previous_page(test_client, generic_product_1, generic_product_2, generic_product_3):