fix(gatsby): more robust adapter zero-conf handling (#38778)

* 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
gatsbyjs · Jan 9, 2024 · 7f08e7b · 7f08e7b
1 parent 0a80cd6
commit 7f08e7b
Show file tree

Hide file tree

Showing 6 changed files with 918 additions and 131 deletions.
diff --git a/e2e-tests/adapters/gatsby-config.ts b/e2e-tests/adapters/gatsby-config.ts
@@ -15,6 +15,22 @@ if (shouldUseDebugAdapter) {
   configOverrides = {
     adapter: debugAdapter(),
   }
+} else {
+  process.env.GATSBY_ADAPTERS_MANIFEST = /* javascript */ `
+    module.exports = [
+      {
+        name: 'Netlify',
+        module: 'gatsby-adapter-netlify',
+        test: () => !!process.env.NETLIFY || !!process.env.NETLIFY_LOCAL,
+        versions: [
+          {
+            gatsbyVersion: '*',
+            moduleVersion: '*',
+          }
+        ],
+      }
+    ]
+  `
 }
 
 const config: GatsbyConfig = {

diff --git a/packages/gatsby/src/utils/__tests__/get-latest-gatsby-files.ts b/packages/gatsby/src/utils/__tests__/get-latest-gatsby-files.ts
@@ -109,12 +109,42 @@ describe(`default behavior: has network connectivity`, () => {
 
   describe(`getLatestAdapters`, () => {
     beforeEach(() => {
+      delete process.env.GATSBY_ADAPTERS_MANIFEST
+    })
+    it(`loads .js modules (prefers github)`, async () => {
       axios.get.mockResolvedValueOnce({ data: latestAdaptersMarker })
+      const data = await getLatestAdapters()
+
+      expect(axios.get).toHaveBeenCalledWith(
+        expect.stringContaining(`raw.githubusercontent.com`),
+        expect.any(Object)
+      )
+
+      expect(axios.get).not.toHaveBeenCalledWith(
+        expect.stringContaining(`unpkg.com`),
+        expect.any(Object)
+      )
+
+      expect(fs.writeFile).toHaveBeenCalledWith(
+        expect.stringContaining(`latest-adapters.js`),
+        latestAdaptersMarker,
+        expect.any(String)
+      )
+
+      expect(data).toEqual(mockAdaptersManifest)
     })
 
-    it(`loads .js modules`, async () => {
+    it(`loads .js modules (fallbacks to unkpg of github fails)`, async () => {
+      axios.get.mockRejectedValueOnce(new Error(`does not matter`))
+      axios.get.mockResolvedValueOnce({ data: latestAdaptersMarker })
+
       const data = await getLatestAdapters()
 
+      expect(axios.get).toHaveBeenCalledWith(
+        expect.stringContaining(`raw.githubusercontent.com`),
+        expect.any(Object)
+      )
+
       expect(axios.get).toHaveBeenCalledWith(
         expect.stringContaining(`unpkg.com`),
         expect.any(Object)
@@ -128,6 +158,37 @@ describe(`default behavior: has network connectivity`, () => {
 
       expect(data).toEqual(mockAdaptersManifest)
     })
+
+    it(`uses GATSBY_ADAPTERS_MANIFEST env var if set`, async () => {
+      process.env.GATSBY_ADAPTERS_MANIFEST = `custom_manifest`
+
+      axios.get.mockRejectedValueOnce(
+        new Error(`does not matter and should't be called`)
+      )
+      axios.get.mockRejectedValueOnce(
+        new Error(`does not matter and should't be called`)
+      )
+
+      const data = await getLatestAdapters()
+
+      expect(axios.get).not.toHaveBeenCalledWith(
+        expect.stringContaining(`raw.githubusercontent.com`),
+        expect.any(Object)
+      )
+
+      expect(axios.get).not.toHaveBeenCalledWith(
+        expect.stringContaining(`unpkg.com`),
+        expect.any(Object)
+      )
+
+      expect(fs.writeFile).toHaveBeenCalledWith(
+        expect.stringContaining(`latest-adapters.js`),
+        process.env.GATSBY_ADAPTERS_MANIFEST,
+        expect.any(String)
+      )
+
+      expect(data).toEqual(mockAdaptersManifest)
+    })
   })
 })