netlify-cli 9.4.3 → 9.6.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "9.4.3",
+  "version": "9.6.1",
   "author": "Netlify Inc.",
   "contributors": [
     "Abraham Schilling <AbrahamSchilling@gmail.com> (https://gitlab.com/n4bb12)",
@@ -199,12 +199,12 @@
     "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\" \"!site/package-lock.json\" \"!.github/**/*.md\""
   },
   "dependencies": {
-    "@netlify/build": "^26.3.1",
-    "@netlify/config": "^17.0.8",
+    "@netlify/build": "^26.3.2",
+    "@netlify/config": "^17.0.9",
     "@netlify/framework-info": "^9.0.0",
     "@netlify/local-functions-proxy": "^1.1.1",
     "@netlify/plugin-edge-handlers": "^3.0.6",
-    "@netlify/plugins-list": "^6.10.2",
+    "@netlify/plugins-list": "^6.11.0",
     "@netlify/routing-local-proxy": "^0.34.1",
     "@netlify/zip-it-and-ship-it": "^5.7.5",
     "@octokit/rest": "^18.0.0",

package/src/commands/base-command.js

@@ -1,4 +1,5 @@
 // @ts-check
+const events = require('events')
 const process = require('process')
 const { format } = require('util')
 
@@ -28,6 +29,7 @@ const {
   pollForToken,
   sortOptions,
   track,
+  watchDebounced,
 } = require('../utils')
 
 // Netlify CLI client id. Lives in bot@netlify.com
@@ -119,6 +121,11 @@ class BaseCommand extends Command {
           await this.init(actionCommand)
           debug(`${name}:preAction`)('end')
         })
+        .hook('postAction', async () => {
+          if (this.configWatcherHandle) {
+            await this.configWatcherHandle.close()
+          }
+        })
     )
   }
 
