netlify-cli 16.9.2 → 17.0.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "16.9.2",
+  "version": "17.0.0",
   "author": "Netlify Inc.",
   "type": "module",
   "engines": {
-    "node": ">=16.16.0"
+    "node": ">=18.18.2"
   },
   "files": [
     "/bin",
@@ -44,13 +44,12 @@
   "dependencies": {
     "@bugsnag/js": "7.20.2",
     "@fastify/static": "6.10.2",
+    "@netlify/blobs": "^4.0.0",
     "@netlify/build": "29.23.4",
     "@netlify/build-info": "7.10.1",
     "@netlify/config": "20.9.0",
     "@netlify/edge-bundler": "9.4.1",
     "@netlify/local-functions-proxy": "1.1.1",
-    "@netlify/sdk": "^1.1.5",
-    "@netlify/serverless-functions-api": "1.10.0",
     "@netlify/zip-it-and-ship-it": "9.25.4",
     "@octokit/rest": "19.0.13",
     "ansi-escapes": "6.2.0",
@@ -149,7 +148,7 @@
     "update-notifier": "6.0.2",
     "uuid": "9.0.0",
     "wait-port": "1.0.4",
-    "winston": "3.8.2",
-    "write-file-atomic": "5.0.1"
+    "write-file-atomic": "5.0.1",
+    "zod": "^3.22.4"
   }
 }

package/src/commands/build/build.mjs

