Merge pull request #345 from NHSDigital/release/2024-10-07

Release/2024-10-07

Author: megan-bower4

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2024-10-07
+- [PI-505] Create EPR Product
+- [PI-538] Increase rate limiting
+- Dependabot: pre-commit
+
 ## 2024-10-02
 - [PI-497] Read a CPM Product
 - [PI-543] Remove snapshot from etl

VERSION

@@ -1 +1 @@
-2024.10.02
+2024.10.07

changelog/2024-10-07.md

@@ -0,0 +1,3 @@
+- [PI-505] Create EPR Product
+- [PI-538] Increase rate limiting
+- Dependabot: pre-commit

docs/public_swagger/swagger.yaml

@@ -480,6 +480,52 @@ paths:
             application/fhir+json:
               schema:
                 $ref: "#/components/schemas/OperationOutcome"
+  /ProductTeam/{product_team_id}/Product/Epr:
+    post:
+      operationId: createproductforeprendpoint
+      summary: createCpmProductForEpr endpoint for APIGEE integration
+      parameters:
+        - name: product_team_id
+          in: path
+          required: true
+          description: logical identifier
+          schema:
+            type: string
+        - in: header
+          name: version
+          schema:
+            $ref: "#/components/schemas/Version"
+        - in: header
+          name: x-request-id
+          schema:
+            $ref: "#/components/schemas/RequestId"
+        - in: header
+          name: x-correlation-id
+          schema:
+            $ref: "#/components/schemas/CorrelationId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                product_name:
+                  type: string
+                  description: Name of the product
+      responses:
+        "201":
+          description: Create operation successful
+          content:
+            application/fhir+json:
+              schema:
+                $ref: "#/components/schemas/OperationOutcome"
+        "4XX":
+          description: "Client Error"
+          content:
+            application/fhir+json:
+              schema:
+                $ref: "#/components/schemas/OperationOutcome"
   /searchSdsDevice:
     get:
       operationId: searchsdsdevice

infrastructure/swagger/04_apigee.yaml

@@ -14,3 +14,7 @@ x-nhsd-apim:
       type: apikey
       header: apikey
       secret: cpm-1 # NB: this is the *name* of the secret, not the value
+  ratelimiting:
+    proxy:
+      timeunit: "minute"
+      limit: 2000

infrastructure/swagger/05_paths.yaml

@@ -226,6 +226,42 @@ paths:
         - ${authoriser_name}: []
         - app-level0: []
 
+  /ProductTeam/{product_team_id}/Product/Epr:
+    post:
+      operationId: createproductforeprendpoint
+      summary: createCpmProductForEpr endpoint for APIGEE integration
+      parameters:
+        - name: product_team_id
+          in: path
+          required: true
+          description: logical identifier
+          schema:
+            type: string
+        - *RequestHeaderVersion
+        - *RequestHeaderRequestId
+        - *RequestHeaderCorrelationId
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                product_name:
+                  type: string
+                  description: Name of the product
+      responses:
+        "201":
+          <<: *Response201
+        "4XX":
+          <<: *Response4XX
+      x-amazon-apigateway-integration:
+        <<: *ApiGatewayIntegration
+        uri: ${method_createCpmProductForEpr}
+      security:
+        - ${authoriser_name}: []
+        - app-level0: []
+
   /Device:
     post:
       responses:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2024.10.02"
+version = "2024.10.07"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"
@@ -29,7 +29,7 @@ attrs = "^24.2.0"
 locust = "^2.29.1"
 
 [tool.poetry.group.dev.dependencies]
-pre-commit = "^3.4.0"
+pre-commit = "^4.0.0"
 black = "^24.1.1"
 flake8 = "^7.0.0"
 behave = "^1.2.6"

src/api/createCpmProduct/index.py

@@ -1,17 +1,7 @@
-from types import ModuleType
-
-from api_utils.versioning.constants import VERSIONING_STEP_ARGS
-from api_utils.versioning.steps import (
-    get_largest_possible_version,
-    get_steps_for_requested_version,
-    versioning_steps,
-)
-from domain.logging.step_decorators import logging_step_decorators
-from domain.response.steps import response_steps
+from api_utils.api_step_chain import execute_step_chain_with_location
 from event.aws.client import dynamodb_client
 from event.environment import BaseEnvironment
 from event.logging.logger import setup_logger
-from event.step_chain import StepChain
 
 from .src.v1.steps import steps as v1_steps
 
@@ -29,51 +19,8 @@ class Environment(BaseEnvironment):
 
 def handler(event: dict, context=None):
     setup_logger(service_name=__file__)
