@netlify/plugin-nextjs 3.9.2 → 4.0.0-beta.4

package/src/lib/pages/withoutProps/redirects.js

@@ -1,51 +0,0 @@
-const getNextConfig = require('../../../../helpers/getNextConfig')
-const addDefaultLocaleRedirect = require('../../helpers/addDefaultLocaleRedirect')
-const asyncForEach = require('../../helpers/asyncForEach')
-const isDynamicRoute = require('../../helpers/isDynamicRoute')
-
-const getPages = require('./pages')
-
-// withoutProps pages
-//
-// Page params {
-//     route -> '/about', '/initial/[id]'
-//     filePath -> 'pages/about.html', 'pages/initial[id].html'
-// }
-//
-// Page params in i18n {
-//     route -> '/en/about', '/fr/initial/[id]'
-//     filePath -> 'pages/en/about.html', 'pages/fr/initial[id].html'
-// }
-//
-
-const getRedirects = async () => {
-  const redirects = []
-  const pages = await getPages()
-  const { basePath } = await getNextConfig()
-
-  await asyncForEach(pages, async ({ route, filePath }) => {
-    const target = filePath.replace(/pages/, '')
-
-    await addDefaultLocaleRedirect(redirects, route, target)
-
-    // For sites that use basePath, manually add necessary redirects here specific
-    // only to this page type (which excludes static route redirects by default)
-    if (basePath && basePath !== '') {
-      redirects.push({
-        route: `${basePath}${route}`,
-        target: route,
-      })
-    }
-
-    // Only create normal redirects for pages with dynamic routing
-    if (!isDynamicRoute(route)) return
-
-    redirects.push({
-      route,
-      target: filePath.replace(/pages/, ''),
-    })
-  })
-  return redirects
-}
-
-module.exports = getRedirects

package/src/lib/pages/withoutProps/setup.js

@@ -1,34 +0,0 @@
-const { join, relative } = require('path')
-
-const { copySync } = require('fs-extra')
-
-const asyncForEach = require('../../helpers/asyncForEach')
-const getI18n = require('../../helpers/getI18n')
-const getNextDistDir = require('../../helpers/getNextDistDir')
-const { logTitle, logItem } = require('../../helpers/logger')
-
-const getPages = require('./pages')
-
-// Identify all pages that have been pre-rendered and copy each one to the
-// Netlify publish directory.
-const setup = async (publishPath) => {
-  logTitle('🔥 Copying pre-rendered pages without props to', publishPath)
-
-  const i18n = await getI18n()
-  const nextDistDir = await getNextDistDir()
-  const pages = await getPages()
-
-  // Copy each page to the Netlify publish directory
-  return pages.map(({ filePath }) => {
-    // HACK: If i18n, 404.html needs to be at the top level of the publish directory
-    if (i18n.defaultLocale && filePath === `pages/${i18n.defaultLocale}/404.html`) {
-      copySync(join(nextDistDir, 'serverless', filePath), join(publishPath, '404.html'))
-    }
-
-    // The path to the file, relative to the pages directory
-    const relativePath = relative('pages', filePath)
-    return { type: 'static', inputPath: relativePath, publishPath }
-  })
-}
-
-module.exports = setup

package/src/lib/pages/worker.js

@@ -1,19 +0,0 @@
-const setupNetlifyFunctionForPage = require('../helpers/setupNetlifyFunctionForPage')
-const setupStaticFileForPage = require('../helpers/setupStaticFileForPage')
-
-exports.processPage = function processPage(job) {
-  try {
-    switch (job.type) {
-      case 'function': {
-        return setupNetlifyFunctionForPage(job)
-      }
-      case 'static': {
-        return setupStaticFileForPage(job)
-      }
-      default:
-        console.log('Unknown job type', job.type)
-    }
-  } catch (error) {
-    console.error('Error in worker', error, 'Job', job)
-  }
-}

package/src/lib/steps/copyNextAssets.js