@@ -430,6 +437,24 @@ class BaseCommand extends Command {
     const globalConfig = await getGlobalConfig()
     const { NetlifyAPI } = await jsClient
 
+    const configWatcher = new events.EventEmitter()
+
+    // Only set up a watcher if we know the config path.
+    if (configPath) {
+      const configWatcherHandle = await watchDebounced(configPath, {
+        depth: 1,
+        onChange: async () => {
+          const { config: newConfig } = await actionCommand.getConfig({ cwd, state, token, ...apiUrlOpts })
+
+          const normalizedNewConfig = normalizeConfig(newConfig)
+          configWatcher.emit('change', normalizedNewConfig)
+        },
+      })
+
+      // chokidar handler
+      this.configWatcherHandle = configWatcherHandle
+    }
+
     actionCommand.netlify = {
       // api methods
       api: new NetlifyAPI(token || '', apiOpts),
@@ -455,6 +480,8 @@ class BaseCommand extends Command {
       globalConfig,
       // state of current site dir
       state,
+      // netlify.toml file watcher
+      configWatcher,
     }
     debug(`${this.name()}:init`)('end')
   }

package/src/commands/dev/dev.js

@@ -14,6 +14,7 @@ const { startFunctionsServer } = require('../../lib/functions/server')
 const {
   OneGraphCliClient,
   loadCLISession,
+  markCliSessionInactive,
   persistNewOperationsDocForSession,
   startOneGraphCLISession,
 } = require('../../lib/one-graph/cli-client')
@@ -32,6 +33,7 @@ const {
   detectServerSettings,
   error,
   exit,
+  generateNetlifyGraphJWT,
   getSiteInformation,
   injectEnvVariables,
   log,
@@ -78,6 +80,30 @@ const isNonExistingCommandError = ({ command, error: commandError }) => {
   )
 }
 
+/**
+ * @type {(() => Promise<void>)[]} - array of functions to run before the process exits
+ */
+const cleanupWork = []
+
+let cleanupStarted = false
+
+/**
+ * @param {object} input
+ * @param {number=} input.exitCode The exit code to return when exiting the process after cleanup
+ */
+const cleanupBeforeExit = async ({ exitCode }) => {
+  // If cleanup has started, then wherever started it will be responsible for exiting
+  if (!cleanupStarted) {
+    cleanupStarted = true
+    try {
+      // eslint-disable-next-line no-unused-vars
+      const cleanupFinished = await Promise.all(cleanupWork.map((cleanup) => cleanup()))
+    } finally {
+      process.exit(exitCode)
+    }
+  }
+}
+
 /**
  * Run a command and pipe stdout, stderr and stdin
  * @param {string} command
@@ -100,30 +126,29 @@ const runCommand = (command, env = {}) => {
 
   // we can't try->await->catch since we don't want to block on the framework server which
   // is a long running process
-  // eslint-disable-next-line promise/catch-or-return,promise/prefer-await-to-then
-  commandProcess.then(async () => {
-    const result = await commandProcess
-    const [commandWithoutArgs] = command.split(' ')
-    // eslint-disable-next-line promise/always-return
-    if (result.failed && isNonExistingCommandError({ command: commandWithoutArgs, error: result })) {
-      log(
-        NETLIFYDEVERR,
-        `Failed running command: ${command}. Please verify ${chalk.magenta(`'${commandWithoutArgs}'`)} exists`,
-      )
-    } else {
-      const errorMessage = result.failed
-        ? `${NETLIFYDEVERR} ${result.shortMessage}`
-        : `${NETLIFYDEVWARN} "${command}" exited with code ${result.exitCode}`
-
-      log(`${errorMessage}. Shutting down Netlify Dev server`)
-    }
-    process.exit(1)
-  })
-  ;['SIGINT', 'SIGTERM', 'SIGQUIT', 'SIGHUP', 'exit'].forEach((signal) => {
-    process.on(signal, () => {
-      commandProcess.kill('SIGTERM', { forceKillAfterTimeout: 500 })
-      process.exit()
+  // eslint-disable-next-line promise/catch-or-return
+  commandProcess
+    // eslint-disable-next-line promise/prefer-await-to-then
+    .then(async () => {
+      const result = await commandProcess
+      const [commandWithoutArgs] = command.split(' ')
+      if (result.failed && isNonExistingCommandError({ command: commandWithoutArgs, error: result })) {
+        log(
+          NETLIFYDEVERR,
+          `Failed running command: ${command}. Please verify ${chalk.magenta(`'${commandWithoutArgs}'`)} exists`,
+        )
+      } else {
+        const errorMessage = result.failed
+          ? `${NETLIFYDEVERR} ${result.shortMessage}`
+          : `${NETLIFYDEVWARN} "${command}" exited with code ${result.exitCode}`
+
+        log(`${errorMessage}. Shutting down Netlify Dev server`)
+      }
+
+      return await cleanupBeforeExit({ exitCode: 1 })
     })
+  ;['SIGINT', 'SIGTERM', 'SIGQUIT', 'SIGHUP', 'exit'].forEach((signal) => {
+    process.on(signal, async () => await cleanupBeforeExit({}))
   })
 
   return commandProcess
@@ -238,6 +263,44 @@ const printBanner = ({ url }) => {
   )
 }
 
+const startPollingForAPIAuthentication = async function (options) {
+  const { api, command, config, site, siteInfo } = options
+  const frequency = 5000
+
+  const helper = async (maybeSiteData) => {
+    const siteData = await (maybeSiteData || api.getSite({ siteId: site.id }))
+    const authlifyTokenId = siteData && siteData.authlify_token_id
+
+    const existingAuthlifyTokenId = config && config.netlifyGraphConfig && config.netlifyGraphConfig.authlifyTokenId
+    if (authlifyTokenId && authlifyTokenId !== existingAuthlifyTokenId) {
+      const netlifyToken = await command.authenticate()
+      // Only inject the authlify config if a token ID exists. This prevents
+      // calling command.authenticate() (which opens a browser window) if the
+      // user hasn't enabled API Authentication
+      const netlifyGraphConfig = {
+        netlifyToken,
+        authlifyTokenId: siteData.authlify_token_id,
+        siteId: site.id,
+      }
+      config.netlifyGraphConfig = netlifyGraphConfig
+
+      const netlifyGraphJWT = generateNetlifyGraphJWT(netlifyGraphConfig)
+
+      if (netlifyGraphJWT != null) {
+        // XXX(anmonteiro): this name is deprecated. Delete after 3/31/2022
+        process.env.ONEGRAPH_AUTHLIFY_TOKEN = netlifyGraphJWT
+        process.env.NETLIFY_GRAPH_TOKEN = netlifyGraphJWT
+      }
+    } else {
+      delete config.netlifyGraphConfig
+    }
+
+    setTimeout(helper, frequency)
+  }
+
+  await helper(siteInfo)
+}
+
 /**
  * The dev command
  * @param {import('commander').OptionValues} options
@@ -263,7 +326,6 @@ const dev = async (options, command) => {
     )
   }
 
-  const startNetlifyGraphWatcher = Boolean(options.graph)
   await injectEnvVariables({ env: command.netlify.cachedConfig.env, site })
 
   const { addonsUrls, capabilities, siteUrl, timeouts } = await getSiteInformation({
@@ -285,11 +347,15 @@ const dev = async (options, command) => {
 
   command.setAnalyticsPayload({ projectType: settings.framework || 'custom', live: options.live })
 
+  const startNetlifyGraphWatcher = Boolean(options.graph)
+  if (startNetlifyGraphWatcher) {
+    startPollingForAPIAuthentication({ api, command, config, site, siteInfo })
+  }
+
   await startFunctionsServer({
     api,
     command,
     config,
-    isGraphEnabled: startNetlifyGraphWatcher,
     settings,
     site,
     siteInfo,
@@ -322,26 +388,48 @@ const dev = async (options, command) => {
   } else if (startNetlifyGraphWatcher) {
     const netlifyToken = await command.authenticate()
     await OneGraphCliClient.ensureAppForSite(netlifyToken, site.id)
-    const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options, settings })
 
-    let graphqlDocument = readGraphQLOperationsSourceFile(netlifyGraphConfig)
+    let stopWatchingCLISessions
 
-    if (!graphqlDocument || graphqlDocument.trim().length === 0) {
-      graphqlDocument = defaultExampleOperationsDoc
-    }
+    const createOrResumeSession = async function () {
+      const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options, settings })
 
-    await startOneGraphCLISession({ netlifyGraphConfig, netlifyToken, site, state })
+      let graphqlDocument = readGraphQLOperationsSourceFile(netlifyGraphConfig)
 
-    // Should be created by startOneGraphCLISession
-    const oneGraphSessionId = loadCLISession(state)
+      if (!graphqlDocument || graphqlDocument.trim().length === 0) {
+        graphqlDocument = defaultExampleOperationsDoc
+      }
 
-    await persistNewOperationsDocForSession({
-      netlifyToken,
-      oneGraphSessionId,
-      operationsDoc: graphqlDocument,
-      siteId: site.id,
+      stopWatchingCLISessions = await startOneGraphCLISession({ netlifyGraphConfig, netlifyToken, site, state })
+
+      // Should be created by startOneGraphCLISession
+      const oneGraphSessionId = loadCLISession(state)
+
+      await persistNewOperationsDocForSession({
+        netlifyGraphConfig,
+        netlifyToken,
+        oneGraphSessionId,
+        operationsDoc: graphqlDocument,
+        siteId: site.id,
+        siteRoot: site.root,
+      })
+
+      return oneGraphSessionId
+    }
+
+    //
+    // Set up a handler for config changes.
+    command.netlify.configWatcher.on('change', (newConfig) => {
+      command.netlify.config = newConfig
+      stopWatchingCLISessions()
+      createOrResumeSession()
     })
 
+    const oneGraphSessionId = await createOrResumeSession()
+    const cleanupSession = () => markCliSessionInactive({ netlifyToken, sessionId: oneGraphSessionId, siteId: site.id })
+
+    cleanupWork.push(cleanupSession)
+
     const graphEditUrl = getGraphEditUrlBySiteId({ siteId: site.id, oneGraphSessionId })
 
     log(

package/src/commands/graph/graph-edit.js

@@ -1,13 +1,7 @@
 // @ts-check
 const gitRepoInfo = require('git-repo-info')
 
-const {
-  OneGraphCliClient,
-  createCLISession,
-  generateSessionName,
-  loadCLISession,
-  upsertMergeCLISessionMetadata,
-} = require('../../lib/one-graph/cli-client')
+const { OneGraphCliClient, ensureCLISession, upsertMergeCLISessionMetadata } = require('../../lib/one-graph/cli-client')
 const {
   defaultExampleOperationsDoc,
   getGraphEditUrlBySiteId,
@@ -48,13 +42,12 @@ const graphEdit = async (options, command) => {
 
   await ensureAppForSite(netlifyToken, siteId)
 
-  let oneGraphSessionId = loadCLISession(state)
-  if (!oneGraphSessionId) {
-    const sessionName = generateSessionName()
-    const oneGraphSession = await createCLISession({ netlifyToken, siteId: site.id, sessionName, metadata: {} })
-    state.set('oneGraphSessionId', oneGraphSession.id)
-    oneGraphSessionId = state.get('oneGraphSessionId')
-  }
+  const oneGraphSessionId = await ensureCLISession({
+    metadata: {},
+    netlifyToken,
+    site,
+    state,
+  })
 
   const { branch } = gitRepoInfo()
   const persistedDoc = await createPersistedQuery(netlifyToken, {

package/src/commands/graph/graph-handler.js

@@ -1,20 +1,28 @@
 // @ts-check
+const inquirer = require('inquirer')
+const { GraphQL } = require('netlify-onegraph-internal')
+
 const {
   buildSchema,
+  defaultExampleOperationsDoc,
+  extractFunctionsFromOperationDoc,
   generateHandlerByOperationName,
   getNetlifyGraphConfig,
+  readGraphQLOperationsSourceFile,
   readGraphQLSchemaFile,
 } = require('../../lib/one-graph/cli-netlify-graph')
 const { error, log } = require('../../utils')
 
+const { parse } = GraphQL
+
 /**
  * Creates the `netlify graph:handler` command
- * @param {string} operationName
+ * @param {string} userOperationName
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command').BaseCommand} command
  * @returns
  */
-const graphHandler = async (operationName, options, command) => {
+const graphHandler = async (userOperationName, options, command) => {
   const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
 
   const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
@@ -31,6 +39,64 @@ const graphHandler = async (operationName, options, command) => {
     error(`Failed to parse Netlify GraphQL schema`)
   }
 
+  let operationName = userOperationName
+  if (!operationName) {
+    try {
+      let currentOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
+      if (currentOperationsDoc.trim().length === 0) {
+        currentOperationsDoc = defaultExampleOperationsDoc
+      }
+
+      const parsedDoc = parse(currentOperationsDoc)
+      const { functions } = extractFunctionsFromOperationDoc(parsedDoc)
+
+      const sorted = Object.values(functions).sort((aItem, bItem) =>
+        aItem.operationName.localeCompare(bItem.operationName),
+      )
+
+      const perPage = 50
+
+      const allOperationChoices = sorted.map((operation) => ({
+        name: `${operation.operationName} (${operation.kind})`,
+        value: operation.operationName,
+      }))
+
+      const filterOperationNames = (operationChoices, input) =>
+        operationChoices.filter((operation) => operation.value.toLowerCase().match(input.toLowerCase()))
+
+      // eslint-disable-next-line node/global-require
+      const inquirerAutocompletePrompt = require('inquirer-autocomplete-prompt')
+      /** multiple matching detectors, make the user choose */
+      inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt)
+
+      const { selectedOperationName } = await inquirer.prompt({
+        name: 'selectedOperationName',
+        message: `For which operation would you like to generate a handler?`,
+        type: 'autocomplete',
+        pageSize: perPage,
+        source(_, input) {
+          if (!input || input === '') {
+            return allOperationChoices
+          }
+
+          const filteredChoices = filterOperationNames(allOperationChoices, input)
+          // only show filtered results
+          return filteredChoices
+        },
+      })
+
+      if (selectedOperationName) {
+        operationName = selectedOperationName
+      }
+    } catch (parseError) {
+      parseError(`Error parsing operations library: ${parseError}`)
+    }
+  }
+
+  if (!operationName) {
+    error(`No operation name provided`)
+  }
+
   generateHandlerByOperationName({ logger: log, netlifyGraphConfig, schema, operationName, handlerOptions: {} })
 }
 
@@ -42,7 +108,7 @@ const graphHandler = async (operationName, options, command) => {
 const createGraphHandlerCommand = (program) =>
   program
     .command('graph:handler')
-    .argument('<name>', 'Operation name')
+    .argument('[name]', 'Operation name')
     .description(
       'Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.',
     )

package/src/functions-templates/javascript/scheduled-function/package.json

@@ -15,6 +15,6 @@
   "author": "Netlify",
   "license": "MIT",
   "dependencies": {
-    "@netlify/functions": "^0.11.0"
+    "@netlify/functions": "^0.11.1"
   }
 }

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

@@ -9,15 +9,15 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "@netlify/functions": "^0.11.0",
-        "@types/node": "^14.18.11",
+        "@netlify/functions": "^0.11.1",
+        "@types/node": "^14.0.0",
         "typescript": "^4.0.0"
       }
     },
     "node_modules/@netlify/functions": {
-      "version": "0.11.0",
-      "resolved": "https://registry.npmjs.org/@netlify/functions/-/functions-0.11.0.tgz",
-      "integrity": "sha512-+WWX081UCkLZYkfh1Ru+PH5HTujNXugeskATGhZLTyS1U3Cqh2gYLArdG1a/vU8WWopu/wjpxEOdWq8/T5Nw5Q==",
+      "version": "0.11.1",
+      "resolved": "https://registry.npmjs.org/@netlify/functions/-/functions-0.11.1.tgz",
+      "integrity": "sha512-J2QUAYRblvTrl/cOYU2RNHdv/EYy4qnKQhds0aDNB560Y83wfpaMS3F7PKpHygGWrVuLRyevenIzsV9MaQrKlQ==",
       "dependencies": {
         "is-promise": "^4.0.0"
       },
@@ -50,9 +50,9 @@
   },
   "dependencies": {
     "@netlify/functions": {
-      "version": "0.11.0",
-      "resolved": "https://registry.npmjs.org/@netlify/functions/-/functions-0.11.0.tgz",
-      "integrity": "sha512-+WWX081UCkLZYkfh1Ru+PH5HTujNXugeskATGhZLTyS1U3Cqh2gYLArdG1a/vU8WWopu/wjpxEOdWq8/T5Nw5Q==",
+      "version": "0.11.1",
+      "resolved": "https://registry.npmjs.org/@netlify/functions/-/functions-0.11.1.tgz",
+      "integrity": "sha512-J2QUAYRblvTrl/cOYU2RNHdv/EYy4qnKQhds0aDNB560Y83wfpaMS3F7PKpHygGWrVuLRyevenIzsV9MaQrKlQ==",
       "requires": {
         "is-promise": "^4.0.0"
       }

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

@@ -14,7 +14,7 @@
   "author": "Netlify",
   "license": "MIT",
   "dependencies": {
-    "@netlify/functions": "^0.11.0",
+    "@netlify/functions": "^0.11.1",
     "@types/node": "^14.0.0",
     "typescript": "^4.0.0"
   }

package/src/functions-templates/typescript/scheduled-function/package.json

@@ -15,7 +15,7 @@
   "author": "Netlify",
   "license": "MIT",
   "dependencies": {
-    "@netlify/functions": "^0.11.0",
+    "@netlify/functions": "^0.11.1",
     "@types/node": "^14.18.9",
     "typescript": "^4.5.5"
   }

package/src/lib/functions/registry.js

@@ -5,12 +5,11 @@ const { env } = require('process')
 
 const terminalLink = require('terminal-link')
 
-const { NETLIFYDEVERR, NETLIFYDEVLOG, NETLIFYDEVWARN, chalk, log, warn } = require('../../utils')
+const { NETLIFYDEVERR, NETLIFYDEVLOG, NETLIFYDEVWARN, chalk, log, warn, watchDebounced } = require('../../utils')
 const { getLogMessage } = require('../log')
 
 const { NetlifyFunction } = require('./netlify-function')
 const runtimes = require('./runtimes')
-const { watchDebounced } = require('./watcher')
 
 const ZIP_EXTENSION = '.zip'
 

package/src/lib/functions/server.js

@@ -1,6 +1,4 @@
 // @ts-check
-const process = require('process')
-
 const jwtDecode = require('jwt-decode')
 
 const {
@@ -47,51 +45,9 @@ const buildClientContext = function (headers) {
   }
 }
 
-const startPollingForAPIAuthentication = async function (options) {
-  const { api, command, config, site, siteInfo } = options
-  const frequency = 5000
-
-  const helper = async (maybeSiteData) => {
-    const siteData = await (maybeSiteData || api.getSite({ siteId: site.id }))
-    const authlifyTokenId = siteData && siteData.authlify_token_id
-
-    const existingAuthlifyTokenId = config && config.netlifyGraphConfig && config.netlifyGraphConfig.authlifyTokenId
-    if (authlifyTokenId && authlifyTokenId !== existingAuthlifyTokenId) {
-      const netlifyToken = await command.authenticate()
-      // Only inject the authlify config if a token ID exists. This prevents
-      // calling command.authenticate() (which opens a browser window) if the
-      // user hasn't enabled API Authentication
-      const netlifyGraphConfig = {
-        netlifyToken,
-        authlifyTokenId: siteData.authlify_token_id,
-        siteId: site.id,
-      }
-      config.netlifyGraphConfig = netlifyGraphConfig
-
-      const netlifyGraphJWT = generateNetlifyGraphJWT(netlifyGraphConfig)
-
-      if (netlifyGraphJWT != null) {
-        // XXX(anmonteiro): this name is deprecated. Delete after 3/31/2022
-        process.env.ONEGRAPH_AUTHLIFY_TOKEN = netlifyGraphJWT
-        process.env.NETLIFY_GRAPH_TOKEN = netlifyGraphJWT
-      }
-    } else {
-      delete config.authlify
-    }
-
-    setTimeout(helper, frequency)
-  }
-
-  await helper(siteInfo)
-}
-
 const createHandler = function (options) {
   const { config, functionsRegistry } = options
 
-  if (options.isGraphEnabled) {
-    startPollingForAPIAuthentication(options)
-  }
-
   return async function handler(request, response) {
     // handle proxies without path re-writes (http-servr)
     const cleanPath = request.path.replace(/^\/.netlify\/(functions|builders)/, '')
@@ -152,7 +108,7 @@ const createHandler = function (options) {
       rawQuery,
     }
 
-    if (config && config.authlify && config.authlify.authlifyTokenId != null) {
+    if (config && config.netlifyGraphConfig && config.netlifyGraphConfig.authlifyTokenId != null) {
       // XXX(anmonteiro): this name is deprecated. Delete after 3/31/2022
       const jwt = generateNetlifyGraphJWT(config.netlifyGraphConfig)
       event.authlifyToken = jwt