Add initial support for new env handling

packages/next/build/entries.ts

@@ -7,6 +7,7 @@ import { isTargetLikeServerless } from '../next-server/server/config'
 import { normalizePagePath } from '../next-server/server/normalize-page-path'
 import { warn } from './output/log'
 import { ServerlessLoaderQuery } from './webpack/loaders/next-serverless-loader'
+import { EnvironmentConfig } from '../lib/load-env-config'
 
 type PagesMapping = {
   [page: string]: string
@@ -64,7 +65,8 @@ export function createEntrypoints(
   target: 'server' | 'serverless' | 'experimental-serverless-trace',
   buildId: string,
   previewMode: __ApiPreviewProps,
-  config: any
+  config: any,
+  envConfig: EnvironmentConfig
 ): Entrypoints {
   const client: WebpackEntrypoints = {}
   const server: WebpackEntrypoints = {}
@@ -73,6 +75,8 @@ export function createEntrypoints(
     Object.keys(config.publicRuntimeConfig).length > 0 ||
     Object.keys(config.serverRuntimeConfig).length > 0
 
+  const hasEnvConfig = Object.keys(envConfig).length > 0
+
   const defaultServerlessOptions = {
     absoluteAppPath: pages['/_app'],
     absoluteDocumentPath: pages['/_document'],
@@ -90,6 +94,7 @@ export function createEntrypoints(
         })
       : '',
     previewProps: JSON.stringify(previewMode),
+    envConfig: hasEnvConfig ? JSON.stringify(envConfig) : '',
   }
 
   Object.keys(pages).forEach(page => {

packages/next/build/index.ts

@@ -70,6 +70,7 @@ import {
 } from './utils'
 import getBaseWebpackConfig from './webpack-config'
 import { writeBuildId } from './write-build-id'
+import { loadEnvConfig } from '../lib/load-env-config'
 
 const fsAccess = promisify(fs.access)
 const fsUnlink = promisify(fs.unlink)
@@ -206,14 +207,19 @@ export default async function build(dir: string, conf = null): Promise<void> {
     previewModeSigningKey: crypto.randomBytes(32).toString('hex'),
     previewModeEncryptionKey: crypto.randomBytes(32).toString('hex'),
   }
+  // TODO: should we process config here also to show any errors
+  // from missing env values which will be missing for auto-export
+  // pages/SSG pages after the build completes
+  const envConfig = loadEnvConfig(dir, false)
 
   const mappedPages = createPagesMapping(pagePaths, config.pageExtensions)
   const entrypoints = createEntrypoints(
     mappedPages,
     target,
     buildId,
     previewProps,
-    config
+    config,
+    envConfig
   )
   const pageKeys = Object.keys(mappedPages)
   const dynamicRoutes = pageKeys.filter(page => isDynamicRoute(page))

packages/next/build/webpack/loaders/next-serverless-loader.ts

@@ -26,6 +26,7 @@ export type ServerlessLoaderQuery = {
   basePath: string
   runtimeConfig: string
   previewProps: string
+  envConfig: string
 }
 
 const nextServerlessLoader: loader.Loader = function() {
@@ -43,6 +44,7 @@ const nextServerlessLoader: loader.Loader = function() {
     basePath,
     runtimeConfig,
     previewProps,
+    envConfig,
   }: ServerlessLoaderQuery =
     typeof this.query === 'string' ? parse(this.query.substr(1)) : this.query
 
@@ -138,10 +140,21 @@ const nextServerlessLoader: loader.Loader = function() {
     }
   `
 
+  const envImports = envConfig
+    ? `
+    const { processEnv } = require('next/dist/lib/load-env-config')
+  `
+    : ''
+
+  const processedEnv = `
+    const processedEnv = ${envConfig ? `processEnv(${envConfig})` : '{}'}
+  `
+
   if (page.match(API_ROUTE)) {
     return `
       import initServer from 'next-plugin-loader?middleware=on-init-server!'
       import onError from 'next-plugin-loader?middleware=on-error-server!'
+      ${envImports}
       ${runtimeConfigImports}
       ${
         /*
@@ -157,6 +170,8 @@ const nextServerlessLoader: loader.Loader = function() {
       ${dynamicRouteMatcher}
       ${handleRewrites}
 
+      ${processedEnv}
+
       export default async (req, res) => {
         try {
           await initServer()
@@ -185,6 +200,7 @@ const nextServerlessLoader: loader.Loader = function() {
             Object.assign({}, parsedUrl.query, params ),
             resolver,
             ${encodedPreviewProps},
+            processedEnv,
             onError
           )
         } catch (err) {
@@ -215,6 +231,7 @@ const nextServerlessLoader: loader.Loader = function() {
     const App = require('${absoluteAppPath}').default;
     ${dynamicRouteImports}
     ${rewriteImports}
+    ${envImports}
 
     const ComponentInfo = require('${absolutePagePath}')
 
@@ -227,6 +244,7 @@ const nextServerlessLoader: loader.Loader = function() {
 
     ${dynamicRouteMatcher}
     ${handleRewrites}
+    ${processedEnv}
 
     export const config = ComponentInfo['confi' + 'g'] || {}
     export const _app = App
@@ -253,6 +271,7 @@ const nextServerlessLoader: loader.Loader = function() {
         assetPrefix: "${assetPrefix}",
         runtimeConfig: runtimeConfig.publicRuntimeConfig || {},
         previewProps: ${encodedPreviewProps},
+        env: processedEnv,
         ..._renderOpts
       }
       let _nextData = false

packages/next/export/index.ts

@@ -34,6 +34,7 @@ import loadConfig, {
 import { eventVersion } from '../telemetry/events'
 import { Telemetry } from '../telemetry/storage'
 import { normalizePagePath } from '../next-server/server/normalize-page-path'
+import { loadEnvConfig } from '../lib/load-env-config'
 
 const mkdirp = promisify(mkdirpModule)
 const copyFile = promisify(copyFileOrig)
@@ -226,6 +227,7 @@ export default async function(
     dir,
     buildId,
     nextExport: true,
+    env: loadEnvConfig(dir),
     assetPrefix: nextConfig.assetPrefix.replace(/\/$/, ''),
     distDir,
     dev: false,

packages/next/lib/find-pages-dir.ts

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import path from 'path'
 
-const existsSync = (f: string): boolean => {
+export const existsSync = (f: string): boolean => {
   try {
     fs.accessSync(f, fs.constants.F_OK)
     return true

packages/next/lib/load-env-config.ts

@@ -0,0 +1,84 @@
+import fs from 'fs'
+import path from 'path'
+import { existsSync } from './find-pages-dir'
+import { ENV_CONFIG_FILE } from '../next-server/lib/constants'
+
+type EnvironmentKey = {
+  description: string
+  required?: boolean // defaults to false
+  value?: string // the default value
+  env?: {
+    development: Omit<EnvironmentKey, 'env'>
+    production: Omit<EnvironmentKey, 'env'>
+    test: Omit<EnvironmentKey, 'env'>
+  }
+}
+export type EnvironmentConfig = {
+  [key: string]: EnvironmentKey
+}
+
+export type Env = { [key: string]: string }
+
+export function processEnv(_Env: EnvironmentConfig): Env {
+  const missingEnvItems = new Set()
+  const Env: Env = {}
+
+  for (const key of Object.keys(_Env)) {
+    const envItem = _Env[key]
+    let curValue: string | undefined = envItem.value
+    let isRequired = envItem.required
+
+    if (process.env[key]) {
+      curValue = process.env[key]
+    } else if (envItem.env) {
+      const nodeEnv = process.env.NODE_ENV
+      const subEnv = envItem.env[nodeEnv]
+
+      if (subEnv) {
+        if (typeof subEnv.required === 'boolean') {
+          isRequired = subEnv.required
+        }
+
+        if (subEnv.value) {
+          curValue = subEnv.value
+        }
+      }
+    }
+
+    if (curValue) {
+      Env[key] = curValue
+    } else if (isRequired) {
+      missingEnvItems.add(key)
+    }
+  }
+
+  if (missingEnvItems.size > 0) {
+    throw new Error(
+      `Required environment items from \`${ENV_CONFIG_FILE}\` are missing: ` +
+        `${[...missingEnvItems].join(', ')}`
+    )
+  }
+  return Env
+}
+
+// loads andy maybe populate env config items
+export function loadEnvConfig(dir: string): Env
+export function loadEnvConfig(dir: string, process: false): EnvironmentConfig
+export function loadEnvConfig(dir: any, process?: any): any {
+  const envPath = path.join(dir, ENV_CONFIG_FILE)
+
+  // don't use require so it's not cached in module cache
+  // in case we want to reload this file
+  if (!existsSync(envPath)) {
+    return {}
+  }
+  // don't use require so it's not cached in module cache
+  // in case we want to reload this file
+  const _Env: EnvironmentConfig = JSON.parse(fs.readFileSync(envPath, 'utf8'))
+
+  // TODO: do we want to validate extra/invalid fields in env.json?
+  if (process === false) {
+    return _Env
+  }
+  return processEnv(_Env)
+}

packages/next/next-server/lib/constants.ts

@@ -12,6 +12,7 @@ export const REACT_LOADABLE_MANIFEST = 'react-loadable-manifest.json'
 export const SERVER_DIRECTORY = 'server'
 export const SERVERLESS_DIRECTORY = 'serverless'
 export const CONFIG_FILE = 'next.config.js'
+export const ENV_CONFIG_FILE = 'env.json'
 export const BUILD_ID_FILE = 'BUILD_ID'
 export const BLOCKED_PAGES = ['/_document', '/_app']
 export const CLIENT_PUBLIC_FILES_PATH = 'public'

packages/next/next-server/lib/utils.ts

@@ -4,6 +4,7 @@ import { ComponentType } from 'react'
 import { format, URLFormatOptions, UrlObject } from 'url'
 import { ManifestItem } from '../server/load-components'
 import { NextRouter } from './router/router'
+import { Env } from '../../lib/load-env-config'
 
 /**
  * Types used by both next and next-server
@@ -180,6 +181,8 @@ export type NextApiRequest = IncomingMessage & {
   }
 
   body: any
+
+  env: Env
 }
 
 /**

packages/next/next-server/server/api-utils.ts

@@ -8,6 +8,7 @@ import { isResSent, NextApiRequest, NextApiResponse } from '../lib/utils'
 import { decryptWithSecret, encryptWithSecret } from './crypto-utils'
 import { interopDefault } from './load-components'
 import { Params } from './router'
+import { Env } from '../../lib/load-env-config'
 
 export type NextApiRequestCookies = { [key: string]: string }
 export type NextApiRequestQuery = { [key: string]: string | string[] }
@@ -24,26 +25,28 @@ export async function apiResolver(
   params: any,
   resolverModule: any,
   apiContext: __ApiPreviewProps,
+  envConfig: Env,
   onError?: ({ err }: { err: any }) => Promise<void>
 ) {
   const apiReq = req as NextApiRequest
   const apiRes = res as NextApiResponse
 
   try {
-    let config: PageConfig = {}
-    let bodyParser = true
     if (!resolverModule) {
       res.statusCode = 404
       res.end('Not Found')
       return
     }
+    const config: PageConfig = resolverModule.config || {}
+    const bodyParser = config.api?.bodyParser !== false
+
+    apiReq.env = config.env
+      ? config.env.reduce((prev: Env, key): Env => {
+          prev[key] = envConfig[key]
+          return prev
+        }, {})
+      : {}
 
-    if (resolverModule.config) {
-      config = resolverModule.config
-      if (config.api && config.api.bodyParser === false) {
-        bodyParser = false
-      }
-    }
     // Parsing of cookies
     setLazyProp({ req: apiReq }, 'cookies', getCookieParser(req))
     // Parsing query string

packages/next/next-server/server/load-components.ts

@@ -11,6 +11,7 @@ import { requirePage } from './require'
 import { BuildManifest } from './get-page-files'
 import { AppType, DocumentType } from '../lib/utils'
 import { PageConfig, NextPageContext } from 'next/types'
+import { Env } from '../../lib/load-env-config'
 
 export function interopDefault(mod: any) {
   return mod.default || mod
@@ -26,6 +27,7 @@ export type ManifestItem = {
 type ReactLoadableManifest = { [moduleId: string]: ManifestItem[] }
 
 type Unstable_getStaticProps = (ctx: {
+  env: Env
   params: ParsedUrlQuery | undefined
   preview?: boolean
   previewData?: any
@@ -39,6 +41,7 @@ export type Unstable_getStaticPaths = () => Promise<{
 }>
 
 type Unstable_getServerProps = (context: {
+  env: Env
   params: ParsedUrlQuery | undefined
   req: IncomingMessage
   res: ServerResponse

packages/next/next-server/server/next-server.ts

@@ -59,6 +59,7 @@ import {
   setSprCache,
 } from './spr-cache'
 import { isBlockedPage } from './utils'
+import { Env, loadEnvConfig } from '../../lib/load-env-config'
 
 const getCustomRouteMatcher = pathMatch(true)
 
@@ -115,6 +116,7 @@ export default class Server {
     hasCssMode: boolean
     dev?: boolean
     pages404?: boolean
+    env: Env
   }
   private compression?: Middleware
   private onErrorMiddleware?: ({ err }: { err: Error }) => Promise<void>
@@ -163,6 +165,8 @@ export default class Server {
       buildId: this.buildId,
       generateEtags,
       pages404: this.nextConfig.experimental.pages404,
+      // TODO: do we want to hot-reload this in development at all?
+      env: loadEnvConfig(dir),
     }
 
     // Only the `publicRuntimeConfig` key is exposed to the client side
@@ -671,6 +675,7 @@ export default class Server {
       query,
       pageModule,
       { ...previewProps },
+      this.renderOpts.env,
       this.onErrorMiddleware
     )
     return true