piper-utils 1.1.30 → 1.1.33

package/src/requestResponse/requestResponse.js

@@ -1,287 +1,293 @@
-import _ from 'lodash';
-import { errorList } from './errorCodes.js';
-
-/**
- * @param {Object} body
- * @param {{dbClose?:function}} [options]
- */
-export function success(body, options) {
-    const dbClose = _.get(options, 'dbClose', _.noop);
-    dbClose();
-
-    return buildResponse(200, body);
-}
-
-/**
- * @param {string} html
- * @param {{dbClose:function|undefined}} options
- */
-export function successHtml(html, options) {
-    const dbClose = _.get(options, 'dbClose', _.noop);
-
-    dbClose();
-    return {
-        statusCode: 200,
-        headers: {
-            'Content-Type': 'text/html',
-            'Access-Control-Allow-Origin': '*',
-            'Access-Control-Allow-Credentials': true
-        },
-        body: html
-    };
-}
-
-/**
- * @param {string} event
- * @returns string
- */
-export function getCurrentUserNameFromCognitoEvent(event) {
-    const attributes = _.get(event, 'request.userAttributes');
-
-    return attributes['cognito:email_alias'] || attributes['email'] || 'UNKNOWN USER';
-}
-
-/**
- * Get the user information from the event object
- *
- * @param event {Object} an event object
- * @returns {{username: string, id: number}}
- */
-export function getCurrentUser(event) {
-    let jsonToParse = _.get(event, 'requestContext.authorizer.claims.custom:UID') ||
-        _.get(event, 'requestContext.authorizer.custom:UID') ||
-        '0';
-
-    const id = JSON.parse(jsonToParse);
-
-    const username = _.get(event, 'requestContext.authorizer.claims.email') || _.get(event, 'requestContext.authorizer.email') || 'localtestuser@gexample.com';
-
-    return {
-        username,
-        id
-    };
-}
-
-/**
- * Create a failure response
- *
- * @param body {Object} an event object
- * @param options {Object} an options object
- * @returns {{statusCode:number, headers:object, body:string}} a response object
- */
-export function failure(body = {}, options) {
-    const dbClose = _.get(options, 'dbClose', _.noop);
-    dbClose();
-    let cleanedErrorBody;
-
-    if (process.env.UTIL_LOG === 'LOG_ALL' || process.env.BUILD_ENV === 'test') {
-        if (_.isObject(body)) {
-            console.error('------->ALL UTIL ERROR:', JSON.stringify(body, null, 2));
-        }
-    }
-
-    const NORMAL_ERROR = { statusCode: 500, errorCode: '5XX', message: 'INTERNAL UTIL ERROR' };
-    cleanedErrorBody = body;
-    if (!_.isUndefined(body.details)) {
-        cleanedErrorBody = detectJoyError(body);
-    } else if (_.isUndefined(body.errorCode) || _.isUndefined(body.statusCode)) {
-        cleanedErrorBody = detectSequelizeError(body);
-    }
-    if (_.get(body, 'response.data.message')) {
-        const err = _.get(body, 'response.data.message');
-        if (_.isObject(body)) {
-            console.error('------->MSG UTIL ERROR:', JSON.stringify(err, null, 2));
-        }
-    }
-    const newBody = _.merge(NORMAL_ERROR, cleanedErrorBody);
-
-    return buildResponse(newBody.statusCode, newBody);
-}
-
-/**
- * Create a failure response object
- *
- * @param statusCode {Number} a status code
- * @param body {Object} an event object
- * @returns {{statusCode:number, headers:object, body:string}} a response object
- */
-function buildResponse(statusCode, body) {
-    return {
-        statusCode: statusCode,
-        headers: {
-            'Access-Control-Allow-Origin': '*',
-            'Access-Control-Allow-Credentials': true
-        },
-        body: JSON.stringify(body)
-    };
-}
-
-/**
- * parse the body of the event object
- *
- * @param requestEvent {{body:string}} an event object
- * @returns event {*} the json object of the body
- */
-export function parseBody(requestEvent) {
-
-    let eventBody = {};
-    if (_.isString(requestEvent.body)) {
-        try {
-            eventBody = JSON.parse(requestEvent.body);
-        } catch (e) {
-            // Invalid JSON
-            eventBody = null;
-
-            throw errorList.invalidJson;
-        }
-    } else if (_.isObject(requestEvent.body)) {
-        eventBody = requestEvent.body;
-    }
-
-    return eventBody;
-}
-
-/**
- * parse the body of the event object
- *
- * @param requestEvent {string|object} an event object
- * @param [callback] {function} undefined a call back function
- * @returns event {*} the json object of the body
- */
-export function parseEvent(requestEvent, callback) {
-    let event = {};
-    if (_.isString(requestEvent)) {
-        try {
-            event = JSON.parse(requestEvent);
-        } catch (e) {
-            // Invalid JSON
-            event = null;
-
-            if (callback) {
-                callback(Error(e));
-            }
-        }
-    } else if (_.isObject(requestEvent)) {
-        event = requestEvent;
-    }
-
-    return event;
-}
-
-/**
- * parse the body of the event object
- * look for sequelize errors and return a message
- * ERRORS should not be caught here this is a fallback for unknown database errors
- *
- * @param body {object} part of a body response
- * @returns error message object {message:string}
- */
-export function detectSequelizeError(body) {
-    const errorBody = {};
-    const errorName = _.get(body, 'name', '');
-
-    if (errorName === 'SequelizeForeignKeyConstraintError') {
-        errorBody.message = 'You cannot delete this item as it is in use';
-        errorBody.statusCode = 409;
-        errorBody.errorCode = '4090';
-        return errorBody;
-    }
-
-    if (errorName === 'SequelizeUniqueConstraintError') {
-        const fields = _.get(body, 'errors', []).map(err => _.get(err, 'path')).filter(Boolean);
-        errorBody.message = fields.length
-            ? 'A record with this ' + fields.join(', ') + ' already exists'
-            : 'A record with this value already exists';
-        errorBody.statusCode = 409;
-        errorBody.errorCode = '4091';
-        return errorBody;
-    }
-
-    if (errorName === 'SequelizeValidationError') {
-        const messages = _.get(body, 'errors', []).map(err => _.get(err, 'message')).filter(Boolean);
-        errorBody.message = messages.length ? messages.join(', ') : 'Validation error';
-        errorBody.statusCode = 400;
-        errorBody.errorCode = '4001';
-        return errorBody;
-    }
-
-    let sequelizeError = _.get(body, 'errors', []).reduce((acc, err) => {
-        acc = acc + ' ' + _.get(err, 'message');
-        return acc;
-    }, '');
-    const parentError = _.get(body, 'parent', '');
-
-    sequelizeError = sequelizeError + _.get(body, 'original.detail', '') + _.get(body, 'TypeError', '') + parentError;
-    errorBody.message = sequelizeError.trim();
-    return errorBody;
-}
-
-export function detectJoyError(body) {
-    const errorBody = {};
-    const details = _.get(body, 'details') || [];
-
-    console.error('USER VALIDATION ERROR:', body);
-    const messages = extractJoyMessages(details);
-    const msg = messages.join(', ');
-
-    if (msg) {
-        errorBody.message = msg;
-    }
-
-    errorBody.statusCode = 400;
-    errorBody.errorCode = '4000';
-    return errorBody;
-}
-
-function extractJoyMessages(details) {
-    const messages = [];
-    for (const detail of details) {
-        const contextDetails = _.get(detail, 'context.details') || [];
-        const directDetails = detail.details || [];
-        const nestedDetails = contextDetails.length > 0 ? contextDetails : directDetails;
-
-        if (nestedDetails.length > 0) {
-            messages.push(...extractJoyMessages(nestedDetails));
-        } else if (detail.message) {
-            messages.push(detail.message);
-        }
-    }
-    return messages;
-}
-
-/**
- * Parse the body of a Dynamoose error response.
- * Attempts to extract a human-readable error message from Dynamoose errors.
- * This is a fallback for unknown database errors.
- *
- * @param {object} body - Part of a body response containing error details.
- * @returns {object} - Error message object { message: string }
- */
-export function detectDynamooseError(body) {
-    const errorBody = {};
-
-    // Start with an empty message string.
-    let dynamooseError = '';
-
-    // If the error body contains an array of errors, concatenate their messages.
-    if (Array.isArray(body.errors)) {
-        dynamooseError += body.errors.reduce((acc, err) => {
-            return acc + ' ' + (err.message || '');
-        }, '');
-    }
-
-    // If there's a top-level message, add it.
-    if (body.message) {
-        dynamooseError += ' ' + body.message;
-    }
-
-    // If there is any additional detail provided, append it.
-    if (body.detail) {
-        dynamooseError += ' ' + body.detail;
-    }
-
-    // Trim the message to remove extra spaces.
-    errorBody.message = dynamooseError.trim();
-
-    return errorBody;
+import _ from 'lodash';
+import { errorList } from './errorCodes.js';
+
+/**
+ * @param {Object} body
+ * @param {{dbClose?:function}} [options]
+ */
+export function success(body, options) {
+    const dbClose = _.get(options, 'dbClose', _.noop);
+    dbClose();
+
+    return buildResponse(200, body);
+}
+
+/**
+ * @param {string} html
+ * @param {{dbClose:function|undefined}} options
+ */
+export function successHtml(html, options) {
+    const dbClose = _.get(options, 'dbClose', _.noop);
+
+    dbClose();
+    return {
+        statusCode: 200,
+        headers: {
+            'Content-Type': 'text/html',
+            'Access-Control-Allow-Origin': '*',
+            'Access-Control-Allow-Credentials': true
+        },
+        body: html
+    };
+}
+
+/**
+ * @param {string} event
+ * @returns string
+ */
+export function getCurrentUserNameFromCognitoEvent(event) {
+    const attributes = _.get(event, 'request.userAttributes');
+
+    return attributes['cognito:email_alias'] || attributes['email'] || 'UNKNOWN USER';
+}
+
+/**
+ * Get the user information from the event object
+ *
+ * @param event {Object} an event object
+ * @returns {{username: string, id: number}}
+ */
+export function getCurrentUser(event) {
+    let jsonToParse = _.get(event, 'requestContext.authorizer.claims.custom:UID') ||
+        _.get(event, 'requestContext.authorizer.custom:UID') ||
+        '0';
+
+    const id = JSON.parse(jsonToParse);
+
+    const username = _.get(event, 'requestContext.authorizer.claims.email') || _.get(event, 'requestContext.authorizer.email') || 'localtestuser@gexample.com';
+
+    return {
+        username,
+        id
+    };
+}
+
+/**
+ * Create a failure response
+ *
+ * @param body {Object} an event object
+ * @param options {Object} an options object
+ * @returns {{statusCode:number, headers:object, body:string}} a response object
+ */
+export function failure(body = {}, options) {
+    const dbClose = _.get(options, 'dbClose', _.noop);
+    dbClose();
+    let cleanedErrorBody;
+
+    if (process.env.UTIL_LOG === 'LOG_ALL' || process.env.BUILD_ENV === 'test') {
+        if (_.isObject(body)) {
+            console.error('------->ALL UTIL ERROR:', JSON.stringify(body, null, 2));
+        }
+    }
+
+    const NORMAL_ERROR = { statusCode: 500, errorCode: '5XX', message: 'INTERNAL UTIL ERROR' };
+    cleanedErrorBody = body;
+    if (!_.isUndefined(body.details)) {
+        cleanedErrorBody = detectJoyError(body);
+    } else if (_.isUndefined(body.errorCode) || _.isUndefined(body.statusCode)) {
+        cleanedErrorBody = detectSequelizeError(body);
+    }
+    if (_.get(body, 'response.data.message')) {
+        const err = _.get(body, 'response.data.message');
+        if (_.isObject(body)) {
+            console.error('------->MSG UTIL ERROR:', JSON.stringify(err, null, 2));
+        }
+    }
+    const newBody = _.merge(NORMAL_ERROR, cleanedErrorBody);
+
+    return buildResponse(newBody.statusCode, newBody);
+}
+
+/**
+ * Create a failure response object
+ *
+ * @param statusCode {Number} a status code
+ * @param body {Object} an event object
+ * @returns {{statusCode:number, headers:object, body:string}} a response object
+ */
+function buildResponse(statusCode, body) {
+    return {
+        statusCode: statusCode,
+        headers: {
+            'Access-Control-Allow-Origin': '*',
+            'Access-Control-Allow-Credentials': true
+        },
+        body: JSON.stringify(body)
+    };
+}
+
+/**
+ * parse the body of the event object
+ *
+ * @param requestEvent {{body:string}} an event object
+ * @returns event {*} the json object of the body
+ */
+export function parseBody(requestEvent) {
+
+    let eventBody = {};
+    if (_.isString(requestEvent.body)) {
+        try {
+            eventBody = JSON.parse(requestEvent.body);
+        } catch (e) {
+            // Invalid JSON
+            eventBody = null;
+
+            throw errorList.invalidJson;
+        }
+    } else if (_.isObject(requestEvent.body)) {
+        eventBody = requestEvent.body;
+    }
+
+    return eventBody;
+}
+
+/**
+ * parse the body of the event object
+ *
+ * @param requestEvent {string|object} an event object
+ * @param [callback] {function} undefined a call back function
+ * @returns event {*} the json object of the body
+ */
+export function parseEvent(requestEvent, callback) {
+    let event = {};
+    if (_.isString(requestEvent)) {
+        try {
+            event = JSON.parse(requestEvent);
+        } catch (e) {
+            // Invalid JSON
+            event = null;
+
+            if (callback) {
+                callback(Error(e));
+            }
+        }
+    } else if (_.isObject(requestEvent)) {
+        event = requestEvent;
+    }
+
+    return event;
+}
+
+/**
+ * parse the body of the event object
+ * look for sequelize errors and return a message
+ * ERRORS should not be caught here this is a fallback for unknown database errors
+ *
+ * @param body {object} part of a body response
+ * @returns error message object {message:string}
+ */
+export function detectSequelizeError(body) {
+    const errorBody = {};
+    const errorName = _.get(body, 'name', '');
+
+    if (errorName === 'SequelizeForeignKeyConstraintError') {
+        errorBody.message = 'You cannot delete this item as it is in use';
+        errorBody.statusCode = 409;
+        errorBody.errorCode = '4090';
+        return errorBody;
+    }
+
+    if (errorName === 'SequelizeUniqueConstraintError') {
+        const fields = _.get(body, 'errors', []).map(err => _.get(err, 'path')).filter(Boolean);
+        errorBody.message = fields.length
+            ? 'A record with this ' + fields.join(', ') + ' already exists'
+            : 'A record with this value already exists';
+        errorBody.statusCode = 409;
+        errorBody.errorCode = '4091';
+        return errorBody;
+    }
+
+    if (errorName === 'SequelizeValidationError') {
+        const messages = _.get(body, 'errors', []).map(err => _.get(err, 'message')).filter(Boolean);
+        errorBody.message = messages.length ? messages.join(', ') : 'Validation error';
+        errorBody.statusCode = 400;
+        errorBody.errorCode = '4001';
+        return errorBody;
+    }
+
+    let sequelizeError = _.get(body, 'errors', []).reduce((acc, err) => {
+        acc = acc + ' ' + _.get(err, 'message');
+        return acc;
+    }, '');
+    const parentError = _.get(body, 'parent', '');
+
+    sequelizeError = sequelizeError + _.get(body, 'original.detail', '') + _.get(body, 'TypeError', '') + parentError;
+    errorBody.message = sequelizeError.trim();
+    return errorBody;
+}
+
+export function detectJoyError(body) {
+    const errorBody = {};
+    const details = _.get(body, 'details') || [];
+
+    console.error('USER VALIDATION ERROR:', JSON.stringify(body, null, 2));
+    const messages = extractJoyMessages(details);
+    const msg = messages.join(', ');
+
+    if (msg) {
+        errorBody.message = msg;
+    }
+
+    errorBody.statusCode = 400;
+    errorBody.errorCode = '4000';
+    return errorBody;
+}
+
+function extractJoyMessages(details) {
+    const messages = [];
+    for (const detail of details) {
+        const contextDetails = _.get(detail, 'context.details') || [];
+        const directDetails = detail.details || [];
+        const nestedDetails = contextDetails.length > 0 ? contextDetails : directDetails;
+
+        if (nestedDetails.length > 0) {
+            messages.push(...extractJoyMessages(nestedDetails));
+        } else if (detail.message) {
+            let msg = detail.message;
+            if (detail.context?.value && /does not match/.test(msg)) {
+                const valueStr = JSON.stringify(detail.context.value);
+                const truncated = valueStr.length > 200 ? valueStr.substring(0, 200) + '...' : valueStr;
+                msg += ', received: ' + truncated;
+            }
+            messages.push(msg);
+        }
+    }
+    return messages;
+}
+
+/**
+ * Parse the body of a Dynamoose error response.
+ * Attempts to extract a human-readable error message from Dynamoose errors.
+ * This is a fallback for unknown database errors.
+ *
+ * @param {object} body - Part of a body response containing error details.
+ * @returns {object} - Error message object { message: string }
+ */
+export function detectDynamooseError(body) {
+    const errorBody = {};
+
+    // Start with an empty message string.
+    let dynamooseError = '';
+
+    // If the error body contains an array of errors, concatenate their messages.
+    if (Array.isArray(body.errors)) {
+        dynamooseError += body.errors.reduce((acc, err) => {
+            return acc + ' ' + (err.message || '');
+        }, '');
+    }
+
+    // If there's a top-level message, add it.
+    if (body.message) {
+        dynamooseError += ' ' + body.message;
+    }
+
+    // If there is any additional detail provided, append it.
+    if (body.detail) {
+        dynamooseError += ' ' + body.detail;
+    }
+
+    // Trim the message to remove extra spaces.
+    errorBody.message = dynamooseError.trim();
+
+    return errorBody;
 }