Skip to content

Commit c9044b1

Browse files
BourgoisMickaelBourgoisMickael
committed
CLDSRV-623: Avoid duplicate error instanciation
(cherry picked from commit 3c128f8)
1 parent 1cf8c2b commit c9044b1

34 files changed

+142
-142
lines changed

‎lib/api/apiUtils/authorization/permissionChecks.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const { evaluators, actionMaps, RequestContext, requestUtils } = require('arsenal').policies;
2-
const { errors } = require('arsenal');
2+
const { errorInstances } = require('arsenal');
33
const { parseCIDR, isValid } = require('ipaddr.js');
44
const constants = require('../../../../constants');
55
const { config } = require('../../../Config');
@@ -566,12 +566,12 @@ function validatePolicyConditions(policy) {
566566
// AWS returns does not return an error if the condition starts with 'aws:'
567567
// so we reproduce this behaviour
568568
if (!validCondition && !conditionKey.startsWith('aws:')) {
569-
return errors.MalformedPolicy.customizeDescription('Policy has an invalid condition key');
569+
return errorInstances.MalformedPolicy.customizeDescription('Policy has an invalid condition key');
570570
}
571571
if (validCondition && validCondition.conditionValueTypeChecker) {
572572
const conditionValueTypeError = validCondition.conditionValueTypeChecker(conditionValue);
573573
if (conditionValueTypeError) {
574-
return errors.MalformedPolicy.customizeDescription(conditionValueTypeError);
574+
return errorInstances.MalformedPolicy.customizeDescription(conditionValueTypeError);
575575
}
576576
}
577577
}

‎lib/api/apiUtils/bucket/bucketCors.js‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const { parseString } = require('xml2js');
2-
const { errors, s3middleware } = require('arsenal');
2+
const { errors, errorInstances, s3middleware } = require('arsenal');
33

44
const escapeForXml = s3middleware.escapeForXml;
55

