use localStorage file as storageKey

Author: islandryu

doc/api/cli.md

@@ -1122,17 +1122,6 @@ added:
 
 Enable experimental support for inspector network resources.
 
-### `--experimental-inspector-storage-key=key`
-
-<!-- YAML
-added:
-  - REPLACEME
--->
-
-> Stability: 1.1 - Active Development
-
-Specify a inspector storage key used by the Node.js inspector when connecting to Chrome DevTools.
-
 ### `--experimental-loader=module`
 
 <!-- YAML
@@ -1237,6 +1226,17 @@ added:
 
 Use this flag to enable [ShadowRealm][] support.
 
+### `--experimental-storage-inspection`
+
+<!-- YAML
+added:
+  - REPLACEME
+-->
+
+> Stability: 1.1 - Active Development
+
+Enable experimental support for storage inspection
+
 ### `--experimental-test-coverage`
 
 <!-- YAML

doc/api/inspector.md

@@ -698,7 +698,7 @@ added:
   * `newValue` {string}
 
 This feature is only available with the
-`--experimental-inspector-storage-key=key` flag enabled.
+`--experimental-storage-inspection` flag enabled.
 
 Broadcasts the `DOMStorage.domStorageItemAdded` event to connected frontends.
 This event indicates that a new item has been added to the storage.
@@ -718,7 +718,7 @@ added:
   * `key` {string}
 
 This feature is only available with the
-`--experimental-inspector-storage-key=key` flag enabled.
+`--experimental-storage-inspection` flag enabled.
 
 Broadcasts the `DOMStorage.domStorageItemRemoved` event to connected frontends.
 This event indicates that an item has been removed from the storage.
@@ -740,7 +740,7 @@ added:
   * `newValue` {string}
 
 This feature is only available with the
-`--experimental-inspector-storage-key=key` flag enabled.
+`--experimental-storage-inspection` flag enabled.
 
 Broadcasts the `DOMStorage.domStorageItemUpdated` event to connected frontends.
 This event indicates that a storage item has been updated.
@@ -759,7 +759,7 @@ added:
     * `isLocalStorage` {boolean}
 
 This feature is only available with the
-`--experimental-inspector-storage-key=key` flag enabled.
+`--experimental-storage-inspection` flag enabled.
 
 Broadcasts the `DOMStorage.domStorageItemsCleared` event to connected
 frontends. This event indicates that all items have been cleared from the
@@ -777,10 +777,7 @@ added:
   * `storageMap` {Object}
 
 This feature is only available with the
-`--experimental-inspector-storage-key=key` flag enabled.
-
-Registers a storage map with the inspector. The registered storage entries are
-reported when getDOMStorageItems is called.
+`--experimental-storage-inspection` flag enabled.
 
 ## Support of breakpoints
 

doc/node.1

@@ -232,7 +232,7 @@ Enable the experimental QUIC support.
 .It Fl -experimental-inspector-network-resource
 Enable experimental support for inspector network resources.
 
-.It Fl -experimental-inspector-storage-key
+.It Fl -experimental-storage-inspection
 Specify a inspector storage key used by the Node.js inspector when connecting to Chrome DevTools.
 
 .

src/inspector/storage_agent.cc

@@ -19,10 +19,17 @@ void StorageAgent::Wire(protocol::UberDispatcher* dispatcher) {
 }
 DispatchResponse StorageAgent::getStorageKey(
     std::optional<protocol::String> frameId, protocol::String* storageKey) {
-  *storageKey = env_->options()->experimental_inspector_storage_key;
+  auto local_storage_file = env_->options()->localstorage_file;
+  *storageKey = to_file_url(local_storage_file);
   return protocol::DispatchResponse::Success();
 }
 
+std::string StorageAgent::to_file_url(const std::filesystem::path& input) {
+  std::filesystem::path abs =
+      std::filesystem::weakly_canonical(std::filesystem::absolute(input));
+  return "file://" + abs.generic_string();
+}
+
 }  // namespace protocol
 }  // namespace inspector
 }  // namespace node

