@rk911/tracker-sdk 1.6.4

package/core/compat.js

@@ -0,0 +1,344 @@
+/**
+ * 兼容层 — 确保现有业务代码的 this.$dadian() 和 v-impression 零改动可用
+ */
+
+function isObject(value) {
+  return Object.prototype.toString.call(value) === '[object Object]'
+}
+
+/**
+ * 创建 $dadian 代理函数
+ * 行为与 new-platform-store-manager/common/public.js 的 activeReport 一致：
+ * 直接将 address 作为 frontUrl，不做路由拼接
+ */
+export function createDadianProxy(tracker) {
+  const config = tracker.getConfig()
+  const dadianUrl = config.dadianUrl
+
+  return function activeReport(frontUrl, postParam) {
+    // [PROJECT-ADAPT] 认证头检查
+    var header = { 'content-type': 'application/json' }
+    if (typeof config.getAuthHeaders === 'function') {
+      var authHeaders = config.getAuthHeaders() || {}
+      if (!authHeaders.Authorization && !authHeaders.token) {
+        return false
+      }
+      Object.assign(header, authHeaders)
+    }
+
+    // postParam 处理（小程序合并 eventBus 字段）
+    var postParamStr = null
+    if (postParam) {
+      if (config.platform === 'weapp' && config.eventBus) {
+        var eventBus = config.eventBus
+        postParamStr = JSON.stringify(
+          isObject(postParam)
+            ? {
+                ...postParam,
+                wxAppOnLaunch: eventBus.wxAppOnLaunch,
+                pageFrom: eventBus.pageFrom,
+                mallOrderExt: eventBus.mallOrderExt,
+              }
+            : postParam
+        )
+      } else {
+        postParamStr = JSON.stringify(postParam)
+      }
+    }
+
+    // 开关关（默认）：旧接口直接 POST + SDK 入队，报 2 次
+    // 开关开：只走 SDK 队列，不调旧接口
+    if (!config.useUnifiedReport) {
+      var url = dadianUrl + '/api/point/task/activeReport'
+      tracker.getQueue().pushLegacy(url, { frontUrl: frontUrl, postParam: postParamStr }, header)
+    }
+
+    // SDK 事件入队（不论开关，始终入队；字段映射始终一套规则）
+    tracker.track('custom', {
+      eventName: frontUrl || 'manual',
+      frontUrl: frontUrl,
+      postParam: postParamStr,
+      elementId: frontUrl,
+    })
+
+    if (config.debug) {
+      console.log('[TrackerSDK] dadian:', frontUrl, postParam)
+    }
+  }
+}
+
+/**
+ * 创建 v-impression 指令
+ * 逻辑与 apph5/directives/impression.js 完全一致
+ */
+export function createImpressionDirective(tracker) {
+  var observers = new WeakMap()
+  var reportedElements = new WeakSet()
+
+  function handleIntersection(entries, observer) {
+    entries.forEach(function (entry) {
+      if (entry.isIntersecting && entry.intersectionRatio >= 1.0) {
+        var el = entry.target
+        if (!reportedElements.has(el)) {
+          var impressionData = el._impressionData || {}
+          var handler = impressionData.handler
+          var data = impressionData.data
+          if (handler && typeof handler === 'function') {
+            handler(data)
+            reportedElements.add(el)
+            observer.unobserve(el)
+          } else {
+            reportedElements.add(el)
+            observer.unobserve(el)
+          }
+        }
+      }
+    })
+  }
+
+  return {
+    bind: function (el, binding) {
+      if (
+        !binding.value ||
+        typeof binding.value.handler !== 'function' ||
+        typeof binding.value.data === 'undefined'
+      ) {
+        return
+      }
+
+      el._impressionData = binding.value
+
+      var options = {
+        root: null,
+        rootMargin: '0px',
+        threshold: 1.0,
+      }
+
+      var observer = new IntersectionObserver(handleIntersection, options)
+      observer.observe(el)
+      observers.set(el, observer)
+    },
+
+    update: function (el, binding) {
+      if (
+        binding.value &&
+        binding.oldValue &&
+        JSON.stringify(binding.value.data) !==
+          JSON.stringify(binding.oldValue.data)
+      ) {
+        el._impressionData = binding.value
+      } else if (binding.value) {
+        el._impressionData = binding.value
+      }
+    },
+
+    unbind: function (el) {
+      var observer = observers.get(el)
+      if (observer) {
+        observer.unobserve(el)
+        observers.delete(el)
+      }
+      reportedElements.delete(el)
+      delete el._impressionData
+    },
+  }
+}
+
+/**
+ * 创建页面停留时长 mixin
+ * 简化版 PageStayTracker，保留核心计时和上报逻辑
+ */
+export function createPageStayMixin(tracker) {
+  var _lastMixinRoute = null
+
+  return {
+    data: function () {
+      return {
+        _pageStayStartTime: 0,
+        _pageStayRoute: '',
+        _pageStayTitle: '',
+      }
+    },
+
+    onLoad: function () {
+      var route = ''
+      try {
+        // 优先用组件自身的页面路由（不受全局导航栈时序影响）
+        if (this.$mp && this.$mp.page && this.$mp.page.route) {
+          route = this.$mp.page.route
+        } else if (this.$page && this.$page.route) {
+          route = this.$page.route
+        } else {
+          // 降级：取全局栈顶（仅首次加载可靠，导航中可能已被更新）
+          var pages = getCurrentPages()
+          if (pages.length > 0) {
+            route = pages[pages.length - 1].route || ''
+          }
+        }
+      } catch (e) {}
+      if (!route) return
+      this._pageStayRoute = route.charAt(0) === '/' ? route : '/' + route
+      this._pageStayTitle = ''
+      try {
+        if (typeof document !== 'undefined' && document.title) {
+          this._pageStayTitle = document.title
+        }
+      } catch (e) {}
+      this._pageStayStartTime = Date.now()
+      this._pageShowReported = false
+    },
+
+    mounted: function () {
+      if (typeof window === 'undefined') return
+      var self = this
+      this._pageshowHandler = function (e) {
+        if (e.persisted) {
+          self._pageStayStartTime = Date.now()
+        }
+      }
+      window.addEventListener('pageshow', this._pageshowHandler)
+
+      // H5 下 app 前后台切换（visibilitychange）不总触发页面 onShow/onHide，
+      // 切回前台后停留起点未重置 → 下次 onHide 因 start=0 早退 → 停留漏测。
+      // 用 visibilitychange 兜底（app-lifecycle 已证明它可靠触发）：
+      // 仅栈顶页面响应，与 onShow/onHide 幂等共存（重复触发因 start=0 早退，不会重报）。
+      if (typeof document !== 'undefined') {
+        this._pageVisHandler = function () {
+          if (!self._isTopStayPage()) return
+          if (document.visibilityState === 'visible') {
+            self._pageStayStartTime = Date.now()
+          } else if (document.visibilityState === 'hidden') {
+            self._pageStayReport()
+          }
+        }
+        document.addEventListener('visibilitychange', this._pageVisHandler)
+      }
+    },
+
+    onShow: function () {
+      if (!this._pageStayRoute) return
+      this._pageStayStartTime = Date.now()
+      if (!this._pageShowReported) {
+        this._pageShowReported = true
+        this._pageShowReport('onShow')
+      }
+    },
+
+    onHide: function () {
+      if (!this._pageStayRoute) return
+      _lastMixinRoute = this._pageStayRoute
+      this._pageStayReport()
+      this._pageShowReported = false
+    },
+
+    onUnload: function () {
+      if (!this._pageStayRoute) return
+      _lastMixinRoute = this._pageStayRoute
+      this._pageStayReport()
+    },
+
+    beforeDestroy: function () {
+      if (this._pageshowHandler && typeof window !== 'undefined') {
+        window.removeEventListener('pageshow', this._pageshowHandler)
+        this._pageshowHandler = null
+      }
+      if (this._pageVisHandler && typeof document !== 'undefined') {
+        document.removeEventListener('visibilitychange', this._pageVisHandler)
+        this._pageVisHandler = null
+      }
+    },
+
+    methods: {
+      // 当前组件是否为导航栈顶（活跃）页面。
+      // visibilitychange 是全局事件，栈中多个页面实例都会收到，
+      // 仅栈顶页响应，避免后台页面误报停留。
+      _isTopStayPage: function () {
+        try {
+          var pages = getCurrentPages()
+          if (!pages || !pages.length) return false
+          var top = pages[pages.length - 1]
+          var route = top && top.route
+            ? (top.route.charAt(0) === '/' ? top.route : '/' + top.route)
+            : ''
+          return route === this._pageStayRoute
+        } catch (e) {
+          return false
+        }
+      },
+
+      _pageShowReport: function (trigger) {
+        var config = tracker.getConfig()
+        var showFrontUrl = config.pageShowFrontUrl || '/storeManager/page_show'
+        var showPostParam = JSON.stringify({
+          pagePath: this._pageStayRoute,
+          timestamp: Date.now(),
+          trigger: trigger,
+        })
+
+        if (!config.useUnifiedReport) {
+          var header = { 'content-type': 'application/json' }
+          if (typeof config.getAuthHeaders === 'function') {
+            Object.assign(header, config.getAuthHeaders() || {})
+          }
+          tracker.getQueue().pushLegacy(
+            config.dadianUrl + '/api/point/task/activeReport',
+            { frontUrl: showFrontUrl, postParam: showPostParam },
+            header
+          )
+
+          // 旧模式：page_show 通过 SDK 队列上报（与 page_view 并存）
+          tracker.track('page_show', {
+            pageRoute: this._pageStayRoute,
+            referrer: _lastMixinRoute || tracker.getReferrer() || null,
+            frontUrl: showFrontUrl,
+            postParam: showPostParam,
+            elementId: showFrontUrl,
+          })
+        }
+        // 统一模式：不再上报 page_show，由 PageViewPlugin 的 page_view 统一负责
+      },
+
+      _pageStayReport: function () {
+        if (!this._pageStayStartTime) return
+        var duration = Date.now() - this._pageStayStartTime
+        this._pageStayStartTime = 0
+
+        var config = tracker.getConfig()
+        // 最小停留阈值：iOS 前后台抖动会产生大量 1~2s 的碎停留，默认 2000ms 过滤噪音
+        var minDuration = (config.pageStay || {}).minStayDuration || 2000
+        if (duration < minDuration) return
+
+        var maxDuration = (config.pageStay || {}).maxStayDuration || 1800000
+        if (duration > maxDuration) duration = maxDuration
+
+        var stayFrontUrl = config.pageStayFrontUrl || '/storeManager/page_stay'
+        var stayPostParam = JSON.stringify({
+          pagePath: this._pageStayRoute,
+          duration: duration,
+          timestamp: Date.now(),
+        })
+
+        if (!config.useUnifiedReport) {
+          var header = { 'content-type': 'application/json' }
+          if (typeof config.getAuthHeaders === 'function') {
+            Object.assign(header, config.getAuthHeaders() || {})
+          }
+          tracker.getQueue().pushLegacy(
+            config.dadianUrl + '/api/point/task/activeReport',
+            { frontUrl: stayFrontUrl, postParam: stayPostParam },
+            header
+          )
+        }
+
+        tracker.track('page_stay', {
+          pageRoute: this._pageStayRoute,
+          pageTitle: this._pageStayTitle || null,
+          duration: duration,
+          frontUrl: stayFrontUrl,
+          postParam: stayPostParam,
+          elementId: stayFrontUrl,
+        })
+      },
+    },
+  }
+}

