Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

Feat/um 49 query builder api (#1573)

Brian Caoba31f48f1abc
diff --git a/components/common/EventDataButton.js b/components/common/EventDataButton.js
new file mode 100644
index 000000000..2b8958402
--- /dev/null
+++ b/components/common/EventDataButton.js
@@ -0,0 +1,48 @@
+import List from 'assets/list-ul.svg';
+import Modal from 'components/common/Modal';
+import PropTypes from 'prop-types';
+import { useState } from 'react';
+import { FormattedMessage } from 'react-intl';
+import Button from './Button';
+import EventDataForm from 'components/forms/EventDataForm';
+import styles from './EventDataButton.module.css';
+
+function EventDataButton({ websiteId }) {
+ const [showEventData, setShowEventData] = useState(false);
+
+ function handleClick() {
+ if (!showEventData) {
+ setShowEventData(true);
+ }
+ }
+
+ function handleClose() {
+ setShowEventData(false);
+ }
+
+ return (
+ <>
+ <Button
+ icon={<List />}
+ tooltip={<FormattedMessage id="label.event-data" defaultMessage="Event" />}
+ tooltipId="button-event"
+ size="small"
+ onClick={handleClick}
+ className={styles.button}
+ >
+ Event Data
+ </Button>
+ {showEventData && (
+ <Modal title={<FormattedMessage id="label.event-data" defaultMessage="Query Event Data" />}>
+ <EventDataForm websiteId={websiteId} onClose={handleClose} />
+ </Modal>
+ )}
+ </>
+ );
+}
+
+EventDataButton.propTypes = {
+ websiteId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+};
+
+export default EventDataButton;
diff --git a/components/common/EventDataButton.module.css b/components/common/EventDataButton.module.css
new file mode 100644
index 000000000..cd2a2ed6e
--- /dev/null
+++ b/components/common/EventDataButton.module.css
@@ -0,0 +1,3 @@
+.button {
+ width: fit-content;
+}
diff --git a/components/forms/EventDataForm.js b/components/forms/EventDataForm.js
new file mode 100644
index 000000000..1bd27a124
--- /dev/null
+++ b/components/forms/EventDataForm.js
@@ -0,0 +1,262 @@
+import classNames from 'classnames';
+import Button from 'components/common/Button';
+import DateFilter from 'components/common/DateFilter';
+import DropDown from 'components/common/DropDown';
+import FormLayout, {
+ FormButtons,
+ FormError,
+ FormMessage,
+ FormRow,
+} from 'components/layout/FormLayout';
+import DataTable from 'components/metrics/DataTable';
+import FilterTags from 'components/metrics/FilterTags';
+import { Field, Form, Formik } from 'formik';
+import useApi from 'hooks/useApi';
+import useDateRange from 'hooks/useDateRange';
+import { useState, useEffect } from 'react';
+import { FormattedMessage } from 'react-intl';
+import styles from './EventDataForm.module.css';
+import useTimezone from 'hooks/useTimezone';
+
+export const filterOptions = [
+ { label: 'Count', value: 'count' },
+ { label: 'Average', value: 'avg' },
+ { label: 'Minimum', value: 'min' },
+ { label: 'Maxmimum', value: 'max' },
+ { label: 'Sum', value: 'sum' },
+];
+
+export const dateOptions = [
+ { label: <FormattedMessage id="label.today" defaultMessage="Today" />, value: '1day' },
+ {
+ label: (
+ <FormattedMessage id="label.last-hours" defaultMessage="Last {x} hours" values={{ x: 24 }} />
+ ),
+ value: '24hour',
+ },
+ {
+ label: <FormattedMessage id="label.yesterday" defaultMessage="Yesterday" />,
+ value: '-1day',
+ },
+ {
+ label: <FormattedMessage id="label.this-week" defaultMessage="This week" />,
+ value: '1week',
+ divider: true,
+ },
+ {
+ label: (
+ <FormattedMessage id="label.last-days" defaultMessage="Last {x} days" values={{ x: 7 }} />
+ ),
+ value: '7day',
+ },
+ {
+ label: <FormattedMessage id="label.this-month" defaultMessage="This month" />,
+ value: '1month',
+ divider: true,
+ },
+ {
+ label: (
+ <FormattedMessage id="label.last-days" defaultMessage="Last {x} days" values={{ x: 30 }} />
+ ),
+ value: '30day',
+ },
+ {
+ label: (
+ <FormattedMessage id="label.last-days" defaultMessage="Last {x} days" values={{ x: 90 }} />
+ ),
+ value: '90day',
+ },
+ { label: <FormattedMessage id="label.this-year" defaultMessage="This year" />, value: '1year' },
+ {
+ label: <FormattedMessage id="label.custom-range" defaultMessage="Custom range" />,
+ value: 'custom',
+ divider: true,
+ },
+];
+
+export default function EventDataForm({ websiteId, onClose, className }) {
+ const { post } = useApi();
+ const [message, setMessage] = useState();
+ const [columns, setColumns] = useState();
+ const [filters, setFilters] = useState();
+ const [data, setData] = useState([]);
+ const [dateRange, setDateRange] = useDateRange('report');
+ const { startDate, endDate, value } = dateRange;
+ const [timezone] = useTimezone();
+ const [isValid, setIsValid] = useState(false);
+
+ useEffect(() => {
+ if (Object.keys(columns).length > 0) {
+ setIsValid(true);
+ } else {
+ setIsValid(false);
+ }
+ }, [columns]);
+
+ const handleAddTag = (value, list, setState, resetForm) => {
+ setState({ ...list, [`${value.field}`]: value.value });
+ resetForm();
+ };
+
+ const handleRemoveTag = (value, list, setState) => {
+ const next = { ...list };
+
+ delete next[`${value}`];
+
+ setState(next);
+ };
+
+ const handleSubmit = async () => {
+ const params = {
+ website_id: websiteId,
+ start_at: +startDate,
+ end_at: +endDate,
+ timezone,
+ columns,
+ filters,
+ };
+
+ const { ok, data } = await post(`/websites/${websiteId}/eventdata`, params);
+
+ if (!ok) {
+ setMessage(<FormattedMessage id="message.failure" defaultMessage="Something went wrong." />);
+ setData([]);
+ } else {
+ setData(data);
+ setMessage(null);
+ }
+ };
+
+ return (
+ <>
+ <FormMessage>{message}</FormMessage>
+ <div className={classNames(styles.container, className)}>
+ <div className={styles.form}>
+ <FormLayout>
+ <div className={styles.filters}>
+ <FormRow>
+ <label htmlFor="date-range">
+ <FormattedMessage id="label.date-range" defaultMessage="Date Range" />
+ </label>
+ <DateFilter
+ value={value}
+ startDate={startDate}
+ endDate={endDate}
+ onChange={setDateRange}
+ options={dateOptions}
+ />
+ </FormRow>
+ </div>
+ <div className={styles.filters}>
+ <Formik
+ initialValues={{ field: '', value: '' }}
+ onSubmit={(value, { resetForm }) =>
+ handleAddTag(value, columns, setColumns, resetForm)
+ }
+ >
+ {({ values, setFieldValue }) => (
+ <Form>
+ <FormRow>
+ <label htmlFor="field">
+ <FormattedMessage id="label.field-name" defaultMessage="Field Name" />
+ </label>
+ <div>
+ <Field name="field" type="text" />
+ <FormError name="field" />
+ </div>
+ </FormRow>
+ <FormRow>
+ <label htmlFor="value">
+ <FormattedMessage id="label.type" defaultMessage="Type" />
+ </label>
+ <div>
+ <DropDown
+ value={values.value}
+ onChange={value => setFieldValue('value', value)}
+ className={styles.dropdown}
+ name="value"
+ options={filterOptions}
+ />
+ <FormError name="value" />
+ </div>
+ </FormRow>
+ <FormButtons className={styles.formButtons}>
+ <Button
+ variant="action"
+ type="submit"
+ disabled={!values.field || !values.value}
+ >
+ <FormattedMessage id="label.add-column" defaultMessage="Add Column" />
+ </Button>
+ </FormButtons>
+ </Form>
+ )}
+ </Formik>
+ <FilterTags
+ className={styles.filterTag}
+ params={columns}
+ onClick={value => handleRemoveTag(value, columns, setColumns)}
+ />
+ </div>
+ <div className={styles.filters}>
+ <Formik
+ initialValues={{ field: '', value: '' }}
+ onSubmit={(value, { resetForm }) =>
+ handleAddTag(value, filters, setFilters, resetForm)
+ }
+ >
+ {({ values }) => (
+ <Form>
+ <FormRow>
+ <label htmlFor="field">
+ <FormattedMessage id="label.field-name" defaultMessage="Field Name" />
+ </label>
+ <div>
+ <Field name="field" type="text" />
+ <FormError name="field" />
+ </div>
+ </FormRow>
+ <FormRow>
+ <label htmlFor="value">
+ <FormattedMessage id="label.value" defaultMessage="Value" />
+ </label>
+ <div>
+ <Field name="value" type="text" />
+ <FormError name="value" />
+ </div>
+ </FormRow>
+ <FormButtons className={styles.formButtons}>
+ <Button
+ variant="action"
+ type="submit"
+ disabled={!values.field || !values.value}
+ >
+ <FormattedMessage id="label.add-filter" defaultMessage="Add Filter" />
+ </Button>
+ </FormButtons>
+ </Form>
+ )}
+ </Formik>
+ <FilterTags
+ className={styles.filterTag}
+ params={filters}
+ onClick={value => handleRemoveTag(value, filters, setFilters)}
+ />
+ </div>
+ </FormLayout>
+ </div>
+ <div>
+ <DataTable className={styles.table} data={data} title="Results" showPercentage={false} />
+ </div>
+ </div>
+ <FormButtons>
+ <Button variant="action" onClick={handleSubmit} disabled={!isValid}>
+ <FormattedMessage id="label.search" defaultMessage="Search" />
+ </Button>
+ <Button onClick={onClose}>
+ <FormattedMessage id="label.cancel" defaultMessage="Cancel" />
+ </Button>
+ </FormButtons>
+ </>
+ );
+}
diff --git a/components/forms/EventDataForm.module.css b/components/forms/EventDataForm.module.css
new file mode 100644
index 000000000..19d76f775
--- /dev/null
+++ b/components/forms/EventDataForm.module.css
@@ -0,0 +1,38 @@
+.container {
+ display: flex;
+}
+
+.form {
+ border-right: 1px solid var(--gray300);
+ width: 420px;
+}
+
+.filters {
+ padding: 10px 5px;
+}
+
+.filters + .filters {
+ border-top: 1px solid var(--gray300);
+ min-height: 250px;
+}
+
+.table {
+ padding: 10px;
+ min-height: 430px;
+ min-width: 400px;
+}
+
+.formButtons {
+ justify-content: flex-start;
+ margin-left: 20px;
+}
+
+.dropdown {
+ min-height: 39px;
+ min-width: 240px;
+}
+
+.filterTag {
+ flex-wrap: wrap;
+ margin: 10px 5px 5px 5px;
+}
diff --git a/components/metrics/DataTable.js b/components/metrics/DataTable.js
index d7e58cf7f..c95961061 100644
--- a/components/metrics/DataTable.js
+++ b/components/metrics/DataTable.js
@@ -16,6 +16,7 @@ export default function DataTable({
height,
animate = true,
virtualize = false,
+ showPercentage = true,
}) {
const [format, setFormat] = useState(true);
const formatFunc = format ? formatLongNumber : formatNumber;
@@ -38,6 +39,7 @@ export default function DataTable({
animate={animate && !virtualize}
format={formatFunc}
onClick={handleSetFormat}
+ showPercentage={showPercentage}
/>
);
};
@@ -68,7 +70,15 @@ export default function DataTable({
);
}
-const AnimatedRow = ({ label, value = 0, percent, animate, format, onClick }) => {
+const AnimatedRow = ({
+ label,
+ value = 0,
+ percent,
+ animate,
+ format,
+ onClick,
+ showPercentage = true,
+}) => {
const props = useSpring({
width: percent,
y: value,
@@ -82,15 +92,17 @@ const AnimatedRow = ({ label, value = 0, percent, animate, format, onClick }) =>
<div className={styles.value} onClick={onClick}>
<animated.div className={styles.value}>{props.y?.interpolate(format)}</animated.div>
</div>
- <div className={styles.percent}>
- <animated.div
- className={styles.bar}
- style={{ width: props.width.interpolate(n => `${n}%`) }}
- />
- <animated.span className={styles.percentValue}>
- {props.width.interpolate(n => `${n.toFixed(0)}%`)}
- </animated.span>
- </div>
+ {showPercentage && (
+ <div className={styles.percent}>
+ <animated.div
+ className={styles.bar}
+ style={{ width: props.width.interpolate(n => `${n}%`) }}
+ />
+ <animated.span className={styles.percentValue}>
+ {props.width.interpolate(n => `${n.toFixed(0)}%`)}
+ </animated.span>
+ </div>
+ )}
</div>
);
};
diff --git a/components/metrics/FilterTags.js b/components/metrics/FilterTags.js
index be65540e1..bb4174b85 100644
--- a/components/metrics/FilterTags.js
+++ b/components/metrics/FilterTags.js
@@ -5,12 +5,12 @@ import Button from 'components/common/Button';
import Times from 'assets/times.svg';
import styles from './FilterTags.module.css';
-export default function FilterTags({ params, onClick }) {
+export default function FilterTags({ className, params, onClick }) {
if (Object.keys(params).filter(key => params[key]).length === 0) {
return null;
}
return (
- <div className={classNames(styles.filters, 'col-12')}>
+ <div className={classNames(styles.filters, 'col-12', className)}>
{Object.keys(params).map(key => {
if (!params[key]) {
return null;
diff --git a/components/metrics/FilterTags.module.css b/components/metrics/FilterTags.module.css
index bb1536e5f..50ae60a0c 100644
--- a/components/metrics/FilterTags.module.css
+++ b/components/metrics/FilterTags.module.css
@@ -7,8 +7,5 @@
.tag {
text-align: center;
margin-bottom: 10px;
-}
-
-.tag + .tag {
- margin-left: 20px;
+ margin-right: 20px;
}
diff --git a/components/metrics/WebsiteHeader.js b/components/metrics/WebsiteHeader.js
index 1a6bdf159..517ef1404 100644
--- a/components/metrics/WebsiteHeader.js
+++ b/components/metrics/WebsiteHeader.js
@@ -1,14 +1,13 @@
-import React from 'react';
+import Arrow from 'assets/arrow-right.svg';
import classNames from 'classnames';
-import { FormattedMessage } from 'react-intl';
+import Favicon from 'components/common/Favicon';
import Link from 'components/common/Link';
import OverflowText from 'components/common/OverflowText';
-import PageHeader from 'components/layout/PageHeader';
import RefreshButton from 'components/common/RefreshButton';
import ButtonLayout from 'components/layout/ButtonLayout';
-import Favicon from 'components/common/Favicon';
+import PageHeader from 'components/layout/PageHeader';
+import { FormattedMessage } from 'react-intl';
import ActiveUsers from './ActiveUsers';
-import Arrow from 'assets/arrow-right.svg';
import styles from './WebsiteHeader.module.css';
export default function WebsiteHeader({ websiteId, title, domain, showLink = false }) {
diff --git a/components/pages/TestConsole.js b/components/pages/TestConsole.js
index 215c350c8..6200f7e5a 100644
--- a/components/pages/TestConsole.js
+++ b/components/pages/TestConsole.js
@@ -24,9 +24,9 @@ export default function TestConsole() {
return null;
}
- const options = data.map(({ name, websiteId }) => ({ label: name, value: websiteId }));
- const website = data.find(({ websiteId }) => websiteId === +websiteId);
- const selectedValue = options.find(({ value }) => value === website?.websiteId)?.value;
+ const options = data.map(({ name, websiteUuid }) => ({ label: name, value: websiteUuid }));
+ const website = data.find(({ websiteUuid }) => websiteId === websiteUuid);
+ const selectedValue = options.find(({ value }) => value === website?.websiteUuid)?.value;
function handleSelect(value) {
router.push(`/console/${value}`);
@@ -104,13 +104,13 @@ export default function TestConsole() {
<div className="row">
<div className="col-12">
<WebsiteChart
- websiteId={website.websiteId}
+ websiteId={website.websiteUuid}
title={website.name}
domain={website.domain}
showLink
/>
<PageHeader>Events</PageHeader>
- <EventsChart websiteId={website.websiteId} />
+ <EventsChart websiteId={website.websiteUuid} />
</div>
</div>
</>
diff --git a/components/pages/WebsiteDetails.js b/components/pages/WebsiteDetails.js
index 3fc234a47..b40bc9ee1 100644
--- a/components/pages/WebsiteDetails.js
+++ b/components/pages/WebsiteDetails.js
@@ -24,6 +24,7 @@ import useFetch from 'hooks/useFetch';
import usePageQuery from 'hooks/usePageQuery';
import { DEFAULT_ANIMATION_DURATION } from 'lib/constants';
import styles from './WebsiteDetails.module.css';
+import EventDataButton from 'components/common/EventDataButton';
const messages = defineMessages({
pages: { id: 'metrics.pages', defaultMessage: 'Pages' },
@@ -183,6 +184,7 @@ export default function WebsiteDetails({ websiteId }) {
<EventsTable {...tableProps} onDataLoad={setEventsData} />
</GridColumn>
<GridColumn xs={12} md={12} lg={8}>
+ <EventDataButton websiteId={websiteId} />
<EventsChart className={styles.eventschart} websiteId={websiteId} />
</GridColumn>
</GridRow>
diff --git a/db/mysql/migrations/04_account_uuid/migration.sql b/db/mysql/migrations/04_account_uuid/migration.sql
deleted file mode 100644
index 7b7b5dea9..000000000
--- a/db/mysql/migrations/04_account_uuid/migration.sql
+++ /dev/null
@@ -1,11 +0,0 @@
--- AlterTable
-ALTER TABLE `account` ADD COLUMN `account_uuid` VARCHAR(36);
-
--- Backfill UUID
-UPDATE `account` SET account_uuid=(SELECT uuid());
-
--- AlterTable
-ALTER TABLE `account` MODIFY `account_uuid` VARCHAR(36) NOT NULL;
-
--- CreateIndex
-CREATE UNIQUE INDEX `account_account_uuid_key` ON `account`(`account_uuid`);
diff --git a/db/mysql/migrations/04_add_uuid/migration.sql b/db/mysql/migrations/04_add_uuid/migration.sql
new file mode 100644
index 000000000..137ee2e32
--- /dev/null
+++ b/db/mysql/migrations/04_add_uuid/migration.sql
@@ -0,0 +1,35 @@
+-- AlterTable
+ALTER TABLE `account` ADD COLUMN `account_uuid` VARCHAR(36);
+
+-- Backfill UUID
+UPDATE `account` SET account_uuid=(SELECT uuid());
+
+-- AlterTable
+ALTER TABLE `account` MODIFY `account_uuid` VARCHAR(36) NOT NULL;
+
+-- CreateIndex
+CREATE UNIQUE INDEX `account_account_uuid_key` ON `account`(`account_uuid`);
+
+-- AlterTable
+ALTER TABLE `event` ADD COLUMN `event_uuid` VARCHAR(36);
+
+-- Backfill UUID
+UPDATE `event` SET event_uuid=(SELECT uuid());
+
+-- AlterTable
+ALTER TABLE `event` MODIFY `event_uuid` VARCHAR(36) NOT NULL;
+
+-- CreateIndex
+CREATE UNIQUE INDEX `event_event_uuid_key` ON `event`(`event_uuid`);
+
+-- CreateIndex
+CREATE INDEX `account_account_uuid_idx` ON `account`(`account_uuid`);
+
+-- CreateIndex
+CREATE INDEX `session_session_uuid_idx` ON `session`(`session_uuid`);
+
+-- CreateIndex
+CREATE INDEX `website_website_uuid_idx` ON `website`(`website_uuid`);
+
+-- CreateIndex
+CREATE INDEX `event_event_uuid_idx` ON `event`(`event_uuid`);
\ No newline at end of file
diff --git a/db/mysql/schema.prisma b/db/mysql/schema.prisma
index 6c740bfbc..bdfafd43d 100644
--- a/db/mysql/schema.prisma
+++ b/db/mysql/schema.prisma
@@ -16,6 +16,8 @@ model account {
updatedAt DateTime? @default(now()) @map("updated_at") @db.Timestamp(0)
accountUuid String @unique() @map("account_uuid") @db.VarChar(36)
website website[]
+
+ @@index([accountUuid])
}
model event {
@@ -25,6 +27,7 @@ model event {
createdAt DateTime? @default(now()) @map("created_at") @db.Timestamp(0)
url String @db.VarChar(500)
eventName String @map("event_name") @db.VarChar(50)
+ eventUuid String @unique() @map("event_uuid") @db.VarChar(36)
session session @relation(fields: [sessionId], references: [id])
website website @relation(fields: [websiteId], references: [id])
eventData eventData?
@@ -32,6 +35,7 @@ model event {
@@index([createdAt])
@@index([sessionId])
@@index([websiteId])
+ @@index([eventUuid])
}
model eventData {
@@ -78,6 +82,7 @@ model session {
@@index([createdAt])
@@index([websiteId])
+ @@index([sessionUuid])
}
model website {
@@ -94,4 +99,5 @@ model website {
session session[]
@@index([userId])
+ @@index([websiteUuid])
}
diff --git a/db/postgresql/migrations/04_account_uuid/migration.sql b/db/postgresql/migrations/04_add_uuid/migration.sql
similarity index 59%
rename from db/postgresql/migrations/04_account_uuid/migration.sql
rename to db/postgresql/migrations/04_add_uuid/migration.sql
index b6929f647..21d4cf07f 100644
--- a/db/postgresql/migrations/04_account_uuid/migration.sql
+++ b/db/postgresql/migrations/04_add_uuid/migration.sql
@@ -11,6 +11,18 @@ ALTER TABLE "account" ALTER COLUMN "account_uuid" SET NOT NULL;
-- CreateIndex
CREATE UNIQUE INDEX "account_account_uuid_key" ON "account"("account_uuid");
+-- AlterTable
+ALTER TABLE "event" ADD COLUMN "event_uuid" UUID NULL;
+
+-- Backfill UUID
+UPDATE "event" SET event_uuid = gen_random_uuid();
+
+-- AlterTable
+ALTER TABLE "event" ALTER COLUMN "event_uuid" SET NOT NULL;
+
+-- CreateIndex
+CREATE UNIQUE INDEX "event_event_uuid_key" ON "event"("event_uuid");
+
-- CreateIndex
CREATE INDEX "account_account_uuid_idx" ON "account"("account_uuid");
@@ -18,4 +30,7 @@ CREATE INDEX "account_account_uuid_idx" ON "account"("account_uuid");
CREATE INDEX "session_session_uuid_idx" ON "session"("session_uuid");
-- CreateIndex
-CREATE INDEX "website_website_uuid_idx" ON "website"("website_uuid");
\ No newline at end of file
+CREATE INDEX "website_website_uuid_idx" ON "website"("website_uuid");
+
+-- CreateIndex
+CREATE INDEX "event_event_uuid_idx" ON "event"("event_uuid");
\ No newline at end of file
diff --git a/db/postgresql/schema.prisma b/db/postgresql/schema.prisma
index 920a6f787..ad1c75959 100644
--- a/db/postgresql/schema.prisma
+++ b/db/postgresql/schema.prisma
@@ -16,6 +16,8 @@ model account {
updatedAt DateTime? @default(now()) @map("updated_at") @db.Timestamptz(6)
accountUuid String @unique @map("account_uuid") @db.Uuid
website website[]
+
+ @@index([accountUuid])
}
model event {
@@ -25,6 +27,7 @@ model event {
createdAt DateTime? @default(now()) @map("created_at") @db.Timestamptz(6)
url String @db.VarChar(500)
eventName String @map("event_name") @db.VarChar(50)
+ eventUuid String @unique @map("event_uuid") @db.Uuid
session session @relation(fields: [sessionId], references: [id])
website website @relation(fields: [websiteId], references: [id])
eventData eventData?
@@ -32,6 +35,7 @@ model event {
@@index([createdAt])
@@index([sessionId])
@@index([websiteId])
+ @@index([eventUuid])
}
model eventData {
@@ -78,6 +82,7 @@ model session {
@@index([createdAt])
@@index([websiteId])
+ @@index([sessionUuid])
}
model website {
@@ -94,4 +99,5 @@ model website {
session session[]
@@index([userId])
+ @@index([websiteUuid])
}
diff --git a/lang/en-US.json b/lang/en-US.json
index aa5e3ae36..f58a25cdf 100644
--- a/lang/en-US.json
+++ b/lang/en-US.json
@@ -1,6 +1,8 @@
{
"label.accounts": "Accounts",
"label.add-account": "Add account",
+ "label.add-column": "Add column",
+ "label.add-filter": "Add filter",
"label.add-website": "Add website",
"label.administrator": "Administrator",
"label.all": "All",
@@ -25,6 +27,8 @@
"label.edit-account": "Edit account",
"label.edit-website": "Edit website",
"label.enable-share-url": "Enable share URL",
+ "label.event-data": "Event Data",
+ "label.field-name": "Field Name",
"label.invalid": "Invalid",
"label.invalid-domain": "Invalid domain",
"label.language": "Language",
@@ -48,6 +52,7 @@
"label.reset": "Reset",
"label.reset-website": "Reset statistics",
"label.save": "Save",
+ "label.search": "Search",
"label.settings": "Settings",
"label.share-url": "Share URL",
"label.single-day": "Single day",
@@ -58,8 +63,10 @@
"label.timezone": "Timezone",
"label.today": "Today",
"label.tracking-code": "Tracking code",
+ "label.type": "Type",
"label.unknown": "Unknown",
"label.username": "Username",
+ "label.value": "Value",
"label.view-details": "View details",
"label.websites": "Websites",
"label.yesterday": "Yesterday",
diff --git a/lib/clickhouse.js b/lib/clickhouse.js
index a01a36cc1..41b1df5a5 100644
--- a/lib/clickhouse.js
+++ b/lib/clickhouse.js
@@ -65,8 +65,45 @@ function getCommaSeparatedStringFormat(data) {
}
function getBetweenDates(field, start_at, end_at) {
- return `${field} between ${getDateFormat(start_at)}
- and ${getDateFormat(end_at)}`;
+ return `${field} between ${getDateFormat(start_at)} and ${getDateFormat(end_at)}`;
+}
+
+function getJsonField(column, property) {
+ return `${column}.${property}`;
+}
+
+function getEventDataColumnsQuery(column, columns) {
+ const query = Object.keys(columns).reduce((arr, key) => {
+ const filter = columns[key];
+
+ if (filter === undefined) {
+ return arr;
+ }
+
+ arr.push(`${filter}(${getJsonField(column, key)}) as ${key}_${filter}`);
+
+ return arr;
+ }, []);
+
+ return query.join(',\n');
+}
+
+function getEventDataFilterQuery(column, filters) {
+ const query = Object.keys(filters).reduce((arr, key) => {
+ const filter = filters[key];
+
+ if (filter === undefined) {
+ return arr;
+ }
+
+ arr.push(
+ `${getJsonField(column, key)} = ${typeof filter === 'string' ? `'${filter}'` : filter}`,
+ );
+
+ return arr;
+ }, []);
+
+ return query.join('\nand ');
}
function getFilterQuery(column, filters = {}, params = []) {
@@ -186,6 +223,8 @@ export default {
getDateFormat,
getCommaSeparatedStringFormat,
getBetweenDates,
+ getEventDataColumnsQuery,
+ getEventDataFilterQuery,
getFilterQuery,
parseFilters,
findUnique,
diff --git a/lib/prisma.js b/lib/prisma.js
index b93afafa8..ab1e6ebfc 100644
--- a/lib/prisma.js
+++ b/lib/prisma.js
@@ -85,6 +85,64 @@ function getTimestampInterval(field) {
}
}
+function getJsonField(column, property, isNumber) {
+ const db = getDatabaseType(process.env.DATABASE_URL);
+
+ if (db === POSTGRESQL) {
+ let accessor = `${column} ->> '${property}'`;
+
+ if (isNumber) {
+ accessor = `CAST(${accessor} AS DECIMAL)`;
+ }
+
+ return accessor;
+ }
+
+ if (db === MYSQL) {
+ return `${column} ->> "$.${property}"`;
+ }
+}
+
+function getEventDataColumnsQuery(column, columns) {
+ const query = Object.keys(columns).reduce((arr, key) => {
+ const filter = columns[key];
+
+ if (filter === undefined) {
+ return arr;
+ }
+
+ const isNumber = ['sum', 'avg', 'min', 'max'].some(a => a === filter);
+
+ arr.push(`${filter}(${getJsonField(column, key, isNumber)}) as "${filter}(${key})"`);
+
+ return arr;
+ }, []);
+
+ return query.join(',\n');
+}
+
+function getEventDataFilterQuery(column, filters) {
+ const query = Object.keys(filters).reduce((arr, key) => {
+ const filter = filters[key];
+
+ if (filter === undefined) {
+ return arr;
+ }
+
+ const isNumber = filter && typeof filter === 'number';
+
+ arr.push(
+ `${getJsonField(column, key, isNumber)} = ${
+ typeof filter === 'string' ? `'${filter}'` : filter
+ }`,
+ );
+
+ return arr;
+ }, []);
+
+ return query.join('\nand ');
+}
+
function getFilterQuery(table, column, filters = {}, params = []) {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
@@ -193,6 +251,8 @@ export default {
getDateQuery,
getTimestampInterval,
getFilterQuery,
+ getEventDataColumnsQuery,
+ getEventDataFilterQuery,
parseFilters,
rawQuery,
transaction,
diff --git a/pages/api/collect.js b/pages/api/collect.js
index 42fd309a9..5a4411d5d 100644
--- a/pages/api/collect.js
+++ b/pages/api/collect.js
@@ -58,13 +58,11 @@ export default async (req, res) => {
await useSession(req, res);
- const {
- session: { website, session },
- } = req;
+ const { website, session } = req.session;
const { type, payload } = getJsonBody(req);
- let { url, referrer, eventName, eventData } = payload;
+ let { url, referrer, event_name: eventName, event_data: eventData } = payload;
if (process.env.REMOVE_TRAILING_SLASH) {
url = url.replace(/\/$/, '');
@@ -88,9 +86,8 @@ export default async (req, res) => {
const token = createToken(
{
- websiteId: website.websiteUuid,
- sessionId: session.sessionId,
- sessionUuid: session.sessionUuid,
+ website,
+ session,
},
secret(),
);
diff --git a/pages/api/websites/[id]/eventdata.js b/pages/api/websites/[id]/eventdata.js
new file mode 100644
index 000000000..86a17b77c
--- /dev/null
+++ b/pages/api/websites/[id]/eventdata.js
@@ -0,0 +1,40 @@
+import moment from 'moment-timezone';
+import { getEventData } from 'queries';
+import { ok, badRequest, methodNotAllowed, unauthorized } from 'next-basics';
+import { allowQuery } from 'lib/auth';
+import { useAuth, useCors } from 'lib/middleware';
+
+export default async (req, res) => {
+ await useCors(req, res);
+ await useAuth(req, res);
+
+ if (req.method === 'POST') {
+ if (!(await allowQuery(req))) {
+ return unauthorized(res);
+ }
+
+ const { id: websiteId } = req.query;
+
+ const { start_at, end_at, timezone, event_name: eventName, columns, filters } = req.body;
+
+ if (!moment.tz.zone(timezone)) {
+ return badRequest(res);
+ }
+
+ const startDate = new Date(+start_at);
+ const endDate = new Date(+end_at);
+
+ const events = await getEventData(websiteId, {
+ startDate,
+ endDate,
+ timezone,
+ eventName,
+ columns,
+ filters,
+ });
+
+ return ok(res, events);
+ }
+
+ return methodNotAllowed(res);
+};
diff --git a/pages/console/[[...id]].js b/pages/console/[[...id]].js
index 8e37e77a7..a13537f85 100644
--- a/pages/console/[[...id]].js
+++ b/pages/console/[[...id]].js
@@ -18,3 +18,9 @@ export default function ConsolePage({ enabled }) {
</Layout>
);
}
+
+export async function getServerSideProps() {
+ return {
+ props: { enabled: !!process.env.ENABLE_TEST_CONSOLE },
+ };
+}
diff --git a/pages/login.js b/pages/login.js
index d46110c82..12f70ac9b 100644
--- a/pages/login.js
+++ b/pages/login.js
@@ -16,6 +16,6 @@ export default function LoginPage({ loginDisabled }) {
export async function getServerSideProps() {
return {
- props: { loginDisabled: !!process.env.DISABLE_LOGIN || process.env.isCloudMode },
+ props: { loginDisabled: !!process.env.DISABLE_LOGIN || !!process.env.isCloudMode },
};
}
diff --git a/queries/analytics/event/getEventData.js b/queries/analytics/event/getEventData.js
new file mode 100644
index 000000000..91302d301
--- /dev/null
+++ b/queries/analytics/event/getEventData.js
@@ -0,0 +1,63 @@
+import clickhouse from 'lib/clickhouse';
+import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
+import prisma from 'lib/prisma';
+
+export async function getEventData(...args) {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(...args),
+ [CLICKHOUSE]: () => clickhouseQuery(...args),
+ });
+}
+
+async function relationalQuery(websiteId, { startDate, endDate, event_name, columns, filters }) {
+ const { rawQuery, getEventDataColumnsQuery, getEventDataFilterQuery } = prisma;
+ const params = [startDate, endDate];
+
+ return rawQuery(
+ `select
+ ${getEventDataColumnsQuery('event_data.event_data', columns)}
+ from event
+ join website
+ on event.website_id = website.website_id
+ join event_data
+ on event.event_id = event_data.event_id
+ where website_uuid='${websiteId}'
+ and event.created_at between $1 and $2
+ ${event_name ? `and event_name = ${event_name}` : ''}
+ ${
+ Object.keys(filters).length > 0
+ ? `and ${getEventDataFilterQuery('event_data.event_data', filters)}`
+ : ''
+ }`,
+ params,
+ ).then(results => {
+ return Object.keys(results[0]).map(a => {
+ return { x: a, y: results[0][`${a}`] };
+ });
+ });
+}
+
+async function clickhouseQuery(websiteId, { startDate, endDate, event_name, columns, filters }) {
+ const { rawQuery, getBetweenDates, getEventDataColumnsQuery, getEventDataFilterQuery } =
+ clickhouse;
+ const params = [websiteId];
+
+ return rawQuery(
+ `select
+ ${getEventDataColumnsQuery('event_data', columns)}
+ from event
+ where website_id= $1
+ ${event_name ? `and event_name = ${event_name}` : ''}
+ and ${getBetweenDates('created_at', startDate, endDate)}
+ ${
+ Object.keys(filters).length > 0
+ ? `and ${getEventDataFilterQuery('event_data', filters)}`
+ : ''
+ }`,
+ params,
+ ).then(results => {
+ return Object.keys(results[0]).map(a => {
+ return { x: a, y: results[0][`${a}`] };
+ });
+ });
+}
diff --git a/queries/analytics/event/getEventMetrics.js b/queries/analytics/event/getEventMetrics.js
index edf5de8c2..605bb6881 100644
--- a/queries/analytics/event/getEventMetrics.js
+++ b/queries/analytics/event/getEventMetrics.js
@@ -18,7 +18,7 @@ async function relationalQuery(
filters = {},
) {
const { rawQuery, getDateQuery, getFilterQuery } = prisma;
- const params = [websiteId, start_at, end_at];
+ const params = [start_at, end_at];
return rawQuery(
`select
@@ -29,7 +29,7 @@ async function relationalQuery(
join website
on event.website_id = website.website_id
where website_uuid='${websiteId}'
- and event.created_at between $2 and $3
+ and event.created_at between $1 and $2
${getFilterQuery('event', filters, params)}
group by 1, 2
order by 2`,
diff --git a/queries/analytics/event/saveEvent.js b/queries/analytics/event/saveEvent.js
index 26cf18b71..de7a1cae4 100644
--- a/queries/analytics/event/saveEvent.js
+++ b/queries/analytics/event/saveEvent.js
@@ -12,13 +12,14 @@ export async function saveEvent(...args) {
async function relationalQuery(
{ websiteId },
- { session: { id: sessionId }, url, eventName, eventData },
+ { session: { id: sessionId }, eventUuid, url, eventName, eventData },
) {
const data = {
websiteId,
sessionId,
url: url?.substring(0, URL_LENGTH),
eventName: eventName?.substring(0, EVENT_NAME_LENGTH),
+ eventUuid,
};
if (eventData) {
@@ -47,7 +48,7 @@ async function clickhouseQuery(
created_at: getDateFormat(new Date()),
url: url?.substring(0, URL_LENGTH),
event_name: eventName?.substring(0, EVENT_NAME_LENGTH),
- event_data: JSON.stringify(eventData),
+ event_data: eventData ? JSON.stringify(eventData) : null,
...sessionArgs,
country: country ? country : null,
};
diff --git a/queries/analytics/pageview/getPageviewMetrics.js b/queries/analytics/pageview/getPageviewMetrics.js
index e1c4d43f9..69607d00e 100644
--- a/queries/analytics/pageview/getPageviewMetrics.js
+++ b/queries/analytics/pageview/getPageviewMetrics.js
@@ -11,7 +11,7 @@ export async function getPageviewMetrics(...args) {
async function relationalQuery(websiteId, { startDate, endDate, column, table, filters = {} }) {
const { rawQuery, parseFilters } = prisma;
- const params = [websiteId, startDate, endDate];
+ const params = [startDate, endDate];
const { pageviewQuery, sessionQuery, eventQuery, joinSession } = parseFilters(
table,
column,
@@ -25,7 +25,7 @@ async function relationalQuery(websiteId, { startDate, endDate, column, table, f
${` join website on ${table}.website_id = website.website_id`}
${joinSession}
where website.website_uuid='${websiteId}'
- and ${table}.created_at between $2 and $3
+ and ${table}.created_at between $1 and $2
${pageviewQuery}
${joinSession && sessionQuery}
${eventQuery}
diff --git a/queries/analytics/pageview/getPageviewParams.js b/queries/analytics/pageview/getPageviewParams.js
index 8ec26dec8..5cdabfa3b 100644
--- a/queries/analytics/pageview/getPageviewParams.js
+++ b/queries/analytics/pageview/getPageviewParams.js
@@ -10,7 +10,7 @@ export async function getPageviewParams(...args) {
async function relationalQuery(websiteId, start_at, end_at, column, table, filters = {}) {
const { parseFilters, rawQuery } = prisma;
- const params = [websiteId, start_at, end_at];
+ const params = [start_at, end_at];
const { pageviewQuery, sessionQuery, eventQuery, joinSession } = parseFilters(
table,
column,
@@ -25,7 +25,7 @@ async function relationalQuery(websiteId, start_at, end_at, column, table, filte
${` join website on ${table}.website_id = website.website_id`}
${joinSession}
where website.website_uuid='${websiteId}'
- and ${table}.created_at between $2 and $3
+ and ${table}.created_at between $1 and $2
and ${table}.url like '%?%'
${pageviewQuery}
${joinSession && sessionQuery}
diff --git a/queries/analytics/pageview/getPageviewStats.js b/queries/analytics/pageview/getPageviewStats.js
index ceed4daf0..5ec8339f3 100644
--- a/queries/analytics/pageview/getPageviewStats.js
+++ b/queries/analytics/pageview/getPageviewStats.js
@@ -22,7 +22,7 @@ async function relationalQuery(
},
) {
const { getDateQuery, parseFilters, rawQuery } = prisma;
- const params = [websiteId, start_at, end_at];
+ const params = [start_at, end_at];
const { pageviewQuery, sessionQuery, joinSession } = parseFilters(
'pageview',
null,
@@ -38,7 +38,7 @@ async function relationalQuery(
on pageview.website_id = website.website_id
${joinSession}
where website.website_uuid='${websiteId}'
- and pageview.created_at between $2 and $3
+ and pageview.created_at between $1 and $2
${pageviewQuery}
${sessionQuery}
group by 1`,
diff --git a/queries/analytics/session/getSessionMetrics.js b/queries/analytics/session/getSessionMetrics.js
index cbf3ed589..020bddfbd 100644
--- a/queries/analytics/session/getSessionMetrics.js
+++ b/queries/analytics/session/getSessionMetrics.js
@@ -11,7 +11,7 @@ export async function getSessionMetrics(...args) {
async function relationalQuery(websiteId, { startDate, endDate, field, filters = {} }) {
const { parseFilters, rawQuery } = prisma;
- const params = [websiteId, startDate, endDate];
+ const params = [startDate, endDate];
const { pageviewQuery, sessionQuery, joinSession } = parseFilters(null, filters, params);
return rawQuery(
@@ -24,7 +24,7 @@ async function relationalQuery(websiteId, { startDate, endDate, field, filters =
on pageview.website_id = website.website_id
${joinSession}
where website.website_uuid='${websiteId}'
- and pageview.created_at between $2 and $3
+ and pageview.created_at between $1 and $2
${pageviewQuery}
${sessionQuery}
)
diff --git a/queries/analytics/stats/getActiveVisitors.js b/queries/analytics/stats/getActiveVisitors.js
index 9d6b1f09e..3a898d94c 100644
--- a/queries/analytics/stats/getActiveVisitors.js
+++ b/queries/analytics/stats/getActiveVisitors.js
@@ -12,7 +12,7 @@ export async function getActiveVisitors(...args) {
async function relationalQuery(websiteId) {
const date = subMinutes(new Date(), 5);
- const params = [websiteId, date];
+ const params = [date];
return prisma.rawQuery(
`select count(distinct session_id) x
@@ -20,7 +20,7 @@ async function relationalQuery(websiteId) {
join website
on pageview.website_id = website.website_id
where website.website_uuid = '${websiteId}'
- and pageview.created_at >= $2`,
+ and pageview.created_at >= $1`,
params,
);
}
diff --git a/queries/analytics/stats/getWebsiteStats.js b/queries/analytics/stats/getWebsiteStats.js
index b6bf7b878..134e1c3ed 100644
--- a/queries/analytics/stats/getWebsiteStats.js
+++ b/queries/analytics/stats/getWebsiteStats.js
@@ -11,7 +11,7 @@ export async function getWebsiteStats(...args) {
async function relationalQuery(websiteId, { start_at, end_at, filters = {} }) {
const { getDateQuery, getTimestampInterval, parseFilters, rawQuery } = prisma;
- const params = [websiteId, start_at, end_at];
+ const params = [start_at, end_at];
const { pageviewQuery, sessionQuery, joinSession } = parseFilters(
'pageview',
null,
@@ -34,7 +34,7 @@ async function relationalQuery(websiteId, { start_at, end_at, filters = {} }) {
on pageview.website_id = website.website_id
${joinSession}
where website.website_uuid='${websiteId}'
- and pageview.created_at between $2 and $3
+ and pageview.created_at between $1 and $2
${pageviewQuery}
${sessionQuery}
group by 1, 2
diff --git a/queries/index.js b/queries/index.js
index d6b4093aa..abff147ab 100644
--- a/queries/index.js
+++ b/queries/index.js
@@ -17,6 +17,7 @@ export * from './admin/website/resetWebsite';
export * from './admin/website/updateWebsite';
export * from './analytics/event/getEventMetrics';
export * from './analytics/event/getEvents';
+export * from './analytics/event/getEventData';
export * from './analytics/event/saveEvent';
export * from './analytics/pageview/getPageviewMetrics';
export * from './analytics/pageview/getPageviewParams';