@rk911/tracker-sdk 1.6.4

package/core/queue.js

@@ -0,0 +1,461 @@
+export class ReportQueue {
+  constructor(adapter, config, session) {
+    this.adapter = adapter
+    this.config = config
+    this.session = session
+    this.queue = []
+    this.flushTimer = null
+    this.isFlushing = false
+    this._hooks = []
+    this._flushedEventIds = new Set()
+    this._legacyRetryQueue = []
+    this._currentPage = null
+    this._clickFlushTimer = null
+    this._refreshUserId = null
+
+    this._loadOfflineCache()
+    this._loadLegacyCache()
+    this._startPageFlushTimer()
+    this._setupPageCloseHandler()
+  }
+
+  setRefreshUserId(fn) {
+    this._refreshUserId = fn
+  }
+
+  // ---- 自动采集事件入队（页面维度批量上报）----
+
+  push(event) {
+    // 未登录时不入队（allowAnonymousTrack 开启时跳过此检查）
+    if (!this.config.allowAnonymousTrack && !this.session.getUserId()) {
+      return
+    }
+
+    var eventPage = event.pageRoute || null
+
+    // 页面边界检测：新事件所属页面与队列中的不同 → 先 flush 旧页面的事件
+    if (eventPage && this._currentPage && eventPage !== this._currentPage && this.queue.length > 0) {
+      this.flush()
+    }
+    if (eventPage && eventPage !== '/') {
+      this._currentPage = eventPage
+    }
+
+    this.queue.push(event)
+    this._notifyHooks([event])
+
+    // 达到批量阈值（默认 10 条）→ 立即上报
+    if (this.queue.length >= this.config.queue.maxBatchSize) {
+      this.flush()
+    } else if (event.eventType === 'click') {
+      // 点击行为 → 延迟上报（等后续接口请求到齐后一起发）
+      this._scheduleClickFlush()
+    } else {
+      // 重置页面停留定时器（60s 无新事件也 flush）
+      this._resetPageFlushTimer()
+    }
+  }
+
+  flush() {
+    if (this.isFlushing || this.queue.length === 0) return
+
+    if (this._refreshUserId) this._refreshUserId()
+
+    // [PROJECT-ADAPT] 认证判断逻辑（allowAnonymousTrack 开关可跳过）
+    if (!this.config.allowAnonymousTrack) {
+      // 检查 1: 没有 userId 不上报
+      if (!this.session.getUserId()) {
+        if (this.config.debug) {
+          console.log('[TrackerSDK] flush skipped: no userId')
+        }
+        return
+      }
+      // 检查 2: 有 getAuthHeaders 时还要验证 token
+      if (typeof this.config.getAuthHeaders === 'function') {
+        var authHeaders = this.config.getAuthHeaders() || {}
+        if (!authHeaders.Authorization && !authHeaders.token && !authHeaders['rsb-token']) {
+          if (this.config.debug) {
+            console.log('[TrackerSDK] flush skipped: no auth token')
+          }
+          return
+        }
+      }
+    }
+
+    this.isFlushing = true
+    var batch = this.queue.splice(0, this.config.queue.maxBatchSize)
+
+    var self = this
+    batch.forEach(function (evt) {
+      if (evt.eventId) self._flushedEventIds.add(evt.eventId)
+    })
+    if (this._flushedEventIds.size > 1000) {
+      var toDelete = this._flushedEventIds.size - 500
+      var iter = this._flushedEventIds.values()
+      for (var i = 0; i < toDelete; i++) {
+        this._flushedEventIds.delete(iter.next().value)
+      }
+    }
+
+    var payload = {
+      appId: this.config.appId,
+      deviceId: this.session.getDeviceId(),
+      sessionId: this.session.getSessionId(),
+      userId: this.session.getUserId(),
+      platform: this.config.pflag !== '' ? this.config.pflag : (this.config.platform || this.adapter.getPlatformName()),
+      events: batch,
+    }
+
+    var url = this.config.dadianUrl + this.config.batchReportUrl
+    var payloadStr = JSON.stringify(payload)
+
+    // 分层发送策略：sendBeacon → fetch+keepalive → adapter.request
+    var sent = this._sendViaBestChannel(url, payloadStr, batch)
+
+    if (sent) {
+      // sendBeacon / fetch+keepalive 已经发出，非阻塞完成
+      this.isFlushing = false
+      if (this.queue.length >= this.config.queue.maxBatchSize) {
+        this.flush()
+      }
+    }
+
+    // 顺便重试 legacy 离线缓存
+    this._retryLegacyCache()
+  }
+
+  /**
+   * 分层发送策略（普通 flush 用）
+   * Layer 1: fetch + keepalive（有 .catch 失败回调 → 可回灌离线缓存，不丢事件）
+   * Layer 2: navigator.sendBeacon（非阻塞、页面关闭可靠，但发出即"成功"、无失败回调）
+   * Layer 3: adapter.request（传统方式，小程序降级到这里，有 .catch）
+   *
+   * 顺序说明：普通 flush 优先 fetch —— sendBeacon 无法感知网络失败，
+   * 一旦静默丢包这批事件就永久丢失（表现为序号缺口）；fetch 的 .catch
+   * 能把失败批次存入离线缓存下次回灌。页面关闭场景走 flushSync（beacon 优先）。
+   *
+   * 注意：sendBeacon 不支持自定义请求头，依赖服务端从 payload 中提取 token/appId/deviceId
+   *
+   * @returns {boolean} true=已通过非阻塞通道发送 false=走了 adapter.request 异步流程
+   */
+  _sendViaBestChannel(url, payloadStr, batch) {
+    var self = this
+
+    // Layer 1: fetch + keepalive（失败可回灌，普通 flush 首选）
+    if (typeof fetch !== 'undefined') {
+      try {
+        var headers = {
+          'Content-Type': 'application/json',
+          token: this.adapter.getToken() || '',
+          appId: String(this.config.appId),
+          deviceId: this.session.getDeviceId() || '',
+        }
+        fetch(url, {
+          method: 'POST',
+          body: payloadStr,
+          headers: headers,
+          keepalive: true,
+        }).then(function (res) {
+          // HTTP 层失败（5xx/4xx）也视为未送达，回灌离线缓存
+          if (res && res.ok === false) {
+            self._saveToOfflineCache(batch)
+            return
+          }
+          if (self.config.debug) {
+            console.log('[TrackerSDK] batch sent via fetch+keepalive:', batch.length)
+          }
+        }).catch(function () {
+          self._saveToOfflineCache(batch)
+        })
+        return true
+      } catch (e) {
+        // fetch 不可用或 keepalive 超限（>64KB），降级
+      }
+    }
+
+    // Layer 2: sendBeacon（fetch 不可用时的非阻塞兜底）
+    // 限制：无法设置自定义请求头 + 无失败回调；payload 超 64KB 可能静默失败，限制 60KB 留余量
+    if (typeof navigator !== 'undefined' && navigator.sendBeacon && payloadStr.length < 61440) {
+      try {
+        var blob = new Blob([payloadStr], { type: 'application/json' })
+        var sent = navigator.sendBeacon(url, blob)
+        if (sent) {
+          if (this.config.debug) {
+            console.log('[TrackerSDK] batch sent via sendBeacon:', batch.length)
+          }
+          return true
+        }
+        // sendBeacon 返回 false（通常是数据超 64KB），降级到 Layer 3
+      } catch (e) {
+        // 某些环境 sendBeacon 抛异常，降级
+      }
+    }
+
+    // Layer 3: adapter.request（小程序 / 极老浏览器降级）
+    var header = {
+      'content-type': 'application/json',
+      token: this.adapter.getToken() || '',
+      appId: String(this.config.appId),
+      deviceId: this.session.getDeviceId() || '',
+    }
+
+    this.adapter
+      .request({ method: 'POST', url: url, data: JSON.parse(payloadStr), header: header })
+      .then(function () {
+        if (self.config.debug) {
+          console.log('[TrackerSDK] batch sent via adapter.request:', batch.length)
+        }
+      })
+      .catch(function () {
+        self._saveToOfflineCache(batch)
+      })
+      .finally(function () {
+        self.isFlushing = false
+        if (self.queue.length >= self.config.queue.maxBatchSize) {
+          self.flush()
+        }
+      })
+
+    return false // adapter.request 是异步的，isFlushing 由 finally 处理
+  }
+
+  // ---- 手动上报（走旧接口）----
+
+  pushLegacy(url, data, header) {
+    var self = this
+    this.adapter
+      .request({ method: 'POST', url: url, data: data, header: header })
+      .then(function (res) {
+        if (self.config.debug) {
+          console.log('[TrackerSDK] legacy report:', data.frontUrl)
+        }
+      })
+      .catch(function () {
+        self._legacyRetryQueue.push({ url: url, data: data, header: header })
+        self._saveLegacyCache()
+        if (self.config.debug) {
+          console.warn('[TrackerSDK] legacy report failed, cached for retry:', data.frontUrl)
+        }
+      })
+  }
+
+  // ---- Legacy 离线缓存与重试 ----
+
+  _saveLegacyCache() {
+    try {
+      var items = this._legacyRetryQueue.slice(-50)
+      this.adapter.setStorage('_tracker_legacy_cache', items)
+    } catch (e) {}
+  }
+
+  _loadLegacyCache() {
+    try {
+      var cached = this.adapter.getStorage('_tracker_legacy_cache')
+      if (Array.isArray(cached) && cached.length > 0) {
+        this._legacyRetryQueue = cached
+        this.adapter.removeStorage('_tracker_legacy_cache')
+      }
+    } catch (e) {}
+  }
+
+  _retryLegacyCache() {
+    if (this._legacyRetryQueue.length === 0) return
+    var items = this._legacyRetryQueue.splice(0)
+    var self = this
+    items.forEach(function (item) {
+      self.adapter
+        .request({ method: 'POST', url: item.url, data: item.data, header: item.header })
+        .then(function () {
+          if (self.config.debug) {
+            console.log('[TrackerSDK] legacy retry success:', item.data.frontUrl)
+          }
+        })
+        .catch(function () {
+          self._legacyRetryQueue.push(item)
+        })
+    })
+    this._saveLegacyCache()
+  }
+
+  // ---- Hook（供验证脚本等外部消费）----
+
+  onReport(fn) {
+    if (typeof fn === 'function') {
+      this._hooks.push(fn)
+    }
+  }
+
+  _notifyHooks(events) {
+    this._hooks.forEach(function (fn) {
+      try {
+        fn(events)
+      } catch (e) {}
+    })
+  }
+
+  // ---- 页面关闭前强制上报 ----
+
+  flushSync() {
+    if (this.queue.length === 0) return
+
+    if (this._refreshUserId) this._refreshUserId()
+
+    // 与 flush() 相同的身份校验：无 userId 时不上报
+    if (!this.config.allowAnonymousTrack && !this.session.getUserId()) {
+      this.queue = []
+      return
+    }
+
+    var self = this
+    var remaining = this.queue.filter(function (evt) {
+      return !self._flushedEventIds.has(evt.eventId)
+    })
+    this.queue = []
+
+    if (remaining.length === 0) return
+
+    remaining.forEach(function (evt) {
+      if (evt.eventId) self._flushedEventIds.add(evt.eventId)
+    })
+
+    var payload = {
+      appId: this.config.appId,
+      deviceId: this.session.getDeviceId(),
+      sessionId: this.session.getSessionId(),
+      userId: this.session.getUserId(),
+      platform: this.config.pflag !== '' ? this.config.pflag : (this.config.platform || this.adapter.getPlatformName()),
+      events: remaining,
+    }
+
+    var url = this.config.dadianUrl + this.config.batchReportUrl
+    var payloadStr = JSON.stringify(payload)
+
+    // 先备份到离线缓存：sendBeacon 无失败回调，网络失败时事件会永久丢失（序号缺口）。
+    // 备份后即使 sendBeacon 静默失败，下次启动时离线缓存可回灌。
+    // 后端按 eventId 幂等去重，不会产生重复。
+    this._saveToOfflineCache(remaining)
+
+    // 页面关闭时优先 sendBeacon（保证送达），超 60KB 跳过避免静默失败
+    if (typeof navigator !== 'undefined' && navigator.sendBeacon && payloadStr.length < 61440) {
+      try {
+        var blob = new Blob([payloadStr], { type: 'application/json' })
+        var sent = navigator.sendBeacon(url, blob)
+        if (sent) {
+          // sendBeacon 成功排队，清除刚写入的离线备份（大概率会送达）
+          this._removeOfflineEvents(remaining)
+          return
+        }
+      } catch (e) {}
+    }
+
+    // sendBeacon 失败降级为 adapter.sendBeacon（平台适配层实现）
+    this.adapter.sendBeacon(url, payload)
+  }
+
+  // ---- 调度策略：页面维度定时器（停留超时 flush）----
+
+  _startPageFlushTimer() {
+    this._resetPageFlushTimer()
+  }
+
+  _resetPageFlushTimer() {
+    var self = this
+    if (this.flushTimer) {
+      clearTimeout(this.flushTimer)
+    }
+    this.flushTimer = setTimeout(function () {
+      self.flush()
+      // flush 后继续下一轮计时
+      self._resetPageFlushTimer()
+    }, this.config.queue.flushInterval)
+  }
+
+  // 点击后延迟 flush：等后续接口请求到齐后一起上报
+  _scheduleClickFlush() {
+    if (this._clickFlushTimer) return
+    var self = this
+    this._clickFlushTimer = setTimeout(function () {
+      self._clickFlushTimer = null
+      self.flush()
+    }, this.config.queue.clickFlushDelay)
+  }
+
+  _stopAutoFlush() {
+    if (this.flushTimer) {
+      clearTimeout(this.flushTimer)
+      this.flushTimer = null
+    }
+    if (this._clickFlushTimer) {
+      clearTimeout(this._clickFlushTimer)
+      this._clickFlushTimer = null
+    }
+  }
+
+  // ---- 页面关闭处理 ----
+
+  _setupPageCloseHandler() {
+    var self = this
+    this.adapter.onPageHide(function () {
+      self.flushSync()
+    })
+    this.adapter.onPageClose(function () {
+      self.flushSync()
+    })
+  }
+
+  // ---- 离线缓存 ----
+
+  _saveToOfflineCache(events) {
+    try {
+      var key = this.config.queue.offlineCacheKey
+      var cached = this.adapter.getStorage(key)
+      var existing = Array.isArray(cached) ? cached : []
+      var maxOffline = 500
+      var merged = existing.concat(events)
+      if (merged.length > maxOffline) {
+        merged = merged.slice(merged.length - maxOffline)
+      }
+      this.adapter.setStorage(key, merged)
+    } catch (e) {
+      // quota 超限时清空离线缓存，保证 localStorage 可用
+      try {
+        this.adapter.removeStorage(this.config.queue.offlineCacheKey)
+      } catch (ignore) {}
+    }
+  }
+
+  _loadOfflineCache() {
+    try {
+      var key = this.config.queue.offlineCacheKey
+      var cached = this.adapter.getStorage(key)
+      if (Array.isArray(cached) && cached.length > 0) {
+        this.queue = cached.concat(this.queue)
+        this.adapter.removeStorage(key)
+      }
+    } catch (e) {}
+  }
+
+  _removeOfflineEvents(events) {
+    try {
+      var key = this.config.queue.offlineCacheKey
+      var cached = this.adapter.getStorage(key)
+      if (!Array.isArray(cached) || cached.length === 0) return
+      var ids = new Set()
+      events.forEach(function (evt) { if (evt.eventId) ids.add(evt.eventId) })
+      var filtered = cached.filter(function (evt) { return !ids.has(evt.eventId) })
+      if (filtered.length === 0) {
+        this.adapter.removeStorage(key)
+      } else {
+        this.adapter.setStorage(key, filtered)
+      }
+    } catch (e) {}
+  }
+
+  // ---- 清理 ----
+
+  destroy() {
+    this._stopAutoFlush()
+    this.flushSync()
+    this._hooks = []
+  }
+}

