statistics.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. /**
  2. * FeHelper数据统计模块
  3. * @author fehelper
  4. */
  5. import Awesome from './awesome.js';
  6. // 数据上报服务器地址
  7. let manifest = chrome.runtime.getManifest();
  8. let SERVER_TRACK_URL = '';
  9. if (manifest.name && manifest.name.endsWith('-Dev')) {
  10. // SERVER_TRACK_URL = 'http://localhost:3001/api/track';
  11. SERVER_TRACK_URL = 'https://chrome.fehelper.com/api/track';
  12. } else {
  13. SERVER_TRACK_URL = 'https://chrome.fehelper.com/api/track';
  14. }
  15. // 用户ID存储键名
  16. const USER_ID_KEY = 'FH_USER_ID';
  17. // 上次使用日期存储键名
  18. const LAST_ACTIVE_DATE_KEY = 'FH_LAST_ACTIVE_DATE';
  19. // 用户日常使用数据存储键名
  20. const USER_USAGE_DATA_KEY = 'FH_USER_USAGE_DATA';
  21. // 记录background启动时间
  22. const FH_TIME_OPENED = Date.now();
  23. let Statistics = (function() {
  24. // 用户唯一标识
  25. let userId = '';
  26. // 今天的日期字符串 YYYY-MM-DD
  27. let todayStr = new Date().toISOString().split('T')[0];
  28. // 本地存储的使用数据
  29. let usageData = {
  30. dailyUsage: {}, // 按日期存储的使用记录
  31. tools: {} // 各工具的使用次数
  32. };
  33. /**
  34. * 生成唯一的用户ID
  35. * @returns {string} 用户ID
  36. */
  37. const generateUserId = () => {
  38. return 'fh_' + Date.now() + '_' + Math.random().toString(36).substr(2, 9);
  39. };
  40. /**
  41. * 获取或创建用户ID
  42. * @returns {Promise<string>} 用户ID
  43. */
  44. const getUserId = async () => {
  45. if (userId) return userId;
  46. try {
  47. const result = await Awesome.StorageMgr.get(USER_ID_KEY);
  48. if (result) {
  49. userId = result;
  50. } else {
  51. userId = generateUserId();
  52. await Awesome.StorageMgr.set(USER_ID_KEY, userId);
  53. }
  54. return userId;
  55. } catch (error) {
  56. console.error('获取用户ID失败:', error);
  57. return generateUserId(); // 失败时生成临时ID
  58. }
  59. };
  60. /**
  61. * 加载本地存储的使用数据
  62. * @returns {Promise<void>}
  63. */
  64. const loadUsageData = async () => {
  65. try {
  66. const data = await Awesome.StorageMgr.get(USER_USAGE_DATA_KEY);
  67. if (data) {
  68. usageData = JSON.parse(data);
  69. }
  70. } catch (error) {
  71. console.error('加载使用数据失败:', error);
  72. }
  73. };
  74. /**
  75. * 保存使用数据到本地存储
  76. * @returns {Promise<void>}
  77. */
  78. const saveUsageData = async () => {
  79. try {
  80. await Awesome.StorageMgr.set(USER_USAGE_DATA_KEY, JSON.stringify(usageData));
  81. } catch (error) {
  82. console.error('保存使用数据失败:', error);
  83. }
  84. };
  85. /**
  86. * 获取客户端详细信息(仅background可用字段,兼容service worker环境,字段与服务端一致)
  87. * @returns {Object}
  88. */
  89. const getClientInfo = async () => {
  90. let tabInfo = {};
  91. try {
  92. // 获取当前活动tab的页面信息
  93. const tabs = await new Promise(resolve => {
  94. chrome.tabs.query({active: true, currentWindow: true}, resolve);
  95. });
  96. if (tabs && tabs.length > 0) {
  97. const tab = tabs[0];
  98. tabInfo = {
  99. pageUrl: tab.url || '',
  100. pageTitle: tab.title || ''
  101. };
  102. }
  103. } catch (e) {
  104. // 忽略tab获取异常
  105. }
  106. const nav = self.navigator || {};
  107. // 只采集服务端需要的字段
  108. return {
  109. userAgent: nav.userAgent || '',
  110. language: nav.language || '',
  111. platform: nav.platform || '',
  112. extensionVersion: chrome.runtime.getManifest().version,
  113. ...tabInfo
  114. };
  115. };
  116. /**
  117. * 使用自建服务器发送事件数据
  118. * @param {string} eventName - 事件名称
  119. * @param {Object} params - 事件参数
  120. */
  121. const sendToServer = async (eventName, params = {}) => {
  122. const uid = await getUserId();
  123. const clientInfo = await getClientInfo();
  124. // 只保留服务端 TrackSchema 需要的字段
  125. const payload = {
  126. event: eventName,
  127. userId: uid,
  128. ...clientInfo
  129. };
  130. // 只允许 TrackSchema 里的字段
  131. const allowedFields = [
  132. 'tool_name', 'extensionVersion', 'browser', 'browserVersion', 'os', 'osVersion',
  133. 'IP', 'country', 'province', 'city', 'pageUrl', 'pageTitle', 'language', 'platform'
  134. ];
  135. for (const key of allowedFields) {
  136. if (params[key] !== undefined) {
  137. payload[key] = params[key];
  138. }
  139. }
  140. try {
  141. fetch(SERVER_TRACK_URL, {
  142. method: 'POST',
  143. body: JSON.stringify(payload),
  144. headers: {
  145. 'Content-Type': 'application/json'
  146. },
  147. keepalive: true
  148. }).catch(e => console.log('自建统计服务器发送失败:', e));
  149. } catch (error) {
  150. console.log('自建统计发送失败:', error);
  151. }
  152. };
  153. /**
  154. * 记录每日活跃用户
  155. * @returns {Promise<void>}
  156. */
  157. const recordDailyActiveUser = async () => {
  158. try {
  159. // 获取上次活跃日期
  160. const lastActiveDate = await Awesome.StorageMgr.get(LAST_ACTIVE_DATE_KEY);
  161. // 如果今天还没有记录,则记录今天的活跃
  162. if (lastActiveDate !== todayStr) {
  163. await Awesome.StorageMgr.set(LAST_ACTIVE_DATE_KEY, todayStr);
  164. // 确保该日期的记录存在
  165. if (!usageData.dailyUsage[todayStr]) {
  166. usageData.dailyUsage[todayStr] = {
  167. date: todayStr,
  168. tools: {}
  169. };
  170. }
  171. // 发送每日活跃记录到自建服务器
  172. sendToServer('daily_active_user', {
  173. date: todayStr
  174. });
  175. }
  176. } catch (error) {
  177. console.error('记录日活跃用户失败:', error);
  178. }
  179. };
  180. /**
  181. * 记录插件安装事件
  182. */
  183. const recordInstallation = async () => {
  184. sendToServer('extension_installed');
  185. };
  186. /**
  187. * 记录插件更新事件
  188. * @param {string} previousVersion - 更新前的版本
  189. */
  190. const recordUpdate = async (previousVersion) => {
  191. sendToServer('extension_updated', {
  192. previous_version: previousVersion
  193. });
  194. };
  195. /**
  196. * 记录插件卸载事件
  197. */
  198. const recordUninstall = async () => {
  199. sendToServer('extension_uninstall');
  200. };
  201. /**
  202. * 记录工具使用情况
  203. * @param {string} toolName - 工具名称
  204. */
  205. const recordToolUsage = async (toolName, params = {}) => {
  206. // 确保今天的记录存在
  207. if (!usageData.dailyUsage[todayStr]) {
  208. usageData.dailyUsage[todayStr] = {
  209. date: todayStr,
  210. tools: {}
  211. };
  212. }
  213. // 增加工具使用计数
  214. if (!usageData.tools[toolName]) {
  215. usageData.tools[toolName] = 0;
  216. }
  217. usageData.tools[toolName]++;
  218. // 增加今天该工具的使用计数
  219. if (!usageData.dailyUsage[todayStr].tools[toolName]) {
  220. usageData.dailyUsage[todayStr].tools[toolName] = 0;
  221. }
  222. usageData.dailyUsage[todayStr].tools[toolName]++;
  223. // 保存使用数据
  224. await saveUsageData();
  225. // 发送工具使用记录到自建服务器
  226. sendToServer('tool_used', {
  227. tool_name: toolName,
  228. date: todayStr,
  229. ...params
  230. });
  231. };
  232. /**
  233. * 定期发送使用摘要数据
  234. */
  235. const scheduleSyncStats = () => {
  236. // 每周发送一次摘要数据
  237. const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
  238. setInterval(async () => {
  239. // 发送工具使用排名
  240. const toolRanking = Object.entries(usageData.tools)
  241. .sort((a, b) => b[1] - a[1])
  242. .slice(0, 5)
  243. .map(([name, count]) => ({name, count}));
  244. sendToServer('usage_summary', {
  245. top_tools: JSON.stringify(toolRanking)
  246. });
  247. // 清理过旧的日期数据(保留30天数据)
  248. const now = new Date();
  249. const thirtyDaysAgo = new Date(now.getTime() - 30 * 24 * 60 * 60 * 1000);
  250. const thirtyDaysAgoStr = thirtyDaysAgo.toISOString().split('T')[0];
  251. Object.keys(usageData.dailyUsage).forEach(date => {
  252. if (date < thirtyDaysAgoStr) {
  253. delete usageData.dailyUsage[date];
  254. }
  255. });
  256. // 保存清理后的数据
  257. await saveUsageData();
  258. }, ONE_WEEK);
  259. };
  260. /**
  261. * 初始化统计模块
  262. */
  263. const init = async () => {
  264. await getUserId();
  265. await loadUsageData();
  266. await recordDailyActiveUser();
  267. scheduleSyncStats();
  268. };
  269. /**
  270. * 获取最近使用的工具(按最近使用时间倒序,默认最近10个)
  271. * @param {number} limit - 返回的最大数量
  272. * @returns {Promise<string[]>} 工具名称数组
  273. */
  274. const getRecentUsedTools = async (limit = 10) => {
  275. // 确保数据已加载
  276. await loadUsageData();
  277. // 收集所有日期,按新到旧排序
  278. const dates = Object.keys(usageData.dailyUsage).sort((a, b) => b.localeCompare(a));
  279. const toolSet = [];
  280. for (const date of dates) {
  281. const tools = Object.keys(usageData.dailyUsage[date].tools || {});
  282. for (const tool of tools) {
  283. if (!toolSet.includes(tool)) {
  284. toolSet.push(tool);
  285. if (toolSet.length >= limit) {
  286. return toolSet;
  287. }
  288. }
  289. }
  290. }
  291. return toolSet;
  292. };
  293. /**
  294. * 获取DashBoard统计数据
  295. * @returns {Promise<Object>} 统计数据对象
  296. */
  297. const getDashboardData = async () => {
  298. await loadUsageData();
  299. // 最近10次使用的工具及时间
  300. const recent = [];
  301. const recentDetail = [];
  302. const dates = Object.keys(usageData.dailyUsage).sort((a, b) => b.localeCompare(a));
  303. for (const date of dates) {
  304. for (const tool of Object.keys(usageData.dailyUsage[date].tools || {})) {
  305. if (!recent.includes(tool)) {
  306. recent.push(tool);
  307. recentDetail.push({ tool, date });
  308. if (recent.length >= 10) break;
  309. }
  310. }
  311. if (recent.length >= 10) break;
  312. }
  313. // 工具使用总次数排行
  314. const mostUsed = Object.entries(usageData.tools)
  315. .sort((a, b) => b[1] - a[1])
  316. .slice(0, 10)
  317. .map(([name, count]) => ({ name, count }));
  318. const totalCount = Object.values(usageData.tools).reduce((a, b) => a + b, 0);
  319. const activeDays = Object.keys(usageData.dailyUsage).length;
  320. const allDates = Object.keys(usageData.dailyUsage).sort();
  321. // 最近10天每日使用情况
  322. const dailyTrend = allDates.slice(-10).map(date => ({
  323. date,
  324. count: Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0)
  325. }));
  326. // 首次和最近活跃日期
  327. const firstDate = allDates[0] || '';
  328. const lastDate = allDates[allDates.length - 1] || '';
  329. // 连续活跃天数
  330. let maxStreak = 0, curStreak = 0, prev = '';
  331. for (let i = 0; i < allDates.length; i++) {
  332. if (i === 0 || (new Date(allDates[i]) - new Date(prev) === 86400000)) {
  333. curStreak++;
  334. } else {
  335. maxStreak = Math.max(maxStreak, curStreak);
  336. curStreak = 1;
  337. }
  338. prev = allDates[i];
  339. }
  340. maxStreak = Math.max(maxStreak, curStreak);
  341. // 本月/本周统计
  342. const now = new Date();
  343. const thisMonth = now.toISOString().slice(0, 7);
  344. const thisWeekMonday = new Date(now.setDate(now.getDate() - now.getDay() + 1)).toISOString().slice(0, 10);
  345. let monthCount = 0, weekCount = 0;
  346. allDates.forEach(date => {
  347. const cnt = Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0);
  348. if (date.startsWith(thisMonth)) monthCount += cnt;
  349. if (date >= thisWeekMonday) weekCount += cnt;
  350. });
  351. // 平均每日使用次数
  352. const avgPerDay = activeDays ? Math.round(totalCount / activeDays * 10) / 10 : 0;
  353. // 最活跃的一天
  354. let maxDay = { date: '', count: 0 };
  355. allDates.forEach(date => {
  356. const cnt = Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0);
  357. if (cnt > maxDay.count) maxDay = { date, count: cnt };
  358. });
  359. // 最近未使用天数
  360. let daysSinceLast = 0;
  361. if (lastDate) {
  362. const diff = Math.floor((new Date() - new Date(lastDate)) / 86400000);
  363. daysSinceLast = diff > 0 ? diff : 0;
  364. }
  365. return {
  366. recent,
  367. recentDetail,
  368. mostUsed,
  369. totalCount,
  370. activeDays,
  371. dailyTrend,
  372. firstDate,
  373. lastDate,
  374. maxStreak,
  375. monthCount,
  376. weekCount,
  377. avgPerDay,
  378. maxDay,
  379. daysSinceLast,
  380. allDates
  381. };
  382. };
  383. return {
  384. init,
  385. recordInstallation,
  386. recordUpdate,
  387. recordToolUsage,
  388. getRecentUsedTools,
  389. getDashboardData,
  390. recordUninstall
  391. };
  392. })();
  393. export default Statistics;