visual-buried-point-platform-uni 1.0.0-alpha.1 → 1.0.0-alpha.11

package/README.md

@@ -1,18 +1,19 @@
 ## Uni版自定义埋点SDK集成文档
 
+### SDK更新日志
+- 1.0.0-alpha.07 最新uni、终端通用埋点sdk;
+- 1.0.0-alpha.08 自定义上报数据结构删除path字段;
+
 ### 1、引入方式
 
 ```js
-npm install visual-buried-point-platform-uni -S --registry=http://verdaccio.gogdev.cn/
-工具-构建npm
+//内网npm链接：http://verdaccio.gogdev.cn/
+npm install visual-buried-point-platform-uni
 ```
 
 ### 2、初始化方式
 
-**app.js**
-
 ```js
-//require引入
 import { init } from 'visual-buried-point-platform-uni'
 onLaunch: function() {
       //初始化sdk
@@ -47,8 +48,6 @@ setUserId(123456);
 setUserId("");
 ```
 
-
-
 ### 4、自定义事件上报
 
 - sdk初始化后，可通过 ***setCustomEvent()*** 方法上报自定义埋点事件，并为事件添加属性值：

package/index.js

@@ -11,6 +11,8 @@ import {
   getDeviceInfoError,
   timeToStr,
   getTrackObj,
+  getCurPath,
+  getUrl,
 } from "./tools.js";
 import { setReportUrl } from "./config.js";
 
@@ -29,6 +31,8 @@ let _config = {
   srcDomain: "",
   flushInterval: 15,
 };
+//custom
+let timer = null;
 //track upload interval
 let tInterval = null;
 let busObj = null;
@@ -74,14 +78,13 @@ export function init(config) {
   startGlobalTime();
 }
 
