@arms/rum-reactnative 0.1.2 → 0.1.3-beta.0

package/lib/commonjs/collector/resource/api.js

@@ -0,0 +1,286 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _rumCore = require("@arms/rum-core");
+var _base = require("../../utils/base");
+var _api = require("../../utils/api");
+class ApiCollector {
+  name = 'api-collector';
+  setup(ctx, sendEvent) {
+    const collectors = ctx.getConfig().collectors || {};
+    if (collectors.api === false) {
+      return;
+    }
+    this.sendEvent = sendEvent;
+    this.ctx = ctx;
+    // this.perfObserver();
+    this.hackXhr();
+    // this.hackFetch();
+  }
+  injectTracing(apiAttr, inject) {
+    const {
+      tracing = false,
+      pid,
+      version = '1.0.0'
+    } = this.ctx.getConfig();
+    const {
+      enable,
+      sample,
+      propagatorTypes,
+      allowedUrls,
+      tracestate,
+      baggage = false
+    } = (0, _rumCore.parseTracingOptions)(tracing);
+    if (!enable) return;
+    // @ts-ignore
+    const resolvedTraceOption = (0, _rumCore.find)(allowedUrls, item => (0, _rumCore.matchList)([item.match], apiAttr.url || ''));
+    if (!resolvedTraceOption) return;
+    let pTypes = resolvedTraceOption.propagatorTypes;
+    if (pTypes && pTypes.length === 0) {
+      pTypes = propagatorTypes;
+    }
+    // skywalking
+    let isSw8 = false;
+    if (pTypes && pTypes.indexOf('sw8') > -1) {
+      pTypes = ['sw8'];
+      isSw8 = true;
+    }
+    const session = this.ctx.session;
+    const traceId = isSw8 ? (0, _rumCore.generateGUID)() : (0, _rumCore.generateTraceId)();
+    const spanId = isSw8 ? (0, _rumCore.generateGUID)() : (0, _rumCore.generateSpanId)();
+    const sampled = (0, _rumCore.performDraw)(sample);
+    const uid = session.getUserId();
+    const sid = session.getSessionId();
+    const traceContext = tracestate ? `rum=v2&browser&${pid}&${sid}&${uid}` : undefined;
+    const baggageContext = baggage ? `rum=v2,appType=browser,pid=${pid},sid=${sid},uid=${uid}` : undefined;
+    const tracingHeaders = (0, _rumCore.makeTracingHeaders)(traceId, spanId, sampled, pTypes || [], {
+      tracestate: traceContext,
+      baggage: baggageContext,
+      appId: pid,
+      appVersion: version,
+      viewName: apiAttr.view?.name
+      // host: location.host
+    });
+    if (sampled) {
+      apiAttr.trace_id = traceId;
+      apiAttr.trace_data = JSON.stringify({
+        spanId,
+        sample,
+        sampled,
+        headers: tracingHeaders
+      });
+    }
+    inject(tracingHeaders);
+  }
+  hackXhr() {
+    const oldXHRProto = XMLHttpRequest.prototype;
+    const self = this;
+    (0, _rumCore.interceptFunction)(oldXHRProto, 'open', function (method, url, async, user, password) {
+      const filters = self.ctx.getConfig().filters || {};
+      const urlStr = String(url);
+      const methodStr = method.toUpperCase();
+      // chrome 对 URL 的最大长度为 8182 个字符
+      if ((0, _rumCore.urlMatch)(urlStr, filters.resource) || methodStr === 'HEAD' || urlStr.length > 8182) return;
+      this.apiCache = {
+        type: _api.ApiType.XHR,
+        method,
+        url,
+        async,
+        user,
+        password,
+        headers: {}
+      };
+      const baseRumEvent = self.ctx.session.getBaseEvent();
+      this.apiAttr = {
+        ...baseRumEvent,
+        url: urlStr,
+        method: methodStr
+      };
+    }, true);
+    (0, _rumCore.interceptFunction)(oldXHRProto, 'setRequestHeader', function (header, value) {
+      if (!this.apiCache) return;
+      this.apiCache.headers = {
+        ...this.apiCache.headers,
+        [header]: value
+      };
+    }, true);
+    (0, _rumCore.interceptFunction)(oldXHRProto, 'send', function (body) {
+      if (!this.apiAttr || !this.apiCache) return;
+      let apiAttr = this.apiAttr;
+      this.apiCache.data = body;
+      self.injectTracing(this.apiAttr, tracingHeaders => {
+        Object.keys(tracingHeaders).forEach(key => {
+          tracingHeaders[key] && this.setRequestHeader(key, tracingHeaders[key]);
+        });
+      });
+      this.addEventListener('loadend', async () => {
+        const {
+          status,
+          statusText,
+          response
+        } = this;
+        const {
+          evaluateApi
+        } = self.ctx.getConfig();
+        if (!this.apiAttr) return;
+        apiAttr.status_code = status;
+        apiAttr.message = statusText;
+        const entry = {
+          name: this.apiAttr.url,
+          entryType: _api.ApiType.XHR,
+          duration: (0, _base.getCurrentTime)() - apiAttr.timestamp
+        };
+        if ((0, _rumCore.isFunction)(evaluateApi)) {
+          try {
+            let error;
+            if (apiAttr.success === _rumCore.ResourceStatus.Failed) {
+              error = new Error(_api.ApiType.XHR + ' error');
+            }
+            const attrs = await evaluateApi?.(this.apiCache, response, error, this);
+            this.apiAttr = apiAttr = {
+              ...apiAttr,
+              ...(0, _api.reviseApiAttr)(attrs)
+            };
+          } catch (e) {
+            _rumCore.logger.warn('api-collector', 'evaluateApi failed for XHR', e);
+          }
+        }
+        self.sendAPI(apiAttr, entry);
+      });
+      this.addEventListener('error', () => {
+        this.apiAttr && (this.apiAttr.success = _rumCore.ResourceStatus.Failed);
+      });
+    }, true);
+  }
+  hackFetch() {
+    const self = this;
+    const originFetch = this.originFetch = globalThis.fetch;
+    const filters = this.ctx.getConfig().filters || {};
+    globalThis.fetch = function (input, init = {}) {
+      const isReq = input instanceof Request;
+      const urlStr = isReq ? input.url : (0, _rumCore.isString)(input) ? input : input.toString();
+      let method = init.method;
+      let headers = init.headers;
+      if (isReq) {
+        !method && (method = input.method);
+        !headers && (headers = input.headers);
+      }
+      method = method ? method.toUpperCase() : 'GET';
+      if (!headers) {
+        init.headers = headers = new Headers();
+      }
+      if ((0, _rumCore.urlMatch)(urlStr, filters.resource) || method === 'HEAD' || init?.mode === 'no-cors' || urlStr.length > 8182) {
+        return originFetch.call(global, input, init);
+      }
+      const baseRumEvent = self.ctx.session.getBaseEvent();
+      let apiAttr = {
+        ...baseRumEvent,
+        url: urlStr,
+        type: _api.ApiType.FETCH,
+        method
+      };
+      let apiResp;
+      let apiError;
+      self.injectTracing(apiAttr, tracingHeaders => {
+        Object.keys(tracingHeaders).forEach(key => {
+          if (!headers) return;
+          if (headers instanceof Headers) {
+            tracingHeaders[key] && headers.set(key, tracingHeaders[key]);
+          } else {
+            // @ts-ignore
+            headers[key] = tracingHeaders[key];
+          }
+        });
+      });
+      async function fetchFinally() {
+        const {
+          evaluateApi
+        } = self.ctx.getConfig();
+        const entry = {
+          name: apiAttr.url,
+          entryType: _api.ApiType.FETCH,
+          duration: (0, _base.getCurrentTime)() - apiAttr.timestamp
+        };
+        if ((0, _rumCore.isFunction)(evaluateApi)) {
+          try {
+            const attrs = await evaluateApi?.({
+              url: input,
+              ...init
+            }, apiResp, apiError);
+            apiAttr = {
+              ...apiAttr,
+              ...(0, _api.reviseApiAttr)(attrs)
+            };
+          } catch (e) {
+            _rumCore.logger.warn('api-collector', 'evaluateApi failed for fetch', e);
+          }
+        }
+        self.sendAPI(apiAttr, entry);
+      }
+      return originFetch.call(globalThis, input, init).then(response => {
+        // @ts-ignore
+        if (response || (0, _rumCore.isFunction)(response.clone)) {
+          apiResp = response.clone();
+          const {
+            status,
+            statusText
+          } = apiResp;
+          apiAttr.status_code = status;
+          apiAttr.message = statusText;
+          fetchFinally().then();
+        }
+        return response;
+      }).catch(error => {
+        apiError = error;
+        apiAttr.message = String(error);
+        apiAttr.success = _rumCore.ResourceStatus.Failed;
+        fetchFinally().then();
+        throw error;
+      });
+    };
+  }
+  sendAPI(apiAttr, entry) {
+    const {
+      parseResourceName
+    } = this.ctx.getConfig();
+    const {
+      url,
+      status_code,
+      view
+    } = apiAttr;
+    const success = (0, _api.getResourceSuccessByCode)(status_code);
+    const measures = {
+      duration: entry.duration
+    };
+    const event = {
+      event_type: _rumCore.RumEventType.RESOURCE,
+      url,
+      name: (0, _api.getResourceName)(url || '', parseResourceName),
+      success,
+      type: entry.initiatorType || entry.entryType,
+      ...apiAttr,
+      timing_data: JSON.stringify(entry),
+      // Measure
+      ...measures,
+      view
+    };
+    this.sendEvent?.(event);
+  }
+  destroy() {
+    this.sendEvent = () => {};
+    // 恢复XHR
+    const oldXHRProto = XMLHttpRequest.prototype;
+    (0, _rumCore.restoreFunction)(oldXHRProto, 'open');
+    (0, _rumCore.restoreFunction)(oldXHRProto, 'setRequestHeader');
+    (0, _rumCore.restoreFunction)(oldXHRProto, 'send');
+    // 恢复 fetch
+    if (this.originFetch) {
+      globalThis.fetch = this.originFetch;
+    }
+  }
+}
+exports.default = ApiCollector;
+//# sourceMappingURL=api.js.map

