${text}
`) + } + + text = text + .replace(//gm, '```\n')
+ .replace(/<\/code><\/pre>/gm, '\n```')
+ .replace(//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 ${path}, 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:
+
+${formatLambdaError(error)}
`)
+ }
+
+ 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 ${statusCode}.
+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) => `${key}`)
+ .join(', ')}. Is this an accident? It won't be interpreted by Netlify.`,
+ )
+ }
+ }
+
+ const statusCode = error ? 500 : 200
+ return acceptsHtml
+ ? {
+ statusCode,
+ contentType: 'text/html',
+ message: `\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 }
diff --git a/src/lib/functions/scheduled.test.js b/src/lib/functions/scheduled.test.js
new file mode 100644
index 00000000000..24013abea86
--- /dev/null
+++ b/src/lib/functions/scheduled.test.js
@@ -0,0 +1,58 @@
+const test = require('ava')
+
+const { buildHelpResponse } = require('./scheduled')
+
+const withAccept = (accept) =>
+ buildHelpResponse({
+ error: undefined,
+ headers: {
+ accept,
+ },
+ path: '/',
+ result: {
+ statusCode: 200,
+ },
+ })
+
+test('buildHelpResponse does content negotiation', (t) => {
+ const html = withAccept('text/html')
+ t.is(html.contentType, 'text/html')
+ t.true(html.message.includes(''))
+
+ const plain = withAccept('text/plain')
+ t.is(plain.contentType, 'text/plain')
+ t.false(plain.message.includes(''))
+})
+
+test('buildHelpResponse prints errors', (t) => {
+ const response = buildHelpResponse({
+ error: new Error('test'),
+ headers: {},
+ path: '/',
+ result: {
+ statusCode: 200,
+ },
+ })
+
+ t.true(response.message.includes('There was an error'))
+})
+
+const withUserAgent = (userAgent) =>
+ buildHelpResponse({
+ error: new Error('test'),
+ headers: {
+ accept: 'text/plain',
+ 'user-agent': userAgent,
+ },
+ path: '/',
+ result: {
+ statusCode: 200,
+ },
+ })
+
+test('buildHelpResponse conditionally prints notice about HTTP x scheduled functions', (t) => {
+ t.true(withUserAgent('').message.includes("it won't work in production"))
+ t.false(withUserAgent('Netlify Clockwork').message.includes("it won't work in production"))
+})
diff --git a/src/lib/functions/server.js b/src/lib/functions/server.js
index 48e8eeb928a..bbe03d3bfb8 100644
--- a/src/lib/functions/server.js
+++ b/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)
diff --git a/src/lib/functions/server.test.js b/src/lib/functions/server.test.js
index 17f4b1d34e4..1e7906cc3e6 100644
--- a/src/lib/functions/server.test.js
+++ b/src/lib/functions/server.test.js
@@ -1,42 +1,25 @@
-const fs = require('fs')
-const { platform } = require('os')
+const { mkdirSync, mkdtempSync, writeFileSync } = require('fs')
+const { tmpdir } = require('os')
const { join } = require('path')
-const zisi = require('@netlify/zip-it-and-ship-it')
const test = require('ava')
const express = require('express')
-const mockRequire = require('mock-require')
-const sinon = require('sinon')
const request = require('supertest')
-const projectRoot = platform() === 'win32' ? 'C:\\my-functions' : `/my-functions`
-const functionsPath = `functions`
-
-// mock mkdir for the functions folder
-sinon.stub(fs.promises, 'mkdir').withArgs(join(projectRoot, functionsPath)).returns(Promise.resolve())
-
const { FunctionsRegistry } = require('./registry')
const { createHandler } = require('./server')
/** @type { express.Express} */
let app
-test.before(async (t) => {
- const mainFile = join(projectRoot, functionsPath, 'hello.js')
- t.context.zisiStub = sinon.stub(zisi, 'listFunctions').returns(
- Promise.resolve([
- {
- name: 'hello',
- mainFile,
- runtime: 'js',
- extension: '.js',
- },
- ]),
- )
+test.before(async () => {
+ const projectRoot = mkdtempSync(join(tmpdir(), 'functions-server-project-root'))
+ const functionsDirectory = join(projectRoot, 'functions')
+ mkdirSync(functionsDirectory)
+
+ const mainFile = join(functionsDirectory, 'hello.js')
+ writeFileSync(mainFile, `exports.handler = (event) => ({ statusCode: 200, body: event.rawUrl })`)
- mockRequire(mainFile, {
- handler: (event) => ({ statusCode: 200, body: event.rawUrl }),
- })
const functionsRegistry = new FunctionsRegistry({
projectRoot,
config: {},
@@ -44,15 +27,11 @@ test.before(async (t) => {
// eslint-disable-next-line no-magic-numbers
settings: { port: 8888 },
})
- await functionsRegistry.scan([functionsPath])
+ await functionsRegistry.scan([functionsDirectory])
app = express()
app.all('*', createHandler({ functionsRegistry }))
})
-test.after((t) => {
- t.context.zisiStub.restore()
-})
-
test('should get the url as the `rawUrl` inside the function', async (t) => {
await request(app)
.get('/hello')
diff --git a/src/utils/functions/constants.js b/src/utils/functions/constants.js
new file mode 100644
index 00000000000..061d31aca74
--- /dev/null
+++ b/src/utils/functions/constants.js
@@ -0,0 +1,5 @@
+const CLOCKWORK_USERAGENT = 'Netlify Clockwork'
+
+module.exports = {
+ CLOCKWORK_USERAGENT,
+}
diff --git a/src/utils/functions/get-functions.js b/src/utils/functions/get-functions.js
index 9f9c4de8a8d..9f8cef2e8fe 100644
--- a/src/utils/functions/get-functions.js
+++ b/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
}
diff --git a/src/utils/functions/get-functions.test.js b/src/utils/functions/get-functions.test.js
index 407f3848f15..ff79f34397f 100644
--- a/src/utils/functions/get-functions.test.js
+++ b/src/utils/functions/get-functions.test.js
@@ -37,6 +37,7 @@ test('should return object with function details for a directory with js files',
mainFile: path.join(builder.directory, 'functions', 'index.js'),
isBackground: false,
runtime: 'js',
+ schedule: undefined,
urlPath: '/.netlify/functions/index',
},
])
@@ -64,6 +65,7 @@ test('should mark background functions based on filenames', async (t) => {
mainFile: path.join(builder.directory, 'functions', 'bar-background', 'bar-background.js'),
isBackground: true,
runtime: 'js',
+ schedule: undefined,
urlPath: '/.netlify/functions/bar-background',
},
{
@@ -71,6 +73,7 @@ test('should mark background functions based on filenames', async (t) => {
mainFile: path.join(builder.directory, 'functions', 'foo-background.js'),
isBackground: true,
runtime: 'js',
+ schedule: undefined,
urlPath: '/.netlify/functions/foo-background',
},
])
diff --git a/src/utils/functions/index.js b/src/utils/functions/index.js
index 8606ce08894..b5952f47014 100644
--- a/src/utils/functions/index.js
+++ b/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,
diff --git a/tests/command.functions.test.js b/tests/command.functions.test.js
index a3542b44eb2..74963e88447 100644
--- a/tests/command.functions.test.js
+++ b/tests/command.functions.test.js
@@ -13,6 +13,7 @@ const { withDevServer } = require('./utils/dev-server')
const got = require('./utils/got')
const { CONFIRM, DOWN, answerWithValue, handleQuestions } = require('./utils/handle-questions')
const { withMockApi } = require('./utils/mock-api')
+const { pause } = require('./utils/pause')
const { killProcess } = require('./utils/process')
const { withSiteBuilder } = require('./utils/site-builder')
@@ -582,6 +583,129 @@ test('should trigger background function from event', async (t) => {
})
})
+test('should serve helpful tips and tricks', async (t) => {
+ await withSiteBuilder('site-with-isc-ping-function', async (builder) => {
+ await builder
+ .withNetlifyToml({
+ config: { functions: { directory: 'functions' } },
+ })
+ // mocking until https://github.com/netlify/functions/pull/226 landed
+ .withContentFile({
+ path: 'node_modules/@netlify/functions/package.json',
+ content: `{}`,
+ })
+ .withContentFile({
+ path: 'node_modules/@netlify/functions/index.js',
+ content: `
+ module.exports.schedule = (schedule, handler) => handler
+ `,
+ })
+ .withContentFile({
+ path: 'functions/hello-world.js',
+ content: `
+ const { schedule } = require('@netlify/functions')
+
+ module.exports.handler = schedule('@daily', () => {
+ return {
+ statusCode: 200,
+ body: "hello world"
+ }
+ })
+ `.trim(),
+ })
+ .buildAsync()
+
+ await withDevServer({ cwd: builder.directory }, async (server) => {
+ const plainTextResponse = await got(`http://localhost:${server.port}/.netlify/functions/hello-world`, {
+ throwHttpErrors: false,
+ retry: null,
+ })
+ const youReturnedBodyRegex = /.*Your function returned `body`. Is this an accident\?.*/
+ t.regex(plainTextResponse.body, youReturnedBodyRegex)
+ t.regex(plainTextResponse.body, /.*You performed an HTTP request.*/)
+ t.is(plainTextResponse.statusCode, 200)
+
+ const htmlResponse = await got(`http://localhost:${server.port}/.netlify/functions/hello-world`, {
+ throwHttpErrors: false,
+ retry: null,
+ headers: {
+ accept: 'text/html',
+ },
+ })
+ t.regex(htmlResponse.body, /.* {
+ await withSiteBuilder('site-with-isc-ping-function', async (builder) => {
+ await builder
+ .withNetlifyToml({
+ config: { functions: { directory: 'functions' } },
+ })
+ // mocking until https://github.com/netlify/functions/pull/226 landed
+ .withContentFile({
+ path: 'node_modules/@netlify/functions/package.json',
+ content: `{}`,
+ })
+ .withContentFile({
+ path: 'node_modules/@netlify/functions/index.js',
+ content: `
+ module.exports.schedule = (schedule, handler) => handler
+ `,
+ })
+ .withContentFile({
+ path: 'functions/hello-world.js',
+ content: `
+ module.exports.handler = () => {
+ return {
+ statusCode: 200
+ }
+ }
+ `.trim(),
+ })
+ .buildAsync()
+
+ await withDevServer({ cwd: builder.directory }, async (server) => {
+ const helloWorldBody = () =>
+ got(`http://localhost:${server.port}/.netlify/functions/hello-world`, {
+ throwHttpErrors: false,
+ retry: null,
+ }).then((response) => response.body)
+
+ t.is(await helloWorldBody(), '')
+
+ await builder
+ .withContentFile({
+ path: 'functions/hello-world.js',
+ content: `
+ const { schedule } = require('@netlify/functions')
+
+ module.exports.handler = schedule("@daily", () => {
+ return {
+ statusCode: 200,
+ body: "test"
+ }
+ })
+ `.trim(),
+ })
+ .buildAsync()
+
+ const DETECT_FILE_CHANGE_DELAY = 500
+ await pause(DETECT_FILE_CHANGE_DELAY)
+
+ const warningMessage = await helloWorldBody()
+ t.true(warningMessage.includes('Your function returned `body`'))
+ })
+ })
+})
+
test('should inject env variables', async (t) => {
await withSiteBuilder('site-with-env-function', async (builder) => {
await builder