8000 fix: resolving the paths correctly when the next-runtime is used from… · opennextjs/opennextjs-netlify@fcd57d1 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit fcd57d1

Browse files
lukasholzerlukasholzer
authored
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
1 parent a6f3ce2 commit fcd57d1

File tree

7 files changed

+43
-41
lines changed

7 files changed

+43
-41
lines changed

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@netlify/next-runtime",
3-
"version": "5.0.0-alpha.19",
3+
"version": "5.0.0-alpha.24",
44
"description": "Run Next.js seamlessly on Netlify",
55
"main": "./dist/index.js",
66
"type": "module",

‎playwright.config.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,15 @@ export default defineConfig({
1919
use: {
2020
/* Base URL to use in actions like `await page.goto('/')`. */
2121
baseURL: process.env.URL,
22-
2322
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
2423
trace: 'on-first-retry',
2524
},
26-
2725
timeout: 10 * 60 * 1000,
28-
2926
/* Configure projects for major browsers */
3027
projects: [
31-
// {
32-
// name: 'setup',
33-
// testMatch: /global\.setup\.ts/,
34-
// },
3528
{
3629
name: 'chromium',
37-
// dependencies: ['setup'],
3830
use: { ...devices['Desktop Chrome'] },
3931
},
4032
],
41-
42-
/* Run your local dev server before starting the tests */
43-
// webServer: {
44-
// command: 'npm run start',
45-
// url: 'http://127.0.0.1:3000',
46-
// reuseExistingServer: !process.env.CI,
47-
// },
4833
})

