errors: fix stacktrace of SystemError

PR-URL: #49956 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: James M Snell <[email protected]>

Author: Uzlopak

benchmark/error/system-error-instantiation.js

@@ -0,0 +1,64 @@
+'use strict';
+
+constcommon=require('../common');
+constassert=require('assert');
+
+constbench=common.createBenchmark(main,{
+n: [1e6],
+code: [
+'built-in',
+'ERR_FS_CP_DIR_TO_NON_DIR',
+],
+stackTraceLimit: [0,10],
+},{
+flags: ['--expose-internals'],
+});
+
+functiongetErrorFactory(code){
+const{
+ERR_FS_CP_DIR_TO_NON_DIR,
+}=require('internal/errors').codes;
+
+switch(code){
+case'built-in':
+return(n)=>newError();
+case'ERR_FS_CP_DIR_TO_NON_DIR':
+return(n)=>newERR_FS_CP_DIR_TO_NON_DIR({
+message: 'cannot overwrite directory',
+path: 'dest',
+syscall: 'cp',
+errno: 21,
+code: 'EISDIR',
+});
+default:
+thrownewError(`${code} not supported`);
+}
+}
+
+functionmain({ n, code, stackTraceLimit }){
+constgetError=getErrorFactory(code);
+
+Error.stackTraceLimit=stackTraceLimit;
+
+// Warm up.
+constlength=1024;
+constarray=[];
+for(leti=0;i<length;++i){
+array.push(getError(i));
+}
+
+bench.start();
+
+for(leti=0;i<n;++i){
+constindex=i%length;
+array[index]=getError(index);
+}
+
+bench.end(n);
+
+// Verify the entries to prevent dead code elimination from making
+// the benchmark invalid.
+for(leti=0;i<length;++i){
+assert.strictEqual(typeofarray[i],'object');
+}
+}

test/parallel/test-errors-systemerror.js

@@ -3,7 +3,8 @@
 
 require('../common');
 constassert=require('assert');
-const{ E, SystemError, codes }=require('internal/errors');
+const{ E, SystemError, codes, kIsNodeError }=require('internal/errors');
+const{ inspect }=require('internal/util/inspect');
 
 assert.throws(
 ()=>{newSystemError();},
@@ -31,7 +32,7 @@ const{ERR_TEST } = codes;
 code: 'ERR_TEST',
 name: 'SystemError',
 message: 'custom message: syscall_test returned ETEST (code message)'+
-' /str => /str2',
+' /str => /str2',
 info: ctx
 }
 );
@@ -51,7 +52,7 @@ const{ERR_TEST } = codes;
 code: 'ERR_TEST',
 name: 'SystemError',
 message: 'custom message: syscall_test returned ETEST (code message)'+
-' /buf => /str2',
+' /buf => /str2',
 info: ctx
 }
 );
@@ -71,7 +72,7 @@ const{ERR_TEST } = codes;
 code: 'ERR_TEST',
 name: 'SystemError',
 message: 'custom message: syscall_test returned ETEST (code message)'+
-' /buf => /buf2',
+' /buf => /buf2',
 info: ctx
 }
 );
@@ -110,6 +111,11 @@ const{ERR_TEST } = codes;
 assert.strictEqual(err.syscall,'test');
 assert.strictEqual(err.path,'path');
 assert.strictEqual(err.dest,'path');
