netlify-cli 17.3.1 → 17.4.0

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

@@ -1,88 +1,81 @@
-// @ts-check
-import fs from 'fs'
-import { createRequire } from 'module'
-import path from 'path'
-
-import inquirer from 'inquirer'
-import fetch from 'node-fetch'
-
-import { NETLIFYDEVWARN, chalk, error, exit } from '../../utils/command-helpers.mjs'
-import { BACKGROUND, CLOCKWORK_USERAGENT, getFunctions } from '../../utils/functions/index.mjs'
-
-const require = createRequire(import.meta.url)
-
+import fs from 'fs';
+import { createRequire } from 'module';
+import path from 'path';
+import inquirer from 'inquirer';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'node... Remove this comment to see the full error message
+import fetch from 'node-fetch';
+import { NETLIFYDEVWARN, chalk, error, exit } from '../../utils/command-helpers.mjs';
+import { BACKGROUND, CLOCKWORK_USERAGENT, getFunctions } from '../../utils/functions/index.mjs';
+const require = createRequire(import.meta.url);
 // https://docs.netlify.com/functions/trigger-on-events/
 const events = [
-  'deploy-building',
-  'deploy-succeeded',
-  'deploy-failed',
-  'deploy-locked',
-  'deploy-unlocked',
-  'split-test-activated',
-  'split-test-deactivated',
-  'split-test-modified',
-  'submission-created',
-  'identity-validate',
-  'identity-signup',
-  'identity-login',
-]
-
-const eventTriggeredFunctions = new Set([...events, ...events.map((name) => `${name}${BACKGROUND}`)])
-
-const DEFAULT_PORT = 8888
-
+    'deploy-building',
+    'deploy-succeeded',
+    'deploy-failed',
+    'deploy-locked',
+    'deploy-unlocked',
+    'split-test-activated',
+    'split-test-deactivated',
+    'split-test-modified',
+    'submission-created',
+    'identity-validate',
+    'identity-signup',
+    'identity-login',
+];
+const eventTriggeredFunctions = new Set([...events, ...events.map((name) => `${name}${BACKGROUND}`)]);
+const DEFAULT_PORT = 8888;
 // https://stackoverflow.com/questions/3710204/how-to-check-if-a-string-is-a-valid-json-string-in-javascript-without-using-try
