Create a primitive for timestamp, unify code (facebook#50585)

Summary:

# Changelog: [Internal]

We've been using same function that formats chrono to unix timestamp in microseconds in multiple different places.

In this diff:
- Introduced `TracingTimeStamp` that can be used  in Tracing domain.
- Moved the formatter to `chronoToTracingTimeStamp` in `react/timing/primitives.h` and re-used it.

Differential Revision: D72649815

Author: hoxyq

packages/react-native/ReactCommon/jsinspector-modern/tracing/CMakeLists.txt

@@ -19,6 +19,7 @@ target_include_directories(jsinspector_tracing PUBLIC ${REACT_COMMON_DIR})
 target_link_libraries(jsinspector_tracing
         folly_runtime
         oscompat
+        react_timing
 )
 target_compile_reactnative_options(jsinspector_tracing PRIVATE)
 target_compile_options(jsinspector_tracing PRIVATE -Wpedantic)

packages/react-native/ReactCommon/jsinspector-modern/tracing/EventLoopTaskReporter.cpp

@@ -8,22 +8,13 @@
 #include "EventLoopTaskReporter.h"
 
 #if defined(REACT_NATIVE_DEBUGGER_ENABLED)
+#include <react/timing/primitives.h>
 #include "PerformanceTracer.h"
 #endif
 
 namespace facebook::react::jsinspector_modern::tracing {
 
 #if defined(REACT_NATIVE_DEBUGGER_ENABLED)
-namespace {
-
-inline uint64_t formatTimePointToUnixTimestamp(
-    std::chrono::steady_clock::time_point timestamp) {
-  return std::chrono::duration_cast<std::chrono::microseconds>(
-             timestamp.time_since_epoch())
-      .count();
-}
-
-} // namespace
 
 EventLoopTaskReporter::EventLoopTaskReporter()
     : startTimestamp_(std::chrono::steady_clock::now()) {}
@@ -33,8 +24,8 @@ EventLoopTaskReporter::~EventLoopTaskReporter() {
   if (performanceTracer.isTracing()) {
     auto end = std::chrono::steady_clock::now();
     performanceTracer.reportEventLoopTask(
-        formatTimePointToUnixTimestamp(startTimestamp_),
-        formatTimePointToUnixTimestamp(end));
+        chronoToTracingTimeStamp(startTimestamp_),
+        chronoToTracingTimeStamp(end));
   }
 }
 

packages/react-native/ReactCommon/jsinspector-modern/tracing/PerformanceTracer.cpp

@@ -8,6 +8,7 @@
 #include "PerformanceTracer.h"
 
 #include <oscompat/OSCompat.h>
+#include <react/timing/primitives.h>
 
 #include <folly/json.h>
 
@@ -18,10 +19,8 @@ namespace facebook::react::jsinspector_modern {
 
 namespace {
 
-uint64_t getUnixTimestampOfNow() {
-  return std::chrono::duration_cast<std::chrono::microseconds>(
-             std::chrono::steady_clock::now().time_since_epoch())
-      .count();
+inline TracingTimeStamp getTracingTimeStampOfNow() {
+  return chronoToTracingTimeStamp(std::chrono::steady_clock::now());
 }
 
 } // namespace
@@ -52,7 +51,7 @@ bool PerformanceTracer::startTracing() {
         .name = "TracingStartedInPage",
         .cat = "disabled-by-default-devtools.timeline",
         .ph = 'I',
-        .ts = getUnixTimestampOfNow(),
+        .ts = getTracingTimeStampOfNow(),
         .pid = processId_,
         .tid = oscompat::getCurrentThreadId(),
         .args = folly::dynamic::object("data", folly::dynamic::object()),
@@ -78,7 +77,7 @@ bool PerformanceTracer::stopTracing() {
       .name = "ReactNative-TracingStopped",
       .cat = "disabled-by-default-devtools.timeline",
       .ph = 'I',
-      .ts = getUnixTimestampOfNow(),
+      .ts = getTracingTimeStampOfNow(),
       .pid = processId_,
       .tid = oscompat::getCurrentThreadId(),
   });
@@ -117,7 +116,7 @@ void PerformanceTracer::collectEvents(
 
 void PerformanceTracer::reportMark(
     const std::string_view& name,
-    uint64_t start) {
+    TracingTimeStamp start) {
   if (!tracing_) {
     return;
   }
@@ -139,7 +138,7 @@ void PerformanceTracer::reportMark(
 
 void PerformanceTracer::reportMeasure(
     const std::string_view& name,
-    uint64_t start,
+    TracingTimeStamp start,
     uint64_t duration,
     const std::optional<DevToolsTrackEntryPayload>& trackMetadata) {
   if (!tracing_) {
@@ -243,7 +242,9 @@ void PerformanceTracer::reportThread(uint64_t id, const std::string& name) {
   });
 }
 
-void PerformanceTracer::reportEventLoopTask(uint64_t start, uint64_t end) {
+void PerformanceTracer::reportEventLoopTask(
+    TracingTimeStamp start,
+    TracingTimeStamp end) {
   if (!tracing_) {
     return;
   }
@@ -286,7 +287,7 @@ folly::dynamic PerformanceTracer::getSerializedRuntimeProfileTraceEvent(
 folly::dynamic PerformanceTracer::getSerializedRuntimeProfileChunkTraceEvent(
     uint16_t profileId,
     uint64_t threadId,
-    uint64_t eventUnixTimestamp,
+    TracingTimeStamp eventUnixTimestamp,
     const tracing::TraceEventProfileChunk& traceEventProfileChunk) {
   return serializeTraceEvent(TraceEvent{
       .id = profileId,

packages/react-native/ReactCommon/jsinspector-modern/tracing/PerformanceTracer.h

@@ -11,6 +11,8 @@
 #include "TraceEvent.h"
 #include "TraceEventProfile.h"
 
+#include <react/timing/primitives.h>
+
 #include <folly/dynamic.h>
 
 #include <functional>
@@ -65,7 +67,7 @@ class PerformanceTracer {
    *
    * See https://w3c.github.io/user-timing/#mark-method.
    */
-  void reportMark(const std::string_view& name, uint64_t start);
+  void reportMark(const std::string_view& name, TracingTimeStamp start);
 
   /**
    * Record a `Performance.measure()` event - a labelled duration. If not
@@ -75,7 +77,7 @@ class PerformanceTracer {
    */
   void reportMeasure(
       const std::string_view& name,
-      uint64_t start,
+      TracingTimeStamp start,
       uint64_t duration,
       const std::optional<DevToolsTrackEntryPayload>& trackMetadata);
 
@@ -99,7 +101,7 @@ class PerformanceTracer {
    * Record an Event Loop tick, which will be represented as an Event Loop task
    * on a timeline view and grouped with JavaScript samples.
    */
-  void reportEventLoopTask(uint64_t start, uint64_t end);
+  void reportEventLoopTask(TracingTimeStamp start, TracingTimeStamp end);
 
   /**
    * Create and serialize Profile Trace Event.
@@ -108,7 +110,7 @@ class PerformanceTracer {
   folly::dynamic getSerializedRuntimeProfileTraceEvent(
       uint64_t threadId,
       uint16_t profileId,
-      uint64_t eventUnixTimestamp);
+      TracingTimeStamp eventUnixTimestamp);
 
   /**
    * Create and serialize ProfileChunk Trace Event.

packages/react-native/ReactCommon/jsinspector-modern/tracing/React-jsinspectortracing.podspec

@@ -47,6 +47,7 @@ Pod::Spec.new do |s|
   end
 
   s.dependency "React-oscompat"
+  s.dependency "React-timing"
 
   add_rn_third_party_dependencies(s)
 end

packages/react-native/ReactCommon/jsinspector-modern/tracing/RuntimeSamplingProfileTraceEventSerializer.cpp

@@ -8,6 +8,8 @@
 #include "RuntimeSamplingProfileTraceEventSerializer.h"
 #include "ProfileTreeNode.h"
 
+#include <react/timing/primitives.h>
+
 namespace facebook::react::jsinspector_modern::tracing {
 
 namespace {
@@ -21,13 +23,6 @@ const uint16_t PROFILE_ID = 1;
 /// by Chrome DevTools.
 const uint32_t FALLBACK_SCRIPT_ID = 0;
 
-uint64_t formatTimePointToUnixTimestamp(
-    std::chrono::steady_clock::time_point timestamp) {
-  return std::chrono::duration_cast<std::chrono::microseconds>(
-             timestamp.time_since_epoch())
-      .count();
-}
-
 TraceEventProfileChunk::CPUProfile::Node convertToTraceEventProfileNode(
     std::shared_ptr<ProfileTreeNode> node) {
   ProfileTreeNode* nodeParent = node->getParent();
@@ -210,8 +205,8 @@ void RuntimeSamplingProfileTraceEventSerializer::serializeAndNotify(
   }
 
   uint64_t firstChunkThreadId = samples.front().getThreadId();
-  uint64_t tracingStartUnixTimestamp =
-      formatTimePointToUnixTimestamp(tracingStartTime);
+  TracingTimeStamp tracingStartUnixTimestamp =
+      chronoToTracingTimeStamp(tracingStartTime);
   uint64_t previousSampleUnixTimestamp = tracingStartUnixTimestamp;
   uint64_t currentChunkUnixTimestamp = tracingStartUnixTimestamp;
 

packages/react-native/ReactCommon/jsinspector-modern/tracing/TraceEvent.h

@@ -7,6 +7,8 @@
 
 #pragma once
 
+#include <react/timing/primitives.h>
+
 #include <folly/dynamic.h>
 
 namespace facebook::react::jsinspector_modern {
@@ -42,7 +44,7 @@ struct TraceEvent {
   char ph;
 
   /** The tracing clock timestamp of the event, in microseconds (µs). */
-  uint64_t ts;
+  TracingTimeStamp ts;
 
   /** The process ID for the process that output this event. */
   uint64_t pid;

packages/react-native/ReactCommon/react/timing/primitives.h

@@ -19,6 +19,11 @@ using DOMHighResTimeStamp = double;
 
 constexpr DOMHighResTimeStamp DOM_HIGH_RES_TIME_STAMP_UNSET = -1.0;
 
+// A unix time stamp in microseconds (μs) that is used in Tracing. All timeline
+// events of the Performance panel in DevTools are in this time base.
+// https://chromedevtools.github.io/devtools-protocol/tot/Tracing/
+using TracingTimeStamp = uint64_t;
+
 inline DOMHighResTimeStamp chronoToDOMHighResTimeStamp(
     std::chrono::steady_clock::duration duration) {
   return static_cast<std::chrono::duration<double, std::milli>>(duration)
@@ -30,4 +35,11 @@ inline DOMHighResTimeStamp chronoToDOMHighResTimeStamp(
   return chronoToDOMHighResTimeStamp(timePoint.time_since_epoch());
 }
 
+inline TracingTimeStamp chronoToTracingTimeStamp(
+    std::chrono::steady_clock::time_point timePoint) {
+  return std::chrono::duration_cast<std::chrono::microseconds>(
+             timePoint.time_since_epoch())
+      .count();
+}
+
 } // namespace facebook::react