@@ -1,31 +0,0 @@
-const { join, resolve } = require('path')
-
-const { copySync, existsSync } = require('fs-extra')
-
-const getNextDistDir = require('../helpers/getNextDistDir')
-const { logTitle } = require('../helpers/logger')
-
-// Copy the NextJS static assets from NextJS distDir to Netlify publish folder.
-// These need to be available for NextJS to work.
-
-// Note: If you're using a custom build setup, such as a monorepo,
-// you may need to explicitly set distDir in your next.config.js.
-
-const copyNextAssets = async (publishPath) => {
-  const nextDistDir = await getNextDistDir()
-  const staticAssetsPath = join(nextDistDir, 'static')
-  if (!existsSync(staticAssetsPath)) {
-    throw new Error(
-      `No static assets found in your distDir (missing /static in ${resolve(
-        nextDistDir,
-      )}). Please check your project configuration. Your next.config.js must be one of \`serverless\` or \`experimental-serverless-trace\`. Your build command should include \`next build\`.`,
-    )
-  }
-  logTitle('💼 Copying static NextJS assets to', publishPath)
-  copySync(staticAssetsPath, join(publishPath, '_next', 'static'), {
-    overwrite: false,
-    errorOnExist: true,
-  })
-}
-
-module.exports = copyNextAssets

package/src/lib/steps/copyPublicFiles.js

@@ -1,18 +0,0 @@
-const { existsSync, copySync } = require('fs-extra')
-
-const { PUBLIC_PATH } = require('../config')
-const { logTitle } = require('../helpers/logger')
-
-// Copy files from public folder to Netlify publish folder
-const copyPublicFiles = (publishPath) => {
-  // Abort if no public/ folder
-  if (!existsSync(PUBLIC_PATH)) return
-
-  // Perform copy operation
-  if (publishPath !== PUBLIC_PATH) {
-    logTitle('🌍️ Copying', PUBLIC_PATH, 'folder to', publishPath)
-    copySync(PUBLIC_PATH, publishPath)
-  }
-}
-
-module.exports = copyPublicFiles

package/src/lib/steps/prepareFolders.js

@@ -1,39 +0,0 @@
-const { join } = require('path')
-
-const findCacheDir = require('find-cache-dir')
-const { emptyDirSync } = require('fs-extra')
-
-const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH } = require('../config')
-const handleFileTracking = require('../helpers/handleFileTracking')
-const { logTitle, log } = require('../helpers/logger')
-
-// Clean existing publish and functions folders
-const prepareFolders = ({ functionsPath, publishPath }) => {
-  logTitle('🚀 Next on Netlify 🚀')
-
-  const isNotConfiguredFunctionsDir = functionsPath === NETLIFY_FUNCTIONS_PATH
-  const isNotConfiguredPublishDir = publishPath === NETLIFY_PUBLISH_PATH
-
-  if (isNotConfiguredFunctionsDir) {
-    log('  ', 'Functions directory: ', functionsPath)
-  }
-  if (isNotConfiguredPublishDir) {
-    log('  ', 'Publish directory: ', publishPath)
-  }
-  if (isNotConfiguredFunctionsDir || isNotConfiguredPublishDir) {
-    log('  ', 'Make sure these are set in your netlify.toml file.')
-  }
-
-  // We can empty these dirs knowing there will only be stale NoN-generated files inside
-  if (isNotConfiguredPublishDir) {
-    emptyDirSync(publishPath)
-  }
-  if (isNotConfiguredFunctionsDir) {
-    emptyDirSync(functionsPath)
-  }
-
-  // This returns a function that runs as the last step of nextOnNetlify()
-  return handleFileTracking({ functionsPath, publishPath })
-}
-
-module.exports = prepareFolders

package/src/lib/steps/setupHeaders.js

