statistics.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  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. const nav = self.navigator || {};
  91. // 只采集服务端需要的字段
  92. return {
  93. userAgent: nav.userAgent || '',
  94. language: nav.language || '',
  95. platform: nav.platform || '',
  96. extensionVersion: chrome.runtime.getManifest().version
  97. };
  98. };
  99. /**
  100. * 判断是否允许统计
  101. * @returns {Promise<boolean>} true=允许,false=禁止
  102. */
  103. const isStatisticsAllowed = async () => {
  104. try {
  105. const forbid = await Awesome.StorageMgr.get('FORBID_STATISTICS');
  106. return !(forbid === true || forbid === 'true');
  107. } catch (e) {
  108. return true;
  109. }
  110. };
  111. /**
  112. * 使用自建服务器发送事件数据
  113. * @param {string} eventName - 事件名称
  114. * @param {Object} params - 事件参数
  115. */
  116. const sendToServer = async (eventName, params = {}) => {
  117. return ''; // 暂时关闭统计
  118. if (!(await isStatisticsAllowed())) return;
  119. const uid = await getUserId();
  120. const clientInfo = await getClientInfo();
  121. // 只保留服务端 TrackSchema 需要的字段
  122. const payload = {
  123. event: eventName,
  124. userId: uid,
  125. ...clientInfo
  126. };
  127. // 只允许 TrackSchema 里的字段
  128. const allowedFields = [
  129. 'tool_name', 'extensionVersion', 'browser', 'browserVersion', 'os', 'osVersion', 'IP', 'language', 'platform'
  130. ];
  131. for (const key of allowedFields) {
  132. if (params[key] !== undefined) {
  133. payload[key] = params[key];
  134. }
  135. }
  136. try {
  137. fetch(SERVER_TRACK_URL, {
  138. method: 'POST',
  139. body: JSON.stringify(payload),
  140. headers: {
  141. 'Content-Type': 'application/json'
  142. },
  143. keepalive: true
  144. }).catch(e => console.log('自建统计服务器发送失败:', e));
  145. } catch (error) {
  146. console.log('自建统计发送失败:', error);
  147. }
  148. };
  149. /**
  150. * 记录每日活跃用户
  151. * @returns {Promise<void>}
  152. */
  153. const recordDailyActiveUser = async () => {
  154. try {
  155. // 获取上次活跃日期
  156. const lastActiveDate = await Awesome.StorageMgr.get(LAST_ACTIVE_DATE_KEY);
  157. // 如果今天还没有记录,则记录今天的活跃
  158. if (lastActiveDate !== todayStr) {
  159. await Awesome.StorageMgr.set(LAST_ACTIVE_DATE_KEY, todayStr);
  160. // 确保该日期的记录存在
  161. if (!usageData.dailyUsage[todayStr]) {
  162. usageData.dailyUsage[todayStr] = {
  163. date: todayStr,
  164. tools: {}
  165. };
  166. }
  167. // 发送每日活跃记录到自建服务器
  168. sendToServer('daily_active_user', {
  169. date: todayStr
  170. });
  171. }
  172. } catch (error) {
  173. console.error('记录日活跃用户失败:', error);
  174. }
  175. };
  176. /**
  177. * 记录插件安装事件
  178. */
  179. const recordInstallation = async () => {
  180. sendToServer('extension_installed');
  181. };
  182. /**
  183. * 记录插件更新事件
  184. * @param {string} previousVersion - 更新前的版本
  185. */
  186. const recordUpdate = async (previousVersion) => {
  187. sendToServer('extension_updated', {
  188. previous_version: previousVersion
  189. });
  190. };
  191. /**
  192. * 记录插件卸载事件
  193. */
  194. const recordUninstall = async () => {
  195. sendToServer('extension_uninstall');
  196. };
  197. /**
  198. * 记录工具使用情况
  199. * @param {string} toolName - 工具名称
  200. */
  201. const recordToolUsage = async (toolName, params = {}) => {
  202. // 确保今天的记录存在
  203. if (!usageData.dailyUsage[todayStr]) {
  204. usageData.dailyUsage[todayStr] = {
  205. date: todayStr,
  206. tools: {}
  207. };
  208. }
  209. // 增加工具使用计数
  210. if (!usageData.tools[toolName]) {
  211. usageData.tools[toolName] = 0;
  212. }
  213. usageData.tools[toolName]++;
  214. // 增加今天该工具的使用计数
  215. if (!usageData.dailyUsage[todayStr].tools[toolName]) {
  216. usageData.dailyUsage[todayStr].tools[toolName] = 0;
  217. }
  218. usageData.dailyUsage[todayStr].tools[toolName]++;
  219. // 保存使用数据
  220. await saveUsageData();
  221. // 发送工具使用记录到自建服务器
  222. sendToServer('tool_used', {
  223. tool_name: toolName,
  224. date: todayStr,
  225. ...params
  226. });
  227. };
  228. /**
  229. * 定期发送使用摘要数据
  230. */
  231. const scheduleSyncStats = () => {
  232. // 每周发送一次摘要数据
  233. const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
  234. setInterval(async () => {
  235. // 发送工具使用排名
  236. const toolRanking = Object.entries(usageData.tools)
  237. .sort((a, b) => b[1] - a[1])
  238. .slice(0, 5)
  239. .map(([name, count]) => ({name, count}));
  240. sendToServer('usage_summary', {
  241. top_tools: JSON.stringify(toolRanking)
  242. });
  243. // 清理过旧的日期数据(保留30天数据)
  244. const now = new Date();
  245. const thirtyDaysAgo = new Date(now.getTime() - 30 * 24 * 60 * 60 * 1000);
  246. const thirtyDaysAgoStr = thirtyDaysAgo.toISOString().split('T')[0];
  247. Object.keys(usageData.dailyUsage).forEach(date => {
  248. if (date < thirtyDaysAgoStr) {
  249. delete usageData.dailyUsage[date];
  250. }
  251. });
  252. // 保存清理后的数据
  253. await saveUsageData();
  254. }, ONE_WEEK);
  255. };
  256. /**
  257. * 初始化统计模块
  258. */
  259. const init = async () => {
  260. await getUserId();
  261. await loadUsageData();
  262. await recordDailyActiveUser();
  263. scheduleSyncStats();
  264. };
  265. /**
  266. * 获取最近使用的工具(按最近使用时间倒序,默认最近10个)
  267. * @param {number} limit - 返回的最大数量
  268. * @returns {Promise<string[]>} 工具名称数组
  269. */
  270. const getRecentUsedTools = async (limit = 10) => {
  271. // 确保数据已加载
  272. await loadUsageData();
  273. // 收集所有日期,按新到旧排序
  274. const dates = Object.keys(usageData.dailyUsage).sort((a, b) => b.localeCompare(a));
  275. const toolSet = [];
  276. for (const date of dates) {
  277. const tools = Object.keys(usageData.dailyUsage[date].tools || {});
  278. for (const tool of tools) {
  279. if (!toolSet.includes(tool)) {
  280. toolSet.push(tool);
  281. if (toolSet.length >= limit) {
  282. return toolSet;
  283. }
  284. }
  285. }
  286. }
  287. return toolSet;
  288. };
  289. /**
  290. * 获取DashBoard统计数据
  291. * @returns {Promise<Object>} 统计数据对象
  292. */
  293. const getDashboardData = async () => {
  294. await loadUsageData();
  295. // 最近10次使用的工具及时间
  296. const recent = [];
  297. const recentDetail = [];
  298. const dates = Object.keys(usageData.dailyUsage).sort((a, b) => b.localeCompare(a));
  299. for (const date of dates) {
  300. for (const tool of Object.keys(usageData.dailyUsage[date].tools || {})) {
  301. if (!recent.includes(tool)) {
  302. recent.push(tool);
  303. recentDetail.push({ tool, date });
  304. if (recent.length >= 10) break;
  305. }
  306. }
  307. if (recent.length >= 10) break;
  308. }
  309. // 工具使用总次数排行
  310. const mostUsed = Object.entries(usageData.tools)
  311. .sort((a, b) => b[1] - a[1])
  312. .slice(0, 10)
  313. .map(([name, count]) => ({ name, count }));
  314. const totalCount = Object.values(usageData.tools).reduce((a, b) => a + b, 0);
  315. const activeDays = Object.keys(usageData.dailyUsage).length;
  316. const allDates = Object.keys(usageData.dailyUsage).sort();
  317. // 最近10天每日使用情况
  318. const dailyTrend = allDates.slice(-10).map(date => ({
  319. date,
  320. count: Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0)
  321. }));
  322. // 首次和最近活跃日期
  323. const firstDate = allDates[0] || '';
  324. const lastDate = allDates[allDates.length - 1] || '';
  325. // 连续活跃天数
  326. let maxStreak = 0, curStreak = 0, prev = '';
  327. for (let i = 0; i < allDates.length; i++) {
  328. if (i === 0 || (new Date(allDates[i]) - new Date(prev) === 86400000)) {
  329. curStreak++;
  330. } else {
  331. maxStreak = Math.max(maxStreak, curStreak);
  332. curStreak = 1;
  333. }
  334. prev = allDates[i];
  335. }
  336. maxStreak = Math.max(maxStreak, curStreak);
  337. // 本月/本周统计
  338. const now = new Date();
  339. const thisMonth = now.toISOString().slice(0, 7);
  340. const thisWeekMonday = new Date(now.setDate(now.getDate() - now.getDay() + 1)).toISOString().slice(0, 10);
  341. let monthCount = 0, weekCount = 0;
  342. allDates.forEach(date => {
  343. const cnt = Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0);
  344. if (date.startsWith(thisMonth)) monthCount += cnt;
  345. if (date >= thisWeekMonday) weekCount += cnt;
  346. });
  347. // 平均每日使用次数
  348. const avgPerDay = activeDays ? Math.round(totalCount / activeDays * 10) / 10 : 0;
  349. // 最活跃的一天
  350. let maxDay = { date: '', count: 0 };
  351. allDates.forEach(date => {
  352. const cnt = Object.values(usageData.dailyUsage[date].tools || {}).reduce((a, b) => a + b, 0);
  353. if (cnt > maxDay.count) maxDay = { date, count: cnt };
  354. });
  355. // 最近未使用天数
  356. let daysSinceLast = 0;
  357. if (lastDate) {
  358. const diff = Math.floor((new Date() - new Date(lastDate)) / 86400000);
  359. daysSinceLast = diff > 0 ? diff : 0;
  360. }
  361. return {
  362. recent,
  363. recentDetail,
  364. mostUsed,
  365. totalCount,
  366. activeDays,
  367. dailyTrend,
  368. firstDate,
  369. lastDate,
  370. maxStreak,
  371. monthCount,
  372. weekCount,
  373. avgPerDay,
  374. maxDay,
  375. daysSinceLast,
  376. allDates
  377. };
  378. };
  379. return {
  380. init,
  381. recordInstallation,
  382. recordUpdate,
  383. recordToolUsage,
  384. getRecentUsedTools,
  385. getDashboardData,
  386. recordUninstall
  387. };
  388. })();
  389. export default Statistics;