-
Notifications
You must be signed in to change notification settings - Fork 29.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
lib: make safe primordials Promise methods #38650
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,38 @@ | ||
// Flags: --expose-internals | ||
'use strict'; | ||
|
||
const common = require('../common'); | ||
const assert = require('assert'); | ||
|
||
const { | ||
PromisePrototypeCatch, | ||
PromisePrototypeThen, | ||
SafePromisePrototypeFinally, | ||
} = require('internal/test/binding').primordials; | ||
|
||
Promise.prototype.catch = common.mustNotCall(); | ||
Promise.prototype.finally = common.mustNotCall(); | ||
Promise.prototype.then = common.mustNotCall(); | ||
|
||
assertIsPromise(PromisePrototypeCatch(Promise.reject(), common.mustCall())); | ||
assertIsPromise(PromisePrototypeThen(test(), common.mustCall())); | ||
assertIsPromise(SafePromisePrototypeFinally(test(), common.mustCall())); | ||
|
||
async function test() { | ||
const catchFn = common.mustCall(); | ||
const finallyFn = common.mustCall(); | ||
|
||
try { | ||
await Promise.reject(); | ||
} catch { | ||
catchFn(); | ||
} finally { | ||
finallyFn(); | ||
} | ||
} | ||
|
||
function assertIsPromise(promise) { | ||
// Make sure the returned promise is a genuine %Promise% object and not a | ||
// subclass instance. | ||
assert.strictEqual(Object.getPrototypeOf(promise), Promise.prototype); | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this creates too many promises to be usable in any hot code paths. I would recommend not adding this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't promises antithetical to hot code path since they are asynchronous? For info,
PromisePrototypeFinally
is only used infs/promises
,timers/promises
, andrun_main
currently. Would you prefer if I added a lint rule to discourage its use so it doesn't end up in a hot code path?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this allocates 3 or 4 promises instead of 1.
Using this specific code will only create problems.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd also be more in favor of discouraging the use of the
catch
andfinally
methods in core:then(undefined, fn)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed used of
PromisePrototypeFinally
where it was possible, and rename the function toSafePromisePrototypeFinally
to highlight the fact it is not a simple bridge to the actual primordial method. I plan to add it to the list of "problematic" primordials to avoid in hot code path in #38635.