@netlify/plugin-nextjs 3.9.1 → 4.0.0-beta.11

package/src/lib/helpers/isRouteWithDataRoute.js

@@ -1,13 +0,0 @@
-const getRoutesManifest = require('./getRoutesManifest')
-
-// Return true if the route has a data route in the routes manifest
-const isRouteWithDataRoute = async (route) => {
-  const { dataRoutes } = await getRoutesManifest()
-
-  // If no data routes exist, return false
-  if (dataRoutes == null) return false
-
-  return dataRoutes.find((dataRoute) => dataRoute.page === route)
-}
-
-module.exports = isRouteWithDataRoute

package/src/lib/helpers/isRouteWithFallback.js

@@ -1,12 +0,0 @@
-const getPrerenderManifest = require('./getPrerenderManifest')
-
-const isRouteWithFallback = async (route) => {
-  if (!route) return false
-
-  const { dynamicRoutes } = await getPrerenderManifest()
-
-  // Fallback "blocking" routes will have fallback: null in manifest
-  return dynamicRoutes[route] && dynamicRoutes[route].fallback !== false
-}
-
-module.exports = isRouteWithFallback

package/src/lib/helpers/logger.js

@@ -1,44 +0,0 @@
-// Helpers for writing info to console.log
-const { program } = require('commander')
-
-// Number of items processed in current build step
-let itemsCount = 0
-
-// Format in bold
-const logTitle = (...args) => {
-  // Finish previous log section
-  finishLogForBuildStep()
-
-  // Print title
-  log(`\x1b[1m${args.join(' ')}\x1b[22m`)
-}
-
-// Indent by three spaces
-const logItem = (...args) => {
-  // Display item if within max log lines
-  if (itemsCount < program.maxLogLines) log('  ', ...args)
-
-  itemsCount += 1
-}
-
-// Just console.log
-const log = (...args) => console.log(...args)
-
-// Finish log section: Write a single line for any suppressed/hidden items
-// and reset the item counter
-const finishLogForBuildStep = () => {
-  // Display number of suppressed log lines
-  if (itemsCount > program.maxLogLines) {
-    const hiddenLines = itemsCount - program.maxLogLines
-    log('  ', '+', hiddenLines, 'more', '(run next-on-netlify with --max-log-lines XX to', 'show more or fewer lines)')
-  }
-
-  // Reset counter
-  itemsCount = 0
-}
-
-module.exports = {
-  logTitle,
-  logItem,
-  log,
-}

package/src/lib/helpers/removeFileExtension.js

@@ -1,4 +0,0 @@
-// Remove the file extension form the route
-const removeFileExtension = (route) => route.replace(/\.[a-zA-Z]+$/, '')
-
-module.exports = removeFileExtension

package/src/lib/helpers/runJobsQueue.js

@@ -1,18 +0,0 @@
-const os = require('os')
-
-const fastq = require('fastq')
-
-const { processPage } = require('../pages/worker')
-
-// TODO: benchmark a large site to find a good value for this
-const PAGE_CONCURRENCY = 4
-
-const runJobsQueue = (jobs) => {
-  console.log(`Building ${jobs.length} pages`)
-
-  const queue = fastq.promise(processPage, PAGE_CONCURRENCY)
-
-  return Promise.all(jobs.map((job) => queue.push(job)))
-}
-
-module.exports = runJobsQueue

package/src/lib/helpers/setupNetlifyFunctionForPage.js

