@netlify/config 15.7.2 → 15.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/config",
-  "version": "15.7.2",
+  "version": "15.8.0",
   "description": "Netlify config module",
   "main": "src/main.js",
   "bin": {
@@ -52,6 +52,7 @@
     "@ungap/from-entries": "^0.2.1",
     "array-flat-polyfill": "^1.0.1",
     "chalk": "^4.1.2",
+    "cron-parser": "^4.1.0",
     "deepmerge": "^4.2.2",
     "dot-prop": "^5.3.0",
     "execa": "^5.1.1",
@@ -64,7 +65,7 @@
     "js-yaml": "^4.0.0",
     "make-dir": "^3.1.0",
     "map-obj": "^4.0.0",
-    "netlify": "^8.0.1",
+    "netlify": "^8.0.3",
     "netlify-headers-parser": "^4.0.1",
     "netlify-redirect-parser": "^11.0.2",
     "omit.js": "^2.0.2",

package/src/functions_config.js

@@ -55,6 +55,7 @@ const FUNCTION_CONFIG_PROPERTIES = new Set([
   'ignored_node_modules',
   'included_files',
   'node_bundler',
+  'schedule',
 ])
 
 // Takes a functions configuration object and looks for the functions directory

package/src/log/messages.js

@@ -4,11 +4,10 @@ const { throwUserError } = require('../error')
 
 const { logWarning } = require('./logger')
 
-const warnTomlBackslashes = function (logs, invalidSequence) {
-  logWarning(
-    logs,
+const throwOnInvalidTomlSequence = function (invalidSequence) {
+  throwUserError(
     `In netlify.toml, the following backslash should be escaped: ${invalidSequence}
-The following will be used instead: \\${invalidSequence}`,
+The following should be used instead: \\${invalidSequence}`,
   )
 }
 
@@ -127,7 +126,7 @@ const getErrorMessage = function ({ message }) {
 }
 
 module.exports = {
-  warnTomlBackslashes,
+  throwOnInvalidTomlSequence,
   warnLegacyFunctionsDirectory,
   warnContextPluginConfig,
   throwContextPluginsConfig,

package/src/main.js

@@ -220,7 +220,7 @@ const getFullConfig = async function ({
   const configPath = await getConfigPath({ configOpt, cwd, repositoryRoot, configBase })
 
   try {
-    const config = await parseConfig(configPath, logs)
+    const config = await parseConfig(configPath)
     const configA = mergeAndNormalizeConfig({
       config,
       defaultConfig,

package/src/mutations/update.js

@@ -32,7 +32,7 @@ const updateConfig = async function (
 
   const inlineConfig = applyMutations({}, configMutations)
   const normalizedInlineConfig = ensureConfigPriority(inlineConfig, context, branch)
-  const updatedConfig = await mergeWithConfig({ normalizedInlineConfig, configPath, logs })
+  const updatedConfig = await mergeWithConfig(normalizedInlineConfig, configPath)
   const configWithHeaders = await addHeaders(updatedConfig, headersPath, logs)
   const finalConfig = await addRedirects(configWithHeaders, redirectsPath, logs)
   const simplifiedConfig = simplifyConfig(finalConfig)
@@ -45,8 +45,8 @@ const updateConfig = async function (
 }
 
 // If `netlify.toml` exists, deeply merges the configuration changes.
-const mergeWithConfig = async function ({ normalizedInlineConfig, configPath, logs }) {
-  const config = await parseOptionalConfig(configPath, logs)
+const mergeWithConfig = async function (normalizedInlineConfig, configPath) {
+  const config = await parseOptionalConfig(configPath)
   const updatedConfig = mergeConfigs([config, normalizedInlineConfig])
   return updatedConfig
 }

package/src/parse.js

@@ -6,13 +6,13 @@ const { promisify } = require('util')
 const pathExists = require('path-exists')
 
 const { throwUserError } = require('./error')
-const { warnTomlBackslashes } = require('./log/messages')
+const { throwOnInvalidTomlSequence } = require('./log/messages')
 const { parseToml } = require('./utils/toml')
 
 const pReadFile = promisify(readFile)
 
 // Load the configuration file and parse it (TOML)
-const parseConfig = async function (configPath, logs) {
+const parseConfig = async function (configPath) {
   if (configPath === undefined) {
     return {}
   }
@@ -21,23 +21,23 @@ const parseConfig = async function (configPath, logs) {
     throwUserError('Configuration file does not exist')
   }
 
-  return await readConfigPath(configPath, logs)
+  return await readConfigPath(configPath)
 }
 
 // Same but `configPath` is required and `configPath` might point to a
 // non-existing file.
-const parseOptionalConfig = async function (configPath, logs) {
+const parseOptionalConfig = async function (configPath) {
   if (!(await pathExists(configPath))) {
     return {}
   }
 
-  return await readConfigPath(configPath, logs)
+  return await readConfigPath(configPath)
 }
 
-const readConfigPath = async function (configPath, logs) {
+const readConfigPath = async function (configPath) {
   const configString = await readConfig(configPath)
 
-  validateTomlBlackslashes(logs, configString)
+  validateTomlBlackslashes(configString)
 
   try {
     return parseToml(configString)
@@ -55,14 +55,14 @@ const readConfig = async function (configPath) {
   }
 }
 
-const validateTomlBlackslashes = function (logs, configString) {
+const validateTomlBlackslashes = function (configString) {
   const result = INVALID_TOML_BLACKSLASH.exec(configString)
   if (result === null) {
     return
   }
 
   const [, invalidTripleSequence, invalidSequence = invalidTripleSequence] = result
-  warnTomlBackslashes(logs, invalidSequence)
+  throwOnInvalidTomlSequence(invalidSequence)
 }
 
 // The TOML specification forbids unrecognized backslash sequences. However,

package/src/validate/validations.js

@@ -1,6 +1,7 @@
 /* eslint-disable max-lines */
 'use strict'
 
+const CronParser = require('cron-parser')
 const isPlainObj = require('is-plain-obj')
 const validateNpmPackageName = require('validate-npm-package-name')
 
@@ -8,6 +9,19 @@ const { bundlers, WILDCARD_ALL: FUNCTIONS_CONFIG_WILDCARD_ALL } = require('../fu
 
 const { functionsDirectoryCheck, isArrayOfObjects, isArrayOfStrings, isString, validProperties } = require('./helpers')
 
+/**
+ * @param {string} cron
+ * @returns {boolean}
+ */
+const isValidCronExpression = (cron) => {
+  try {
+    CronParser.parseExpression(cron)
+    return true
+  } catch (error) {
+    return false
+  }
+}
+
 // List of validations performed on the configuration file.
 // Validation are performed in order: parent should be before children.
 // Each validation is an object with the following properties:
@@ -212,6 +226,14 @@ const POST_NORMALIZE_VALIDATIONS = [
       functions: { directory: 'my-functions' },
     }),
   },
+  {
+    property: 'functions.*.schedule',
+    check: isValidCronExpression,
+    message: 'must be a valid cron expression (see https://ntl.fyi/cron-syntax).',
+    example: (value, key, prevPath) => ({
+      functions: { [prevPath[1]]: { schedule: '5 4 * * *' } },
+    }),
+  },
   {
     property: 'functionsDirectory',
     check: isString,