-
Notifications
You must be signed in to change notification settings - Fork 30k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fs: aggregate errors in fsPromises to avoid error swallowing
Add AggregateError support to fsPromises, instead of swallowing errors if fs.close throws.
- Loading branch information
Showing
4 changed files
with
225 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
test/parallel/test-fs-promises-file-handle-aggregate-errors.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
'use strict'; | ||
// Flags: --expose-internals | ||
|
||
const common = require('../common'); | ||
const tmpdir = require('../common/tmpdir'); | ||
|
||
// The following tests validate aggregate errors are thrown correctly | ||
// when both an operation and close throw. | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { | ||
readFile, | ||
writeFile, | ||
truncate, | ||
lchmod, | ||
} = fs.promises; | ||
const { | ||
FileHandle, | ||
} = require('internal/fs/promises'); | ||
|
||
const assert = require('assert'); | ||
const originalFd = Object.getOwnPropertyDescriptor(FileHandle.prototype, 'fd'); | ||
|
||
let count = 0; | ||
async function createFile() { | ||
const filePath = path.join(tmpdir.path, `aggregate_errors_${++count}.txt`); | ||
await writeFile(filePath, 'content'); | ||
return filePath; | ||
} | ||
|
||
async function checkAggregateError(op) { | ||
try { | ||
const filePath = await createFile(); | ||
Object.defineProperty(FileHandle.prototype, 'fd', { | ||
get: function() { | ||
// Close is set by using a setter, | ||
// so it needs to be set on the instance. | ||
const originalClose = this.close; | ||
this.close = async () => { | ||
// close the file | ||
await originalClose.call(this); | ||
const closeError = new Error('CLOSE_ERROR'); | ||
closeError.code = 456; | ||
throw closeError; | ||
}; | ||
const opError = new Error('INTERNAL_ERROR'); | ||
opError.code = 123; | ||
throw opError; | ||
} | ||
}); | ||
|
||
await op(filePath).catch(common.mustCall((err) => { | ||
assert.strictEqual(err.constructor.name, 'AggregateError'); | ||
assert.strictEqual(err.code, 123); | ||
assert.strictEqual(err.errors.length, 2); | ||
assert.strictEqual(err.errors[0].message, 'INTERNAL_ERROR'); | ||
assert.strictEqual(err.errors[1].message, 'CLOSE_ERROR'); | ||
})); | ||
} finally { | ||
Object.defineProperty(FileHandle.prototype, 'fd', originalFd); | ||
} | ||
} | ||
(async function() { | ||
tmpdir.refresh(); | ||
await checkAggregateError((filePath) => truncate(filePath)); | ||
await checkAggregateError((filePath) => readFile(filePath)); | ||
await checkAggregateError((filePath) => writeFile(filePath, '123')); | ||
if (common.isOSX) { | ||
await checkAggregateError((filePath) => lchmod(filePath, 0o777)); | ||
} | ||
})().then(common.mustCall()); |
68 changes: 68 additions & 0 deletions
68
test/parallel/test-fs-promises-file-handle-close-errors.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
'use strict'; | ||
// Flags: --expose-internals | ||
|
||
const common = require('../common'); | ||
const tmpdir = require('../common/tmpdir'); | ||
|
||
// The following tests validate aggregate errors are thrown correctly | ||
// when both an operation and close throw. | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { | ||
readFile, | ||
writeFile, | ||
truncate, | ||
lchmod, | ||
} = fs.promises; | ||
const { | ||
FileHandle, | ||
} = require('internal/fs/promises'); | ||
|
||
const assert = require('assert'); | ||
const originalFd = Object.getOwnPropertyDescriptor(FileHandle.prototype, 'fd'); | ||
|
||
let count = 0; | ||
async function createFile() { | ||
const filePath = path.join(tmpdir.path, `close_errors_${++count}.txt`); | ||
await writeFile(filePath, 'content'); | ||
return filePath; | ||
} | ||
|
||
async function checkAggregateError(op) { | ||
try { | ||
const filePath = await createFile(); | ||
Object.defineProperty(FileHandle.prototype, 'fd', { | ||
get: function() { | ||
// Close is set by using a setter, | ||
// so it needs to be set on the instance. | ||
const originalClose = this.close; | ||
this.close = async () => { | ||
// close the file | ||
await originalClose.call(this); | ||
const closeError = new Error('CLOSE_ERROR'); | ||
closeError.code = 456; | ||
throw closeError; | ||
}; | ||
return originalFd.get.call(this); | ||
} | ||
}); | ||
|
||
await op(filePath).catch(common.mustCall((err) => { | ||
assert.strictEqual(err.constructor.name, 'Error'); | ||
assert.strictEqual(err.message, 'CLOSE_ERROR'); | ||
assert.strictEqual(err.code, 456); | ||
})); | ||
} finally { | ||
Object.defineProperty(FileHandle.prototype, 'fd', originalFd); | ||
} | ||
} | ||
(async function() { | ||
tmpdir.refresh(); | ||
await checkAggregateError((filePath) => truncate(filePath)); | ||
await checkAggregateError((filePath) => readFile(filePath)); | ||
await checkAggregateError((filePath) => writeFile(filePath, '123')); | ||
if (common.isOSX) { | ||
await checkAggregateError((filePath) => lchmod(filePath, 0o777)); | ||
} | ||
})().then(common.mustCall()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
'use strict'; | ||
// Flags: --expose-internals | ||
|
||
const common = require('../common'); | ||
const tmpdir = require('../common/tmpdir'); | ||
|
||
// The following tests validate aggregate errors are thrown correctly | ||
// when both an operation and close throw. | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { | ||
readFile, | ||
writeFile, | ||
truncate, | ||
lchmod, | ||
} = fs.promises; | ||
const { | ||
FileHandle, | ||
} = require('internal/fs/promises'); | ||
|
||
const assert = require('assert'); | ||
const originalFd = Object.getOwnPropertyDescriptor(FileHandle.prototype, 'fd'); | ||
|
||
let count = 0; | ||
async function createFile() { | ||
const filePath = path.join(tmpdir.path, `op_errors_${++count}.txt`); | ||
await writeFile(filePath, 'content'); | ||
return filePath; | ||
} | ||
|
||
async function checkAggregateError(op) { | ||
try { | ||
const filePath = await createFile(); | ||
Object.defineProperty(FileHandle.prototype, 'fd', { | ||
get: function() { | ||
// Close is set by using a setter, | ||
// so it needs to be set on the instance. | ||
const originalClose = this.close; | ||
this.close = common.mustCall(function(...args) { | ||
return originalClose.apply(this, args); | ||
}); | ||
const opError = new Error('INTERNAL_ERROR'); | ||
opError.code = 123; | ||
throw opError; | ||
} | ||
}); | ||
|
||
await op(filePath).catch(common.mustCall((err) => { | ||
assert.strictEqual(err.constructor.name, 'Error'); | ||
assert.strictEqual(err.message, 'INTERNAL_ERROR'); | ||
assert.strictEqual(err.code, 123); | ||
})); | ||
} finally { | ||
Object.defineProperty(FileHandle.prototype, 'fd', originalFd); | ||
} | ||
} | ||
(async function() { | ||
tmpdir.refresh(); | ||
await checkAggregateError((filePath) => truncate(filePath)); | ||
await checkAggregateError((filePath) => readFile(filePath)); | ||
await checkAggregateError((filePath) => writeFile(filePath, '123')); | ||
if (common.isOSX) { | ||
await checkAggregateError((filePath) => lchmod(filePath, 0o777)); | ||
} | ||
})().then(common.mustCall()); |