+// @ts-expect-error TS(7006) FIXME: Parameter 'jsonString' implicitly has an 'any' typ... Remove this comment to see the full error message
 const tryParseJSON = function (jsonString) {
-  try {
-    const parsedValue = JSON.parse(jsonString)
-
-    // Handle non-exception-throwing cases:
-    // Neither JSON.parse(false) or JSON.parse(1234) throw errors, hence the type-checking,
-    // but... JSON.parse(null) returns null, and typeof null === "object",
-    // so we must check for that, too. Thankfully, null is falsey, so this suffices:
-    if (parsedValue && typeof parsedValue === 'object') {
-      return parsedValue
+    try {
+        const parsedValue = JSON.parse(jsonString);
+        // Handle non-exception-throwing cases:
+        // Neither JSON.parse(false) or JSON.parse(1234) throw errors, hence the type-checking,
+        // but... JSON.parse(null) returns null, and typeof null === "object",
+        // so we must check for that, too. Thankfully, null is falsey, so this suffices:
+        if (parsedValue && typeof parsedValue === 'object') {
+            return parsedValue;
+        }
     }
-  } catch {}
-
-  return false
-}
-
+    catch { }
+    return false;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'querystring' implicitly has an 'any' ty... Remove this comment to see the full error message
 const formatQstring = function (querystring) {
-  if (querystring) {
-    return `?${querystring}`
-  }
-  return ''
-}
-
+    if (querystring) {
+        return `?${querystring}`;
+    }
+    return '';
+};
 /**
  * process payloads from flag
  * @param {string} payloadString
  * @param {string} workingDir
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'payloadString' implicitly has an 'any' ... Remove this comment to see the full error message
 const processPayloadFromFlag = function (payloadString, workingDir) {
-  if (payloadString) {
-    // case 1: jsonstring
-    let payload = tryParseJSON(payloadString)
-    if (payload) return payload
-    // case 2: jsonpath
-    const payloadpath = path.join(workingDir, payloadString)
-    const pathexists = fs.existsSync(payloadpath)
-    if (pathexists) {
-      try {
-        // there is code execution potential here
-
-        payload = require(payloadpath)
-        return payload
-      } catch (error_) {
-        console.error(error_)
-      }
+    if (payloadString) {
+        // case 1: jsonstring
+        let payload = tryParseJSON(payloadString);
+        if (payload)
+            return payload;
+        // case 2: jsonpath
+        const payloadpath = path.join(workingDir, payloadString);
+        const pathexists = fs.existsSync(payloadpath);
+        if (pathexists) {
+            try {
+                // there is code execution potential here
+                payload = require(payloadpath);
+                return payload;
+            }
+            catch (error_) {
+                console.error(error_);
+            }
+        }
+        // case 3: invalid string, invalid path
+        return false;
     }
-    // case 3: invalid string, invalid path
-    return false
-  }
-}
-
+};
 /**
  * prompt for a name if name not supplied
  *  also used in functions:create
@@ -91,182 +84,166 @@ const processPayloadFromFlag = function (payloadString, workingDir) {
  * @param {string} [argumentName] The name that might be provided as argument (optional argument)
  * @returns {Promise<string>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'functions' implicitly has an 'any' type... Remove this comment to see the full error message
 const getNameFromArgs = async function (functions, options, argumentName) {
-  const functionToTrigger = getFunctionToTrigger(options, argumentName)
-  const functionNames = functions.map(({ name }) => name)
-
-  if (functionToTrigger) {
-    if (functionNames.includes(functionToTrigger)) {
-      return functionToTrigger
+    const functionToTrigger = getFunctionToTrigger(options, argumentName);
+    // @ts-expect-error TS(7031) FIXME: Binding element 'name' implicitly has an 'any' typ... Remove this comment to see the full error message
+    const functionNames = functions.map(({ name }) => name);
+    if (functionToTrigger) {
+        if (functionNames.includes(functionToTrigger)) {
+            return functionToTrigger;
+        }
+        console.warn(`Function name ${chalk.yellow(functionToTrigger)} supplied but no matching function found in your functions folder, forcing you to pick a valid one...`);
     }
-
-    console.warn(
-      `Function name ${chalk.yellow(
-        functionToTrigger,
-      )} supplied but no matching function found in your functions folder, forcing you to pick a valid one...`,
-    )
-  }
-
-  const { trigger } = await inquirer.prompt([
-    {
-      type: 'list',
-      message: 'Pick a function to trigger',
-      name: 'trigger',
-      choices: functionNames,
-    },
-  ])
-  return trigger
-}
-
+    const { trigger } = await inquirer.prompt([
+        {
+            type: 'list',
+            message: 'Pick a function to trigger',
+            name: 'trigger',
+            choices: functionNames,
+        },
+    ]);
+    return trigger;
+};
 /**
  * get the function name out of the argument or options
  * @param {import('commander').OptionValues} options
  * @param {string} [argumentName] The name that might be provided as argument (optional argument)
  * @returns {string}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const getFunctionToTrigger = function (options, argumentName) {
-  if (options.name) {
-    if (argumentName) {
-      console.error('function name specified in both flag and arg format, pick one')
-      exit(1)
+    if (options.name) {
+        if (argumentName) {
+            console.error('function name specified in both flag and arg format, pick one');
+            exit(1);
+        }
+        return options.name;
     }
-
-    return options.name
-  }
-
-  return argumentName
-}
-
+    return argumentName;
+};
 /**
  * The functions:invoke command
  * @param {string} nameArgument
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'nameArgument' implicitly has an 'any' t... Remove this comment to see the full error message
 const functionsInvoke = async (nameArgument, options, command) => {
-  const { config, relConfigFilePath } = command.netlify
-
-  const functionsDir = options.functions || (config.dev && config.dev.functions) || config.functionsDirectory
-  if (typeof functionsDir === 'undefined') {
-    error(`Functions directory is undefined, did you forget to set it in ${relConfigFilePath}?`)
-  }
-
-  if (!options.port)
-    console.warn(`${NETLIFYDEVWARN} "port" flag was not specified. Attempting to connect to localhost:8888 by default`)
-  const port = options.port || DEFAULT_PORT
-
-  const functions = await getFunctions(functionsDir, config)
-  const functionToTrigger = await getNameFromArgs(functions, options, nameArgument)
-  const functionObj = functions.find((func) => func.name === functionToTrigger)
-
-  let headers = {}
-  let body = {}
-
-  if (functionObj.schedule) {
-    headers = {
-      'user-agent': CLOCKWORK_USERAGENT,
+    const { config, relConfigFilePath } = command.netlify;
+    const functionsDir = options.functions || (config.dev && config.dev.functions) || config.functionsDirectory;
+    if (typeof functionsDir === 'undefined') {
+        error(`Functions directory is undefined, did you forget to set it in ${relConfigFilePath}?`);
     }
-  } else if (eventTriggeredFunctions.has(functionToTrigger)) {
-    /** handle event triggered fns  */
-    // https://docs.netlify.com/functions/trigger-on-events/
-    const [name, event] = functionToTrigger.split('-')
-    if (name === 'identity') {
-      // https://docs.netlify.com/functions/functions-and-identity/#trigger-functions-on-identity-events
-      body.event = event
-      body.user = {
-        id: '1111a1a1-a11a-1111-aa11-aaa11111a11a',
-        aud: '',
-        role: '',
-        email: 'foo@trust-this-company.com',
-        app_metadata: {
-          provider: 'email',
-        },
-        user_metadata: {
-          full_name: 'Test Person',
-        },
-        created_at: new Date(Date.now()).toISOString(),
-        update_at: new Date(Date.now()).toISOString(),
-      }
-    } else {
-      // non identity functions seem to have a different shape
-      // https://docs.netlify.com/functions/trigger-on-events/#payload
-      body.payload = {
-        TODO: 'mock up payload data better',
-      }
-      body.site = {
-        TODO: 'mock up site data better',
-      }
+    if (!options.port)
+        console.warn(`${NETLIFYDEVWARN} "port" flag was not specified. Attempting to connect to localhost:8888 by default`);
+    const port = options.port || DEFAULT_PORT;
+    const functions = await getFunctions(functionsDir, config);
+    const functionToTrigger = await getNameFromArgs(functions, options, nameArgument);
+    const functionObj = functions.find((func) => func.name === functionToTrigger);
+    let headers = {};
+    let body = {};
+    // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+    if (functionObj.schedule) {
+        headers = {
+            'user-agent': CLOCKWORK_USERAGENT,
+        };
+    }
+    else if (eventTriggeredFunctions.has(functionToTrigger)) {
+        /** handle event triggered fns  */
+        // https://docs.netlify.com/functions/trigger-on-events/
+        const [name, event] = functionToTrigger.split('-');
+        if (name === 'identity') {
+            // https://docs.netlify.com/functions/functions-and-identity/#trigger-functions-on-identity-events
+            // @ts-expect-error TS(2339) FIXME: Property 'event' does not exist on type '{}'.
+            body.event = event;
+            // @ts-expect-error TS(2339) FIXME: Property 'user' does not exist on type '{}'.
+            body.user = {
+                id: '1111a1a1-a11a-1111-aa11-aaa11111a11a',
+                aud: '',
+                role: '',
+                email: 'foo@trust-this-company.com',
+                app_metadata: {
+                    provider: 'email',
+                },
+                user_metadata: {
+                    full_name: 'Test Person',
+                },
+                created_at: new Date(Date.now()).toISOString(),
+                update_at: new Date(Date.now()).toISOString(),
+            };
+        }
+        else {
+            // non identity functions seem to have a different shape
+            // https://docs.netlify.com/functions/trigger-on-events/#payload
+            // @ts-expect-error TS(2339) FIXME: Property 'payload' does not exist on type '{}'.
+            body.payload = {
+                TODO: 'mock up payload data better',
+            };
+            // @ts-expect-error TS(2339) FIXME: Property 'site' does not exist on type '{}'.
+            body.site = {
+                TODO: 'mock up site data better',
+            };
+        }
+    }
+    else {
+        // NOT an event triggered function, but may still want to simulate authentication locally
+        const isAuthenticated = Boolean(options.identity);
+        if (isAuthenticated) {
+            headers = {
+                authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb3VyY2UiOiJuZXRsaWZ5IGZ1bmN0aW9uczp0cmlnZ2VyIiwidGVzdERhdGEiOiJORVRMSUZZX0RFVl9MT0NBTExZX0VNVUxBVEVEX0pXVCJ9.Xb6vOFrfLUZmyUkXBbCvU4bM7q8tPilF0F03Wupap_c',
+            };
+            // you can decode this https://jwt.io/
+            // {
+            //   "source": "netlify functions:trigger",
+            //   "testData": "NETLIFY_DEV_LOCALLY_EMULATED_JWT"
+            // }
+        }
+    }
+    const payload = processPayloadFromFlag(options.payload, command.workingDir);
+    body = { ...body, ...payload };
+    try {
+        const response = await fetch(`http://localhost:${port}/.netlify/functions/${functionToTrigger}${formatQstring(options.querystring)}`, {
+            method: 'post',
+            headers,
+            body: JSON.stringify(body),
+        });
+        const data = await response.text();
+        console.log(data);
     }
