@rk911/tracker-sdk 1.6.4

package/core/tracker.js

@@ -0,0 +1,287 @@
+import { mergeConfig } from './config.js'
+import { SessionManager } from './session.js'
+import { ReportQueue } from './queue.js'
+
+export class Tracker {
+  constructor(config, adapter) {
+    this.config = mergeConfig(config)
+    this.adapter = adapter
+    this.session = new SessionManager(adapter, this.config)
+    this.queue = new ReportQueue(adapter, this.config, this.session)
+    this.plugins = []
+    this._destroyed = false
+    this._userProperties = null
+
+    this._paramResolvers = {}
+    this._referrer = null
+    this._currentPage = null
+    this._currentScrollDepth = null
+    this._sampled = this._decideSampling()
+    this._validEventTypes = {
+      page_view: true, page_stay: true, click: true, custom: true,
+      api_request: true, js_error: true, app_lifecycle: true, page_show: true,
+      exposure: true, scroll_depth: true, performance: true,
+    }
+  }
+
+  _decideSampling() {
+    var sampling = this.config.sampling
+    if (sampling === undefined || sampling === null || sampling >= 1) {
+      return true
+    }
+    if (sampling <= 0) return false
+    var sessionId = this.session.getSessionId()
+    var hash = 0
+    for (var i = 0; i < sessionId.length; i++) {
+      hash = ((hash << 5) - hash + sessionId.charCodeAt(i)) | 0
+    }
+    return Math.abs(hash % 100) / 100 < sampling
+  }
+
+  _getDeviceFields() {
+    var info = this.adapter.getDeviceInfo() || {}
+    return {
+      deviceBrand: info.brand || null,
+      deviceModel: info.model || null,
+      os: info.platform || info.os || null,
+      osVersion: info.system || null,
+      screenWidth: info.screenWidth || null,
+      screenHeight: info.screenHeight || null,
+    }
+  }
+
+  // ---- 插件管理 ----
+
+  use(plugin) {
+    if (this._destroyed) return this
+    if (plugin.name && this.plugins.some(p => p.name === plugin.name)) {
+      if (this.config.debug) {
+        console.warn('[TrackerSDK] plugin "' + plugin.name + '" already registered, skipping')
+      }
+      return this
+    }
+    this.plugins.push(plugin)
+    plugin.install(this)
+    return this
+  }
+
+  // ---- 自动采集上报 ----
+
+  track(eventType, data) {
+    if (this._destroyed) return
+    if (!this._sampled) return
+
+    if (!this._validEventTypes[eventType]) {
+      if (this.config.debug) {
+        console.warn('[TrackerSDK] invalid eventType "' + eventType + '", dropped')
+      }
+      return
+    }
+
+    // 先评估会话是否过期（空闲超 timeout 会在此滚动到新 session 并重置序列号），
+    // 必须在 touch() 之前，否则 touch 刷新 lastActivityTime 后过期判断永远为 false
+    this.session.getSessionId()
+
+    var seq = this.session.nextSequence()
+    this.session.touch()
+
+    var eventData = data || {}
+
+    // 只有导航事件（page_view）才更新页面链路状态（_currentPage/_referrer）
+    // page_stay/click 等事件传的 pageRoute 仅表示"事件发生在哪个页面"，不是导航信号
+    var declaredPage = eventData.pageRoute || null
+
+    if (eventType === 'page_view' && declaredPage && declaredPage !== '/' && declaredPage !== this._currentPage) {
+      if (this._currentPage) {
+        this._referrer = this._currentPage
+      }
+      this._currentPage = declaredPage
+    }
+
+    if (!this._currentPage) {
+      var initRoute = this.adapter.getCurrentPagePath()
+      if (initRoute && initRoute !== '/') {
+        this._currentPage = initRoute
+      }
+    }
+
+    // 动态参数解析：click 插件传入 _paramName 和 _element
+    if (eventData._paramName && this._paramResolvers[eventData._paramName]) {
+      try {
+        var resolved = this._paramResolvers[eventData._paramName](eventData._element)
+        if (resolved && typeof resolved === 'object') {
+          if (resolved.extKey) eventData.extKey = resolved.extKey
+          if (resolved.extValue) eventData.extValue = resolved.extValue
+          if (resolved.extIntValue !== undefined) eventData.extIntValue = resolved.extIntValue
+          if (resolved.postParam) eventData.postParam = resolved.postParam
+        }
+      } catch (e) {
+        if (this.config.debug) {
+          console.warn('[TrackerSDK] paramResolver error:', eventData._paramName, e)
+        }
+      }
+    }
+    delete eventData._paramName
+    delete eventData._element
+
+    var event = {
+      eventId: this.adapter.generateId('e'),
+      eventType: eventType,
+      eventName: eventData.eventName || eventType,
+      timestamp: this.adapter.getTimestamp(),
+      sequence: seq,
+      pageRoute: 'pageRoute' in eventData ? (eventData.pageRoute || null) : (this._currentPage || this.adapter.getCurrentPagePath()),
+      pageTitle: 'pageTitle' in eventData ? (eventData.pageTitle || null) : (this.adapter.getPageTitle ? this.adapter.getPageTitle() : null),
+      elementId: eventData.elementId || null,
+      elementText: eventData.elementText || null,
+      duration: eventData.duration || null,
+      scrollDepth: eventData.scrollDepth || this._currentScrollDepth || null,
+      errorMessage: eventData.errorMessage || null,
+      errorStack: eventData.errorStack || null,
+      extraData: eventData.extraData ? JSON.stringify(eventData.extraData) : null,
+      extKey: eventData.extKey || null,
+      extValue: eventData.extValue || null,
+      extIntValue: eventData.extIntValue || null,
+      frontUrl: eventData.frontUrl || null,
+      postParam: eventData.postParam != null && eventData.postParam !== ''
+        ? (typeof eventData.postParam === 'string'
+          ? eventData.postParam
+          : JSON.stringify(eventData.postParam))
+        : '',
+      networkType: this.adapter.getNetworkType
+        ? this.adapter.getNetworkType()
+        : null,
+      referrer: eventData.referrer || this._referrer || null,
+    }
+
+    // 自引用 referrer（来源页 = 当前页）对路径还原无意义，清空。
+    // 常见于后台切回后 _referrer 未随导航更新，page_stay 继承到当前页自身。
+    if (event.referrer && event.referrer === event.pageRoute) {
+      event.referrer = null
+    }
+
+    var deviceFields = this._getDeviceFields()
+    Object.keys(deviceFields).forEach(function (key) {
+      event[key] = deviceFields[key]
+    })
+
+    this.queue.push(event)
+
+    if (this.config.debug) {
+      console.log('[TrackerSDK] track:', eventType, event)
+    }
+  }
+
+  // ---- 手动上报（走旧接口）----
+
+  trackLegacy(frontUrl, postParam, extraHeader) {
+    if (this._destroyed) return
+
+    this.session.touch()
+
+    var url = this.config.dadianUrl + '/api/point/task/activeReport'
+    var header = {
+      'content-type': 'application/json',
+      token: this.adapter.getToken() || '',
+    }
+    if (extraHeader) {
+      Object.keys(extraHeader).forEach(function (k) {
+        header[k] = extraHeader[k]
+      })
+    }
+    var data = {
+      frontUrl: frontUrl,
+      postParam:
+        typeof postParam === 'string' ? postParam : JSON.stringify(postParam),
+    }
+
+    this.queue.pushLegacy(url, data, header)
+  }
+
+  // ---- 用户标识 ----
+
+  setUser(userId) {
+    this.session.setUser(userId)
+  }
+
+  setDeviceId(deviceId) {
+    this.session.setDeviceId(deviceId)
+  }
+
+  setUserProperties(properties) {
+    this._userProperties = properties
+  }
+
+  getUserProperties() {
+    return this._userProperties
+  }
+
+  // ---- 页面导航状态（referrer）----
+
+  updatePageRoute(newPage) {
+    if (newPage && newPage !== this._currentPage) {
+      if (this._currentPage) {
+        this._referrer = this._currentPage
+      }
+      this._currentPage = newPage
+    }
+  }
+
+  getReferrer() {
+    return this._referrer
+  }
+
+  // ---- 动态参数解析器 ----
+
+  registerParam(name, fn) {
+    if (typeof name === 'string' && typeof fn === 'function') {
+      this._paramResolvers[name] = fn
+    }
+  }
+
+  unregisterParam(name) {
+    delete this._paramResolvers[name]
+  }
+
+  // ---- 访问器 ----
+
+  getAdapter() {
+    return this.adapter
+  }
+
+  getSession() {
+    return this.session
+  }
+
+  getQueue() {
+    return this.queue
+  }
+
+  getConfig() {
+    return this.config
+  }
+
+  // ---- Hook ----
+
+  onReport(fn) {
+    this.queue.onReport(fn)
+  }
+
+  // ---- 清理 ----
+
+  destroy() {
+    if (this._destroyed) return
+    this._destroyed = true
+
+    this.plugins.forEach(function (plugin) {
+      if (typeof plugin.destroy === 'function') {
+        plugin.destroy()
+      }
+    })
+    this.plugins = []
+
+    this.queue.destroy()
+    this.session.destroy()
+    this.adapter.destroy()
+  }
+}

