fix(gatsby): more robust adapter zero-conf handling #38778
Conversation
gatsbot
bot
added
the
status: triage needed
pieh
added
topic: adapters
| if (!dataToUse && tryGithubBeforeUnpkg) { | ||
| dataToUse = await _fetchFile(GITHUB_ROOT, fileName) | ||
| } |
There was a problem hiding this comment.
optionally this uses github as source of content, to make it faster to deliver adapter version manifest changes to users - using unpkg require npm publish which currently is not the fastest process
| import { satisfies } from "semver" | ||
| import type { AdapterInit } from "./types" | ||
| import { preferDefault } from "../../bootstrap/prefer-default" | ||
| import { getLatestAdapters } from "../get-latest-gatsby-files" | ||
|
|
||
| const getAdaptersCacheDir = (): string => join(process.cwd(), `.cache/adapters`) | ||
| export const getAdaptersCacheDir = (): string => | ||
| join(process.cwd(), `.cache/adapters`) |
There was a problem hiding this comment.
Small nit (not-blocking), could put the path in a constant
There was a problem hiding this comment.
It probably could, tho I vaguely remember a PR long time ago that moved similar path constructor from constant to function for some usecase where CWD changed after modules were imported.
It also was already a function and only change I did was to export it (to use in tests), so IMO there are is not enough benefits to mess with that (cost of running path.join couple of times vs just once is something you can't even measure as variance will be much greater than perf difference), so I will just keep it as-is
pieh
deleted the
fix/adapters-manifest-fail-build-on-incompatible-adapter
branch
* feat: prefer github for adapters version manifest * fix(gatsby): more robust adapter autoinstallation handling to prevent broken deploys * test: always allow using installed adapter version in e2e-tests/adapter (cherry picked from commit 7f08e7b)
* feat: prefer github for adapters version manifest * fix(gatsby): more robust adapter autoinstallation handling to prevent broken deploys * test: always allow using installed adapter version in e2e-tests/adapter (cherry picked from commit 7f08e7b) Co-authored-by: Michal Piechowiak <[email protected]>
Description
Current adapter handling is subpar and it's easy for build to skip using adapters which can result in broken deploys. For example if manually installed adapter by user is not matching the version expected to be used for current version of gatsby - gatsby would silently skip using any adapter and then redirect/rewrites, API functions, DSG/SSR would just not work.
This changes logic a bit so that:
Which means that situation described above wouldn't happen because we would discard incompatible adapter installed manually by user and instead autoinstall required version ourselves.
There were few other "improvements" made here:
gatsby-dev-clisets dev versions and semver matching, so added ability to provide custom adapter manifest via env var (and skip pulling manifest from github/npm/unpkg) and used that in our adapters e2e to always allow using dev version of adapter (aka code of adapter in tested branch / backport PR) - fix(gatsby): allow gatsby-adapter-netlify@">=1.0.0 <=1.0.3" for gatsby@<5.12.10 (#38758) #38762 is example of failure with some notes on why exactly it happenedDocumentation
Tests
Related Issues
#38752