Merge branch 'mk/self-global' of github.com:netlify/next-runtime into mk/self-global

Author: ericapisani

README.md

@@ -44,7 +44,7 @@ by targeting the `/_next/image/*` route:
 
 ## Disabling included image loader
 
-If you wish to disable the use of the image loader which is bundled into the runtime by default, set the `DISABLE_IPX` environment variable to `true`. 
+If you wish to disable the use of the image loader which is bundled into the runtime by default, set the `DISABLE_IPX` environment variable to `true`.
 
 This should only be done if the site is not using `next/image` or is using a different loader (such as Cloudinary or Imgix).
 
@@ -60,7 +60,7 @@ For more details on Next.js Middleware with Netlify, see the [middleware docs](h
 
 ### Limitations
 
-Due to how the site configuration is handled when it's run using Netlify Edge Functions, data such as `locale` and `defaultLocale` will be missing on the `req.nextUrl` object when running `netlify dev`. 
+Due to how the site configuration is handled when it's run using Netlify Edge Functions, data such as `locale` and `defaultLocale` will be missing on the `req.nextUrl` object when running `netlify dev`.
 
 However, this data is available on `req.nextUrl` in a production environment.
 
@@ -107,7 +107,15 @@ Edge runtime or middleware is enabled it will also generate edge functions for m
 
 ## Manually installing the Next.js Runtime
 
-The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it manually like this:
+The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it manually in the
+following ways:
+
+### From the UI (Recommended):
+
+You can go to the [UI](https://app.netlify.com/plugins/@netlify/plugin-nextjs/install) and choose the site to install the Next.js Runtime on. This method
+is recommended because you will benefit from auto-upgrades to important fixes and feature updates.
+
+### From `npm`:
 
 ```shell
 npm install -D @netlify/plugin-nextjs
@@ -117,9 +125,11 @@ npm install -D @netlify/plugin-nextjs
 
 ```toml
 [[plugins]]
-package = "@netlify/plugin-nextjs"
+  package = "@netlify/plugin-nextjs"
 ```
 
+This method is recommended if you wish to pin the Next.js Runtime to a specific version.
+
 ## Manually upgrading from an older version of the Next.js Runtime
 
 If you previously set these values, they're no longer needed and should be removed:
@@ -139,7 +149,7 @@ information on changes to how they are handled in this version. In particular, n
 files must be placed in `public`, not in the root of the site.
 
 ## Using with pnpm
-If your site uses pnpm to manage dependencies, currently you must [enable public hoisting](https://pnpm.io/npmrc#public-hoist-pattern). 
+If your site uses pnpm to manage dependencies, currently you must [enable public hoisting](https://pnpm.io/npmrc#public-hoist-pattern).
 The simplest way to do this is to create a `.npmrc` file in the root of your project with the content:
 
 ```ini

packages/runtime/src/helpers/edge.ts

@@ -117,6 +117,7 @@ const fetch = async (url, init) => {
 }
 
 // Next edge runtime uses "self" as a function-scoped global-like object, but some of the older polyfills expect it to equal globalThis
+// See https://nextjs.org/docs/basic-features/supported-browsers-features#polyfills
 const self = { ...globalThis, fetch }
 
 `

packages/runtime/src/helpers/files.ts

@@ -337,11 +337,13 @@ const getServerFile = (root: string, includeBase = true) => {
 /**
  * Find the source file for a given page route
  */
-export const getSourceFileForPage = (page: string, root: string) => {
-  for (const extension of SOURCE_FILE_EXTENSIONS) {
-    const file = join(root, `${page}.${extension}`)
-    if (existsSync(file)) {
-      return file
+export const getSourceFileForPage = (page: string, roots: string[]) => {
+  for (const root of roots) {
+    for (const extension of SOURCE_FILE_EXTENSIONS) {
+      const file = join(root, `${page}.${extension}`)
+      if (existsSync(file)) {
+        return file
+      }
     }
   }
   console.log('Could not find source file for page', page)

packages/runtime/src/helpers/functions.ts

@@ -169,11 +169,14 @@ export const setupImageFunction = async ({
 export const getApiRouteConfigs = async (publish: string, baseDir: string): Promise<Array<ApiRouteConfig>> => {
   const pages = await readJSON(join(publish, 'server', 'pages-manifest.json'))
   const apiRoutes = Object.keys(pages).filter((page) => page.startsWith('/api/'))
+  // two possible places
+  // Ref: https://nextjs.org/docs/advanced-features/src-directory
   const pagesDir = join(baseDir, 'pages')
+  const srcPagesDir = join(baseDir, 'src', 'pages')
 
   return await Promise.all(
     apiRoutes.map(async (apiRoute) => {
-      const filePath = getSourceFileForPage(apiRoute, pagesDir)
+      const filePath = getSourceFileForPage(apiRoute, [pagesDir, srcPagesDir])
       return { route: apiRoute, config: await extractConfigFromFile(filePath), compiled: pages[apiRoute] }
     }),
   )

test/e2e/jest.config.js

@@ -14,7 +14,7 @@ const config = {
     '\\.[jt]sx?$': 'babel-jest',
   },
   verbose: true,
-  testTimeout: 60000,
+  testTimeout: 300000,
   moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],
   moduleNameMapper: {
     'e2e-utils': '<rootDir>/next-test-lib/e2e-utils.ts',