package/lib/commonjs/collector/view/perf.js

@@ -0,0 +1,79 @@
+// import { ICollector, IContext, isArray, RumEvent } from '@arms/rum-core';
+// import { getPerformance } from "../../utils/platform";
+// import { getCurView } from "../../utils/view";
+//
+//
+//
+//
+// export default class PerfCollector implements ICollector {
+//   name = 'perf-collector';
+//   ctx: IContext;
+//   sendEvent: (payload: RumEvent) => void;
+//   perfObserver: any;
+//
+//   setup(ctx: IContext, sendEvent: (payload: RumEvent) => void) {
+//     const {collectors = {}} = ctx.getConfig();
+//     if (collectors.perf === false) {
+//       return;
+//     }
+//     this.ctx = ctx;
+//     this.sendEvent = sendEvent;
+//     const performance = getPerformance();
+//     if (!performance || !performance.createObserver) return;
+//     this.perfObserver = performance.createObserver(this.observerHandler)
+//     this.perfObserver.observe({entryTypes: ['launch', 'navigation', 'render', 'paint', 'resource']});
+//   }
+//
+//   observerHandler = (ev) => {
+//     const entries = isArray(ev) ? ev : ev.getEntries();
+//     const perfData = {
+//       view: getCurView(this.ctx)
+//     };
+//     if (Array.isArray(entries) && entries.length > 0) {
+//       for (let i = 0; i < entries.length; i++) {
+//         const item = entries[i];
+//         if (typeof item.duration === 'number') {
+//           switch (item.name) {
+//             case 'appLaunch':
+//             case 'app-click':
+//               perfData['launch'] = item.duration;
+//               break;
+//             case 'firstPaint':
+//             // case 'first-paint':
+//               perfData['first-paint'] = item.duration;
+//               break;
+//             case 'firstRender':
+//               perfData['first_render'] = item.duration;
+//               break;
+//             case 'firstContentfulPaint':
+//             // case 'first-contentful-paint':
+//               perfData['first_contentful_paint'] = item.duration;
+//               break;
+//             case 'largestContentfulPaint':
+//             // case 'largest-contentful-paint':
+//               perfData['largest_contentful_paint'] = item.duration;
+//               break;
+//             case 'resourceTiming':
+//             case 'resource-timing':
+//               perfData['timing_data'] = JSON.stringify(item);
+//               break;
+//             default:
+//               break;
+//           }
+//         }
+//       }
+//     }
+//
+//     if (!Object.keys(perfData).length) return;
+//     // TODO 处理性能数据
+//     // console.warn('perf-collector: ', perfData);
+//   };
+//
+//   destroy() {
+//     if (this.perfObserver) {
+//       this.perfObserver.disconnect();
+//     }
+//   }
+// }
+"use strict";
+//# sourceMappingURL=perf.js.map

