fs: warn instead of throwing if no callback #7897

thefourtheye · 2016-07-27T17:02:57Z

Checklist

make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

fs

Description of change

9359de9
made sure that if no callback function is passed to asynchronous
functions, the system will throw.

But, this breaks a lot of existing modules including npm (Refer:
#7846). Till all the necessary
dependencies use the async functions properly, no module can work.

So, this patch issues a deprecation warning, instead of throwing and
the throwing behaviour will be restored in the next major release.

cc @ChALkeR @nodejs/collaborators @nodejs/ctc

thefourtheye · 2016-07-27T17:04:49Z

CI Run: https://ci.nodejs.org/job/node-test-pull-request/3439/

MylesBorins · 2016-07-27T18:23:46Z

Sign in to view

-  if (typeof cb !== 'function') {
+  if (typeof cb === 'undefined') {
+    // TODO throw error instead of deprecation warning in v8.0.0
+    let m = 'async function calls without valid callbacks is deprecated.';


nit: are deprecated

MylesBorins · 2016-07-27T18:27:12Z

citgm: https://ci.nodejs.org/view/Node.js-citgm/job/thealphanerd-smoker-xunit/39/

I like the approach here. +1 for this over the revert

yorkie · 2016-07-27T18:35:59Z

Sign in to view

@@ -95,7 +98,14 @@ function sanitizeFD(fd) {
 // for callbacks that are passed to the binding layer, callbacks that are
 // invoked from JS already run in the proper scope.
 function makeCallback(cb) {
-  if (typeof cb !== 'function') {
+  if (typeof cb === 'undefined') {
+    // TODO throw error instead of deprecation warning in v8.0.0


I did remember the other TODO/FIXME/etc.'s format is not like this, suggest:

// TODO(thefourtheye): throw error instead of deprecation warning in v8.0.0

yorkie · 2016-07-27T18:38:41Z

Sign in to view

@@ -40,6 +41,8 @@ const isWindows = process.platform === 'win32';

 const errnoException = util._errnoException;

+const NOOP = function() {};


noop in lower case would be better that keeps consistent with https://github.com/nodejs/node/search?utf8=%E2%9C%93&q=NOOP.

claudiorodriguez · 2016-07-28T07:40:15Z

citgm failing:

+ npm set progress=false
...
npm ERR! npm  v3.10.3
...
npm ERR! cb is not a function

thefourtheye · 2016-07-28T07:46:30Z

Do you guys know how I can locally reproduce this problem?

targos · 2016-07-28T08:15:17Z

Do you guys know how I can locally reproduce this problem?

make test-npm

thefourtheye · 2016-07-28T08:49:50Z

~~I think when npm/npm#13497 lands and gets integrated to Node.js Core, this problem will be solved.~~

Wait, this should not fail though. I'll investigate further, a little later.

cjihrig · 2016-08-01T15:49:54Z

Sign in to view

@@ -95,7 +98,15 @@ function sanitizeFD(fd) {
 // for callbacks that are passed to the binding layer, callbacks that are
 // invoked from JS already run in the proper scope.
 function makeCallback(cb) {
-  if (typeof cb !== 'function') {
+  if (typeof cb === 'undefined') {


You can just compare cb === undefined.

RReverser · 2016-08-02T16:27:34Z

Sign in to view

@@ -40,6 +41,8 @@ const isWindows = process.platform === 'win32';

 const errnoException = util._errnoException;

+const noop = function() {};
+
 var printDeprecation;
 try {
  printDeprecation = require('internal/util').printDeprecationMessage;


You can put var right here (to avoid duplication) or change top-level declaration to let.

jasnell · 2016-08-04T19:05:07Z

Sign in to view

+    // Refer the discussion: https://github.com/nodejs/node/pull/7846
+    let m = 'async function calls without valid callbacks are deprecated.';
+    if (!process.traceDeprecation)
+      m += ' Use --trace-deprecation to find the function responsible.';


I'm not sure this additional part about --trace-deprecation is necessary but can live with it.

jasnell · 2016-08-04T19:06:03Z

Sign in to view

+  if (typeof cb === 'undefined') {
+    // TODO(thefourtheye): throw error instead of deprecation warning in v8.0.0
+    // Refer the discussion: https://github.com/nodejs/node/pull/7846
+    let m = 'async function calls without valid callbacks are deprecated.';


s/async/Asynchronous

jasnell · 2016-08-04T19:06:52Z

A test case validating that the deprecation warning is emitted would be good. With that added this LGTM

addaleax · 2016-08-04T22:47:14Z

@thefourtheye As expected, this conflicts now… I think it’s okay to apply the changes that got reverted here again (with the intention to squash in the warnings?). Sorry for the trouble the process is causing you!

jasnell · 2016-08-09T19:46:21Z

ping @thefourtheye

thefourtheye · 2016-08-12T07:07:01Z

Updated with the deprecation warning alone. PTAL people.

silverwind · 2016-08-12T18:08:07Z

Sign in to view

@@ -112,10 +113,13 @@ function maybeCallback(cb) {
 // invoked from JS already run in the proper scope.
 function makeCallback(cb) {
  if (cb === undefined) {
+    // TODO(thefourtheye) throw error instead of warning in major version > 7
+    let m = 'asynchronous function calls without callbacks is deprecated.';


are deprecated

or even better, make it singular.

@silverwind Done.

jasnell · 2016-08-18T18:25:16Z

~~LGTM with @silverwind's nit addressed~~

Actually, let me take that back... this uses internal which means it would end up being blocked by the graceful-fs issues. Instead of using printDeprecationNotice, this should be modified to use the new process.emitWarning() API.

For instance:

process.emitWarning(depMessage, 'DeprecationWarning');

By passing DeprecationWarning as the second argument, this will be handled as a normal deprecation.

ping @thefourtheye

thefourtheye · 2016-08-19T01:28:00Z

@jasnell I modified it to use printDeprecation function which already takes care of the graceful-fs problem. Is that okay?

jasnell · 2016-08-19T01:38:50Z

@thefourtheye ... That partially handles it. See #8166. I'm attempting to move things away from using the internal util printDeprecationMessage.

jasnell · 2016-08-26T14:00:04Z

LGTM with a nit if CI is green.

This patch issues a deprecation warning, if an asynchronous function is called without a callback function.

thefourtheye · 2016-08-26T14:17:26Z

CI Run: https://ci.nodejs.org/job/node-test-pull-request/3845/

yorkie · 2016-08-26T16:36:32Z

LGTM if CI is green

jasnell · 2016-08-26T16:38:26Z

@nodejs/ctc ... as a semver-major this needs another CTC signoff...

addaleax · 2016-08-27T05:57:10Z

LGTM

thefourtheye · 2016-08-27T07:17:58Z

Thanks for the review people. Landed in f8f283b

This patch issues a deprecation warning, if an asynchronous function is called without a callback function. PR-URL: #7897 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Notable Changes: * Buffer * Passing invalid input to Buffer.byteLength will now throw an error [nodejs#8946](nodejs#8946). * Calling Buffer without new is now deprecated and will emit a process warning [nodejs#8169](nodejs#8169). * Passing a negative number to allocUnsafe will now throw an error [nodejs#7079](nodejs#7079). * Child Process * The fork and execFile methods now have stronger argument validation [nodejs#7399](nodejs#7399). * Cluster * The worker.suicide method is deprecated and will emit a process warning [nodejs#3747](nodejs#3747). * Deps * V8 has been updated to 5.4.500.36 [nodejs#8317](nodejs#8317), [nodejs#8852](nodejs#8852), [nodejs#9253](nodejs#9253). * NODE_MODULE_VERSION has been updated to 51 [nodejs#8808](nodejs#8808). * File System * A process warning is emitted if a callback is not passed to async file system methods [nodejs#7897](nodejs#7897). * Intl * Intl.v8BreakIterator constructor has been deprecated and will emit a process warning [nodejs#8908](nodejs#8908). * Promises * Unhandled Promise rejections have been deprecated and will emit a process warning [nodejs#8217](nodejs#8217). * Punycode * The `punycode` module has been deprecated [nodejs#7941](nodejs#7941). * URL * An Experimental WHATWG URL Parser has been introduced [nodejs#7448](nodejs#7448).

Notable Changes: * Buffer * Passing invalid input to Buffer.byteLength will now throw an error [#8946](#8946). * Calling Buffer without new is now deprecated and will emit a process warning [#8169](#8169). * Passing a negative number to allocUnsafe will now throw an error [#7079](#7079). * Child Process * The fork and execFile methods now have stronger argument validation [#7399](#7399). * Cluster * The worker.suicide method is deprecated and will emit a process warning [#3747](#3747). * Deps * V8 has been updated to 5.4.500.36 [#8317](#8317), [#8852](#8852), [#9253](#9253). * NODE_MODULE_VERSION has been updated to 51 [#8808](#8808). * File System * A process warning is emitted if a callback is not passed to async file system methods [#7897](#7897). * Intl * Intl.v8BreakIterator constructor has been deprecated and will emit a process warning [#8908](#8908). * Promises * Unhandled Promise rejections have been deprecated and will emit a process warning [#8217](#8217). * Punycode * The `punycode` module has been deprecated [#7941](#7941). * URL * An Experimental WHATWG URL Parser has been introduced [#7448](#7448). PR-URL: #9099

Notable Changes: * Buffer * Passing invalid input to Buffer.byteLength will now throw an error [#8946](nodejs/node#8946). * Calling Buffer without new is now deprecated and will emit a process warning [#8169](nodejs/node#8169). * Passing a negative number to allocUnsafe will now throw an error [#7079](nodejs/node#7079). * Child Process * The fork and execFile methods now have stronger argument validation [#7399](nodejs/node#7399). * Cluster * The worker.suicide method is deprecated and will emit a process warning [#3747](nodejs/node#3747). * Deps * V8 has been updated to 5.4.500.36 [#8317](nodejs/node#8317), [#8852](nodejs/node#8852), [#9253](nodejs/node#9253). * NODE_MODULE_VERSION has been updated to 51 [#8808](nodejs/node#8808). * File System * A process warning is emitted if a callback is not passed to async file system methods [#7897](nodejs/node#7897). * Intl * Intl.v8BreakIterator constructor has been deprecated and will emit a process warning [#8908](nodejs/node#8908). * Promises * Unhandled Promise rejections have been deprecated and will emit a process warning [#8217](nodejs/node#8217). * Punycode * The `punycode` module has been deprecated [#7941](nodejs/node#7941). * URL * An Experimental WHATWG URL Parser has been introduced [#7448](nodejs/node#7448). Signed-off-by: Ilkka Myller <ilkka.myller@nodefield.com>

thefourtheye added fs semver-major labels Jul 27, 2016

MylesBorins reviewed Jul 27, 2016
View changes

yorkie reviewed Jul 27, 2016
View changes

thefourtheye mentioned this pull request Jul 28, 2016

Revert fs changes #7846

Closed

2 of 2 tasks complete

cjihrig reviewed Aug 1, 2016
View changes

RReverser reviewed Aug 2, 2016
View changes

jasnell reviewed Aug 4, 2016
View changes

addaleax added this to the 7.0.0 milestone Aug 8, 2016

thefourtheye force-pushed the thefourtheye:fs-warn-instead-of-throwing branch 2 times, most recently Aug 12, 2016

silverwind reviewed Aug 12, 2016
View changes

thefourtheye force-pushed the thefourtheye:fs-warn-instead-of-throwing branch Aug 19, 2016

thefourtheye force-pushed the thefourtheye:fs-warn-instead-of-throwing branch 2 times, most recently Aug 19, 2016

fs: warn if no callback is passed to async calls

Unverified

This user has not yet uploaded their public key.

GPG key ID: 800C90E774692D78 Learn about signing commits

3e97e2c

This patch issues a deprecation warning, if an asynchronous function is called without a callback function.

thefourtheye force-pushed the thefourtheye:fs-warn-instead-of-throwing branch to 3e97e2c Aug 26, 2016

thefourtheye closed this Aug 27, 2016

thefourtheye deleted the thefourtheye:fs-warn-instead-of-throwing branch Aug 27, 2016

jasnell mentioned this pull request Oct 14, 2016

v7.0.0 Proposal #9099

Closed

goliney mentioned this pull request Oct 25, 2016

Node v7 support tschaub/mock-fs#174

Merged

thefourtheye mentioned this pull request May 11, 2017

fs: Revert throw on invalid callbacks #12976

Merged

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

2 of 3 tasks complete

aduh95 mentioned this pull request Feb 1, 2021

fs: use a default callback for fs.close() #37174

Closed

nodejs / node

fs: warn instead of throwing if no callback #7897

fs: warn instead of throwing if no callback #7897

thefourtheye commented Jul 27, 2016

thefourtheye commented Jul 27, 2016

This comment has been minimized.

This comment has been minimized.

MylesBorins commented Jul 27, 2016

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

claudiorodriguez commented Jul 28, 2016

thefourtheye commented Jul 28, 2016

targos commented Jul 28, 2016

thefourtheye commented Jul 28, 2016 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jasnell commented Aug 4, 2016

addaleax commented Aug 4, 2016

jasnell commented Aug 9, 2016

thefourtheye commented Aug 12, 2016

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jasnell commented Aug 18, 2016 •

edited

thefourtheye commented Aug 19, 2016

jasnell commented Aug 19, 2016

jasnell commented Aug 26, 2016

thefourtheye commented Aug 26, 2016

yorkie commented Aug 26, 2016

jasnell commented Aug 26, 2016

addaleax commented Aug 27, 2016

thefourtheye commented Aug 27, 2016

		@@ -40,6 +41,8 @@ const isWindows = process.platform === 'win32';

		const errnoException = util._errnoException;

		const NOOP = function() {};

nodejs / node

fs: warn instead of throwing if no callback #7897

fs: warn instead of throwing if no callback #7897

Conversation

thefourtheye commented Jul 27, 2016

Checklist

Affected core subsystem(s)

Description of change

thefourtheye commented Jul 27, 2016

This comment has been minimized.

MylesBorins Jul 27, 2016 Member

This comment has been minimized.

thefourtheye Jul 28, 2016 Author Contributor

MylesBorins commented Jul 27, 2016

This comment has been minimized.

yorkie Jul 27, 2016 Member

This comment has been minimized.

thefourtheye Jul 28, 2016 Author Contributor

This comment has been minimized.

yorkie Jul 27, 2016 Member

This comment has been minimized.

thefourtheye Jul 28, 2016 Author Contributor

claudiorodriguez commented Jul 28, 2016

thefourtheye commented Jul 28, 2016

targos commented Jul 28, 2016

thefourtheye commented Jul 28, 2016 • edited

This comment has been minimized.

cjihrig Aug 1, 2016 Contributor

This comment has been minimized.

RReverser Aug 2, 2016 Member

This comment has been minimized.

jasnell Aug 4, 2016 Member

This comment has been minimized.

jasnell Aug 4, 2016 Member

jasnell commented Aug 4, 2016

addaleax commented Aug 4, 2016

jasnell commented Aug 9, 2016

thefourtheye commented Aug 12, 2016

This comment has been minimized.

silverwind Aug 12, 2016 Contributor

This comment has been minimized.

silverwind Aug 12, 2016 Contributor

This comment has been minimized.

thefourtheye Aug 19, 2016 Author Contributor

jasnell commented Aug 18, 2016 • edited

thefourtheye commented Aug 19, 2016

jasnell commented Aug 19, 2016

jasnell commented Aug 26, 2016

thefourtheye commented Aug 26, 2016

yorkie commented Aug 26, 2016

jasnell commented Aug 26, 2016

addaleax commented Aug 27, 2016

thefourtheye commented Aug 27, 2016

MylesBorins Jul 27, 2016
Member

thefourtheye Jul 28, 2016
Author Contributor

yorkie Jul 27, 2016
Member

thefourtheye Jul 28, 2016
Author Contributor

yorkie Jul 27, 2016
Member

thefourtheye Jul 28, 2016
Author Contributor

thefourtheye commented Jul 28, 2016 •

edited

cjihrig Aug 1, 2016
Contributor

RReverser Aug 2, 2016
Member

jasnell Aug 4, 2016
Member

jasnell Aug 4, 2016
Member

silverwind Aug 12, 2016
Contributor

silverwind Aug 12, 2016
Contributor

thefourtheye Aug 19, 2016
Author Contributor

jasnell commented Aug 18, 2016 •

edited