fix: resolving the paths correctly when the next-runtime is used from source (#77)

Fixes https://linear.app/netlify/issue/FRA-120/fix-dependency-tracing-when-using-runtime-from-source

Author: lukasholzer

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/next-runtime",
-  "version": "5.0.0-alpha.19",
+  "version": "5.0.0-alpha.24",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "./dist/index.js",
   "type": "module",

playwright.config.ts

@@ -19,30 +19,15 @@ export default defineConfig({
   use: {
     /* Base URL to use in actions like `await page.goto('/')`. */
     baseURL: process.env.URL,
-
     /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
     trace: 'on-first-retry',
   },
-
   timeout: 10 * 60 * 1000,
-
   /* Configure projects for major browsers */
   projects: [
-    // {
-    //   name: 'setup',
-    //   testMatch: /global\.setup\.ts/,
-    // },
     {
       name: 'chromium',
-      // dependencies: ['setup'],
       use: { ...devices['Desktop Chrome'] },
     },
   ],
-
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-  //   command: 'npm run start',
-  //   url: 'http://127.0.0.1:3000',
-  //   reuseExistingServer: !process.env.CI,
-  // },
 })

src/build/functions/server.ts

@@ -1,7 +1,7 @@
 import { NetlifyPluginOptions } from '@netlify/build'
 import { nodeFileTrace } from '@vercel/nft'
 import { cp, rm, writeFile } from 'fs/promises'
-import { join, relative, resolve } from 'node:path'
+import { basename, join, relative, resolve } from 'node:path'
 import {
   PLUGIN_DIR,
   PLUGIN_NAME,
@@ -35,14 +35,21 @@ export const createServerHandler = async ({
     },
   )
 
+  // if the parent directory of the plugin directory is not a @netlify folder we are consuming
+  // the runtime from source and not over node_modules
+  // this can be for example in the `netlify.toml` specified as the following
+  //   [[plugins]]
+  //   package = "../next-runtime-minimal"
+  // in this case we use the PLUGIN_DIR for calculating the relative path
+  const isRunFromSource = basename(join(PLUGIN_DIR, '..')) !== '@netlify'
+  const cwd = isRunFromSource ? PLUGIN_DIR : process.cwd()
+
   // copy the handler dependencies
   await Promise.all(
     [...fileList].map(async (path) => {
-      // we have to use a fake cwd that points to the actual repository root. On the deployed version this will be the build directory
-      // As in the integration tests the node_modules are not located in the tmp directory
-      const cwd = process.env.NETLIFY_FAKE_TEST_CWD || process.cwd()
       const absPath = `/${path}`
-      // if the file that got traced is inside the plugin directory resolve it with the plugin directory
+      // if the file that got traced is inside the plugin directory (like `dist/run/handlers/server.js`)
+      // resolve it with the plugin directory like `<abs-path>/node_modules/@netlify/next-runtime`
       // if it is a node_module resolve it with the process working directory.
       const relPath = relative(path.includes(PLUGIN_NAME) ? PLUGIN_DIR : cwd, absPath)
       await cp(absPath, resolve(SERVER_HANDLER_DIR, relPath), {

tests/e2e/page-router.test.ts

@@ -8,8 +8,8 @@ test.describe('page-router', () => {
     ctx = await createE2EFixture('page-router')
   })
 
-  test.afterAll(async () => {
-    await ctx?.cleanup?.()
+  test.afterAll(async ({}, testInfo) => {
+    await ctx?.cleanup?.(!!testInfo.errors.length)
   })
 
   // NOT working yet as blob storage upload ins not working with the CLI

tests/e2e/simple-app.test.ts

@@ -8,8 +8,8 @@ test.describe('simple-next-app', () => {
     ctx = await createE2EFixture('simple-next-app')
   })
 
-  test.afterAll(async () => {
-    await ctx?.cleanup?.()
+  test.afterAll(async ({}, testInfo) => {
+    await ctx?.cleanup?.(!!testInfo.errors.length)
   })
 
   test('Renders the Home page correctly', async ({ page }) => {

tests/utils/create-e2e-fixture.ts

@@ -1,7 +1,7 @@
 import { execaCommand } from 'execa'
 import fg from 'fast-glob'
 import { exec } from 'node:child_process'
-import { copyFile, mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises'
+import { copyFile, mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
 import { dirname, join } from 'node:path'
 import { fileURLToPath } from 'node:url'
@@ -12,9 +12,8 @@ import pLimit from 'p-limit'
 const SITE_ID = 'ee859ce9-44a7-46be-830b-ead85e445e53'
 
 export interface DeployResult {
-  site_name: string
-  deploy_id: string
-  deploy_url: string
+  deployID: string
+  url: string
   logs: string
 }
 
@@ -25,14 +24,22 @@ export interface DeployResult {
 export const createE2EFixture = async (fixture: string) => {
   const cwd = await mkdtemp(join(tmpdir(), 'netlify-next-runtime-'))
   let deployID: string
-  const _cleanup = () => cleanup(cwd, deployID)
+  let logs: string
+  const _cleanup = (failure: boolean = false) => {
+    if (failure) {
+      console.log(logs)
+    }
+    // on failures we don't delete the deploy
+    return cleanup(cwd, failure === true ? undefined : deployID)
+  }
   try {
     const [packageName] = await Promise.all([buildAndPackRuntime(cwd), copyFixture(fixture, cwd)])
     await installRuntime(packageName, cwd)
     const result = await deploySite(cwd)
-    console.log(`🌍 Deployed Site is live under: ${result.deploy_url}`)
-    deployID = result.deploy_id
-    return { cwd, cleanup: _cleanup, deployID: result.deploy_id, url: result.deploy_url }
+    console.log(`🌍 Deployed Site is live under: ${result.url}`)
+    deployID = result.deployID
+    logs = result.logs
+    return { cwd, cleanup: _cleanup, deployID: result.deployID, url: result.url }
   } catch (error) {
     await _cleanup()
     throw error
@@ -92,10 +99,18 @@ async function installRuntime(packageName: string, cwd: string): Promise<void> {
 
 async function deploySite(cwd: string): Promise<DeployResult> {
   console.log(`🚀  Building and Deploying Site...`)
-  const cmd = `ntl deploy --build --site ${SITE_ID} --json`
-  const { stdout } = await execaCommand(cmd, { cwd })
+  const outputFile = 'deploy-output.txt'
+  const cmd = `ntl deploy --build --site ${SITE_ID}`
+
+  await execaCommand(cmd, { cwd, all: true }).pipeAll?.(join(cwd, outputFile))
+  const output = await readFile(join(cwd, outputFile), 'utf-8')
 
-  return JSON.parse(stdout)
+  const [url] = new RegExp(/https:.+runtime-testing\.netlify\.app/gm).exec(output) || []
+  if (!url) {
+    throw new Error('Could not extract the URL from the build logs')
+  }
+  const [deployID] = new URL(url).host.split('--')
+  return { url, deployID, logs: output }
 }
 
 async function deleteDeploy(deploy_id?: string): Promise<void> {

tests/utils/fixture.ts

@@ -95,11 +95,6 @@ export async function runPlugin(
   ctx: FixtureTestContext,
   constants: Partial<NetlifyPluginConstants> = {},
 ) {
-  // this is needed as the node_modules of the runtime are not copied over to the temp directory
-  // so in this case we use the NETLIFY_FAKE_TEST_CWD || process.cwd() that will fallback to the actual cwd on production
-  const repoRoot = fileURLToPath(new URL('../../', import.meta.url))
-  vi.stubEnv('NETLIFY_FAKE_TEST_CWD', repoRoot)
-
   const { onBuild } = await import('../../src/index.js')
   await onBuild({
     constants: {