src: cleanup unused headers #30328

alferpal · 2019-11-07T19:45:22Z

Node codebase has evolved a lot in the more than 10 years of its
existence. As more features (and code) have been added, changed,
removed, it's sometimes hard to keep track of what gets used and what
not.

This commits attempts to clean some of those potentially left-over
headers using suggestions from include-what-you-use

Refs: #27531

make -j4 test (UNIX)
commit message follows commit guidelines

In addition, also tested with make -j8 make -j8 test-all

addaleax · 2019-11-07T20:42:19Z

src/connect_wrap.cc

+namespace v8 {
+class Object;
+template <class T> class Local;
+}  // namespace v8


This file includes v8.h indirectly anyway, should we add this here? (ditto below?)

Like, any file that actively uses V8 APIs will have it included anyway, through node.h or otherwise…

I'll take a look, remove the declarations and let you know of the result (sometime tomorrow afternoon / evening)

I think I've removed the declarations you pointed, and they were as you said not needed.

Were the ones removed by my last commit all the ones you were referring to?

mscdex · 2019-11-07T22:04:12Z

Isn't it possible to utilize some kind of tooling to automatically check/take care of this sort of thing?

alferpal · 2019-11-08T18:06:04Z

@mscdex This PR originates from testing one of such tools (include-what-you-use) against node's c++ codebase.

The problem I've noticed with include-what-you-use is that it works on the assumption that everything used in a file, is going to be explicitly included.

This assumption seems not to be aligned with the reality of node's C++ code, where, as @addaleax pointed in her review comment, some declarations are fine to be implicitly included by includes of your includes.

As for other tools, I've never used C++ professionally / in large codebases and I don't know if they exists, as I'm way outside C++ 's ecosystem.

nodejs-github-bot · 2019-11-09T23:50:13Z

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

src/tracing/agent.h

alferpal · 2019-11-10T15:31:59Z

In the last CI run, there was a failure in node-test-commit-osx for osx1011 (log ) and tries to fix that.

The other two errors in that CI run, I'm not sure what to make of them.

addaleax · 2019-11-10T18:46:15Z