@@ -1,44 +0,0 @@
-const { join } = require('path')
-
-const { copySync, writeFile, ensureDir, copy } = require('fs-extra')
-
-const { TEMPLATES_DIR } = require('../config')
-const getTemplate = require('../templates/getTemplate')
-
-const copyDynamicImportChunks = require('./copyDynamicImportChunks')
-const getNetlifyFunctionName = require('./getNetlifyFunctionName')
-const getNextDistDir = require('./getNextDistDir')
-const getPreviewModeFunctionName = require('./getPreviewModeFunctionName')
-const { logItem } = require('./logger')
-
-// Create a Netlify Function for the page with the given file path
-const setupNetlifyFunctionForPage = async ({ filePath, functionsPath, isApiPage, isODB, forFallbackPreviewMode }) => {
-  // Set function name based on file path
-  const defaultFunctionName = getNetlifyFunctionName(filePath, isApiPage)
-  const functionName = forFallbackPreviewMode ? getPreviewModeFunctionName(defaultFunctionName) : defaultFunctionName
-  const functionDirectory = join(functionsPath, functionName)
-
-  await ensureDir(functionDirectory)
-
-  if (isApiPage && functionName.endsWith('-background')) {
-    logItem(`👁 Setting up API page ${functionName} as a Netlify background function`)
-  }
-
-  // Write entry point to function directory
-  const entryPointPath = join(functionDirectory, `${functionName}.js`)
-  await writeFile(entryPointPath, getTemplate({ filePath, isODB }))
-
-  // Copy function helper
-  await copy(join(TEMPLATES_DIR, 'getHandlerFunction.js'), join(functionDirectory, 'getHandlerFunction.js'))
-
-  // Copy any dynamic import chunks
-  await copyDynamicImportChunks(functionDirectory)
-
-  // Copy page to our custom path
-  const nextPageCopyPath = join(functionDirectory, 'nextPage', filePath)
-  const nextDistDir = await getNextDistDir()
-
-  copySync(join(nextDistDir, 'serverless', filePath), nextPageCopyPath)
-}
-
-module.exports = setupNetlifyFunctionForPage

package/src/lib/helpers/setupStaticFileForPage.js

@@ -1,18 +0,0 @@
-const { join } = require('path')
-
-const { copySync } = require('fs-extra')
-
-const getNextDistDir = require('./getNextDistDir')
-
-// Copy the static asset from pages/inputPath to out_publish/outputPath
-const setupStaticFileForPage = async ({ inputPath, outputPath = null, publishPath }) => {
-  const nextDistDir = await getNextDistDir()
-
-  // Perform copy operation
-  copySync(join(nextDistDir, 'serverless', 'pages', inputPath), join(publishPath, outputPath || inputPath), {
-    overwrite: false,
-    errorOnExist: true,
-  })
-}
-
-module.exports = setupStaticFileForPage

package/src/lib/pages/api/pages.js

@@ -1,22 +0,0 @@
-const getPagesManifest = require('../../helpers/getPagesManifest')
-const isApiRoute = require('../../helpers/isApiRoute')
-
-const getPages = async () => {
-  // Get HTML and SSR pages and API endpoints from the NextJS pages manifest
-  const pagesManifest = await getPagesManifest()
-
-  // Collect pages
-  const pages = []
-
-  // Parse pages
-  Object.entries(pagesManifest).forEach(([route, filePath]) => {
-    // Skip non-API endpoints
-    if (!isApiRoute(route)) return
-
-    // Add page
-    pages.push({ route, filePath })
-  })
-  return pages
-}
-
-module.exports = getPages

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

@@ -1,13 +0,0 @@
-const getNetlifyFunctionName = require('../../helpers/getNetlifyFunctionName')
-
-const getPages = require('./pages')
-
-const getRedirects = async () => {
-  const pages = await getPages()
-  return pages.map(({ route, filePath }) => ({
-    route,
-    target: `/.netlify/functions/${getNetlifyFunctionName(filePath, true)}`,
-  }))
-}
-
-module.exports = getRedirects

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

@@ -1,15 +0,0 @@
-const { logTitle } = require('../../helpers/logger')
-
-const getPages = require('./pages')
-
-// Create a Netlify Function for every API endpoint
-const setup = async (functionsPath) => {
-  logTitle('💫 Setting up API endpoints as Netlify Functions in', functionsPath)
-
-  const pages = await getPages()
-
-  // Create Netlify Function job for every page
-  return pages.map(({ filePath }) => ({ type: 'function', filePath, functionsPath, isApiPage: true }))
-}
-
-module.exports = setup

