feat: add local dev experience for scheduled functions

package.json

@@ -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",

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('-')

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) {

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

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 }) => {