analytics export

apps/api/src/Analytics-Export/analytics-export.controller.spec.ts

@@ -0,0 +1,209 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AnalyticsExportController } from '../analytics-export.controller';
+import { AnalyticsExportService } from '../analytics-export.service';
+import { ExportAnalyticsDto } from '../dto/export-analytics.dto';
+import { ExportJobStatusDto } from '../dto/export-response.dto';
+import { AnalyticsMetric } from '../enums/analytics-metric.enum';
+import { ExportStatus } from '../enums/export-status.enum';
+
+// ─── Mocks ───────────────────────────────────────────────────────────────────
+
+const mockService = () => ({
+  initiateExport: jest.fn(),
+  getJobStatus: jest.fn(),
+  listUserJobs: jest.fn(),
+  buildSyncCsv: jest.fn(),
+  repository: {
+    findJobById: jest.fn(),
+  },
+});
+
+const makeDto = (overrides: Partial<ExportAnalyticsDto> = {}): ExportAnalyticsDto => ({
+  metrics: [AnalyticsMetric.GAS_PRICE],
+  startDate: '2024-01-01T00:00:00.000Z',
+  endDate: '2024-01-31T23:59:59.000Z',
+  includeMetadata: true,
+  delimiter: ',',
+  dateFormat: 'iso',
+  timezone: 'UTC',
+  async: false,
+  ...overrides,
+});
+
+const mockRequest = (userId = 'user-123') => ({
+  user: { id: userId },
+});
+
+const mockResponse = () => {
+  const res: Record<string, jest.Mock> = {};
+  res.setHeader = jest.fn().mockReturnValue(res);
+  res.status = jest.fn().mockReturnValue(res);
+  res.json = jest.fn().mockReturnValue(res);
+  res.send = jest.fn().mockReturnValue(res);
+  return res;
+};
+
+// ─── Tests ───────────────────────────────────────────────────────────────────
+
+describe('AnalyticsExportController', () => {
+  let controller: AnalyticsExportController;
+  let service: ReturnType<typeof mockService>;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [AnalyticsExportController],
+      providers: [{ provide: AnalyticsExportService, useFactory: mockService }],
+    })
+      .overrideGuard(Object) // bypass AuthGuard
+      .useValue({ canActivate: () => true })
+      .compile();
+
+    controller = module.get(AnalyticsExportController);
+    service = module.get(AnalyticsExportService);
+  });
+
+  // ─── exportAnalytics (sync) ───────────────────────────────────────────────
+
+  describe('exportAnalytics() — synchronous', () => {
+    it('should set CSV headers and send the CSV body', async () => {
+      const csvPayload = {
+        csv: 'ID,Metric\nrec-001,gas_price',
+        filename: 'analytics_gas_price_2024-01-01_to_2024-01-31.csv',
+      };
+      service.initiateExport.mockResolvedValue(csvPayload);
+
+      const req = mockRequest() as never;
+      const res = mockResponse() as never;
+
+      await controller.exportAnalytics(makeDto(), req, res);
+
+      expect((res as ReturnType<typeof mockResponse>).setHeader).toHaveBeenCalledWith('Content-Type', 'text/csv; charset=utf-8');
+      expect((res as ReturnType<typeof mockResponse>).setHeader).toHaveBeenCalledWith(
+        'Content-Disposition',
+        `attachment; filename="${csvPayload.filename}"`,
+      );
+      expect((res as ReturnType<typeof mockResponse>).send).toHaveBeenCalledWith(csvPayload.csv);
+    });
+
+    it('should set X-Export-Row-Count header', async () => {
+      service.initiateExport.mockResolvedValue({
+        csv: 'ID\nrec-001\nrec-002',
+        filename: 'test.csv',
+      });
+
+      const res = mockResponse() as never;
+      await controller.exportAnalytics(makeDto(), mockRequest() as never, res);
+
+      expect((res as ReturnType<typeof mockResponse>).setHeader).toHaveBeenCalledWith('X-Export-Row-Count', '2');
+    });
+  });
+
+  // ─── exportAnalytics (async) ──────────────────────────────────────────────
+
+  describe('exportAnalytics() — asynchronous', () => {
+    it('should return 202 ACCEPTED with job info for async export', async () => {
+      const jobResponse = {
+        jobId: 'job-abc',
+        status: ExportStatus.PENDING,
+        message: 'Export job queued successfully.',
+        statusUrl: '/analytics/export/jobs/job-abc',
+        createdAt: new Date().toISOString(),
+      };
+      service.initiateExport.mockResolvedValue(jobResponse);
+
+      const res = mockResponse() as never;
+      await controller.exportAnalytics(makeDto({ async: true }), mockRequest() as never, res);
+
+      expect((res as ReturnType<typeof mockResponse>).status).toHaveBeenCalledWith(202);
+      expect((res as ReturnType<typeof mockResponse>).json).toHaveBeenCalledWith(jobResponse);
+    });
+  });
+
+  // ─── listJobs ─────────────────────────────────────────────────────────────
+
+  describe('listJobs()', () => {
+    it('should return the list of user jobs', async () => {
+      const jobs: ExportJobStatusDto[] = [
+        {
+          jobId: 'job-1',
+          status: ExportStatus.COMPLETED,
+          rowCount: 200,
+          fileSizeBytes: 8192,
+          downloadUrl: '/download',
+          errorMessage: null,
+          createdAt: new Date().toISOString(),
+          completedAt: new Date().toISOString(),
+        },
+      ];
+      service.listUserJobs.mockResolvedValue(jobs);
+
+      const result = await controller.listJobs(mockRequest() as never);
+
+      expect(result).toEqual(jobs);
+      expect(service.listUserJobs).toHaveBeenCalledWith('user-123');
+    });
+  });
+
+  // ─── getJobStatus ─────────────────────────────────────────────────────────
+
+  describe('getJobStatus()', () => {
+    it('should delegate to service and return status DTO', async () => {
+      const statusDto: ExportJobStatusDto = {
+        jobId: 'job-xyz',
+        status: ExportStatus.PROCESSING,
+        rowCount: null,
+        fileSizeBytes: null,
+        downloadUrl: null,
+        errorMessage: null,
+        createdAt: new Date().toISOString(),
+        completedAt: null,
+      };
+      service.getJobStatus.mockResolvedValue(statusDto);
+
+      const result = await controller.getJobStatus('job-xyz', mockRequest() as never);
+
+      expect(result).toEqual(statusDto);
+      expect(service.getJobStatus).toHaveBeenCalledWith('job-xyz', 'user-123');
+    });
+  });
+
+  // ─── downloadJobResult ────────────────────────────────────────────────────
+
+  describe('downloadJobResult()', () => {
+    it('should return CSV for a completed job', async () => {
+      service.getJobStatus.mockResolvedValue({
+        jobId: 'job-done',
+        status: ExportStatus.COMPLETED,
+      });
+      service.repository.findJobById.mockResolvedValue({
+        id: 'job-done',
+        options: {},
+      });
+      service.buildSyncCsv.mockResolvedValue({
+        csv: 'ID,Metric\nrec-001,gas_price',
+        filename: 'test.csv',
+      });
+
+      const res = mockResponse() as never;
+      await controller.downloadJobResult('job-done', mockRequest() as never, res);
+
+      expect((res as ReturnType<typeof mockResponse>).setHeader).toHaveBeenCalledWith('Content-Type', 'text/csv; charset=utf-8');
+      expect((res as ReturnType<typeof mockResponse>).send).toHaveBeenCalled();
+    });
+
+    it('should return 409 Conflict when job is not completed', async () => {
+      service.getJobStatus.mockResolvedValue({
+        jobId: 'job-pending',
+        status: ExportStatus.PROCESSING,
+      });
+
+      const res = mockResponse() as never;
+      await controller.downloadJobResult('job-pending', mockRequest() as never, res);
+
+      expect((res as ReturnType<typeof mockResponse>).status).toHaveBeenCalledWith(409);
+      expect((res as ReturnType<typeof mockResponse>).json).toHaveBeenCalledWith(
+        expect.objectContaining({ status: ExportStatus.PROCESSING }),
+      );
+    });
+  });
+});