package/src/lib/pages/getInitialProps/pages.js

@@ -1,40 +0,0 @@
-const asyncForEach = require('../../helpers/asyncForEach')
-const getPagesManifest = require('../../helpers/getPagesManifest')
-const isApiRoute = require('../../helpers/isApiRoute')
-const isFrameworkRoute = require('../../helpers/isFrameworkRoute')
-const isHtmlFile = require('../../helpers/isHtmlFile')
-const isRouteInPrerenderManifest = require('../../helpers/isRouteInPrerenderManifest')
-const isRouteWithDataRoute = require('../../helpers/isRouteWithDataRoute')
-
-const getPages = async () => {
-  // Get HTML and SSR pages and API endpoints from the NextJS pages manifest
-  const pagesManifest = await getPagesManifest()
-
-  // Collect pages
-  const pages = []
-
-  // Parse pages
-  await asyncForEach(Object.entries(pagesManifest), async ([route, filePath]) => {
-    // Ignore HTML files
-    if (isHtmlFile(filePath)) return
-
-    // Skip framework pages, such as _app and _error
-    if (isFrameworkRoute(route)) return
-
-    // Skip API endpoints
-    if (isApiRoute(route)) return
-
-    // Skip page if it is actually used with getStaticProps
-    if (await isRouteInPrerenderManifest(route)) return
-
-    // Skip page if it has a data route (because then it is a page with
-    // getServerSideProps)
-    if (await isRouteWithDataRoute(route)) return
-
-    // Add page
-    pages.push({ route, filePath })
-  })
-  return pages
-}
-
-module.exports = getPages

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

@@ -1,26 +0,0 @@
-const addLocaleRedirects = require('../../helpers/addLocaleRedirects')
-const asyncForEach = require('../../helpers/asyncForEach')
-const getNetlifyFunctionName = require('../../helpers/getNetlifyFunctionName')
-
-const getPages = require('./pages')
-
-const getRedirects = async () => {
-  const redirects = []
-  const pages = await getPages()
-
-  await asyncForEach(pages, async ({ route, filePath }) => {
-    const functionName = getNetlifyFunctionName(filePath)
-    const target = `/.netlify/functions/${functionName}`
-
-    await addLocaleRedirects(redirects, route, target)
-
-    redirects.push({
-      route,
-      target,
-    })
-  })
-
-  return redirects
-}
-
-module.exports = getRedirects

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

@@ -1,15 +0,0 @@
-const { logTitle } = require('../../helpers/logger')
-
-const getPages = require('./pages')
-
-// Create a Netlify Function for every page with getInitialProps
-const setup = async (functionsPath) => {
-  logTitle('💫 Setting up pages with getInitialProps as Netlify Functions in', functionsPath)
-
-  const pages = await getPages()
-
-  // Create Netlify Function for every page
-  return pages.map(({ filePath }) => ({ type: 'function', filePath, functionsPath }))
-}
-
-module.exports = setup

package/src/lib/pages/getServerSideProps/pages.js

