Updated test console. Refactored fetch for tracker.

This commit is contained in:
Mike Cao 2022-08-09 10:27:35 -07:00
commit bc75b622b5
4 changed files with 106 additions and 122 deletions

View File

@ -1,4 +1,3 @@
import React, { useState } from 'react';
import classNames from 'classnames'; import classNames from 'classnames';
import Head from 'next/head'; import Head from 'next/head';
import Link from 'next/link'; import Link from 'next/link';
@ -9,36 +8,37 @@ import DropDown from 'components/common/DropDown';
import WebsiteChart from 'components/metrics/WebsiteChart'; import WebsiteChart from 'components/metrics/WebsiteChart';
import EventsChart from 'components/metrics/EventsChart'; import EventsChart from 'components/metrics/EventsChart';
import Button from 'components/common/Button'; import Button from 'components/common/Button';
import EmptyPlaceholder from 'components/common/EmptyPlaceholder';
import Icon from 'components/common/Icon';
import useFetch from 'hooks/useFetch'; import useFetch from 'hooks/useFetch';
import useUser from 'hooks/useUser';
import ChevronDown from 'assets/chevron-down.svg';
import styles from './TestConsole.module.css'; import styles from './TestConsole.module.css';
export default function TestConsole() { export default function TestConsole() {
const { user } = useUser();
const [website, setWebsite] = useState();
const [show, setShow] = useState(true);
const { basePath } = useRouter();
const { data } = useFetch('/websites'); const { data } = useFetch('/websites');
const router = useRouter();
const {
basePath,
query: { id },
} = router;
const websiteId = id?.[0];
if (!data || !user?.is_admin) { if (!data) {
return null; return null;
} }
const options = data.map(({ name, website_id }) => ({ label: name, value: website_id })); const options = data.map(({ name, website_id }) => ({ label: name, value: website_id }));
const website = data.find(({ website_id }) => website_id === +websiteId);
const selectedValue = options.find(({ value }) => value === website?.website_id)?.value; const selectedValue = options.find(({ value }) => value === website?.website_id)?.value;
console.log({ websiteId, data, options, website });
function handleSelect(value) { function handleSelect(value) {
setWebsite(data.find(({ website_id }) => website_id === value)); router.push(`/console/${value}`);
} }
function handleClick() { function handleClick() {
window.umami('event (default)'); window.umami('umami-default');
window.umami.trackView('/page-view', 'https://www.google.com'); window.umami.trackView('/page-view', 'https://www.google.com');
window.umami.trackEvent('event (custom)', null, 'custom-type'); window.umami.trackEvent('track-event-no-data');
window.umami.trackEvent('event (custom)', { test: 'test-data' }, 'custom-data-type'); window.umami.trackEvent('track-event-with-data', { test: 'test-data', time: Date.now() });
} }
return ( return (
@ -62,54 +62,47 @@ export default function TestConsole() {
onChange={handleSelect} onChange={handleSelect}
/> />
</PageHeader> </PageHeader>
{!selectedValue && <EmptyPlaceholder msg="I hope you know what you're doing here" />} {website && (
{selectedValue && (
<> <>
<div> <div className={classNames(styles.test, 'row')}>
<Icon <div className="col-4">
icon={<ChevronDown />} <PageHeader>Page links</PageHeader>
className={classNames({ [styles.hidden]: !show })} <div>
onClick={() => setShow(!show)} <Link href={`/console/${websiteId}?page=1`}>
/> <a>page one</a>
</div> </Link>
{show && (
<div className={classNames(styles.test, 'row')}>
<div className="col-4">
<PageHeader>Page links</PageHeader>
<div>
<Link href={`?page=1`}>
<a>page one</a>
</Link>
</div>
<div>
<Link href={`?page=2`}>
<a>page two</a>
</Link>
</div>
<div>
<Link href={`https://www.google.com`}>
<a className="umami--click--external-link">external link</a>
</Link>
</div>
</div> </div>
<div className="col-4"> <div>
<PageHeader>CSS events</PageHeader> <Link href={`/console/${websiteId}?page=2`}>
<Button <a>page two</a>
id="primary-button" </Link>
className="umami--click--primary-button"
variant="action"
>
Send event
</Button>
</div> </div>
<div className="col-4"> <div>
<PageHeader>Javascript events</PageHeader> <Link href={`https://www.google.com`}>
<Button id="manual-button" variant="action" onClick={handleClick}> <a className="umami--click--external-link-direct">external link (direct)</a>
Run script </Link>
</Button> </div>
<div>
<Link href={`https://www.google.com`}>
<a className="umami--click--external-link-tab" target="_blank">
external link (tab)
</a>
</Link>
</div> </div>
</div> </div>
)} <div className="col-4">
<PageHeader>CSS events</PageHeader>
<Button id="primary-button" className="umami--click--button-click" variant="action">
Send event
</Button>
</div>
<div className="col-4">
<PageHeader>Javascript events</PageHeader>
<Button id="manual-button" variant="action" onClick={handleClick}>
Run script
</Button>
</div>
</div>
<div className="row"> <div className="row">
<div className="col-12"> <div className="col-12">
<WebsiteChart <WebsiteChart

View File

@ -35,6 +35,7 @@ if (process.env.FORCE_SSL) {
module.exports = { module.exports = {
env: { env: {
currentVersion: pkg.version, currentVersion: pkg.version,
isProduction: process.env.NODE_ENV === 'production',
}, },
basePath: process.env.BASE_PATH, basePath: process.env.BASE_PATH,
output: 'standalone', output: 'standalone',

View File

@ -2,11 +2,13 @@ import React from 'react';
import Layout from 'components/layout/Layout'; import Layout from 'components/layout/Layout';
import TestConsole from 'components/pages/TestConsole'; import TestConsole from 'components/pages/TestConsole';
import useRequireLogin from 'hooks/useRequireLogin'; import useRequireLogin from 'hooks/useRequireLogin';
import useUser from 'hooks/useUser';
export default function TestPage() { export default function ConsolePage({ enabled }) {
const { loading } = useRequireLogin(); const { loading } = useRequireLogin();
const { user } = useUser();
if (loading) { if (loading || !enabled || !user?.is_admin) {
return null; return null;
} }
@ -16,3 +18,9 @@ export default function TestPage() {
</Layout> </Layout>
); );
} }
export async function getServerSideProps() {
return {
props: { enabled: !!process.env.ENABLE_TEST_CONSOLE },
};
}

View File

@ -5,23 +5,25 @@ import { removeTrailingSlash } from '../lib/url';
const { const {
screen: { width, height }, screen: { width, height },
navigator: { language }, navigator: { language },
location: { hostname, pathname, search }, location,
localStorage, localStorage,
document, document,
history, history,
} = window; } = window;
const { hostname, pathname, search } = location;
const { currentScript } = document;
const script = document.querySelector('script[data-website-id]'); if (!currentScript) return;
if (!script) return; const _data = 'data-';
const _false = 'false';
const attr = script.getAttribute.bind(script); const attr = currentScript.getAttribute.bind(currentScript);
const website = attr('data-website-id'); const website = attr(_data + 'website-id');
const hostUrl = attr('data-host-url'); const hostUrl = attr(_data + 'host-url');
const autoTrack = attr('data-auto-track') !== 'false'; const autoTrack = attr(_data + 'auto-track') !== _false;
const dnt = attr('data-do-not-track'); const dnt = attr(_data + 'do-not-track');
const cssEvents = attr('data-css-events') !== 'false'; const cssEvents = attr(_data + 'css-events') !== _false;
const domain = attr('data-domains') || ''; const domain = attr(_data + 'domains') || '';
const domains = domain.split(',').map(n => n.trim()); const domains = domain.split(',').map(n => n.trim());
const eventClass = /^umami--([a-z]+)--([\w]+[\w-]*)$/; const eventClass = /^umami--([a-z]+)--([\w]+[\w-]*)$/;
@ -34,7 +36,8 @@ import { removeTrailingSlash } from '../lib/url';
const root = hostUrl const root = hostUrl
? removeTrailingSlash(hostUrl) ? removeTrailingSlash(hostUrl)
: script.src.split('/').slice(0, -1).join('/'); : currentScript.src.split('/').slice(0, -1).join('/');
const endpoint = `${root}/api/collect`;
const screen = `${width}x${height}`; const screen = `${width}x${height}`;
const listeners = {}; const listeners = {};
let currentUrl = `${pathname}${search}`; let currentUrl = `${pathname}${search}`;
@ -43,21 +46,6 @@ import { removeTrailingSlash } from '../lib/url';
/* Collect metrics */ /* Collect metrics */
const post = (url, data, callback) => {
const req = new XMLHttpRequest();
req.open('POST', url, true);
req.setRequestHeader('Content-Type', 'application/json');
if (cache) req.setRequestHeader('x-umami-cache', cache);
req.onreadystatechange = () => {
if (req.readyState === 4) {
callback(req.response);
}
};
req.send(JSON.stringify(data));
};
const getPayload = () => ({ const getPayload = () => ({
website, website,
hostname, hostname,
@ -68,7 +56,7 @@ import { removeTrailingSlash } from '../lib/url';
const assign = (a, b) => { const assign = (a, b) => {
Object.keys(b).forEach(key => { Object.keys(b).forEach(key => {
a[key] = b[key]; if (b[key] !== undefined) a[key] = b[key];
}); });
return a; return a;
}; };
@ -76,17 +64,16 @@ import { removeTrailingSlash } from '../lib/url';
const collect = (type, payload) => { const collect = (type, payload) => {
if (trackingDisabled()) return; if (trackingDisabled()) return;
post( return fetch(endpoint, {
`${root}/api/collect`, method: 'POST',
{ body: JSON.stringify({ type, payload }),
type, headers: assign({ 'Content-Type': 'application/json' }, { ['x-umami-cache']: cache }),
payload, })
}, .then(res => res.text())
res => (cache = res), .then(text => (cache = text));
);
}; };
const trackView = (url = currentUrl, referrer = currentRef, uuid = website) => { const trackView = (url = currentUrl, referrer = currentRef, uuid = website) =>
collect( collect(
'pageview', 'pageview',
assign(getPayload(), { assign(getPayload(), {
@ -95,9 +82,8 @@ import { removeTrailingSlash } from '../lib/url';
referrer, referrer,
}), }),
); );
};
const trackEvent = (event_name = 'custom', event_data, url = currentUrl, uuid = website) => { const trackEvent = (event_name, event_data, url = currentUrl, uuid = website) =>
collect( collect(
'event', 'event',
assign(getPayload(), { assign(getPayload(), {
@ -107,49 +93,45 @@ import { removeTrailingSlash } from '../lib/url';
event_data, event_data,
}), }),
); );
};
/* Handle events */ /* Handle events */
const sendEvent = name => {
const payload = getPayload();
payload.event_name = name;
const data = JSON.stringify({
type: 'event',
payload,
});
fetch(`${root}/api/collect`, {
method: 'POST',
body: data,
keepalive: true,
});
};
const addEvents = node => { const addEvents = node => {
const elements = node.querySelectorAll(eventSelect); const elements = node.querySelectorAll(eventSelect);
Array.prototype.forEach.call(elements, addEvent); Array.prototype.forEach.call(elements, addEvent);
}; };
const addEvent = element => { const addEvent = element => {
(element.getAttribute('class') || '').split(' ').forEach(className => { const get = element.getAttribute.bind(element);
(get('class') || '').split(' ').forEach(className => {
if (!eventClass.test(className)) return; if (!eventClass.test(className)) return;
const [, type, name] = className.split('--'); const [, event, name] = className.split('--');
const listener = listeners[className] const listener = listeners[className]
? listeners[className] ? listeners[className]
: (listeners[className] = () => { : (listeners[className] = e => {
if (element.tagName === 'A') { if (
sendEvent(name); event === 'click' &&
element.tagName === 'A' &&
!(
e.ctrlKey ||
e.shiftKey ||
e.metaKey ||
(e.button && e.button === 1) ||
get('target')
)
) {
e.preventDefault();
trackEvent(name).then(() => {
location.href = get('href');
});
} else { } else {
trackEvent(name); trackEvent(name);
} }
}); });
element.addEventListener(type, listener, true); element.addEventListener(event, listener, true);
}); });
}; };