Re-write CH queries to use query params.

lib/clickhouse.js

@@ -1,231 +0,0 @@
-import { ClickHouse } from 'clickhouse';
-import dateFormat from 'dateformat';
-import debug from 'debug';
-import { FILTER_IGNORED } from 'lib/constants';
-import { CLICKHOUSE } from 'lib/db';
-
-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;
-const enabled = Boolean(process.env.CLICKHOUSE_URL);
-
-function getClient() {
-  const {
-    hostname,
-    port,
-    pathname,
-    username = 'default',
-    password,
-  } = new URL(process.env.CLICKHOUSE_URL);
-
-  const client = new ClickHouse({
-    url: hostname,
-    port: Number(port),
-    format: 'json',
-    config: {
-      database: pathname.replace('/', ''),
-    },
-    basicAuth: password ? { username, password } : null,
-  });
-
-  if (process.env.NODE_ENV !== 'production') {
-    global[CLICKHOUSE] = client;
-  }
-
-  log('Clickhouse initialized');
-
-  return client;
-}
-
-function getDateStringQuery(data, unit) {
-  return `formatDateTime(${data}, '${CLICKHOUSE_DATE_FORMATS[unit]}')`;
-}
-
-function getDateQuery(field, unit, timezone) {
-  if (timezone) {
-    return `date_trunc('${unit}', ${field}, '${timezone}')`;
-  }
-  return `date_trunc('${unit}', ${field})`;
-}
-
-function getDateFormat(date) {
-  return `'${dateFormat(date, 'UTC:yyyy-mm-dd HH:MM:ss')}'`;
-}
-
-function getCommaSeparatedStringFormat(data) {
-  return data.map(a => `'${a}'`).join(',') || '';
-}
-
-function getBetweenDates(field, start_at, 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 "${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;
-    }
-
-    arr.push(
-      `${getJsonField(column, key)} = ${typeof filter === 'string' ? `'${filter}'` : filter}`,
-    );
-
-    return arr;
-  }, []);
-
-  return query.join('\nand ');
-}
-
-function getFilterQuery(filters = {}, params = []) {
-  const query = Object.keys(filters).reduce((arr, key) => {
-    const filter = filters[key];
-
-    if (filter === undefined || filter === FILTER_IGNORED) {
-      return arr;
-    }
-
-    switch (key) {
-      case 'url':
-      case 'os':
-      case 'browser':
-      case 'device':
-      case 'country':
-      case 'event_name':
-        arr.push(`and ${key}=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
-
-      case 'referrer':
-        arr.push(`and referrer like $${params.length + 1}`);
-        params.push(`%${decodeURIComponent(filter)}%`);
-        break;
-
-      case 'domain':
-        arr.push(`and referrer not like $${params.length + 1}`);
-        arr.push(`and referrer not like '/%'`);
-        params.push(`%://${filter}/%`);
-        break;
-
-      case 'query':
-        arr.push(`and url like '%?%'`);
-    }
-
-    return arr;
-  }, []);
-
-  return query.join('\n');
-}
-
-function parseFilters(filters = {}, params = []) {
-  const { domain, url, event_url, referrer, os, browser, device, country, event_name, query } =
-    filters;
-
-  const pageviewFilters = { domain, url, referrer, query };
-  const sessionFilters = { os, browser, device, country };
-  const eventFilters = { url: event_url, event_name };
-
-  return {
-    pageviewFilters,
-    sessionFilters,
-    eventFilters,
-    event: { event_name },
-    filterQuery: getFilterQuery(filters, params),
-  };
-}
-
-function formatQuery(str, params = []) {
-  let formattedString = str;
-
-  params.forEach((param, i) => {
-    let replace = param;
-
-    if (typeof param === 'string' || param instanceof String) {
-      replace = `'${replace}'`;
-    }
-
-    formattedString = formattedString.replace(`$${i + 1}`, replace);
-  });
-
-  return formattedString;
-}
-
-async function rawQuery(query, params = []) {
-  let formattedQuery = formatQuery(query, params);
-
-  if (process.env.LOG_QUERY) {
-    log(formattedQuery);
-  }
-
-  await connect();
-
-  return clickhouse.query(formattedQuery).toPromise();
-}
-
-async function findUnique(data) {
-  if (data.length > 1) {
-    throw `${data.length} records found when expecting 1.`;
-  }
-
-  return data[0] ?? null;
-}
-
-async function findFirst(data) {
-  return data[0] ?? null;
-}
-
-async function connect() {
-  if (!clickhouse) {
-    clickhouse = process.env.CLICKHOUSE_URL && (global[CLICKHOUSE] || getClient());
-  }
-
-  return clickhouse;
-}
-
-export default {
-  enabled,
-  client: clickhouse,
-  log,
-  connect,
-  getDateStringQuery,
-  getDateQuery,
-  getDateFormat,
-  getCommaSeparatedStringFormat,
-  getBetweenDates,
-  getEventDataColumnsQuery,
-  getEventDataFilterQuery,
-  getFilterQuery,
-  parseFilters,
-  findUnique,
-  findFirst,
-  rawQuery,
-};