[cli] Replace update-notifier dependency with built in

packages/cli/package.json

@@ -51,8 +51,7 @@
     "@vercel/redwood": "1.0.13",
     "@vercel/remix": "1.0.14",
     "@vercel/ruby": "1.3.20",
-    "@vercel/static-build": "1.0.13",
-    "update-notifier": "5.1.0"
+    "@vercel/static-build": "1.0.13"
   },
   "devDependencies": {
     "@alex_neo/jest-expect-message": "1.0.5",

packages/cli/scripts/build.ts

@@ -1,7 +1,7 @@
 import cpy from 'cpy';
 import execa from 'execa';
 import { join } from 'path';
-import { remove, writeFile } from 'fs-extra';
+import { remove, readJSON, writeFile } from 'fs-extra';
 
 const dirRoot = join(__dirname, '..');
 const distRoot = join(dirRoot, 'dist');
@@ -43,15 +43,15 @@ async function main() {
     stdio: 'inherit',
   });
 
+  const pkg = await readJSON(join(dirRoot, 'package.json'));
+  const dependencies = Object.keys(pkg?.dependencies ?? {});
   // Do the initial `ncc` build
-  console.log();
-  const args = [
-    'ncc',
-    'build',
-    '--external',
-    'update-notifier',
-    'src/index.ts',
-  ];
+  console.log('Dependencies:', dependencies);
+  const externs = [];
+  for (const dep of dependencies) {
+    externs.push('--external', dep);
+  }
+  const args = ['ncc', 'build', 'src/index.ts', ...externs];
   await execa('yarn', args, { stdio: 'inherit', cwd: dirRoot });
 
   // `ncc` has some issues with `@vercel/fun`'s runtime files:
@@ -78,6 +78,10 @@ async function main() {
   // Band-aid to bundle stuff that `ncc` neglects to bundle
   await cpy(join(dirRoot, 'src/util/projects/VERCEL_DIR_README.txt'), distRoot);
   await cpy(join(dirRoot, 'src/util/dev/builder-worker.js'), distRoot);
+  await cpy(
+    join(dirRoot, 'src/util/update-notifier/update-worker.js'),
+    distRoot
+  );
 
   console.log('Finished building Vercel CLI');
 }

packages/cli/src/index.ts

@@ -18,7 +18,7 @@ import sourceMap from '@zeit/source-map-support';
 import { mkdirp } from 'fs-extra';
 import chalk from 'chalk';
 import epipebomb from 'epipebomb';
-import updateNotifier from 'update-notifier';
+import updateNotifier from './util/update-notifier';
 import { URL } from 'url';
 import * as Sentry from '@sentry/node';
 import hp from './util/humanize-path';
@@ -55,13 +55,6 @@ import { VercelConfig } from '@vercel/client';
 
 const isCanary = pkg.version.includes('canary');
 
-// Checks for available update and returns an instance
-const notifier = updateNotifier({
-  pkg,
-  distTag: isCanary ? 'canary' : 'latest',
-  updateCheckInterval: 1000 * 60 * 60 * 24 * 7, // 1 week
-});
-
 const VERCEL_DIR = getGlobalPathConfig();
 const VERCEL_CONFIG_PATH = configFiles.getConfigFilePath();
 const VERCEL_AUTH_CONFIG_PATH = configFiles.getAuthConfigFilePath();
@@ -149,22 +142,28 @@ const main = async () => {
   }
 
   // Print update information, if available
