mmintel/gridpilot.gg
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

refactor analytics module

Browse Source
This commit is contained in:
Marc Mintel
2025-12-21 22:51:08 +01:00
parent 9bd2e630e6
commit 0f60200917
14 changed files with 133 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
apps/api/src/domain/analytics/AnalyticsProviders.ts
View File

@@ -1,12 +1,10 @@
import { Provider } from '@nestjs/common';
import { AnalyticsService } from './AnalyticsService';
import type { IPageViewRepository } from '@core/analytics/domain/repositories/IPageViewRepository';
import type { IEngagementRepository } from '@core/analytics/domain/repositories/IEngagementRepository';
import type { Logger, UseCaseOutputPort } from '@core/shared/application';
import type { RecordPageViewOutput } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import type { RecordEngagementOutput } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import type { GetDashboardDataOutput } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import type { GetAnalyticsMetricsOutput } from '@core/analytics/application/use-cases/GetAnalyticsMetricsUseCase';
import type { RecordEngagementOutput } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import type { RecordPageViewOutput } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import type { IEngagementRepository } from '@core/analytics/domain/repositories/IEngagementRepository';
import type { IPageViewRepository } from '@core/analytics/domain/repositories/IPageViewRepository';
import type { Logger, UseCaseOutputPort } from '@core/shared/application';
import { Provider } from '@nestjs/common';
const Logger_TOKEN = 'Logger_TOKEN';
const IPAGE_VIEW_REPO_TOKEN = 'IPageViewRepository_TOKEN';
@@ -20,21 +18,16 @@ const GET_ANALYTICS_METRICS_OUTPUT_PORT_TOKEN = 'GetAnalyticsMetricsOutputPort_T
import { InMemoryEngagementRepository } from '@adapters/analytics/persistence/inmemory/InMemoryEngagementRepository';
import { InMemoryPageViewRepository } from '@adapters/analytics/persistence/inmemory/InMemoryPageViewRepository';
import { ConsoleLogger } from '@adapters/logging/ConsoleLogger';
import { RecordPageViewUseCase } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import { RecordEngagementUseCase } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import { GetDashboardDataUseCase } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import { GetAnalyticsMetricsUseCase } from '@core/analytics/application/use-cases/GetAnalyticsMetricsUseCase';
import { RecordPageViewPresenter } from './presenters/RecordPageViewPresenter';
import { RecordEngagementPresenter } from './presenters/RecordEngagementPresenter';
import { GetDashboardDataPresenter } from './presenters/GetDashboardDataPresenter';
import { GetDashboardDataOutput, GetDashboardDataUseCase } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import { RecordEngagementUseCase } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import { RecordPageViewUseCase } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import { GetAnalyticsMetricsPresenter } from './presenters/GetAnalyticsMetricsPresenter';
import { GetDashboardDataPresenter } from './presenters/GetDashboardDataPresenter';
import { RecordEngagementPresenter } from './presenters/RecordEngagementPresenter';
import { RecordPageViewPresenter } from './presenters/RecordPageViewPresenter';
export const AnalyticsProviders: Provider[] = [
AnalyticsService,
RecordPageViewPresenter,
RecordEngagementPresenter,
GetDashboardDataPresenter,
GetAnalyticsMetricsPresenter,
{
provide: Logger_TOKEN,
useClass: ConsoleLogger,

48
apps/api/src/domain/analytics/AnalyticsService.ts
View File

@@ -1,18 +1,18 @@
import { Injectable, Inject } from '@nestjs/common';
import type { RecordPageViewInputDTO } from './dtos/RecordPageViewInputDTO';
import type { RecordPageViewOutputDTO } from './dtos/RecordPageViewOutputDTO';
import { GetAnalyticsMetricsUseCase } from '@core/analytics/application/use-cases/GetAnalyticsMetricsUseCase';
import { GetDashboardDataUseCase } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import { RecordEngagementUseCase } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import { RecordPageViewUseCase } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import { Inject, Injectable } from '@nestjs/common';
import type { GetAnalyticsMetricsOutputDTO } from './dtos/GetAnalyticsMetricsOutputDTO';
import type { GetDashboardDataOutputDTO } from './dtos/GetDashboardDataOutputDTO';
import type { RecordEngagementInputDTO } from './dtos/RecordEngagementInputDTO';
import type { RecordEngagementOutputDTO } from './dtos/RecordEngagementOutputDTO';
import type { GetDashboardDataOutputDTO } from './dtos/GetDashboardDataOutputDTO';
import type { GetAnalyticsMetricsOutputDTO } from './dtos/GetAnalyticsMetricsOutputDTO';
import { RecordPageViewUseCase } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import { RecordEngagementUseCase } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import { GetDashboardDataUseCase } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import { GetAnalyticsMetricsUseCase } from '@core/analytics/application/use-cases/GetAnalyticsMetricsUseCase';
import { RecordPageViewPresenter } from './presenters/RecordPageViewPresenter';
import { RecordEngagementPresenter } from './presenters/RecordEngagementPresenter';
import { GetDashboardDataPresenter } from './presenters/GetDashboardDataPresenter';
import type { RecordPageViewInputDTO } from './dtos/RecordPageViewInputDTO';
import type { RecordPageViewOutputDTO } from './dtos/RecordPageViewOutputDTO';
import { GetAnalyticsMetricsPresenter } from './presenters/GetAnalyticsMetricsPresenter';
import { GetDashboardDataPresenter } from './presenters/GetDashboardDataPresenter';
import { RecordEngagementPresenter } from './presenters/RecordEngagementPresenter';
import { RecordPageViewPresenter } from './presenters/RecordPageViewPresenter';
type RecordPageViewInput = RecordPageViewInputDTO;
type RecordEngagementInput = RecordEngagementInputDTO;
@@ -24,45 +24,53 @@ export class AnalyticsService {
@Inject(RecordEngagementUseCase) private readonly recordEngagementUseCase: RecordEngagementUseCase,
@Inject(GetDashboardDataUseCase) private readonly getDashboardDataUseCase: GetDashboardDataUseCase,
@Inject(GetAnalyticsMetricsUseCase) private readonly getAnalyticsMetricsUseCase: GetAnalyticsMetricsUseCase,
private readonly recordPageViewPresenter: RecordPageViewPresenter,
private readonly recordEngagementPresenter: RecordEngagementPresenter,
private readonly getDashboardDataPresenter: GetDashboardDataPresenter,
private readonly getAnalyticsMetricsPresenter: GetAnalyticsMetricsPresenter,
) {}
async recordPageView(input: RecordPageViewInput): Promise<RecordPageViewOutputDTO> {
const presenter = new RecordPageViewPresenter();
const result = await this.recordPageViewUseCase.execute(input);
if (result.isErr()) {
const error = result.unwrapErr();
throw new Error(error.details?.message ?? 'Failed to record page view');
}
return this.recordPageViewPresenter.getResponseModel();
return presenter.responseModel;
}
async recordEngagement(input: RecordEngagementInput): Promise<RecordEngagementOutputDTO> {
const presenter = new RecordEngagementPresenter();
const result = await this.recordEngagementUseCase.execute(input);
if (result.isErr()) {
const error = result.unwrapErr();
throw new Error(error.details?.message ?? 'Failed to record engagement');
}
return this.recordEngagementPresenter.getResponseModel();
return presenter.responseModel;
}
async getDashboardData(): Promise<GetDashboardDataOutputDTO> {
const presenter = new GetDashboardDataPresenter();
const result = await this.getDashboardDataUseCase.execute({});
if (result.isErr()) {
const error = result.unwrapErr();
throw new Error(error.details?.message ?? 'Failed to get dashboard data');
}
return this.getDashboardDataPresenter.getResponseModel();
return presenter.responseModel;
}
async getAnalyticsMetrics(): Promise<GetAnalyticsMetricsOutputDTO> {
const presenter = new GetAnalyticsMetricsPresenter();
const result = await this.getAnalyticsMetricsUseCase.execute({});
if (result.isErr()) {
const error = result.unwrapErr();
throw new Error(error.details?.message ?? 'Failed to get analytics metrics');
}
return this.getAnalyticsMetricsPresenter.getResponseModel();
return presenter.responseModel;
}
}

10
apps/api/src/domain/analytics/presenters/GetAnalyticsMetricsPresenter.test.ts
View File

@@ -27,9 +27,19 @@ describe('GetAnalyticsMetricsPresenter', () => {
averageSessionDuration: 300,
bounceRate: 0.4,
});
expect(presenter.responseModel).toEqual({
pageViews: 1000,
uniqueVisitors: 500,
averageSessionDuration: 300,
bounceRate: 0.4,
});
});
it('getResponseModel throws if not presented', () => {
expect(() => presenter.getResponseModel()).toThrow('Presenter not presented');
});
it('responseModel throws if not presented', () => {
expect(() => presenter.responseModel).toThrow('Presenter not presented');
});
});

