import { IDBPDatabase, openDB } from 'idb'; import browser, { Tabs } from 'webextension-polyfill'; /* eslint-disable no-fallthrough */ /* eslint-disable default-case */ import moment from 'moment'; import { SiteInfo } from 'src/types/sites'; import { getOperatingSystem } from '../utils'; import { changeExtensionStatus } from '../utils/changeExtensionStatus'; import getDomainFromUrl, { getDomain } from '../utils/getDomainFromUrl'; import { getSettings, Settings } from '../utils/settings'; import config, { ExtensionStatus } from '../config/config'; import { EntityType, Heartbeat } from '../types/heartbeats'; import { getApiKey } from '../utils/apiKey'; import { getLoggingType } from '../utils/logging'; class WakaTimeCore { tabsWithDevtoolsOpen: Tabs.Tab[]; lastHeartbeat: Heartbeat | undefined; lastHeartbeatSentAt = 0; lastExtensionState: ExtensionStatus = 'allGood'; db: IDBPDatabase | undefined; constructor() { this.tabsWithDevtoolsOpen = []; } /** * Creates a IndexDB using idb https://github.com/jakearchibald/idb * a library that adds promises to IndexedDB and makes it easy to use */ async createDB() { const dbConnection = await openDB('wakatime', 1, { upgrade(db, oldVersion) { // Create a store of objects const store = db.createObjectStore('cacheHeartbeats', { // The `time` property of the object will be the key, and be incremented automatically keyPath: 'time', }); // Switch over the oldVersion, *without breaks*, to allow the database to be incrementally upgraded. switch (oldVersion) { case 0: // Placeholder to execute when database is created (oldVersion is 0) case 1: // Create an index called `type` based on the `type` property of objects in the store store.createIndex('time', 'time'); } }, }); this.db = dbConnection; } shouldSendHeartbeat(heartbeat: Heartbeat): boolean { if (!this.lastHeartbeat) return true; if (this.lastHeartbeat.entity !== heartbeat.entity) return true; if (this.lastHeartbeatSentAt + 120000 < Date.now()) return true; return false; } canSendHeartbeat(url: string, settings: Settings): boolean { for (const site of config.nonTrackableSites) { if (url.startsWith(site)) { // Don't send a heartbeat on sites like 'chrome://newtab/' or 'about:newtab' return false; } } if (!settings.trackSocialMedia) { const domain = getDomain(url); if ( settings.socialMediaSites.find((pattern) => { const re = new RegExp(pattern.replace(/\*/g, '.*')); return re.test(domain); }) !== undefined ) { return false; } } if (settings.loggingStyle === 'deny') { return ( settings.denyList.find((pattern) => { const re = new RegExp(pattern.replace(/\*/g, '.*')); return re.test(url); }) == undefined ); } return ( settings.allowList.find((pattern) => { const re = new RegExp(pattern.replace(/\*/g, '.*')); return re.test(url); }) !== undefined ); } async handleActivity(tabId: number) { const settings = await getSettings(); if (!settings.loggingEnabled) { await changeExtensionStatus('notLogging'); return; } const activeTab = await this.getCurrentTab(tabId); if (!activeTab) return; const url = activeTab.url as string; if (!this.canSendHeartbeat(url, settings)) { await changeExtensionStatus('ignored'); return; } if (settings.extensionStatus !== 'notSignedIn') { await changeExtensionStatus('allGood'); } const heartbeat = await this.buildHeartbeat(url, settings, activeTab); if (!this.shouldSendHeartbeat(heartbeat)) return; // append heartbeat to queue await this.db?.add('cacheHeartbeats', heartbeat); } async getCurrentTab(tabId: number): Promise { const tabs: browser.Tabs.Tab[] = await browser.tabs.query({ active: true, currentWindow: true, }); const activeTab = tabs[0]; if (tabId !== activeTab.id) return; return activeTab; } async buildHeartbeat(url: string, settings: Settings, tab: browser.Tabs.Tab): Promise { if (!tab.id) { throw Error('Missing tab id.'); } const heartbeat = ( (await browser.tabs.sendMessage(tab.id, { task: 'getHeartbeatFromPage', url })) as { heartbeat?: SiteInfo; } ).heartbeat; const entity = settings.loggingType === 'domain' ? getDomainFromUrl(url) : url; return { branch: heartbeat?.branch, category: heartbeat?.category, entity: heartbeat?.entity ?? entity, entityType: heartbeat?.entityType ?? (settings.loggingType as EntityType), language: heartbeat?.language, project: heartbeat?.project, }; } /** * Given the heartbeat and logging type it creates a payload and * sends an ajax post request to the API. * * @param heartbeat * @param debug */ async sendHeartbeat( heartbeat: Heartbeat, apiKey: string, navigationPayload: Record, ): Promise { console.log('Sending Heartbeat', heartbeat); let payload; const loggingType = await getLoggingType(); // Get only the domain from the entity. // And send that in heartbeat if (loggingType == 'domain') { heartbeat.url = getDomainFromUrl(heartbeat.url); payload = await this.preparePayload(heartbeat, 'domain'); await this.sendPostRequestToApi( { ...payload, ...navigationPayload }, apiKey, heartbeat.hostname, ); } // Send entity in heartbeat else if (loggingType == 'url') { payload = await this.preparePayload(heartbeat, 'url'); await this.sendPostRequestToApi( { ...payload, ...navigationPayload }, apiKey, heartbeat.hostname, ); } } /** * Creates payload for the heartbeat and returns it as JSON. * * @param heartbeat * @param type * @param debug * @returns {*} * @private */ async preparePayload(heartbeat: Heartbeat, type: string): Promise> { const os = await getOperatingSystem(); let browserName = 'chrome'; let userAgent; if (IS_FIREFOX) { browserName = 'firefox'; userAgent = navigator.userAgent.match(/Firefox\/\S+/g)?.[0]; } else if (IS_EDGE) { browserName = 'edge'; userAgent = navigator.userAgent; } else { userAgent = navigator.userAgent.match(/Chrome\/\S+/g)?.[0]; } const payload: Record = { entity: heartbeat.url, time: moment().format('X'), type: type, user_agent: `${userAgent} ${os} ${browserName}-wakatime/${config.version}`, }; payload.project = heartbeat.project ?? '<>'; payload.branch = heartbeat.branch ?? '<>'; return payload; } /** * Sends AJAX request with payload to the heartbeat API as JSON. * * @param payload * @param method * @returns {*} */ async sendPostRequestToApi( payload: Record, apiKey = '', hostname = '', ): Promise { try { const items = await browser.storage.sync.get({ apiUrl: config.apiUrl, heartbeatApiEndPoint: config.heartbeatApiEndPoint, }); const request: RequestInit = { body: JSON.stringify(payload), credentials: 'omit', method: 'POST', }; if (hostname) { request.headers = { 'X-Machine-Name': hostname, }; } const response = await fetch( `${items.apiUrl}${items.heartbeatApiEndPoint}?api_key=${apiKey}`, request, ); await response.json(); } catch (err: unknown) { if (this.db) { await this.db.add('cacheHeartbeats', payload); } await changeExtensionStatus('notSignedIn'); } } /** * Sends cached heartbeats request to wakatime api * @param requests */ async sendCachedHeartbeatsRequest(): Promise { const apiKey = await getApiKey(); if (!apiKey) { return changeExtensionStatus('notLogging'); } if (this.db) { const requests = await this.db.getAll('cacheHeartbeats'); await this.db.clear('cacheHeartbeats'); const chunkSize = 50; // Create batches of max 50 request for (let i = 0; i < requests.length; i += chunkSize) { const chunk = requests.slice(i, i + chunkSize); const requestsPromises: Promise[] = []; chunk.forEach((request: Record) => requestsPromises.push(this.sendPostRequestToApi(request, apiKey)), ); try { await Promise.all(requestsPromises); } catch (error: unknown) { console.log('Error sending heartbeats'); } } } } } export default new WakaTimeCore();