‎src/build/functions/server.ts

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { NetlifyPluginOptions } from '@netlify/build'
22
import { nodeFileTrace } from '@vercel/nft'
33
import { cp, rm, writeFile } from 'fs/promises'
4-
import { join, relative, resolve } from 'node:path'
4+
import { basename, join, relative, resolve } from 'node:path'
55
import {
66
PLUGIN_DIR,
77
PLUGIN_NAME,
@@ -35,14 +35,21 @@ export const createServerHandler = async ({
3535
},
3636
)
3737

38+
// if the parent directory of the plugin directory is not a @netlify folder we are consuming
39+
// the runtime from source and not over node_modules
40+
// this can be for example in the `netlify.toml` specified as the following
41+
// [[plugins]]
42+
// package = "../next-runtime-minimal"
43+
// in this case we use the PLUGIN_DIR for calculating the relative path
44+
const isRunFromSource = basename(join(PLUGIN_DIR, '..')) !== '@netlify'
45+
const cwd = isRunFromSource ? PLUGIN_DIR : process.cwd()
46+
3847
// copy the handler dependencies
3948
await Promise.all(
4049
[...fileList].map(async (path) => {
41-
// we have to use a fake cwd that points to the actual repository root. On the deployed version this will be the build directory
42-
// As in the integration tests the node_modules are not located in the tmp directory
43-
const cwd = process.env.NETLIFY_FAKE_TEST_CWD || process.cwd()
4450
const absPath = `/${path}`
45-
// if the file that got traced is inside the plugin directory resolve it with the plugin directory
51+
// if the file that got traced is inside the plugin directory (like `dist/run/handlers/server.js`)
52+
// resolve it with the plugin directory like `<abs-path>/node_modules/@netlify/next-runtime`
4653
// if it is a node_module resolve it with the process working directory.
4754
const relPath = relative(path.includes(PLUGIN_NAME) ? PLUGIN_DIR : cwd, absPath)
4855
await cp(absPath, resolve(SERVER_HANDLER_DIR, relPath), {

‎tests/e2e/page-router.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ test.describe('page-router', () => {
88
ctx = await createE2EFixture('page-router')
99
})
1010

11-
test.afterAll(async () => {
12-
await ctx?.cleanup?.()
11+
test.afterAll(async ({}, testInfo) => {
12+
await ctx?.cleanup?.(!!testInfo.errors.length)
1313
})
1414

1515
// NOT working yet as blob storage upload ins not working with the CLI

‎tests/e2e/simple-app.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ test.describe('simple-next-app', () => {
88
ctx = await createE2EFixture('simple-next-app')
99
})
1010

11-
test.afterAll(async () => {
12-
await ctx?.cleanup?.()
11+
test.afterAll(async ({}, testInfo) => {
12+
await ctx?.cleanup?.(!!testInfo.errors.length)
1313
})
1414

1515
test('Renders the Home page correctly', async ({ page }) => {

‎tests/utils/create-e2e-fixture.ts

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { execaCommand } from 'execa'
22
import fg from 'fast-glob'
33
import { exec } from 'node:child_process'
4-
import { copyFile, mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises'
4+
import { copyFile, mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
55
import { tmpdir } from 'node:os'
66
import { dirname, join } from 'node:path'
77
import { fileURLToPath } from 'node:url'
@@ -12,9 +12,8 @@ import pLimit from 'p-limit'
1212
const SITE_ID = 'ee859ce9-44a7-46be-830b-ead85e445e53'
1313

1414
export interface DeployResult {
15-
site_name: string
16-
deploy_id: string
17-
deploy_url: string
15+
deployID: string
16+
url: string
1817
logs: string
1918
}
2019

@@ -25,14 +24,22 @@ export interface DeployResult {
2524
export const createE2EFixture = async (fixture: string) => {
2625
const cwd = await mkdtemp(join(tmpdir(), 'netlify-next-runtime-'))
2726
let deployID: string
28-
const _cleanup = () => cleanup(cwd, deployID)
27+
let logs: string
28+
const _cleanup = (failure: boolean = false) => {
29+
if (failure) {
30+
console.log(logs)
31+
}
32+
// on failures we don't delete the deploy
33+
return cleanup(cwd, failure === true ? undefined : deployID)
34+
}
2935
try {
3036
const [packageName] = await Promise.all([buildAndPackRuntime(cwd), copyFixture(fixture, cwd)])
3137
await installRuntime(packageName, cwd)
3238
const result = await deploySite(cwd)
33-
console.log(`🌍 Deployed Site is live under: ${result.deploy_url}`)
34-
deployID = result.deploy_id
35-
return { cwd, cleanup: _cleanup, deployID: result.deploy_id, url: result.deploy_url }
39+
console.log(`🌍 Deployed Site is live under: ${result.url}`)
40+
deployID = result.deployID
41+
logs = result.logs
42+
return { cwd, cleanup: _cleanup, deployID: result.deployID, url: result.url }
3643
} catch (error) {
3744
await _cleanup()
3845
throw error
@@ -92,10 +99,18 @@ async function installRuntime(packageName: string, cwd: string): Promise<void> {
9299

93100
async function deploySite(cwd: string): Promise<DeployResult> {
94101
console.log(`🚀 Building and Deploying Site...`)
95-
const cmd = `ntl deploy --build --site ${SITE_ID} --json`
96-
const { stdout } = await execaCommand(cmd, { cwd })
102+
const outputFile = 'deploy-output.txt'
103+
const cmd = `ntl deploy --build --site ${SITE_ID}`
104+
105+
await execaCommand(cmd, { cwd, all: true }).pipeAll?.(join(cwd, outputFile))
106+
const output = await readFile(join(cwd, outputFile), 'utf-8')
97107

98-
return JSON.parse(stdout)
108+
const [url] = new RegExp(/https:.+runtime-testing\.netlify\.app/gm).exec(output) || []
109+
if (!url) {
110+
throw new Error('Could not extract the URL from the build logs')
111+
}
112+
const [deployID] = new URL(url).host.split('--')
113+
return { url, deployID, logs: output }
99114
}
100115

101116
async function deleteDeploy(deploy_id?: string): Promise<void> {

‎tests/utils/fixture.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,6 @@ export async function runPlugin(
9595
ctx: FixtureTestContext,
9696
constants: Partial<NetlifyPluginConstants> = {},
9797
) {
98-
// this is needed as the node_modules of the runtime are not copied over to the temp directory
99-
// so in this case we use the NETLIFY_FAKE_TEST_CWD || process.cwd() that will fallback to the actual cwd on production
100-
const repoRoot = fileURLToPath(new URL('../../', import.meta.url))
101-
vi.stubEnv('NETLIFY_FAKE_TEST_CWD', repoRoot)
102-
10398
const { onBuild } = await import('../../src/index.js')
10499
await onBuild({
105100
constants: {

0 commit comments

Comments
 (0)
0