src/connect_wrap.h


 namespace node {

+class Environment;


async_wrap.h is guaranteed to have a forward declaration of this because it uses it for the AsyncWrap constructor

addaleax · 2019-11-10T18:46:53Z

src/connection_wrap.h

+namespace v8 {
+class Object;
+template <class T> class Local;
+}  // namespace v8


stream_wrap.h is guaranteed to include v8.h because it defines a BaseObject subclass

addaleax · 2019-11-10T18:49:56Z

src/module_wrap.h

 #include "base_object-inl.h"

 namespace node {
+
+class Environment;


base_object-inl.h is guaranteed to have a forward declaration of this because it uses it as a return type… however, it’s not great that base_object-inl.h is included here rather than base_object.h. Can we replace it with the latter?

addaleax · 2019-11-10T18:50:50Z

src/string_bytes.h

@@ -27,7 +27,7 @@
 // Decodes a v8::Local<v8::String> or Buffer to a raw char*

 #include "v8.h"
-#include "env.h"
+#include "env-inl.h"


Can you explain why this is necessary? If an inline function here uses an inline function from env.h, then it’s probably best to either make it non-inline and move it to the .cc file, or create a string_bytes-inl.h that defines that function and includes env-inl.h?

The more I think of it, it's probably not necessary and an over reaction on my side to this CI error on osx https://ci.nodejs.org/job/node-test-commit-osx/29819/nodes=osx1011/console

Why would only that build fail for that particular reason still leaves me puzzled

Yeah… I don’t know either, but I think it makes sense to move StringBytes::InlineDecoder::Decode() into a string_bytes-inl.h?

addaleax · 2019-11-10T18:51:40Z

src/udp_wrap.h

 #include "handle_wrap.h"
 #include "uv.h"
 #include "v8.h"

 namespace node {

+class AsyncWrap;


handle_wrap.h is guaranteed to provide AsyncWrap because including it defines a subclass of AsyncWrap

nodejs-github-bot · 2019-11-18T12:25:46Z

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

addaleax · 2019-11-27T23:57:42Z

@alferpal Looks like there’s a merge commit in here now … can you rebase that out? Our CI doesn’t handle merge commits well, unfortunately

alferpal · 2019-11-28T05:38:02Z

Ah, didn't realise. Sorry, will fix it in a couple hours.

…

On Thu, 28 Nov 2019, 00:57 Anna Henningsen, ***@***.***> wrote: @alferpal <https://github.com/alferpal> Looks like there’s a merge commit in here now … can you rebase that out? Our CI doesn’t handle merge commits well, unfortunately — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#30328?email_source=notifications&email_token=AAGDDYRWEAUOBBLIYP45IFTQV4CPRA5CNFSM4JKMQAJ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFLBMAQ#issuecomment-559289858>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAGDDYSTKHS7AXBBYI2K3DLQV4CPRANCNFSM4JKMQAJQ> .

Node codebase has evolved a lot in the more than 10 years of its existence. As more features (and code) have been added, changed, removed, it's sometimes hard to keep track of what gets used and what not. This commits attempts to clean some of those potentially left-over headers using suggestions from include-what-you-use Refs: #27531

Introduced in a previous commit, this delcarations proved to be not needed.

It seems that the dependency string_bytes had in Environment::isolate() was always supplied transitively and not directly. Removing env-inl from api/encoding.cc broke this dependency chain, and this commit attempts to fix this at the root.

Include the plain header file instead of its inline counterpart

nodejs-github-bot · 2019-11-28T12:12:40Z

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

Node codebase has evolved a lot in the more than 10 years of its existence. As more features (and code) have been added, changed, removed, it's sometimes hard to keep track of what gets used and what not. This commits attempts to clean some of those potentially left-over headers using suggestions from include-what-you-use Refs: #27531 PR-URL: #30328 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]>

addaleax · 2019-11-28T22:40:17Z

Landed in 7686b5a, sorry for all the delays and thanks for the PR! 🎉

Node codebase has evolved a lot in the more than 10 years of its existence. As more features (and code) have been added, changed, removed, it's sometimes hard to keep track of what gets used and what not. This commits attempts to clean some of those potentially left-over headers using suggestions from include-what-you-use Refs: #27531 PR-URL: #30328 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Nov 7, 2019

addaleax approved these changes Nov 7, 2019

View reviewed changes

joyeecheung approved these changes Nov 10, 2019

View reviewed changes

lundibundi reviewed Nov 10, 2019

View reviewed changes

src/tracing/agent.h Outdated Show resolved Hide resolved

addaleax approved these changes Nov 10, 2019

View reviewed changes

jasnell approved these changes Nov 12, 2019

View reviewed changes

addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 18, 2019

alferpal added 8 commits November 28, 2019 08:39

src: remove unnecessary v8 forward declarations

a33c48d

Introduced in a previous commit, this delcarations proved to be not needed.

src: add missing namespace comment

4200839

src: include env-inl in string_bytes

f28b8c4

It seems that the dependency string_bytes had in Environment::isolate() was always supplied transitively and not directly. Removing env-inl from api/encoding.cc broke this dependency chain, and this commit attempts to fix this at the root.

src: remove unnecessary forward declarations

77d07ce

src: include base_object in module_wrap.h

240ba7d

Include the plain header file instead of its inline counterpart

src: fix build errors on macos

d7f2f40

src: remove unused header added by mistake

db5d6f1

addaleax closed this Nov 28, 2019

BridgeAR mentioned this pull request Dec 3, 2019

v13.3.0 proposal #30774

Merged

BethGriggs mentioned this pull request Dec 9, 2019

v12.13.2 proposal #30865

Closed

BethGriggs mentioned this pull request Dec 23, 2019

v12.14.1 proposal #31069

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: cleanup unused headers #30328

src: cleanup unused headers #30328

alferpal commented Nov 7, 2019

addaleax Nov 7, 2019

alferpal Nov 7, 2019

alferpal Nov 8, 2019 •

edited

Loading

mscdex commented Nov 7, 2019

alferpal commented Nov 8, 2019

nodejs-github-bot commented Nov 9, 2019

alferpal commented Nov 10, 2019 •

edited

Loading

addaleax Nov 10, 2019

addaleax Nov 10, 2019

addaleax Nov 10, 2019

addaleax Nov 10, 2019

alferpal Nov 11, 2019

addaleax Nov 11, 2019

addaleax Nov 10, 2019

nodejs-github-bot commented Nov 18, 2019

addaleax commented Nov 27, 2019

alferpal commented Nov 28, 2019 via email

nodejs-github-bot commented Nov 28, 2019

addaleax commented Nov 28, 2019

src: cleanup unused headers #30328

src: cleanup unused headers #30328

Conversation

alferpal commented Nov 7, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alferpal Nov 8, 2019 • edited Loading

Choose a reason for hiding this comment

mscdex commented Nov 7, 2019

alferpal commented Nov 8, 2019

nodejs-github-bot commented Nov 9, 2019

alferpal commented Nov 10, 2019 • edited Loading

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

nodejs-github-bot commented Nov 18, 2019

addaleax commented Nov 27, 2019

alferpal commented Nov 28, 2019 via email

nodejs-github-bot commented Nov 28, 2019

addaleax commented Nov 28, 2019

alferpal Nov 8, 2019 •

edited

Loading

alferpal commented Nov 10, 2019 •

edited

Loading