15
apps/api/src/domain/analytics/presenters/GetAnalyticsMetricsPresenter.ts
View File

@@ -1,12 +1,12 @@
import type { UseCaseOutputPort } from '@core/shared/application';
import type { GetAnalyticsMetricsOutput } from '@core/analytics/application/use-cases/GetAnalyticsMetricsUseCase';
import type { UseCaseOutputPort } from '@core/shared/application';
import type { GetAnalyticsMetricsOutputDTO } from '../dtos/GetAnalyticsMetricsOutputDTO';
export class GetAnalyticsMetricsPresenter implements UseCaseOutputPort<GetAnalyticsMetricsOutput> {
private responseModel: GetAnalyticsMetricsOutputDTO | null = null;
private model: GetAnalyticsMetricsOutputDTO | null = null;
present(result: GetAnalyticsMetricsOutput): void {
this.responseModel = {
this.model = {
pageViews: result.pageViews,
uniqueVisitors: result.uniqueVisitors,
averageSessionDuration: result.averageSessionDuration,
@@ -14,8 +14,13 @@ export class GetAnalyticsMetricsPresenter implements UseCaseOutputPort<GetAnalyt
};
}
get responseModel(): GetAnalyticsMetricsOutputDTO {
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
getResponseModel(): GetAnalyticsMetricsOutputDTO {
if (!this.responseModel) throw new Error('Presenter not presented');
return this.responseModel;
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
}

10
apps/api/src/domain/analytics/presenters/GetDashboardDataPresenter.test.ts
View File

@@ -25,9 +25,19 @@ describe('GetDashboardDataPresenter', () => {
totalRaces: 20,
totalLeagues: 5,
});
expect(presenter.responseModel).toEqual({
totalUsers: 100,
activeUsers: 50,
totalRaces: 20,
totalLeagues: 5,
});
});
it('getResponseModel throws if not presented', () => {
expect(() => presenter.getResponseModel()).toThrow('Presenter not presented');
});
it('responseModel throws if not presented', () => {
expect(() => presenter.responseModel).toThrow('Presenter not presented');
});
});

