@rk911/tracker-sdk 1.6.4

package/plugins/api-watch.js

@@ -0,0 +1,240 @@
+export class ApiWatchPlugin {
+  constructor() {
+    this.name = 'api-watch'
+    this.tracker = null
+    this._interceptorAdded = false
+    // 后台切换计数：请求期间计数变化说明 app 被挂起过，duration 含后台时间
+    this._bgCount = 0
+    this._totalHiddenTime = 0
+    this._lastHideTime = 0
+    this._bgDebounceTimer = null
+    this._visibilityHandler = null
+  }
+
+  install(tracker) {
+    this.tracker = tracker
+    this._setupBgWatch()
+    this._setupInterceptor()
+  }
+
+  // 记录切后台次数和累计后台时长，用于修正 duration
+  _setupBgWatch() {
+    if (typeof document === 'undefined') return
+    var self = this
+    this._visibilityHandler = function () {
+      if (document.visibilityState === 'hidden') {
+        var hideTime = Date.now()
+        if (self._bgDebounceTimer) clearTimeout(self._bgDebounceTimer)
+        self._bgDebounceTimer = setTimeout(function () {
+          self._bgDebounceTimer = null
+          self._bgCount++
+          self._lastHideTime = hideTime
+        }, 500)
+      } else {
+        if (self._bgDebounceTimer) {
+          clearTimeout(self._bgDebounceTimer)
+          self._bgDebounceTimer = null
+        } else if (self._lastHideTime) {
+          self._totalHiddenTime += Date.now() - self._lastHideTime
+          self._lastHideTime = 0
+        }
+      }
+    }
+    document.addEventListener('visibilitychange', this._visibilityHandler)
+  }
+
+  // [PROJECT-ADAPT] API 拦截方式
+  // 当前使用 uni.addInterceptor（uni-app 运行时专属）
+  // 非 uni-app 项目需替换为 XMLHttpRequest/fetch 拦截
+  _setupInterceptor() {
+    var self = this
+    var config = this.tracker.getConfig()
+
+    try {
+      uni.addInterceptor('request', {
+        invoke: function (args) {
+          // 给请求打上开始时间标记
+          args._trackStartTime = Date.now()
+          args._trackBgCount = self._bgCount
+          args._trackHiddenTimeStart = self._totalHiddenTime + (self._lastHideTime ? Date.now() - self._lastHideTime : 0)
+          return args
+        },
+        success: function (res, args) {
+          self._reportApi(args, res, null)
+        },
+        fail: function (err, args) {
+          self._reportApi(args, null, err)
+        },
+      })
+      this._interceptorAdded = true
+    } catch (e) {
+      if (config.debug) {
+        console.warn('[TrackerSDK] api-watch: failed to add interceptor', e)
+      }
+    }
+  }
+
+  _reportApi(args, res, err) {
+    if (!args || !args.url) return
+
+    var config = this.tracker.getConfig()
+
+    // [PROJECT-ADAPT] 自身请求过滤列表
+    if (
+      args.url.indexOf('/api/point/task/activeReport') >= 0 ||
+      args.url.indexOf(config.batchReportUrl) >= 0 ||
+      args.url.indexOf('/api/track/collect') >= 0
+    ) {
+      return
+    }
+
+    var duration = args._trackStartTime
+      ? Date.now() - args._trackStartTime
+      : 0
+
+    var data = {
+      url: args.url,
+      method: (args.method || 'GET').toUpperCase(),
+      duration: duration,
+    }
+
+    // 请求期间发生过切后台 → 修正 duration 减去后台挂起时间
+    if (args._trackBgCount !== undefined && this._bgCount !== args._trackBgCount) {
+      data.bgSuspended = true
+      var hiddenNow = this._totalHiddenTime + (this._lastHideTime ? Date.now() - this._lastHideTime : 0)
+      var hiddenDuring = hiddenNow - (args._trackHiddenTimeStart || 0)
+      if (hiddenDuring > 0) {
+        data.rawDuration = duration
+        data.duration = Math.max(0, duration - hiddenDuring)
+      }
+    }
+
+    // 请求参数
+    if (args.data) {
+      try {
+        data.requestParams = typeof args.data === 'string' ? args.data : JSON.stringify(args.data)
+      } catch (e) {}
+    }
+
+    // 请求头（过滤敏感字段）
+    if (args.header) {
+      data.requestHeaders = this._filterHeaders(args.header)
+    }
+
+    if (res) {
+      data.statusCode = res.statusCode || 0
+      // 响应头
+      if (res.header) {
+        data.responseHeaders = this._filterHeaders(res.header)
+      }
+      // 响应数据（过滤图片/base64/超长响应，避免污染轨迹表）
+      if (res.data) {
+        var rd = this._extractResponseData(res)
+        if (rd !== undefined) data.responseData = rd
+      }
+    }
+
+    if (err) {
+      data.statusCode = 0
+      data.error = err.errMsg || String(err)
+    }
+
+    this.tracker.track('api_request', {
+      eventName: data.url,
+      extraData: data,
+    })
+  }
+
+  /**
+   * 提取响应数据用于上报，剔除对分析无价值且体积巨大的内容：
+   *   - 图片/音视频/二进制响应（content-type 判断）→ 只留占位
+   *   - 含 base64 内联数据（海报二维码等）→ 只留字节数占位
+   *   - 超长文本 → 截断并标注（避免留半截 JSON 被误当完整数据）
+   * @returns {string|undefined} undefined 表示无可用响应数据（不写字段）
+   */
+  _extractResponseData(res) {
+    // content-type：非文本类直接省略
+    var ct = ''
+    if (res.header) {
+      for (var k in res.header) {
+        if (res.header.hasOwnProperty(k) && k.toLowerCase() === 'content-type') {
+          ct = String(res.header[k]).toLowerCase()
+          break
+        }
+      }
+    }
+    if (ct && (ct.indexOf('image/') >= 0 || ct.indexOf('audio/') >= 0 ||
+               ct.indexOf('video/') >= 0 || ct.indexOf('octet-stream') >= 0)) {
+      return '[非文本响应:' + ct + ',已省略]'
+    }
+
+    var str
+    try {
+      str = typeof res.data === 'string' ? res.data : JSON.stringify(res.data)
+    } catch (e) {
+      return undefined
+    }
+    if (!str) return undefined
+
+    // 含 base64 内联数据（二维码/海报图片等）→ 省略，避免污染轨迹表
+    if (str.indexOf(';base64,') >= 0 || str.indexOf('data:image') >= 0) {
+      return '[含base64内联数据,已省略 ' + str.length + ' 字节]'
+    }
+
+    var MAX = 1024
+    if (str.length > MAX) {
+      return str.substring(0, MAX) + '...[已截断,共' + str.length + '字节]'
+    }
+    return str
+  }
+
+  _filterHeaders(headers) {
+    if (!headers || typeof headers !== 'object') return null
+    var filtered = {}
+    var sensitiveKeys = ['authorization', 'token', 'rsb-token', 'cookie', 'set-cookie']
+    for (var key in headers) {
+      if (!headers.hasOwnProperty(key)) continue
+      if (sensitiveKeys.indexOf(key.toLowerCase()) >= 0) {
+        filtered[key] = this._encryptValue(headers[key])
+      } else {
+        filtered[key] = headers[key]
+      }
+    }
+    return filtered
+  }
+
+  _encryptValue(value) {
+    if (!value) return ''
+    try {
+      var encoded = encodeURIComponent(value)
+      var result = ''
+      for (var i = 0; i < encoded.length; i++) {
+        result += String.fromCharCode(encoded.charCodeAt(i) ^ 0x5A)
+      }
+      var full = btoa(result)
+      if (full.length > 16) {
+        return 'ENC:' + full.substring(0, 16) + '...'
+      }
+      return 'ENC:' + full
+    } catch (e) {
+      return ''
+    }
+  }
+
+  destroy() {
+    if (this._bgDebounceTimer) {
+      clearTimeout(this._bgDebounceTimer)
+      this._bgDebounceTimer = null
+    }
+    if (this._interceptorAdded) {
+      try {
+        uni.removeInterceptor('request')
+      } catch (e) {}
+    }
+    if (this._visibilityHandler && typeof document !== 'undefined') {
+      document.removeEventListener('visibilitychange', this._visibilityHandler)
+    }
+    this._visibilityHandler = null
+    this.tracker = null
+  }
+}

