[MWPW-174041] : Generic method to parse the error object (including nested error object) and flatten it to be logged in splunk incase of ims token failure #497
Conversation
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
eslint
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
A space is required after ','.
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
A space is required after ','.
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
A space is required after ','.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 198 to 199 in ae6d683
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'error_generic' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'pre_upload_error_loading_verb_limits' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'pre_upload_error_empty_verb_limits' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'pre_upload_error_renaming_file' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'pre_upload_error_fetch_redirect_url' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_validate_files' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_unsupported_type' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_empty_file' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_file_too_large' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_only_accept_one_file' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_file_same_type' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_unsupported_type_multi' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_empty_file_multi' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_file_too_large_multi' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_multiple_invalid_files' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_max_num_files' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'validation_error_file_same_type_multi' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_validation_error_max_page_count' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_validation_error_min_page_count' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_validation_error_verify_page_count' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_validation_error_max_page_count_multi' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_validation_error_duplicate_asset' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_error_max_quota_exceeded' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_error_no_storage_provision' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_error_chunk_upload' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_error_finalize_asset' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_error_redirect_to_app' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'upload_warn_chunk_upload' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'pre_upload_warn_renamed_invalid_file_name' found.
🚫 [eslint] <quote-props> reported by reviewdog 🐶
Unnecessarily quoted property 'warn_delete_asset' found.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 345 to 346 in ae6d683
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 384 to 385 in ae6d683
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
There should be no space before ','.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <semi> reported by reviewdog 🐶
Missing semicolon.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 426 to 427 in ae6d683
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 466 to 467 in ae6d683
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required before '}'.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required after '{'.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required before '}'.
🚫 [eslint] <keyword-spacing> reported by reviewdog 🐶
Expected space(s) after "if".
🚫 [eslint] <quotes> reported by reviewdog 🐶
Strings must use singlequote.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required after '{'.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required before '}'.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required after '{'.
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
A space is required after ','.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required before '}'.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required after '{'.
🚫 [eslint] <comma-spacing> reported by reviewdog 🐶
A space is required after ','.
🚫 [eslint] <object-curly-spacing> reported by reviewdog 🐶
A space is required before '}'.
🚫 [eslint] <curly> reported by reviewdog 🐶
Expected { after 'if' condition.
unity/unitylibs/core/workflow/workflow-acrobat/action-binder.js
Lines 620 to 623 in ae6d683
🚫 [eslint] <eol-last> reported by reviewdog 🐶
Newline required at end of file but not found.
🚫 [eslint] <no-unused-vars> reported by reviewdog 🐶
'area' is assigned a value but never used.
unity/unitylibs/scripts/utils.js
Line 29 in ae6d683
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/scripts/utils.js
Lines 110 to 111 in ae6d683
🚫 [eslint] <no-promise-executor-return> reported by reviewdog 🐶
Return values from promise executor functions cannot be read.
unity/unitylibs/scripts/utils.js
Line 131 in ae6d683
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
unity/unitylibs/scripts/utils.js
8000 Lines 165 to 166 in ae6d683
🚫 [eslint] <semi> reported by reviewdog 🐶
Missing semicolon.
unity/unitylibs/scripts/utils.js
Lines 192 to 193 in ae6d683
🚫 [eslint] <no-unneeded-ternary> reported by reviewdog 🐶
Unnecessary use of conditional expression for default assignment.
unity/unitylibs/scripts/utils.js
Line 193 in ae6d683
🚫 [eslint] <no-else-return> reported by reviewdog 🐶
Unnecessary 'else' after 'return'.
unity/unitylibs/scripts/utils.js
Line 214 in ae6d683
🚫 [eslint] <no-unused-vars> reported by reviewdog 🐶
'e' is defined but never used.
unity/unitylibs/scripts/utils.js
Line 217 in ae6d683
🚫 [eslint] <no-return-await> reported by reviewdog 🐶
Redundant use of await on a return value.
unity/unitylibs/scripts/utils.js
Line 269 in ae6d683
🚫 [eslint] <no-shadow> reported by reviewdog 🐶
'delay' is already declared in the upper scope on line 342 column 17.
unity/unitylibs/scripts/utils.js
Line 313 in ae6d683
🚫 [eslint] <no-await-in-loop> reported by reviewdog 🐶
Unexpected await inside a loop.
unity/unitylibs/scripts/utils.js
Line 316 in ae6d683
🚫 [eslint] <max-len> reported by reviewdog 🐶
This line has a length of 101. Maximum allowed is 100.
unity/unitylibs/scripts/utils.js
Line 317 in ae6d683
🚫 [eslint] <no-await-in-loop> reported by reviewdog 🐶
Unexpected await inside a loop.
unity/unitylibs/scripts/utils.js
Line 318 in ae6d683
🚫 [eslint] <no-promise-executor-return> reported by reviewdog 🐶
Return values from promise executor functions cannot be read.
unity/unitylibs/scripts/utils.js
Line 318 in ae6d683
🚫 [eslint] <no-await-in-loop> reported by reviewdog 🐶
Unexpected await inside a loop.
unity/unitylibs/scripts/utils.js
Line 324 in ae6d683
🚫 [eslint] <no-promise-executor-return> reported by reviewdog 🐶
Return values from promise executor functions cannot be read.
unity/unitylibs/scripts/utils.js
Line 324 in ae6d683
🚫 [eslint] <space-infix-ops> reported by reviewdog 🐶
Operator '=' must be spaced.
unity/unitylibs/scripts/utils.js
Line 350 in ae6d683
🚫 [eslint] <space-infix-ops> reported by reviewdog 🐶
Operator '=' must be spaced.
unity/unitylibs/scripts/utils.js
Line 350 in ae6d683
🚫 [eslint] <space-infix-ops> reported by reviewdog 🐶
Operator '=' must be spaced.
unity/unitylibs/scripts/utils.js
Line 350 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 352 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 353 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 354 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 6 spaces but found 10.
unity/unitylibs/scripts/utils.js
Line 355 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 356 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 358 in ae6d683
🚫 [eslint] <indent> reported by reviewdog 🐶
Expected indentation of 4 spaces but found 6.
unity/unitylibs/scripts/utils.js
Line 360 in ae6d683
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
unity/unitylibs/scripts/utils.js
Line 389 in ae6d683
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
unity/unitylibs/scripts/utils.js
Line 391 in ae6d683
🚫 [eslint] <no-underscore-dangle> reported by reviewdog 🐶
Unexpected dangling '_' in '_adobe_corpnew'.
unity/unitylibs/scripts/utils.js
Line 407 in ae6d683
🚫 [eslint] <no-underscore-dangle> reported by reviewdog 🐶
Unexpected dangling '_' in '_satellite'.
unity/unitylibs/scripts/utils.js
Line 409 in ae6d683
There was a problem hiding this comment.
Could we possibly instead move the flattenObject function out of the utils file and into a separate file? I understand the initial reasoning for keeping it here, however as this method is only called if the access token is null or expired, I don't believe we should incur a performance hit across all workflows by adding to utils which is used across all of our workflows. We can instead dynamically load it as needed. Please let me know your thoughts.
|
@arugupta1992 Please include the ticket number in PR title as well. |
…ically when required
| @@ -715,7 +715,7 @@ export default class ActionBinder { | |||
| const errorDetails = this.tokenError; | |||
| await this.dispatchErrorToast('pre_upload_error_fetching_access_token', null, `Could not fetch access token; Error: ${errorDetails.originalError}`, false, true, { | |||
| code: 'pre_upload_error_fetching_access_token', | |||
| desc: `${errorDetails.message}; Error: ${errorDetails.originalError.message}, Stack : ${errorDetails.originalError.stack}`, | |||
| desc: errorDetails | |||
There was a problem hiding this comment.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
| desc: errorDetails | |
| desc: errorDetails, |
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
🚫 [eslint] <no-multiple-empty-lines> reported by reviewdog 🐶
More than 1 blank line not allowed.
| originalError: retryAttempt.error, | ||
| originalToken: accessToken, | ||
| originalError: flattenObject(retryAttempt.error), | ||
| originalToken: accessToken |
There was a problem hiding this comment.
🚫 [eslint] <
F438
;comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
| originalToken: accessToken | |
| originalToken: accessToken, |
| export function flattenObject(obj, options = {}) { | ||
| const { | ||
| separator = '.', | ||
| prefix = '', | ||
| maxDepth = 10, | ||
| includeArrays = true, | ||
| preserveNull = false, | ||
| excludeTypes = ['function'], | ||
| seenObjects = new WeakSet() | ||
| } = options; | ||
| if (obj === null || obj === undefined) return preserveNull ? { [prefix || 'value']: obj } : {}; | ||
| if (typeof obj !== 'object') return { [prefix || 'value']: obj }; | ||
| if (seenObjects.has(obj)) return { [prefix || 'circular']: '[Circular Reference]' }; | ||
| if (maxDepth <= 0) return { [prefix || 'maxDepth']: '[Max Depth Reached]' }; | ||
| seenObjects.add(obj); | ||
| const flattened = {}; | ||
| try { | ||
| if (Array.isArray(obj)) { | ||
| if (!includeArrays) flattened[prefix || 'array'] = `[Array(${obj.length})]`; | ||
| else { | ||
| obj.forEach((item, index) => { | ||
| const key = prefix ? `${prefix}${separator}${index}` : `${index}`; | ||
| const nested = flattenObject(item, { | ||
| ...options, | ||
| prefix: key, | ||
| maxDepth: maxDepth - 1, | ||
| seenObjects | ||
| }); | ||
| Object.assign(flattened, nested); | ||
| }); | ||
| } | ||
| } | ||
| else { | ||
| Object.keys(obj).forEach(key => { | ||
| const value = obj[key]; | ||
| const newKey = prefix ? `${prefix}${separator}${key}` : key; | ||
| if (excludeTypes.includes(typeof value)) { | ||
| flattened[newKey] = `[${typeof value}]`; | ||
| return; | ||
| } | ||
| if (value === null || value === undefined) { | ||
| if (preserveNull) flattened[newKey] = value; | ||
| return; | ||
| } | ||
| if (typeof value !== 'object') flattened[newKey] = value; | ||
| else { | ||
| const nested = flattenObject(value, { | ||
| ...options, | ||
| prefix: newKey, | ||
| maxDepth: maxDepth - 1, | ||
| seenObjects | ||
| }); | ||
| Object.assign(flattened, nested); | ||
| } | ||
| }); | ||
| } | ||
| } finally { | ||
| seenObjects.delete(obj); | ||
| } | ||
| return flattened; | ||
| } |
There was a problem hiding this comment.
🚫 [eslint] <import/prefer-default-export> reported by reviewdog 🐶
Prefer default export.
| includeArrays = true, | ||
| preserveNull = false, | ||
| excludeTypes = ['function'], | ||
| seenObjects = new WeakSet() |
There was a problem hiding this comment.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
| seenObjects = new WeakSet() | |
| seenObjects = new WeakSet(), |
| Object.assign(flattened, nested); | ||
| }); | ||
| } | ||
| } |
There was a problem hiding this comment.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
| } | |
| } |
| } | ||
| } | ||
| else { | ||
| Object.keys(obj).forEach(key => { |
There was a problem hiding this comment.
🚫 [eslint] <arrow-parens> reported by reviewdog 🐶
Expected parentheses around arrow function argument.
| Object.keys(obj).forEach(key => { | |
| Object.keys(obj).forEach((key) => { |
| ...options, | ||
| prefix: newKey, | ||
| maxDepth: maxDepth - 1, | ||
| seenObjects |
There was a problem hiding this comment.
🚫 [eslint] <comma-dangle> reported by reviewdog 🐶
Missing trailing comma.
| seenObjects | |
| seenObjects, |
| seenObjects.delete(obj); | ||
| } | ||
| return flattened; | ||
| } |
There was a problem hiding this comment.
🚫 [eslint] <no-trailing-spaces> reported by reviewdog 🐶
Trailing spaces not allowed.
| } | |
| } |
| seenObjects.delete(obj); | ||
| } | ||
| return flattened; | ||
| } |
|
|
||
|
|
There was a problem hiding this comment.
nit: remove extra new lines
* stage: [MWPW-174041] : Generic method to parse the error object (including nested error object) and flatten it to be logged in splunk incase of ims token failure (#497) [MWPW-175541] Improve Unit Tests (#496) [MWPW-175937] Unity linting fixes (#495) [NALA]UI Automation tests scripts for batch 2A verbs (#491) [MWPW-174048] Remove close icon from prompt suggestion dropdown (#492) IMS error logging improvement - Phase 1 (#493) [MWPW-173462] Loading screen: Text should not be marked as a heading (#487) Allow empty query (#488) Sending error object in addition to error message in case of IMS token failures (#486) [MWPW-174632] Getting 'unable to process the request' error toast for 'Empty File + Max File Size' upload for 2b/2c (#476) [MWPW-171797] Introduce timeout to all fetch calls being made (#484) # Conflicts: # unitylibs/core/workflow/workflow-acrobat/action-binder.js # unitylibs/core/workflow/workflow-acrobat/upload-handler.js
* stage: [MWPW-173999] [MWPW-174144] Add additional headers (#457) [MWPW-174041] : Generic method to parse the error object (including nested error object) and flatten it to be logged in splunk incase of ims token failure (#497) [MWPW-175541] Improve Unit Tests (#496) [MWPW-175937] Unity linting fixes (#495) [NALA]UI Automation tests scripts for batch 2A verbs (#491) [MWPW-174048] Remove close icon from prompt suggestion dropdown (#492) IMS error logging improvement - Phase 1 (#493) # Conflicts: # unitylibs/core/workflow/workflow-acrobat/action-binder.js
…ested error object) and flatten it to be logged in splunk incase of ims token failure (#497) Resolves: [MWPW-174041](https://jira.corp.adobe.com/browse/MWPW-174041) **Test URLs:** Before: https://stage--dc--adobecom.aem.page/acrobat/online/compress-pdf?unitylibs=stage After: https://stage--dc--adobecom.hlx.live/acrobat/online/rotate-pdf?unitylibs=imsEnahncement-2 URL for testing: https://stage--dc--adobecom.hlx.live/acrobat/online/rotate-pdf?unitylibs=imsEnahncement-2
- #457 - #497 - #496 - #495 - #491 - #492 - #493 **Test URLs:** CC - Before: https://main--cc--adobecom.hlx.live/products/photoshop/online?unitylibs=main - After: https://main--cc--adobecom.hlx.live/products/photoshop/online?unitylibs=stage DC - Before: https://main--dc--adobecom.hlx.live/acrobat/online/compress?unitylibs=main - After: https://main--dc--adobecom.hlx.live/acrobat/online/compress?unitylibs=stage
Resolves: MWPW-174041
Test URLs:
Before: https://stage--dc--adobecom.aem.page/acrobat/online/compress-pdf?unitylibs=stage
After: https://stage--dc--adobecom.hlx.live/acrobat/online/rotate-pdf?unitylibs=imsEnahncement-2
URL for testing:
https://stage--dc--adobecom.hlx.live/acrobat/online/rotate-pdf?unitylibs=imsEnahncement-2