@cloudcare/browser-core 3.2.17 → 3.2.22

package/src/configuration/transportConfiguration.js

@@ -30,7 +30,7 @@ function getEndPointUrl(configuration, type) {
   return endpoint
 }
 
-function trim(str) {
+export function trim(str) {
   return str.replace(TRIM_REGIX, '')
 }
 

package/src/dataMap.js

@@ -42,6 +42,10 @@ export var commonFields = {
   page_states: '_gc.page_states',
   session_sample_rate: '_gc.configuration.session_sample_rate',
   session_replay_sample_rate: '_gc.configuration.session_replay_sample_rate',
+  session_on_error_sample_rate:
+    '_gc.configuration.session_on_error_sample_rate',
+  session_replay_on_error_sample_rate:
+    '_gc.configuration.session_replay_on_error_sample_rate',
   drift: '_gc.drift'
 }
 // 需要用双引号将字符串类型的field value括起来， 这里有数组标示[string, path]
@@ -55,6 +59,9 @@ export var dataMap = {
     },
     fields: {
       sampled_for_replay: 'session.sampled_for_replay',
+      sampled_for_error_replay: 'session.sampled_for_error_replay',
+      sampled_for_error_session: 'session.sampled_for_error_session',
+      session_error_timestamp: 'session.error_timestamp_for_session',
       is_active: 'view.is_active',
       session_replay_stats: '_gc.replay_stats',
       session_is_active: 'session.is_active',

package/src/index.js

@@ -27,6 +27,7 @@ export * from './helper/taskQueue'
 export * from './tracekit'
 export * from './configuration/configuration'
 export * from './configuration/transportConfiguration'
+export * from './configuration/remoteConfiguration'
 export * from './browser/cookie'
 export * from './browser/fetchObservable'
 export * from './browser/xhrObservable'

package/src/session/sessionManagement.js

@@ -64,7 +64,8 @@ export function startSessionManager(
   function buildSessionContext() {
     return {
       id: sessionStore.getSession().id,
-      trackingType: sessionStore.getSession()[productKey]
+      trackingType: sessionStore.getSession()[productKey],
+      hasError: !!sessionStore.getSession().hasError
     }
   }
 

package/src/session/sessionState.js

@@ -27,10 +27,7 @@ export function isSessionInExpiredState(session) {
   return session.isExpired !== undefined || !isActiveSession(session)
 }
 
-// An active session is a session in either `Tracked` or `NotTracked` state
 function isActiveSession(sessionState) {
-  // created and expire can be undefined for versions which was not storing them
-  // these checks could be removed when older versions will not be available/live anymore
   return (
     (sessionState.created === undefined ||
       dateNow() - Number(sessionState.created) < SESSION_TIME_OUT_DELAY) &&

package/src/transport/eventBridge.js

@@ -11,14 +11,49 @@ export function getEventBridge() {
   }
 
   return {
-    send(eventType, event) {
+    getCapabilities() {
+      return JSON.parse(
+        (eventBridgeGlobal.getCapabilities &&
+          eventBridgeGlobal.getCapabilities()) ||
+          '[]'
+      )
+    },
+    getPrivacyLevel() {
+      return (
+        eventBridgeGlobal.getPrivacyLevel && eventBridgeGlobal.getPrivacyLevel()
+      )
+    },
+    getAllowedWebViewHosts() {
+      return JSON.parse(eventBridgeGlobal.getAllowedWebViewHosts())
+    },
+    send(eventType, event, viewId) {
+      const view = viewId ? { id: viewId } : undefined
       eventBridgeGlobal.sendEvent(
-        JSON.stringify({ name: eventType, data: event })
+        JSON.stringify({ name: eventType, data: event, view })
       )
     }
   }
 }
-export function canUseEventBridge() {
+export const BridgeCapability = {
+  RECORDS: 'records'
+}
+export function bridgeSupports(capability) {
+  const bridge = getEventBridge()
+
+  return !!bridge && bridge.getCapabilities().includes(capability)
+}
+export function canUseEventBridge(
+  currentHost = getGlobalObject().location?.hostname
+) {
   var bridge = getEventBridge()
-  return !!bridge
+
+  return (
+    !!bridge &&
+    bridge
+      .getAllowedWebViewHosts()
+      .some(
+        (allowedHost) =>
+          currentHost === allowedHost || currentHost.endsWith(`.${allowedHost}`)
+      )
+  )
 }

package/src/transport/index.js

@@ -2,4 +2,9 @@ export { createHttpRequest } from './httpRequest'
 export { createBatch, processedMessageByDataMap } from './batch'
 export { startBatchWithReplica } from './startBatchWithReplica'
 export { createFlushController } from './flushController'
-export { getEventBridge, canUseEventBridge } from './eventBridge'
+export {
+  getEventBridge,
+  canUseEventBridge,
+  bridgeSupports,
+  BridgeCapability
+} from './eventBridge'

package/types/index.d.ts

@@ -109,6 +109,16 @@ export declare const DefaultPrivacyLevel: {
 export type DefaultPrivacyLevel =
   (typeof DefaultPrivacyLevel)[keyof typeof DefaultPrivacyLevel]
 
+export const NodePrivacyLevel = {
+  IGNORE: 'ignore',
+  HIDDEN: 'hidden',
+  ALLOW: DefaultPrivacyLevel.ALLOW,
+  MASK: DefaultPrivacyLevel.MASK,
+  MASK_USER_INPUT: DefaultPrivacyLevel.MASK_USER_INPUT
+} as const
+export type NodePrivacyLevel =
+  (typeof NodePrivacyLevel)[keyof typeof NodePrivacyLevel]
+
 export type MatchOption = string | RegExp | ((value: string) => boolean)
 export type TracingOption = {
   match: MatchOption
@@ -142,10 +152,26 @@ export interface RumBaseInitConfiguration extends InitConfiguration {
   allowedTracingUrls?: Array<MatchOption | TracingOption> | undefined
   defaultPrivacyLevel?: DefaultPrivacyLevel | undefined
   /**
-     * Session Replay 数据采集百分比:
+   * 错误会话补偿采样率：
+   * - 当会话未被 `sessionSampleRate` 采样时，若会话期间发生错误，则按此比例采集
+   * 此类会话将在错误发生时开始记录事件，并持续记录直到会话结束。
+   * - 取值范围 0-100，100 表示全采错误会话，0 表示忽略错误会话
+   */
+  sessionOnErrorSampleRate?: number | undefined
+
+  /**
+   * Session Replay 全量采集采样率：
+   * - 用于控制所有会话重放的全量数据采集比例
+   * - 取值范围 0-100，100 表示全量采集，0 表示不采集
+   **/
+  sessionReplaySampleRate?: number | undefined
+
+  /** 错误会话重放补偿采样率：
+   * - 当会话未被 `sessionReplaySampleRate` 采样时，若会话期间发生错误，则按此比例采集
+   * 此类回放将记录错误发生前最多一分钟的事件，并持续记录直到会话结束。
 100 表示全收集；0 表示不收集。
      */
-  sessionReplaySampleRate?: number | undefined
+  sessionReplayOnErrorSampleRate?: number | undefined
   /**
    * 是否开启用户行为采集。
    */
@@ -163,6 +189,14 @@ export interface RumBaseInitConfiguration extends InitConfiguration {
    * 压缩 RUM 数据请求内容，以减少发送大量数据时的带宽使用量。压缩在 Worker 线程中完成。
    */
   compressIntakeRequests?: boolean | undefined
+  /**
+   * 是否开启数据采集的远程配置功能，默认不开启
+   * 远程配置功能可以在不发布新版本的情况下，动态修改数据采集的配置项
+   * 例如：可以在远程配置中修改采样率、是否开启用户行为采集等
+   * 远程配置功能需要在观测云控制台中开启
+   *
+   */
+  remoteConfiguration?: boolean | undefined
   /**
    * 配置链路追踪工具类型，如果不配置默认为 ddtrace。目前支持 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6 种数据类型。
    */
@@ -186,6 +220,13 @@ export interface RumBaseInitConfiguration extends InitConfiguration {
    * 是否开启 longAnimationFrame 采集，覆盖 longtask 采集，目前调试阶段
    */
   enableLongAnimationFrame?: boolean | undefined
+  /**
+   * session replay 是否屏蔽某个节点数据，可用于实现对某些特定 node 屏蔽效果
+   * @param node 节点对象
+   * @param privacyLevel 当前隐私等级
+   * @returns true 表示屏蔽该节点，false 表示不屏蔽节点 继续执行 privacyLevel 逻辑
+   */
+  shouldMaskNode?: (node: Node, privacyLevel: NodePrivacyLevel) => boolean
 }
 export type RumInitConfiguration = RumBaseInitConfiguration &
   DatakitInitConfiguration