Allow using ESM pkg with custom incremental cache #59863

huozhi · 2023-12-21T23:21:54Z

Use dynamic import instead of require to load the incremental cache handled, so when using ESM it will still work.

Updated the tests and merged them into new test suite, include 3 cases of custom cache definition:

CJS with module.exports
CJS with exports.default with ESM mark
ESM with export default

Closes NEXT-1924
Fixes #58509

ijjk · 2023-12-21T23:27:23Z

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
buildDuration	12.7s	12.7s	N/A
buildDurationCached	7.1s	5.9s	N/A
nodeModulesSize	202 MB	202 MB	⚠️ +3.48 kB
nextStartRea..uration (ms)	418ms	427ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
193.HASH.js gzip	181 B	182 B	N/A
3f784ff6-HASH.js gzip	53.3 kB	53.3 kB	✓
433-HASH.js gzip	28.3 kB	28.4 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	240 B	242 B	N/A
main-HASH.js gzip	31.7 kB	31.7 kB	N/A
webpack-HASH.js gzip	1.7 kB	1.7 kB	N/A
Overall change	98.5 kB	98.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
_app-HASH.js gzip	194 B	195 B	N/A
_error-HASH.js gzip	183 B	181 B	N/A
amp-HASH.js gzip	504 B	502 B	N/A
css-HASH.js gzip	321 B	321 B	✓
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	255 B	253 B	N/A
head-HASH.js gzip	350 B	349 B	N/A
hooks-HASH.js gzip	369 B	369 B	✓
image-HASH.js gzip	4.28 kB	4.28 kB	N/A
index-HASH.js gzip	255 B	256 B	N/A
link-HASH.js gzip	2.61 kB	2.61 kB	✓
routerDirect..HASH.js gzip	312 B	311 B	N/A
script-HASH.js gzip	385 B	383 B	N/A
withRouter-HASH.js gzip	307 B	308 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.4 kB	3.4 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
_buildManifest.js gzip	483 B	484 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
index.html gzip	527 B	527 B	✓
link.html gzip	540 B	540 B	✓
withRouter.html gzip	523 B	521 B	N/A
Overall change	1.07 kB	1.07 kB	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
edge-ssr.js gzip	93.7 kB	93.8 kB	N/A
page.js gzip	147 kB	147 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
middleware-b..fest.js gzip	624 B	624 B	✓
middleware-r..fest.js gzip	151 B	151 B	✓
middleware.js gzip	37.4 kB	37.4 kB	N/A
edge-runtime..pack.js gzip	1.92 kB	1.92 kB	✓
Overall change	2.7 kB	2.7 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js feat/use-import-inc-cache	Change
app-page-exp...dev.js gzip	168 kB	168 kB	✓
app-page-exp..prod.js gzip	94.2 kB	94.2 kB	✓
app-page-tur..prod.js gzip	94.9 kB	94.9 kB	✓
app-page-tur..prod.js gzip	89.4 kB	89.4 kB	✓
app-page.run...dev.js gzip	138 kB	138 kB	✓
app-page.run..prod.js gzip	88.7 kB	88.7 kB	✓
app-route-ex...dev.js gzip	24.1 kB	24.1 kB	✓
app-route-ex..prod.js gzip	16.7 kB	16.7 kB	✓
app-route-tu..prod.js gzip	16.7 kB	16.7 kB	✓
app-route-tu..prod.js gzip	16.3 kB	16.3 kB	✓
app-route.ru...dev.js gzip	23.5 kB	23.5 kB	✓
app-route.ru..prod.js gzip	16.3 kB	16.3 kB	✓
pages-api-tu..prod.js gzip	9.38 kB	9.38 kB	✓
pages-api.ru...dev.js gzip	9.65 kB	9.65 kB	✓
pages-api.ru..prod.js gzip	9.37 kB	9.37 kB	✓
pages-turbo...prod.js gzip	21.9 kB	21.9 kB	✓
pages.runtim...dev.js gzip	22.5 kB	22.5 kB	✓
pages.runtim..prod.js gzip	21.9 kB	21.9 kB	✓
server.runti..prod.js gzip	49.4 kB	49.4 kB	N/A
Overall change	882 kB	882 kB	✓