apps/api/src/Analytics-Export/analytics-export.controller.ts

@@ -0,0 +1,142 @@
+import {
+  Controller,
+  Get,
+  Header,
+  HttpCode,
+  HttpStatus,
+  Param,
+  ParseUUIDPipe,
+  Post,
+  Query,
+  Req,
+  Res,
+  UseGuards,
+} from '@nestjs/common';
+import { Response, Request } from 'express';
+import { ExportAnalyticsDto } from './dto/export-analytics.dto';
+import {
+  ExportJobResponseDto,
+  ExportJobStatusDto,
+} from './dto/export-response.dto';
+import { AnalyticsExportService } from './analytics-export.service';
+import { ExportStatus } from './enums/export-status.enum';
+
+/**
+ * Placeholder JWT guard — swap for your actual AuthGuard.
+ * e.g. @UseGuards(JwtAuthGuard)
+ */
+import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
+
+@Injectable()
+class AuthGuard implements CanActivate {
+  canActivate(context: ExecutionContext): boolean {
+    // Replace with real JWT validation
+    const req = context.switchToHttp().getRequest<Request>();
+    return !!(req as Request & { user?: unknown }).user;
+  }
+}
+
+@Controller('analytics/export')
+@UseGuards(AuthGuard)
+export class AnalyticsExportController {
+  constructor(private readonly exportService: AnalyticsExportService) {}
+
+  /**
+   * POST /analytics/export
+   *
+   * If async=false (default): returns a CSV file download.
+   * If async=true: enqueues a background job and returns a job reference.
+   */
+  @Post()
+  @HttpCode(HttpStatus.OK)
+  async exportAnalytics(
+    @Query() dto: ExportAnalyticsDto,
+    @Req() req: Request & { user: { id: string } },
+    @Res() res: Response,
+  ): Promise<void> {
+    const userId = req.user.id;
+    const result = await this.exportService.initiateExport(userId, dto);
+
+    if ('csv' in result) {
+      // Synchronous: stream CSV directly
+      const { csv, filename } = result;
+      res.setHeader('Content-Type', 'text/csv; charset=utf-8');
+      res.setHeader(
+        'Content-Disposition',
+        `attachment; filename="${filename}"`,
+      );
+      res.setHeader('Content-Length', Buffer.byteLength(csv, 'utf8'));
+      res.setHeader('X-Export-Row-Count', String(csv.split('\n').length - 1));
+      res.send(csv);
+    } else {
+      // Async: return job info as JSON
+      res.setHeader('Content-Type', 'application/json');
+      res.status(HttpStatus.ACCEPTED).json(result);
+    }
+  }
+
+  /**
+   * GET /analytics/export/jobs
+   *
+   * List recent export jobs for the authenticated user.
+   */
+  @Get('jobs')
+  async listJobs(
+    @Req() req: Request & { user: { id: string } },
+  ): Promise<ExportJobStatusDto[]> {
+    return this.exportService.listUserJobs(req.user.id);
+  }
+
+  /**
+   * GET /analytics/export/jobs/:jobId
+   *
+   * Poll the status of an async export job.
+   */
+  @Get('jobs/:jobId')
+  async getJobStatus(
+    @Param('jobId', ParseUUIDPipe) jobId: string,
+    @Req() req: Request & { user: { id: string } },
+  ): Promise<ExportJobStatusDto> {
+    return this.exportService.getJobStatus(jobId, req.user.id);
+  }
+
+  /**
+   * GET /analytics/export/jobs/:jobId/download
+   *
+   * Re-generate and download the CSV for a completed async job.
+   * In production, redirect to a presigned S3/GCS URL instead.
+   */
+  @Get('jobs/:jobId/download')
+  async downloadJobResult(
+    @Param('jobId', ParseUUIDPipe) jobId: string,
+    @Req() req: Request & { user: { id: string } },
+    @Res() res: Response,
+  ): Promise<void> {
+    const job = await this.exportService.getJobStatus(jobId, req.user.id);
+
+    if (job.status !== ExportStatus.COMPLETED) {
+      res.status(HttpStatus.CONFLICT).json({
+        message: `Job is not completed yet. Current status: ${job.status}`,
+        status: job.status,
+      });
+      return;
+    }
+
+    // Retrieve the job entity and re-run the CSV build
+    const jobEntity = await this.exportService['repository'].findJobById(jobId);
+    if (!jobEntity) {
+      res.status(HttpStatus.NOT_FOUND).json({ message: 'Job not found' });
+      return;
+    }
+
+    const { csv, filename } = await this.exportService.buildSyncCsv(
+      req.user.id,
+      jobEntity.options,
+    );
+
+    res.setHeader('Content-Type', 'text/csv; charset=utf-8');
+    res.setHeader('Content-Disposition', `attachment; filename="${filename}"`);
+    res.setHeader('Content-Length', Buffer.byteLength(csv, 'utf8'));
+    res.send(csv);
+  }
+}