import { ClickHouseClient, createClient } from '@clickhouse/client'; import dateFormat from 'dateformat'; import debug from 'debug'; import { CLICKHOUSE } from 'lib/db'; import { QueryFilters, QueryOptions } from './types'; import { FILTER_COLUMNS, OPERATORS } from './constants'; import { loadWebsite } from './load'; import { maxDate } from './date'; export const CLICKHOUSE_DATE_FORMATS = { minute: '%Y-%m-%d %H:%M:00', hour: '%Y-%m-%d %H:00:00', day: '%Y-%m-%d', month: '%Y-%m-01', year: '%Y-01-01', }; const log = debug('umami:clickhouse'); let clickhouse: ClickHouseClient; const enabled = Boolean(process.env.CLICKHOUSE_URL); function getClient() { const { hostname, port, pathname, protocol, username = 'default', password, } = new URL(process.env.CLICKHOUSE_URL); const client = createClient({ host: `${protocol}//${hostname}:${port}`, database: pathname.replace('/', ''), username: username, password, }); if (process.env.NODE_ENV !== 'production') { global[CLICKHOUSE] = client; } log('Clickhouse initialized'); return client; } function getDateStringQuery(data: any, unit: string | number) { return `formatDateTime(${data}, '${CLICKHOUSE_DATE_FORMATS[unit]}')`; } function getDateQuery(field: string, unit: string, timezone?: string) { if (timezone) { return `date_trunc('${unit}', ${field}, '${timezone}')`; } return `date_trunc('${unit}', ${field})`; } function getDateFormat(date: Date) { return `'${dateFormat(date, 'UTC:yyyy-mm-dd HH:MM:ss')}'`; } function mapFilter(column: string, operator: string, name: string, type = 'String') { switch (operator) { case OPERATORS.equals: return `${column} = {${name}:${type}}`; case OPERATORS.notEquals: return `${column} != {${name}:${type}}`; default: return ''; } } function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {}) { const query = Object.keys(filters).reduce((arr, name) => { const value = filters[name]; const operator = value?.filter ?? OPERATORS.equals; const column = FILTER_COLUMNS[name] ?? options?.columns?.[name]; if (value !== undefined && column) { arr.push(`and ${mapFilter(column, operator, name)}`); if (name === 'referrer') { arr.push('and referrer_domain != {websiteDomain:String}'); } } return arr; }, []); return query.join('\n'); } function normalizeFilters(filters = {}) { return Object.keys(filters).reduce((obj, key) => { const value = filters[key]; obj[key] = value?.value ?? value; return obj; }, {}); } async function parseFilters(websiteId: string, filters: QueryFilters = {}, options?: QueryOptions) { const website = await loadWebsite(websiteId); return { filterQuery: getFilterQuery(filters, options), params: { ...normalizeFilters(filters), websiteId, startDate: maxDate(filters.startDate, new Date(website?.resetAt)), websiteDomain: website.domain, }, }; } async function rawQuery(query: string, params: Record = {}): Promise { if (process.env.LOG_QUERY) { log('QUERY:\n', query); log('PARAMETERS:\n', params); } await connect(); const resultSet = await clickhouse.query({ query: query, query_params: params, format: 'JSONEachRow', }); return resultSet.json(); } async function findUnique(data: any[]) { if (data.length > 1) { throw `${data.length} records found when expecting 1.`; } return findFirst(data); } async function findFirst(data: any[]) { return data[0] ?? null; } async function connect() { if (enabled && !clickhouse) { clickhouse = process.env.CLICKHOUSE_URL && (global[CLICKHOUSE] || getClient()); } return clickhouse; } export default { enabled, client: clickhouse, log, connect, getDateStringQuery, getDateQuery, getDateFormat, getFilterQuery, parseFilters, findUnique, findFirst, rawQuery, };