From 6fc8c0b4a89a405a0200b5b241e2e8851fa548f3 Mon Sep 17 00:00:00 2001 From: marcos-silva-rodrigues Date: Tue, 20 May 2025 16:50:04 -0300 Subject: [PATCH] FEAT: add mixpanel service to track share access --- docsfera.json | 27 ++-- src/modules/catalog/catalog.module.ts | 1 + src/modules/catalog/share/share.controller.ts | 7 +- src/modules/catalog/share/share.module.ts | 4 +- src/modules/catalog/share/share.service.ts | 19 ++- src/modules/mixpanel/mixpanel.controller.ts | 80 +----------- src/modules/mixpanel/mixpanel.module.ts | 7 +- src/modules/mixpanel/mixpanel.service.ts | 118 ++++++++++++++++++ 8 files changed, 165 insertions(+), 98 deletions(-) create mode 100644 src/modules/mixpanel/mixpanel.service.ts diff --git a/docsfera.json b/docsfera.json index f6896c9..ebc41e9 100644 --- a/docsfera.json +++ b/docsfera.json @@ -5501,6 +5501,17 @@ ] } }, + "/trackEvent/{id}": { + "post": { + "operationId": "MixpanelController_trackEvent", + "parameters": [], + "responses": { + "201": { + "description": "" + } + } + } + }, "/terms-of-use/token": { "get": { "operationId": "TermsOfUseController_getToken", @@ -5995,22 +6006,6 @@ ] } }, - "/trackEvent/{id}": { - "post": { - "operationId": "MixpanelController_trackEvent", - "parameters": [], - "responses": { - "201": { - "description": "" - } - }, - "security": [ - { - "access-token": [] - } - ] - } - }, "/open-data/sharing-ocean-data": { "post": { "operationId": "OpenDataController_createUser", diff --git a/src/modules/catalog/catalog.module.ts b/src/modules/catalog/catalog.module.ts index 8320d37..8ce1579 100644 --- a/src/modules/catalog/catalog.module.ts +++ b/src/modules/catalog/catalog.module.ts @@ -11,6 +11,7 @@ import { RolesModule } from '../roles/roles.module'; import { CustomersModule } from '../customers/customers.module'; import { ShareModule } from './share/share.module'; import { CatalogService } from './catalog.service'; +import { MixpanelModule } from '../mixpanel/mixpanel.module'; const client = new CatalogClientConfiguration(); diff --git a/src/modules/catalog/share/share.controller.ts b/src/modules/catalog/share/share.controller.ts index a5240bf..efc394e 100644 --- a/src/modules/catalog/share/share.controller.ts +++ b/src/modules/catalog/share/share.controller.ts @@ -3,6 +3,7 @@ import { Get, Inject, Param, + Req, UseFilters, } from '@nestjs/common'; import { @@ -21,6 +22,7 @@ import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filt import { Language } from 'src/decorators/language.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; import { ShareService } from './share.service'; +import { Request } from 'express'; @ApiTags('Catalog') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @@ -39,10 +41,11 @@ export class ShareController { @Get('/:id') async getShareDataAsset( @Param('id') id: string, - @User() user: RequestUser + @User() user: RequestUser, + @Req() request: Request ) { this.logger.info(`GET //:id`); - return await this.catalogShareService.getOneDataAssetPublic(id, user); + return await this.catalogShareService.getOneDataAssetPublic(id, user, request); } @Get('/:id/columns-metadata') diff --git a/src/modules/catalog/share/share.module.ts b/src/modules/catalog/share/share.module.ts index 1f0c7fb..ce7021c 100644 --- a/src/modules/catalog/share/share.module.ts +++ b/src/modules/catalog/share/share.module.ts @@ -8,6 +8,7 @@ import { ShareMetadataModule } from "src/modules/share-metadata/share-metadata.m import { ShareController } from "./share.controller"; import DadosferaLogger from "@dadosfera/dadosfera-logs"; import { ShareService } from "./share.service"; +import { MixpanelModule } from "src/modules/mixpanel/mixpanel.module"; const client = new CatalogClientConfiguration(); @@ -17,7 +18,8 @@ const client = new CatalogClientConfiguration(); UsersModule, RolesModule, CustomersModule, - ShareMetadataModule + ShareMetadataModule, + MixpanelModule ], controllers: [ShareController], providers: [ShareService, DadosferaLogger], diff --git a/src/modules/catalog/share/share.service.ts b/src/modules/catalog/share/share.service.ts index 1729f43..da8d3fe 100644 --- a/src/modules/catalog/share/share.service.ts +++ b/src/modules/catalog/share/share.service.ts @@ -20,6 +20,8 @@ import { Metadata } from '@grpc/grpc-js'; import { lastValueFrom } from 'rxjs'; import { ShareMetadataService } from 'src/modules/share-metadata/share-metadata.service'; import { isJWT } from 'class-validator'; +import { MixpanelService } from 'src/modules/mixpanel/mixpanel.service'; +import { Request } from 'express'; export class ShareService implements OnModuleInit { catalogReadService: ReadService.CatalogReadServices; @@ -32,7 +34,8 @@ export class ShareService implements OnModuleInit { private readonly grpcClient: ClientGrpc, private readonly userService: UsersService, private readonly roleService: RolesService, - private shareMetadataService: ShareMetadataService, + private readonly shareMetadataService: ShareMetadataService, + private readonly mixpanelService: MixpanelService, ) { this.logger = dadosferaLogger.logger; } @@ -76,7 +79,7 @@ export class ShareService implements OnModuleInit { return result; } - async getOneDataAssetPublic(id: string, user: RequestUser) { + async getOneDataAssetPublic(id: string, user: RequestUser, request: Request) { this.logger.info("getOneDataAssetPublic: " + JSON.stringify({ id, userId: user?.user_id, @@ -85,6 +88,18 @@ export class ShareService implements OnModuleInit { try { const shareMetadata = await this.getShareMetadata(id, user); + const mixpanelTracker = { + asset: shareMetadata.assetId, + type: isJWT(id) ? 'assigned' : shareMetadata.type, + customer: shareMetadata.customerName + } + + if (user) { + await this.mixpanelService.track("share_page", user, request, mixpanelTracker); + } else { + await this.mixpanelService.trackShare(request, mixpanelTracker); + } + this.logger.info("shareMetadata: " + JSON.stringify(shareMetadata)) const metadata = PackTheMetadata({ customer_id: shareMetadata.customerId, diff --git a/src/modules/mixpanel/mixpanel.controller.ts b/src/modules/mixpanel/mixpanel.controller.ts index 04e8950..477569b 100644 --- a/src/modules/mixpanel/mixpanel.controller.ts +++ b/src/modules/mixpanel/mixpanel.controller.ts @@ -3,14 +3,13 @@ import { init } from 'mixpanel'; import { Authenticated } from 'src/decorators/authentication.decorator'; import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; import { RequestUser, User } from 'src/decorators/user.decorator'; +import { MixpanelService } from './mixpanel.service'; @ApiInternalOnlyController() -@Authenticated() @Controller('trackEvent') export class MixpanelController { constructor( - @Inject('MIXPANEL_TOKEN') - private readonly mixpanelToken: string, + private mixpanelService: MixpanelService ) {} @Post(':id') async trackEvent( @@ -20,82 +19,11 @@ export class MixpanelController { @Req() request ) { delete body.info; - const mixpanel = init(this.mixpanelToken); - - const separator = user.username.includes('-') ? '-' : '.'; - const removeValues = [ - '.dadosferatech.dadosfera', - '.demo.dadosfera', - '.dadosferademo', - '.dadosferarh.dadosfera', - '.dadosferatech.dadosfera2', - '.dadosferatech.dadosfera', - '.dadosfera.fin', - '.dadosferafin.dadosfera', - '.praxio.dadosfera', - '.dadosfera.tech', - '.treinamentos@dadosfera.ai', - '.dadosfera2', - '.treinamentosfera', - '.dadosfera', - ]; - - let username = user.username; - - removeValues.forEach((value) => { - username = username.replace(value, ''); - }); - - username = username.split('@')?.[0]; - username = username.split('+')?.[0]; - - let firstName = username - .substring(0, username.indexOf(separator)) - .replace('dadosfera', ''); - let lastName = username - .substring(username.lastIndexOf(separator) + 1) - .replace('dadosfera', ''); - - if (!firstName) { - firstName = lastName; - lastName = ''; - } - - firstName = this.capitalize(firstName); - lastName = this.capitalize(lastName); - - await mixpanel.people.set(user.username, { - $first_name: firstName, - $last_name: lastName, - $name: this.getFullName(firstName, lastName), - $email: user.username.includes('@') - ? user.username - : user.username + '@dadosfera.ai', - customer_name: user.customer_name - }); - - await mixpanel.track(id, { - distinct_id: user.username, - customer: user.customer_name, - env: process.env.ENV, - $ip: request.ip, - $os: request.headers['sec-ch-ua-platform'] || '', - $browser: request.headers['user-agent'], - ...body, - }); + + await this.mixpanelService.track(id, user, request, body) return { id, body, user: user.username }; } - capitalize(sentence: string): string { - if (!sentence) { - return ''; - } - return sentence[0].toUpperCase() + sentence.substring(1); - } - - getFullName(firstName: string, lastName: string) { - return `${firstName}${lastName ? ' ' + lastName : ''}`; - } } diff --git a/src/modules/mixpanel/mixpanel.module.ts b/src/modules/mixpanel/mixpanel.module.ts index 98f130d..f3ed70e 100644 --- a/src/modules/mixpanel/mixpanel.module.ts +++ b/src/modules/mixpanel/mixpanel.module.ts @@ -1,6 +1,8 @@ import { Module } from '@nestjs/common'; import { getSecretFromSecretsManager } from 'src/utils/SecretManager'; import { MixpanelController } from './mixpanel.controller'; +import { MixpanelService } from './mixpanel.service'; +import DadosferaLogger from '@dadosfera/dadosfera-logs'; @Module({ controllers: [MixpanelController], @@ -8,9 +10,12 @@ import { MixpanelController } from './mixpanel.controller'; { provide: 'MIXPANEL_TOKEN', useValue: getSecretFromSecretsManager( - `${process.env.ENV}/root/mixpanel_token`, + `prd/root/mixpanel_token`, ), }, + MixpanelService, + DadosferaLogger ], + exports: [MixpanelService] }) export class MixpanelModule {} diff --git a/src/modules/mixpanel/mixpanel.service.ts b/src/modules/mixpanel/mixpanel.service.ts new file mode 100644 index 0000000..3dd1879 --- /dev/null +++ b/src/modules/mixpanel/mixpanel.service.ts @@ -0,0 +1,118 @@ +import DadosferaLogger from '@dadosfera/dadosfera-logs'; +import { Inject } from '@nestjs/common'; +import { Request } from 'express'; +import mixpanel, { init } from 'mixpanel'; +import { RequestUser } from 'src/decorators/user.decorator'; + +export class MixpanelService { + logger: DadosferaLogger; + + constructor( + @Inject('MIXPANEL_TOKEN') + private readonly mixpanelToken: string, + @Inject(DadosferaLogger) + dadosferaLogger: DadosferaLogger, + ) { + this.logger = dadosferaLogger.logger; + } + + async track(eventName: string, user: RequestUser, request: Request, body: any) { + this.logger.info("track: " + JSON.stringify({ + eventName, + ...body + })) + const mixpanel = init(this.mixpanelToken); + await this.setPeople(user, mixpanel); + + await mixpanel.track(eventName, { + distinct_id: user.username, + customer: user.customer_name, + env: process.env.ENV, + $ip: request.ip, + $os: request.headers['sec-ch-ua-platform'] || '', + $browser: request.headers['user-agent'], + ...body, + }); + return; + } + + async trackShare(request: Request, body: any) { + this.logger.info("trackShare: " + JSON.stringify(body)) + const mixpanel = init(this.mixpanelToken); + + await mixpanel.track("share_page", { + env: process.env.ENV, + $ip: request.ip, + $os: request.headers['sec-ch-ua-platform'] || '', + $browser: request.headers['user-agent'], + ...body, + }); + return; + } + + private async setPeople(user: RequestUser, mixpanel: mixpanel.Mixpanel) { + const separator = user.username.includes('-') ? '-' : '.'; + const removeValues = [ + '.dadosferatech.dadosfera', + '.demo.dadosfera', + '.dadosferademo', + '.dadosferarh.dadosfera', + '.dadosferatech.dadosfera2', + '.dadosferatech.dadosfera', + '.dadosfera.fin', + '.dadosferafin.dadosfera', + '.praxio.dadosfera', + '.dadosfera.tech', + '.treinamentos@dadosfera.ai', + '.dadosfera2', + '.treinamentosfera', + '.dadosfera', + ]; + + let username = user.username; + + removeValues.forEach((value) => { + username = username.replace(value, ''); + }); + + username = username.split('@')?.[0]; + username = username.split('+')?.[0]; + + let firstName = username + .substring(0, username.indexOf(separator)) + .replace('dadosfera', ''); + let lastName = username + .substring(username.lastIndexOf(separator) + 1) + .replace('dadosfera', ''); + + if (!firstName) { + firstName = lastName; + lastName = ''; + } + + firstName = this.capitalize(firstName); + lastName = this.capitalize(lastName); + + await mixpanel.people.set(user.username, { + $first_name: firstName, + $last_name: lastName, + $name: this.getFullName(firstName, lastName), + $email: user.username.includes('@') + ? user.username + : user.username + '@dadosfera.ai', + customer_name: user.customer_name, + }); + } + + private capitalize(sentence: string): string { + if (!sentence) { + return ''; + } + + return sentence[0].toUpperCase() + sentence.substring(1); + } + + private getFullName(firstName: string, lastName: string) { + return `${firstName}${lastName ? ' ' + lastName : ''}`; + } +}