package/lib/commonjs/collector/view/pv.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _rumCore = require("@arms/rum-core");
+var _view = require("../../utils/view");
+var _crash = require("../../types/crash");
+class PvCollector {
+  name = 'pv-collector';
+  pageMap = {};
+  setup(ctx, sendEvent) {
+    this.ctx = ctx;
+    this.sendEvent = sendEvent;
+    (0, _view.addNavigateListener)(this.onChange);
+  }
+  onChange = route => {
+    // {"name":"index","path":"/","key":"index-SB2hXmOGNdpiLskG5sXwj"}
+    // {"name":"__root","key":"__root-jPbNqG7-HaM-OUx_FcCUw"}
+    const {
+      key,
+      name,
+      path,
+      params
+    } = route;
+    const page = {
+      name,
+      path,
+      id: key,
+      params
+    };
+    if (name === '__root') return;
+    this.sendPv(page);
+  };
+  sendPv = page => {
+    const prevPage = this.prevPage;
+    const ctx = this.ctx;
+    if (page.id === prevPage?.id) {
+      // 路由没有发生变化，不发送
+      return;
+    }
+    page.name = this.getViewName(page.path || page.name || '', page);
+    if (prevPage && prevPage.id in this.pageMap) {
+      delete this.pageMap[prevPage.id];
+      ctx.removeView(prevPage.id);
+    }
+    this.prevPage = page;
+    ctx.addView(page);
+
+    // 路由回退情况下已经上报
+    if (page.id in this.pageMap) {
+      return;
+    }
+    this.pageMap[page.id] = page;
+    this.sendEvent?.({
+      event_type: _rumCore.RumEventType.VIEW,
+      type: 'pv',
+      loading_type: 'initial_load',
+      ...page
+    });
+
+    // 同步当前 view 上下文到原生侧（崩溃报告关联用）
+    const sessionId = ctx.session?.getSessionId?.() || '';
+    const userId = ctx.session?.getUserId?.() || '';
+    ctx.emitter.emit(_crash.CRASH_CONTEXT_EVENT, {
+      session_id: sessionId,
+      user_id: userId,
+      view_id: page.id,
+      view_name: page.name
+    });
+  };
+  getViewName(url, page) {
+    let {
+      parseViewName
+    } = this.ctx?.getConfig();
+    let name = page.name;
+    if (parseViewName && (0, _rumCore.isFunction)(parseViewName)) {
+      name = parseViewName(url, page) || name;
+    }
+    return name;
+  }
+  destroy() {
+    (0, _view.removeNavigateListener)(this.onChange);
+  }
+}
+exports.default = PvCollector;
+//# sourceMappingURL=pv.js.map