15
apps/api/src/domain/analytics/presenters/GetDashboardDataPresenter.ts
View File

@@ -1,12 +1,12 @@
import type { UseCaseOutputPort } from '@core/shared/application';
import type { GetDashboardDataOutput } from '@core/analytics/application/use-cases/GetDashboardDataUseCase';
import type { UseCaseOutputPort } from '@core/shared/application';
import type { GetDashboardDataOutputDTO } from '../dtos/GetDashboardDataOutputDTO';
export class GetDashboardDataPresenter implements UseCaseOutputPort<GetDashboardDataOutput> {
private responseModel: GetDashboardDataOutputDTO | null = null;
private model: GetDashboardDataOutputDTO | null = null;
present(result: GetDashboardDataOutput): void {
this.responseModel = {
this.model = {
totalUsers: result.totalUsers,
activeUsers: result.activeUsers,
totalRaces: result.totalRaces,
@@ -14,8 +14,13 @@ export class GetDashboardDataPresenter implements UseCaseOutputPort<GetDashboard
};
}
get responseModel(): GetDashboardDataOutputDTO {
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
getResponseModel(): GetDashboardDataOutputDTO {
if (!this.responseModel) throw new Error('Presenter not presented');
return this.responseModel;
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
}

8
apps/api/src/domain/analytics/presenters/RecordEngagementPresenter.test.ts
View File

@@ -21,9 +21,17 @@ describe('RecordEngagementPresenter', () => {
eventId: 'event-123',
engagementWeight: 10,
});
expect(presenter.responseModel).toEqual({
eventId: 'event-123',
engagementWeight: 10,
});
});
it('getResponseModel throws if not presented', () => {
expect(() => presenter.getResponseModel()).toThrow('Presenter not presented');
});
it('responseModel throws if not presented', () => {
expect(() => presenter.responseModel).toThrow('Presenter not presented');
});
});

15
apps/api/src/domain/analytics/presenters/RecordEngagementPresenter.ts
View File

