ref: Move time-related utils to a new file

Author: rhcarvalho

packages/utils/src/index.ts

@@ -2,6 +2,7 @@ export * from './async';
 export * from './browser';
 export * from './dsn';
 export * from './error';
+export * from './instrument';
 export * from './is';
 export * from './logger';
 export * from './memo';
@@ -14,4 +15,4 @@ export * from './stacktrace';
 export * from './string';
 export * from './supports';
 export * from './syncpromise';
-export * from './instrument';
+export * from './time';

packages/utils/src/misc.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Event, Integration, StackFrame, WrappedFunction } from '@sentry/types';
 
-import { dynamicRequire, isNodeEnv } from './node';
+import { isNodeEnv } from './node';
 import { snipLine } from './string';
 
 /** Internal */
@@ -38,13 +38,6 @@ export function getGlobalObject<T>(): T & SentryGlobal {
     : fallbackGlobalObject) as T & SentryGlobal;
 }
 
-/**
- * Determines if running in react native
- */
-export function isReactNative(): boolean {
-  return getGlobalObject<Window>().navigator?.product === 'ReactNative';
-}
-
 /**
  * Extended Window interface that allows for Crypto API usage in IE browsers
  */
@@ -241,94 +234,6 @@ export function getLocationHref(): string {
   }
 }
 
-const INITIAL_TIME = Date.now();
-let prevNow = 0;
-
-/**
- * Cross platform compatible partial performance implementation
- */
-interface CrossPlatformPerformance {
-  timeOrigin: number;
-  /**
-   * Returns the current timestamp in ms
-   */
-  now(): number;
-}
-
-const performanceFallback: CrossPlatformPerformance = {
-  now(): number {
-    let now = Date.now() - INITIAL_TIME;
-    if (now < prevNow) {
-      now = prevNow;
-    }
-    prevNow = now;
-    return now;
-  },
-  timeOrigin: INITIAL_TIME,
-};
-
-/**
- * Performance wrapper for react native as performance.now() has been found to start off with an unusual offset.
- */
-function getReactNativePerformanceWrapper(): CrossPlatformPerformance {
-  // Performance only available >= RN 0.63
-  const { performance } = getGlobalObject<Window>();
-  if (performance && typeof performance.now === 'function') {
-    const INITIAL_OFFSET = performance.now();
-
-    return {
-      now(): number {
-        return performance.now() - INITIAL_OFFSET;
-      },
-      timeOrigin: INITIAL_TIME,
-    };
-  }
-  return performanceFallback;
-}
-
-export const crossPlatformPerformance: CrossPlatformPerformance = ((): CrossPlatformPerformance => {
-  // React Native's performance.now() starts with a gigantic offset, so we need to wrap it.
-  if (isReactNative()) {
-    return getReactNativePerformanceWrapper();
-  }
-
-  if (isNodeEnv()) {
-    try {
-      const perfHooks = dynamicRequire(module, 'perf_hooks') as { performance: CrossPlatformPerformance };
-      return perfHooks.performance;
-    } catch (_) {
-      return performanceFallback;
-    }
-  }
-
-  const { performance } = getGlobalObject<Window>();
-
-  if (!performance || !performance.now) {
-    return performanceFallback;
-  }
-
-  // Polyfill for performance.timeOrigin.
-  //
-  // While performance.timing.navigationStart is deprecated in favor of performance.timeOrigin, performance.timeOrigin
-  // is not as widely supported. Namely, performance.timeOrigin is undefined in Safari as of writing.
-  if (performance.timeOrigin === undefined) {
-    // As of writing, performance.timing is not available in Web Workers in mainstream browsers, so it is not always a
-    // valid fallback. In the absence of a initial time provided by the browser, fallback to INITIAL_TIME.
-    // @ts-ignore ignored because timeOrigin is a readonly property but we want to override
-    // eslint-disable-next-line deprecation/deprecation
-    performance.timeOrigin = (performance.timing && performance.timing.navigationStart) || INITIAL_TIME;
-  }
-
-  return performance;
-})();
-
-/**
- * Returns a timestamp in seconds with milliseconds precision since the UNIX epoch calculated with the monotonic clock.
- */
-export function timestampWithMs(): number {
-  return (crossPlatformPerformance.timeOrigin + crossPlatformPerformance.now()) / 1000;
-}
-
 // https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
 const SEMVER_REGEXP = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
 