src/inspector/storage_agent.h

@@ -26,6 +26,7 @@ class StorageAgent : public protocol::Storage::Backend {
  private:
   std::unique_ptr<protocol::Storage::Frontend> frontend_;
   Environment* env_;
+  std::string to_file_url(const std::filesystem::path& input);
 };
 }  // namespace protocol
 }  // namespace inspector

src/inspector_agent.cc

@@ -265,7 +265,7 @@ class ChannelImpl final : public v8_inspector::V8Inspector::Channel,
       target_agent_->Wire(node_dispatcher_.get());
       target_agent_->listenWorker(worker_manager);
     }
-    if (env->options()->experimental_inspector_storage_key.empty() == false) {
+    if (env->options()->experimental_storage_inspection) {
       dom_storage_agent_ = std::make_unique<DOMStorageAgent>(env);
       dom_storage_agent_->Wire(node_dispatcher_.get());
       storage_agent_ = std::make_unique<protocol::StorageAgent>(env_);
@@ -308,7 +308,7 @@ class ChannelImpl final : public v8_inspector::V8Inspector::Channel,
       network_inspector_->emitNotification(
           context, domain_name, event_name, params);
     } else if (dom_storage_agent_ && dom_storage_agent_->canEmit(domain_name) &&
-               !env_->options()->experimental_inspector_storage_key.empty()) {
+               env_->options()->experimental_storage_inspection) {
       dom_storage_agent_->emitNotification(context, event_name, params);
     }
   }

src/node_options.cc

@@ -783,9 +783,9 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
   AddOption("--experimental-network-inspection",
             "experimental network inspection support",
             &EnvironmentOptions::experimental_network_inspection);
-  AddOption("--experimental-inspector-storage-key",
+  AddOption("--experimental-storage-inspection",
             "experimental storage inspection support",
-            &EnvironmentOptions::experimental_inspector_storage_key);
+            &EnvironmentOptions::experimental_storage_inspection);
   AddOption("--experimental-worker-inspection",
             "experimental worker inspection support",
             &EnvironmentOptions::experimental_worker_inspection);

src/node_options.h

@@ -176,7 +176,7 @@ class EnvironmentOptions : public Options {
   bool cpu_prof = false;
   bool experimental_network_inspection = false;
   bool experimental_worker_inspection = false;
-  std::string experimental_inspector_storage_key;
+  bool experimental_storage_inspection = false;
   bool experimental_inspector_network_resource = false;
   std::string heap_prof_dir;
   std::string heap_prof_name;

test/parallel/test-inspector-dom-storage.js

@@ -1,10 +1,11 @@
-// Flags: --inspect=0 --experimental-inspector-storage-key=node-inspector://default-dom-storage
+// Flags: --inspect=0 --experimental-storage-inspection --localstorage-file=./localstorage.db
 'use strict';
 
 const common = require('../common');
 const assert = require('assert');
 common.skipIfInspectorDisabled();
 const { DOMStorage, Session } = require('node:inspector/promises');
+const { pathToFileURL } = require('node:url');
 
 
 async function test() {
@@ -13,6 +14,11 @@ async function test() {
 
   await session.post('DOMStorage.enable');
 
+  const localStorageFileUrl = pathToFileURL('./localstorage.db').toString();
+
+  const { storageKey } = await session.post('Storage.getStorageKey');
+  assert.strictEqual(storageKey, localStorageFileUrl);
+
   await checkStorage(true);
   await checkStorage(false);
 

test/parallel/test-inspector-emit-protocol-event.js

@@ -1,4 +1,4 @@
-// Flags: --inspect=0 --experimental-network-inspection --experimental-inspector-storage-key=node-inspector://default-dom-storage
+// Flags: --inspect=0 --experimental-network-inspection --experimental-storage-inspection
 'use strict';
 const common = require('../common');