Skip to content

Commit 5263fe2

Browse files
committed
fix: @W-5907580@ respect code if it exist
1 parent e94c6c9 commit 5263fe2

File tree

3 files changed

+22
-36
lines changed

3 files changed

+22
-36
lines changed

src/sfdxError.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
*/
77

88
import { NamedError } from '@salesforce/kit';
9-
import { ensure, isString, JsonMap, Optional } from '@salesforce/ts-types';
9+
import { ensure, isString, JsonMap, Optional, getString, hasString, ensureString } from '@salesforce/ts-types';
1010
import { Messages, Tokens } from './messages';
1111

1212
/**
@@ -205,6 +205,10 @@ export class SfdxError extends NamedError {
205205
sfdxError.stack = sfdxError.stack.replace(`${err.name}: ${err.message}`, 'Outer stack:');
206206
sfdxError.stack = `${err.stack}\n${sfdxError.stack}`;
207207
}
208+
// Some errors may have a code, so don't look that information
209+
if (hasString(err, 'code')) {
210+
sfdxError.code = ensureString(getString(err, 'code'));
211+
}
208212
return sfdxError;
209213
}
210214

@@ -231,6 +235,8 @@ export class SfdxError extends NamedError {
231235
// Additional data helpful for consumers of this error. E.g., API call result
232236
public data: any; // tslint:disable-line:no-any
233237

238+
public code?: string;
239+
234240
/**
235241
* Create an SfdxError.
236242
* @param message The error message.

test/unit/sfdxErrorTest.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,18 @@ describe('SfdxError', () => {
103103
.to.contain('Outer stack:\n')
104104
.and.contain(myError.stack);
105105
});
106+
107+
it('should return a wrapped error with a code', () => {
108+
class CodeError extends Error {
109+
public code?: string;
110+
}
111+
const myErrorCode = 'OhMyError';
112+
const myError = new CodeError('test');
113+
myError.code = myErrorCode;
114+
const mySfdxError = SfdxError.wrap(myError);
115+
expect(mySfdxError).to.be.an.instanceOf(SfdxError);
116+
expect(mySfdxError.code).to.equal(myErrorCode);
117+
});
106118
});
107119

108120
describe('toObject', () => {

yarn.lock

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1781,7 +1781,7 @@ debug@^4.0.0, debug@^4.1.0:
17811781
dependencies:
17821782
ms "^2.1.1"
17831783

1784-
debuglog@*, debuglog@^1.0.1:
1784+
debuglog@^1.0.1:
17851785
version "1.0.1"
17861786
resolved "https://registry.npmjs.org/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
17871787
integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -2944,7 +2944,7 @@ import-lazy@^2.1.0:
29442944
resolved "https://registry.npmjs.org/import-lazy/-/import-lazy-2.1.0.tgz#05698e3d45c88e8d7e9d92cb0584e77f096f3e43"
29452945
integrity sha1-BWmOPUXIjo1+nZLLBYTnfwlvPkM=
29462946

2947-
imurmurhash@*, imurmurhash@^0.1.4:
2947+
imurmurhash@^0.1.4:
29482948
version "0.1.4"
29492949
resolved "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
29502950
integrity sha1-khi5srkoojixPcT7a21XbyMUU+o=
@@ -3743,11 +3743,6 @@ lodash-cli@^4:
37433743
semver "5.3.0"
37443744
uglify-js "2.7.5"
37453745

3746-
lodash._baseindexof@*:
3747-
version "3.1.0"
3748-
resolved "https://registry.npmjs.org/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
3749-
integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
3750-
37513746
lodash._baseuniq@~4.6.0:
37523747
version "4.6.0"
37533748
resolved "https://registry.npmjs.org/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -3756,33 +3751,11 @@ lodash._baseuniq@~4.6.0:
37563751
lodash._createset "~4.0.0"
37573752
lodash._root "~3.0.0"
37583753

3759-
lodash._bindcallback@*:
3760-
version "3.0.1"
3761-
resolved "https://registry.npmjs.org/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
3762-
integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
3763-
3764-
lodash._cacheindexof@*:
3765-
version "3.0.2"
3766-
resolved "https://registry.npmjs.org/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
3767-
integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
3768-
3769-
lodash._createcache@*:
3770-
version "3.1.2"
3771-
resolved "https://registry.npmjs.org/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
3772-
integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
3773-
dependencies:
3774-
lodash._getnative "^3.0.0"
3775-
37763754
lodash._createset@~4.0.0:
37773755
version "4.0.3"
37783756
resolved "https://registry.npmjs.org/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
37793757
integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
37803758

3781-
lodash._getnative@*, lodash._getnative@^3.0.0:
3782-
version "3.9.1"
3783-
resolved "https://registry.npmjs.org/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
3784-
integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
3785-
37863759
lodash._reinterpolate@~3.0.0:
37873760
version "3.0.0"
37883761
resolved "https://registry.npmjs.org/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d"
@@ -3833,11 +3806,6 @@ lodash.map@^4.5.1:
38333806
resolved "https://registry.npmjs.org/lodash.map/-/lodash.map-4.6.0.tgz#771ec7839e3473d9c4cde28b19394c3562f4f6d3"
38343807
integrity sha1-dx7Hg540c9nEzeKLGTlMNWL09tM=
38353808

3836-
lodash.restparam@*:
3837-
version "3.6.1"
3838-
resolved "https://registry.npmjs.org/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
3839-
integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=
3840-
38413809
lodash.set@^4.3.2:
38423810
version "4.3.2"
38433811
resolved "https://registry.npmjs.org/lodash.set/-/lodash.set-4.3.2.tgz#d8757b1da807dde24816b0d6a84bea1a76230b23"
@@ -5529,7 +5497,7 @@ readable-stream@~1.1.10:
55295497
isarray "0.0.1"
55305498
string_decoder "~0.10.x"
55315499

5532-
readdir-scoped-modules@*, readdir-scoped-modules@^1.0.0:
5500+
readdir-scoped-modules@^1.0.0:
55335501
version "1.0.2"
55345502
resolved "https://registry.npmjs.org/readdir-scoped-modules/-/readdir-scoped-modules-1.0.2.tgz#9fafa37d286be5d92cbaebdee030dc9b5f406747"
55355503
integrity sha1-n6+jfShr5dksuuve4DDcm19AZ0c=

0 commit comments

Comments
 (0)