001/*-
002 * #%L
003 * Smile CDR - CDR
004 * %%
005 * Copyright (C) 2016 - 2025 Smile CDR, Inc.
006 * %%
007 * All rights reserved.
008 * #L%
009 */
010package ca.cdr.api.util;
011
012import ca.cdr.api.model.json.TransactionLogStepJson;
013import ca.cdr.api.pub.hl7v2.model.MappingMessage;
014import ca.uhn.fhir.rest.api.server.RequestDetails;
015import ca.uhn.fhir.rest.server.servlet.ServletRequestDetails;
016import com.fasterxml.jackson.core.JsonProcessingException;
017import com.fasterxml.jackson.databind.ObjectMapper;
018import jakarta.servlet.http.HttpServletRequest;
019import org.apache.commons.lang3.Validate;
020
021import java.util.ArrayList;
022import java.util.Collections;
023import java.util.HashMap;
024import java.util.List;
025import java.util.Map;
026
027/**
028 * NOTE: this utility is using vanilla Jackson - FHIR resources can not be serialized.
029 */
030public class TransactionLogRequestDetailsUtil {
031        public static final String STEPS_LIST_KEY = TransactionLogRequestDetailsUtil.class.getName() + "_STEPS_LIST";
032        public static final String REQUEST_SUBTYPE_KEY =
033                        TransactionLogRequestDetailsUtil.class.getName() + "_REQUEST_SUBTYPE_KEY";
034        private static final String MESSAGES_LIST_KEY = TransactionLogRequestDetailsUtil.class.getName() + "_MESSAGES_LIST";
035        private static final String ADDITIONAL_JSON_MAP_KEY =
036                        TransactionLogRequestDetailsUtil.class.getName() + "_ADDITIONAL_JSON_MAP";
037
038        private static final ObjectMapper ourObjectMapper = new ObjectMapper();
039
040        private TransactionLogRequestDetailsUtil() {}
041
042        public static void addMessageToRequest(RequestDetails theDetails, MappingMessage theMessage) {
043                Validate.notNull(theDetails, "theDetails must not be null");
044                Validate.notNull(theMessage, "theMessage must not be null");
045                @SuppressWarnings("unchecked")
046                List<MappingMessage> messages =
047                                (List<MappingMessage>) theDetails.getUserData().get(MESSAGES_LIST_KEY);
048                if (messages == null) {
049                        messages = new ArrayList<>();
050                        theDetails.getUserData().put(MESSAGES_LIST_KEY, messages);
051                }
052                messages.add(theMessage);
053        }
054
055        public static List<MappingMessage> getMessagesOnRequest(RequestDetails theDetails) {
056                @SuppressWarnings("unchecked")
057                List<MappingMessage> messages =
058                                (List<MappingMessage>) theDetails.getUserData().get(MESSAGES_LIST_KEY);
059                if (messages == null) {
060                        return List.of();
061                }
062                return Collections.unmodifiableList(messages);
063        }
064
065        public static List<TransactionLogStepJson> getTransactionLogStepsFromRequest(RequestDetails theRequestDetails) {
066                @SuppressWarnings("unchecked")
067                List<TransactionLogStepJson> steps =
068                                (List<TransactionLogStepJson>) theRequestDetails.getAttribute(STEPS_LIST_KEY);
069                if (steps == null) {
070                        return List.of();
071                }
072                return Collections.unmodifiableList(steps);
073        }
074
075        /**
076         * Adds a transaction log step to the attribute which holds the list of steps for the provided request.
077         * @param theRequestDetails the request details
078         * @param theStep the transaction log step to add
079         */
080        public static void addTransactionLogStepForRequest(
081                        ServletRequestDetails theRequestDetails, TransactionLogStepJson theStep) {
082                Validate.notNull(theRequestDetails, "theRequestDetails must not be null");
083                addTransactionLogStepForRequest(theRequestDetails.getServletRequest(), theStep);
084        }
085
086        /**
087         * Adds a transaction log step to the attribute which holds the list of steps for the provided request.
088         * @param theRequest the request
089         * @param theStep the transaction log step to add
090         */
091        public static void addTransactionLogStepForRequest(HttpServletRequest theRequest, TransactionLogStepJson theStep) {
092                Validate.notNull(theRequest, "theRequest must not be null");
093                Validate.notNull(theStep, "theStep must not be null");
094                @SuppressWarnings("unchecked")
095                List<TransactionLogStepJson> steps = (List<TransactionLogStepJson>) theRequest.getAttribute(STEPS_LIST_KEY);
096                if (steps == null) {
097                        steps = new ArrayList<>();
098                        theRequest.setAttribute(STEPS_LIST_KEY, steps);
099                }
100                steps.add(theStep);
101        }
102
103        /**
104         * NOTE: this method is using vanilla Jackson - FHIR resources can not be serialized.
105         *
106         * Utility method to add key/value pairs to a transactionLog.  The provided value needs to be serializable
107         * with Jackson since pairs are accumulated and subsequently formatted in an inline json string.
108         * IllegalArgumentException is thrown if <code>theValue</code> is not Json serializable with Jackson or <code>null</code>.
109         *      The additional log properties will be tallied and rendered as inline json in the transactionLogEventJson:
110         *{
111         *              "id": 2,
112         *      "initialTimestamp": "2023-08-29T14:00:30.096-04:00",
113         *              "type": "FHIR_REQUEST",
114         *              "subType": "FHIR_CREATE",
115         *              "outcome": "SUCCESS",
116         *              ...
117         *              "requestId": "r1bW96uhRAn2z8iU",
118         *              "additionalJson": { "diseases": [ "Tuberculosis", "Polio", "Malaria", "Dengue fever"], "clinic": "Acme Ouest" },
119         *              ...
120         *              "userFamilyName": "GenericUser",
121         *              "userGivenName": "Admin"
122         *              }
123         *
124         * @param theRequestDetails The request details where the pairs will be stored
125         * @param theKey The key for referencing to theObject.  Keys are transformed into json properties when serializing a pair.
126         * @param theValue The value needing storage.  Values are transformed into json values when serializing a pair.
127         *
128         */
129        public static void addAdditionalJsonProperty(RequestDetails theRequestDetails, String theKey, Object theValue) {
130                Validate.notNull(theRequestDetails, "theDetails must not be null");
131                Validate.notNull(theKey, "theKey must not be null");
132                Validate.notNull(theValue, "theValue must not be null");
133
134                try {
135                        // ensure that the value can be serialized to JSON
136                        ourObjectMapper.writeValueAsString(theValue);
137                } catch (JsonProcessingException e) {
138                        throw new IllegalArgumentException(
139                                        String.format(
140                                                        "Unable to add pair with key %s to the additional Json property as the provided value object could not be parsed.",
141                                                        theKey),
142                                        e);
143                }
144                @SuppressWarnings("unchecked")
145                Map<String, Object> additionalJsonPropertiesMap =
146                                (Map<String, Object>) theRequestDetails.getAttribute(ADDITIONAL_JSON_MAP_KEY);
147                if (additionalJsonPropertiesMap == null) {
148                        additionalJsonPropertiesMap = new HashMap<>();
149                        theRequestDetails.setAttribute(ADDITIONAL_JSON_MAP_KEY, additionalJsonPropertiesMap);
150                }
151                additionalJsonPropertiesMap.put(theKey, theValue);
152        }
153
154        public static Map<String, Object> getAdditionalJsonPropertiesMap(RequestDetails theRequestDetails) {
155                Validate.notNull(theRequestDetails, "theRequestDetails must not be null");
156                @SuppressWarnings("unchecked")
157                Map<String, Object> additionalJsonPropertiesMap =
158                                (Map<String, Object>) theRequestDetails.getAttribute(ADDITIONAL_JSON_MAP_KEY);
159                if (additionalJsonPropertiesMap == null) {
160                        return Map.of();
161                }
162                return additionalJsonPropertiesMap;
163        }
164}