feat: support dotenv files (#429)

* test: add e2e tests for checking access to env vars defined in dot env files

* fix: support dotenv files in generated handler function

---------

Co-authored-by: Mateusz Bocian <[email protected]>

Author: pieh

src/build/functions/server.ts

@@ -20,30 +20,38 @@ const tracer = wrapTracer(trace.getTracer('Next runtime'))
 const copyHandlerDependencies = async (ctx: PluginContext) => {
   await tracer.withActiveSpan('copyHandlerDependencies', async (span) => {
     const promises: Promise<void>[] = []
-    const { included_files: includedFiles = [] } = ctx.netlifyConfig.functions?.['*'] || {}
     // if the user specified some files to include in the lambda
     // we need to copy them to the functions-internal folder
+    const { included_files: includedFiles = [] } = ctx.netlifyConfig.functions?.['*'] || {}
+
+    // we also force including the .env files to ensure those are available in the lambda
+    includedFiles.push(
+      posixJoin(ctx.relativeAppDir, '.env'),
+      posixJoin(ctx.relativeAppDir, '.env.production'),
+      posixJoin(ctx.relativeAppDir, '.env.local'),
+      posixJoin(ctx.relativeAppDir, '.env.production.local'),
+    )
+
     span.setAttribute('next.includedFiles', includedFiles.join(','))
-    if (includedFiles.length !== 0) {
-      const resolvedFiles = await Promise.all(
-        includedFiles.map((globPattern) => glob(globPattern, { cwd: process.cwd() })),
+
+    const resolvedFiles = await Promise.all(
+      includedFiles.map((globPattern) => glob(globPattern, { cwd: process.cwd() })),
+    )
+    for (const filePath of resolvedFiles.flat()) {
+      promises.push(
+        cp(
+          join(process.cwd(), filePath),
+          // the serverHandlerDir is aware of the dist dir.
+          // The distDir must not be the package path therefore we need to rely on the
+          // serverHandlerDir instead of the serverHandlerRootDir
+          // therefore we need to remove the package path from the filePath
+          join(ctx.serverHandlerDir, relative(ctx.relativeAppDir, filePath)),
+          {
+            recursive: true,
+            force: true,
+          },
+        ),
       )
-      for (const filePath of resolvedFiles.flat()) {
-        promises.push(
-          cp(
-            join(process.cwd(), filePath),
-            // the serverHandlerDir is aware of the dist dir.
-            // The distDir must not be the package path therefore we need to rely on the
-            // serverHandlerDir instead of the serverHandlerRootDir
-            // therefore we need to remove the package path from the filePath
-            join(ctx.serverHandlerDir, relative(ctx.relativeAppDir, filePath)),
-            {
-              recursive: true,
-              force: true,
-            },
-          ),
-        )
-      }
     }
 
     const fileList = await glob('dist/**/*', { cwd: ctx.pluginDir })

tests/e2e/nx-integrated.test.ts

@@ -29,3 +29,16 @@ test('Renders the Home page correctly with distDir', async ({ page, nxIntegrated
 
   await expectImageWasLoaded(page.locator('img'))
 })
+
+test('environment variables from .env files should be available for functions', async ({
+  nxIntegratedDistDir,
+}) => {
+  const response = await fetch(`${nxIntegratedDistDir.url}/api/env`)
+  const data = await response.json()
+  expect(data).toEqual({
+    '.env': 'defined in .env',
+    '.env.local': 'defined in .env.local',
+    '.env.production': 'defined in .env.production',
+    '.env.production.local': 'defined in .env.production.local',
+  })
+})

tests/e2e/page-router.test.ts

@@ -379,6 +379,19 @@ test.describe('Simple Page Router (no basePath, no i18n)', () => {
     expect(headers['netlify-cdn-cache-control']).toBe('max-age=31536000')
     expect(headers['cache-control']).toBe('public,max-age=0,must-revalidate')
   })
+
+  test('environment variables from .env files should be available for functions', async ({
+    pageRouter,
+  }) => {
+    const response = await fetch(`${pageRouter.url}/api/env`)
+    const data = await response.json()
+    expect(data).toEqual({
+      '.env': 'defined in .env',
+      '.env.local': 'defined in .env.local',
+      '.env.production': 'defined in .env.production',
+      '.env.production.local': 'defined in .env.production.local',
+    })
+  })
 })
 
 test.describe('Page Router with basePath and i18n', () => {

tests/e2e/turborepo.test.ts

@@ -206,4 +206,17 @@ test.describe('[NPM] Package manager', () => {
     const date3 = await page.textContent('[data-testid="date-now"]')
     expect(date3).not.toBe(date2)
   })
+
+  test('environment variables from .env files should be available for functions', async ({
+    turborepoNPM,
+  }) => {
+    const response = await fetch(`${turborepoNPM.url}/api/env`)
+    const data = await response.json()
+    expect(data).toEqual({
+      '.env': 'defined in .env',
+      '.env.local': 'defined in .env.local',
+      '.env.production': 'defined in .env.production',
+      '.env.production.local': 'defined in .env.production.local',
+    })
+  })
 })

tests/fixtures/nx-integrated/apps/custom-dist-dir/.env

@@ -0,0 +1 @@
+FROM_DOT_ENV="defined in .env"

tests/fixtures/nx-integrated/apps/custom-dist-dir/.env.local

@@ -0,0 +1 @@
+FROM_DOT_ENV_DOT_LOCAL="defined in .env.local"

tests/fixtures/nx-integrated/apps/custom-dist-dir/.env.production

@@ -0,0 +1 @@
+FROM_DOT_ENV_DOT_PRODUCTION="defined in .env.production"

tests/fixtures/nx-integrated/apps/custom-dist-dir/.env.production.local

@@ -0,0 +1 @@
+FROM_DOT_ENV_DOT_PRODUCTION_DOT_LOCAL="defined in .env.production.local"

tests/fixtures/nx-integrated/apps/custom-dist-dir/app/api/env/route.ts

@@ -0,0 +1,12 @@
+import { NextResponse } from 'next/server'
+
+export async function GET() {
+  return NextResponse.json({ 
+    '.env': process.env.FROM_DOT_ENV ?? 'undefined',
+    '.env.local': process.env.FROM_DOT_ENV_DOT_LOCAL ?? 'undefined',
+    '.env.production': process.env.FROM_DOT_ENV_DOT_PRODUCTION ?? 'undefined',
+    '.env.production.local': process.env.FROM_DOT_ENV_DOT_PRODUCTION_DOT_LOCAL ?? 'undefined',
+  })
+}
+
+export const dynamic = 'force-dynamic'

tests/fixtures/page-router/.env

@@ -0,0 +1 @@
+FROM_DOT_ENV="defined in .env"