@@ -1,43 +0,0 @@
-const asyncForEach = require('../../helpers/asyncForEach')
-const getPagesManifest = require('../../helpers/getPagesManifest')
-const isApiRoute = require('../../helpers/isApiRoute')
-const isFrameworkRoute = require('../../helpers/isFrameworkRoute')
-const isHtmlFile = require('../../helpers/isHtmlFile')
-const isRouteInPrerenderManifest = require('../../helpers/isRouteInPrerenderManifest')
-const isRouteWithDataRoute = require('../../helpers/isRouteWithDataRoute')
-
-const getPages = async () => {
-  // Collect pages
-  const pages = []
-
-  // Get HTML and SSR pages and API endpoints from the NextJS pages manifest
-  const pagesManifest = await getPagesManifest()
-
-  // Parse pages
-  await asyncForEach(Object.entries(pagesManifest), async ([route, filePath]) => {
-    // Ignore HTML files
-    if (isHtmlFile(filePath)) return
-
-    // Skip framework pages, such as _app and _error
-    if (isFrameworkRoute(route)) return
-
-    // Skip API endpoints
-    if (isApiRoute(route)) return
-
-    // Skip page if it is actually used with getStaticProps
-    const isInPrerenderManifest = await isRouteInPrerenderManifest(route)
-    if (isInPrerenderManifest) return
-
-    // Skip page if it has no data route (because then it is a page with
-    // getInitialProps)
-    const hasDataRoute = await isRouteWithDataRoute(route)
-    if (!hasDataRoute) return
-
-    // Add page
-    pages.push({ route, filePath })
-  })
-
-  return pages
-}
-
-module.exports = getPages

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

@@ -1,44 +0,0 @@
-const addLocaleRedirects = require('../../helpers/addLocaleRedirects')
-const asyncForEach = require('../../helpers/asyncForEach')
-const getDataRouteForRoute = require('../../helpers/getDataRouteForRoute')
-const getNetlifyFunctionName = require('../../helpers/getNetlifyFunctionName')
-
-const getPages = require('./pages')
-
-// getServerSideProps pages
-//
-// Page params {
-//     route -> '/ssr', '/ssr/[id]'
-//     filePath -> 'pages/ssr.js', 'pages/ssr/[id].js'
-// }
-//
-
-const getRedirects = async () => {
-  const redirects = []
-  const pages = await getPages()
-
-  await asyncForEach(pages, async ({ route, filePath }) => {
-    const functionName = getNetlifyFunctionName(filePath)
-    const target = `/.netlify/functions/${functionName}`
-
-    await addLocaleRedirects(redirects, route, target)
-
-    // Add one redirect for the naked route
-    // i.e. /ssr
-    redirects.push({
-      route,
-      target,
-    })
-
-    // Add one redirect for the data route;
-    // pages-manifest doesn't provide the dataRoute for us so we
-    // construct it ourselves with getDataRouteForRoute
-    redirects.push({
-      route: await getDataRouteForRoute(route),
-      target,
-    })
-  })
-  return redirects
-}
-
-module.exports = getRedirects

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

@@ -1,15 +0,0 @@
-const { logTitle } = require('../../helpers/logger')
-
-const getPages = require('./pages')
-
-// Create a Netlify Function for every page with getServerSideProps
-const setup = async (functionsPath) => {
-  logTitle('💫 Setting up pages with getServerSideProps as Netlify Functions in', functionsPath)
-
-  const pages = await getPages()
-
-  // Create Netlify Function for every page
-  return pages.map(({ filePath }) => ({ type: 'function', filePath, functionsPath }))
-}
-
-module.exports = setup

package/src/lib/pages/getStaticProps/pages.js

@@ -1,26 +0,0 @@
-const asyncForEach = require('../../helpers/asyncForEach')
-const getPrerenderManifest = require('../../helpers/getPrerenderManifest')
-const isRouteWithFallback = require('../../helpers/isRouteWithFallback')
-
-// Get pages using getStaticProps
-const getPages = async () => {
-  const { routes } = await getPrerenderManifest()
-
-  // Collect pages
-  const pages = []
-
-  await asyncForEach(Object.entries(routes), async ([route, { dataRoute, initialRevalidateSeconds, srcRoute }]) => {
-    // Ignore pages with revalidate (but no fallback), these will need to be SSRed
-    const isFallbackRoute = await isRouteWithFallback(srcRoute)
-    if (initialRevalidateSeconds && !isFallbackRoute) return
-
-    pages.push({
-      route,
-      dataRoute,
-      srcRoute,
-    })
-  })
-  return pages
-}
-
-module.exports = getPages

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