-  if (notifier.update && notifier.update.latest !== pkg.version && isTTY) {
-    const { latest } = notifier.update;
-    console.log(
-      info(
-        `${chalk.black.bgCyan('UPDATE AVAILABLE')} ` +
-          `Run ${cmd(
-            await getUpdateCommand()
-          )} to install ${getTitleName()} CLI ${latest}`
-      )
-    );
+  if (isTTY && !process.env.NO_UPDATE_NOTIFIER) {
+    // Checks for available update and returns an instance
+    const latest = await updateNotifier({
+      distTag: isCanary ? 'canary' : 'latest',
+      pkg,
+    });
+    if (latest) {
+      console.log(
+        info(
+          `${chalk.black.bgCyan('UPDATE AVAILABLE')} ` +
+            `Run ${cmd(
+              await getUpdateCommand()
+            )} to install ${getTitleName()} CLI ${latest}`
+        )
+      );
 
-    console.log(
-      info(
-        `Changelog: https://github.com/vercel/vercel/releases/tag/vercel@${latest}`
-      )
-    );
+      console.log(
+        `${info(
+          `Changelog: https://github.com/vercel/vercel/releases/tag/vercel@${latest}`
+        )}\n`
+      );
+    }
   }
 
   // The second argument to the command can be:

packages/cli/src/util/update-notifier/index.ts

@@ -0,0 +1,103 @@
+import semver from 'semver';
+import XDGAppPaths from 'xdg-app-paths';
+import { dirname, resolve as resolvePath } from 'path';
+// import { fileURLToPath } from 'url';
+import { outputJSON, readJSON } from 'fs-extra';
+import type { PackageJson } from '@vercel/build-utils';
+import { spawn } from 'child_process';
+
+interface UpdateNotifierConfig {
+  version: string;
+  expireAt: number;
+  notified: boolean;
+}
+
+/**
+ * Determines if it needs to check for a newer CLI version and returns the last
+ * detected version. The version could be stale, but still newer than the
+ * current version.
+ */
+export default async function updateNotifier({
+  cacheDir = XDGAppPaths('com.vercel.cli').cache(),
+  distTag = 'latest',
+  pkg,
+  updateCheckInterval = 1000 * 60 * 60 * 24 * 7, // 1 week
+  wait,
+}: {
+  cacheDir?: string;
+  distTag?: string;
+  pkg: PackageJson;
+  updateCheckInterval?: number;
+  wait?: boolean;
+}): Promise<string | undefined> {
+  const cacheFile = resolvePath(
+    cacheDir,
+    'update-notifier',
+    `${pkg.name}-${distTag}.json`
+  );
+
+  const loadCache = async (): Promise<UpdateNotifierConfig | undefined> => {
+    try {
+      return await readJSON(cacheFile);
+    } catch (e: any) {
+      // cache does not exist or malformed
+    }
+  };
+
+  let cache = await loadCache();
+
+  if (!cache || cache.expireAt < Date.now()) {
+    await new Promise<void>(resolve => {
+      // spawn the worker, wait for the worker to report it's ready, then
+      // signal the worker to fetch the latest version
+
+      const script = resolvePath(
+        dirname(__filename),
+        '..',
+        '..',
+        '..',
+        'dist',
+        'update-worker.js'
+      );
+      // const script = resolvePath(dirname(fileURLToPath(import.meta.url)), '..', '..', '..', 'dist', 'update-worker.js');
+
+      const worker = spawn(process.execPath, [script], {
+        stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
+        windowsHide: true,
+      });
+
+      worker.on('close', () => resolve());
+      worker.on('error', () => resolve());
+
+      worker.once('message', () => {
+        worker.send({
+          cacheFile,
+          distTag,
+          name: pkg.name,
+          updateCheckInterval,
+        });
+
+        if (!wait) {
+          worker.unref();
+          resolve();
+        }
+      });
+    });
+
+    if (wait) {
+      // if we waited, might as well reload the cache with the latest version
+      cache = await loadCache();
+    }
+  }
+
+  if (
+    cache &&
+    !cache.notified &&
+    pkg.version &&
+    semver.lt(pkg.version, cache.version)
+  ) {
+    cache.notified = true;
+    await outputJSON(cacheFile, cache);
+    return cache.version;
+  }
+}

packages/cli/src/util/update-notifier/update-worker.js

@@ -0,0 +1,59 @@
+/**
+ * This file is spawned in the background and checks npm for the latest version
+ * of the CLI, then writes the version to the cache file.
+ */
+
+// import fetch from 'node-fetch';
+// import { Agent as HttpsAgent } from 'https';
+// import { outputJSON } from 'fs-extra';
+const fetch = require('node-fetch');
+const { Agent: HttpsAgent } = require('https');
+const { outputJSON } = require('fs-extra');
+
+process.on('unhandledRejection', err => {
+  console.error('Exiting update worker due to error:');
+  console.error(err);
+  process.exit(1);
+});
+
+process.on('message', async msg => {
+  try {
+    await fetchLatest(msg);
+  } finally {
+    process.disconnect();
+  }
+});
+
+/**
+ * Fetch the latest version from npm. We do this in a separate function so that
+ * destructuring our required arguments acts as a validator of sorts.
+ */
+async function fetchLatest({ cacheFile, distTag, name, updateCheckInterval }) {
+  // See: `npm config get maxsockets`
+  const agent = new HttpsAgent({
+    keepAlive: true,
+    maxSockets: 15,
+  });
+  const headers = {
+    accept:
+      'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*',
+  };
+  const url = `https://registry.npmjs.org/${name}`;
+  const res = await fetch(url, { agent, headers });
+  const json = await res.json();
+  const tags = json['dist-tags'];
+  const version = tags[distTag];
+
+  await outputJSON(cacheFile, {
+    expireAt: Date.now() + updateCheckInterval,
+    notified: false,
+    version,
+  });
+}
+
+/**
+ * Signal the parent process we're ready to fetch.
+ */
+if (process.connected && process.send) {
+  process.send({ type: 'ready' });
+}