fix(functions): stop providing clientContext to background functions (#…

…4395) * fix(functions): stop providing clientContext to background functions * test: add test Co-authored-by: Erez Rokah <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
netlify · Mar 2, 2022 · e14feb2 · e14feb2 · github-actions · Mar 2, 2022
1 parent 4e74045
commit e14feb2
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/src/lib/functions/server.js b/src/lib/functions/server.js
@@ -120,7 +120,8 @@ const createHandler = function (options) {
     if (func.isBackground) {
       handleBackgroundFunction(functionName, response)
 
-      const { error } = await func.invoke(event, clientContext)
+      // background functions do not receive a clientContext
+      const { error } = await func.invoke(event)
 
       handleBackgroundFunctionResult(functionName, error)
     } else if (await func.isScheduled()) {

diff --git a/tests/integration/100.command.dev.test.js b/tests/integration/100.command.dev.test.js
@@ -132,6 +132,29 @@ testMatrix.forEach(({ args }) => {
     })
   })
 
+  test(testName('background function clientContext,identity should be null', args), async (t) => {
+    await withSiteBuilder('site-with-background-function', async (builder) => {
+      await builder
+        .withNetlifyToml({ config: { functions: { directory: 'functions' } } })
+        .withFunction({
+          path: 'hello-background.js',
+          handler: (_, context) => {
+            console.log(`__CLIENT_CONTEXT__START__${JSON.stringify(context)}__CLIENT_CONTEXT__END__`)
+          },
+        })
+        .buildAsync()
+
+      await withDevServer({ cwd: builder.directory, args }, async ({ outputBuffer, url }) => {
+        await got(`${url}/.netlify/functions/hello-background`)
+
+        const output = outputBuffer.toString()
+        const context = JSON.parse(output.match(/__CLIENT_CONTEXT__START__(.*)__CLIENT_CONTEXT__END__/)[1])
+        t.is(context.clientContext, null)
+        t.is(context.identity, null)
+      })
+    })
+  })
+
   test(testName('should enforce role based redirects with default secret and role path', args), async (t) => {
     await withSiteBuilder('site-with-default-role-based-redirects', async (builder) => {
       setupRoleBasedRedirectsSite(builder)