react-native-nitro-tracing 0.6.0

package/package.json

@@ -0,0 +1,236 @@
+{
+  "name": "react-native-nitro-tracing",
+  "version": "0.6.0",
+  "description": "In-app performance tracing for React Native: native spans, frame and resource metrics, a live inspector and Perfetto export — for dev, custom and UAT builds",
+  "main": "lib/commonjs/index.cjs",
+  "module": "lib/module/index.mjs",
+  "types": "lib/typescript/src/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
+    "android/build.gradle",
+    "android/gradle.properties",
+    "android/fix-prefab.gradle",
+    "android/CMakeLists.txt",
+    "android/src",
+    "android/proguard-rules.pro",
+    "cpp",
+    "ios/**/*.h",
+    "ios/**/*.m",
+    "ios/**/*.mm",
+    "ios/**/*.cpp",
+    "ios/**/*.swift",
+    "nitro.json",
+    "*.podspec",
+    "README.md",
+    "plugins.ts",
+    "performance.ts",
+    "sentry.ts",
+    "release-profiler.ts",
+    "client.ts",
+    "react.ts",
+    "expo.ts",
+    "LICENSE",
+    "CHANGELOG.md",
+    "!src/**/*.test.*"
+  ],
+  "keywords": [
+    "react-native",
+    "nitro-modules",
+    "performance",
+    "tracing",
+    "profiler",
+    "expo",
+    "perfetto",
+    "trace-inspector",
+    "sentry"
+  ],
+  "author": "gugell",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gugell/react-native-nitro-tracing.git",
+    "directory": "packages/react-native-nitro-tracing"
+  },
+  "bugs": "https://github.com/gugell/react-native-nitro-tracing/issues",
+  "license": "MIT",
+  "homepage": "https://github.com/gugell/react-native-nitro-tracing#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.25.3",
+    "@babel/preset-typescript": "^7.25.0",
+    "@legendapp/list": "3.4.0",
+    "@sentry/react-native": "8.27.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.0.0",
+    "@types/react": "~19.2.14",
+    "@types/react-test-renderer": "19",
+    "babel-jest": "^29.7.0",
+    "esbuild": "0.28.2",
+    "expo-dev-client": "~56.0.27",
+    "expo-file-system": "~56.0.11",
+    "expo-glass-effect": "56.0.4",
+    "expo-sharing": "~56.0.26",
+    "jest": "^29.7.0",
+    "nitrogen": "0.37.1",
+    "react": "19.2.3",
+    "react-native": "0.85.3",
+    "react-native-bottom-tabs": "1.4.0",
+    "react-native-nitro-modules": "0.37.1",
+    "react-native-performance": "^6.0.0",
+    "react-native-safe-area-context": "~5.7.0",
+    "react-test-renderer": "19.2.3",
+    "typescript": "~6.0.3"
+  },
+  "peerDependencies": {
+    "@legendapp/list": ">=3.4.0 <4",
+    "@sentry/react-native": ">=7.11.0 <9",
+    "expo-dev-client": ">=56",
+    "expo-file-system": ">=56",
+    "expo-sharing": ">=56",
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "^0.37.1",
+    "react-native-performance": ">=6",
+    "react-native-safe-area-context": ">=5.7.0 <6",
+    "react-native-bottom-tabs": ">=1.4.0 <2",
+    "expo-glass-effect": ">=56"
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false,
+    "semi": false
+  },
+  "peerDependenciesMeta": {
+    "react-native-performance": {
+      "optional": true
+    },
+    "@sentry/react-native": {
+      "optional": true
+    },
+    "expo-dev-client": {
+      "optional": true
+    },
+    "expo-file-system": {
+      "optional": true
+    },
+    "expo-sharing": {
+      "optional": true
+    },
+    "react-native-safe-area-context": {
+      "optional": true
+    },
+    "@legendapp/list": {
+      "optional": true
+    },
+    "react-native-bottom-tabs": {
+      "optional": true
+    },
+    "expo-glass-effect": {
+      "optional": true
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/typescript/src/index.d.ts",
+      "react-native": "./src/index.ts",
+      "import": "./lib/module/index.mjs",
+      "require": "./lib/commonjs/index.cjs",
+      "default": "./lib/module/index.mjs"
+    },
+    "./client": {
+      "types": "./lib/typescript/client.d.ts",
+      "react-native": "./client.ts",
+      "import": "./lib/module/client.mjs",
+      "require": "./lib/commonjs/client.cjs",
+      "default": "./lib/module/client.mjs"
+    },
+    "./react": {
+      "types": "./lib/typescript/react.d.ts",
+      "react-native": "./react.ts",
+      "import": "./lib/module/react.mjs",
+      "require": "./lib/commonjs/react.cjs",
+      "default": "./lib/module/react.mjs"
+    },
+    "./expo": {
+      "types": "./lib/typescript/expo.d.ts",
+      "react-native": "./expo.ts",
+      "import": "./lib/module/expo.mjs",
+      "require": "./lib/commonjs/expo.cjs",
+      "default": "./lib/module/expo.mjs"
+    },
+    "./plugins": {
+      "types": "./lib/typescript/plugins.d.ts",
+      "react-native": "./plugins.ts",
+      "import": "./lib/module/plugins.mjs",
+      "require": "./lib/commonjs/plugins.cjs",
+      "default": "./lib/module/plugins.mjs"
+    },
+    "./performance": {
+      "types": "./lib/typescript/performance.d.ts",
+      "react-native": "./performance.ts",
+      "import": "./lib/module/performance.mjs",
+      "require": "./lib/commonjs/performance.cjs",
+      "default": "./lib/module/performance.mjs"
+    },
+    "./sentry": {
+      "types": "./lib/typescript/sentry.d.ts",
+      "react-native": "./sentry.ts",
+      "import": "./lib/module/sentry.mjs",
+      "require": "./lib/commonjs/sentry.cjs",
+      "default": "./lib/module/sentry.mjs"
+    },
+    "./release-profiler": {
+      "types": "./lib/typescript/release-profiler.d.ts",
+      "react-native": "./release-profiler.ts",
+      "import": "./lib/module/release-profiler.mjs",
+      "require": "./lib/commonjs/release-profiler.cjs",
+      "default": "./lib/module/release-profiler.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "release-it": {
+    "npm": {
+      "publish": true,
+      "publishPath": "../../artifacts/release/react-native-nitro-tracing.tgz",
+      "publishPackageManager": "npm",
+      "publishArgs": [
+        "--access",
+        "public"
+      ]
+    },
+    "git": {
+      "commit": false,
+      "tag": false,
+      "push": false,
+      "requireCleanWorkingDir": false,
+      "requireUpstream": false,
+      "requireBranch": false
+    },
+    "github": {
+      "release": false
+    },
+    "hooks": {
+      "before:init": "pnpm --dir ../.. check",
+      "after:bump": "node ../../scripts/pack-check.mjs --release"
+    }
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "nitrogen": "nitrogen",
+    "test:native": "sh scripts/test-native.sh",
+    "test": "jest --runInBand",
+    "build": "node scripts/build.mjs && tsc -p tsconfig.build.json",
+    "test:sentry": "node scripts/test-sentry.cjs",
+    "release": "release-it"
+  }
+}

