@logbrew/react-native 0.1.11 → 0.1.12

package/index.cjs

@@ -4,6 +4,7 @@ const {
   createTraceparent,
   LogBrewClient,
   parseTraceparent,
+  PRODUCT_ANALYTICS_SCHEMA_VERSION,
   SdkError,
   TransportError
 } = require("@logbrew/sdk");
@@ -17,6 +18,7 @@ const DEFAULT_SDK_NAME = "logbrew-react-native";
 const DEFAULT_SDK_VERSION = "0.1.0";
 const DEFAULT_ENDPOINT = "https://api.logbrew.co/v1/events";
 const MAX_ACTION_NAME_LENGTH = 64;
+const MAX_PRODUCT_ANALYTICS_SURFACE_LENGTH = 256;
 const SCREEN_ACTION_PREFIX = "screen:";
 const BACKGROUND_APP_STATES = new Set(["background", "inactive"]);
 const LogBrewNativeContext = React.createContext(null);
@@ -27,6 +29,7 @@ function createLogBrewReactNativeClient({
   automaticDelivery,
   apiKey,
   clientKey,
+  context,
   deliveryIntervalMs,
   deliveryQueueThreshold,
   eventStore,
@@ -47,6 +50,7 @@ function createLogBrewReactNativeClient({
   return LogBrewClient.create({
     apiKey: authKey,
     automaticDelivery,
+    context,
     deliveryIntervalMs,
     deliveryQueueThreshold,
     eventStore,
@@ -304,9 +308,14 @@ function captureScreenView(client, screenName, {
       ...getReactNativeContext({ platform, appState }),
       screen: screenName,
       ...metadata,
-      ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
+      ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace()),
+      ...productAnalyticsMetadata("screen_view", screenName)
     }
   });
+  recordIssueBreadcrumb(client, {
+    timestamp,
+    attributes: { name: screenActionName(screenName), status }
+  }, "navigation", "navigation");
 }
 
 function captureAppStateChange(client, state, {
@@ -329,6 +338,10 @@ function captureAppStateChange(client, state, {
       ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
     }
   });
+  recordIssueBreadcrumb(client, {
+    timestamp,
+    attributes: { name: "app_state_change", status: "success" }
+  }, "app.state", "state");
 }
 
 function createReactNativeActionEvent({
@@ -359,7 +372,8 @@ function createReactNativeActionEvent({
         sessionId,
         traceId,
         ...metadata,
-        ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
+        ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace()),
+        ...productAnalyticsMetadata("interaction", screen)
       })
     }
   };
@@ -369,6 +383,7 @@ function captureReactNativeAction(client, input = {}) {
   requireClient(client);
   const event = createReactNativeActionEvent(input);
   client.action(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "ui.action", "user");
   return event;
 }
 
@@ -421,6 +436,7 @@ function captureReactNativeNetwork(client, input = {}) {
   requireClient(client);
   const event = createReactNativeNetworkEvent(input);
   client.action(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "http", "http");
   return event;
 }
 
@@ -459,6 +475,7 @@ function captureReactNativeNavigationSpan(client, input = {}) {
   requireClient(client);
   const event = createReactNativeNavigationSpanEvent(input);
   client.span(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "navigation", "navigation");
   return event;
 }
 
@@ -579,10 +596,12 @@ function createReactNativeErrorEvent(error, {
   debugIdMap,
   environment,
   fingerprint,
+  handled = true,
   id,
   idFactory = defaultErrorEventId,
   includeStack = false,
   level = "error",
+  mechanism = "react-native.error",
   metadata = {},
   now = () => new Date().toISOString(),
   platform,
@@ -600,8 +619,10 @@ function createReactNativeErrorEvent(error, {
     debugIdMap: debugIdMap === undefined ? runtimeReactNativeDebugIdMap() : debugIdMap,
     environment,
     fingerprint,
+    handled,
     includeErrorStack: includeStack,
     level,
+    mechanism,
     metadata: {
       ...getReactNativeContext({ platform, appState }),
       errorValueType: details.valueType,
@@ -852,6 +873,40 @@ function defaultFetch() {
   return typeof globalThis.fetch === "function" ? globalThis.fetch.bind(globalThis) : undefined;
 }
 
+function recordIssueBreadcrumb(client, event, category, type) {
+  if (typeof client?.addBreadcrumb !== "function") {
+    return;
+  }
+  const status = typeof event?.attributes?.status === "string"
+    ? event.attributes.status
+    : undefined;
+  const message = boundedBreadcrumbMessage(event?.attributes?.name);
+  client.addBreadcrumb({
+    category,
+    type,
+    level: status === "failure" || status === "error" ? "error" : "info",
+    ...(message === undefined ? {} : { message }),
+    ...(status === undefined ? {} : { data: { status } })
+  }, event.timestamp);
+}
+
+function boundedBreadcrumbMessage(value) {
+  if (typeof value !== "string" || value.trim() === "") {
+    return undefined;
+  }
+  const characters = Array.from(value);
+  if (
+    characters.length > 512
+    || characters.some((character) => {
+      const code = character.codePointAt(0);
+      return code !== undefined && (code <= 31 || (code >= 127 && code <= 159));
+    })
+  ) {
+    return undefined;
+  }
+  return value;
+}
+
 function defaultRandomValues(length) {
   if (!globalThis.crypto || typeof globalThis.crypto.getRandomValues !== "function") {
     throw new SdkError("configuration_error", "createReactNativeTraceparent requires crypto.getRandomValues or randomValues");
@@ -1043,6 +1098,33 @@ function screenActionName(screenName) {
   return `${SCREEN_ACTION_PREFIX}${screenSegment}`;
 }
 
+function productAnalyticsMetadata(kind, surface) {
+  return {
+    analyticsSchemaVersion: PRODUCT_ANALYTICS_SCHEMA_VERSION,
+    analyticsKind: kind,
+    analyticsSurface: boundedProductAnalyticsSurface(surface)
+  };
+}
+
+function boundedProductAnalyticsSurface(surface) {
+  if (typeof surface !== "string") {
+    return undefined;
+  }
+  const normalized = surface.trim();
+  const characters = Array.from(normalized);
+  if (
+    normalized === ""
+    || characters.length > MAX_PRODUCT_ANALYTICS_SURFACE_LENGTH
+    || characters.some((character) => {
+      const code = character.codePointAt(0);
+      return code !== undefined && (code <= 31 || (code >= 127 && code <= 159));
+    })
+  ) {
+    return undefined;
+  }
+  return normalized;
+}
+
 function statusFromStatusCode(statusCode) {
   if (typeof statusCode === "number" && Number.isFinite(statusCode) && statusCode >= 400) {
     return "failure";

package/index.d.cts

@@ -11,6 +11,7 @@ import type {
   Metadata,
   ReleaseAttributes,
   SpanAttributes,
+  TelemetryContext,
   Transport,
   TransportResponse
 } from "@logbrew/sdk";
@@ -36,6 +37,7 @@ export type CreateLogBrewReactNativeClientConfig = {
   automaticDelivery?: boolean;
   apiKey?: string;
   clientKey?: string;
+  context?: TelemetryContext;
   deliveryIntervalMs?: number;
   deliveryQueueThreshold?: number;
   /** Advanced synchronous persistence seam. React Native apps normally use the native entry's persistentQueue mode. */
@@ -287,10 +289,12 @@ export type CaptureReactNativeErrorOptions = ReactNativeContextOptions & {
   debugIdMap?: Record<string, string>;
   environment?: string;
   fingerprint?: string;
+  handled?: boolean;
   id?: string;
   idFactory?: (context: ReactNativeErrorIdFactoryContext) => string;
   includeStack?: boolean;
   level?: IssueAttributes["level"];
+  mechanism?: string;
   now?: () => string;
   release?: string;
   runtime?: string;

package/index.d.ts

@@ -11,6 +11,7 @@ import type {
   Metadata,
   ReleaseAttributes,
   SpanAttributes,
+  TelemetryContext,
   Transport,
   TransportResponse
 } from "@logbrew/sdk";
@@ -36,6 +37,7 @@ export type CreateLogBrewReactNativeClientConfig = {
   automaticDelivery?: boolean;
   apiKey?: string;
   clientKey?: string;
+  context?: TelemetryContext;
   deliveryIntervalMs?: number;
   deliveryQueueThreshold?: number;
   /** Advanced synchronous persistence seam. React Native apps normally use the native entry's persistentQueue mode. */
@@ -287,10 +289,12 @@ export type CaptureReactNativeErrorOptions = ReactNativeContextOptions & {
   debugIdMap?: Record<string, string>;
   environment?: string;
   fingerprint?: string;
+  handled?: boolean;
   id?: string;
   idFactory?: (context: ReactNativeErrorIdFactoryContext) => string;
   includeStack?: boolean;
   level?: IssueAttributes["level"];
+  mechanism?: string;
   now?: () => string;
   release?: string;
   runtime?: string;

package/index.js

@@ -4,6 +4,7 @@ import {
   createTraceparent,
   LogBrewClient,
   parseTraceparent,
+  PRODUCT_ANALYTICS_SCHEMA_VERSION,
   SdkError,
   TransportError
 } from "@logbrew/sdk";
@@ -17,6 +18,7 @@ const DEFAULT_SDK_NAME = "logbrew-react-native";
 const DEFAULT_SDK_VERSION = "0.1.0";
 const DEFAULT_ENDPOINT = "https://api.logbrew.co/v1/events";
 const MAX_ACTION_NAME_LENGTH = 64;
+const MAX_PRODUCT_ANALYTICS_SURFACE_LENGTH = 256;
 const SCREEN_ACTION_PREFIX = "screen:";
 const BACKGROUND_APP_STATES = new Set(["background", "inactive"]);
 const LogBrewNativeContext = React.createContext(null);
@@ -27,6 +29,7 @@ export function createLogBrewReactNativeClient({
   automaticDelivery,
   apiKey,
   clientKey,
+  context,
   deliveryIntervalMs,
   deliveryQueueThreshold,
   eventStore,
@@ -47,6 +50,7 @@ export function createLogBrewReactNativeClient({
   return LogBrewClient.create({
     apiKey: authKey,
     automaticDelivery,
+    context,
     deliveryIntervalMs,
     deliveryQueueThreshold,
     eventStore,
@@ -304,9 +308,14 @@ export function captureScreenView(client, screenName, {
       ...getReactNativeContext({ platform, appState }),
       screen: screenName,
       ...metadata,
-      ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
+      ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace()),
+      ...productAnalyticsMetadata("screen_view", screenName)
     }
   });
+  recordIssueBreadcrumb(client, {
+    timestamp,
+    attributes: { name: screenActionName(screenName), status }
+  }, "navigation", "navigation");
 }
 
 export function captureAppStateChange(client, state, {
@@ -329,6 +338,10 @@ export function captureAppStateChange(client, state, {
       ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
     }
   });
+  recordIssueBreadcrumb(client, {
+    timestamp,
+    attributes: { name: "app_state_change", status: "success" }
+  }, "app.state", "state");
 }
 
 export function createReactNativeActionEvent({
@@ -359,7 +372,8 @@ export function createReactNativeActionEvent({
         sessionId,
         traceId,
         ...metadata,
-        ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace())
+        ...getReactNativeTraceMetadata(trace ?? getActiveLogBrewTrace()),
+        ...productAnalyticsMetadata("interaction", screen)
       })
     }
   };
@@ -369,6 +383,7 @@ export function captureReactNativeAction(client, input = {}) {
   requireClient(client);
   const event = createReactNativeActionEvent(input);
   client.action(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "ui.action", "user");
   return event;
 }
 
@@ -421,6 +436,7 @@ export function captureReactNativeNetwork(client, input = {}) {
   requireClient(client);
   const event = createReactNativeNetworkEvent(input);
   client.action(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "http", "http");
   return event;
 }
 
@@ -459,6 +475,7 @@ export function captureReactNativeNavigationSpan(client, input = {}) {
   requireClient(client);
   const event = createReactNativeNavigationSpanEvent(input);
   client.span(event.id, event.timestamp, event.attributes);
+  recordIssueBreadcrumb(client, event, "navigation", "navigation");
   return event;
 }
 
@@ -568,10 +585,12 @@ export function createReactNativeErrorEvent(error, {
   debugIdMap,
   environment,
   fingerprint,
+  handled = true,
   id,
   idFactory = defaultErrorEventId,
   includeStack = false,
   level = "error",
+  mechanism = "react-native.error",
   metadata = {},
   now = () => new Date().toISOString(),
   platform,
@@ -589,8 +608,10 @@ export function createReactNativeErrorEvent(error, {
     debugIdMap: debugIdMap === undefined ? runtimeReactNativeDebugIdMap() : debugIdMap,
     environment,
     fingerprint,
+    handled,
     includeErrorStack: includeStack,
     level,
+    mechanism,
     metadata: {
       ...getReactNativeContext({ platform, appState }),
       errorValueType: details.valueType,
@@ -841,6 +862,40 @@ function defaultFetch() {
   return typeof globalThis.fetch === "function" ? globalThis.fetch.bind(globalThis) : undefined;
 }
 
+function recordIssueBreadcrumb(client, event, category, type) {
+  if (typeof client?.addBreadcrumb !== "function") {
+    return;
+  }
+  const status = typeof event?.attributes?.status === "string"
+    ? event.attributes.status
+    : undefined;
+  const message = boundedBreadcrumbMessage(event?.attributes?.name);
+  client.addBreadcrumb({
+    category,
+    type,
+    level: status === "failure" || status === "error" ? "error" : "info",
+    ...(message === undefined ? {} : { message }),
+    ...(status === undefined ? {} : { data: { status } })
+  }, event.timestamp);
+}
+
+function boundedBreadcrumbMessage(value) {
+  if (typeof value !== "string" || value.trim() === "") {
+    return undefined;
+  }
+  const characters = Array.from(value);
+  if (
+    characters.length > 512
+    || characters.some((character) => {
+      const code = character.codePointAt(0);
+      return code !== undefined && (code <= 31 || (code >= 127 && code <= 159));
+    })
+  ) {
+    return undefined;
+  }
+  return value;
+}
+
 function defaultRandomValues(length) {
   if (!globalThis.crypto || typeof globalThis.crypto.getRandomValues !== "function") {
     throw new SdkError("configuration_error", "createReactNativeTraceparent requires crypto.getRandomValues or randomValues");
@@ -1032,6 +1087,33 @@ function screenActionName(screenName) {
   return `${SCREEN_ACTION_PREFIX}${screenSegment}`;
 }
 
+function productAnalyticsMetadata(kind, surface) {
+  return {
+    analyticsSchemaVersion: PRODUCT_ANALYTICS_SCHEMA_VERSION,
+    analyticsKind: kind,
+    analyticsSurface: boundedProductAnalyticsSurface(surface)
+  };
+}
+
+function boundedProductAnalyticsSurface(surface) {
+  if (typeof surface !== "string") {
+    return undefined;
+  }
+  const normalized = surface.trim();
+  const characters = Array.from(normalized);
+  if (
+    normalized === ""
+    || characters.length > MAX_PRODUCT_ANALYTICS_SURFACE_LENGTH
+    || characters.some((character) => {
+      const code = character.codePointAt(0);
+      return code !== undefined && (code <= 31 || (code >= 127 && code <= 159));
+    })
+  ) {
+    return undefined;
+  }
+  return normalized;
+}
+
 function statusFromStatusCode(statusCode) {
   if (typeof statusCode === "number" && Number.isFinite(statusCode) && statusCode >= 400) {
     return "failure";

package/index.native.d.ts

@@ -2,6 +2,7 @@ import type { EventStore, LogBrewClient } from "@logbrew/sdk";
 import type { CreateLogBrewReactNativeClientConfig } from "./index.js";
 
 export * from "./index.js";
+export * from "./apple-native-diagnostics.js";
 export {
   installLogBrewReactNativeGlobalErrorHandler,
   installLogBrewReactNativePromiseRejectionTracker
@@ -41,7 +42,10 @@ declare const defaultExport: Omit<
 > & {
   createLogBrewReactNativeClient: typeof createLogBrewReactNativeClient;
   createDefaultLogBrewReactNativeClient: typeof createDefaultLogBrewReactNativeClient;
+  getLogBrewAppleNativeDiagnosticsStatus: typeof import("./apple-native-diagnostics.js").getLogBrewAppleNativeDiagnosticsStatus;
+  installLogBrewAppleNativeDiagnostics: typeof import("./apple-native-diagnostics.js").installLogBrewAppleNativeDiagnostics;
   purgeLogBrewReactNativePersistentQueue: typeof purgeLogBrewReactNativePersistentQueue;
+  replayLogBrewAppleNativeDiagnostics: typeof import("./apple-native-diagnostics.js").replayLogBrewAppleNativeDiagnostics;
 };
 
 export default defaultExport;

package/index.native.js

@@ -10,6 +10,11 @@ import {
   getReactNativeContext
 } from "./index.js";
 import baseDefault from "./index.js";
+import {
+  getLogBrewAppleNativeDiagnosticsStatus,
+  installLogBrewAppleNativeDiagnostics,
+  replayLogBrewAppleNativeDiagnostics
+} from "./apple-native-diagnostics.js";
 import {
   purgeReactNativePersistentQueue,
   resolveReactNativePersistentEventStore
@@ -18,6 +23,11 @@ export {
   installLogBrewReactNativeGlobalErrorHandler,
   installLogBrewReactNativePromiseRejectionTracker
 } from "./global-errors.native.js";
+export {
+  getLogBrewAppleNativeDiagnosticsStatus,
+  installLogBrewAppleNativeDiagnostics,
+  replayLogBrewAppleNativeDiagnostics
+};
 
 export * from "./index.js";
 
@@ -133,7 +143,10 @@ const defaultExport = {
   createDefaultLogBrewReactNativeClient,
   createLogBrewReactNativeClient,
   getDefaultReactNativeContext,
-  purgeLogBrewReactNativePersistentQueue
+  getLogBrewAppleNativeDiagnosticsStatus,
+  installLogBrewAppleNativeDiagnostics,
+  purgeLogBrewReactNativePersistentQueue,
+  replayLogBrewAppleNativeDiagnostics
 };
 
 export default defaultExport;

package/ios/AppleDiagnostics/LBRNAppleDiagnosticsModule.h

@@ -0,0 +1,4 @@
+#import <React/RCTBridgeModule.h>
+
+@interface LBRNAppleDiagnosticsModule : NSObject <RCTBridgeModule>
+@end

package/ios/AppleDiagnostics/LBRNAppleDiagnosticsModule.mm

@@ -0,0 +1,56 @@
+#import "LBRNAppleDiagnosticsModule.h"
+
+#if __has_include(<LogBrewReactNative/LogBrewReactNative-Swift.h>)
+#import <LogBrewReactNative/LogBrewReactNative-Swift.h>
+#elif __has_include("LogBrewReactNative-Swift.h")
+#import "LogBrewReactNative-Swift.h"
+#else
+#error "LogBrew React Native Apple diagnostics requires its generated Swift interface"
+#endif
+
+#ifdef RCT_NEW_ARCH_ENABLED
+#import <LogBrewReactNativeSpec/LogBrewReactNativeSpec.h>
+#endif
+
+@interface LBRNAppleDiagnosticsModule ()
+#ifdef RCT_NEW_ARCH_ENABLED
+<NativeLogBrewAppleDiagnosticsSpec>
+#endif
+@end
+
+@implementation LBRNAppleDiagnosticsModule
+
+RCT_EXPORT_MODULE(LogBrewAppleDiagnostics)
+
++ (BOOL)requiresMainQueueSetup
+{
+    return YES;
+}
+
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(installNativeDiagnostics:(NSDictionary *)configuration)
+{
+    return [LBRNAppleNativeDiagnostics installWithConfiguration:configuration];
+}
+
+RCT_EXPORT_METHOD(replayNativeDiagnostics:(RCTPromiseResolveBlock)resolve
+                  reject:(__unused RCTPromiseRejectBlock)reject)
+{
+    [LBRNAppleNativeDiagnostics replayWithCompletion:^(NSDictionary *result) {
+      resolve(result);
+    }];
+}
+
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(nativeDiagnosticsStatus)
+{
+    return [LBRNAppleNativeDiagnostics status];
+}
+
+#ifdef RCT_NEW_ARCH_ENABLED
+- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
+    (const facebook::react::ObjCTurboModule::InitParams &)params
+{
+    return std::make_shared<facebook::react::NativeLogBrewAppleDiagnosticsSpecJSI>(params);
+}
+#endif
+
+@end