Skip to content

Commit

Permalink
half way through refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
alanhamlett committed Aug 27, 2024
1 parent d5e94de commit d34c8ca
Show file tree
Hide file tree
Showing 13 changed files with 313 additions and 143 deletions.
2 changes: 1 addition & 1 deletion src/components/MainList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { configLogout, setLoggingEnabled } from '../reducers/configReducer';
import { userLogout } from '../reducers/currentUser';
import { ReduxSelector } from '../types/store';
import { User } from '../types/user';
import changeExtensionState from '../utils/changeExtensionState';
import changeExtensionState from '../utils/changeExtensionStatus';

export interface MainListProps {
loggingEnabled: boolean;
Expand Down
4 changes: 4 additions & 0 deletions src/components/Options.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ export default function Options(): JSX.Element {
apiKey: '',
apiUrl: config.apiUrl,
denyList: [],
extensionStatus: 'allGood',
hostname: '',
loading: false,
loggingEnabled: true,
loggingStyle: config.loggingStyle,
loggingType: config.loggingType,
socialMediaSites: config.socialMediaSites,
Expand Down Expand Up @@ -54,7 +56,9 @@ export default function Options(): JSX.Element {
apiKey: state.apiKey,
apiUrl: state.apiUrl,
denyList: state.denyList,
extensionStatus: state.extensionStatus,
hostname: state.hostname,
loggingEnabled: state.loggingEnabled,
loggingStyle: state.loggingStyle,
loggingType: state.loggingType,
socialMediaSites: state.socialMediaSites,
Expand Down
8 changes: 4 additions & 4 deletions src/components/WakaTime.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import NavBar from './NavBar';

export default function WakaTime(): JSX.Element {
const dispatch = useDispatch();
const [extensionState, setExtensionState] = useState('');
const [extensionStatus, setExtensionStatus] = useState('');

const {
apiKey: apiKeyFromRedux,
Expand All @@ -21,8 +21,8 @@ export default function WakaTime(): JSX.Element {
useEffect(() => {
const fetchData = async () => {
await fetchUserData(apiKeyFromRedux, dispatch);
const items = await browser.storage.sync.get({ extensionState: '' });
setExtensionState(items.extensionState as string);
const items = await browser.storage.sync.get({ extensionStatus: '' });
setExtensionStatus(items.extensionStatus as string);
};
void fetchData();
}, []);
Expand All @@ -32,7 +32,7 @@ export default function WakaTime(): JSX.Element {
return (
<div className="py-4 px-2 pt-0">
<NavBar />
{isApiKeyValid && extensionState === 'notSignedIn' && (
{isApiKeyValid && extensionStatus === 'notSignedIn' && (
<Alert
type={config.alert.failure.type}
text={'Invalid API key or API url'}
Expand Down
4 changes: 2 additions & 2 deletions src/config/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import browser from 'webextension-polyfill';
/**
* Logging
*/
export type ApiStates = 'allGood' | 'notLogging' | 'notSignedIn' | 'ignored';
export type ExtensionStatus = 'allGood' | 'notLogging' | 'notSignedIn' | 'ignored';
/**
* Supported logging style
*/
Expand Down Expand Up @@ -90,7 +90,7 @@ export interface Config {
name: string;
nonTrackableSites: string[];
socialMediaSites: string[];
states: ApiStates[];
states: ExtensionStatus[];
/**
* Get stats from the wakatime api
*/
Expand Down
111 changes: 61 additions & 50 deletions src/core/WakaTimeCore.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
import { IDBPDatabase, openDB } from 'idb';
import moment from 'moment';
import browser, { Tabs } from 'webextension-polyfill';
import { IS_EDGE, IS_FIREFOX, getOperatingSystem, isCodeReviewing } from '../utils';
import { getHeartbeatFromPage } from '../utils/heartbeat';
/* eslint-disable no-fallthrough */
/* eslint-disable default-case */
import moment from 'moment';
import { getOperatingSystem, isCodeReviewing } from '../utils';
import { changeExtensionStatus } from '../utils/changeExtensionStatus';
import getDomainFromUrl, { getDomain } from '../utils/getDomainFromUrl';
import { getSettings, Settings } from '../utils/settings';

import config from '../config/config';
import config, { ExtensionStatus } from '../config/config';
import { Heartbeat } from '../types/heartbeats';
import { getApiKey } from '../utils/apiKey';
import changeExtensionState from '../utils/changeExtensionState';
import contains from '../utils/contains';
import { getHeartbeatFromPage } from '../utils/heartbeat';
import { getLoggingType } from '../utils/logging';

class WakaTimeCore {
tabsWithDevtoolsOpen: Tabs.Tab[];
lastHeartbeat: Heartbeat | undefined;
lastHeartbeatSentAt = 0;
lastExtensionState: ExtensionStatus = 'allGood';
db: IDBPDatabase | undefined;
constructor() {
this.tabsWithDevtoolsOpen = [];
Expand Down Expand Up @@ -55,47 +57,56 @@ class WakaTimeCore {
return false;
}

async processHeartbeat(heartbeat: Heartbeat) {
const apiKey = await getApiKey();
if (!apiKey) return changeExtensionState('notLogging');
canSendHeartbeat(url: string, settings: Settings): boolean {
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(url: string, heartbeat: Heartbeat) {
const settings = await getSettings();
if (!settings.loggingEnabled) {
await changeExtensionStatus('notLogging');
return;
}

if (!this.shouldSendHeartbeat(heartbeat)) return;

if (items.loggingStyle == 'deny') {
if (!contains(url, items.denyList as string)) {
await this.sendHeartbeat(
{
branch: null,
hostname: items.hostname as string,
project,
url,
},
apiKey,
payload,
);
} else {
await changeExtensionState('ignored');
console.log(`${url} is on denyList.`);
}
} else if (items.loggingStyle == 'allow') {
const heartbeat = this.getHeartbeat(url, items.allowList as string);
if (heartbeat.url) {
await this.sendHeartbeat(
{
...heartbeat,
branch: null,
hostname: items.hostname as string,
project: heartbeat.project ?? project,
},
apiKey,
payload,
);
} else {
await changeExtensionState('ignored');
console.log(`${url} is not on allowList.`);
if (!this.canSendHeartbeat(url, settings)) {
await changeExtensionStatus('ignored');
return;
}

if (this.db) {
// append heartbeat to queue
await this.db.add('cacheHeartbeats', heartbeat);

if (settings.extensionStatus !== 'notSignedIn') {
await changeExtensionStatus('allGood');
}
} else {
throw Error(`Unknown logging styel: ${items.loggingStyle}`);
}
}

Expand All @@ -106,7 +117,7 @@ class WakaTimeCore {
async recordHeartbeat(html: string, payload: Record<string, unknown> = {}): Promise<void> {
const apiKey = await getApiKey();
if (!apiKey) {
return changeExtensionState('notLogging');
return changeExtensionStatus('notLogging');
}
const items = await browser.storage.sync.get({
allowList: '',
Expand All @@ -118,14 +129,14 @@ class WakaTimeCore {
trackSocialMedia: config.trackSocialMedia,
});
if (items.loggingEnabled === true) {
await changeExtensionState('allGood');
await changeExtensionStatus('allGood');

let newState = '';
// Detects we are running this code in the extension scope
if (browser.idle as browser.Idle.Static | undefined) {
newState = await browser.idle.queryState(config.detectionIntervalInSeconds);
if (newState !== 'active') {
return changeExtensionState('notLogging');
return changeExtensionStatus('notLogging');
}
}

Expand All @@ -150,7 +161,7 @@ class WakaTimeCore {
const hostname = getDomain(url);
if (!items.trackSocialMedia) {
if ((items.socialMediaSites as string[]).includes(hostname)) {
return changeExtensionState('ignored');
return changeExtensionStatus('ignored');
}
}

Expand All @@ -176,7 +187,7 @@ class WakaTimeCore {
payload,
);
} else {
await changeExtensionState('ignored');
await changeExtensionStatus('ignored');
console.log(`${url} is on denyList.`);
}
} else if (items.loggingStyle == 'allow') {
Expand All @@ -193,7 +204,7 @@ class WakaTimeCore {
payload,
);
} else {
await changeExtensionState('ignored');
await changeExtensionStatus('ignored');
console.log(`${url} is not on allowList.`);
}
} else {
Expand Down Expand Up @@ -374,7 +385,7 @@ class WakaTimeCore {
await this.db.add('cacheHeartbeats', payload);
}

await changeExtensionState('notSignedIn');
await changeExtensionStatus('notSignedIn');
}
}

Expand All @@ -385,7 +396,7 @@ class WakaTimeCore {
async sendCachedHeartbeatsRequest(): Promise<void> {
const apiKey = await getApiKey();
if (!apiKey) {
return changeExtensionState('notLogging');
return changeExtensionStatus('notLogging');
}

if (this.db) {
Expand Down
30 changes: 0 additions & 30 deletions src/utils/changeExtensionIcon.ts

This file was deleted.

31 changes: 0 additions & 31 deletions src/utils/changeExtensionState.ts

This file was deleted.

Loading

0 comments on commit d34c8ca

Please sign in to comment.