Track backend events (#5405)

Add tracking to backend events, we might disable frontend tracking which
doesn't bring much value to improve the product
This commit is contained in:
Félix Malfait
2024-05-14 16:42:28 +02:00
committed by GitHub
parent ffdd3a7d4e
commit a53ce1c488
5 changed files with 52 additions and 23 deletions

View File

@ -0,0 +1,29 @@
import { Injectable } from '@nestjs/common';
import { OnEvent } from '@nestjs/event-emitter';
import { AnalyticsService } from 'src/engine/core-modules/analytics/analytics.service';
import { CreateAnalyticsInput } from 'src/engine/core-modules/analytics/dto/create-analytics.input';
import { ObjectRecordCreateEvent } from 'src/engine/integrations/event-emitter/types/object-record-create.event';
@Injectable()
export class TelemetryListener {
constructor(private readonly analyticsService: AnalyticsService) {}
@OnEvent('*.created')
async handleAllCreate(payload: ObjectRecordCreateEvent<any>) {
this.analyticsService.create(
{
type: 'track',
name: payload.name,
data: JSON.parse(`{
"eventName": "${payload.name}"
}`),
} as CreateAnalyticsInput,
payload.userId,
payload.workspaceId,
'', // voluntarely not retrieving this
'', // to avoid slowing down
'',
);
}
}

View File

@ -11,6 +11,8 @@ import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity'; import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata'; import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
import { ObjectMetadataRepositoryModule } from 'src/engine/object-metadata-repository/object-metadata-repository.module'; import { ObjectMetadataRepositoryModule } from 'src/engine/object-metadata-repository/object-metadata-repository.module';
import { TelemetryListener } from 'src/engine/api/graphql/workspace-query-runner/listeners/telemetry.listener';
import { AnalyticsModule } from 'src/engine/core-modules/analytics/analytics.module';
import { WorkspaceQueryRunnerService } from './workspace-query-runner.service'; import { WorkspaceQueryRunnerService } from './workspace-query-runner.service';
@ -24,12 +26,14 @@ import { EntityEventsToDbListener } from './listeners/entity-events-to-db.listen
WorkspacePreQueryHookModule, WorkspacePreQueryHookModule,
TypeOrmModule.forFeature([Workspace, FeatureFlagEntity], 'core'), TypeOrmModule.forFeature([Workspace, FeatureFlagEntity], 'core'),
ObjectMetadataRepositoryModule.forFeature([WorkspaceMemberObjectMetadata]), ObjectMetadataRepositoryModule.forFeature([WorkspaceMemberObjectMetadata]),
AnalyticsModule,
], ],
providers: [ providers: [
WorkspaceQueryRunnerService, WorkspaceQueryRunnerService,
...workspaceQueryRunnerFactories, ...workspaceQueryRunnerFactories,
RecordPositionListener, RecordPositionListener,
EntityEventsToDbListener, EntityEventsToDbListener,
TelemetryListener,
], ],
exports: [WorkspaceQueryRunnerService], exports: [WorkspaceQueryRunnerService],
}) })

View File

@ -11,5 +11,6 @@ import { AnalyticsResolver } from './analytics.resolver';
baseURL: 'https://t.twenty.com/api/v1/s2s', baseURL: 'https://t.twenty.com/api/v1/s2s',
}), }),
], ],
exports: [AnalyticsService],
}) })
export class AnalyticsModule {} export class AnalyticsModule {}

View File

@ -28,9 +28,11 @@ export class AnalyticsResolver {
) { ) {
return this.analyticsService.create( return this.analyticsService.create(
createAnalyticsInput, createAnalyticsInput,
user, user?.id,
workspace, workspace?.id,
request, workspace?.displayName,
workspace?.domainName,
request.hostname,
); );
} }
} }

View File

@ -1,12 +1,8 @@
import { Injectable, Logger } from '@nestjs/common'; import { Injectable, Logger } from '@nestjs/common';
import { HttpService } from '@nestjs/axios'; import { HttpService } from '@nestjs/axios';
import { Request } from 'express';
import { anonymize } from 'src/utils/anonymize'; import { anonymize } from 'src/utils/anonymize';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service'; import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
import { User } from 'src/engine/core-modules/user/user.entity';
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
import { CreateAnalyticsInput } from './dto/create-analytics.input'; import { CreateAnalyticsInput } from './dto/create-analytics.input';
@ -21,9 +17,11 @@ export class AnalyticsService {
async create( async create(
createEventInput: CreateAnalyticsInput, createEventInput: CreateAnalyticsInput,
user: User | undefined, userId: string | undefined,
workspace: Workspace | undefined, workspaceId: string | undefined,
request: Request, workspaceDisplayName: string | undefined,
workspaceDomainName: string | undefined,
hostName: string | undefined,
) { ) {
if (!this.environmentService.get('TELEMETRY_ENABLED')) { if (!this.environmentService.get('TELEMETRY_ENABLED')) {
return { success: true }; return { success: true };
@ -36,19 +34,14 @@ export class AnalyticsService {
const data = { const data = {
type: createEventInput.type, type: createEventInput.type,
data: { data: {
hostname: request.hostname, hostname: hostName,
userUUID: user userUUID: anonymizationEnabled && userId ? anonymize(userId) : userId,
? anonymizationEnabled workspaceUUID:
? anonymize(user.id) anonymizationEnabled && workspaceId
: user.id ? anonymize(workspaceId)
: undefined, : workspaceId,
workspaceUUID: workspace workspaceDisplayName: workspaceDisplayName,
? anonymizationEnabled workspaceDomainName: workspaceDomainName,
? anonymize(workspace.id)
: workspace.id
: undefined,
workspaceDisplayName: workspace ? workspace.displayName : undefined,
workspaceDomainName: workspace ? workspace.domainName : undefined,
...createEventInput.data, ...createEventInput.data,
}, },
}; };