remove next patching as we don't use that for newer next versions

Author: pieh

src/build/content/next-shims/telemetry-storage.cts

@@ -7,12 +7,7 @@ import { beforeEach, describe, expect, test, vi } from 'vitest'
 import { mockFileSystem } from '../../../tests/index.js'
 import { PluginContext, RequiredServerFilesManifest } from '../plugin-context.js'
 
-import {
-  copyNextServerCode,
-  getPatchesToApply,
-  NextInternalModuleReplacement,
-  verifyHandlerDirStructure,
-} from './server.js'
+import { copyNextServerCode, verifyHandlerDirStructure } from './server.js'
 
 vi.mock('node:fs', async () => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any, unicorn/no-await-expression-member
@@ -272,112 +267,3 @@ describe('verifyHandlerDirStructure', () => {
     )
   })
 })
-
-describe(`getPatchesToApply`, () => {
-  beforeEach(() => {
-    delete process.env.NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES
-  })
-  test('ongoing: false', () => {
-    const shouldPatchBeApplied = {
-      '13.4.1': false, // before supported next version
-      '13.5.1': true, // first stable supported version
-      '14.1.4-canary.1': true, // canary version before stable with maxStableVersion - should be applied
-      '14.1.4': true, // latest stable tested version
-      '14.2.0': false, // untested stable version
-      '14.2.0-canary.37': true, // maxVersion, should be applied
-      '14.2.0-canary.38': false, // not ongoing patch so should not be applied
-    }
-
-    const nextModule = 'test'
-
-    const patches: NextInternalModuleReplacement[] = [
-      {
-        ongoing: false,
-        minVersion: '13.5.0-canary.0',
-        maxVersion: '14.2.0-canary.37',
-        nextModule,
-        shimModule: 'not-used-in-test',
-      },
-    ]
-
-    for (const [nextVersion, telemetryShimShouldBeApplied] of Object.entries(
-      shouldPatchBeApplied,
-    )) {
-      const patchesToApply = getPatchesToApply(nextVersion, patches)
-      const hasTelemetryShim = patchesToApply.some((patch) => patch.nextModule === nextModule)
-      expect({ nextVersion, apply: hasTelemetryShim }).toEqual({
-        nextVersion,
-        apply: telemetryShimShouldBeApplied,
-      })
-    }
-  })
-
-  test('ongoing: true', () => {
-    const shouldPatchBeApplied = {
-      '13.4.1': false, // before supported next version
-      '13.5.1': true, // first stable supported version
-      '14.1.4-canary.1': true, // canary version before stable with maxStableVersion - should be applied
-      '14.1.4': true, // latest stable tested version
-      '14.2.0': false, // untested stable version
-      '14.2.0-canary.38': true, // ongoing patch so should be applied on prerelease versions
-    }
-
-    const nextModule = 'test'
-
-    const patches: NextInternalModuleReplacement[] = [
-      {
-        ongoing: true,
-        minVersion: '13.5.0-canary.0',
-        maxStableVersion: '14.1.4',
-        nextModule,
-        shimModule: 'not-used-in-test',
-      },
-    ]
-
-    for (const [nextVersion, telemetryShimShouldBeApplied] of Object.entries(
-      shouldPatchBeApplied,
-    )) {
-      const patchesToApply = getPatchesToApply(nextVersion, patches)
-      const hasTelemetryShim = patchesToApply.some((patch) => patch.nextModule === nextModule)
-      expect({ nextVersion, apply: hasTelemetryShim }).toEqual({
-        nextVersion,
-        apply: telemetryShimShouldBeApplied,
-      })
-    }
-  })
-
-  test('ongoing: true + NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES', () => {
-    process.env.NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES = 'true'
-    const shouldPatchBeApplied = {
-      '13.4.1': false, // before supported next version
-      '13.5.1': true, // first stable supported version
-      '14.1.4-canary.1': true, // canary version before stable with maxStableVersion - should be applied
-      '14.1.4': true, // latest stable tested version
-      '14.2.0': true, // untested stable version but NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES is used
-      '14.2.0-canary.38': true, // ongoing patch so should be applied on prerelease versions
-    }
-
-    const nextModule = 'test'
-
-    const patches: NextInternalModuleReplacement[] = [
-      {
-        ongoing: true,
-        minVersion: '13.5.0-canary.0',
-        maxStableVersion: '14.1.4',
-        nextModule,
-        shimModule: 'not-used-in-test',
-      },
-    ]
-
-    for (const [nextVersion, telemetryShimShouldBeApplied] of Object.entries(
-      shouldPatchBeApplied,
-    )) {
-      const patchesToApply = getPatchesToApply(nextVersion, patches)
-      const hasTelemetryShim = patchesToApply.some((patch) => patch.nextModule === nextModule)
-      expect({ nextVersion, apply: hasTelemetryShim }).toEqual({
-        nextVersion,
-        apply: telemetryShimShouldBeApplied,
-      })
-    }
-  })
-})

