src,test: disable trace events tests when perfetto is enabled

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

benchmark/misc/trace.js

@@ -14,13 +14,13 @@ const bench = common.createBenchmark(main, {
 });
 
 const {
-  TRACE_EVENT_PHASE_NESTABLE_ASYNC_BEGIN: kBeforeEvent,
+  TRACE_EVENT_PHASE_BEGIN: kBeginEvent,
 } = common.binding('constants').trace;
 
 function doTrace(n, trace) {
   bench.start();
   for (let i = 0; i < n; i++) {
-    trace(kBeforeEvent, 'foo', 'test', 0, 'test');
+    trace(kBeginEvent, 'foo', 'test', 0, 'test');
   }
   bench.end(n);
 }

src/debug_utils.h

@@ -61,6 +61,7 @@ void NODE_EXTERN_PRIVATE FWrite(FILE* file, const std::string& str);
   V(MODULE)                                                                    \
   V(MKSNAPSHOT)                                                                \
   V(SNAPSHOT_SERDES)                                                           \
+  V(PERFETTO)                                                                  \
   V(PERMISSION_MODEL)                                                          \
   V(PLATFORM_MINIMAL)                                                          \
   V(PLATFORM_VERBOSE)                                                          \

src/tracing/agent_perfetto.cc

@@ -30,6 +30,30 @@ std::set<std::string> flatten(
   return result;
 }
 
+void perfetto_log_callback(perfetto::LogMessageCallbackArgs args) {
+  const char* level_str = "UNKNOWN";
+  switch (args.level) {
+    case perfetto::base::kLogDebug:
+      level_str = "DEBUG";
+      break;
+    case perfetto::base::kLogInfo:
+      level_str = "INFO";
+      break;
+    case perfetto::base::kLogImportant:
+      level_str = "IMPORTANT";
+      break;
+    case perfetto::base::kLogError:
+      level_str = "ERROR";
+      break;
+  }
+  per_process::Debug(DebugCategory::PERFETTO,
+                     "[%s] %s:%d: %s\n",
+                     level_str,
+                     args.filename,
+                     args.line,
+                     args.message);
+}
+
 }  // namespace
 
 // Writes trace chunks to a file, rotating by size. It deliberately uses the
@@ -252,6 +276,7 @@ PerfettoTracingAgent::PerfettoTracingAgent() {
   // Set up the in-process backend that the tracing controller will connect
   // to.
   perfetto::TracingInitArgs init_args;
+  init_args.log_message_callback = perfetto_log_callback;
   init_args.backends = perfetto::BackendType::kInProcessBackend;
   perfetto::Tracing::Initialize(init_args);
 

test/common/index.js

@@ -71,6 +71,7 @@ const hasCrypto = Boolean(process.versions.openssl) &&
 const hasInspector = Boolean(process.features.inspector);
 const hasSQLite = Boolean(process.versions.sqlite);
 const hasFFI = Boolean(process.config.variables.node_use_ffi);
+const hasPerfetto = Boolean(process.config.variables.v8_use_perfetto);
 
 const hasQuic = hasCrypto && !!process.features.quic;
 
@@ -768,6 +769,18 @@ function skipIfFFIMissing() {
   }
 }
 
+function skipIfPerfettoEnabled() {
+  if (hasPerfetto) {
+    skip('Perfetto is enabled');
+  }
+}
+
+function skipIfPerfettoDisabled() {
+  if (!hasPerfetto) {
+    skip('Perfetto is disabled');
+  }
+}
+
 function getArrayBufferViews(buf) {
   const { buffer, byteOffset, byteLength } = buf;
 
@@ -1045,6 +1058,8 @@ const common = {
   skipIfInspectorDisabled,
   skipIfFFIMissing,
   skipIfSQLiteMissing,
+  skipIfPerfettoEnabled,
+  skipIfPerfettoDisabled,
   spawnPromisified,
   sleepSync,
   usesSharedLibrary,

test/common/index.mjs

@@ -52,6 +52,7 @@ const {
   skipIfEslintMissing,
   skipIfInspectorDisabled,
   skipIfSQLiteMissing,
+  skipIfPerfettoEnabled,
   spawnPromisified,
   sleepSync,
 } = common;
@@ -109,6 +110,7 @@ export {
   skipIfEslintMissing,
   skipIfInspectorDisabled,
   skipIfSQLiteMissing,
+  skipIfPerfettoEnabled,
   spawnPromisified,
   sleepSync,
 };

test/parallel/test-inspector-tracing-domain.js

@@ -3,6 +3,7 @@
 const common = require('../common');
 
 common.skipIfInspectorDisabled();
+common.skipIfPerfettoEnabled();
 
 const { isMainThread } = require('worker_threads');
 

test/parallel/test-module-print-timing.mjs

@@ -1,4 +1,4 @@
-import { isWindows } from '../common/index.mjs';
+import { isWindows, skipIfPerfettoEnabled } from '../common/index.mjs';
 import assert from 'node:assert';
 import { writeFileSync } from 'node:fs';
 import { readFile } from 'node:fs/promises';
@@ -7,6 +7,7 @@ import tmpdir from '../common/tmpdir.js';
 import { spawnSyncAndAssert } from '../common/child_process.js';
 import fixtures from '../common/fixtures.js';
 
+skipIfPerfettoEnabled();
 tmpdir.refresh();
 
 it('should print the timing information for cjs', () => {

test/parallel/test-permission-fs-write-trace-events.js

@@ -5,6 +5,7 @@ const common = require('../common');
 const { spawnSyncAndExitWithoutError } = require('../common/child_process');
 const { isMainThread } = require('worker_threads');
 
+common.skipIfPerfettoEnabled();
 if (!isMainThread) {
   common.skip('This test only works on a main thread');
 }

test/parallel/test-trace-events-all.js

@@ -4,6 +4,8 @@ const assert = require('assert');
 const cp = require('child_process');
 const fs = require('fs');
 
+common.skipIfPerfettoEnabled();
+
 const CODE =
   'setTimeout(() => { for (let i = 0; i < 100000; i++) { "test" + i } }, 1)';
 

test/parallel/test-trace-events-api.js

@@ -4,6 +4,8 @@
 const common = require('../common');
 const { isMainThread } = require('worker_threads');
 
+common.skipIfPerfettoEnabled();
+
 if (!isMainThread) {
   // https://github.com/nodejs/node/issues/22767
   common.skip('This test only works on a main thread');