@@ -74,7 +74,7 @@ const build = async (options, command) => {
 export const createBuildCommand = (program) =>
   program
     .command('build')
-    .description('(Beta) Build on your local machine')
+    .description('Build on your local machine')
     .option(
       '--context <context>',
       'Specify a build context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")',

package/src/commands/completion/completion.mjs

@@ -50,7 +50,7 @@ export const createCompletionCommand = (program) => {
 
   return program
     .command('completion')
-    .description('(Beta) Generate shell completion script\nRun this command to see instructions for your shell.')
+    .description('Generate shell completion script\nRun this command to see instructions for your shell.')
     .addExamples(['netlify completion:install'])
     .action((options, command) => {
       command.help()

package/src/commands/dev/dev.mjs

@@ -3,6 +3,7 @@ import process from 'process'
 
 import { Option } from 'commander'
 
+import { getBlobsContext } from '../../lib/blobs/blobs.mjs'
 import { promptEditorHelper } from '../../lib/edge-functions/editor-helper.mjs'
 import { startFunctionsServer } from '../../lib/functions/server.mjs'
 import { printBanner } from '../../utils/banner.mjs'
@@ -161,8 +162,15 @@ const dev = async (options, command) => {
     },
   })
 
+  const blobsContext = await getBlobsContext({
+    debug: options.debug,
+    projectRoot: command.workingDir,
+    siteID: site.id ?? 'unknown-site-id',
+  })
+
   const functionsRegistry = await startFunctionsServer({
     api,
+    blobsContext,
     command,
     config,
     debug: options.debug,
@@ -202,6 +210,7 @@ const dev = async (options, command) => {
 
   await startProxyServer({
     addonsUrls,
+    blobsContext,
     config,
     configPath: configPathOverride,
     debug: options.debug,

package/src/commands/integration/deploy.mjs

@@ -1,14 +1,11 @@
-/* eslint-disable import/extensions */
+import fs from 'fs'
 import { resolve } from 'path'
 import { exit, env } from 'process'
 
-// eslint-disable-next-line n/no-missing-import
-import { getConfiguration } from '@netlify/sdk/cli-utils'
-// eslint-disable-next-line n/no-unpublished-import
-import fs from 'fs-extra'
 import inquirer from 'inquirer'
 import yaml from 'js-yaml'
 import fetch from 'node-fetch'
+import { z } from 'zod'
 
 import { getBuildOptions } from '../../lib/build.mjs'
 import { getToken, chalk, log } from '../../utils/command-helpers.mjs'
@@ -176,7 +173,7 @@ export async function registerIntegration(workingDir, siteId, accountId, localIn
   })
 
   const filePath = resolve(workingDir, 'integration.yaml')
-  await fs.writeFile(filePath, updatedIntegrationConfig)
+  await fs.promises.writeFile(filePath, updatedIntegrationConfig)
 
   log(chalk.yellow('Your integration.yaml file has been updated. Please commit and push these changes.'))
 }
@@ -304,12 +301,66 @@ export async function updateIntegration(
     })
 
     const filePath = resolve(workingDir, 'integration.yaml')
-    await fs.writeFile(filePath, updatedIntegrationConfig)
+    await fs.promises.writeFile(filePath, updatedIntegrationConfig)
 
     log(chalk.yellow('Changes to the integration.yaml file are complete. Please commit and push these changes.'))
   }
 }
 
+const possibleFiles = ['integration.yaml', 'integration.yml', 'integration.netlify.yaml', 'integration.netlify.yml']
+const IntegrationConfigurationSchema = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  slug: z.string().regex(/^[a-z\d-]+$/, 'slug must be lowercase with dashes'),
+  scopes: z
+    .object({
+      all: z.boolean().optional(),
+      site: z.array(z.enum(['read', 'write'])).optional(),
+      env: z.array(z.enum(['read', 'write', 'delete'])).optional(),
+      user: z.array(z.enum(['read', 'write'])).optional(),
+    })
+    .optional(),
+  integrationLevel: z.enum(['site', 'team', 'team-and-site']).optional(),
+})
+
+const getConfigurationFile = (workingDir) => {
+  const pwd = workingDir
+
+  const fileName = possibleFiles.find((configFileName) => fs.existsSync(resolve(pwd, configFileName)))
+
+  return fileName
+}
+
+export const getConfiguration = (workingDir) => {
+  const pwd = workingDir
+
+  const fileName = getConfigurationFile(workingDir)
+
+  if (!fileName) {
+    throw new Error('No configuration file found')
+  }
+
+  try {
+    const { config } = yaml.load(fs.readFileSync(resolve(pwd, fileName), 'utf-8'))
+
+    if (!config) {
+      throw new Error('No configuration found')
+    }
+
+    const parseResult = IntegrationConfigurationSchema.safeParse(config)
+
+    if (!parseResult.success) {
+      console.error(parseResult.error.message)
+      throw new Error('Invalid Configuration')
+    }
+
+    return config
+  } catch (error) {
+    console.error(error)
+    console.error(`No configuration found in ${fileName} in ${pwd}`)
+    exit(1)
+  }
+}
 /**
  * The deploy command for Netlify Integrations
  * @param {import('commander').OptionValues} options
@@ -330,7 +381,7 @@ const deploy = async (options, command) => {
   // Confirm that a site is linked and that the user is logged in
   checkOptions(buildOptions)
 
-  const { description, integrationLevel, name, scopes, slug } = await getConfiguration()
+  const { description, integrationLevel, name, scopes, slug } = await getConfiguration(command.workingDir)
   const localIntegrationConfig = { name, description, scopes, slug, integrationLevel }
 
   const { accountId } = await getSiteInformation({
@@ -394,4 +445,3 @@ export const createDeployCommand = (program) =>
     .option('-a, --auth <token>', 'Netlify auth token to deploy with', env.NETLIFY_AUTH_TOKEN)
     .option('-s, --site <name-or-id>', 'A site name or ID to deploy to', env.NETLIFY_SITE_ID)
     .action(deploy)
-/* eslint-enable import/extensions */

package/src/commands/recipes/recipes-list.mjs

@@ -27,6 +27,6 @@ const recipesListCommand = async () => {
 export const createRecipesListCommand = (program) =>
   program
     .command('recipes:list')
-    .description(`(Beta) List the recipes available to create and modify files in a project`)
+    .description(`List the recipes available to create and modify files in a project`)
     .addExamples(['netlify recipes:list'])
     .action(recipesListCommand)

package/src/commands/recipes/recipes.mjs

@@ -81,7 +81,7 @@ export const createRecipesCommand = (program) => {
   program
     .command('recipes')
     .argument('[name]', 'name of the recipe')
-    .description(`(Beta) Create and modify files in a project using pre-defined recipes`)
+    .description(`Create and modify files in a project using pre-defined recipes`)
     .option('-n, --name <name>', 'recipe name to use')
     .addExamples(['netlify recipes my-recipe', 'netlify recipes --name my-recipe'])
     .action(recipesCommand)

package/src/commands/serve/serve.mjs

@@ -167,7 +167,7 @@ export const createServeCommand = (program) =>
   program
     .command('serve')
     .description(
-      '(Beta) Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run `serve` again.',
+      'Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run `serve` again.',
     )
     .option(
       '--context <context>',

package/src/lib/blobs/blobs.mjs

@@ -0,0 +1,50 @@
+import path from 'path'
+
+import { BlobsServer } from '@netlify/blobs'
+import { v4 as uuidv4 } from 'uuid'
+
+import { getPathInProject } from '../settings.mjs'
+
+/**
+ * @typedef BlobsContext
+ * @type {object}
+ * @property {string} edgeURL
+ * @property {string} deployID
+ * @property {string} siteID
+ * @property {string} token
+ */
+
+/**
+ * Starts a local Blobs server and returns a context object that lets functions
+ * connect to it.
+ *
+ * @param {object} options
+ * @param {boolean} options.debug
+ * @param {string} options.projectRoot
+ * @param {string} options.siteID
+ * @returns {Promise<BlobsContext>}
+ */
+export const getBlobsContext = async ({ debug, projectRoot, siteID }) => {
+  const token = uuidv4()
+  const { port } = await startBlobsServer({ debug, projectRoot, token })
+  const context = {
+    deployID: '0',
+    edgeURL: `http://localhost:${port}`,
+    siteID,
+    token,
+  }
+
+  return context
+}
+
+const startBlobsServer = async ({ debug, projectRoot, token }) => {
+  const directory = path.resolve(projectRoot, getPathInProject(['blobs']))
+  const server = new BlobsServer({
+    debug,
+    directory,
+    token,
+  })
+  const { port } = await server.start()
+
+  return { port }
+}

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

@@ -1,5 +1,5 @@
 import { env } from 'process'
 
-const latestBootstrapURL = 'https://650bfd807b21ed000893e25c--edge.netlify.com/bootstrap/index-combined.ts'
+const latestBootstrapURL = 'https://6539213a19a93a000876a033--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 = {
+  BlobsInfo: 'x-nf-blobs-info',
   DeployID: 'x-nf-deploy-id',
   FeatureFlags: 'x-nf-feature-flags',
   ForwardedHost: 'x-forwarded-host',

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

@@ -66,6 +66,7 @@ export const createAccountInfoHeader = (accountInfo = {}) => {
  *
  * @param {object} config
  * @param {*} config.accountId
+ * @param {import("../blobs/blobs.mjs").BlobsContext} config.blobsContext
  * @param {*} config.config
  * @param {*} config.configPath
  * @param {*} config.debug
@@ -85,6 +86,7 @@ export const createAccountInfoHeader = (accountInfo = {}) => {
  */
 export const initializeProxy = async ({
   accountId,
+  blobsContext,
   config,
   configPath,
   debug,
@@ -151,6 +153,12 @@ export const initializeProxy = async ({
     req.headers[headers.Site] = createSiteInfoHeader(siteInfo)
     req.headers[headers.Account] = createAccountInfoHeader({ id: accountId })
 
+    if (blobsContext?.edgeURL && blobsContext?.token) {
+      req.headers[headers.BlobsInfo] = Buffer.from(
+        JSON.stringify({ url: blobsContext.edgeURL, token: blobsContext.token }),
+      ).toString('base64')
+    }
+
     await registry.initialize()
 
     const url = new URL(req.url, `http://${LOCAL_HOST}:${mainPort}`)

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

@@ -1,4 +1,5 @@
 // @ts-check
+import { Buffer } from 'buffer'
 import { basename, extname } from 'path'
 import { version as nodeVersion } from 'process'
 
@@ -23,6 +24,7 @@ const getNextRun = function (schedule) {
 
 export default class NetlifyFunction {
   constructor({
+    blobsContext,
     config,
     directory,
     displayName,
@@ -34,6 +36,7 @@ export default class NetlifyFunction {
     timeoutBackground,
     timeoutSynchronous,
   }) {
+    this.blobsContext = blobsContext
     this.buildError = null
     this.config = config
     this.directory = directory
@@ -181,7 +184,7 @@ export default class NetlifyFunction {
   }
 
   // Invokes the function and returns its response object.
-  async invoke(event, context) {
+  async invoke(event, context = {}) {
     await this.buildQueue
 
     if (this.buildError) {
@@ -189,10 +192,24 @@ export default class NetlifyFunction {
     }
 
     const timeout = this.isBackground ? this.timeoutBackground : this.timeoutSynchronous
+    const environment = {}
+
+    if (this.blobsContext) {
+      const payload = JSON.stringify({
+        url: this.blobsContext.edgeURL,
+        token: this.blobsContext.token,
+      })
+
+      context.custom = {
+        ...context?.custom,
+        blobs: Buffer.from(payload).toString('base64'),
+      }
+    }
 
     try {
       const result = await this.runtime.invokeFunction({
         context,
+        environment,
         event,
         func: this,
         timeout,

package/src/lib/functions/registry.mjs

@@ -34,6 +34,7 @@ const ZIP_EXTENSION = '.zip'
 
 export class FunctionsRegistry {
   constructor({
+    blobsContext,
     capabilities,
     config,
     debug = false,
@@ -52,6 +53,13 @@ export class FunctionsRegistry {
     this.timeouts = timeouts
     this.settings = settings
 
+    /**
+     * Context object for Netlify Blobs
+     *
+     * @type {import("../blobs/blobs.mjs").BlobsContext}
+     */
+    this.blobsContext = blobsContext
+
     /**
      * An object to be shared among all functions in the registry. It can be
      * used to cache the results of the build function — e.g. it's used in
@@ -493,6 +501,7 @@ export class FunctionsRegistry {
         }
 
         const func = new NetlifyFunction({
+          blobsContext: this.blobsContext,
           config: this.config,
           directory: directories.find((directory) => mainFile.startsWith(directory)),
           mainFile,

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

@@ -51,13 +51,14 @@ export const getBuildFunction = async ({ config, directory, errorExit, func, pro
 
 const workerURL = new URL('worker.mjs', import.meta.url)
 
-export const invokeFunction = async ({ context, event, func, timeout }) => {
+export const invokeFunction = async ({ context, environment, event, func, timeout }) => {
   if (func.buildData.runtimeAPIVersion !== 2) {
     return await invokeFunctionDirectly({ context, event, func, timeout })
   }
 
   const workerData = {
     clientContext: JSON.stringify(context),
+    environment,
     event,
     // If a function builder has defined a `buildPath` property, we use it.
     // Otherwise, we'll invoke the function's main file.

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

@@ -1,4 +1,5 @@
 import { createServer } from 'net'
+import process from 'process'
 import { isMainThread, workerData, parentPort } from 'worker_threads'
 
 import { isStream } from 'is-stream'
@@ -13,7 +14,12 @@ sourceMapSupport.install()
 
 lambdaLocal.getLogger().level = 'alert'
 
-const { clientContext, entryFilePath, event, timeoutMs } = workerData
+const { clientContext, entryFilePath, environment = {}, event, timeoutMs } = workerData
+
+// Injecting into the environment any properties passed in by the parent.
+for (const key in environment) {
+  process.env[key] = environment[key]
+}
 
 const lambdaFunc = await import(entryFilePath)
 

package/src/lib/functions/server.mjs

@@ -137,6 +137,7 @@ export const createHandler = function (options) {
       'client-ip': [remoteAddress],
       'x-nf-client-connection-ip': [remoteAddress],
       'x-nf-account-id': [options.accountId],
+      'x-nf-site-id': [options?.siteInfo?.id],
       [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()
@@ -245,6 +246,7 @@ const getFunctionsServer = (options) => {
 /**
  *
  * @param {object} options
+ * @param {import("../blobs/blobs.mjs").BlobsContext} options.blobsContext
  * @param {import('../../commands/base-command.mjs').default} options.command
  * @param {*} options.capabilities
  * @param {*} options.config
@@ -258,8 +260,19 @@ const getFunctionsServer = (options) => {
  * @returns {Promise<import('./registry.mjs').FunctionsRegistry | undefined>}
  */
 export const startFunctionsServer = async (options) => {
-  const { capabilities, command, config, debug, loadDistFunctions, settings, site, siteInfo, siteUrl, timeouts } =
-    options
+  const {
+    blobsContext,
+    capabilities,
+    command,
+    config,
+    debug,
+    loadDistFunctions,
+    settings,
+    site,
+    siteInfo,
+    siteUrl,
+    timeouts,
+  } = options
   const internalFunctionsDir = await getInternalFunctionsDir({ base: site.root })
   const functionsDirectories = []
   let manifest
@@ -306,6 +319,7 @@ export const startFunctionsServer = async (options) => {
   }
 
   const functionsRegistry = new FunctionsRegistry({
+    blobsContext,
     capabilities,
     config,
     debug,

package/src/utils/deploy/deploy-site.mjs

@@ -28,7 +28,7 @@ export const deploySite = async (
     concurrentHash = DEFAULT_CONCURRENT_HASH,
     concurrentUpload = DEFAULT_CONCURRENT_UPLOAD,
     configPath = null,
-    deployId: deployIdOpt = null,
+    deployId,
     deployTimeout = DEFAULT_DEPLOY_TIMEOUT,
     draft = false,
     filter,
@@ -37,8 +37,6 @@ export const deploySite = async (
     hashAlgorithm,
     manifestPath,
     maxRetry = DEFAULT_MAX_RETRY,
-    // API calls this the 'title'
-    message: title,
     siteEnv,
     siteRoot,
     skipFunctionsCache,
@@ -120,9 +118,9 @@ For more information, visit https://ntl.fyi/cli-native-modules.`)
     phase: 'start',
   })
 
-  let deploy
-  let deployParams = cleanDeep({
+  const deployParams = cleanDeep({
     siteId,
+    deploy_id: deployId,
     body: {
       files,
       functions,
@@ -133,19 +131,11 @@ For more information, visit https://ntl.fyi/cli-native-modules.`)
       draft,
     },
   })
-  if (deployIdOpt === null) {
-    if (title) {
-      deployParams = { ...deployParams, title }
-    }
-    deploy = await api.createSiteDeploy(deployParams)
-  } else {
-    deployParams = { ...deployParams, deploy_id: deployIdOpt }
-    deploy = await api.updateSiteDeploy(deployParams)
-  }
+  let deploy = await api.updateSiteDeploy(deployParams)
 
   if (deployParams.body.async) deploy = await waitForDiff(api, deploy.id, siteId, deployTimeout)
 
-  const { id: deployId, required: requiredFiles, required_functions: requiredFns } = deploy
+  const { required: requiredFiles, required_functions: requiredFns } = deploy
 
   statusCb({
     type: 'create-deploy',

package/src/utils/proxy-server.mjs

@@ -38,6 +38,7 @@ export const generateInspectSettings = (edgeInspect, edgeInspectBrk) => {
  * @param {object} params
  * @param {string=} params.accountId
  * @param {*} params.addonsUrls
+ * @param {import("../lib/blobs/blobs.mjs").BlobsContext} blobsContext
  * @param {import('../commands/types.js').NetlifyOptions["config"]} params.config
  * @param {string} [params.configPath] An override for the Netlify config path
  * @param {boolean} params.debug
@@ -58,6 +59,7 @@ export const generateInspectSettings = (edgeInspect, edgeInspectBrk) => {
 export const startProxyServer = async ({
   accountId,
   addonsUrls,
+  blobsContext,
   config,
   configPath,
   debug,
@@ -76,6 +78,7 @@ export const startProxyServer = async ({
 }) => {
   const url = await startProxy({
     addonsUrls,
+    blobsContext,
     config,
     configPath: configPath || site.configPath,
     debug,

package/src/utils/proxy.mjs

@@ -675,6 +675,7 @@ export const getProxyUrl = function (settings) {
 export const startProxy = async function ({
   accountId,
   addonsUrls,
+  blobsContext,
   config,
   configPath,
   debug,
@@ -693,6 +694,7 @@ export const startProxy = async function ({
   const secondaryServerPort = settings.https ? await getAvailablePort() : null
   const functionsServer = settings.functionsPort ? `http://127.0.0.1:${settings.functionsPort}` : null
   const edgeFunctionsProxy = await initializeEdgeFunctionsProxy({
+    blobsContext,
     config,
     configPath,
     debug,