netlify-cli 8.0.7 → 8.1.0-rc

package/src/commands/watch/watch.js

@@ -0,0 +1,121 @@
+const cli = require('cli-ux').default
+const pWaitFor = require('p-wait-for')
+const prettyjson = require('prettyjson')
+
+const { chalk, error, generateExamplesHelp, log } = require('../../utils')
+const { init } = require('../init')
+
+// 1 second
+const INIT_WAIT = 1e3
+
+// 1 second
+const BUILD_FINISH_INTERVAL = 1e3
+// 20 minutes
+const BUILD_FINISH_TIMEOUT = 12e5
+
+const waitForBuildFinish = async function (api, siteId) {
+  let firstPass = true
+
+  const waitForBuildToFinish = async function () {
+    const builds = await api.listSiteBuilds({ siteId })
+    // build.error
+    const currentBuilds = builds.filter((build) => !build.done)
+
+    // if build.error
+    // @TODO implement build error messages into this
+
+    if (!currentBuilds || currentBuilds.length === 0) {
+      cli.action.stop()
+      return true
+    }
+    firstPass = false
+    return false
+  }
+
+  await pWaitFor(waitForBuildToFinish, {
+    interval: BUILD_FINISH_INTERVAL,
+    timeout: BUILD_FINISH_TIMEOUT,
+    message: 'Timeout while waiting for deploy to finish',
+  })
+
+  // return only when build done or timeout happens
+  return firstPass
+}
+
+/**
+ * The watch command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const watch = async (options, command) => {
+  await command.authenticate()
+  const client = command.netlify.api
+  let siteId = command.netlify.site.id
+
+  if (!siteId) {
+    // TODO: build init command
+    const siteData = await init({}, command)
+    siteId = siteData.id
+  }
+
+  // wait for 1 sec for everything to kickoff
+  console.time('Deploy time')
+  await cli.wait(INIT_WAIT)
+
+  // Get latest commit and look for that
+  // git rev-parse HEAD
+
+  // if no sha, its a manual "triggered deploy"
+  //
+  // {
+  //     "id": "5b4e23db82d3f1780abd74f3",
+  //     "deploy_id": "5b4e23db82d3f1780abd74f2",
+  //     "sha": "pull/1/head",
+  //     "log": [],
+  //     "done": false,
+  //     "error": null,
+  //     "created_at": "2018-07-17T17:14:03.423Z"
+  // }
+  //
+  cli.action.start('Waiting for active site deploys to complete')
+  try {
+    // Fetch all builds!
+    // const builds = await client.listSiteBuilds({siteId})
+    //
+    // // Filter down to any that are not done
+    // const buildsToWatch = builds.filter((build) => {
+    //   return !build.done
+    // })
+
+    const noActiveBuilds = await waitForBuildFinish(client, siteId)
+
+    const siteData = await client.getSite({ siteId })
+
+    const message = chalk.cyanBright.bold.underline(noActiveBuilds ? 'Last build' : 'Deploy complete')
+    log()
+    log(message)
+    log(
+      prettyjson.render({
+        URL: siteData.ssl_url || siteData.url,
+        Admin: siteData.admin_url,
+      }),
+    )
+    console.timeEnd('Deploy time')
+  } catch (error_) {
+    error(error_)
+  }
+}
+
+/**
+ * Creates the `netlify watch` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createWatchCommand = (program) =>
+  program
+    .command('watch')
+    .description('Watch for site deploy to finish')
+    .addHelpText('after', generateExamplesHelp([`netlify watch`, `git push && netlify watch`]))
+    .action(watch)
+
+module.exports = { createWatchCommand }

package/src/lib/build.js

@@ -1,15 +1,24 @@
+// @ts-check
 const build = require('@netlify/build')
 
+/**
+ * The buildConfig + a missing cachedConfig
+ * @typedef BuildConfig
+ * @type {Parameters<import('@netlify/build/src/core/main')>[0] & {cachedConfig: any}}
+ */
+
 // We have already resolved the configuration using `@netlify/config`
 // This is stored as `netlify.cachedConfig` and can be passed to
 // `@netlify/build --cachedConfig`.
