Expose event and context of Netlify Function in Next.js pages and API routes

[FinnWoelm]

When a page is being SSR-ed by a Netlify Function, allow users to access the function's event and context parameters. These can be accessed as a property on the req object in all SSR-ed pages and in API routes:

• req.netlifyFunctionParams.event
• req.netlifyFunctionParams.context

Example

const Page = () => <p>Hello World!</p>;

export const getServerSideProps = async ({ req }) => {
  // Get event and context from Netlify Function
  const {
    netlifyFunctionParams: { event, context },
  } = req;

  // Access Netlify identity
  const { identity, user } = context.clientContext;

  // Modify callbackWaitsForEmptyEventLoop behavior
  context.callbackWaitsForEmptyEventLoop = false;

  // See how much time is remaining before function timeout
  const timeRemaining = context.getRemainingTimeInMillis();

  return {
    props: {},
  };
};

export default Page;

Use Cases

This allows users to access/leverage Netlify identity for their Next.js page (see #20).
It also allows users to modify the callbackWaitsForEmptyEventLoop behavior (see #66 (comment)).

Fixes #20

[FinnWoelm]

@lindsaylevine @ehmicky: Is netlifyFunction the appopriate name for making the event and context objects available on the req object?

I opted for netlifyFunction, because I wanted a name that makes it clear that this is not Next.js behavior and thus won't work on any other platform. But if you think something else would be better, let's change it! 😊 (Best to change it now, because changing it later would probably be a breaking change and require a major version bump.)

[FinnWoelm]

PS: Why make the event and context objects available via the req parameter? Because the req and res objects are passed as-is through Next.js to pages and API routes (

next-on-netlify/lib/templates/renderNextPage.js

Line 24 in 818cb91

if (isNextPage) return nextPage.render(req, res);

). We can add any number of custom properties onto the req (or res) object and they will be available to users.

[lindsaylevine]

THIS IS SO DOPE, YAY

[lindsaylevine]

AWESOMEEEE

[lindsaylevine]

i think this name is fine. maybe netlifyFunctionData since the value itself is not really a function but 🤷‍♀️

[FinnWoelm]

True! How about netlifyFunctionParams, since it's not just data but also some functions?

[lindsaylevine]

sounds good!!!!!

[FinnWoelm]

It's now netlifyFunctionParams :)

[FinnWoelm]

If we're happy with netlifyFunctionParams, this is ready to be merged! LMK and I can do the merging :)

[lindsaylevine]

do it!!!