Diff details

Diff for page.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: 01de970

ijjk · 2023-12-22T15:46:07Z

Tests Passed

PfisterFactor · 2024-01-04T23:12:00Z

Just wanted to chime in saying thank you for fixing the issue I've been banging my head on for weeks!

Use dynamic import instead of require to load the incremental cache handled, so when using ESM it will still work. Updated the tests and merged them into new test suite, include 3 cases of custom cache definition: - CJS with `module.exports` - CJS with `exports.default` with ESM mark - ESM with `export default` Closes NEXT-1924 Fixes vercel#58509

### Fixing a bug ### What? Custom cache handler doesn't work on Windows ### Why? It broke in a recent fix, when adding ESM support - #59863. The problem is not new - dynamic imports consider an absolute path in Windows as a protocol: `ERR! Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'C:'` ### How? As a solution, it is necessary to explicitly indicate that it is indeed an absolute path, for example by adding a / at the beginning, but the most reliable way is to use pathToFileURL. Since the logic is repeated in 4 places - I created a common function. Fixes #58509 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site>

Use import for inc cache

b6d6c71

ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Dec 21, 2023

interop

8d3fead

Fredkiss3 mentioned this pull request Dec 22, 2023

Refactor/use docker swarm Fredkiss3/gh-next#114

Merged

3 tasks

huozhi added 3 commits December 22, 2023 15:52

add test

45bdf2c

rm duplicate interop

3ba746a

fix ts

c959f8a

huozhi added 5 commits December 22, 2023 17:06

interop

ea12a64

separate

c94e556

interop outside

9dc532e

fix test

ac25ccd

fix lint

676b71d

huozhi marked this pull request as ready for review December 22, 2023 19:38

huozhi requested review from timneutkens, ijjk, shuding, ztanner, feedthejim, a team and wyattjoh as code owners December 22, 2023 19:38

Merge branch 'canary' into feat/use-import-inc-cache

01de970

huozhi changed the title ~~Use import for inc cache~~ Allow using ESM pkg with custom increamental cache Jan 2, 2024

timneutkens changed the title ~~Allow using ESM pkg with custom increamental cache~~ Allow using ESM pkg with custom incremental cache Jan 3, 2024

timneutkens approved these changes Jan 3, 2024

View reviewed changes

huozhi merged commit 7818c2d into canary Jan 3, 2024
72 checks passed

huozhi deleted the feat/use-import-inc-cache branch January 3, 2024 13:22

samcx mentioned this pull request Jan 6, 2024

chore: update turbo to the latest #60293

Closed

This was referenced Jan 6, 2024

Fix custom cache handler importing on windows #60307

Closed

Fix custom cache handler importing on windows #60312

Merged

github-actions bot added the locked label Jan 19, 2024

github-actions bot locked as resolved and limited conversation to collaborators Jan 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow using ESM pkg with custom incremental cache #59863

Allow using ESM pkg with custom incremental cache #59863

huozhi commented Dec 21, 2023 •

edited by timneutkens

Loading

ijjk commented Dec 21, 2023 •

edited

Loading

ijjk commented Dec 22, 2023 •

edited

Loading

PfisterFactor commented Jan 4, 2024

Allow using ESM pkg with custom incremental cache #59863

Allow using ESM pkg with custom incremental cache #59863

Conversation

huozhi commented Dec 21, 2023 • edited by timneutkens Loading

ijjk commented Dec 21, 2023 • edited Loading

Stats from current PR

ijjk commented Dec 22, 2023 • edited Loading

Tests Passed

PfisterFactor commented Jan 4, 2024

huozhi commented Dec 21, 2023 •

edited by timneutkens

Loading

ijjk commented Dec 21, 2023 •

edited

Loading

ijjk commented Dec 22, 2023 •

edited

Loading