Merge pull request #15 from pagevamp/feat-analytics-filter

Feat analytics filter

Author: laxman-aqw

.env.example

@@ -0,0 +1,17 @@
+NODE_ENV=development
+DB_PORT=5432
+DB_TYPE=postgres
+DB_HOST=db
+DB_USERNAME=
+DB_PASSWORD=
+DB_NAME=postgres
+DB_LOGGING=
+JWT_SECRET=
+JWT_VERIFICATION_TOKEN_SECRET=
+JWT_VERIFICATION_TOKEN_EXPIRATION_TIME=3600
+EMAIL_CONFIRMATION_URL=
+EMAIL_SERVICE=
+EMAIL_USER=
+EMAIL_PASS=
+ENCRYPTION_KEY=
+REDIRECT_BASE_URL = 

src/analytics/analytics.controller.ts

@@ -0,0 +1,30 @@
+import {
+  Body,
+  Controller,
+  Get,
+  HttpCode,
+  HttpStatus,
+  Query,
+  Req,
+  UseGuards,
+} from '@nestjs/common';
+import { FilterAnalyticsRequestData } from './dto/filter-analytics-request-data';
+import { AnalyticsService } from './analytics.service';
+import { AuthGuard } from 'src/auth/auth.guard';
+import type { RequestWithUser } from 'src/types/RequestWithUser';
+
+@Controller('analytics')
+export class AnalyticsController {
+  constructor(private readonly analyticsService: AnalyticsService) {}
+
+  @UseGuards(AuthGuard)
+  @HttpCode(HttpStatus.OK)
+  @Get()
+  async filterUrlAnalytics(
+    @Query() query: FilterAnalyticsRequestData,
+    @Req() request: RequestWithUser,
+  ) {
+    const userId = request.decodedData.sub;
+    return this.analyticsService.getAnalytics(query, userId);
+  }
+}

src/analytics/analytics.entity.ts