packages/utils/src/time.ts

@@ -0,0 +1,98 @@
+import { getGlobalObject } from './misc';
+import { dynamicRequire, isNodeEnv } from './node';
+
+const INITIAL_TIME = Date.now();
+
+/**
+ * Cross platform compatible partial performance implementation
+ */
+interface CrossPlatformPerformance {
+  timeOrigin: number;
+  /**
+   * Returns the current timestamp in ms
+   */
+  now(): number;
+}
+
+let prevNow = 0;
+
+const performanceFallback: CrossPlatformPerformance = {
+  now(): number {
+    let now = Date.now() - INITIAL_TIME;
+    if (now < prevNow) {
+      now = prevNow;
+    }
+    prevNow = now;
+    return now;
+  },
+  timeOrigin: INITIAL_TIME,
+};
+
+export const crossPlatformPerformance: CrossPlatformPerformance = ((): CrossPlatformPerformance => {
+  // React Native's performance.now() starts with a gigantic offset, so we need to wrap it.
+  if (isReactNative()) {
+    return getReactNativePerformanceWrapper();
+  }
+
+  if (isNodeEnv()) {
+    try {
+      const perfHooks = dynamicRequire(module, 'perf_hooks') as { performance: CrossPlatformPerformance };
+      return perfHooks.performance;
+    } catch (_) {
+      return performanceFallback;
+    }
+  }
+
+  const { performance } = getGlobalObject<Window>();
+
+  if (!performance || !performance.now) {
+    return performanceFallback;
+  }
+
+  // Polyfill for performance.timeOrigin.
+  //
+  // While performance.timing.navigationStart is deprecated in favor of performance.timeOrigin, performance.timeOrigin
+  // is not as widely supported. Namely, performance.timeOrigin is undefined in Safari as of writing.
+  if (performance.timeOrigin === undefined) {
+    // As of writing, performance.timing is not available in Web Workers in mainstream browsers, so it is not always a
+    // valid fallback. In the absence of a initial time provided by the browser, fallback to INITIAL_TIME.
+    // @ts-ignore ignored because timeOrigin is a readonly property but we want to override
+    // eslint-disable-next-line deprecation/deprecation
+    performance.timeOrigin = (performance.timing && performance.timing.navigationStart) || INITIAL_TIME;
+  }
+
+  return performance;
+})();
+
+/**
+ * Returns a timestamp in seconds with milliseconds precision since the UNIX epoch calculated with the monotonic clock.
+ */
+export function timestampWithMs(): number {
+  return (crossPlatformPerformance.timeOrigin + crossPlatformPerformance.now()) / 1000;
+}
+
+/**
+ * Determines if running in react native
+ */
+export function isReactNative(): boolean {
+  return getGlobalObject<Window>().navigator?.product === 'ReactNative';
+}
+
+/**
+ * Performance wrapper for react native as performance.now() has been found to start off with an unusual offset.
+ */
+function getReactNativePerformanceWrapper(): CrossPlatformPerformance {
+  // Performance only available >= RN 0.63
+  const { performance } = getGlobalObject<Window>();
+  if (performance && typeof performance.now === 'function') {
+    const INITIAL_OFFSET = performance.now();
+
+    return {
+      now(): number {
+        return performance.now() - INITIAL_OFFSET;
+      },
+      timeOrigin: INITIAL_TIME,
+    };
+  }
+  return performanceFallback;
+}