fix: remove update-notifier as unhelpful (#4856)

Currently build shows a warning when run in the Netlify CLI and `@netlify/build` is not
up2date. This can happen when the CLI is outdated, but the CLI already uses update-notifier,
so there would be two warnings. This can also happen if the CLI is latest but @netlify/build
has just release a new version and it is not included in the CLI yet. In this case the user
cannot do anything about this, because the CLI has a shrinkwrap and we force the version of
@netlify/build, so updating the lockfile will not help.

Author: danez

package-lock.json

@@ -113,7 +113,6 @@
     "tmp-promise": "^3.0.2",
     "ts-node": "^10.6.0",
     "typescript": "^4.8.4",
-    "update-notifier": "^5.0.0",
     "uuid": "^8.0.0",
     "yargs": "^17.6.0"
   },
@@ -132,7 +131,6 @@
     "get-port": "^6.0.0",
     "get-stream": "^6.0.0",
     "has-ansi": "^5.0.0",
-    "is-ci": "^3.0.0",
     "moize": "^6.0.0",
     "path-key": "^4.0.0",
     "process-exists": "^5.0.0",

packages/build/package.json

@@ -4,7 +4,7 @@ import { logFlags } from '../log/messages/config.js'
 import { removeFalsy } from '../utils/remove_falsy.js'
 
 import { DEFAULT_FEATURE_FLAGS } from './feature_flags.js'
-import { BuildCLIFlags, Mode } from './types.js'
+import type { BuildCLIFlags, Mode, TestOptions } from './types.js'
 
 const REQUIRE_MODE: Mode = 'require'
 const DEFAULT_EDGE_FUNCTIONS_DIST = '.netlify/edge-functions-dist/'