package/lib/commonjs/expoConfigPlugin.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Expo config plugin for @arms/rum-reactnative.
+ *
+ * 在 app.config 中声明后，将 SDK 配置写入 `expoConfig.extra.rumSdk`，运行时可通过
+ * `Constants.expoConfig?.extra?.rumSdk` 读取，避免在 JS 入口硬编码 endpoint。
+ *
+ * app.config.ts 示例：
+ *   plugins: [['@arms/rum-reactnative', { endpoint: '...', env: 'prod' }]]
+ *
+ * 仅做配置透传，不注入原生构建设置（podspec / gradle 已由 autolinking 处理）。
+ * 零运行时依赖，非 Expo 用户安装本包不会拉入 @expo/* 。
+ */
+
+/** 本插件触碰到的 expo config 切片，故意放宽以避免对 @expo/config-types 的硬依赖。 */
+
+const withRumSdk = (config, props) => {
+  const extra = {
+    ...(config.extra ?? {})
+  };
+  extra.rumSdk = {
+    endpoint: props?.endpoint,
+    env: props?.env ?? 'prod',
+    version: props?.version
+  };
+  return {
+    ...config,
+    extra
+  };
+};
+var _default = exports.default = withRumSdk;
+//# sourceMappingURL=expoConfigPlugin.js.map

package/lib/commonjs/index.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ArmsRum", {
+  enumerable: true,
+  get: function () {
+    return _shell.ArmsRum;
+  }
+});
+Object.defineProperty(exports, "callMonitored", {
+  enumerable: true,
+  get: function () {
+    return _rumCore.callMonitored;
+  }
+});
+exports.default = void 0;
+Object.defineProperty(exports, "logger", {
+  enumerable: true,
+  get: function () {
+    return _rumCore.logger;
+  }
+});
+var _shell = _interopRequireWildcard(require("./shell"));
+var _rumCore = require("@arms/rum-core");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+var _default = exports.default = _shell.default;
+//# sourceMappingURL=index.js.map