-const getBuildOptions = ({
-  context: {
-    netlify: { cachedConfig },
-  },
-  flags: { debug, dry, json, offline, silent },
-  token,
-}) => ({
+/**
+ *
+ * @param {object} config
+ * @param {*} config.cachedConfig
+ * @param {string} config.token
+ * @param {import('commander').OptionValues} config.options
+ * @returns {BuildConfig}
+ */
+const getBuildOptions = ({ cachedConfig, options: { debug, dry, json, offline, silent }, token }) => ({
   cachedConfig,
   token,
   dry,
@@ -24,6 +33,11 @@ const getBuildOptions = ({
   },
 })
 
+/**
+ * run the build command
+ * @param {BuildConfig} options
+ * @returns
+ */
 const runBuild = async (options) => {
   const { configMutations, netlifyConfig: newConfig, severityCode: exitCode } = await build(options)
   return { exitCode, newConfig, configMutations }

package/src/lib/exec-fetcher.js

@@ -1,12 +1,14 @@
+// @ts-check
 const path = require('path')
 const process = require('process')
 
-const execa = require('execa')
 const { fetchLatest, fetchVersion, newerVersion, updateAvailable } = require('gh-release-fetch')
 const isExe = require('isexe')
 
-const { log } = require('../utils/command-helpers')
-const { NETLIFYDEVWARN } = require('../utils/logo')
+// cannot directly import from ../utils as it would create a circular dependency.
+// the file `src/utils/live-tunnel.js` depends on this file
+const { NETLIFYDEVWARN, log } = require('../utils/command-helpers')
+const execa = require('../utils/execa')
 
 const isWindows = () => process.platform === 'win32'
 

package/src/lib/fs.js

@@ -1,22 +1,22 @@
-const fs = require('fs')
-const { promisify } = require('util')
+// @ts-check
+const {
+  constants,
+  promises: { access, readFile, rm, stat },
+} = require('fs')
+const { version } = require('process')
 
 const del = require('del')
-const makeDir = require('make-dir')
-const pathType = require('path-type')
+const { gte, parse } = require('semver')
 
-const statAsync = promisify(fs.stat)
-const readFileAsync = promisify(fs.readFile)
-const writeFileAsync = promisify(fs.writeFile)
-const rmFileAsync = promisify(fs.unlink)
-const copyFileAsync = promisify(fs.copyFile)
-const accessAsync = promisify(fs.access)
-const mkdtempAsync = promisify(fs.mkdtemp)
-const appendFileAsync = promisify(fs.appendFile)
+const NODE_VERSION = parse(version)
 
-const readFileAsyncCatchError = async (filepath) => {
+/**
+ * reads a file async and catches potential errors
+ * @param {string} filePath
+ */
+const readFileAsyncCatchError = async (filePath) => {
   try {
-    return { content: await readFileAsync(filepath) }
+    return { content: await readFile(filePath, 'utf-8') }
   } catch (error) {
     return { error }
   }
@@ -24,42 +24,60 @@ const readFileAsyncCatchError = async (filepath) => {
 
 const fileExistsAsync = async (filePath) => {
   try {
-    await accessAsync(filePath, fs.F_OK)
+    await access(filePath, constants.F_OK)
     return true
   } catch {
     return false
   }
 }
 
-const isDirectoryAsync = (filePath) => pathType.isDirectory(filePath)
-const isFileAsync = (filePath) => pathType.isFile(filePath)
-
-const mkdirRecursiveSync = (path) => makeDir.sync(path)
-const mkdirRecursiveAsync = (path) => makeDir(path)
+/**
+ * Removes a directory recursively and async
+ * @param {string} path
+ * @returns {Promise<void>}
+ */
+const rmdirRecursiveAsync = async (path) => {
+  if (gte(NODE_VERSION, '14.14.0')) {
+    return await rm(path, { force: true, recursive: true })
+  }
+  await del(path, { force: true })
+}
 
-const rmdirRecursiveAsync = (path) => del(path, { force: true })
-const safelyRmdirRecursiveAsync = async (path) => {
+/**
+ * calls stat async with a function and catches potential errors
+ * @param {string} filePath
+ * @param {keyof import('fs').StatsBase<number>} type For example `isDirectory` or `isFile`
+ */
+const isType = async (filePath, type) => {
   try {
-    await rmdirRecursiveAsync(path)
-  } catch (error) {
-    // no-op
+    const stats = await stat(filePath)
+    // @ts-ignore
+    return typeof stats[type] === 'function' ? stats[type]() : stats[type]
+  } catch (error_) {
+    if (error_.code === 'ENOENT') {
+      return false
+    }
+
+    throw error_
   }
 }
 
+/**
+ * Checks if the provided filePath is a file
+ * @param {string} filePath
+ */
+const isFileAsync = (filePath) => isType(filePath, 'isFile')
+
+/**
+ * Checks if the provided filePath is a directory
+ * @param {string} filePath
+ */
+const isDirectoryAsync = (filePath) => isType(filePath, 'isDirectory')
+
 module.exports = {
-  statAsync,
-  readFileAsync,
-  readFileAsyncCatchError,
-  writeFileAsync,
-  rmFileAsync,
-  copyFileAsync,
   fileExistsAsync,
   isDirectoryAsync,
   isFileAsync,
-  mkdirRecursiveSync,
-  mkdirRecursiveAsync,
+  readFileAsyncCatchError,
   rmdirRecursiveAsync,
-  safelyRmdirRecursiveAsync,
-  mkdtempAsync,
-  appendFileAsync,
 }

package/src/lib/functions/background.js

@@ -1,4 +1,4 @@
-const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('../../utils/logo')
+const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('../../utils')
 
 const { formatLambdaError, styleFunctionName } = require('./utils')
 

package/src/lib/functions/form-submissions-handler.js

@@ -1,11 +1,12 @@
+// @ts-check
 const { Readable } = require('stream')
 
 const { parse: parseContentType } = require('content-type')
 const multiparty = require('multiparty')
 const getRawBody = require('raw-body')
 
+const { BACKGROUND } = require('../../utils')
 const { warn } = require('../../utils/command-helpers')
-const { BACKGROUND } = require('../../utils/get-functions')
 const { capitalize } = require('../string')
 
 const createFormSubmissionHandler = function ({ functionsRegistry, siteUrl }) {

package/src/lib/functions/local-proxy.js

@@ -1,8 +1,9 @@
+// @ts-check
 const { stdout } = require('process')
 
 const { getBinaryPath: getFunctionsProxyPath } = require('@netlify/local-functions-proxy')
 
-const execa = require('../../utils/execa')
+const { execa } = require('../../utils')
 
 const runFunctionsProxy = ({ binaryPath, context, directory, event, name, timeout }) => {
   const functionsProxyPath = getFunctionsProxyPath()

package/src/lib/functions/netlify-function.js

@@ -1,8 +1,11 @@
+// @ts-check
 const { error: errorExit } = require('../../utils/command-helpers')
-const { difference } = require('../../utils/difference')
 
 const BACKGROUND_SUFFIX = '-background'
 
+// Returns a new set with all elements of `setA` that don't exist in `setB`.
+const difference = (setA, setB) => new Set([...setA].filter((item) => !setB.has(item)))
+
 class NetlifyFunction {
   constructor({ config, directory, mainFile, name, projectRoot, runtime, timeoutBackground, timeoutSynchronous }) {
     this.config = config

package/src/lib/functions/registry.js

@@ -1,10 +1,8 @@
+// @ts-check
+const { mkdir } = require('fs').promises
 const { env } = require('process')
 
-const chalk = require('chalk')
-
-const { log, warn } = require('../../utils/command-helpers')
-const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('../../utils/logo')
-const { mkdirRecursiveAsync } = require('../fs')
+const { NETLIFYDEVERR, NETLIFYDEVLOG, chalk, log, warn } = require('../../utils')
 const { getLogMessage } = require('../log')
 
 const { NetlifyFunction } = require('./netlify-function')
@@ -45,7 +43,7 @@ class FunctionsRegistry {
   }
 
   static async prepareDirectoryScan(directory) {
-    await mkdirRecursiveAsync(directory)
+    await mkdir(directory, { recursive: true })
 
     // We give runtimes the opportunity to react to a directory scan and run
     // additional logic before the directory is read. So if they implement a

package/src/lib/functions/runtimes/go/index.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { dirname, extname } = require('path')
 const { platform } = require('process')
 
@@ -5,7 +6,7 @@ const tempy = require('tempy')
 
 const isWindows = platform === 'win32'
 
-const execa = require('../../../../utils/execa')
+const { execa } = require('../../../../utils')
 const { runFunctionsProxy } = require('../../local-proxy')
 
 const build = async ({ binaryPath, functionDirectory }) => {

package/src/lib/functions/runtimes/js/builders/netlify-lambda.js

@@ -1,9 +1,11 @@
+// @ts-check
+const { readFile } = require('fs').promises
 const { resolve } = require('path')
 
-const execa = require('execa')
 const minimist = require('minimist')
 
-const { fileExistsAsync, readFileAsync } = require('../../../../fs')
+const { execa } = require('../../../../../utils')
+const { fileExistsAsync } = require('../../../../fs')
 const { memoizedBuild } = require('../../../memoized-build')
 
 const detectNetlifyLambda = async function ({ packageJson } = {}) {
@@ -59,8 +61,8 @@ module.exports = async function handler() {
     return false
   }
 
-  const content = await readFileAsync('package.json')
-  const packageJson = JSON.parse(content, { encoding: 'utf8' })
+  const content = await readFile('package.json', 'utf-8')
+  const packageJson = JSON.parse(content)
   return detectNetlifyLambda({ packageJson })
 }
 module.exports.detectNetlifyLambda = detectNetlifyLambda

package/src/lib/functions/runtimes/js/builders/zisi.js

@@ -1,3 +1,4 @@
+const { writeFile } = require('fs').promises
 const path = require('path')
 
 const { zipFunction } = require('@netlify/zip-it-and-ship-it')
@@ -6,8 +7,7 @@ const makeDir = require('make-dir')
 const readPkgUp = require('read-pkg-up')
 const sourceMapSupport = require('source-map-support')
 
-const { NETLIFYDEVERR } = require('../../../../../utils/logo')
-const { writeFileAsync } = require('../../../../fs')
+const { NETLIFYDEVERR } = require('../../../../../utils')
 const { getPathInProject } = require('../../../../settings')
 const { normalizeFunctionsConfig } = require('../../../config')
 const { memoizedBuild } = require('../../../memoized-build')
@@ -47,7 +47,7 @@ const buildFunction = async ({ cache, config, directory, func, hasTypeModule, pr
   // some projects include a package.json with "type=module", forcing Node to interpret every descending file
   // as ESM. ZISI outputs CJS, so we emit an overriding directive into the output directory.
   if (hasTypeModule) {
-    await writeFileAsync(
+    await writeFile(
       path.join(functionPath, `package.json`),
       JSON.stringify({
         type: 'commonjs',

package/src/lib/functions/runtimes/rust/index.js

@@ -1,3 +1,5 @@
+// @ts-check
+const { readFile } = require('fs').promises
 const { dirname, extname, join, resolve } = require('path')
 const { platform } = require('process')
 
@@ -6,8 +8,7 @@ const toml = require('toml')
 
 const isWindows = platform === 'win32'
 
-const execa = require('../../../../utils/execa')
-const { readFileAsync } = require('../../../fs')
+const { execa } = require('../../../../utils')
 const { getPathInProject } = require('../../../settings')
 const { runFunctionsProxy } = require('../../local-proxy')
 
@@ -36,7 +37,7 @@ const getBuildFunction =
 
 const getCrateName = async (cwd) => {
   const manifestPath = await findUp('Cargo.toml', { cwd, type: 'file' })
-  const manifest = await readFileAsync(manifestPath)
+  const manifest = await readFile(manifestPath, 'utf-8')
   const { package } = toml.parse(manifest)
 
   return package.name

package/src/lib/functions/server.js

@@ -1,8 +1,7 @@
+// @ts-check
 const jwtDecode = require('jwt-decode')
 
-const { error: errorExit, log } = require('../../utils/command-helpers')
-const { getInternalFunctionsDir } = require('../../utils/functions')
-const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('../../utils/logo')
+const { NETLIFYDEVERR, NETLIFYDEVLOG, error: errorExit, getInternalFunctionsDir, log } = require('../../utils')
 
 const { handleBackgroundFunction, handleBackgroundFunctionResult } = require('./background')
 const { createFormSubmissionHandler } = require('./form-submissions-handler')

package/src/lib/functions/synchronous.js

@@ -1,6 +1,7 @@
+// @ts-check
 const { Buffer } = require('buffer')
 
-const { NETLIFYDEVERR } = require('../../utils/logo')
+const { NETLIFYDEVERR } = require('../../utils')
 
 const { detectAwsSdkError } = require('./utils')
 

package/src/lib/functions/utils.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk')
-
-const { warn } = require('../../utils/command-helpers')
+// @ts-check
+const { chalk, warn } = require('../../utils')
 const { getLogMessage } = require('../log')
 
 const DEFAULT_LAMBDA_OPTIONS = {

package/src/lib/functions/watcher.js

@@ -1,3 +1,4 @@
+// @ts-check
 const chokidar = require('chokidar')
 const decache = require('decache')
 const debounce = require('lodash/debounce')

package/src/lib/http-agent.js

@@ -1,12 +1,10 @@
+const { readFile } = require('fs').promises
 const { URL } = require('url')
 
 const { HttpsProxyAgent } = require('https-proxy-agent')
 const waitPort = require('wait-port')
 
-const { exit, log } = require('../utils/command-helpers')
-const { NETLIFYDEVERR, NETLIFYDEVWARN } = require('../utils/logo')
-
-const fs = require('./fs')
+const { NETLIFYDEVERR, NETLIFYDEVWARN, exit, log } = require('../utils')
 
 // https://github.com/TooTallNate/node-https-proxy-agent/issues/89
 class HttpsProxyAgentWithCA extends HttpsProxyAgent {
@@ -68,7 +66,7 @@ const tryGetAgent = async ({ certificateFile, httpProxy }) => {
   let certificate
   if (certificateFile) {
     try {
-      certificate = await fs.readFileAsync(certificateFile)
+      certificate = await readFile(certificateFile)
     } catch (error) {
       response = { warning: `Could not read certificate file '${certificateFile}'.`, message: error.message }
     }

package/src/lib/log.js

@@ -1,6 +1,7 @@
-const chalk = require('chalk')
 const dotProp = require('dot-prop')
 
+const { chalk } = require('../utils')
+
 const RED_BACKGROUND = chalk.red('-background')
 const [PRO, BUSINESS, ENTERPRISE] = ['Pro', 'Business', 'Enterprise'].map((plan) => chalk.magenta(plan))
 const BACKGROUND_FUNCTIONS_WARNING = `A serverless function ending in \`${RED_BACKGROUND}\` was detected.

package/src/lib/spinner.js

@@ -1,15 +1,31 @@
+// @ts-check
 const logSymbols = require('log-symbols')
 const ora = require('ora')
 
+/**
+ * Creates a spinner with the following text
+ * @param {object} config
+ * @param {string} config.text
+ * @returns {ora.Ora}
+ */
 const startSpinner = ({ text }) =>
   ora({
     text,
   }).start()
 
+/**
+ * Stops the spinner with the following text
+ * @param {object} config
+ * @param {object} [config.error]
+ * @param {ora.Ora} config.spinner
+ * @param {string} config.text
+ * @returns {void}
+ */
 const stopSpinner = ({ error, spinner, text }) => {
   if (!spinner) {
     return
   }
+  // TODO: refactor no package needed `log-symbols` for that
   const symbol = error ? logSymbols.error : logSymbols.success
   spinner.stopAndPersist({
     text,
@@ -17,6 +33,12 @@ const stopSpinner = ({ error, spinner, text }) => {
   })
 }
 
+/**
+ * Clears the spinner
+ * @param {object} config
+ * @param {ora.Ora} config.spinner
+ * @returns {void}
+ */
 const clearSpinner = ({ spinner }) => {
   if (spinner) {
     spinner.stop()

package/src/utils/addons/diffs/index.js

@@ -1,3 +1,4 @@
+// @ts-check
 const concordance = require('concordance')
 
 const { concordanceDiffOptions, concordanceOptions } = require('./options')

package/src/utils/addons/diffs/options.js

@@ -1,5 +1,7 @@
+// @ts-check
 const ansiStyles = require('ansi-styles')
-const chalk = require('chalk')
+
+const { chalk } = require('../../command-helpers')
 
 const forceColor = new chalk.Instance({ level: 1 })
 

package/src/utils/addons/prepare.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk')
-
-const { error, exit, log, warn } = require('../command-helpers')
+// @ts-check
+const { chalk, error, exit, log, warn } = require('../command-helpers')
 
 const ADDON_VALIDATION = {
   EXISTS: 'EXISTS',
@@ -81,17 +80,25 @@ const getAddons = async ({ api, siteId }) => {
   return addons
 }
 
-const prepareAddonCommand = async ({ addonName, context, validation }) => {
-  const { netlify } = context
+/**
+ *
+ * @param {object} config
+ * @param {import('../../commands/base-command').BaseCommand} config.command
+ * @param {string} [config.addonName]
+ * @param {keyof ADDON_VALIDATION} [config.validation]
+ */
+const prepareAddonCommand = async ({ addonName, command, validation }) => {
+  const { netlify } = command
   const { api, site } = netlify
   const siteId = site.id
   if (!siteId) {
     error('No site id found, please run inside a site folder or `netlify link`')
   }
 
-  await context.authenticate()
+  await command.authenticate()
 
   const [manifest, siteData, addons] = await Promise.all([
+    // TODO: check as `getAddonManifest` did not accept a parameter error
     addonName ? getAddonManifest({ api, addonName, error }) : Promise.resolve(),
     getSiteData({ api, siteId }),
     getAddons({ api, siteId }),

package/src/utils/addons/prompts.js

@@ -1,4 +1,5 @@
-const chalk = require('chalk')
+// @ts-check
+const { chalk } = require('../command-helpers')
 
 /* programmatically generate CLI prompts */
 module.exports = function generatePrompts(settings) {

package/src/utils/addons/render.js

@@ -1,5 +1,7 @@
+// @ts-check
 const AsciiTable = require('ascii-table')
-const chalk = require('chalk')
+
+const { chalk } = require('../command-helpers')
 
 const missingValues = function (values, manifest) {
   const display = values