src: fix perfetto build on GetTraceFilePath

Signed-off-by: Chengzhong Wu <cwu631@bloomberg.net>
PR-URL: #64721
Fixes: nodejs/diagnostics#654
Refs: #64565
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Author: legendecas

src/node_trace_events.cc

@@ -7,7 +7,7 @@
 #include "node_v8_platform-inl.h"
 #include "permission/permission.h"
 #include "tracing/agent.h"
-#include "tracing/node_trace_writer.h"
+#include "tracing/trace_event_helper.h"
 #include "util-inl.h"
 
 #include <set>
@@ -90,7 +90,7 @@ void NodeCategorySet::Enable(const FunctionCallbackInfo<Value>& args) {
     THROW_IF_INSUFFICIENT_PERMISSIONS(
         category_set->env(),
         permission::PermissionScope::kFileSystemWrite,
-        tracing::NodeTraceWriter::GetFilePath(
+        tracing::GetTraceFilePath(
             per_process::cli_options->trace_event_file_pattern, 1));
     auto* agent = tracing::Agent::GetInstance();
     agent->StartTracing(per_process::cli_options->trace_event_categories);

src/tracing/agent_perfetto.cc

@@ -6,6 +6,7 @@
 #include "env-inl.h"
 #include "node_options.h"
 #include "trace_event.h"
+#include "trace_event_helper.h"
 
 #include "trace_event_perfetto.h"
 
@@ -21,16 +22,6 @@ constexpr uint64_t kReadPeriodMs = 5000;
 // trace file grows without bound.
 constexpr uint64_t kMaxFileSizeBytes = 64 * 1024 * 1024;  // 64 MiB
 
-void replace_substring(std::string* target,
-                       std::string_view search,
-                       std::string_view insert) {
-  size_t pos = target->find(search);
-  for (; pos != std::string::npos; pos = target->find(search, pos)) {
-    target->replace(pos, search.size(), insert);
-    pos += insert.size();
-  }
-}
-
 std::set<std::string> flatten(
     const std::unordered_map<int, std::multiset<std::string>>& map) {
   std::set<std::string> result;
@@ -104,9 +95,7 @@ class SimpleWriter : public TraceWriter {
     ++file_num_;
     uv_fs_t req;
 
-    std::string filepath(log_file_pattern_);
-    replace_substring(&filepath, "${pid}", std::to_string(uv_os_getpid()));
-    replace_substring(&filepath, "${rotation}", std::to_string(file_num_));
+    std::string filepath = GetTraceFilePath(log_file_pattern_, file_num_);
 
     if (fd_ >= 0) {
       uv_fs_close(loop_, &req, fd_, nullptr);

src/tracing/node_trace_writer.cc

@@ -1,4 +1,5 @@
 #include "tracing/node_trace_writer.h"
+#include "tracing/trace_event_helper.h"
 
 #include "util-inl.h"
 
@@ -8,27 +9,9 @@
 namespace node {
 namespace tracing {
 
-void replace_substring(std::string* target,
-                       const std::string& search,
-                       const std::string& insert) {
-  size_t pos = target->find(search);
-  for (; pos != std::string::npos; pos = target->find(search, pos)) {
-    target->replace(pos, search.size(), insert);
-    pos += insert.size();
-  }
-}
-
 NodeTraceWriter::NodeTraceWriter(const std::string& log_file_pattern)
     : log_file_pattern_(log_file_pattern) {}
 
-std::string NodeTraceWriter::GetFilePath(const std::string& log_file_pattern,
-                                         int file_num) {
-  std::string filepath(log_file_pattern);
-  replace_substring(&filepath, "${pid}", std::to_string(uv_os_getpid()));
-  replace_substring(&filepath, "${rotation}", std::to_string(file_num));
-  return filepath;
-}
-
 void NodeTraceWriter::InitializeOnThread(uv_loop_t* loop) {
   CHECK_NULL(tracing_loop_);
   tracing_loop_ = loop;
@@ -82,9 +65,7 @@ void NodeTraceWriter::OpenNewFileForStreaming() {
   ++file_num_;
   uv_fs_t req;
 
-  // Evaluate a JS-style template string, it accepts the values ${pid} and
-  // ${rotation}
-  std::string filepath(GetFilePath(log_file_pattern_, file_num_));
+  std::string filepath = GetTraceFilePath(log_file_pattern_, file_num_);
 
   if (fd_ != -1) {
     CHECK_EQ(uv_fs_close(nullptr, &req, fd_, nullptr), 0);

src/tracing/node_trace_writer.h

@@ -21,9 +21,6 @@ class NodeTraceWriter : public AsyncTraceWriter {
   explicit NodeTraceWriter(const std::string& log_file_pattern);
   ~NodeTraceWriter() override;
 
-  static std::string GetFilePath(const std::string& log_file_pattern,
-                                 int file_num);
-
   void InitializeOnThread(uv_loop_t* loop) override;
   void AppendTraceEvent(TraceObject* trace_event) override;
   void Flush(bool blocking) override;

src/tracing/trace_event_helper.cc

@@ -1,5 +1,9 @@
 #include "tracing/trace_event_helper.h"
 #include "node.h"
+#include "uv.h"
+
+#include <string>
+#include <string_view>
 
 namespace node {
 namespace tracing {
@@ -14,6 +18,26 @@ void TraceEventHelper::SetTracingController(v8::TracingController* controller) {
   g_controller = controller;
 }
 
+namespace {
+void replace_substring(std::string* target,
+                       std::string_view search,
+                       std::string_view insert) {
+  size_t pos = target->find(search);
+  for (; pos != std::string::npos; pos = target->find(search, pos)) {
+    target->replace(pos, search.size(), insert);
+    pos += insert.size();
+  }
+}
+}  // namespace
+
+std::string GetTraceFilePath(std::string_view log_file_pattern, int file_num) {
+  // Evaluate a JS-style template string that accepts ${pid} and ${rotation}.
+  std::string filepath(log_file_pattern);
+  replace_substring(&filepath, "${pid}", std::to_string(uv_os_getpid()));
+  replace_substring(&filepath, "${rotation}", std::to_string(file_num));
+  return filepath;
+}
+
 }  // namespace tracing
 
 v8::TracingController* GetTracingController() {

src/tracing/trace_event_helper.h

@@ -5,8 +5,15 @@
 
 #include "v8-platform.h"
 
+#include <string>
+#include <string_view>
+
 namespace node::tracing {
 
+// Expands a trace log file pattern into a concrete path, substituting ${pid}
+// and ${rotation}.
+std::string GetTraceFilePath(std::string_view log_file_pattern, int file_num);
+
 class TraceEventHelper {
  public:
   static v8::TracingController* GetTracingController();