feat: skip run if @netlify/plugin-nextjs installed (#1536)

* feat: skip run if @netlify/plugin-nextjs installed

disable in order to avoid conflicts should the old package be installed in the project.

* test: add a couple of tests

* feat: add shortlink

Shortlink will eventually link to related documentation

Author: ericapisani

packages/runtime/src/helpers/utils.ts

@@ -188,6 +188,17 @@ export const isNextAuthInstalled = (): boolean => {
   }
 }
 
+export const isOldPluginInstalled = (): boolean => {
+  try {
+    // eslint-disable-next-line import/no-unassigned-import, import/no-extraneous-dependencies, n/no-extraneous-require
+    require('@netlify/plugin-nextjs')
+    return true
+  } catch {
+    // Ignore the MODULE_NOT_FOUND error
+    return false
+  }
+}
+
 export const getCustomImageResponseHeaders = (headers: Header[]): Record<string, string> | null => {
   const customImageResponseHeaders = headers.find((header) => header.for?.startsWith('/_next/image/'))
 

packages/runtime/src/index.ts

@@ -19,7 +19,7 @@ import { updateConfig, writeEdgeFunctions, loadMiddlewareManifest } from './help
 import { moveStaticPages, movePublicFiles, patchNextFiles } from './helpers/files'
 import { generateFunctions, setupImageFunction, generatePagesResolver } from './helpers/functions'
 import { generateRedirects, generateStaticRedirects } from './helpers/redirects'
-import { shouldSkip, isNextAuthInstalled, getCustomImageResponseHeaders } from './helpers/utils'
+import { shouldSkip, isNextAuthInstalled, isOldPluginInstalled, getCustomImageResponseHeaders } from './helpers/utils'
 import {
   verifyNetlifyBuildVersion,
   checkNextSiteHasBuilt,
@@ -39,6 +39,10 @@ const plugin: NetlifyPlugin = {
       cache,
     },
   }) {
+    if (isOldPluginInstalled()) {
+      return
+    }
+
     const { publish } = netlifyConfig.build
     if (shouldSkip()) {
       await restoreCache({ cache, publish })
@@ -65,7 +69,7 @@ const plugin: NetlifyPlugin = {
       build: { failBuild },
     },
   }) {
-    if (shouldSkip()) {
+    if (isOldPluginInstalled() || shouldSkip()) {
       return
     }
     const { publish } = netlifyConfig.build
@@ -178,6 +182,14 @@ const plugin: NetlifyPlugin = {
   }) {
     await saveCache({ cache, publish })
 
+    if (isOldPluginInstalled()) {
+      status.show({
+        summary:
+          'Please remove @netlify/plugin-nextjs from your site. It is no longer required and will prevent you using new features. Learn more: https://ntl.fyi/3w85e2E',
+      })
+      return
+    }
+
     if (shouldSkip()) {
       status.show({
         title: 'Essential Next.js plugin did not run',

test/index.js

@@ -2,6 +2,7 @@ jest.mock('../packages/runtime/src/helpers/utils', () => {
   return {
     ...jest.requireActual('../packages/runtime/src/helpers/utils'),
     isNextAuthInstalled: jest.fn(),
+    isOldPluginInstalled: jest.fn(),
   }
 })
 
@@ -33,8 +34,6 @@ const {
 } = require('../packages/runtime/src/helpers/config')
 const { dirname } = require('path')
 const { getProblematicUserRewrites } = require('../packages/runtime/src/helpers/verification')
-const { onPostBuild } = require('../packages/runtime/lib')
-const { basePath } = require('../demos/next-i18next/next.config')
 
 const chance = new Chance()
 const FIXTURES_DIR = `${__dirname}/fixtures`
@@ -560,6 +559,43 @@ describe('onBuild()', () => {
 })
 
 describe('onPostBuild', () => {
+  const { isOldPluginInstalled } = require('../packages/runtime/src/helpers/utils')
+
+  test('show warning message to remove old plugin', async () => {
+    isOldPluginInstalled.mockImplementation(() => {
+      return true
+    })
+    const mockStatusFunc = jest.fn()
+
+    await plugin.onPostBuild({
+      ...defaultArgs,
+      utils: { ...utils, status: { show: mockStatusFunc } }
+    })
+
+    expect(mockStatusFunc).toHaveBeenCalledWith({ "summary": "Please remove @netlify/plugin-nextjs from your site. It is no longer required and will prevent you using new features. Learn more: https://ntl.fyi/3w85e2E" })
+
+  })
+
+  test('does not show warning message to remove old plugin', async () => {
+    isOldPluginInstalled.mockImplementation(() => {
+      return false
+    })
+    const mockStatusFunc = jest.fn()
+    await moveNextDist()
+
+    await plugin.onPostBuild({
+      ...defaultArgs,
+      utils: {
+        ...utils,
+        status: { show: mockStatusFunc },
+        functions: { list: jest.fn().mockResolvedValue([]) }
+      }
+    })
+
+    expect(mockStatusFunc).not.toHaveBeenCalledWith({ "summary": "Please remove @netlify/plugin-nextjs from your site. It is no longer required and will prevent you using new features." })
+
+  })
+
   test('saves cache with right paths', async () => {
     await moveNextDist()