Merge pull request #264 from wakatime/get-project-name-only-from-vali…

…d-url

Properly check if a url match is a project / repository

package.json

@@ -38,6 +38,7 @@
     "idb": "^7.1.1",
     "jquery": "^3.6.3",
     "moment": "^2.29.4",
+    "node-html-parser": "^6.1.13",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-redux": "^8.0.5",

src/background.ts

@@ -1,6 +1,7 @@
 import browser from 'webextension-polyfill';
 import WakaTimeCore from './core/WakaTimeCore';
 import { PostHeartbeatMessage } from './types/heartbeats';
+import { getHtmlContentByTabId } from './utils';
 
 // Add a listener to resolve alarms
 browser.alarms.onAlarm.addListener(async (alarm) => {
@@ -22,9 +23,10 @@ browser.alarms.create('heartbeatAlarm', { periodInMinutes: 2 });
 /**
  * Whenever a active tab is changed it records a heartbeat with that tab url.
  */
-browser.tabs.onActivated.addListener(async () => {
+browser.tabs.onActivated.addListener(async (activeInfo) => {
   console.log('recording a heartbeat - active tab changed');
-  await WakaTimeCore.recordHeartbeat();
+  const html = await getHtmlContentByTabId(activeInfo.tabId);
+  await WakaTimeCore.recordHeartbeat(html);
 });
 
 /**
@@ -33,7 +35,17 @@ browser.tabs.onActivated.addListener(async () => {
 browser.windows.onFocusChanged.addListener(async (windowId) => {
   if (windowId != browser.windows.WINDOW_ID_NONE) {
     console.log('recording a heartbeat - active window changed');
-    await WakaTimeCore.recordHeartbeat();
+    const tabs: browser.Tabs.Tab[] = await browser.tabs.query({
+      active: true,
+      currentWindow: true,
+    });
+
+    let html = '';
+    const tabId = tabs[0]?.id;
+    if (tabId) {
+      html = await getHtmlContentByTabId(tabId);
+    }
+    await WakaTimeCore.recordHeartbeat(html);
   }
 });
 
@@ -50,7 +62,8 @@ browser.tabs.onUpdated.addListener(async (tabId, changeInfo) => {
     });
     // If tab updated is the same as active tab
     if (tabId == tabs[0]?.id) {
-      await WakaTimeCore.recordHeartbeat();
+      const html = await getHtmlContentByTabId(tabId);
+      await WakaTimeCore.recordHeartbeat(html);
     }
   }
 });
@@ -63,9 +76,12 @@ self.addEventListener('activate', async () => {
   await WakaTimeCore.createDB();
 });
 
-browser.runtime.onMessage.addListener(async (request: PostHeartbeatMessage) => {
+browser.runtime.onMessage.addListener(async (request: PostHeartbeatMessage, sender) => {
   if (request.recordHeartbeat === true) {
-    await WakaTimeCore.recordHeartbeat(request.projectDetails);
+    if (sender.tab?.id) {
+      const html = await getHtmlContentByTabId(sender.tab.id);
+      await WakaTimeCore.recordHeartbeat(html, request.projectDetails);
+    }
   }
 });
 

src/components/MainList.test.tsx

@@ -20,6 +20,7 @@ describe('MainList', () => {
     totalTimeLoggedToday = '1/1/1999';
   });
   it('should render properly', () => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const { container } = renderWithProviders(
       <MainList loggingEnabled={loggingEnabled} totalTimeLoggedToday={totalTimeLoggedToday} />,
     );

src/components/NavBar.test.tsx

@@ -14,6 +14,7 @@ jest.mock('webextension-polyfill', () => {
 
 describe('NavBar', () => {
   it('should render properly', () => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const { container } = renderWithProviders(<NavBar />);
     expect(container).toMatchInlineSnapshot(`
       <div>

src/core/WakaTimeCore.ts

@@ -112,7 +112,7 @@ class WakaTimeCore {
    * Depending on various factors detects the current active tab URL or domain,
    * and sends it to WakaTime for logging.
    */
-  async recordHeartbeat(payload: Record<string, unknown> = {}): Promise<void> {
+  async recordHeartbeat(html: string, payload: Record<string, unknown> = {}): Promise<void> {
     const apiKey = await getApiKey();
     if (!apiKey) {
       return changeExtensionState('notLogging');
@@ -164,7 +164,7 @@ class WakaTimeCore {
       }
 
       // Checks dev websites
-      const project = generateProjectFromDevSites(url);
+      const project = generateProjectFromDevSites(url, html);
 
       // Check if code reviewing
       const codeReviewing = isCodeReviewing(url);

src/manifests/chrome.json

@@ -32,6 +32,6 @@
   "options_ui": {
     "page": "options.html"
   },
-  "permissions": ["alarms", "tabs", "storage", "idle"],
+  "permissions": ["<all_urls>", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
   "version": "3.0.22"
 }

src/manifests/edge.json

@@ -32,6 +32,6 @@
   "options_ui": {
     "page": "options.html"
   },
-  "permissions": ["alarms", "tabs", "storage", "idle"],
+  "permissions": ["<all_urls>", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
   "version": "3.0.22"
 }

src/manifests/firefox.json

@@ -38,6 +38,6 @@
     "chrome_style": false,
     "page": "options.html"
   },
-  "permissions": ["<all_urls>", "alarms", "tabs", "storage", "idle"],
+  "permissions": ["<all_urls>", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
   "version": "3.0.22"
 }

src/options.tsx

@@ -3,10 +3,14 @@ import { createRoot } from 'react-dom/client';
 import Options from './components/Options';
 
 /* This is a fix for Bootstrap requiring jQuery */
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-expect-error
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 global.jQuery = require('jquery');
 require('bootstrap');
 
 const container = document.getElementById('wakatime-options');
-const root = createRoot(container!);
-
-root.render(<Options />);
+if (container) {
+  const root = createRoot(container);
+  root.render(<Options />);
+}

src/popup.tsx

@@ -8,12 +8,14 @@ import checkCurrentUser from './utils/checkCurrentUser';
 import 'bootstrap/dist/js/bootstrap';
 
 const container = document.getElementById('wakatime');
-const root = createRoot(container!);
-const store = createStore('WakaTime-Options');
-checkCurrentUser(store)(30 * 1000);
+if (container) {
+  const root = createRoot(container);
+  const store = createStore();
+  checkCurrentUser(store)(30 * 1000);
 
-root.render(
-  <Provider store={store}>
-    <WakaTime />
-  </Provider>,
-);
+  root.render(
+    <Provider store={store}>
+      <WakaTime />
+    </Provider>,
+  );
+}

src/types/heartbeats.ts

@@ -35,6 +35,7 @@ export interface SendHeartbeat {
 }
 
 export interface ProjectDetails {
+  [key: string]: string;
   category: string;
   editor: string;
   language: string;