@cloudcare/browser-core 3.2.19 → 3.2.24

package/src/configuration/remoteConfiguration.js

@@ -0,0 +1,213 @@
+import { addEventListener } from '../browser/addEventListener'
+import { display } from '../helper/display'
+import { trim } from './transportConfiguration'
+import { objectEntries, getType } from '../helper/tools'
+export function fetchAndApplyRemoteConfiguration(initConfiguration, callback) {
+  fetchRemoteConfiguration(initConfiguration, (remoteInitConfiguration) => {
+    callback(
+      applyRemoteConfiguration(initConfiguration, remoteInitConfiguration)
+    )
+  })
+}
+/**
+ * 数据上报采样率，100 表示全收集；0 表示不收集。默认 100
+ */
+//   sessionSampleRate?: number | undefined
+//   telemetrySampleRate?: number | undefined
+//   silentMultipleInit?: boolean | undefined
+
+//   service?: string | undefined
+//   /** Web 应用当前环境，如 prod：线上环境；gray：灰度环境；pre：预发布环境；common：日常环境；local：本地环境。 */
+//   env?: string | undefined
+//   /** Web 应用的版本号。 */
+//   version?: string | undefined
+//   /** 链路数据采样百分比：100 表示全收集；0 表示不收集。 */
+//   tracingSampleRate?: number | undefined
+//   /**
+//    * @deprecated use usePartitionedCrossSiteSessionCookie instead
+//    */
+//   useCrossSiteSessionCookie?: boolean | undefined
+//   /**
+//    * 是否使用跨域 cookie，开启第三方 cookie 跨分区实现。默认不允许跨域，例如嵌套跨域 iframe 的情况。
+//    */
+//   usePartitionedCrossSiteSessionCookie?: boolean | undefined
+//   useSecureSessionCookie?: boolean | undefined
+//   trackSessionAcrossSubdomains?: boolean | undefined
+//   /**
+//    * 是否把公共数据存储到localstorage,默认不存储
+//    */
+//   storeContextsToLocal?: boolean | undefined
+//   /**
+//    * 定义存储到 localstorage 的 key ，默认不填，自动生成, 该参数主要是为了区分在同一个域名下，不同子路径共用store 的问题
+//    */
+//   storeContextsKey?: string | undefined
+//   /**
+//    * 数据以 application/json 的发送方式，默认text
+//    */
+//   sendContentTypeByJson?: boolean | undefined
+//   /**
+//    * 在 cookie 不可用的情况下，可以开启该选项，把数据储存到 localstorage
+//    */
+// allowFallbackToLocalStorage ?: boolean | undefined
+//   /**
+//    * 错误会话补偿采样率：
+//    * - 当会话未被 `sessionSampleRate` 采样时，若会话期间发生错误，则按此比例采集
+//    * 此类会话将在错误发生时开始记录事件，并持续记录直到会话结束。
+//    * - 取值范围 0-100，100 表示全采错误会话，0 表示忽略错误会话
+//    */
+//   sessionOnErrorSampleRate?: number | undefined
+
+//   /**
+//    * Session Replay 全量采集采样率：
+//    * - 用于控制所有会话重放的全量数据采集比例
+//    * - 取值范围 0-100，100 表示全量采集，0 表示不采集
+//    **/
+//   sessionReplaySampleRate?: number | undefined
+
+//   /** 错误会话重放补偿采样率：
+//    * - 当会话未被 `sessionReplaySampleRate` 采样时，若会话期间发生错误，则按此比例采集
+//    * 此类回放将记录错误发生前最多一分钟的事件，并持续记录直到会话结束。
+// 100 表示全收集；0 表示不收集。
+//      */
+//   sessionReplayOnErrorSampleRate?: number | undefined
+//   /**
+//    * 是否开启用户行为采集。
+//    */
+//   trackUserInteractions?: boolean | undefined
+//   /**
+//    * 指定 action 数据 name 获取方式，默认自动获取，可以指定元素特定属性名称,alt,name,title,aria-labelledby,aria-label,data-guance-action-name 这些属性
+//    */
+//   actionNameAttribute?: string | undefined
+//   trackViewsManually?: boolean | undefined
+//   /**
+//    * sessionReplay 和 compressIntakeRequests数据压缩都是在 webwork 线程中完成，所以默认情况下，需要在开启csp 安全访问的情况下，允许 worker-src blob:; workerUrl 配置允许自行托管 worker 地址
+//    */
+//   workerUrl?: string
+//   /**
+//    * 压缩 RUM 数据请求内容，以减少发送大量数据时的带宽使用量。压缩在 Worker 线程中完成。
+//    */
+// compressIntakeRequests ?: boolean | undefined
+//    /**
+//      * 配置链路追踪工具类型，如果不配置默认为 ddtrace。目前支持 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6 种数据类型。
+//      */
+//     traceType?: TraceType
+
+const modifiableFieldPaths = {
+  sessionSampleRate: 'number',
+  telemetrySampleRate: 'number',
+  silentMultipleInit: 'boolean',
+  service: 'string',
+  env: 'string',
+  version: 'string',
+  tracingSampleRate: 'number',
+  useCrossSiteSessionCookie: 'boolean',
+  usePartitionedCrossSiteSessionCookie: 'boolean',
+  useSecureSessionCookie: 'boolean',
+  trackSessionAcrossSubdomains: 'boolean',
+  storeContextsToLocal: 'boolean',
+  storeContextsKey: 'string',
+  sendContentTypeByJson: 'boolean',
+  allowFallbackToLocalStorage: 'boolean',
+  sessionOnErrorSampleRate: 'number',
+  sessionReplaySampleRate: 'number',
+  sessionReplayOnErrorSampleRate: 'number',
+  trackUserInteractions: 'boolean',
+  trackInteractions: 'boolean',
+  actionNameAttribute: 'string',
+  trackViewsManually: 'boolean',
+  workerUrl: 'string',
+  compressIntakeRequests: 'boolean',
+  traceType: 'string'
+}
+function modificationByFieldsPath(remoteConfiguration, modifiableFieldPaths) {
+  const result = {}
+  objectEntries(modifiableFieldPaths).forEach(([fieldPath, fieldType]) => {
+    // const sourceValue = sourceConfiguration[fieldPath]
+    const remoteValue = remoteConfiguration[fieldPath]
+    if (getType(remoteValue) === fieldType) {
+      result[fieldPath] = remoteValue
+    }
+  })
+  return result
+}
+export function applyRemoteConfiguration(
+  initConfiguration,
+  remoteInitConfiguration
+) {
+  const simpleRemoteInitConfiguration = {}
+  for (const key in remoteInitConfiguration) {
+    if (remoteInitConfiguration[key] !== undefined) {
+      //  ex
+      //        {
+      //     "R.d1b454d0_22eb_11ef_9b66_95ca11aa2c6c.sessionSampleRate": 80
+      // }
+      //  transform to
+      // {
+      //     "sessionSampleRate": 80
+      // }
+      const simpleKey = key.replace(
+        'R.' + initConfiguration.applicationId + '.',
+        ''
+      )
+      simpleRemoteInitConfiguration[simpleKey] = remoteInitConfiguration[key]
+    }
+  }
+  return {
+    ...initConfiguration,
+    ...modificationByFieldsPath(
+      simpleRemoteInitConfiguration,
+      modifiableFieldPaths
+    )
+  }
+}
+
+export function fetchRemoteConfiguration(configuration, callback) {
+  const xhr = new XMLHttpRequest()
+
+  addEventListener(xhr, 'load', function () {
+    if (xhr.status === 200) {
+      const remoteConfiguration = JSON.parse(xhr.responseText)
+      callback(remoteConfiguration.content)
+    } else {
+      callback({})
+      displayRemoteConfigurationFetchingError()
+    }
+  })
+
+  addEventListener(xhr, 'error', function () {
+    callback({})
+    displayRemoteConfigurationFetchingError()
+  })
+
+  xhr.open('GET', buildEndpoint(configuration))
+  xhr.send()
+}
+
+export function buildEndpoint(configuration) {
+  var url =
+    configuration.datakitOrigin ||
+    configuration.datakitUrl ||
+    configuration.site
+  if (url.indexOf('/') === 0) {
+    // 绝对路径这种 /xxx
+    url = location.origin + trim(url)
+  }
+  var endpoint = url
+  if (url.lastIndexOf('/') === url.length - 1) {
+    endpoint = trim(url) + 'v1/env_variable'
+  } else {
+    endpoint = trim(url) + '/v1/env_variable'
+  }
+  // 这里需要加上token和app_id
+  endpoint += '?app_id=' + configuration.applicationId
+  //testing-openway.dataflux.cn/v1/env_variable?token=a47fb0cdddaa4561a90d941317cdbc0b&app_id=d1b454d0_22eb_11ef_9b66_95ca11aa2c6c&to_headless=true
+  if (configuration.site && configuration.clientToken) {
+    endpoint =
+      endpoint + '&token=' + configuration.clientToken + '&to_headless=true'
+  }
+  return endpoint
+}
+
+function displayRemoteConfigurationFetchingError() {
+  display.error('Error fetching the remote configuration.')
+}

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