@@ -1,37 +0,0 @@
-const { join } = require('path')
-
-const { existsSync, readFileSync, writeFileSync } = require('fs-extra')
-
-const { CUSTOM_HEADERS_PATH } = require('../config')
-const { logTitle, logItem } = require('../helpers/logger')
-
-const indentNewLine = (s) => `\n  ${s}`
-
-// Setup _headers file to override specific header rules for next assets
-const setupHeaders = (publishPath) => {
-  logTitle('🔀 Setting up headers')
-
-  // Collect custom redirects defined by the user
-  const headers = []
-  if (existsSync(CUSTOM_HEADERS_PATH)) {
-    logItem('# Prepending custom headers')
-    headers.push(readFileSync(CUSTOM_HEADERS_PATH, 'utf8'))
-  }
-
-  // Add NoN section heading
-  headers.push('# Next-on-Netlify Headers')
-
-  // Add rule to override cache control for static chunks
-  const staticChunkRule = [
-    `/_next/static/chunks/*`,
-    indentNewLine(`cache-control: public`),
-    indentNewLine(`cache-control: max-age=31536000`),
-    indentNewLine(`cache-control: immutable`),
-  ].join('')
-  headers.push(staticChunkRule)
-
-  // Write redirects to _redirects file
-  writeFileSync(join(publishPath, '_headers'), headers.join('\n'))
-}
-
-module.exports = setupHeaders

package/src/lib/steps/setupImageFunction.js

@@ -1,17 +0,0 @@
-const { join } = require('path')
-
-const { copyFile, writeJSON, ensureDir } = require('fs-extra')
-
-const { NEXT_IMAGE_FUNCTION_NAME, TEMPLATES_DIR } = require('../config')
-
-// Move our next/image function into the correct functions directory
-const setupImageFunction = async (functionsPath, imageconfig = {}) => {
-  const functionName = `${NEXT_IMAGE_FUNCTION_NAME}.js`
-  const functionDirectory = join(functionsPath, NEXT_IMAGE_FUNCTION_NAME)
-
-  await ensureDir(functionDirectory)
-  await writeJSON(join(functionDirectory, 'imageconfig.json'), imageconfig)
-  await copyFile(join(TEMPLATES_DIR, 'imageFunction.js'), join(functionDirectory, functionName))
-}
-
-module.exports = setupImageFunction

package/src/lib/steps/setupPages.js

@@ -1,25 +0,0 @@
-const runJobsQueue = require('../helpers/runJobsQueue')
-const apiSetup = require('../pages/api/setup')
-const getInitialPropsSetup = require('../pages/getInitialProps/setup')
-const getServerSidePropsSetup = require('../pages/getServerSideProps/setup')
-const getStaticPropsSetup = require('../pages/getStaticProps/setup')
-const getSPFallbackSetup = require('../pages/getStaticPropsWithFallback/setup')
-const getSPRevalidateSetup = require('../pages/getStaticPropsWithRevalidate/setup')
-const withoutPropsSetup = require('../pages/withoutProps/setup')
-
-// Set up all our NextJS pages according to the recipes defined in pages/
-const setupPages = async ({ functionsPath, publishPath }) => {
-  const jobs = [
-    ...(await apiSetup(functionsPath)),
-    ...(await getInitialPropsSetup(functionsPath)),
-    ...(await getServerSidePropsSetup(functionsPath)),
-    ...(await getStaticPropsSetup({ functionsPath, publishPath })),
-    ...(await getSPFallbackSetup(functionsPath)),
-    ...(await getSPRevalidateSetup(functionsPath)),
-    ...(await withoutPropsSetup(publishPath)),
-  ]
-
-  return runJobsQueue(jobs)
-}
-
-module.exports = setupPages

package/src/lib/steps/setupRedirects.js

