diff options
author | Joyee Cheung <joyeec9h3@gmail.com> | 2018-03-21 00:46:30 +0800 |
---|---|---|
committer | Joyee Cheung <joyeec9h3@gmail.com> | 2018-04-05 04:46:26 +0800 |
commit | 7d06761f839bbff8c671b0e1a6d541faa5452354 (patch) | |
tree | 0e7b375cd841c9a66f8c08cffe4b03d2f6c60277 /test/parallel/test-errors-systemerror.js | |
parent | 3e0d40d4af6f437ecacb8b54d0d84ed0e5a4899f (diff) | |
download | node-new-7d06761f839bbff8c671b0e1a6d541faa5452354.tar.gz |
errors: improve SystemError messages
This commit improves the SystemError messages by allowing user
to combine a custom message and the libuv error message. Also
since we now prefer use subclasses to construct the errors instead
of using `new errors.SystemError()` directly, this removes
the behavior of assigning a default error code `ERR_SYSTEM_ERROR`
to SystemError and requires the user to directly use the
`ERR_SYSTEM_ERROR` class to construct errors instead.
Also merges `makeNodeError` into the SystemError class definition
since that's the only place the function gets used and it seems
unnecessary to introduce another level of inheritance. SystemError
now directly inherits from Error instead of an intermmediate Error
class that inherits from Error.
Class hierarchy before this patch:
ERR_SOCKET_BUFFER_SIZE -> Error (use message formatted by SystemError)
ERR_SYSTEM_ERROR -> NodeError (temp) -> Error
After:
ERR_SOCKET_BUFFER_SIZE -> SystemError -> Error
ERR_TTY_INIT_FAILED -> SystemError -> Error
ERR_SYSTEM_ERROR -> SystemError -> Error
Error messages before this patch:
```
const dgram = require('dgram');
const socket = dgram.createSocket('udp4');
socket.setRecvBufferSize(8192);
// Error [ERR_SOCKET_BUFFER_SIZE]: Could not get or set buffer
// size: Error [ERR_SYSTEM_ERROR]: bad file descriptor:
// EBADF [uv_recv_buffer_size]
// at bufferSize (dgram.js:191:11)
// at Socket.setRecvBufferSize (dgram.js:689:3)
const tty = require('tty');
new tty.WriteStream(1 << 30);
// Error [ERR_SYSTEM_ERROR]: invalid argument: EINVAL [uv_tty_init]
// at new WriteStream (tty.js:84:11)
```
After:
```
const dgram = require('dgram');
const socket = dgram.createSocket('udp4');
socket.setRecvBufferSize(8192);
// SystemError [ERR_SOCKET_BUFFER_SIZE]: Could not get or set buffer
// size: uv_recv_buffer_size returned EBADF (bad file descriptor)
// at bufferSize (dgram.js:191:11)
// at Socket.setRecvBufferSize (dgram.js:689:3)
const tty = require('tty');
new tty.WriteStream(1 << 30);
// SystemError [ERR_TTY_INIT_FAILED]: TTY initialization failed:
// uv_tty_init returned EINVAL (invalid argument)
// at new WriteStream (tty.js:84:11)
```
PR-URL: https://github.com/nodejs/node/pull/19514
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'test/parallel/test-errors-systemerror.js')
-rw-r--r-- | test/parallel/test-errors-systemerror.js | 160 |
1 files changed, 45 insertions, 115 deletions
diff --git a/test/parallel/test-errors-systemerror.js b/test/parallel/test-errors-systemerror.js index 45ac734175..285c89b5d2 100644 --- a/test/parallel/test-errors-systemerror.js +++ b/test/parallel/test-errors-systemerror.js @@ -4,149 +4,79 @@ const common = require('../common'); const assert = require('assert'); const errors = require('internal/errors'); +const { AssertionError } = require('assert'); -common.expectsError( - () => { throw new errors.SystemError(); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred' - } -); - -common.expectsError( - () => { throw new errors.SystemError({}); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred' - } -); +const { E, SystemError } = errors; common.expectsError( - () => { throw new errors.SystemError(null); }, + () => { throw new errors.SystemError(); }, { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred' + code: 'ERR_ASSERTION', + type: AssertionError, + message: 'An invalid error message key was used: undefined.' } ); -common.expectsError( - () => { throw new errors.SystemError({ code: 'ERR' }); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: ERR' - } -); +E('ERR_TEST', 'custom message', SystemError); +const { ERR_TEST } = errors.codes; { const ctx = { - code: 'ERR', - syscall: 'foo' + code: 'ETEST', + message: 'code message', + syscall: 'syscall_test', + path: '/str', + dest: '/str2' }; - common.expectsError( - () => { throw new errors.SystemError(ctx); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: ERR [foo]' - } - ); -} -{ - const ctx = { - code: 'ERR', - syscall: 'foo', - path: Buffer.from('a') - }; common.expectsError( - () => { throw new errors.SystemError(ctx); }, + () => { throw new ERR_TEST(ctx); }, { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: ERR [foo]: a' + code: 'ERR_TEST', + type: SystemError, + message: 'custom message: syscall_test returned ETEST (code message)' + + ' /str => /str2', + info: ctx } ); } { const ctx = { - code: 'ERR', - syscall: 'foo', - path: Buffer.from('a'), - dest: Buffer.from('b') - }; - common.expectsError( - () => { throw new errors.SystemError(ctx); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: ERR [foo]: a => b' - } - ); -} - -{ - const ctx = { - syscall: 'foo', - path: Buffer.from('a'), - dest: Buffer.from('b') - }; - common.expectsError( - () => { throw new errors.SystemError(ctx); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: [foo]: a => b' - } - ); -} - -{ - const ctx = { - path: Buffer.from('a'), - dest: Buffer.from('b') - }; - common.expectsError( - () => { throw new errors.SystemError(ctx); }, - { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'A system error occurred: a => b' - } - ); -} - -{ - const ctx = { - code: 'ERR', - message: 'something happened', - syscall: 'foo', - path: Buffer.from('a'), - dest: Buffer.from('b') + code: 'ETEST', + message: 'code message', + syscall: 'syscall_test', + path: Buffer.from('/buf'), + dest: '/str2' }; common.expectsError( - () => { throw new errors.SystemError(ctx); }, + () => { throw new ERR_TEST(ctx); }, { - code: 'ERR_SYSTEM_ERROR', - type: errors.SystemError, - message: 'something happened: ERR [foo]: a => b' + code: 'ERR_TEST', + type: SystemError, + message: 'custom message: syscall_test returned ETEST (code message)' + + ' /buf => /str2', + info: ctx } ); } { const ctx = { - code: 'ERR_ASSERTION' + code: 'ETEST', + message: 'code message', + syscall: 'syscall_test', + path: Buffer.from('/buf'), + dest: Buffer.from('/buf2') }; common.expectsError( - () => { throw new errors.SystemError(ctx); }, + () => { throw new ERR_TEST(ctx); }, { - code: 'ERR_ASSERTION', - type: errors.SystemError + code: 'ERR_TEST', + type: SystemError, + message: 'custom message: syscall_test returned ETEST (code message)' + + ' /buf => /buf2', + info: ctx } ); } @@ -156,20 +86,20 @@ common.expectsError( code: 'ERR', errno: 123, message: 'something happened', - syscall: 'foo', + syscall: 'syscall_test', path: Buffer.from('a'), dest: Buffer.from('b') }; - const err = new errors.SystemError(ctx); + const err = new ERR_TEST(ctx); assert.strictEqual(err.info, ctx); - assert.strictEqual(err.code, 'ERR_SYSTEM_ERROR'); + assert.strictEqual(err.code, 'ERR_TEST'); err.code = 'test'; assert.strictEqual(err.code, 'test'); // Test legacy properties. These shouldn't be used anymore // but let us make sure they still work assert.strictEqual(err.errno, 123); - assert.strictEqual(err.syscall, 'foo'); + assert.strictEqual(err.syscall, 'syscall_test'); assert.strictEqual(err.path, 'a'); assert.strictEqual(err.dest, 'b'); |