netlify-cli 10.6.3 → 10.8.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "10.6.3",
+  "version": "10.8.0",
   "author": "Netlify Inc.",
   "contributors": [
     "Abraham Schilling <AbrahamSchilling@gmail.com> (https://gitlab.com/n4bb12)",
@@ -31,6 +31,7 @@
     "Dan Loewenherz <dan@lionheartsw.com> (https://twitter.com/dwlz)",
     "Daniel Tschinder (https://twitter.com/TschinderDaniel)",
     "Daniel Woelfel <dwwoelfel@gmail.com> (https://twitter.com/danielwoelfel)",
+    "Dario De Vito",
     "Dave Ackerman <dmackerman@gmail.com>",
     "David Calavera <david@netlify.com> (https://twitter.com/calavera)",
     "David Lemler <dlemler@pm.me> (https://twitter.com/davidlemlerm)",
@@ -55,6 +56,7 @@
     "Jake Jarvis <jake@jarv.is> (https://twitter.com/jakejarvis)",
     "Jakob Warkotsch <j.warkotsch@gmail.com>",
     "James George (https://twitter.com/james_madhacks)",
+    "Jason Barry (https://twitter.com/jasbarry)",
     "Jason Lengstorf <jason@lengstorf.com> (https://twitter.com/jlengstorf)",
     "Jeremy Monson (www.surfline.com)",
     "Jessica Parsons",
@@ -90,6 +92,7 @@
     "Nicolas Gonzalez",
     "Pankaj Patil <pankaj.patil2099@hotmail.com> (https://twitter.com/pankajpatil16)",
     "Peter",
+    "Prince Wilson (https://twitter.com/maxcell)",
     "Rachael Stavchansky",
     "Raees Iqbal <raees@netlify.com> (https://raeesbhatti.com/)",
     "Ricardo Mendes <rokusu@gmail.com> (https://twitter.com/locks)",
@@ -138,6 +141,7 @@
     "dustincrogers",
     "ehmicky (https://twitter.com/ehmicky)",
     "internal tools netlibot",
+    "just toby",
     "kvn-shn",
     "netlibot (https://www.netlify.com)",
     "nikoladev",
@@ -212,18 +216,18 @@
     "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,tools,scripts,site,tests,.github}/**/*.{mjs,cjs,js,md,yml,json,html}\" \"*.{mjs,cjs,js,yml,json,html}\" \".*.{mjs,cjs,js,yml,json,html}\" \"!CHANGELOG.md\" \"!npm-shrinkwrap.json\" \"!**/*/package-lock.json\" \"!.github/**/*.md\""
   },
   "dependencies": {
-    "@netlify/build": "^27.3.1",
-    "@netlify/config": "^18.1.0",
-    "@netlify/edge-bundler": "^1.4.1",
+    "@netlify/build": "^27.3.3",
+    "@netlify/config": "^18.1.1",
+    "@netlify/edge-bundler": "^1.5.0",
     "@netlify/framework-info": "^9.1.0",
     "@netlify/local-functions-proxy": "^1.1.1",
-    "@netlify/plugins-list": "^6.28.0",
-    "@netlify/zip-it-and-ship-it": "^5.11.1",
+    "@netlify/plugins-list": "^6.30.0",
+    "@netlify/zip-it-and-ship-it": "^5.12.0",
     "@octokit/rest": "^18.0.0",
     "@sindresorhus/slugify": "^1.1.0",
     "ansi-escapes": "^5.0.0",
     "ansi-styles": "^5.0.0",
-    "ansi2html": "^0.0.1",
+    "ansi-to-html": "^0.7.2",
     "ascii-table": "0.0.9",
     "backoff": "^2.5.0",
     "better-opn": "^3.0.0",
@@ -232,7 +236,7 @@
     "chokidar": "^3.0.2",
     "ci-info": "^3.0.0",
     "clean-deep": "^3.0.2",
-    "commander": "^9.0.0",
+    "commander": "^9.2.0",
     "concordance": "^5.0.0",
     "configstore": "^5.0.0",
     "content-type": "^1.0.4",
@@ -257,7 +261,6 @@
     "fuzzy": "^0.1.3",
     "get-port": "^5.1.0",
     "gh-release-fetch": "^3.0.0",
-    "git-clone": "^0.2.0",
     "git-repo-info": "^2.1.0",
     "gitconfiglocal": "^2.1.0",
     "hasbin": "^1.2.3",
@@ -318,7 +321,7 @@
     "unixify": "^1.0.0",
     "update-notifier": "^5.0.0",
     "uuid": "^8.0.0",
-    "wait-port": "^0.2.2",
+    "wait-port": "^0.2.14",
     "winston": "^3.2.1",
     "write-file-atomic": "^4.0.0"
   },

