feat: move custom image cdn url generator implementation to adapter #38715
Conversation
gatsbot
bot
added
the
status: triage needed
pieh
added
topic: media
| { | ||
| title: `remote-file (SSR, Page Query)`, | ||
| pagePath: `/routes/ssr/remote-file/`, | ||
| fileCDN: false, | ||
| placeholders: false, | ||
| }, |
There was a problem hiding this comment.
Some context here why fileCDN and placeholders are not checked - simply they don't exactly work.
fileCDN explanation:
Because fileCDN is not supported - it would try to run FILE_CDN job "locally" in lambda - however there is a problem with running actual IMAGE_CDN and FILE_CDN jobs (this happens when there is no handling at request time) - the "worker" responsible for handling those jobs is failing to load - this happens locally as well in gatsby serve, so this is not adapter or Netlify issue - it's a framework issue. However even if we fix worker loading - it still actually wouldn't exactly "just work" on Netlify as there is no straight forward way to add additional static assets to deployment after initial build and deployment finished - this likely could be supported via proxy lambda or something like that, but that would need additional work to properly work.
placeholders explanation:
linkfs we use in
gatsby/packages/gatsby/src/utils/page-ssr-module/lambda.ts
Lines 53 to 72 in e3365ab
doesn't seem to provide implementation for new lfs.WriteStream() which is used to generate placeholders (it does provide implementation for fs.createWriteStream so it should be possible to fix/patch it up, but didn't want to do it in this PR)
| // For array of cropFocus values, append them as comma-separated string | ||
| params.append(`crop`, cropFocus.join(`,`)) | ||
| } else { | ||
| params.append(`crop`, cropFocus) |
There was a problem hiding this comment.
I wonder if we want to add any kind of comment here that we are using a field that is supported but not documented with crop (position is documented but both work with the api).
There was a problem hiding this comment.
is it just alias and we could just use position instead of crop to use documented one?
(I just moved implementation as-is from gatsby-plugin-utils alternative url generator, so I have no context on this part)
There was a problem hiding this comment.
Yes that's a good point. I was trying to mirror using the same parameters, but I suppose we can just change it.
…ature and individual arguments
* alternate image url construction * try using image cdn in e2e site * Update netlify.toml * have separate check for dispatching image and file service * fix tests? * try to use images from deploy (so we can avoid using ones hosted externally) * replicate prod-runtime imagecdn tests in adapters * fix import * adjusting remote-file tests * adjusting remote-file tests 2 * cleanup/test * assert naturalWidth/height in image-cdn tests (both adapters and production-runtime) * remove unused * don't use path prefix for alternate image cdn url * _gatsby/file is prefixed * feat: move custom image cdn url generator implementation to adapter (#38715) * feat: move custom image cdn url generator implementation to adapter * provide public types for custom image cdn url generator function signature and individual arguments * use position/cover * update comment * update docs * chore: types/jsdocs shuffle * apply suggestion from https://github.com/gatsbyjs/gatsby/pull/38685\#discussion_r1414135797 * remove docs from feature branch * feat: provide custom FILE_CDN url generator from adapter (#38735) * feat: provide file cdn from adapters * update test * fix tests * use edge function for non-image File CDN * why edge function was not deployed? * bump netlify-cli * ? * bump node for adapters tests * add execa to dev deps * cleanup * some jsdocs updates * add note that generated urls ideally are relative, but can be absolute as well * feat: allow adding remote file allowed url patterns (#38719) * feat: move custom image cdn url generator implementation to adapter * provide public types for custom image cdn url generator function signature and individual arguments * feat: allow adding image cdn allowed url patterns * Module.createRequireFromPath doesn't exist anymore in Node 18, and because package requires at least that version we remove it * fix contentful source image url * fix wordpress source image url * rename ImageCdnAllowed to RemoteFileAllowed as it's not just for image cdn * compare allowed remote urls in netlify.toml with ones generated by gatsby * url testing in filecdn * jsdocs * print warnings for netlify.toml about missing remote_images patterns * test if any existing pattern in netlify.toml allow needed remote url instead of just string comparison * chore: update adapter README about imageCDN * use correct remote_images for adapters e2e site --------- Co-authored-by: Michal Piechowiak <misiek.piechowiak@gmail.com>
Description
This builds on top of #38685 to add pluggable way of providing custom image cdn url generator implementation by adapters, so platform specific endpoint is not hardcoded in platform agnostic package
Documentation
Tests
Related Issues
FRA-95