package/lib/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/commonjs/plugin.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _reactNative = require("react-native");
+var _rumCore = require("@arms/rum-core");
+var _platform = require("./utils/platform");
+var _shell = _interopRequireDefault(require("./shell"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const RumSdkModule = _reactNative.NativeModules.RumSdkModule;
+function initRum(config) {
+  _shell.default.init({
+    ...config,
+    beforeReport(bundle) {
+      RumSdkModule.sendEvent(JSON.stringify(bundle));
+      return null;
+    }
+  });
+}
+if (RumSdkModule) {
+  const eventEmitter = new _reactNative.NativeEventEmitter(RumSdkModule);
+  eventEmitter.addListener('rumNativeEvent', config => {
+    if ((0, _rumCore.isString)(config)) {
+      try {
+        config = JSON.parse(config);
+      } catch (e) {
+        console.warn('getConfig error', e);
+        return;
+      }
+    }
+    // pid 为可选配置，未提供时使用默认值（格式：react-native@{VERSION}）
+    // 这确保了即使未在ARMS控制台创建应用，SDK也能正常初始化和上报
+    if (!config.pid) {
+      config.pid = `react-native@${_platform.VERSION}`;
+    }
+    // endpoint 为必填配置，未提供时使用本地回环地址作为兜底
+    if (!config.endpoint) {
+      config.endpoint = `http://127.0.0.1/?version=${_platform.VERSION}`;
+    }
+    initRum(config);
+  });
+  RumSdkModule?.getConfig?.();
+}
+var _default = exports.default = _shell.default;
+//# sourceMappingURL=plugin.js.map

package/lib/commonjs/processor/default-processor.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _base = require("../utils/base");
+var _view = require("../utils/view");
+class DefaultProcessor {
+  name = 'default-processor';
+  process(ctx) {
+    const event = ctx.getRumEvent();
+    const view = (0, _view.getCurView)(ctx);
+    const session_id = ctx.session.getSessionId();
+    const event_id = ctx.session.getEventId();
+    const rumEvent = {
+      timestamp: (0, _base.getCurrentTime)(),
+      session_id,
+      event_id,
+      view,
+      ...event
+    };
+    return rumEvent;
+  }
+}
+exports.default = DefaultProcessor;
+//# sourceMappingURL=default-processor.js.map

package/lib/commonjs/processor/session-processor.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _rumCore = require("@arms/rum-core");
+var _crash = require("../types/crash");
+var _view = require("../utils/view");
+class SessionProcessor {
+  name = 'session-processor';
+  lastSessionId = '';
+  setup(ctx) {
+    this.ctx = ctx;
+    this.update = (0, _rumCore.debounce)(this.update, _rumCore.ONE_SECOND);
+    // 延迟到下一个事件循环执行，确保 collectors 已完成 setup 并注册了
+    // CRASH_CONTEXT_EVENT 监听器（rum-core 中 processors.setup() 先于
+    // collectors.setup() 执行）。消除 session 创建后 1 秒内的 context
+    // 同步窗口，同时避免 emit 事件因无监听器而被丢弃
+    setTimeout(() => this.syncCrashContext(), 0);
+    // sdk.onTouchStart(this.update)
+  }
+  update = e => {
+    if (e && !e.isTrusted) return;
+    this.ctx?.session.updateSession();
+    this.syncCrashContext();
+  };
+  process(ctx) {
+    this.update();
+    return ctx.getRumEvent();
+  }
+  syncCrashContext() {
+    if (!this.ctx) return;
+    const sessionId = this.ctx.session.getSessionId();
+    if (sessionId === this.lastSessionId) return;
+    this.lastSessionId = sessionId;
+    const view = (0, _view.getCurView)(this.ctx);
+    this.ctx.emitter.emit(_crash.CRASH_CONTEXT_EVENT, {
+      session_id: sessionId,
+      user_id: this.ctx.session.getUserId(),
+      view_id: view?.id || '',
+      view_name: view?.name || ''
+    });
+  }
+}
+exports.default = SessionProcessor;
+//# sourceMappingURL=session-processor.js.map