netlify-cli 10.13.0 → 10.16.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "10.13.0",
+  "version": "10.16.0",
   "author": "Netlify Inc.",
   "contributors": [
     "Abraham Schilling <AbrahamSchilling@gmail.com> (https://gitlab.com/n4bb12)",
@@ -26,6 +26,7 @@
     "Charlie Depman <cdepman@gmail.com> (depman.dev)",
     "Charlie Depman <cdepman@gmail.com> (depman.dev)",
     "Charlie Depman <cdepman@gmail.com> (depman.dev)",
+    "Chris Templin <ctemplin@gmail.com>",
     "Cole Bosmann",
     "Dan Croak (https://twitter.com/croaky)",
     "Dan Loewenherz <dan@lionheartsw.com> (https://twitter.com/dwlz)",
@@ -219,13 +220,13 @@
     "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\" \"!**/*/package-lock.json\" \"!.github/**/*.md\""
   },
   "dependencies": {
-    "@netlify/build": "^27.7.0",
+    "@netlify/build": "^27.8.1",
     "@netlify/config": "^18.1.2",
-    "@netlify/edge-bundler": "^1.8.0",
-    "@netlify/framework-info": "^9.1.1",
+    "@netlify/edge-bundler": "^1.12.1",
+    "@netlify/framework-info": "^9.2.0",
     "@netlify/local-functions-proxy": "^1.1.1",
-    "@netlify/plugins-list": "^6.35.0",
-    "@netlify/zip-it-and-ship-it": "^5.13.2",
+    "@netlify/plugins-list": "^6.37.0",
+    "@netlify/zip-it-and-ship-it": "^5.13.4",
     "@octokit/rest": "^18.0.0",
     "@sindresorhus/slugify": "^1.1.0",
     "ansi-escapes": "^5.0.0",
@@ -290,7 +291,7 @@
     "multiparty": "^4.2.1",
     "netlify": "^12.0.0",
     "netlify-headers-parser": "^6.0.2",
-    "netlify-onegraph-internal": "0.3.10",
+    "netlify-onegraph-internal": "0.8.1",
     "netlify-redirect-parser": "^13.0.5",
     "netlify-redirector": "^0.2.1",
     "node-fetch": "^2.6.0",

package/src/commands/dev/dev.js

@@ -233,6 +233,7 @@ const FRAMEWORK_PORT_TIMEOUT = 6e5
  * @param {object} params
  * @param {*} params.addonsUrls
  * @param {import('../base-command').NetlifyOptions["config"]} params.config
+ * @param {import('../base-command').NetlifyOptions["cachedConfig"]['env']} params.env
  * @param {InspectSettings} params.inspectSettings
  * @param {() => Promise<object>} params.getUpdatedConfig
  * @param {string} params.geolocationMode
@@ -247,6 +248,7 @@ const FRAMEWORK_PORT_TIMEOUT = 6e5
 const startProxyServer = async ({
   addonsUrls,
   config,
+  env,
   geoCountry,
   geolocationMode,
   getUpdatedConfig,
@@ -261,6 +263,7 @@ const startProxyServer = async ({
     addonsUrls,
     config,
     configPath: site.configPath,
+    env,
     geolocationMode,
     geoCountry,
     getUpdatedConfig,
@@ -479,6 +482,7 @@ const dev = async (options, command) => {
   let url = await startProxyServer({
     addonsUrls,
     config,
+    env: command.netlify.cachedConfig.env,
     geolocationMode: options.geo,
     geoCountry: options.country,
     getUpdatedConfig,
@@ -514,6 +518,9 @@ const dev = async (options, command) => {
 
     let stopWatchingCLISessions
 
+    let liveConfig = { ...config }
+    let isRestartingSession = false
+
     const createOrResumeSession = async function () {
       const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options, settings })
 
@@ -524,6 +531,7 @@ const dev = async (options, command) => {
       }
 
       stopWatchingCLISessions = await startOneGraphCLISession({
+        config: liveConfig,
         netlifyGraphConfig,
         netlifyToken,
         site,
@@ -535,6 +543,7 @@ const dev = async (options, command) => {
       const oneGraphSessionId = loadCLISession(state)
 
       await persistNewOperationsDocForSession({
+        config: liveConfig,
         netlifyGraphConfig,
         netlifyToken,
         oneGraphSessionId,
@@ -570,10 +579,16 @@ const dev = async (options, command) => {
     }
 
     // Set up a handler for config changes.
-    configWatcher.on('change', (newConfig) => {
+    configWatcher.on('change', async (newConfig) => {
       command.netlify.config = newConfig
-      stopWatchingCLISessions()
-      createOrResumeSession()
+      liveConfig = newConfig
+      if (isRestartingSession) {
+        return
+      }
+      stopWatchingCLISessions && stopWatchingCLISessions()
+      isRestartingSession = true
+      await createOrResumeSession()
+      isRestartingSession = false
     })
 
     const oneGraphSessionId = await createOrResumeSession()

package/src/commands/functions/functions-invoke.js

@@ -8,7 +8,7 @@ const fetch = require('node-fetch')
 
 const { BACKGROUND, CLOCKWORK_USERAGENT, NETLIFYDEVWARN, chalk, error, exit, getFunctions } = require('../../utils')
 
-// https://www.netlify.com/docs/functions/#event-triggered-functions
+// https://docs.netlify.com/functions/trigger-on-events/
 const events = [
   'deploy-building',
   'deploy-succeeded',
@@ -161,10 +161,10 @@ const functionsInvoke = async (nameArgument, options, command) => {
     }
   } else if (eventTriggeredFunctions.has(functionToTrigger)) {
     /** handle event triggered fns  */
-    // https://www.netlify.com/docs/functions/#event-triggered-functions
+    // https://docs.netlify.com/functions/trigger-on-events/
     const [name, event] = functionToTrigger.split('-')
     if (name === 'identity') {
-      // https://www.netlify.com/docs/functions/#identity-event-functions
+      // https://docs.netlify.com/functions/functions-and-identity/#trigger-functions-on-identity-events
       body.event = event
       body.user = {
         id: '1111a1a1-a11a-1111-aa11-aaa11111a11a',
@@ -182,7 +182,7 @@ const functionsInvoke = async (nameArgument, options, command) => {
       }
     } else {
       // non identity functions seem to have a different shape
-      // https://www.netlify.com/docs/functions/#event-function-payloads
+      // https://docs.netlify.com/functions/trigger-on-events/#payload
       body.payload = {
         TODO: 'mock up payload data better',
       }

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

@@ -21,7 +21,7 @@ const { ensureAppForSite, executeCreatePersistedQueryMutation } = OneGraphCliCli
  * @returns
  */
 const graphEdit = async (options, command) => {
-  const { site, state } = command.netlify
+  const { config, site, state } = command.netlify
   const siteId = site.id
 
   if (!site.id) {
@@ -44,10 +44,12 @@ const graphEdit = async (options, command) => {
   await ensureAppForSite(netlifyToken, siteId)
 
   const oneGraphSessionId = await ensureCLISession({
+    config,
     metadata: {},
     netlifyToken,
     site,
     state,
+    netlifyGraphConfig,
   })
 
   const { branch } = gitRepoInfo()
@@ -76,7 +78,7 @@ const graphEdit = async (options, command) => {
 
   const { jwt } = await OneGraphClient.getGraphJwtForSite({ siteId, nfToken: netlifyToken })
   await upsertMergeCLISessionMetadata({
-    netlifyGraphConfig,
+    config,
     jwt,
     siteId,
     siteRoot: site.root,

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

@@ -1,29 +1,27 @@
+/* eslint-disable eslint-comments/disable-enable-pair */
 // @ts-check
-const inquirer = require('inquirer')
-const { GraphQL } = require('netlify-onegraph-internal')
 
 const {
+  autocompleteCodegenModules,
+  autocompleteOperationNames,
   buildSchema,
-  defaultExampleOperationsDoc,
-  extractFunctionsFromOperationDoc,
   generateHandlerByOperationName,
+  getCodegenFunctionById,
+  getCodegenModule,
   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} userOperationName
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command').BaseCommand} command
  * @returns
  */
-const graphHandler = async (userOperationName, options, command) => {
+const graphHandler = async (args, options, command) => {
   const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
+  const { config } = command.netlify
 
   const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
 
@@ -35,69 +33,48 @@ const graphHandler = async (userOperationName, options, command) => {
     error(`Error parsing schema: ${buildSchemaError}`)
   }
 
-  if (!schema) {
-    error(`Failed to parse Netlify GraphQL schema`)
-  }
+  const userOperationName = args.operationName
+  const userCodegenId = options.codegen
 
   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 n/global-require
-      const inquirerAutocompletePrompt = require('inquirer-autocomplete-prompt')
-      /** multiple matching detectors, make the user choose */
-      inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt)
+    operationName = await autocompleteOperationNames({ netlifyGraphConfig })
+  }
 
-      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
-          }
+  if (!operationName) {
+    error(`No operation name provided`)
+  }
 
-          const filteredChoices = filterOperationNames(allOperationChoices, input)
-          // only show filtered results
-          return filteredChoices
-        },
-      })
+  const codegenModule = await getCodegenModule({ config })
+  if (!codegenModule) {
+    error(
+      `No Netlify Graph codegen module specified in netlify.toml under the [graph] header. Please specify 'codeGenerator' field and try again.`,
+    )
+    return
+  }
 
-      if (selectedOperationName) {
-        operationName = selectedOperationName
-      }
-    } catch (parseError) {
-      parseError(`Error parsing operations library: ${parseError}`)
-    }
+  let codeGenerator = userCodegenId ? await getCodegenFunctionById({ config, id: userCodegenId }) : null
+  if (!codeGenerator) {
+    codeGenerator = await autocompleteCodegenModules({ config })
   }
 
-  if (!operationName) {
-    error(`No operation name provided`)
+  if (!codeGenerator) {
+    error(`Unable to select appropriate Netlify Graph code generator`)
+    return
   }
 
-  generateHandlerByOperationName({ logger: log, netlifyGraphConfig, schema, operationName, handlerOptions: {} })
+  if (schema) {
+    generateHandlerByOperationName({
+      generate: codeGenerator.generateHandler,
+      logger: log,
+      netlifyGraphConfig,
+      schema,
+      operationName,
+      handlerOptions: {},
+    })
+  } else {
+    error(`Failed to parse Netlify GraphQL schema`)
+  }
 }
 
 /**
@@ -109,11 +86,12 @@ const createGraphHandlerCommand = (program) =>
   program
     .command('graph:handler')
     .argument('[name]', 'Operation name')
+    .option('-c, --codegen <id>', 'The id of the specific code generator to use')
     .description(
       'Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.',
     )
     .action(async (operationName, options, command) => {
-      await graphHandler(operationName, options, command)
+      await graphHandler({ operationName }, options, command)
     })
 
 module.exports = { createGraphHandlerCommand }

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

@@ -0,0 +1,152 @@
+// @ts-check
+const { Buffer } = require('buffer')
+
+const { OneGraphClient } = require('netlify-onegraph-internal')
+const { v4: uuidv4 } = require('uuid')
+
+const { OneGraphCliClient, ensureCLISession } = require('../../lib/one-graph/cli-client')
+const { getNetlifyGraphConfig } = require('../../lib/one-graph/cli-netlify-graph')
+const { NETLIFYDEVERR, chalk, error, exit, getToken, log } = require('../../utils')
+const { msg } = require('../login/login')
+
+const { ensureAppForSite, executeCreateApiTokenMutation } = OneGraphCliClient
+
+/**
+ * Creates the `netlify graph:init` command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ * @returns
+ */
+const graphInit = async (options, command) => {
+  const { api, config, site, state } = command.netlify
+  const siteId = site.id
+
+  if (!siteId) {
+    error(
+      `${NETLIFYDEVERR} Warning: no siteId defined, unable to start Netlify Graph. To enable, run ${chalk.yellow(
+        'netlify init',
+      )} or ${chalk.yellow('netlify link')}`,
+    )
+  }
+
+  let [netlifyToken, loginLocation] = await getToken()
+  if (!netlifyToken) {
+    netlifyToken = await command.authenticate()
+  }
+
+  let siteData = null
+  try {
+    // @ts-ignore: we need better types for our api object
+    siteData = await api.getSite({ siteId })
+  } catch (error_) {
+    if (netlifyToken && error_.status === 401) {
+      log(`Already logged in ${msg(loginLocation)}`)
+      log()
+      log(`Run ${chalk.cyanBright('netlify status')} for account details`)
+      log()
+      log(`or run ${chalk.cyanBright('netlify switch')} to switch accounts`)
+      log()
+      log(`To see all available commands run: ${chalk.cyanBright('netlify help')}`)
+      log()
+      return exit()
+    }
+    throw error_
+  }
+
+  if (netlifyToken == null) {
+    error(
+      `${NETLIFYDEVERR} Error: Unable to start Netlify Graph without a login. To enable, run ${chalk.yellow(
+        'netlify login',
+      )} first`,
+    )
+    return exit()
+  }
+
+  await ensureAppForSite(netlifyToken, siteId)
+
+  const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
+  await ensureCLISession({
+    config,
+    metadata: {},
+    netlifyToken,
+    site,
+    state,
+    netlifyGraphConfig,
+  })
+
+  let envChanged = false
+
+  // Get current environment variables set in the UI
+  const {
+    build_settings: { env = {} },
+  } = siteData
+
+  const newEnv = {
+    ...env,
+  }
+
+  if (!env.NETLIFY_GRAPH_WEBHOOK_SECRET) {
+    envChanged = true
+    const secret = Buffer.from(uuidv4()).toString('base64')
+    newEnv.NETLIFY_GRAPH_WEBHOOK_SECRET = secret
+  }
+
+  if (!env.NETLIFY_GRAPH_PERSIST_QUERY_TOKEN) {
+    const variables = {
+      input: {
+        appId: siteId,
+        scopes: ['MODIFY_SCHEMA', 'PERSIST_QUERY'],
+      },
+    }
+
+    const { jwt } = await OneGraphClient.getGraphJwtForSite({ siteId, nfToken: netlifyToken })
+    const result = await executeCreateApiTokenMutation(variables, {
+      siteId,
+      accessToken: jwt,
+    })
+
+    const token =
+      result.data &&
+      result.data.oneGraph &&
+      result.data.oneGraph.createApiToken &&
+      result.data.oneGraph.createApiToken.accessToken &&
+      result.data.oneGraph.createApiToken.accessToken.token
+
+    if (token) {
+      envChanged = true
+      newEnv.NETLIFY_GRAPH_PERSIST_QUERY_TOKEN = token
+    } else {
+      error(`Unable to create Netlify Graph persist query token: ${JSON.stringify(result.errors, null, 2)}`)
+    }
+  }
+
+  if (envChanged) {
+    // Apply environment variable updates
+    // @ts-ignore
+    await api.updateSite({
+      siteId,
+      body: {
+        build_settings: {
+          env: newEnv,
+        },
+      },
+    })
+
+    log(`Finished updating Graph-related environment variables for site ${siteData.name}`)
+  }
+}
+
+/**
+ * Creates the `netlify graph:init` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createGraphInitCommand = (program) =>
+  program
+    .command('graph:init')
+    .description('Initialize all the resources for Netlify Graph')
+    .action(async (options, command) => {
+      await graphInit(options, command)
+    })
+
+module.exports = { createGraphInitCommand }

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

@@ -1,4 +1,7 @@
 // @ts-check
+const { GraphQL } = require('netlify-onegraph-internal')
+
+const { readLockfile } = require('../../lib/one-graph/cli-client')
 const {
   buildSchema,
   defaultExampleOperationsDoc,
@@ -9,7 +12,7 @@ const {
   readGraphQLOperationsSourceFile,
   readGraphQLSchemaFile,
 } = require('../../lib/one-graph/cli-netlify-graph')
-const { error, log } = require('../../utils')
+const { NETLIFYDEVERR, chalk, error, log } = require('../../utils')
 
 /**
  * Creates the `netlify graph:library` command
@@ -18,10 +21,19 @@ const { error, log } = require('../../utils')
  * @returns
  */
 const graphLibrary = async (options, command) => {
+  const { config } = command.netlify
   const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
 
   const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
 
+  let currentOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
+  if (currentOperationsDoc.trim().length === 0) {
+    currentOperationsDoc = defaultExampleOperationsDoc
+  }
+
+  const parsedDoc = parse(currentOperationsDoc)
+  const { fragments, functions } = extractFunctionsFromOperationDoc(GraphQL, parsedDoc)
+
   let schema
 
   try {
@@ -32,24 +44,34 @@ const graphLibrary = async (options, command) => {
 
   if (!schema) {
     error(`Failed to parse Netlify GraphQL schema`)
+    return
   }
 
-  let currentOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
-  if (currentOperationsDoc.trim().length === 0) {
-    currentOperationsDoc = defaultExampleOperationsDoc
+  const lockfile = readLockfile({ siteRoot: command.netlify.site.root })
+
+  if (lockfile === undefined) {
+    error(
+      `${NETLIFYDEVERR} Error: no lockfile found, unable to run \`netlify graph:library\`. To pull a remote schema (and create a lockfile), run ${chalk.yellow(
+        'netlify graph:pull',
+      )} `,
+    )
+    return
   }
 
-  const parsedDoc = parse(currentOperationsDoc)
-  const { fragments, functions } = extractFunctionsFromOperationDoc(parsedDoc)
+  const { schemaId } = lockfile.locked
 
-  generateFunctionsFile({
+  const payload = {
+    config,
     logger: log,
     netlifyGraphConfig,
     schema,
+    schemaId,
     operationsDoc: currentOperationsDoc,
     functions,
     fragments,
-  })
+  }
+
+  generateFunctionsFile(payload)
 }
 
 /**

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

@@ -26,13 +26,18 @@ const graphOperations = async (options, command) => {
     }
 
     const parsedDoc = parse(currentOperationsDoc)
-    const { fragments, functions } = extractFunctionsFromOperationDoc(parsedDoc)
+    const { fragments, functions } = extractFunctionsFromOperationDoc(GraphQL, parsedDoc)
 
     const sorted = {
+      /** @type {import('netlify-onegraph-internal/dist/netlifyGraph').ExtractedFunction[]} */
       queries: [],
+      /** @type {import('netlify-onegraph-internal/dist/netlifyGraph').ExtractedFunction[]} */
       mutations: [],
+      /** @type {import('netlify-onegraph-internal/dist/netlifyGraph').ExtractedFunction[]} */
       subscriptions: [],
+      /** @type {import('netlify-onegraph-internal/dist/netlifyGraph').ExtractedFragment[]} */
       fragments: [],
+      /** @type {any[]} */
       other: [],
     }