-
Notifications
You must be signed in to change notification settings - Fork 28.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
assert: port common.mustCall() to assert
Fixes: #31392 PR-URL: #31982 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>
- Loading branch information
1 parent
a87dfd2
commit c87ed21
Showing
10 changed files
with
388 additions
and
3 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
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
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
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
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,93 @@ | ||
'use strict'; | ||
|
||
const { | ||
Error, | ||
SafeSet, | ||
} = primordials; | ||
|
||
const { | ||
codes: { | ||
ERR_UNAVAILABLE_DURING_EXIT, | ||
}, | ||
} = require('internal/errors'); | ||
const AssertionError = require('internal/assert/assertion_error'); | ||
const { | ||
validateUint32, | ||
} = require('internal/validators'); | ||
|
||
const noop = () => {}; | ||
|
||
class CallTracker { | ||
|
||
#callChecks = new SafeSet() | ||
|
||
calls(fn, exact = 1) { | ||
if (process._exiting) | ||
throw new ERR_UNAVAILABLE_DURING_EXIT(); | ||
if (typeof fn === 'number') { | ||
exact = fn; | ||
fn = noop; | ||
} else if (fn === undefined) { | ||
fn = noop; | ||
} | ||
|
||
validateUint32(exact, 'exact', true); | ||
|
||
const context = { | ||
exact, | ||
actual: 0, | ||
// eslint-disable-next-line no-restricted-syntax | ||
stackTrace: new Error(), | ||
name: fn.name || 'calls' | ||
}; | ||
const callChecks = this.#callChecks; | ||
callChecks.add(context); | ||
|
||
return function() { | ||
context.actual++; | ||
if (context.actual === context.exact) { | ||
// Once function has reached its call count remove it from | ||
// callChecks set to prevent memory leaks. | ||
callChecks.delete(context); | ||
} | ||
// If function has been called more than expected times, add back into | ||
// callchecks. | ||
if (context.actual === context.exact + 1) { | ||
callChecks.add(context); | ||
} | ||
return fn.apply(this, arguments); | ||
}; | ||
} | ||
|
||
report() { | ||
const errors = []; | ||
for (const context of this.#callChecks) { | ||
// If functions have not been called exact times | ||
if (context.actual !== context.exact) { | ||
const message = `Expected the ${context.name} function to be ` + | ||
`executed ${context.exact} time(s) but was ` + | ||
`executed ${context.actual} time(s).`; | ||
errors.push({ | ||
message, | ||
actual: context.actual, | ||
expected: context.exact, | ||
operator: context.name, | ||
stack: context.stackTrace | ||
}); | ||
} | ||
} | ||
return errors; | ||
} | ||
|
||
verify() { | ||
const errors = this.report(); | ||
if (errors.length > 0) { | ||
throw new AssertionError({ | ||
message: 'Function(s) were not called the expected number of times', | ||
details: errors, | ||
}); | ||
} | ||
} | ||
} | ||
|
||
module.exports = CallTracker; |
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
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
Oops, something went wrong.