@@ -5,31 +5,36 @@ import {
   ManyToOne,
   JoinColumn,
   CreateDateColumn,
+  Index,
 } from 'typeorm';
 import { Url } from 'src/url/url.entity';
 
 @Entity({ name: 'url_analytics' })
 export class UrlAnalytics {
+  @Index()
   @PrimaryGeneratedColumn('uuid')
   readonly id: string;
 
   @Column({ type: 'uuid', name: 'url_id' })
   readonly urlId: string;
 
   @Column({ type: 'varchar', length: 40, nullable: true, name: 'country' })
-  readonly country: string;
+  readonly country: string | null;
 
   @Column({ type: 'varchar', length: 50, nullable: true, name: 'device' })
-  readonly device: string;
+  readonly device: string | null;
+
+  @Column({ type: 'varchar', length: 40, nullable: true, name: 'os' })
+  readonly os: string | null;
 
   @Column({ type: 'varchar', length: 40, nullable: true, name: 'browser' })
-  readonly browser: string;
+  readonly browser: string | null;
 
-  @Column({ type: 'varchar', length: 100, nullable: true, name: 'ip' })
-  readonly ip: string;
+  @Column({ type: 'varchar', length: 100, nullable: true, name: 'ip_address' })
+  readonly ipAddress: string | null;
 
   @Column({ type: 'varchar', length: 255, nullable: true, name: 'user_agent' })
-  readonly userAgent: string;
+  readonly userAgent: string | null;
 
   @CreateDateColumn({ type: 'timestamp with time zone', name: 'redirected_at' })
   readonly redirectedAt: Date;

src/analytics/analytics.module.ts

@@ -2,11 +2,13 @@ import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { AnalyticsService } from './analytics.service';
 import { UrlAnalytics } from './analytics.entity';
+import { AnalyticsController } from './analytics.controller';
+import { AuthModule } from 'src/auth/auth.module';
 
 @Module({
-  imports: [TypeOrmModule.forFeature([UrlAnalytics])],
+  imports: [TypeOrmModule.forFeature([UrlAnalytics]), AuthModule],
   providers: [AnalyticsService],
   exports: [],
-  controllers: [],
+  controllers: [AnalyticsController],
 })
 export class AnalyticsModule {}

src/analytics/analytics.service.ts

@@ -1,5 +1,4 @@
 import { Injectable } from '@nestjs/common';
-import { Request } from 'express';
 import geoip from 'geoip-lite';
 import { UrlAnalytics } from './analytics.entity';
 import { InjectRepository } from '@nestjs/typeorm';
@@ -8,6 +7,7 @@ import useragent from 'useragent';
 import { ParsedUserAgent } from './types';
 import { OnEvent } from '@nestjs/event-emitter';
 import { UrlRedirectedEvent } from 'src/event/Url-redirected.events';
+import { FilterAnalyticsRequestData } from './dto/filter-analytics-request-data';
 @Injectable()
 export class AnalyticsService {
   constructor(
@@ -19,10 +19,9 @@ export class AnalyticsService {
   async recordClick(event: UrlRedirectedEvent): Promise<void> {
     const urlId = event.urlId;
     const req = event.req;
-    const ip =
-      (req.headers['x-forwarded-for'] as string)?.split(',')[0]?.trim() ||
-      req.socket?.remoteAddress?.replace('::ffff:', '') ||
-      '0.0.0.0';
+    const ipAddress = (req.headers['x-forwarded-for'] as string)
+      ?.split(',')[0]
+      ?.trim();
 
     const userAgent = req.headers['user-agent'] || '';
     const parsed = (
@@ -31,20 +30,85 @@ export class AnalyticsService {
       }
     ).parse(userAgent);
 
+    // Match the first section inside parentheses of the User-Agent string (up to the first semicolon).
+    // This typically represents the device or platform, e.g. "Windows NT 10.0" or "iPhone".
     const deviceMatch = parsed.source.match(/\(([^;]+);/);
     const device = deviceMatch ? deviceMatch[1] : 'Unknown Device';
-    const geo = geoip.lookup(ip);
+
+    // Look for known browser names followed by a version number,
+    // e.g. "Chrome/120.0", "Firefox/118.0".
+    const browserMatch = parsed.source.match(
+      /(Chrome|Firefox|Safari|Edge|Opera)\/[\d.]+/,
+    );
+    const browser = browserMatch ? browserMatch[0] : 'Unknown Browser';
+
+    // Match the substring inside parentheses that follows the first semicolon.
+    // For example, from "(Windows NT 10.0; Win64; x64)" → captures "Win64; x64".
+    const osMatch = parsed.source.match(/\((?:[^;]+);\s*([^)]+)\)/);
+
+    const os = osMatch ? osMatch[1] : 'Unknown OS';
+
+    const geo = geoip.lookup(ipAddress);
     const country = geo?.country || 'Unknown';
 
     const analytics = this.analyticsRepo.create({
       urlId,
-      ip,
-      browser: `${parsed.family} ${parsed.major}.${parsed.minor}.${parsed.patch} `,
+      os,
+      ipAddress,
+      browser: browser,
       userAgent,
       device: device,
       country,
     });
 
     await this.analyticsRepo.save(analytics);
   }
+
+  async getAnalytics(requestData: FilterAnalyticsRequestData, userId: string) {
+    const qb = this.analyticsRepo
+      .createQueryBuilder('a')
+      .innerJoin('a.url', 'url');
+
+    qb.andWhere('url.userId=:userId', { userId });
+
+    if (requestData.startDate && requestData.endDate) {
+      qb.andWhere('a.redirectedAt BETWEEN :start AND :end', {
+        start: requestData.startDate,
+        end: requestData.endDate,
+      });
+    }
+
+    if (requestData.startDate) {
+      qb.andWhere('a.redirectedAt >= :start', { start: requestData.startDate });
+    }
+
+    if (requestData.endDate) {
+      qb.andWhere('a.redirectedAt <= :end', { end: requestData.endDate });
+    }
+
+    if (requestData.browser) {
+      qb.andWhere('a.browser = :browser', { browser: requestData.browser });
+    }
+    if (requestData.country) {
+      qb.andWhere('a.country = :country', { country: requestData.country });
+    }
+
+    if (requestData.device) {
+      qb.andWhere('a.device = :device', { device: requestData.device });
+    }
+
+    if (requestData.os) {
+      qb.andWhere('a.os = :os', { os: requestData.os });
+    }
+
+    if (requestData.groupByUrl) {
+      qb.select('a.url', 'url')
+        .addSelect('COUNT(*)', 'hits')
+        .groupBy('a.url')
+        .orderBy('hits', 'DESC');
+      return qb.getRawMany();
+    }
+
+    return qb.getMany();
+  }
 }

src/analytics/dto/filter-analytics-request-data.ts

@@ -0,0 +1,44 @@
+import {
+  IsDateString,
+  isDateString,
+  IsNotEmpty,
+  IsOptional,
+} from 'class-validator';
+import { Transform } from 'class-transformer';
+
+export class FilterAnalyticsRequestData {
+  @IsOptional()
+  browser?: string | null;
+
+  @IsOptional()
+  device?: string | null;
+
+  @IsOptional()
+  groupByUrl?: boolean | null;
+
+  @IsOptional()
+  urlId?: string | null;
+
+  @IsOptional()
+  os?: string | null;
+
+  @IsOptional()
+  country?: string | null;
+
+  @IsOptional()
+  ip?: string | null;
+
+  @IsOptional()
+  @IsDateString()
+  @Transform(({ value }) => new Date(value).toUTCString(), {
+    toPlainOnly: true,
+  })
+  startDate?: Date | null;
+
+  @IsOptional()
+  @IsDateString()
+  @Transform(({ value }) => new Date(value).toUTCString(), {
+    toPlainOnly: true,
+  })
+  endDate?: Date | null;
+}

src/analytics/types.ts

@@ -4,10 +4,4 @@ export type ParsedUserAgent = {
   minor: string;
   patch: string;
   source: string;
-  device: {
-    family: string;
-    major: string;
-    minor: string;
-    patch: string;
-  };
 };

src/auth/auth.guard.ts

@@ -25,9 +25,11 @@ export class AuthGuard implements CanActivate {
     const decoded = await this.authService.validateToken(token);
     request.decodedData = decoded;
     const userData = request.decodedData;
+
     if (!userData) {
       throw new UnauthorizedException('Invalid or missing token');
     }
+
     return true;
   }
 }

src/auth/email-verification.entity.ts

@@ -6,10 +6,12 @@ import {
   CreateDateColumn,
   JoinColumn,
   OneToOne,
+  Index,
 } from 'typeorm';
 
 @Entity('email_verifications')
 export class EmailVerification {
+  @Index()
   @PrimaryGeneratedColumn('uuid')
   readonly id: string;