-
-
Notifications
You must be signed in to change notification settings - Fork 33.1k
vm: expose hasTopLevelAwait on SourceTextModule #59865
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
Open
legendecas
wants to merge
1
commit into
nodejs:main
Choose a base branch
from
legendecas:vm-async-graph
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−0
Open
Changes from all commits
Commits
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 hidden or 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -920,6 +920,33 @@ to disallow any changes to it. | |||||||||||
Corresponds to the `[[RequestedModules]]` field of [Cyclic Module Record][]s in | ||||||||||||
the ECMAScript specification. | ||||||||||||
|
||||||||||||
### `sourceTextModule.getHasAsyncGraph()` | ||||||||||||
|
||||||||||||
<!-- YAML | ||||||||||||
added: REPLACEME | ||||||||||||
--> | ||||||||||||
|
||||||||||||
* Returns: {boolean} | ||||||||||||
|
||||||||||||
Returns `true` if the module has a dependency graph that contains top-level | ||||||||||||
`await` expressions, otherwise returns `false`. | ||||||||||||
Comment on lines
+931
to
+932
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|
||||||||||||
This requires the module to be instantiated first. If the module is not | ||||||||||||
instantiated yet, an error will be thrown. | ||||||||||||
|
||||||||||||
### `sourceTextModule.hasTopLevelAwait` | ||||||||||||
|
||||||||||||
<!-- YAML | ||||||||||||
added: REPLACEME | ||||||||||||
--> | ||||||||||||
|
||||||||||||
* Type: {boolean} | ||||||||||||
|
||||||||||||
Indicates whether the module contains any top-level `await` expressions. | ||||||||||||
|
||||||||||||
This corresponds to the field `[[HasTLA]]` in [Cyclic Module Record][] in the | ||||||||||||
ECMAScript specification. | ||||||||||||
|
||||||||||||
### `sourceTextModule.instantiate()` | ||||||||||||
|
||||||||||||
<!-- YAML | ||||||||||||
|
This file contains hidden or 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 hidden or 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,67 @@ | ||
'use strict'; | ||
|
||
// Flags: --experimental-vm-modules | ||
|
||
require('../common'); | ||
|
||
const assert = require('assert'); | ||
|
||
const { SourceTextModule } = require('vm'); | ||
const test = require('node:test'); | ||
|
||
test('module is not instantiated yet', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
`); | ||
assert.throws(() => foo.getHasAsyncGraph(), { | ||
code: 'ERR_VM_MODULE_STATUS', | ||
}); | ||
}); | ||
|
||
test('simple module with top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
await 0; | ||
`); | ||
foo.linkRequests([]); | ||
foo.instantiate(); | ||
|
||
assert.strictEqual(foo.getHasAsyncGraph(), true); | ||
}); | ||
|
||
test('simple module with non top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
export async function f() { | ||
await 0; | ||
} | ||
`); | ||
foo.linkRequests([]); | ||
foo.instantiate(); | ||
|
||
assert.strictEqual(foo.getHasAsyncGraph(), false); | ||
}); | ||
|
||
test('module with a dependency containing top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
await 0; | ||
`); | ||
foo.linkRequests([]); | ||
|
||
const bar = new SourceTextModule(` | ||
export { foo } from 'foo'; | ||
`); | ||
bar.linkRequests([foo]); | ||
bar.instantiate(); | ||
|
||
assert.strictEqual(foo.getHasAsyncGraph(), true); | ||
assert.strictEqual(bar.getHasAsyncGraph(), true); | ||
}); |
This file contains hidden or 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,59 @@ | ||
'use strict'; | ||
|
||
// Flags: --experimental-vm-modules | ||
|
||
require('../common'); | ||
|
||
const assert = require('assert'); | ||
|
||
const { SourceTextModule } = require('vm'); | ||
const test = require('node:test'); | ||
|
||
test('simple module', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
`); | ||
assert.strictEqual(foo.hasTopLevelAwait, false); | ||
}); | ||
|
||
test('simple module with top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
await 0; | ||
`); | ||
assert.strictEqual(foo.hasTopLevelAwait, true); | ||
}); | ||
|
||
test('simple module with non top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
export async function f() { | ||
await 0; | ||
} | ||
`); | ||
assert.strictEqual(foo.hasTopLevelAwait, false); | ||
}); | ||
|
||
test('module with a dependency containing top-level await', () => { | ||
const foo = new SourceTextModule(` | ||
export const foo = 4 | ||
export default 5; | ||
|
||
await 0; | ||
`); | ||
foo.linkRequests([]); | ||
|
||
const bar = new SourceTextModule(` | ||
export { foo } from 'foo'; | ||
`); | ||
bar.linkRequests([foo]); | ||
bar.instantiate(); | ||
|
||
assert.strictEqual(foo.hasTopLevelAwait, true); | ||
assert.strictEqual(bar.hasTopLevelAwait, false); | ||
}); |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Does it need to be a method? It seems fine to just make it a getter property, and it would be more consistent with other getter properties (e.g.
error
requires the module to be errored, but it's still a getter property)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.
This requires the module to be instantiated, and throws before instantiation.
I think throwing in a getter is not a good pattern. Making it a method indicates that this could incur traversal on the dependency graph, and may throw if this is not instantiated.