package/core/session.js

@@ -0,0 +1,128 @@
+var DEVICE_ID_KEY = '_tracker_device_id'
+
+export class SessionManager {
+  constructor(adapter, config) {
+    this.adapter = adapter
+    this.config = config
+    this.sessionId = null
+    this.startTime = 0
+    this.lastActivityTime = 0
+    this.sequence = 0
+    this.userId = null
+    this.deviceId = null
+    this._storageKey = config.session.storageKey || '_tracker_session'
+    this._renewListeners = []
+
+    this._initDeviceId()
+    this._restore()
+  }
+
+  _initDeviceId() {
+    var stored = this.adapter.getStorage(DEVICE_ID_KEY)
+      || this.adapter.getStorage('deviceId')
+    if (stored) {
+      this.deviceId = stored
+      this.adapter.setStorage(DEVICE_ID_KEY, stored)
+    } else {
+      this.deviceId = this.adapter.generateId('dev')
+      this.adapter.setStorage(DEVICE_ID_KEY, this.deviceId)
+    }
+  }
+
+  getSessionId() {
+    if (!this.sessionId || this._isExpired()) {
+      var wasRenew = !!this.sessionId
+      this._createNew()
+      if (wasRenew) this._notifyRenew()
+    }
+    return this.sessionId
+  }
+
+  onRenew(fn) {
+    if (typeof fn === 'function') this._renewListeners.push(fn)
+  }
+
+  _notifyRenew() {
+    this._renewListeners.forEach(function (fn) { try { fn() } catch (e) {} })
+  }
+
+  nextSequence() {
+    this.sequence++
+    return this.sequence
+  }
+
+  touch() {
+    this.lastActivityTime = this.adapter.getTimestamp()
+    this._save()
+  }
+
+  setUser(userId) {
+    this.userId = userId
+    this._save()
+  }
+
+  setDeviceId(deviceId) {
+    this.deviceId = deviceId
+    this.adapter.setStorage(DEVICE_ID_KEY, deviceId)
+    this._save()
+  }
+
+  getUserId() {
+    return this.userId
+  }
+
+  getDeviceId() {
+    return this.deviceId
+  }
+
+  _isExpired() {
+    if (!this.lastActivityTime) return true
+    var now = this.adapter.getTimestamp()
+    return now - this.lastActivityTime > this.config.session.timeout
+  }
+
+  _createNew() {
+    this.sessionId = this.adapter.generateId('sess')
+    this.startTime = this.adapter.getTimestamp()
+    this.lastActivityTime = this.startTime
+    this.sequence = 0
+    this._save()
+  }
+
+  _save() {
+    var data = {
+      sessionId: this.sessionId,
+      startTime: this.startTime,
+      lastActivityTime: this.lastActivityTime,
+      sequence: this.sequence,
+    }
+    this.adapter.setSessionStorage(this._storageKey, data)
+  }
+
+  _restore() {
+    var data = this.adapter.getSessionStorage(this._storageKey)
+    if (data && data.sessionId) {
+      this.sessionId = data.sessionId
+      this.startTime = data.startTime
+      this.lastActivityTime = data.lastActivityTime
+      this.sequence = data.sequence || 0
+
+      if (this._isExpired()) {
+        this._createNew()
+      }
+    } else {
+      this._createNew()
+    }
+  }
+
+  resetSession() {
+    this.adapter.removeSessionStorage(this._storageKey)
+    this.userId = null
+    this._createNew()
+  }
+
+  destroy() {
+    this.adapter.removeSessionStorage(this._storageKey)
+    this.sessionId = null
+  }
+}