-    return execute_step_chain(
+    return execute_step_chain_with_location(
         event=event,
         cache=cache,
         versioned_steps=versioned_steps,
     )
-
-
-STEP_DECORATORS = [*logging_step_decorators]
-
-
-def lower_case_keys(_dict: dict[str, str]):
-    return {k.lower(): v for k, v in _dict.items()}
-
-
-def execute_step_chain(
-    event: dict, cache: dict, versioned_steps: dict[str, ModuleType]
-):
-    event["headers"] = lower_case_keys(event.get("headers", {}))
-
-    version_chain = StepChain(
-        step_chain=versioning_steps, step_decorators=STEP_DECORATORS
-    )
-    version_chain.run(
-        init={
-            VERSIONING_STEP_ARGS.EVENT: event,
-            VERSIONING_STEP_ARGS.VERSIONED_STEPS: versioned_steps,
-        }
-    )
-
-    version = None
-    location = None
-    if isinstance(version_chain.result, Exception):
-        result = version_chain.result
-    else:
-        version = version_chain.data[get_largest_possible_version]
-        steps = version_chain.data[get_steps_for_requested_version]
-        api_chain = StepChain(step_chain=steps, step_decorators=STEP_DECORATORS)
-        api_chain.run(cache=cache, init=event)
-        if isinstance(api_chain.result, Exception):
-            result = api_chain.result
-        else:
-            result, location = api_chain.result
-
-    response_chain = StepChain(
-        step_chain=response_steps, step_decorators=STEP_DECORATORS
-    )
-    response_chain.run(init=(result, version, location))
-    return response_chain.result

src/api/createCpmProduct/policies/dynamodb.json

@@ -1 +1 @@
-["dynamodb:Query", "dynamodb:PutItem"]
+["dynamodb:Query", "dynamodb:PutItem", "dynamodb:GetItem"]

src/api/createCpmProduct/src/v1/steps.py

@@ -1,90 +1,3 @@
-from http import HTTPStatus
+from domain.common_steps.create_product import after_steps, before_steps
 
-from aws_lambda_powertools.utilities.data_classes import APIGatewayProxyEvent
-from domain.core.cpm_product import CpmProduct
-from domain.core.cpm_system_id import ProductId
-from domain.core.product_team.v3 import ProductTeam
-from domain.repository.cpm_product_repository.v3 import CpmProductRepository
-from domain.repository.product_team_repository.v2 import ProductTeamRepository
-from domain.request_models.v1 import (
-    CreateCpmProductIncomingParams,
-    ProductTeamPathParams,
-)
-from domain.response.validation_errors import (
-    InboundValidationError,
-    mark_json_decode_errors_as_inbound,
-    mark_validation_errors_as_inbound,
-)
-from event.step_chain import StepChain
-from pydantic import ValidationError
-
-
-@mark_validation_errors_as_inbound
-def parse_path_params(data, cache) -> ProductTeamPathParams:
-    event = APIGatewayProxyEvent(data[StepChain.INIT])
-    return ProductTeamPathParams(**event.path_parameters)
-
-
-@mark_json_decode_errors_as_inbound
-def parse_event_body(data, cache) -> dict:
-    event = APIGatewayProxyEvent(data[StepChain.INIT])
-    return event.json_body if event.body else {}
-
-
-def parse_incoming_cpm_product(data, cache) -> CreateCpmProductIncomingParams:
-    json_body = data[parse_event_body]
-    try:
-        incoming_product = CreateCpmProductIncomingParams(**json_body)
-        return incoming_product
-    except ValidationError as exc:
-        raise InboundValidationError(errors=exc.raw_errors, model=exc.model)
-
-
-def read_product_team(data, cache) -> ProductTeam:
-    path_params: ProductTeamPathParams = data[parse_path_params]
-
-    product_team_repo = ProductTeamRepository(
-        table_name=cache["DYNAMODB_TABLE"], dynamodb_client=cache["DYNAMODB_CLIENT"]
-    )
-    return product_team_repo.read(id=path_params.product_team_id)
-
-
-def generate_cpm_product_id(data, cache) -> str:
-    generated_product_id = ProductId.create()
-    return generated_product_id.id
-
-
-@mark_validation_errors_as_inbound
-def create_cpm_product(data, cache) -> CpmProduct:
-    incoming_product = data[parse_incoming_cpm_product]
-    product_team: ProductTeam = data[read_product_team]
-    product_id = data[generate_cpm_product_id]
-    product = product_team.create_cpm_product(
-        product_id=product_id, name=incoming_product.product_name
-    )
-    return product
-
-
-def save_cpm_product(data, cache) -> dict:
-    cpm_product = data[create_cpm_product]
-    cpm_product_repo = CpmProductRepository(
-        table_name=cache["DYNAMODB_TABLE"], dynamodb_client=cache["DYNAMODB_CLIENT"]
-    )
-    return cpm_product_repo.write(entity=cpm_product)
-
-
-def set_http_status(data, cache) -> tuple[HTTPStatus, str]:
-    product: CpmProduct = data[create_cpm_product]
-    return HTTPStatus.CREATED, str(product.id)
-
-
-steps = [
-    parse_path_params,
-    parse_event_body,
-    parse_incoming_cpm_product,
-    read_product_team,
-    generate_cpm_product_id,
-    create_cpm_product,
-    save_cpm_product,
-    set_http_status,
-]
+steps = [*before_steps, *after_steps]