package/customize/index.js

@@ -0,0 +1,92 @@
+/**
+ * SDK 定制化调度入口
+ *
+ * 目录结构：
+ *   customize/
+ *     index.js              — 当前文件，统一调度入口
+ *     modules/
+ *       common.js           — 技术栈通用方法（uni-app 所有项目共享）
+ *       store-manager.js    — 店长端项目定制（appId=1）
+ *       （后续项目在此添加，如 customer-app.js、mini-program.js）
+ *
+ * 两种调用方式：
+ *   1. SDK 内部：config.projectRules.isTabbarClick(el)
+ *   2. 业务代码：customize.callFunction('store-manager', 'extractNavTarget', eventName)
+ */
+
+// appId → 模块文件名映射
+var APP_ID_MAP = {
+  '1': 'store-manager',
+  // '12': 'customer-app',
+  // '18': 'mini-program',
+}
+
+/**
+ * 动态加载 modules 下的模块
+ */
+function loadModule(moduleName) {
+  try {
+    var m = require('./modules/' + moduleName)
+    return m.default || m
+  } catch (e) {
+    console.warn('[customize] module not found:', moduleName)
+    return null
+  }
+}
+
+/**
+ * 调用指定模块的指定方法
+ * @param {string} moduleName - 模块名（common / store-manager / ...）
+ * @param {string} methodName - 方法名
+ * @param {...any} args - 参数（直接传给方法）
+ * @returns {any} 方法返回值
+ */
+function callFunction(moduleName, methodName) {
+  var mod = loadModule(moduleName)
+  if (!mod) return undefined
+  if (!methodName || typeof mod[methodName] !== 'function') {
+    console.warn('[customize] method not found:', moduleName + '.' + methodName)
+    return undefined
+  }
+  var args = Array.prototype.slice.call(arguments, 2)
+  return mod[methodName].apply(null, args)
+}
+
+/**
+ * 根据 appId 获取合并后的项目规则（common + 项目模块）
+ * SDK 初始化时调用，返回值赋给 config.projectRules
+ *
+ * @param {string|number} appId
+ * @returns {object|null} 合并后的 rules 对象
+ */
+function getProjectRules(appId) {
+  if (!appId) return null
+  var projectName = APP_ID_MAP[String(appId)]
+  if (!projectName) return null
+
+  var commonMod = loadModule('common') || {}
+  var projectMod = loadModule(projectName) || {}
+
+  // 项目模块优先，common 兜底
+  var rules = {}
+  var key
+  for (key in commonMod) {
+    if (commonMod.hasOwnProperty(key)) {
+      rules[key] = commonMod[key]
+    }
+  }
+  for (key in projectMod) {
+    if (projectMod.hasOwnProperty(key)) {
+      rules[key] = projectMod[key]
+    }
+  }
+
+  return rules
+}
+
+export { callFunction, getProjectRules }
+
+export default {
+  callFunction: callFunction,
+  getProjectRules: getProjectRules,
+}

