lib: name anonymous callbacks #21412

mlrv · 2018-06-19T21:07:44Z

First contribution here!

This commit is to help in the effort to name all anonymous
functions to help when heap debugging. Specifically, this commit
fixes some anonymous functions used as listeners in the lib/ folder.

Refs: #8913

Checklist

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

Trott · 2018-06-19T23:52:22Z

lib/_tls_common.js

@@ -240,7 +240,7 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
    c.infoAccess = Object.create(null);

    // XXX: More key validation?
-    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function(all, key, val) {
+    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function replacerCallback(all, key, val) {


Is that supposed to be replaceCallback instead of replacerCallback?

It wasn't a typo in my head. I suppose that it makes sense in both versions:

replacerCallback -> the replacer function (inside replace)

replaceCallback -> the callback of the replace function

Happy to change it of course

Nah, if it wasn't a typo, it's fine with me. Just wanted to give you the opportunity to fix it up if it was a mistake.

Trott

LGTM if CI is green

trivikr · 2018-06-20T04:19:10Z

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

benjamingr

Thanks for doing this and following up! 🎉

mlrv · 2018-06-20T09:54:15Z

Glad to see it all seems to go well :)

If I understood correctly, the standard process is to wait at least 48 hours before merging, am I right?

Is there anything else that needs to be done?

benjamingr · 2018-06-20T10:33:06Z

@mlrv that is correct, we can fast track this one though since it's naming rather than functionality. This is all explained here: https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#waiting-for-approvals . It also explicitly states that since this is a good-first-issue then fast-tracking might be appropriate.

Collaborators 👍 this comment to support fast-tracking this change.

Trott · 2018-06-20T17:07:04Z

CI again to try to confirm Windows failure is unlikely to be related: https://ci.nodejs.org/job/node-test-pull-request/15538/

Trott · 2018-06-21T21:26:55Z

Hmmm... let's try a total re-run:

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

apapirovski

Hi @mlrv — thank you for working on this. In my opinion naming should provide some value, rather than just being decorative. Names such as socketOnceCallback do not help anyone and do not make the stack trace any more descriptive than an anonymous function would. I've left some comments regarding some potentially more useful names.

apapirovski · 2018-06-25T05:58:05Z

lib/_stream_readable.js

@@ -721,7 +721,7 @@ Readable.prototype.pipe = function(dest, pipeOpts) {
 };

 function pipeOnDrain(src) {
-  return function() {
+  return function pipeOnDrainInner() {


pipeOnDrainCallback? It won't be "inner" by the time it's in a stack trace.

apapirovski · 2018-06-25T05:58:41Z

lib/_http_outgoing.js

@@ -185,7 +185,7 @@ OutgoingMessage.prototype.setTimeout = function setTimeout(msecs, callback) {
  }

  if (!this.socket) {
-    this.once('socket', function(socket) {
+    this.once('socket', function socketOnceCallback(socket) {


socketSetTimeoutOnConnect?

apapirovski · 2018-06-25T05:58:52Z

lib/_http_outgoing.js

@@ -202,7 +202,7 @@ OutgoingMessage.prototype.destroy = function destroy(error) {
  if (this.socket) {
    this.socket.destroy(error);
  } else {
-    this.once('socket', function(socket) {
+    this.once('socket', function socketOnceCallback(socket) {


socketDestroyOnConnect?

apapirovski · 2018-06-25T06:00:01Z

lib/_tls_common.js

@@ -240,7 +240,7 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
    c.infoAccess = Object.create(null);

    // XXX: More key validation?
-    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function(all, key, val) {
+    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function replacerCallback(all, key, val) {


Switch to an anonymous function instead of naming it? The function name is not particularly useful.

I thought there was consensus that naming anonymous callback functions was helpful. If that's not the case, I should update #8913 (comment).

@apapirovski any update on this?

My bad here as far as dropping the ball and misphrasing. What I meant to say is: I think this should just be an arrow function. I don't think we gain much by naming callbacks for things like String.prototype.replace.

I implemented the suggestions and fixed the conflicts. Happy to go ahead if all the checks are green?

mlrv · 2018-06-26T08:10:03Z

Hi @apapirovski, thanks for the feedback, I totally see your point. Happy to change the names if you think those could be more helpful. On the last comment, not sure I agree with you, what do other people think?

apapirovski · 2018-07-30T02:07:52Z

lib/_tls_common.js

@@ -240,7 +240,7 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
    c.infoAccess = Object.create(null);

    // XXX: More key validation?
-    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function (all, key, val) {
+    info.replace(/([^\n:]*):([^\n]*)(?:\n|$)/g, function(all, key, val) {


I would suggest just using (all, key, val) => { here.

mlrv · 2018-07-30T17:28:21Z

@benjamingr all green, good to go? :)

Trott · 2018-08-01T01:23:29Z

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

not sure about the arrow function fitting in with the rest but won't block

Trott · 2018-08-01T01:27:06Z

Weird. CI failed on git due to a conflict. Let's try again...

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

Trott · 2018-08-01T01:35:55Z

GitHub says this has no conflicts with the base branch, but manually trying to apply the changes shows conflicts. I'll resolve them, push back up, and restart CI.

This commit is to help in the effort to name all anonymous functions to help when heap debugging. Specifically, this commit fixes some anonymous functions used as listeners in the lib/ folder. Refs: nodejs#8913

Trott · 2018-08-01T01:39:56Z

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

Trott · 2018-08-01T01:57:00Z

Might be good for people to double-check the changes now that I've done a rebase and resolved conflicts.

Trott · 2018-08-03T02:59:35Z

Resume Build: https://ci.nodejs.org/job/node-test-pull-request/16165/

This commit is to help in the effort to name all anonymous functions to help when heap debugging. Specifically, this commit fixes some anonymous functions used as listeners in the lib/ folder. PR-URL: #21412 Reviewed-By: Weijia Wang <starkwang@126.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Refs: #8913

maclover7 · 2018-08-04T21:22:32Z

Landed in d7496bf, congrats on your first PR to Node.js!
❤️ 💚 💙 💛 💜

This commit is to help in the effort to name all anonymous functions to help when heap debugging. Specifically, this commit fixes some anonymous functions used as listeners in the lib/ folder. PR-URL: #21412 Reviewed-By: Weijia Wang <starkwang@126.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Refs: #8913

nodejs-github-bot added http Issues or PRs related to the http subsystem. stream Issues and PRs related to the stream subsystem. tls Issues and PRs related to the tls subsystem. labels Jun 19, 2018

Trott reviewed Jun 19, 2018

View reviewed changes

Trott previously approved these changes Jun 19, 2018

View reviewed changes

starkwang approved these changes Jun 20, 2018

View reviewed changes

trivikr approved these changes Jun 20, 2018

View reviewed changes

trivikr added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 20, 2018

benjamingr approved these changes Jun 20, 2018

View reviewed changes

BridgeAR approved these changes Jun 20, 2018

View reviewed changes

BridgeAR added the fast-track PRs that do not need to wait for 48 hours to land. label Jun 20, 2018

lpinca approved these changes Jun 20, 2018

View reviewed changes

jasnell approved these changes Jun 21, 2018

View reviewed changes

apapirovski requested changes Jun 25, 2018

View reviewed changes

addaleax removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. fast-track PRs that do not need to wait for 48 hours to land. labels Jul 13, 2018

maclover7 added the wip Issues and PRs that are still a work in progress. label Jul 28, 2018

apapirovski reviewed Jul 30, 2018

View reviewed changes

apapirovski approved these changes Jul 30, 2018

View reviewed changes

benjamingr added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 30, 2018

mlrv added 4 commits July 31, 2018 18:37

lib: name anonymous callbacks

607ee37

This commit is to help in the effort to name all anonymous functions to help when heap debugging. Specifically, this commit fixes some anonymous functions used as listeners in the lib/ folder. Refs: nodejs#8913

Improved naming

72c2573

Make linter happy

fa194ca

Use arrow function

b1e3dc1

Trott force-pushed the marco/issue-8913 branch from 760ec4c to b1e3dc1 Compare August 1, 2018 01:39

maclover7 approved these changes Aug 3, 2018

View reviewed changes

maclover7 removed the wip Issues and PRs that are still a work in progress. label Aug 3, 2018

maclover7 closed this Aug 4, 2018

rvagg mentioned this pull request Aug 13, 2018

Release proposal: v10.9.0 #22295

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: name anonymous callbacks #21412

lib: name anonymous callbacks #21412

mlrv commented Jun 19, 2018

Trott Jun 19, 2018

mlrv Jun 20, 2018 •

edited

Trott Jun 20, 2018

Trott left a comment

trivikr commented Jun 20, 2018

benjamingr left a comment

mlrv commented Jun 20, 2018

benjamingr commented Jun 20, 2018

Trott commented Jun 20, 2018

Trott commented Jun 21, 2018

apapirovski left a comment

apapirovski Jun 25, 2018

apapirovski Jun 25, 2018

apapirovski Jun 25, 2018

apapirovski Jun 25, 2018

Trott Jun 26, 2018

mlrv Jun 29, 2018

apapirovski Jul 29, 2018

mlrv Jul 29, 2018

mlrv commented Jun 26, 2018

apapirovski Jul 30, 2018

mlrv commented Jul 30, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 3, 2018

maclover7 commented Aug 4, 2018

lib: name anonymous callbacks #21412

lib: name anonymous callbacks #21412

Conversation

mlrv commented Jun 19, 2018

Checklist

Choose a reason for hiding this comment

mlrv Jun 20, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott left a comment

Choose a reason for hiding this comment

trivikr commented Jun 20, 2018

benjamingr left a comment

Choose a reason for hiding this comment

mlrv commented Jun 20, 2018

benjamingr commented Jun 20, 2018

Trott commented Jun 20, 2018

Trott commented Jun 21, 2018

apapirovski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlrv commented Jun 26, 2018

Choose a reason for hiding this comment

mlrv commented Jul 30, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 1, 2018

Trott commented Aug 3, 2018

maclover7 commented Aug 4, 2018

mlrv Jun 20, 2018 •

edited