fix: centralize build plugin auto-enable escape hatches (#6777)

Author: mrstork

packages/build-info/src/frameworks/angular.test.ts

@@ -1,4 +1,4 @@
-import { beforeEach, expect, test } from 'vitest'
+import { afterEach, beforeEach, expect, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../tests/mock-file-system.js'
 import { NodeFS } from '../node/file-system.js'
@@ -8,6 +8,10 @@ beforeEach((ctx) => {
   ctx.fs = new NodeFS()
 })
 
+afterEach(() => {
+  vi.unstubAllEnvs()
+})
+
 test('should detect Angular', async ({ fs }) => {
   const cwd = mockFileSystem({
     'package.json': JSON.stringify({ dependencies: { '@angular/cli': '17.0.0' } }),
@@ -66,3 +70,27 @@ test('should only install plugin on v17+', async ({ fs }) => {
   expect(detected?.[0].build.directory).toBe('dist/')
   expect(detected?.[0].plugins).toEqual([])
 })
+
+test('should not install plugin when NETLIFY_ANGULAR_PLUGIN_SKIP is set', async ({ fs }) => {
+  const cwd = mockFileSystem({
+    'package.json': JSON.stringify({ dependencies: { '@angular/cli': '17.0.0' } }),
+    'angular.json': JSON.stringify({
+      projects: {
+        demo: {
+          architect: {
+            build: {
+              builder: '@angular-devkit/build-angular:application',
+              options: {
+                outputPath: 'dist/demo',
+              },
+            },
+          },
+        },
+      },
+    }),
+  })
+  vi.stubEnv('NETLIFY_ANGULAR_PLUGIN_SKIP', 'true')
+  const detected = await new Project(fs, cwd).detectFrameworks()
+  expect(detected?.[0].id).toBe('angular')
+  expect(detected?.[0].plugins).toHaveLength(0)
+})

packages/build-info/src/frameworks/angular.ts

@@ -31,7 +31,7 @@ export class Angular extends BaseFramework implements Framework {
     await super.detect()
 
     if (this.detected) {
-      if (this.version && gte(this.version, '17.0.0-rc')) {
+      if (this.version && gte(this.version, '17.0.0-rc') && !process.env.NETLIFY_ANGULAR_PLUGIN_SKIP) {
         this.plugins.push('@netlify/angular-runtime')
         const angularJson = await this.project.fs.gracefullyReadFile('angular.json')
         if (angularJson) {

packages/build-info/src/frameworks/gatsby.test.ts

@@ -1,4 +1,4 @@
-import { beforeEach, expect, test } from 'vitest'
+import { afterEach, beforeEach, expect, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../tests/mock-file-system.js'
 import { NodeFS } from '../node/file-system.js'
@@ -8,6 +8,10 @@ beforeEach((ctx) => {
   ctx.fs = new NodeFS()
 })
 
+afterEach(() => {
+  vi.unstubAllEnvs()
+})
+
 test('should not add the plugin if the node version is below 12.13.0', async ({ fs }) => {
   const cwd = mockFileSystem({
     'package.json': JSON.stringify({ dependencies: { gatsby: '^4.0.0' } }),
@@ -89,3 +93,15 @@ test('should detect a simple Gatsby 5 project', async ({ fs }) => {
     }),
   )
 })
+
+test('should not add the plugin if NETLIFY_SKIP_GATSBY_BUILD_PLUGIN is set', async ({ fs }) => {
+  const cwd = mockFileSystem({
+    'package.json': JSON.stringify({ dependencies: { gatsby: '^4.0.0' } }),
+    'gatsby-config.js': '',
+  })
+  fs.cwd = cwd
+  vi.stubEnv('NETLIFY_SKIP_GATSBY_BUILD_PLUGIN', 'true')
+  const detected = await new Project(fs, cwd).setNodeVersion('12.13.0').detectFrameworks()
+  expect(detected?.[0].id).toBe('gatsby')
+  expect(detected?.[0].plugins).toHaveLength(0)
+})

packages/build-info/src/frameworks/gatsby.ts

@@ -44,7 +44,7 @@ export class Gatsby extends BaseFramework implements Framework {
       }
 
       const nodeVersion = await this.project.getCurrentNodeVersion()
-      if (nodeVersion && gte(nodeVersion, '12.13.0')) {
+      if (nodeVersion && gte(nodeVersion, '12.13.0') && !process.env.NETLIFY_SKIP_GATSBY_BUILD_PLUGIN) {
         this.plugins.push('@netlify/plugin-gatsby')
       }
       return this as DetectedFramework

packages/build-info/src/frameworks/next.test.ts

@@ -1,6 +1,6 @@
 import { join } from 'path'
 
-import { beforeEach, describe, expect, test } from 'vitest'
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
 
 import { createFixture } from '../../tests/helpers.js'
 import { mockFileSystem } from '../../tests/mock-file-system.js'
@@ -34,6 +34,10 @@ describe('Next.js Plugin', () => {
     })
   })
 
+  afterEach(() => {
+    vi.unstubAllEnvs()
+  })
+
   test('Should detect Next.js plugin for Next.js if when Node version >= 10.13.0', async ({ fs, cwd }) => {
     const project = new Project(fs, cwd).setNodeVersion('v10.13.0')
     const frameworks = await project.detectFrameworks()
@@ -47,6 +51,14 @@ describe('Next.js Plugin', () => {
     expect(frameworks?.[0].id).toBe('next')
     expect(frameworks?.[0].plugins).toHaveLength(0)
   })
+
+  test('Should not install plugin when NETLIFY_NEXT_PLUGIN_SKIP is set', async ({ fs, cwd }) => {
+    const project = new Project(fs, cwd).setNodeVersion('v10.13.0')
+    vi.stubEnv('NETLIFY_NEXT_PLUGIN_SKIP', 'true')
+    const frameworks = await project.detectFrameworks()
+    expect(frameworks?.[0].id).toBe('next')
+    expect(frameworks?.[0].plugins).toHaveLength(0)
+  })
 })
 
 describe('simple Next.js project', async () => {

packages/build-info/src/frameworks/next.ts

@@ -32,7 +32,7 @@ export class Next extends BaseFramework implements Framework {
 
     if (this.detected) {
       const nodeVersion = await this.project.getCurrentNodeVersion()
-      if (nodeVersion && gte(nodeVersion, '10.13.0')) {
+      if (nodeVersion && gte(nodeVersion, '10.13.0') && !process.env.NETLIFY_NEXT_PLUGIN_SKIP) {
         this.plugins.push('@netlify/plugin-nextjs')
       }
       return this as DetectedFramework