package/src/commands/deploy/deploy.js

@@ -37,12 +37,21 @@ const { sitesCreate } = require('../sites')
 
 const DEFAULT_DEPLOY_TIMEOUT = 1.2e6
 
-const triggerDeploy = async ({ api, siteData, siteId }) => {
+const triggerDeploy = async ({ api, options, siteData, siteId }) => {
   try {
     const siteBuild = await api.createSiteBuild({ siteId })
-    log(
-      `${NETLIFYDEV} A new deployment was triggered successfully. Visit https://app.netlify.com/sites/${siteData.name}/deploys/${siteBuild.deploy_id} to see the logs.`,
-    )
+    if (options.json) {
+      logJson({
+        site_id: siteId,
+        site_name: siteData.name,
+        deploy_id: `${siteBuild.deploy_id}`,
+        logs: `https://app.netlify.com/sites/${siteData.name}/deploys/${siteBuild.deploy_id}`,
+      })
+    } else {
+      log(
+        `${NETLIFYDEV} A new deployment was triggered successfully. Visit https://app.netlify.com/sites/${siteData.name}/deploys/${siteBuild.deploy_id} to see the logs.`,
+      )
+    }
   } catch (error_) {
     if (error_.status === 404) {
       error('Site not found. Please rerun "netlify link" and make sure that your site has CI configured.')
@@ -553,7 +562,7 @@ const deploy = async (options, command) => {
   const deployToProduction = options.prod || (options.prodIfUnlocked && !siteData.published_deploy.locked)
 
   if (options.trigger) {
-    return triggerDeploy({ api, siteId, siteData })
+    return triggerDeploy({ api, options, siteData, siteId })
   }
 
   const { newConfig, configMutations = [] } = await handleBuild({

package/src/commands/dev/dev.js

@@ -26,6 +26,7 @@ const {
   getNetlifyGraphConfig,
   readGraphQLOperationsSourceFile,
 } = require('../../lib/one-graph/cli-netlify-graph')
+const { startSpinner, stopSpinner } = require('../../lib/spinner')
 const {
   BANG,
   NETLIFYDEV,
@@ -115,7 +116,7 @@ const cleanupBeforeExit = async ({ exitCode }) => {
  * @param {NodeJS.ProcessEnv} env
  * @returns {execa.ExecaChildProcess<string>}
  */
-const runCommand = (command, env = {}) => {
+const runCommand = (command, env = {}, spinner = null) => {
   const commandProcess = execa.command(command, {
     preferLocal: true,
     // we use reject=false to avoid rejecting synchronously when the command doesn't exist
@@ -125,8 +126,23 @@ const runCommand = (command, env = {}) => {
     windowsHide: false,
   })
 
-  commandProcess.stdout.pipe(stripAnsiCc.stream()).pipe(process.stdout)
-  commandProcess.stderr.pipe(stripAnsiCc.stream()).pipe(process.stderr)
+  // This ensures that an active spinner stays at the bottom of the commandline
+  // even though the actual framework command might be outputting stuff
+  const pipeDataWithSpinner = (writeStream, chunk) => {
+    if (spinner && spinner.isSpinning) {
+      spinner.clear()
+      spinner.isSilent = true
+    }
+    writeStream.write(chunk, () => {
+      if (spinner && spinner.isSpinning) {
+        spinner.isSilent = false
+        spinner.render()
+      }
+    })
+  }
+
+  commandProcess.stdout.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stdout))
+  commandProcess.stderr.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stderr))
   process.stdin.pipe(commandProcess.stdin)
 
   // we can't try->await->catch since we don't want to block on the framework server which
@@ -173,15 +189,16 @@ const startFrameworkServer = async function ({ settings }) {
 
   log(`${NETLIFYDEVLOG} Starting Netlify Dev with ${settings.framework || 'custom config'}`)
 
-  runCommand(settings.command, settings.env)
+  const spinner = startSpinner({
+    text: `Waiting for framework port ${settings.frameworkPort}. This can be configured using the 'targetPort' property in the netlify.toml`,
+  })
+
+  runCommand(settings.command, settings.env, spinner)
 
   try {
-    log(
-      `${NETLIFYDEVLOG} Waiting for framework port ${settings.frameworkPort}. This can be configured using the 'targetPort' property in the netlify.toml`,
-    )
     const open = await waitPort({
       port: settings.frameworkPort,
-      output: 'dots',
+      output: 'silent',
       timeout: FRAMEWORK_PORT_TIMEOUT,
       ...(settings.pollingStrategies.includes('HTTP') && { protocol: 'http' }),
     })
@@ -189,7 +206,10 @@ const startFrameworkServer = async function ({ settings }) {
     if (!open) {
       throw new Error(`Timed out waiting for port '${settings.frameworkPort}' to be open`)
     }
+
+    stopSpinner({ error: false, spinner })
   } catch {
+    stopSpinner({ error: true, spinner })
     log(NETLIFYDEVERR, `Netlify Dev could not connect to localhost:${settings.frameworkPort}.`)
     log(NETLIFYDEVERR, `Please make sure your framework server is running on port ${settings.frameworkPort}`)
     exit(1)
@@ -481,7 +501,13 @@ const dev = async (options, command) => {
         graphqlDocument = defaultExampleOperationsDoc
       }
 
-      stopWatchingCLISessions = await startOneGraphCLISession({ netlifyGraphConfig, netlifyToken, site, state })
+      stopWatchingCLISessions = await startOneGraphCLISession({
+        netlifyGraphConfig,
+        netlifyToken,
+        site,
+        state,
+        oneGraphSessionId: options.sessionId,
+      })
 
       // Should be created by startOneGraphCLISession
       const oneGraphSessionId = loadCLISession(state)
@@ -579,6 +605,7 @@ const createDevCommand = (program) => {
         .hideHelp(),
     )
     .addOption(new Option('--graph', 'enable Netlify Graph support').hideHelp())
+    .addOption(new Option('--sessionId [sessionId]', '(Graph) connect to cloud session with ID [sessionId]'))
     .addOption(
       new Option(
         '-e, --edgeInspect [address]',

package/src/commands/env/env-import.js

@@ -5,7 +5,7 @@ const AsciiTable = require('ascii-table')
 const dotenv = require('dotenv')
 const isEmpty = require('lodash/isEmpty')
 
-const { exit, log, logJson } = require('../../utils')
+const { exit, log, logJson, translateFromEnvelopeToMongo, translateFromMongoToEnvelope } = require('../../utils')
 
 /**
  * The env:import command
@@ -23,13 +23,6 @@ const envImport = async (fileName, options, command) => {
     return false
   }
 
-  const siteData = await api.getSite({ siteId })
-
-  // Get current environment variables set in the UI
-  const {
-    build_settings: { env = {} },
-  } = siteData
-
   let importedEnv = {}
   try {
     const envFileContents = await readFile(fileName, 'utf-8')
@@ -44,21 +37,14 @@ const envImport = async (fileName, options, command) => {
     return false
   }
 
-  // Apply environment variable updates
-  const siteResult = await api.updateSite({
-    siteId,
-    body: {
-      build_settings: {
-        // Only set imported variables if --replaceExisting or otherwise merge
-        // imported ones with the current environment variables.
-        env: options.replaceExisting ? importedEnv : { ...env, ...importedEnv },
-      },
-    },
-  })
+  const siteData = await api.getSite({ siteId })
+
+  const importIntoService = siteData.use_envelope ? importIntoEnvelope : importIntoMongo
+  const finalEnv = await importIntoService({ api, importedEnv, options, siteData })
 
   // Return new environment variables of site if using json flag
   if (options.json) {
-    logJson(siteResult.build_settings.env)
+    logJson(finalEnv)
     return false
   }
 
@@ -71,6 +57,66 @@ const envImport = async (fileName, options, command) => {
   log(table.toString())
 }
 
+/**
+ * Updates the imported env in the site record
+ * @returns {Promise<object>}
+ */
+const importIntoMongo = async ({ api, importedEnv, options, siteData }) => {
+  const { env = {} } = siteData.build_settings
+  const siteId = siteData.id
+
+  const finalEnv = options.replaceExisting ? importedEnv : { ...env, ...importedEnv }
+
+  // Apply environment variable updates
+  await api.updateSite({
+    siteId,
+    body: {
+      build_settings: {
+        // Only set imported variables if --replaceExisting or otherwise merge
+        // imported ones with the current environment variables.
+        env: finalEnv,
+      },
+    },
+  })
+
+  return finalEnv
+}
+
+/**
+ * Saves the imported env in the Envelope service
+ * @returns {Promise<object>}
+ */
+const importIntoEnvelope = async ({ api, importedEnv, options, siteData }) => {
+  // fetch env vars
+  const accountId = siteData.account_slug
+  const siteId = siteData.id
+  const dotEnvKeys = Object.keys(importedEnv)
+  const envelopeVariables = await api.getEnvVars({ accountId, siteId })
+  const envelopeKeys = envelopeVariables.map(({ key }) => key)
+
+  // if user intends to replace all existing env vars
+  // either replace; delete all existing env vars on the site
+  // or, merge; delete only the existing env vars that would collide with new .env entries
+  const keysToDelete = options.replaceExisting ? envelopeKeys : envelopeKeys.filter((key) => dotEnvKeys.includes(key))
+
+  // delete marked env vars in parallel
+  await Promise.all(keysToDelete.map((key) => api.deleteEnvVar({ accountId, siteId, key })))
+
+  // hit create endpoint
+  const body = translateFromMongoToEnvelope(importedEnv)
+  try {
+    await api.createEnvVars({ accountId, siteId, body })
+  } catch (error) {
+    throw error.json ? error.json.msg : error
+  }
+
+  // return final env to aid in --json output (for testing)
+  return {
+    ...translateFromEnvelopeToMongo(envelopeVariables.filter(({ key }) => !keysToDelete.includes(key))),
+    ...importedEnv,
+  }
+}
+
 /**
  * Creates the `netlify env:import` command
  * @param {import('../base-command').BaseCommand} program

package/src/commands/env/env-migrate.js

@@ -2,7 +2,13 @@
 
 const { isEmpty } = require('lodash')
 
-const { chalk, error: logError, log } = require('../../utils')
+const {
+  chalk,
+  error: logError,
+  log,
+  translateFromEnvelopeToMongo,
+  translateFromMongoToEnvelope,
+} = require('../../utils')
 
 const safeGetSite = async (api, siteId) => {
   try {
@@ -51,6 +57,37 @@ const envMigrate = async (options, command) => {
     return false
   }
 
+  // determine if siteFrom and/or siteTo is on Envelope
+  let method
+  if (!siteFrom.use_envelope && !siteTo.use_envelope) {
+    method = mongoToMongo
+  } else if (!siteFrom.use_envelope && siteTo.use_envelope) {
+    method = mongoToEnvelope
+  } else if (siteFrom.use_envelope && !siteTo.use_envelope) {
+    method = envelopeToMongo
+  } else {
+    method = envelopeToEnvelope
+  }
+  const success = await method({ api, siteFrom, siteTo })
+
+  if (!success) {
+    return false
+  }
+
+  log(
+    `Successfully migrated environment variables from ${chalk.greenBright(siteFrom.name)} to ${chalk.greenBright(
+      siteTo.name,
+    )}`,
+  )
+
+  return true
+}
+
+/**
+ * Copies the env from a site not configured with Envelope to a different site not configured with Envelope
+ * @returns {Promise<boolean>}
+ */
+const mongoToMongo = async ({ api, siteFrom, siteTo }) => {
   const [
     {
       build_settings: { env: envFrom = {} },
@@ -73,7 +110,7 @@ const envMigrate = async (options, command) => {
 
   // Apply environment variable updates
   await api.updateSite({
-    siteId: siteId.to,
+    siteId: siteTo.id,
     body: {
       build_settings: {
         env: mergedEnv,
@@ -81,11 +118,107 @@ const envMigrate = async (options, command) => {
     },
   })
 
-  log(
-    `Successfully migrated environment variables from ${chalk.greenBright(siteFrom.name)} to ${chalk.greenBright(
-      siteTo.name,
-    )}`,
-  )
+  return true
+}
+
+/**
+ * Copies the env from a site not configured with Envelope to a site configured with Envelope
+ * @returns {Promise<boolean>}
+ */
+const mongoToEnvelope = async ({ api, siteFrom, siteTo }) => {
+  const envFrom = siteFrom.build_settings.env || {}
+  const keysFrom = Object.keys(envFrom)
+
+  if (isEmpty(envFrom)) {
+    log(`${chalk.greenBright(siteFrom.name)} has no environment variables, nothing to migrate`)
+    return false
+  }
+
+  const accountId = siteTo.account_slug
+  const siteId = siteTo.id
+
+  const envelopeTo = await api.getEnvVars({ accountId, siteId })
+
+  const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key))
+  // delete marked env vars in parallel
+  await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })))
+
+  // hit create endpoint
+  const body = translateFromMongoToEnvelope(envFrom)
+  try {
+    await api.createEnvVars({ accountId, siteId, body })
+  } catch (error) {
+    throw error.json ? error.json.msg : error
+  }
+
+  return true
+}
+
+/**
+ * Copies the env from a site configured with Envelope to a site not configured with Envelope
+ * @returns {Promise<boolean>}
+ */
+const envelopeToMongo = async ({ api, siteFrom, siteTo }) => {
+  const envelopeVariables = await api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id })
+  const envFrom = translateFromEnvelopeToMongo(envelopeVariables)
+
+  if (isEmpty(envFrom)) {
+    log(`${chalk.greenBright(siteFrom.name)} has no environment variables, nothing to migrate`)
+    return false
+  }
+
+  const envTo = siteTo.build_settings.env || {}
+
+  // Merge from site A to site B
+  const mergedEnv = {
+    ...envTo,
+    ...envFrom,
+  }
+
+  // Apply environment variable updates
+  await api.updateSite({
+    siteId: siteTo.id,
+    body: {
+      build_settings: {
+        env: mergedEnv,
+      },
+    },
+  })
+
+  return true
+}
+
+/**
+ * Copies the env from a site configured with Envelope to a different site configured with Envelope
+ * @returns {Promise<boolean>}
+ */
+const envelopeToEnvelope = async ({ api, siteFrom, siteTo }) => {
+  const [envelopeFrom, envelopeTo] = await Promise.all([
+    api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id }),
+    api.getEnvVars({ accountId: siteTo.account_slug, siteId: siteTo.id }),
+  ])
+
+  const keysFrom = envelopeFrom.map(({ key }) => key)
+
+  if (isEmpty(keysFrom)) {
+    log(`${chalk.greenBright(siteFrom.name)} has no environment variables, nothing to migrate`)
+    return false
+  }
+
+  const accountId = siteTo.account_slug
+  const siteId = siteTo.id
+  const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key))
+  // delete marked env vars in parallel
+  await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })))
+
+  // hit create endpoint
+  try {
+    await api.createEnvVars({ accountId, siteId, body: envelopeFrom })
+  } catch (error) {
+    throw error.json ? error.json.msg : error
+  }
+
+  return true
 }
 
 /**

package/src/commands/env/env-set.js

@@ -1,15 +1,15 @@
 // @ts-check
-const { log, logJson } = require('../../utils')
+const { log, logJson, translateFromEnvelopeToMongo } = require('../../utils')
 
 /**
  * The env:set command
- * @param {string} name Environment variable name
+ * @param {string} key Environment variable key
  * @param {string} value Value to set to
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command').BaseCommand} command
  * @returns {Promise<boolean>}
  */
-const envSet = async (name, value, options, command) => {
+const envSet = async (key, value, options, command) => {
   const { api, site } = command.netlify
   const siteId = site.id
 
@@ -21,32 +21,67 @@ const envSet = async (name, value, options, command) => {
   const siteData = await api.getSite({ siteId })
 
   // Get current environment variables set in the UI
-  const {
-    build_settings: { env = {} },
-  } = siteData
+  const setInService = siteData.use_envelope ? setInEnvelope : setInMongo
+  const finalEnv = await setInService({ api, siteData, key, value })
 
+  // Return new environment variables of site if using json flag
+  if (options.json) {
+    logJson(finalEnv)
+    return false
+  }
+
+  log(`Set environment variable ${key}=${value} for site ${siteData.name}`)
+}
+
+/**
+ * Updates the env for a site record with a new key/value pair
+ * @returns {Promise<object>}
+ */
+const setInMongo = async ({ api, key, siteData, value }) => {
+  const { env = {} } = siteData.build_settings
   const newEnv = {
     ...env,
-    [name]: value,
+    [key]: value,
   }
-
   // Apply environment variable updates
-  const siteResult = await api.updateSite({
-    siteId,
+  await api.updateSite({
+    siteId: siteData.id,
     body: {
       build_settings: {
         env: newEnv,
       },
     },
   })
+  return newEnv
+}
 
-  // Return new environment variables of site if using json flag
-  if (options.json) {
-    logJson(siteResult.build_settings.env)
-    return false
+/**
+ * Updates the env for a site configured with Envelope with a new key/value pair
+ * @returns {Promise<object>}
+ */
+const setInEnvelope = async ({ api, key, siteData, value }) => {
+  const accountId = siteData.account_slug
+  const siteId = siteData.id
+  // fetch envelope env vars
+  const envelopeVariables = await api.getEnvVars({ accountId, siteId })
+  const scopes = ['builds', 'functions', 'runtime', 'post_processing']
+  const values = [{ context: 'all', value }]
+  // check if we need to create or update
+  const exists = envelopeVariables.some((envVar) => envVar.key === key)
+  const method = exists ? api.updateEnvVar : api.createEnvVars
+  const body = exists ? { key, scopes, values } : [{ key, scopes, values }]
+
+  try {
+    await method({ accountId, siteId, key, body })
+  } catch (error) {
+    throw error.json ? error.json.msg : error
   }
 
-  log(`Set environment variable ${name}=${value} for site ${siteData.name}`)
+  const env = translateFromEnvelopeToMongo(envelopeVariables)
+  return {
+    ...env,
+    [key]: value,
+  }
 }
 
 /**
@@ -57,11 +92,11 @@ const envSet = async (name, value, options, command) => {
 const createEnvSetCommand = (program) =>
   program
     .command('env:set')
-    .argument('<name>', 'Environment variable name')
+    .argument('<key>', 'Environment variable key')
     .argument('[value]', 'Value to set to', '')
     .description('Set value of environment variable')
-    .action(async (name, value, options, command) => {
-      await envSet(name, value, options, command)
+    .action(async (key, value, options, command) => {
+      await envSet(key, value, options, command)
     })
 
 module.exports = { createEnvSetCommand }