src/build/content/server.test.ts

@@ -186,108 +186,6 @@ async function recreateNodeModuleSymlinks(src: string, dest: string, org?: strin
   )
 }
 
-export type NextInternalModuleReplacement = {
-  /**
-   * Minimum Next.js version that this patch should be applied to
-   */
-  minVersion: string
-  /**
-   * If the reason to patch was not addressed in Next.js we mark this as ongoing
-   * to continue to test latest versions to know wether we should bump `maxStableVersion`
-   */
-  ongoing: boolean
-  /**
-   * Module that should be replaced
-   */
-  nextModule: string
-  /**
-   * Location of replacement module (relative to `<runtime>/dist/build/content`)
-   */
-  shimModule: string
-} & (
-  | {
-      ongoing: true
-      /**
-       * Maximum Next.js version that this patch should be applied to, note that for ongoing patches
-       * we will continue to apply patch for prerelease versions also as canary versions are released
-       * very frequently and trying to target canary versions is not practical. If user is using
-       * canary next versions they should be aware of the risks
-       */
-      maxStableVersion: string
-    }
-  | {
-      ongoing: false
-      /**
-       * Maximum Next.js version that this patch should be applied to. This should be last released
-       * version of Next.js before version making the patch not needed anymore (can be canary version).
-       */
-      maxVersion: string
-    }
-)
-
-const nextInternalModuleReplacements: NextInternalModuleReplacement[] = [
-  {
-    // standalone is loading expensive Telemetry module that is not actually used
-    // so this replace that module with lightweight no-op shim that doesn't load additional modules
-    // see https://github.com/vercel/next.js/pull/63574 that removed need for this shim
-    ongoing: false,
-    minVersion: '13.5.0-canary.0',
-    // perf released in https://github.com/vercel/next.js/releases/tag/v14.2.0-canary.43
-    maxVersion: '14.2.0-canary.42',
-    nextModule: 'next/dist/telemetry/storage.js',
-    shimModule: './next-shims/telemetry-storage.cjs',
-  },
-]
-
-export function getPatchesToApply(
-  nextVersion: string,
-  patches: NextInternalModuleReplacement[] = nextInternalModuleReplacements,
-) {
-  return patches.filter((patch) => {
-    // don't apply patches for next versions below minVersion
-    if (semverLowerThan(nextVersion, patch.minVersion)) {
-      return false
-    }
-
-    if (patch.ongoing) {
-      // apply ongoing patches when used next version is prerelease or NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES env var is used
-      if (prerelease(nextVersion) || process.env.NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES) {
-        return true
-      }
-
-      // apply ongoing patches for stable next versions below or equal maxStableVersion
-      return semverLowerThanOrEqual(nextVersion, patch.maxStableVersion)
-    }
-
-    // apply patches for next versions below or equal maxVersion
-    return semverLowerThanOrEqual(nextVersion, patch.maxVersion)
-  })
-}
-
-async function patchNextModules(
-  ctx: PluginContext,
-  nextVersion: string,
-  serverHandlerRequireResolve: NodeRequire['resolve'],
-): Promise<void> {
-  // apply only those patches that target used Next version
-  const moduleReplacementsToApply = getPatchesToApply(nextVersion)
-
-  if (moduleReplacementsToApply.length !== 0) {
-    await Promise.all(
-      moduleReplacementsToApply.map(async ({ nextModule, shimModule }) => {
-        try {
-          const nextModulePath = serverHandlerRequireResolve(nextModule)
-          const shimModulePath = posixJoin(ctx.pluginDir, 'dist', 'build', 'content', shimModule)
-
-          await cp(shimModulePath, nextModulePath, { force: true })
-        } catch {
-          // this is perf optimization, so failing it shouldn't break the build
-        }
-      }),
-    )
-  }
-}
-
 export const copyNextDependencies = async (ctx: PluginContext): Promise<void> => {
   await tracer.withActiveSpan('copyNextDependencies', async () => {
     const entries = await readdir(ctx.standaloneDir)
@@ -325,10 +223,6 @@ export const copyNextDependencies = async (ctx: PluginContext): Promise<void> =>
 
     const serverHandlerRequire = createRequire(posixJoin(ctx.serverHandlerDir, ':internal:'))
 
-    if (ctx.nextVersion) {
-      await patchNextModules(ctx, ctx.nextVersion, serverHandlerRequire.resolve)
-    }
-
     // detect if it might lead to a runtime issue and throw an error upfront on build time instead of silently failing during runtime
     try {
       const nextEntryAbsolutePath = serverHandlerRequire.resolve('next')

src/build/content/server.ts

@@ -19,7 +19,6 @@ import {
   test,
   vi,
 } from 'vitest'
-import { getPatchesToApply } from '../../src/build/content/server.js'
 import { type FixtureTestContext } from '../utils/contexts.js'
 import {
   createFixture,
@@ -434,78 +433,3 @@ test<FixtureTestContext>('can require CJS module that is not bundled', async (ct
   expect(parsedBody.notBundledCJSModule.isBundled).toEqual(false)
   expect(parsedBody.bundledCJSModule.isBundled).toEqual(true)
 })
-
-describe('next patching', async () => {
-  const { cp: originalCp, appendFile } = (await vi.importActual(
-    'node:fs/promises',
-  )) as typeof import('node:fs/promises')
-
-  const { version: nextVersion } = createRequire(
-    `${getFixtureSourceDirectory('simple')}/:internal:`,
-  )('next/package.json')
-
-  beforeAll(() => {
-    process.env.NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES = 'true'
-  })
-
-  afterAll(() => {
-    delete process.env.NETLIFY_NEXT_FORCE_APPLY_ONGOING_PATCHES
-  })
-
-  beforeEach(() => {
-    mockedCp.mockClear()
-    mockedCp.mockRestore()
-  })
-
-  test<FixtureTestContext>(`expected patches are applied and used (next version: "${nextVersion}")`, async (ctx) => {
-    const patches = getPatchesToApply(nextVersion)
-
-    await createFixture('simple', ctx)
-
-    const fieldNamePrefix = `TEST_${Date.now()}`
-
-    mockedCp.mockImplementation(async (...args) => {
-      const returnValue = await originalCp(...args)
-      if (typeof args[1] === 'string') {
-        for (const patch of patches) {
-          if (args[1].includes(join(patch.nextModule))) {
-            // we append something to assert that patch file was actually used
-            await appendFile(
-              args[1],
-              `;globalThis['${fieldNamePrefix}_${patch.nextModule}'] = 'patched'`,
-            )
-          }
-        }
-      }
-
-      return returnValue
-    })
-
-    await runPlugin(ctx)
-
-    // patched files was not used before function invocation
-    for (const patch of patches) {
-      expect(globalThis[`${fieldNamePrefix}_${patch.nextModule}`]).not.toBeDefined()
-    }
-
-    const home = await invokeFunction(ctx)
-    // make sure the function does work
-    expect(home.statusCode).toBe(200)
-    expect(load(home.body)('h1').text()).toBe('Home')
-
-    let shouldUpdateUpperBoundMessage = ''
-
-    // file was used during function invocation
-    for (const patch of patches) {
-      expect(globalThis[`${fieldNamePrefix}_${patch.nextModule}`]).toBe('patched')
-
-      if (patch.ongoing && !prerelease(nextVersion) && gt(nextVersion, patch.maxStableVersion)) {
-        shouldUpdateUpperBoundMessage += `Ongoing ${shouldUpdateUpperBoundMessage ? '\n' : ''}"${patch.nextModule}" patch still works on "${nextVersion}" which is higher than currently set maxStableVersion ("${patch.maxStableVersion}"). Update maxStableVersion in "src/build/content/server.ts" for this patch to at least "${nextVersion}".`
-      }
-    }
-
-    if (shouldUpdateUpperBoundMessage) {
-      expect.fail(shouldUpdateUpperBoundMessage)
-    }
-  })
-})