CR-156:Export consolidated conditions as PDF (#167)

* CR-156:Export consolidated conditions as PDF

* CR-156:Export consolidated conditions as PDF

Linting issues

* CR-156:Export consolidated conditions as PDF

Moved the PDF generation from frontend to the server side.

* CR-156:Export consolidated conditions as PDF

Linting error fix

Author: don-aot

condition-api/src/condition_api/__init__.py

@@ -73,6 +73,11 @@ def create_app(run_mode=os.getenv('FLASK_ENV', 'development')):
     @app.before_request
     def set_origin():
         g.origin_url = request.environ.get('HTTP_ORIGIN', 'localhost')
+        auth_header = request.headers.get('Authorization', None)
+        if auth_header and auth_header.startswith('Bearer '):
+            g.access_token = auth_header.split(' ')[1]
+        else:
+            g.access_token = None
 
     build_cache(app)
 

condition-api/src/condition_api/config.py

@@ -76,6 +76,10 @@ class _Config():  # pylint: disable=too-few-public-methods
     JWT_OIDC_CACHING_ENABLED = os.getenv('JWT_OIDC_CACHING_ENABLED', 'True')
     JWT_OIDC_JWKS_CACHE_TIMEOUT = 300
 
+    # DocGen service (external PDF/HTML rendering microservice)
+    DOCGEN_SERVICE_URL = os.getenv('DOCGEN_SERVICE_URL', '')
+    EAO_LOGO_URL = os.getenv('EAO_LOGO_URL', '')
+
     # Service account details
     KEYCLOAK_BASE_URL = os.getenv('KEYCLOAK_BASE_URL')
     KEYCLOAK_REALMNAME = os.getenv('KEYCLOAK_REALMNAME', 'condition')

condition-api/src/condition_api/resources/consolidated_condition.py

@@ -13,24 +13,61 @@
 # limitations under the License.
 """API endpoints for managing a consolidated condition resource."""
 
+import re
+from datetime import datetime
 from http import HTTPStatus
+from io import BytesIO
 
-from flask import request
+from flask import current_app, request, send_file
 from flask_cors import cross_origin
 from flask_restx import Namespace, Resource
 
 from marshmallow import ValidationError
 
 from condition_api.services import authorization
 from condition_api.services.condition_service import ConditionService
+from condition_api.services.docgen_service import TEMPLATE_KEY, DocGenService
 from condition_api.utils.util import allowedorigins, cors_preflight
 
 from .apihelper import Api as ApiHelper
 from ..auth import auth
 
 API = Namespace("conditions", description="Endpoints for Consolidated Condition Management")
-"""Custom exception messages
-"""
+
+
+def _build_render_context(consolidated: dict) -> dict:
+    """Build the template context dict from consolidated conditions data."""
+    conditions = consolidated.get("conditions", [])
+    project_name = consolidated.get("project_name", "")
+
+    amendment_set = set()
+    for cond in conditions:
+        for part in (cond.get("amendment_names") or "").split(","):
+            trimmed = part.strip()
+            if trimmed:
+                amendment_set.add(trimmed)
+
+    approved_count = sum(1 for c in conditions if c.get("is_approved"))
+    now = datetime.now()
+
+    return {
+        "project_name": project_name,
+        "generated_on": now.strftime("%A, %B ") + str(now.day) + now.strftime(", %Y"),
+        "generated_on_short": now.strftime("%B ") + str(now.day) + now.strftime(", %Y"),
+        "total_conditions": len(conditions),
+        "amendment_list": ", ".join(sorted(amendment_set)),
+        "all_approved": all(cond.get("is_approved") for cond in conditions),
+        "approved_count": approved_count,
+        "awaiting_count": len(conditions) - approved_count,
+        "logo_url": current_app.config.get("EAO_LOGO_URL", ""),
+        "conditions": conditions,
+    }
+
+
+def _safe_filename(project_name: str) -> str:
+    """Return a filesystem-safe version of the project name."""
+    name = re.sub(r"[^a-z0-9]", "_", project_name.lower())
+    return re.sub(r"_+", "_", name).strip("_")
 
 
 @cors_preflight("GET, OPTIONS")
@@ -71,3 +108,51 @@ def get(project_id):
 
         except ValidationError as err:
             return {"message": str(err)}, HTTPStatus.BAD_REQUEST
+
+
+@cors_preflight("POST, OPTIONS")
+@API.route("/project/<string:project_id>/render", methods=["POST", "OPTIONS"])
+class ConsolidatedConditionRenderResource(Resource):
+    """Resource for rendering consolidated conditions as a PDF via the DocGen service."""
+
+    @staticmethod
+    @ApiHelper.swagger_decorators(API, endpoint_description="Render consolidated conditions as PDF")
+    @API.response(HTTPStatus.BAD_REQUEST, "Bad Request")
+    @API.response(HTTPStatus.NOT_FOUND, "No conditions found")
+    @auth.optional
+    @cross_origin(origins=allowedorigins())
+    def post(project_id):
+        """Generate a PDF of consolidated conditions for a project."""
+        try:
+            output_format = "pdf"
+            if request.is_json:
+                output_format = request.json.get("output_format", "pdf")
+
+            consolidated = ConditionService.get_consolidated_conditions(
+                project_id,
+                all_conditions=True,
+                include_condition_attributes=False,
+                user_is_internal=True,
+            )
+
+            if not consolidated:
+                return {"message": "No conditions found for this project"}, HTTPStatus.NOT_FOUND
+
+            context = _build_render_context(consolidated)
+            docgen_response = DocGenService.render_template(TEMPLATE_KEY, context, output_format)
+
+            if output_format == "pdf":
+                safe_name = _safe_filename(consolidated.get("project_name", ""))
+                return send_file(
+                    BytesIO(docgen_response.content),
+                    mimetype="application/pdf",
+                    as_attachment=True,
+                    download_name=f"Consolidated_Conditions_{safe_name}.pdf",
+                )
+
+            return docgen_response.json(), HTTPStatus.OK
+
+        except ValidationError as err:
+            return {"message": str(err)}, HTTPStatus.BAD_REQUEST
+        except Exception as err:  # pylint: disable=broad-except
+            return {"message": f"Failed to generate PDF: {str(err)}"}, HTTPStatus.INTERNAL_SERVER_ERROR

condition-api/src/condition_api/services/condition_service.py

@@ -961,9 +961,13 @@ def _process_internal_conditions(condition_data):
                 "year_issued": row.year_issued,
                 "effective_document_id": row.effective_document_id,
                 "source_document": row.amendment_name if row.amendment_name
-                and row.condition_type == ConditionType.ADD else row.document_label
+                and row.condition_type == ConditionType.ADD else row.document_label,
+                "subconditions": []
             }
 
