netlify-cli 8.14.1 → 8.15.0

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "netlify-cli",
-  "version": "8.14.1",
+  "version": "8.15.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "8.14.1",
+      "version": "8.15.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
@@ -22,6 +22,7 @@
         "@sindresorhus/slugify": "^1.1.0",
         "ansi-escapes": "^5.0.0",
         "ansi-styles": "^5.0.0",
+        "ansi2html": "^0.0.1",
         "ascii-table": "0.0.9",
         "backoff": "^2.5.0",
         "better-opn": "^3.0.0",
@@ -36,6 +37,7 @@
         "content-type": "^1.0.4",
         "cookie": "^0.4.0",
         "copy-template-dir": "^1.4.0",
+        "cron-parser": "^4.2.1",
         "debug": "^4.1.1",
         "decache": "^4.6.0",
         "del": "^6.0.0",
@@ -134,7 +136,6 @@
         "ini": "^2.0.0",
         "jsonwebtoken": "^8.5.1",
         "mock-fs": "^5.1.2",
-        "mock-require": "^3.0.3",
         "p-timeout": "^4.0.0",
         "proxyquire": "^2.1.3",
         "seedrandom": "^3.0.5",
@@ -4426,6 +4427,17 @@
         "url": "https://github.com/chalk/ansi-styles?sponsor=1"
       }
     },
+    "node_modules/ansi2html": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmjs.org/ansi2html/-/ansi2html-0.0.1.tgz",
+      "integrity": "sha1-u4gARhtECvALkb89c2al4LhHO6g=",
+      "bin": {
+        "ansi2html": "bin/ansi2html"
+      },
+      "engines": {
+        "node": ">0.4"
+      }
+    },
     "node_modules/any-observable": {
       "version": "0.3.0",
       "resolved": "https://registry.npmjs.org/any-observable/-/any-observable-0.3.0.tgz",
@@ -10887,12 +10899,6 @@
         "node": ">=6.0"
       }
     },
-    "node_modules/get-caller-file": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.3.tgz",
-      "integrity": "sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==",
-      "dev": true
-    },
     "node_modules/get-intrinsic": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz",
@@ -14770,31 +14776,6 @@
         "node": ">=12.0.0"
       }
     },
-    "node_modules/mock-require": {
-      "version": "3.0.3",
-      "resolved": "https://registry.npmjs.org/mock-require/-/mock-require-3.0.3.tgz",
-      "integrity": "sha512-lLzfLHcyc10MKQnNUCv7dMcoY/2Qxd6wJfbqCcVk3LDb8An4hF6ohk5AztrvgKhJCqj36uyzi/p5se+tvyD+Wg==",
-      "dev": true,
-      "dependencies": {
-        "get-caller-file": "^1.0.2",
-        "normalize-path": "^2.1.1"
-      },
-      "engines": {
-        "node": ">=4.3.0"
-      }
-    },
-    "node_modules/mock-require/node_modules/normalize-path": {
-      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz",
-      "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=",
-      "dev": true,
-      "dependencies": {
-        "remove-trailing-separator": "^1.0.1"
-      },
-      "engines": {
-        "node": ">=0.10.0"
-      }
-    },
     "node_modules/module-definition": {
       "version": "3.3.1",
       "resolved": "https://registry.npmjs.org/module-definition/-/module-definition-3.3.1.tgz",
@@ -24813,6 +24794,11 @@
       "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz",
       "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA=="
     },
+    "ansi2html": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmjs.org/ansi2html/-/ansi2html-0.0.1.tgz",
+      "integrity": "sha1-u4gARhtECvALkb89c2al4LhHO6g="
+    },
     "any-observable": {
       "version": "0.3.0",
       "resolved": "https://registry.npmjs.org/any-observable/-/any-observable-0.3.0.tgz",
@@ -29735,12 +29721,6 @@
         "node-source-walk": "^4.0.0"
       }
     },
-    "get-caller-file": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.3.tgz",
-      "integrity": "sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==",
-      "dev": true
-    },
     "get-intrinsic": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz",
