📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
- Refactor and simplify query for custom events - Move query to service - Add validation for Cloudflare in createViewDto - Update migrations
Yehor Dremliuha145b6e591151
diff --git a/apps/production/src/analytics/analytics.controller.ts b/apps/production/src/analytics/analytics.controller.tsindex cca2bb2a8..388aeaf3e 100644--- a/apps/production/src/analytics/analytics.controller.ts+++ b/apps/production/src/analytics/analytics.controller.ts@@ -93,7 +93,6 @@ import { GetErrorDTO } from './dto/get-error.dto'import { PatchStatusDTO } from './dto/patch-status.dto'import { ProjectService } from '../project/project.service'import { ProjectsViewsRepository } from '../project/repositories/projects-views.repository'-import { ProjectViewCustomEventMetaValueType } from '../project/entity/project-view-custom-event.entity'// eslint-disable-next-line @typescript-eslint/no-var-requiresconst mysql = require('mysql2')@@ -429,52 +428,11 @@ export class AnalyticsController {}))const metaKeys = customEvents.map(event => event.metaKey)-- const query = `- SELECT- key,- sum(- CASE- ${customEvents- .map(- event => `- WHEN key = '${event.metaKey}' THEN ${- event.metaValueType ===- ProjectViewCustomEventMetaValueType.INTEGER- ? 'toInt32OrZero(value)'- : 'toFloat32OrZero(value)'- }- `,- )- .join('')}- ELSE 0- END- ) AS sum,- avg(- CASE- ${customEvents- .map(- event => `- WHEN key = '${event.metaKey}' THEN ${- event.metaValueType ===- ProjectViewCustomEventMetaValueType.INTEGER- ? 'toInt32OrZero(value)'- : 'toFloat32OrZero(value)'- }- `,- )- .join('')}- ELSE 0- END- ) AS avg- FROM customEV- ARRAY JOIN meta.key AS key, meta.value AS value- WHERE pid = {pid:String} AND key IN (${metaKeys.map(key => `'${key}'`).join(', ')})- GROUP BY key- `- const metaResult = await clickhouse- .query(query, { params: { pid } })- .toPromise()+ const metaResult = await this.analyticsService.getMetaResult(+ pid,+ metaKeys,+ customEvents,+ )let newTimebucket = timeBucketlet allowedTumebucketForPeriodAlldiff --git a/apps/production/src/analytics/analytics.service.ts b/apps/production/src/analytics/analytics.service.tsindex ab6dda25f..2de5d684b 100644--- a/apps/production/src/analytics/analytics.service.ts+++ b/apps/production/src/analytics/analytics.service.ts@@ -3670,4 +3670,52 @@ export class AnalyticsService {events,}}++ async getMetaResult(+ pid: string,+ metaKeys: string[],+ customEvents: {+ customEventName: string+ metaKey: string+ metaValue: string+ metaValueType: string+ }[],+ ) {+ const casesSum = customEvents+ .map(+ event => `+ WHEN key = '${event.metaKey}' THEN ${+ event.metaValueType === 'INTEGER'+ ? 'toInt32OrZero(value)'+ : 'toFloat32OrZero(value)'+ }+ `,+ )+ .join(' ')++ const casesAvg = customEvents+ .map(+ event => `+ WHEN key = '${event.metaKey}' THEN ${+ event.metaValueType === 'INTEGER'+ ? 'toInt32OrZero(value)'+ : 'toFloat32OrZero(value)'+ }+ `,+ )+ .join(' ')++ const query = `+ SELECT+ key,+ sum(CASE ${casesSum} ELSE 0 END) AS sum,+ avg(CASE ${casesAvg} ELSE 0 END) AS avg+ FROM customEV+ ARRAY JOIN meta.key AS key, meta.value AS value+ WHERE pid = {pid:String} AND key IN (${metaKeys.map(key => `'${key}'`).join(', ')})+ GROUP BY key+ `++ return clickhouse.query(query, { params: { pid } }).toPromise()+ }}diff --git a/apps/production/src/project/dto/create-project-view.dto.ts b/apps/production/src/project/dto/create-project-view.dto.tsindex d5743ffc7..b5e4f7896 100644--- a/apps/production/src/project/dto/create-project-view.dto.ts+++ b/apps/production/src/project/dto/create-project-view.dto.ts@@ -14,33 +14,38 @@ import { ApiProperty } from '@nestjs/swagger'import { ProjectViewType } from '../entity/project-view.entity'import { ProjectViewCustomEventMetaValueType } from '../entity/project-view-custom-event.entity'-export enum OperatingSystem {- Windows = 'Windows',- MacOS = 'Mac OS',- Android = 'Android',- iOS = 'iOS',- Linux = 'Linux',- Ubuntu = 'Ubuntu',- ChromiumOS = 'Chromium OS',- Fedora = 'Fedora',- FreeBSD = 'FreeBSD',- Tizen = 'Tizen',-}+import { registerDecorator, ValidationOptions, ValidatorConstraint, ValidatorConstraintInterface } from 'class-validator'+import { isISO31661Alpha2 } from 'class-validator'+++// This can be updated by the customer request.+// In case we find out that ``cc`` may have any other values, just extend the ``allowedValues`` defined below+// Current implementation is for ``Cloudflare``++const allowedValues = ['T1', 'XX']++@ValidatorConstraint({ async: false })+export class IsISO31661Alpha2OrCustomConstraint implements ValidatorConstraintInterface {+ validate(value: any) {-export enum Browser {- Chrome = 'Chrome',- Firefox = 'Firefox',- MobileSafari = 'Mobile Safari',- Safari = 'Safari',- SamsungBrowser = 'Samsung Browser',+ return isISO31661Alpha2(value) || allowedValues.includes(value)+ }++ defaultMessage() {+ return `cc must be a valid ISO 3166-1 alpha-2 country code or one of the following: ${allowedValues}`+ }}-export enum Device {- Desktop = 'Desktop',- Mobile = 'Mobile',- Tablet = 'Tablet',- Wearable = 'Wearable',- SmartTV = 'Smarttv',+export function IsISO31661Alpha2OrCustom(validationOptions?: ValidationOptions) {+ return function (object: Object, propertyName: string) {+ registerDecorator({+ target: object.constructor,+ propertyName: propertyName,+ options: validationOptions,+ constraints: [],+ validator: IsISO31661Alpha2OrCustomConstraint,+ })+ }}export class ProjectViewCustomEventDto {@@ -103,17 +108,17 @@ export class CreateProjectViewDto {description: 'User device (mobile, desktop, tablet, etc.)',nullable: true,})- @IsEnum(Device)+ @IsString()@IsOptional()dv?: string@ApiProperty({ description: 'Browser', nullable: true })- @IsEnum(Browser)+ @IsString()@IsOptional()br?: string@ApiProperty({ description: 'Operating system', nullable: true })- @IsEnum(OperatingSystem)+ @IsString()@IsOptional()os?: string@@ -155,7 +160,7 @@ export class CreateProjectViewDto {ca?: string@ApiProperty({ description: 'Country code', nullable: true })- @IsISO31661Alpha2()+ @IsISO31661Alpha2OrCustom()@IsNotEmpty()cc: stringdiff --git a/migrations/mysql/2024_07_08.sql b/migrations/mysql/2024_07_08.sqlindex fa95b6263..ac969a963 100644--- a/migrations/mysql/2024_07_08.sql+++ b/migrations/mysql/2024_07_08.sql@@ -18,8 +18,8 @@ CREATE TABLE projects_views (ct VARCHAR(255) NULL,createdAt DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),updatedAt DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),- CONSTRAINT fk_project FOREIGN KEY (projectId) REFERENCES projects(id) ON DELETE CASCADE-);+ FOREIGN KEY (projectId) REFERENCES projects(id) ON DELETE CASCADE+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE projects_views_custom_events (@@ -31,5 +31,6 @@ CREATE TABLE projects_views_custom_events (metaValueType ENUM('string', 'integer', 'float') NOT NULL DEFAULT 'string',createdAt DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),updatedAt DATETIME(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),- CONSTRAINT fk_view FOREIGN KEY (viewId) REFERENCES projects_views(id) ON DELETE CASCADE-);+ FOREIGN KEY (viewId) REFERENCES projects_views(id) ON DELETE CASCADE+)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;+