-  } else {
-    // NOT an event triggered function, but may still want to simulate authentication locally
-    const isAuthenticated = Boolean(options.identity)
-
-    if (isAuthenticated) {
-      headers = {
-        authorization:
-          'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb3VyY2UiOiJuZXRsaWZ5IGZ1bmN0aW9uczp0cmlnZ2VyIiwidGVzdERhdGEiOiJORVRMSUZZX0RFVl9MT0NBTExZX0VNVUxBVEVEX0pXVCJ9.Xb6vOFrfLUZmyUkXBbCvU4bM7q8tPilF0F03Wupap_c',
-      }
-      // you can decode this https://jwt.io/
-      // {
-      //   "source": "netlify functions:trigger",
-      //   "testData": "NETLIFY_DEV_LOCALLY_EMULATED_JWT"
-      // }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(`Ran into an error invoking your function: ${error_.message}`);
     }
-  }
-  const payload = processPayloadFromFlag(options.payload, command.workingDir)
-  body = { ...body, ...payload }
-
-  try {
-    const response = await fetch(
-      `http://localhost:${port}/.netlify/functions/${functionToTrigger}${formatQstring(options.querystring)}`,
-      {
-        method: 'post',
-        headers,
-        body: JSON.stringify(body),
-      },
-    )
-    const data = await response.text()
-    console.log(data)
-  } catch (error_) {
-    error(`Ran into an error invoking your function: ${error_.message}`)
-  }
-}
-
+};
 /**
  * Creates the `netlify functions:invoke` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createFunctionsInvokeCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createFunctionsInvokeCommand = (program) => program
     .command('functions:invoke')
     .alias('function:trigger')
     .argument('[name]', 'function name to invoke')
-    .description(
-      `Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions`,
-    )
+    .description(`Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions`)
     .option('-n, --name <name>', 'function name to invoke')
     .option('-f, --functions <dir>', 'Specify a functions folder to parse, overriding netlify.toml')
     .option('-q, --querystring <query>', 'Querystring to add to your function invocation')
     .option('-p, --payload <data>', 'Supply POST payload in stringified json, or a path to a json file')
     // TODO: refactor to not need the `undefined` state by removing the --identity flag (value `identity` will be then always defined to true or false)
-    .option(
-      '--identity',
-      'simulate Netlify Identity authentication JWT. pass --identity to affirm unauthenticated request',
-    )
-    .option(
-      '--no-identity',
-      'simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request',
-    )
+    .option('--identity', 'simulate Netlify Identity authentication JWT. pass --identity to affirm unauthenticated request')
+    .option('--no-identity', 'simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'value' implicitly has an 'any' type.
     .option('--port <port>', 'Port where netlify dev is accessible. e.g. 8888', (value) => Number.parseInt(value))
     .addExamples([
-      'netlify functions:invoke',
-      'netlify functions:invoke myfunction',
-      'netlify functions:invoke --name myfunction',
-      'netlify functions:invoke --name myfunction --identity',
-      'netlify functions:invoke --name myfunction --no-identity',
-      `netlify functions:invoke myfunction --payload '{"foo": 1}'`,
-      'netlify functions:invoke myfunction --querystring "foo=1',
-      'netlify functions:invoke myfunction --payload "./pathTo.json"',
-    ])
-    .action(functionsInvoke)
+    'netlify functions:invoke',
+    'netlify functions:invoke myfunction',
+    'netlify functions:invoke --name myfunction',
+    'netlify functions:invoke --name myfunction --identity',
+    'netlify functions:invoke --name myfunction --no-identity',
+    `netlify functions:invoke myfunction --payload '{"foo": 1}'`,
+    'netlify functions:invoke myfunction --querystring "foo=1',
+    'netlify functions:invoke myfunction --payload "./pathTo.json"',
+])
+    .action(functionsInvoke);

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

@@ -1,74 +1,64 @@
-// @ts-check
-import AsciiTable from 'ascii-table'
-
-import { exit, log, logJson } from '../../utils/command-helpers.mjs'
-import { getFunctions, getFunctionsDir } from '../../utils/functions/index.mjs'
-import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
-
+import AsciiTable from 'ascii-table';
+import { exit, log, logJson } from '../../utils/command-helpers.mjs';
+import { getFunctions, getFunctionsDir } from '../../utils/functions/index.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'deployedFunctions' implicitly has an 'a... Remove this comment to see the full error message
 const normalizeFunction = function (deployedFunctions, { name, urlPath: url }) {
-  const isDeployed = deployedFunctions.some((deployedFunction) => deployedFunction.n === name)
-  return { name, url, isDeployed }
-}
-
+    // @ts-expect-error TS(7006) FIXME: Parameter 'deployedFunction' implicitly has an 'an... Remove this comment to see the full error message
+    const isDeployed = deployedFunctions.some((deployedFunction) => deployedFunction.n === name);
+    return { name, url, isDeployed };
+};
 /**
  * The functions:list command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const functionsList = async (options, command) => {
-  const { config, relConfigFilePath, siteInfo } = command.netlify
-
-  const deploy = siteInfo.published_deploy || {}
-  const deployedFunctions = deploy.available_functions || []
-
-  const functionsDir = getFunctionsDir({ options, config })
-
-  if (typeof functionsDir === 'undefined') {
-    log('Functions directory is undefined')
-    log(`Please verify that 'functions.directory' is set in your Netlify configuration file ${relConfigFilePath}`)
-    log('Refer to https://docs.netlify.com/configure-builds/file-based-configuration/ for more information')
-    exit(1)
-  }
-
-  const functions = await getFunctions(functionsDir)
-  const normalizedFunctions = functions.map(normalizeFunction.bind(null, deployedFunctions))
-
-  if (normalizedFunctions.length === 0) {
-    log(`No functions found in ${functionsDir}`)
-    exit()
-  }
-
-  if (options.json) {
-    logJson(normalizedFunctions)
-    exit()
-  }
-
-  // Make table
-  log(`Based on local functions folder ${functionsDir}, these are the functions detected`)
-  const table = new AsciiTable(`Netlify Functions (in local functions folder)`)
-  table.setHeading('Name', 'URL', 'deployed')
-  normalizedFunctions.forEach(({ isDeployed, name, url }) => {
-    table.addRow(name, url, isDeployed ? 'yes' : 'no')
-  })
-  log(table.toString())
-}
-
+    const { config, relConfigFilePath, siteInfo } = command.netlify;
+    const deploy = siteInfo.published_deploy || {};
+    const deployedFunctions = deploy.available_functions || [];
+    // @ts-expect-error TS(2554) FIXME: Expected 2 arguments, but got 1.
+    const functionsDir = getFunctionsDir({ options, config });
+    if (typeof functionsDir === 'undefined') {
+        log('Functions directory is undefined');
+        log(`Please verify that 'functions.directory' is set in your Netlify configuration file ${relConfigFilePath}`);
+        log('Refer to https://ntl.fyi/file-based-build-config for more information');
+        exit(1);
+    }
+    const functions = await getFunctions(functionsDir);
+    const normalizedFunctions = functions.map(normalizeFunction.bind(null, deployedFunctions));
+    if (normalizedFunctions.length === 0) {
+        log(`No functions found in ${functionsDir}`);
+        exit();
+    }
+    if (options.json) {
+        logJson(normalizedFunctions);
+        exit();
+    }
+    // Make table
+    log(`Based on local functions folder ${functionsDir}, these are the functions detected`);
+    const table = new AsciiTable(`Netlify Functions (in local functions folder)`);
+    table.setHeading('Name', 'URL', 'deployed');
+    normalizedFunctions.forEach(({ isDeployed, name, url }) => {
+        table.addRow(name, url, isDeployed ? 'yes' : 'no');
+    });
+    log(table.toString());
+};
 /**
  * Creates the `netlify functions:list` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createFunctionsListCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createFunctionsListCommand = (program) => program
     .command('functions:list')
     .alias('function:list')
-    .description(
-      `List functions that exist locally
+    .description(`List functions that exist locally
 Helpful for making sure that you have formatted your functions correctly
 
-NOT the same as listing the functions that have been deployed. For that info you need to go to your Netlify deploy log.`,
-    )
+NOT the same as listing the functions that have been deployed. For that info you need to go to your Netlify deploy log.`)
     .option('-f, --functions <dir>', 'Specify a functions directory to list')
     .option('--json', 'Output function data as JSON')
     .hook('preAction', requiresSiteInfo)
-    .action(functionsList)
+    .action(functionsList);