package/plugins/app-lifecycle.js

@@ -0,0 +1,90 @@
+export class AppLifecyclePlugin {
+  constructor() {
+    this.name = 'app-lifecycle'
+    this.tracker = null
+    this._visibilityHandler = null
+    this._lastState = 'foreground'
+    this._debounceTimer = null
+  }
+
+  install(tracker) {
+    this.tracker = tracker
+    var adapter = tracker.getAdapter()
+    var platform = adapter.getPlatformName()
+    var self = this
+
+    if (platform === 'web' || platform === 'app') {
+      this._setupWebLifecycle()
+    }
+    // 小程序的 App.onShow/onHide 通过 mixin 在 index.js 中注册处理
+  }
+
+  _setupWebLifecycle() {
+    if (typeof document === 'undefined') return
+
+    var self = this
+    this._visibilityHandler = function () {
+      var state = document.visibilityState
+      if (state === 'hidden') {
+        // 延迟 500ms 上报，系统通知/来电横幅等瞬时隐藏会被后续 visible 取消
+        if (self._debounceTimer) {
+          clearTimeout(self._debounceTimer)
+        }
+        self._debounceTimer = setTimeout(function () {
+          self._debounceTimer = null
+          if (self._lastState !== 'background') {
+            self._lastState = 'background'
+            self.tracker.track('app_lifecycle', {
+              eventName: 'background',
+            })
+            self.tracker.getQueue().flush()
+          }
+        }, 500)
+      } else if (state === 'visible') {
+        if (self._debounceTimer) {
+          clearTimeout(self._debounceTimer)
+          self._debounceTimer = null
+        }
+        if (self._lastState !== 'foreground') {
+          self._lastState = 'foreground'
+          self.tracker.track('app_lifecycle', {
+            eventName: 'foreground',
+          })
+        }
+      }
+    }
+    document.addEventListener('visibilitychange', this._visibilityHandler)
+  }
+
+  // 供小程序端 mixin 调用
+  trackAppShow() {
+    if (this._lastState !== 'foreground') {
+      this._lastState = 'foreground'
+      this.tracker.track('app_lifecycle', {
+        eventName: 'foreground',
+      })
+    }
+  }
+
+  trackAppHide() {
+    if (this._lastState !== 'background') {
+      this._lastState = 'background'
+      this.tracker.track('app_lifecycle', {
+        eventName: 'background',
+      })
+      this.tracker.getQueue().flush()
+    }
+  }
+
+  destroy() {
+    if (this._debounceTimer) {
+      clearTimeout(this._debounceTimer)
+      this._debounceTimer = null
+    }
+    if (this._visibilityHandler && typeof document !== 'undefined') {
+      document.removeEventListener('visibilitychange', this._visibilityHandler)
+    }
+    this._visibilityHandler = null
+    this.tracker = null
+  }
+}