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

doc: fs.readFile is async but not partitioned #17154

Closed

davisjam wants to merge 1 commit into nodejs:master from davisjam:Warning-ReadFile

Contributor

davisjam commented Nov 20, 2017

This change was suggested during the discussion of #17054.

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

docs, fs

nodejs-github-bot added doc fs labels

jasnell reviewed

View reviewed changes

doc/api/fs.md Outdated

    
            @@ -1897,6 +1897,10 @@ Any specified file descriptor has to support reading.
          
              *Note*: If a file descriptor is specified as the `path`, it will not be closed

              automatically.

              *Note*: `fs.readFile()` reads the entire file in a single threadpool request.

              To minimize threadpool task variation, prefer the partitioned APIs `fs.read()`

              and `ReadStream` when reading files as part of fulfilling a client request.

Member

jasnell Nov 20, 2017

Nit: using fs.createReadStream() instead of ReadStream here may be clearer for most users.

Contributor Author

davisjam Nov 20, 2017

Addressed in 6789de6

jasnell approved these changes

View reviewed changes

jasnell approved these changes

View reviewed changes

Trott approved these changes

View reviewed changes

gireeshpunathil approved these changes

View reviewed changes

vsemozhetbyt approved these changes

View reviewed changes

Member

joyeecheung commented Nov 21, 2017

linter CI: https://ci.nodejs.org/job/node-test-linter/13776/

Member

joyeecheung commented Nov 21, 2017

Pure doc change, multiple approvals, I think this one can be fast-tracked.

joyeecheung added fast-track author ready labels

davisjam mentioned this pull request

fs: partition readFile to avoid threadpool exhaustion #17054

Closed

3 tasks

davisjam added a commit to davisjam/node that referenced this pull request


          doc: non-partitioned async crypto operations

158692e

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of nodejs#17054.
See also nodejs#17154.

davisjam mentioned this pull request

doc: non-partitioned async crypto operations #17250

Closed

2 tasks

Member

jasnell commented Nov 22, 2017

@davisjam ... can I ask you to please squash the two commits.


          doc: fs.readFile is async but not partitioned

f32cbac

This change was suggested during the discussion of nodejs#17054.

davisjam force-pushed the Warning-ReadFile branch from 6789de6 to f32cbac Compare

November 22, 2017 19:07

Contributor Author

davisjam commented Nov 22, 2017

jasnell pushed a commit that referenced this pull request


          doc: fs.readFile is async but not partitioned

a59ad82

This change was suggested during the discussion of #17054.

PR-URL: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

Member

jasnell commented Nov 22, 2017

Landed in a59ad82

jasnell closed this

addaleax removed the author ready label

addaleax pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

16e87ed

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins pushed a commit that referenced this pull request


          doc: fs.readFile is async but not partitioned

dd918ae

This change was suggested during the discussion of #17054.

PR-URL: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

d500f04

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins pushed a commit that referenced this pull request


          doc: fs.readFile is async but not partitioned

04c4c1f

This change was suggested during the discussion of #17054.

PR-URL: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins mentioned this pull request

v9.3.0 proposal #17631

Merged

MylesBorins added the dont-land-on-v6.x label

gibfahn pushed a commit that referenced this pull request


          doc: fs.readFile is async but not partitioned

ed9296d

This change was suggested during the discussion of #17054.

PR-URL: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

gibfahn added the land-on-v8.x label

gibfahn pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

a2c82c3

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn mentioned this pull request

v8.9.4 proposal #17772

Closed

gibfahn pushed a commit that referenced this pull request


          doc: fs.readFile is async but not partitioned

ec1a35c

This change was suggested during the discussion of #17054.

PR-URL: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

gibfahn pushed a commit that referenced this pull request


          doc: non-partitioned async crypto operations

5d1b76c

Neither crypto.randomBytes nor crypto.randomFill
partitions the work submitted to the threadpool.

This change was suggested during the discussion of #17054.
See also #17154.

PR-URL: #17250
Refs: #17154
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn mentioned this pull request

v8.9.4 proposal #17774

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc fast-track fs