netlify-cli 15.9.1 → 15.10.0-rc.0

package/src/commands/link/link.mjs

@@ -11,11 +11,11 @@ import { track } from '../../utils/telemetry/index.mjs'
 
 /**
  *
- * @param {import('../base-command.mjs').NetlifyOptions} netlify
+ * @param {import('../base-command.mjs').default} command
  * @param {import('commander').OptionValues} options
  */
-const linkPrompt = async (netlify, options) => {
-  const { api, state } = netlify
+const linkPrompt = async (command, options) => {
+  const { api, state } = command.netlify
 
   const SITE_NAME_PROMPT = 'Search by full or partial site name'
   const SITE_LIST_PROMPT = 'Choose from a list of your recently updated sites'
@@ -24,7 +24,7 @@ const linkPrompt = async (netlify, options) => {
   let GIT_REMOTE_PROMPT = 'Use the current git remote origin URL'
   let site
   // Get git remote data if exists
-  const repoData = await getRepoData({ remoteName: options.gitRemoteName })
+  const repoData = await getRepoData({ workingDir: command.workingDir, remoteName: options.gitRemoteName })
 
   let linkChoices = [SITE_NAME_PROMPT, SITE_LIST_PROMPT, SITE_ID_PROMPT]
 
@@ -326,7 +326,7 @@ export const link = async (options, command) => {
       kind: 'byName',
     })
   } else {
-    siteData = await linkPrompt(command.netlify, options)
+    siteData = await linkPrompt(command, options)
   }
   return siteData
 }

package/src/commands/serve/serve.mjs

