fix(xsnap): Accommodate spaces in installation path #10082
Merged
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
Deploying agoric-sdk with
|
| Latest commit: |
e1b2a28
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2d452e27.agoric-sdk.pages.dev |
| Branch Preview URL: | https://kriskowal-xsnap-spaces-in-in.agoric-sdk.pages.dev |
dckc
approved these changes
Sep 12, 2024
| @@ -21,7 +22,7 @@ const avaHandler = `./avaHandler.cjs`; | |||
|
|
|||
| /** @type { (ref: string, readFile: typeof import('fs').promises.readFile ) => Promise<string> } */ | |||
| const asset = (ref, readFile) => | |||
| readFile(new URL(ref, import.meta.url).pathname, 'utf8'); | |||
| readFile(fileURLToPath(new URL(ref, import.meta.url)), 'utf8'); | |||
There was a problem hiding this comment.
asset() is about reading stuff out of the package. I wonder about using the node:module API here.
After thinking it over, I suppose it's more of a change than is necessary to fix this.
But I'll leave my thinking-out-loud here for comparison...
Suggested change
| readFile(fileURLToPath(new URL(ref, import.meta.url)), 'utf8'); | |
| readFile(nodeRequire.resolve(ref), 'utf8'); |
presuming:
import { createRequire } from 'node:module';
const nodeRequire = createRequire(import.meta.url);There was a problem hiding this comment.
It occurred to me, and would be useful especially for reaching for assets in other packages.
There was a problem hiding this comment.
I like it!
Not a blocker, of course. I suppose it'll come up again when we fully expunge .pathname
kriskowal
force-pushed
the
kriskowal-xsnap-spaces-in-install-path
branch
from
1768df2 to
e1b2a28
Compare
turadg
approved these changes
Sep 12, 2024
| @@ -21,7 +22,7 @@ const avaHandler = `./avaHandler.cjs`; | |||
|
|
|||
| /** @type { (ref: string, readFile: typeof import('fs').promises.readFile ) => Promise<string> } */ | |||
| const asset = (ref, readFile) => | |||
| readFile(new URL(ref, import.meta.url).pathname, 'utf8'); | |||
| readFile(fileURLToPath(new URL(ref, import.meta.url)), 'utf8'); | |||
There was a problem hiding this comment.
I like it!
Not a blocker, of course. I suppose it'll come up again when we fully expunge .pathname
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
When installed on a Mac via npm in nvm, the path to the xsnap binary inevitably includes a space as in
Application Support. The patternnew URL(location).pathnamedoes not account for URL encoded spaces in the input URL, as will occur based onimport.meta.url. This pivots xsnap to useurl.fileURLToPathinstead which does take these into account as well as Windows drive letters.Security Considerations
None.
Scaling Considerations
None.
Documentation Considerations
None.
Testing Considerations
I created a git worktree named
agoric sdkfor the development of this branch. The xsnap tests failed under that directory name before this change, and worked afterward.Upgrade Considerations
None.