fix: add concurrency limit to fs calls #301
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #301 +/- ##
==========================================
+ Coverage 80.45% 80.57% +0.11%
==========================================
Files 13 13
Lines 1489 1498 +9
Branches 555 556 +1
==========================================
+ Hits 1198 1207 +9
Misses 121 121
Partials 170 170
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
ijjk
reviewed
Jul 15, 2022
Brooooooklyn
force-pushed
the
add-limit-to-readlink
branch
from
62c49bf
to
f098d71
Compare
styfle
reviewed
Jul 15, 2022
styfle
reviewed
Jul 15, 2022
styfle
previously requested changes
Jul 15, 2022
ijjk
changed the title
styfle
reviewed
Jul 15, 2022
styfle
reviewed
Jul 15, 2022
Brooooooklyn
force-pushed
the
add-limit-to-readlink
branch
from
f098d71
to
3e1d2b2
Compare
Brooooooklyn
force-pushed
the
add-limit-to-readlink
branch
from
3e1d2b2
to
90d78fb
Compare
ijjk
reviewed
Jul 18, 2022
ijjk
approved these changes
Jul 18, 2022
jridgewell
approved these changes
Jul 18, 2022
src/node-file-trace.ts
Outdated
| try { | ||
| const link = await fsReadlink(path); | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
These aren't async operations.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
| @@ -162,6 +170,7 @@ export class Job { | |||
| return link; | |||
| } | |||
| catch (e) { | |||
| await this.fileIOQueue.release(); | |||
There was a problem hiding this comment.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
| try { | ||
| const stats = await fsStat(path); | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
| this.statCache.set(path, stats); | ||
| return stats; | ||
| } | ||
| catch (e) { | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
| try { | ||
| const source = (await fsReadFile(path)).toString(); | ||
| this.fileCache.set(path, source); | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
| return source; | ||
| } | ||
| catch (e) { | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
Suggested change
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); |
src/node-file-trace.ts
Outdated
Comment on lines
225
to
226
| this.fileCache.set(path, source); | ||
| await this.fileIOQueue.release(); |
There was a problem hiding this comment.
Nit: Flip these to make it consistent with the others:
Suggested change
| this.fileCache.set(path, source); | |
| await this.fileIOQueue.release(); | |
| this.fileIOQueue.release(); | |
| this.fileCache.set(path, source); |
styfle
reviewed
Jul 18, 2022
src/node-file-trace.ts
Outdated
| @@ -79,6 +81,9 @@ export class Job { | |||
| ts = true, | |||
| analysis = {}, | |||
| cache, | |||
| // we use a default of 1024 concurrency to balance | |||
| // performance and memory usage for fs operations | |||
| fileIOConcurrency = Number(process.env.FILE_IO_CONCURRENCY) || 1024, | |||
There was a problem hiding this comment.
Let not use an env var. Instead, the consumer should pass the fileIOConcurrency option to nodeFileTrace()
We also need to update the README.md with the new option
styfle
reviewed
Jul 19, 2022
ijjk
approved these changes
Jul 19, 2022
This was referenced Jul 21, 2022
kodiakhq bot
pushed a commit
to vercel/vercel
that referenced
this pull request
Jul 22, 2022
### Related Issues Updates to the latest version of `@vercel/nft` which adds fs concurrency limits to help alleviate memory usage. x-ref: vercel/nft#301 ### 📋 Checklist <!-- Please keep your PR as a Draft until the checklist is complete --> #### Tests - [ ] The code changed/added as part of this PR has been covered with tests - [ ] All tests pass locally with `yarn test-unit` #### Code Review - [ ] This PR has a concise title and thorough description useful to a reviewer - [ ] Issue from task tracker has a link to this PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds concurrency limits to our
fscalls to attempt to alleviate memory issues with too many promises being stored in memory at once.x-ref: slack thread