package/customize/modules/common.js

@@ -0,0 +1,43 @@
+/**
+ * 技术栈通用定制方法（uni-app 全项目共享）
+ *
+ * 这里放的是所有 uni-app 项目都需要的通用检测/处理逻辑，
+ * 与具体业务项目无关。项目级别的特殊处理放各自的模块文件里。
+ */
+export default {
+
+  /**
+   * 检测元素是否在原生 uni-tabbar 内
+   * uni-app 内置 tabbar 会渲染为 <uni-tabbar> 标签或带 uni-tabbar class 的元素
+   * 所有 uni-app 项目通用，不需要项目定制
+   */
+  isNativeTabbar: function (_this, el) {
+    var current = el
+    var depth = 0
+    while (current && current !== document.body && depth < 10) {
+      var tag = (current.tagName || '').toLowerCase()
+      if (tag === 'uni-tabbar' || tag === 'tabbar') return true
+      var cls = current.className || ''
+      if (typeof cls === 'string') {
+        if (cls.indexOf('uni-tabbar') > -1 || cls.indexOf('tabBar') > -1 || cls.indexOf('tab-bar') > -1) return true
+      }
+      current = current.parentElement || current.parentNode
+      depth++
+    }
+    return false
+  },
+
+  /**
+   * 获取当前页面路由（uni-app 通用）
+   * 通过 getCurrentPages() 获取，所有 uni-app 项目一致
+   */
+  getCurrentRoute: function () {
+    try {
+      var pages = getCurrentPages()
+      if (pages.length > 0) {
+        return pages[pages.length - 1].route || ''
+      }
+    } catch (e) {}
+    return ''
+  },
+}