@@ -22,6 +22,7 @@ export var commonTags = {
   browser_version_major: 'device.browser_version_major',
   screen_size: 'device.screen_size',
   network_type: 'device.network_type',
+  time_zone: 'device.time_zone',
   device: 'device.device',
   view_id: 'view.id',
   view_referrer: 'view.referrer',

package/src/helper/deviceInfo.js

@@ -307,6 +307,10 @@ var MethodLibrary = {
     })()
     return _this.language
   }),
+  getTimeZone: monitor(function () {
+    const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone
+    return timeZone
+  }),
   // 浏览器信息
   getBrowserInfo: monitor(function () {
     var _this = this
@@ -619,7 +623,8 @@ if (typeof window !== 'undefined') {
     browserVersionMajor: MethodLibrary.getBrowserInfo().browserMajor,
     screenSize: window.screen.width + '*' + window.screen.height,
     networkType: MethodLibrary.getNetwork(),
-    device: MethodLibrary.getDeviceType()
+    device: MethodLibrary.getDeviceType(),
+    timeZone: MethodLibrary.getTimeZone()
   }
 }
 export var deviceInfo = _deviceInfo

package/src/helper/getZoneJsOriginalValue.js

@@ -1,3 +1,4 @@
+import { getGlobalObject } from '../init'
 /**
  * Gets the original value for a DOM API that was potentially patched by Zone.js.
  *
@@ -12,7 +13,7 @@
  * [1]: https://github.com/angular/angular/tree/main/packages/zone.js
  */
 export function getZoneJsOriginalValue(target, name) {
-  var browserWindow = window
+  var browserWindow = getGlobalObject()
   var original
   if (
     browserWindow.Zone &&

package/src/helper/valueHistory.js

@@ -3,7 +3,13 @@ import { setInterval, clearInterval } from './timer'
 var END_OF_TIMES = Infinity
 
 export var CLEAR_OLD_VALUES_INTERVAL = ONE_MINUTE
+let cleanupHistoriesInterval = null
 
+const cleanupTasks = new Set()
+
+function cleanupHistories() {
+  cleanupTasks.forEach((task) => task())
+}
 /**
  *
  * @param {expireDelay,maxEntries } params
@@ -14,11 +20,13 @@ export function createValueHistory(params) {
   var maxEntries = params.maxEntries
 
   var entries = []
-  var clearOldValuesInterval = setInterval(function () {
-    return clearOldValues()
-  }, CLEAR_OLD_VALUES_INTERVAL)
+  if (cleanupHistoriesInterval) {
+    cleanupHistoriesInterval = setInterval(function () {
+      return clearExpiredValues()
+    }, CLEAR_OLD_VALUES_INTERVAL)
+  }
 
-  function clearOldValues() {
+  function clearExpiredValues() {
     var oldTimeThreshold = relativeNow() - expireDelay
     while (
       entries.length > 0 &&
@@ -27,7 +35,7 @@ export function createValueHistory(params) {
       entries.pop()
     }
   }
-
+  cleanupTasks.add(clearExpiredValues)
   function add(value, startTime) {
     var entry = {
       value: value,
@@ -103,7 +111,11 @@ export function createValueHistory(params) {
    * Stop internal garbage collection of past entries.
    */
   function stop() {
-    clearInterval(clearOldValuesInterval)
+    cleanupTasks.delete(clearExpiredValues)
+    if (cleanupTasks.size === 0 && cleanupHistoriesInterval) {
+      clearInterval(cleanupHistoriesInterval)
+      cleanupHistoriesInterval = null
+    }
   }
 
   return {

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/sessionStore.js

@@ -206,7 +206,7 @@ export function startSessionStore(
     expandOrRenewSession: throttledExpandOrRenewSession,
     expandSession,
     getSession: function () {
-      return sessionCache || {}
+      return sessionCache
     },
     renewObservable,
     expireObservable,

package/src/session/sessionStoreOperations.js

@@ -48,10 +48,7 @@ export function processSessionStoreOperations(
   let currentStore = retrieveStore()
   if (isLockEnabled) {
     // if someone has lock, retry later
-    if (
-      currentStore.lock &&
-      !isSessionInNotStartedState(currentStore.session)
-    ) {
+    if (currentStore.lock) {
       retryLater(operations, sessionStoreStrategy, numberOfRetries)
       return
     }
@@ -60,10 +57,7 @@ export function processSessionStoreOperations(
     persistWithLock(currentStore.session)
     // if lock is not acquired, retry later
     currentStore = retrieveStore()
-    if (
-      currentStore.lock !== currentLock &&
-      !isSessionInNotStartedState(currentStore.session)
-    ) {
+    if (currentStore.lock !== currentLock) {
       retryLater(operations, sessionStoreStrategy, numberOfRetries)
       return
     }
@@ -72,10 +66,7 @@ export function processSessionStoreOperations(
   if (isLockEnabled) {
     // if lock corrupted after process, retry later
     currentStore = retrieveStore()
-    if (
-      currentStore.lock !== currentLock &&
-      !isSessionInNotStartedState(currentStore.session)
-    ) {
+    if (currentStore.lock !== currentLock) {
       retryLater(operations, sessionStoreStrategy, numberOfRetries)
       return
     }
@@ -96,10 +87,7 @@ export function processSessionStoreOperations(
     if (!(processedSession && isSessionInExpiredState(processedSession))) {
       // if lock corrupted after persist, retry later
       currentStore = retrieveStore()
-      if (
-        currentStore.lock !== currentLock &&
-        !isSessionInNotStartedState(currentStore.session)
-      ) {
+      if (currentStore.lock !== currentLock) {
         retryLater(operations, sessionStoreStrategy, numberOfRetries)
         return
       }

package/src/tracekit/computeStackTrace.js

@@ -36,6 +36,7 @@ export function computeStackTrace(ex) {
 }
 var fileUrl =
   '((?:file|https?|blob|chrome-extension|electron|native|eval|webpack|<anonymous>|\\w+\\.|\\/).*?)'
+
 var filePosition = '(?::(\\d+))'
 var CHROME_LINE_RE = new RegExp(
   '^\\s*at (.*?) ?\\(' +
@@ -117,7 +118,7 @@ function parseWinLine(line) {
 }
 
 var GECKO_LINE_RE =
-  /^\s*(.*?)(?:\((.*?)\))?(?:^|@)((?:file|https?|blob|chrome|webpack|resource|capacitor|\[native).*?|[^@]*bundle)(?::(\d+))?(?::(\d+))?\s*$/i
+  /^\s*(.*?)(?:\((.*?)\))?(?:^|@)((?:file|https?|blob|chrome|webpack|resource|capacitor|\[native).*?|[^@]*bundle|\[wasm code\])(?::(\d+))?(?::(\d+))?\s*$/i
 var GECKO_EVAL_RE = /(\S+) line (\d+)(?: > eval line \d+)* > eval/i
 
 function parseGeckoLine(line) {

package/src/transport/eventBridge.js

@@ -11,14 +11,66 @@ 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 &&
+          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
+) {
+  const eventBridgeGlobal = getEventBridgeGlobal()
+  if (
+    eventBridgeGlobal &&
+    eventBridgeGlobal.getAllowedWebViewHosts === undefined
+  ) {
+    return true
+  }
+  if (
+    eventBridgeGlobal &&
+    eventBridgeGlobal.getAllowedWebViewHosts &&
+    eventBridgeGlobal.getAllowedWebViewHosts() === null
+  ) {
+    return true
+  }
   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

@@ -189,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 种数据类型。
    */