package/core/config.js

@@ -0,0 +1,132 @@
+// [PROJECT-ADAPT] 默认配置
+// 各项目通过 Vue.use(TrackerSDK, { ... }) 覆盖以下默认值
+// 标记有 ★ 的字段是各项目最可能需要覆盖的
+const DEFAULT_CONFIG = {
+  appId: '',           // ★ 店长端=1, apph5=12/13, 小程序=18（每个项目固定，不会变）
+  dadianUrl: '',       // ★ 各环境域名不同
+  platform: '',        // ★ 运行时类型: 'web' | 'weapp' | 'app'（SDK 内部使用，决定插件行为）
+  pflag: '',           // ★ 业务平台标识: 对应 PlatformList 的值（上报用，区分白标）
+  tokenKey: 'token',   // ★ 小程序用 'tokenV2'
+
+  plugins: [],
+
+  queue: {
+    maxBatchSize: 10,       // 达到此条数立即上报（页面维度批量）
+    flushInterval: 60000,   // 同页面停留超过此时长（ms）也触发上报
+    clickFlushDelay: 3000,  // 点击后延迟上报时间（ms），等待后续接口请求一起批量发出
+    maxQueueSize: 100,
+    offlineCacheKey: '_tracker_offline_cache',
+  },
+
+  session: {
+    timeout: 30 * 60 * 1000,
+    storageKey: '_tracker_session',
+  },
+
+  pageStay: {
+    heartbeatInterval: 5000,
+    maxStayDuration: 1800000,
+    minStayDuration: 2000,
+  },
+
+  // 曝光插件配置
+  exposure: {
+    validExposureTime: 1000,  // 有效曝光最小停留时长 ms
+    exitRatio: 0.7,           // 低于此比例判定为离开视口
+    threshold: 0.5,           // 普通模式可见比例阈值
+    useDuration: false,       // 是否启用停留时长验证
+    observeDynamicElements: true, // 是否监控动态 DOM 元素
+  },
+
+  // 滚动深度插件配置
+  scrollDepth: {
+    throttle: 1000,     // 节流间隔 ms
+    milestone: false,   // 是否只在 25/50/75/100% 里程碑时上报
+  },
+
+  // 采样率 0-1，1 表示全量采集，0.5 表示 50% 的会话被采集
+  // 采用会话级别采样，同一个 session 内所有事件要么全采要么全不采
+  sampling: 1,
+
+  batchReportUrl: '/api/point/task/trackBatch',
+
+  // ★ 无 token 上报开关
+  // false（默认）：flush 时必须有 token 才上报，无 token 事件留在队列等待
+  // true：无 token 也可上报（适用于不需要登录的场景）
+  allowAnonymousTrack: false,
+
+  // ★ 统一上报开关
+  // false（默认）：$dadian/$track 旧接口直接 POST + SDK 入队，报 2 次（过渡期双写）
+  // true：$dadian/$track 只走 SDK 队列 → trackBatch，不再调旧接口（迁移完成后开启）
+  useUnifiedReport: true,
+
+  // ★ page_stay / page_show 事件在旧接口中的 frontUrl（各项目已注册的值）
+  // 店长端: '/storeManager/page_stay', '/storeManager/page_show'
+  // appH5: 根据实际注册值填写
+  pageStayFrontUrl: '/storeManager/page_stay',
+  pageShowFrontUrl: '/storeManager/page_show',
+
+  // ★ [PROJECT-ADAPT] 认证头回调
+  // 店长端: () => ({ Authorization: orgToken, token: orgToken, 'rsb-token': token })
+  // 小程序: () => ({ token: tokenV2 })
+  // apph5: () => ({ 'rsb-token': token })
+  getAuthHeaders: null,
+
+  // 设备注册配置
+  deviceRegister: {
+    url: '/api/point/device/add',
+    appVersion: '1.0',
+  },
+
+  eventBus: null,
+
+  debug: false,
+}
+
+function deepMerge(target, source) {
+  const result = { ...target }
+  for (const key of Object.keys(source)) {
+    if (source[key] === undefined) continue
+    if (
+      source[key] &&
+      typeof source[key] === 'object' &&
+      !Array.isArray(source[key]) &&
+      target[key] &&
+      typeof target[key] === 'object' &&
+      !Array.isArray(target[key])
+    ) {
+      result[key] = deepMerge(target[key], source[key])
+    } else {
+      result[key] = source[key]
+    }
+  }
+  return result
+}
+
+export function getDefaultConfig() {
+  return JSON.parse(JSON.stringify(DEFAULT_CONFIG))
+}
+
+export function mergeConfig(userConfig) {
+  const config = deepMerge(DEFAULT_CONFIG, userConfig)
+  if (userConfig.eventBus) {
+    config.eventBus = userConfig.eventBus
+  }
+  if (typeof userConfig.getAuthHeaders === 'function') {
+    config.getAuthHeaders = userConfig.getAuthHeaders
+  }
+  if (userConfig.projectRules) {
+    config.projectRules = userConfig.projectRules
+  }
+  validateConfig(config)
+  return config
+}
+
+export function validateConfig(config) {
+  if (!config.appId) {
+    throw new Error('[TrackerSDK] appId is required')
+  }
+  if (!config.dadianUrl) {
+    throw new Error('[TrackerSDK] dadianUrl is required')
+  }
+}