netlify-cli 15.3.2 → 15.4.0

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "netlify-cli",
-  "version": "15.3.2",
+  "version": "15.4.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "15.3.2",
+      "version": "15.4.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "15.3.2",
+  "version": "15.4.0",
   "author": "Netlify Inc.",
   "type": "module",
   "engines": {

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/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)