@@ -30,7 +30,7 @@ export type ResolvedFlags = {
   saveConfig: boolean
   /** Netlify API endpoint @default `api.netlify.com` */
   apiHost?: string
-  testOpts: Record<string, unknown>
+  testOpts: TestOptions
   statsd: { port: number }
   timeline: 'build' | string
   cachedConfig: Record<string, unknown>

packages/build/src/core/normalize_flags.ts

@@ -51,12 +51,16 @@ export enum SeverityCode {
   systemError,
 }
 
+export type TestOptions = {
+  errorMonitor?: any
+}
+
 export type ErrorParam = {
   errorMonitor: any
   mode: Mode
   logs: string[]
   debug: any
-  testOpts?: any
+  testOpts?: TestOptions
   childEnv?: any
   netlifyConfig?: NetlifyConfig
 }

packages/build/src/core/types.ts

@@ -4,7 +4,6 @@ import { pathExists } from 'path-exists'
 
 import { ErrorParam } from '../core/types.js'
 import { logBuildError } from '../log/messages/core.js'
-import { logOldCliVersionError } from '../log/old_version.js'
 
 import { removeErrorColors } from './colors.js'
 import { getErrorInfo } from './info.js'
@@ -14,7 +13,7 @@ import { parseErrorInfo } from './parse/parse.js'
 // Logs and reports a build failure
 export const handleBuildError = async function (
   error: Error,
-  { errorMonitor, netlifyConfig, childEnv, mode, logs, debug, testOpts }: ErrorParam,
+  { errorMonitor, netlifyConfig, childEnv, logs, debug, testOpts }: ErrorParam,
 ) {
   const basicErrorInfo = parseErrorInfo(error)
 
@@ -25,9 +24,8 @@ export const handleBuildError = async function (
   removeErrorColors(error)
   // Some errors, such as telemetry ones, should not be logged
   if (basicErrorInfo.showInBuildLog) {
-    logBuildError({ error, netlifyConfig, mode, logs, debug, testOpts })
+    logBuildError({ error, netlifyConfig, logs, debug })
   }
-  logOldCliVersionError({ mode, testOpts })
   await reportBuildError({ error, errorMonitor, childEnv, logs, testOpts })
 
   return basicErrorInfo

packages/build/src/error/handle.ts

@@ -7,7 +7,6 @@ import { roundTimerToMillisecs } from '../../time/measure.js'
 import { ROOT_PACKAGE_JSON } from '../../utils/json.js'
 import { getLogHeaderFunc } from '../header_func.js'
 import { log, logMessage, logWarning, logHeader, logSubHeader, logWarningArray, BufferedLogs } from '../logger.js'
-import { logOldCliVersionError } from '../old_version.js'
 import { THEME } from '../theme.js'
 
 import { logConfigOnError } from './config.js'
@@ -18,15 +17,14 @@ export const logBuildStart = function (logs?: BufferedLogs) {
   logMessage(logs, `${ROOT_PACKAGE_JSON.name} ${ROOT_PACKAGE_JSON.version}`)
 }
 
-export const logBuildError = function ({ error, netlifyConfig, mode, logs, debug, testOpts }) {
+export const logBuildError = function ({ error, netlifyConfig, logs, debug }) {
   const fullErrorInfo = getFullErrorInfo({ error, colors: true, debug })
   const { severity } = fullErrorInfo
   const { title, body } = serializeLogError({ fullErrorInfo })
   const logHeaderFunc = getLogHeaderFunc(error)
   logHeaderFunc(logs, title)
   logMessage(logs, `\n${body}\n`)
   logConfigOnError({ logs, netlifyConfig, severity })
-  logOldCliVersionError({ mode, testOpts })
 }
 
 export const logBuildSuccess = function (logs) {

packages/build/src/log/messages/core.ts

@@ -1,21 +1,20 @@
-import { promises as fs, readFileSync } from 'fs'
+import { readFile } from 'fs/promises'
 import { fileURLToPath } from 'url'
 
-import { PackageJson } from 'read-pkg-up'
+import type { PackageJson } from 'read-pkg-up'
+
+// We know how our package.json looks like, so we can be very specific with the type
+// and only add the properties we want to use
+export type RootPackageJson = { name: string; version: string }
 
 const ROOT_PACKAGE_JSON_PATH = fileURLToPath(new URL('../../package.json', import.meta.url))
 
 // TODO: Replace with dynamic `import()` once it is supported without
 // experimental flags
-export const importJsonFile = async function (filePath: string) {
-  const fileContents = await fs.readFile(filePath, 'utf-8')
-  return JSON.parse(fileContents)
-}
+export const importJsonFile = async function (filePath: string): Promise<PackageJson> {
+  const fileContents = await readFile(filePath, 'utf-8')
 
-const importJsonFileSync = function (filePath: string) {
-  // Use sync I/O so it is easier to migrate to `import()` later on
-  const fileContents = readFileSync(filePath, 'utf-8')
   return JSON.parse(fileContents)
 }
 
-export const ROOT_PACKAGE_JSON: PackageJson = importJsonFileSync(ROOT_PACKAGE_JSON_PATH)
+export const ROOT_PACKAGE_JSON = (await importJsonFile(ROOT_PACKAGE_JSON_PATH)) as RootPackageJson

packages/build/src/log/old_version.js

@@ -2,7 +2,6 @@ import { Fixture, normalizeOutput } from '@netlify/testing'
 import test from 'ava'
 import chalk from 'chalk'
 import hasAnsi from 'has-ansi'
-// import isCI from 'is-ci'
 
 test('Colors in parent process', async (t) => {
   const { output } = await new Fixture('./fixtures/parent')
@@ -33,20 +32,6 @@ test('No TTY', async (t) => {
   t.false(hasAnsi(output))
 })
 
-// In GitHub actions, `update-notifier` is never enabled
-// @todo: uncomment after upgrading to Ava v4.
-// See https://github.com/netlify/build/issues/3615
-// if (!isCI) {
-//   test('Print a warning when using an old version through Netlify CLI', async (t) => {
-//     // We need to unset some environment variables which would otherwise disable `update-notifier`
-//     const { output } = await new Fixture('./fixtures/error')
-//       .withFlags({ mode: 'cli', testOpts: { oldCliLogs: true } })
-//       .withEnv({ NODE_ENV: '' })
-//       .runBuildBinary()
-//     t.snapshot(normalizeOutput(output))
-//   })
-// }
-
 test('Logs whether the build commands came from the UI', async (t) => {
   const output = await new Fixture('./fixtures/empty')
     .withFlags({ defaultConfig: { build: { command: 'node --invalid' } } })