+        for cond_id in conditions_map:
+            ConditionService._populate_subconditions(conditions_map, cond_id)
+
         return ProjectDocumentConditionSchema().dump(
             {
                 "project_name": condition_data[0].project_name,

condition-api/src/condition_api/services/docgen_service.py

@@ -0,0 +1,70 @@
+# Copyright © 2024 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Service for generating documents via the DocGen service."""
+
+import time
+
+import requests
+from flask import current_app, g, json
+
+TEMPLATE_KEY = "CONSOLIDATED_CONDITIONS_TEMPLATE"
+APP_NAME = "CONDITION"
+
+_MAX_RETRIES = 3
+_RETRY_WAIT = 2  # seconds
+
+
+class DocGenService:
+    """Service for generating PDF/HTML documents via the external DocGen service."""
+
+    @staticmethod
+    def render_template(template_key: str, context: dict, output_type: str = "html"):
+        """Render a registered template with the given context data."""
+        return _request_docgen_service(
+            "templates/render?use_total_pages=true",
+            {
+                "template_key": template_key,
+                "app": APP_NAME,
+                "data": context,
+                "output_type": output_type,
+            },
+        )
+
+
+def _request_docgen_service(relative_url: str, data: dict = None):
+    """Make a POST request to the DocGen service with simple retry logic."""
+    token = getattr(g, "access_token", None)
+    docgen_service_url = current_app.config.get("DOCGEN_SERVICE_URL", "")
+
+    headers = {
+        "Content-Type": "application/json",
+        "Authorization": f"Bearer {token}",
+    }
+
+    url = f"{docgen_service_url}/api/{relative_url}"
+
+    last_exc = None
+    for attempt in range(_MAX_RETRIES):
+        try:
+            response = requests.post(
+                url=url, headers=headers, data=json.dumps(data), timeout=60
+            )
+            response.raise_for_status()
+            return response
+        except requests.exceptions.RequestException as exc:
+            last_exc = exc
+            if attempt < _MAX_RETRIES - 1:
+                time.sleep(_RETRY_WAIT)
+
+    raise last_exc