Merge pull request #495 from NHSDigital/release/2025-02-13

Release/2025 02 13

Author: jameslinnell

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2025-02-13
+- [PI-767] Table design change
+
 ## 2025-02-12
 - [PI-762] UI Demo POC
 

VERSION

@@ -1 +1 @@
-2025.02.12
+2025.02.13

changelog/2025-02-13.md

@@ -0,0 +1 @@
+- [PI-767] Table design change

infrastructure/swagger/05_paths.yaml

@@ -315,7 +315,7 @@ paths:
       description: |
         - Delete a product using a product team ID and product ID.
       tags:
-        - Core Product ID Endpointsurce (DELETE)
+        - Core Product ID Endpoints
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2025.02.12"
+version = "2025.02.13"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"

src/api/readCpmProduct/tests/test_index.py

@@ -13,7 +13,7 @@
 
 TABLE_NAME = "hiya"
 ODS_CODE = "F5H1R"
-PRODUCT_TEAM_ID = "F5H1R.641be376-3954-4339-822c-54071c9ff1a0"
+PRODUCT_TEAM_ID = "641be376-3954-4339-822c-54071c9ff1a0"
 PRODUCT_TEAM_NAME = "product-team-name"
 PRODUCT_ID = "P.XXX-YYY"
 PRODUCT_NAME = "cpm-product-name"
@@ -64,7 +64,6 @@ def test_index(version):
                 },
             }
         )
-
     response_body = json_loads(result["body"])
 
     # Assertions for fields that must exactly match

src/api/readProductTeam/tests/test_index.py

@@ -23,7 +23,7 @@
 )
 def test_index(version):
     org = Root.create_ods_organisation(ods_code=CPM_PRODUCT_TEAM_NO_ID["ods_code"])
-    product_team = org.create_product_team_epr(
+    product_team = org.create_product_team(
         name=CPM_PRODUCT_TEAM_NO_ID["name"], keys=CPM_PRODUCT_TEAM_NO_ID["keys"]
     )
 
@@ -135,7 +135,7 @@ def test_index_no_such_product_team(version, product_id):
 )
 def test_index_by_alias(version):
     org = Root.create_ods_organisation(ods_code=CPM_PRODUCT_TEAM_NO_ID["ods_code"])
-    product_team = org.create_product_team_epr(
+    product_team = org.create_product_team(
         name=CPM_PRODUCT_TEAM_NO_ID["name"], keys=CPM_PRODUCT_TEAM_NO_ID["keys"]
     )
 

src/layers/domain/core/enum.py

@@ -12,3 +12,9 @@ class Environment(StrEnum):
     REF = auto()
     INT = auto()
     PROD = auto()
+
+
+class EntityType(StrEnum):
+    PRODUCT_TEAM = auto()
+    PRODUCT_TEAM_ALIAS = auto()
+    PRODUCT = auto()

src/layers/domain/repository/cpm_product_repository/tests/v1/test_cpm_product_repository_keys_v1.py

@@ -1,11 +1,7 @@
 import pytest
 from domain.core.cpm_product import CpmProduct
 from domain.core.product_key import ProductKey, ProductKeyType
-from domain.core.root import Root
 from domain.repository.cpm_product_repository import CpmProductRepository
-from domain.repository.errors import AlreadyExistsError
-
-from test_helpers.sample_data import CPM_PRODUCT_TEAM_NO_ID
 
 PARTY_KEY = "ABC-123456"
 
@@ -17,32 +13,7 @@ def test__product_repository__add_key(
     party_key = ProductKey(key_type=ProductKeyType.PARTY_KEY, key_value=PARTY_KEY)
     product.add_key(**party_key.dict())
     repository.write(product)
-
     product_by_id = repository.read(
         product_team_id=product.product_team_id, id=product.id
     )
     assert product_by_id.keys == [party_key]
-
-
-@pytest.mark.integration
-def test__product_repository__cannot_add_duplicate_key(
-    product: CpmProduct, repository: CpmProductRepository
-):
-    """This test guards against Party Key clashes"""
-
-    party_key = ProductKey(key_type=ProductKeyType.PARTY_KEY, key_value=PARTY_KEY)
-    product.add_key(**party_key.dict())
-    repository.write(product)
-
-    # Create a second unrelated product
-    org = Root.create_ods_organisation(ods_code=CPM_PRODUCT_TEAM_NO_ID["ods_code"])
-    second_product_team = org.create_product_team(
-        name=CPM_PRODUCT_TEAM_NO_ID["name"], keys=CPM_PRODUCT_TEAM_NO_ID["keys"]
-    )
-    second_product = second_product_team.create_cpm_product(
-        name="another-cpm-product-name"
-    )
-    second_product.add_key(**party_key.dict())
-
-    with pytest.raises(AlreadyExistsError):
-        repository.write(second_product)

src/layers/domain/repository/cpm_product_repository/v1.py

@@ -5,6 +5,7 @@
     CpmProductDeletedEvent,
     CpmProductKeyAddedEvent,
 )
+from domain.core.enum import EntityType
 from domain.core.product_key import ProductKey
 from domain.repository.cpm_repository import Repository
 from domain.repository.keys import TableKey
@@ -32,27 +33,27 @@ def handle_CpmProductCreatedEvent(self, event: CpmProductCreatedEvent):
             parent_key_parts=(event.product_team_id,),
             data=asdict(event),
             root=True,
+            row_type=EntityType.PRODUCT,
         )
 
     def handle_CpmProductKeyAddedEvent(self, event: CpmProductKeyAddedEvent):
         # Create a copy of the Product indexed against the new key
         new_key = ProductKey(**event.new_key)
-        create_transaction = self.create_index(
-            id=new_key.key_value,
-            parent_key_parts=(event.product_team_id,),
-            data=asdict(event),
-            root=False,
-        )
-
         # Update the value of "keys" on all other copies of this Device
         product_keys = {ProductKey(**key) for key in event.keys}
         product_keys_before_update = product_keys - {new_key}
         update_transactions = self.update_indexes(
+            pk=TableKey.PRODUCT_TEAM.key(event.product_team_id),
             id=event.id,
             keys=product_keys_before_update,
             data={"keys": event.keys, "updated_on": event.updated_on},
         )
-        return [create_transaction] + update_transactions
+        return update_transactions
 
     def handle_CpmProductDeletedEvent(self, event: CpmProductDeletedEvent):
-        return self.update_indexes(id=event.id, keys=event.keys, data=asdict(event))
+        return self.update_indexes(
+            pk=TableKey.PRODUCT_TEAM.key(event.product_team_id),
+            id=event.id,
+            keys=event.keys,
+            data=asdict(event),
+        )