Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor to unify writeFile, readFile, and add readManifest #60137

Merged
merged 2 commits into from
Jan 3, 2024
Merged

Refactor to unify writeFile, readFile, and add readManifest #60137

merged 2 commits into from
Jan 3, 2024

Conversation

timneutkens
Copy link
Member

@timneutkens timneutkens commented Jan 2, 2024 •
edited by padmaia
Loading

What?

Consolidates similar function calls, sets up readManifest and the foundation for writeManifest too.

Closes NEXT-1954

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Jan 2, 2024
@timneutkens timneutkens mentioned this pull request Jan 2, 2024
Merged
@timneutkens
Copy link
Member Author

timneutkens commented Jan 2, 2024 •
edited
Loading

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@timneutkens timneutkens mentioned this pull request Jan 2, 2024
Merged
@ijjk
Copy link
Member

ijjk commented Jan 2, 2024 •
edited
Loading

Tests Passed

@ijjk
Copy link
Member

ijjk commented Jan 2, 2024 •
edited
Loading

Stats from current PR

Default Build
General Overall increase ⚠️
vercel/next.js canary vercel/next.js 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest Change
buildDuration 12.8s 12.8s N/A
buildDurationCached 7.1s 6.2s N/A
nodeModulesSize 202 MB 202 MB ⚠️ +1.34 kB
nextStartRea..uration (ms) 426ms 438ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest 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.4 kB 28.5 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB ✓
main-app-HASH.js gzip 239 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 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary vercel/next.js 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest 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 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest 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 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest Change
index.html gzip 528 B 526 B N/A
link.html gzip 541 B 538 B N/A
withRouter.html gzip 524 B 521 B N/A
Overall change 0 B 0 B ✓
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest 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 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest Change
middleware-b..fest.js gzip 625 B 624 B N/A
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.07 kB 2.07 kB ✓
Next Runtimes
vercel/next.js canary vercel/next.js 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest 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 ✓
Overall change 932 kB 932 kB ✓
Commit: 201b370

@timneutkens timneutkens force-pushed the 01-02-Move_cacheDir_logic_to_getCacheDir branch from e82e3f8 to 2a760fd Compare January 3, 2024 08:41
@timneutkens timneutkens force-pushed the 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest branch from 91f3f4e to 0980f2f Compare January 3, 2024 08:41
This was referenced Jan 3, 2024
Merged
Merged
Merged
feedthejim
feedthejim reviewed Jan 3, 2024
View reviewed changes
packages/next/src/build/index.ts
return fs.readFile(filePath, 'utf8')
}

async function readManifest<T extends object>(filePath: string): Promise<T> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have some method for this that handles caching

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems we have this one:

next.js/packages/next/src/server/load-manifest.ts

Line 5 in 100c932

export function loadManifest(path: string, shouldCache: boolean = true) {
but that one is more geared towards having the long-running process and the memory is never cleaned up because it uses a module-scope Map, I don't think we need to cache these right now 👍

feedthejim
feedthejim reviewed Jan 3, 2024
View reviewed changes
packages/next/src/build/index.ts
return 4
}

async function writeFileUtf8(filePath: string, content: string) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a particular point to this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty straightforward, not all writefile calls had utf-8 set even though they should have, this makes sure all of them have it.

Base automatically changed from 01-02-Move_cacheDir_logic_to_getCacheDir to canary January 3, 2024 15:40
@timneutkens timneutkens force-pushed the 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest branch from 0980f2f to 201b370 Compare January 3, 2024 15:41
@timneutkens timneutkens requested a review from feedthejim January 3, 2024 15:48
@timneutkens timneutkens merged commit 4e9a3ba into canary Jan 3, 2024
70 checks passed
@timneutkens timneutkens deleted the 01-02-Refactor_to_unify_writeFile_readFile_and_add_readManifest branch January 3, 2024 17:59
@samcx samcx mentioned this pull request Jan 6, 2024
Closed
agustints pushed a commit to agustints/next.js that referenced this pull request Jan 6, 2024
@timneutkens @agustints
Refactor to unify writeFile, readFile, and add readManifest (vercel#6…
4681a02 
…0137)

## What?

Consolidates similar function calls, sets up `readManifest` and the
foundation for `writeManifest` too.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->


Closes NEXT-1954
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ztanner ztanner ztanner approved these changes

@ijjk ijjk Awaiting requested review from ijjk

@shuding shuding Awaiting requested review from shuding

@huozhi huozhi Awaiting requested review from huozhi

@feedthejim feedthejim Awaiting requested review from feedthejim

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team. locked type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@timneutkens @ijjk @ztanner @feedthejim