feat(compartment-mapper): expose extraParsers option #2190
Closed
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
This change: 1. Creates a minimal interface for the `fs`, `url`, and `crypto` objects as passed into `makeReadPowers()`. This makes it easier to duck-type the objects. 2. Fixes the invalid type of `MaybeReadPowers`; properties (defined thru `@property`) are ignored in a `@typedef` of that `@typedef` does not extend `object`/`Object`. 3. Added necessary type assertion in `powers.js` 4. Adds return type to `makeReadPowersSloppy()` # Conflicts: # packages/compartment-mapper/src/types.js
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @boneskull and the rest of your teammates on |
boneskull
force-pushed
the
boneskull/load-compartment-for-archive
branch
from
5fe0f92 to
8f632a2
Compare
boneskull
force-pushed
the
boneskull/expose-extra-parsers
branch
from
39a6889 to
a4d6b59
Compare
|
I think my choice of |
kriskowal
reviewed
Mar 28, 2024
boneskull
force-pushed
the
boneskull/expose-extra-parsers
branch
from
a4d6b59 to
dc733f2
Compare
boneskull
force-pushed
the
boneskull/load-compartment-for-archive
branch
from
8f632a2 to
7dfbd98
Compare
boneskull
force-pushed
the
boneskull/expose-extra-parsers
branch
from
dc733f2 to
cd03184
Compare
This extracts a function, `loadCompartmentForArchive()`, from `digestLocation()` in `archive.js`, and exposes it. This function returns archival-ready data structures, in addition to a record of the compartment renames which `makeArchiveCompartmentMap()` performs. The intent is to leverage the module resolution performed by the function, which is reflected in its output. A consumer can use the information therein to perform additional operations on the tree (e.g., parse ASTs). # Conflicts: # packages/compartment-mapper/src/types.js
The `fallbackLanguageForExtension` option is an optional mapping of file extension to parser name. Consumers can use it to associate a file extension with a specific parser, e.g., `{"node": "bytes"}` or override the default mappings.
The specific use-case is enabling creation of compartment map descriptors for Node.js native modules (e.g., `index.node`) _without_ needing a `parsers: {node: 'bytes'}` property in the `package.json` of the package containing the native module.
boneskull
force-pushed
the
boneskull/expose-extra-parsers
branch
from
cd03184 to
41af691
Compare
boneskull
force-pushed
the
boneskull/load-compartment-for-archive
branch
from
7dfbd98 to
7834bec
Compare
boneskull
force-pushed
the
boneskull/load-compartment-for-archive
branch
from
7834bec to
fa8c103
Compare
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.
Description
The
extraParsersoption is an optional mapping of file extension (without leading.) to parser name. Consumers can use it to associate a file extension with a specific parser, e.g.,{"node": "bytes"}or override the default mappings.The specific use-case is enabling creation of compartment map descriptors for Node.js native modules (e.g.,
index.node) without needing aparsers: {node: 'bytes'}property in thepackage.jsonof the package containing the native module.Because we are unlikely to be the maintainers of any given package exposing a native module, we do not have control over its
package.json; to add the neededparsersfield would require forking or usingpatch-packageor something else. With this change, the consumer can addextraParsers: {node: 'bytes'}to any supported API call.The API calls supporting the new option should be any that end up calling
link()inlink.js; this is where the mapping is concatenated with the default set of parsers.Upgrade Considerations
This is a backwards-compatible change.