umami/lib/queries.js

596 lines
13 KiB
JavaScript
Raw Normal View History

2020-08-12 05:05:40 +02:00
import moment from 'moment-timezone';
2020-09-25 08:02:11 +02:00
import prisma from 'lib/db';
2020-08-18 09:51:32 +02:00
import { subMinutes } from 'date-fns';
2021-03-13 08:45:19 +01:00
import {
MYSQL,
POSTGRESQL,
MYSQL_DATE_FORMATS,
POSTGRESQL_DATE_FORMATS,
URL_LENGTH,
} from 'lib/constants';
2020-08-12 05:05:40 +02:00
export function getDatabase() {
const type =
2020-08-30 09:02:03 +02:00
process.env.DATABASE_TYPE ||
(process.env.DATABASE_URL && process.env.DATABASE_URL.split(':')[0]);
if (type === 'postgres') {
return 'postgresql';
}
return type;
2020-08-12 05:05:40 +02:00
}
2020-09-25 08:02:11 +02:00
export function getDateQuery(field, unit, timezone) {
const db = getDatabase();
if (db === POSTGRESQL) {
if (timezone) {
return `to_char(date_trunc('${unit}', ${field} at time zone '${timezone}'), '${POSTGRESQL_DATE_FORMATS[unit]}')`;
}
return `to_char(date_trunc('${unit}', ${field}), '${POSTGRESQL_DATE_FORMATS[unit]}')`;
}
if (db === MYSQL) {
if (timezone) {
const tz = moment.tz(timezone).format('Z');
return `DATE_FORMAT(convert_tz(${field},'+00:00','${tz}'), '${MYSQL_DATE_FORMATS[unit]}')`;
}
return `DATE_FORMAT(${field}, '${MYSQL_DATE_FORMATS[unit]}')`;
}
}
2020-09-25 08:02:11 +02:00
export function getTimestampInterval(field) {
const db = getDatabase();
if (db === POSTGRESQL) {
return `floor(extract(epoch from max(${field}) - min(${field})))`;
}
if (db === MYSQL) {
return `floor(unix_timestamp(max(${field})) - unix_timestamp(min(${field})))`;
}
}
2022-04-10 12:51:43 +02:00
export function getFilterQuery(table, filters = {}, params = []) {
const query = Object.keys(filters).reduce((arr, key) => {
const value = filters[key];
if (value === undefined) {
return arr;
}
switch (key) {
case 'url':
2022-04-14 04:04:06 +02:00
if (table === 'pageview' || table === 'event') {
2022-04-10 12:51:43 +02:00
arr.push(`and ${table}.${key}=$${params.length + 1}`);
params.push(decodeURIComponent(value));
}
break;
case 'os':
case 'browser':
case 'device':
case 'country':
if (table === 'session') {
arr.push(`and ${table}.${key}=$${params.length + 1}`);
params.push(decodeURIComponent(value));
}
break;
case 'event_type':
if (table === 'event') {
arr.push(`and ${table}.${key}=$${params.length + 1}`);
params.push(decodeURIComponent(value));
}
break;
case 'referrer':
if (table === 'pageview') {
arr.push(`and ${table}.referrer like $${params.length + 1}`);
params.push(`%${decodeURIComponent(value)}%`);
}
break;
case 'domain':
if (table === 'pageview') {
arr.push(`and ${table}.referrer not like $${params.length + 1}`);
arr.push(`and ${table}.referrer not like '/%'`);
params.push(`%://${value}/%`);
}
break;
}
return arr;
}, []);
return query.join('\n');
}
2022-04-11 09:19:29 +02:00
export function parseFilters(table, filters = {}, params = []) {
2022-04-14 04:04:06 +02:00
const { domain, url, event_url, referrer, os, browser, device, country, event_type } = filters;
2022-04-11 09:19:29 +02:00
const pageviewFilters = { domain, url, referrer };
const sessionFilters = { os, browser, device, country };
2022-04-14 04:04:06 +02:00
const eventFilters = { url: event_url, event_type };
2022-04-11 09:19:29 +02:00
return {
pageviewFilters,
sessionFilters,
eventFilters,
event: { event_type },
joinSession:
os || browser || device || country
? `inner join session on ${table}.session_id = session.session_id`
: '',
pageviewQuery: getFilterQuery('pageview', pageviewFilters, params),
sessionQuery: getFilterQuery('session', sessionFilters, params),
eventQuery: getFilterQuery('event', eventFilters, params),
};
}
2022-04-10 12:51:43 +02:00
export async function runQuery(query) {
return query.catch(e => {
throw e;
});
}
export async function rawQuery(query, params = []) {
const db = getDatabase();
if (db !== POSTGRESQL && db !== MYSQL) {
return Promise.reject(new Error('Unknown database.'));
}
const sql = db === MYSQL ? query.replace(/\$[0-9]+/g, '?') : query;
return runQuery(prisma.$queryRawUnsafe.apply(prisma, [sql, ...params]));
}
2020-08-12 07:24:41 +02:00
export async function getWebsiteById(website_id) {
return runQuery(
prisma.website.findUnique({
2020-08-12 07:24:41 +02:00
where: {
website_id,
},
}),
);
}
export async function getWebsiteByUuid(website_uuid) {
return runQuery(
prisma.website.findUnique({
2020-08-12 07:24:41 +02:00
where: {
website_uuid,
},
}),
);
}
2020-08-15 10:17:15 +02:00
export async function getWebsiteByShareId(share_id) {
return runQuery(
prisma.website.findUnique({
2020-08-15 10:17:15 +02:00
where: {
share_id,
},
}),
);
}
2020-08-12 07:24:41 +02:00
export async function getUserWebsites(user_id) {
return runQuery(
prisma.website.findMany({
where: {
user_id,
},
orderBy: {
name: 'asc',
},
}),
);
}
export async function getAllWebsites() {
let data = await runQuery(
prisma.website.findMany({
orderBy: [
{
user_id: 'asc',
},
{
name: 'asc',
},
],
include: {
account: {
select: {
username: true,
},
},
},
}),
);
return data.map(i => ({ ...i, account: i.account.username }));
}
2020-08-12 07:24:41 +02:00
export async function createWebsite(user_id, data) {
return runQuery(
prisma.website.create({
data: {
account: {
connect: {
user_id,
},
},
...data,
},
}),
);
}
export async function updateWebsite(website_id, data) {
return runQuery(
prisma.website.update({
where: {
website_id,
},
data,
}),
);
}
export async function resetWebsite(website_id) {
return runQuery(prisma.$queryRaw`delete from session where website_id=${website_id}`);
}
2020-08-12 07:24:41 +02:00
export async function deleteWebsite(website_id) {
return runQuery(
prisma.website.delete({
where: {
website_id,
},
}),
);
}
export async function createSession(website_id, data) {
return runQuery(
prisma.session.create({
data: {
2021-03-25 13:44:37 +01:00
website_id,
2020-08-12 07:24:41 +02:00
...data,
},
select: {
session_id: true,
},
}),
);
}
export async function getSessionByUuid(session_uuid) {
return runQuery(
prisma.session.findUnique({
2020-08-12 07:24:41 +02:00
where: {
session_uuid,
},
}),
);
}
export async function savePageView(website_id, session_id, url, referrer) {
return runQuery(
prisma.pageview.create({
data: {
2021-03-25 13:44:37 +01:00
website_id,
session_id,
2021-03-27 04:56:08 +01:00
url: url?.substr(0, URL_LENGTH),
referrer: referrer?.substr(0, URL_LENGTH),
2020-08-12 07:24:41 +02:00
},
}),
);
}
export async function saveEvent(website_id, session_id, url, event_type, event_value) {
return runQuery(
prisma.event.create({
data: {
2021-03-25 13:44:37 +01:00
website_id,
session_id,
2021-03-27 04:56:08 +01:00
url: url?.substr(0, URL_LENGTH),
event_type: event_type?.substr(0, 50),
event_value: event_value?.substr(0, 50),
2020-08-12 07:24:41 +02:00
},
}),
);
}
export async function getAccounts() {
2022-04-04 07:25:32 +02:00
return runQuery(
prisma.account.findMany({
orderBy: [
{ is_admin: 'desc' },
{
username: 'asc',
},
],
}),
);
2020-08-12 07:24:41 +02:00
}
export async function getAccountById(user_id) {
return runQuery(
prisma.account.findUnique({
2020-08-12 07:24:41 +02:00
where: {
user_id,
},
}),
);
}
export async function getAccountByUsername(username) {
return runQuery(
prisma.account.findUnique({
2020-08-12 07:24:41 +02:00
where: {
username,
},
}),
);
}
export async function updateAccount(user_id, data) {
return runQuery(
prisma.account.update({
where: {
user_id,
},
data,
}),
);
}
export async function deleteAccount(user_id) {
return runQuery(
prisma.account.delete({
where: {
user_id,
},
}),
);
}
export async function createAccount(data) {
return runQuery(
prisma.account.create({
data,
}),
);
}
2020-10-09 08:26:05 +02:00
export async function getSessions(websites, start_at) {
return runQuery(
prisma.session.findMany({
where: {
website: {
website_id: {
in: websites,
},
},
created_at: {
gte: start_at,
},
},
}),
);
}
export async function getPageviews(websites, start_at) {
return runQuery(
prisma.pageview.findMany({
where: {
website: {
website_id: {
in: websites,
},
},
created_at: {
gte: start_at,
},
},
}),
);
}
export async function getEvents(websites, start_at) {
return runQuery(
prisma.event.findMany({
where: {
website: {
website_id: {
in: websites,
},
},
created_at: {
gte: start_at,
},
},
}),
);
}
export function getWebsiteStats(website_id, start_at, end_at, filters = {}) {
2020-09-26 07:31:18 +02:00
const params = [website_id, start_at, end_at];
2022-04-11 09:19:29 +02:00
const { pageviewQuery, sessionQuery, joinSession } = parseFilters('pageview', filters, params);
2021-11-22 07:00:14 +01:00
2020-09-25 08:02:11 +02:00
return rawQuery(
`
2020-08-12 05:05:40 +02:00
select sum(t.c) as "pageviews",
count(distinct t.session_id) as "uniques",
2020-08-24 19:52:47 +02:00
sum(case when t.c = 1 then 1 else 0 end) as "bounces",
2020-08-12 05:05:40 +02:00
sum(t.time) as "totaltime"
from (
2022-04-10 12:51:43 +02:00
select pageview.session_id,
${getDateQuery('pageview.created_at', 'hour')},
2020-08-12 05:05:40 +02:00
count(*) c,
2022-04-10 12:51:43 +02:00
${getTimestampInterval('pageview.created_at')} as "time"
2020-08-12 05:05:40 +02:00
from pageview
2022-04-10 12:51:43 +02:00
${joinSession}
where pageview.website_id=$1
and pageview.created_at between $2 and $3
2022-04-11 09:19:29 +02:00
${pageviewQuery}
${sessionQuery}
2020-08-12 05:05:40 +02:00
group by 1, 2
) t
2020-09-25 08:02:11 +02:00
`,
2020-09-26 07:31:18 +02:00
params,
2020-09-25 08:02:11 +02:00
);
2020-08-12 05:05:40 +02:00
}
export function getPageviewStats(
2020-08-12 07:24:41 +02:00
website_id,
start_at,
end_at,
timezone = 'utc',
unit = 'day',
count = '*',
2021-11-22 07:00:14 +01:00
filters = {},
2020-08-12 07:24:41 +02:00
) {
2020-09-26 07:31:18 +02:00
const params = [website_id, start_at, end_at];
2022-04-11 09:19:29 +02:00
const { pageviewQuery, sessionQuery, joinSession } = parseFilters('pageview', filters, params);
2021-11-22 07:00:14 +01:00
2020-09-25 08:02:11 +02:00
return rawQuery(
`
2022-04-10 12:51:43 +02:00
select ${getDateQuery('pageview.created_at', unit, timezone)} t,
2020-09-25 08:02:11 +02:00
count(${count}) y
from pageview
2022-04-10 12:51:43 +02:00
${joinSession}
where pageview.website_id=$1
and pageview.created_at between $2 and $3
2022-04-11 09:19:29 +02:00
${pageviewQuery}
${sessionQuery}
2020-09-25 08:02:11 +02:00
group by 1
order by 1
`,
2020-09-26 07:31:18 +02:00
params,
2020-09-25 08:02:11 +02:00
);
2020-08-12 05:05:40 +02:00
}
export function getSessionMetrics(website_id, start_at, end_at, field, filters = {}) {
2020-09-26 07:31:18 +02:00
const params = [website_id, start_at, end_at];
2022-04-11 09:19:29 +02:00
const { pageviewQuery, sessionQuery, joinSession } = parseFilters('pageview', filters, params);
return rawQuery(
`
select ${field} x, count(*) y
2022-04-10 12:51:43 +02:00
from session as x
where x.session_id in (
select pageview.session_id
from pageview
2022-04-10 12:51:43 +02:00
${joinSession}
where pageview.website_id=$1
and pageview.created_at between $2 and $3
2022-04-11 09:19:29 +02:00
${pageviewQuery}
${sessionQuery}
)
group by 1
order by 2 desc
`,
2020-09-26 07:31:18 +02:00
params,
);
}
export function getPageviewMetrics(website_id, start_at, end_at, field, table, filters = {}) {
2020-09-26 07:31:18 +02:00
const params = [website_id, start_at, end_at];
2022-04-14 04:04:06 +02:00
const { pageviewQuery, sessionQuery, eventQuery, joinSession } = parseFilters(
table,
filters,
params,
);
2020-09-25 08:02:11 +02:00
return rawQuery(
`
select ${field} x, count(*) y
2020-09-25 08:02:11 +02:00
from ${table}
2022-04-10 12:51:43 +02:00
${joinSession}
where ${table}.website_id=$1
and ${table}.created_at between $2 and $3
2022-04-11 09:19:29 +02:00
${pageviewQuery}
${joinSession && sessionQuery}
2022-04-14 04:04:06 +02:00
${eventQuery}
2020-09-25 08:02:11 +02:00
group by 1
order by 2 desc
`,
2020-09-26 07:31:18 +02:00
params,
2020-09-25 08:02:11 +02:00
);
2020-08-12 05:05:40 +02:00
}
2020-08-18 09:51:32 +02:00
export function getActiveVisitors(website_id) {
2020-08-19 03:33:59 +02:00
const date = subMinutes(new Date(), 5);
2020-09-26 07:31:18 +02:00
const params = [website_id, date];
2020-08-19 03:33:59 +02:00
2020-09-25 08:02:11 +02:00
return rawQuery(
`
2020-08-18 09:51:32 +02:00
select count(distinct session_id) x
from pageview
where website_id=$1
and created_at >= $2
`,
2020-09-26 07:31:18 +02:00
params,
2020-09-25 08:02:11 +02:00
);
2020-08-18 09:51:32 +02:00
}
2020-08-25 08:49:14 +02:00
2020-10-09 08:26:05 +02:00
export function getEventMetrics(
website_id,
start_at,
end_at,
timezone = 'utc',
unit = 'day',
filters = {},
) {
2020-09-26 07:31:18 +02:00
const params = [website_id, start_at, end_at];
2020-09-25 08:02:11 +02:00
return rawQuery(
`
select
event_value x,
${getDateQuery('created_at', unit, timezone)} t,
count(*) y
from event
where website_id=$1
and created_at between $2 and $3
2022-04-10 12:51:43 +02:00
${getFilterQuery('event', filters, params)}
2020-09-25 08:02:11 +02:00
group by 1, 2
order by 2
`,
2020-09-26 07:31:18 +02:00
params,
2020-09-25 08:02:11 +02:00
);
2020-08-27 12:42:24 +02:00
}
export async function getRealtimeData(websites, time) {
const [pageviews, sessions, events] = await Promise.all([
getPageviews(websites, time),
getSessions(websites, time),
getEvents(websites, time),
]);
return {
pageviews: pageviews.map(({ view_id, ...props }) => ({
__id: `p${view_id}`,
view_id,
...props,
})),
sessions: sessions.map(({ session_id, ...props }) => ({
__id: `s${session_id}`,
session_id,
...props,
})),
events: events.map(({ event_id, ...props }) => ({
__id: `e${event_id}`,
event_id,
...props,
})),
timestamp: Date.now(),
};
}