@@ -1,70 +0,0 @@
-const { join } = require('path')
-
-const slash = require('slash')
-
-const addDefaultLocaleRedirect = require('../../helpers/addDefaultLocaleRedirect')
-const asyncForEach = require('../../helpers/asyncForEach')
-const getFilePathForRoute = require('../../helpers/getFilePathForRoute')
-const getNetlifyFunctionName = require('../../helpers/getNetlifyFunctionName')
-const getPreviewModeFunctionName = require('../../helpers/getPreviewModeFunctionName')
-const isRouteWithFallback = require('../../helpers/isRouteWithFallback')
-
-const getPages = require('./pages')
-
-// getStaticProps pages
-//
-// Page params {
-//     route -> '/getStaticProps', '/getStaticProps/3'
-//     dataRoute -> '/_next/data/{BUILD_ID}/getStaticProps.json', '_next/data/{BUILD_ID}/getStaticProps/3.json'
-//     srcRoute -> null, /getStaticProps/[id]
-// }
-//
-// Page params with i18n {
-//     route -> '/getStaticProps', '/en/getStaticProps/3'
-//     dataRoute -> '/_next/data/{BUILD_ID}/getStaticProps.json', '_next/data/{BUILD_ID}/en/getStaticProps/3.json'
-//     srcRoute -> null, /getStaticProps/[id]
-// }
-//
-//
-
-// Pages with getStaticProps (without fallback or revalidation) only need
-// redirects for i18n and handling preview mode
-const getRedirects = async () => {
-  const redirects = []
-  const pages = await getPages()
-
-  await asyncForEach(pages, async ({ route, dataRoute, srcRoute }) => {
-    const relativePath = getFilePathForRoute(srcRoute || route, 'js')
-    const filePath = slash(join('pages', relativePath))
-    const functionName = getNetlifyFunctionName(filePath)
-    const isODB = await isRouteWithFallback(srcRoute)
-
-    // Preview mode conditions
-    const conditions = ['Cookie=__prerender_bypass,__next_preview_data']
-    // ODB pages' preview mode needs a special flagged standard function because
-    // their default function (an ODB) is not functional for preview mode
-    const target = `/.netlify/functions/${functionName}`
-    const previewModeTarget = isODB ? `/.netlify/functions/${getPreviewModeFunctionName(functionName)}` : target
-    const previewModeRedirect = { conditions, force: true, target: previewModeTarget }
-
-    // Add a preview mode redirect for the standard route
-    redirects.push({
-      route,
-      ...previewModeRedirect,
-    })
-
-    // Add a preview mode redirect for the data route, same conditions
-    redirects.push({
-      route: dataRoute,
-      ...previewModeRedirect,
-    })
-
-    // Preview mode default locale redirect must precede normal default locale redirect
-    await addDefaultLocaleRedirect(redirects, route, target, { conditions, force: true })
-    await addDefaultLocaleRedirect(redirects, route)
-  })
-
-  return redirects
-}
-
-module.exports = getRedirects

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

