RFC: Include ctx in getStaticProps

[birkir]

#15255

Hi everyone.

I have a use-case where I need to access the http request on SSG Previews.

It wouldn't hurt to pass the ctx as a prop on getStaticProps, so that's is my proposal.

Example usage would be:

export function getStaticProps(props: GetStaticPropsContext) {
  if (props.preview) {
    const rawCookies = props.ctx?.req?.headers?.cookie;
    // do something with cookies.
  }
}

The cookie I am trying to read is set by an Iframe on a different domain that is rendered on the page.

It will change between routes, hence not able to use setPreviewData api.

[jkjustjoshing]

getStaticProps is only run at build time, not in response to a given request.

You might be looking for getServerSideProps or getInitialProps?

[birkir]

It is run in preview mode at runtime 😉

[birkir]

Paging @Timer
Any feedback?

[birkir]

Its a very simple change that will benefit many use cases

#15255