fix(image): allow usage of image from any directory #5932
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
🦋 Changeset detectedLatest commit: 71e24c4 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: integration
Currently, @astrojs/image allows *importing* images from srcDir
only. Importing images from outside srcDir fails miserably *in dev
mode* and produces incorrect src.
This happens because `path.relative(fileURLToPath(config.srcDir), id)`
resolves to "../something" and when joined with '/@astroimage' cancels
it out (`join('/@astroimage', '../../something')` => `'/something'`).
Rework /@astroimage URL scheme to be similar to "/@fs/" scheme—always
export absolute path to the target file.
rasendubi
force-pushed
the
fix-image-outside-srcdir
branch
from
ddf8929
to
71e24c4
Compare
|
This is great! |
rasendubi
commented
Jan 27, 2023
Comment on lines
66
to
78
| } else { | ||
| const relId = path.relative(fileURLToPath(config.srcDir), id); | ||
|
|
||
| meta.src = join('/@astroimage', relId); | ||
|
|
||
| // Windows compat | ||
| meta.src = slash(meta.src); | ||
| meta.src = '/@astroimage' + url.pathname; | ||
| } | ||
|
|
||
| return `export default ${JSON.stringify(meta)}`; | ||
| }, | ||
| configureServer(server) { | ||
| server.middlewares.use(async (req, res, next) => { | ||
| if (req.url?.startsWith('/@astroimage/')) { | ||
| const [, id] = req.url.split('/@astroimage/'); | ||
| // Reconstructing URL to get rid of query parameters in path | ||
| const url = new URL(req.url.slice('/@astroimage'.length), 'file:'); | ||
|
|
||
| const url = new URL(id, config.srcDir); | ||
| const file = await fs.readFile(url); |
There was a problem hiding this comment.
If you are reviewing a PR, this is the core and the only meaningful change—the rest is just tests
|
What's my next step to get this PR moving? cc @matthewp @natemoo-re @andersk (btw, congrats on 2.0 launch!) |
|
Thanks for the PR @rasendubi! I'm going to pull in @Princesseuh who is doing some cleanup on the image integration. This seems like a reasonable change! |
Princesseuh
approved these changes
Jan 30, 2023
Merged
matthewp
pushed a commit
that referenced
this pull request
Feb 3, 2023
Currently, @astrojs/image allows *importing* images from srcDir
only. Importing images from outside srcDir fails miserably *in dev
mode* and produces incorrect src.
This happens because `path.relative(fileURLToPath(config.srcDir), id)`
resolves to "../something" and when joined with '/@astroimage' cancels
it out (`join('/@astroimage', '../../something')` => `'/something'`).
Rework /@astroimage URL scheme to be similar to "/@fs/" scheme—always
export absolute path to the target file.
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.
Currently, @astrojs/image allows importing images from srcDir only. Importing images from outside srcDir fails miserably in dev mode and produces incorrect src.
This happens because
path.relative(fileURLToPath(config.srcDir), id)resolves to "../something" and when joined with '/@astroimage' cancels it (join('/@astroimage', '../../something')=>'/something').Rework /@astroimage URL scheme to be similar to "/@fs/" scheme—always export absolute path to the target file. This allows images to be places anywhere on the filesystem—even outside project root.
Testing
Added tests for
@astrojs/image.Docs
This lifts the restriction of only placing images in src or public directory. Images can be imported from anywhere—even outside project root.
/cc @withastro/maintainers-docs for feedback!