netlify-cli 15.3.1 → 15.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "15.3.1",
+  "version": "15.4.0",
   "author": "Netlify Inc.",
   "type": "module",
   "engines": {
@@ -44,13 +44,13 @@
   "dependencies": {
     "@bugsnag/js": "7.20.2",
     "@fastify/static": "6.10.2",
-    "@netlify/build": "29.11.7",
-    "@netlify/build-info": "7.0.4",
-    "@netlify/config": "20.4.3",
-    "@netlify/edge-bundler": "8.16.0",
-    "@netlify/framework-info": "9.8.8",
+    "@netlify/build": "29.12.1",
+    "@netlify/build-info": "7.0.5",
+    "@netlify/config": "20.4.4",
+    "@netlify/edge-bundler": "8.16.1",
+    "@netlify/framework-info": "9.8.9",
     "@netlify/local-functions-proxy": "1.1.1",
-    "@netlify/zip-it-and-ship-it": "9.7.0",
+    "@netlify/zip-it-and-ship-it": "9.8.0",
     "@octokit/rest": "19.0.11",
     "@skn0tt/lambda-local": "2.0.3",
     "ansi-escapes": "6.2.0",
@@ -83,6 +83,7 @@
     "express": "4.18.2",
     "express-logging": "1.1.1",
     "extract-zip": "2.0.1",
+    "fastest-levenshtein": "1.0.16",
     "fastify": "4.17.0",
     "find-up": "6.3.0",
     "flush-write-stream": "2.0.0",
@@ -90,7 +91,7 @@
     "from2-array": "0.0.4",
     "fuzzy": "0.1.3",
     "get-port": "5.1.1",
-    "gh-release-fetch": "4.0.0",
+    "gh-release-fetch": "4.0.1",
     "git-repo-info": "2.1.1",
     "gitconfiglocal": "2.1.0",
     "hasbin": "1.2.3",
@@ -133,7 +134,6 @@
     "read-pkg-up": "9.1.0",
     "semver": "7.5.1",
     "source-map-support": "0.5.21",
-    "string-similarity": "4.0.4",
     "strip-ansi-control-characters": "2.0.0",
     "tabtab": "3.0.2",
     "tempy": "3.0.0",

package/src/commands/dev/dev.mjs

@@ -21,7 +21,7 @@ import detectServerSettings, { getConfigWithPlugins } from '../../utils/detect-s
 import { getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.mjs'
 import { getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs'
 import { ensureNetlifyIgnore } from '../../utils/gitignore.mjs'
-import { startLiveTunnel } from '../../utils/live-tunnel.mjs'
+import { getLiveTunnelSlug, startLiveTunnel } from '../../utils/live-tunnel.mjs'
 import openBrowser from '../../utils/open-browser.mjs'
 import { generateInspectSettings, startProxyServer } from '../../utils/proxy-server.mjs'
 import { getProxyUrl } from '../../utils/proxy.mjs'
@@ -37,16 +37,33 @@ import { createDevExecCommand } from './dev-exec.mjs'
  * @param {import('commander').OptionValues} config.options
  * @param {*} config.settings
  * @param {*} config.site
+ * @param {*} config.state
  * @returns
  */
-const handleLiveTunnel = async ({ api, options, settings, site }) => {
-  if (options.live) {
+const handleLiveTunnel = async ({ api, options, settings, site, state }) => {
+  const { live } = options
+
+  if (live) {
+    const customSlug = typeof live === 'string' && live.length !== 0 ? live : undefined
+    const slug = getLiveTunnelSlug(state, customSlug)
+
+    let message = `${NETLIFYDEVWARN} Creating live URL with ID ${chalk.yellow(slug)}`
+
+    if (!customSlug) {
+      message += ` (to generate a custom URL, use ${chalk.magenta('--live=<subdomain>')})`
+    }
+
+    log(message)
+
     const sessionUrl = await startLiveTunnel({
       siteId: site.id,
       netlifyApiToken: api.accessToken,
       localPort: settings.port,
+      slug,
     })
+
     process.env.BASE_URL = sessionUrl
+
     return sessionUrl
   }
 }
@@ -125,8 +142,9 @@ const dev = async (options, command) => {
 
   command.setAnalyticsPayload({ live: options.live })
 
-  const liveTunnelUrl = await handleLiveTunnel({ options, site, api, settings })
+  const liveTunnelUrl = await handleLiveTunnel({ options, site, api, settings, state })
   const url = liveTunnelUrl || getProxyUrl(settings)
+
   process.env.URL = url
   process.env.DEPLOY_URL = url
 
@@ -229,7 +247,11 @@ export const createDevCommand = (program) => {
     .option('-d ,--dir <path>', 'dir with static files')
     .option('-f ,--functions <folder>', 'specify a functions folder to serve')
     .option('-o ,--offline', 'disables any features that require network access')
-    .option('-l, --live', 'start a public live session', false)
+    .option(
+      '-l, --live [subdomain]',
+      'start a public live session; optionally, supply a subdomain to generate a custom URL',
+      false,
+    )
     .addOption(
       new Option('--functionsPort <port>', 'Old, prefer --functions-port. Port of functions server')
         .argParser((value) => Number.parseInt(value))

package/src/commands/main.mjs

@@ -2,8 +2,8 @@
 import process from 'process'
 
 import { Option } from 'commander'
+import { closest } from 'fastest-levenshtein'
 import inquirer from 'inquirer'
-import { findBestMatch } from 'string-similarity'
 
 import { BANG, chalk, error, exit, log, NETLIFY_CYAN, USER_AGENT, warn } from '../utils/command-helpers.mjs'
 import execa from '../utils/execa.mjs'
@@ -118,9 +118,7 @@ const mainCommand = async function (options, command) {
   warn(`${chalk.yellow(command.args[0])} is not a ${command.name()} command.`)
 
   const allCommands = command.commands.map((cmd) => cmd.name())
-  const {
-    bestMatch: { target: suggestion },
-  } = findBestMatch(command.args[0], allCommands)
+  const suggestion = closest(command.args[0], allCommands)
 
   const applySuggestion = await new Promise((resolve) => {
     const prompt = inquirer.prompt({

package/src/commands/recipes/recipes.mjs

@@ -1,8 +1,8 @@
 // @ts-check
 import { basename } from 'path'
 
+import { closest } from 'fastest-levenshtein'
 import inquirer from 'inquirer'
-import { findBestMatch } from 'string-similarity'
 
 import { NETLIFYDEVERR, chalk, log } from '../../utils/command-helpers.mjs'
 
@@ -28,7 +28,10 @@ const recipesCommand = async (recipeName, options, command) => {
   try {
     return await runRecipe({ config, recipeName: sanitizedRecipeName, repositoryRoot })
   } catch (error) {
-    if (error.code !== 'MODULE_NOT_FOUND') {
+    if (
+      // The ESM loader throws this instead of MODULE_NOT_FOUND
+      error.code !== 'ERR_MODULE_NOT_FOUND'
+    ) {
       throw error
     }
 
@@ -36,9 +39,7 @@ const recipesCommand = async (recipeName, options, command) => {
 
     const recipes = await listRecipes()
     const recipeNames = recipes.map(({ name }) => name)
-    const {
-      bestMatch: { target: suggestion },
-    } = findBestMatch(recipeName, recipeNames)
+    const suggestion = closest(recipeName, recipeNames)
     const applySuggestion = await new Promise((resolve) => {
       const prompt = inquirer.prompt({
         type: 'confirm',

package/src/functions-templates/javascript/token-hider/package-lock.json

@@ -164,9 +164,9 @@
       "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg=="
     },
     "node_modules/qs": {
-      "version": "6.11.1",
-      "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.1.tgz",
-      "integrity": "sha512-0wsrzgTz/kAVIeuxSjnpGC56rzYtr6JT/2BwEvMaPhFIoYa1aGO8LbzuU1R0uUYQkLpWBTOj0l/CLAJB64J6nQ==",
+      "version": "6.11.2",
+      "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.2.tgz",
+      "integrity": "sha512-tDNIz22aBzCDxLtVH++VnTfzxlfeK5CbqohpSqpJgj1Wg/cQbStNAz3NuqCs5vV+pjBsK4x4pN9HlVh7rcYRiA==",
       "dependencies": {
         "side-channel": "^1.0.4"
       },
@@ -296,9 +296,9 @@
       "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg=="
     },
     "qs": {
-      "version": "6.11.1",
-      "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.1.tgz",
-      "integrity": "sha512-0wsrzgTz/kAVIeuxSjnpGC56rzYtr6JT/2BwEvMaPhFIoYa1aGO8LbzuU1R0uUYQkLpWBTOj0l/CLAJB64J6nQ==",
+      "version": "6.11.2",
+      "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.2.tgz",
+      "integrity": "sha512-tDNIz22aBzCDxLtVH++VnTfzxlfeK5CbqohpSqpJgj1Wg/cQbStNAz3NuqCs5vV+pjBsK4x4pN9HlVh7rcYRiA==",
       "requires": {
         "side-channel": "^1.0.4"
       }

package/src/functions-templates/typescript/hello-world/package-lock.json

@@ -26,9 +26,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "14.18.47",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.47.tgz",
-      "integrity": "sha512-OuJi8bIng4wYHHA3YpKauL58dZrPxro3d0tabPHyiNF8rKfGKuVfr83oFlPLmKri1cX+Z3cJP39GXmnqkP11Gw=="
+      "version": "14.18.48",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.48.tgz",
+      "integrity": "sha512-iL0PIMwejpmuVHgfibHpfDwOdsbmB50wr21X71VnF5d7SsBF7WK+ZvP/SCcFm7Iwb9iiYSap9rlrdhToNAWdxg=="
     },
     "node_modules/is-promise": {
       "version": "4.0.0",
@@ -58,9 +58,9 @@
       }
     },
     "@types/node": {
-      "version": "14.18.47",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.47.tgz",
-      "integrity": "sha512-OuJi8bIng4wYHHA3YpKauL58dZrPxro3d0tabPHyiNF8rKfGKuVfr83oFlPLmKri1cX+Z3cJP39GXmnqkP11Gw=="
+      "version": "14.18.48",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.48.tgz",
+      "integrity": "sha512-iL0PIMwejpmuVHgfibHpfDwOdsbmB50wr21X71VnF5d7SsBF7WK+ZvP/SCcFm7Iwb9iiYSap9rlrdhToNAWdxg=="
     },
     "is-promise": {
       "version": "4.0.0",

package/src/utils/live-tunnel.mjs

@@ -3,6 +3,7 @@ import process from 'process'
 
 import fetch from 'node-fetch'
 import pWaitFor from 'p-wait-for'
+import { v4 as uuidv4 } from 'uuid'
 
 import { fetchLatestVersion, shouldFetchLatestVersion } from '../lib/exec-fetcher.mjs'
 import { getPathInHome } from '../lib/settings.mjs'
@@ -12,13 +13,14 @@ import execa from './execa.mjs'
 
 const PACKAGE_NAME = 'live-tunnel-client'
 const EXEC_NAME = PACKAGE_NAME
+const SLUG_LOCAL_STATE_KEY = 'liveTunnelSlug'
 
 // 1 second
 const TUNNEL_POLL_INTERVAL = 1e3
 // 5 minutes
 const TUNNEL_POLL_TIMEOUT = 3e5
 
-const createTunnel = async function ({ netlifyApiToken, siteId }) {
+const createTunnel = async function ({ netlifyApiToken, siteId, slug }) {
   await installTunnelClient()
 
   if (!siteId) {
@@ -29,9 +31,8 @@ const createTunnel = async function ({ netlifyApiToken, siteId }) {
     )
     process.exit(1)
   }
-  log(`${NETLIFYDEVLOG} Creating Live Tunnel for ${siteId}`)
-  const url = `https://api.netlify.com/api/v1/live_sessions?site_id=${siteId}`
 
+  const url = `https://api.netlify.com/api/v1/live_sessions?site_id=${siteId}&slug=${slug}`
   const response = await fetch(url, {
     method: 'POST',
     headers: {
@@ -87,10 +88,11 @@ const installTunnelClient = async function () {
   })
 }
 
-export const startLiveTunnel = async ({ localPort, netlifyApiToken, siteId }) => {
+export const startLiveTunnel = async ({ localPort, netlifyApiToken, siteId, slug }) => {
   const session = await createTunnel({
     siteId,
     netlifyApiToken,
+    slug,
   })
 
   const isLiveTunnelReady = async function () {
@@ -121,3 +123,27 @@ export const startLiveTunnel = async ({ localPort, netlifyApiToken, siteId }) =>
 
   return session.session_url
 }
+
+export const getLiveTunnelSlug = (state, override) => {
+  if (override !== undefined) {
+    return override
+  }
+
+  const newSlug = generateRandomSlug()
+
+  try {
+    const existingSlug = state.get(SLUG_LOCAL_STATE_KEY)
+
+    if (existingSlug !== undefined) {
+      return existingSlug
+    }
+
+    state.set(SLUG_LOCAL_STATE_KEY, newSlug)
+  } catch (error) {
+    log(`${NETLIFYDEVERR} Could not read or write local state file: ${error.message}`)
+  }
+
+  return newSlug
+}
+
+const generateRandomSlug = () => uuidv4().slice(0, 8)