@@ -1,68 +0,0 @@
-const { join } = require('path')
-
-const { copySync } = require('fs-extra')
-const slash = require('slash')
-
-const getFilePathForRoute = require('../../helpers/getFilePathForRoute')
-const getI18n = require('../../helpers/getI18n')
-const getNextDistDir = require('../../helpers/getNextDistDir')
-const isRouteWithFallback = require('../../helpers/isRouteWithFallback')
-const { logTitle } = require('../../helpers/logger')
-
-const getPages = require('./pages')
-
-// Copy pre-rendered SSG pages
-const setup = async ({ functionsPath, publishPath }) => {
-  logTitle('🔥 Copying pre-rendered pages with getStaticProps and JSON data to', publishPath)
-  // Keep track of the functions that have been set up, so that we do not set up
-  // a function for the same file path twice
-  const filePathsDone = new Set()
-  const pages = await getPages()
-  const nextDistDir = await getNextDistDir()
-  const i18n = await getI18n()
-
-  const jobs = []
-
-  await Promise.all(
-    pages.map(async ({ route, dataRoute, srcRoute }) => {
-      // Copy pre-rendered HTML page
-      const htmlPath = getFilePathForRoute(route, 'html')
-
-      jobs.push({ type: 'static', inputPath: htmlPath, publishPath })
-
-      // Copy page's JSON data
-      const jsonPath = getFilePathForRoute(route, 'json')
-      jobs.push({
-        type: 'static',
-        inputPath: jsonPath,
-        outputPath: dataRoute,
-        publishPath,
-      })
-
-      // HACK: If i18n, 404.html needs to be at the top level of the publish directory
-      if (i18n.defaultLocale && route === `/${i18n.defaultLocale}/404`) {
-        copySync(join(nextDistDir, 'serverless', 'pages', htmlPath), join(publishPath, '404.html'))
-      }
-
-      // Set up the Netlify function (this is ONLY for preview mode)
-      const relativePath = getFilePathForRoute(srcRoute || route, 'js')
-      const filePath = slash(join('pages', relativePath))
-
-      // Skip if we have already set up a function for this file
-
-      if (filePathsDone.has(filePath)) {
-        return
-      }
-      filePathsDone.add(filePath)
-
-      // or if the source route has a fallback (handled by getStaticPropsWithFallback)
-      if (await isRouteWithFallback(srcRoute)) {
-        return
-      }
-      jobs.push({ type: 'function', filePath, functionsPath })
-    }),
-  )
-  return jobs
-}
-
-module.exports = setup

package/src/lib/pages/getStaticPropsWithFallback/pages.js

@@ -1,24 +0,0 @@
-const getPrerenderManifest = require('../../helpers/getPrerenderManifest')
-
-// Get pages using getStaticProps
-const getPages = async () => {
-  const { dynamicRoutes } = await getPrerenderManifest()
-
-  // Collect pages
-  const pages = []
-
-  Object.entries(dynamicRoutes).forEach(([route, { dataRoute, fallback }]) => {
-    // Skip pages without fallback
-    if (fallback === false) return
-
-    // Add the page
-    pages.push({
-      route,
-      dataRoute,
-    })
-  })
-
-  return pages
-}
-
-module.exports = getPages

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

@@ -1,51 +0,0 @@
-const { join } = require('path')
-
-const slash = require('slash')
-
-const { PREVIEW_MODE_COOKIES } = require('../../config')
-const addLocaleRedirects = require('../../helpers/addLocaleRedirects')
-const asyncForEach = require('../../helpers/asyncForEach')
-const getFilePathForRoute = require('../../helpers/getFilePathForRoute')
-const getNetlifyFunctionName = require('../../helpers/getNetlifyFunctionName')
-const getPreviewModeFunctionName = require('../../helpers/getPreviewModeFunctionName')
-
-const getPages = require('./pages')
-
-const getRedirects = async () => {
-  const redirects = []
-  const pages = await getPages()
-
-  await asyncForEach(pages, async ({ route, dataRoute }) => {
-    const relativePath = getFilePathForRoute(route, 'js')
-    const filePath = slash(join('pages', relativePath))
-    const functionName = getNetlifyFunctionName(filePath)
-    const target = `/.netlify/functions/${functionName}`
-    const previewModeTarget = `/.netlify/functions/${getPreviewModeFunctionName(functionName)}`
-
-    await addLocaleRedirects(redirects, route, target)
-
-    // Add a redirect for preview mode pointing to the standard function
-    redirects.push({
-      route,
-      target: previewModeTarget,
-      conditions: PREVIEW_MODE_COOKIES,
-      force: true,
-      specialPreviewMode: true,
-    })
-
-    // Add one redirect pointing to the ODB
-    redirects.push({
-      route,
-      target,
-    })
-
-    // Add one redirect for the data route
-    redirects.push({
-      route: dataRoute,
-      target,
-    })
-  })
-  return redirects
-}
-
-module.exports = getRedirects