Fix symlink and copy logic to `standalone` directory when using `outputStandalone` #35535

remorses · 2022-03-22T21:31:10Z

Bug

Fixes #35235
Fixes #32987

Added a copy function that correctly handles symlinks

Added integration test for the pnpm app that makes heavy use of symlinks

ijjk · 2022-03-23T00:23:20Z

Failing test suites

Commit: 7acfea0

yarn testheadless test/production/next/jest/index.test.ts

next/jest > should work

Expand output

● next/jest › should work

thrown: "Exceeded timeout of 90000 ms for a hook.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

   6 |   let next: NextInstance
   7 |
>  8 |   beforeAll(async () => {
     |   ^
   9 |     next = await createNext({
  10 |       files: {
  11 |         'public/vercel.svg':

  at production/next/jest/index.test.ts:8:3
  at Object.<anonymous> (production/next/jest/index.test.ts:5:1)

● Test suite failed to run

TypeError: Cannot read properties of undefined (reading 'destroy')

  134 |     })
  135 |   })
> 136 |   afterAll(() => next.destroy())
      |                       ^
  137 |
  138 |   it('should work', async () => {
  139 |     const html = await renderViaHTTP(next.url, '/')

  at production/next/jest/index.test.ts:136:23

● Test suite failed to run

next instance not destroyed before exiting, make sure to call .destroy() after the tests after finished

  91 |     if (nextInstance) {
  92 |       await nextInstance.destroy()
> 93 |       throw new Error(
     |             ^
  94 |         `next instance not destroyed before exiting, make sure to call .destroy() after the tests after finished`
  95 |       )
  96 |     }

  at lib/e2e-utils.ts:93:13

Read more about building and testing Next.js in contributing.md.

…-standalone

remorses · 2022-03-25T13:21:32Z

@ijjk can you review? I noticed you made the original pr for this feature

ijjk · 2022-03-25T13:44:09Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
buildDuration	20s	19.9s	-45ms
buildDurationCached	7.9s	7.8s	-135ms
nodeModulesSize	484 MB	484 MB	-75 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.322	4.362	⚠️ +0.04
/ avg req/sec	578.44	573.17	⚠️ -5.27
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.108	2.154	⚠️ +0.05
/error-in-render avg req/sec	1185.68	1160.62	⚠️ -25.06

Client Bundles (main, webpack)

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
925.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	28.3 kB	28.3 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	72 kB	72 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	192 B	192 B	✓
amp-HASH.js gzip	309 B	309 B	✓
css-HASH.js gzip	327 B	327 B	✓
dynamic-HASH.js gzip	3.04 kB	3.04 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	920 B	920 B	✓
image-HASH.js gzip	5.73 kB	5.73 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.36 kB	2.36 kB	✓
routerDirect..HASH.js gzip	320 B	320 B	✓
script-HASH.js gzip	392 B	392 B	✓
withRouter-HASH.js gzip	319 B	319 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	16 kB	16 kB	✓

Client Build Manifests

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
_buildManifest.js gzip	461 B	461 B	✓
Overall change	461 B	461 B	✓

Rendered Page Sizes

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
index.html gzip	531 B	531 B	✓
link.html gzip	543 B	543 B	✓
withRouter.html gzip	524 B	524 B	✓
Overall change	1.6 kB	1.6 kB	✓

Default Build with SWC (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
buildDuration	24s	23.7s	-285ms
buildDurationCached	7.7s	7.8s	⚠️ +80ms
nodeModulesSize	484 MB	484 MB	-75 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.417	4.402	-0.01
/ avg req/sec	565.96	567.95	+1.99
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.086	2.141	⚠️ +0.06
/error-in-render avg req/sec	1198.5	1167.65	⚠️ -30.85

Client Bundles (main, webpack)

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
925.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	28.7 kB	28.7 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	72.6 kB	72.6 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	179 B	179 B	✓
amp-HASH.js gzip	313 B	313 B	✓
css-HASH.js gzip	325 B	325 B	✓
dynamic-HASH.js gzip	3.02 kB	3.02 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	921 B	921 B	✓
image-HASH.js gzip	5.77 kB	5.77 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	2.44 kB	2.44 kB	✓
routerDirect..HASH.js gzip	322 B	322 B	✓
script-HASH.js gzip	393 B	393 B	✓
withRouter-HASH.js gzip	317 B	317 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	16.1 kB	16.1 kB	✓

Client Build Manifests

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
_buildManifest.js gzip	458 B	458 B	✓
Overall change	458 B	458 B	✓

Rendered Page Sizes

	vercel/next.js canary	remorses/next.js fix-symlinks-with-standalone	Change
index.html gzip	531 B	531 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

Commit: b85c223

dkozickis · 2022-04-08T06:22:02Z

Great stuff, hopefully @ijjk can review 🙏

test/integration/pnpm-support/test/index.test.js

…-standalone

remorses · 2022-04-13T20:20:33Z

I added a test for outputStandalone and fixed the symlink code keeping the already existing logic

remorses · 2022-04-13T20:21:36Z

packages/next/build/utils.ts

-              path.relative(tracingRoot, symlink),
-              fileOutputPath
-            )
+            await fs.symlink(symlink, fileOutputPath)


symlink is already a relative path, no need to use path.relative

timneutkens

This change looks fine, tests are passing 👍 Thanks!

fix symlink logic with outputStandalone

aaf9c98

ijjk added the type: next label Mar 22, 2022

This comment has been minimized.

Sign in to view

remorses added 5 commits March 23, 2022 00:33

refactored and commented copy function

119d9ff

faster symlink check

b3bc508

removed Dockerfile

22ac196

removed console.logs from test

06a6759

fix symlinksOutsideRoot test

7acfea0

This comment has been minimized.

Sign in to view

remorses added 2 commits March 23, 2022 10:44

Merge remote-tracking branch 'upstream/canary' into fix-symlinks-with…

025c562

…-standalone

removed a console.log for files out of root

1de776a

This comment has been minimized.

Sign in to view

remorses changed the title ~~Fix symlink logic when using outputStandalone~~ Fix symlink and copy logic to standalone directory when using outputStandalone Mar 23, 2022

remorses marked this pull request as ready for review March 23, 2022 10:17

remorses requested review from timneutkens, ijjk, shuding, padmaia and huozhi as code owners March 23, 2022 10:17

added missing types to copy

8dfa95a

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-symlinks-with-standalone

c94a30c

ijjk reviewed Apr 9, 2022

View reviewed changes

test/integration/pnpm-support/test/index.test.js Outdated Show resolved Hide resolved

remorses added 2 commits April 10, 2022 12:17

Merge remote-tracking branch 'upstream/canary' into fix-symlinks-with…

5e53eb0

…-standalone

removed custom copy function, fix symlink code

fdd1496

remorses added 2 commits April 13, 2022 22:14

test outputStandalone and pnpm

992866c

Merge remote-tracking branch 'upstream/canary' into fix-symlinks-with…

c415f48

…-standalone

remorses commented Apr 13, 2022

View reviewed changes

remorses added 2 commits April 14, 2022 10:19

appProcess is no more a promise

c474595

Merge branch 'canary' into fix-symlinks-with-standalone

b85c223

timneutkens approved these changes Apr 15, 2022

View reviewed changes

Merge branch 'canary' into fix-symlinks-with-standalone

51c6d59

timneutkens merged commit 5a785e4 into vercel:canary Apr 15, 2022

github-actions bot locked as resolved and limited conversation to collaborators May 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix symlink and copy logic to `standalone` directory when using `outputStandalone` #35535

Fix symlink and copy logic to `standalone` directory when using `outputStandalone` #35535

remorses commented Mar 22, 2022 •

edited

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 23, 2022

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

remorses commented Mar 25, 2022

ijjk commented Mar 25, 2022 •

edited

dkozickis commented Apr 8, 2022

remorses commented Apr 13, 2022

remorses Apr 13, 2022

timneutkens left a comment •

edited

Fix symlink and copy logic to standalone directory when using outputStandalone #35535

Fix symlink and copy logic to standalone directory when using outputStandalone #35535

Conversation

remorses commented Mar 22, 2022 • edited

Bug

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 23, 2022

Failing test suites

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

remorses commented Mar 25, 2022

ijjk commented Mar 25, 2022 • edited

Stats from current PR

dkozickis commented Apr 8, 2022

remorses commented Apr 13, 2022

remorses Apr 13, 2022

Choose a reason for hiding this comment

timneutkens left a comment • edited

Choose a reason for hiding this comment

Fix symlink and copy logic to `standalone` directory when using `outputStandalone` #35535

Fix symlink and copy logic to `standalone` directory when using `outputStandalone` #35535

remorses commented Mar 22, 2022 •

edited

ijjk commented Mar 25, 2022 •

edited

timneutkens left a comment •

edited