@@ -82,7 +82,7 @@ const _validator = {
8282
const parsedValue = parseInt(seconds[0], 10);
8383
const errMsg = `MaxAgeSeconds "${seconds[0]}" is not a valid value.`;
8484
if (Number.isNaN(parsedValue) || parsedValue < 0) {
85-
return errors.MalformedXML.customizeDescription(errMsg);
85+
return errorInstances.MalformedXML.customizeDescription(errMsg);
8686
}
8787
return parsedValue;
8888
},
@@ -92,7 +92,7 @@ const _validator = {
9292
*/
9393
validateNumberRules(length) {
9494
if (length > 100) {
95-
return errors.InvalidRequest
95+
return errorInstances.InvalidRequest
9696
.customizeDescription(customizedErrs.numberRules);
9797
}
9898
return true;
@@ -110,7 +110,7 @@ const _validator = {
110110
allowedMethods.length > 0) {
111111
return true;
112112
}
113-
return errors.MalformedXML
113+
return errorInstances.MalformedXML
114114
.customizeDescription(customizedErrs.originAndMethodExist);
115115
},
116116
/** _validator.validateMethods - check values of AllowedMethod's
@@ -130,7 +130,7 @@ const _validator = {
130130
if (!methods.every(isValidMethod)) {
131131
const errMsg = 'Found unsupported HTTP method in CORS config. ' +
132132
`Unsupported method is "${invalidMethod}"`;
133-
return errors.InvalidRequest.customizeDescription(errMsg);
133+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
134134
}
135135
return true;
136136
},
@@ -148,7 +148,7 @@ const _validator = {
148148
if (!this.validateNumberWildcards(element)) {
149149
const errMsg = `${typeElement} "${element}" can not have ` +
150150
'more than one wildcard.';
151-
return errors.InvalidRequest.customizeDescription(errMsg);
151+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
152152
}
153153
}
154154
return true;
@@ -192,12 +192,12 @@ const _validator = {
192192
if (header.indexOf('*') !== -1) {
193193
const errMsg = `ExposeHeader ${header} contains a wildcard. ` +
194194
'Wildcards are currently not supported for ExposeHeader.';
195-
return errors.InvalidRequest.customizeDescription(errMsg);
195+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
196196
}
197197
if (!/^[A-Za-z0-9-]*$/.test(header)) {
198198
const errMsg = `ExposeHeader ${header} contains invalid ` +
199199
'character.';
200-
return errors.InvalidRequest.customizeDescription(errMsg);
200+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
201201
}
202202
}
203203
return true;
@@ -221,7 +221,7 @@ function _validateCorsXml(rules) {
221221
let result;
222222

223223
if (rules.length > 100) {
224-
return errors.InvalidRequest
224+
return errorInstances.InvalidRequest
225225
.customizeDescription(customizedErrs.numberRules);
226226
}
227227
for (let i = 0; i < rules.length; i++) {
@@ -302,7 +302,7 @@ function parseCorsXml(xml, log, cb) {
302302
!result.CORSConfiguration.CORSRule ||
303303
!Array.isArray(result.CORSConfiguration.CORSRule)) {
304304
const errMsg = 'Invalid cors configuration xml';
305-
return cb(errors.MalformedXML.customizeDescription(errMsg));
305+
return cb(errorInstances.MalformedXML.customizeDescription(errMsg));
306306
}
307307

308308
const validationRes =

‎lib/api/apiUtils/bucket/bucketEncryption.js‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { errors } = require('arsenal');
1+
const { errors, errorInstances } = require('arsenal');
22
const metadata = require('../../../metadata/wrapper');
33
const kms = require('../../../kms/wrapper');
44
const { parseString } = require('xml2js');
@@ -83,7 +83,7 @@ function parseEncryptionXml(xml, log, cb) {
8383
log.trace('error in sse config, can not specify KMSMasterKeyID when using AES256', {
8484
method: 'parseEncryptionXml',
8585
});
86-
return cb(errors.InvalidArgument.customizeDescription(
86+
return cb(errorInstances.InvalidArgument.customizeDescription(
8787
'a KMSMasterKeyID is not applicable if the default sse algorithm is not aws:kms'));
8888
}
8989

@@ -151,13 +151,14 @@ function parseObjectEncryptionHeaders(headers) {
151151

152152
if (sseAlgorithm && sseAlgorithm !== 'AES256' && sseAlgorithm !== 'aws:kms') {
153153
return {
154-
error: errors.InvalidArgument.customizeDescription('The encryption method specified is not supported'),
154+
error: errorInstances.InvalidArgument
155+
.customizeDescription('The encryption method specified is not supported'),
155156
};
156157
}
157158

158159
if (sseAlgorithm !== 'aws:kms' && configuredMasterKeyId) {
159160
return {
160-
error: errors.InvalidArgument.customizeDescription(
161+
error: errorInstances.InvalidArgument.customizeDescription(
161162
'a KMSMasterKeyID is not applicable if the default sse algorithm is not aws:kms'),
162163
};
163164
}

‎lib/api/apiUtils/bucket/bucketWebsite.js‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const { parseString } = require('xml2js');
2-
const { errors, s3middleware } = require('arsenal');
2+
const { errors, errorInstances, s3middleware } = require('arsenal');
33

44
const escapeForXml = s3middleware.escapeForXml;
55
const { WebsiteConfiguration } =
@@ -152,7 +152,7 @@ function _validateWebsiteConfigXml(parsingResult) {
152152
if (!parsingResult.IndexDocument && !parsingResult.RedirectAllRequestsTo) {
153153
errMsg = 'Value for IndexDocument Suffix must be provided if ' +
154154
'RedirectAllRequestsTo is empty';
155-
return errors.InvalidArgument.customizeDescription(errMsg);
155+
return errorInstances.InvalidArgument.customizeDescription(errMsg);
156156
}
157157

158158
if (parsingResult.RedirectAllRequestsTo) {
@@ -162,23 +162,23 @@ function _validateWebsiteConfigXml(parsingResult) {
162162
parsingResult.RoutingRules) {
163163
errMsg = 'RedirectAllRequestsTo cannot be provided in ' +
164164
'conjunction with other Routing Rules.';
165-
return errors.InvalidRequest.customizeDescription(errMsg);
165+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
166166
}
167167
if (!xmlContainsElem(parent, 'HostName')) {
168168
errMsg = 'RedirectAllRequestsTo not well-formed';
169-
return errors.MalformedXML.customizeDescription(errMsg);
169+
return errorInstances.MalformedXML.customizeDescription(errMsg);
170170
}
171171
if (!_isValidString(parent[0].HostName[0])) {
172172
errMsg = 'Valid HostName required in RedirectAllRequestsTo';
173-
return errors.InvalidRequest.customizeDescription(errMsg);
173+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
174174
}
175175
redirectAllObj.hostName = parent[0].HostName[0];
176176
if (xmlContainsElem(parent, 'Protocol', { validateParent: false })) {
177177
if (parent[0].Protocol[0] !== 'http' &&
178178
parent[0].Protocol[0] !== 'https') {
179179
errMsg = 'Invalid protocol, protocol can be http or https. ' +
180180
'If not defined, the protocol will be selected automatically.';
181-
return errors.InvalidRequest.customizeDescription(errMsg);
181+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
182182
}
183183
redirectAllObj.protocol = parent[0].Protocol[0];
184184
}
@@ -189,11 +189,11 @@ function _validateWebsiteConfigXml(parsingResult) {
189189
const parent = parsingResult.IndexDocument;
190190
if (!xmlContainsElem(parent, 'Suffix')) {
191191
errMsg = 'IndexDocument is not well-formed';
192-
return errors.MalformedXML.customizeDescription(errMsg);
192+
return errorInstances.MalformedXML.customizeDescription(errMsg);
193193
} else if (!_isValidString(parent[0].Suffix[0])
194194
|| parent[0].Suffix[0].indexOf('/') !== -1) {
195195
errMsg = 'IndexDocument Suffix is not well-formed';
196-
return errors.InvalidArgument.customizeDescription(errMsg);
196+
return errorInstances.InvalidArgument.customizeDescription(errMsg);
197197
}
198198
websiteConfig.setIndexDocument(parent[0].Suffix[0]);
199199
}
@@ -202,11 +202,11 @@ function _validateWebsiteConfigXml(parsingResult) {
202202
const parent = parsingResult.ErrorDocument;
203203
if (!xmlContainsElem(parent, 'Key')) {
204204
errMsg = 'ErrorDocument is not well-formed';
205-
return errors.MalformedXML.customizeDescription(errMsg);
205+
return errorInstances.MalformedXML.customizeDescription(errMsg);
206206
}
207207
if (!_isValidString(parent[0].Key[0])) {
208208
errMsg = 'ErrorDocument Key is not well-formed';
209-
return errors.InvalidArgument.customizeDescription(errMsg);
209+
return errorInstances.InvalidArgument.customizeDescription(errMsg);
210210
}
211211
websiteConfig.setErrorDocument(parent[0].Key[0]);
212212
}
@@ -215,15 +215,15 @@ function _validateWebsiteConfigXml(parsingResult) {
215215
const parent = parsingResult.RoutingRules;
216216
if (!xmlContainsElem(parent, 'RoutingRule', { isList: true })) {
217217
errMsg = 'RoutingRules is not well-formed';
218-
return errors.MalformedXML.customizeDescription(errMsg);
218+
return errorInstances.MalformedXML.customizeDescription(errMsg);
219219
}
220220
for (let i = 0; i < parent[0].RoutingRule.length; i++) {
221221
const rule = parent[0].RoutingRule[i];
222222
const ruleObj = { redirect: {} };
223223
if (!_isValidElem(rule.Redirect)) {
224224
errMsg = 'RoutingRule requires Redirect, which is ' +
225225
'missing or not well-formed';
226-
return errors.MalformedXML.customizeDescription(errMsg);
226+
return errorInstances.MalformedXML.customizeDescription(errMsg);
227227
}
228228
// Looks like AWS doesn't actually make this check, but AWS
229229
// documentation specifies at least one of the following elements
@@ -237,7 +237,7 @@ function _validateWebsiteConfigXml(parsingResult) {
237237
errMsg = 'Redirect must contain at least one of ' +
238238
'following: Protocol, HostName, ReplaceKeyPrefixWith, ' +
239239
'ReplaceKeyWith, or HttpRedirectCode element';
240-
return errors.MalformedXML.customizeDescription(errMsg);
240+
return errorInstances.MalformedXML.customizeDescription(errMsg);
241241
}
242242
if (rule.Redirect[0].Protocol) {
243243
if (!_isValidElem(rule.Redirect[0].Protocol) ||
@@ -246,24 +246,24 @@ function _validateWebsiteConfigXml(parsingResult) {
246246
errMsg = 'Invalid protocol, protocol can be http or ' +
247247
'https. If not defined, the protocol will be selected ' +
248248
'automatically.';
249-
return errors.InvalidRequest.customizeDescription(errMsg);
249+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
250250
}
251251
ruleObj.redirect.protocol = rule.Redirect[0].Protocol[0];
252252
}
253253
if (rule.Redirect[0].HttpRedirectCode) {
254254
errMsg = 'The provided HTTP redirect code is not valid. ' +
255255
'It should be a string containing a number.';
256256
if (!_isValidElem(rule.Redirect[0].HttpRedirectCode)) {
257-
return errors.MalformedXML.customizeDescription(errMsg);
257+
return errorInstances.MalformedXML.customizeDescription(errMsg);
258258
}
259259
const code = parseInt(rule.Redirect[0].HttpRedirectCode[0], 10);
260260
if (Number.isNaN(code)) {
261-
return errors.MalformedXML.customizeDescription(errMsg);
261+
return errorInstances.MalformedXML.customizeDescription(errMsg);
262262
}
263263
if (!(code > 300 && code < 400)) {
264264
errMsg = `The provided HTTP redirect code (${code}) is ` +
265265
'not valid. Valid codes are 3XX except 300';
266-
return errors.InvalidRequest.customizeDescription(errMsg);
266+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
267267
}
268268
ruleObj.redirect.httpRedirectCode = code;
269269
}
@@ -273,7 +273,7 @@ function _validateWebsiteConfigXml(parsingResult) {
273273
if (elem) {
274274
if (!_isValidElem(elem) || !_isValidString(elem[0])) {
275275
errMsg = `Redirect ${elem} is not well-formed`;
276-
return errors.InvalidArgument
276+
return errorInstances.InvalidArgument
277277
.customizeDescription(errMsg);
278278
}
279279
ruleObj.redirect[`${elemName.charAt(0).toLowerCase()}` +
@@ -286,7 +286,7 @@ function _validateWebsiteConfigXml(parsingResult) {
286286
{ validateParent: false, checkForAll: true })) {
287287
errMsg = 'Redirect must not contain both ReplaceKeyWith ' +
288288
'and ReplaceKeyPrefixWith';
289-
return errors.InvalidRequest.customizeDescription(errMsg);
289+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
290290
}
291291
if (Array.isArray(rule.Condition) && rule.Condition.length === 1) {
292292
ruleObj.condition = {};
@@ -295,14 +295,14 @@ function _validateWebsiteConfigXml(parsingResult) {
295295
errMsg = 'Condition is not well-formed. ' +
296296
'Condition should contain valid KeyPrefixEquals or ' +
297297
'HttpErrorCodeReturnEquals element.';
298-
return errors.InvalidRequest.customizeDescription(errMsg);
298+
return errorInstances.InvalidRequest.customizeDescription(errMsg);
299299
}
300300
if (rule.Condition[0].KeyPrefixEquals) {
301301
const keyPrefixEquals = rule.Condition[0].KeyPrefixEquals;
302302
if (!_isValidElem(keyPrefixEquals) ||
303303
!_isValidString(keyPrefixEquals[0])) {
304304
errMsg = 'Condition KeyPrefixEquals is not well-formed';
305-
return errors.InvalidArgument
305+
return errorInstances.InvalidArgument
306306
.customizeDescription(errMsg);
307307
}
308308
ruleObj.condition.keyPrefixEquals = keyPrefixEquals[0];
@@ -312,17 +312,17 @@ function _validateWebsiteConfigXml(parsingResult) {
312312
'It should be a string containing a number.';
313313
if (!_isValidElem(rule.Condition[0]
314314
.HttpErrorCodeReturnedEquals)) {
315-
return errors.MalformedXML.customizeDescription(errMsg);
315+
return errorInstances.MalformedXML.customizeDescription(errMsg);
316316
}
317317
const code = parseInt(rule.Condition[0]
318318
.HttpErrorCodeReturnedEquals[0], 10);
319319
if (Number.isNaN(code)) {
320-
return errors.MalformedXML.customizeDescription(errMsg);
320+
return errorInstances.MalformedXML.customizeDescription(errMsg);
321321
}
322322
if (!(code > 399 && code < 600)) {
323323
errMsg = `The provided HTTP error code (${code}) is ` +
324324
'not valid. Valid codes are 4XX or 5XX.';
325-
return errors.InvalidRequest
325+
return errorInstances.InvalidRequest
326326
.customizeDescription(errMsg);
327327
}
328328
ruleObj.condition.httpErrorCodeReturnedEquals = code;
@@ -347,7 +347,7 @@ function parseWebsiteConfigXml(xml, log, cb) {
347347

348348
if (!result || !result.WebsiteConfiguration) {
349349
const errMsg = 'Invalid website configuration xml';
350-
return cb(errors.MalformedXML.customizeDescription(errMsg));
350+
return cb(errorInstances.MalformedXML.customizeDescription(errMsg));
351351
}
352352

353353
const validationRes =

‎lib/api/apiUtils/bucket/getNotificationConfiguration.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { errors, models } = require('arsenal');
1+
const { errorInstances, models } = require('arsenal');
22
const { NotificationConfiguration } = models;
33

44
const { config } = require('../../../Config');
@@ -10,7 +10,7 @@ function getNotificationConfiguration(parsedXml) {
1010
return notifConfig;
1111
}
1212
if (!config.bucketNotificationDestinations) {
13-
return { error: errors.InvalidArgument.customizeDescription(
13+
return { error: errorInstances.InvalidArgument.customizeDescription(
1414
'Unable to validate the following destination configurations') };
1515
}
1616
const targets = new Set(config.bucketNotificationDestinations.map(t => t.resource));
@@ -19,7 +19,7 @@ function getNotificationConfiguration(parsedXml) {
1919
// TODO: match the error message to AWS's response along with
2020
// the request destination name in the response
2121
const errDesc = 'Unable to validate the destination configuration';
22-
return { error: errors.InvalidArgument.customizeDescription(errDesc) };
22+
return { error: errorInstances.InvalidArgument.customizeDescription(errDesc) };
2323
}
2424
return notifConfig;
2525
}

‎lib/api/apiUtils/object/createAndStoreObject.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const async = require('async');
2-
const { errors, s3middleware } = require('arsenal');
2+
const { errors, errorInstances, s3middleware } = require('arsenal');
33
const getMetaHeaders = s3middleware.userMetadata.getMetaHeaders;
44

55
const constants = require('../../../../constants');
@@ -190,7 +190,7 @@ function createAndStoreObject(bucketName, bucketMD, objectKey, objMD, authInfo,
190190
log.debug(externalVersioningErrorMessage,
191191
{ method: 'createAndStoreObject', error: errors.NotImplemented });
192192
return process.nextTick(() => {
193-
callback(errors.NotImplemented.customizeDescription(
193+
callback(errorInstances.NotImplemented.customizeDescription(
194194
externalVersioningErrorMessage));
195195
});
196196
}

‎lib/api/apiUtils/object/locationConstraintCheck.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { errors } = require('arsenal');
1+
const { errorInstances } = require('arsenal');
22

33
const { BackendInfo } = require('./BackendInfo');
44
const constants = require('../../../../constants');
@@ -34,7 +34,7 @@ function locationConstraintCheck(request, metaHeaders, bucket, log) {
3434
requestEndpoint, log);
3535
if (!controllingBackend.isValid) {
3636
backendInfoObj = {
37-
err: errors.InvalidArgument.customizeDescription(controllingBackend.
37+
err: errorInstances.InvalidArgument.customizeDescription(controllingBackend.
3838
description),
3939
};
4040
return backendInfoObj;

0 commit comments

Comments
 (0)