package/performance.ts

@@ -0,0 +1,2 @@
+export { createPerformancePlugin } from './src/plugins/performance'
+export type { PerformancePluginOptions } from './src/plugins/performance'

package/plugins.ts

@@ -0,0 +1,24 @@
+export { startPlugins } from './src/plugins/startPlugins'
+export type {
+  TracePlugin,
+  PluginContext,
+  PluginHandle,
+} from './src/plugins/TracePlugin'
+
+export { createRuntimeMetricsPlugin } from './src/plugins/runtimeMetrics'
+export type { RuntimeMetricsOptions } from './src/plugins/runtimeMetrics'
+
+export {
+  createNavigationPlugin,
+  createScreenTracker,
+} from './src/plugins/navigation'
+export type {
+  NavigationRefLike,
+  NavigationPluginOptions,
+} from './src/plugins/navigation'
+export { createNetworkPlugin, urlTemplate } from './src/plugins/network'
+export type { NetworkPluginOptions } from './src/plugins/network'
+export { createErrorsPlugin } from './src/plugins/errors'
+export type { ErrorsPluginOptions, ErrorUtilsLike } from './src/plugins/errors'
+export { createNativeMetricsPlugin } from './src/plugins/nativeMetrics'
+export type { NativeMetricsOptions } from './src/plugins/nativeMetrics'

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {},
+    },
+  },
+}

package/react.ts

@@ -0,0 +1,10 @@
+export { TraceInspector } from './src/react/TraceInspector'
+export { TraceOverlay } from './src/react/TraceOverlay'
+export { defaultLabels } from './src/react/labels'
+export type {
+  InspectorLabels,
+  InspectorTranslator,
+  InspectorLabelKey,
+} from './src/react/labels'
+
+export { useAppReadyMetric } from './src/react/useAppReadyMetric'

package/release-profiler.ts

@@ -0,0 +1,6 @@
+export { createReleaseProfilerPlugin } from './src/plugins/releaseProfiler'
+export type {
+  ReleaseProfilerApi,
+  ReleaseProfilerOptions,
+  ReleaseProfilerPlugin,
+} from './src/plugins/releaseProfiler'

package/sentry.ts

@@ -0,0 +1,2 @@
+export { createSentryPlugin } from './src/plugins/sentry'
+export type { SentryPluginOptions } from './src/plugins/sentry'

package/src/client/TracingSink.ts

@@ -0,0 +1,25 @@
+/** Optional compatibility output for app logs and breadcrumbs, separate from native retention. */
+export interface TracingEntry {
+  name: string
+  entryType: string
+  durationMs: number
+  value?: number | string
+  attributes?: Record<string, unknown>
+}
+export type TracingSink = (line: string, entry: TracingEntry) => void
+export function formatTracingEntry(entry: TracingEntry): string {
+  const attributes = entry.attributes
+  const id = attributes?.id
+  const suffix = typeof id === 'string' ? ` [${id.slice(-6)}]` : ''
+  const details = Object.entries(attributes ?? {})
+    .filter(([key, value]) => key !== 'id' && value !== undefined)
+    .map(([key, value]) => `${key}=${value}`)
+  const detail = details.length ? ` {${details.join(' ')}}` : ''
+  const label =
+    entry.entryType === 'metric'
+      ? `${entry.name}=${entry.value}`
+      : entry.entryType === 'measure'
+        ? `${entry.name} ${entry.durationMs.toFixed(0)}ms`
+        : entry.name
+  return `${label}${suffix}${detail}`
+}