Merge pull request #171 from dadosfera/ft/mixpanel-track

FEAT: Mixpanel Tracker

.github/workflows/deploy-manually.yml

@@ -6,7 +6,7 @@ on:
   workflow_dispatch:
     inputs:
       environment:
-        description: 'Deployment environment'
+        description: "Deployment environment"
         required: true
         type: choice
         options:
@@ -39,7 +39,7 @@ jobs:
       new_release_version: ${{ (steps.semantic.outputs.new_release_published == 'true' && steps.semantic.outputs.new_release_version) || (github.event_name == 'workflow_dispatch' && '0.0.0') }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - if: github.event_name != 'workflow_dispatch'
         name: Semantic Release
@@ -73,7 +73,7 @@ jobs:
     if: ${{ github.event_name == 'workflow_dispatch' || needs.semantic_release.outputs.new_release_published == 'true' }}
     needs: [extract_environment, semantic_release]
     runs-on:
-      [self-hosted, '${{ needs.extract_environment.outputs.environment }}']
+      [self-hosted, "${{ needs.extract_environment.outputs.environment }}"]
 
     steps:
       - name: Checkout
@@ -145,12 +145,12 @@ jobs:
   api_docs:
     needs: [extract_environment, semantic_release, deploy]
     runs-on:
-      [self-hosted, '${{ needs.extract_environment.outputs.environment }}']
+      [self-hosted, "${{ needs.extract_environment.outputs.environment }}"]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Extract Docs BlockId and PageId 
+      - name: Extract Docs BlockId and PageId
         env:
           ENV: ${{ needs.extract_environment.outputs.environment }}
           DEV_DOCS_BLOCK_ID: ${{ secrets.DEV_DOCS_BLOCK_ID }}
@@ -181,16 +181,7 @@ jobs:
           DOCS_PAGE_ID: ${{ steps.extract_docs_info.outputs.page_id }}
           DOCS_BLOCK_ID: ${{ steps.extract_docs_info.outputs.block_id }}
         run: |
-          SWAGGER=`cat swagger.txt`
-          curl --request POST \
-            --url $DOCS_URL \
-            --header 'Content-Type: application/json' \
-            --data @<(cat <<EOF
-            {
-            "service": "$DOCS_API_TOKEN",
-            "pageId": "$DOCS_PAGE_ID",
-            "blockId": "$DOCS_BLOCK_ID",
-            "schema":  $SWAGGER
-          }
-          EOF
-          )
+          sed -i -e "s/\${DOCS_API_TOKEN}/$DOCS_API_TOKEN/g" docsfera.json
+          sed -i -e "s/\${DOCS_PAGE_ID}/$DOCS_PAGE_ID/g" docsfera.json
+          sed -i -e "s/\${DOCS_BLOCK_ID}/$DOCS_BLOCK_ID/g" docsfera.json
+          curl -X POST -H 'Content-Type: application/json' -d @docsfera.json $DOCS_URL

package-lock.json

@@ -12,7 +12,7 @@
       "dependencies": {
         "@aws-sdk/client-secrets-manager": "^3.112.0",
         "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-        "@dadosfera/protospack-v2": "3.19.1",
+        "@dadosfera/protospack-v2": "3.19.2",
         "@grpc/grpc-js": "^1.6.7",
         "@grpc/proto-loader": "^0.6.13",
         "@nestjs/common": "^8.4.7",
@@ -33,6 +33,7 @@
         "helmet": "^5.1.0",
         "jsonwebtoken": "^8.5.1",
         "jwk-to-pem": "^2.0.5",
+        "mixpanel": "^0.17.0",
         "passport": "^0.6.0",
         "passport-facebook": "^3.0.0",
         "passport-forcedotcom": "^0.1.5",
@@ -1726,9 +1727,9 @@
       }
     },
     "node_modules/@dadosfera/protospack-v2": {
-      "version": "3.19.1",
-      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.19.1.tgz",
-      "integrity": "sha512-8YCyyc9Jpls31mXGdsw6IksZc6BGgNNm2Ht85rtapZfhGowOIXkjfXLlWFy7WxfMl0AQYH3pV3u4/WO7rR/JPA==",
+      "version": "3.19.2",
+      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.19.2.tgz",
+      "integrity": "sha512-0+5V4zo7x36Y9xojYnktTllm41uhAttEFTT13i2sBXn4Cb6xSCX5rOyMHwRHb4TOHTpWvaO58lGjP/i0x+lpEg==",
       "dependencies": {
         "@grpc/grpc-js": "^1.6.7",
         "rxjs": "^7.5.5",
@@ -3543,7 +3544,6 @@
     },
     "node_modules/agent-base": {
       "version": "6.0.2",
-      "dev": true,
       "license": "MIT",
       "dependencies": {
         "debug": "4"
@@ -8205,6 +8205,29 @@
       "version": "1.2.6",
       "license": "MIT"
     },
+    "node_modules/mixpanel": {
+      "version": "0.17.0",
+      "resolved": "https://registry.npmjs.org/mixpanel/-/mixpanel-0.17.0.tgz",
+      "integrity": "sha512-DY5WeOy/hmkPrNiiZugJpWR0iMuOwuj1a3u0bgwB2eUFRV6oIew/pIahhpawdbNjb+Bye4a8ID3gefeNPvL81g==",
+      "dependencies": {
+        "https-proxy-agent": "5.0.0"
+      },
+      "engines": {
+        "node": ">=10.0"
+      }
+    },
+    "node_modules/mixpanel/node_modules/https-proxy-agent": {
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.0.tgz",
+      "integrity": "sha512-EkYm5BcKUGiduxzSt3Eppko+PiNWNEpa4ySk9vTC6wDsQJW9rHSa+UhGNJoRYp7bz6Ht1eaRIa6QaJqO5rCFbA==",
+      "dependencies": {
+        "agent-base": "6",
+        "debug": "4"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
     "node_modules/mkdirp": {
       "version": "0.5.6",
       "license": "MIT",
@@ -12307,9 +12330,9 @@
       }
     },
     "@dadosfera/protospack-v2": {
-      "version": "3.19.1",
-      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.19.1.tgz",
-      "integrity": "sha512-8YCyyc9Jpls31mXGdsw6IksZc6BGgNNm2Ht85rtapZfhGowOIXkjfXLlWFy7WxfMl0AQYH3pV3u4/WO7rR/JPA==",
+      "version": "3.19.2",
+      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com:443/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.19.2.tgz",
+      "integrity": "sha512-0+5V4zo7x36Y9xojYnktTllm41uhAttEFTT13i2sBXn4Cb6xSCX5rOyMHwRHb4TOHTpWvaO58lGjP/i0x+lpEg==",
       "requires": {
         "@grpc/grpc-js": "^1.6.7",
         "rxjs": "^7.5.5",
@@ -13556,7 +13579,6 @@
     },
     "agent-base": {
       "version": "6.0.2",
-      "dev": true,
       "requires": {
         "debug": "4"
       }
@@ -16720,6 +16742,25 @@
     "minimist": {
       "version": "1.2.6"
     },
+    "mixpanel": {
+      "version": "0.17.0",
+      "resolved": "https://registry.npmjs.org/mixpanel/-/mixpanel-0.17.0.tgz",
+      "integrity": "sha512-DY5WeOy/hmkPrNiiZugJpWR0iMuOwuj1a3u0bgwB2eUFRV6oIew/pIahhpawdbNjb+Bye4a8ID3gefeNPvL81g==",
+      "requires": {
+        "https-proxy-agent": "5.0.0"
+      },
+      "dependencies": {
+        "https-proxy-agent": {
+          "version": "5.0.0",
+          "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.0.tgz",
+          "integrity": "sha512-EkYm5BcKUGiduxzSt3Eppko+PiNWNEpa4ySk9vTC6wDsQJW9rHSa+UhGNJoRYp7bz6Ht1eaRIa6QaJqO5rCFbA==",
+          "requires": {
+            "agent-base": "6",
+            "debug": "4"
+          }
+        }
+      }
+    },
     "mkdirp": {
       "version": "0.5.6",
       "requires": {

package.json

@@ -28,7 +28,7 @@
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "^3.112.0",
     "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-    "@dadosfera/protospack-v2": "3.19.1",
+    "@dadosfera/protospack-v2": "3.19.2",
     "@grpc/grpc-js": "^1.6.7",
     "@grpc/proto-loader": "^0.6.13",
     "@nestjs/common": "^8.4.7",
@@ -49,6 +49,7 @@
     "helmet": "^5.1.0",
     "jsonwebtoken": "^8.5.1",
     "jwk-to-pem": "^2.0.5",
+    "mixpanel": "^0.17.0",
     "passport": "^0.6.0",
     "passport-facebook": "^3.0.0",
     "passport-forcedotcom": "^0.1.5",

src/app.module.ts

@@ -24,6 +24,7 @@ import { CatalogModule } from './modules/catalog/catalog.module';
 import { ConfigModule } from '@nestjs/config';
 import { PipelinesV2Module } from './modules/pipelinesV2/pipelines.module';
 import { ProductboardModule } from './modules/productboard/productboard.module';
+import { MixpanelModule } from './modules/mixpanel/mixpanel.module';
 
 @Module({
   controllers: [],
@@ -56,6 +57,7 @@ import { ProductboardModule } from './modules/productboard/productboard.module';
     OauthModule,
     CatalogModule,
     ProductboardModule,
+    MixpanelModule,
   ],
 })
 export class AppModule {}

src/main.ts

@@ -6,6 +6,8 @@ import { DadosferaLogger } from '@dadosfera/dadosfera-logs';
 
 import { AppModule } from './app.module';
 import { writeFileSync } from 'fs';
+import { execSync } from 'child_process';
+import { INestApplication } from '@nestjs/common';
 async function bootstrap() {
   DadosferaLogger.setupLogger({
     serviceName: 'maestro',
@@ -24,26 +26,53 @@ async function bootstrap() {
   });
 
   app.use(helmet());
+  configureSwagger(app);
 
+  await app.listen(3333);
+}
+function configureSwagger(app: INestApplication) {
   const date = new Date();
+  const swaggerVersion = `${date.getDate()}.${
+    date.getMonth() + 1
+  }.${date.getFullYear()} - ${date.getHours()}:${date.getMinutes()}`;
+
+  let branchName = '';
+  try {
+    branchName = execSync('git rev-parse --abbrev-ref HEAD')
+      .toString()
+      .replace('\n', '')
+      .trim();
+  } catch (error) {
+    console.log("Can't get branch name", error);
+  }
+  const swaggerTitle = branchName ? `Maestro - ${branchName}` : 'Maestro';
 
   const config = new DocumentBuilder()
-    .setTitle('Maestro')
+    .setTitle(swaggerTitle)
     .setDescription('Documentation for Maestro gateway')
-    .setVersion(
-      `${date.getDate()}.${
-        date.getMonth() + 1
-      }.${date.getFullYear()} - ${date.getHours()}:${date.getMinutes()}`,
+    .setVersion(swaggerVersion)
+    .addBearerAuth(
+      { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' },
+      'Authorization',
     )
-    .addBearerAuth()
     .build();
 
   const document = SwaggerModule.createDocument(app, config);
 
   if (process.env.ENV === 'local') SwaggerModule.setup('api', app, document);
 
-  await writeFileSync('swagger.txt', JSON.stringify(JSON.stringify(document)));
-
-  await app.listen(3333);
+  writeFileSync(
+    'docsfera.json',
+    JSON.stringify(
+      {
+        service: '${DOCS_API_TOKEN}',
+        pageId: '${DOCS_PAGE_ID}',
+        blockId: '${DOCS_BLOCK_ID}',
+        schema: document,
+      },
+      null,
+      2,
+    ),
+  );
 }
 bootstrap();

src/modules/mixpanel/mixpanel.controller.ts

@@ -0,0 +1,31 @@
+import { Body, Controller, Inject, Param, Post } from '@nestjs/common';
+import { init } from 'mixpanel';
+import { RequestUser, User } from 'src/authentication/user.decorator';
+
+@Controller('trackEvent')
+export class MixpanelController {
+  constructor(
+    @Inject('MIXPANEL_TOKEN')
+    private readonly mixpanelToken: string,
+  ) {}
+  @Post(':id')
+  async trackEvent(@Param('id') id, @Body() body, @User() user: RequestUser) {
+    delete body.info;
+    const mixpanel = init(this.mixpanelToken);
+
+    await mixpanel.people.set(user.username, {
+      $name: user.username,
+      $email: user.username,
+      customer_name: user.customer_name,
+    });
+
+    await mixpanel.track(id, {
+      distinct_id: user.username,
+      customer: user.customer_name,
+      env: process.env.ENV,
+      ...body,
+    });
+
+    return { id, body, user: user.username };
+  }
+}

src/modules/mixpanel/mixpanel.module.ts

@@ -0,0 +1,16 @@
+import { Module } from '@nestjs/common';
+import { getSecreteFromSecreteManager } from 'src/utils/SecretManager';
+import { MixpanelController } from './mixpanel.controller';
+
+@Module({
+  controllers: [MixpanelController],
+  providers: [
+    {
+      provide: 'MIXPANEL_TOKEN',
+      useValue: getSecreteFromSecreteManager(
+        `${process.env.ENV}/root/mixpanel_token`,
+      ),
+    },
+  ],
+})
+export class MixpanelModule {}