@@ -1,19 +1,24 @@
import type { UseCaseOutputPort } from '@core/shared/application';
import type { RecordEngagementOutput } from '@core/analytics/application/use-cases/RecordEngagementUseCase';
import type { UseCaseOutputPort } from '@core/shared/application';
import type { RecordEngagementOutputDTO } from '../dtos/RecordEngagementOutputDTO';
export class RecordEngagementPresenter implements UseCaseOutputPort<RecordEngagementOutput> {
private responseModel: RecordEngagementOutputDTO | null = null;
private model: RecordEngagementOutputDTO | null = null;
present(result: RecordEngagementOutput): void {
this.responseModel = {
this.model = {
eventId: result.eventId,
engagementWeight: result.engagementWeight,
};
}
get responseModel(): RecordEngagementOutputDTO {
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
getResponseModel(): RecordEngagementOutputDTO {
if (!this.responseModel) throw new Error('Presenter not presented');
return this.responseModel;
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
}

7
apps/api/src/domain/analytics/presenters/RecordPageViewPresenter.test.ts
View File

@@ -19,9 +19,16 @@ describe('RecordPageViewPresenter', () => {
expect(presenter.getResponseModel()).toEqual({
pageViewId: 'pv-123',
});
expect(presenter.responseModel).toEqual({
pageViewId: 'pv-123',
});
});
it('getResponseModel throws if not presented', () => {
expect(() => presenter.getResponseModel()).toThrow('Presenter not presented');
});
it('responseModel throws if not presented', () => {
expect(() => presenter.responseModel).toThrow('Presenter not presented');
});
});

15
apps/api/src/domain/analytics/presenters/RecordPageViewPresenter.ts
View File

@@ -1,18 +1,23 @@
import type { UseCaseOutputPort } from '@core/shared/application';
import type { RecordPageViewOutput } from '@core/analytics/application/use-cases/RecordPageViewUseCase';
import type { UseCaseOutputPort } from '@core/shared/application';
import type { RecordPageViewOutputDTO } from '../dtos/RecordPageViewOutputDTO';
export class RecordPageViewPresenter implements UseCaseOutputPort<RecordPageViewOutput> {
private responseModel: RecordPageViewOutputDTO | null = null;
private model: RecordPageViewOutputDTO | null = null;
present(result: RecordPageViewOutput): void {
this.responseModel = {
this.model = {
pageViewId: result.pageViewId,
};
}
get responseModel(): RecordPageViewOutputDTO {
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
getResponseModel(): RecordPageViewOutputDTO {
if (!this.responseModel) throw new Error('Presenter not presented');
return this.responseModel;
if (!this.model) throw new Error('Presenter not presented');
return this.model;
}
}

3
apps/api/src/domain/auth/AuthService.ts
View File

@@ -42,6 +42,7 @@ export class AuthService {
return null;
}
// TODO no mapping in here, must use presenter
const authenticatedUserDTO = this.mapUserToAuthenticatedUserDTO(User.fromStored(user));
const apiSession = this.buildAuthSessionDTO(coreSession.token, authenticatedUserDTO);
@@ -113,7 +114,7 @@ export class AuthService {
this.logger.debug('[AuthService] Attempting logout.');
const commandResultPresenter = new CommandResultPresenter();
const result = await this.logoutUseCase.execute();
const result = await this.logoutUseCase.execute(); // TODO
if (result.isErr()) {
const error = result.unwrapErr();

6
apps/api/src/domain/dashboard/DashboardService.ts
View File

@@ -1,5 +1,5 @@
import { Injectable, Inject } from '@nestjs/common';
import { DashboardOverviewUseCase } from '@core/racing/application/use-cases/DashboardOverviewUseCase';
import { Inject, Injectable } from '@nestjs/common';
import { DashboardOverviewDTO } from './dtos/DashboardOverviewDTO';
import { DashboardOverviewPresenter } from './presenters/DashboardOverviewPresenter';
@@ -7,14 +7,14 @@ import { DashboardOverviewPresenter } from './presenters/DashboardOverviewPresen
import type { Logger } from '@core/shared/application/Logger';
// Tokens
import { LOGGER_TOKEN, DASHBOARD_OVERVIEW_USE_CASE_TOKEN, DASHBOARD_OVERVIEW_OUTPUT_PORT_TOKEN } from './DashboardProviders';
import { DASHBOARD_OVERVIEW_OUTPUT_PORT_TOKEN, DASHBOARD_OVERVIEW_USE_CASE_TOKEN, LOGGER_TOKEN } from './DashboardProviders';
@Injectable()
export class DashboardService {
constructor(
@Inject(LOGGER_TOKEN) private readonly logger: Logger,
@Inject(DASHBOARD_OVERVIEW_USE_CASE_TOKEN) private readonly dashboardOverviewUseCase: DashboardOverviewUseCase,
@Inject(DASHBOARD_OVERVIEW_OUTPUT_PORT_TOKEN) private readonly dashboardOverviewPresenter: DashboardOverviewPresenter,
@Inject(DASHBOARD_OVERVIEW_OUTPUT_PORT_TOKEN) private readonly dashboardOverviewPresenter: DashboardOverviewPresenter, // TODO no presenter injection
) {}
async getDashboardOverview(driverId: string): Promise<DashboardOverviewDTO> {

18
apps/api/src/domain/dashboard/presenters/DashboardOverviewPresenter.test.ts
View File

@@ -1,12 +1,12 @@
import { describe, it, expect, beforeEach } from 'vitest';
import { DashboardOverviewPresenter } from './DashboardOverviewPresenter';
import type { DashboardOverviewResult } from '@core/racing/application/use-cases/DashboardOverviewUseCase';
import { Driver } from '@core/racing/domain/entities/Driver';
import { Race } from '@core/racing/domain/entities/Race';
import { League } from '@core/racing/domain/entities/League';
import { Race } from '@core/racing/domain/entities/Race';
import { Standing } from '@core/racing/domain/entities/Standing';
import { Result as RaceResult } from '@core/racing/domain/entities/result/Result';
import type { FeedItem } from '@core/social/domain/types/FeedItem';
import { beforeEach, describe, expect, it } from 'vitest';
import { DashboardOverviewPresenter } from './DashboardOverviewPresenter';
const createOutput = (): DashboardOverviewResult => {
const driver = Driver.create({ id: 'driver-1', iracingId: '12345', name: 'Test Driver', country: 'DE' });
@@ -148,15 +148,15 @@ describe('DashboardOverviewPresenter', () => {
expect(dto.activeLeaguesCount).toBe(2);
expect(dto.currentDriver?.id).toBe('driver-1');
expect(dto.myUpcomingRaces[0].id).toBe('race-1');
expect(dto.otherUpcomingRaces[0].id).toBe('race-2');
expect(dto.myUpcomingRaces[0]!.id).toBe('race-1');
expect(dto.otherUpcomingRaces[0]!.id).toBe('race-2');
expect(dto.upcomingRaces).toHaveLength(2);
expect(dto.nextRace?.id).toBe('race-1');
expect(dto.recentResults[0].raceId).toBe('race-3');
expect(dto.leagueStandingsSummaries[0].leagueId).toBe('league-1');
expect(dto.recentResults[0]!.raceId).toBe('race-3');
expect(dto.leagueStandingsSummaries[0]!.leagueId).toBe('league-1');
expect(dto.feedSummary.notificationCount).toBe(3);
expect(dto.feedSummary.items[0].id).toBe('feed-1');
expect(dto.friends[0].id).toBe('friend-1');
expect(dto.feedSummary.items[0]!.id).toBe('feed-1');
expect(dto.friends[0]!.id).toBe('friend-1');
});
});

7
apps/api/src/domain/driver/presenters/DriversLeaderboardPresenter.test.ts
View File

@@ -1,7 +1,9 @@
import { describe, it, expect, beforeEach } from 'vitest';
import { GetDriversLeaderboardResult } from '@core/racing/application/use-cases/GetDriversLeaderboardUseCase';
import { Result } from '@core/shared/application/Result';
import { beforeEach, describe, expect, it } from 'vitest';
import { DriversLeaderboardPresenter } from './DriversLeaderboardPresenter';
import type { GetDriversLeaderboardResult } from '../../../../../core/racing/application/use-cases/GetDriversLeaderboardUseCase';
// TODO fix eslint issues
describe('DriversLeaderboardPresenter', () => {
let presenter: DriversLeaderboardPresenter;
@@ -54,7 +56,6 @@ describe('DriversLeaderboardPresenter', () => {
presenter.present(result);
const api = presenter.responseModel;
expect(result.drivers).toHaveLength(2);
expect(result.drivers[0]).toEqual({