@@ -1,105 +0,0 @@
-const { join } = require('path')
-
-const { existsSync, readFileSync, writeFileSync } = require('fs-extra')
-
-const getNextConfig = require('../../../helpers/getNextConfig')
-const { CUSTOM_REDIRECTS_PATH, NEXT_IMAGE_FUNCTION_NAME } = require('../config')
-const convertToBasePathRedirects = require('../helpers/convertToBasePathRedirects')
-const formatRedirectTarget = require('../helpers/formatRedirectTarget')
-const getNetlifyRoutes = require('../helpers/getNetlifyRoutes')
-const getSortedRedirects = require('../helpers/getSortedRedirects')
-const isDynamicRoute = require('../helpers/isDynamicRoute')
-const isRootCatchAllRedirect = require('../helpers/isRootCatchAllRedirect')
-const { logTitle, logItem } = require('../helpers/logger')
-const removeFileExtension = require('../helpers/removeFileExtension')
-
-// Setup _redirects file that routes all requests to the appropriate location,
-// such as one of the Netlify functions or one of the static files.
-const setupRedirects = async (publishPath) => {
-  logTitle('🔀 Setting up redirects')
-
-  // Collect custom redirects defined by the user
-  const redirects = []
-  if (existsSync(CUSTOM_REDIRECTS_PATH)) {
-    logItem('# Prepending custom redirects')
-    redirects.push(readFileSync(CUSTOM_REDIRECTS_PATH, 'utf8'))
-  }
-
-  // Collect redirects for NextJS pages
-  const getApiRedirects = require('../pages/api/redirects')
-  const getInitialPropsRedirects = require('../pages/getInitialProps/redirects')
-  const getServerSidePropsRedirects = require('../pages/getServerSideProps/redirects')
-  const getStaticPropsRedirects = require('../pages/getStaticProps/redirects')
-  const getSPFallbackRedirects = require('../pages/getStaticPropsWithFallback/redirects')
-  const getSPRevalidateRedirects = require('../pages/getStaticPropsWithRevalidate/redirects')
-  const getWithoutPropsRedirects = require('../pages/withoutProps/redirects')
-
-  let nextRedirects = [
-    ...(await getApiRedirects()),
-    ...(await getInitialPropsRedirects()),
-    ...(await getServerSidePropsRedirects()),
-    ...(await getStaticPropsRedirects()),
-    ...(await getSPFallbackRedirects()),
-    ...(await getSPRevalidateRedirects()),
-    ...(await getWithoutPropsRedirects()),
-  ]
-
-  // Add _redirect section heading
-  redirects.push('# Next-on-Netlify Redirects')
-
-  const { basePath } = await getNextConfig()
-  if (basePath && basePath !== '') {
-    nextRedirects = convertToBasePathRedirects({ basePath, nextRedirects })
-  }
-
-  const staticRedirects = nextRedirects.filter(({ route }) => !isDynamicRoute(removeFileExtension(route)))
-  const dynamicRedirects = nextRedirects.filter(({ route }) => isDynamicRoute(removeFileExtension(route)))
-
-  // Add necessary next/image redirects for our image function
-  dynamicRedirects.push({
-    route: `${basePath || ''}/_next/image*  url=:url w=:width q=:quality`,
-    target: `/nextimg/:url/:width/:quality`,
-    statusCode: '301',
-    force: true,
-  })
-  dynamicRedirects.push({
-    route: '/nextimg/*',
-    target: `/.netlify/functions/${NEXT_IMAGE_FUNCTION_NAME}`,
-  })
-
-  const sortedStaticRedirects = getSortedRedirects(staticRedirects)
-  const sortedDynamicRedirects = getSortedRedirects(dynamicRedirects)
-
-  // Assemble redirects for each route
-  ;[...sortedStaticRedirects, ...sortedDynamicRedirects].forEach((nextRedirect) => {
-    // One route may map to multiple Netlify routes: e.g., catch-all pages
-    // require two Netlify routes in the _redirects file
-    getNetlifyRoutes(nextRedirect.route).forEach((netlifyRoute) => {
-      const { conditions = [], force = false, statusCode = '200', target } = nextRedirect
-      const redirectPieces = [
-        netlifyRoute,
-        formatRedirectTarget({ basePath, target }),
-        `${statusCode}${force ? '!' : ''}`,
-        conditions.join('  '),
-      ]
-      const redirect = redirectPieces.join('  ').trim()
-      logItem(redirect)
-      redirects.push(redirect)
-    })
-  })
-
-  // This takes care of this issue: https://github.com/netlify/next-on-netlify/issues/43
-  // where the page chunk for a root level catch-all is served incorrectly to the client.
-  // NOTE: Netlify is also investigating this issue internally.
-  const hasRootCatchAll = redirects.some(isRootCatchAllRedirect)
-  if (hasRootCatchAll) {
-    const rootCatchAllIndex = redirects.findIndex(isRootCatchAllRedirect)
-    // Add general "no-op" redirect before the root catch-all redirect
-    redirects.splice(rootCatchAllIndex, 0, '/_next/*  /_next/:splat  200')
-  }
-
-  // Write redirects to _redirects file
-  writeFileSync(join(publishPath, '_redirects'), redirects.join('\n'))
-}
-
-module.exports = setupRedirects

