inspector: introduce --experimental-network-inspection

nodejs · Jul 3, 2024 · 48feeb3 · 48feeb3
1 parent c31467f
commit 48feeb3
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 4 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -998,6 +998,17 @@ added:
 
 Enable experimental support for the `https:` protocol in `import` specifiers.
 
+### `--experimental-network-inspection`
+
+<!-- YAML
+added:
+  - REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Enable experimental support for the network inspection with Chrome DevTools.
+
 ### `--experimental-permission`
 
 <!-- YAML
@@ -2847,6 +2858,7 @@ one is included in the list below.
 * `--experimental-loader`
 * `--experimental-modules`
 * `--experimental-network-imports`
+* `--experimental-network-inspection`
 * `--experimental-permission`
 * `--experimental-print-required-tla`
 * `--experimental-require-module`

diff --git a/doc/api/inspector.md b/doc/api/inspector.md
@@ -441,6 +441,8 @@ added:
 * `eventName` {string}
 * `params` {Object}
 
+This feature is only available with the `--experimental-network-inspection` flag enabled.
+
 Emits a protocol event with the specified `eventName` and optional `params`. This function allows you to send
 custom events that conform to the DevTools protocol, facilitating integration with debugging and inspection tools.
 The emitted events can be captured by connected DevTools Frontend instances, such as Chrome DevTools.

diff --git a/lib/internal/process/pre_execution.js b/lib/internal/process/pre_execution.js
@@ -441,7 +441,7 @@ function setupInspectorHooks() {
 }
 
 function setupNetworkInspection() {
-  if (!internalBinding('inspector').isEnabled()) {
+  if (!internalBinding('inspector').isEnabled() || !getOptionValue('--experimental-network-inspection')) {
     return;
   }
   const dc = require('diagnostics_channel');

diff --git a/src/inspector_agent.cc b/src/inspector_agent.cc
@@ -886,7 +886,8 @@ std::unique_ptr<InspectorSession> Agent::ConnectToMainThread(
 
 void Agent::EmitProtocolEvent(const StringView& event,
                               const StringView& params) {
-  if (!IsListening()) return;
+  if (!IsListening() || !env()->options()->experimental_network_inspection)
+    return;
   client_->emitNotification(event, params);
 }
 

diff --git a/src/node_options.cc b/src/node_options.cc
@@ -591,6 +591,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             "Directory where the V8 profiles generated by --cpu-prof will be "
             "placed. Does not affect --prof.",
             &EnvironmentOptions::cpu_prof_dir);
+  AddOption("--experimental-network-inspection",
+            "experimental network inspection support",
+            &EnvironmentOptions::experimental_network_inspection,
+            kAllowedInEnvvar);
   AddOption(
       "--heap-prof",
       "Start the V8 heap profiler on start up, and write the heap profile "

diff --git a/src/node_options.h b/src/node_options.h
@@ -161,6 +161,7 @@ class EnvironmentOptions : public Options {
   uint64_t cpu_prof_interval = kDefaultCpuProfInterval;
   std::string cpu_prof_name;
   bool cpu_prof = false;
+  bool experimental_network_inspection = false;
   std::string heap_prof_dir;
   std::string heap_prof_name;
   static const uint64_t kDefaultHeapProfInterval = 512 * 1024;

diff --git a/test/parallel/test-inspector-emit-protocol-event.mjs b/test/parallel/test-inspector-emit-protocol-event.mjs
@@ -1,4 +1,4 @@
-// Flags: --inspect=0
+// Flags: --inspect=0 --experimental-network-inspection
 
 import * as common from '../common/index.mjs';
 

diff --git a/test/parallel/test-inspector-network-domain.mjs b/test/parallel/test-inspector-network-domain.mjs
@@ -1,4 +1,4 @@
-// Flags: --inspect=0
+// Flags: --inspect=0 --experimental-network-inspection
 
 import * as common from '../common/index.mjs';