package/customize/modules/store-manager.js

@@ -0,0 +1,56 @@
+/**
+ * 店长端 (store-manager) 项目定制方法
+ * appId: 1
+ *
+ * 只放和店长端项目业务相关的特殊处理，
+ * 技术栈通用的逻辑在 common.js 里。
+ */
+export default {
+
+  name: 'store-manager',
+  appId: '1',
+
+  /**
+   * 判断点击是否在店长端自定义底部导航区域
+   * 店长端用 footer-h.vue 组件，class="footers" / "footer-item"
+   * 返回 true 时 click.js 跳过自动采集（由业务代码手动 $track 上报）
+   */
+  isTabbarClick: function (_this, el) {
+    var current = el
+    var depth = 0
+    while (current && current !== document.body && depth < 10) {
+      var cls = current.className || ''
+      if (typeof cls === 'string') {
+        if (cls.indexOf('footers') > -1 || cls.indexOf('footer-item') > -1) return true
+      }
+      current = current.parentElement || current.parentNode
+      depth++
+    }
+    return false
+  },
+
+  /**
+   * 从导航事件中提取目标页面路由
+   * 店长端 footer-h 组件的 $track 调用格式：this.$track('footer/click' + url)
+   * 其中 url 为 /pages/xxx/index
+   * 返回目标路由供 SDK 提前更新 referrer 链路
+   */
+  extractNavTarget: function (_this, eventName) {
+    if (!eventName) return null
+    var match = eventName.match(/footer\/click(\/pages\/[^\s?#]+)/)
+    if (match) return match[1]
+    return null
+  },
+
+  /**
+   * 不需要自动采集 click 的选择器/区域
+   * 这些区域已有手动埋点，自动采集会导致重复或错误 pageRoute
+   */
+  ignoreClickSelectors: ['.footers', '.footer-item'],
+
+  /**
+   * 旧接口上报用的 frontUrl（各项目已在后台注册的值）
+   */
+  pageStayFrontUrl: '/storeManager/page_stay',
+  pageShowFrontUrl: '/storeManager/page_show',
+}