diff --git a/src/core/WakaTimeCore.ts b/src/core/WakaTimeCore.ts
index 67f3e44e..9c6f4f8a 100644
--- a/src/core/WakaTimeCore.ts
+++ b/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
= {}): Promise {
+ async recordHeartbeat(html: string, payload: Record = {}): Promise {
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);
diff --git a/src/manifests/chrome.json b/src/manifests/chrome.json
index 93c0d360..f5de4ef0 100644
--- a/src/manifests/chrome.json
+++ b/src/manifests/chrome.json
@@ -32,6 +32,6 @@
"options_ui": {
"page": "options.html"
},
- "permissions": ["alarms", "tabs", "storage", "idle"],
+ "permissions": ["", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
"version": "3.0.22"
}
diff --git a/src/manifests/edge.json b/src/manifests/edge.json
index f111d83e..c8a3b6f6 100644
--- a/src/manifests/edge.json
+++ b/src/manifests/edge.json
@@ -32,6 +32,6 @@
"options_ui": {
"page": "options.html"
},
- "permissions": ["alarms", "tabs", "storage", "idle"],
+ "permissions": ["", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
"version": "3.0.22"
}
diff --git a/src/manifests/firefox.json b/src/manifests/firefox.json
index fc18db29..c8563d98 100644
--- a/src/manifests/firefox.json
+++ b/src/manifests/firefox.json
@@ -38,6 +38,6 @@
"chrome_style": false,
"page": "options.html"
},
- "permissions": ["", "alarms", "tabs", "storage", "idle"],
+ "permissions": ["", "alarms", "tabs", "storage", "idle", "activeTab", "scripting"],
"version": "3.0.22"
}
diff --git a/src/options.tsx b/src/options.tsx
index ab0582d0..c9c8c725 100644
--- a/src/options.tsx
+++ b/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();
+if (container) {
+ const root = createRoot(container);
+ root.render();
+}
diff --git a/src/popup.tsx b/src/popup.tsx
index 78d68c37..80187f3d 100644
--- a/src/popup.tsx
+++ b/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(
-
-
- ,
-);
+ root.render(
+
+
+ ,
+ );
+}
diff --git a/src/types/heartbeats.ts b/src/types/heartbeats.ts
index 4897eaa2..21fbac2f 100644
--- a/src/types/heartbeats.ts
+++ b/src/types/heartbeats.ts
@@ -35,6 +35,7 @@ export interface SendHeartbeat {
}
export interface ProjectDetails {
+ [key: string]: string;
category: string;
editor: string;
language: string;
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 11217c9d..0be4a51d 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -1,33 +1,146 @@
+import { parse } from 'node-html-parser';
+
export const IS_EDGE = navigator.userAgent.includes('Edg');
export const IS_FIREFOX = navigator.userAgent.includes('Firefox');
export const IS_CHROME = IS_EDGE === false && IS_FIREFOX === false;
-const REG_LIST = [
- // GitHub. Eg. URL: https://github.com/workspace-name/project-name
- /(?<=github\.(?:com|dev)\/[^/]+\/)([^/?#]+)/,
- // Gitlab. Eg. URL: https://gitlab.com/workspace-name/project-name
- /(?<=gitlab\.com\/[^/]+\/)([^/?#]+)/,
- // BitBucket. Eg. URL: https://bitbucket.org/workspace-name/project-name/src
- /(?<=bitbucket\.org\/[^/]+\/)([^/?#]+)/,
- // Travis CI. Eg. URL: https://app.travis-ci.com/github/workspace-name/project-name/no-build?serverType=git
- /(?<=app\.travis-ci\.com\/[^/]+\/[^/]+\/)([^/?#]+)/,
- // Circle CI. Eg. URL: https://app.circleci.com/projects/project-setup/github/workspace-name/project-name/
- /(?<=app\.circleci\.com\/projects\/[^/]+\/[^/]+\/[^/]+\/)([^/?#]+)/,
- // Vercel. Eg. URL: http://vercel.com/team-name/project-name
- /(?<=vercel\.com\/[^/]+\/)([^/?#]+)/,
-];
+type ProjectNameExtractor = (url: string, html: string) => string | null;
+
+const GitHub: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const { hostname } = new URL(url);
+ const match = url.match(/(?<=github\.(?:com|dev)\/[^/]+\/)([^/?#]+)/);
+
+ if (match) {
+ if (hostname.endsWith('.com')) {
+ const root = parse(html);
+ const repoName = root
+ .querySelector('meta[name=octolytics-dimension-repository_nwo]')
+ ?.getAttribute('content');
+ if (!repoName || repoName.split('/')[1] !== match[0]) {
+ return null;
+ }
+ }
+ return match[0];
+ }
+
+ return null;
+};
+
+const GitLab: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const match = url.match(/(?<=gitlab\.com\/[^/]+\/)([^/?#]+)/);
+
+ if (match) {
+ const root = parse(html);
+ const repoName = root.querySelector('body')?.getAttribute('data-project-full-path');
+ if (!repoName || repoName.split('/')[1] !== match[0]) {
+ return null;
+ }
+ return match[0];
+ }
+
+ return null;
+};
-export const generateProjectFromDevSites = (url: string): string | null => {
- let match: RegExpMatchArray | null = null;
+const BitBucket: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const match = url.match(/(?<=bitbucket\.org\/[^/]+\/)([^/?#]+)/);
- for (const reg of REG_LIST) {
- match = url.match(reg);
- if (match) {
- break;
+ if (match) {
+ const root = parse(html);
+ // this regex extracts the project name from the title
+ // eg. title: jhondoe / my-test-repo — Bitbucket
+ const match2 = root.querySelector('title')?.textContent.match(/(?<=\/\s)([^/\s]+)(?=\s—)/);
+ if (match2 && match2[0] === match[0]) {
+ return match[0];
}
}
- return match?.[0] ?? null;
+ return null;
+};
+
+const TravisCI: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const match = url.match(/(?<=app\.travis-ci\.com\/[^/]+\/[^/]+\/)([^/?#]+)/);
+
+ if (match) {
+ const root = parse(html);
+ const projectName = root.querySelector('#ember737')?.textContent;
+ if (projectName === match[0]) {
+ return match[0];
+ }
+ }
+
+ return null;
+};
+
+const CircleCI: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const projectPageMatch = url.match(
+ /(?<=app\.circleci\.com\/projects\/[^/]+\/[^/]+\/[^/]+\/)([^/?#]+)/,
+ );
+
+ if (projectPageMatch) {
+ const root = parse(html);
+ const seconndBreadcrumbLabel = root.querySelector(
+ '#__next > div:nth-child(2) > div > div > main > div > header > div:nth-child(1) > ol > li:nth-child(2) > div > div > span',
+ )?.textContent;
+ const seconndBreadcrumbValue = root.querySelector(
+ '#__next > div:nth-child(2) > div > div > main > div > header > div:nth-child(1) > ol > li:nth-child(2) > div > span',
+ )?.textContent;
+ if (seconndBreadcrumbLabel === 'Project' && seconndBreadcrumbValue === projectPageMatch[0]) {
+ return projectPageMatch[0];
+ }
+ }
+
+ const settingsPageMatch = url.match(
+ /(?<=app\.circleci\.com\/settings\/project\/[^/]+\/[^/]+\/)([^/?#]+)/,
+ );
+ if (settingsPageMatch) {
+ const root = parse(html);
+ const pageTitle = root.querySelector(
+ '#__next > div > div:nth-child(1) > header > div > div:nth-child(2) > h1',
+ )?.textContent;
+ const pageSubtitle = root.querySelector(
+ '#__next > div > div:nth-child(1) > header > div > div:nth-child(2) > div',
+ )?.textContent;
+ if (pageTitle === 'Project Settings' && pageSubtitle === settingsPageMatch[0]) {
+ return settingsPageMatch[0];
+ }
+ }
+
+ return null;
+};
+
+const Vercel: ProjectNameExtractor = (url: string, html: string): string | null => {
+ const match = url.match(/(?<=vercel\.com\/[^/]+\/)([^/?#]+)/);
+
+ if (match) {
+ const root = parse(html);
+ // this regex extracts the project name from the title
+ // eg. title: test-website - Overview – Vercel
+ const match2 = root.querySelector('title')?.textContent.match(/^[^\s]+(?=\s-\s)/);
+ if (match2 && match2[0] === match[0]) {
+ return match[0];
+ }
+ }
+
+ return null;
+};
+
+const ProjectNameExtractors: ProjectNameExtractor[] = [
+ GitHub,
+ GitLab,
+ BitBucket,
+ TravisCI,
+ CircleCI,
+ Vercel,
+];
+
+export const generateProjectFromDevSites = (url: string, html: string): string | null => {
+ for (const projectNameExtractor of ProjectNameExtractors) {
+ const projectName = projectNameExtractor(url, html);
+ if (projectName) {
+ return projectName;
+ }
+ }
+ return null;
};
const CODE_REVIEW_URL_REG_LIST = [/github.com\/[^/]+\/[^/]+\/pull\/\d+\/files/];
@@ -40,3 +153,10 @@ export const isCodeReviewing = (url: string): boolean => {
}
return false;
};
+
+export const getHtmlContentByTabId = async (tabId: number): Promise => {
+ const response = (await browser.tabs.sendMessage(tabId, { message: 'get_html' })) as {
+ html: string;
+ };
+ return response.html;
+};
diff --git a/src/utils/test-utils.tsx b/src/utils/test-utils.tsx
index d472da34..c5e21b88 100644
--- a/src/utils/test-utils.tsx
+++ b/src/utils/test-utils.tsx
@@ -1,14 +1,14 @@
-import React, { PropsWithChildren } from 'react';
-import { render } from '@testing-library/react';
-import type { RenderOptions } from '@testing-library/react';
-import { combineReducers, configureStore, Store } from '@reduxjs/toolkit';
import type { PreloadedState } from '@reduxjs/toolkit';
+import { combineReducers, configureStore, Store } from '@reduxjs/toolkit';
+import type { RenderOptions } from '@testing-library/react';
+import { render } from '@testing-library/react';
+import React, { PropsWithChildren } from 'react';
import { Provider } from 'react-redux';
import { RootState } from '../stores/createStore';
// As a basic setup, import your same slice reducers
-import userReducer, { initialState as InitalCurrentUser } from '../reducers/currentUser';
import configReducer, { initialConfigState } from '../reducers/configReducer';
+import userReducer, { initialState as InitalCurrentUser } from '../reducers/currentUser';
// This type interface extends the default options for render from RTL, as well
// as allows the user to specify other things such as initialState, store.
@@ -33,6 +33,7 @@ export function renderWithProviders(
store = configureStore({ preloadedState, reducer: rootReducer }),
...renderOptions
}: ExtendedRenderOptions = {},
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
): any {
function Wrapper({ children }: PropsWithChildren>): JSX.Element {
return {children};
diff --git a/src/utils/user.ts b/src/utils/user.ts
index 1eac8052..152fc11b 100644
--- a/src/utils/user.ts
+++ b/src/utils/user.ts
@@ -1,8 +1,9 @@
import { AnyAction, Dispatch } from '@reduxjs/toolkit';
-import { setApiKey, setLoggingEnabled, setTotalTimeLoggedToday } from '../reducers/configReducer';
import config from '../config/config';
import WakaTimeCore from '../core/WakaTimeCore';
+import { setApiKey, setLoggingEnabled, setTotalTimeLoggedToday } from '../reducers/configReducer';
import { setUser } from '../reducers/currentUser';
+import { getHtmlContentByTabId } from '.';
import changeExtensionState from './changeExtensionState';
export const logUserIn = async (apiKey: string): Promise => {
@@ -65,7 +66,17 @@ export const fetchUserData = async (
dispatch(setLoggingEnabled(items.loggingEnabled as boolean));
dispatch(setTotalTimeLoggedToday(totalTimeLoggedTodayResponse.text));
- await WakaTimeCore.recordHeartbeat();
+ const tabs = 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);
} catch (err: unknown) {
await changeExtensionState('notSignedIn');
}
diff --git a/src/wakatimeScript.ts b/src/wakatimeScript.ts
index 63649fbc..3addfdeb 100644
--- a/src/wakatimeScript.ts
+++ b/src/wakatimeScript.ts
@@ -83,3 +83,9 @@ document.body.addEventListener(
debounce(() => init()),
true,
);
+
+chrome.runtime.onMessage.addListener((request: { message: string }, sender, sendResponse) => {
+ if (request.message === 'get_html') {
+ sendResponse({ html: document.documentElement.outerHTML });
+ }
+});
diff --git a/tsconfig.json b/tsconfig.json
index 6b1da8d5..e76c4d5f 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -13,7 +13,8 @@
"outDir": "lib",
"lib": ["es2015", "es2016", "es2017", "dom"],
"baseUrl": "./",
- "paths": {}
+ "paths": {},
+ "strictNullChecks": true
},
"exclude": []
}