feat: allows disabling function size check

Author: ericapisani

packages/runtime/src/helpers/utils.ts

@@ -196,4 +196,7 @@ export const getCustomImageResponseHeaders = (headers: Header[]): Record<string,
   }
   return null
 }
+
+export const isBundleSizeCheckDisabled = () =>
+  process.env.DISABLE_BUNDLE_ZIP_SIZE_CHECK === '1' || process.env.DISABLE_BUNDLE_ZIP_SIZE_CHECK === 'true'
 /* eslint-enable max-lines */

packages/runtime/src/helpers/verification.ts

@@ -11,6 +11,8 @@ import { satisfies } from 'semver'
 
 import { LAMBDA_MAX_SIZE } from '../constants'
 
+import { isBundleSizeCheckDisabled } from './utils'
+
 // This is when nft support was added
 const REQUIRED_BUILD_VERSION = '>=18.16.0'
 
@@ -105,6 +107,15 @@ export const checkForRootPublish = ({
 }
 
 export const checkZipSize = async (file: string, maxSize: number = LAMBDA_MAX_SIZE): Promise<void> => {
+  // Requires contacting the Netlify Support team to fully enable.
+  // Enabling this without contacting them can result in failed deploys.
+  if (isBundleSizeCheckDisabled()) {
+    console.warn(
+      'Function bundle size check was DISABLED with the DISABLE_BUNDLE_ZIP_SIZE_CHECK environment. Your deployment will break if it exceeds the maximum supported size of function zip files in your account.',
+    )
+    return
+  }
+
   if (!existsSync(file)) {
     console.warn(`Could not check zip size because ${file} does not exist`)
     return

test/helpers/verification.spec.ts

@@ -1,9 +1,12 @@
-import { checkNextSiteHasBuilt } from '../../packages/runtime/src/helpers/verification'
+import Chance from 'chance'
+import { checkNextSiteHasBuilt, checkZipSize } from '../../packages/runtime/src/helpers/verification'
 import { outdent } from 'outdent'
 
 import type { NetlifyPluginUtils } from '@netlify/build'
 type FailBuild = NetlifyPluginUtils['build']['failBuild']
 
+const chance = new Chance()
+
 jest.mock('fs', () => {
   return {
     existsSync: jest.fn(),
@@ -78,3 +81,22 @@ describe('checkNextSiteHasBuilt', () => {
     expect(failBuildMock).toHaveBeenCalledWith(expectedFailureMessage)
   })
 })
+
+describe('checkZipSize', () => {
+  let consoleSpy
+
+  beforeEach(() => {
+    consoleSpy = jest.spyOn(global.console, 'warn')
+  })
+
+  afterEach(() => {
+    jest.restoreAllMocks()
+    delete process.env.DISABLE_BUNDLE_ZIP_SIZE_CHECK
+  })
+
+  it('emits a warning that DISABLE_BUNDLE_ZIP_SIZE_CHECK was enabled', async () => {
+    process.env.DISABLE_BUNDLE_ZIP_SIZE_CHECK = 'false'
+    await checkZipSize(chance.string())
+    expect(consoleSpy).toHaveBeenCalledWith('Function bundle size check was DISABLED with the DISABLE_BUNDLE_ZIP_SIZE_CHECK environment. Your deployment will break if it exceeds the maximum supported size of function zip files in your account.')
+  })
+})