@@ -38,6 +38,7 @@ const serve = async (options, command) => {
   const devConfig = {
     ...(config.functionsDirectory && { functions: config.functionsDirectory }),
     ...(config.build.publish && { publish: config.build.publish }),
+
     ...config.dev,
     ...options,
     // Override the `framework` value so that we start a static server and not
@@ -69,10 +70,9 @@ const serve = async (options, command) => {
   // Netlify Build are loaded.
   await getInternalFunctionsDir({ base: site.root, ensureExists: true })
 
-  /** @type {Partial<import('../../utils/types').ServerSettings>} */
-  let settings = {}
+  let settings = /** @type {import('../../utils/types.js').ServerSettings} */ ({})
   try {
-    settings = await detectServerSettings(devConfig, options, site.root)
+    settings = await detectServerSettings(devConfig, options, command)
 
     cachedConfig.config = getConfigWithPlugins(cachedConfig.config, settings)
   } catch (error_) {
@@ -87,7 +87,11 @@ const serve = async (options, command) => {
     `${NETLIFYDEVWARN} Changes will not be hot-reloaded, so if you need to rebuild your site you must exit and run 'netlify serve' again`,
   )
 
-  const { configPath: configPathOverride } = await runBuildTimeline({ cachedConfig, options, settings, site })
+  const { configPath: configPathOverride } = await runBuildTimeline({
+    command,
+    settings,
+    options,
+  })
 
   await startFunctionsServer({
     api,
@@ -117,8 +121,7 @@ const serve = async (options, command) => {
 
   // TODO: We should consolidate this with the existing config watcher.
   const getUpdatedConfig = async () => {
-    const cwd = options.cwd || process.cwd()
-    const { config: newConfig } = await command.getConfig({ cwd, offline: true, state })
+    const { config: newConfig } = await command.getConfig({ cwd: command.workingDir, offline: true, state })
     const normalizedNewConfig = normalizeConfig(newConfig)
 
     return normalizedNewConfig
@@ -135,6 +138,7 @@ const serve = async (options, command) => {
     getUpdatedConfig,
     inspectSettings,
     offline: options.offline,
+    projectDir: command.workingDir,
     settings,
     site,
     siteInfo,

package/src/commands/sites/sites-create-template.mjs

@@ -197,7 +197,7 @@ const sitesCreateTemplate = async (repository, options, command) => {
 
   if (options.withCi) {
     log('Configuring CI')
-    const repoData = await getRepoData()
+    const repoData = await getRepoData({ workingDir: command.workingDir })
     await configureRepo({ command, siteId: site.id, repoData, manual: options.manual })
   }
 

package/src/commands/sites/sites-create.mjs

@@ -102,7 +102,7 @@ export const sitesCreate = async (options, command) => {
 
   if (options.withCi) {
     log('Configuring CI')
-    const repoData = await getRepoData()
+    const repoData = await getRepoData({ workingDir: command.workingDir })
     await configureRepo({ command, siteId: site.id, repoData, manual: options.manual })
   }
 

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

@@ -26,9 +26,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "14.18.53",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.53.tgz",
-      "integrity": "sha512-soGmOpVBUq+gaBMwom1M+krC/NNbWlosh4AtGA03SyWNDiqSKtwp7OulO1M6+mg8YkHMvJ/y0AkCeO8d1hNb7A=="
+      "version": "14.18.54",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.54.tgz",
+      "integrity": "sha512-uq7O52wvo2Lggsx1x21tKZgqkJpvwCseBBPtX/nKQfpVlEsLOb11zZ1CRsWUKvJF0+lzuA9jwvA7Pr2Wt7i3xw=="
     },
     "node_modules/is-promise": {
       "version": "4.0.0",
@@ -58,9 +58,9 @@
       }
     },
     "@types/node": {
-      "version": "14.18.53",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.53.tgz",
-      "integrity": "sha512-soGmOpVBUq+gaBMwom1M+krC/NNbWlosh4AtGA03SyWNDiqSKtwp7OulO1M6+mg8YkHMvJ/y0AkCeO8d1hNb7A=="
+      "version": "14.18.54",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.18.54.tgz",
+      "integrity": "sha512-uq7O52wvo2Lggsx1x21tKZgqkJpvwCseBBPtX/nKQfpVlEsLOb11zZ1CRsWUKvJF0+lzuA9jwvA7Pr2Wt7i3xw=="
     },
     "is-promise": {
       "version": "4.0.0",

package/src/lib/edge-functions/bootstrap.mjs

@@ -1,5 +1,5 @@
 import { env } from 'process'
 
-const latestBootstrapURL = 'https://6494585a67d46e0008867e60--edge.netlify.com/bootstrap/index-combined.ts'
+const latestBootstrapURL = 'https://64c264287e9cbb0008621df3--edge.netlify.com/bootstrap/index-combined.ts'
 
 export const getBootstrapURL = () => env.NETLIFY_EDGE_BOOTSTRAP || latestBootstrapURL

package/src/lib/edge-functions/headers.mjs

@@ -2,6 +2,7 @@
 import { Buffer } from 'buffer'
 
 export const headers = {
+  DeployID: 'x-nf-deploy-id',
   FeatureFlags: 'x-nf-feature-flags',
   ForwardedHost: 'x-forwarded-host',
   Functions: 'x-nf-edge-functions',

package/src/lib/edge-functions/internal.mjs

@@ -1,14 +1,16 @@
 // @ts-check
 import { readFile, stat } from 'fs/promises'
 import { dirname, join, resolve } from 'path'
-import { cwd } from 'process'
 
 import { getPathInProject } from '../settings.mjs'
 
 import { INTERNAL_EDGE_FUNCTIONS_FOLDER } from './consts.mjs'
 
-export const getInternalFunctions = async () => {
-  const path = join(cwd(), getPathInProject([INTERNAL_EDGE_FUNCTIONS_FOLDER]))
+/**
+ * @param {string} workingDir
+ */
+export const getInternalFunctions = async (workingDir) => {
+  const path = join(workingDir, getPathInProject([INTERNAL_EDGE_FUNCTIONS_FOLDER]))
 
   try {
     const stats = await stat(path)

package/src/lib/edge-functions/proxy.mjs

@@ -1,7 +1,7 @@
 // @ts-check
 import { Buffer } from 'buffer'
 import { relative } from 'path'
-import { cwd, env } from 'process'
+import { env } from 'process'
 
 // eslint-disable-next-line import/no-namespace
 import * as bundler from '@netlify/edge-bundler'
@@ -62,6 +62,26 @@ export const createAccountInfoHeader = (accountInfo = {}) => {
   return Buffer.from(accountString).toString('base64')
 }
 
+/**
+ *
+ * @param {object} config
+ * @param {*} config.accountId
+ * @param {*} config.config
+ * @param {*} config.configPath
+ * @param {*} config.debug
+ * @param {*} config.env
+ * @param {*} config.geoCountry
+ * @param {*} config.geolocationMode
+ * @param {*} config.getUpdatedConfig
+ * @param {*} config.inspectSettings
+ * @param {*} config.mainPort
+ * @param {boolean=} config.offline
+ * @param {*} config.passthroughPort
+ * @param {*} config.projectDir
+ * @param {*} config.siteInfo
+ * @param {*} config.state
+ * @returns
+ */
 export const initializeProxy = async ({
   accountId,
   config,
@@ -79,7 +99,11 @@ export const initializeProxy = async ({
   siteInfo,
   state,
 }) => {
-  const { functions: internalFunctions, importMap, path: internalFunctionsPath } = await getInternalFunctions()
+  const {
+    functions: internalFunctions,
+    importMap,
+    path: internalFunctionsPath,
+  } = await getInternalFunctions(projectDir)
   const userFunctionsPath = config.build.edge_functions
   const isolatePort = await getAvailablePort()
 
@@ -114,7 +138,8 @@ export const initializeProxy = async ({
     if (!registry) return
 
     // Setting header with geolocation and site info.
-    req.headers[headers.Geo] = JSON.stringify(geoLocation)
+    req.headers[headers.Geo] = Buffer.from(JSON.stringify(geoLocation)).toString('base64')
+    req.headers[headers.DeployID] = '0'
     req.headers[headers.Site] = createSiteInfoHeader(siteInfo)
     req.headers[headers.Account] = createAccountInfoHeader({ id: accountId })
 
@@ -132,7 +157,7 @@ export const initializeProxy = async ({
         )} matches declaration for edge function ${chalk.yellow(
           functionName,
         )}, but there's no matching function file in ${chalk.yellow(
-          relative(cwd(), userFunctionsPath),
+          relative(projectDir, userFunctionsPath),
         )}. Please visit ${chalk.blue('https://ntl.fyi/edge-create')} for more information.`,
       )
     })

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

@@ -3,7 +3,7 @@ import { dirname } from 'path'
 import { pathToFileURL } from 'url'
 import { Worker } from 'worker_threads'
 
-import lambdaLocal from '@skn0tt/lambda-local'
+import lambdaLocal from 'lambda-local'
 import winston from 'winston'
 
 import detectNetlifyLambdaBuilder from './builders/netlify-lambda.mjs'

package/src/lib/functions/runtimes/js/worker.mjs

@@ -1,8 +1,8 @@
 import { createServer } from 'net'
 import { isMainThread, workerData, parentPort } from 'worker_threads'
 
-import lambdaLocal from '@skn0tt/lambda-local'
 import { isStream } from 'is-stream'
+import lambdaLocal from 'lambda-local'
 import sourceMapSupport from 'source-map-support'
 
 if (isMainThread) {

package/src/lib/functions/server.mjs

@@ -1,4 +1,6 @@
 // @ts-check
+import { Buffer } from 'buffer'
+
 import express from 'express'
 import expressLogging from 'express-logging'
 import jwtDecode from 'jwt-decode'
@@ -47,7 +49,6 @@ const hasBody = (req) =>
   // eslint-disable-next-line unicorn/prefer-number-properties
   (req.header('transfer-encoding') !== undefined || !isNaN(req.header('content-length'))) &&
   // we expect a string or a buffer, because we use the two bodyParsers(text, raw) from express
-  // eslint-disable-next-line n/prefer-global/buffer
   (typeof req.body === 'string' || Buffer.isBuffer(req.body))
 
 export const createHandler = function (options) {
@@ -114,7 +115,7 @@ export const createHandler = function (options) {
       'client-ip': [remoteAddress],
       'x-nf-client-connection-ip': [remoteAddress],
       'x-nf-account-id': [options.accountId],
-      [efHeaders.Geo]: JSON.stringify(geoLocation),
+      [efHeaders.Geo]: Buffer.from(JSON.stringify(geoLocation)).toString('base64'),
     }).reduce((prev, [key, value]) => ({ ...prev, [key]: Array.isArray(value) ? value : [value] }), {})
     const rawQuery = new URLSearchParams(requestQuery).toString()
     const protocol = options.config?.dev?.https ? 'https' : 'http'

package/src/lib/spinner.mjs

@@ -17,7 +17,7 @@ export const startSpinner = ({ text }) =>
  * Stops the spinner with the following text
  * @param {object} config
  * @param {ora.Ora} config.spinner
- * @param {object} [config.error]
+ * @param {boolean} [config.error]
  * @param {string} [config.text]
  * @returns {void}
  */

package/src/recipes/vscode/index.mjs

@@ -1,3 +1,4 @@
+// @ts-check
 import { join } from 'path'
 
 import { DenoBridge } from '@netlify/edge-bundler'
@@ -27,15 +28,24 @@ const getPrompt = ({ fileExists, path }) => {
 const getEdgeFunctionsPath = ({ config, repositoryRoot }) =>
   config.build.edge_functions || join(repositoryRoot, 'netlify', 'edge-functions')
 
+/**
+ * @param {string} repositoryRoot
+ */
 const getSettingsPath = (repositoryRoot) => join(repositoryRoot, '.vscode', 'settings.json')
 
-const hasDenoVSCodeExt = async () => {
-  const { stdout: extensions } = await execa('code', ['--list-extensions'], { stderr: 'inherit' })
+/**
+ * @param {string} repositoryRoot
+ */
+const hasDenoVSCodeExt = async (repositoryRoot) => {
+  const { stdout: extensions } = await execa('code', ['--list-extensions'], { stderr: 'inherit', cwd: repositoryRoot })
   return extensions.split('\n').includes('denoland.vscode-deno')
 }
 
-const getDenoVSCodeExt = async () => {
-  await execa('code', ['--install-extension', 'denoland.vscode-deno'], { stdio: 'inherit' })
+/**
+ * @param {string} repositoryRoot
+ */
+const getDenoVSCodeExt = async (repositoryRoot) => {
+  await execa('code', ['--install-extension', 'denoland.vscode-deno'], { stdio: 'inherit', cwd: repositoryRoot })
 }
 
 const getDenoExtPrompt = () => {
@@ -49,6 +59,12 @@ const getDenoExtPrompt = () => {
   })
 }
 
+/**
+ * @param {object} params
+ * @param {*} params.config
+ * @param {string} params.repositoryRoot
+ * @returns
+ */
 export const run = async ({ config, repositoryRoot }) => {
   const deno = new DenoBridge({
     onBeforeDownload: () =>
@@ -66,9 +82,11 @@ export const run = async ({ config, repositoryRoot }) => {
   }
 
   try {
-    if (!(await hasDenoVSCodeExt())) {
+    if (!(await hasDenoVSCodeExt(repositoryRoot))) {
       const { confirm: denoExtConfirm } = await getDenoExtPrompt()
-      if (denoExtConfirm) getDenoVSCodeExt()
+      if (denoExtConfirm) {
+        getDenoVSCodeExt(repositoryRoot)
+      }
     }
   } catch {
     log(

package/src/utils/build-info.mjs

@@ -0,0 +1,100 @@
+// @ts-check
+
+import fuzzy from 'fuzzy'
+import inquirer from 'inquirer'
+
+import { chalk, log } from './command-helpers.mjs'
+
+/**
+ * Filters the inquirer settings based on the input
+ * @param {ReturnType<typeof formatSettingsArrForInquirer>} scriptInquirerOptions
+ * @param {string} input
+ */
+const filterSettings = function (scriptInquirerOptions, input) {
+  const filterOptions = scriptInquirerOptions.map((scriptInquirerOption) => scriptInquirerOption.name)
+  // TODO: remove once https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1394 is fixed
+  // eslint-disable-next-line unicorn/no-array-method-this-argument
+  const filteredSettings = fuzzy.filter(input, filterOptions)
+  const filteredSettingNames = new Set(
+    filteredSettings.map((filteredSetting) => (input ? filteredSetting.string : filteredSetting)),
+  )
+  return scriptInquirerOptions.filter((t) => filteredSettingNames.has(t.name))
+}
+
+/** @typedef {import('@netlify/build-info').Settings} Settings */
+
+/**
+ * @param {Settings[]} settings
+ * @param {'dev' | 'build'} type The type of command (dev or build)
+ */
+const formatSettingsArrForInquirer = function (settings, type = 'dev') {
+  return settings.map((setting) => {
+    const cmd = type === 'dev' ? setting.devCommand : setting.buildCommand
+    return {
+      name: `[${chalk.yellow(setting.framework.name)}] '${cmd}'`,
+      value: { ...setting, commands: [cmd] },
+      short: `${setting.name}-${cmd}`,
+    }
+  })
+}
+
+/**
+ * Uses @netlify/build-info to detect the dev settings and port based on the framework
+ * and the build system that is used.
+ * @param {import('../commands/base-command.mjs').default} command
+ * @param {'dev' | 'build'} type The type of command (dev or build)
+ * @returns {Promise<Settings | undefined>}
+ */
+export const detectFrameworkSettings = async (command, type = 'dev') => {
+  const { relConfigFilePath } = command.netlify
+  const settings = await detectBuildSettings(command)
+  if (settings.length === 1) {
+    return settings[0]
+  }
+
+  if (settings.length > 1) {
+    /** multiple matching detectors, make the user choose */
+    const scriptInquirerOptions = formatSettingsArrForInquirer(settings, type)
+    /** @type {{chosenSettings: Settings}} */
+    const { chosenSettings } = await inquirer.prompt({
+      name: 'chosenSettings',
+      message: `Multiple possible ${type} commands found`,
+      type: 'autocomplete',
+      source(/** @type {string} */ _, input = '') {
+        if (!input) return scriptInquirerOptions
+        // only show filtered results
+        return filterSettings(scriptInquirerOptions, input)
+      },
+    })
+
+    log(`
+Update your ${relConfigFilePath} to avoid this selection prompt next time:
+
+[build]
+command = "${chosenSettings.buildCommand}"
+publish = "${chosenSettings.dist}"
+
+[dev]
+command = "${chosenSettings.devCommand}"
+`)
+    return chosenSettings
+  }
+}
+
+/**
+ * Detects and filters the build setting for a project and a command
+ * @param {import('../commands/base-command.mjs').default} command
+ */
+export const detectBuildSettings = async (command) => {
+  const { project, workspacePackage } = command
+  const buildSettings = await project.getBuildSettings(project.workspace ? workspacePackage : '')
+  return buildSettings
+    .filter((setting) => {
+      if (project.workspace && project.relativeBaseDirectory && setting.packagePath) {
+        return project.relativeBaseDirectory.startsWith(setting.packagePath)
+      }
+
+      return true
+    })
+    .filter((setting) => setting.devCommand)
+}

package/src/utils/command-helpers.mjs

@@ -24,7 +24,7 @@ const argv = process.argv.slice(2)
  * Chalk instance for CLI that can be initialized with no colors mode
  * needed for json outputs where we don't want to have colors
  * @param  {boolean} noColors - disable chalk colors
- * @return {object} - default or custom chalk instance
+ * @return {import('chalk').ChalkInstance} - default or custom chalk instance
  */
 const safeChalk = function (noColors) {
   if (noColors) {
@@ -174,12 +174,18 @@ export const warn = (message = '') => {
 
 /**
  * throws an error or log it
- * @param {string|Error} message
+ * @param {unknown} message
  * @param {object} [options]
  * @param {boolean} [options.exit]
  */
 export const error = (message = '', options = {}) => {
-  const err = message instanceof Error ? message : new Error(message)
+  const err =
+    message instanceof Error
+      ? message
+      : // eslint-disable-next-line unicorn/no-nested-ternary
+      typeof message === 'string'
+      ? new Error(message)
+      : /** @type {Error} */ ({ message, stack: undefined, name: 'Error' })
 
   if (options.exit === false) {
     const bang = chalk.red(BANG)
@@ -198,10 +204,13 @@ export const exit = (code = 0) => {
   process.exit(code)
 }
 
-// When `build.publish` is not set by the user, the CLI behavior differs in
-// several ways. It detects it by checking if `build.publish` is `undefined`.
-// However, `@netlify/config` adds a default value to `build.publish`.
-// This removes 'publish' and 'publishOrigin' in this case.
+/**
+ * When `build.publish` is not set by the user, the CLI behavior differs in
+ * several ways. It detects it by checking if `build.publish` is `undefined`.
+ * However, `@netlify/config` adds a default value to `build.publish`.
+ * This removes 'publish' and 'publishOrigin' in this case.
+ * @param {*} config
+ */
 export const normalizeConfig = (config) => {
   // Unused var here is in order to omit 'publish' from build config
   // eslint-disable-next-line no-unused-vars