@@ -32621,27 +32601,6 @@
       "integrity": "sha512-YkjQkdLulFrz0vD4BfNQdQRVmgycXTV7ykuHMlyv+C8WCHazpkiQRDthwa02kSyo8wKnY9wRptHfQLgmf0eR+A==",
       "dev": true
     },
-    "mock-require": {
-      "version": "3.0.3",
-      "resolved": "https://registry.npmjs.org/mock-require/-/mock-require-3.0.3.tgz",
-      "integrity": "sha512-lLzfLHcyc10MKQnNUCv7dMcoY/2Qxd6wJfbqCcVk3LDb8An4hF6ohk5AztrvgKhJCqj36uyzi/p5se+tvyD+Wg==",
-      "dev": true,
-      "requires": {
-        "get-caller-file": "^1.0.2",
-        "normalize-path": "^2.1.1"
-      },
-      "dependencies": {
-        "normalize-path": {
-          "version": "2.1.1",
-          "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz",
-          "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=",
-          "dev": true,
-          "requires": {
-            "remove-trailing-separator": "^1.0.1"
-          }
-        }
-      }
-    },
     "module-definition": {
       "version": "3.3.1",
       "resolved": "https://registry.npmjs.org/module-definition/-/module-definition-3.3.1.tgz",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "8.14.1",
+  "version": "8.15.0",
   "author": "Netlify Inc.",
   "contributors": [
     "Mathias Biilmann <matt@netlify.com> (https://twitter.com/biilmann)",
@@ -64,7 +64,7 @@
     "test:dev:ava": "ava --verbose",
     "test:ci:ava": "c8 -r json ava",
     "test:affected": "node ./tools/affected-test.js",
-    "e2e": "node ./tools/e2e/run.js",
+    "e2e": "node ./tools/e2e/run.mjs",
     "docs": "node ./site/scripts/docs.js",
     "watch": "c8 --reporter=lcov ava --watch",
     "site:build": "run-s site:build:*",
@@ -73,8 +73,8 @@
     "postinstall": "node ./scripts/postinstall.js"
   },
   "config": {
-    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,tools,scripts,site,tests,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,tools,scripts,site,tests,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!CHANGELOG.md\" \"!npm-shrinkwrap.json\" \"!.github/**/*.md\""
+    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,tools,scripts,site,tests,.github}/**/*.{mjs,cjs,js,md,html}\" \"*.{mjs,cjs,js,md,html}\" \".*.{mjs,cjs,js,md,html}\"",
+    "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\" \"!.github/**/*.md\""
   },
   "dependencies": {
     "@netlify/build": "^26.2.0",
@@ -89,6 +89,7 @@
     "@sindresorhus/slugify": "^1.1.0",
     "ansi-escapes": "^5.0.0",
     "ansi-styles": "^5.0.0",
+    "ansi2html": "^0.0.1",
     "ascii-table": "0.0.9",
     "backoff": "^2.5.0",
     "better-opn": "^3.0.0",
@@ -103,6 +104,7 @@
     "content-type": "^1.0.4",
     "cookie": "^0.4.0",
     "copy-template-dir": "^1.4.0",
+    "cron-parser": "^4.2.1",
     "debug": "^4.1.1",
     "decache": "^4.6.0",
     "del": "^6.0.0",
@@ -197,7 +199,6 @@
     "ini": "^2.0.0",
     "jsonwebtoken": "^8.5.1",
     "mock-fs": "^5.1.2",
-    "mock-require": "^3.0.3",
     "p-timeout": "^4.0.0",
     "proxyquire": "^2.1.3",
     "seedrandom": "^3.0.5",

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

@@ -3,10 +3,11 @@ const fs = require('fs')
 const path = require('path')
 const process = require('process')
 
+const CronParser = require('cron-parser')
 const inquirer = require('inquirer')
 const fetch = require('node-fetch')
 
-const { BACKGROUND, NETLIFYDEVWARN, chalk, error, exit, getFunctions } = require('../../utils')
+const { BACKGROUND, CLOCKWORK_USERAGENT, NETLIFYDEVWARN, chalk, error, exit, getFunctions } = require('../../utils')
 
 // https://www.netlify.com/docs/functions/#event-triggered-functions
 const events = [
@@ -130,6 +131,13 @@ const getFunctionToTrigger = function (options, argumentName) {
   return argumentName
 }
 
+const getNextRun = function (schedule) {
+  const cron = CronParser.parseExpression(schedule, {
+    tz: 'Etc/UTC',
+  })
+  return cron.next().toDate()
+}
+
 /**
  * The functions:invoke command
  * @param {string} nameArgument
@@ -150,11 +158,18 @@ const functionsInvoke = async (nameArgument, options, command) => {
 
   const functions = await getFunctions(functionsDir)
   const functionToTrigger = await getNameFromArgs(functions, options, nameArgument)
+  const functionObj = functions.find((func) => func.name === functionToTrigger)
 
   let headers = {}
   let body = {}
 
-  if (eventTriggeredFunctions.has(functionToTrigger)) {
+  if (functionObj.schedule) {
+    body.next_run = getNextRun(functionObj.schedule)
+    headers = {
+      'user-agent': CLOCKWORK_USERAGENT,
+      'X-NF-Event': 'schedule',
+    }
+  } else if (eventTriggeredFunctions.has(functionToTrigger)) {
     /** handle event triggered fns  */
     // https://www.netlify.com/docs/functions/#event-triggered-functions
     const [name, event] = functionToTrigger.split('-')

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

@@ -32,6 +32,7 @@ class NetlifyFunction {
     // Determines whether this is a background function based on the function
     // name.
     this.isBackground = name.endsWith(BACKGROUND_SUFFIX)
+    this.schedule = null
 
     // List of the function's source files. This starts out as an empty set
     // and will get populated on every build.
@@ -44,6 +45,12 @@ class NetlifyFunction {
     return /^[A-Za-z0-9_-]+$/.test(this.name)
   }
 
+  async isScheduled() {
+    await this.buildQueue
+
+    return Boolean(this.schedule)
+  }
+
   // The `build` method transforms source files into invocable functions. Its
   // return value is an object with:
   //
@@ -61,12 +68,13 @@ class NetlifyFunction {
     this.buildQueue = buildFunction({ cache })
 
     try {
-      const { srcFiles, ...buildData } = await this.buildQueue
+      const { schedule, srcFiles, ...buildData } = await this.buildQueue
       const srcFilesSet = new Set(srcFiles)
       const srcFilesDiff = this.getSrcFilesDiff(srcFilesSet)
 
       this.buildData = buildData
       this.srcFiles = srcFilesSet
+      this.schedule = schedule
 
       return { srcFilesDiff }
     } catch (error) {

package/src/lib/functions/runtimes/js/builders/zisi.js

@@ -1,7 +1,7 @@
 const { mkdir, writeFile } = require('fs').promises
 const path = require('path')
 
-const { zipFunction } = require('@netlify/zip-it-and-ship-it')
+const { listFunction, zipFunction } = require('@netlify/zip-it-and-ship-it')
 const decache = require('decache')
 const readPkgUp = require('read-pkg-up')
 const sourceMapSupport = require('source-map-support')
@@ -35,7 +35,11 @@ const buildFunction = async ({ cache, config, directory, func, hasTypeModule, pr
   // root of the functions directory (e.g. `functions/my-func.js`). In
   // this case, we use `mainFile` as the function path of `zipFunction`.
   const entryPath = functionDirectory === directory ? func.mainFile : functionDirectory
-  const { inputs, path: functionPath } = await memoizedBuild({
+  const {
+    inputs,
+    path: functionPath,
+    schedule,
+  } = await memoizedBuild({
     cache,
     cacheKey: `zisi-${entryPath}`,
     command: () => zipFunction(entryPath, targetDirectory, zipOptions),
@@ -56,7 +60,22 @@ const buildFunction = async ({ cache, config, directory, func, hasTypeModule, pr
 
   clearFunctionsCache(targetDirectory)
 
-  return { buildPath, srcFiles }
+  return { buildPath, srcFiles, schedule }
+}
+
+/**
+ * @param {object} params
+ * @param {unknown} params.config
+ * @param {string} params.mainFile
+ * @param {string} params.projectRoot
+ */
+const parseForSchedule = async ({ config, mainFile, projectRoot }) => {
+  const listedFunction = await listFunction(mainFile, {
+    config: netlifyConfigToZisiConfig({ config, projectRoot }),
+    parseISC: true,
+  })
+
+  return listedFunction && listedFunction.schedule
 }
 
 // Clears the cache for any files inside the directory from which functions are
@@ -79,10 +98,11 @@ const getTargetDirectory = async ({ errorExit }) => {
   return targetDirectory
 }
 
+const netlifyConfigToZisiConfig = ({ config, projectRoot }) =>
+  addFunctionsConfigDefaults(normalizeFunctionsConfig({ functionsConfig: config.functions, projectRoot }))
+
 module.exports = async ({ config, directory, errorExit, func, projectRoot }) => {
-  const functionsConfig = addFunctionsConfigDefaults(
-    normalizeFunctionsConfig({ functionsConfig: config.functions, projectRoot }),
-  )
+  const functionsConfig = netlifyConfigToZisiConfig({ config, projectRoot })
 
   const packageJson = await readPkgUp(func.mainFile)
   const hasTypeModule = packageJson && packageJson.packageJson.type === 'module'
@@ -115,3 +135,5 @@ module.exports = async ({ config, directory, errorExit, func, projectRoot }) =>
     target: targetDirectory,
   }
 }
+
+module.exports.parseForSchedule = parseForSchedule

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

@@ -46,8 +46,9 @@ const getBuildFunction = async ({ config, directory, errorExit, func, projectRoo
   // main file otherwise.
   const functionDirectory = dirname(func.mainFile)
   const srcFiles = functionDirectory === directory ? [func.mainFile] : [functionDirectory]
+  const schedule = await detectZisiBuilder.parseForSchedule({ mainFile: func.mainFile, config, projectRoot })
 
-  return () => ({ srcFiles })
+  return () => ({ schedule, srcFiles })
 }
 
 const invokeFunction = async ({ context, event, func, timeout }) => {

package/src/lib/functions/scheduled.js

@@ -0,0 +1,98 @@
+const ansi2html = require('ansi2html')
+
+const { CLOCKWORK_USERAGENT } = require('../../utils')
+
+const { formatLambdaError } = require('./utils')
+
+const buildHelpResponse = ({ error, headers, path, result }) => {
+  const acceptsHtml = headers.accept && headers.accept.includes('text/html')
+
+  const paragraph = (text) => {
+    text = text.trim()
+
+    if (acceptsHtml) {
+      return ansi2html(`<p>${text}</p>`)
+    }
+
+    text = text
+      .replace(/<pre><code>/gm, '```\n')
+      .replace(/<\/code><\/pre>/gm, '\n```')
+      .replace(/<code>/gm, '`')
+      .replace(/<\/code>/gm, '`')
+
+    return `${text}\n\n`
+  }
+
+  const isSimulatedRequest = headers['user-agent'] === CLOCKWORK_USERAGENT
+
+  let message = ''
+
+  if (!isSimulatedRequest) {
+    message += paragraph(`
+You performed an HTTP request to <code>${path}</code>, which is a scheduled function.
+You can do this to test your functions locally, but it won't work in production.
+    `)
+  }
+
+  if (error) {
+    message += paragraph(`
+There was an error during execution of your scheduled function:
+
+<pre><code>${formatLambdaError(error)}</code></pre>`)
+  }
+
+  if (result) {
+    // lambda emulator adds level field, which isn't user-provided
+    const returnValue = { ...result }
+    delete returnValue.level
+
+    const { statusCode } = returnValue
+    if (statusCode >= 500) {
+      message += paragraph(`
+Your function returned a status code of <code>${statusCode}</code>.
+At the moment, Netlify does nothing about that. In the future, there might be a retry mechanism based on this.
+`)
+    }
+
+    const allowedKeys = new Set(['statusCode'])
+    const returnedKeys = Object.keys(returnValue)
+    const ignoredKeys = returnedKeys.filter((key) => !allowedKeys.has(key))
+
+    if (ignoredKeys.length !== 0) {
+      message += paragraph(
+        `Your function returned ${ignoredKeys
+          .map((key) => `<code>${key}</code>`)
+          .join(', ')}. Is this an accident? It won't be interpreted by Netlify.`,
+      )
+    }
+  }
+
+  const statusCode = error ? 500 : 200
+  return acceptsHtml
+    ? {
+        statusCode,
+        contentType: 'text/html',
+        message: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">\n
+                ${message}`,
+      }
+    : {
+        statusCode,
+        contentType: 'text/plain',
+        message,
+      }
+}
+
+const handleScheduledFunction = ({ error, request, response, result }) => {
+  const { contentType, message, statusCode } = buildHelpResponse({
+    error,
+    headers: request.headers,
+    path: request.path,
+    result,
+  })
+
+  response.status(statusCode)
+  response.set('Content-Type', contentType)
+  response.send(message)
+}
+
+module.exports = { handleScheduledFunction, buildHelpResponse }

package/src/lib/functions/server.js

@@ -6,6 +6,7 @@ const { NETLIFYDEVERR, NETLIFYDEVLOG, error: errorExit, getInternalFunctionsDir,
 const { handleBackgroundFunction, handleBackgroundFunctionResult } = require('./background')
 const { createFormSubmissionHandler } = require('./form-submissions-handler')
 const { FunctionsRegistry } = require('./registry')
+const { handleScheduledFunction } = require('./scheduled')
 const { handleSynchronousFunction } = require('./synchronous')
 const { shouldBase64Encode } = require('./utils')
 
@@ -105,6 +106,15 @@ const createHandler = function ({ functionsRegistry }) {
       const { error } = await func.invoke(event, clientContext)
 
       handleBackgroundFunctionResult(functionName, error)
+    } else if (await func.isScheduled()) {
+      const { error, result } = await func.invoke(event, clientContext)
+
+      handleScheduledFunction({
+        error,
+        result,
+        request,
+        response,
+      })
     } else {
       const { error, result } = await func.invoke(event, clientContext)
 

package/src/utils/functions/constants.js

@@ -0,0 +1,5 @@
+const CLOCKWORK_USERAGENT = 'Netlify Clockwork'
+
+module.exports = {
+  CLOCKWORK_USERAGENT,
+}

package/src/utils/functions/get-functions.js

@@ -5,10 +5,10 @@ const getUrlPath = (functionName) => `/.netlify/functions/${functionName}`
 
 const BACKGROUND = '-background'
 
-const addFunctionProps = ({ mainFile, name, runtime }) => {
+const addFunctionProps = ({ mainFile, name, runtime, schedule }) => {
   const urlPath = getUrlPath(name)
   const isBackground = name.endsWith(BACKGROUND)
-  return { mainFile, name, runtime, urlPath, isBackground }
+  return { mainFile, name, runtime, urlPath, isBackground, schedule }
 }
 
 const JS = 'js'
@@ -21,7 +21,9 @@ const getFunctions = async (functionsSrcDir) => {
   // performance optimization, load '@netlify/zip-it-and-ship-it' on demand
   // eslint-disable-next-line node/global-require
   const { listFunctions } = require('@netlify/zip-it-and-ship-it')
-  const functions = await listFunctions(functionsSrcDir)
+  const functions = await listFunctions(functionsSrcDir, {
+    parseISC: true,
+  })
   const functionsWithProps = functions.filter(({ runtime }) => runtime === JS).map((func) => addFunctionProps(func))
   return functionsWithProps
 }

package/src/utils/functions/index.js

@@ -1,8 +1,10 @@
+const constants = require('./constants')
 const edgeHandlers = require('./edge-handlers')
 const functions = require('./functions')
 const getFunctions = require('./get-functions')
 
 module.exports = {
+  ...constants,
   ...functions,
   ...edgeHandlers,
   ...getFunctions,