Addressed pr review changes

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.entity.ts

@@ -5,34 +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;
+  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.service.ts

@@ -19,7 +19,7 @@ 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)
+    const ipAddress = (req.headers['x-forwarded-for'] as string)
       ?.split(',')[0]
       ?.trim();
 
@@ -30,25 +30,31 @@ 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';
 
+    // 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(ip);
+    const geo = geoip.lookup(ipAddress);
     const country = geo?.country || 'Unknown';
 
     const analytics = this.analyticsRepo.create({
       urlId,
       os,
-      ip,
+      ipAddress,
       browser: browser,
       userAgent,
       device: device,
@@ -70,9 +76,13 @@ export class AnalyticsService {
         start: requestData.startDate,
         end: requestData.endDate,
       });
-    } else if (requestData.startDate) {
+    }
+
+    if (requestData.startDate) {
       qb.andWhere('a.redirectedAt >= :start', { start: requestData.startDate });
-    } else if (requestData.endDate) {
+    }
+
+    if (requestData.endDate) {
       qb.andWhere('a.redirectedAt <= :end', { end: requestData.endDate });
     }
 

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

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

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;
 

src/migrations/1762158558309-renameIpColumn.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class RenameIpColumn1762158558309 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+    ALTER TABLE "url_analytics"
+      RENAME COLUMN "ip" TO "ip_address";
+            `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE "url_analytics"
+      RENAME COLUMN "ip_address" TO "ip";
+    `);
+  }
+}

src/migrations/1762159175018-relengthUserAgent.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class RelengthUserAgent1762159175018 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        ALTER TABLE "url_analytics"
+        ALTER COLUMN "user_agent" TYPE TEXT;`);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        ALTER TABLE "url_analytics"
+        ALTER COLUMN "user_agent" TYPE varchar(200);`);
+  }
+}

src/url/url.entity.ts

@@ -7,11 +7,13 @@ import {
   ManyToOne,
   JoinColumn,
   DeleteDateColumn,
+  Index,
 } from 'typeorm';
 import { User } from 'src/user/user.entity';
 
 @Entity({ name: 'urls' })
 export class Url {
+  @Index()
   @PrimaryGeneratedColumn('uuid')
   readonly id: string;
 

src/user/user.entity.ts

@@ -4,10 +4,12 @@ import {
   Column,
   CreateDateColumn,
   DeleteDateColumn,
+  Index,
 } from 'typeorm';
 
 @Entity({ name: 'users' })
 export class User {
+  @Index()
   @PrimaryGeneratedColumn('uuid')
   readonly id: string;