+
+assert.strictEqual(err.info.errno,321);
+assert.strictEqual(err.info.dest.toString(),'path');
+assert.strictEqual(err.info.path.toString(),'path');
+assert.strictEqual(err.info.syscall,'test');
 }
 
 {
@@ -128,8 +134,277 @@ const{ERR_TEST } = codes;
 code: 'ERR_TEST',
 name: 'Foobar',
 message: 'custom message: syscall_test returned ERR_TEST '+
-'(Error occurred)',
+'(Error occurred)',
 info: ctx
 }
 );
 }
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// is set to true
+assert.strictEqual(err[kIsNodeError],true);
+
+// is not writable
+assert.throws(
+()=>{err[kIsNodeError]=false;},
+{
+name: 'TypeError',
+message: /Symbol\(kIsNodeError\)/,
+}
+);
+
+// is not enumerable
+assert.strictEqual(Object.prototype.propertyIsEnumerable.call(err,kIsNodeError),false);
+
+// is configurable
+deleteerr[kIsNodeError];
+assert.strictEqual(kIsNodeErrorinerr,false);
+}
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// is set to true
+assert.strictEqual(err.name,'SystemError');
+
+// is writable
+err.name='CustomError';
+assert.strictEqual(err.name,'CustomError');
+
+// is not enumerable
+assert.strictEqual(Object.prototype.propertyIsEnumerable.call(err,'name'),false);
+
+// is configurable
+deleteerr.name;
+assert.strictEqual(err.name,'Error');
+}
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// Is set with the correct message
+assert.strictEqual(err.message,'custom message: syscall_test returned ERR (something happened)');
+
+// is writable
+err.message='custom message';
+assert.strictEqual(err.message,'custom message');
+
+// is not enumerable
+assert.strictEqual(Object.prototype.propertyIsEnumerable.call(err,'message'),false);
+
+// is configurable
+deleteerr.message;
+assert.strictEqual(err.message,'');
+}
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// Is set to the correct syscall
+assert.strictEqual(err.syscall,'syscall_test');
+
+// is writable
+err.syscall='custom syscall';
+assert.strictEqual(err.syscall,'custom syscall');
+
+// is enumerable
+assert(Object.prototype.propertyIsEnumerable.call(err,'syscall'));
+
+// is configurable
+deleteerr.syscall;
+assert.strictEqual('syscall'inerr,false);
+}
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// Is set to the correct errno
+assert.strictEqual(err.errno,123);
+
+// is writable
+err.errno='custom errno';
+assert.strictEqual(err.errno,'custom errno');
+
+// is enumerable
+assert(Object.prototype.propertyIsEnumerable.call(err,'errno'));
+
+// is configurable
+deleteerr.errno;
+assert.strictEqual('errno'inerr,false);
+}
+
+{
+constctx={
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+};
+consterr=newERR_TEST(ctx);
+
+// Is set to the correct info
+assert.strictEqual(Object.keys(err.info).length,4);
+assert.strictEqual(err.info.errno,123);
+assert.strictEqual(err.info.code,'ERR');
+assert.strictEqual(err.info.message,'something happened');
+assert.strictEqual(err.info.syscall,'syscall_test');
+
+// is not writable
+assert.throws(
+()=>{
+err.info={
+ ...ctx,
+errno: 124
+};
+},
+{
+name: 'TypeError',
+message: /'info'/,
+}
+);
+
+assert.strictEqual(Object.keys(err.info).length,4);
+assert.strictEqual(err.info.errno,123);
+assert.strictEqual(err.info.code,'ERR');
+assert.strictEqual(err.info.message,'something happened');
+assert.strictEqual(err.info.syscall,'syscall_test');
+
+// is enumerable
+assert(Object.prototype.propertyIsEnumerable.call(err,'info'));
+
+// is configurable
+deleteerr.info;
+
+assert.strictEqual('info'inerr,false);
+}
+
+{
+// Make sure the stack trace does not contain SystemError
+try{
+thrownewERR_TEST({
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+});
+}catch(e){
+assert.doesNotMatch(e.stack,/atnewSystemError/);
+assert.match(e.stack.split('\n')[1],/test-errors-systemerror\.js/);
+}
+}
+
+{
+// Make sure the stack trace has the correct number of frames
+constlimit=Error.stackTraceLimit;
+Error.stackTraceLimit=3;
+functiona(){
+b();
+}
+
+functionb(){
+c();
+}
+
+functionc(){
+thrownewERR_TEST({
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+});
+}
+try{
+a();
+}catch(e){
+assert.doesNotMatch(e.stack,/atnewSystemError/);
+assert.match(e.stack.split('\n')[1],/test-errors-systemerror\.js/);
+assert.match(e.stack.split('\n')[1],/atc\(/);
+assert.match(e.stack.split('\n')[2],/test-errors-systemerror\.js/);
+assert.match(e.stack.split('\n')[2],/atb\(/);
+assert.match(e.stack.split('\n')[3],/test-errors-systemerror\.js/);
+assert.match(e.stack.split('\n')[3],/ata\(/);
+assert.strictEqual(e.stack.split('\n').length,4);
+}finally{
+Error.stackTraceLimit=limit;
+}
+}
+
+{
+// Inspect should return the correct string
+consterr=newERR_TEST({
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+custom: 'custom'
+});
+letinspectedErr=inspect(err);
+
+assert.ok(inspectedErr.includes(`info:{
+ code: 'ERR',
+ errno: 123,
+ message: 'something happened',
+ syscall: 'syscall_test',
+ custom: 'custom'
+ },`));
+
+err.syscall='custom_syscall';
+
+inspectedErr=inspect(err);
+
+assert.ok(inspectedErr.includes(`info:{
+ code: 'ERR',
+ errno: 123,
+ message: 'something happened',
+ syscall: 'custom_syscall',
+ custom: 'custom'
+ },`));
+}
+
+{
+// toString should return the correct string
+
+consterr=newERR_TEST({
+code: 'ERR',
+errno: 123,
+message: 'something happened',
+syscall: 'syscall_test',
+});
+
+assert.strictEqual(
+err.toString(),
+'SystemError [ERR_TEST]: custom message: syscall_test returned ERR (something happened)'
+);
+}