-
Notifications
You must be signed in to change notification settings - Fork 12
/
utils.js
124 lines (104 loc) · 3.7 KB
/
utils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
Copyright 2024 Adobe. All rights reserved.
This file is licensed to you 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 REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/
const cloneDeep = require('lodash.clonedeep')
/**
* Replaces any hidden field values with the string '<hidden>'
*
* @private
* @param {object} sourceObj the object to needs fields hidden
* @param {Array<string>} fieldsToHide the fields that need the value hidden
* @returns {object} the source object but with the specified fields hidden
*/
function withHiddenFields (sourceObj, fieldsToHide) {
if (!sourceObj || !Array.isArray(fieldsToHide)) {
return sourceObj
}
const copyConfig = cloneDeep(sourceObj)
fieldsToHide.forEach(f => {
const keys = f.split('.')
const lastKey = keys.slice(-1)[0]
// keep last key
const traverse = keys
.slice(0, -1)
.reduce((obj, k) => obj && obj[k], copyConfig)
if (traverse && traverse[lastKey]) {
traverse[lastKey] = '<hidden>'
}
})
return copyConfig
}
/**
* Checks whether this library is in the context of being called in Adobe Runtime.
*
* @private
* @returns {boolean} returns true if in Adobe Runtime
*/
function isInternalToAdobeRuntime () {
const { __OW_NAMESPACE, __OW_API_HOST, __OW_ACTIVATION_ID } = process.env
return !!(__OW_NAMESPACE && __OW_API_HOST && __OW_ACTIVATION_ID)
}
/**
* Format the AJV errors into human-readable strings.
*
* @private
* @param {Array<object>} errors the errors to format
* @returns {Array<string>} the human readable error(s)
*/
function formatAjvErrors (errors) {
const stringErrors = []
const handledKeywords = ['required', 'enum', 'type', 'pattern']
// ///////////////////////////////////////////
// 'required' errors
// we collect all required property errors into one error string
const requiredPropertyErrors = errors.filter((error) => {
return (
error.keyword === 'required' &&
error.params?.missingProperty
)
})
if (requiredPropertyErrors.length > 0) {
stringErrors.push(`must have required properties: ${requiredPropertyErrors.map(error => error.params?.missingProperty).join(', ')}`)
}
// ///////////////////////////////////////////
// 'enum' errors
errors
.filter((error) => error.keyword === 'enum' && error.params?.allowedValues)
.forEach((error) =>
stringErrors.push(`${error.instancePath} must be equal to one of the allowed values: ${error.params?.allowedValues.join(', ')}`)
)
// ///////////////////////////////////////////
// 'type' errors
errors
.filter((error) => error.keyword === 'type')
.forEach((error) =>
stringErrors.push(`${error.instancePath} ${error.message}`)
)
// ///////////////////////////////////////////
// 'pattern' errors
errors
.filter((error) => error.keyword === 'pattern')
.forEach((error) =>
stringErrors.push(`${error.instancePath} ${error.message}`)
)
// ///////////////////////////////////////////
// unhandled errors
errors
.filter((error) => !handledKeywords.includes(error.keyword))
.forEach((error) =>
stringErrors.push(`WARNING: keyword '${error.keyword}' was not handled for formatting: ${JSON.stringify(error, null, 2)}`)
)
return stringErrors
}
module.exports = {
withHiddenFields,
isInternalToAdobeRuntime,
formatAjvErrors
}