package/src/lib/templates/getHandlerFunction.js

@@ -1,209 +0,0 @@
-// TEMPLATE: This file will be copied to the Netlify functions directory
-
-// Render function for the Next.js page
-const { Buffer } = require('buffer')
-const http = require('http')
-const queryString = require('querystring')
-const Stream = require('stream')
-
-// Mock a HTTP IncomingMessage object from the Netlify Function event parameters
-// Based on API Gateway Lambda Compat
-// Source: https://github.com/serverless-nextjs/serverless-next.js/blob/master/packages/compat-layers/apigw-lambda-compat/lib/compatLayer.js
-
-const createRequestObject = ({ event, context }) => {
-  const {
-    requestContext = {},
-    path = '',
-    multiValueQueryStringParameters,
-    pathParameters,
-    httpMethod,
-    multiValueHeaders = {},
-    body,
-    isBase64Encoded,
-  } = event
-
-  const newStream = new Stream.Readable()
-  const req = Object.assign(newStream, http.IncomingMessage.prototype)
-  req.url = (requestContext.path || path || '').replace(new RegExp(`^/${requestContext.stage}`), '') || '/'
-
-  let qs = ''
-
-  if (multiValueQueryStringParameters) {
-    qs += queryString.stringify(multiValueQueryStringParameters)
-  }
-
-  if (pathParameters) {
-    const pathParametersQs = queryString.stringify(pathParameters)
-
-    qs += qs.length === 0 ? pathParametersQs : `&${pathParametersQs}`
-  }
-
-  const hasQueryString = qs.length !== 0
-
-  if (hasQueryString) {
-    req.url += `?${qs}`
-  }
-
-  req.method = httpMethod
-  req.rawHeaders = []
-  req.headers = {}
-
-  // Expose Netlify Function event and callback on request object.
-  // This makes it possible to access the clientContext, for example.
-  // See: https://github.com/netlify/next-on-netlify/issues/20
-  // It also allows users to change the behavior of waiting for empty event
-  // loop.
-  // See: https://github.com/netlify/next-on-netlify/issues/66#issuecomment-719988804
-  req.netlifyFunctionParams = { event, context }
-
-  for (const key of Object.keys(multiValueHeaders)) {
-    for (const value of multiValueHeaders[key]) {
-      req.rawHeaders.push(key)
-      req.rawHeaders.push(value)
-    }
-    req.headers[key.toLowerCase()] = multiValueHeaders[key].toString()
-  }
-
-  req.getHeader = (name) => req.headers[name.toLowerCase()]
-  req.getHeaders = () => req.headers
-
-  req.connection = {}
-
-  if (body) {
-    req.push(body, isBase64Encoded ? 'base64' : undefined)
-  }
-
-  req.push(null)
-
-  return req
-}
-
-// Mock a HTTP ServerResponse object that returns a Netlify Function-compatible
-// response via the onResEnd callback when res.end() is called.
-// Based on API Gateway Lambda Compat
-// Source: https://github.com/serverless-nextjs/serverless-next.js/blob/master/packages/compat-layers/apigw-lambda-compat/lib/compatLayer.js
-
-const createResponseObject = ({ onResEnd }) => {
-  const response = {
-    isBase64Encoded: true,
-    multiValueHeaders: {},
-  }
-
-  const res = new Stream()
-  Object.defineProperty(res, 'statusCode', {
-    get() {
-      return response.statusCode
-    },
-    set(statusCode) {
-      response.statusCode = statusCode
-    },
-  })
-  res.headers = {}
-  res.writeHead = (status, headers) => {
-    response.statusCode = status
-    if (headers) res.headers = Object.assign(res.headers, headers)
-
-    // Return res object to allow for chaining
-    // Fixes: https://github.com/netlify/next-on-netlify/pull/74
-    return res
-  }
-  res.write = (chunk) => {
-    if (!response.body) {
-      response.body = Buffer.from('')
-    }
-
-    response.body = Buffer.concat([
-      Buffer.isBuffer(response.body) ? response.body : Buffer.from(response.body),
-      Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk),
-    ])
-  }
-  res.setHeader = (name, value) => {
-    res.headers[name.toLowerCase()] = value
-  }
-  res.removeHeader = (name) => {
-    delete res.headers[name.toLowerCase()]
-  }
-  res.getHeader = (name) => res.headers[name.toLowerCase()]
-  res.getHeaders = () => res.headers
-  res.hasHeader = (name) => Boolean(res.getHeader(name))
-  res.end = (text) => {
-    if (text) res.write(text)
-    if (!res.statusCode) {
-      res.statusCode = 200
-    }
-
-    if (response.body) {
-      response.body = Buffer.from(response.body).toString('base64')
-    }
-    response.multiValueHeaders = res.headers
-    res.writeHead(response.statusCode)
-
-    // Convert all multiValueHeaders into arrays
-    for (const key of Object.keys(response.multiValueHeaders)) {
-      if (!Array.isArray(response.multiValueHeaders[key])) {
-        response.multiValueHeaders[key] = [response.multiValueHeaders[key]]
-      }
-    }
-
-    res.finished = true
-    res.writableEnded = true
-    // Call onResEnd handler with the response object
-    onResEnd(response)
-  }
-
-  return res
-}
-
-// Render the Next.js page
-const renderNextPage = ({ event, context }, nextPage) => {
-  // The Next.js page is rendered inside a promise that is resolved when the
-  // Next.js page ends the response via `res.end()`
-  const promise = new Promise((resolve) => {
-    // Create a Next.js-compatible request and response object
-    // These mock the ClientRequest and ServerResponse classes from node http
-    // See: https://nodejs.org/api/http.html
-    const req = createRequestObject({ event, context })
-    const res = createResponseObject({
-      onResEnd: (response) => resolve(response),
-    })
-
-    // Check if page is a Next.js page or an API route
-    const isNextPage = nextPage.render instanceof Function
-    const isApiRoute = !isNextPage
-
-    // Perform the render: render() for Next.js page or default() for API route
-    if (isNextPage) return nextPage.render(req, res)
-    if (isApiRoute) return nextPage.default(req, res)
-  })
-
-  // Return the promise
-  return promise
-}
-
-const getHandlerFunction = (nextPage) => async (event, context) => {
-  // x-forwarded-host is undefined on Netlify for proxied apps that need it
-  // fixes https://github.com/netlify/next-on-netlify/issues/46
-  if (!event.multiValueHeaders.hasOwnProperty('x-forwarded-host')) {
-    // eslint-disable-next-line no-param-reassign
-    event.multiValueHeaders['x-forwarded-host'] = [event.headers.host]
-  }
-
-  // Get the request URL
-  const { path } = event
-  console.log('[request]', path)
-
-  // Render the Next.js page
-  const response = await renderNextPage({ event, context }, nextPage)
-
-  // Convert header values to string. Netlify does not support integers as
-  // header values. See: https://github.com/netlify/cli/issues/451
-  Object.keys(response.multiValueHeaders).forEach((key) => {
-    response.multiValueHeaders[key] = response.multiValueHeaders[key].map((value) => String(value))
-  })
-
-  response.multiValueHeaders['Cache-Control'] = ['no-cache']
-
-  return response
-}
-
-exports.getHandlerFunction = getHandlerFunction

package/src/lib/templates/getTemplate.js

@@ -1,15 +0,0 @@
-const getTemplate = ({ filePath, isODB }) => {
-  if (isODB) {
-    return `// Auto-generated file. DO NOT MODIFY.
-const { getHandlerFunction } = require('./getHandlerFunction')
-const { builder } = require('@netlify/functions')
-exports.handler = builder(getHandlerFunction(require("./nextPage/${filePath}")))
-`
-  }
-  return `// Auto-generated file. DO NOT MODIFY.
-const { getHandlerFunction } = require('./getHandlerFunction')
-exports.handler = getHandlerFunction(require("./nextPage/${filePath}"))
-  `
-}
-
-module.exports = getTemplate