feat(endo): Search for index.js and implied package exports #424
Conversation
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
michaelfig
reviewed
Aug 22, 2020
packages/endo/DESIGN.md
Outdated
|
|
||
| // ExitName is the name of a built-in module, to be threaded in from the | ||
| // modules passed to the module executor. | ||
| type ExitName string; |
There was a problem hiding this comment.
Suggested change
| type ExitName string; | |
| type ExitName = string; |
| // In Node.js, an absolute specifier always indicates a built-in or | ||
| // third-party dependency. | ||
| // The `moduleMapHook` captures all third-party dependencies. | ||
| if (moduleSpecifier !== "." && !moduleSpecifier.startsWith("./")) { |
There was a problem hiding this comment.
Do you also need to handle
&& moduleSpecifier !== '..' && !moduleSpecifier.startsWith('../')?
There was a problem hiding this comment.
It would be good in general to validate the moduleSpecifier. Any specifier that starts with ../ is invalid because it escapes the package root. I have a utility that throws if a module specifier escapes the package root in general, which I could use as a guard here.
| const types = {}; | ||
|
|
||
| Object.assign(result, { | ||
| label: `${name}${version ? `-v${version}` : ""}`, |
There was a problem hiding this comment.
Would @version be better, to help avoid naming collisions.
Suggested change
| label: `${name}${version ? `-v${version}` : ""}`, | |
| label: `${name}${version ? `@${version}` : ""}`, |
There was a problem hiding this comment.
I was previously using name@version#number for compartment labels in archives, and quickly got in trouble when using URL math with them. I might try again, but they would end up % encoded.
kriskowal
force-pushed
the
kris/endo-probe
branch
3 times, most recently
from
dde4c78
to
f6210c3
Compare
kriskowal
force-pushed
the
kris/endo-mitm
branch
from
5085ce0
to
93283e3
Compare
kriskowal
force-pushed
the
kris/endo-probe
branch
from
f6210c3
to
389d7cd
Compare
kriskowal
force-pushed
the
kris/endo-mitm
branch
from
93283e3
to
de0ea45
Compare
kriskowal
force-pushed
the
kris/endo-probe
branch
from
389d7cd
to
32d4fe6
Compare
kriskowal
force-pushed
the
kris/endo-mitm
branch
from
de0ea45
to
2b7a5f9
Compare
kriskowal
force-pushed
the
kris/endo-probe
branch
from
32d4fe6
to
0222f73
Compare
kriskowal
force-pushed
the
kris/endo-mitm
branch
from
2b7a5f9
to
b945563
Compare
kriskowal
force-pushed
the
kris/endo-probe
branch
from
0222f73
to
78d1f0f
Compare
When asked for a module named "x", Node.js will search for "x.js" then "x/index.js". For packages that do not supply an "exports" property in their "package.json", any module contained by that package is a valid exported module. To achieve parity with these two features, Endo uses different techniques when loading from the file system and loading from an archive. When reading from the file system, Endo will search for a satsifactory candidate in each compartment's asynchronous importHook. Endo also uses the compartment's new moduleMapHook to search for dependency compartments in the "scope" of a module identifier prefix. These allow Endo to operate from an incomplete compartment map for the initial load. The Endo archiver instead creates a more complete compartment map, with every discovered module. This introduces a new kind of module to the compartment map module descriptor type union: modules with known locations and corresponding parsers. The archiver erases the "scopes", "types", and "parsers" on each compartment description since they are no longer necessary. When reading from an archive, Endo uses an importHook that consults the compartment map directly for the locations of all contained modules, and creates a complete moduleMap up front.
kriskowal
force-pushed
the
kris/endo-mitm
branch
from
b945563
to
9153014
Compare
kriskowal
force-pushed
the
kris/endo-probe
branch
from
78d1f0f
to
444b063
Compare
kriskowal
force-pushed
the
kris/endo-mitm
branch
10 times, most recently
from
cb1fcad
to
bf310ac
Compare
|
Looks like I messed up the stack and that this was a duplicate of #434 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When asked for a module named "x", Node.js will search for "x.js" then "x/index.js".
For packages that do not supply an "exports" property in their "package.json", any module contained by that package is a valid exported module.
To achieve parity with these two features, Endo uses different techniques when loading from the file system and loading from an archive.
When reading from the file system, Endo will search for a satsifactory candidate in each compartment's asynchronous importHook. Endo also uses the compartment's new moduleMapHook to search for dependency compartments in the "scope" of a module identifier prefix. These allow Endo to operate from an incomplete compartment map for the initial load.
The Endo archiver instead creates a more complete compartment map, with every discovered module. This introduces a new kind of module to the compartment map module descriptor type union: modules with known locations and corresponding parsers. The archiver erases the "scopes", "types", and "parsers" on each compartment description since they are no longer necessary.
When reading from an archive, Endo uses an importHook that consults the compartment map directly for the locations of all contained modules, and creates a complete moduleMap up front.