-//the general custom report interval is enabled
+//the general custom reportCustom interval is enabled
 function startGlobalTime() {
   clearInterval(cInterval);
   cInterval = setInterval(() => {
     let cData = getSData();
-    console.log("storage data " + cData);
     if (cData) {
-      report(cData);
+      reportCustom(cData);
       delSData();
     }
   }, _config.flushInterval * 1000);
@@ -106,7 +109,7 @@ export function setCustomEvent(data) {
   reportData = {
     ctk: data.$ctk ? data.$ctk : "",
     duration: "",
-    element: null,
+    element: data.$element ? data.$element : null,
     eventId: data.$event_id ? data.$event_id : "",
     event: data.$event_code ? data.$event_code : "",
     groupId: "",
@@ -117,27 +120,29 @@ export function setCustomEvent(data) {
       pageId: MD5(_path),
       path: _path,
       title: _page.title ? _page.title : "",
+      url: _path ? _path : getUrl(platform),
     },
-    path: data.$path ? data.$path : "",
     properties: data.$extend_param ? JSON.stringify(data.$extend_param) : "",
     traceId: "",
     trackId: trackId,
     triggerTime: timeToStr(Date.now()),
-    url: "",
   };
   if (reportData) {
     addCache(reportData);
-    const data = getCache();
-    if (data.length) {
-      addSData(data);
-      clearCache();
-    }
+    clearTimeout(timer);
+    timer = setTimeout(() => {
+      const data = getCache();
+      if (data.length) {
+        addSData(data);
+        clearCache();
+      }
+    }, 1000);
   }
 }
 
-function report(data) {
+function reportCustom(data) {
   if (!reportUrl) {
-    //console.error("please set upload data url");
+    console.error("please set upload data reportUrl");
     return;
   }
   const comData = commonData(data);
@@ -145,25 +150,23 @@ function report(data) {
     ...comData,
     dataAbstract: MD5(JSON.stringify(comData)),
   };
-  uni.nextTick(function () {
-    uni.request({
-      url: reportUrl,
-      method: "POST",
-      header: {
-        "Content-Type": "application/json",
-        appKey: _config.token,
-        projectId: _config.token,
-      },
-      data: reportData,
-      success: function (res) {},
-      fail: function (error) {
-        console.error(error);
-      },
-    });
+  uni.request({
+    url: reportUrl,
+    method: "POST",
+    header: {
+      "Content-Type": "application/json",
+      appKey: _config.token,
+      projectId: _config.token,
+    },
+    data: reportData,
+    success: function (res) {},
+    fail: function (error) {
+      console.error(error);
+    },
   });
 }
 
-//track upload-注册
+//track upload-registry
 export function onStartTrack(tData) {
   busObj = null;
   startTime = 0;
@@ -186,17 +189,27 @@ export function onDestroyTrack() {
 
 function assemblyTrackData(type) {
   if (busObj) {
-    let obj = getTrackObj(busObj);
+    let obj = getTrackObj(busObj, platform);
     let trackData = null;
+    let cirtemp = -1;
     if (type === "destroy") {
+      cirtemp = 3;
       startTime = (Date.now() - startTimeLong) / 1000;
+    } else {
+      if (startTime === 0) {
+        startTime === 0;
+        cirtemp = 1;
+      } else {
+        startTime = 15;
+        cirtemp = 2;
+      }
     }
     trackData = {
       busSegment: busObj.busSegment,
-      circulation: obj.circulation,
+      circulation: cirtemp,
       ctk: busObj.ctk ? busObj.ctk : "",
       domain: obj.domain,
-      duration: startTime === 0 ? 0 : startTime,
+      duration: startTime,
       module: busObj.module,
       path: obj.path,
       properties: busObj.extend_param
@@ -243,24 +256,11 @@ function reportTrack(data) {
   });
 }
 
-function getCurPath() {
-  if (platform) {
-    if (platform == "wx") {
-      let gcp = getCurrentPages();
-      return gcp ? gcp[gcp.length - 1].route : "/";
-    } else if (platform == "web") {
-      return window.location.hostname;
-    } else if (platform == "android" || platform === "ios") {
-      return "";
-    }
-  }
-}
-
 function commonData(allData) {
   return {
     app: appData,
     data: allData,
-    deviceData: deviceData,
+    device: deviceData,
     lsi: localLsi,
     projectId: _config.token,
     userAgent: uAgent ? uAgent : "",
@@ -289,7 +289,7 @@ function getBaseicInfo() {
         platform = "wx";
         appData = wxInfo();
       }
-      deviceData = getDeviceInfo(res);
+      deviceData = getDeviceInfo(res, platform);
     },
     fail: function (error) {
       deviceData = getDeviceInfoError();
@@ -297,10 +297,7 @@ function getBaseicInfo() {
     complete: function () {
       uni.getNetworkType({
         success(res) {
-          deviceData = {
-            ...deviceData,
-            network: res.networkType,
-          };
+          deviceData.network = res.networkType;
         },
       });
     },

package/lsi-md5.js

@@ -1,15 +1,14 @@
 // 此js在npm build，根据name + version + md5后会自动修改package.json中的lsi
 // 注：发给后端，作为标识依据和上报字段lsi值
-import fs from 'fs' ;
-import MD5 from 'md5' ;
-const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
-
+import fs from "fs";
+import MD5 from "md5";
+const packageJson = JSON.parse(fs.readFileSync("./package.json", "utf-8"));
 
 const { name, version } = packageJson;
 // MD5
 const combinedString = name + "-" + version;
 const md5Str = MD5(combinedString);
-packageJson.lsi = md5Str;
+packageJson.lsi = md5Str + "#" + version;
 //base64
 // const combinedString = name.substring(0, 16) + "v" + version;
 // const base64Str = btoa(combinedString);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "visual-buried-point-platform-uni",
-  "version": "1.0.0-alpha.01",
-  "lsi": "e640f6dcca0160bfded7c074ba108e9f",
+  "version": "1.0.0-alpha.11",
+  "lsi": "451804ea84c42e02c91ca4788c40d48c#1.0.0-alpha.11",
   "description": "To make it easy for you to get started with GitLab, here's a list of recommended next steps.",
   "main": "index.js",
   "scripts": {

package/tools.js

@@ -64,11 +64,14 @@ export function webH5Info(result) {
 
 //微信的appInfo
 export function wxInfo() {
-  let accInfo = uni.getAccountInfoSync();
+  const accInfo = uni.getAccountInfoSync();
+  const bInfo = uni.getAppBaseInfo();
   return {
-    name: "",
-    packageName: accInfo ? accInfo.appId : "",
-    version: accInfo ? accInfo.envVersion + accInfo.version : "",
+    name: bInfo.appName ? bInfo.appName : "",
+    packageName: accInfo ? accInfo.miniProgram.appId : "",
+    version: accInfo
+      ? accInfo.miniProgram.envVersion + accInfo.miniProgram.version
+      : "",
     carrier: "mini",
     ecology: "wechat",
   };
@@ -81,6 +84,8 @@ export function getAppInfo(result) {
     name: result.appName,
     version: version ? version : "",
     carrier: "app",
+    packageName: "",
+    ecology: "",
   };
   if (result.platform === "android") {
     let osName = "android";
@@ -88,47 +93,44 @@ export function getAppInfo(result) {
     if (result.romName.includes("HarmonyOS")) {
       osName = "harmonyOS";
     }
-    app = {
-      ...app,
-      packageName: pkName ? pkName : "",
-      ecology: osName,
-    };
+    app.packageName = pkName ? pkName : "";
+    app.ecology = osName;
   } else if (result.platform === "ios") {
     let pkName = plus.ios
       .importClass("NSBundle")
       .mainBundle()
       .bundleIdentifier();
-    app = {
-      ...app,
-      packageName: pkName ? pkName : "",
-      ecology: "ios",
-    };
+    app.packageName = pkName ? pkName : "";
+    app.ecology = "ios";
   } else {
-    app = {
-      ...app,
-      packageName: "",
-      version: "",
-      ecology: "unknown",
-    };
+    app.ecology = "unknown";
   }
   return app;
 }
 
-function getCurDeviceType(ua) {
-  const userAgent = ua.toLowerCase();
-  if (/(windows|win32|win64|wow64)/.test(userAgent)) {
-    return 1;
-  } else if (/(linux|android)/.test(userAgent)) {
-    return 2;
-  } else if (/(macintosh|mac os x|iphone|ipad|ipod)/.test(userAgent)) {
-    return 2;
+function getCurDeviceType(res, platform) {
+  if (platform !== "wx") {
+    const userAgent = res.ua.toLowerCase();
+    if (/(windows|win32|win64|wow64)/.test(userAgent)) {
+      return 1;
+    } else if (/(linux|android)/.test(userAgent)) {
+      return 2;
+    } else if (/(macintosh|mac os x|iphone|ipad|ipod)/.test(userAgent)) {
+      return 2;
+    } else {
+      return 2;
+    }
   } else {
-    return 2;
+    if (res.deviceType === "pc") {
+      return 1;
+    } else {
+      return 2;
+    }
   }
 }
 
 //获取设备信息
-export function getDeviceInfo(res) {
+export function getDeviceInfo(res, platform) {
   let device = {
     lang: res.osLanguage ? res.osLanguage : res.hostLanguage,
     brand: res.deviceBrand + " " + res.deviceModel,
@@ -139,7 +141,7 @@ export function getDeviceInfo(res) {
     browserVersion: res.browserVersion,
     color: "",
     deviceId: res.deviceId,
-    deviceType: getCurDeviceType(res.ua),
+    deviceType: getCurDeviceType(res, platform),
     network: "",
   };
   return device;
@@ -162,48 +164,35 @@ export function getDeviceInfoError() {
   };
 }
 
-//流量上报H5环境
-export function getTrackObj(busObj) {
-  //uni 通用h5、app、wx拿到当前路由栈
+//uni 通用h5、app、wx拿到当前路由栈
+export function getTrackObj(busObj, platform) {
   const pages = getCurrentPages();
   const gcp = pages[pages.length - 1];
-  //h5
-  let wl = window.location;
-  let docTitle = document.title;
-  let refurl = document.referrer;
-  let parsedUrl;
-  if (refurl) {
-    parsedUrl = new URL(refurl);
-  } else {
-    let busRefUrl = busObj.sourceUrl;
-    if (busRefUrl) {
-      parsedUrl = new URL(busRefUrl);
-    } else {
-      parsedUrl = "";
-    }
-  }
   if (gcp) {
-    let domain = "";
-    let url = "";
-    if (busObj.domain) {
-      domain = busObj.domain;
-    } else {
-      domain = wl.hostname ? wl.hostname : "";
-    }
-    if (busObj.url) {
-      url = busObj.url;
-    } else {
-      url = wl.href ? wl.href : "";
-    }
     return {
       path: gcp.route,
-      domain: domain,
-      url: url,
-      circulation: gcp.length > 1 ? 2 : 1,
-      visitPage: gcp.length,
-      sourceDomain: parsedUrl ? parsedUrl.hostname : "",
-      sourceUrl: parsedUrl,
-      title: docTitle ? docTitle : "",
+      domain: busObj.domain ? busObj.domain : "",
+      url: busObj.url ? busObj.url : getUrl(platform),
+      circulation: pages.length > 1 ? 2 : 1,
+      visitPage: pages.length,
+      sourceDomain: busObj.sourceDomain ? busObj.sourceDomain : "",
+      sourceUrl: busObj.sourceUrl ? busObj.sourceUrl : "",
+      title: busObj.title ? busObj.title : "",
     };
   }
 }
+
+export function getCurPath() {
+  const pages = getCurrentPages();
+  const gcp = pages[pages.length - 1];
+  return gcp ? gcp.route : "/";
+}
+
+export function getUrl(platform) {
+  if (!platform) return "";
+  if (platform === "web" || platform === "h5") {
+    return window.location.href;
+  } else {
+    return "";
+  }
+}